1.\" $NetBSD: uhid.4,v 1.13 2001/12/29 14:41:59 augustss Exp $ 2.\" $FreeBSD: src/share/man/man4/uhid.4,v 1.1.2.3 2002/08/16 05:02:25 trhodes Exp $ 3.\" 4.\" Copyright (c) 1999, 2001 The NetBSD Foundation, Inc. 5.\" All rights reserved. 6.\" 7.\" This code is derived from software contributed to The NetBSD Foundation 8.\" by Lennart Augustsson. 9.\" 10.\" Redistribution and use in source and binary forms, with or without 11.\" modification, are permitted provided that the following conditions 12.\" are met: 13.\" 1. Redistributions of source code must retain the above copyright 14.\" notice, this list of conditions and the following disclaimer. 15.\" 2. Redistributions in binary form must reproduce the above copyright 16.\" notice, this list of conditions and the following disclaimer in the 17.\" documentation and/or other materials provided with the distribution. 18.\" 3. All advertising materials mentioning features or use of this software 19.\" must display the following acknowledgment: 20.\" This product includes software developed by the NetBSD 21.\" Foundation, Inc. and its contributors. 22.\" 4. Neither the name of The NetBSD Foundation nor the names of its 23.\" contributors may be used to endorse or promote products derived 24.\" from this software without specific prior written permission. 25.\" 26.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 27.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 28.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 29.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 30.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 31.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 32.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 33.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 34.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 35.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 36.\" POSSIBILITY OF SUCH DAMAGE. 37.\" 38.Dd July 12, 1998 39.Dt UHID 4 40.Os 41.Sh NAME 42.Nm uhid 43.Nd USB generic HID support 44.Sh SYNOPSIS 45.Cd "device uhid" 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_ID (int) 58Get the report identifier used by this HID report. 59.It Dv USB_GET_REPORT_DESC (struct usb_ctl_report_desc) 60Get the HID report descriptor. Using 61this descriptor the exact layout and meaning of data to/from 62the device can be found. The report descriptor is delivered 63without any processing. 64.Bd -literal 65struct usb_ctl_report_desc { 66 int size; 67 u_char data[1024]; /* filled data size will vary */ 68}; 69.Ed 70.It Dv USB_SET_IMMED (int) 71Sets the device in a mode where each 72.Xr read 2 73will return the current value of the input report. Normally 74a 75.Xr read 2 76will only return the data that the device reports on its 77interrupt pipe. This call may fail if the device does not support 78this feature. 79.It Dv USB_GET_REPORT (struct usb_ctl_report) 80Get a report from the device without waiting for data on 81the interrupt pipe. The 82.Fa report 83field indicates which report is requested. It should be 84.Dv UHID_INPUT_REPORT , 85.Dv UHID_OUTPUT_REPORT , 86or 87.Dv UHID_FEATURE_REPORT . 88This call may fail if the device does not support this feature. 89.Bd -literal 90struct usb_ctl_report { 91 int report; 92 u_char data[1024]; /* used data size will vary */ 93}; 94.Ed 95.It Dv USB_SET_REPORT (struct usb_ctl_report) 96Set a report in the device. The 97.Fa report 98field indicates which report is to be set. It should be 99.Dv UHID_INPUT_REPORT , 100.Dv UHID_OUTPUT_REPORT , 101or 102.Dv UHID_FEATURE_REPORT . 103This call may fail if the device does not support this feature. 104.El 105.Pp 106Use 107.Xr read 2 108to get data from the device. Data should be read in chunks of the 109size prescribed by the report descriptor. 110.Pp 111Use 112.Xr write 2 113send data to the device. Data should be written in chunks of the 114size prescribed by the report descriptor. 115.Sh FILES 116.Bl -tag -width Pa 117.It Pa /dev/uhid? 118.El 119.Sh SEE ALSO 120.Xr usbhidctl 1 , 121.Xr usb 4 122.Sh HISTORY 123The 124.Nm 125driver 126appeared in 127.Nx 1.4 . 128This manual page was adopted from 129.Nx 130by 131.An Tom Rhodes Aq Mt trhodes@FreeBSD.org 132in April 2002. 133