Update ath.4 and ath_hal.4 manual pages from FreeBSD.
authorSascha Wildner <saw@online.de>
Fri, 3 Jan 2014 01:55:53 +0000 (02:55 +0100)
committerSascha Wildner <saw@online.de>
Fri, 3 Jan 2014 01:55:53 +0000 (02:55 +0100)
share/man/man4/ath.4
share/man/man4/ath_hal.4

index d6dc601..1487536 100644 (file)
@@ -26,9 +26,9 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 .\" THE POSSIBILITY OF SUCH DAMAGES.
 .\"
-.\" $FreeBSD: src/share/man/man4/ath.4,v 1.52 2010/03/21 17:53:54 sam Exp $
+.\" $FreeBSD: head/share/man/man4/ath.4 235317 2012-05-12 03:25:46Z gjb $
 .\"
-.Dd April 27, 2010
+.Dd January 2, 2014
 .Dt ATH 4
 .Os
 .Sh NAME
@@ -63,6 +63,19 @@ a PCI and/or CardBus interface are supported.
 Supported features include 802.11 and 802.3 frames, power management, BSS,
 IBSS, MBSS, TDMA, and host-based access point operation modes.
 All host/device interaction is via DMA.
+.\".Pp
+.\"Please note that from FreeBSD-9.0, the
+.\".Nm
+.\"driver does not include the PCI/PCIe bus glue.
+.\"The same driver supports multiple underlying bus types, including PCI/PCIe,
+.\"but also embedded (AHB) and USB in the future.
+.\".Pp
+.\"To enable use for PCI/PCIe systems, see the
+.\".Xr ath_pci 4
+.\"driver.
+.\"For embedded systems which use the AHB to connect the wireless MAC, see the
+.\".Xr ath_ahb 4
+.\"driver.
 .Pp
 The
 .Nm
@@ -80,8 +93,8 @@ with transmit speeds appropriate to each.
 AR5416-class devices are capable of 802.11n operation
 but are supported only in legacy modes (802.11a, 11b, 11g).
 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
+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.)
@@ -141,9 +154,6 @@ The
 .Nm
 driver supports all Atheros Cardbus and PCI cards,
 except those that are based on the AR5005VL chipset.
-.Pp
-A list of cards that are supported can be found at
-.Pa http://customerproducts.atheros.com/customerproducts/default.asp .
 .Sh EXAMPLES
 Join a specific BSS network with WEP encryption:
 .Bd -literal -offset indent
@@ -198,7 +208,7 @@ ifconfig wlan0 create wlandev ath0 wlanmode tdma \e
 The Atheros Hardware Access Layer was unable to configure the hardware
 as requested.
 The status code is explained in the HAL include file
-.Pa sys/contrib/dev/ath/ah.h .
+.Pa sys/dev/netif/ath/ath_hal/ah.h .
 .It "ath%d: failed to allocate descriptors: %d"
 The driver was unable to allocate contiguous memory for the transmit
 and receive descriptors.
@@ -208,8 +218,8 @@ The request to the HAL to set up 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 set up the transmit queue for 802.11 beacon
-frames failed.
+The request to the HAL to set up 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.
@@ -227,7 +237,7 @@ The driver will reset the hardware and continue.
 The Atheros Hardware Access Layer was unable to reset the hardware
 as requested.
 The status code is explained in the HAL include file
-.Pa sys/contrib/dev/ath/ah.h .
+.Pa sys/dev/netif/ath/ath_hal/ah.h .
 This should not happen.
 .It "ath%d: unable to start recv logic"
 The driver was unable to restart frame reception.
index bba3b28..515e6cf 100644 (file)
@@ -26,9 +26,9 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 .\" THE POSSIBILITY OF SUCH DAMAGES.
 .\"
-.\" $FreeBSD: src/share/man/man4/ath_hal.4,v 1.13 2009/03/25 21:20:19 sam Exp $
+.\" $FreeBSD: head/share/man/man4/ath_hal.4 253552 2013-07-22 19:32:42Z pluknet $
 .\"
-.Dd April 27, 2010
+.Dd January 2, 2014
 .Dt ATH_HAL 4
 .Os
 .Sh NAME
 .\".Cd "device ath_ar5312"
 .\".Cd "device ath_rf2136"
 .\".Cd "device ath_rf2137"
+.\".Cd "device ath_ar9130"
 .\".Cd "device ath_ar9160"
 .\".Cd "device ath_ar9280"
+.\".Cd "device ath_ar9285"
+.\".Cd "device ath_ar9287"
+.\".Cd "device ath_ar9300"
 .\".Cd "options AH_SUPPORT_AR5416"
 .Sh DESCRIPTION
 The hal provides hardware support for wireless network adapters based on
 the Atheros AR5210, AR5211, AR5212, AR5213, AR2413, AR2417, AR2425,
-AR5413, AR5416, AR5418, AR5424, AR9160, and AR9280 chips (and companion
-RF/baseband parts).
+AR5413, AR5416, AR5418, AR5424, AR9160, AR9220, AR9280, AR9285, AR9287,
+AR9380, AR9390, AR9580, AR9590, AR9562 and QCA9565
+chips (and companion RF/baseband parts).
 This code is part of the
 .Xr ath 4
 driver but configured separately to allow fine-grained control
@@ -66,13 +71,15 @@ over the set of chips supported.
 Selecting
 .Nm
 enables support for all PCI and Cardbus devices.
-Note this includes AR5416, AR9160, and AR9280 devices and
-must be accompanied by the
+Note this includes AR5416, AR5418, AR9130, AR9160, AR9220, AR9280, AR9285
+and AR9287 devices and must be accompanied by the
 AH_SUPPORT_AR5416
 option to enable the extended hardware descriptor format used by
 AR5416 and later devices.
 .Pp
-Devices supported come in either Cardbus or mini-PCI packages.
+Some devices come in Cardbus/MiniPCI/PCI format.
+Others (for example AR2413, AR2427, AR5418, AR9280, AR9285, AR9287) come in
+PCIe, Mini-PCIe or ExpressCard format.
 .Pp
 Historically this code has been released in a binary-only form
 and packaged as a separate module.
@@ -109,7 +116,9 @@ module:
 .It "Netgear WAG311    AR5212  PCI     a/b/g"
 .It "Netgear WAB501    AR5211  CardBus a/b"
 .It "Netgear WAG511    AR5212  CardBus a/b/g"
-.It "Netgear WG311     AR5212  PCI     b/g"
+.It "Netgear WG311 (aka WG311v1)       AR5212  PCI     b/g"
+.It "Netgear WG311v2   AR5212  PCI     b/g"
+.It "Netgear WG311T    AR5212  PCI     b/g"
 .It "Netgear WG511T    AR5212  CardBus b/g"
 .It "Orinoco 8480      AR5212  CardBus a/b/g"
 .It "Orinoco 8470WD    AR5212  CardBus a/b/g"
@@ -121,10 +130,8 @@ module:
 .It "Sony PCWA-C300S   AR5212  Cardbus b/g"
 .It "Sony PCWA-C500    AR5210  Cardbus a"
 .It "3Com 3CRPAG175    AR5212  CardBus a/b/g"
+.It "TP-LINK TL-WDN4800        AR9380  PCIe    a/b/g/n"
 .El
-.Pp
-An up to date list can be found at
-.Pa http://customerproducts.atheros.com/customerproducts .
 .Sh SEE ALSO
 .Xr ath 4
 .Sh HISTORY