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 December 6, 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 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 cue 4 106CATC USB-EL1210A Ethernet driver 107.It Xr ipheth 4 108USB Apple iPhone/iPad tethered Ethernet driver 109.It Xr kue 4 110Kawasaki LSI KL5KUSB101B Ethernet driver 111.It Xr mos 4 112Moschip MCS7730/MCS7830/MCS7832 USB Ethernet driver 113.\".It Xr rue 4 114.\"RealTek RTL8150 Ethernet driver 115.It Xr udav 4 116Davicom DM9601 USB Ethernet driver 117.El 118.Ss Wireless network interfaces 119.Bl -tag -width ".Xr snd_uaudio 4" -offset indent -compact 120.It Xr ndis 4 121NDIS miniport driver wrapper 122.It Xr rum 4 123Ralink Technology RT2501USB/RT2601USB IEEE 802.11 driver 124.It Xr run 4 125Ralink Technology RT2700U/RT2800U/RT3000U IEEE 802.11 driver 126.\".It Xr ubt 4 127.\"Bluetooth adapters 128.\".It Xr ural 4 129.\"Ralink Technology RT2500USB IEEE 802.11 driver 130.It Xr urndis 4 131RNDIS USB ethernet driver 132.It Xr urtwn 4 133Realtek RTL8188CU/RTL8192CU IEEE 802.11 driver 134.El 135.Ss Serial and parallel interfaces 136.Bl -tag -width ".Xr snd_uaudio 4" -offset indent -compact 137.It Xr u3g 4 138support for 3G datacards 139.It Xr uark 4 140Arkmicro Technologies ARK3116 based serial adapters 141.It Xr ubsa 4 142Belkin serial adapters 143.It Xr ubser 4 144support for BWCT console serial adapters 145.It Xr uchcom 4 146WinChipHead CH341/CH340 serial adapters 147.It Xr ucom 4 148tty support 149.It Xr ucycom 4 150Cypress CY7C63743 and CY7C64013 USB to RS232 bridges 151.It Xr ufoma 4 152mobile phone support 153.It Xr uftdi 4 154serial devices based on the FTDI chips 155.It Xr ugensa 4 156generic serial device 157.It Xr uipaq 4 158support for iPAQ units 159.It Xr ulpt 4 160printer support 161.It Xr umcs 4 162serial adapters based on the MCS7820 and MCS7840 chips 163.It Xr umct 4 164Magic Control Technology USB-232 based serial adapters 165.It Xr umodem 4 166modem support 167.It Xr umoscom 4 168serial adapters based on the MCS7703 chip 169.It Xr uplcom 4 170Prolific PL-2303/2303X/2303HX serial adapters 171.It Xr uslcom 4 172Silicon Laboratories CP2101, CP2102 and CP2103 USB to serial bridge 173.It Xr uvisor 4 174support for the Handspring Visor, a Palmpilot compatible PDA 175.It Xr uvscom 4 176SUNTAC 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 188Cypress 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 193eGalax touchscreen driver 194.It Xr uhid 4 195generic driver for Human Interface Devices 196.It Xr ukbd 4 197keyboards that follow the boot protocol 198.It Xr ums 4 199mouse devices 200.El 201.Sh INTRODUCTION TO USB 202The 203.Tn USB 204is a system where external devices can be connected to a PC. 205The most common USB speeds are: 206.Bl -tag -width 6n -offset indent 207.It Low Speed (1.5MBit/sec) 208.It Full Speed (12MBit/sec) 209.It High Speed (480MBit/sec) 210.El 211.Pp 212Each 213.Tn USB 214has a USB controller that is the master of the bus. 215The physical communication is simplex which means the host controller only communicates with one USB device at a time. 216.Pp 217There can be up to 127 devices connected to an USB HUB tree. 218The addresses are assigned 219dynamically by the host when each device is attached to the bus. 220.Pp 221Within each device there can be up to 16 endpoints. 222Each endpoint 223is individually addressed and the addresses are static. 224Each of these endpoints will communicate in one of four different modes: 225.Em control , isochronous , bulk , 226or 227.Em interrupt . 228A device always has at least one endpoint. 229This endpoint has address 0 and is a control 230endpoint and is used to give commands to and extract basic data, 231such as descriptors, from the device. 232Each endpoint, except the control endpoint, is unidirectional. 233.Pp 234The endpoints in a device are grouped into interfaces. 235An interface is a logical unit within a device; e.g.\& 236a compound device with both a keyboard and a trackball would present 237one interface for each. 238An interface can sometimes be set into different modes, 239called alternate settings, which affects how it operates. 240Different alternate settings can have different endpoints 241within it. 242.Pp 243A device may operate in different configurations. 244Depending on the 245configuration, the device may present different sets of endpoints 246and interfaces. 247.Pp 248The bus enumeration of the 249.Tn USB 250bus proceeds in several steps: 251.Bl -enum 252.It 253Any interface specific driver can attach to the device. 254.It 255If none is found, generic interface class drivers can attach. 256.El 257.Sh SEE ALSO 258The 259.Tn USB 260specifications can be found at: 261.Pp 262.D1 Pa http://www.usb.org/developers/docs/ 263.Pp 264.Xr libusb 3 , 265.Xr aue 4 , 266.Xr axe 4 , 267.Xr axge 4 , 268.Xr cue 4 , 269.Xr ehci 4 , 270.Xr ipheth 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