xref: /openbsd-src/share/man/man4/rsu.4 (revision d09093c168a1a6df49f1ee8217bfa05a5712a645)
1.\" $OpenBSD: rsu.4,v 1.25 2021/10/24 12:32:42 kn 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: October 24 2021 $
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 (WPA1 and WPA2).
62WPA2 is the current encryption standard for wireless networks.
63It is strongly recommended that neither WEP nor WPA1
64are used as the sole mechanism to secure wireless communication,
65due to serious weaknesses.
66WPA1 is disabled by default and may be enabled using the option
67.Qq Cm wpaprotos Ar wpa1,wpa2 .
68For standard WPA networks which use pre-shared keys (PSK),
69keys are configured using the
70.Qq Cm wpakey
71option.
72WPA-Enterprise networks require use of the wpa_supplicant package.
73.Pp
74The
75.Nm
76driver can be configured at runtime with
77.Xr ifconfig 8
78or on boot with
79.Xr hostname.if 5 .
80.Sh FILES
81The adapter needs firmware files to run, which are loaded on demand by
82the driver when the device is attached:
83.Pp
84.Bl -tag -width Ds -offset indent -compact
85.It Pa /etc/firmware/rsu-rtl8712
86.El
87.Sh HARDWARE
88The following adapters should work:
89.Pp
90.Bl -tag -width Ds -offset indent -compact
91.It ASUS USB-N10
92.It ASUS WL-167G V3
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 example scans for available networks:
106.Pp
107.Dl # ifconfig rsu0 scan
108.Pp
109The following
110.Xr hostname.if 5
111example configures rsu0 to join network
112.Dq mynwid ,
113using WPA key
114.Dq mywpakey ,
115obtaining an IP address using DHCP:
116.Bd -literal -offset indent
117join mynwid wpakey mywpakey
118inet autoconf
119.Ed
120.Sh DIAGNOSTICS
121.Bl -diag
122.It "rsu0: error N, could not read firmware ..."
123For some reason, the driver was unable to read the microcode file from the
124filesystem.
125The file might be missing or corrupted.
126.It "rsu0: device timeout"
127A frame dispatched to the hardware for transmission did not complete in time.
128The driver will reset the hardware.
129This should not happen.
130.El
131.Sh SEE ALSO
132.Xr arp 4 ,
133.Xr ifmedia 4 ,
134.Xr intro 4 ,
135.Xr netintro 4 ,
136.Xr usb 4 ,
137.Xr hostname.if 5 ,
138.Xr ifconfig 8
139.Sh HISTORY
140The
141.Nm
142driver first appeared in
143.Ox 4.9 .
144.Sh AUTHORS
145The
146.Nm
147driver was written by
148.An Damien Bergamini Aq Mt damien.bergamini@free.fr .
149.Sh CAVEATS
150The
151.Nm
152driver does not support any of the 802.11n capabilities offered by the
153adapters.
154Additional work is required in
155.Xr ieee80211 9
156before those features can be supported.
157.Pp
158This driver does not support powersave mode.
159