Update usb hid manpages to reflect new changes

From NetBSD

5 files changed, 113 insertions, 19 deletions

diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile
index 7d3e264a7d7..2d58fa11e92 100644
--- a/share/man/man4/Makefile
+++ b/share/man/man4/Makefile
@@ -1,4 +1,4 @@
-#	$OpenBSD: Makefile,v 1.205 2002/05/07 19:40:53 nate Exp $
+#	$OpenBSD: Makefile,v 1.206 2002/05/09 15:25:32 nate Exp $
 
 MAN=	aac.4 ac97.4 addcom.4 adv.4 aha.4 ahb.4 ahc.4 aic.4 ami.4 amphy.4 \
 	an.4 aria.4 ast.4 atalk.4 atapiscsi.4 \
@@ -26,7 +26,8 @@ MAN=	aac.4 ac97.4 addcom.4 adv.4 aha.4 ahb.4 ahc.4 aic.4 ami.4 amphy.4 \
 	sl.4 sm.4 spp.4 sppp.4 sqphy.4 ss.4 st.4 ste.4 stge.4 sti.4 sv.4 \
 	tb.4 tcic.4 tcp.4 termios.4 ti.4 tl.4 tlphy.4 \
 	tp.4 tqphy.4 trm.4 tty.4 tun.4 twe.4 tx.4 txp.4 txphy.4 \
-	uaudio.4 ubsec.4 ucom.4 udp.4 uftdi.4 ugen.4 uhci.4 uhid.4 uk.4 ukbd.4 \
+	uaudio.4 ubsec.4 ucom.4 udp.4 uftdi.4 ugen.4 uhci.4 uhid.4 uhidev.4 \
+	uk.4 ukbd.4 \
 	ukphy.4 ulpt.4 umodem.4 ums.4 umass.4 unix.4 upl.4 uplcom.4 urio.4 \
 	url.4 urlphy.4 usb.4 uscanner.4 usscanner.4 uvisor.4 uyap.4 \
 	vga.4 vlan.4 vnd.4 vr.4 \
diff --git a/share/man/man4/uhid.4 b/share/man/man4/uhid.4
index 3fe8a041752..5b379085063 100644
--- a/share/man/man4/uhid.4
+++ b/share/man/man4/uhid.4
@@ -1,7 +1,7 @@
-.\"	$OpenBSD: uhid.4,v 1.9 2001/12/30 07:24:07 pvalchev Exp $
-.\"	$NetBSD: uhid.4,v 1.6 1999/05/11 21:05:09 augustss Exp $
+.\" $OpenBSD: uhid.4,v 1.10 2002/05/09 15:25:32 nate Exp $
+.\" $NetBSD: uhid.4,v 1.13 2001/12/29 14:41:59 augustss Exp $
 .\"
-.\" Copyright (c) 1999 The NetBSD Foundation, Inc.
+.\" Copyright (c) 1999, 2001 The NetBSD Foundation, Inc.
 .\" All rights reserved.
 .\"
 .\" This code is derived from software contributed to The NetBSD Foundation
@@ -42,7 +42,7 @@
 .Nm uhid
 .Nd USB generic HID support
 .Sh SYNOPSIS
-.Cd "uhid* at uhub?"
+.Cd "uhid* at uhidev? reportid ?"
 .Sh DESCRIPTION
 The
 .Nm
@@ -54,6 +54,8 @@ The device handles the following
 calls:
 .Pp
 .Bl -tag -width indent -compact
+.It Dv USB_GET_REPORT_ID (int)
+Get the report identifier used by this HID report.
 .It Dv USB_GET_REPORT_DESC (struct usb_ctl_report_desc)
 Get the HID report descriptor.
 Using this descriptor the exact layout and meaning of data to/from
@@ -85,13 +87,23 @@ It should be
 .Dv UHID_OUTPUT_REPORT ,
 or
 .Dv UHID_FEATURE_REPORT .
-This call may fail if the device does not support
-this feature.
+This call may fail if the device does not support this feature.
 .Bd -literal
 struct usb_ctl_report {
 	int report;
-	u_char	data[1024];	/* filled data size will vary */
+	u_char	data[1024];	/* used data size will vary */
 };
+.It Dv USB_SET_REPORT (struct usb_ctl_report)
+Set a report in the device.
+The
+.Dv report
+field indicates which report is to be set.
+It should be
+.Dv UHID_INPUT_REPORT ,
+.Dv UHID_OUTPUT_REPORT ,
+or
+.Dv UHID_FEATURE_REPORT .
+This call may fail if the device does not support this feature.
 .Ed
 .El
 .Pp
diff --git a/share/man/man4/uhidev.4 b/share/man/man4/uhidev.4
new file mode 100644
index 00000000000..7631f65dfee
--- /dev/null
+++ b/share/man/man4/uhidev.4
@@ -0,0 +1,71 @@
+.\" $OpenBSD: uhidev.4,v 1.1 2002/05/09 15:25:32 nate Exp $
+.\" $NetBSD: uhidev.4,v 1.2 2001/12/29 03:06:41 augustss Exp $
+.\"
+.\" Copyright (c) 2001 The NetBSD Foundation, Inc.
+.\" All rights reserved.
+.\"
+.\" This code is derived from software contributed to The NetBSD Foundation
+.\" by Lennart Augustsson.
+.\"
+.\" 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 the NetBSD
+.\"        Foundation, Inc. and its contributors.
+.\" 4. Neither the name of The NetBSD Foundation nor the names of its
+.\"    contributors may be used to endorse or promote products derived
+.\"    from this software without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
+.\" ``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 FOUNDATION OR CONTRIBUTORS
+.\" 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 December 27, 2001
+.Dt UHIDEV 4
+.Os
+.Sh NAME
+.Nm uhidev
+.Nd USB Human Interface Device support
+.Sh SYNOPSIS
+.Cd "uhidev* at uhub?"
+.Cd "uhid*   at uhidev? reportid ?"
+.Cd "ukbd*   at uhidev? reportid ?"
+.Cd "ums*    at uhidev? reportid ?"
+.Sh DESCRIPTION
+The
+.Nm
+driver handles all Human Interface Devices.  Each HID device
+can have several components, e.g., a keyboard and a mouse.
+These components use different report identifiers (a byte) to
+distinguish which one data is coming from.  The
+.Nm
+driver has other drivers attached that handle particular
+kinds of devices and
+.Nm
+only dispatches data to them based on the report id.
+.Sh SEE ALSO
+.Xr uhid 4 ,
+.Xr ukbd 4 ,
+.Xr ums 4 ,
+.Xr usb 4
+.Sh HISTORY
+The
+.Nm
+driver
+appeared in
+.Ox 3.2 .
diff --git a/share/man/man4/ukbd.4 b/share/man/man4/ukbd.4
index 2d38134833a..c23ca82b47e 100644
--- a/share/man/man4/ukbd.4
+++ b/share/man/man4/ukbd.4
@@ -1,7 +1,7 @@
-.\" $OpenBSD: ukbd.4,v 1.2 2001/08/03 15:21:16 mpech Exp $
-.\" $NetBSD: ukbd.4,v 1.5 1999/12/15 22:07:34 abs Exp $
+.\" $OpenBSD: ukbd.4,v 1.3 2002/05/09 15:25:32 nate Exp $
+.\" $NetBSD: ukbd.4,v 1.10 2001/12/29 15:12:32 augustss Exp $
 .\"
-.\" Copyright (c) 1999 The NetBSD Foundation, Inc.
+.\" Copyright (c) 1999, 2001 The NetBSD Foundation, Inc.
 .\" All rights reserved.
 .\"
 .\" This code is derived from software contributed to The NetBSD Foundation
@@ -42,16 +42,18 @@
 .Nm ukbd
 .Nd USB keyboard support
 .Sh SYNOPSIS
-.Cd "ukbd*     at uhub?"
-.Cd "wskbd*    at ukbd? console ?"
+.Cd "ukbd*  at uhidev? reportid ?"
+.Cd "wskbd* at ukbd? console ?"
 .Sh DESCRIPTION
 The
 .Nm
-driver provides support for USB keyboards that follow the boot protocol.
+driver provides support for USB keyboards (i.e., HID devices
+with reports in usage page 7).
 Access to the keyboard is through the
 .Xr wscons 4
 driver.
 .Sh SEE ALSO
+.Xr uhidev 4 ,
 .Xr usb 4 ,
 .Xr wskbd 4
 .Sh HISTORY
@@ -63,3 +65,10 @@ appeared in
 .Ox
 support was added in
 .Ox 2.8 .
+.Sh BUGS
+The
+.Nm
+driver is brought into action rather late in the boot process, so if
+it is used as the console driver then
+.Xr ddb 4
+is not usable until late in the boot.
diff --git a/share/man/man4/ums.4 b/share/man/man4/ums.4
index 70308179aae..3e8a38d33ad 100644
--- a/share/man/man4/ums.4
+++ b/share/man/man4/ums.4
@@ -1,7 +1,7 @@
-.\" $OpenBSD: ums.4,v 1.3 2001/08/03 15:21:16 mpech Exp $
-.\" $NetBSD: ums.4,v 1.5 1999/04/13 20:25:29 augustss Exp $
+.\" $OpenBSD: ums.4,v 1.4 2002/05/09 15:25:32 nate Exp $
+.\" $NetBSD: ums.4,v 1.7 2001/12/28 17:38:00 augustss Exp $
 .\"
-.\" Copyright (c) 1999 The NetBSD Foundation, Inc.
+.\" Copyright (c) 1999, 2001 The NetBSD Foundation, Inc.
 .\" All rights reserved.
 .\"
 .\" This code is derived from software contributed to The NetBSD Foundation
@@ -42,7 +42,7 @@
 .Nm ums
 .Nd USB mouse support
 .Sh SYNOPSIS
-.Cd "ums*     at uhub?"
+.Cd "ums*     at uhidev? reportid ?"
 .Cd "wsmouse* at ums?"
 .Sh DESCRIPTION
 The
@@ -52,6 +52,7 @@ Access to the mouse is through the
 .Xr wscons 4
 driver.
 .Sh SEE ALSO
+.Xr uhidev 4 ,
 .Xr usb 4 ,
 .Xr wsmouse 4
 .Sh HISTORY