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.10 2008/07/26 16:25:40 swildner Exp $
  34 .\"
  35 .Dd July 26, 2008
  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 Refer to the
 129 .Sx EXAMPLES
 130 section of
 131 .Xr wlan 4 .
 132 .Sh DIAGNOSTICS
 133 .Bl -diag
 134 .It "ath%d: unable to attach hardware; HAL status %u"
 135 The Atheros Hardware Access Layer was unable to configure the hardware
 136 as requested.
 137 The status code is explained in the HAL include file
 138 .Pa sys/contrib/dev/ath/ah.h .
 139 .It "ath%d: failed to allocate descriptors: %d"
 140 The driver was unable to allocate contiguous memory for the transmit
 141 and receive descriptors.
 142 This usually indicates system memory is scarce and/or fragmented.
 143 .It "ath%d: unable to setup a data xmit queue!"
 144 The request to the HAL to set up the transmit queue for normal
 145 data frames failed.
 146 This should not happen.
 147 .It "ath%d: unable to setup a beacon xmit queue!"
 148 The request to the HAL to set up the transmit queue for 802.11 beacon frames
 149 frames failed.
 150 This should not happen.
 151 .It "ath%d: 802.11 address: %s"
 152 The MAC address programmed in the EEPROM is displayed.
 153 .It "ath%d: hardware error; resetting"
 154 An unrecoverable error in the hardware occurred.
 155 Errors of this sort include unrecoverable DMA errors.
 156 The driver will reset the hardware and continue.
 157 .It "ath%d: rx FIFO overrun; resetting"
 158 The receive FIFO in the hardware overflowed before the data could be
 159 transferred to the host.
 160 This typically occurs because the hardware ran short of receive
 161 descriptors and had no place to transfer received data.
 162 The driver will reset the hardware and continue.
 163 .It "ath%d: unable to reset hardware; hal status %u"
 164 The Atheros Hardware Access Layer was unable to reset the hardware
 165 as requested.
 166 The status code is explained in the HAL include file
 167 .Pa sys/contrib/dev/ath/ah.h .
 168 This should not happen.
 169 .It "ath%d: unable to start recv logic"
 170 The driver was unable to restart frame reception.
 171 This should not happen.
 172 .It "ath%d: device timeout"
 173 A frame dispatched to the hardware for transmission did not complete in time.
 174 The driver will reset the hardware and continue.
 175 This should not happen.
 176 .It "ath%d: bogus xmit rate 0x%x"
 177 An invalid transmit rate was specified for an outgoing frame.
 178 The frame is discarded.
 179 This should not happen.
 180 .It "ath%d: ath_chan_set: unable to reset channel %u (%u Mhz)"
 181 The Atheros Hardware Access Layer was unable to reset the hardware
 182 when switching channels during scanning.
 183 This should not happen.
 184 .It "ath%d: unable to allocate channel table"
 185 The driver was unable to allocate memory for the table used to hold
 186 the set of available channels.
 187 .It "ath%d: unable to collect channel list from hal"
 188 A problem occurred while querying the HAL to find the set of available
 189 channels for the device.
 190 This should not happen.
 191 .It "ath%d: failed to enable memory mapping"
 192 The driver was unable to enable memory-mapped I/O to the PCI device registers.
 193 This should not happen.
 194 .It "ath%d: failed to enable bus mastering"
 195 The driver was unable to enable the device as a PCI bus master for doing DMA.
 196 This should not happen.
 197 .It "ath%d: cannot map register space"
 198 The driver was unable to map the device registers into the host address space.
 199 This should not happen.
 200 .It "ath%d: could not map interrupt"
 201 The driver was unable to allocate an IRQ for the device interrupt.
 202 This should not happen.
 203 .It "ath%d: could not establish interrupt"
 204 The driver was unable to install the device interrupt handler.
 205 This should not happen.
 206 .El
 207 .Sh SEE ALSO
 208 .Xr an 4 ,
 209 .Xr arp 4 ,
 210 .Xr ath_hal 4 ,
 211 .Xr ifmedia 4 ,
 212 .Xr netintro 4 ,
 213 .Xr wi 4 ,
 214 .Xr wlan 4 ,
 215 .Xr hostapd 8 ,
 216 .Xr ifconfig 8 ,
 217 .Xr wpa_supplicant 8
 218 .Sh HISTORY
 219 The
 220 .Nm
 221 device driver first appeared in
 222 .Fx 5.2
 223 and was imported into
 224 .Dx 1.5 .
 225 .Sh CAVEATS
 226 Different regulatory domains have different default channels for adhoc
 227 mode.
 228 See
 229 .Xr ifconfig 8
 230 for information on how to change the channel.
 231 Different regulatory domains may not be able to communicate with each
 232 other with 802.11a as different regulatory domains do not necessarily
 233 have overlapping channels.
 234 .Pp
 235 Revision A1 of the D-LINK DWL-G520 and DWL-G650 are based on an
 236 Intersil PrismGT chip and are not supported by this driver.
 237 .Pp
 238 Revision v3 of the Netgear WG311 is based on a Marvell Libertas
 239 88W8335 and is not supported by this driver.
 240 .Sh BUGS
 241 There is no software retransmit; only hardware retransmit is used.
 242 .Pp
 243 The driver does not fully enable power-save operation of the chip;
 244 consequently power use is suboptimal.
 245 .Pp
 246 The driver honors the regulatory domain programmed into the EEPROM of a
 247 device and does not support overriding this setting.
 248 This is done to insure compliance with local regulatory agencies when
 249 operating as an access point.
 250 Unfortunately this also means that devices purchased for use in one locale
 251 may not be usable in another.
 252 Changes are planned to remove this restriction when operating in station mode.
 253 .Pp
 254 WPA is not supported for 5210 parts.
 255 .Pp
 256 Atheros' SuperG functionality is not supported.