Sync uhid.4 with FreeBSD.
authorSascha Wildner <saw@online.de>
Fri, 14 Mar 2014 10:10:43 +0000 (11:10 +0100)
committerSascha Wildner <saw@online.de>
Fri, 14 Mar 2014 10:10:43 +0000 (11:10 +0100)
share/man/man4/uhid.4

index bf68d8d..f533524 100644 (file)
@@ -1,5 +1,4 @@
 .\" $NetBSD: uhid.4,v 1.13 2001/12/29 14:41:59 augustss Exp $
-.\" $FreeBSD: src/share/man/man4/uhid.4,v 1.1.2.3 2002/08/16 05:02:25 trhodes Exp $
 .\"
 .\" Copyright (c) 1999, 2001 The NetBSD Foundation, Inc.
 .\" All rights reserved.
 .\" 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 acknowledgment:
-.\"        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
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd July 12, 1998
+.\" $FreeBSD: head/share/man/man4/uhid.4 204605 2010-03-02 21:59:03Z joel $
+.\"
+.Dd March 14, 2014
 .Dt UHID 4
 .Os
 .Sh NAME
 .Nm uhid
 .Nd USB generic HID support
 .Sh SYNOPSIS
+To compile this driver into the kernel,
+place the following line in your
+kernel configuration file:
+.Bd -ragged -offset indent
 .Cd "device uhid"
+.Ed
+.Pp
+Alternatively, to load the driver as a
+module at boot time, place the following line in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+uhid_load="YES"
+.Ed
 .Sh DESCRIPTION
 The
 .Nm
@@ -52,35 +58,40 @@ in USB devices that do not have a special driver.
 The device handles the following
 .Xr ioctl 2
 calls:
-.Pp
-.Bl -tag -width indent -compact
-.It Dv USB_GET_REPORT_ID (int)
+.Bl -tag -width indent
+.It Dv USB_GET_REPORT_ID Pq Vt 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
+.It Dv USB_GET_REPORT_DESC Pq Vt "struct usb_ctl_report_desc"
+Get the HID report descriptor.
+Using
 this descriptor the exact layout and meaning of data to/from
-the device can be found.  The report descriptor is delivered
+the device can be found.
+The report descriptor is delivered
 without any processing.
 .Bd -literal
 struct usb_ctl_report_desc {
-    int     size;
-    u_char  data[1024];        /* filled data size will vary */
+    int     ucrd_size;
+    u_char  ucrd_data[1024];   /* filled data size will vary */
 };
 .Ed
-.It Dv USB_SET_IMMED (int)
+.It Dv USB_SET_IMMED Pq Vt int
 Sets the device in a mode where each
 .Xr read 2
-will return the current value of the input report.  Normally
+will return the current value of the input report.
+Normally
 a
 .Xr read 2
 will only return the data that the device reports on its
-interrupt pipe.  This call may fail if the device does not support
+interrupt pipe.
+This call may fail if the device does not support
 this feature.
-.It Dv USB_GET_REPORT (struct usb_ctl_report)
+.It Dv USB_GET_REPORT Pq Vt "struct usb_ctl_report"
 Get a report from the device without waiting for data on
-the interrupt pipe.  The
+the interrupt pipe.
+The
 .Fa report
-field indicates which report is requested.  It should be
+field indicates which report is requested.
+It should be
 .Dv UHID_INPUT_REPORT ,
 .Dv UHID_OUTPUT_REPORT ,
 or
@@ -88,14 +99,16 @@ or
 This call may fail if the device does not support this feature.
 .Bd -literal
 struct usb_ctl_report {
-       int report;
-       u_char  data[1024];     /* used data size will vary */
+       int ucr_report;
+       u_char  ucr_data[1024]; /* used data size will vary */
 };
 .Ed
-.It Dv USB_SET_REPORT (struct usb_ctl_report)
-Set a report in the device.  The
+.It Dv USB_SET_REPORT Pq Vt "struct usb_ctl_report"
+Set a report in the device.
+The
 .Fa report
-field indicates which report is to be set.  It should be
+field indicates which report is to be set.
+It should be
 .Dv UHID_INPUT_REPORT ,
 .Dv UHID_OUTPUT_REPORT ,
 or
@@ -105,15 +118,17 @@ This call may fail if the device does not support this feature.
 .Pp
 Use
 .Xr read 2
-to get data from the device.  Data should be read in chunks of the
+to get data from the device.
+Data should be read in chunks of the
 size prescribed by the report descriptor.
 .Pp
 Use
 .Xr write 2
-send data to the device.  Data should be written in chunks of the
+to send data to the device.
+Data should be written in chunks of the
 size prescribed by the report descriptor.
 .Sh FILES
-.Bl -tag -width Pa
+.Bl -tag -width ".Pa /dev/uhid?"
 .It Pa /dev/uhid?
 .El
 .Sh SEE ALSO