share/man/man4/usb_template.4

   1 .\" $FreeBSD$
   2 .\"
   3 .\" Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .Dd August 7, 2019
  27 .Dt USB_TEMPLATE 4
  28 .Os
  29 .
  30 .Sh NAME
  31 .
  32 .
  33 .Nm usb_template
  34 .
  35 .Nd "USB device side templates"
  36 .
  37 .
  38 .Sh SYNOPSIS
  39 To compile this module into the kernel, place the following line in
  40 your kernel configuration file:
  41 .Bd -ragged -offset indent
  42 .Cd "device usb_template"
  43 .Ed
  44 .Pp
  45 To load the module at boot time, place the following line in
  46 .Xr loader.conf 5 :
  47 .Bd -literal -offset indent
  48 usb_template_load="YES"
  49 .Ed
  50 .
  51 .Sh DESCRIPTION
  52 The
  53 .Nm
  54 module implements various USB templates that are needed when
  55 programming an USB device side driver.
  56 .
  57 A USB template consists of an USB device descriptor, one or more USB
  58 configuration descriptors, one or more USB interface descriptors, one
  59 or more USB endpoint descriptors, USB strings and additional USB
  60 descriptors.
  61 .
  62 USB templates are selected using the
  63 .Va hw.usb.template
  64 sysctl and tunable,
  65 or by using the
  66 .Xr usbconfig 8
  67 .Cm set_template
  68 subcommand.
  69 Changing the
  70 .Va hw.usb.template
  71 sysctl triggers reenumeration by the USB host; changes to other sysctls
  72 may not be visible to the host until reenumeration is performed.
  73 .Pp
  74 Available templates are:
  75 .Bl -column -offset 3n "Value"
  76 .It Em Value Ta Em Description
  77 .It Dv 0 Ta USB Mass Storage, see
  78 .Xr cfumass 4
  79 .It Dv 1 Ta CDC Ethernet, see
  80 .Xr cdce 4
  81 .It Dv 2 Ta Media Transfer Protocol (MTP)
  82 .It Dv 3 Ta USB serial port, see
  83 .Xr umodem 4
  84 .It Dv 4 Ta USB audio
  85 .It Dv 5 Ta USB keyboard
  86 .It Dv 6 Ta USB mouse
  87 .It Dv 7 Ta USB phone
  88 .It Dv 8 Ta CDC Ethernet and serial port
  89 .It Dv 9 Ta USB MIDI
  90 .It Dv 10 Ta CDC Ethernet, serial port, and storage
  91 .It Dv 11 Ta CDC Ethernet Emulation Model, see
  92 .Xr cdceem 4
  93 .El
  94 .
  95 .Sh SYSCTL VARIABLES
  96 The following variables are available as both
  97 .Xr sysctl 8
  98 variables and
  99 .Xr loader 8
 100 tunables:
 101 .Bl -tag -width indent
 102 .It Va hw.usb.template
 103 Currently selected template.
 104 Set to -1 to make the device disappear from the USB host point of view.
 105 .It Va hw.usb.template_power
 106 USB bus power consumption in mA at 5V.
 107 Must be between 0 and 500.
 108 Setting to 0 marks the device as self-powered.
 109 Defaults to 500mA.
 110 .It Va hw.usb.templates.N
 111 Configuration for template number
 112 .Va N .
 113 .It Va hw.usb.templates.N.vendor_id
 114 16-bit vendor identifier (VID), usually assigned by USB-IF.
 115 .It Va hw.usb.templates.N.product_id
 116 16-bit product identifier (PID).
 117 .It Va hw.usb.templates.N.manufacturer
 118 String containing human-readable manufacturer name.
 119 .It Va hw.usb.templates.N.product
 120 String containing human-readable product name.
 121 .El
 122 .Sh SEE ALSO
 123 .Xr cfumass 4 ,
 124 .Xr usb 4 ,
 125 .Xr usfs 4 ,
 126 .Xr usbconfig 8
 127 .Sh STANDARDS
 128 The
 129 .Nm
 130 module complies to the USB 1.0, 2.0 and 3.0 standard.
 131 .Sh HISTORY
 132 The
 133 .Nm
 134 module was written by
 135 .An Hans Petter Selasky Aq Mt hselasky@FreeBSD.org .