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$
  33 .\"/
  34 .Dd December 7, 2006
  35 .Dt ATH 4
  36 .Os
  37 .Sh NAME
  38 .Nm ath
  39 .Nd "Atheros IEEE 802.11 wireless network driver"
  40 .Sh SYNOPSIS
  41 To compile this driver into the kernel,
  42 place the following lines in your
  43 kernel configuration file:
  44 .Bd -ragged -offset indent
  45 .Cd "device ath"
  46 .Cd "device ath_hal"
  47 .Cd "device ath_rate_sample"
  48 .Cd "device wlan"
  49 .Ed
  50 .Pp
  51 Alternatively, to load the driver as a
  52 module at boot time, place the following line in
  53 .Xr loader.conf 5 :
  54 .Bd -literal -offset indent
  55 if_ath_load="YES"
  56 .Ed
  57 .Sh DESCRIPTION
  58 The
  59 .Nm
  60 driver provides support for wireless network adapters based on
  61 the Atheros AR5210, AR5211, and AR5212 programming APIs.
  62 These APIs are used by a wide variety of chips; all chips with
  63 a PCI and/or CardBus interface are supported.
  64 Chip-specific support is provided by the Atheros Hardware Access Layer
  65 (HAL), that is packaged separately.
  66 .Pp
  67 Supported features include 802.11 and 802.3 frames, power management, BSS,
  68 IBSS, and host-based access point operation modes.
  69 All host/device interaction is via DMA.
  70 .Pp
  71 The
  72 .Nm
  73 driver encapsulates all IP and ARP traffic as 802.11 frames, however
  74 it can receive either 802.11 or 802.3 frames.
  75 Transmit speed and operating mode is selectable
  76 and depends on the specific chipset.
  77 AR5210-based devices support 802.11a operation with transmit speeds
  78 of 6 Mbps, 9 Mbps, 12 Mbps, 18 Mbps, 24 Mbps, 36 Mbps, 48 Mbps, and 54 Mbps.
  79 AR5211-based devices support 802.11a and 802.11b operation with transmit
  80 speeds as above for 802.11a operation and
  81 1Mbps, 2Mbps, 5.5 Mbps and 11Mbps for 802.11b operation.
  82 AR5212-based devices support 802.11a, 802.11b, and 802.11g operation
  83 with transmit speeds appropriate to each.
  84 Most chips also support an Atheros Turbo Mode (TM) that operates in
  85 the 5Ghz frequency range with 2x the transmit speeds.
  86 Some chips also support Turbo mode in the 2.4Ghz range with 802.11g
  87 though this support is not presently available due to regulatory requirements.
  88 (Note that Turbo modes are, however,
  89 only interoperable with other Atheros-based devices.)
  90 The actual transmit speed used is dependent on signal quality and the
  91 .Dq "rate control"
  92 algorithm employed by the driver.
  93 All chips support WEP encryption.
  94 The AR5212 has hardware support for the 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 By default, the
 101 .Nm
 102 driver configures the card for BSS operation (aka infrastructure
 103 mode).
 104 This mode requires the use of an access point (base station).
 105 .Pp
 106 The
 107 .Nm
 108 driver also supports the standard IBSS point-to-point mode
 109 where stations can communicate amongst themselves without the
 110 aid of an access point.
 111 .Pp
 112 The driver may also be configured to operate in hostap mode.
 113 In this mode a host may function as an access point (base station).
 114 Access points are different than operating in IBSS mode.
 115 They operate in BSS mode.
 116 They allow for easier roaming and bridge all Ethernet traffic such
 117 that machines connected via an access point appear to be on the local
 118 Ethernet segment.
 119 .Pp
 120 For more information on configuring this device, see
 121 .Xr ifconfig 8 .
 122 .Pp
 123 Devices supported by the
 124 .Nm
 125 driver come in either Cardbus or mini-PCI packages.
 126 Wireless cards in Cardbus slots may be inserted and ejected on the fly.
 127 .Sh HARDWARE
 128 The
 129 .Nm
 130 driver supports all Atheros Cardbus or PCI cards,
 131 except those that are based on the AR5005VL chipset.
 132 .Pp
 133 A list of cards that are supported can be found at
 134 .Pa http://customerproducts.atheros.com/customerproducts/default.asp .
 135 .Sh EXAMPLES
 136 Join an existing BSS network (ie: connect to an access point):
 137 .Pp
 138 .Dl "ifconfig ath0 inet 192.168.0.20 netmask 0xffffff00"
 139 .Pp
 140 Join a specific BSS network with network name
 141 .Dq Li my_net :
 142 .Pp
 143 .Dl "ifconfig ath0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net"
 144 .Pp
 145 Join a specific BSS network with WEP encryption:
 146 .Bd -literal -offset indent
 147 ifconfig ath0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
 148         wepmode on wepkey 0x8736639624
 149 .Ed
 150 .Pp
 151 Join/create an 802.11b IBSS network with network name
 152 .Dq Li my_net :
 153 .Bd -literal -offset indent
 154 ifconfig ath0 inet 192.168.0.22 netmask 0xffffff00 ssid my_net \e
 155         mode 11b mediaopt adhoc
 156 .Ed
 157 .Pp
 158 Create an 802.11g host-based access point:
 159 .Bd -literal -offset indent
 160 ifconfig ath0 inet 192.168.0.10 netmask 0xffffff00 ssid my_ap \e
 161         mode 11g mediaopt hostap
 162 .Ed
 163 .Pp
 164 Create an 802.11a host-based access point with WEP enabled:
 165 .Bd -literal -offset indent
 166 ifconfig ath0 inet 192.168.0.10 netmask 0xffffff00 ssid my_ap \e
 167         wepmode on wepkey 0x1234567890 mode 11a mediaopt hostap
 168 .Ed
 169 .Pp
 170 Create a host-based wireless bridge to fxp0:
 171 .Bd -literal -offset indent
 172 ifconfig ath0 inet up ssid my_ap media DS/11Mbps mediaopt hostap
 173 sysctl net.inet.ip.check_interface=0
 174 ifconfig bridge0 create
 175 ifconfig bridge0 addm ath0 addm fxp0 up
 176 .Ed
 177 .Pp
 178 This will give you the same functionality as an access point.
 179 .Sh DIAGNOSTICS
 180 .Bl -diag
 181 .It "ath%d: unable to attach hardware; HAL status %u"
 182 The Atheros Hardware Access Layer was unable to configure the hardware
 183 as requested.
 184 The status code is explained in the HAL include file
 185 .Pa sys/contrib/dev/ath/ah.h .
 186 .It "ath%d: failed to allocate descriptors: %d"
 187 The driver was unable to allocate contiguous memory for the transmit
 188 and receive descriptors.
 189 This usually indicates system memory is scarce and/or fragmented.
 190 .It "ath%d: unable to setup a data xmit queue!"
 191 The request to the HAL to set up the transmit queue for normal
 192 data frames failed.
 193 This should not happen.
 194 .It "ath%d: unable to setup a beacon xmit queue!"
 195 The request to the HAL to set up the transmit queue for 802.11 beacon frames
 196 frames failed.
 197 This should not happen.
 198 .It "ath%d: 802.11 address: %s"
 199 The MAC address programmed in the EEPROM is displayed.
 200 .It "ath%d: hardware error; resetting"
 201 An unrecoverable error in the hardware occurred.
 202 Errors of this sort include unrecoverable DMA errors.
 203 The driver will reset the hardware and continue.
 204 .It "ath%d: rx FIFO overrun; resetting"
 205 The receive FIFO in the hardware overflowed before the data could be
 206 transferred to the host.
 207 This typically occurs because the hardware ran short of receive
 208 descriptors and had no place to transfer received data.
 209 The driver will reset the hardware and continue.
 210 .It "ath%d: unable to reset hardware; hal status %u"
 211 The Atheros Hardware Access Layer was unable to reset the hardware
 212 as requested.
 213 The status code is explained in the HAL include file
 214 .Pa sys/contrib/dev/ath/ah.h .
 215 This should not happen.
 216 .It "ath%d: unable to start recv logic"
 217 The driver was unable to restart frame reception.
 218 This should not happen.
 219 .It "ath%d: device timeout"
 220 A frame dispatched to the hardware for transmission did not complete in time.
 221 The driver will reset the hardware and continue.
 222 This should not happen.
 223 .It "ath%d: bogus xmit rate 0x%x"
 224 An invalid transmit rate was specified for an outgoing frame.
 225 The frame is discarded.
 226 This should not happen.
 227 .It "ath%d: ath_chan_set: unable to reset channel %u (%u Mhz)"
 228 The Atheros Hardware Access Layer was unable to reset the hardware
 229 when switching channels during scanning.
 230 This should not happen.
 231 .It "ath%d: unable to allocate channel table"
 232 The driver was unable to allocate memory for the table used to hold
 233 the set of available channels.
 234 .It "ath%d: unable to collect channel list from hal"
 235 A problem occurred while querying the HAL to find the set of available
 236 channels for the device.
 237 This should not happen.
 238 .It "ath%d: failed to enable memory mapping"
 239 The driver was unable to enable memory-mapped I/O to the PCI device registers.
 240 This should not happen.
 241 .It "ath%d: failed to enable bus mastering"
 242 The driver was unable to enable the device as a PCI bus master for doing DMA.
 243 This should not happen.
 244 .It "ath%d: cannot map register space"
 245 The driver was unable to map the device registers into the host address space.
 246 This should not happen.
 247 .It "ath%d: could not map interrupt"
 248 The driver was unable to allocate an IRQ for the device interrupt.
 249 This should not happen.
 250 .It "ath%d: could not establish interrupt"
 251 The driver was unable to install the device interrupt handler.
 252 This should not happen.
 253 .El
 254 .Sh SEE ALSO
 255 .Xr altq 4 ,
 256 .Xr an 4 ,
 257 .Xr arp 4 ,
 258 .Xr ath_hal 4 ,
 259 .Xr netintro 4 ,
 260 .Xr pcic 4 ,
 261 .Xr wi 4 ,
 262 .Xr wlan 4 ,
 263 .Xr ifconfig 8 ,
 264 .Sh HISTORY
 265 The
 266 .Nm
 267 device driver first appeared in
 268 .Fx 5.2 .
 269 .Sh CAVEATS
 270 Different regulatory domains have different default channels for adhoc
 271 mode.
 272 See
 273 .Xr ifconfig 8
 274 for information on how to change the channel.
 275 Different regulatory domains may not be able to communicate with each
 276 other with 802.11a as different regulatory domains do not necessarily
 277 have overlapping channels.
 278 .Pp
 279 Revision A1 of the D-LINK DWL-G520 and DWL-G650 are based on an
 280 Intersil PrismGT chip and are not supported by this driver.
 281 .Sh BUGS
 282 There is no software retransmit; only hardware retransmit is used.
 283 .Pp
 284 The driver does not fully enable power-save operation of the chip;
 285 consequently power use is suboptimal.
 286 .Pp
 287 The driver honors the regulatory domain programmed into the EEPROM of a
 288 device and does not support overriding this setting.
 289 This is done to insure compliance with local regulatory agencies when
 290 operating as an access point.
 291 Unfortunately this also means that devices purchased for use in one locale
 292 may not be usable in another.
 293 Changes are planned to remove this restriction when operating in station mode.
 294 .Pp
 295 WPA is not supported for 5210 parts.
 296 .Pp
 297 Atheros' SuperG functionality is not supported.