xref: /freebsd/share/man/man4/rsu.4 (revision 006afc9b5c6a74f22ce7bbea4c307a940c52f069)
1.\" $OpenBSD: rsu.4,v 1.11 2013/02/14 07:40:42 jmc Exp $
2.\" $FreeBSD$
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 July 29 2013
19.Dt RSU 4
20.Os
21.Sh NAME
22.Nm rsu
23.Nd Realtek RTL8188SU/RTL8192SU USB IEEE 802.11b/g/n wireless network device
24.Sh SYNOPSIS
25.\.Cd "rsu* at uhub? port ?"
26To compile this driver into the kernel,
27place the following lines in your kernel configuration file:
28.Bd -ragged -offset indent
29.Cd "device ehci"
30.Cd "device uhci"
31.Cd "device ohci"
32.Cd "device usb"
33.Cd "device rsu"
34.Cd "device wlan"
35.Ed
36.Pp
37Alternatively, to load the driver as a module at boot time,
38place the following line in
39.Xr loader.conf 5:
40.Bd -literal -offset indent
41.Xr if_rsu_load="YES"
42.Ed
43.Pp
44After you have read the license in /usr/share/doc/legal/realtek
45you will want to add the following lines to
46.Xr loader.conf 5 :
47.Bd -literal -offset indent
48legal.realtek.license_ack=1
49rsu-rtl8712fw_load="YES"
50.Ed
51.Sh DESCRIPTION
52The
53.Nm
54driver supports USB 2.0 wireless network devices based on Realtek
55RTL8188SU, RTL8191SU and RTL8192SU chipsets.
56.Pp
57The RTL8188SU is a highly integrated 802.11n adapter that combines
58a MAC, a 1T1R capable baseband and an RF in a single chip.
59It operates in the 2GHz spectrum only.
60.Pp
61The RTL8191SU is a highly integrated multiple-in, single-out (MISO)
62802.11n adapter that combines a MAC, a 1T2R capable baseband and an
63RF in a single chip.
64It operates in the 2GHz spectrum only.
65.Pp
66The RTL8192SU is a highly integrated multiple-in, multiple-out (MIMO)
67802.11n adapter that combines a MAC, a 2T2R capable baseband and an
68RF in a single chip.
69It operates in the 2GHz spectrum only.
70.Pp
71These are the modes the
72.Nm
73driver can operate in:
74.Bl -tag -width "IBSS-masterXX"
75.It BSS mode
76Also known as
77.Em infrastructure
78mode, this is used when associating with an access point, through
79which all traffic passes.
80This mode is the default.
81.El
82.Pp
83The
84.Nm
85driver can be configured to use
86Wired Equivalent Privacy (WEP) or
87Wi-Fi Protected Access (WPA-PSK and WPA2-PSK).
88WPA is the de facto encryption standard for wireless networks.
89It is strongly recommended that WEP
90not be used as the sole mechanism
91to secure wireless communication,
92due to serious weaknesses in it.
93.Pp
94The
95.Nm
96driver can be configured at runtime with
97.Xr ifconfig 8
98or on boot with
99.Xr hostname 1 .
100.Sh FILES
101The driver needs at least version 1.2 of the following firmware file,
102which is loaded when an interface is attached:
103.Pp
104.Bl -tag -width Ds -offset indent -compact
105.It /boot/kernel/rsu-rtl8712fw.ko
106.El
107.Sh HARDWARE
108The following adapters should work:
109.Pp
110.Bl -tag -width Ds -offset indent -compact
111.It ASUS USB-N10
112.It Belkin F7D1101 v1
113.It D-Link DWA-131 A1
114.It EDUP EP-MS150N(W)
115.It Hercules HWGUn-54
116.It Hercules HWNUm-300
117.It Planex GW-USNano
118.It Sitecom WL-349 v1
119.It Sitecom WL-353
120.It Sweex LW154
121.It TRENDnet TEW-648UB
122.It TRENDnet TEW-649UB
123.Sh EXAMPLES
124Join an existing BSS network (i.e., connect to an access point):
125.Bd -literal -offset indent
126ifconfig wlan create wlandev rsu0 inet 192.168.0.20 \e
127    netmask 0xffffff00
128.Ed
129.Pp
130Join a specific BSS network with network name
131.Dq Li my_net :
132.Pp
133.Dl "ifconfig wlan create wlandev rsu0 ssid my_net up"
134.Pp
135Join a specific BSS network with 64-bit WEP encryption:
136.Bd -literal -offset indent
137ifconfig wlan create wlandev rsu0 ssid my_net \e
138        wepmode on wepkey 0x1234567890 weptxkey 1 up
139.Ed
140.Sh DIAGNOSTICS
141.Bl -diag
142.It "%s: failed load firmware of file rsu-rtl8712fw"
143For some reason, the driver was unable to read the microcode file from the
144filesystem.
145The file might be missing or corrupted.
146.It "device timeout"
147A frame dispatched to the hardware for transmission did not complete in time.
148The driver will reset the hardware.
149This should not happen.
150.El
151.Sh SEE ALSO
152.Xr arp 8 ,
153.Xr intro 1 ,
154.Xr netintro 4 ,
155.Xr usb 3 ,
156.Xr hostname 1 ,
157.Xr ifconfig 8,
158.Xr wlan 4 ,
159.Xr rsufw 4
160.Sh HISTORY
161The
162.Nm
163driver first appeared in
164.Ox 4.9 and
165.Fx 10.0 .
166.Sh AUTHORS
167.An -nosplit
168The
169.Nm
170driver was written by
171.An Damien Bergamini Aq damien@openbsd.org
172and ported by
173.An Rui Paulo Aq rpaulo@freebsd.org .
174.Sh CAVEATS
175The
176.Nm
177driver does not support any of the 802.11n capabilities offered by the
178adapters.
179