share/man/man4/uhid.4

   1 .\" $NetBSD: uhid.4,v 1.13 2001/12/29 14:41:59 augustss Exp $
   2 .\"
   3 .\" Copyright (c) 1999, 2001 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by Lennart Augustsson.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .\" $FreeBSD$
  31 .\"
  32 .Dd Oct 31, 2020
  33 .Dt UHID 4
  34 .Os
  35 .Sh NAME
  36 .Nm uhid
  37 .Nd USB generic HID support
  38 .Sh SYNOPSIS
  39 To compile this driver into the kernel,
  40 place the following line in your
  41 kernel configuration file:
  42 .Bd -ragged -offset indent
  43 .Cd "device uhid"
  44 .Ed
  45 .Pp
  46 Alternatively, to load the driver as a
  47 module at boot time, place the following line in
  48 .Xr loader.conf 5 :
  49 .Bd -literal -offset indent
  50 uhid_load="YES"
  51 .Ed
  52 .Sh DESCRIPTION
  53 The
  54 .Nm
  55 driver provides support for all HID (Human Interface Device) interfaces
  56 in USB devices that do not have a special driver.
  57 .Pp
  58 The device handles the following
  59 .Xr ioctl 2
  60 calls:
  61 .Bl -tag -width indent
  62 .It Dv USB_GET_REPORT_ID Pq Vt int
  63 Get the report identifier used by this HID report.
  64 .It Dv USB_GET_REPORT_DESC Pq Vt "struct usb_gen_descriptor"
  65 Get the HID report descriptor.
  66 Copies a maximum of
  67 .Va ugd_maxlen
  68 bytes of the report descriptor data into the memory
  69 specified by
  70 .Va ugd_data .
  71 Upon return
  72 .Va ugd_actlen
  73 is set to the number of bytes copied.
  74 Using
  75 this descriptor the exact layout and meaning of data to/from
  76 the device can be found.
  77 The report descriptor is delivered
  78 without any processing.
  79 .Bd -literal
  80 struct usb_gen_descriptor {
  81         void   *ugd_data;
  82         uint16_t ugd_maxlen;
  83         uint16_t ugd_actlen;
  84         uint8_t ugd_report_type;
  85         ...
  86 };
  87 .Ed
  88 .It Dv USB_SET_IMMED Pq Vt int
  89 Sets the device in a mode where each
  90 .Xr read 2
  91 will return the current value of the input report.
  92 Normally
  93 a
  94 .Xr read 2
  95 will only return the data that the device reports on its
  96 interrupt pipe.
  97 This call may fail if the device does not support
  98 this feature.
  99 .It Dv USB_GET_REPORT Pq Vt "struct usb_gen_descriptor"
 100 Get a report from the device without waiting for data on
 101 the interrupt pipe.
 102 Copies a maximum of
 103 .Va ugd_maxlen
 104 bytes of the report data into the memory specified by
 105 .Va ugd_data .
 106 Upon return
 107 .Va ugd_actlen
 108 is set to the number of bytes copied.
 109 The
 110 .Va ugd_report_type
 111 field indicates which report is requested.
 112 It should be
 113 .Dv UHID_INPUT_REPORT ,
 114 .Dv UHID_OUTPUT_REPORT ,
 115 or
 116 .Dv UHID_FEATURE_REPORT .
 117 This call may fail if the device does not support this feature.
 118 .It Dv USB_SET_REPORT Pq Vt "struct usb_gen_descriptor"
 119 Set a report in the device.
 120 The
 121 .Va ugd_report_type
 122 field indicates which report is to be set.
 123 It should be
 124 .Dv UHID_INPUT_REPORT ,
 125 .Dv UHID_OUTPUT_REPORT ,
 126 or
 127 .Dv UHID_FEATURE_REPORT .
 128 The value of the report is specified by the
 129 .Va ugd_data
 130 and the
 131 .Va ugd_maxlen
 132 fields.
 133 This call may fail if the device does not support this feature.
 134 .It Dv USB_GET_DEVICEINFO Pq Vt "struct usb_device_info"
 135 Returns information about the device, like USB vendor ID and USB product ID.
 136 This call will not issue any USB transactions.
 137 Also refer to
 138 .Xr ugen 4 .
 139 .El
 140 .Pp
 141 Use
 142 .Xr read 2
 143 to get data from the device.
 144 Data should be read in chunks of the
 145 size prescribed by the report descriptor.
 146 .Pp
 147 Use
 148 .Xr write 2
 149 to send data to the device.
 150 Data should be written in chunks of the
 151 size prescribed by the report descriptor.
 152 .Sh SYSCTL VARIABLES
 153 The following variables are available as both
 154 .Xr sysctl 8
 155 variables and
 156 .Xr loader 8
 157 tunables:
 158 .Bl -tag -width indent
 159 .It Va hw.usb.uhid.debug
 160 Debug output level, where 0 is debugging disabled and larger values increase
 161 debug message verbosity.
 162 Default is 0.
 163 .El
 164 .Sh FILES
 165 .Bl -tag -width ".Pa /dev/uhid?"
 166 .It Pa /dev/uhid?
 167 .El
 168 .Sh SEE ALSO
 169 .Xr usbhidctl 1 ,
 170 .Xr usb 4
 171 .Sh HISTORY
 172 The
 173 .Nm
 174 driver
 175 appeared in
 176 .Nx 1.4 .
 177 This manual page was adopted from
 178 .Nx
 179 by
 180 .An Tom Rhodes Aq Mt trhodes@FreeBSD.org
 181 in April 2002.