2 .\" John-Mark Gurney. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 3. Neither the name of the author nor the names of any co-contributors
13 .\" may be used to endorse or promote products derived from this software
14 .\" without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY John-Mark Gurney AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" $FreeBSD: src/share/man/man4/sysmouse.4,v 1.12.2.5 2001/12/17 11:30:12 ru Exp $
35 .\" .Nd supplies mouse data from syscons for other applications
36 .Nd virtualized mouse driver
41 The console driver, in conjunction with the mouse daemon
43 supplies mouse data to the user process in the standardized way via the
46 This arrangement makes it possible for the console and the user process
48 .Tn X\ Window System )
51 The user process which wants to utilize mouse operation simply opens
56 mouse data from the device via
60 is running, otherwise the user process won't see any data coming from
65 driver has two levels of operation.
66 The current operation level can be referred to and changed via ioctl calls.
68 The level zero, the basic level, is the lowest level at which the driver
69 offers the basic service to user programs.
73 provides horizontal and vertical movement of the mouse
74 and state of up to three buttons in the
78 .Bl -tag -width Byte_1 -compact
80 .Bl -tag -width bit_7 -compact
86 Left button status; cleared if pressed, otherwise set.
88 Middle button status; cleared if pressed, otherwise set.
90 if the device does not have the middle button.
92 Right button status; cleared if pressed, otherwise set.
95 The first half of horizontal movement count in two's complement;
98 The first half of vertical movement count in two's complement;
101 The second half of the horizontal movement count in two's complement;
102 -128 through 127. To obtain the full horizontal movement count, add
105 The second half of the vertical movement count in two's complement;
106 -128 through 127. To obtain the full vertical movement count, add
110 At the level one, the extended level, mouse data is encoded
111 in the standard format
112 .Dv MOUSE_PROTO_SYSMOUSE
118 .\" driver can somewhat `accelerate' the movement of the pointing device.
119 .\" The faster you move the device, the further the pointer
120 .\" travels on the screen.
121 .\" The driver has an internal variable which governs the effect of
122 .\" the acceleration. Its value can be modified via the driver flag
123 .\" or via an ioctl call.
125 This section describes two classes of
130 driver itself, and commands for the console and the console control drivers.
132 There are a few commands for mouse drivers.
133 General description of the commands is given in
135 Following are the features specific to the
139 .Bl -tag -width MOUSE -compact
140 .It Dv MOUSE_GETLEVEL Ar int *level
141 .It Dv MOUSE_SETLEVEL Ar int *level
142 These commands manipulate the operation level of the mouse driver.
144 .It Dv MOUSE_GETHWINFO Ar mousehw_t *hw
145 Returns the hardware information of the attached device in the following
148 field is guaranteed to be filled with the correct value in the current
153 typedef struct mousehw {
154 int buttons; /* number of buttons */
155 int iftype; /* I/F type */
156 int type; /* mouse/track ball/pad... */
157 int model; /* I/F dependent model ID */
158 int hwid; /* I/F dependent hardware ID */
164 field holds the number of buttons detected by the driver.
169 .Dv MOUSE_IF_SYSMOUSE .
173 tells the device type:
175 .Dv MOUSE_TRACKBALL ,
184 .Dv MOUSE_MODEL_GENERIC
185 at the operation level 0.
187 .Dv MOUSE_MODEL_GENERIC
190 constants at higher operation levels.
196 .It Dv MOUSE_GETMODE Ar mousemode_t *mode
197 The command gets the current operation parameters of the mouse
200 typedef struct mousemode {
201 int protocol; /* MOUSE_PROTO_XXX */
202 int rate; /* report rate (per sec) */
203 int resolution; /* MOUSE_RES_XXX, -1 if unknown */
204 int accelfactor; /* acceleration factor */
205 int level; /* driver operation level */
206 int packetsize; /* the length of the data packet */
207 unsigned char syncmask[2]; /* sync. bits */
213 field tells the format in which the device status is returned
214 when the mouse data is read by the user program.
217 at the operation level zero.
218 .Dv MOUSE_PROTO_SYSMOUSE
219 at the operation level one.
235 field specifies the length of the data packet.
239 .Bl -tag -width level_0__ -compact
248 holds a bit mask and pattern to detect the first byte of the
251 is the bit mask to be ANDed with a byte.
252 If the result is equal to
254 the byte is likely to be the first byte of the data packet.
255 Note that this method of detecting the first byte is not 100% reliable;
256 thus, it should be taken only as an advisory measure.
258 .It Dv MOUSE_SETMODE Ar mousemode_t *mode
259 The command changes the current operation parameters of the mouse driver
265 Setting values in the other field does not generate
266 error and has no effect.
268 .\" .It Dv MOUSE_GETVARS Ar mousevar_t *vars
269 .\" .It Dv MOUSE_SETVARS Ar mousevar_t *vars
270 .\" These commands are not supported by the
274 .It Dv MOUSE_READDATA Ar mousedata_t *data
275 .It Dv MOUSE_READSTATE Ar mousedata_t *state
276 These commands are not supported by the
280 .It Dv MOUSE_GETSTATUS Ar mousestatus_t *status
281 The command returns the current state of buttons and
282 movement counts in the structure as defined in
285 .Ss Console and Consolectl Ioctls
286 The user process issues console
288 calls to the current virtual console in order to control
292 also provides a method for the user process to receive a
294 when a button is pressed.
300 calls to the console control device
302 to inform the console of mouse actions including mouse movement
307 commands are defined as
309 which takes the following argument.
314 struct mouse_data data;
315 struct mouse_mode mode;
316 struct mouse_event event;
321 .Bl -tag -width operation -compact
325 .Bl -tag -width MOUSE_MOVEABS -compact
327 Enables and displays mouse cursor.
329 Disables and hides mouse cursor.
331 Moves mouse cursor to position supplied in
334 Adds position supplied in
338 Returns current mouse position in the current virtual console
344 to be delivered to the current process when a button is pressed.
345 The signal to be delivered is set in
349 The above operations are for virtual consoles.
350 The operations defined
351 below are for the console control device and are used by
353 to pass mouse data to the console driver.
355 .Bl -tag -width MOUSE_MOVEABS -compact
357 .It Dv MOUSE_MOTIONEVENT
358 These operations take the information in
360 and act upon it. Mouse data will be sent to the
362 driver if it is open.
364 also processes button press actions and sends signal to the process if
365 requested or performs cut and paste operations
366 if the current console is a text interface.
367 .It Dv MOUSE_BUTTONEVENT
369 specifies a button and its click count.
370 The console driver will
371 use this information for signal delivery if requested or
372 for cut and paste operations if the console is in text mode.
375 .Dv MOUSE_MOTIONEVENT
377 .Dv MOUSE_BUTTONEVENT
378 are newer interface and are designed to be used together.
379 They are intended to replace functions performed by
386 .Bl -tag -width data -compact
401 represent movement of the mouse along respective directions.
403 tells the state of buttons.
404 It encodes up to 31 buttons in the bit 0 though
405 the bit 30. If a button is held down, the corresponding bit is set.
417 field specifies the signal to be delivered to the process.
419 one of the values defined in
423 field is currently unused.
435 field specifies a button number as in
437 Only one bit/button is set.
441 holds the click count: the number of times the user has clicked the button
446 .Bl -tag -width /dev/consolectl -compact
447 .It Pa /dev/consolectl
448 device to control the console
450 virtualized mouse driver
463 manual page example first appeared in
468 manual page was written by
469 .An John-Mark Gurney Aq Mt gurney_j@efn.org
471 .An Kazutaka Yokota Aq Mt yokota@FreeBSD.org .