share/man/man7d/hid.7d

   1 '\" te
   2 .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   4 .\"  See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the
   5 .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH HID 7D "May 13, 2017"
   7 .SH NAME
   8 hid \- Human interface device (HID) class driver
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBkeyboard@unit-address\fR
  13 \fBmouse@unit-address\fR
  14 \fBinput@unit-address:consumer_control\fR
  15 \fB#include <sys/hid.h>\fR
  16 \fBint ioctl(int fildes, int command, ... /*arg*/);\fR
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .LP
  21 The \fBhid\fR driver is a USBA (Solaris USB Architecture) compliant client
  22 driver that supports the \fIHuman Interface Device Class (HID) 1.0\fR
  23 specification. The Human Interface Device (HID) class encompasses devices
  24 controlled by humans to operate computer systems. Typical examples of HID
  25 devices include keyboards, mice, trackballs, and joysticks. HID also covers
  26 front-panel controls such as knobs, switches, and buttons. A USB device with
  27 multiple interfaces may have one interface for audio and a HID interface to
  28 define the buttons that control the audio.
  29 .sp
  30 .LP
  31 The \fBhid\fR driver is general and primarily handles the USB functionality of
  32 the device and generic HID functionality. For example, HID interfaces are
  33 required to have an interrupt pipe for the device to send data packets, and the
  34 \fBhid\fR driver opens the pipe to the interrupt endpoint and starts polling.
  35 The \fBhid\fR driver is also responsible for managing the device through the
  36 default control pipe. In addition to being a USB client driver, the \fBhid\fR
  37 driver is also a STREAMS driver so that modules may be pushed on top of it.
  38 .sp
  39 .LP
  40 The HID specification is flexible, and HID devices dynamically describe their
  41 packets and other parameters through a HID report descriptor. The HID parser is
  42 a misc module that parses the HID report descriptor and creates a database of
  43 information about the device. The \fBhid\fR driver queries the HID parser to
  44 find out the type and characteristics of the HID device. The HID specification
  45 predefines packet formats for the boot protocol keyboard and mouse.
  46 .SH IOCTLS
  47 .ne 2
  48 .na
  49 \fB\fBHIDIOCKMGDIRECT\fR\fR
  50 .ad
  51 .RS 19n
  52 This ioctl should only be addressed to a USB keyboard or mouse device. The
  53 \fBhid\fR driver maintains two streams for each USB keyboard/mouse instance: an
  54 internal one for the use of the kernel and an external one for the use of user
  55 applications. This ioctl returns the information of which stream gets the input
  56 for the moment.
  57 .sp
  58 \fIarg\fR must point to a variable of \fBint\fR type. Upon return, \fB0\fR
  59 means the internal stream gets the input, \fB1\fR means the external stream
  60 gets the input.
  61 .RE
  62
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fBHIDIOCKMSDIRECT\fR\fR
  67 .ad
  68 .RS 19n
  69 This ioctl should only be addressed to a USB keyboard or mouse device. The hid
  70 driver maintains two streams for each USB keyboard/mouse instance: an internal
  71 one for the use of the kernel and an external one for the use of user
  72 applications. This ioctl sets which stream should get the input for the moment.
  73 .sp
  74 \fIarg\fR must point to a variable of \fBint\fR type. The argument \fB0\fR
  75 means the internal stream gets the input, \fB1\fR means the external stream
  76 gets the input.
  77 .RE
  78
  79 .SH FILES
  80 .ne 2
  81 .na
  82 \fB\fB/kernel/drv/hid\fR\fR
  83 .ad
  84 .sp .6
  85 .RS 4n
  86 32-bit x86 ELF kernel hid module
  87 .RE
  88
  89 .sp
  90 .ne 2
  91 .na
  92 \fB\fB/kernel/drv/amd64/hid\fR\fR
  93 .ad
  94 .sp .6
  95 .RS 4n
  96 64-bit x86 ELF kernel hid module
  97 .RE
  98
  99 .sp
 100 .ne 2
 101 .na
 102 \fB\fB/kernel/drv/sparcv9/hid\fR\fR
 103 .ad
 104 .sp .6
 105 .RS 4n
 106 64-bit SPARC ELF kernel hid module
 107 .RE
 108
 109 .sp
 110 .ne 2
 111 .na
 112 \fB\fB/kernel/misc/hidparser\fR\fR
 113 .ad
 114 .sp .6
 115 .RS 4n
 116 32-bit x86 ELF kernel hidparser module
 117 .RE
 118
 119 .sp
 120 .ne 2
 121 .na
 122 \fB\fB/kernel/misc/amd64/hidparser\fR\fR
 123 .ad
 124 .sp .6
 125 .RS 4n
 126 64-bit x86 ELF kernel hidparser module
 127 .RE
 128
 129 .sp
 130 .ne 2
 131 .na
 132 \fB\fB/kernel/misc/sparcv9/hidparser\fR\fR
 133 .ad
 134 .sp .6
 135 .RS 4n
 136 64-bit SPARC ELF kernel hidparser module
 137 .RE
 138
 139 .SH ATTRIBUTES
 140 .LP
 141 See \fBattributes\fR(5) for descriptions of the following attributes:
 142 .sp
 143
 144 .sp
 145 .TS
 146 box;
 147 c | c
 148 l | l .
 149 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 150 _
 151 Architecture    SPARC, x86, PCI-based systems
 152 .TE
 153
 154 .SH SEE ALSO
 155 .LP
 156 \fBcfgadm_usb\fR(8), \fBattributes\fR(5), \fBusba\fR(7D), \fBvirtualkm\fR(7D)
 157 .sp
 158 .LP
 159 \fIWriting Device Drivers\fR
 160 .sp
 161 .LP
 162 \fISTREAMS Programming Guide\fR
 163 .sp
 164 .LP
 165 \fIUniversal Serial Bus Specification 1.0 and 1.1\fR
 166 .sp
 167 .LP
 168 \fIDevice Class Definition for Human Interface Devices (HID) 1.1\fR
 169 .sp
 170 .LP
 171 \fISystem Administration Guide: Basic Administration\fR
 172 .SH DIAGNOSTICS
 173 .ne 2
 174 .na
 175 \fBhid_attach: Unsupported HID device.\fR
 176 .ad
 177 .sp .6
 178 .RS 4n
 179 The device requires a protocol not supported by the hid driver.
 180 .RE
 181
 182 .sp
 183 .ne 2
 184 .na
 185 \fBParsing of hid descriptor failed.\fR
 186 .ad
 187 .sp .6
 188 .RS 4n
 189 The HID report descriptor cannot be parsed correctly. The device cannot be
 190 supported by the hid driver.
 191 .RE
 192
 193 .sp
 194 .ne 2
 195 .na
 196 \fBInvalid report descriptor.\fR
 197 .ad
 198 .sp .6
 199 .RS 4n
 200 The HID report descriptor is invalid. The device cannot be supported by the hid
 201 driver.
 202 .RE
 203
 204 .sp
 205 .LP
 206 The following messages may be logged into the system log. They are formatted in
 207 the following manner:
 208 .sp
 209 .in +2
 210 .nf
 211 <device path><hid<instance number>): message...
 212 .fi
 213 .in -2
 214 .sp
 215
 216 .sp
 217 .ne 2
 218 .na
 219 \fBhid_attach: Unsupported HID device.\fR
 220 .ad
 221 .sp .6
 222 .RS 4n
 223 The device cannot be supported by this version of the HID driver.
 224 .RE
 225
 226 .sp
 227 .ne 2
 228 .na
 229 \fBParsing of HID descriptor failed.\fR
 230 .ad
 231 .sp .6
 232 .RS 4n
 233 The device cannot be supported by this version of the HID driver.
 234 .RE
 235
 236 .sp
 237 .ne 2
 238 .na
 239 \fBInvalid report descriptor.\fR
 240 .ad
 241 .sp .6
 242 .RS 4n
 243 The device cannot be supported by this version of the HID driver.
 244 .RE
 245
 246 .SH NOTES
 247 .LP
 248 The hid driver currently supports only keyboard, mouse and audio HID control
 249 devices.
 250 .sp
 251 .LP
 252 Normally a mouse is not power managed and consequently, screen darkening can be
 253 undone with a mouse movement. If power management of the mouse is required, add
 254 the following line to \fBhid.conf\fR then reboot the system:
 255 .sp
 256 .in +2
 257 .nf
 258 hid-mouse-pm-enable;
 259 .fi
 260 .in -2
 261
 262 .sp
 263 .LP
 264 Modern mice that are power managed require a 'click' to wake up. Occasionally,
 265 this may cause unexpected results.