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: head/share/man/man4/uhid.4 204605 2010-03-02 21:59:03Z joel $
  31 .\"
  32 .Dd March 14, 2014
  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_ctl_report_desc"
  65 Get the HID report descriptor.
  66 Using
  67 this descriptor the exact layout and meaning of data to/from
  68 the device can be found.
  69 The report descriptor is delivered
  70 without any processing.
  71 .Bd -literal
  72 struct usb_ctl_report_desc {
  73     int     ucrd_size;
  74     u_char  ucrd_data[1024];    /* filled data size will vary */
  75 };
  76 .Ed
  77 .It Dv USB_SET_IMMED Pq Vt int
  78 Sets the device in a mode where each
  79 .Xr read 2
  80 will return the current value of the input report.
  81 Normally
  82 a
  83 .Xr read 2
  84 will only return the data that the device reports on its
  85 interrupt pipe.
  86 This call may fail if the device does not support
  87 this feature.
  88 .It Dv USB_GET_REPORT Pq Vt "struct usb_ctl_report"
  89 Get a report from the device without waiting for data on
  90 the interrupt pipe.
  91 The
  92 .Fa report
  93 field indicates which report is requested.
  94 It should be
  95 .Dv UHID_INPUT_REPORT ,
  96 .Dv UHID_OUTPUT_REPORT ,
  97 or
  98 .Dv UHID_FEATURE_REPORT .
  99 This call may fail if the device does not support this feature.
 100 .Bd -literal
 101 struct usb_ctl_report {
 102         int ucr_report;
 103         u_char  ucr_data[1024]; /* used data size will vary */
 104 };
 105 .Ed
 106 .It Dv USB_SET_REPORT Pq Vt "struct usb_ctl_report"
 107 Set a report in the device.
 108 The
 109 .Fa report
 110 field indicates which report is to be set.
 111 It should be
 112 .Dv UHID_INPUT_REPORT ,
 113 .Dv UHID_OUTPUT_REPORT ,
 114 or
 115 .Dv UHID_FEATURE_REPORT .
 116 This call may fail if the device does not support this feature.
 117 .El
 118 .Pp
 119 Use
 120 .Xr read 2
 121 to get data from the device.
 122 Data should be read in chunks of the
 123 size prescribed by the report descriptor.
 124 .Pp
 125 Use
 126 .Xr write 2
 127 to send data to the device.
 128 Data should be written in chunks of the
 129 size prescribed by the report descriptor.
 130 .Sh FILES
 131 .Bl -tag -width ".Pa /dev/uhid?"
 132 .It Pa /dev/uhid?
 133 .El
 134 .Sh SEE ALSO
 135 .Xr usbhidctl 1 ,
 136 .Xr usb 4
 137 .Sh HISTORY
 138 The
 139 .Nm
 140 driver
 141 appeared in
 142 .Nx 1.4 .
 143 This manual page was adopted from
 144 .Nx
 145 by
 146 .An Tom Rhodes Aq Mt trhodes@FreeBSD.org
 147 in April 2002.