kernel/usb4bsd: Bring in the axge(4) ethernet driver.
[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 November 15, 2014
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 snd_uaudio 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 usfs 4
93 Mass 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
100 ASIX Electronics AX88x7x/760 USB Ethernet driver
101 .It Xr axge 4
102 ASIX Electronics AX88178A/AX88179 USB Gigabit Ethernet driver
103 .It Xr cue 4
104 CATC USB-EL1210A Ethernet driver
105 .It Xr ipheth 4
106 USB Apple iPhone/iPad tethered Ethernet driver
107 .It Xr kue 4
108 Kawasaki LSI KL5KUSB101B Ethernet driver
109 .\".It Xr lgue 4
110 .\"USB CDC (communication device class) driver for the LG P-500 smartphone
111 .It Xr mos 4
112 Moschip MCS7730/MCS7830/MCS7832 USB Ethernet driver
113 .\".It Xr rue 4
114 .\"RealTek RTL8150 Ethernet driver
115 .It Xr udav 4
116 Davicom 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
121 NDIS miniport driver wrapper
122 .It Xr rum 4
123 Ralink Technology RT2501USB/RT2601USB IEEE 802.11 driver
124 .It Xr run 4
125 Ralink 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
131 RNDIS USB ethernet driver
132 .It Xr urtwn 4
133 Realtek 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 moscom 4
138 .\"MosChip Semiconductor MCS7703 based serial adapters
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 uticom 4
176 .\"Texas Instruments TUSB3410 RS232 to USB converter
177 .It Xr uvisor 4
178 support for the Handspring Visor, a Palmpilot compatible PDA
179 .It Xr uvscom 4
180 SUNTAC Slipper U VS-10U serial adapters
181 .El
182 .\".Ss Audio devices
183 .\".Bl -tag -width ".Xr snd_uaudio 4" -offset indent -compact
184 .\".It Xr snd_uaudio 4
185 .\"audio device driver
186 .\".It Xr urio 4
187 .\"driver for the Rio500 MP3 player
188 .\".El
189 .Ss Radio receiver devices
190 .Bl -tag -width ".Xr snd_uaudio 4" -offset indent -compact
191 .It Xr ufm 4
192 Cypress Semiconductor FM Radio
193 .El
194 .Ss Human Interface Devices
195 .Bl -tag -width ".Xr snd_uaudio 4" -offset indent -compact
196 .It Xr uep 4
197 eGalax touchscreen driver
198 .It Xr uhid 4
199 generic driver for Human Interface Devices
200 .It Xr ukbd 4
201 keyboards that follow the boot protocol
202 .It Xr ums 4
203 mouse devices
204 .El
205 .\".Ss Miscellaneous devices
206 .\".Bl -tag -width ".Xr snd_uaudio 4" -offset indent -compact
207 .\".It Xr uscanner 4
208 .\"scanner support
209 .\".El
210 .Sh INTRODUCTION TO USB
211 The
212 .Tn USB
213 is a system where external devices can be connected to a PC.
214 The most common USB speeds are:
215 .Bl -tag -width 6n -offset indent
216 .It Low Speed (1.5MBit/sec)
217 .It Full Speed (12MBit/sec)
218 .It High Speed (480MBit/sec)
219 .El
220 .Pp
221 Each
222 .Tn USB
223 has a USB controller that is the master of the bus.
224 The physical communication is simplex which means the host controller only communicates with one USB device at a time.
225 .Pp
226 There can be up to 127 devices connected to an USB HUB tree.
227 The addresses are assigned
228 dynamically by the host when each device is attached to the bus.
229 .Pp
230 Within each device there can be up to 16 endpoints.
231 Each endpoint
232 is individually addressed and the addresses are static.
233 Each of these endpoints will communicate in one of four different modes:
234 .Em control , isochronous , bulk ,
235 or
236 .Em interrupt .
237 A device always has at least one endpoint.
238 This endpoint has address 0 and is a control
239 endpoint and is used to give commands to and extract basic data,
240 such as descriptors, from the device.
241 Each endpoint, except the control endpoint, is unidirectional.
242 .Pp
243 The endpoints in a device are grouped into interfaces.
244 An interface is a logical unit within a device; e.g.\&
245 a compound device with both a keyboard and a trackball would present
246 one interface for each.
247 An interface can sometimes be set into different modes,
248 called alternate settings, which affects how it operates.
249 Different alternate settings can have different endpoints
250 within it.
251 .Pp
252 A device may operate in different configurations.
253 Depending on the
254 configuration, the device may present different sets of endpoints
255 and interfaces.
256 .Pp
257 The bus enumeration of the
258 .Tn USB
259 bus proceeds in several steps:
260 .Bl -enum
261 .It
262 Any interface specific driver can attach to the device.
263 .It
264 If none is found, generic interface class drivers can attach.
265 .El
266 .Sh SEE ALSO
267 The
268 .Tn USB
269 specifications can be found at:
270 .Pp
271 .D1 Pa http://www.usb.org/developers/docs/
272 .Pp
273 .Xr libusb 3 ,
274 .Xr aue 4 ,
275 .Xr axe 4 ,
276 .Xr axge 4 ,
277 .Xr cue 4 ,
278 .Xr ehci 4 ,
279 .Xr ipheth 4 ,
280 .Xr kue 4 ,
281 .Xr mos 4 ,
282 .Xr ndis 4 ,
283 .Xr ohci 4 ,
284 .Xr pci 4 ,
285 .\".Xr rue 4 ,
286 .Xr rum 4 ,
287 .Xr run 4 ,
288 .Xr u3g 4 ,
289 .Xr uark 4 ,
290 .Xr ubsa 4 ,
291 .Xr ubser 4 ,
292 .Xr uchcom 4 ,
293 .Xr ucom 4 ,
294 .Xr ucycom 4 ,
295 .Xr udav 4 ,
296 .Xr uep 4 ,
297 .Xr ufm 4 ,
298 .Xr ufoma 4 ,
299 .Xr uftdi 4 ,
300 .Xr ugensa 4 ,
301 .Xr uhci 4 ,
302 .Xr uhid 4 ,
303 .Xr uipaq 4 ,
304 .Xr ukbd 4 ,
305 .Xr ulpt 4 ,
306 .Xr umass 4 ,
307 .Xr umcs 4 ,
308 .Xr umct 4 ,
309 .Xr umodem 4 ,
310 .Xr umoscom 4 ,
311 .Xr ums 4 ,
312 .Xr uplcom 4 ,
313 .\".Xr urio 4 ,
314 .Xr urtwn 4 ,
315 .Xr usfs 4 ,
316 .Xr uslcom 4 ,
317 .Xr uvisor 4 ,
318 .Xr uvscom 4 ,
319 .Xr xhci 4 ,
320 .Xr usbconfig 8 ,
321 .Xr usbdi 9
322 .Sh STANDARDS
323 The
324 .Nm
325 module complies with the USB 2.0 standard.
326 .Sh HISTORY
327 The
328 .Nm
329 module has been inspired by the
330 .Nx
331 USB stack initially written by Lennart Augustsson.
332 The
333 .Nm
334 module was written by
335 .An Hans Petter Selasky Aq Mt hselasky@FreeBSD.org .