xref: /freebsd/share/man/man4/rsu.4 (revision 1603881667360c015f6685131f2f25474fa67a72)
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 23, 2021
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 rsufw"
34.Cd "device wlan"
35.Ed
36.Pp
37Alternatively, to load the driver as a module at boot time,
38place the following lines in
39.Xr loader.conf 5 :
40.Bd -literal -offset indent
41if_rsu_load="YES"
42rsu-rtl8712fw_load="YES"
43.Ed
44.Sh DESCRIPTION
45The
46.Nm
47driver supports USB 2.0 wireless network devices based on Realtek
48RTL8188SU, RTL8191SU and RTL8192SU chipsets.
49.Pp
50The RTL8188SU is a highly integrated 802.11n adapter that combines
51a MAC, a 1T1R capable baseband and an RF in a single chip.
52It operates in the 2GHz spectrum only.
53.Pp
54The RTL8191SU is a highly integrated multiple-in, single-out (MISO)
55802.11n adapter that combines a MAC, a 1T2R capable baseband and an
56RF in a single chip.
57It operates in the 2GHz spectrum only.
58.Pp
59The RTL8192SU is a highly integrated multiple-in, multiple-out (MIMO)
60802.11n adapter that combines a MAC, a 2T2R capable baseband and an
61RF in a single chip.
62It operates in the 2GHz spectrum only.
63.Pp
64These are the modes the
65.Nm
66driver can operate in:
67.Bl -tag -width "IBSS-masterXX"
68.It BSS mode
69Also known as
70.Em infrastructure
71mode, this is used when associating with an access point, through
72which all traffic passes.
73This mode is the default.
74.It monitor mode
75In this mode the driver is able to receive packets without
76associating with an access point.
77This disables the internal receive filter and enables the card to
78capture packets from networks which it wouldn't normally have access to,
79or to scan for access points.
80.El
81.Pp
82The
83.Nm
84driver can be configured to use
85Wired Equivalent Privacy (WEP) or
86Wi-Fi Protected Access (WPA-PSK and WPA2-PSK).
87WPA is the de facto encryption standard for wireless networks.
88It is strongly recommended that WEP
89not be used as the sole mechanism
90to secure wireless communication,
91due to serious weaknesses in it.
92.Pp
93The
94.Nm
95driver can be configured at runtime with
96.Xr ifconfig 8 .
97.Sh FILES
98.Bl -tag -width ".Pa /usr/share/doc/legal/realtek.LICENSE" -compact
99.It Pa /usr/share/doc/legal/realtek.LICENSE
100.Nm
101firmware license
102.El
103.Pp
104The driver needs at least version 1.2 of the following firmware file,
105which is loaded when an interface is attached:
106.Pp
107.Bl -tag -width Ds -offset indent -compact
108.It Pa /boot/kernel/rsu-rtl8712fw.ko
109.El
110.Sh HARDWARE
111The
112.Nm
113driver provices support for Realtek RTL8188SU/RTL8192SU USB IEEE 802.11b/g/n
114wireless network adapters, including:
115.Pp
116.Bl -tag -width Ds -offset indent -compact
117.It ASUS USB-N10
118.It ASUS WL-167G V3
119.It Belkin F7D1101 v1
120.It D-Link DWA-131 A1
121.It EDUP EP-MS150N(W)
122.It Edimax EW-7622UMN
123.It Hercules HWGUn-54
124.It Hercules HWNUm-300
125.It Planex GW-USNano
126.It Sitecom WL-349 v1
127.It Sitecom WL-353
128.It Sweex LW154
129.It TRENDnet TEW-646UBH
130.It TRENDnet TEW-648UB
131.It TRENDnet TEW-649UB
132.El
133.Sh EXAMPLES
134Join an existing BSS network (i.e., connect to an access point):
135.Bd -literal -offset indent
136ifconfig wlan create wlandev rsu0 inet 192.168.0.20 \e
137    netmask 0xffffff00
138.Ed
139.Pp
140Join a specific BSS network with network name
141.Dq Li my_net :
142.Pp
143.Dl "ifconfig wlan create wlandev rsu0 ssid my_net up"
144.Pp
145Join a specific BSS network with 64-bit WEP encryption:
146.Bd -literal -offset indent
147ifconfig wlan create wlandev rsu0 ssid my_net \e
148        wepmode on wepkey 0x1234567890 weptxkey 1 up
149.Ed
150.Sh DIAGNOSTICS
151.Bl -diag
152.It "%s: failed load firmware of file rsu-rtl8712fw"
153For some reason, the driver was unable to read the microcode file from the
154filesystem.
155The file might be missing or corrupted.
156.It "device timeout"
157A frame dispatched to the hardware for transmission did not complete in time.
158The driver will reset the hardware.
159This should not happen.
160.El
161.Sh SEE ALSO
162.Xr intro 1 ,
163.Xr netintro 4 ,
164.Xr rsufw 4 ,
165.Xr usb 4 ,
166.Xr wlan 4 ,
167.Xr arp 8 ,
168.Xr hostapd 8 ,
169.Xr ifconfig 8 ,
170.Xr wpa_supplicant 8
171.Sh HISTORY
172The
173.Nm
174driver first appeared in
175.Ox 4.9 and
176.Fx 10.0 .
177.Sh AUTHORS
178.An -nosplit
179The
180.Nm
181driver was written by
182.An Damien Bergamini Aq Mt damien@openbsd.org
183and ported by
184.An Rui Paulo Aq Mt rpaulo@freebsd.org .
185The 802.11n support was added by
186.An Adrian Chadd Aq Mt adrian@freebsd.org .
187.Sh CAVEATS
188The
189.Nm
190driver currently does not support 802.11n transmit aggregation,
191either A-MSDU or A-MPDU.
192.Pp
193The
194.Nm
195driver does not capture management frames in non-monitor modes;
196without this limitation some firmware functions (e.g., 'join bss')
197will not work properly.
198