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 May 27, 2021
  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 umoscom 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 urio 4
  93 Diamond Rio 500 MP3 player
  94 .It Xr usfs 4
  95 Mass storage driver for device-side mode
  96 .El
  97 .Ss Wired network interfaces
  98 .Bl -tag -width ".Xr umoscom 4" -offset indent -compact
  99 .It Xr aue 4
 100 ADMtek AN986 Pegasus Ethernet driver
 101 .It Xr axe 4
 102 ASIX Electronics AX88x7x/760 USB Ethernet driver
 103 .It Xr axge 4
 104 ASIX Electronics AX88178A/AX88179 USB Gigabit Ethernet driver
 105 .It Xr cdce 4
 106 USB Communication Device Class Ethernet driver
 107 .It Xr cue 4
 108 CATC USB-EL1210A Ethernet driver
 109 .It Xr ipheth 4
 110 USB Apple iPhone/iPad tethered Ethernet driver
 111 .It Xr kue 4
 112 Kawasaki LSI KL5KUSB101B Ethernet driver
 113 .It Xr mos 4
 114 Moschip MCS7730/MCS7830/MCS7832 USB Ethernet driver
 115 .It Xr udav 4
 116 Davicom DM9601 USB Ethernet driver
 117 .El
 118 .Ss Wireless network interfaces
 119 .Bl -tag -width ".Xr umoscom 4" -offset indent -compact
 120 .It Xr ndis 4
 121 NDIS miniport driver wrapper
 122 .It Xr rum 4
 123 Ralink Technology RT2501USB/RT2601USB IEEE 802.11 driver
 124 .It Xr run 4
 125 Ralink Technology RT2700U/RT2800U/RT3000U IEEE 802.11 driver
 126 .\".It Xr ubt 4
 127 .\"Bluetooth adapters
 128 .It Xr urndis 4
 129 RNDIS USB ethernet driver
 130 .It Xr urtwn 4
 131 Realtek RTL8188CU/RTL8192CU IEEE 802.11 driver
 132 .El
 133 .Ss Serial and parallel interfaces
 134 .Bl -tag -width ".Xr umoscom 4" -offset indent -compact
 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 uvisor 4
 172 support for the Handspring Visor, a Palmpilot compatible PDA
 173 .It Xr uvscom 4
 174 SUNTAC Slipper U VS-10U serial adapters
 175 .El
 176 .Ss Audio devices
 177 .Bl -tag -width ".Xr umoscom 4" -offset indent -compact
 178 .It Xr uaudio 4
 179 audio device driver
 180 .El
 181 .Ss Radio receiver devices
 182 .Bl -tag -width ".Xr umoscom 4" -offset indent -compact
 183 .It Xr ufm 4
 184 Cypress Semiconductor FM Radio
 185 .El
 186 .Ss Human Interface Devices
 187 .Bl -tag -width ".Xr umoscom 4" -offset indent -compact
 188 .It Xr uep 4
 189 eGalax touchscreen driver
 190 .It Xr uhid 4
 191 generic driver for Human Interface Devices
 192 .It Xr ukbd 4
 193 keyboards that follow the boot protocol
 194 .It Xr ums 4
 195 mouse devices
 196 .It Xr wsp 4
 197 Wellspring touchpad driver for Apple laptops
 198 .El
 199 .Sh INTRODUCTION TO USB
 200 The
 201 .Tn USB
 202 is a system where external devices can be connected to a PC.
 203 The most common USB speeds are:
 204 .Bl -tag -width 6n -offset indent
 205 .It Low Speed (1.5MBit/sec)
 206 .It Full Speed (12MBit/sec)
 207 .It High Speed (480MBit/sec)
 208 .El
 209 .Pp
 210 Each
 211 .Tn USB
 212 has a USB controller that is the master of the bus.
 213 The physical communication is simplex which means the host controller only communicates with one USB device at a time.
 214 .Pp
 215 There can be up to 127 devices connected to an USB HUB tree.
 216 The addresses are assigned
 217 dynamically by the host when each device is attached to the bus.
 218 .Pp
 219 Within each device there can be up to 16 endpoints.
 220 Each endpoint
 221 is individually addressed and the addresses are static.
 222 Each of these endpoints will communicate in one of four different modes:
 223 .Em control , isochronous , bulk ,
 224 or
 225 .Em interrupt .
 226 A device always has at least one endpoint.
 227 This endpoint has address 0 and is a control
 228 endpoint and is used to give commands to and extract basic data,
 229 such as descriptors, from the device.
 230 Each endpoint, except the control endpoint, is unidirectional.
 231 .Pp
 232 The endpoints in a device are grouped into interfaces.
 233 An interface is a logical unit within a device; e.g.\&
 234 a compound device with both a keyboard and a trackball would present
 235 one interface for each.
 236 An interface can sometimes be set into different modes,
 237 called alternate settings, which affects how it operates.
 238 Different alternate settings can have different endpoints
 239 within it.
 240 .Pp
 241 A device may operate in different configurations.
 242 Depending on the
 243 configuration, the device may present different sets of endpoints
 244 and interfaces.
 245 .Pp
 246 The bus enumeration of the
 247 .Tn USB
 248 bus proceeds in several steps:
 249 .Bl -enum
 250 .It
 251 Any interface specific driver can attach to the device.
 252 .It
 253 If none is found, generic interface class drivers can attach.
 254 .El
 255 .Sh SEE ALSO
 256 The
 257 .Tn USB
 258 specifications can be found at:
 259 .Pp
 260 .D1 Pa http://www.usb.org/developers/docs/
 261 .Pp
 262 .Xr usbhidaction 1 ,
 263 .Xr usbhidctl 1 ,
 264 .Xr libusb 3 ,
 265 .Xr libusb20 3 ,
 266 .Xr usbhid 3 ,
 267 .Xr aue 4 ,
 268 .Xr axe 4 ,
 269 .Xr axge 4 ,
 270 .Xr cdce 4 ,
 271 .Xr cue 4 ,
 272 .Xr ehci 4 ,
 273 .Xr ipheth 4 ,
 274 .Xr kue 4 ,
 275 .Xr mos 4 ,
 276 .Xr ndis 4 ,
 277 .Xr ohci 4 ,
 278 .Xr pci 4 ,
 279 .Xr rum 4 ,
 280 .Xr run 4 ,
 281 .Xr u3g 4 ,
 282 .Xr uark 4 ,
 283 .Xr uaudio 4 ,
 284 .Xr ubsa 4 ,
 285 .Xr ubser 4 ,
 286 .Xr uchcom 4 ,
 287 .Xr ucom 4 ,
 288 .Xr ucycom 4 ,
 289 .Xr udav 4 ,
 290 .Xr uep 4 ,
 291 .Xr ufm 4 ,
 292 .Xr ufoma 4 ,
 293 .Xr uftdi 4 ,
 294 .Xr ugen 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 urndis 4 ,
 310 .Xr urtwn 4 ,
 311 .Xr usb_template 4 ,
 312 .Xr usfs 4 ,
 313 .Xr uslcom 4 ,
 314 .Xr uvisor 4 ,
 315 .Xr uvscom 4 ,
 316 .Xr wsp 4 ,
 317 .Xr xhci 4 ,
 318 .Xr usbconfig 8 ,
 319 .Xr usbdi 9
 320 .Sh STANDARDS
 321 The
 322 .Nm
 323 module complies with the USB 2.0 standard.
 324 .Sh HISTORY
 325 The
 326 .Nm
 327 module has been inspired by the
 328 .Nx
 329 USB stack initially written by Lennart Augustsson.
 330 The
 331 .Nm
 332 module was written by
 333 .An Hans Petter Selasky Aq Mt hselasky@FreeBSD.org .