share/man/man4/sysmouse.4

   1 .\" Copyright 1997 John-Mark Gurney.  All rights reserved.
   2 .\"
   3 .\" Redistribution and use in source and binary forms, with or without
   4 .\" modification, are permitted provided that the following conditions
   5 .\" are met:
   6 .\" 1. Redistributions of source code must retain the above copyright
   7 .\"    notice, this list of conditions and the following disclaimer.
   8 .\" 2. Redistributions in binary form must reproduce the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer in the
  10 .\"    documentation and/or other materials provided with the distribution.
  11 .\"
  12 .\" THIS SOFTWARE IS PROVIDED BY John-Mark Gurney AND CONTRIBUTORS ``AS IS'' AND
  13 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  14 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  15 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  16 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  17 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  18 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  19 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  20 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  21 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  22 .\" SUCH DAMAGE.
  23 .\"
  24 .\" $FreeBSD$
  25 .\"
  26 .Dd March 25, 2014
  27 .Dt SYSMOUSE 4
  28 .Os
  29 .Sh NAME
  30 .Nm sysmouse
  31 .\" .Nd supplies mouse data from syscons for other applications
  32 .Nd virtualized mouse driver
  33 .Sh SYNOPSIS
  34 .In sys/mouse.h
  35 .In sys/consio.h
  36 .Sh DESCRIPTION
  37 The console driver, in conjunction with the mouse daemon
  38 .Xr moused 8 ,
  39 supplies mouse data to the user process in the standardized way via the
  40 .Nm
  41 driver.
  42 This arrangement makes it possible for the console and the user process
  43 (such as the
  44 .Tn X\ Window System )
  45 to share the mouse.
  46 .Pp
  47 The user process which wants to utilize mouse operation simply opens
  48 .Pa /dev/sysmouse
  49 with a
  50 .Xr open 2
  51 call and reads
  52 mouse data from the device via
  53 .Xr read 2 .
  54 Make sure that
  55 .Xr moused 8
  56 is running, otherwise the user process will not see any data coming from
  57 the mouse.
  58 .Pp
  59 .Ss Operation Levels
  60 The
  61 .Nm
  62 driver has two levels of operation.
  63 The current operation level can be referred to and changed via ioctl calls.
  64 .Pp
  65 The level zero, the basic level, is the lowest level at which the driver
  66 offers the basic service to user programs.
  67 The
  68 .Nm
  69 driver
  70 provides horizontal and vertical movement of the mouse
  71 and state of up to three buttons in the
  72 .Tn MouseSystems
  73 format as follows.
  74 .Pp
  75 .Bl -tag -width Byte_1 -compact
  76 .It Byte 1
  77 .Bl -tag -width bit_7 -compact
  78 .It bit 7
  79 Always one.
  80 .It bit 6..3
  81 Always zero.
  82 .It bit 2
  83 Left button status; cleared if pressed, otherwise set.
  84 .It bit 1
  85 Middle button status; cleared if pressed, otherwise set.
  86 Always one,
  87 if the device does not have the middle button.
  88 .It bit 0
  89 Right button status; cleared if pressed, otherwise set.
  90 .El
  91 .It Byte 2
  92 The first half of horizontal movement count in two's complement;
  93 \-128 through 127.
  94 .It Byte 3
  95 The first half of vertical movement count in two's complement;
  96 \-128 through 127.
  97 .It Byte 4
  98 The second half of the horizontal movement count in two's complement;
  99 \-128 through 127.
 100 To obtain the full horizontal movement count, add
 101 the byte 2 and 4.
 102 .It Byte 5
 103 The second half of the vertical movement count in two's complement;
 104 \-128 through 127.
 105 To obtain the full vertical movement count, add
 106 the byte 3 and 5.
 107 .El
 108 .Pp
 109 At the level one, the extended level, mouse data is encoded
 110 in the standard format
 111 .Dv MOUSE_PROTO_SYSMOUSE
 112 as defined in
 113 .Xr mouse 4 .
 114 .\" .Ss Acceleration
 115 .\" The
 116 .\" .Nm
 117 .\" driver can somewhat `accelerate' the movement of the pointing device.
 118 .\" The faster you move the device, the further the pointer
 119 .\" travels on the screen.
 120 .\" The driver has an internal variable which governs the effect of
 121 .\" the acceleration. Its value can be modified via the driver flag
 122 .\" or via an ioctl call.
 123 .Sh IOCTLS
 124 This section describes two classes of
 125 .Xr ioctl 2
 126 commands:
 127 commands for the
 128 .Nm
 129 driver itself, and commands for the console and the console control drivers.
 130 .Ss Sysmouse Ioctls
 131 There are a few commands for mouse drivers.
 132 General description of the commands is given in
 133 .Xr mouse 4 .
 134 Following are the features specific to the
 135 .Nm
 136 driver.
 137 .Pp
 138 .Bl -tag -width MOUSE -compact
 139 .It Dv MOUSE_GETLEVEL Ar int *level
 140 .It Dv MOUSE_SETLEVEL Ar int *level
 141 These commands manipulate the operation level of the mouse driver.
 142 .Pp
 143 .It Dv MOUSE_GETHWINFO Ar mousehw_t *hw
 144 Returns the hardware information of the attached device in the following
 145 structure.
 146 Only the
 147 .Va iftype
 148 field is guaranteed to be filled with the correct value in the current
 149 version of the
 150 .Nm
 151 driver.
 152 .Bd -literal
 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 */
 159 } mousehw_t;
 160 .Ed
 161 .Pp
 162 The
 163 .Va buttons
 164 field holds the number of buttons detected by the driver.
 165 .Pp
 166 The
 167 .Va iftype
 168 is always
 169 .Dv MOUSE_IF_SYSMOUSE .
 170 .Pp
 171 The
 172 .Va type
 173 tells the device type:
 174 .Dv MOUSE_MOUSE ,
 175 .Dv MOUSE_TRACKBALL ,
 176 .Dv MOUSE_STICK ,
 177 .Dv MOUSE_PAD ,
 178 or
 179 .Dv MOUSE_UNKNOWN .
 180 .Pp
 181 The
 182 .Va model
 183 is always
 184 .Dv MOUSE_MODEL_GENERIC
 185 at the operation level 0.
 186 It may be
 187 .Dv MOUSE_MODEL_GENERIC
 188 or one of
 189 .Dv MOUSE_MODEL_XXX
 190 constants at higher operation levels.
 191 .Pp
 192 The
 193 .Va hwid
 194 is always zero.
 195 .Pp
 196 .It Dv MOUSE_GETMODE Ar mousemode_t *mode
 197 The command gets the current operation parameters of the mouse
 198 driver.
 199 .Bd -literal
 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 */
 208 } mousemode_t;
 209 .Ed
 210 .Pp
 211 The
 212 .Va protocol
 213 field tells the format in which the device status is returned
 214 when the mouse data is read by the user program.
 215 It is
 216 .Dv MOUSE_PROTO_MSC
 217 at the operation level zero.
 218 .Dv MOUSE_PROTO_SYSMOUSE
 219 at the operation level one.
 220 .Pp
 221 The
 222 .Va rate
 223 is always set to \-1.
 224 .Pp
 225 The
 226 .Va resolution
 227 is always set to \-1.
 228 .Pp
 229 The
 230 .Va accelfactor
 231 is always 0.
 232 .Pp
 233 The
 234 .Va packetsize
 235 field specifies the length of the data packet.
 236 It depends on the
 237 operation level.
 238 .Pp
 239 .Bl -tag -width level_0__ -compact
 240 .It Em level 0
 241 5 bytes
 242 .It Em level 1
 243 8 bytes
 244 .El
 245 .Pp
 246 The array
 247 .Va syncmask
 248 holds a bit mask and pattern to detect the first byte of the
 249 data packet.
 250 .Va syncmask[0]
 251 is the bit mask to be ANDed with a byte.
 252 If the result is equal to
 253 .Va syncmask[1] ,
 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.
 257 .Pp
 258 .It Dv MOUSE_SETMODE Ar mousemode_t *mode
 259 The command changes the current operation parameters of the mouse driver
 260 as specified in
 261 .Ar mode .
 262 Only
 263 .Va level
 264 may be modifiable.
 265 Setting values in the other field does not generate
 266 error and has no effect.
 267 .\" .Pp
 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
 271 .\" .Nm
 272 .\" driver.
 273 .Pp
 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
 277 .Nm
 278 driver.
 279 .Pp
 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
 283 .Xr mouse 4 .
 284 .El
 285 .Ss Console and Consolectl Ioctls
 286 The user process issues console
 287 .Fn ioctl
 288 calls to the current virtual console in order to control
 289 the mouse pointer.
 290 The console
 291 .Fn ioctl
 292 also provides a method for the user process to receive a
 293 .Xr signal 3
 294 when a button is pressed.
 295 .Pp
 296 The mouse daemon
 297 .Xr moused 8
 298 uses
 299 .Fn ioctl
 300 calls to the console control device
 301 .Pa /dev/consolectl
 302 to inform the console of mouse actions including mouse movement
 303 and button status.
 304 .Pp
 305 Both classes of
 306 .Fn ioctl
 307 commands are defined as
 308 .Dv CONS_MOUSECTL
 309 which takes the following argument.
 310 .Bd -literal
 311 struct mouse_info {
 312     int operation;
 313     union {
 314         struct mouse_data data;
 315         struct mouse_mode mode;
 316         struct mouse_event event;
 317     } u;
 318 };
 319 .Ed
 320 .Pp
 321 .Bl -tag -width operation -compact
 322 .It Va operation
 323 This can be one of
 324 .Pp
 325 .Bl -tag -width MOUSE_MOVEABS -compact
 326 .It Dv MOUSE_SHOW
 327 Enables and displays mouse cursor.
 328 .It Dv MOUSE_HIDE
 329 Disables and hides mouse cursor.
 330 .It Dv MOUSE_MOVEABS
 331 Moves mouse cursor to position supplied in
 332 .Va u.data .
 333 .It Dv MOUSE_MOVEREL
 334 Adds position supplied in
 335 .Va u.data
 336 to current position.
 337 .It Dv MOUSE_GETINFO
 338 Returns current mouse position in the current virtual console
 339 and button status in
 340 .Va u.data .
 341 .It Dv MOUSE_MODE
 342 This sets the
 343 .Xr signal 3
 344 to be delivered to the current process when a button is pressed.
 345 The signal to be delivered is set in
 346 .Va u.mode .
 347 .El
 348 .Pp
 349 The above operations are for virtual consoles.
 350 The operations defined
 351 below are for the console control device and are used by
 352 .Xr moused 8
 353 to pass mouse data to the console driver.
 354 .Pp
 355 .Bl -tag -width MOUSE_MOVEABS -compact
 356 .It Dv MOUSE_ACTION
 357 .It Dv MOUSE_MOTION_EVENT
 358 These operations take the information in
 359 .Va u.data
 360 and act upon it.
 361 Mouse data will be sent to the
 362 .Nm
 363 driver if it is open.
 364 .Dv MOUSE_ACTION
 365 also processes button press actions and sends signal to the process if
 366 requested or performs cut and paste operations
 367 if the current console is a text interface.
 368 .It Dv MOUSE_BUTTON_EVENT
 369 .Va u.data
 370 specifies a button and its click count.
 371 The console driver will
 372 use this information for signal delivery if requested or
 373 for cut and paste operations if the console is in text mode.
 374 .El
 375 .Pp
 376 .Dv MOUSE_MOTION_EVENT
 377 and
 378 .Dv MOUSE_BUTTON_EVENT
 379 are newer interface and are designed to be used together.
 380 They are intended to replace functions performed by
 381 .Dv MOUSE_ACTION
 382 alone.
 383 .Pp
 384 .It Va u
 385 This union is one of
 386 .Pp
 387 .Bl -tag -width data -compact
 388 .It Va data
 389 .Bd -literal
 390 struct mouse_data {
 391     int x;
 392     int y;
 393     int z;
 394     int buttons;
 395 };
 396 .Ed
 397 .Pp
 398 .Va x , y
 399 and
 400 .Va z
 401 represent movement of the mouse along respective directions.
 402 .Va buttons
 403 tells the state of buttons.
 404 It encodes up to 31 buttons in the bit 0 though
 405 the bit 30.
 406 If a button is held down, the corresponding bit is set.
 407 .Pp
 408 .It Va mode
 409 .Bd -literal
 410 struct mouse_mode {
 411     int mode;
 412     int signal;
 413 };
 414 .Ed
 415 .Pp
 416 The
 417 .Va signal
 418 field specifies the signal to be delivered to the process.
 419 It must be
 420 one of the values defined in
 421 .In signal.h .
 422 The
 423 .Va mode
 424 field is currently unused.
 425 .Pp
 426 .It Va event
 427 .Bd -literal
 428 struct mouse_event {
 429     int id;
 430     int value;
 431 };
 432 .Ed
 433 .Pp
 434 The
 435 .Va id
 436 field specifies a button number as in
 437 .Va u.data.buttons .
 438 Only one bit/button is set.
 439 The
 440 .Va value
 441 field
 442 holds the click count: the number of times the user has clicked the button
 443 successively.
 444 .El
 445 .El
 446 .Sh FILES
 447 .Bl -tag -width /dev/consolectl -compact
 448 .It Pa /dev/consolectl
 449 device to control the console
 450 .It Pa /dev/sysmouse
 451 virtualized mouse driver
 452 .It Pa /dev/ttyv%d
 453 virtual consoles
 454 .El
 455 .Sh SEE ALSO
 456 .Xr vidcontrol 1 ,
 457 .Xr ioctl 2 ,
 458 .Xr signal 3 ,
 459 .Xr mouse 4 ,
 460 .Xr moused 8
 461 .Sh HISTORY
 462 The
 463 .Nm
 464 driver first appeared in
 465 .Fx 2.2 .
 466 .Sh AUTHORS
 467 .An -nosplit
 468 This
 469 manual page was written by
 470 .An John-Mark Gurney Aq Mt jmg@FreeBSD.org
 471 and
 472 .An Kazutaka Yokota Aq Mt yokota@FreeBSD.org .