1 .\" Copyright (c) 1997, 1998 Nick Hibma <n_hibma@FreeBSD.org>
2 .\" Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
25 .\" $FreeBSD: head/share/man/man4/usb.4 258618 2013-11-26 07:52:40Z lwhsu $
32 .Nd Universal Serial Bus
34 To compile this driver into the kernel,
35 place the following line in your
36 kernel configuration file:
37 .Bd -ragged -offset indent
41 Alternatively, to load the driver as a
42 module at boot time, place the following line in
44 .Bd -literal -offset indent
47 .Sh USERLAND PROGRAMMING
48 USB functions can be accessed from userland through the libusb library.
54 provides machine-independent bus support and drivers for
56 devices in host and device side mode.
60 driver has three layers:
61 .Bl -tag -width 6n -offset indent
62 .It USB Controller (Bus)
67 The controller attaches to a physical bus
72 bus attaches to the controller, and the root hub attaches
74 Any devices attached to the bus will attach to the root hub
75 or another hub attached to the
81 device will always be present as it is needed for the
85 provides support for the following devices.
87 .Bl -tag -width ".Xr snd_uaudio 4" -offset indent -compact
91 Mass Storage Devices, e.g., external disk drives
93 Mass storage driver for device-side mode
95 .Ss Wired network interfaces
96 .Bl -tag -width ".Xr snd_uaudio 4" -offset indent -compact
98 .\"ADMtek AN986 Pegasus Ethernet driver
100 ASIX Electronics AX88x7x/760 USB Ethernet driver
102 .\"CATC USB-EL1210A Ethernet driver
104 .\"Kawasaki LSI KL5KUSB101B Ethernet driver
106 .\"USB CDC (communication device class) driver for the LG P-500 smartphone
108 .\"RealTek RTL8150 Ethernet driver
110 Davicom DM9601 USB Ethernet driver
112 .Ss Wireless network interfaces
113 .Bl -tag -width ".Xr snd_uaudio 4" -offset indent -compact
115 NDIS miniport driver wrapper
117 Ralink Technology RT2501USB/RT2601USB IEEE 802.11 driver
119 Ralink Technology RT2700U/RT2800U/RT3000U IEEE 802.11 driver
121 .\"Bluetooth adapters
123 .\"Ralink Technology RT2500USB IEEE 802.11 driver
125 RNDIS USB ethernet driver
127 Realtek RTL8188CU/RTL8192CU IEEE 802.11 driver
129 .Ss Serial and parallel interfaces
130 .Bl -tag -width ".Xr snd_uaudio 4" -offset indent -compact
132 .\"MosChip Semiconductor MCS7703 based serial adapters
134 support for 3G datacards
136 Arkmicro Technologies ARK3116 based serial adapters
138 Belkin serial adapters
140 support for BWCT console serial adapters
142 WinChipHead CH341/CH340 serial adapters
146 Cypress CY7C63743 and CY7C64013 USB to RS232 bridges
150 serial devices based on the FTDI chips
152 generic serial device
154 support for iPAQ units
158 serial adapters based on the MCS7820 and MCS7840 chips
160 Magic Control Technology USB-232 based serial adapters
164 serial adapters based on the MCS7703 chip
166 Prolific PL-2303/2303X/2303HX serial adapters
168 Silicon Laboratories CP2101, CP2102 and CP2103 USB to serial bridge
170 .\"Texas Instruments TUSB3410 RS232 to USB converter
172 support for the Handspring Visor, a Palmpilot compatible PDA
174 SUNTAC Slipper U VS-10U serial adapters
177 .\".Bl -tag -width ".Xr snd_uaudio 4" -offset indent -compact
178 .\".It Xr snd_uaudio 4
179 .\"audio device driver
181 .\"driver for the Rio500 MP3 player
183 .Ss Radio receiver devices
184 .Bl -tag -width ".Xr snd_uaudio 4" -offset indent -compact
186 Cypress Semiconductor FM Radio
188 .Ss Human Interface Devices
189 .Bl -tag -width ".Xr snd_uaudio 4" -offset indent -compact
191 eGalax touchscreen driver
193 generic driver for Human Interface Devices
195 keyboards that follow the boot protocol
199 .\".Ss Miscellaneous devices
200 .\".Bl -tag -width ".Xr snd_uaudio 4" -offset indent -compact
204 .Sh INTRODUCTION TO USB
207 is a system where external devices can be connected to a PC.
208 The 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)
217 has a USB controller that is the master of the bus.
218 The physical communication is simplex which means the host controller only communicates with one USB device at a time.
220 There can be up to 127 devices connected to an USB HUB tree.
221 The addresses are assigned
222 dynamically by the host when each device is attached to the bus.
224 Within each device there can be up to 16 endpoints.
226 is individually addressed and the addresses are static.
227 Each of these endpoints will communicate in one of four different modes:
228 .Em control , isochronous , bulk ,
231 A device always has at least one endpoint.
232 This endpoint has address 0 and is a control
233 endpoint and is used to give commands to and extract basic data,
234 such as descriptors, from the device.
235 Each endpoint, except the control endpoint, is unidirectional.
237 The endpoints in a device are grouped into interfaces.
238 An interface is a logical unit within a device; e.g.\&
239 a compound device with both a keyboard and a trackball would present
240 one interface for each.
241 An interface can sometimes be set into different modes,
242 called alternate settings, which affects how it operates.
243 Different alternate settings can have different endpoints
246 A device may operate in different configurations.
248 configuration, the device may present different sets of endpoints
251 The bus enumeration of the
253 bus proceeds in several steps:
256 Any interface specific driver can attach to the device.
258 If none is found, generic interface class drivers can attach.
263 specifications can be found at:
265 .D1 Pa http://www.usb.org/developers/docs/
318 module complies with the USB 2.0 standard.
322 module has been inspired by the
324 USB stack initially written by Lennart Augustsson.
327 module was written by
328 .An Hans Petter Selasky Aq Mt hselasky@FreeBSD.org .