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