3 .\" Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp>
4 .\" All rights reserved.
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
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.
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.
34 .Nd PS/2 mouse style pointing device driver
36 .Cd "options KBD_RESETDELAY=N"
37 .Cd "options KBD_MAXWAIT=N"
38 .Cd "options PSM_DEBUG=N"
39 .Cd "options KBDIO_DEBUG=N"
43 .Pa /boot/device.hints :
44 .Cd hint.psm.0.at="atkbdc"
45 .Cd hint.psm.0.irq="12"
49 driver provides support for the PS/2 mouse style pointing device.
50 Currently there can be only one
52 device node in the system.
53 As the PS/2 mouse port is located
54 at the auxiliary port of the keyboard controller,
55 the keyboard controller driver,
57 must also be configured in the kernel.
58 Note that there is currently no provision of changing the
62 Basic PS/2 style pointing device has two or three buttons.
63 Some devices may have a roller or a wheel and/or additional buttons.
65 The PS/2 style pointing device usually has several grades of resolution,
66 that is, sensitivity of movement.
67 They are typically 25, 50, 100 and 200
69 Some devices may have finer resolution.
70 The current resolution can be changed at runtime.
73 driver allows the user to initially set the resolution
76 .Sx "DRIVER CONFIGURATION" )
77 or change it later via the
84 Frequency, or report rate, at which the device sends movement
85 and button state reports to the host system is also configurable.
86 The PS/2 style pointing device typically supports 10, 20, 40, 60, 80, 100
87 and 200 reports per second.
88 60 or 100 appears to be the default value for many devices.
89 Note that when there is no movement and no button has changed its state,
90 the device will not send anything to the host system.
91 The report rate can be changed via an ioctl call.
95 driver has three levels of operation.
96 The current operation level can be set via an ioctl call.
98 At the level zero the basic support is provided; the device driver will report
99 horizontal and vertical movement of the attached device
100 and state of up to three buttons.
101 The movement and status are encoded in a series of fixed-length data packets
103 .Sx "Data Packet Format" ) .
104 This is the default level of operation and the driver is initially
105 at this level when opened by the user program.
107 The operation level one, the `extended' level, supports a roller (or wheel),
108 if any, and up to 11 buttons.
109 The movement of the roller is reported as movement along the Z axis.
110 8 byte data packets are sent to the user program at this level.
112 At the operation level two, data from the pointing device is passed to the
113 user program as is. Conversely, command from the user program is passed
114 to the pointing device as is and the user program is responsible for
115 status validation and error recovery.
116 Modern PS/2 type pointing devices often use proprietary data format.
117 Therefore, the user program is expected to have
118 intimate knowledge about the format from a particular device when operating
119 the driver at this level.
120 This level is called `native' level.
121 .Ss Data Packet Format
122 Data packets read from the
124 driver are formatted differently at each operation level.
126 A data packet from the PS/2 mouse style pointing device
127 is three bytes long at the operation level zero:
129 .Bl -tag -width Byte_1 -compact
131 .Bl -tag -width bit_7 -compact
133 One indicates overflow in the vertical movement count.
135 One indicates overflow in the horizontal movement count.
137 Set if the vertical movement count is negative.
139 Set if the horizontal movement count is negative.
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.
146 Middle button status; set if pressed.
147 For devices without the middle
148 button, this bit is always zero.
150 Right button status; set if pressed.
152 Left button status; set if pressed.
155 Horizontal movement count in two's complement;
157 Note that the sign bit is in the first byte.
159 Vertical movement count in two's complement;
161 Note that the sign bit is in the first byte.
164 At the level one, a data packet is encoded
165 in the standard format
166 .Dv MOUSE_PROTO_SYSMOUSE
170 At the level two, native level, there is no standard on the size and format
175 driver can somewhat `accelerate' the movement of the pointing device.
176 The faster you move the device, the further the pointer
177 travels on the screen.
178 The driver has an internal variable which governs the effect of
180 Its value can be modified via the driver flag
181 or via an ioctl call.
183 The minor device number of the
186 .Bd -literal -offset indent
187 minor = (`unit' << 1) | `non-blocking'
190 where `unit' is the device number (usually 0) and the `non-blocking' bit
191 is set to indicate ``do not block waiting for mouse input,
192 return immediately''.
193 The `non-blocking' bit should be set for \fIXFree86\fP,
194 therefore the minor device number usually used for \fIXFree86\fP is 1.
197 for device node names.
198 .Sh DRIVER CONFIGURATION
199 .Ss Kernel Configuration Options
200 There are following kernel configuration options to control the
203 They may be set in the kernel configuration file
206 .Bl -tag -width MOUSE
207 .It Em KBD_RESETDELAY=X , KBD_MAXWAIT=Y
210 driver will attempt to reset the pointing device during the boot process.
211 It sometimes takes a long while before the device will respond after
213 These options control how long the driver should wait before
214 it eventually gives up waiting.
220 If the driver seems unable to detect your pointing
221 device, you may want to increase these values.
222 The default values are
228 .It Em PSM_DEBUG=N , KBDIO_DEBUG=N
229 Sets the debug level to
231 The default debug level is zero.
239 driver accepts the following driver flags.
241 .Pa /boot/device.hints
246 .Bl -tag -width MOUSE
247 .It bit 0..3 RESOLUTION
248 This flag specifies the resolution of the pointing device.
249 It must be zero through four.
250 The greater the value
251 is, the finer resolution the device will select.
252 Actual resolution selected by this field varies according to the model
254 Typical resolutions are:
256 .Bl -tag -width 0_(medium_high)__ -compact
258 25 pulse per inch (ppi)
259 .It Em 2 (medium low)
261 .It Em 3 (medium high)
267 Leaving this flag zero will selects the default resolution for the
268 device (whatever it is).
269 .It bit 4..7 ACCELERATION
270 This flag controls the amount of acceleration effect.
271 The smaller the value of this flag is, more sensitive the movement becomes.
272 The minimum value allowed, thus the value for the most sensitive setting,
274 Setting this flag to zero will completely disables the
276 .It bit 8 NOCHECKSYNC
279 driver tries to detect the first byte of the data packet by checking
280 the bit pattern of that byte.
281 Although this method should work with most
282 PS/2 pointing devices, it may interfere with some devices which are not
283 so compatible with known devices.
284 If you think your pointing device is not functioning as expected,
285 and the kernel frequently prints the following message to the console,
286 .Bd -literal -offset indent
287 psmintr: out of sync (xxxx != yyyy).
290 set this flag to disable synchronization check and see if it helps.
294 driver will not try to identify the model of the pointing device and
295 will not carry out model-specific initialization.
296 The device should always act like a standard PS/2 mouse without such
298 Extra features, such as wheels and additional buttons, will not be
303 When this flag is set, the
305 driver will not reset the pointing device when initializing the device.
309 is started after another OS has run, the pointing device will inherit
310 settings from the previous OS.
311 However, because there is no way for the
313 driver to know the settings, the device and the driver may not
315 The flag should never be necessary under normal circumstances.
317 Some pad devices report as if the fourth button is pressed
318 when the user `taps' the surface of the device (see
320 This flag will make the
322 driver assume that the device behaves this way.
323 Without the flag, the driver will assume this behavior
324 for ALPS GlidePoint models only.
325 .It bit 12 IGNOREPORTERROR
328 driver ignore certain error conditions when probing the PS/2 mouse port.
329 It should never be necessary under normal circumstances.
330 .It bit 13 HOOKRESUME
331 The built-in PS/2 pointing device of some laptop computers is somehow
332 not operable immediately after the system `resumes' from
333 the power saving mode,
334 though it will eventually become available.
335 There are reports that
336 stimulating the device by performing I/O will help
337 waking up the device quickly.
338 This flag will enable a piece of code in the
341 the `resume' event and exercise some harmless I/O operations on the
343 .It bit 14 INITAFTERSUSPEND
344 This flag adds more drastic action for the above problem.
347 driver to reset and re-initialize the pointing device
348 after the `resume' event.
349 It has no effect unless the
354 Extended support for Synaptics touchpads can be enabled by setting
355 .Va hw.psm.synaptics_support
361 to handle packets from guest devices (sticks) and extra buttons.
363 Tap and drag gestures can be disabled by setting
364 .Va hw.psm.tap_enabled
368 Currently, this is only supported on Synaptics touchpads with Extended
369 support disabled. The behaviour may be changed after boot by setting
370 the sysctl with the same name and by restarting
373 .Pa /etc/rc.d/moused .
377 commands for mouse drivers.
378 These commands and related structures and constants are defined in
380 General description of the commands is given in
382 This section explains the features specific to the
386 .Bl -tag -width MOUSE -compact
387 .It Dv MOUSE_GETLEVEL Ar int *level
388 .It Dv MOUSE_SETLEVEL Ar int *level
389 These commands manipulate the operation level of the
393 .It Dv MOUSE_GETHWINFO Ar mousehw_t *hw
394 Returns the hardware information of the attached device in the following
397 typedef struct mousehw {
398 int buttons; /* number of buttons */
399 int iftype; /* I/F type */
400 int type; /* mouse/track ball/pad... */
401 int model; /* I/F dependent model ID */
402 int hwid; /* I/F dependent hardware ID */
408 field holds the number of buttons on the device.
411 driver currently can detect the 3 button mouse from Logitech and report
413 The 3 button mouse from the other manufacturer may or may not be
415 However, it will not affect the operation of
425 tells the device type:
427 .Dv MOUSE_TRACKBALL ,
432 The user should not heavily rely on this field, as the
433 driver may not always, in fact it is very rarely able to, identify
439 .Dv MOUSE_MODEL_GENERIC
440 at the operation level 0.
442 .Dv MOUSE_MODEL_GENERIC
445 constants at higher operation levels.
448 driver may or may not set an appropriate value in this field.
452 is the ID value returned by the device.
455 .Bl -tag -width 0__ -compact
457 Mouse (Microsoft, Logitech and many other manufacturers)
459 Microsoft Ballpoint mouse
461 Microsoft IntelliMouse
464 .It Dv MOUSE_SYN_GETHWINFO Ar synapticshw_t *synhw
465 Retrieves extra information associated with Synaptics Touchpads.
467 .Va hw.psm.synaptics_support
470 typedef struct synapticshw {
471 int infoMajor; /* major hardware revision */
472 int infoMinor; /* minor hardware revision */
473 int infoRot180; /* touchpad is rotated */
474 int infoPortrait; /* touchpad is a portrait */
475 int infoSensor; /* sensor model */
476 int infoHardware; /* hardware model */
477 int infoNewAbs; /* supports the newabs format */
478 int capPen; /* can detect a pen */
479 int infoSimpleC; /* supports simple commands */
480 int infoGeometry; /* touchpad dimensions */
481 int capExtended; /* supports extended packets */
482 int capSleep; /* can be suspended/resumed */
483 int capFourButtons; /* has four buttons */
484 int capMultiFinger; /* can detect multiple fingers */
485 int capPalmDetect; /* can detect a palm */
486 int capPassthrough; /* can passthrough guest packets */
491 .Em Synaptics TouchPad Interfacing Guide
492 for more information about the fields in this structure.
494 .It Dv MOUSE_GETMODE Ar mousemode_t *mode
495 The command gets the current operation parameters of the mouse
498 typedef struct mousemode {
499 int protocol; /* MOUSE_PROTO_XXX */
500 int rate; /* report rate (per sec), -1 if unknown */
501 int resolution; /* MOUSE_RES_XXX, -1 if unknown */
502 int accelfactor; /* acceleration factor */
503 int level; /* driver operation level */
504 int packetsize; /* the length of the data packet */
505 unsigned char syncmask[2]; /* sync. bits */
513 at the operation level zero and two.
514 .Dv MOUSE_PROTO_SYSMOUSE
515 at the operation level one.
519 is the status report rate (reports/sec) at which the device will send
520 movement report to the host computer.
521 Typical supported values are 10, 20, 40, 60, 80, 100 and 200.
522 Some mice may accept other arbitrary values too.
526 of the pointing device must be one of
528 constants or a positive value.
529 The greater the value
530 is, the finer resolution the mouse will select.
531 Actual resolution selected by the
533 constant varies according to the model of mouse.
534 Typical resolutions are:
536 .Bl -tag -width MOUSE_RES_MEDIUMHIGH__ -compact
539 .It Dv MOUSE_RES_MEDIUMLOW
541 .It Dv MOUSE_RES_MEDIUMHIGH
543 .It Dv MOUSE_RES_HIGH
549 field holds a value to control acceleration feature
552 It must be zero or greater.
553 If it is zero, acceleration is disabled.
557 field specifies the length of the data packet.
559 operation level and the model of the pointing device.
561 .Bl -tag -width level_0__ -compact
567 Depends on the model of the device
572 holds a bit mask and pattern to detect the first byte of the
575 is the bit mask to be ANDed with a byte.
576 If the result is equal to
578 the byte is likely to be the first byte of the data packet.
579 Note that this detection method is not 100% reliable,
580 thus, should be taken only as an advisory measure.
582 .It Dv MOUSE_SETMODE Ar mousemode_t *mode
583 The command changes the current operation parameters of the mouse driver
593 Setting values in the other field does not generate
594 error and has no effect.
596 If you do not want to change the current setting of a field, put -1
598 You may also put zero in
602 and the default value for the fields will be selected.
604 .\" .It Dv MOUSE_GETVARS Ar mousevar_t *vars
605 .\" .It Dv MOUSE_SETVARS Ar mousevar_t *vars
606 .\" These commands are not supported by the
610 .It Dv MOUSE_READDATA Ar mousedata_t *data
611 .\" The command reads the raw data from the device.
613 .\" typedef struct mousedata {
614 .\" int len; /* # of data in the buffer */
615 .\" int buf[16]; /* data buffer */
619 .\" Upon returning to the user program, the driver will place the number
620 .\" of valid data bytes in the buffer in the
624 .It Dv MOUSE_READSTATE Ar mousedata_t *state
625 .\" The command reads the hardware settings from the device.
626 .\" Upon returning to the user program, the driver will place the number
627 .\" of valid data bytes in the buffer in the
629 .\" field. It is usually 3 bytes.
630 .\" The buffer is formatted as follows:
632 .\" .Bl -tag -width Byte_1 -compact
634 .\" .Bl -tag -width bit_6 -compact
638 .\" 0 - stream mode, 1 - remote mode.
639 .\" In the stream mode, the pointing device sends the device status
640 .\" whenever its state changes. In the remote mode, the host computer
641 .\" must request the status to be sent.
644 .\" driver puts the device in the stream mode.
646 .\" Set if the pointing device is currently enabled. Otherwise zero.
648 .\" 0 - 1:1 scaling, 1 - 2:1 scaling.
649 .\" 1:1 scaling is the default.
653 .\" Left button status; set if pressed.
655 .\" Middle button status; set if pressed.
657 .\" Right button status; set if pressed.
660 .\" .Bl -tag -width bit_6_0 -compact
664 .\" Resolution code: zero through three. Actual resolution for
665 .\" the resolution code varies from one device to another.
668 .\" The status report rate (reports/sec) at which the device will send
669 .\" movement report to the host computer.
671 These commands are not currently supported by the
675 .It Dv MOUSE_GETSTATUS Ar mousestatus_t *status
676 The command returns the current state of buttons and
677 movement counts as described in
681 .Bl -tag -width /dev/npsm0 -compact
683 `non-blocking' device node
685 `blocking' device node under
689 In order to install the
691 driver, you need to add
696 to your kernel configuration file, and put the following lines to
697 .Pa /boot/device.hints .
699 .Dl hint.atkbdc.0.at="isa"
700 .Dl hint.atkbdc.0.port="0x060"
701 .Dl hint.psm.0.at="atkbdc"
702 .Dl hint.psm.0.irq="12"
704 If you add the following statement to
705 .Pa /boot/device.hints ,
707 .Dl hint.psm.0.flags="0x2000"
709 you will add the optional code to stimulate the pointing device
710 after the `resume' event.
712 .Dl hint.psm.0.flags="0x24"
714 The above line will set the device resolution high (4)
715 and the acceleration factor to 2.
717 At debug level 0, little information is logged except for the following
718 line during boot process:
719 .Bd -literal -offset indent
725 the device ID code returned by the found pointing device.
730 At debug level 1 more information will be logged
731 while the driver probes the auxiliary port (mouse port).
732 Messages are logged with the LOG_KERN facility at the LOG_DEBUG level
735 .Bd -literal -offset indent
736 psm0: current command byte:xxxx
737 kbdio: TEST_AUX_PORT status:0000
738 kbdio: RESET_AUX return code:00fa
739 kbdio: RESET_AUX status:00aa
740 kbdio: RESET_AUX ID:0000
744 psm0: model AAAA, device ID X, N buttons
745 psm0: config:00000www, flags:0000uuuu, packet size:M
746 psm0: syncmask:xx, syncbits:yy
749 The first line shows the command byte value of the keyboard
750 controller just before the auxiliary port is probed.
751 It usually is 4D, 45, 47 or 65, depending on how the motherboard BIOS
752 initialized the keyboard controller upon power-up.
754 The second line shows the result of the keyboard controller's
755 test on the auxiliary port interface, with zero indicating
756 no error; note that some controllers report no error even if
757 the port does not exist in the system, however.
759 The third through fifth lines show the reset status of the pointing device.
760 The functioning device should return the sequence of FA AA <ID>.
761 The ID code is described above.
763 The seventh line shows the current hardware settings.
765 .\" .Dv MOUSE_READSTATE
767 These bytes are formatted as follows:
769 .Bl -tag -width Byte_1 -compact
771 .Bl -tag -width bit_6 -compact
775 0 - stream mode, 1 - remote mode.
776 In the stream mode, the pointing device sends the device status
777 whenever its state changes.
778 In the remote mode, the host computer
779 must request the status to be sent.
782 driver puts the device in the stream mode.
784 Set if the pointing device is currently enabled.
787 0 - 1:1 scaling, 1 - 2:1 scaling.
788 1:1 scaling is the default.
792 Left button status; set if pressed.
794 Middle button status; set if pressed.
796 Right button status; set if pressed.
799 .Bl -tag -width bit_6_0 -compact
803 Resolution code: zero through three.
804 Actual resolution for
805 the resolution code varies from one device to another.
808 The status report rate (reports/sec) at which the device will send
809 movement report to the host computer.
812 Note that the pointing device will not be enabled until the
814 driver is opened by the user program.
816 The rest of the lines show the device ID code, the number of detected
817 buttons and internal variables.
819 At debug level 2, much more detailed information is logged.
821 Many pad devices behave as if the first (left) button were pressed if
822 the user `taps' the surface of the pad.
823 In contrast, some pad products, e.g.\& some versions of ALPS GlidePoint
824 and Interlink VersaPad, treat the tapping action
825 as fourth button events.
827 It is reported that Interlink VersaPad requires both
831 flags in order to recover from suspended state.
832 These flags are automatically set when VersaPad is detected by the
836 Some PS/2 mouse models from MouseSystems require to be put in the
837 high resolution mode to work properly.
838 Use the driver flag to
841 There is not a guaranteed way to re-synchronize with the first byte
842 of the packet once we are out of synchronization with the data
844 However, if you are using the \fIXFree86\fP server and experiencing
845 the problem, you may be able to make the X server synchronize with the mouse
846 by switching away to a virtual terminal and getting back to the X server,
847 unless the X server is accessing the mouse via
849 Clicking any button without moving the mouse may also work.
860 .%T Synaptics TouchPad Interfacing Guide
861 .%U http://www.synaptics.com/
868 driver is based on the work done by quite a number of people, including
879 This manual page was written by
880 .An Kazutaka Yokota Aq yokota@FreeBSD.org .
885 It was never functional anyway.
887 Enabling the extended support for Synaptics touchpads has been reported to
888 cause problems with responsivity on some (newer) models of Synaptics
889 hardware, particularly those with guest devices.