1.\" 2.\" Copyright (c) 1997 3.\" Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp> 4.\" All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer as 11.\" the first lines of this file unmodified. 12.\" 2. Redistributions in binary form must reproduce the above copyright 13.\" notice, this list of conditions and the following disclaimer in the 14.\" documentation and/or other materials provided with the distribution. 15.\" 16.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 17.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 18.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 19.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 20.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 21.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 22.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 23.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 24.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 25.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 26.\" 27.\" $FreeBSD$ 28.\" 29.Dd April 8, 2008 30.Dt PSM 4 31.Os 32.Sh NAME 33.Nm psm 34.Nd PS/2 mouse style pointing device driver 35.Sh SYNOPSIS 36.Cd "options KBD_RESETDELAY=N" 37.Cd "options KBD_MAXWAIT=N" 38.Cd "options PSM_DEBUG=N" 39.Cd "options KBDIO_DEBUG=N" 40.Cd "device psm" 41.Pp 42In 43.Pa /boot/device.hints : 44.Cd hint.psm.0.at="atkbdc" 45.Cd hint.psm.0.irq="12" 46.Sh DESCRIPTION 47The 48.Nm 49driver provides support for the PS/2 mouse style pointing device. 50Currently there can be only one 51.Nm 52device node in the system. 53As the PS/2 mouse port is located 54at the auxiliary port of the keyboard controller, 55the keyboard controller driver, 56.Nm atkbdc , 57must also be configured in the kernel. 58Note that there is currently no provision of changing the 59.Em irq 60number. 61.Pp 62Basic PS/2 style pointing device has two or three buttons. 63Some devices may have a roller or a wheel and/or additional buttons. 64.Ss Device Resolution 65The PS/2 style pointing device usually has several grades of resolution, 66that is, sensitivity of movement. 67They are typically 25, 50, 100 and 200 68pulse per inch. 69Some devices may have finer resolution. 70The current resolution can be changed at runtime. 71The 72.Nm 73driver allows the user to initially set the resolution 74via the driver flag 75(see 76.Sx "DRIVER CONFIGURATION" ) 77or change it later via the 78.Xr ioctl 2 79command 80.Dv MOUSE_SETMODE 81(see 82.Sx IOCTLS ) . 83.Ss Report Rate 84Frequency, or report rate, at which the device sends movement 85and button state reports to the host system is also configurable. 86The PS/2 style pointing device typically supports 10, 20, 40, 60, 80, 100 87and 200 reports per second. 8860 or 100 appears to be the default value for many devices. 89Note that when there is no movement and no button has changed its state, 90the device will not send anything to the host system. 91The report rate can be changed via an ioctl call. 92.Ss Operation Levels 93The 94.Nm 95driver has three levels of operation. 96The current operation level can be set via an ioctl call. 97.Pp 98At the level zero the basic support is provided; the device driver will report 99horizontal and vertical movement of the attached device 100and state of up to three buttons. 101The movement and status are encoded in a series of fixed-length data packets 102(see 103.Sx "Data Packet Format" ) . 104This is the default level of operation and the driver is initially 105at this level when opened by the user program. 106.Pp 107The operation level one, the `extended' level, supports a roller (or wheel), 108if any, and up to 11 buttons. 109The movement of the roller is reported as movement along the Z axis. 1108 byte data packets are sent to the user program at this level. 111.Pp 112At the operation level two, data from the pointing device is passed to the 113user program as is. Conversely, command from the user program is passed 114to the pointing device as is and the user program is responsible for 115status validation and error recovery. 116Modern PS/2 type pointing devices often use proprietary data format. 117Therefore, the user program is expected to have 118intimate knowledge about the format from a particular device when operating 119the driver at this level. 120This level is called `native' level. 121.Ss Data Packet Format 122Data packets read from the 123.Nm 124driver are formatted differently at each operation level. 125.Pp 126A data packet from the PS/2 mouse style pointing device 127is three bytes long at the operation level zero: 128.Pp 129.Bl -tag -width Byte_1 -compact 130.It Byte 1 131.Bl -tag -width bit_7 -compact 132.It bit 7 133One indicates overflow in the vertical movement count. 134.It bit 6 135One indicates overflow in the horizontal movement count. 136.It bit 5 137Set if the vertical movement count is negative. 138.It bit 4 139Set if the horizontal movement count is negative. 140.It bit 3 141Always one. 142.\" The ALPS GlidePoint clears this bit when the user `taps' the surface of 143.\" the pad, otherwise the bit is set. 144.\" Most, if not all, other devices always set this bit. 145.It bit 2 146Middle button status; set if pressed. 147For devices without the middle 148button, this bit is always zero. 149.It bit 1 150Right button status; set if pressed. 151.It bit 0 152Left button status; set if pressed. 153.El 154.It Byte 2 155Horizontal movement count in two's complement; 156-256 through 255. 157Note that the sign bit is in the first byte. 158.It Byte 3 159Vertical movement count in two's complement; 160-256 through 255. 161Note that the sign bit is in the first byte. 162.El 163.Pp 164At the level one, a data packet is encoded 165in the standard format 166.Dv MOUSE_PROTO_SYSMOUSE 167as defined in 168.Xr mouse 4 . 169.Pp 170At the level two, native level, there is no standard on the size and format 171of the data packet. 172.Ss Acceleration 173The 174.Nm 175driver can somewhat `accelerate' the movement of the pointing device. 176The faster you move the device, the further the pointer 177travels on the screen. 178The driver has an internal variable which governs the effect of 179the acceleration. 180Its value can be modified via the driver flag 181or via an ioctl call. 182.Sh DRIVER CONFIGURATION 183.Ss Kernel Configuration Options 184There are following kernel configuration options to control the 185.Nm 186driver. 187They may be set in the kernel configuration file 188(see 189.Xr config 8 ) . 190.Bl -tag -width MOUSE 191.It Em KBD_RESETDELAY=X , KBD_MAXWAIT=Y 192The 193.Nm 194driver will attempt to reset the pointing device during the boot process. 195It sometimes takes a long while before the device will respond after 196reset. 197These options control how long the driver should wait before 198it eventually gives up waiting. 199The driver will wait 200.Fa X 201* 202.Fa Y 203msecs at most. 204If the driver seems unable to detect your pointing 205device, you may want to increase these values. 206The default values are 207200 msec for 208.Fa X 209and 5 210for 211.Fa Y . 212.It Em PSM_DEBUG=N , KBDIO_DEBUG=N 213Sets the debug level to 214.Fa N . 215The default debug level is zero. 216See 217.Sx DIAGNOSTICS 218for debug logging. 219.El 220.Ss Driver Flags 221The 222.Nm 223driver accepts the following driver flags. 224Set them in 225.Pa /boot/device.hints 226(see 227.Sx EXAMPLES 228below). 229.Bl -tag -width MOUSE 230.It bit 0..3 RESOLUTION 231This flag specifies the resolution of the pointing device. 232It must be zero through four. 233The greater the value 234is, the finer resolution the device will select. 235Actual resolution selected by this field varies according to the model 236of the device. 237Typical resolutions are: 238.Pp 239.Bl -tag -width 0_(medium_high)__ -compact 240.It Em 1 (low) 24125 pulse per inch (ppi) 242.It Em 2 (medium low) 24350 ppi 244.It Em 3 (medium high) 245100 ppi 246.It Em 4 (high) 247200 ppi 248.El 249.Pp 250Leaving this flag zero will selects the default resolution for the 251device (whatever it is). 252.It bit 4..7 ACCELERATION 253This flag controls the amount of acceleration effect. 254The smaller the value of this flag is, more sensitive the movement becomes. 255The minimum value allowed, thus the value for the most sensitive setting, 256is one. 257Setting this flag to zero will completely disables the 258acceleration effect. 259.It bit 8 NOCHECKSYNC 260The 261.Nm 262driver tries to detect the first byte of the data packet by checking 263the bit pattern of that byte. 264Although this method should work with most 265PS/2 pointing devices, it may interfere with some devices which are not 266so compatible with known devices. 267If you think your pointing device is not functioning as expected, 268and the kernel frequently prints the following message to the console, 269.Bd -literal -offset indent 270psmintr: out of sync (xxxx != yyyy). 271.Ed 272.Pp 273set this flag to disable synchronization check and see if it helps. 274.It bit 9 NOIDPROBE 275The 276.Nm 277driver will not try to identify the model of the pointing device and 278will not carry out model-specific initialization. 279The device should always act like a standard PS/2 mouse without such 280initialization. 281Extra features, such as wheels and additional buttons, will not be 282recognized by the 283.Nm 284driver. 285.It bit 10 NORESET 286When this flag is set, the 287.Nm 288driver will not reset the pointing device when initializing the device. 289If the 290.Fx 291kernel 292is started after another OS has run, the pointing device will inherit 293settings from the previous OS. 294However, because there is no way for the 295.Nm 296driver to know the settings, the device and the driver may not 297work correctly. 298The flag should never be necessary under normal circumstances. 299.It bit 11 FORCETAP 300Some pad devices report as if the fourth button is pressed 301when the user `taps' the surface of the device (see 302.Sx CAVEATS ) . 303This flag will make the 304.Nm 305driver assume that the device behaves this way. 306Without the flag, the driver will assume this behavior 307for ALPS GlidePoint models only. 308.It bit 12 IGNOREPORTERROR 309This flag makes 310.Nm 311driver ignore certain error conditions when probing the PS/2 mouse port. 312It should never be necessary under normal circumstances. 313.It bit 13 HOOKRESUME 314The built-in PS/2 pointing device of some laptop computers is somehow 315not operable immediately after the system `resumes' from 316the power saving mode, 317though it will eventually become available. 318There are reports that 319stimulating the device by performing I/O will help 320waking up the device quickly. 321This flag will enable a piece of code in the 322.Nm 323driver to hook 324the `resume' event and exercise some harmless I/O operations on the 325device. 326.It bit 14 INITAFTERSUSPEND 327This flag adds more drastic action for the above problem. 328It will cause the 329.Nm 330driver to reset and re-initialize the pointing device 331after the `resume' event. 332It has no effect unless the 333.Em HOOKRESUME 334flag is set as well. 335.El 336.Sh LOADER TUNABLES 337Extended support for Synaptics touchpads can be enabled by setting 338.Va hw.psm.synaptics_support 339to 340.Em 1 341at boot-time. 342This will enable 343.Nm 344to handle packets from guest devices (sticks) and extra buttons. 345.Pp 346Tap and drag gestures can be disabled by setting 347.Va hw.psm.tap_enabled 348to 349.Em 0 350at boot-time. 351Currently, this is only supported on Synaptics touchpads with Extended 352support disabled. The behaviour may be changed after boot by setting 353the sysctl with the same name and by restarting 354.Xr moused 8 355using 356.Pa /etc/rc.d/moused . 357.Sh IOCTLS 358There are a few 359.Xr ioctl 2 360commands for mouse drivers. 361These commands and related structures and constants are defined in 362.In sys/mouse.h . 363General description of the commands is given in 364.Xr mouse 4 . 365This section explains the features specific to the 366.Nm 367driver. 368.Pp 369.Bl -tag -width MOUSE -compact 370.It Dv MOUSE_GETLEVEL Ar int *level 371.It Dv MOUSE_SETLEVEL Ar int *level 372These commands manipulate the operation level of the 373.Nm 374driver. 375.Pp 376.It Dv MOUSE_GETHWINFO Ar mousehw_t *hw 377Returns the hardware information of the attached device in the following 378structure. 379.Bd -literal 380typedef struct mousehw { 381 int buttons; /* number of buttons */ 382 int iftype; /* I/F type */ 383 int type; /* mouse/track ball/pad... */ 384 int model; /* I/F dependent model ID */ 385 int hwid; /* I/F dependent hardware ID */ 386} mousehw_t; 387.Ed 388.Pp 389The 390.Dv buttons 391field holds the number of buttons on the device. 392The 393.Nm 394driver currently can detect the 3 button mouse from Logitech and report 395accordingly. 396The 3 button mouse from the other manufacturer may or may not be 397reported correctly. 398However, it will not affect the operation of 399the driver. 400.Pp 401The 402.Dv iftype 403is always 404.Dv MOUSE_IF_PS2 . 405.Pp 406The 407.Dv type 408tells the device type: 409.Dv MOUSE_MOUSE , 410.Dv MOUSE_TRACKBALL , 411.Dv MOUSE_STICK , 412.Dv MOUSE_PAD , 413or 414.Dv MOUSE_UNKNOWN . 415The user should not heavily rely on this field, as the 416driver may not always, in fact it is very rarely able to, identify 417the device type. 418.Pp 419The 420.Dv model 421is always 422.Dv MOUSE_MODEL_GENERIC 423at the operation level 0. 424It may be 425.Dv MOUSE_MODEL_GENERIC 426or one of 427.Dv MOUSE_MODEL_XXX 428constants at higher operation levels. 429Again the 430.Nm 431driver may or may not set an appropriate value in this field. 432.Pp 433The 434.Dv hwid 435is the ID value returned by the device. 436Known IDs include: 437.Pp 438.Bl -tag -width 0__ -compact 439.It Em 0 440Mouse (Microsoft, Logitech and many other manufacturers) 441.It Em 2 442Microsoft Ballpoint mouse 443.It Em 3 444Microsoft IntelliMouse 445.El 446.Pp 447.It Dv MOUSE_SYN_GETHWINFO Ar synapticshw_t *synhw 448Retrieves extra information associated with Synaptics Touchpads. 449Only available when 450.Va hw.psm.synaptics_support 451has been enabled. 452.Bd -literal 453typedef struct synapticshw { 454 int infoMajor; /* major hardware revision */ 455 int infoMinor; /* minor hardware revision */ 456 int infoRot180; /* touchpad is rotated */ 457 int infoPortrait; /* touchpad is a portrait */ 458 int infoSensor; /* sensor model */ 459 int infoHardware; /* hardware model */ 460 int infoNewAbs; /* supports the newabs format */ 461 int capPen; /* can detect a pen */ 462 int infoSimpleC; /* supports simple commands */ 463 int infoGeometry; /* touchpad dimensions */ 464 int capExtended; /* supports extended packets */ 465 int capSleep; /* can be suspended/resumed */ 466 int capFourButtons; /* has four buttons */ 467 int capMultiFinger; /* can detect multiple fingers */ 468 int capPalmDetect; /* can detect a palm */ 469 int capPassthrough; /* can passthrough guest packets */ 470} synapticshw_t; 471.Ed 472.Pp 473See the 474.Em Synaptics TouchPad Interfacing Guide 475for more information about the fields in this structure. 476.Pp 477.It Dv MOUSE_GETMODE Ar mousemode_t *mode 478The command gets the current operation parameters of the mouse 479driver. 480.Bd -literal 481typedef struct mousemode { 482 int protocol; /* MOUSE_PROTO_XXX */ 483 int rate; /* report rate (per sec), -1 if unknown */ 484 int resolution; /* MOUSE_RES_XXX, -1 if unknown */ 485 int accelfactor; /* acceleration factor */ 486 int level; /* driver operation level */ 487 int packetsize; /* the length of the data packet */ 488 unsigned char syncmask[2]; /* sync. bits */ 489} mousemode_t; 490.Ed 491.Pp 492The 493.Dv protocol 494is 495.Dv MOUSE_PROTO_PS2 496at the operation level zero and two. 497.Dv MOUSE_PROTO_SYSMOUSE 498at the operation level one. 499.Pp 500The 501.Dv rate 502is the status report rate (reports/sec) at which the device will send 503movement report to the host computer. 504Typical supported values are 10, 20, 40, 60, 80, 100 and 200. 505Some mice may accept other arbitrary values too. 506.Pp 507The 508.Dv resolution 509of the pointing device must be one of 510.Dv MOUSE_RES_XXX 511constants or a positive value. 512The greater the value 513is, the finer resolution the mouse will select. 514Actual resolution selected by the 515.Dv MOUSE_RES_XXX 516constant varies according to the model of mouse. 517Typical resolutions are: 518.Pp 519.Bl -tag -width MOUSE_RES_MEDIUMHIGH__ -compact 520.It Dv MOUSE_RES_LOW 52125 ppi 522.It Dv MOUSE_RES_MEDIUMLOW 52350 ppi 524.It Dv MOUSE_RES_MEDIUMHIGH 525100 ppi 526.It Dv MOUSE_RES_HIGH 527200 ppi 528.El 529.Pp 530The 531.Dv accelfactor 532field holds a value to control acceleration feature 533(see 534.Sx Acceleration ) . 535It must be zero or greater. 536If it is zero, acceleration is disabled. 537.Pp 538The 539.Dv packetsize 540field specifies the length of the data packet. 541It depends on the 542operation level and the model of the pointing device. 543.Pp 544.Bl -tag -width level_0__ -compact 545.It Em level 0 5463 bytes 547.It Em level 1 5488 bytes 549.It Em level 2 550Depends on the model of the device 551.El 552.Pp 553The array 554.Dv syncmask 555holds a bit mask and pattern to detect the first byte of the 556data packet. 557.Dv syncmask[0] 558is the bit mask to be ANDed with a byte. 559If the result is equal to 560.Dv syncmask[1] , 561the byte is likely to be the first byte of the data packet. 562Note that this detection method is not 100% reliable, 563thus, should be taken only as an advisory measure. 564.Pp 565.It Dv MOUSE_SETMODE Ar mousemode_t *mode 566The command changes the current operation parameters of the mouse driver 567as specified in 568.Ar mode . 569Only 570.Dv rate , 571.Dv resolution , 572.Dv level 573and 574.Dv accelfactor 575may be modifiable. 576Setting values in the other field does not generate 577error and has no effect. 578.Pp 579If you do not want to change the current setting of a field, put -1 580there. 581You may also put zero in 582.Dv resolution 583and 584.Dv rate , 585and the default value for the fields will be selected. 586.\" .Pp 587.\" .It Dv MOUSE_GETVARS Ar mousevar_t *vars 588.\" .It Dv MOUSE_SETVARS Ar mousevar_t *vars 589.\" These commands are not supported by the 590.\" .Nm 591.\" driver. 592.Pp 593.It Dv MOUSE_READDATA Ar mousedata_t *data 594.\" The command reads the raw data from the device. 595.\" .Bd -literal 596.\" typedef struct mousedata { 597.\" int len; /* # of data in the buffer */ 598.\" int buf[16]; /* data buffer */ 599.\" } mousedata_t; 600.\" .Ed 601.\" .Pp 602.\" Upon returning to the user program, the driver will place the number 603.\" of valid data bytes in the buffer in the 604.\" .Dv len 605.\" field. 606.\" .Pp 607.It Dv MOUSE_READSTATE Ar mousedata_t *state 608.\" The command reads the hardware settings from the device. 609.\" Upon returning to the user program, the driver will place the number 610.\" of valid data bytes in the buffer in the 611.\" .Dv len 612.\" field. It is usually 3 bytes. 613.\" The buffer is formatted as follows: 614.\" .Pp 615.\" .Bl -tag -width Byte_1 -compact 616.\" .It Byte 1 617.\" .Bl -tag -width bit_6 -compact 618.\" .It bit 7 619.\" Reserved. 620.\" .It bit 6 621.\" 0 - stream mode, 1 - remote mode. 622.\" In the stream mode, the pointing device sends the device status 623.\" whenever its state changes. In the remote mode, the host computer 624.\" must request the status to be sent. 625.\" The 626.\" .Nm 627.\" driver puts the device in the stream mode. 628.\" .It bit 5 629.\" Set if the pointing device is currently enabled. Otherwise zero. 630.\" .It bit 4 631.\" 0 - 1:1 scaling, 1 - 2:1 scaling. 632.\" 1:1 scaling is the default. 633.\" .It bit 3 634.\" Reserved. 635.\" .It bit 2 636.\" Left button status; set if pressed. 637.\" .It bit 1 638.\" Middle button status; set if pressed. 639.\" .It bit 0 640.\" Right button status; set if pressed. 641.\" .El 642.\" .It Byte 2 643.\" .Bl -tag -width bit_6_0 -compact 644.\" .It bit 7 645.\" Reserved. 646.\" .It bit 6..0 647.\" Resolution code: zero through three. Actual resolution for 648.\" the resolution code varies from one device to another. 649.\" .El 650.\" .It Byte 3 651.\" The status report rate (reports/sec) at which the device will send 652.\" movement report to the host computer. 653.\" .El 654These commands are not currently supported by the 655.Nm 656driver. 657.Pp 658.It Dv MOUSE_GETSTATUS Ar mousestatus_t *status 659The command returns the current state of buttons and 660movement counts as described in 661.Xr mouse 4 . 662.El 663.Sh FILES 664.Bl -tag -width /dev/npsm0 -compact 665.It Pa /dev/psm0 666`non-blocking' device node 667.It Pa /dev/bpsm0 668`blocking' device node 669.El 670.Sh EXAMPLES 671In order to install the 672.Nm 673driver, you need to add 674.Pp 675.Dl "device atkbdc" 676.Dl "device psm" 677.Pp 678to your kernel configuration file, and put the following lines to 679.Pa /boot/device.hints . 680.Pp 681.Dl hint.atkbdc.0.at="isa" 682.Dl hint.atkbdc.0.port="0x060" 683.Dl hint.psm.0.at="atkbdc" 684.Dl hint.psm.0.irq="12" 685.Pp 686If you add the following statement to 687.Pa /boot/device.hints , 688.Pp 689.Dl hint.psm.0.flags="0x2000" 690.Pp 691you will add the optional code to stimulate the pointing device 692after the `resume' event. 693.Pp 694.Dl hint.psm.0.flags="0x24" 695.Pp 696The above line will set the device resolution high (4) 697and the acceleration factor to 2. 698.Sh DIAGNOSTICS 699At debug level 0, little information is logged except for the following 700line during boot process: 701.Bd -literal -offset indent 702psm0: device ID X 703.Ed 704.Pp 705where 706.Fa X 707the device ID code returned by the found pointing device. 708See 709.Dv MOUSE_GETINFO 710for known IDs. 711.Pp 712At debug level 1 more information will be logged 713while the driver probes the auxiliary port (mouse port). 714Messages are logged with the LOG_KERN facility at the LOG_DEBUG level 715(see 716.Xr syslogd 8 ) . 717.Bd -literal -offset indent 718psm0: current command byte:xxxx 719kbdio: TEST_AUX_PORT status:0000 720kbdio: RESET_AUX return code:00fa 721kbdio: RESET_AUX status:00aa 722kbdio: RESET_AUX ID:0000 723[...] 724psm: status 00 02 64 725psm0 irq 12 on isa 726psm0: model AAAA, device ID X, N buttons 727psm0: config:00000www, flags:0000uuuu, packet size:M 728psm0: syncmask:xx, syncbits:yy 729.Ed 730.Pp 731The first line shows the command byte value of the keyboard 732controller just before the auxiliary port is probed. 733It usually is 4D, 45, 47 or 65, depending on how the motherboard BIOS 734initialized the keyboard controller upon power-up. 735.Pp 736The second line shows the result of the keyboard controller's 737test on the auxiliary port interface, with zero indicating 738no error; note that some controllers report no error even if 739the port does not exist in the system, however. 740.Pp 741The third through fifth lines show the reset status of the pointing device. 742The functioning device should return the sequence of FA AA <ID>. 743The ID code is described above. 744.Pp 745The seventh line shows the current hardware settings. 746.\" See 747.\" .Dv MOUSE_READSTATE 748.\" for definitions. 749These bytes are formatted as follows: 750.Pp 751.Bl -tag -width Byte_1 -compact 752.It Byte 1 753.Bl -tag -width bit_6 -compact 754.It bit 7 755Reserved. 756.It bit 6 7570 - stream mode, 1 - remote mode. 758In the stream mode, the pointing device sends the device status 759whenever its state changes. 760In the remote mode, the host computer 761must request the status to be sent. 762The 763.Nm 764driver puts the device in the stream mode. 765.It bit 5 766Set if the pointing device is currently enabled. 767Otherwise zero. 768.It bit 4 7690 - 1:1 scaling, 1 - 2:1 scaling. 7701:1 scaling is the default. 771.It bit 3 772Reserved. 773.It bit 2 774Left button status; set if pressed. 775.It bit 1 776Middle button status; set if pressed. 777.It bit 0 778Right button status; set if pressed. 779.El 780.It Byte 2 781.Bl -tag -width bit_6_0 -compact 782.It bit 7 783Reserved. 784.It bit 6..0 785Resolution code: zero through three. 786Actual resolution for 787the resolution code varies from one device to another. 788.El 789.It Byte 3 790The status report rate (reports/sec) at which the device will send 791movement report to the host computer. 792.El 793.Pp 794Note that the pointing device will not be enabled until the 795.Nm 796driver is opened by the user program. 797.Pp 798The rest of the lines show the device ID code, the number of detected 799buttons and internal variables. 800.Pp 801At debug level 2, much more detailed information is logged. 802.Sh SEE ALSO 803.Xr ioctl 2 , 804.Xr syslog 3 , 805.Xr atkbdc 4 , 806.Xr mouse 4 , 807.Xr mse 4 , 808.Xr sysmouse 4 , 809.Xr moused 8 , 810.Xr syslogd 8 811.Rs 812.%T Synaptics TouchPad Interfacing Guide 813.%U http://www.synaptics.com/ 814.Re 815.\".Sh HISTORY 816.Sh AUTHORS 817.An -nosplit 818The 819.Nm 820driver is based on the work done by quite a number of people, including 821.An Eric Forsberg , 822.An Sandi Donno , 823.An Rick Macklem , 824.An Andrew Herbert , 825.An Charles Hannum , 826.An Shoji Yuen 827and 828.An Kazutaka Yokota 829to name the few. 830.Pp 831This manual page was written by 832.An Kazutaka Yokota Aq yokota@FreeBSD.org . 833.Sh CAVEATS 834Many pad devices behave as if the first (left) button were pressed if 835the user `taps' the surface of the pad. 836In contrast, some pad products, e.g.\& some versions of ALPS GlidePoint 837and Interlink VersaPad, treat the tapping action 838as fourth button events. 839.Pp 840It is reported that Interlink VersaPad requires both 841.Em HOOKRESUME 842and 843.Em INITAFTERSUSPEND 844flags in order to recover from suspended state. 845These flags are automatically set when VersaPad is detected by the 846.Nm 847driver. 848.Pp 849Some PS/2 mouse models from MouseSystems require to be put in the 850high resolution mode to work properly. 851Use the driver flag to 852set resolution. 853.Pp 854There is not a guaranteed way to re-synchronize with the first byte 855of the packet once we are out of synchronization with the data 856stream. 857However, if you are using the \fIXFree86\fP server and experiencing 858the problem, you may be able to make the X server synchronize with the mouse 859by switching away to a virtual terminal and getting back to the X server, 860unless the X server is accessing the mouse via 861.Xr moused 8 . 862Clicking any button without moving the mouse may also work. 863.Sh BUGS 864The ioctl command 865.Dv MOUSEIOCREAD 866has been removed. 867It was never functional anyway. 868.Pp 869Enabling the extended support for Synaptics touchpads has been reported to 870cause problems with responsivity on some (newer) models of Synaptics 871hardware, particularly those with guest devices. 872