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