xref: /netbsd-src/share/man/man4/man4.sparc/ms.4 (revision 633f3639db593aa92599e0f49563a30ce60059e2)
1.\"	$NetBSD: ms.4,v 1.10 2017/02/17 22:24:47 christos Exp $
2.\"
3.\" Copyright (c) 1996 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Paul Kranenburg.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
30.Dd February 17, 2017
31.Dt MS 4 sparc
32.Os
33.Sh NAME
34.Nm ms
35.Nd Sun workstation mouse driver
36.Sh SYNOPSIS
37.Cd "pseudo-device mouse"
38.Sh DESCRIPTION
39The
40.Nm
41driver provides an interface to the workstation console mouse.
42This
43.Tn Mouse Systems
44three-button device produces five-byte blobs of the form:
45.Bd -literal -offset indent
46b dx dy dx dy
47.Ed
48.Pp
49where
50.Dq b
51is the button state, encoded as
52.Li 0x80|(~buttons)
53-- there are three buttons (4=left, 2=middle, 1=right) --
54and
55.Dq \&dx
56and
57.Dq \&dy
58are X and Y delta values, none of which are in the range
59.Bq Li 0x80..0x87 .
60.Pp
61The device special file
62.Pa /dev/mouse
63is used to get direct access to the mouse input stream.
64The following
65ioctl's are supported (mostly just enough to keep the
66.Xr Xorg 1
67server going):
68.Bl -tag -width VUIDSFORMAT
69.It Dv VUIDSFORMAT
70Set translation mode.
71The argument is of type
72.Fa "int *" ,
73the only value supported is
74.Dv VUID_FIRM_EVENT .
75.It Dv VUIDGFORMAT
76Get translation mode.
77The argument is of type
78.Fa "int *" .
79.Dv VUID_FIRM_EVENT
80is always returned.
81.El
82.Ss OPTIONS
83The mouse driver can be configured using the following kernel configuration
84file options.
85.Bl -tag -width VUIDSFORMAT
86.It Cd options SUN_MS_BPS=integer
87This option causes the kernel to communicate with the mouse using the serial
88baud rate
89.Va integer .
90It is useful for mice which do not communicate at 1200 baud.
91.El
92.Sh SEE ALSO
93.Xr sparc/kbd 4
94.Sh BUGS
95.Nm
96is hardwired to the built-in
97.Em zs1
98serial port.
99