- NetBSD Manual Pages
WSMOUSE(9) NetBSD Kernel Developer's Manual WSMOUSE(9)
Powered by man-cgi (2020-09-24).
Maintained for NetBSD
by Kimmo Suominen.
Based on man-cgi by Panagiotis Christias.
wsmouse, wsmouse_input, wsmousedevprint -- wscons mouse support
wsmouse_input(struct device *msdev, u_int btns, int x, int y, int z,
int w, u_int flags);
wsmousedevprint(void *aux, const char *pnp);
The wsmouse module is a component of the wscons(9) framework to provide
machine-independent mouse support. Most of the support is provided by
the wsmouse(4) device driver, which must be a child of the hardware
Mouse drivers providing support for wscons pointer devices will make use
of the following data types:
A structure used to specify the mouse access functions. All
pointer devices must provide this structure and pass it to the
wsmouse(4) child device. It has the following members:
int (*enable)(void *);
int (*ioctl)(void *v, u_long cmd, void *data,
int flag, struct lwp *l);
void (*disable)(void *);
The enable member defines the function to be called to enable
monitoring pointer movements and passing these events to wscons.
The disable member defines the function to disable movement
events. The ioctl member defines the function to be called to
perform mouse-specific ioctl calls.
There is a void * cookie provided by the mouse driver associated
with these functions, which is passed to them when they are
A structure used to attach the wsmouse(4) child device. It has
the following members:
const struct wsmouse_accessops *accessops;
wsmouse_input(msdev, btns, x, y, z, w, flags)
Callback from the mouse driver to the wsmouse interface driver.
Arguments are as follows:
msdev This is the struct device pointer passed from
config_found() on attaching the child wsmouse(4) to spec-
ify the mouse device.
btns This specifies the current button status. Bits for
pressed buttons (which will cause the
WSCONS_EVENT_MOUSE_DOWN event on wsmouse(4) device)
should be set, and bits for released buttons (which will
cause the WSCONS_EVENT_MOUSE_UP event) should be zero.
The left most button state should be in LSB, i.e. for
typical three button mouse, the left button is 0x01, the
middle button is 0x02, and the right button is 0x04.
x Absolute or relative X-axis value to specify the pointer
coordinate. Rightward (moving the mouse right) is posi-
y Absolute or relative Y-axis value to specify the pointer
coordinate. Upward (moving the mouse forward) is posi-
tive. Note that this aspect is opposite from the one
used in the X server dix layer.
z Absolute or relative Z-axis value to specify the pointer
coordinate. Usually this axis is used for the wheel.
Downward (turning the wheel backward) is positive.
w Absolute or relative W-axis value to specify the pointer
coordinate. Usually this axis would be used for the hor-
izontal component of the wheel.
flags This argument specifies whether the pointer device and
the measurement of the x, y, z, and w axes is in relative
or absolute mode. Valid values for flags are:
Absolute mode in x axis.
Absolute mode in y axis.
Absolute mode in z axis.
Absolute mode in w axis.
The default wsmouse printing routine used by config_found().
Mouse drivers which want to use the wsmouse module must be a parent to
the wsmouse(4) device and provide an attachment interface. To attach the
wsmouse(4) device, the mouse driver must allocate and populate a
wsmousedev_attach_args structure with the supported operations and call-
backs and call config_found() to perform the attach (see autoconf(9)).
When a mouse-movement event is received, the device driver must perform
any necessary movement decoding to wscons events and pass the events to
wscons via wsmouse_input().
The wscons framework calls back into the hardware driver by invoking the
functions that are specified in the accessops structure. The enable()
and disable() functions are relatively simple and self-explanatory. The
ioctl() function is called by the wscons interface to perform mouse-spe-
cific ioctl operations (see ioctl(2)). The argument cmd to the ioctl()
function specifies the specific command to perform using the data data.
Valid commands are listed in sys/dev/wscons/wsconsio.h.
The wscons subsystem is implemented within the directory sys/dev/wscons.
The wsmouse module itself is implement within the file
sys/dev/wscons/wsmouse.c. ioctl(2) operations are listed in
ioctl(2), pms(4), wscons(4), wsmouse(4), autoconf(9), driver(9),
intro(9), wscons(9), wsdisplay(9), wskbd(9)
NetBSD 9.0 November 12, 2006 NetBSD 9.0