diff options
author | ru <ru@FreeBSD.org> | 2002-05-30 12:39:38 +0000 |
---|---|---|
committer | ru <ru@FreeBSD.org> | 2002-05-30 12:39:38 +0000 |
commit | 21f1002bbbf6ac4bbd1465803a3166fd479d022d (patch) | |
tree | b498d5ca50b22dee3e15931ac1cbf424e91cc272 /share/man/man4/uhid.4 | |
parent | 934525de9ecc1a8955abff7f1afee86deca92340 (diff) | |
download | FreeBSD-src-21f1002bbbf6ac4bbd1465803a3166fd479d022d.zip FreeBSD-src-21f1002bbbf6ac4bbd1465803a3166fd479d022d.tar.gz |
mdoc(7) police: fixed markup.
This manpage is still too NetBSD-centric.
Diffstat (limited to 'share/man/man4/uhid.4')
-rw-r--r-- | share/man/man4/uhid.4 | 57 |
1 files changed, 34 insertions, 23 deletions
diff --git a/share/man/man4/uhid.4 b/share/man/man4/uhid.4 index 342fe33..374dfb6 100644 --- a/share/man/man4/uhid.4 +++ b/share/man/man4/uhid.4 @@ -1,5 +1,4 @@ .\" $NetBSD: uhid.4,v 1.13 2001/12/29 14:41:59 augustss Exp $ -.\" $FreeBSD$ .\" .\" Copyright (c) 1999, 2001 The NetBSD Foundation, Inc. .\" All rights reserved. @@ -35,6 +34,8 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" +.\" $FreeBSD$ +.\" .Dd July 12, 1998 .Dt UHID 4 .Os @@ -52,14 +53,15 @@ 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 { @@ -67,20 +69,24 @@ struct usb_ctl_report_desc { u_char 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 -.Dv report -field indicates which report is requested. It should be +the interrupt pipe. +The +.Va report +field indicates which report is requested. +It should be .Dv UHID_INPUT_REPORT , .Dv UHID_OUTPUT_REPORT , or @@ -91,29 +97,33 @@ struct usb_ctl_report { int report; 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 +.Ed +.It Dv USB_SET_REPORT Pq Vt "struct usb_ctl_report" +Set a report in the device. +The +.Va 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 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 @@ -130,5 +140,6 @@ appeared in .Nx 1.4 . This manual page was adopted from .Nx -by Tom Rhodes <trhodes@FreeBSD.org> +by +.An Tom Rhodes Aq trhodes@FreeBSD.org in April 2002. |