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