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.
27 .\" $FreeBSD: src/share/man/man4/psm.4,v 1.24.2.9 2002/12/29 16:35:38 schweikh Exp $
28 .\" $DragonFly: src/share/man/man4/psm.4,v 1.6 2007/05/17 08:19:01 swildner Exp $
35 .Nd PS/2 mouse style pointing device driver
37 .Cd "options KBD_RESETDELAY=N"
38 .Cd "options KBD_MAXWAIT=N"
39 .Cd "options PSM_DEBUG=N"
40 .Cd "options KBDIO_DEBUG=N"
41 .Cd "device psm0 at atkbdc? irq 12"
45 driver provides support for the PS/2 mouse style pointing device.
46 Currently there can be only one
48 device node in the system.
49 As the PS/2 mouse port is located
50 at the auxiliary port of the keyboard controller,
51 the keyboard controller driver,
53 must also be configured in the kernel.
54 Note that there is currently no provision of changing the
58 Basic PS/2 style pointing device has two or three buttons.
59 Some devices may have a roller or a wheel and/or additional buttons.
61 The PS/2 style pointing device usually has several grades of resolution,
62 that is, sensitivity of movement.
63 They are typically 25, 50, 100 and 200
65 Some devices may have finer resolution.
66 The current resolution can be changed at runtime.
69 driver allows the user to initially set the resolution
72 .Sx "DRIVER CONFIGURATION" )
73 or change it later via the
80 Frequency, or report rate, at which the device sends movement
81 and button state reports to the host system is also configurable.
82 The PS/2 style pointing device typically supports 10, 20, 40, 60, 80, 100
83 and 200 reports per second.
84 60 or 100 appears to be the default value for many devices.
85 Note that when there is no movement and no button has changed its state,
86 the device won't send anything to the host system.
87 The report rate can be changed via an ioctl call.
91 driver has three levels of operation.
92 The current operation level can be set via an ioctl call.
94 At the level zero the basic support is provided; the device driver will report
95 horizontal and vertical movement of the attached device
96 and state of up to three buttons.
97 The movement and status are encoded in a series of fixed-length data packets
99 .Sx "Data Packet Format" ) .
100 This is the default level of operation and the driver is initially
101 at this level when opened by the user program.
103 The operation level one, the `extended' level, supports a roller (or wheel),
104 if any, and up to 11 buttons.
105 The movement of the roller is reported as movement along the Z axis.
106 8 byte data packets are sent to the user program at this level.
108 At the operation level two, data from the pointing device is passed to the
110 Modern PS/2 type pointing devices often use proprietary data format.
111 Therefore, the user program is expected to have
112 intimate knowledge about the format from a particular device when operating
113 the driver at this level.
114 This level is called `native' level.
115 .Ss Data Packet Format
116 Data packets read from the
118 driver are formatted differently at each operation level.
120 A data packet from the PS/2 mouse style pointing device
121 is three bytes long at the operation level zero:
123 .Bl -tag -width Byte_1 -compact
125 .Bl -tag -width bit_7 -compact
127 One indicates overflow in the vertical movement count.
129 One indicates overflow in the horizontal movement count.
131 Set if the vertical movement count is negative.
133 Set if the horizontal movement count is negative.
136 .\" The ALPS GlidePoint clears this bit when the user `taps' the surface of
137 .\" the pad, otherwise the bit is set.
138 .\" Most, if not all, other devices always set this bit.
140 Middle button status; set if pressed.
141 For devices without the middle
142 button, this bit is always zero.
144 Right button status; set if pressed.
146 Left button status; set if pressed.
149 Horizontal movement count in two's complement;
151 Note that the sign bit is in the first byte.
153 Vertical movement count in two's complement;
155 Note that the sign bit is in the first byte.
158 At the level one, a data packet is encoded
159 in the standard format
160 .Dv MOUSE_PROTO_SYSMOUSE
164 At the level two, native level, there is no standard on the size and format
169 driver can somewhat `accelerate' the movement of the pointing device.
170 The faster you move the device, the further the pointer
171 travels on the screen.
172 The driver has an internal variable which governs the effect of
174 Its value can be modified via the driver flag
175 or via an ioctl call.
177 The minor device number of the
180 .Bd -literal -offset indent
181 minor = (`unit' << 1) | `non-blocking'
184 where `unit' is the device number (usually 0) and the `non-blocking' bit
185 is set to indicate ``don't block waiting for mouse input,
186 return immediately''.
187 The `non-blocking' bit should be set for \fIXFree86\fP,
188 therefore the minor device number usually used for \fIXFree86\fP is 1.
191 for device node names.
192 .Sh DRIVER CONFIGURATION
193 .Ss Kernel Configuration Options
194 There are following kernel configuration options to control the
197 They may be set in the kernel configuration file
200 .Bl -tag -width MOUSE
201 .It Em KBD_RESETDELAY=X , KBD_MAXWAIT=Y
204 driver will attempt to reset the pointing device during the boot process.
205 It sometimes takes a long while before the device will respond after
207 These options control how long the driver should wait before
208 it eventually gives up waiting.
214 If the driver seems unable to detect your pointing
215 device, you may want to increase these values.
216 The default values are
222 .It Em PSM_DEBUG=N , KBDIO_DEBUG=N
223 Sets the debug level to
225 The default debug level is zero.
233 driver accepts the following driver flags.
235 kernel configuration file or in the User Configuration Menu at
240 .Bl -tag -width MOUSE
241 .It bit 0..3 RESOLUTION
242 This flag specifies the resolution of the pointing device.
243 It must be zero through four.
244 The greater the value
245 is, the finer resolution the device will select.
246 Actual resolution selected by this field varies according to the model
248 Typical resolutions are:
250 .Bl -tag -width 0_(medium_high)__ -compact
252 25 pulse per inch (ppi)
253 .It Em 2 (medium low)
255 .It Em 3 (medium high)
261 Leaving this flag zero will selects the default resolution for the
262 device (whatever it is).
263 .It bit 4..7 ACCELERATION
264 This flag controls the amount of acceleration effect.
265 The smaller the value of this flag is, more sensitive the movement becomes.
266 The minimum value allowed, thus the value for the most sensitive setting,
268 Setting this flag to zero will completely disables the
270 .It bit 8 NOCHECKSYNC
273 driver tries to detect the first byte of the data packet by checking
274 the bit pattern of that byte.
275 Although this method should work with most
276 PS/2 pointing devices, it may interfere with some devices which are not
277 so compatible with known devices.
278 If you think your pointing device is not functioning as expected,
279 and the kernel frequently prints the following message to the console,
280 .Bd -literal -offset indent
281 psmintr: out of sync (xxxx != yyyy).
284 set this flag to disable synchronization check and see if it helps.
288 driver will not try to identify the model of the pointing device and
289 will not carry out model-specific initialization.
290 The device should always act like a standard PS/2 mouse without such
292 Extra features, such as wheels and additional buttons, won't be
297 When this flag is set, the
299 driver won't reset the pointing device when initializing the device.
303 is started after another OS has run, the pointing device will inherit
304 settings from the previous OS.
305 However, because there is no way for the
307 driver to know the settings, the device and the driver may not
309 The flag should never be necessary under normal circumstances.
311 Some pad devices report as if the fourth button is pressed
312 when the user `taps' the surface of the device (see
314 This flag will make the
316 driver assume that the device behaves this way.
317 Without the flag, the driver will assume this behavior
318 for ALPS GlidePoint models only.
319 .It bit 12 IGNOREPORTERROR
322 driver ignore certain error conditions when probing the PS/2 mouse port.
323 It should never be necessary under normal circumstances.
324 .It bit 13 HOOKRESUME
325 The built-in PS/2 pointing device of some laptop computers is somehow
326 not operable immediately after the system `resumes' from
327 the power saving mode,
328 though it will eventually become available.
329 There are reports that
330 stimulating the device by performing I/O will help
331 waking up the device quickly.
332 This flag will enable a piece of code in the
335 the `resume' event and exercise some harmless I/O operations on the
337 .It bit 14 INITAFTERSUSPEND
338 This flag adds more drastic action for the above problem.
341 driver to reset and re-initialize the pointing device
342 after the `resume' event.
343 It has no effect unless the
350 commands for mouse drivers.
351 These commands and related structures and constants are defined in
352 .In machine/mouse.h .
353 General description of the commands is given in
355 This section explains the features specific to the
359 .Bl -tag -width MOUSE -compact
360 .It Dv MOUSE_GETLEVEL Ar int *level
361 .It Dv MOUSE_SETLEVEL Ar int *level
362 These commands manipulate the operation level of the
366 .It Dv MOUSE_GETHWINFO Ar mousehw_t *hw
367 Returns the hardware information of the attached device in the following
370 typedef struct mousehw {
371 int buttons; /* number of buttons */
372 int iftype; /* I/F type */
373 int type; /* mouse/track ball/pad... */
374 int model; /* I/F dependent model ID */
375 int hwid; /* I/F dependent hardware ID */
381 field holds the number of buttons on the device.
384 driver currently can detect the 3 button mouse from Logitech and report
386 The 3 button mouse from the other manufacturer may or may not be
388 However, it will not affect the operation of
398 tells the device type:
400 .Dv MOUSE_TRACKBALL ,
405 The user should not heavily rely on this field, as the
406 driver may not always, in fact it is very rarely able to, identify
412 .Dv MOUSE_MODEL_GENERIC
413 at the operation level 0.
415 .Dv MOUSE_MODEL_GENERIC
418 constants at higher operation levels.
421 driver may or may not set an appropriate value in this field.
425 is the ID value returned by the device.
428 .Bl -tag -width 0__ -compact
430 Mouse (Microsoft, Logitech and many other manufacturers)
432 Microsoft Ballpoint mouse
434 Microsoft IntelliMouse
437 .It Dv MOUSE_GETMODE Ar mousemode_t *mode
438 The command gets the current operation parameters of the mouse
441 typedef struct mousemode {
442 int protocol; /* MOUSE_PROTO_XXX */
443 int rate; /* report rate (per sec), -1 if unknown */
444 int resolution; /* MOUSE_RES_XXX, -1 if unknown */
445 int accelfactor; /* acceleration factor */
446 int level; /* driver operation level */
447 int packetsize; /* the length of the data packet */
448 unsigned char syncmask[2]; /* sync. bits */
456 at the operation level zero and two.
457 .Dv MOUSE_PROTO_SYSMOUSE
458 at the operation level one.
462 is the status report rate (reports/sec) at which the device will send
463 movement report to the host computer.
464 Typical supported values are 10, 20, 40, 60, 80, 100 and 200.
465 Some mice may accept other arbitrary values too.
469 of the pointing device must be one of
471 constants or a positive value.
472 The greater the value
473 is, the finer resolution the mouse will select.
474 Actual resolution selected by the
476 constant varies according to the model of mouse.
477 Typical resolutions are:
479 .Bl -tag -width MOUSE_RES_MEDIUMHIGH__ -compact
482 .It Dv MOUSE_RES_MEDIUMLOW
484 .It Dv MOUSE_RES_MEDIUMHIGH
486 .It Dv MOUSE_RES_HIGH
492 field holds a value to control acceleration feature
495 It must be zero or greater. If it is zero, acceleration is disabled.
499 field specifies the length of the data packet.
501 operation level and the model of the pointing device.
503 .Bl -tag -width level_0__ -compact
509 Depends on the model of the device
514 holds a bit mask and pattern to detect the first byte of the
517 is the bit mask to be ANDed with a byte.
518 If the result is equal to
520 the byte is likely to be the first byte of the data packet.
521 Note that this detection method is not 100% reliable,
522 thus, should be taken only as an advisory measure.
524 .It Dv MOUSE_SETMODE Ar mousemode_t *mode
525 The command changes the current operation parameters of the mouse driver
535 Setting values in the other field does not generate
536 error and has no effect.
538 If you do not want to change the current setting of a field, put -1
540 You may also put zero in
544 and the default value for the fields will be selected.
546 .\" .It Dv MOUSE_GETVARS Ar mousevar_t *vars
547 .\" .It Dv MOUSE_SETVARS Ar mousevar_t *vars
548 .\" These commands are not supported by the
552 .It Dv MOUSE_READDATA Ar mousedata_t *data
553 .\" The command reads the raw data from the device.
555 .\" typedef struct mousedata {
556 .\" int len; /* # of data in the buffer */
557 .\" int buf[16]; /* data buffer */
561 .\" Upon returning to the user program, the driver will place the number
562 .\" of valid data bytes in the buffer in the
566 .It Dv MOUSE_READSTATE Ar mousedata_t *state
567 .\" The command reads the hardware settings from the device.
568 .\" Upon returning to the user program, the driver will place the number
569 .\" of valid data bytes in the buffer in the
571 .\" field. It is usually 3 bytes.
572 .\" The buffer is formatted as follows:
574 .\" .Bl -tag -width Byte_1 -compact
576 .\" .Bl -tag -width bit_6 -compact
580 .\" 0 - stream mode, 1 - remote mode.
581 .\" In the stream mode, the pointing device sends the device status
582 .\" whenever its state changes. In the remote mode, the host computer
583 .\" must request the status to be sent.
586 .\" driver puts the device in the stream mode.
588 .\" Set if the pointing device is currently enabled. Otherwise zero.
590 .\" 0 - 1:1 scaling, 1 - 2:1 scaling.
591 .\" 1:1 scaling is the default.
595 .\" Left button status; set if pressed.
597 .\" Middle button status; set if pressed.
599 .\" Right button status; set if pressed.
602 .\" .Bl -tag -width bit_6_0 -compact
606 .\" Resolution code: zero through three. Actual resolution for
607 .\" the resolution code varies from one device to another.
610 .\" The status report rate (reports/sec) at which the device will send
611 .\" movement report to the host computer.
613 These commands are not currently supported by the
617 .It Dv MOUSE_GETSTATUS Ar mousestatus_t *status
618 The command returns the current state of buttons and
619 movement counts as described in
623 .Bl -tag -width /dev/npsm0 -compact
625 `non-blocking' device node
627 `blocking' device node
630 .Dl "device psm0 at atkbdc? irq 12 flags 0x2000"
634 driver to the kernel with the optional code to stimulate the pointing device
635 after the `resume' event.
637 .Dl "device psm0 at atkbdc? flags 0x024 irq 12"
639 Set the device resolution high (4) and the acceleration factor to 2.
641 At debug level 0, little information is logged except for the following
642 line during boot process:
643 .Bd -literal -offset indent
649 the device ID code returned by the found pointing device.
654 At debug level 1 more information will be logged
655 while the driver probes the auxiliary port (mouse port).
656 Messages are logged with the LOG_KERN facility at the LOG_DEBUG level
659 .Bd -literal -offset indent
660 psm0: current command byte:xxxx
661 kbdio: TEST_AUX_PORT status:0000
662 kbdio: RESET_AUX return code:00fa
663 kbdio: RESET_AUX status:00aa
664 kbdio: RESET_AUX ID:0000
668 psm0: model AAAA, device ID X, N buttons
669 psm0: config:00000www, flags:0000uuuu, packet size:M
670 psm0: syncmask:xx, syncbits:yy
673 The first line shows the command byte value of the keyboard
674 controller just before the auxiliary port is probed.
675 It usually is 4D, 45, 47 or 65, depending on how the motherboard BIOS
676 initialized the keyboard controller upon power-up.
678 The second line shows the result of the keyboard controller's
679 test on the auxiliary port interface, with zero indicating
680 no error; note that some controllers report no error even if
681 the port does not exist in the system, however.
683 The third through fifth lines show the reset status of the pointing device.
684 The functioning device should return the sequence of FA AA <ID>.
685 The ID code is described above.
687 The seventh line shows the current hardware settings.
689 .\" .Dv MOUSE_READSTATE
691 These bytes are formatted as follows:
693 .Bl -tag -width Byte_1 -compact
695 .Bl -tag -width bit_6 -compact
699 0 - stream mode, 1 - remote mode.
700 In the stream mode, the pointing device sends the device status
701 whenever its state changes.
702 In the remote mode, the host computer
703 must request the status to be sent.
706 driver puts the device in the stream mode.
708 Set if the pointing device is currently enabled.
711 0 - 1:1 scaling, 1 - 2:1 scaling.
712 1:1 scaling is the default.
716 Left button status; set if pressed.
718 Middle button status; set if pressed.
720 Right button status; set if pressed.
723 .Bl -tag -width bit_6_0 -compact
727 Resolution code: zero through three.
728 Actual resolution for
729 the resolution code varies from one device to another.
732 The status report rate (reports/sec) at which the device will send
733 movement report to the host computer.
736 Note that the pointing device will not be enabled until the
738 driver is opened by the user program.
740 The rest of the lines show the device ID code, the number of detected
741 buttons and internal variables.
743 At debug level 2, much more detailed information is logged.
745 Many pad devices behave as if the first (left) button were pressed if
746 the user `taps' the surface of the pad.
747 In contrast, some pad products, e.g. some versions of ALPS GlidePoint
748 and Interlink VersaPad, treat the tapping action
749 as fourth button events.
751 It is reported that Interlink VersaPad requires both
755 flags in order to recover from suspended state.
756 These flags are automatically set when VersaPad is detected by the
760 Some PS/2 mouse models from MouseSystems require to be put in the
761 high resolution mode to work properly.
762 Use the driver flag to
765 There is not a guaranteed way to re-synchronize with the first byte
766 of the packet once we are out of synchronization with the data
768 However, if you are using the \fIXFree86\fP server and experiencing
769 the problem, you may be able to make the X server synchronize with the mouse
770 by switching away to a virtual terminal and getting back to the X server,
771 unless the X server is accessing the mouse via
773 Clicking any button without moving the mouse may also work.
788 driver is based on the work done by quite a number of people, including
799 This manual page was written by
800 .An Kazutaka Yokota Aq yokota@FreeBSD.org .
805 It was never functional anyway.