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.
29 .Dd September 29, 2004
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 won't 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
114 Modern PS/2 type pointing devices often use proprietary data format.
115 Therefore, the user program is expected to have
116 intimate knowledge about the format from a particular device when operating
117 the driver at this level.
118 This level is called `native' level.
119 .Ss Data Packet Format
120 Data packets read from the
122 driver are formatted differently at each operation level.
124 A data packet from the PS/2 mouse style pointing device
125 is three bytes long at the operation level zero:
127 .Bl -tag -width Byte_1 -compact
129 .Bl -tag -width bit_7 -compact
131 One indicates overflow in the vertical movement count.
133 One indicates overflow in the horizontal movement count.
135 Set if the vertical movement count is negative.
137 Set if the horizontal movement count is negative.
140 .\" The ALPS GlidePoint clears this bit when the user `taps' the surface of
141 .\" the pad, otherwise the bit is set.
142 .\" Most, if not all, other devices always set this bit.
144 Middle button status; set if pressed.
145 For devices without the middle
146 button, this bit is always zero.
148 Right button status; set if pressed.
150 Left button status; set if pressed.
153 Horizontal movement count in two's complement;
155 Note that the sign bit is in the first byte.
157 Vertical movement count in two's complement;
159 Note that the sign bit is in the first byte.
162 At the level one, a data packet is encoded
163 in the standard format
164 .Dv MOUSE_PROTO_SYSMOUSE
168 At the level two, native level, there is no standard on the size and format
173 driver can somewhat `accelerate' the movement of the pointing device.
174 The faster you move the device, the further the pointer
175 travels on the screen.
176 The driver has an internal variable which governs the effect of
178 Its value can be modified via the driver flag
179 or via an ioctl call.
181 The minor device number of the
184 .Bd -literal -offset indent
185 minor = (`unit' << 1) | `non-blocking'
188 where `unit' is the device number (usually 0) and the `non-blocking' bit
189 is set to indicate ``don't block waiting for mouse input,
190 return immediately''.
191 The `non-blocking' bit should be set for \fIXFree86\fP,
192 therefore the minor device number usually used for \fIXFree86\fP is 1.
195 for device node names.
196 .Sh DRIVER CONFIGURATION
197 .Ss Kernel Configuration Options
198 There are following kernel configuration options to control the
201 They may be set in the kernel configuration file
204 .Bl -tag -width MOUSE
205 .It Em KBD_RESETDELAY=X , KBD_MAXWAIT=Y
208 driver will attempt to reset the pointing device during the boot process.
209 It sometimes takes a long while before the device will respond after
211 These options control how long the driver should wait before
212 it eventually gives up waiting.
218 If the driver seems unable to detect your pointing
219 device, you may want to increase these values.
220 The default values are
226 .It Em PSM_DEBUG=N , KBDIO_DEBUG=N
227 Sets the debug level to
229 The default debug level is zero.
237 driver accepts the following driver flags.
239 .Pa /boot/device.hints
244 .Bl -tag -width MOUSE
245 .It bit 0..3 RESOLUTION
246 This flag specifies the resolution of the pointing device.
247 It must be zero through four.
248 The greater the value
249 is, the finer resolution the device will select.
250 Actual resolution selected by this field varies according to the model
252 Typical resolutions are:
254 .Bl -tag -width 0_(medium_high)__ -compact
256 25 pulse per inch (ppi)
257 .It Em 2 (medium low)
259 .It Em 3 (medium high)
265 Leaving this flag zero will selects the default resolution for the
266 device (whatever it is).
267 .It bit 4..7 ACCELERATION
268 This flag controls the amount of acceleration effect.
269 The smaller the value of this flag is, more sensitive the movement becomes.
270 The minimum value allowed, thus the value for the most sensitive setting,
272 Setting this flag to zero will completely disables the
274 .It bit 8 NOCHECKSYNC
277 driver tries to detect the first byte of the data packet by checking
278 the bit pattern of that byte.
279 Although this method should work with most
280 PS/2 pointing devices, it may interfere with some devices which are not
281 so compatible with known devices.
282 If you think your pointing device is not functioning as expected,
283 and the kernel frequently prints the following message to the console,
284 .Bd -literal -offset indent
285 psmintr: out of sync (xxxx != yyyy).
288 set this flag to disable synchronization check and see if it helps.
292 driver will not try to identify the model of the pointing device and
293 will not carry out model-specific initialization.
294 The device should always act like a standard PS/2 mouse without such
296 Extra features, such as wheels and additional buttons, won't be
301 When this flag is set, the
303 driver won't reset the pointing device when initializing the device.
307 is started after another OS has run, the pointing device will inherit
308 settings from the previous OS.
309 However, because there is no way for the
311 driver to know the settings, the device and the driver may not
313 The flag should never be necessary under normal circumstances.
315 Some pad devices report as if the fourth button is pressed
316 when the user `taps' the surface of the device (see
318 This flag will make the
320 driver assume that the device behaves this way.
321 Without the flag, the driver will assume this behavior
322 for ALPS GlidePoint models only.
323 .It bit 12 IGNOREPORTERROR
326 driver ignore certain error conditions when probing the PS/2 mouse port.
327 It should never be necessary under normal circumstances.
328 .It bit 13 HOOKRESUME
329 The built-in PS/2 pointing device of some laptop computers is somehow
330 not operable immediately after the system `resumes' from
331 the power saving mode,
332 though it will eventually become available.
333 There are reports that
334 stimulating the device by performing I/O will help
335 waking up the device quickly.
336 This flag will enable a piece of code in the
339 the `resume' event and exercise some harmless I/O operations on the
341 .It bit 14 INITAFTERSUSPEND
342 This flag adds more drastic action for the above problem.
345 driver to reset and re-initialize the pointing device
346 after the `resume' event.
347 It has no effect unless the
352 Extended support for Synaptics touchpads can be enabled by setting
353 .Va hw.psm.synaptics_support
359 to handle packets from guest devices (sticks) and extra buttons.
363 commands for mouse drivers.
364 These commands and related structures and constants are defined in
366 General description of the commands is given in
368 This section explains the features specific to the
372 .Bl -tag -width MOUSE -compact
373 .It Dv MOUSE_GETLEVEL Ar int *level
374 .It Dv MOUSE_SETLEVEL Ar int *level
375 These commands manipulate the operation level of the
379 .It Dv MOUSE_GETHWINFO Ar mousehw_t *hw
380 Returns the hardware information of the attached device in the following
383 typedef struct mousehw {
384 int buttons; /* number of buttons */
385 int iftype; /* I/F type */
386 int type; /* mouse/track ball/pad... */
387 int model; /* I/F dependent model ID */
388 int hwid; /* I/F dependent hardware ID */
394 field holds the number of buttons on the device.
397 driver currently can detect the 3 button mouse from Logitech and report
399 The 3 button mouse from the other manufacturer may or may not be
401 However, it will not affect the operation of
411 tells the device type:
413 .Dv MOUSE_TRACKBALL ,
418 The user should not heavily rely on this field, as the
419 driver may not always, in fact it is very rarely able to, identify
425 .Dv MOUSE_MODEL_GENERIC
426 at the operation level 0.
428 .Dv MOUSE_MODEL_GENERIC
431 constants at higher operation levels.
434 driver may or may not set an appropriate value in this field.
438 is the ID value returned by the device.
441 .Bl -tag -width 0__ -compact
443 Mouse (Microsoft, Logitech and many other manufacturers)
445 Microsoft Ballpoint mouse
447 Microsoft IntelliMouse
450 .It Dv MOUSE_SYN_GETHWINFO Ar synapticshw_t *synhw
451 Retrieves extra information associated with Synaptics Touchpads.
453 .Va hw.psm.synaptics_support
456 typedef struct synapticshw {
457 int infoMajor; /* major hardware revision */
458 int infoMinor; /* minor hardware revision */
459 int infoRot180; /* touchpad is rotated */
460 int infoPortrait; /* touchpad is a portrait */
461 int infoSensor; /* sensor model */
462 int infoHardware; /* hardware model */
463 int infoNewAbs; /* supports the newabs format */
464 int capPen; /* can detect a pen */
465 int infoSimpleC; /* supports simple commands */
466 int infoGeometry; /* touchpad dimensions */
467 int capExtended; /* supports extended packets */
468 int capSleep; /* can be suspended/resumed */
469 int capFourButtons; /* has four buttons */
470 int capMultiFinger; /* can detect multiple fingers */
471 int capPalmDetect; /* can detect a palm */
472 int capPassthrough; /* can passthrough guest packets */
477 .Em Synaptics TouchPad Interfacing Guide
478 for more information about the fields in this structure.
480 .It Dv MOUSE_GETMODE Ar mousemode_t *mode
481 The command gets the current operation parameters of the mouse
484 typedef struct mousemode {
485 int protocol; /* MOUSE_PROTO_XXX */
486 int rate; /* report rate (per sec), -1 if unknown */
487 int resolution; /* MOUSE_RES_XXX, -1 if unknown */
488 int accelfactor; /* acceleration factor */
489 int level; /* driver operation level */
490 int packetsize; /* the length of the data packet */
491 unsigned char syncmask[2]; /* sync. bits */
499 at the operation level zero and two.
500 .Dv MOUSE_PROTO_SYSMOUSE
501 at the operation level one.
505 is the status report rate (reports/sec) at which the device will send
506 movement report to the host computer.
507 Typical supported values are 10, 20, 40, 60, 80, 100 and 200.
508 Some mice may accept other arbitrary values too.
512 of the pointing device must be one of
514 constants or a positive value.
515 The greater the value
516 is, the finer resolution the mouse will select.
517 Actual resolution selected by the
519 constant varies according to the model of mouse.
520 Typical resolutions are:
522 .Bl -tag -width MOUSE_RES_MEDIUMHIGH__ -compact
525 .It Dv MOUSE_RES_MEDIUMLOW
527 .It Dv MOUSE_RES_MEDIUMHIGH
529 .It Dv MOUSE_RES_HIGH
535 field holds a value to control acceleration feature
538 It must be zero or greater.
539 If it is zero, acceleration is disabled.
543 field specifies the length of the data packet.
545 operation level and the model of the pointing device.
547 .Bl -tag -width level_0__ -compact
553 Depends on the model of the device
558 holds a bit mask and pattern to detect the first byte of the
561 is the bit mask to be ANDed with a byte.
562 If the result is equal to
564 the byte is likely to be the first byte of the data packet.
565 Note that this detection method is not 100% reliable,
566 thus, should be taken only as an advisory measure.
568 .It Dv MOUSE_SETMODE Ar mousemode_t *mode
569 The command changes the current operation parameters of the mouse driver
579 Setting values in the other field does not generate
580 error and has no effect.
582 If you do not want to change the current setting of a field, put -1
584 You may also put zero in
588 and the default value for the fields will be selected.
590 .\" .It Dv MOUSE_GETVARS Ar mousevar_t *vars
591 .\" .It Dv MOUSE_SETVARS Ar mousevar_t *vars
592 .\" These commands are not supported by the
596 .It Dv MOUSE_READDATA Ar mousedata_t *data
597 .\" The command reads the raw data from the device.
599 .\" typedef struct mousedata {
600 .\" int len; /* # of data in the buffer */
601 .\" int buf[16]; /* data buffer */
605 .\" Upon returning to the user program, the driver will place the number
606 .\" of valid data bytes in the buffer in the
610 .It Dv MOUSE_READSTATE Ar mousedata_t *state
611 .\" The command reads the hardware settings from the device.
612 .\" Upon returning to the user program, the driver will place the number
613 .\" of valid data bytes in the buffer in the
615 .\" field. It is usually 3 bytes.
616 .\" The buffer is formatted as follows:
618 .\" .Bl -tag -width Byte_1 -compact
620 .\" .Bl -tag -width bit_6 -compact
624 .\" 0 - stream mode, 1 - remote mode.
625 .\" In the stream mode, the pointing device sends the device status
626 .\" whenever its state changes. In the remote mode, the host computer
627 .\" must request the status to be sent.
630 .\" driver puts the device in the stream mode.
632 .\" Set if the pointing device is currently enabled. Otherwise zero.
634 .\" 0 - 1:1 scaling, 1 - 2:1 scaling.
635 .\" 1:1 scaling is the default.
639 .\" Left button status; set if pressed.
641 .\" Middle button status; set if pressed.
643 .\" Right button status; set if pressed.
646 .\" .Bl -tag -width bit_6_0 -compact
650 .\" Resolution code: zero through three. Actual resolution for
651 .\" the resolution code varies from one device to another.
654 .\" The status report rate (reports/sec) at which the device will send
655 .\" movement report to the host computer.
657 These commands are not currently supported by the
661 .It Dv MOUSE_GETSTATUS Ar mousestatus_t *status
662 The command returns the current state of buttons and
663 movement counts as described in
667 .Bl -tag -width /dev/npsm0 -compact
669 `non-blocking' device node
671 `blocking' device node under
675 In order to install the
677 driver, you need to add
682 to your kernel configuration file, and put the following lines to
683 .Pa /boot/device.hints .
685 .Dl hint.atkbdc.0.at="isa"
686 .Dl hint.atkbdc.0.port="0x060"
687 .Dl hint.psm.0.at="atkbdc"
688 .Dl hint.psm.0.irq="12"
690 If you add the following statement to
691 .Pa /boot/device.hints ,
693 .Dl hint.psm.0.flags="0x2000"
695 you will add the optional code to stimulate the pointing device
696 after the `resume' event.
698 .Dl hint.psm.0.flags="0x24"
700 The above line will set the device resolution high (4)
701 and the acceleration factor to 2.
703 At debug level 0, little information is logged except for the following
704 line during boot process:
705 .Bd -literal -offset indent
711 the device ID code returned by the found pointing device.
716 At debug level 1 more information will be logged
717 while the driver probes the auxiliary port (mouse port).
718 Messages are logged with the LOG_KERN facility at the LOG_DEBUG level
721 .Bd -literal -offset indent
722 psm0: current command byte:xxxx
723 kbdio: TEST_AUX_PORT status:0000
724 kbdio: RESET_AUX return code:00fa
725 kbdio: RESET_AUX status:00aa
726 kbdio: RESET_AUX ID:0000
730 psm0: model AAAA, device ID X, N buttons
731 psm0: config:00000www, flags:0000uuuu, packet size:M
732 psm0: syncmask:xx, syncbits:yy
735 The first line shows the command byte value of the keyboard
736 controller just before the auxiliary port is probed.
737 It usually is 4D, 45, 47 or 65, depending on how the motherboard BIOS
738 initialized the keyboard controller upon power-up.
740 The second line shows the result of the keyboard controller's
741 test on the auxiliary port interface, with zero indicating
742 no error; note that some controllers report no error even if
743 the port does not exist in the system, however.
745 The third through fifth lines show the reset status of the pointing device.
746 The functioning device should return the sequence of FA AA <ID>.
747 The ID code is described above.
749 The seventh line shows the current hardware settings.
751 .\" .Dv MOUSE_READSTATE
753 These bytes are formatted as follows:
755 .Bl -tag -width Byte_1 -compact
757 .Bl -tag -width bit_6 -compact
761 0 - stream mode, 1 - remote mode.
762 In the stream mode, the pointing device sends the device status
763 whenever its state changes.
764 In the remote mode, the host computer
765 must request the status to be sent.
768 driver puts the device in the stream mode.
770 Set if the pointing device is currently enabled.
773 0 - 1:1 scaling, 1 - 2:1 scaling.
774 1:1 scaling is the default.
778 Left button status; set if pressed.
780 Middle button status; set if pressed.
782 Right button status; set if pressed.
785 .Bl -tag -width bit_6_0 -compact
789 Resolution code: zero through three.
790 Actual resolution for
791 the resolution code varies from one device to another.
794 The status report rate (reports/sec) at which the device will send
795 movement report to the host computer.
798 Note that the pointing device will not be enabled until the
800 driver is opened by the user program.
802 The rest of the lines show the device ID code, the number of detected
803 buttons and internal variables.
805 At debug level 2, much more detailed information is logged.
807 Many pad devices behave as if the first (left) button were pressed if
808 the user `taps' the surface of the pad.
809 In contrast, some pad products, e.g.\& some versions of ALPS GlidePoint
810 and Interlink VersaPad, treat the tapping action
811 as fourth button events.
813 It is reported that Interlink VersaPad requires both
817 flags in order to recover from suspended state.
818 These flags are automatically set when VersaPad is detected by the
822 Some PS/2 mouse models from MouseSystems require to be put in the
823 high resolution mode to work properly.
824 Use the driver flag to
827 There is not a guaranteed way to re-synchronize with the first byte
828 of the packet once we are out of synchronization with the data
830 However, if you are using the \fIXFree86\fP server and experiencing
831 the problem, you may be able to make the X server synchronize with the mouse
832 by switching away to a virtual terminal and getting back to the X server,
833 unless the X server is accessing the mouse via
835 Clicking any button without moving the mouse may also work.
840 It was never functional anyway.
842 Enabling the extended support for Synaptics touchpads has been reported to
843 cause problems with responsivity on some (newer) models of Synaptics
844 hardware, particularly those with guest devices.
856 .%T Synaptics TouchPad Interfacing Guide
857 .%O http://www.synaptics.com/
864 driver is based on the work done by quite a number of people, including
875 This manual page was written by
876 .An Kazutaka Yokota Aq yokota@FreeBSD.org .