xref: /freebsd/share/man/man4/rsu.4 (revision b64c5a0ace59af62eff52bfe110a521dc73c937b)
1.\"-
2.\" SPDX-License-Identifier: ISC
3.\"
4.\" $OpenBSD: rsu.4,v 1.11 2013/02/14 07:40:42 jmc Exp $
5.\"
6.\" Copyright (c) 2010 Damien Bergamini <damien.bergamini@free.fr>
7.\"
8.\" Permission to use, copy, modify, and distribute this software for any
9.\" purpose with or without fee is hereby granted, provided that the above
10.\" copyright notice and this permission notice appear in all copies.
11.\"
12.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
13.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
14.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
15.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
16.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
17.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
18.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19.\"
20.Dd November 10, 2024
21.Dt RSU 4
22.Os
23.Sh NAME
24.Nm rsu
25.Nd Realtek RTL8188SU/RTL8192SU USB IEEE 802.11b/g/n wireless network driver
26.Sh SYNOPSIS
27To compile this driver into the kernel,
28place the following lines in your kernel configuration file:
29.Bd -ragged -offset indent
30.Cd "device ehci"
31.Cd "device uhci"
32.Cd "device ohci"
33.Cd "device usb"
34.Cd "device rsu"
35.Cd "device rsufw"
36.Cd "device wlan"
37.Ed
38.Pp
39Alternatively, to load the driver as a module at boot time,
40place the following lines in
41.Xr loader.conf 5 :
42.Bd -literal -offset indent
43if_rsu_load="YES"
44rsu-rtl8712fw_load="YES"
45.Ed
46.Sh DESCRIPTION
47The
48.Nm
49driver supports USB 2.0 wireless network devices based on Realtek
50RTL8188SU, RTL8191SU and RTL8192SU chipsets.
51.Pp
52The RTL8188SU is a highly integrated 802.11n adapter that combines
53a MAC, a 1T1R capable baseband and an RF in a single chip.
54It operates in the 2GHz spectrum only.
55.Pp
56The RTL8191SU is a highly integrated multiple-in, single-out (MISO)
57802.11n adapter that combines a MAC, a 1T2R capable baseband and an
58RF in a single chip.
59It operates in the 2GHz spectrum only.
60.Pp
61The RTL8192SU is a highly integrated multiple-in, multiple-out (MIMO)
62802.11n adapter that combines a MAC, a 2T2R capable baseband and an
63RF in a single chip.
64It operates in the 2GHz spectrum only.
65.Pp
66These are the modes the
67.Nm
68driver can operate in:
69.Bl -tag -width "IBSS-masterXX"
70.It BSS mode
71Also known as
72.Em infrastructure
73mode, this is used when associating with an access point, through
74which all traffic passes.
75This mode is the default.
76.It monitor mode
77In this mode the driver is able to receive packets without
78associating with an access point.
79This disables the internal receive filter and enables the card to
80capture packets from networks which it wouldn't normally have access to,
81or to scan for access points.
82.El
83.Pp
84The
85.Nm
86driver can be configured to use
87Wired Equivalent Privacy (WEP) or
88Wi-Fi Protected Access (WPA-PSK and WPA2-PSK).
89WPA is the de facto encryption standard for wireless networks.
90It is strongly recommended that WEP
91not be used as the sole mechanism
92to secure wireless communication,
93due to serious weaknesses in it.
94.Pp
95The
96.Nm
97driver can be configured at runtime with
98.Xr ifconfig 8 .
99.Sh HARDWARE
100The
101.Nm
102driver provides support for Realtek RTL8188SU/RTL8192SU USB IEEE 802.11b/g/n
103wireless network adapters, including:
104.Pp
105.Bl -bullet -offset indent -compact
106.It
107ASUS USB-N10
108.It
109ASUS WL-167G V3
110.It
111Belkin F7D1101 v1
112.It
113D-Link DWA-131 A1
114.It
115EDUP EP-MS150N(W)
116.It
117Edimax EW-7622UMN
118.It
119Hercules HWGUn-54
120.It
121Hercules HWNUm-300
122.It
123Planex GW-USNano
124.It
125Sitecom WL-349 v1
126.It
127Sitecom WL-353
128.It
129Sweex LW154
130.It
131TRENDnet TEW-646UBH
132.It
133TRENDnet TEW-648UB
134.It
135TRENDnet TEW-649UB
136.El
137.Sh FILES
138.Bl -tag -width "/usr/share/doc/legal/realtek.LICENSE" -compact
139.It Pa /usr/share/doc/legal/realtek.LICENSE
140.Nm
141firmware license
142.El
143.Pp
144The driver needs at least version 1.2 of the following firmware file,
145which is loaded when an interface is attached:
146.Pp
147.Bl -tag -width Ds -offset indent -compact
148.It Pa /boot/kernel/rsu-rtl8712fw.ko
149.El
150.Sh EXAMPLES
151Join an existing BSS network (i.e., connect to an access point):
152.Pp
153.Dl ifconfig wlan create wlandev rsu0 inet 192.0.2.20/24
154.Pp
155Join a specific BSS network with network name
156.Ar my_net :
157.Pp
158.Dl ifconfig wlan create wlandev rsu0 ssid my_net up
159.Pp
160Join a specific BSS network with 64-bit WEP encryption:
161.Bd -literal -offset indent
162ifconfig wlan create wlandev rsu0 ssid my_net \e
163    wepmode on wepkey 0x1234567890 weptxkey 1 up
164.Ed
165.Sh DIAGNOSTICS
166.Bl -diag
167.It "%s: failed load firmware of file rsu-rtl8712fw"
168For some reason, the driver was unable to read the microcode file from the
169filesystem.
170The file might be missing or corrupted.
171.It "device timeout"
172A frame dispatched to the hardware for transmission did not complete in time.
173The driver will reset the hardware.
174This should not happen.
175.El
176.Sh SEE ALSO
177.Xr intro 1 ,
178.Xr netintro 4 ,
179.Xr rsufw 4 ,
180.Xr usb 4 ,
181.Xr wlan 4 ,
182.Xr networking 7 ,
183.Xr arp 8 ,
184.Xr hostapd 8 ,
185.Xr ifconfig 8 ,
186.Xr wpa_supplicant 8
187.Sh HISTORY
188The
189.Nm
190driver first appeared in
191.Ox 4.9 and
192.Fx 10.0 .
193.Sh AUTHORS
194.An -nosplit
195The
196.Nm
197driver was written by
198.An Damien Bergamini Aq Mt damien@openbsd.org
199and ported by
200.An Rui Paulo Aq Mt rpaulo@freebsd.org .
201The 802.11n support was added by
202.An Adrian Chadd Aq Mt adrian@freebsd.org .
203.Sh CAVEATS
204The
205.Nm
206driver currently does not support 802.11n transmit aggregation,
207either A-MSDU or A-MPDU.
208.Pp
209The
210.Nm
211driver does not capture management frames in non-monitor modes;
212without this limitation some firmware functions (e.g., 'join bss')
213will not work properly.
214