share/man/man4/usb.4

   1 .\" Copyright (c) 1997, 1998 Nick Hibma <n_hibma@FreeBSD.org>
   2 .\" Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd April 24, 2018
  28 .Dt USB 4
  29 .Os
  30 .Sh NAME
  31 .Nm usb
  32 .Nd Universal Serial Bus
  33 .Sh SYNOPSIS
  34 To compile this driver into the kernel,
  35 place the following line in your
  36 kernel configuration file:
  37 .Bd -ragged -offset indent
  38 .Cd "device usb"
  39 .Ed
  40 .Pp
  41 Alternatively, to load the driver as a
  42 module at boot time, place the following line in
  43 .Xr loader.conf 5 :
  44 .Bd -literal -offset indent
  45 usb_load="YES"
  46 .Ed
  47 .Sh USERLAND PROGRAMMING
  48 USB functions can be accessed from userland through the libusb library.
  49 See
  50 .Xr libusb 3
  51 for more information.
  52 .Sh DESCRIPTION
  53 .Fx
  54 provides machine-independent bus support and drivers for
  55 .Tn USB
  56 devices in host and device side mode.
  57 .Pp
  58 The
  59 .Nm
  60 driver has three layers:
  61 .Bl -tag -width 6n -offset indent
  62 .It USB Controller (Bus)
  63 .It USB Device
  64 .It USB Driver
  65 .El
  66 .Pp
  67 The controller attaches to a physical bus
  68 like
  69 .Xr pci 4 .
  70 The
  71 .Tn USB
  72 bus attaches to the controller, and the root hub attaches
  73 to the controller.
  74 Any devices attached to the bus will attach to the root hub
  75 or another hub attached to the
  76 .Tn USB
  77 bus.
  78 .Pp
  79 The
  80 .Nm uhub
  81 device will always be present as it is needed for the root hub.
  82 .Sh INTRODUCTION TO USB
  83 The
  84 .Tn USB
  85 is a system where external devices can be connected to a PC.
  86 The most common USB speeds are:
  87 .Bl -tag -width 6n -offset indent
  88 .It Low Speed (1.5MBit/sec)
  89 .It Full Speed (12MBit/sec)
  90 .It High Speed (480MBit/sec)
  91 .El
  92 .Pp
  93 Each
  94 .Tn USB
  95 has a USB controller that is the master of the bus.
  96 The physical communication is simplex which means the host controller only
  97 communicates with one USB device at a time.
  98 .Pp
  99 There can be up to 127 devices connected to an USB HUB tree.
 100 The addresses are assigned dynamically by the host when each device is
 101 attached to the bus.
 102 .Pp
 103 Within each device there can be up to 16 endpoints.
 104 Each endpoint is individually addressed and the addresses are static.
 105 Each of these endpoints will communicate in one of four different modes:
 106 .Em control , isochronous , bulk ,
 107 or
 108 .Em interrupt .
 109 A device always has at least one endpoint.
 110 This endpoint has address 0 and is a control endpoint and is used to give
 111 commands to and extract basic data, such as descriptors, from the device.
 112 Each endpoint, except the control endpoint, is unidirectional.
 113 .Pp
 114 The endpoints in a device are grouped into interfaces.
 115 An interface is a logical unit within a device, e.g., a compound device with
 116 both a keyboard and a trackball, would present one interface for each.
 117 An interface can sometimes be set into different modes, called alternate
 118 settings, which affects how it operates.
 119 Different alternate settings can have different endpoints within it.
 120 .Pp
 121 A device may operate in different configurations.
 122 Depending on the configuration, the device may present different sets of
 123 endpoints and interfaces.
 124 .Pp
 125 The bus enumeration of the
 126 .Tn USB
 127 bus proceeds in several steps:
 128 .Bl -enum
 129 .It
 130 Any interface specific driver can attach to the device.
 131 .It
 132 If none is found, generic interface class drivers can attach.
 133 .El
 134 .Sh SYSCTL VARIABLES
 135 The following variables are available as both
 136 .Xr sysctl 8
 137 variables and
 138 .Xr loader 8
 139 tunables:
 140 .Bl -tag -width indent
 141 .It Va hw.usb.debug
 142 Debug output level, where 0 is debugging disabled and larger values increase
 143 debug message verbosity.
 144 Default is 0.
 145 .El
 146 .Sh SEE ALSO
 147 The
 148 .Tn USB
 149 specifications can be found at:
 150 .Pp
 151 .D1 Pa http://www.usb.org/developers/docs/
 152 .Pp
 153 .Xr libusb 3 ,
 154 .Xr aue 4 ,
 155 .Xr axe 4 ,
 156 .Xr axge 4 ,
 157 .Xr cue 4 ,
 158 .Xr ehci 4 ,
 159 .Xr kue 4 ,
 160 .Xr mos 4 ,
 161 .Xr ohci 4 ,
 162 .Xr pci 4 ,
 163 .Xr rue 4 ,
 164 .Xr ucom 4 ,
 165 .Xr udav 4 ,
 166 .Xr uhci 4 ,
 167 .Xr uhid 4 ,
 168 .Xr ukbd 4 ,
 169 .Xr ulpt 4 ,
 170 .Xr umass 4 ,
 171 .Xr ums 4 ,
 172 .Xr uplcom 4 ,
 173 .Xr urio 4 ,
 174 .Xr uvscom 4 ,
 175 .Xr xhci 4
 176 .Xr usbconfig 8 ,
 177 .Xr usbdi 9
 178 .Sh STANDARDS
 179 The
 180 .Nm
 181 module complies with the USB 2.0 standard.
 182 .Sh HISTORY
 183 The
 184 .Nm
 185 module has been inspired by the
 186 .Nx
 187 USB stack initially written by
 188 .An Lennart Augustsson .
 189 The
 190 .Nm
 191 module was written by
 192 .An Hans Petter Selasky Aq Mt hselasky@FreeBSD.org .