kernel/usb4bsd: Sync urtwn(4) with current FreeBSD.
[dragonfly.git] / share / man / man4 / urtwn.4
1 .\"
2 .\" Copyright (c) 2010 Damien Bergamini <damien.bergamini@free.fr>
3 .\"
4 .\" Permission to use, copy, modify, and distribute this software for any
5 .\" purpose with or without fee is hereby granted, provided that the above
6 .\" copyright notice and this permission notice appear in all copies.
7 .\"
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15 .\"
16 .\" $FreeBSD: head/share/man/man4/urtwn.4 267938 2014-06-26 21:46:14Z bapt $
17 .\"
18 .Dd July 30, 2014
19 .Dt URTWN 4
20 .Os
21 .Sh NAME
22 .Nm urtwn
23 .Nd Realtek RTL8188CU/RTL8188EU/RTL8192CU USB IEEE 802.11b/g/n wireless network device
24 .Sh SYNOPSIS
25 To compile this driver into the kernel,
26 place the following lines in your
27 kernel configuration file:
28 .Bd -ragged -offset indent
29 .Cd "device ehci"
30 .Cd "device uhci"
31 .Cd "device ohci"
32 .Cd "device usb"
33 .Cd "device urtwn"
34 .Cd "device wlan"
35 .Ed
36 .Pp
37 Alternatively, to load the driver as a
38 module at boot time, place the following line in
39 .Xr loader.conf 5 :
40 .Bd -literal -offset indent
41 if_urtwn_load="YES"
42 .Ed
43 .Pp
44 In both cases, place the following line in
45 .Xr loader.conf 5
46 to acknowledge the firmware license (see below):
47 .Bd -literal -offset indent
48 legal.realtek.license_ack=1
49 .Ed
50 .Sh DESCRIPTION
51 The
52 .Nm
53 driver supports USB 2.0 wireless network devices based on Realtek
54 RTL8188CUS, RTL8188CE-VAU, RTL8188EUS, RTL8188RU and RTL8192CU chipsets.
55 .Pp
56 The RTL8188CUS and RTL8188EUS are highly integrated 802.11n adapter that
57 combine a MAC, a 1T1R capable baseband and an RF in a single chip.
58 They operate in the 2GHz spectrum only.
59 The RTL8188RU is a high-power variant of the RTL8188CUS.
60 The RTL8188CE-VAU is a PCI Express Mini Card adapter that attaches
61 to the USB interface.
62 .Pp
63 The RTL8192CU is a highly integrated multiple-in, multiple-out (MIMO)
64 802.11n adapter that combines a MAC, a 2T2R capable baseband and an
65 RF in a single chip.
66 It operates in the 2GHz spectrum only.
67 .Pp
68 This driver requires the firmware built with the
69 .Xr urtwnfw 4
70 module to work.
71 For the loaded firmware to be enabled for use the license at
72 .Pa /usr/share/doc/legal/realtek/LICENSE
73 must be agreed to by adding the following line to
74 .Xr loader.conf 5 :
75 .Pp
76 .Dl "legal.realtek.license_ack=1"
77 .Sh FILES
78 .Bl -tag -width ".Pa /usr/share/doc/legal/realtek/LICENSE" -compact
79 .It Pa /usr/share/doc/legal/realtek/LICENSE
80 .Nm
81 firmware license
82 .El
83 .Sh HARDWARE
84 The
85 .Nm
86 driver supports Realtek RTL8188CU/RTL8188EU/RTL8192CU based USB
87 IEEE 802.11b/g/n wireless network adapters, including:
88 .Pp
89 .Bl -tag -width Ds -offset indent -compact
90 .It Adafruit USB WiFi (802.11b/g/n) Module
91 .It ASUS USB-N10 NANO
92 .It Belkin F7D1102 Surf Wireless Micro
93 .It D-Link DWA-131
94 .It Edimax EW-7811Un
95 .It Netgear WNA1000M
96 .It Realtek RTL8192CU
97 .It Realtek RTL8188CUS
98 .It TP-LINK TL-WN723N v3
99 .It TP-LINK TL-WN725N v2
100 .El
101 .Sh EXAMPLES
102 Join an existing BSS network (i.e., connect to an access point):
103 .Bd -literal -offset indent
104 ifconfig wlan create wlandev urtwn0 inet 192.168.0.20 \e
105     netmask 0xffffff00
106 .Ed
107 .Pp
108 Join a specific BSS network with network name
109 .Dq Li my_net :
110 .Pp
111 .Dl "ifconfig wlan create wlandev urtwn0 ssid my_net up"
112 .Pp
113 Join a specific BSS network with 64-bit WEP encryption:
114 .Bd -literal -offset indent
115 ifconfig wlan create wlandev urtwn0 ssid my_net \e
116         wepmode on wepkey 0x1234567890 weptxkey 1 up
117 .Ed
118 .Sh DIAGNOSTICS
119 .Bl -diag
120 .It "urtwn%d: error %d, could not read firmware %s"
121 For some reason, the driver was unable to read the microcode file from the
122 filesystem.
123 The file might be missing or corrupted.
124 .It "urtwn%d: device timeout"
125 A frame dispatched to the hardware for transmission did not complete in time.
126 The driver will reset the hardware.
127 This should not happen.
128 .El
129 .Sh SEE ALSO
130 .Xr ifmedia 4 ,
131 .Xr intro 4 ,
132 .Xr netintro 4 ,
133 .Xr urtwnfw 4 ,
134 .Xr usb 4 ,
135 .Xr wlan 4 ,
136 .Xr wlan_ccmp 4 ,
137 .Xr wlan_tkip 4 ,
138 .Xr wlan_wep 4 ,
139 .Xr ifconfig 8 ,
140 .Xr wpa_supplicant 8
141 .Rs
142 .%T Realtek
143 .%O http://www.realtek.com.tw
144 .Re
145 .Sh HISTORY
146 The
147 .Nm
148 driver first appeared in
149 .Ox 4.9
150 and
151 .Fx 10.0 .
152 .Sh AUTHORS
153 The
154 .Nm
155 driver was written by
156 .An Damien Bergamini Aq Mt damien@openbsd.org .
157 .Sh CAVEATS
158 The
159 .Nm
160 driver does not support any of the 802.11n capabilities offered by the
161 adapters.