diff options
| author | Jacob McDonnell <jacob@jacobmcdonnell.com> | 2026-04-25 19:59:05 -0400 |
|---|---|---|
| committer | Jacob McDonnell <jacob@jacobmcdonnell.com> | 2026-04-25 19:59:05 -0400 |
| commit | 1f19f33e45791ea59aed048796fc68672c6723a5 (patch) | |
| tree | 54625fba89e91d1c2177801ec635e8528bba937f /static/netbsd/man4/uhid.4 3.html | |
| parent | ac5e55f5f2af5b92794c2aded46c6bae85b5f5ed (diff) | |
docs: Removed Precompiled HTML
Diffstat (limited to 'static/netbsd/man4/uhid.4 3.html')
| -rw-r--r-- | static/netbsd/man4/uhid.4 3.html | 131 |
1 files changed, 0 insertions, 131 deletions
diff --git a/static/netbsd/man4/uhid.4 3.html b/static/netbsd/man4/uhid.4 3.html deleted file mode 100644 index cad91074..00000000 --- a/static/netbsd/man4/uhid.4 3.html +++ /dev/null @@ -1,131 +0,0 @@ -<table class="head"> - <tr> - <td class="head-ltitle">UHID(4)</td> - <td class="head-vol">Device Drivers Manual</td> - <td class="head-rtitle">UHID(4)</td> - </tr> -</table> -<div class="manual-text"> -<section class="Sh"> -<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1> -<p class="Pp"><code class="Nm">uhid</code> — <span class="Nd">USB generic - HID support</span></p> -</section> -<section class="Sh"> -<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1> -<p class="Pp"><code class="Cd">uhid* at uhidev? reportid ? flags N</code></p> -</section> -<section class="Sh"> -<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> -<p class="Pp">The <code class="Nm">uhid</code> driver provides support for all - HID (Human Interface Device) interfaces in USB devices that do not have a - special driver.</p> -<p class="Pp">Normally the <code class="Nm">uhid</code> driver is used when no - other HID driver attaches to a device. If “flags 1” is - specified, the <code class="Nm">uhid</code> driver will instead attach with - a very high priority and always be used. Together with the - <code class="Cd">vendor</code> and <code class="Cd">product</code> locators - on the <a class="Xr">uhidev(4)</a> driver this can be used to force the - <code class="Nm">uhid</code> driver to be used for a certain device.</p> -<p class="Pp">The device handles the following <a class="Xr">ioctl(2)</a> - calls:</p> -<dl class="Bl-tag"> - <dt id="USB_GET_REPORT_ID"><a class="permalink" href="#USB_GET_REPORT_ID"><code class="Dv">USB_GET_REPORT_ID - (int)</code></a></dt> - <dd>Get the report identifier used by this HID report.</dd> - <dt id="USB_GET_REPORT_DESC"><a class="permalink" href="#USB_GET_REPORT_DESC"><code class="Dv">USB_GET_REPORT_DESC - (struct usb_ctl_report_desc)</code></a></dt> - <dd>Get the HID report descriptor. Using this descriptor the exact layout and - meaning of data to/from the device can be found. The report descriptor is - delivered without any processing. - <div class="Bd Pp Li"> - <pre>struct usb_ctl_report_desc { - int ucrd_size; - u_char ucrd_data[1024]; /* filled data size will vary */ -};</pre> - </div> - </dd> - <dt id="USB_SET_IMMED"><a class="permalink" href="#USB_SET_IMMED"><code class="Dv">USB_SET_IMMED - (int)</code></a></dt> - <dd>Sets the device in a mode where each <a class="Xr">read(2)</a> will return - the current value of the input report. Normally a - <a class="Xr">read(2)</a> will only return the data that the device - reports on its interrupt pipe. This call may fail if the device does not - support this feature.</dd> - <dt id="USB_GET_REPORT"><a class="permalink" href="#USB_GET_REPORT"><code class="Dv">USB_GET_REPORT - (struct usb_ctl_report)</code></a></dt> - <dd>Get a report from the device without waiting for data on the interrupt - pipe. The <code class="Dv">report</code> field indicates which report is - requested. It should be <code class="Dv">UHID_INPUT_REPORT</code>, - <code class="Dv">UHID_OUTPUT_REPORT</code>, or - <code class="Dv">UHID_FEATURE_REPORT</code>. This call may fail if the - device does not support this feature. - <div class="Bd Pp Li"> - <pre>struct usb_ctl_report { - int ucr_report; - u_char ucr_data[1024]; /* used data size will vary */ -};</pre> - </div> - </dd> - <dt id="USB_SET_REPORT"><a class="permalink" href="#USB_SET_REPORT"><code class="Dv">USB_SET_REPORT - (struct usb_ctl_report)</code></a></dt> - <dd>Set a report in the device. The <code class="Dv">report</code> field - indicates which report is to be set. It should be - <code class="Dv">UHID_INPUT_REPORT</code>, - <code class="Dv">UHID_OUTPUT_REPORT</code>, or - <code class="Dv">UHID_FEATURE_REPORT</code>. This call may fail if the - device does not support this feature.</dd> - <dt id="USB_GET_DEVICE_DESC"><a class="permalink" href="#USB_GET_DEVICE_DESC"><code class="Dv">USB_GET_DEVICE_DESC - (usb_device_descriptor_t)</code></a></dt> - <dd>Return the device descriptor.</dd> - <dt id="USB_GET_DEVICEINFO"><a class="permalink" href="#USB_GET_DEVICEINFO"><code class="Dv">USB_GET_DEVICEINFO - (struct usb_device_info)</code></a></dt> - <dd>Get an information summary for the device. This call will not issue any - USB transactions.</dd> - <dt id="USB_GET_STRING_DESC"><a class="permalink" href="#USB_GET_STRING_DESC"><code class="Dv">USB_GET_STRING_DESC - (struct usb_string_desc)</code></a></dt> - <dd>Get a string descriptor for the given language id and string index. - <div class="Bd Pp Li"> - <pre>struct usb_string_desc { - int usd_string_index; - int usd_language_id; - usb_string_descriptor_t usd_desc; -};</pre> - </div> - </dd> -</dl> -<p class="Pp">Use <a class="Xr">read(2)</a> to get data from the device. Data - should be read in chunks of the size prescribed by the report - descriptor.</p> -<p class="Pp">Use <a class="Xr">write(2)</a> send data to the device. Data - should be written in chunks of the size prescribed by the report - descriptor.</p> -</section> -<section class="Sh"> -<h1 class="Sh" id="FILES"><a class="permalink" href="#FILES">FILES</a></h1> -<dl class="Bl-tag"> - <dt><span class="Pa">/dev/uhid?</span></dt> - <dd style="width: auto;"> </dd> -</dl> -</section> -<section class="Sh"> -<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE - ALSO</a></h1> -<p class="Pp"><a class="Xr">usbhidaction(1)</a>, <a class="Xr">usbhidctl(1)</a>, - <a class="Xr">uhidev(4)</a>, <a class="Xr">usb(4)</a></p> -</section> -<section class="Sh"> -<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1> -<p class="Pp">The <code class="Nm">uhid</code> driver appeared in - <span class="Ux">NetBSD 1.4</span>. Support for the - <code class="Dv">USB_GET_DEVICEINFO</code> and - <code class="Dv">USB_GET_STRING_DESC</code> ioctls appeared in - <span class="Ux">NetBSD 2.0</span>.</p> -</section> -</div> -<table class="foot"> - <tr> - <td class="foot-date">May 14, 2012</td> - <td class="foot-os">NetBSD 10.1</td> - </tr> -</table> |
