[src/trunk]: src/share/man/man4/man4.acorn32 In a shocking departure from tra...

[bjh21 <bjh21%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/36876c98bd41
branches:  trunk
changeset: 545877:36876c98bd41
user:      bjh21 <bjh21%NetBSD.org@localhost>
date:      Thu Apr 17 11:46:09 2003 +0000

description:
In a shocking departure from tradition, provide useful documentation of the
state of mouse support in NetBSD/acorn32.  Maybe this will inspire someone
to make it work better.

Largely taken from bits of i386 documentation that are long obsolete, apart
from qms(4), which is entirely new (the old quadmouse(4) being useless).

diffstat:

 share/man/man4/man4.acorn32/Makefile   |   8 ++-
 share/man/man4/man4.acorn32/busmouse.4 |  81 ++++++++++++++++++++++++++++++++++
 share/man/man4/man4.acorn32/opms.4     |  70 +++++++++++++++++++++++++++++
 share/man/man4/man4.acorn32/qms.4      |  41 +++++++++++++++++
 4 files changed, 197 insertions(+), 3 deletions(-)

diffs (220 lines):

diff -r f1775dfb8d47 -r 36876c98bd41 share/man/man4/man4.acorn32/Makefile
--- a/share/man/man4/man4.acorn32/Makefile      Thu Apr 17 11:45:13 2003 +0000
+++ b/share/man/man4/man4.acorn32/Makefile      Thu Apr 17 11:46:09 2003 +0000
@@ -1,7 +1,9 @@
-#      $NetBSD: Makefile,v 1.1 2003/04/17 10:16:12 wiz Exp $
+#      $NetBSD: Makefile,v 1.2 2003/04/17 11:46:09 bjh21 Exp $
 
-MAN=   asc.4 autoconf.4 beep.4 cosc.4 csc.4 ie.4 intro.4 \
-       kbd.4 lpt.4 mainbus.4 mem.4 podulebus.4 ptsc.4
+MAN=   asc.4 autoconf.4 beep.4 busmouse.4 cosc.4 csc.4 ie.4 intro.4 \
+       kbd.4 lpt.4 mainbus.4 mem.4 opms.4 podulebus.4 ptsc.4 qms.4
+
+MLINKS=        qms.4 wsqms.4
 
 MANSUBDIR=/acorn32
 
diff -r f1775dfb8d47 -r 36876c98bd41 share/man/man4/man4.acorn32/busmouse.4
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/share/man/man4/man4.acorn32/busmouse.4    Thu Apr 17 11:46:09 2003 +0000
@@ -0,0 +1,81 @@
+.\"    $NetBSD: busmouse.4,v 1.1 2003/04/17 11:46:09 bjh21 Exp $
+.\"
+.\" Copyright (c) 1996 Michael Graff
+.\" 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 Michael Graff for the
+.\"      NetBSD Foundation, Inc.
+.\" 4. 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 March 12, 1997
+.Dt BUSMOUSE 4 acorn32
+.Os
+.Sh NAME
+.Nm busmouse
+.Nd Bus mouse driver
+.Sh SYNOPSIS
+.In machine/mouse.h
+.Sh DESCRIPTION
+Many mouse drivers internally convert the protocol
+the mouse uses natively to a common busmouse protocol.
+.Pp
+The drivers allow information to be retrieved from the driver using an
+.Xr ioctl 2
+call or by reading the device directly using
+.Xr read 2 .
+.Pp
+The
+.Dv MOUSEIOCREAD
+.Xr ioctl 2
+is defined in the header
+.Aq Pa machine/mouse.h .
+It returns a
+.Li struct mouseinfo .
+.Pp
+When reading the mouse device directly, each change of button state or
+mouse movement generates a five byte event.
+The bytes contain:
+.Bl -tag -width xxxx -offset indent -compact
+.It 1
+Button status. (u_char)
+.It 2
+Right/left movement.  Positive values indicate right, negative
+left. (char)
+.It 3
+Up/down movement.  Positive values indicate up, negative down. (char)
+.It 4
+Reserved.  Should be zero. (char)
+.It 5
+Reserved.  Should be zero. (char)
+.El
+.Pp
+The direction bytes are signed characters, giving a range of +127 to -127.
+A positive value indicates movement to the right or up, and a negative
+value movement left or down.
+.Sh SEE ALSO
+.Xr ioctl 2 ,
+.Xr read 2 ,
+.Xr qms 4 ,
+.Xr opms 4
diff -r f1775dfb8d47 -r 36876c98bd41 share/man/man4/man4.acorn32/opms.4
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/share/man/man4/man4.acorn32/opms.4        Thu Apr 17 11:46:09 2003 +0000
@@ -0,0 +1,70 @@
+.\" $NetBSD: opms.4,v 1.1 2003/04/17 11:46:09 bjh21 Exp $
+.\"
+.\" 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 for the
+.\"          NetBSD Project.  See http://www.netbsd.org/ for
+.\"          information about NetBSD.
+.\" 4. 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.
+.\"
+.\" <<Id: LICENSE,v 1.2 2000/06/14 15:57:33 cgd Exp>>
+.\"
+.Dd April 17 2003
+.Dt OPMS 4 acorn32
+.Os
+.Sh NAME
+.Nm opms
+.Nd PS/2 auxiliary port mouse driver
+.Sh SYNOPSIS
+.Cd opms* at iomd?
+.Sh DESCRIPTION
+This driver provides a interface to a PS/2 mouse port on ARM7500-
+and ARM7500FE-based machines which is backwards-compatible to previous
+.Nx Ns /acorn32
+versions without
+.Xr wscons 4
+support.
+The
+.Nm
+driver internally converts the PS/2 mouse output into
+.Xr busmouse 4
+protocol.
+.Sh FILES
+.Bl -tag -width Pa -compact
+.It Pa /dev/pms0
+first PS/2 mouse device.
+.El
+.Sh SEE ALSO
+.Xr busmouse 4 ,
+.Xr pms 4 ,
+.Xr qms 4 ,
+.Xr wsmouse 4
+.Sh BUGS
+This driver should be replaced be a
+.Xr wsmouse 4 Ns -compatible
+one, or even an instance of the machine-independent
+.Xr pms 4
+driver.
diff -r f1775dfb8d47 -r 36876c98bd41 share/man/man4/man4.acorn32/qms.4
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/share/man/man4/man4.acorn32/qms.4 Thu Apr 17 11:46:09 2003 +0000
@@ -0,0 +1,41 @@
+.\"    $NetBSD: qms.4,v 1.1 2003/04/17 11:46:10 bjh21 Exp $
+.\"
+.\" written by Ben Harris, 2003
+.\" This file is in the Public Domain
+.\"
+.Dd April 17, 2003
+.Dt QMS 4 acorn32
+.Os
+.Sh NAME
+.Nm qms ,
+.Nm wsqms
+.Nd Quadrature mouse drivers
+.Sh SYNOPSIS
+.Cd qms* at iomd?
+.Cd wsqms* at iomd?
+.Cd wsmouse* at wsqms?
+.Sh DESCRIPTION
+These drivers provide interfaces to an IOMD quadrature mouse, found on
+IOMD20-based systems such as the Acorn Risc PC.
+The
+.Nm qms
+driver provides an interface compatible with the
+.Xr busmouse 4
+protocol, while the
+.Nm wsqms
+driver interfaces to the
+.Xr wsmouse 4
+driver to provide a generic, machine-independent mouse interface.
+.Sh FILES
+.Bl -tag -width Pa -compact
+.It Pa /dev/qms0
+.Xr busmouse 4 Ns -compatible
+interface to
+.Nm qms
+.El
+.Sh SEE ALSO
+.Xr busmouse 4 ,
+.Xr opms 4 ,
+.Xr wsmouse 4
+.Sh BUGS
+These two drivers should be merged, or the old interface removed entirely.