summaryrefslogtreecommitdiff
path: root/share/man/man4/man4.i386/pms.4
blob: 6c1a7f9995fcc8f851293b46f2724c119af08ff5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
.\"
.\"	$OpenBSD: pms.4,v 1.7 2000/03/06 21:46:57 aaron Exp $
.\"
.\" Copyright (c) 1996, Jason Downs.
.\" Copyright (c) 1993 Christopher G. Demetriou
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"      This product includes software developed by Christopher G. Demetriou.
.\" 3. The name of the author may not be used to endorse or promote products
.\"    derived from this software without specific prior written permission
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd October 10, 1999
.Dt PMS 4 i386
.Os
.Sh NAME
.Nm pms
.Nd
PS/2 auxiliary port mouse driver
.Sh SYNOPSIS
.\" XXX this is awful hackery to get it to work right... -- cgd
.\".Cd "pms0 at isa? port" \&"IO_KBD\&" irq 12
.Cd "pms0 at pckbd? irq 12"
.Sh DESCRIPTION
This driver provides an interface to a PS/2 auxiliary port mice.  The driver
offers two modes of operation, both a raw and the old style translated
input stream.  The translating portion of the driver provides BusMouse
codes; in raw mode no translations are performed.
The
.Nm
driver provides three
.Em ioctls
for getting mouse status and changing modes.  They are defined in the
following include:
.Bd -literal -offset indent
#include <machine/mouse.h>
.Ed

The
.Dv MOUSEIOCREAD
.Em ioctl
is used to read the current mouse stats, and takes the
.Dv "struct mouseinfo"
as an argument to store the data in.

The
.Dv MOUSEIOCSRAW
.Em ioctl
puts the device into raw mode, if it is not already, and the
.Dv MOUSEIOCSCOOKED
.Em ioctl
puts it into translated (or cooked) mode.  If the mode of the
.Nm
device driver changes, all pending but not yet read input is flushed.
.Pp
In translated mode, the
.Nm
driver also supports
.Dq Intellimouse
devices, with the wheel acting as a third button.  The kernel must currently
be compiled with
.Pp
.Cd option INTELLIMOUSE
.Pp
specified in the config file, and the X server can be configured to use
the translated mode of the driver.  (The output of the translated mode is
.Em Busmouse
compatible.)  Otherwise, the mouse works as a normal, two button, PS/2
device.
.Pp
.Sh NOTES
The translated mode of this driver is being deprecated. The raw device 
.Pa /dev/psm0
should be used in
.Pa /etc/XF86Config
with the 
.Em PS/2
protocol, or one of its variants
.Pf ( Em IMPS/2
for MS Intellimouse,
.Em ThinkingMousePS/2
for Kensington Thinking Mouse).
.Pp
.Sh FILES
.Bl -tag -width /dev/pms0 -compact
.It Pa /dev/psm0
PS/2 mouse device file, defaulting to raw mode
.It Pa /dev/pms0
PS/2 mouse device file, defaulting to translating mode
.El
.Sh SEE ALSO
.Xr lms 4 ,
.Xr mms 4 ,
.Xr XF86Config 4