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