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: head/share/man/man4/usb.4 258618 2013-11-26 07:52:40Z lwhsu $
  26 .\"
  27 .Dd November 3, 2014
  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 .Dx
  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
  82 root hub.
  83 .Pp
  84 .Dx
  85 provides support for the following devices.
  86 .Ss Storage devices
  87 .Bl -tag -width ".Xr snd_uaudio 4" -offset indent -compact
  88 .\".It Xr natausb 4
  89 .\"...
  90 .It Xr umass 4
  91 Mass Storage Devices, e.g., external disk drives
  92 .It Xr usfs 4
  93 Mass storage driver for device-side mode
  94 .El
  95 .Ss Wired network interfaces
  96 .Bl -tag -width ".Xr snd_uaudio 4" -offset indent -compact
  97 .\".It Xr aue 4
  98 .\"ADMtek AN986 Pegasus Ethernet driver
  99 .It Xr axe 4
 100 ASIX Electronics AX88x7x/760 USB Ethernet driver
 101 .\".It Xr cue 4
 102 .\"CATC USB-EL1210A Ethernet driver
 103 .\".It Xr kue 4
 104 .\"Kawasaki LSI KL5KUSB101B Ethernet driver
 105 .\".It Xr lgue 4
 106 .\"USB CDC (communication device class) driver for the LG P-500 smartphone
 107 .It Xr mos 4
 108 Moschip MCS7730/MCS7830/MCS7832 USB Ethernet driver
 109 .\".It Xr rue 4
 110 .\"RealTek RTL8150 Ethernet driver
 111 .It Xr udav 4
 112 Davicom DM9601 USB Ethernet driver
 113 .El
 114 .Ss Wireless network interfaces
 115 .Bl -tag -width ".Xr snd_uaudio 4" -offset indent -compact
 116 .It Xr ndis 4
 117 NDIS miniport driver wrapper
 118 .It Xr rum 4
 119 Ralink Technology RT2501USB/RT2601USB IEEE 802.11 driver
 120 .It Xr run 4
 121 Ralink Technology RT2700U/RT2800U/RT3000U IEEE 802.11 driver
 122 .\".It Xr ubt 4
 123 .\"Bluetooth adapters
 124 .\".It Xr ural 4
 125 .\"Ralink Technology RT2500USB IEEE 802.11 driver
 126 .It Xr urndis 4
 127 RNDIS USB ethernet driver
 128 .It Xr urtwn 4
 129 Realtek RTL8188CU/RTL8192CU IEEE 802.11 driver
 130 .El
 131 .Ss Serial and parallel interfaces
 132 .Bl -tag -width ".Xr snd_uaudio 4" -offset indent -compact
 133 .\".It Xr moscom 4
 134 .\"MosChip Semiconductor MCS7703 based serial adapters
 135 .It Xr u3g 4
 136 support for 3G datacards
 137 .It Xr uark 4
 138 Arkmicro Technologies ARK3116 based serial adapters
 139 .It Xr ubsa 4
 140 Belkin serial adapters
 141 .It Xr ubser 4
 142 support for BWCT console serial adapters
 143 .It Xr uchcom 4
 144 WinChipHead CH341/CH340 serial adapters
 145 .It Xr ucom 4
 146 tty support
 147 .It Xr ucycom 4
 148 Cypress CY7C63743 and CY7C64013 USB to RS232 bridges
 149 .It Xr ufoma 4
 150 mobile phone support
 151 .It Xr uftdi 4
 152 serial devices based on the FTDI chips
 153 .It Xr ugensa 4
 154 generic serial device
 155 .It Xr uipaq 4
 156 support for iPAQ units
 157 .It Xr ulpt 4
 158 printer support
 159 .It Xr umcs 4
 160 serial adapters based on the MCS7820 and MCS7840 chips
 161 .It Xr umct 4
 162 Magic Control Technology USB-232 based serial adapters
 163 .It Xr umodem 4
 164 modem support
 165 .It Xr umoscom 4
 166 serial adapters based on the MCS7703 chip
 167 .It Xr uplcom 4
 168 Prolific PL-2303/2303X/2303HX serial adapters
 169 .It Xr uslcom 4
 170 Silicon Laboratories CP2101, CP2102 and CP2103 USB to serial bridge
 171 .\".It Xr uticom 4
 172 .\"Texas Instruments TUSB3410 RS232 to USB converter
 173 .It Xr uvisor 4
 174 support for the Handspring Visor, a Palmpilot compatible PDA
 175 .It Xr uvscom 4
 176 SUNTAC Slipper U VS-10U serial adapters
 177 .El
 178 .\".Ss Audio devices
 179 .\".Bl -tag -width ".Xr snd_uaudio 4" -offset indent -compact
 180 .\".It Xr snd_uaudio 4
 181 .\"audio device driver
 182 .\".It Xr urio 4
 183 .\"driver for the Rio500 MP3 player
 184 .\".El
 185 .Ss Radio receiver devices
 186 .Bl -tag -width ".Xr snd_uaudio 4" -offset indent -compact
 187 .It Xr ufm 4
 188 Cypress Semiconductor FM Radio
 189 .El
 190 .Ss Human Interface Devices
 191 .Bl -tag -width ".Xr snd_uaudio 4" -offset indent -compact
 192 .It Xr uep 4
 193 eGalax touchscreen driver
 194 .It Xr uhid 4
 195 generic driver for Human Interface Devices
 196 .It Xr ukbd 4
 197 keyboards that follow the boot protocol
 198 .It Xr ums 4
 199 mouse devices
 200 .El
 201 .\".Ss Miscellaneous devices
 202 .\".Bl -tag -width ".Xr snd_uaudio 4" -offset indent -compact
 203 .\".It Xr uscanner 4
 204 .\"scanner support
 205 .\".El
 206 .Sh INTRODUCTION TO USB
 207 The
 208 .Tn USB
 209 is a system where external devices can be connected to a PC.
 210 The most common USB speeds are:
 211 .Bl -tag -width 6n -offset indent
 212 .It Low Speed (1.5MBit/sec)
 213 .It Full Speed (12MBit/sec)
 214 .It High Speed (480MBit/sec)
 215 .El
 216 .Pp
 217 Each
 218 .Tn USB
 219 has a USB controller that is the master of the bus.
 220 The physical communication is simplex which means the host controller only communicates with one USB device at a time.
 221 .Pp
 222 There can be up to 127 devices connected to an USB HUB tree.
 223 The addresses are assigned
 224 dynamically by the host when each device is attached to the bus.
 225 .Pp
 226 Within each device there can be up to 16 endpoints.
 227 Each endpoint
 228 is individually addressed and the addresses are static.
 229 Each of these endpoints will communicate in one of four different modes:
 230 .Em control , isochronous , bulk ,
 231 or
 232 .Em interrupt .
 233 A device always has at least one endpoint.
 234 This endpoint has address 0 and is a control
 235 endpoint and is used to give commands to and extract basic data,
 236 such as descriptors, from the device.
 237 Each endpoint, except the control endpoint, is unidirectional.
 238 .Pp
 239 The endpoints in a device are grouped into interfaces.
 240 An interface is a logical unit within a device; e.g.\&
 241 a compound device with both a keyboard and a trackball would present
 242 one interface for each.
 243 An interface can sometimes be set into different modes,
 244 called alternate settings, which affects how it operates.
 245 Different alternate settings can have different endpoints
 246 within it.
 247 .Pp
 248 A device may operate in different configurations.
 249 Depending on the
 250 configuration, the device may present different sets of endpoints
 251 and interfaces.
 252 .Pp
 253 The bus enumeration of the
 254 .Tn USB
 255 bus proceeds in several steps:
 256 .Bl -enum
 257 .It
 258 Any interface specific driver can attach to the device.
 259 .It
 260 If none is found, generic interface class drivers can attach.
 261 .El
 262 .Sh SEE ALSO
 263 The
 264 .Tn USB
 265 specifications can be found at:
 266 .Pp
 267 .D1 Pa http://www.usb.org/developers/docs/
 268 .Pp
 269 .Xr libusb 3 ,
 270 .\".Xr aue 4 ,
 271 .Xr axe 4 ,
 272 .\".Xr axge 4 ,
 273 .\".Xr cue 4 ,
 274 .Xr ehci 4 ,
 275 .\".Xr kue 4 ,
 276 .Xr mos 4 ,
 277 .Xr ndis 4 ,
 278 .Xr ohci 4 ,
 279 .Xr pci 4 ,
 280 .\".Xr rue 4 ,
 281 .Xr rum 4 ,
 282 .Xr run 4 ,
 283 .Xr u3g 4 ,
 284 .Xr uark 4 ,
 285 .Xr ubsa 4 ,
 286 .Xr ubser 4 ,
 287 .Xr uchcom 4 ,
 288 .Xr ucom 4 ,
 289 .Xr ucycom 4 ,
 290 .Xr udav 4 ,
 291 .Xr uep 4 ,
 292 .Xr ufm 4 ,
 293 .Xr ufoma 4 ,
 294 .Xr uftdi 4 ,
 295 .Xr ugensa 4 ,
 296 .Xr uhci 4 ,
 297 .Xr uhid 4 ,
 298 .Xr uipaq 4 ,
 299 .Xr ukbd 4 ,
 300 .Xr ulpt 4 ,
 301 .Xr umass 4 ,
 302 .Xr umcs 4 ,
 303 .Xr umct 4 ,
 304 .Xr umodem 4 ,
 305 .Xr umoscom 4 ,
 306 .Xr ums 4 ,
 307 .Xr uplcom 4 ,
 308 .\".Xr urio 4 ,
 309 .Xr urtwn 4 ,
 310 .Xr usfs 4 ,
 311 .Xr uslcom 4 ,
 312 .Xr uvisor 4 ,
 313 .Xr uvscom 4 ,
 314 .Xr xhci 4 ,
 315 .Xr usbconfig 8 ,
 316 .Xr usbdi 9
 317 .Sh STANDARDS
 318 The
 319 .Nm
 320 module complies with the USB 2.0 standard.
 321 .Sh HISTORY
 322 The
 323 .Nm
 324 module has been inspired by the
 325 .Nx
 326 USB stack initially written by Lennart Augustsson.
 327 The
 328 .Nm
 329 module was written by
 330 .An Hans Petter Selasky Aq Mt hselasky@FreeBSD.org .