1.\" $NetBSD: ms.4,v 1.6 1999/12/17 16:23:25 abs 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.\" 3. All advertising materials mentioning features or use of this software 18.\" must display the following acknowledgement: 19.\" This product includes software developed by the NetBSD 20.\" Foundation, Inc. and its contributors. 21.\" 4. Neither the name of The NetBSD Foundation nor the names of its 22.\" contributors may be used to endorse or promote products derived 23.\" from this software without specific prior written permission. 24.\" 25.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 26.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 27.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 28.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 29.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 30.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 31.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 32.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 33.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 34.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 35.\" POSSIBILITY OF SUCH DAMAGE. 36.\" 37.Dd June 22, 1996 38.Dt MS 4 sparc 39.Os 40.Sh NAME 41.Nm ms 42.Nd Sun workstation mouse driver 43.Sh SYNOPSIS 44.Cd "pseudo-device mouse" 45.Sh DESCRIPTION 46The 47.Nm 48driver provides an interface to the workstation console mouse. 49This 50.Tn Mouse Systems 51three-button device produces five-byte blobs of the form: 52.Pp 53.Bd -literal -offset indent 54b dx dy dx dy 55.Ed 56.Pp 57where 58.Dq b 59is the button state, encoded as 60.Li 0x80|(~buttons) 61-- there are three buttons (4=left, 2=middle, 1=right) -- 62and 63.Dq \&dx 64and 65.Dq \&dy 66are X and Y delta values, none of which are in the range 67.Bq Li 0x80..0x87 . 68.Pp 69The device special file 70.Pa /dev/mouse 71is used to get direct access to the mouse input stream. 72The following 73ioctl's are supported (mostly just enough to keep the 74.Xr X 1 75server going): 76.Bl -tag -width VUIDSFORMAT 77.It Dv VUIDSFORMAT 78Set translation mode. 79The argument is of type 80.Fa "int *" , 81the only value supported is 82.Dv VUID_FIRM_EVENT . 83.It Dv VUIDGFORMAT 84Get translation mode. 85The argument is of type 86.Fa "int *" . 87.Dv VUID_FIRM_EVENT 88is always returned. 89.El 90.Ss OPTIONS 91The mouse driver can be configured using the following kernel configuration 92file options. 93.Bl -tag 94.It Cd options SUN_MS_BPS=integer 95This option causes the kernel to communicate with the mouse using the serial 96baud rate 97.Va integer . 98It is useful for mice which do not communicate at 1200 baud. 99.El 100.Sh SEE ALSO 101.Xr kbd 4 102.Sh BUGS 103.Nm 104is hardwired to the built-in 105.Em zs1 106serial port. 107