summaryrefslogtreecommitdiff
path: root/lib/libusbhid/usbhid.3
diff options
context:
space:
mode:
authorMike Pechkin <mpech@cvs.openbsd.org>2002-05-01 08:03:31 +0000
committerMike Pechkin <mpech@cvs.openbsd.org>2002-05-01 08:03:31 +0000
commit41434dbdbf3099a023505b5b3915bf4d9b778ee1 (patch)
tree1ca936fb3301ad4347fcc3a38fd2c83e87a15817 /lib/libusbhid/usbhid.3
parent04e9f1abe6384e852ca0207d882814dab9237dd4 (diff)
o) start new sentence on a new line;
o) always close .Bl tags; o) fix usage of .Xr; millert@ ok
Diffstat (limited to 'lib/libusbhid/usbhid.3')
-rw-r--r--lib/libusbhid/usbhid.328
1 files changed, 15 insertions, 13 deletions
diff --git a/lib/libusbhid/usbhid.3 b/lib/libusbhid/usbhid.3
index fbfc61077bb..066d3a8da34 100644
--- a/lib/libusbhid/usbhid.3
+++ b/lib/libusbhid/usbhid.3
@@ -1,4 +1,4 @@
-.\" $OpenBSD: usbhid.3,v 1.2 2002/04/30 16:31:42 mpech Exp $
+.\" $OpenBSD: usbhid.3,v 1.3 2002/05/01 08:03:30 mpech Exp $
.\" $NetBSD: usb.3,v 1.14 2001/04/09 12:09:49 wiz Exp $
.\"
.\" Copyright (c) 1999 Lennart Augustsson <augustss@netbsd.org>
@@ -96,11 +96,11 @@ A report descriptor can be obtained by calling
.Fn hid_get_report_desc
with a file descriptor obtained by opening a
.Xr uhid 4
-device. Alternatively a data buffer containing the report descriptor can be
-passed into
+device.
+Alternatively a data buffer containing the report descriptor can be passed into
.Fn hid_use_report_desc .
-The data is copied into an internal structure. When the report descriptor
-is no longer needed it should be freed by calling
+The data is copied into an internal structure.
+When the report descriptor is no longer needed it should be freed by calling
.Fn hid_dispose_report_desc .
The type
.Fa report_desc_t
@@ -113,8 +113,8 @@ fails it will return
To parse the report descriptor the
.Fn hid_start_parse
function should be called with a report descriptor and a set that
-describes which items that are interesting. The set is obtained
-by or-ing together values
+describes which items that are interesting.
+The set is obtained by or-ing together values
.Fa "(1 << k)"
where
.Fa k
@@ -144,17 +144,18 @@ can be found in
and the meaning of the components in the USB HID documentation.
.Pp
Data should be read/written to the device in the size of
-the report. The size of a report (of a certain kind) can be
-computed by the
+the report.
+The size of a report (of a certain kind) can be computed by the
.Fn hid_report_size
-function. If the report is prefixed by an ID byte it is
-stored at
+function.
+If the report is prefixed by an ID byte it is stored at
.Fa idp ,
otherwise it will contain 0.
.Pp
To locate a single item the
.Fn hid_locate
-function can be used. It should be given the usage code of
+function can be used.
+It should be given the usage code of
the item and its kind and it will fill the item and return
non-zero if the item was found.
.Ss NAME TRANSLATION FUNCTIONS
@@ -179,7 +180,8 @@ if it cannot be found.
Before any of these functions can be called the usage table
must be parsed, this is done by calling
.Fn hid_init
-with the name of the table. Passing
+with the name of the table.
+Passing
.Fa NULL
to this function will cause it to use the default table.
.Ss DATA EXTRACTION FUNCTIONS