diff options
| -rw-r--r-- | share/man/man4/Makefile | 4 | ||||
| -rw-r--r-- | share/man/man4/ath.4 | 290 |
2 files changed, 292 insertions, 2 deletions
diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile index ffc3bfcf3c0..eb196d6576f 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -1,8 +1,8 @@ -# $OpenBSD: Makefile,v 1.278 2004/10/20 12:50:48 deraadt Exp $ +# $OpenBSD: Makefile,v 1.279 2004/11/07 02:44:24 deraadt Exp $ MAN= aac.4 ac97.4 acphy.4 addcom.4 adv.4 aha.4 ahb.4 ahc.4 ahd.4 \ aic.4 amdpm.4 ami.4 amphy.4 an.4 aria.4 ast.4 atalk.4 \ - atapiscsi.4 atw.4 audio.4 aue.4 auich.4 autri.4 auvia.4 awi.4 \ + atapiscsi.4 ath.4 atw.4 audio.4 aue.4 auich.4 autri.4 auvia.4 awi.4 \ axe.4 az.4 bce.4 bge.4 bha.4 bio.4 bktr.4 bmtphy.4 boca.4 bpf.4 \ brgphy.4 bridge.4 cac.4 cardbus.4 carp.4 ccd.4 cd.4 \ cdce.4 ch.4 clcs.4 clct.4 cmpci.4 cnw.4 com.4 \ diff --git a/share/man/man4/ath.4 b/share/man/man4/ath.4 new file mode 100644 index 00000000000..3f5af55c833 --- /dev/null +++ b/share/man/man4/ath.4 @@ -0,0 +1,290 @@ +.\" $NetBSD: ath.4,v 1.5 2004/07/03 16:58:18 mycroft Exp $ +.\" +.\" Copyright (c) 2002, 2003 Sam Leffler, Errno Consulting +.\" All rights reserved. +.\"" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer, +.\" without modification. +.\" 2. Redistributions in binary form must reproduce at minimum a disclaimer +.\" similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any +.\" redistribution must be conditioned upon including a substantially +.\" similar Disclaimer requirement for further binary redistribution. +.\" 3. Neither the names of the above-listed copyright holders nor the names +.\" of any contributors may be used to endorse or promote products derived +.\" from this software without specific prior written permission. +.\" +.\" NO WARRANTY +.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +.\" LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY +.\" AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL +.\" THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, +.\" OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER +.\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF +.\" THE POSSIBILITY OF SUCH DAMAGES. +.\" +.\" +.\" Note: This man page was taken by Perry Metzger almost entirely +.\" from the "ath" and "ath_hal" man pages in FreeBSD. I claim no +.\" copyright because there was nearly no original work performed in +.\" doing so. Maintainers should check the FreeBSD originals for +.\" updates against the following two revisions and incorporate them +.\" if needed: +.\" +.\" $FreeBSD: /repoman/r/ncvs/src/share/man/man4/ath.4,v 1.16 2004/02/18 08:30:08 maxim Exp $ +.\" parts from $FreeBSD: /repoman/r/ncvs/src/share/man/man4/ath_hal.4,v 1.7 2004/01/07 20:49:51 blackend Exp $ +.\" +.Dd February 27, 2004 +.Dt ATH 4 +.Os +.Sh NAME +.Nm ath +.Nd Atheros IEEE 802.11 driver +.Sh SYNOPSIS +.Cd "ath* at pci? dev ? function ?" +.Cd "ath* at cardbus? dev ? function ?" +.Sh DESCRIPTION +The +.Nm +driver provides support for wireless network adapters based on +the Atheros AR5210, AR5211, and AR5212 chips. +Chip-specific support is provided by the Atheros Hardware Access Layer +(HAL), which is currently available only in binary form for selected +architectures. +.Pp +Supported features include 802.11 and 802.3 frames, power management, BSS, +IBSS, and host-based access point operation modes. +All host/device interaction is via DMA. +.Pp +The +.Nm +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 +depending on your hardware. +.Pp +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. +.Pp +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. +.Pp +AR5212-based devices support 802.11a, 802.11b, and 802.11g operation +with transmit speeds appropriate to each. +.Pp +All chips also support an Atheros Turbo Mode (TM) that operates in the +802.11a frequency range with 2x the transmit speeds. +(This mode is, however, only interoperable with other Atheros-based devices.) +.Pp +The actual transmit speed used is dependent on signal quality and the +.Dq rate control +algorithm employed by the driver. +All chips support WEP encryption. +AR5211 and AR5212 support the AES, TKIP, and Michael cryptographic +operations required for WPA but at this time the driver does not support them. +To enable encryption, use +.Xr ifconfig 8 . +.Pp +By default, the +.Nm +driver configures the card for BSS operation (aka infrastructure +mode). +This mode requires the use of an access point (base station). +.Pp +The +.Nm +driver also supports the standard IBSS point-to-point mode +where stations can communicate amongst themselves without the +aid of an access point. +.Pp +The driver may also be configured to operate in hostap mode. +In this mode a host may function as an access point (base station). +Access points are different than operating in IBSS mode. +They operate in BSS mode. +They allow for easier roaming and bridge all ethernet traffic such +that machines connected via an access point appear to be on the local +ethernet segment. +.Pp +For more information on configuring this device, see +.Xr ifconfig 8 . +.Pp +Devices supported by the +.Nm +driver come in either CardBus or mini-PCI packages. +Wireless cards in CardBus slots may be inserted and ejected on the fly. +.Pp +The following cards are among those supported by the +.Nm +driver: +.Pp +.Bl -column -compact "Samsung SWL-5200N" "AR5212" "CardBus" "a/b/g" +.Em "Card Chip Bus Standard" +Aztech WL830PC AR5212 CardBus b/g +D-Link DWL-A650 AR5210 CardBus a +D-Link DWL-AB650 AR5211 CardBus a/b +D-Link DWL-A520 AR5210 PCI a +D-Link DWL-AG520 AR5212 PCI a/b/g +D-Link DWL-AG650 AR5212 CardBus a/b/g +D-Link DWL-G520 AR5212 PCI b/g +D-Link DWL-G650B AR5212 CardBus b/g +Elecom LD-WL54AG AR5212 CardBus a/b/g +Elecom LD-WL54 AR5211 CardBus a +Fujitsu E5454 AR5212 CardBus a/b/g +Fujitsu FMV-JW481 AR5212 CardBus a/b/g +Fujitsu E5454 AR5212 CardBus a/b/g +HP NC4000 AR5212 PCI a/b/g +I/O Data WN-AB AR5212 CardBus a/b +I/O Data WN-AG AR5212 CardBus a/b/g +I/O Data WN-A54 AR5212 CardBus a +Linksys WMP55AG AR5212 PCI a/b/g +Linksys WPC51AB AR5211 CardBus a/b +Linksys WPC55AG AR5212 CardBus a/b/g +NEC PA-WL/54AG AR5212 CardBus a/b/g +Netgear WAG311 AR5212 PCI a/b/g +Netgear WAB501 AR5211 CardBus a/b +Netgear WAG511 AR5212 CardBus a/b/g +Netgear WG311 AR5212 PCI b/g +Netgear WG511T AR5212 CardBus b/g +Orinoco 8480 AR5212 CardBus a/b/g +Orinoco 8470WD AR5212 CardBus a/b/g +Proxim Skyline 4030 AR5210 CardBus a +Proxim Skyline 4032 AR5210 PCI a +Samsung SWL-5200N AR5212 CardBus a/b/g +SMC SMC2735W AR5210 CardBus a +Sony PCWA-C700 AR5212 CardBus a/b +Sony PCWA-C300S AR5212 CardBus b/g +Sony PCWA-C500 AR5210 CardBus a +3Com 3CRPAG175 AR5212 CardBus a/b/g +.El +.Pp +An up to date list can be found at +.Pa http://customerproducts.atheros.com/customerproducts . +.Sh DIAGNOSTICS +.Bl -diag +.It "ath%d: unable to attach hardware; HAL status %u" +The Atheros Hardware Access Layer was unable to configure the hardware +as requested. +The status code is explained in the HAL include file +.Pa contrib/sys/dev/ic/athhal.h . +.It "ath%d: failed to allocate descriptors: %d" +The driver was unable to allocate contiguous memory for the transmit +and receive descriptors. +This usually indicates system memory is scarce and/or fragmented. +.It "ath%d: unable to setup a data xmit queue!" +The request to the HAL to setup the transmit queue for normal +data frames failed. +This should not happen. +.It "ath%d: unable to setup a beacon xmit queue!" +The request to the HAL to setup the transmit queue for 802.11 beacon frames +failed. +This should not happen. +.It "ath%d: 802.11 address: %s" +The MAC address programmed in the EEPROM is displayed. +.It "ath%d: hardware error; resetting" +An unrecoverable error in the hardware occurred. +Errors of this sort include unrecoverable DMA errors. +The driver will reset the hardware and continue. +.It "ath%d: rx FIFO overrun; resetting" +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. +.It "ath%d: unable to reset hardware; hal status %u" +The Atheros Hardware Access Layer was unable to reset the hardware +as requested. +The status code is explained in the HAL include file +.Pa contrib/sys/dev/ic/athhal.h . +This should not happen. +.It "ath%d: unable to start recv logic" +The driver was unable to restart frame reception. +This should not happen. +.It "ath%d: device timeout" +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. +.It "ath%d: bogus xmit rate 0x%x" +An invalid transmit rate was specified for an outgoing frame. +The frame is discarded. +This should not happen. +.It "ath%d: ath_chan_set: unable to reset channel %u (%u Mhz)" +The Atheros Hardware Access Layer was unable to reset the hardware +when switching channels during scanning. +This should not happen. +.It "ath%d: unable to allocate channel table" +The driver was unable to allocate memory for the table used to hold +the set of available channels. +.It "ath%d: unable to collect channel list from hal" +A problem occurred while querying the HAL to find the set of available +channels for the device. +This should not happen. +.It "ath%d: %s: %dM -\*[Gt] %dM (%d ok, %d err, %d retr)" +The driver's rate control algorithm changed the current rate for transmitting +frames. +This message is temporarily enabled for normal use to help in diagnosing +and improving the rate control algorithm. +The message indicates the new and old transmit rates and the statistics +it used to decide on this change. +.It "ath%d: failed to enable memory mapping" +The driver was unable to enable memory-mapped I/O to the PCI device registers. +This should not happen. +.It "ath%d: failed to enable bus mastering" +The driver was unable to enable the device as a PCI bus master for doing DMA. +This should not happen. +.It "ath%d: cannot map register space" +The driver was unable to map the device registers into the host address space. +This should not happen. +.It "ath%d: could not map interrupt" +The driver was unable to allocate an IRQ for the device interrupt. +This should not happen. +.It "ath%d: could not establish interrupt" +The driver was unable to install the device interrupt handler. +This should not happen. +.El +.Sh SEE ALSO +.Xr arp 4 , +.Xr cardbus 4 , +.Xr ifmedia 4 , +.Xr netintro 4 , +.Xr pci 4 , +.Xr ifconfig 8 +.Sh AUTHORS +The +.Nm +driver was written by +.An Sam Leffler , +and was ported to +.Ox +by +.An Reyk Floeter . +.Sh CAVEATS +Different regulatory domains have different default channels for adhoc +mode. +See +.Xr ifconfig 8 +for information on how to change the channel. +Different regulatory domains may not be able to communicate with each +other with 802.11a as different regulatory domains do not necessarily +have overlapping channels. +.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. +.Pp +.Sh BUGS +Performance in lossy environments is suboptimal. +The algorithm used to select the rate for transmitted packets is +very simplistic. +There is no software retransmit; only hardware retransmit is used. +Contributors are encouraged to replace the existing rate control algorithm +with a better one (hint: all the information needed is available to the driver). +.Pp +The driver does not fully enable power-save operation of the chip; +consequently power use is suboptimal. |