4c459bb997971c2545552b9d64c8eb317bd4b130
[dragonfly.git] / share / man / man4 / usb.4
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 2, 2018
28 .Dt USB 4
29 .Os
30 .Sh NAME
31 .Nm usb
32 .Nd Universal Serial Bus
33 .Sh SYNOPSIS
34 To compile this driver into the kernel,
35 place the following line in your
36 kernel configuration file:
37 .Bd -ragged -offset indent
38 .Cd "device usb"
39 .Ed
40 .Pp
41 Alternatively, to load the driver as a
42 module at boot time, place the following line in
43 .Xr loader.conf 5 :
44 .Bd -literal -offset indent
45 usb_load="YES"
46 .Ed
47 .Sh USERLAND PROGRAMMING
48 USB functions can be accessed from userland through the libusb library.
49 See
50 .Xr libusb 3
51 for more information.
52 .Sh DESCRIPTION
53 .Dx
54 provides machine-independent bus support and drivers for
55 .Tn USB
56 devices in host and device side mode.
57 .Pp
58 The
59 .Nm
60 driver 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
67 The controller attaches to a physical bus
68 like
69 .Xr pci 4 .
70 The
71 .Tn USB
72 bus attaches to the controller, and the root hub attaches
73 to the controller.
74 Any devices attached to the bus will attach to the root hub
75 or another hub attached to the
76 .Tn USB
77 bus.
78 .Pp
79 The
80 .Nm uhub
81 device will always be present as it is needed for the
82 root hub.
83 .Pp
84 .Dx
85 provides support for the following devices.
86 .Ss Storage devices
87 .Bl -tag -width ".Xr umoscom 4" -offset indent -compact
88 .\".It Xr natausb 4
89 .\"...
90 .It Xr umass 4
91 Mass Storage Devices, e.g., external disk drives
92 .It Xr urio 4
93 Diamond Rio 500 MP3 player
94 .It Xr usfs 4
95 Mass storage driver for device-side mode
96 .El
97 .Ss Wired network interfaces
98 .Bl -tag -width ".Xr umoscom 4" -offset indent -compact
99 .It Xr aue 4
100 ADMtek AN986 Pegasus Ethernet driver
101 .It Xr axe 4
102 ASIX Electronics AX88x7x/760 USB Ethernet driver
103 .It Xr axge 4
104 ASIX Electronics AX88178A/AX88179 USB Gigabit Ethernet driver
105 .It Xr cdce 4
106 USB Communication Device Class Ethernet driver
107 .It Xr cue 4
108 CATC USB-EL1210A Ethernet driver
109 .It Xr ipheth 4
110 USB Apple iPhone/iPad tethered Ethernet driver
111 .It Xr kue 4
112 Kawasaki LSI KL5KUSB101B Ethernet driver
113 .It Xr mos 4
114 Moschip MCS7730/MCS7830/MCS7832 USB Ethernet driver
115 .\".It Xr rue 4
116 .\"RealTek RTL8150 Ethernet driver
117 .It Xr udav 4
118 Davicom DM9601 USB Ethernet driver
119 .El
120 .Ss Wireless network interfaces
121 .Bl -tag -width ".Xr umoscom 4" -offset indent -compact
122 .It Xr ndis 4
123 NDIS miniport driver wrapper
124 .It Xr rum 4
125 Ralink Technology RT2501USB/RT2601USB IEEE 802.11 driver
126 .It Xr run 4
127 Ralink 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
133 RNDIS USB ethernet driver
134 .It Xr urtwn 4
135 Realtek RTL8188CU/RTL8192CU IEEE 802.11 driver
136 .El
137 .Ss Serial and parallel interfaces
138 .Bl -tag -width ".Xr umoscom 4" -offset indent -compact
139 .It Xr u3g 4
140 support for 3G datacards
141 .It Xr uark 4
142 Arkmicro Technologies ARK3116 based serial adapters
143 .It Xr ubsa 4
144 Belkin serial adapters
145 .It Xr ubser 4
146 support for BWCT console serial adapters
147 .It Xr uchcom 4
148 WinChipHead CH341/CH340 serial adapters
149 .It Xr ucom 4
150 tty support
151 .It Xr ucycom 4
152 Cypress CY7C63743 and CY7C64013 USB to RS232 bridges
153 .It Xr ufoma 4
154 mobile phone support
155 .It Xr uftdi 4
156 serial devices based on the FTDI chips
157 .It Xr ugensa 4
158 generic serial device
159 .It Xr uipaq 4
160 support for iPAQ units
161 .It Xr ulpt 4
162 printer support
163 .It Xr umcs 4
164 serial adapters based on the MCS7820 and MCS7840 chips
165 .It Xr umct 4
166 Magic Control Technology USB-232 based serial adapters
167 .It Xr umodem 4
168 modem support
169 .It Xr umoscom 4
170 serial adapters based on the MCS7703 chip
171 .It Xr uplcom 4
172 Prolific PL-2303/2303X/2303HX serial adapters
173 .It Xr uslcom 4
174 Silicon Laboratories CP2101, CP2102 and CP2103 USB to serial bridge
175 .It Xr uvisor 4
176 support for the Handspring Visor, a Palmpilot compatible PDA
177 .It Xr uvscom 4
178 SUNTAC Slipper U VS-10U serial adapters
179 .El
180 .Ss Audio devices
181 .Bl -tag -width ".Xr umoscom 4" -offset indent -compact
182 .It Xr uaudio 4
183 audio device driver
184 .El
185 .Ss Radio receiver devices
186 .Bl -tag -width ".Xr umoscom 4" -offset indent -compact
187 .It Xr ufm 4
188 Cypress Semiconductor FM Radio
189 .El
190 .Ss Human Interface Devices
191 .Bl -tag -width ".Xr umoscom 4" -offset indent -compact
192 .It Xr uep 4
193 eGalax touchscreen driver
194 .It Xr uhid 4
195 generic driver for Human Interface Devices
196 .It Xr ukbd 4
197 keyboards that follow the boot protocol
198 .It Xr ums 4
199 mouse devices
200 .El
201 .Sh INTRODUCTION TO USB
202 The
203 .Tn USB
204 is a system where external devices can be connected to a PC.
205 The 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
212 Each
213 .Tn USB
214 has a USB controller that is the master of the bus.
215 The physical communication is simplex which means the host controller only communicates with one USB device at a time.
216 .Pp
217 There can be up to 127 devices connected to an USB HUB tree.
218 The addresses are assigned
219 dynamically by the host when each device is attached to the bus.
220 .Pp
221 Within each device there can be up to 16 endpoints.
222 Each endpoint
223 is individually addressed and the addresses are static.
224 Each of these endpoints will communicate in one of four different modes:
225 .Em control , isochronous , bulk ,
226 or
227 .Em interrupt .
228 A device always has at least one endpoint.
229 This endpoint has address 0 and is a control
230 endpoint and is used to give commands to and extract basic data,
231 such as descriptors, from the device.
232 Each endpoint, except the control endpoint, is unidirectional.
233 .Pp
234 The endpoints in a device are grouped into interfaces.
235 An interface is a logical unit within a device; e.g.\&
236 a compound device with both a keyboard and a trackball would present
237 one interface for each.
238 An interface can sometimes be set into different modes,
239 called alternate settings, which affects how it operates.
240 Different alternate settings can have different endpoints
241 within it.
242 .Pp
243 A device may operate in different configurations.
244 Depending on the
245 configuration, the device may present different sets of endpoints
246 and interfaces.
247 .Pp
248 The bus enumeration of the
249 .Tn USB
250 bus proceeds in several steps:
251 .Bl -enum
252 .It
253 Any interface specific driver can attach to the device.
254 .It
255 If none is found, generic interface class drivers can attach.
256 .El
257 .Sh SEE ALSO
258 The
259 .Tn USB
260 specifications 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 cdce 4 ,
269 .Xr cue 4 ,
270 .Xr ehci 4 ,
271 .Xr ipheth 4 ,
272 .Xr kue 4 ,
273 .Xr mos 4 ,
274 .Xr ndis 4 ,
275 .Xr ohci 4 ,
276 .Xr pci 4 ,
277 .\".Xr rue 4 ,
278 .Xr rum 4 ,
279 .Xr run 4 ,
280 .Xr u3g 4 ,
281 .Xr uark 4 ,
282 .Xr uaudio 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
316 The
317 .Nm
318 module complies with the USB 2.0 standard.
319 .Sh HISTORY
320 The
321 .Nm
322 module has been inspired by the
323 .Nx
324 USB stack initially written by Lennart Augustsson.
325 The
326 .Nm
327 module was written by
328 .An Hans Petter Selasky Aq Mt hselasky@FreeBSD.org .