summaryrefslogtreecommitdiff
path: root/static/netbsd/man4/athn.4 3.html
blob: 7fcf2c15ded87aab54abfb2a613a47caa3429919 (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
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
<table class="head">
  <tr>
    <td class="head-ltitle">ATHN(4)</td>
    <td class="head-vol">Device Drivers Manual</td>
    <td class="head-rtitle">ATHN(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">athn</code> &#x2014; <span class="Nd">Atheros
    IEEE 802.11a/g/n 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">athn* at cardbus?</code>
  <br/>
  <code class="Cd">athn* at pci?</code>
  <br/>
  <code class="Cd">athn* 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">athn</code> driver provides support for a
    wide variety of Atheros 802.11n devices, ranging from the AR5008 up to the
    AR9287.</p>
<p class="Pp">The AR5008 (codenamed Owl) is the first generation of Atheros
    802.11n solutions. It consists of two chips, a MAC/Baseband Processor and a
    Radio-on-a-Chip. The MAC/Baseband Processor can be an AR5416 (PCI and
    CardBus form factors) or an AR5418 (PCIe Mini Card form factor). The radio
    can be an AR2122, AR2133, AR5122 or an AR5133 chip. The AR2122 chip operates
    in the 2GHz spectrum and supports up to 2 transmit paths and 2 receiver
    paths (2T2R). The AR2133 chip operates in the 2GHz spectrum and supports up
    to 3 transmit paths and 3 receiver paths (3T3R). The AR5122 chip operates in
    the 2GHz and 5GHz spectra and supports up to 2 transmit paths and 2 receiver
    paths (2T2R). The AR5133 chip operates in the 2GHz and 5GHz spectra and
    supports up to 3 transmit paths and 3 receiver paths (3T3R).</p>
<p class="Pp">The AR9001 (codenamed Sowl) is a Mini-PCI 802.11n solution. It
    consists of two chips, an AR9160 MAC/Baseband Processor and an AR9103 or
    AR9106 Radio-on-a-Chip. The AR9103 chip operates in the 2GHz spectrum and
    supports up to 3 transmit paths and 3 receiver paths (3T3R). The AR9106 chip
    operates in the 2GHz and 5GHz spectra and supports up to 3 transmit paths
    and 3 receiver paths (3T3R).</p>
<p class="Pp">The AR9220, AR9223 and AR9280 (codenamed Merlin) are the first
    generation of Atheros single-chip 802.11n solutions. The AR9220 and AR9223
    exist in PCI and Mini-PCI form factors. The AR9280 exists in PCIe Mini Card
    (XB92), half Mini Card (HB92) and USB 2.0 (AR9280+AR7010) form factors. The
    AR9220 and AR9280 operate in the 2GHz and 5GHz spectra and support 2
    transmit paths and 2 receiver paths (2T2R). The AR9223 operates in the 2GHz
    spectrum and supports 2 transmit paths and 2 receiver paths (2T2R).</p>
<p class="Pp">The AR9281 is a single-chip PCIe 802.11n solution. It exists in
    PCIe Mini Card (XB91) and half Mini Card (HB91) form factors. It operates in
    the 2GHz spectrum and supports 1 transmit path and 2 receiver paths
  (1T2R).</p>
<p class="Pp">The AR9285 (codenamed Kite) is a single-chip PCIe 802.11n solution
    that targets the value PC market. It exists in PCIe half Mini Card (HB95)
    form factor only. It operates in the 2GHz spectrum and supports a single
    stream (1T1R). It can be combined with the AR3011 chip to form a combo
    WiFi/Bluetooth device (WB195).</p>
<p class="Pp">The AR9271 is a single-chip USB 2.0 802.11n solution. It operates
    in the 2GHz spectrum and supports a single stream (1T1R).</p>
<p class="Pp">The AR2427 is a single-chip PCIe 802.11b/g solution similar to the
    other AR9280 solutions but with 802.11n capabilities removed. It exists in
    PCIe Mini Card form factor only. It operates in the 2GHz spectrum.</p>
<p class="Pp">The AR9227 and AR9287 are single-chip 802.11n solutions that
    target mid-tier PCs. The AR9227 exists in PCI and Mini-PCI form factors. The
    AR9287 exists in PCIe half Mini Card (HB97) and USB 2.0 (AR9287+AR7010) form
    factors. They operate in the 2GHz spectrum and support 2 transmit paths and
    2 receiver paths (2T2R).</p>
<p class="Pp">The following table summarizes the supported chips and their
    capabilities.</p>
<table class="Bl-column Bd-indent">
  <tr id="Chipset">
    <td><a class="permalink" href="#Chipset"><i class="Em">Chipset</i></a></td>
    <td><a class="permalink" href="#Spectrum"><i class="Em" id="Spectrum">Spectrum</i></a></td>
    <td><a class="permalink" href="#TxR:S"><i class="Em" id="TxR:S">TxR:S</i></a></td>
    <td><a class="permalink" href="#Bus"><i class="Em" id="Bus">Bus</i></a></td>
  </tr>
  <tr>
    <td>AR5008-2NG (AR5416+AR2122)</td>
    <td>2GHz</td>
    <td>2x2:2</td>
    <td>PCI/CardBus</td>
  </tr>
  <tr>
    <td>AR5008-3NG (AR5416+AR2133)</td>
    <td>2GHz</td>
    <td>3x3:2</td>
    <td>PCI/CardBus</td>
  </tr>
  <tr>
    <td>AR5008-2NX (AR5416+AR5122)</td>
    <td>2GHz/5GHz</td>
    <td>2x2:2</td>
    <td>PCI/CardBus</td>
  </tr>
  <tr>
    <td>AR5008-3NX (AR5416+AR5133)</td>
    <td>2GHz/5GHz</td>
    <td>3x3:2</td>
    <td>PCI/CardBus</td>
  </tr>
  <tr>
    <td>AR5008E-2NG (AR5418+AR2122)</td>
    <td>2GHz</td>
    <td>2x2:2</td>
    <td>PCIe</td>
  </tr>
  <tr>
    <td>AR5008E-3NG (AR5418+AR2133)</td>
    <td>2GHz</td>
    <td>3x3:2</td>
    <td>PCIe</td>
  </tr>
  <tr>
    <td>AR5008E-2NX (AR5418+AR5122)</td>
    <td>2GHz/5GHz</td>
    <td>2x2:2</td>
    <td>PCIe</td>
  </tr>
  <tr>
    <td>AR5008E-3NX (AR5418+AR5133)</td>
    <td>2GHz/5GHz</td>
    <td>3x3:2</td>
    <td>PCIe</td>
  </tr>
  <tr>
    <td>AR9001-2NG (AR9160+AR9103)</td>
    <td>2GHz</td>
    <td>2x2:2</td>
    <td>PCI</td>
  </tr>
  <tr>
    <td>AR9001-3NG (AR9160+AR9103)</td>
    <td>2GHz</td>
    <td>3x3:2</td>
    <td>PCI</td>
  </tr>
  <tr>
    <td>AR9001-3NX2 (AR9160+AR9106)</td>
    <td>2GHz/5GHz</td>
    <td>3x3:2</td>
    <td>PCI</td>
  </tr>
  <tr>
    <td>AR9220</td>
    <td>2GHz/5GHz</td>
    <td>2x2:2</td>
    <td>PCI</td>
  </tr>
  <tr>
    <td>AR9223</td>
    <td>2GHz</td>
    <td>2x2:2</td>
    <td>PCI</td>
  </tr>
  <tr>
    <td>AR9280</td>
    <td>2GHz/5GHz</td>
    <td>2x2:2</td>
    <td>PCIe</td>
  </tr>
  <tr>
    <td>AR9280+AR7010</td>
    <td>2GHz/5GHz</td>
    <td>2x2:2</td>
    <td>USB 2.0</td>
  </tr>
  <tr>
    <td>AR9281</td>
    <td>2GHz</td>
    <td>1x2:2</td>
    <td>PCIe</td>
  </tr>
  <tr>
    <td>AR9285</td>
    <td>2GHz</td>
    <td>1x1:1</td>
    <td>PCIe</td>
  </tr>
  <tr>
    <td>AR9271</td>
    <td>2GHz</td>
    <td>1x1:1</td>
    <td>USB 2.0</td>
  </tr>
  <tr>
    <td>AR2427</td>
    <td>2GHz</td>
    <td>1x1:1</td>
    <td>PCIe</td>
  </tr>
  <tr>
    <td>AR9227</td>
    <td>2GHz</td>
    <td>2x2:2</td>
    <td>PCI</td>
  </tr>
  <tr>
    <td>AR9287</td>
    <td>2GHz</td>
    <td>2x2:2</td>
    <td>PCIe</td>
  </tr>
  <tr>
    <td>AR9287+AR7010</td>
    <td>2GHz</td>
    <td>2x2:2</td>
    <td>USB 2.0</td>
  </tr>
</table>
<p class="Pp">These are the modes the <code class="Nm">athn</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>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">athn</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. The
    <code class="Nm">athn</code> driver relies on the software 802.11 stack for
    both encryption and decryption of data frames.</p>
<p class="Pp">The transmit speed is user-selectable or can be adapted
    automatically by the driver depending on the number of hardware transmission
    retries.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="FILES"><a class="permalink" href="#FILES">FILES</a></h1>
<p class="Pp">For USB devices, the driver needs at least version 1.1 of the
    following firmware files, which are loaded when an interface is
  attached:</p>
<p class="Pp"></p>
<div class="Bd-indent">
<dl class="Bl-tag Bl-compact">
  <dt>/libdata/firmware/athn-ar7010</dt>
  <dd style="width: auto;">&#x00A0;</dd>
  <dt>/libdata/firmware/athn-ar7010-11</dt>
  <dd style="width: auto;">&#x00A0;</dd>
  <dt>/libdata/firmware/athn-ar9271</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
    athn0 to join whatever network is available on boot, using WEP key
    &#x201C;0x1deadbeef1&#x201D;, channel 11, obtaining an IP address using
    DHCP:</p>
<div class="Bd Pp Bd-indent Li">
<pre>dhcp NONE NONE NONE 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 255.255.255.0 NONE media autoselect \
	mediaopt hostap nwid my_net chan 11</pre>
</div>
<p class="Pp">Join an existing BSS network, &#x201C;my_net&#x201D;:</p>
<div class="Bd Pp Bd-indent Li">
<pre># ifconfig athn0 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>athn%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>
  <dt>athn%d: radio is disabled by hardware switch</dt>
  <dd>The radio transmitter is off and thus no packet can go out. The driver
      will reset the hardware. Make sure the laptop radio switch is on.</dd>
  <dt>athn%d: radio switch turned off</dt>
  <dd>The radio switch has been turned off while the interface was up and
      running. The driver will turn the interface down.</dd>
  <dt>athn%d: error %d, could not read firmware %s</dt>
  <dd>For some reason, the driver was unable to read the firmware file from the
      filesystem. The file might be missing or corrupted.</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">cardbus(4)</a>,
    <a class="Xr">ifmedia(4)</a>, <a class="Xr">intro(4)</a>,
    <a class="Xr">netintro(4)</a>, <a class="Xr">pci(4)</a>,
    <a class="Xr">usb(4)</a>, <a class="Xr">ifconfig.if(5)</a>,
    <a class="Xr">ifconfig(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">athn</code> driver first appeared in
    <span class="Ux">OpenBSD 4.7</span>. Support for USB 2.0 devices first
    appeared in <span class="Ux">OpenBSD 4.9</span>. It was later ported to
    <span class="Ux">NetBSD 7.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">athn</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;
    based on source code licensed under the ISC released in 2008 by Atheros
    Communications for Linux.</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">athn</code> driver does not support any of
    the 802.11n capabilities offered by the adapters. Additional work is
    required in <a class="Xr">ieee80211(9)</a> before those features can be
    supported.</p>
</section>
</div>
<table class="foot">
  <tr>
    <td class="foot-date">July 31, 2013</td>
    <td class="foot-os">NetBSD 10.1</td>
  </tr>
</table>