xref: /openbsd-src/share/man/man4/rsu.4 (revision 46035553bfdd96e63c94e32da0210227ec2e3cf1)
1.\" $OpenBSD: rsu.4,v 1.22 2019/11/10 14:10:41 sthen 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: November 10 2019 $
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 driver needs at least version 1.1 of the following firmware file,
82which is loaded when an interface is attached:
83.Pp
84.Bl -tag -width Ds -offset indent -compact
85.It Pa /etc/firmware/rsu-rtl8712fw
86.El
87.Pp
88A prepackaged version of the firmware can be installed using
89.Xr fw_update 1 .
90.Sh HARDWARE
91The following adapters should work:
92.Pp
93.Bl -tag -width Ds -offset indent -compact
94.It ASUS USB-N10
95.It ASUS WL-167G V3
96.It Belkin F7D1101 v1
97.It D-Link DWA-131 A1
98.It Hercules HWGUn-54
99.It Hercules HWNUm-300
100.It Planex GW-USNano
101.It Sitecom WL-349 v1
102.It Sitecom WL-353
103.It Sweex LW154
104.It TRENDnet TEW-648UB
105.It TRENDnet TEW-649UB
106.El
107.Sh EXAMPLES
108The following example scans for available networks:
109.Pp
110.Dl # ifconfig rsu0 scan
111.Pp
112The following
113.Xr hostname.if 5
114example configures rsu0 to join network
115.Dq mynwid ,
116using WPA key
117.Dq mywpakey ,
118obtaining an IP address using DHCP:
119.Bd -literal -offset indent
120nwid mynwid wpakey mywpakey
121dhcp
122.Ed
123.Sh DIAGNOSTICS
124.Bl -diag
125.It "rsu0: error N, could not read firmware ..."
126For some reason, the driver was unable to read the microcode file from the
127filesystem.
128The file might be missing or corrupted.
129.It "rsu0: device timeout"
130A frame dispatched to the hardware for transmission did not complete in time.
131The driver will reset the hardware.
132This should not happen.
133.El
134.Sh SEE ALSO
135.Xr arp 4 ,
136.Xr ifmedia 4 ,
137.Xr intro 4 ,
138.Xr netintro 4 ,
139.Xr usb 4 ,
140.Xr hostname.if 5 ,
141.Xr ifconfig 8
142.Sh HISTORY
143The
144.Nm
145driver first appeared in
146.Ox 4.9 .
147.Sh AUTHORS
148The
149.Nm
150driver was written by
151.An Damien Bergamini Aq Mt damien.bergamini@free.fr .
152.Sh CAVEATS
153The
154.Nm
155driver does not support any of the 802.11n capabilities offered by the
156adapters.
157Additional work is required in
158.Xr ieee80211 9
159before those features can be supported.
160.Pp
161This driver does not support powersave mode.
162