diff options
Diffstat (limited to 'static/freebsd/man4/usb_template.4 3.html')
| -rw-r--r-- | static/freebsd/man4/usb_template.4 3.html | 142 |
1 files changed, 0 insertions, 142 deletions
diff --git a/static/freebsd/man4/usb_template.4 3.html b/static/freebsd/man4/usb_template.4 3.html deleted file mode 100644 index caa96d4b..00000000 --- a/static/freebsd/man4/usb_template.4 3.html +++ /dev/null @@ -1,142 +0,0 @@ -<table class="head"> - <tr> - <td class="head-ltitle">USB_TEMPLATE(4)</td> - <td class="head-vol">Device Drivers Manual</td> - <td class="head-rtitle">USB_TEMPLATE(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">usb_template</code> — <span class="Nd">USB - device side templates</span></p> -</section> -<section class="Sh"> -<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1> -<p class="Pp">To compile this module into the kernel, place the following line - in your kernel configuration file:</p> -<div class="Bd Pp Bd-indent"><code class="Cd">device usb_template</code></div> -<p class="Pp">To load the module at boot time, place the following line in - <a class="Xr">loader.conf(5)</a>:</p> -<div class="Bd Pp Bd-indent Li"> -<pre>usb_template_load="YES"</pre> -</div> -</section> -<section class="Sh"> -<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> -<p class="Pp">The <code class="Nm">usb_template</code> module implements various - USB templates that are needed when programming an USB device side driver. A - USB template consists of an USB device descriptor, one or more USB - configuration descriptors, one or more USB interface descriptors, one or - more USB endpoint descriptors, USB strings and additional USB descriptors. - USB templates are selected using the <var class="Va">hw.usb.template</var> - sysctl and tunable, or by using the <a class="Xr">usbconfig(8)</a> - <code class="Cm">set_template</code> subcommand. Changing the - <var class="Va">hw.usb.template</var> sysctl triggers reenumeration by the - USB host; changes to other sysctls may not be visible to the host until - reenumeration is performed.</p> -<p class="Pp">Available templates are:</p> -<table class="Bl-column Bd-indent"> - <tr id="Value"> - <td><a class="permalink" href="#Value"><i class="Em">Value</i></a></td> - <td><a class="permalink" href="#Description"><i class="Em" id="Description">Description</i></a></td> - </tr> - <tr id="0"> - <td><a class="permalink" href="#0"><code class="Dv">0</code></a></td> - <td>USB Mass Storage, see <a class="Xr">cfumass(4)</a></td> - </tr> - <tr id="1"> - <td><a class="permalink" href="#1"><code class="Dv">1</code></a></td> - <td>CDC Ethernet, see <a class="Xr">cdce(4)</a></td> - </tr> - <tr id="2"> - <td><a class="permalink" href="#2"><code class="Dv">2</code></a></td> - <td>Media Transfer Protocol (MTP)</td> - </tr> - <tr id="3"> - <td><a class="permalink" href="#3"><code class="Dv">3</code></a></td> - <td>USB serial port, see <a class="Xr">umodem(4)</a></td> - </tr> - <tr id="4"> - <td><a class="permalink" href="#4"><code class="Dv">4</code></a></td> - <td>USB audio</td> - </tr> - <tr id="5"> - <td><a class="permalink" href="#5"><code class="Dv">5</code></a></td> - <td>USB keyboard</td> - </tr> - <tr id="6"> - <td><a class="permalink" href="#6"><code class="Dv">6</code></a></td> - <td>USB mouse</td> - </tr> - <tr id="7"> - <td><a class="permalink" href="#7"><code class="Dv">7</code></a></td> - <td>USB phone</td> - </tr> - <tr id="8"> - <td><a class="permalink" href="#8"><code class="Dv">8</code></a></td> - <td>CDC Ethernet and serial port</td> - </tr> - <tr id="9"> - <td><a class="permalink" href="#9"><code class="Dv">9</code></a></td> - <td>USB MIDI</td> - </tr> - <tr id="10"> - <td><a class="permalink" href="#10"><code class="Dv">10</code></a></td> - <td>CDC Ethernet, serial port, and storage</td> - </tr> - <tr id="11"> - <td><a class="permalink" href="#11"><code class="Dv">11</code></a></td> - <td>CDC Ethernet Emulation Model, see <a class="Xr">cdceem(4)</a></td> - </tr> -</table> -</section> -<section class="Sh"> -<h1 class="Sh" id="SYSCTL_VARIABLES"><a class="permalink" href="#SYSCTL_VARIABLES">SYSCTL - VARIABLES</a></h1> -<p class="Pp">The following variables are available as both - <a class="Xr">sysctl(8)</a> variables and <a class="Xr">loader(8)</a> - tunables:</p> -<dl class="Bl-tag"> - <dt id="hw.usb.template"><var class="Va">hw.usb.template</var></dt> - <dd>Currently selected template. Set to -1 to make the device disappear from - the USB host point of view.</dd> - <dt id="hw.usb.template_power"><var class="Va">hw.usb.template_power</var></dt> - <dd>USB bus power consumption in mA at 5V. Must be between 0 and 500. Setting - to 0 marks the device as self-powered. Defaults to 500mA.</dd> - <dt id="hw.usb.templates.N"><var class="Va">hw.usb.templates.N</var></dt> - <dd>Configuration for template number <var class="Va">N</var>.</dd> - <dt id="hw.usb.templates.N.vendor_id"><var class="Va">hw.usb.templates.N.vendor_id</var></dt> - <dd>16-bit vendor identifier (VID), usually assigned by USB-IF.</dd> - <dt id="hw.usb.templates.N.product_id"><var class="Va">hw.usb.templates.N.product_id</var></dt> - <dd>16-bit product identifier (PID).</dd> - <dt id="hw.usb.templates.N.manufacturer"><var class="Va">hw.usb.templates.N.manufacturer</var></dt> - <dd>String containing human-readable manufacturer name.</dd> - <dt id="hw.usb.templates.N.product"><var class="Va">hw.usb.templates.N.product</var></dt> - <dd>String containing human-readable product name.</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">cfumass(4)</a>, <a class="Xr">usb(4)</a>, - <a class="Xr">usfs(4)</a>, <a class="Xr">usbconfig(8)</a></p> -</section> -<section class="Sh"> -<h1 class="Sh" id="STANDARDS"><a class="permalink" href="#STANDARDS">STANDARDS</a></h1> -<p class="Pp">The <code class="Nm">usb_template</code> module complies to the - USB 1.0, 2.0 and 3.0 standard.</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">usb_template</code> module was written by - <span class="An">Hans Petter Selasky</span> - <<a class="Mt" href="mailto:hselasky@FreeBSD.org">hselasky@FreeBSD.org</a>>.</p> -</section> -</div> -<table class="foot"> - <tr> - <td class="foot-date">August 7, 2019</td> - <td class="foot-os">FreeBSD 15.0</td> - </tr> -</table> |