1.\" $NetBSD: uhid.4,v 1.8 2000/03/20 01:35:30 augustss 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.Pp 46.Sh DESCRIPTION 47The 48.Nm 49driver provides support for all HID (Human Interface Device) interfaces 50in USB devices that do not have a special driver. 51.Pp 52The device handles the following 53.Xr ioctl 2 54calls: 55.Pp 56.Bl -tag -width indent -compact 57.It Dv USB_GET_REPORT_DESC (struct usb_ctl_report_desc) 58Get the HID report descriptor. Using 59this descriptor the exact layout and meaning of data to/from 60the device can be found. The report descriptor is delivered 61without any processing. 62.Bd -literal 63struct usb_ctl_report_desc { 64 int size; 65 u_char data[1024]; /* filled data size will vary */ 66}; 67.Ed 68.It Dv USB_SET_IMMED (int) 69Sets the device in a mode where each 70.Xr read 2 71will return the current value of the input report. Normally 72a 73.Xr read 2 74will only return the data that the device reports on its 75interrupt pipe. This call may fail if the device does not support 76this feature. 77.It Dv USB_GET_REPORT (struct usb_ctl_report) 78Get a report from the device without waiting for data on 79the interrupt pipe. The 80.Dv report 81field indicates which report is requested. It should be 82.Dv UHID_INPUT_REPORT , 83.Dv UHID_OUTPUT_REPORT , 84or 85.Dv UHID_FEATURE_REPORT . 86This call may fail if the device does not support this feature. 87.Bd -literal 88struct usb_ctl_report { 89 int report; 90 u_char data[1024]; /* used data size will vary */ 91}; 92.It Dv USB_SET_REPORT (struct usb_ctl_report) 93Set a report in the device. The 94.Dv report 95field indicates which report is to be set. It should be 96.Dv UHID_INPUT_REPORT , 97.Dv UHID_OUTPUT_REPORT , 98or 99.Dv UHID_FEATURE_REPORT . 100This call may fail if the device does not support this feature. 101.Ed 102.El 103.Pp 104Use 105.Xr read 2 106to get data from the device. Data should be read in chunks of the 107size prescribed by the report descriptor. 108.Pp 109Use 110.Xr write 2 111send data to the device. Data should be written in chunks of the 112size prescribed by the report descriptor. 113.Sh FILES 114.Bl -tag -width Pa 115.It Pa /dev/uhid? 116.El 117.Sh SEE ALSO 118.Xr usb 3 , 119.Xr usb 4 , 120.Xr usbhidctl 1 121.Sh HISTORY 122The 123.Nm 124driver 125appeared in 126.Nx 1.4 . 127