xref: /freebsd/share/man/man4/rsu.4 (revision 40a8ac8f62b535d30349faf28cf47106b7041b83)
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 May 3, 2014
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
25To compile this driver into the kernel,
26place the following lines in your kernel configuration file:
27.Bd -ragged -offset indent
28.Cd "device ehci"
29.Cd "device uhci"
30.Cd "device ohci"
31.Cd "device usb"
32.Cd "device rsu"
33.Cd "device wlan"
34.Ed
35.Pp
36Alternatively, to load the driver as a module at boot time,
37place the following line in
38.Xr loader.conf 5 :
39.Bd -literal -offset indent
40if_rsu_load="YES"
41.Ed
42.Pp
43After you have read the license in
44.Pa /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 .
98.Sh FILES
99The driver needs at least version 1.2 of the following firmware file,
100which is loaded when an interface is attached:
101.Pp
102.Bl -tag -width Ds -offset indent -compact
103.It Pa /boot/kernel/rsu-rtl8712fw.ko
104.El
105.Sh HARDWARE
106The
107.Nm
108driver provices support for Realtek RTL8188SU/RTL8192SU USB IEEE 802.11b/g/n
109wireless network adapters, including:
110.Pp
111.Bl -tag -width Ds -offset indent -compact
112.It ASUS USB-N10
113.It Belkin F7D1101 v1
114.It D-Link DWA-131 A1
115.It EDUP EP-MS150N(W)
116.It Hercules HWGUn-54
117.It Hercules HWNUm-300
118.It Planex GW-USNano
119.It Sitecom WL-349 v1
120.It Sitecom WL-353
121.It Sweex LW154
122.It TRENDnet TEW-648UB
123.It TRENDnet TEW-649UB
124.El
125.Sh EXAMPLES
126Join an existing BSS network (i.e., connect to an access point):
127.Bd -literal -offset indent
128ifconfig wlan create wlandev rsu0 inet 192.168.0.20 \e
129    netmask 0xffffff00
130.Ed
131.Pp
132Join a specific BSS network with network name
133.Dq Li my_net :
134.Pp
135.Dl "ifconfig wlan create wlandev rsu0 ssid my_net up"
136.Pp
137Join a specific BSS network with 64-bit WEP encryption:
138.Bd -literal -offset indent
139ifconfig wlan create wlandev rsu0 ssid my_net \e
140        wepmode on wepkey 0x1234567890 weptxkey 1 up
141.Ed
142.Sh DIAGNOSTICS
143.Bl -diag
144.It "%s: failed load firmware of file rsu-rtl8712fw"
145For some reason, the driver was unable to read the microcode file from the
146filesystem.
147The file might be missing or corrupted.
148.It "device timeout"
149A frame dispatched to the hardware for transmission did not complete in time.
150The driver will reset the hardware.
151This should not happen.
152.El
153.Sh SEE ALSO
154.Xr intro 1 ,
155.Xr usb 4 ,
156.Xr netintro 4 ,
157.Xr rsufw 4 ,
158.Xr wlan 4 ,
159.Xr arp 8 ,
160.Xr hostapd 8 ,
161.Xr ifconfig 8 ,
162.Xr wpa_supplicant 8
163.Sh HISTORY
164The
165.Nm
166driver first appeared in
167.Ox 4.9 and
168.Fx 10.0 .
169.Sh AUTHORS
170.An -nosplit
171The
172.Nm
173driver was written by
174.An Damien Bergamini Aq Mt damien@openbsd.org
175and ported by
176.An Rui Paulo Aq Mt rpaulo@freebsd.org .
177.Sh CAVEATS
178The
179.Nm
180driver does not support any of the 802.11n capabilities offered by the
181adapters.
182