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 September 5, 2005
  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 following cards are among those supported by the
 129 .Nm
 130 driver:
 131 .Pp
 132 .Bl -column -compact "Samsung SWL-5200N" "AR5212" "Cardbus" "a/b/g"
 133 .It Em "Card    Chip    Bus     Standard"
 134 .It "Aztech WL830PC     AR5212  CardBus b/g"
 135 .It "Cisco AIR-CB21AG   AR5115  Cardbus a/b/g"
 136 .It "Cisco AIR-PI21AG   AR5115  PCI     a/b/g"
 137 .It "D-Link DWL-A650    AR5210  CardBus a"
 138 .It "D-Link DWL-AB650   AR5211  CardBus a/b"
 139 .It "D-Link DWL-A520    AR5210  PCI     a"
 140 .It "D-Link DWL-AG520   AR5212  PCI     a/b/g"
 141 .It "D-Link DWL-AG650   AR5212  CardBus a/b/g"
 142 .It "D-Link DWL-G520B   AR5212  PCI     b/g"
 143 .It "D-Link DWL-G650B   AR5212  CardBus b/g"
 144 .It "Elecom LD-WL54AG   AR5212  Cardbus a/b/g"
 145 .It "Elecom LD-WL54     AR5211  Cardbus a"
 146 .It "Fujitsu E5454      AR5212  Cardbus a/b/g"
 147 .It "Fujitsu FMV-JW481  AR5212  Cardbus a/b/g"
 148 .It "Fujitsu E5454      AR5212  Cardbus a/b/g"
 149 .It "HP NC4000  AR5212  PCI     a/b/g"
 150 .It "I/O Data WN-AB     AR5212  CardBus a/b"
 151 .It "I/O Data WN-AG     AR5212  CardBus a/b/g"
 152 .It "I/O Data WN-A54    AR5212  CardBus a"
 153 .It "Linksys WMP55AG    AR5212  PCI     a/b/g"
 154 .It "Linksys WPC51AB    AR5211  CardBus a/b"
 155 .It "Linksys WPC55AG    AR5212  CardBus a/b/g"
 156 .It "NEC PA-WL/54AG     AR5212  CardBus a/b/g"
 157 .It "Netgear WAG311     AR5212  PCI     a/b/g"
 158 .It "Netgear WAB501     AR5211  CardBus a/b"
 159 .It "Netgear WAG511     AR5212  CardBus a/b/g"
 160 .It "Netgear WG311T     AR5212  PCI     b/g"
 161 .It "Netgear WG511T     AR5212  CardBus b/g"
 162 .It "Orinoco 8480       AR5212  CardBus a/b/g"
 163 .It "Orinoco 8470WD     AR5212  CardBus a/b/g"
 164 .It "Proxim Skyline 4030        AR5210  CardBus a"
 165 .It "Proxim Skyline 4032        AR5210  PCI     a"
 166 .It "Samsung SWL-5200N  AR5212  CardBus a/b/g"
 167 .It "SMC SMC2536W-AG    AR5212  CardBus a/b/g"
 168 .It "SMC SMC2735W       AR5210  CardBus a"
 169 .It "Sony PCWA-C700     AR5212  Cardbus a/b"
 170 .It "Sony PCWA-C300S    AR5212  Cardbus b/g"
 171 .It "Sony PCWA-C500     AR5210  Cardbus a"
 172 .It "3Com 3CRPAG175     AR5212  CardBus a/b/g"
 173 .El
 174 .Pp
 175 An up to date list can be found at
 176 .Pa http://customerproducts.atheros.com/customerproducts .
 177 .Sh EXAMPLES
 178 Join an existing BSS network (ie: connect to an access point):
 179 .Pp
 180 .Dl "ifconfig ath0 inet 192.168.0.20 netmask 0xffffff00"
 181 .Pp
 182 Join a specific BSS network with network name
 183 .Dq Li my_net :
 184 .Pp
 185 .Dl "ifconfig ath0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net"
 186 .Pp
 187 Join a specific BSS network with WEP encryption:
 188 .Bd -literal -offset indent
 189 ifconfig ath0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
 190         wepmode on wepkey 0x8736639624
 191 .Ed
 192 .Pp
 193 Join/create an 802.11b IBSS network with network name
 194 .Dq Li my_net :
 195 .Bd -literal -offset indent
 196 ifconfig ath0 inet 192.168.0.22 netmask 0xffffff00 ssid my_net \e
 197         mode 11b mediaopt adhoc
 198 .Ed
 199 .Pp
 200 Create an 802.11g host-based access point:
 201 .Bd -literal -offset indent
 202 ifconfig ath0 inet 192.168.0.10 netmask 0xffffff00 ssid my_ap \e
 203         mode 11g mediaopt hostap
 204 .Ed
 205 .Pp
 206 Create an 802.11a host-based access point with WEP enabled:
 207 .Bd -literal -offset indent
 208 ifconfig ath0 inet 192.168.0.10 netmask 0xffffff00 ssid my_ap \e
 209         wepmode on wepkey 0x1234567890 mode 11a mediaopt hostap
 210 .Ed
 211 .Pp
 212 Create a host-based wireless bridge to fxp0:
 213 .Bd -literal -offset indent
 214 ifconfig ath0 inet up ssid my_ap media DS/11Mbps mediaopt hostap
 215 sysctl net.inet.ip.check_interface=0
 216 ifconfig bridge0 create
 217 ifconfig bridge0 addm ath0 addm fxp0
 218 .Ed
 219 .Pp
 220 This will give you the same functionality as an access point.
 221 .Sh DIAGNOSTICS
 222 .Bl -diag
 223 .It "ath%d: unable to attach hardware; HAL status %u"
 224 The Atheros Hardware Access Layer was unable to configure the hardware
 225 as requested.
 226 The status code is explained in the HAL include file
 227 .Pa sys/contrib/dev/ath/ah.h .
 228 .It "ath%d: failed to allocate descriptors: %d"
 229 The driver was unable to allocate contiguous memory for the transmit
 230 and receive descriptors.
 231 This usually indicates system memory is scarce and/or fragmented.
 232 .It "ath%d: unable to setup a data xmit queue!"
 233 The request to the HAL to set up the transmit queue for normal
 234 data frames failed.
 235 This should not happen.
 236 .It "ath%d: unable to setup a beacon xmit queue!"
 237 The request to the HAL to set up the transmit queue for 802.11 beacon frames
 238 frames failed.
 239 This should not happen.
 240 .It "ath%d: 802.11 address: %s"
 241 The MAC address programmed in the EEPROM is displayed.
 242 .It "ath%d: hardware error; resetting"
 243 An unrecoverable error in the hardware occurred.
 244 Errors of this sort include unrecoverable DMA errors.
 245 The driver will reset the hardware and continue.
 246 .It "ath%d: rx FIFO overrun; resetting"
 247 The receive FIFO in the hardware overflowed before the data could be
 248 transferred to the host.
 249 This typically occurs because the hardware ran short of receive
 250 descriptors and had no place to transfer received data.
 251 The driver will reset the hardware and continue.
 252 .It "ath%d: unable to reset hardware; hal status %u"
 253 The Atheros Hardware Access Layer was unable to reset the hardware
 254 as requested.
 255 The status code is explained in the HAL include file
 256 .Pa sys/contrib/dev/ath/ah.h .
 257 This should not happen.
 258 .It "ath%d: unable to start recv logic"
 259 The driver was unable to restart frame reception.
 260 This should not happen.
 261 .It "ath%d: device timeout"
 262 A frame dispatched to the hardware for transmission did not complete in time.
 263 The driver will reset the hardware and continue.
 264 This should not happen.
 265 .It "ath%d: bogus xmit rate 0x%x"
 266 An invalid transmit rate was specified for an outgoing frame.
 267 The frame is discarded.
 268 This should not happen.
 269 .It "ath%d: ath_chan_set: unable to reset channel %u (%u Mhz)"
 270 The Atheros Hardware Access Layer was unable to reset the hardware
 271 when switching channels during scanning.
 272 This should not happen.
 273 .It "ath%d: unable to allocate channel table"
 274 The driver was unable to allocate memory for the table used to hold
 275 the set of available channels.
 276 .It "ath%d: unable to collect channel list from hal"
 277 A problem occurred while querying the HAL to find the set of available
 278 channels for the device.
 279 This should not happen.
 280 .It "ath%d: failed to enable memory mapping"
 281 The driver was unable to enable memory-mapped I/O to the PCI device registers.
 282 This should not happen.
 283 .It "ath%d: failed to enable bus mastering"
 284 The driver was unable to enable the device as a PCI bus master for doing DMA.
 285 This should not happen.
 286 .It "ath%d: cannot map register space"
 287 The driver was unable to map the device registers into the host address space.
 288 This should not happen.
 289 .It "ath%d: could not map interrupt"
 290 The driver was unable to allocate an IRQ for the device interrupt.
 291 This should not happen.
 292 .It "ath%d: could not establish interrupt"
 293 The driver was unable to install the device interrupt handler.
 294 This should not happen.
 295 .El
 296 .Sh SEE ALSO
 297 .Xr an 4 ,
 298 .Xr arp 4 ,
 299 .Xr ath_hal 4 ,
 300 .Xr card 4 ,
 301 .Xr netintro 4 ,
 302 .Xr pcic 4 ,
 303 .Xr wi 4 ,
 304 .Xr wlan 4 ,
 305 .Xr ifconfig 8 ,
 306 .Xr wicontrol 8
 307 .Sh HISTORY
 308 The
 309 .Nm
 310 device driver first appeared in
 311 .Fx 5.2 .
 312 .Sh CAVEATS
 313 Different regulatory domains have different default channels for adhoc
 314 mode.
 315 See
 316 .Xr ifconfig 8
 317 for information on how to change the channel.
 318 See
 319 .Xr wicontrol 8
 320 for information on different regulatory domains.
 321 Different regulatory domains may not be able to communicate with each
 322 other with 802.11a as different regulatory domains do not necessarily
 323 have overlapping channels.
 324 .Pp
 325 Revision A1 of the D-LINK DWL-G520 and DWL-G650 are based on an
 326 Intersil PrismGT chip and are not supported by this driver.
 327 .Sh BUGS
 328 There is no software retransmit; only hardware retransmit is used.
 329 .Pp
 330 The driver does not fully enable power-save operation of the chip;
 331 consequently power use is suboptimal.
 332 .Pp
 333 The driver honors the regulatory domain programmed into the EEPROM of a
 334 device and does not support overriding this setting.
 335 This is done to insure compliance with local regulatory agencies when
 336 operating as an access point.
 337 Unfortunately this also means that devices purchased for use in one locale
 338 may not be usable in another.
 339 Changes are planned to remove this restriction when operating in station mode.
 340 .Pp
 341 WPA is not supported for 5210 parts.
 342 .Pp
 343 Atheros' SuperG functionality is not supported.