xref: /openbsd-src/share/man/man4/urtwn.4 (revision 50b7afb2c2c0993b0894d4e34bf857cb13ed9c80)
1.\" $OpenBSD: urtwn.4,v 1.30 2014/06/23 13:45:14 jmc 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 23 2014 $
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 current 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 can be installed using
89.Xr fw_update 1 .
90.Sh HARDWARE
91The following adapters should work:
92.Pp
93.Bl -tag -width Ds -offset indent -compact
94.It Airlink101 AWLL5088
95.It Alfa AWUS036NHR
96.It Aus. Linx AL-9604R1S
97.It B-Link BL-LW05-5R
98.It Belkin F7D1102 Surf Wireless Micro
99.It D-Link DWA-121
100.It D-Link DWA-131 rev B
101.It D-Link DWA-133
102.It D-Link DWA-135
103.It Digitus DN-7042
104.It Edimax EW-7811Un
105.It EDUP EP-N8508
106.It Full River FR-W100NUL
107.It Hercules Wireless N USB Pico HWNUp-150
108.It IO-DATA WN-G150UM
109.It ISY IWL4000 USB Wireless Micro Adapter
110.It Netgear WNA1000A
111.It Patriot PCUSBW1150
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 Prolink WN2201
118.It Sitecom WL-365
119.It Solwise NET-WL-UMD-606N
120.It TRENDnet TEW-648UBM
121.El
122.Sh EXAMPLES
123The following example scans for available networks:
124.Pp
125.Dl # ifconfig urtwn0 scan
126.Pp
127The following
128.Xr hostname.if 5
129example configures urtwn0 to join network
130.Dq mynwid ,
131using WPA key
132.Dq mywpakey ,
133obtaining an IP address using DHCP:
134.Bd -literal -offset indent
135nwid mynwid
136wpakey mywpakey
137dhcp
138.Ed
139.Sh DIAGNOSTICS
140.Bl -diag
141.It "urtwn0: error N, could not read firmware ..."
142For some reason, the driver was unable to read the microcode file from the
143filesystem.
144The file might be missing or corrupted.
145.It "urtwn0: device timeout"
146A frame dispatched to the hardware for transmission did not complete in time.
147The driver will reset the hardware.
148This should not happen.
149.El
150.Sh SEE ALSO
151.Xr arp 4 ,
152.Xr ifmedia 4 ,
153.Xr intro 4 ,
154.Xr netintro 4 ,
155.Xr usb 4 ,
156.Xr hostname.if 5 ,
157.Xr ifconfig 8
158.Sh HISTORY
159The
160.Nm
161driver first appeared in
162.Ox 4.9 .
163.Sh AUTHORS
164The
165.Nm
166driver was written by
167.An Damien Bergamini Aq Mt damien.bergamini@free.fr .
168.Sh CAVEATS
169The
170.Nm
171driver does not support any of the 802.11n capabilities offered by the
172adapters.
173Additional work is required in
174.Xr ieee80211 9
175before those features can be supported.
176