lib/libusbhid/usbhid.3

   1 .\"     $NetBSD: usb.3,v 1.13 2000/09/24 02:17:52 augustss Exp $
   2 .\"
   3 .\" Copyright (c) 1999, 2001 Lennart Augustsson <augustss@NetBSD.org>
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\" $FreeBSD: src/lib/libusbhid/usbhid.3,v 1.18 2005/11/24 11:26:36 ru Exp $
  28 .\" $DragonFly: src/lib/libusbhid/usbhid.3,v 1.10 2008/11/26 17:17:16 swildner Exp $
  29 .\"
  30 .Dd November 24, 2008
  31 .Dt USBHID 3
  32 .Os
  33 .Sh NAME
  34 .Nm usbhid ,
  35 .Nm hid_get_report_desc ,
  36 .Nm hid_use_report_desc ,
  37 .Nm hid_dispose_report_desc ,
  38 .Nm hid_start_parse ,
  39 .Nm hid_end_parse ,
  40 .Nm hid_get_item ,
  41 .Nm hid_report_size ,
  42 .Nm hid_locate ,
  43 .Nm hid_usage_page ,
  44 .Nm hid_usage_in_page ,
  45 .Nm hid_init ,
  46 .Nm hid_get_data ,
  47 .Nm hid_set_data
  48 .Nd USB HID access routines
  49 .Sh LIBRARY
  50 .Lb libusbhid
  51 .Sh SYNOPSIS
  52 .In usbhid.h
  53 .Ft report_desc_t
  54 .Fn hid_get_report_desc "int file"
  55 .Ft report_desc_t
  56 .Fn hid_use_report_desc "unsigned char *data" "unsigned int size"
  57 .Ft void
  58 .Fn hid_dispose_report_desc "report_desc_t d"
  59 .Ft hid_data_t
  60 .Fn hid_start_parse "report_desc_t d" "int kindset" "int id"
  61 .Ft void
  62 .Fn hid_end_parse "hid_data_t s"
  63 .Ft int
  64 .Fn hid_get_item "hid_data_t s" "hid_item_t *h"
  65 .Ft int
  66 .Fn hid_report_size "report_desc_t d" "hid_kind_t k" "int id"
  67 .Ft int
  68 .Fn hid_locate "report_desc_t d" "u_int usage" "hid_kind_t k" "hid_item_t *h" "int id"
  69 .Ft "const char *"
  70 .Fn hid_usage_page "int i"
  71 .Ft "const char *"
  72 .Fn hid_usage_in_page "u_int u"
  73 .Ft int
  74 .Fn hid_parse_usage_page "const char *"
  75 .Ft int
  76 .Fn hid_parse_usage_in_page "const char *"
  77 .Ft void
  78 .Fn hid_init "const char *file"
  79 .Ft int
  80 .Fn hid_get_data "const void *data" "const hid_item_t *h"
  81 .Ft void
  82 .Fn hid_set_data "void *buf" "const hid_item_t *h" "int data"
  83 .Sh DESCRIPTION
  84 The
  85 .Nm
  86 library provides routines to extract data from USB Human Interface Devices.
  87 .Ss Introduction
  88 USB HID devices send and receive data layed out in a device dependent way.
  89 The
  90 .Nm
  91 library contains routines to extract the
  92 .Em "report descriptor"
  93 which contains the data layout information and then use this information.
  94 .Pp
  95 The routines can be divided into four parts: extraction of the descriptor,
  96 parsing of the descriptor, translating to/from symbolic names, and
  97 data manipulation.
  98 .Ss Descriptor Functions
  99 A report descriptor can be obtained by calling
 100 .Fn hid_get_report_desc
 101 with a file descriptor obtained by opening a
 102 .Xr uhid 4
 103 device.
 104 Alternatively a data buffer containing the report descriptor can be
 105 passed into
 106 .Fn hid_use_report_desc .
 107 The data is copied into an internal structure.
 108 When the report descriptor
 109 is no longer needed it should be freed by calling
 110 .Fn hid_dispose_report_desc .
 111 The type
 112 .Vt report_desc_t
 113 is opaque and should be used when calling the parsing functions.
 114 If
 115 .Fn hid_dispose_report_desc
 116 fails it will return
 117 .Dv NULL .
 118 .Ss Descriptor Parsing Functions
 119 To parse the report descriptor the
 120 .Fn hid_start_parse
 121 function should be called with a report descriptor and a set that
 122 describes which items that are interesting.
 123 The set is obtained by OR-ing together values
 124 .Fa "(1 << k)"
 125 where
 126 .Fa k
 127 is an item of type
 128 .Vt hid_kind_t .
 129 The report ID (if present) is given by
 130 .Fa id .
 131 The function returns
 132 .Dv NULL
 133 if the initialization fails, otherwise an opaque value to be used
 134 in subsequent calls.
 135 After parsing the
 136 .Fn hid_end_parse
 137 function should be called to free internal data structures.
 138 .Pp
 139 To iterate through all the items in the report descriptor
 140 .Fn hid_get_item
 141 should be called while it returns a value greater than 0.
 142 When the report descriptor ends it will returns 0; a syntax
 143 error within the report descriptor will cause a return value less
 144 than 0.
 145 The struct pointed to by
 146 .Fa h
 147 will be filled with the relevant data for the item.
 148 The definition of
 149 .Vt hid_item_t
 150 can be found in
 151 .In usbhid.h
 152 and the meaning of the components in the USB HID documentation.
 153 .Pp
 154 Data should be read/written to the device in the size of
 155 the report.
 156 The size of a report (of a certain kind) can be computed by the
 157 .Fn hid_report_size
 158 function.
 159 If the report is prefixed by an ID byte it is given by
 160 .Fa id .
 161 .Pp
 162 To locate a single item the
 163 .Fn hid_locate
 164 function can be used.
 165 It should be given the usage code of
 166 the item and its kind and it will fill the item and return
 167 non-zero if the item was found.
 168 .Ss Name Translation Functions
 169 The function
 170 .Fn hid_usage_page
 171 will return the symbolic name of a usage page, and the function
 172 .Fn hid_usage_in_page
 173 will return the symbolic name of the usage within the page.
 174 Both these functions may return a pointer to static data.
 175 .Pp
 176 The functions
 177 .Fn hid_parse_usage_page
 178 and
 179 .Fn hid_parse_usage_in_page
 180 are the inverses of
 181 .Fn hid_usage_page
 182 and
 183 .Fn hid_usage_in_page .
 184 They take a usage string and return the number of the usage, or \-1
 185 if it cannot be found.
 186 .Pp
 187 Before any of these functions can be called the usage table
 188 must be parsed, this is done by calling
 189 .Fn hid_init
 190 with the name of the table.
 191 Passing
 192 .Dv NULL
 193 to this function will cause it to use the default table.
 194 .Ss Data Extraction Functions
 195 Given the data obtained from a HID device and an item in the
 196 report descriptor the
 197 .Fn hid_get_data
 198 function extracts the value of the item.
 199 Conversely
 200 .Fn hid_set_data
 201 can be used to put data into a report (which must be zeroed first).
 202 .Sh FILES
 203 .Bl -tag -width ".Pa /usr/share/misc/usb_hid_usages"
 204 .It Pa /usr/share/misc/usb_hid_usages
 205 The default HID usage table.
 206 .El
 207 .Sh EXAMPLES
 208 Not yet.
 209 .Sh SEE ALSO
 210 The
 211 .Tn USB
 212 specifications can be found at
 213 .Pa http://www.usb.org/developers/docs/ .
 214 .Pp
 215 .Xr uhid 4 ,
 216 .Xr usb 4
 217 .Sh HISTORY
 218 The
 219 .Nm
 220 library first appeared in
 221 .Nx 1.5 .
 222 .Sh BUGS
 223 This man page is woefully incomplete.