1.\" $NetBSD: uhid.4,v 1.10 2001/09/11 23:18:55 wiz Exp $ 2.\" 3.\" Copyright (c) 1999 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.\" 3. All advertising materials mentioning features or use of this software 18.\" must display the following acknowledgement: 19.\" This product includes software developed by the NetBSD 20.\" Foundation, Inc. and its contributors. 21.\" 4. Neither the name of The NetBSD Foundation nor the names of its 22.\" contributors may be used to endorse or promote products derived 23.\" from this software without specific prior written permission. 24.\" 25.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 26.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 27.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 28.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 29.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 30.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 31.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 32.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 33.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 34.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 35.\" POSSIBILITY OF SUCH DAMAGE. 36.\" 37.Dd July 12, 1998 38.Dt UHID 4 39.Os 40.Sh NAME 41.Nm uhid 42.Nd USB generic HID support 43.Sh SYNOPSIS 44.Cd "uhid* at uhub?" 45.Sh DESCRIPTION 46The 47.Nm 48driver provides support for all HID (Human Interface Device) interfaces 49in USB devices that do not have a special driver. 50.Pp 51The device handles the following 52.Xr ioctl 2 53calls: 54.Pp 55.Bl -tag -width indent -compact 56.It Dv USB_GET_REPORT_DESC (struct usb_ctl_report_desc) 57Get the HID report descriptor. Using 58this descriptor the exact layout and meaning of data to/from 59the device can be found. The report descriptor is delivered 60without any processing. 61.Bd -literal 62struct usb_ctl_report_desc { 63 int size; 64 u_char data[1024]; /* filled data size will vary */ 65}; 66.Ed 67.It Dv USB_SET_IMMED (int) 68Sets the device in a mode where each 69.Xr read 2 70will return the current value of the input report. Normally 71a 72.Xr read 2 73will only return the data that the device reports on its 74interrupt pipe. This call may fail if the device does not support 75this feature. 76.It Dv USB_GET_REPORT (struct usb_ctl_report) 77Get a report from the device without waiting for data on 78the interrupt pipe. The 79.Dv report 80field indicates which report is requested. It should be 81.Dv UHID_INPUT_REPORT , 82.Dv UHID_OUTPUT_REPORT , 83or 84.Dv UHID_FEATURE_REPORT . 85This call may fail if the device does not support this feature. 86.Bd -literal 87struct usb_ctl_report { 88 int report; 89 u_char data[1024]; /* used data size will vary */ 90}; 91.It Dv USB_SET_REPORT (struct usb_ctl_report) 92Set a report in the device. The 93.Dv report 94field indicates which report is to be set. It should be 95.Dv UHID_INPUT_REPORT , 96.Dv UHID_OUTPUT_REPORT , 97or 98.Dv UHID_FEATURE_REPORT . 99This call may fail if the device does not support this feature. 100.Ed 101.El 102.Pp 103Use 104.Xr read 2 105to get data from the device. Data should be read in chunks of the 106size prescribed by the report descriptor. 107.Pp 108Use 109.Xr write 2 110send data to the device. Data should be written in chunks of the 111size prescribed by the report descriptor. 112.Sh FILES 113.Bl -tag -width Pa 114.It Pa /dev/uhid? 115.El 116.Sh SEE ALSO 117.Xr usbhidctl 1 , 118.Xr usb 3 , 119.Xr usb 4 120.Sh HISTORY 121The 122.Nm 123driver 124appeared in 125.Nx 1.4 . 126