xref: /netbsd-src/share/man/man4/urtwn.4 (revision b757af438b42b93f8c6571f026d8b8ef3eaf5fc9)
1.\" $NetBSD: urtwn.4,v 1.2 2012/03/25 08:45:02 wiz Exp $
2.\" $OpenBSD: urtwn.4,v 1.15 2011/11/26 06:39:33 ckuethe Exp $
3.\"
4.\" Copyright (c) 2010 Damien Bergamini <damien.bergamini@free.fr>
5.\"
6.\" Permission to use, copy, modify, and distribute this software for any
7.\" purpose with or without fee is hereby granted, provided that the above
8.\" copyright notice and this permission notice appear in all copies.
9.\"
10.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17.\"
18.Dd March 25, 2012
19.Dt URTWN 4
20.Os
21.Sh NAME
22.Nm urtwn
23.Nd Realtek RTL8188CU/RTL8192CU USB IEEE 802.11b/g/n wireless network device
24.Sh SYNOPSIS
25.Cd "urtwn* at uhub? port ?"
26.Sh DESCRIPTION
27The
28.Nm
29driver supports USB 2.0 wireless network devices based on Realtek
30RTL8188CUS, RTL8188CE-VAU, RTL8188RU, and RTL8192CU chipsets.
31.Pp
32The RTL8188CUS is a highly integrated 802.11n adapter that combines
33a MAC, a 1T1R capable baseband and an RF in a single chip.
34It operates in the 2GHz spectrum only.
35The RTL8188RU is a high-power variant of the RTL8188CUS.
36The RTL8188CE-VAU is a PCI Express Mini Card adapter that attaches
37to the USB interface.
38.Pp
39The RTL8192CU is a highly integrated multiple-in, multiple-out (MIMO)
40802.11n adapter that combines a MAC, a 2T2R capable baseband and an
41RF in a single chip.
42It operates in the 2GHz spectrum only.
43.Pp
44These are the modes the
45.Nm
46driver can operate in:
47.Bl -tag -width "IBSS-masterXX"
48.It BSS mode
49Also known as
50.Em infrastructure
51mode, this is used when associating with an access point, through
52which all traffic passes.
53This mode is the default.
54.It monitor mode
55In this mode the driver is able to receive packets without
56associating with an access point.
57This disables the internal receive filter and enables the card to
58capture packets from networks which it wouldn't normally have access to,
59or to scan for access points.
60.El
61.Pp
62The
63.Nm
64driver can be configured to use
65Wired Equivalent Privacy (WEP) or
66Wi-Fi Protected Access (WPA-PSK and WPA2-PSK).
67WPA is the de facto encryption standard for wireless networks.
68It is strongly recommended that WEP
69not be used as the sole mechanism
70to secure wireless communication,
71due to serious weaknesses in it.
72.Pp
73The
74.Nm
75driver can be configured at runtime with
76.Xr ifconfig 8
77or on boot with
78.Xr ifconfig.if 5 .
79.Sh FILES
80The driver needs at least version 1.1p0 of the following firmware files,
81which are loaded when an interface is attached:
82.Pp
83.Bl -tag -width Ds -offset indent -compact
84.It /libdata/firmware/urtwn/urtwn-rtl8192cfwT
85.It /libdata/firmware/urtwn/urtwn-rtl8192cfwU
86.It /libdata/firmware/urtwn/urtwn-rtl8723fw
87.El
88.Pp
89A prepackaged version of the firmware, designed to be used with
90.Xr pkg_add 1 ,
91can be found at:
92.Bd -literal -offset 3n
93http://firmware.openbsd.org/firmware/urtwn-firmware-1.1p0.tgz
94.Ed
95.Sh HARDWARE
96The following adapters should work:
97.Pp
98.Bl -tag -width Ds -offset indent -compact
99.It Airlink101 AWLL5088
100.It Aus. Linx AL-9604R1S
101.It B-Link BL-LW05-5R
102.It Belkin F7D1102 Surf Wireless Micro
103.It D-Link DWA-121
104.It D-Link DWA-133
105.It D-Link DWA-135
106.It Digitus DN-7042
107.It Edimax EW-7811Un
108.It EDUP EP-N8508
109.It Full River FR-W100NUL
110.It Hercules Wireless N USB Pico HWNUp-150
111.It Netgear WNA1000A
112.It Planex GW-USEco300
113.It Planex GW-USNano2
114.It Planex GW-USValue-EZ
115.It Planex GW-USWExtreme
116.It POWCHIP POW-N18
117.It Sitecom WL-365
118.It Solwise NET-WL-UMD-606N
119.It TRENDnet TEW-648UBM
120.El
121.Sh EXAMPLES
122The following
123.Xr ifconfig.if 5
124example configures urtwn0 to join whatever network is available on boot,
125using WEP key
126.Dq 0x1deadbeef1 ,
127channel 11, obtaining an IP address using DHCP:
128.Bd -literal -offset indent
129nwkey 0x1deadbeef1 chan 11
130dhcp
131.Ed
132.Pp
133Configure urtwn0 to join network
134.Dq my_net
135using WPA with passphrase
136.Dq my_passphrase :
137.Bd -literal -offset indent
138# ifconfig urtwn0 nwid my_net wpakey my_passphrase
139.Ed
140.Pp
141Join an existing BSS network,
142.Dq my_net :
143.Bd -literal -offset indent
144# ifconfig urtwn0 192.168.1.1 netmask 0xffffff00 nwid my_net
145.Ed
146.Sh DIAGNOSTICS
147.Bl -diag
148.It "urtwn%d: error %d, could not read firmware %s"
149For some reason, the driver was unable to read the microcode file from the
150filesystem.
151The file might be missing or corrupted.
152.It "urtwn%d: device timeout"
153A frame dispatched to the hardware for transmission did not complete in time.
154The driver will reset the hardware.
155This should not happen.
156.El
157.Sh SEE ALSO
158.Xr arp 4 ,
159.Xr netintro 4 ,
160.Xr usb 4 ,
161.Xr ifconfig.if 5 ,
162.Xr wpa_supplicant.conf 5 ,
163.Xr ifconfig 8 ,
164.Xr wpa_supplicant 8
165.Sh HISTORY
166The
167.Nm
168device driver first appeared in
169.Ox 4.9
170and in
171.Nx 7.0 .
172.Sh AUTHORS
173The
174.Nm
175driver was written by
176.An Damien Bergamini
177.Aq damien@openbsd.org
178for
179.Ox
180and ported to
181.Nx
182by
183.An NONAKA Kimihiro
184.Aq nonaka@NetBSD.org .
185.Sh CAVEATS
186The
187.Nm
188driver does not support any of the 802.11n capabilities offered by the
189adapters.
190Additional work is required in
191.Xr ieee80211 9
192before those features can be supported.
193