Sync ath.4 and ath_hal.4 manual pages with FreeBSD.
[dragonfly.git] / share / man / man4 / ath_hal.4
CommitLineData
193b341d 1.\"-
3b2190c0 2.\" Copyright (c) 2002-2009 Sam Leffler, Errno Consulting
193b341d 3.\" All rights reserved.
3b2190c0 4.\"
193b341d
SZ
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.
193b341d
SZ
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.\"
3b2190c0 29.\" $FreeBSD: src/share/man/man4/ath_hal.4,v 1.13 2009/03/25 21:20:19 sam Exp $
193b341d 30.\"
28b76601 31.Dd April 27, 2010
193b341d
SZ
32.Dt ATH_HAL 4
33.Os
34.Sh NAME
35.Nm ath_hal
36.Nd "Atheros Hardware Access Layer (HAL)"
37.Sh SYNOPSIS
54170488 38.Cd "device ath_hal"
28b76601
SW
39.Cd "options AH_SUPPORT_AR5416"
40or
41.Cd "device ath_ar5210"
42.Cd "device ath_ar5211"
43.Cd "device ath_ar5212"
44.Cd "device ath_rf2413"
45.Cd "device ath_rf2417"
46.Cd "device ath_rf2425"
47.Cd "device ath_rf5111"
48.Cd "device ath_rf5112"
49.Cd "device ath_rf5413"
50.Cd "device ath_ar5416"
51.\".Cd "device ath_ar5312"
52.\".Cd "device ath_rf2136"
53.\".Cd "device ath_rf2137"
54.Cd "device ath_ar9160"
55.Cd "device ath_ar9280"
56.Cd "options AH_SUPPORT_AR5416"
193b341d 57.Sh DESCRIPTION
28b76601 58The hal provides hardware support for wireless network adapters based on
3b2190c0
SW
59the Atheros AR5210, AR5211, AR5212, AR5213, AR2413, AR2417, AR2425,
60AR5413, AR5416, AR5418, AR5424, AR9160, and AR9280 chips (and companion
61RF/baseband parts).
28b76601 62This code is part of the
193b341d 63.Xr ath 4
28b76601
SW
64driver but configured separately to allow fine-grained control
65over the set of chips supported.
66Selecting
193b341d 67.Nm
28b76601
SW
68enables support for all PCI and Cardbus devices.
69Note this includes AR5416, AR9160, and AR9280 devices and
70must be accompanied by the
71AH_SUPPORT_AR5416
72option to enable the extended hardware descriptor format used by
73AR5416 and later devices.
74.Pp
75Devices supported come in either Cardbus or mini-PCI packages.
76.Pp
77Historically this code has been released in a binary-only form
78and packaged as a separate module.
79With the release of source code for the hal this is no longer true
80and the code is tightly integrated with the driver.
193b341d
SZ
81.Sh HARDWARE
82The following cards are among those supported by the
83.Nm
84module:
85.Pp
86.Bl -column -compact "Samsung SWL-5200N" "AR5212" "Cardbus" "a/b/g"
87.It Em "Card Chip Bus Standard"
88.It "Aztech WL830PC AR5212 CardBus b/g"
89.It "D-Link DWL-A650 AR5210 CardBus a"
90.It "D-Link DWL-AB650 AR5211 CardBus a/b"
91.It "D-Link DWL-A520 AR5210 PCI a"
92.It "D-Link DWL-AG520 AR5212 PCI a/b/g"
93.It "D-Link DWL-AG650 AR5212 CardBus a/b/g"
94.It "D-Link DWL-G520B AR5212 PCI b/g"
95.It "D-Link DWL-G650B AR5212 CardBus b/g"
96.It "Elecom LD-WL54AG AR5212 Cardbus a/b/g"
97.It "Elecom LD-WL54 AR5211 Cardbus a"
98.It "Fujitsu E5454 AR5212 Cardbus a/b/g"
99.It "Fujitsu FMV-JW481 AR5212 Cardbus a/b/g"
100.It "Fujitsu E5454 AR5212 Cardbus a/b/g"
101.It "HP NC4000 AR5212 PCI a/b/g"
102.It "I/O Data WN-AB AR5212 CardBus a/b"
103.It "I/O Data WN-AG AR5212 CardBus a/b/g"
104.It "I/O Data WN-A54 AR5212 CardBus a"
105.It "Linksys WMP55AG AR5212 PCI a/b/g"
106.It "Linksys WPC51AB AR5211 CardBus a/b"
107.It "Linksys WPC55AG AR5212 CardBus a/b/g"
108.It "NEC PA-WL/54AG AR5212 CardBus a/b/g"
109.It "Netgear WAG311 AR5212 PCI a/b/g"
110.It "Netgear WAB501 AR5211 CardBus a/b"
111.It "Netgear WAG511 AR5212 CardBus a/b/g"
112.It "Netgear WG311 AR5212 PCI b/g"
113.It "Netgear WG511T AR5212 CardBus b/g"
114.It "Orinoco 8480 AR5212 CardBus a/b/g"
115.It "Orinoco 8470WD AR5212 CardBus a/b/g"
116.It "Proxim Skyline 4030 AR5210 CardBus a"
117.It "Proxim Skyline 4032 AR5210 PCI a"
118.It "Samsung SWL-5200N AR5212 CardBus a/b/g"
119.It "SMC SMC2735W AR5210 CardBus a"
120.It "Sony PCWA-C700 AR5212 Cardbus a/b"
121.It "Sony PCWA-C300S AR5212 Cardbus b/g"
122.It "Sony PCWA-C500 AR5210 Cardbus a"
123.It "3Com 3CRPAG175 AR5212 CardBus a/b/g"
124.El
125.Pp
126An up to date list can be found at
193b341d
SZ
127.Pa http://customerproducts.atheros.com/customerproducts .
128.Sh SEE ALSO
129.Xr ath 4
130.Sh HISTORY
131The
132.Nm
133module first appeared in
134.Fx 5.2
135and was imported into
136.Dx 1.5 .
193b341d
SZ
137.Sh BUGS
138See
139.Xr ath 4
140for known bugs.