summaryrefslogtreecommitdiff
path: root/static/netbsd/man4/rum.4 3.html
blob: f945a1acc353b804b7a33bf0d1c7e79eb912bfe6 (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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
<table class="head">
  <tr>
    <td class="head-ltitle">RUM(4)</td>
    <td class="head-vol">Device Drivers Manual</td>
    <td class="head-rtitle">RUM(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">rum</code> &#x2014; <span class="Nd">Ralink
    Technology USB IEEE 802.11a/b/g wireless network device</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<p class="Pp"><code class="Cd">rum* at uhub? port ?</code></p>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">The <code class="Nm">rum</code> driver supports USB 2.0 wireless
    adapters based on the Ralink RT2501USB and RT2601USB chipsets.</p>
<p class="Pp">The RT2501USB chipset is the second generation of 802.11a/b/g
    adapters from Ralink. It consists of two integrated chips, an RT2571W
    MAC/BBP and an RT2528 or RT5226 radio transceiver.</p>
<p class="Pp">The RT2601USB chipset consists of two integrated chips, an RT2671
    MAC/BBP and an RT2527 or RT5225 radio transceiver. This chipset uses the
    IEEE 802.11n MIMO (multiple-input multiple-output) technology with multiple
    antennas to extend the operating range of the adapter and to achieve higher
    throughput.</p>
<p class="Pp">These are the modes the <code class="Nm">rum</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 id="IEEE">IBSS mode</dt>
  <dd>Also known as <a class="permalink" href="#IEEE"><i class="Em">IEEE
      ad-hoc</i></a> mode or
      <a class="permalink" href="#peer-to-peer"><i class="Em" id="peer-to-peer">peer-to-peer</i></a>
      mode. This is the standardized method of operating without an access
      point. Stations associate with a service set. However, actual connections
      between stations are peer-to-peer.</dd>
  <dt>Host AP</dt>
  <dd>In this mode the driver acts as an access point (base station) for other
      cards.</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">rum</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>
</section>
<section class="Sh">
<h1 class="Sh" id="CONFIGURATION"><a class="permalink" href="#CONFIGURATION">CONFIGURATION</a></h1>
<p class="Pp">The <code class="Nm">rum</code> driver can be configured at
    runtime with <a class="Xr">ifconfig(8)</a> or on boot with
    <a class="Xr">ifconfig.if(5)</a> using the following parameters:</p>
<dl class="Bl-tag">
  <dt id="bssid"><a class="permalink" href="#bssid"><code class="Cm">bssid</code></a>
    <var class="Ar">bssid</var></dt>
  <dd>Set the desired BSSID.</dd>
  <dt id="bssid~2"><a class="permalink" href="#bssid~2"><code class="Fl">-bssid</code></a></dt>
  <dd>Unset the desired BSSID. The interface will automatically select a BSSID
      in this mode, which is the default.</dd>
  <dt id="chan"><a class="permalink" href="#chan"><code class="Cm">chan</code></a>
    <var class="Ar">n</var></dt>
  <dd>Set the channel (radio frequency) to be used by the driver based on the
      given channel ID <var class="Ar">n</var>.</dd>
  <dt id="chan~2"><a class="permalink" href="#chan~2"><code class="Fl">-chan</code></a></dt>
  <dd>Unset the desired channel to be used by the driver. The driver will
      automatically select a channel in this mode, which is the default.</dd>
  <dt id="media"><a class="permalink" href="#media"><code class="Cm">media</code></a>
    <var class="Ar">media</var></dt>
  <dd>The <code class="Nm">rum</code> driver supports the following
      <var class="Ar">media</var> types:
    <p class="Pp"></p>
    <dl class="Bl-tag Bl-compact">
      <dt id="autoselect"><a class="permalink" href="#autoselect"><code class="Cm">autoselect</code></a></dt>
      <dd>Enable autoselection of the media type and options.</dd>
      <dt id="DS1"><a class="permalink" href="#DS1"><code class="Cm">DS1</code></a></dt>
      <dd>Set 802.11b DS 1Mbps operation.</dd>
      <dt id="DS2"><a class="permalink" href="#DS2"><code class="Cm">DS2</code></a></dt>
      <dd>Set 802.11b DS 2Mbps operation.</dd>
      <dt id="DS5"><a class="permalink" href="#DS5"><code class="Cm">DS5</code></a></dt>
      <dd>Set 802.11b DS 5.5Mbps operation.</dd>
      <dt id="DS11"><a class="permalink" href="#DS11"><code class="Cm">DS11</code></a></dt>
      <dd>Set 802.11b DS 11Mbps operation.</dd>
      <dt id="OFDM6"><a class="permalink" href="#OFDM6"><code class="Cm">OFDM6</code></a></dt>
      <dd>Set 802.11a/g OFDM 6Mbps operation.</dd>
      <dt id="OFDM9"><a class="permalink" href="#OFDM9"><code class="Cm">OFDM9</code></a></dt>
      <dd>Set 802.11a/g OFDM 9Mbps operation.</dd>
      <dt id="OFDM12"><a class="permalink" href="#OFDM12"><code class="Cm">OFDM12</code></a></dt>
      <dd>Set 802.11a/g OFDM 12Mbps operation.</dd>
      <dt id="OFDM18"><a class="permalink" href="#OFDM18"><code class="Cm">OFDM18</code></a></dt>
      <dd>Set 802.11a/g OFDM 18Mbps operation.</dd>
      <dt id="OFDM24"><a class="permalink" href="#OFDM24"><code class="Cm">OFDM24</code></a></dt>
      <dd>Set 802.11a/g OFDM 24Mbps operation.</dd>
      <dt id="OFDM36"><a class="permalink" href="#OFDM36"><code class="Cm">OFDM36</code></a></dt>
      <dd>Set 802.11a/g OFDM 36Mbps operation.</dd>
      <dt id="OFDM48"><a class="permalink" href="#OFDM48"><code class="Cm">OFDM48</code></a></dt>
      <dd>Set 802.11a/g OFDM 48Mbps operation.</dd>
      <dt id="OFDM54"><a class="permalink" href="#OFDM54"><code class="Cm">OFDM54</code></a></dt>
      <dd>Set 802.11a/g OFDM 54Mbps operation.</dd>
    </dl>
  </dd>
  <dt id="mediaopt"><a class="permalink" href="#mediaopt"><code class="Cm">mediaopt</code></a>
    <var class="Ar">opts</var></dt>
  <dd>The <code class="Nm">rum</code> driver supports the following media
      options:
    <p class="Pp"></p>
    <dl class="Bl-tag Bl-compact">
      <dt id="hostap"><a class="permalink" href="#hostap"><code class="Cm">hostap</code></a></dt>
      <dd>Select Host AP operation.</dd>
      <dt id="ibss"><a class="permalink" href="#ibss"><code class="Cm">ibss</code></a></dt>
      <dd>Select IBSS operation.</dd>
      <dt id="monitor"><a class="permalink" href="#monitor"><code class="Cm">monitor</code></a></dt>
      <dd>Select monitor mode.</dd>
    </dl>
  </dd>
  <dt id="mediaopt~2"><a class="permalink" href="#mediaopt~2"><code class="Fl">-mediaopt</code></a>
    <var class="Ar">opts</var></dt>
  <dd>Disable the specified media options on the driver and return it to the
      default mode of operation (BSS).</dd>
  <dt id="mode"><a class="permalink" href="#mode"><code class="Cm">mode</code></a>
    <var class="Ar">mode</var></dt>
  <dd>The <code class="Nm">rum</code> driver supports the following modes:
    <p class="Pp"></p>
    <dl class="Bl-tag Bl-compact">
      <dt id="11a"><a class="permalink" href="#11a"><code class="Cm">11a</code></a></dt>
      <dd>Force 802.11a operation.</dd>
      <dt id="11b"><a class="permalink" href="#11b"><code class="Cm">11b</code></a></dt>
      <dd>Force 802.11b operation.</dd>
      <dt id="11g"><a class="permalink" href="#11g"><code class="Cm">11g</code></a></dt>
      <dd>Force 802.11g operation.</dd>
    </dl>
  </dd>
  <dt id="nwid"><a class="permalink" href="#nwid"><code class="Cm">nwid</code></a>
    <var class="Ar">id</var></dt>
  <dd>Set the network ID. The <var class="Ar">id</var> can either be any text
      string up to 32 characters in length, or a series of hexadecimal digits up
      to 64 digits. An empty <var class="Ar">id</var> string allows the
      interface to connect to any available access points. By default the
      <code class="Nm">rum</code> driver uses an empty string. Note that network
      ID is synonymous with Extended Service Set ID (ESSID).</dd>
  <dt id="nwkey"><a class="permalink" href="#nwkey"><code class="Cm">nwkey</code></a>
    <var class="Ar">key</var></dt>
  <dd>Enable WEP encryption using the specified <var class="Ar">key</var>. The
      <var class="Ar">key</var> can either be a string, a series of hexadecimal
      digits (preceded by &#x2018;0x&#x2019;), or a set of keys of the form
      &#x201C;n:k1,k2,k3,k4&#x201D;, where &#x2018;n&#x2019; specifies which of
      the keys will be used for transmitted packets, and the four keys,
      &#x201C;k1&#x201D; through &#x201C;k4&#x201D;, are configured as WEP keys.
      If a set of keys is specified, a comma (&#x2018;,&#x2019;) within the key
      must be escaped with a backslash. Note that if multiple keys are used,
      their order must be the same within the network.
      <code class="Nm">rum</code> is capable of using both 40-bit (5 characters
      or 10 hexadecimal digits) or 104-bit (13 characters or 26 hexadecimal
      digits) keys.</dd>
  <dt id="nwkey~2"><a class="permalink" href="#nwkey~2"><code class="Fl">-nwkey</code></a></dt>
  <dd>Disable WEP encryption. This is the default mode of operation.</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="FILES"><a class="permalink" href="#FILES">FILES</a></h1>
<p class="Pp">The following firmware file is loaded when an interface is brought
    up:</p>
<p class="Pp"></p>
<div class="Bd-indent">
<dl class="Bl-tag Bl-compact">
  <dt>/libdata/firmware/rum/rum-rt2573</dt>
  <dd style="width: auto;">&#x00A0;</dd>
</dl>
</div>
See <a class="Xr">firmload(9)</a> for how to change this.
</section>
<section class="Sh">
<h1 class="Sh" id="HARDWARE"><a class="permalink" href="#HARDWARE">HARDWARE</a></h1>
<p class="Pp">The following adapters should work:</p>
<p class="Pp"></p>
<div class="Bd-indent">
<dl class="Bl-tag Bl-compact">
  <dt>Airlink101 AWLL5025</dt>
  <dd style="width: auto;">&#x00A0;</dd>
  <dt>ASUS WL-167g ver 2</dt>
  <dd style="width: auto;">&#x00A0;</dd>
  <dt>Belkin F5D7050 ver 3</dt>
  <dd style="width: auto;">&#x00A0;</dd>
  <dt>Belkin F5D9050 ver 3</dt>
  <dd style="width: auto;">&#x00A0;</dd>
  <dt>CNet CWD-854 ver F</dt>
  <dd style="width: auto;">&#x00A0;</dd>
  <dt>Conceptronic C54RU ver 2</dt>
  <dd style="width: auto;">&#x00A0;</dd>
  <dt>D-Link DWL-G122 rev C1</dt>
  <dd style="width: auto;">&#x00A0;</dd>
  <dt>D-Link WUA-1340</dt>
  <dd style="width: auto;">&#x00A0;</dd>
  <dt>Edimax EW-7318USG</dt>
  <dd style="width: auto;">&#x00A0;</dd>
  <dt>Gigabyte GN-WB01GS</dt>
  <dd style="width: auto;">&#x00A0;</dd>
  <dt>Hawking HWUG1</dt>
  <dd style="width: auto;">&#x00A0;</dd>
  <dt>LevelOne WNC-0301USB</dt>
  <dd style="width: auto;">&#x00A0;</dd>
  <dt>Linksys WUSB54G rev C</dt>
  <dd style="width: auto;">&#x00A0;</dd>
  <dt>Planex GW-USMM</dt>
  <dd style="width: auto;">&#x00A0;</dd>
  <dt>Senao NUB-3701</dt>
  <dd style="width: auto;">&#x00A0;</dd>
  <dt>Sitecom WL-113 ver 2</dt>
  <dd style="width: auto;">&#x00A0;</dd>
  <dt>Sitecom WL-172</dt>
  <dd style="width: auto;">&#x00A0;</dd>
  <dt>Synet MW-P54SS</dt>
  <dd style="width: auto;">&#x00A0;</dd>
  <dt>TP-LINK TL-WN321G</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">The following <a class="Xr">ifconfig.if(5)</a> example configures
    rum0 to join whatever network is available on boot, using WEP key
    &#x201C;0x1deadbeef1&#x201D;, channel 11:</p>
<div class="Bd Pp Bd-indent Li">
<pre>inet 192.168.1.1 netmask 255.255.255.0 nwkey 0x1deadbeef1 chan 11</pre>
</div>
<p class="Pp">The following <a class="Xr">ifconfig.if(5)</a> example creates a
    host-based access point on boot:</p>
<div class="Bd Pp Bd-indent Li">
<pre>inet 192.168.1.1 netmask 255.255.255.0 media autoselect \
	mediaopt hostap nwid my_net chan 11</pre>
</div>
<p class="Pp">Configure rum0 for WEP, using hex key
    &#x201C;0x1deadbeef1&#x201D;:</p>
<div class="Bd Pp Bd-indent Li">
<pre># ifconfig rum0 nwkey 0x1deadbeef1</pre>
</div>
<p class="Pp">Return rum0 to its default settings:</p>
<div class="Bd Pp Bd-indent Li">
<pre># ifconfig rum0 -bssid -chan media autoselect \
	nwid &quot;&quot; -nwkey</pre>
</div>
<p class="Pp">Join an existing BSS network, &#x201C;my_net&#x201D;:</p>
<div class="Bd Pp Bd-indent Li">
<pre># ifconfig rum0 192.168.1.1 netmask 0xffffff00 nwid my_net</pre>
</div>
</section>
<section class="Sh">
<h1 class="Sh" id="DIAGNOSTICS"><a class="permalink" href="#DIAGNOSTICS">DIAGNOSTICS</a></h1>
<dl class="Bl-diag">
  <dt>rum%d: failed loadfirmware of file %s</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>rum%d: could not load 8051 microcode</dt>
  <dd>An error occurred while attempting to upload the microcode to the onboard
      8051 microcontroller unit.</dd>
  <dt>rum%d: 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">arp(4)</a>, <a class="Xr">ifmedia(4)</a>,
    <a class="Xr">netintro(4)</a>, <a class="Xr">usb(4)</a>,
    <a class="Xr">ifconfig.if(5)</a>, <a class="Xr">hostapd(8)</a>,
    <a class="Xr">ifconfig(8)</a>, <a class="Xr">firmload(9)</a></p>
<p class="Pp"><a class="Lk" href="http://www.ralinktech.com">Ralink
    Technology</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">rum</code> driver first appeared in
    <span class="Ux">NetBSD 4.0</span> and <span class="Ux">OpenBSD
  4.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">rum</code> driver was written by
    <span class="An">Niall O'Higgins</span>
    &lt;<a class="Mt" href="mailto:niallo@openbsd.org">niallo@openbsd.org</a>&gt;
    and
  <br/>
  <span class="An">Damien Bergamini</span>
    &lt;<a class="Mt" href="mailto:damien@openbsd.org">damien@openbsd.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">rum</code> driver supports automatic control
    of the transmit speed in BSS mode only. Therefore the use of a
    <code class="Nm">rum</code> adapter in Host AP mode is discouraged.</p>
<p class="Pp">The Synet MW-P54SS USB Wireless Broadband Router first attaches as
    a virtual <a class="Xr">cd(4)</a> device on the <a class="Xr">umass(4)</a>
    mass storage bus. It will re-attach with this driver after using
    <a class="Xr">eject(1)</a> on the corresponding device.</p>
</section>
</div>
<table class="foot">
  <tr>
    <td class="foot-date">September 21, 2020</td>
    <td class="foot-os">NetBSD 10.1</td>
  </tr>
</table>