xref: /netbsd/share/man/man4/pms.4 (revision bf9ec67e)
1.\" $NetBSD: pms.4,v 1.8 2002/03/18 18:59:57 wiz Exp $
2.\"
3.\" Copyright (c) 1993 Christopher G. Demetriou
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.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"          This product includes software developed for the
17.\"          NetBSD Project.  See http://www.netbsd.org/ for
18.\"          information about NetBSD.
19.\" 4. The name of the author may not be used to endorse or promote products
20.\"    derived from this software without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
23.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
25.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
26.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
27.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
31.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32.\"
33.\" <<Id: LICENSE,v 1.2 2000/06/14 15:57:33 cgd Exp>>
34.\"
35.Dd March 12, 1997
36.Dt PMS 4
37.Os
38.Sh NAME
39.Nm pms
40.Nd PS/2 auxiliary port mouse driver
41.Sh SYNOPSIS
42.Cd pckbc* at isa?
43.Cd pms* at pckbc?
44.Cd wsmouse* at pms?
45.Sh DESCRIPTION
46The
47.Nm
48driver provides an interface to PS/2 auxiliary port mice within the
49.Xr wscons 4
50framework. Parent device in terms of the autoconfiguration framework is
51.Xr pckbc 4 ,
52the PC keyboard controller.
53.Dq pms
54is a generic driver which supports mice using common variants of the PS/2
55protocol, including wheel mice of the
56.Dq IntelliMouse
57breed.  Wheel movements are mapped to a third (z-) axis.  The driver is
58believed to work with both 3-button and 5-button mice with scroll wheels.
59Mice which use other protocol extensions are not currently supported, but
60might be if protocol documentation could be found.
61Mouse related data are accessed by
62.Xr wsmouse 4
63devices.
64.Pp
65The
66.Nm
67driver has been updated to attempt to renegotiate mouse protocol after seeing
68suspicious or defective mouse protocol packets, or unusual delays in the
69middle of a packet; this should improve the chances that a mouse will recover
70after being switched away or reset (for instance, by a console switch).
71.Sh SEE ALSO
72.Xr opms 4 ,
73.Xr pckbc 4 ,
74.Xr ums 4 ,
75.Xr wsmouse 4
76.Sh AUTHORS
77The
78.Nm
79driver was originally written by Christopher G. Demetriou.  The changes to
80merge the
81.Dq IntelliMouse
82protocol in, and reset the mouse in the event of protocol problems, were
83contributed by Peter Seebach.  Special thanks to Ray Trent, at Synaptics,
84who contributed valuable insight into how to identify bogus mouse data.
85.Sh BUGS
86It is possible for the driver to mistakenly negotiate the non-scroll-wheel
87protocol, after which it is unlikely to recover until the device is closed
88and reopened.
89