5e7f667b8b142e112d1edbe194e218e08eb67d9b
[dragonfly.git] / share / man / man4 / ath.4
1 .\"-
2 .\" Copyright (c) 2002-2004 Sam Leffler, Errno Consulting
3 .\" All rights reserved.
4 .\""
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer,
10 .\"    without modification.
11 .\" 2. Redistributions in binary form must reproduce at minimum a disclaimer
12 .\"    similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
13 .\"    redistribution must be conditioned upon including a substantially
14 .\"    similar Disclaimer requirement for further binary redistribution.
15 .\" 3. Neither the names of the above-listed copyright holders nor the names
16 .\"    of any contributors may be used to endorse or promote products derived
17 .\"    from this software without specific prior written permission.
18 .\"
19 .\" NO WARRANTY
20 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 .\" LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
23 .\" AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
24 .\" THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
25 .\" OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
28 .\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
30 .\" THE POSSIBILITY OF SUCH DAMAGES.
31 .\"
32 .\" $FreeBSD: /repoman/r/ncvs/src/share/man/man4/ath.4,v 1.40 2006/05/12 17:58:11 keramida Exp $
33 .\" $DragonFly: src/share/man/man4/ath.4,v 1.7 2007/09/16 19:06:26 swildner Exp $
34 .\"
35 .Dd July 13, 2006
36 .Dt ATH 4
37 .Os
38 .Sh NAME
39 .Nm ath
40 .Nd "Atheros IEEE 802.11 wireless network driver"
41 .Sh SYNOPSIS
42 To load the driver as a
43 module at boot time, place the following line in
44 .Xr loader.conf 5 :
45 .Bd -literal -offset indent
46 if_ath_load="YES"
47 .Ed
48 .Sh DESCRIPTION
49 The
50 .Nm
51 driver provides support for wireless network adapters based on
52 the Atheros AR5210, AR5211, and AR5212 programming APIs.
53 These APIs are used by a wide variety of chips; all chips with
54 a PCI and/or CardBus interface are supported.
55 Chip-specific support is provided by the Atheros Hardware Access Layer
56 (HAL), that is packaged separately.
57 .Pp
58 Supported features include 802.11 and 802.3 frames, power management, BSS,
59 IBSS, and host-based access point operation modes.
60 All host/device interaction is via DMA.
61 .Pp
62 The
63 .Nm
64 driver encapsulates all IP and ARP traffic as 802.11 frames, however
65 it can receive either 802.11 or 802.3 frames.
66 Transmit speed and operating mode is selectable
67 and depends on the specific chipset.
68 AR5210-based devices support 802.11a operation with transmit speeds
69 of 6 Mbps, 9 Mbps, 12 Mbps, 18 Mbps, 24 Mbps, 36 Mbps, 48 Mbps, and 54 Mbps.
70 AR5211-based devices support 802.11a and 802.11b operation with transmit
71 speeds as above for 802.11a operation and
72 1Mbps, 2Mbps, 5.5 Mbps and 11Mbps for 802.11b operation.
73 AR5212-based devices support 802.11a, 802.11b, and 802.11g operation
74 with transmit speeds appropriate to each.
75 Most chips also support an Atheros Turbo Mode (TM) that operates in
76 the 5Ghz frequency range with 2x the transmit speeds.
77 Some chips also support Turbo mode in the 2.4Ghz range with 802.11g
78 though this support is not presently available due to regulatory requirements.
79 (Note that Turbo modes are, however,
80 only interoperable with other Atheros-based devices.)
81 The actual transmit speed used is dependent on signal quality and the
82 .Dq "rate control"
83 algorithm employed by the driver.
84 All chips support WEP encryption.
85 The AR5212 has hardware support for the AES-CCM, TKIP, and Michael cryptographic
86 operations required for WPA.
87 To enable encryption, use
88 .Xr ifconfig 8
89 as shown below.
90 .Pp
91 By default, the
92 .Nm
93 driver configures the card for BSS operation (aka infrastructure
94 mode).
95 This mode requires the use of an access point (base station).
96 .Pp
97 The
98 .Nm
99 driver also supports the standard IBSS point-to-point mode
100 where stations can communicate amongst themselves without the
101 aid of an access point.
102 .Pp
103 The driver may also be configured to operate in hostap mode.
104 In this mode a host may function as an access point (base station).
105 Access points are different than operating in IBSS mode.
106 They operate in BSS mode.
107 They allow for easier roaming and bridge all Ethernet traffic such
108 that machines connected via an access point appear to be on the local
109 Ethernet segment.
110 .Pp
111 For more information on configuring this device, see
112 .Xr ifconfig 8 .
113 .Pp
114 Devices supported by the
115 .Nm
116 driver come in either Cardbus or mini-PCI packages.
117 Wireless cards in Cardbus slots may be inserted and ejected on the fly.
118 .Sh HARDWARE
119 The
120 .Nm
121 driver supports all Atheros Cardbus or PCI cards,
122 except those that are based on the AR5005VL chipset.
123 .Pp
124 A list of cards that are supported can be found at
125 .Pp
126 .Pa http://customerproducts.atheros.com/customerproducts .
127 .Sh EXAMPLES
128 Join an existing BSS network (ie: connect to an access point):
129 .Pp
130 .Dl "ifconfig ath0 inet 192.168.0.20 netmask 0xffffff00"
131 .Pp
132 Join a specific BSS network with network name
133 .Dq Li my_net :
134 .Pp
135 .Dl "ifconfig ath0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net"
136 .Pp
137 Join a specific BSS network with WEP encryption:
138 .Bd -literal -offset indent
139 ifconfig ath0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
140         wepmode on wepkey 0x8736639624
141 .Ed
142 .Pp
143 Join/create an 802.11b IBSS network with network name
144 .Dq Li my_net :
145 .Bd -literal -offset indent
146 ifconfig ath0 inet 192.168.0.22 netmask 0xffffff00 ssid my_net \e
147         mode 11b mediaopt adhoc
148 .Ed
149 .\".Pp
150 .\"Create an 802.11g host-based access point:
151 .\".Bd -literal -offset indent
152 .\"ifconfig ath0 inet 192.168.0.10 netmask 0xffffff00 ssid my_ap \e
153 .\"     mode 11g mediaopt hostap
154 .\".Ed
155 .\".Pp
156 .\"Create an 802.11a host-based access point with WEP enabled:
157 .\".Bd -literal -offset indent
158 .\"ifconfig ath0 inet 192.168.0.10 netmask 0xffffff00 ssid my_ap \e
159 .\"     wepmode on wepkey 0x1234567890 mode 11a mediaopt hostap
160 .\".Ed
161 .\".Pp
162 .\"Create a host-based wireless bridge to fxp0:
163 .\".Bd -literal -offset indent
164 .\"ifconfig ath0 inet up ssid my_ap media DS/11Mbps mediaopt hostap
165 .\"sysctl net.inet.ip.check_interface=0
166 .\"ifconfig bridge0 create
167 .\"ifconfig bridge0 addm ath0 addm fxp0 up
168 .\".Ed
169 .\".Pp
170 .\"This will give you the same functionality as an access point.
171 .Sh DIAGNOSTICS
172 .Bl -diag
173 .It "ath%d: unable to attach hardware; HAL status %u"
174 The Atheros Hardware Access Layer was unable to configure the hardware
175 as requested.
176 The status code is explained in the HAL include file
177 .Pa sys/contrib/dev/ath/ah.h .
178 .It "ath%d: failed to allocate descriptors: %d"
179 The driver was unable to allocate contiguous memory for the transmit
180 and receive descriptors.
181 This usually indicates system memory is scarce and/or fragmented.
182 .It "ath%d: unable to setup a data xmit queue!"
183 The request to the HAL to set up the transmit queue for normal
184 data frames failed.
185 This should not happen.
186 .It "ath%d: unable to setup a beacon xmit queue!"
187 The request to the HAL to set up the transmit queue for 802.11 beacon frames
188 frames failed.
189 This should not happen.
190 .It "ath%d: 802.11 address: %s"
191 The MAC address programmed in the EEPROM is displayed.
192 .It "ath%d: hardware error; resetting"
193 An unrecoverable error in the hardware occurred.
194 Errors of this sort include unrecoverable DMA errors.
195 The driver will reset the hardware and continue.
196 .It "ath%d: rx FIFO overrun; resetting"
197 The receive FIFO in the hardware overflowed before the data could be
198 transferred to the host.
199 This typically occurs because the hardware ran short of receive
200 descriptors and had no place to transfer received data.
201 The driver will reset the hardware and continue.
202 .It "ath%d: unable to reset hardware; hal status %u"
203 The Atheros Hardware Access Layer was unable to reset the hardware
204 as requested.
205 The status code is explained in the HAL include file
206 .Pa sys/contrib/dev/ath/ah.h .
207 This should not happen.
208 .It "ath%d: unable to start recv logic"
209 The driver was unable to restart frame reception.
210 This should not happen.
211 .It "ath%d: device timeout"
212 A frame dispatched to the hardware for transmission did not complete in time.
213 The driver will reset the hardware and continue.
214 This should not happen.
215 .It "ath%d: bogus xmit rate 0x%x"
216 An invalid transmit rate was specified for an outgoing frame.
217 The frame is discarded.
218 This should not happen.
219 .It "ath%d: ath_chan_set: unable to reset channel %u (%u Mhz)"
220 The Atheros Hardware Access Layer was unable to reset the hardware
221 when switching channels during scanning.
222 This should not happen.
223 .It "ath%d: unable to allocate channel table"
224 The driver was unable to allocate memory for the table used to hold
225 the set of available channels.
226 .It "ath%d: unable to collect channel list from hal"
227 A problem occurred while querying the HAL to find the set of available
228 channels for the device.
229 This should not happen.
230 .It "ath%d: failed to enable memory mapping"
231 The driver was unable to enable memory-mapped I/O to the PCI device registers.
232 This should not happen.
233 .It "ath%d: failed to enable bus mastering"
234 The driver was unable to enable the device as a PCI bus master for doing DMA.
235 This should not happen.
236 .It "ath%d: cannot map register space"
237 The driver was unable to map the device registers into the host address space.
238 This should not happen.
239 .It "ath%d: could not map interrupt"
240 The driver was unable to allocate an IRQ for the device interrupt.
241 This should not happen.
242 .It "ath%d: could not establish interrupt"
243 The driver was unable to install the device interrupt handler.
244 This should not happen.
245 .El
246 .Sh SEE ALSO
247 .Xr an 4 ,
248 .Xr arp 4 ,
249 .Xr ath_hal 4 ,
250 .Xr ifmedia 4 ,
251 .Xr netintro 4 ,
252 .Xr wi 4 ,
253 .Xr wlan 4 ,
254 .Xr hostapd 8 ,
255 .Xr ifconfig 8 ,
256 .Xr wicontrol 8 ,
257 .Xr wpa_supplicant 8
258 .Sh HISTORY
259 The
260 .Nm
261 device driver first appeared in
262 .Fx 5.2
263 and was imported into
264 .Dx 1.5 .
265 .Sh CAVEATS
266 Different regulatory domains have different default channels for adhoc
267 mode.
268 See
269 .Xr ifconfig 8
270 for information on how to change the channel.
271 See
272 .Xr wicontrol 8
273 for information on different regulatory domains.
274 Different regulatory domains may not be able to communicate with each
275 other with 802.11a as different regulatory domains do not necessarily
276 have overlapping channels.
277 .Pp
278 Revision A1 of the D-LINK DWL-G520 and DWL-G650 are based on an
279 Intersil PrismGT chip and are not supported by this driver.
280 .Pp
281 Revision v3 of the Netgear WG311 is based on a Marvell Libertas
282 88W8335 and is not supported by this driver.
283 .Sh BUGS
284 There is no software retransmit; only hardware retransmit is used.
285 .Pp
286 The driver does not fully enable power-save operation of the chip;
287 consequently power use is suboptimal.
288 .Pp
289 The driver honors the regulatory domain programmed into the EEPROM of a
290 device and does not support overriding this setting.
291 This is done to insure compliance with local regulatory agencies when
292 operating as an access point.
293 Unfortunately this also means that devices purchased for use in one locale
294 may not be usable in another.
295 Changes are planned to remove this restriction when operating in station mode.
296 .Pp
297 WPA is not supported for 5210 parts.
298 .Pp
299 Atheros' SuperG functionality is not supported.