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 June 16, 2020
  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_pci"
  44 .Cd "device ath_hal"
  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 if_ath_pci_load="YES"
  55 .Ed
  56 .Sh DESCRIPTION
  57 The
  58 .Nm
  59 driver provides support for wireless network adapters based on
  60 the Atheros AR5210, AR5211, AR5212, AR5416 and AR9300 programming APIs.
  61 These APIs are used by a wide variety of chips; most all chips with
  62 a PCI, PCIe and/or CardBus interface are supported.
  63 .Pp
  64 Supported features include 802.11 and 802.3 frames, power management, BSS,
  65 IBSS, MBSS, WDS/DWDS TDMA, and host-based access point operation modes.
  66 All host/device interaction is via DMA.
  67 .Pp
  68 Please note that from FreeBSD-9.0, the
  69 .Nm
  70 driver does not include the PCI/PCIe bus glue.
  71 The same driver supports multiple underlying bus types, including PCI/PCIe,
  72 but also embedded (AHB) and USB in the future.
  73 .Pp
  74 To enable use for PCI/PCIe systems, see the
  75 .Xr ath_pci 4
  76 driver.
  77 For embedded systems which use the AHB to connect the wireless MAC, see the
  78 .Xr ath_ahb 4
  79 driver.
  80 .Pp
  81 The
  82 .Nm
  83 driver encapsulates all IP and ARP traffic as 802.11 frames, however
  84 it can receive either 802.11 or 802.3 frames.
  85 Transmit speed and operating mode is selectable
  86 and depends on the specific chipset.
  87 AR5210-based devices support 802.11a operation with transmit speeds
  88 of 6 Mbps, 9 Mbps, 12 Mbps, 18 Mbps, 24 Mbps, 36 Mbps, 48 Mbps, and 54 Mbps.
  89 AR5211-based devices support 802.11a and 802.11b operation with transmit
  90 speeds as above for 802.11a operation and
  91 1Mbps, 2Mbps, 5.5 Mbps and 11Mbps for 802.11b operation.
  92 AR5212-based devices support 802.11a, 802.11b, and 802.11g operation
  93 with transmit speeds appropriate to each.
  94 AR5416 and later class devices are capable of 802.11n operation.
  95 Most chips also support an Atheros Turbo Mode (TM) that operates in
  96 the 5GHz frequency range with 2x the transmit speeds.
  97 Some chips also support Turbo mode in the 2.4GHz range with 802.11g
  98 though this support is not presently available due to regulatory requirements.
  99 (Note that Turbo modes are, however,
 100 only interoperable with other Atheros-based devices.)
 101 AR5212-based and AR5416-based devices also support half- (10MHz) and quarter-width (5MHz) channels.
 102 The actual transmit speed used is dependent on signal quality and the
 103 .Dq "rate control"
 104 algorithm employed by the driver.
 105 All chips support WEP encryption.
 106 AR5212, AR5416 and later parts have hardware support for the
 107 AES-CCM, TKIP, and Michael cryptographic
 108 operations required for WPA.
 109 To enable encryption, use
 110 .Xr ifconfig 8
 111 as shown below.
 112 .Pp
 113 The driver supports
 114 .Cm station ,
 115 .Cm adhoc ,
 116 .Cm adhoc-demo ,
 117 .Cm hostap ,
 118 .Cm mesh ,
 119 .Cm wds ,
 120 and
 121 .Cm monitor
 122 mode operation.
 123 Multiple
 124 .Cm hostap
 125 virtual interfaces may be configured for simultaneous
 126 use on cards that use a 5212 or later part.
 127 When multiple interfaces are configured each may have a separate
 128 mac address that is formed by setting the U/L bits in the mac
 129 address assigned to the underlying device.
 130 Any number of
 131 .Cm wds
 132 virtual interfaces may be configured together with
 133 .Cm hostap
 134 interfaces.
 135 Multiple
 136 .Cm station
 137 interfaces may be operated together with
 138 .Cm hostap
 139 interfaces to construct a wireless repeater device.
 140 The driver also support
 141 .Cm tdma
 142 operation when compiled with
 143 .Cd "options IEEE80211_SUPPORT_TDMA"
 144 (which also enables the required 802.11 support).
 145 For more information on configuring this device, see
 146 .Xr ifconfig 8 .
 147 .Pp
 148 Devices supported by the
 149 .Nm
 150 driver come in Cardbus, ExpressCard, Mini-PCI and Mini-PCIe packages.
 151 Wireless cards in Cardbus and ExpressCard slots may be inserted and
 152 ejected on the fly.
 153 .Sh HARDWARE
 154 The
 155 .Nm
 156 driver supports all Atheros Cardbus, ExpressCard, PCI and PCIe cards,
 157 except those that are based on the AR5005VL chipset.
 158 .Sh EXAMPLES
 159 Join a specific BSS network with WEP encryption:
 160 .Bd -literal -offset indent
 161 ifconfig wlan0 create wlandev ath0
 162 ifconfig wlan0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
 163         wepmode on wepkey 0x8736639624
 164 .Ed
 165 .Pp
 166 Join/create an 802.11b IBSS network with network name
 167 .Dq Li my_net :
 168 .Bd -literal -offset indent
 169 ifconfig wlan0 create wlandev ath0 wlanmode adhoc
 170 ifconfig wlan0 inet 192.168.0.22 netmask 0xffffff00 ssid my_net \e
 171         mode 11b
 172 .Ed
 173 .Pp
 174 Create an 802.11g host-based access point:
 175 .Bd -literal -offset indent
 176 ifconfig wlan0 create wlandev ath0 wlanmode hostap
 177 ifconfig wlan0 inet 192.168.0.10 netmask 0xffffff00 ssid my_ap \e
 178         mode 11g
 179 .Ed
 180 .Pp
 181 Create an 802.11a mesh station:
 182 .Bd -literal -offset indent
 183 ifconfig wlan0 create wlandev ath0 wlanmode mesh
 184 ifconfig wlan0 meshid my_mesh mode 11a inet 192.168.0.10/24
 185 .Ed
 186 .Pp
 187 Create two virtual 802.11a host-based access points, one with
 188 WEP enabled and one with no security, and bridge them to
 189 the fxp0 (wired) device:
 190 .Bd -literal -offset indent
 191 ifconfig wlan0 create wlandev ath0 wlanmode hostap \e
 192         ssid paying-customers wepmode on wepkey 0x1234567890 \e
 193         mode 11a up
 194 ifconfig wlan1 create wlandev ath0 wlanmode hostap bssid \e
 195         ssid freeloaders up
 196 ifconfig bridge0 create addm wlan0 addm wlan1 addm fxp0 up
 197 .Ed
 198 .Pp
 199 Create a master node in a two slot TDMA BSS configured to use
 200 2.5 millisecond slots.
 201 .Bd -literal -offset indent
 202 ifconfig wlan0 create wlandev ath0 wlanmode tdma \e
 203         ssid tdma-test tmdaslot 0 tdmaslotlen 2500 \e
 204         channel 36 up
 205 .Ed
 206 .Sh DIAGNOSTICS
 207 .Bl -diag
 208 .It "ath%d: unable to attach hardware; HAL status %u"
 209 The Atheros Hardware Access Layer was unable to configure the hardware
 210 as requested.
 211 The status code is explained in the HAL include file
 212 .Pa sys/dev/ath/ath_hal/ah.h .
 213 .It "ath%d: failed to allocate descriptors: %d"
 214 The driver was unable to allocate contiguous memory for the transmit
 215 and receive descriptors.
 216 This usually indicates system memory is scarce and/or fragmented.
 217 .It "ath%d: unable to setup a data xmit queue!"
 218 The request to the HAL to set up the transmit queue for normal
 219 data frames failed.
 220 This should not happen.
 221 .It "ath%d: unable to setup a beacon xmit queue!"
 222 The request to the HAL to set up the transmit queue for 802.11 beacon frames
 223 failed.
 224 This should not happen.
 225 .It "ath%d: 802.11 address: %s"
 226 The MAC address programmed in the EEPROM is displayed.
 227 .It "ath%d: hardware error; resetting"
 228 An unrecoverable error in the hardware occurred.
 229 Errors of this sort include unrecoverable DMA errors.
 230 The driver will reset the hardware and continue.
 231 .It "ath%d: rx FIFO overrun; resetting"
 232 The receive FIFO in the hardware overflowed before the data could be
 233 transferred to the host.
 234 This typically occurs because the hardware ran short of receive
 235 descriptors and had no place to transfer received data.
 236 The driver will reset the hardware and continue.
 237 .It "ath%d: unable to reset hardware; hal status %u"
 238 The Atheros Hardware Access Layer was unable to reset the hardware
 239 as requested.
 240 The status code is explained in the HAL include file
 241 .Pa sys/dev/ath/ath_hal/ah.h .
 242 This should not happen.
 243 .It "ath%d: unable to start recv logic"
 244 The driver was unable to restart frame reception.
 245 This should not happen.
 246 .It "ath%d: device timeout"
 247 A frame dispatched to the hardware for transmission did not complete in time.
 248 The driver will reset the hardware and continue.
 249 This should not happen.
 250 .It "ath%d: bogus xmit rate 0x%x"
 251 An invalid transmit rate was specified for an outgoing frame.
 252 The frame is discarded.
 253 This should not happen.
 254 .It "ath%d: ath_chan_set: unable to reset channel %u (%u MHz)"
 255 The Atheros Hardware Access Layer was unable to reset the hardware
 256 when switching channels during scanning.
 257 This should not happen.
 258 .It "ath%d: failed to enable memory mapping"
 259 The driver was unable to enable memory-mapped I/O to the PCI device registers.
 260 This should not happen.
 261 .It "ath%d: failed to enable bus mastering"
 262 The driver was unable to enable the device as a PCI bus master for doing DMA.
 263 This should not happen.
 264 .It "ath%d: cannot map register space"
 265 The driver was unable to map the device registers into the host address space.
 266 This should not happen.
 267 .It "ath%d: could not map interrupt"
 268 The driver was unable to allocate an IRQ for the device interrupt.
 269 This should not happen.
 270 .It "ath%d: could not establish interrupt"
 271 The driver was unable to install the device interrupt handler.
 272 This should not happen.
 273 .El
 274 .Sh SEE ALSO
 275 .Xr ath_hal 4 ,
 276 .Xr cardbus 4 ,
 277 .Xr intro 4 ,
 278 .Xr pcic 4 ,
 279 .Xr wlan 4 ,
 280 .Xr wlan_ccmp 4 ,
 281 .Xr wlan_tkip 4 ,
 282 .Xr wlan_wep 4 ,
 283 .Xr wlan_xauth 4 ,
 284 .Xr hostapd 8 ,
 285 .Xr ifconfig 8 ,
 286 .Xr wpa_supplicant 8
 287 .Sh HISTORY
 288 The
 289 .Nm
 290 device driver first appeared in
 291 .Fx 5.2 .
 292 .Sh CAVEATS
 293 Revision A1 of the D-LINK DWL-G520 and DWL-G650 are based on an
 294 Intersil PrismGT chip and are not supported by this driver.
 295 .Sh BUGS
 296 The driver does supports optional station mode power-save operation.
 297 .Pp
 298 The AR5210 can only do WEP in hardware; consequently hardware assisted WEP
 299 is disabled in order to allow software implementations of TKIP and CCMP to
 300 function.
 301 Hardware WEP can be re-enabled by modifying the driver.