summaryrefslogtreecommitdiff
path: root/static/freebsd/man4/rsu.4 3.html
blob: ac00c4fbd5e2bc42174cd2a5c74abe29f9c372e6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
<table class="head">
  <tr>
    <td class="head-ltitle">RSU(4)</td>
    <td class="head-vol">Device Drivers Manual</td>
    <td class="head-rtitle">RSU(4)</td>
  </tr>
</table>
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<p class="Pp"><code class="Nm">rsu</code> &#x2014; <span class="Nd">Realtek
    RTL8188SU/RTL8192SU USB IEEE 802.11b/g/n wireless network driver</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<p class="Pp">To compile this driver into the kernel, place the following lines
    in your kernel configuration file:</p>
<div class="Bd Pp Bd-indent"><code class="Cd">device ehci</code>
<br/>
<code class="Cd">device uhci</code>
<br/>
<code class="Cd">device ohci</code>
<br/>
<code class="Cd">device usb</code>
<br/>
<code class="Cd">device rsu</code>
<br/>
<code class="Cd">device rsufw</code>
<br/>
<code class="Cd">device wlan</code></div>
<p class="Pp">Alternatively, to load the driver as a module at boot time, place
    the following lines in <a class="Xr">loader.conf(5)</a>:</p>
<div class="Bd Pp Bd-indent Li">
<pre>if_rsu_load=&quot;YES&quot;
rsu-rtl8712fw_load=&quot;YES&quot;</pre>
</div>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">The <code class="Nm">rsu</code> driver supports USB 2.0 wireless
    network devices based on Realtek RTL8188SU, RTL8191SU and RTL8192SU
    chipsets.</p>
<p class="Pp">The RTL8188SU is a highly integrated 802.11n adapter that combines
    a MAC, a 1T1R capable baseband and an RF in a single chip. It operates in
    the 2GHz spectrum only.</p>
<p class="Pp">The RTL8191SU is a highly integrated multiple-in, single-out
    (MISO) 802.11n adapter that combines a MAC, a 1T2R capable baseband and an
    RF in a single chip. It operates in the 2GHz spectrum only.</p>
<p class="Pp">The RTL8192SU is a highly integrated multiple-in, multiple-out
    (MIMO) 802.11n adapter that combines a MAC, a 2T2R capable baseband and an
    RF in a single chip. It operates in the 2GHz spectrum only.</p>
<p class="Pp">These are the modes the <code class="Nm">rsu</code> driver can
    operate in:</p>
<dl class="Bl-tag">
  <dt id="infrastructure">BSS mode</dt>
  <dd>Also known as
      <a class="permalink" href="#infrastructure"><i class="Em">infrastructure</i></a>
      mode, this is used when associating with an access point, through which
      all traffic passes. This mode is the default.</dd>
  <dt>monitor mode</dt>
  <dd>In this mode the driver is able to receive packets without associating
      with an access point. This disables the internal receive filter and
      enables the card to capture packets from networks which it wouldn't
      normally have access to, or to scan for access points.</dd>
</dl>
<p class="Pp">The <code class="Nm">rsu</code> driver can be configured to use
    Wired Equivalent Privacy (WEP) or Wi-Fi Protected Access (WPA-PSK and
    WPA2-PSK). WPA is the de facto encryption standard for wireless networks. It
    is strongly recommended that WEP not be used as the sole mechanism to secure
    wireless communication, due to serious weaknesses in it.</p>
<p class="Pp">The <code class="Nm">rsu</code> driver can be configured at
    runtime with <a class="Xr">ifconfig(8)</a>.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="HARDWARE"><a class="permalink" href="#HARDWARE">HARDWARE</a></h1>
<p class="Pp">The <code class="Nm">rsu</code> driver provides support for
    Realtek RTL8188SU/RTL8192SU USB IEEE 802.11b/g/n wireless network adapters,
    including:</p>
<p class="Pp"></p>
<ul class="Bl-bullet Bd-indent Bl-compact">
  <li>ASUS USB-N10</li>
  <li>ASUS WL-167G V3</li>
  <li>Belkin F7D1101 v1</li>
  <li>D-Link DWA-131 A1</li>
  <li>EDUP EP-MS150N(W)</li>
  <li>Edimax EW-7622UMN</li>
  <li>Hercules HWGUn-54</li>
  <li>Hercules HWNUm-300</li>
  <li>Planex GW-USNano</li>
  <li>Sitecom WL-349 v1</li>
  <li>Sitecom WL-353</li>
  <li>Sitecom WLA-1100 v1001</li>
  <li>Sweex LW154</li>
  <li>TRENDnet TEW-646UBH</li>
  <li>TRENDnet TEW-648UB</li>
  <li>TRENDnet TEW-649UB</li>
</ul>
</section>
<section class="Sh">
<h1 class="Sh" id="FILES"><a class="permalink" href="#FILES">FILES</a></h1>
<dl class="Bl-tag Bl-compact">
  <dt><span class="Pa">/usr/share/doc/legal/realtek.LICENSE</span></dt>
  <dd><code class="Nm">rsu</code> firmware license</dd>
</dl>
<p class="Pp">The driver needs at least version 1.2 of the following firmware
    file, which is loaded when an interface is attached:</p>
<p class="Pp"></p>
<div class="Bd-indent">
<dl class="Bl-tag Bl-compact">
  <dt><span class="Pa">/boot/kernel/rsu-rtl8712fw.ko</span></dt>
  <dd style="width: auto;">&#x00A0;</dd>
</dl>
</div>
</section>
<section class="Sh">
<h1 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h1>
<p class="Pp">Join an existing BSS network (i.e., connect to an access
  point):</p>
<p class="Pp"></p>
<div class="Bd Bd-indent"><code class="Li">ifconfig wlan create wlandev rsu0
  inet 192.0.2.20/24</code></div>
<p class="Pp">Join a specific BSS network with network name
    <var class="Ar">my_net</var>:</p>
<p class="Pp"></p>
<div class="Bd Bd-indent"><code class="Li">ifconfig wlan create wlandev rsu0
  ssid my_net up</code></div>
<p class="Pp">Join a specific BSS network with 64-bit WEP encryption:</p>
<div class="Bd Pp Bd-indent Li">
<pre>ifconfig wlan create wlandev rsu0 ssid my_net \
    wepmode on wepkey 0x1234567890 weptxkey 1 up</pre>
</div>
</section>
<section class="Sh">
<h1 class="Sh" id="DIAGNOSTICS"><a class="permalink" href="#DIAGNOSTICS">DIAGNOSTICS</a></h1>
<dl class="Bl-diag">
  <dt>%s: failed load firmware of file rsu-rtl8712fw</dt>
  <dd>For some reason, the driver was unable to read the microcode file from the
      filesystem. The file might be missing or corrupted.</dd>
  <dt>device timeout</dt>
  <dd>A frame dispatched to the hardware for transmission did not complete in
      time. The driver will reset the hardware. This should not happen.</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
  ALSO</a></h1>
<p class="Pp"><a class="Xr">intro(1)</a>, <a class="Xr">netintro(4)</a>,
    <a class="Xr">rsufw(4)</a>, <a class="Xr">usb(4)</a>,
    <a class="Xr">wlan(4)</a>, <a class="Xr">networking(7)</a>,
    <a class="Xr">arp(8)</a>, <a class="Xr">hostapd(8)</a>,
    <a class="Xr">ifconfig(8)</a>, <a class="Xr">wpa_supplicant(8)</a></p>
</section>
<section class="Sh">
<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
<p class="Pp">The <code class="Nm">rsu</code> driver first appeared in
    <span class="Ux">OpenBSD 4.9</span> and <span class="Ux">FreeBSD
    10.0</span>.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1>
<p class="Pp">The <code class="Nm">rsu</code> driver was written by
    <span class="An">Damien Bergamini</span>
    &lt;<a class="Mt" href="mailto:damien@openbsd.org">damien@openbsd.org</a>&gt;
    and ported by <span class="An">Rui Paulo</span>
    &lt;<a class="Mt" href="mailto:rpaulo@freebsd.org">rpaulo@freebsd.org</a>&gt;.
    The 802.11n support was added by <span class="An">Adrian Chadd</span>
    &lt;<a class="Mt" href="mailto:adrian@freebsd.org">adrian@freebsd.org</a>&gt;.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="CAVEATS"><a class="permalink" href="#CAVEATS">CAVEATS</a></h1>
<p class="Pp">The <code class="Nm">rsu</code> driver currently does not support
    802.11n transmit aggregation, either A-MSDU or A-MPDU.</p>
<p class="Pp">The <code class="Nm">rsu</code> driver does not capture management
    frames in non-monitor modes; without this limitation some firmware functions
    (e.g., 'join bss') will not work properly.</p>
</section>
</div>
<table class="foot">
  <tr>
    <td class="foot-date">April 1, 2025</td>
    <td class="foot-os">FreeBSD 15.0</td>
  </tr>
</table>