xref: /openbsd-src/share/man/man4/rsu.4 (revision 4c1e55dc91edd6e69ccc60ce855900fbc12cf34f)
1.\" $OpenBSD: rsu.4,v 1.8 2011/09/17 15:35:32 stsp 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: September 17 2011 $
18.Dt RSU 4
19.Os
20.Sh NAME
21.Nm rsu
22.Nd Realtek RTL8188SU/RTL8192SU USB IEEE 802.11b/g/n wireless network device
23.Sh SYNOPSIS
24.Cd "rsu* at uhub? port ?"
25.Sh DESCRIPTION
26The
27.Nm
28driver supports USB 2.0 wireless network devices based on Realtek
29RTL8188SU, RTL8191SU and RTL8192SU chipsets.
30.Pp
31The RTL8188SU 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.
34.Pp
35The RTL8191SU is a highly integrated multiple-in, single-out (MISO)
36802.11n adapter that combines a MAC, a 1T2R capable baseband and an
37RF in a single chip.
38It operates in the 2GHz spectrum only.
39.Pp
40The RTL8192SU is a highly integrated multiple-in, multiple-out (MIMO)
41802.11n adapter that combines a MAC, a 2T2R capable baseband and an
42RF in a single chip.
43It operates in the 2GHz spectrum only.
44.Pp
45These are the modes the
46.Nm
47driver can operate in:
48.Bl -tag -width "IBSS-masterXX"
49.It BSS mode
50Also known as
51.Em infrastructure
52mode, this is used when associating with an access point, through
53which all traffic passes.
54This mode is the default.
55.El
56.Pp
57The
58.Nm
59driver can be configured to use
60Wired Equivalent Privacy (WEP) or
61Wi-Fi Protected Access (WPA-PSK and WPA2-PSK).
62WPA is the de facto encryption standard for wireless networks.
63It is strongly recommended that WEP
64not be used as the sole mechanism
65to secure wireless communication,
66due to serious weaknesses in it.
67.Pp
68The
69.Nm
70driver can be configured at runtime with
71.Xr ifconfig 8
72or on boot with
73.Xr hostname.if 5 .
74.Sh FILES
75The driver needs at least version 1.1 of the following firmware file,
76which is loaded when an interface is attached:
77.Pp
78.Bl -tag -width Ds -offset indent -compact
79.It /etc/firmware/rsu-rtl8712fw
80.El
81.Pp
82A prepackaged version of the firmware, designed to be used with
83.Xr pkg_add 1 ,
84can be found at:
85.Bd -literal -offset 3n
86http://firmware.openbsd.org/firmware/rsu-firmware-1.1.tgz
87.Ed
88.Sh HARDWARE
89The following adapters should work:
90.Pp
91.Bl -tag -width Ds -offset indent -compact
92.It ASUS USB-N10
93.It Belkin F7D1101 v1
94.It D-Link DWA-131 A1
95.It Hercules HWGUn-54
96.It Hercules HWNUm-300
97.It Planex GW-USNano
98.It Sitecom WL-349 v1
99.It Sitecom WL-353
100.It Sweex LW154
101.It TRENDnet TEW-648UB
102.It TRENDnet TEW-649UB
103.El
104.Sh EXAMPLES
105The following
106.Xr hostname.if 5
107example configures rsu0 to join whatever network is available on boot,
108using WEP key
109.Dq 0x1deadbeef1 ,
110channel 11, obtaining an IP address using DHCP:
111.Bd -literal -offset indent
112dhcp NONE NONE NONE nwkey 0x1deadbeef1 chan 11
113.Ed
114.Pp
115Configure rsu0 to join network
116.Dq my_net
117using WPA with passphrase
118.Dq my_passphrase :
119.Bd -literal -offset indent
120# ifconfig rsu0 nwid my_net wpakey my_passphrase
121.Ed
122.Pp
123Join an existing BSS network,
124.Dq my_net :
125.Bd -literal -offset indent
126# ifconfig rsu0 192.168.1.1 netmask 0xffffff00 nwid my_net
127.Ed
128.Sh DIAGNOSTICS
129.Bl -diag
130.It "rsu%d: error %d, could not read firmware %s"
131For some reason, the driver was unable to read the microcode file from the
132filesystem.
133The file might be missing or corrupted.
134.It "rsu%d: device timeout"
135A frame dispatched to the hardware for transmission did not complete in time.
136The driver will reset the hardware.
137This should not happen.
138.El
139.Sh SEE ALSO
140.Xr arp 4 ,
141.Xr ifmedia 4 ,
142.Xr intro 4 ,
143.Xr netintro 4 ,
144.Xr usb 4 ,
145.Xr hostname.if 5 ,
146.Xr ifconfig 8
147.Sh HISTORY
148The
149.Nm
150driver first appeared in
151.Ox 4.9 .
152.Sh AUTHORS
153The
154.Nm
155driver was written by
156.An Damien Bergamini Aq damien@openbsd.org
157.
158.Sh CAVEATS
159The
160.Nm
161driver does not support any of the 802.11n capabilities offered by the
162adapters.
163Additional work is required in
164.Xr ieee80211 9
165before those features can be supported.
166