xref: /openbsd/share/man/man4/urtwn.4 (revision 5af055cd)
1.\" $OpenBSD: urtwn.4,v 1.38 2016/01/20 23:40:33 juanfra 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: January 20 2016 $
18.Dt URTWN 4
19.Os
20.Sh NAME
21.Nm urtwn
22.Nd Realtek RTL8188CU/RTL8188EU/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, RTL8188EUS, RTL8188RU and RTL8192CU chipsets.
30.Pp
31The RTL8188CUS and RTL8188EUS are highly integrated 802.11n adapters
32that combine a MAC, a 1T1R capable baseband and an RF in a single chip.
33They operate 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.It /etc/firmware/urtwn-rtl8188eufw
87.El
88.Pp
89A prepackaged version of the firmware can be installed using
90.Xr fw_update 1 .
91.Sh HARDWARE
92The following adapters should work:
93.Pp
94.Bl -tag -width Ds -offset indent -compact
95.It Airlink101 AWLL5088
96.It Alfa AWUS036NHR
97.It Approx APPUSB300NANO V1
98.It Aus. Linx AL-9604R1S
99.It B-Link BL-LW05-5R
100.It Belkin F7D1102 Surf Wireless Micro
101.It D-Link DWA-121
102.It D-Link DWA-123 rev \&D1
103.It D-Link DWA-125 rev \&D1
104.It D-Link DWA-131 rev B
105.It D-Link DWA-133
106.It D-Link DWA-135
107.It Digitus DN-7042
108.It Edimax EW-7811Un
109.It EDUP EP-N8508
110.It Elecom WDC-150SU2M
111.It Full River FR-W100NUL
112.It Hercules Wireless N USB Pico HWNUp-150
113.It IO-DATA WN-G150UM
114.It ISY IWL4000 USB Wireless Micro Adapter
115.It Netgear WNA1000A
116.It Netgear WNA1000M
117.It Netgear WNA1000Mv2
118.It On Networks N300MA
119.It Patriot PCUSBW1150
120.It Planex GW-USEco300
121.It Planex GW-USNano2
122.It Planex GW-USValue-EZ
123.It Planex GW-USWExtreme
124.It POWCHIP POW-N18
125.It Prolink WN2201
126.It Sitecom WL-365
127.It Sitecom WLA-2100 v2
128.It Solwise NET-WL-UMD-606N
129.It TP-LINK TL-WN723N v3
130.It TP-LINK TL-WN725N v2
131.It TP-Link TL-WN821N v4
132.It TRENDnet TEW-648UBM
133.El
134.Sh EXAMPLES
135The following example scans for available networks:
136.Pp
137.Dl # ifconfig urtwn0 scan
138.Pp
139The following
140.Xr hostname.if 5
141example configures urtwn0 to join network
142.Dq mynwid ,
143using WPA key
144.Dq mywpakey ,
145obtaining an IP address using DHCP:
146.Bd -literal -offset indent
147nwid mynwid
148wpakey mywpakey
149dhcp
150.Ed
151.Sh DIAGNOSTICS
152.Bl -diag
153.It "urtwn0: error N, could not read firmware ..."
154For some reason, the driver was unable to read the microcode file from the
155filesystem.
156The file might be missing or corrupted.
157.It "urtwn0: device timeout"
158A frame dispatched to the hardware for transmission did not complete in time.
159The driver will reset the hardware.
160This should not happen.
161.El
162.Sh SEE ALSO
163.Xr arp 4 ,
164.Xr ifmedia 4 ,
165.Xr intro 4 ,
166.Xr netintro 4 ,
167.Xr usb 4 ,
168.Xr hostname.if 5 ,
169.Xr ifconfig 8
170.Sh HISTORY
171The
172.Nm
173driver first appeared in
174.Ox 4.9 .
175.Sh AUTHORS
176The
177.Nm
178driver was written by
179.An Damien Bergamini Aq Mt damien.bergamini@free.fr .
180.Sh CAVEATS
181The
182.Nm
183driver does not support any of the 802.11n capabilities offered by the
184adapters.
185Additional work is required in
186.Xr ieee80211 9
187before those features can be supported.
188