share/man/man4/ath.4

   1 .\"-
   2 .\" Copyright (c) 2002-2009 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 .\"
  16 .\" NO WARRANTY
  17 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19 .\" LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
  20 .\" AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
  21 .\" THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
  22 .\" OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  23 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  24 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  25 .\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  26 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  27 .\" THE POSSIBILITY OF SUCH DAMAGES.
  28 .\"
  29 .\" $FreeBSD$
  30 .\"/
  31 .Dd July 8, 2009
  32 .Dt ATH 4
  33 .Os
  34 .Sh NAME
  35 .Nm ath
  36 .Nd "Atheros IEEE 802.11 wireless network driver"
  37 .Sh SYNOPSIS
  38 To compile this driver into the kernel,
  39 place the following lines in your
  40 kernel configuration file:
  41 .Bd -ragged -offset indent
  42 .Cd "device ath"
  43 .Cd "device ath_hal"
  44 .Cd "options AH_SUPPORT_AR5416"
  45 .Cd "device ath_rate_sample"
  46 .Cd "device wlan"
  47 .Ed
  48 .Pp
  49 Alternatively, to load the driver as a
  50 module at boot time, place the following line in
  51 .Xr loader.conf 5 :
  52 .Bd -literal -offset indent
  53 if_ath_load="YES"
  54 .Ed
  55 .Sh DESCRIPTION
  56 The
  57 .Nm
  58 driver provides support for wireless network adapters based on
  59 the Atheros AR5210, AR5211, AR5212, and AR5416 programming APIs.
  60 These APIs are used by a wide variety of chips; most all chips with
  61 a PCI and/or CardBus interface are supported.
  62 .Pp
  63 Supported features include 802.11 and 802.3 frames, power management, BSS,
  64 IBSS, MBSS, TDMA, and host-based access point operation modes.
  65 All host/device interaction is via DMA.
  66 .Pp
  67 The
  68 .Nm
  69 driver encapsulates all IP and ARP traffic as 802.11 frames, however
  70 it can receive either 802.11 or 802.3 frames.
  71 Transmit speed and operating mode is selectable
  72 and depends on the specific chipset.
  73 AR5210-based devices support 802.11a operation with transmit speeds
  74 of 6 Mbps, 9 Mbps, 12 Mbps, 18 Mbps, 24 Mbps, 36 Mbps, 48 Mbps, and 54 Mbps.
  75 AR5211-based devices support 802.11a and 802.11b operation with transmit
  76 speeds as above for 802.11a operation and
  77 1Mbps, 2Mbps, 5.5 Mbps and 11Mbps for 802.11b operation.
  78 AR5212-based devices support 802.11a, 802.11b, and 802.11g operation
  79 with transmit speeds appropriate to each.
  80 AR5416-class devices are capable of 802.11n operation
  81 but are supported only in legacy modes (802.11a, 11b, 11g).
  82 Most chips also support an Atheros Turbo Mode (TM) that operates in
  83 the 5Ghz frequency range with 2x the transmit speeds.
  84 Some chips also support Turbo mode in the 2.4Ghz range with 802.11g
  85 though this support is not presently available due to regulatory requirements.
  86 (Note that Turbo modes are, however,
  87 only interoperable with other Atheros-based devices.)
  88 AR5212-based devices also support half- (10MHz) and quarter-width (5MHz) channels.
  89 The actual transmit speed used is dependent on signal quality and the
  90 .Dq "rate control"
  91 algorithm employed by the driver.
  92 All chips support WEP encryption.
  93 AR5212 and AR5416 parts have hardware support for the
  94 AES-CCM, TKIP, and Michael cryptographic
  95 operations required for WPA.
  96 To enable encryption, use
  97 .Xr ifconfig 8
  98 as shown below.
  99 .Pp
 100 The driver supports
 101 .Cm station ,
 102 .Cm adhoc ,
 103 .Cm adhoc-demo ,
 104 .Cm hostap ,
 105 .Cm mesh ,
 106 .Cm wds ,
 107 and
 108 .Cm monitor
 109 mode operation.
 110 Multiple
 111 .Cm hostap
 112 virtual interfaces may be configured for simultaneous
 113 use on cards that use a 5212 part.
 114 When multiple interfaces are configured each may have a separate
 115 mac address that is formed by setting the U/L bits in the mac
 116 address assigned to the underlying device.
 117 Any number of
 118 .Cm wds
 119 virtual interfaces may be configured together with
 120 .Cm hostap
 121 interfaces.
 122 Multiple
 123 .Cm station
 124 interfaces may be operated together with
 125 .Cm hostap
 126 interfaces to construct a wireless repeater device.
 127 The driver also support
 128 .Cm tdma
 129 operation when compiled with
 130 .Cd "options IEEE80211_SUPPORT_TDMA"
 131 (which also enables the required 802.11 support).
 132 For more information on configuring this device, see
 133 .Xr ifconfig 8 .
 134 .Pp
 135 Devices supported by the
 136 .Nm
 137 driver come in either Cardbus or mini-PCI packages.
 138 Wireless cards in Cardbus slots may be inserted and ejected on the fly.
 139 .Sh HARDWARE
 140 The
 141 .Nm
 142 driver supports all Atheros Cardbus and PCI cards,
 143 except those that are based on the AR5005VL chipset.
 144 .Pp
 145 A list of cards that are supported can be found at
 146 .Pa http://customerproducts.atheros.com/customerproducts/default.asp .
 147 .Sh EXAMPLES
 148 Join an existing BSS network (ie: connect to an access point):
 149 .Pp
 150 .Dl "ifconfig ath0 inet 192.168.0.20 netmask 0xffffff00"
 151 .Pp
 152 Join a specific BSS network with network name
 153 .Dq Li my_net :
 154 .Pp
 155 .Dl "ifconfig ath0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net"
 156 .Pp
 157 Join a specific BSS network with WEP encryption:
 158 .Bd -literal -offset indent
 159 ifconfig wlan0 create wlandev ath0
 160 ifconfig wlan0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
 161         wepmode on wepkey 0x8736639624
 162 .Ed
 163 .Pp
 164 Join/create an 802.11b IBSS network with network name
 165 .Dq Li my_net :
 166 .Bd -literal -offset indent
 167 ifconfig wlan0 create wlandev ath0 wlanmode adhoc
 168 ifconfig wlan0 inet 192.168.0.22 netmask 0xffffff00 ssid my_net \e
 169         mode 11b
 170 .Ed
 171 .Pp
 172 Create an 802.11g host-based access point:
 173 .Bd -literal -offset indent
 174 ifconfig wlan0 create wlandev ath0 wlanmode hostap
 175 ifconfig wlan0 inet 192.168.0.10 netmask 0xffffff00 ssid my_ap \e
 176         mode 11g
 177 .Ed
 178 .Pp
 179 Create an 802.11a mesh station:
 180 .Bd -literal -offset indent
 181 ifconfig wlan0 create wlandev ath0 wlanmode mesh
 182 ifconfig wlan0 meshid my_mesh mode 11a inet 192.168.0.10/24
 183 .Ed
 184 .Pp
 185 Create two virtual 802.11a host-based access points, one with
 186 with WEP enabled and one with no security, and bridge them to
 187 the fxp0 (wired) device:
 188 .Bd -literal -offset indent
 189 ifconfig wlan0 create wlandev ath0 wlanmode hostap \e
 190         ssid paying-customers wepmode on wepkey 0x1234567890 \e
 191         mode 11a up
 192 ifconfig wlan1 create wlandev ath0 wlanmode hostap bssid \e
 193         ssid freeloaders up
 194 ifconfig bridge0 create addm wlan0 addm wlan1 addm fxp0 up
 195 .Ed
 196 .Pp
 197 Create a master node in a two slot TDMA BSS configured to use
 198 2.5 millisecond slots.
 199 .Bd -literal -offset indent
 200 ifconfig wlan0 create wlandev ath0 wlanmode tdma \e
 201         ssid tdma-test tmdaslot 0 tdmaslotlen 2500 \e
 202         channel 36 up
 203 .Ed
 204 .Sh DIAGNOSTICS
 205 .Bl -diag
 206 .It "ath%d: unable to attach hardware; HAL status %u"
 207 The Atheros Hardware Access Layer was unable to configure the hardware
 208 as requested.
 209 The status code is explained in the HAL include file
 210 .Pa sys/contrib/dev/ath/ah.h .
 211 .It "ath%d: failed to allocate descriptors: %d"
 212 The driver was unable to allocate contiguous memory for the transmit
 213 and receive descriptors.
 214 This usually indicates system memory is scarce and/or fragmented.
 215 .It "ath%d: unable to setup a data xmit queue!"
 216 The request to the HAL to set up the transmit queue for normal
 217 data frames failed.
 218 This should not happen.
 219 .It "ath%d: unable to setup a beacon xmit queue!"
 220 The request to the HAL to set up the transmit queue for 802.11 beacon frames
 221 frames failed.
 222 This should not happen.
 223 .It "ath%d: 802.11 address: %s"
 224 The MAC address programmed in the EEPROM is displayed.
 225 .It "ath%d: hardware error; resetting"
 226 An unrecoverable error in the hardware occurred.
 227 Errors of this sort include unrecoverable DMA errors.
 228 The driver will reset the hardware and continue.
 229 .It "ath%d: rx FIFO overrun; resetting"
 230 The receive FIFO in the hardware overflowed before the data could be
 231 transferred to the host.
 232 This typically occurs because the hardware ran short of receive
 233 descriptors and had no place to transfer received data.
 234 The driver will reset the hardware and continue.
 235 .It "ath%d: unable to reset hardware; hal status %u"
 236 The Atheros Hardware Access Layer was unable to reset the hardware
 237 as requested.
 238 The status code is explained in the HAL include file
 239 .Pa sys/contrib/dev/ath/ah.h .
 240 This should not happen.
 241 .It "ath%d: unable to start recv logic"
 242 The driver was unable to restart frame reception.
 243 This should not happen.
 244 .It "ath%d: device timeout"
 245 A frame dispatched to the hardware for transmission did not complete in time.
 246 The driver will reset the hardware and continue.
 247 This should not happen.
 248 .It "ath%d: bogus xmit rate 0x%x"
 249 An invalid transmit rate was specified for an outgoing frame.
 250 The frame is discarded.
 251 This should not happen.
 252 .It "ath%d: ath_chan_set: unable to reset channel %u (%u MHz)"
 253 The Atheros Hardware Access Layer was unable to reset the hardware
 254 when switching channels during scanning.
 255 This should not happen.
 256 .It "ath%d: failed to enable memory mapping"
 257 The driver was unable to enable memory-mapped I/O to the PCI device registers.
 258 This should not happen.
 259 .It "ath%d: failed to enable bus mastering"
 260 The driver was unable to enable the device as a PCI bus master for doing DMA.
 261 This should not happen.
 262 .It "ath%d: cannot map register space"
 263 The driver was unable to map the device registers into the host address space.
 264 This should not happen.
 265 .It "ath%d: could not map interrupt"
 266 The driver was unable to allocate an IRQ for the device interrupt.
 267 This should not happen.
 268 .It "ath%d: could not establish interrupt"
 269 The driver was unable to install the device interrupt handler.
 270 This should not happen.
 271 .El
 272 .Sh SEE ALSO
 273 .Xr ath_hal 4 ,
 274 .Xr cardbus 4 ,
 275 .Xr intro 4 ,
 276 .Xr pcic 4 ,
 277 .Xr wlan 4 ,
 278 .Xr wlan_ccmp 4 ,
 279 .Xr wlan_tkip 4 ,
 280 .Xr wlan_wep 4 ,
 281 .Xr wlan_xauth 4 ,
 282 .Xr hostapd 8 ,
 283 .Xr ifconfig 8 ,
 284 .Xr wpa_supplicant 8
 285 .Sh HISTORY
 286 The
 287 .Nm
 288 device driver first appeared in
 289 .Fx 5.2 .
 290 .Sh CAVEATS
 291 Revision A1 of the D-LINK DWL-G520 and DWL-G650 are based on an
 292 Intersil PrismGT chip and are not supported by this driver.
 293 .Sh BUGS
 294 There is no software retransmit; only hardware retransmit is used.
 295 .Pp
 296 The driver does not fully enable power-save operation of the chip
 297 in station mode; consequently power use is suboptimal (e.g. on a laptop).
 298 .Pp
 299 WPA is not supported for 5210 parts.