diff options
Diffstat (limited to 'static/freebsd/man4/ath.4 3.html')
| -rw-r--r-- | static/freebsd/man4/ath.4 3.html | 233 |
1 files changed, 233 insertions, 0 deletions
diff --git a/static/freebsd/man4/ath.4 3.html b/static/freebsd/man4/ath.4 3.html new file mode 100644 index 00000000..e84661ea --- /dev/null +++ b/static/freebsd/man4/ath.4 3.html @@ -0,0 +1,233 @@ +<table class="head"> + <tr> + <td class="head-ltitle">ATH(4)</td> + <td class="head-vol">Device Drivers Manual</td> + <td class="head-rtitle">ATH(4)</td> + </tr> +</table> +<div class="manual-text"> +<section class="Sh"> +<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1> +<p class="Pp"><code class="Nm">ath</code> — <span class="Nd">Atheros IEEE + 802.11 wireless network driver</span></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1> +<p class="Pp">To compile this driver into the kernel, place the following lines + in your kernel configuration file:</p> +<div class="Bd Pp Bd-indent"><code class="Cd">device ath</code> +<br/> +<code class="Cd">device ath_hal</code> +<br/> +<code class="Cd">device ath_rate_sample</code> +<br/> +<code class="Cd">device wlan</code></div> +<p class="Pp">Alternatively, to load the driver as a module at boot time, place + the following line in <a class="Xr">loader.conf(5)</a>:</p> +<div class="Bd Pp Bd-indent Li"> +<pre>if_ath_load="YES"</pre> +</div> +</section> +<section class="Sh"> +<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> +<p class="Pp">The <code class="Nm">ath</code> driver provides support for + wireless network adapters based on the Atheros AR5210, AR5211, AR5212, + AR5416 and AR9300 programming APIs. These APIs are used by a wide variety of + chips; most all chips with a PCI, PCIe and/or CardBus interface are + supported.</p> +<p class="Pp">Supported features include 802.11 and 802.3 frames, power + management, BSS, IBSS, MBSS, WDS/DWDS TDMA, and host-based access point + operation modes. All host/device interaction is via DMA.</p> +<p class="Pp">The <code class="Nm">ath</code> driver encapsulates all IP and ARP + traffic as 802.11 frames, however it can receive either 802.11 or 802.3 + frames. Transmit speed and operating mode is selectable and depends on the + specific chipset. AR5210-based devices support 802.11a operation with + transmit speeds of 6 Mbps, 9 Mbps, 12 Mbps, 18 Mbps, 24 Mbps, 36 Mbps, 48 + Mbps, and 54 Mbps. AR5211-based devices support 802.11a and 802.11b + operation with transmit speeds as above for 802.11a operation and 1Mbps, + 2Mbps, 5.5 Mbps and 11Mbps for 802.11b operation. AR5212-based devices + support 802.11a, 802.11b, and 802.11g operation with transmit speeds + appropriate to each. AR5416 and later class devices are capable of 802.11n + operation. Most chips also support an Atheros Turbo Mode (TM) that operates + in the 5GHz frequency range with 2x the transmit speeds. Some chips also + support Turbo mode in the 2.4GHz range with 802.11g though this support is + not presently available due to regulatory requirements. (Note that Turbo + modes are, however, only interoperable with other Atheros-based devices.) + AR5212-based and AR5416-based devices also support half- (10MHz) and + quarter-width (5MHz) channels. The actual transmit speed used is dependent + on signal quality and the “rate control” algorithm employed by + the driver. All chips support WEP encryption. AR5212, AR5416 and later parts + have hardware support for the AES-CCM, TKIP, and Michael cryptographic + operations required for WPA. To enable encryption, use + <a class="Xr">ifconfig(8)</a> as shown below.</p> +<p class="Pp">The driver supports <code class="Cm">station</code>, + <code class="Cm">adhoc</code>, <code class="Cm">adhoc-demo</code>, + <code class="Cm">hostap</code>, <code class="Cm">mesh</code>, + <code class="Cm">wds</code>, and <code class="Cm">monitor</code> mode + operation. Multiple <code class="Cm">hostap</code> virtual interfaces may be + configured for simultaneous use on cards that use a 5212 or later part. When + multiple interfaces are configured each may have a separate mac address that + is formed by setting the U/L bits in the mac address assigned to the + underlying device. Any number of <code class="Cm">wds</code> virtual + interfaces may be configured together with <code class="Cm">hostap</code> + interfaces. Multiple <code class="Cm">station</code> interfaces may be + operated together with <code class="Cm">hostap</code> interfaces to + construct a wireless repeater device. The driver also support + <code class="Cm">tdma</code> operation when compiled with + <code class="Cd">options IEEE80211_SUPPORT_TDMA</code> (which also enables + the required 802.11 support). For more information on configuring this + device, see <a class="Xr">ifconfig(8)</a>.</p> +<p class="Pp">Devices supported by the <code class="Nm">ath</code> driver come + in Cardbus, ExpressCard, Mini-PCI and Mini-PCIe packages. Wireless cards in + Cardbus and ExpressCard slots may be inserted and ejected on the fly.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="HARDWARE"><a class="permalink" href="#HARDWARE">HARDWARE</a></h1> +<p class="Pp">The <code class="Nm">ath</code> driver supports all Atheros + Cardbus, ExpressCard, PCI and PCIe cards, except those that are based on the + AR5005VL chipset.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h1> +<p class="Pp">Join a specific BSS network with WEP encryption:</p> +<div class="Bd Pp Bd-indent Li"> +<pre>ifconfig wlan0 create wlandev ath0 +ifconfig wlan0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \ + wepmode on wepkey 0x8736639624</pre> +</div> +<p class="Pp">Join/create an 802.11b IBSS network with network name + “<code class="Li">my_net</code>”:</p> +<div class="Bd Pp Bd-indent Li"> +<pre>ifconfig wlan0 create wlandev ath0 wlanmode adhoc +ifconfig wlan0 inet 192.168.0.22 netmask 0xffffff00 ssid my_net \ + mode 11b</pre> +</div> +<p class="Pp">Create an 802.11g host-based access point:</p> +<div class="Bd Pp Bd-indent Li"> +<pre>ifconfig wlan0 create wlandev ath0 wlanmode hostap +ifconfig wlan0 inet 192.168.0.10 netmask 0xffffff00 ssid my_ap \ + mode 11g</pre> +</div> +<p class="Pp">Create an 802.11a mesh station:</p> +<div class="Bd Pp Bd-indent Li"> +<pre>ifconfig wlan0 create wlandev ath0 wlanmode mesh +ifconfig wlan0 meshid my_mesh mode 11a inet 192.168.0.10/24</pre> +</div> +<p class="Pp">Create two virtual 802.11a host-based access points, one with WEP + enabled and one with no security, and bridge them to the fxp0 (wired) + device:</p> +<div class="Bd Pp Bd-indent Li"> +<pre>ifconfig wlan0 create wlandev ath0 wlanmode hostap \ + ssid paying-customers wepmode on wepkey 0x1234567890 \ + mode 11a up +ifconfig wlan1 create wlandev ath0 wlanmode hostap bssid \ + ssid freeloaders up +ifconfig bridge0 create addm wlan0 addm wlan1 addm fxp0 up</pre> +</div> +<p class="Pp">Create a master node in a two slot TDMA BSS configured to use 2.5 + millisecond slots.</p> +<div class="Bd Pp Bd-indent Li"> +<pre>ifconfig wlan0 create wlandev ath0 wlanmode tdma \ + ssid tdma-test tmdaslot 0 tdmaslotlen 2500 \ + channel 36 up</pre> +</div> +</section> +<section class="Sh"> +<h1 class="Sh" id="DIAGNOSTICS"><a class="permalink" href="#DIAGNOSTICS">DIAGNOSTICS</a></h1> +<dl class="Bl-diag"> + <dt>ath%d: unable to attach hardware; HAL status %u</dt> + <dd>The Atheros Hardware Access Layer was unable to configure the hardware as + requested. The status code is explained in the HAL include file + <span class="Pa">sys/dev/ath/ath_hal/ah.h</span>.</dd> + <dt>ath%d: failed to allocate descriptors: %d</dt> + <dd>The driver was unable to allocate contiguous memory for the transmit and + receive descriptors. This usually indicates system memory is scarce and/or + fragmented.</dd> + <dt>ath%d: unable to setup a data xmit queue!</dt> + <dd>The request to the HAL to set up the transmit queue for normal data frames + failed. This should not happen.</dd> + <dt>ath%d: unable to setup a beacon xmit queue!</dt> + <dd>The request to the HAL to set up the transmit queue for 802.11 beacon + frames failed. This should not happen.</dd> + <dt>ath%d: 802.11 address: %s</dt> + <dd>The MAC address programmed in the EEPROM is displayed.</dd> + <dt>ath%d: hardware error; resetting</dt> + <dd>An unrecoverable error in the hardware occurred. Errors of this sort + include unrecoverable DMA errors. The driver will reset the hardware and + continue.</dd> + <dt>ath%d: rx FIFO overrun; resetting</dt> + <dd>The receive FIFO in the hardware overflowed before the data could be + transferred to the host. This typically occurs because the hardware ran + short of receive descriptors and had no place to transfer received data. + The driver will reset the hardware and continue.</dd> + <dt>ath%d: unable to reset hardware; hal status %u</dt> + <dd>The Atheros Hardware Access Layer was unable to reset the hardware as + requested. The status code is explained in the HAL include file + <span class="Pa">sys/dev/ath/ath_hal/ah.h</span>. This should not + happen.</dd> + <dt>ath%d: unable to start recv logic</dt> + <dd>The driver was unable to restart frame reception. This should not + happen.</dd> + <dt>ath%d: device timeout</dt> + <dd>A frame dispatched to the hardware for transmission did not complete in + time. The driver will reset the hardware and continue. This should not + happen.</dd> + <dt>ath%d: bogus xmit rate 0x%x</dt> + <dd>An invalid transmit rate was specified for an outgoing frame. The frame is + discarded. This should not happen.</dd> + <dt>ath%d: ath_chan_set: unable to reset channel %u (%u MHz)</dt> + <dd>The Atheros Hardware Access Layer was unable to reset the hardware when + switching channels during scanning. This should not happen.</dd> + <dt>ath%d: failed to enable memory mapping</dt> + <dd>The driver was unable to enable memory-mapped I/O to the PCI device + registers. This should not happen.</dd> + <dt>ath%d: failed to enable bus mastering</dt> + <dd>The driver was unable to enable the device as a PCI bus master for doing + DMA. This should not happen.</dd> + <dt>ath%d: cannot map register space</dt> + <dd>The driver was unable to map the device registers into the host address + space. This should not happen.</dd> + <dt>ath%d: could not map interrupt</dt> + <dd>The driver was unable to allocate an IRQ for the device interrupt. This + should not happen.</dd> + <dt>ath%d: could not establish interrupt</dt> + <dd>The driver was unable to install the device interrupt handler. This should + not happen.</dd> +</dl> +</section> +<section class="Sh"> +<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE + ALSO</a></h1> +<p class="Pp"><a class="Xr">ath_hal(4)</a>, <a class="Xr">cardbus(4)</a>, + <a class="Xr">intro(4)</a>, <a class="Xr">wlan(4)</a>, + <a class="Xr">wlan_ccmp(4)</a>, <a class="Xr">wlan_tkip(4)</a>, + <a class="Xr">wlan_wep(4)</a>, <a class="Xr">wlan_xauth(4)</a>, + <a class="Xr">hostapd(8)</a>, <a class="Xr">ifconfig(8)</a>, + <a class="Xr">wpa_supplicant(8)</a></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1> +<p class="Pp">The <code class="Nm">ath</code> device driver first appeared in + <span class="Ux">FreeBSD 5.2</span>.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="CAVEATS"><a class="permalink" href="#CAVEATS">CAVEATS</a></h1> +<p class="Pp">Revision A1 of the D-LINK DWL-G520 and DWL-G650 are based on an + Intersil PrismGT chip and are not supported by this driver.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="BUGS"><a class="permalink" href="#BUGS">BUGS</a></h1> +<p class="Pp">The driver does supports optional station mode power-save + operation.</p> +<p class="Pp">The AR5210 can only do WEP in hardware; consequently hardware + assisted WEP is disabled in order to allow software implementations of TKIP + and CCMP to function. Hardware WEP can be re-enabled by modifying the + driver.</p> +</section> +</div> +<table class="foot"> + <tr> + <td class="foot-date">August 7, 2023</td> + <td class="foot-os">FreeBSD 15.0</td> + </tr> +</table> |