Merge from vendor branch LESS:
[dragonfly.git] / share / man / man4 / acx.4
1 .\"
2 .\" Copyright (c) 2006 The DragonFly Project.  All rights reserved.
3 .\" 
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\"    notice, this list of conditions and the following disclaimer in
12 .\"    the documentation and/or other materials provided with the
13 .\"    distribution.
14 .\" 3. Neither the name of The DragonFly Project nor the names of its
15 .\"    contributors may be used to endorse or promote products derived
16 .\"    from this software without specific, prior written permission.
17 .\" 
18 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
21 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
22 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
23 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
24 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
28 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 .\" SUCH DAMAGE.
30 .\"
31 .\" $DragonFly: src/share/man/man4/acx.4,v 1.9 2007/09/16 19:06:26 swildner Exp $
32 .\"
33 .Dd September 15, 2007
34 .Dt ACX 4
35 .Os
36 .Sh NAME
37 .Nm acx
38 .Nd Texas Instruments ACX100/ACX111 IEEE 802.11a/b/g wireless network driver
39 .Sh SYNOPSIS
40 To compile this driver into the kernel, place the following lines in
41 your kernel configuration file:
42 .Bd -ragged -offset indent
43 .Cd "device acx"
44 .Cd "device wlan"
45 .Cd "device wlan_ratectl_onoe"
46 .Cd "device wlan_ratectl_amrr"
47 .Ed
48 .Pp
49 Alternatively, to load the driver as a module at boot time, place the
50 following line in
51 .Pa /boot/loader.conf :
52 .Bd -literal -offset indent
53 if_acx_load="YES"
54 .Ed
55 .Sh DESCRIPTION
56 The
57 .Nm
58 driver provides support for Texas Instruments TNETW1100/TNETW1100B (ACX100)
59 and TNETW1130 (ACX111) based PCI/CardBus network adapters.
60 .Pp
61 The ACX100A and ACX100B are first generation 802.11b devices
62 from TI.
63 The ACX111 is a second generation device which supports 802.11b/g
64 and in some cases 802.11a.
65 .Pp
66 By default, the
67 .Nm
68 driver configures the adapter for BSS operation (infrastructure mode).
69 This mode requires the use of an access point.
70 In addition, IBSS operation (adhoc mode) is also supported.
71 For more information on configuring this device, see
72 .Xr ifconfig 8 .
73 .Ss MIB Variables
74 The following per-interface variables are implemented in the
75 .Va hw.acx Ns Em X
76 branch of the
77 .Xr sysctl 3
78 MIB.
79 .Bl -tag -width ".Va msdu_lifetime"
80 .It Va msdu_lifetime
81 MSDU life time.
82 .El
83 .Sh HARDWARE
84 The following cards are among those supported by the
85 .Nm
86 driver:
87 .Pp
88 .Bl -column -compact "Microcom Travelcard" "ACX111" "CardBus" "a/b/g" -offset 6n
89 .Em "Card       Chip    Bus     Standard"
90 D-Link DWL-520+ ACX100  PCI     b
91 D-Link DWL-650+ ACX100  CardBus b
92 D-Link DWL-G520+        ACX111  PCI     b/g
93 D-Link DWL-G630+        ACX111  CardBus b/g
94 D-Link DWL-G650+        ACX111  CardBus b/g
95 Ergenic ERG WL-003      ACX100  CardBus b
96 Hamlet HNWP254  ACX111  CardBus b/g
97 Hawking HWP54G  ACX111  PCI     b/g
98 Linksys WPC54Gv2        ACX111  CardBus b/g
99 Microcom Travelcard     ACX111  CardBus b/g
100 Netgear WG311v2 ACX111  PCI     b/g
101 Sceptre SC254W+ ACX111  CardBus b/g
102 Tornado/ADT 211g        ACX111  PCI     b/g
103 USR USR5410     ACX111  CardBus b/g
104 USR USR5416     ACX111  PCI     b/g
105 ZyXEL G-160     ACX111  CardBus b/g
106 ZyXEL G-360 EE  ACX111  PCI     b/g
107 .El
108 .Sh FILES
109 The firmware for the adapter is not shipped with
110 .Dx
111 and must be obtained separately.
112 An archive with firmware files that are known to work can be found at:
113 .Bd -literal -offset indent
114 http://leaf.dragonflybsd.org/~sephe/acx/acx_fw.tbz
115 .Ed
116 .Pp
117 See
118 .Xr acxcontrol 8
119 for more information on loading firmware.
120 .Sh SEE ALSO
121 .Xr arp 4 ,
122 .Xr cardbus 4 ,
123 .Xr ifmedia 4 ,
124 .Xr pci 4 ,
125 .Xr wlan_ratectl 4 ,
126 .Xr acxcontrol 8 ,
127 .Xr hostapd 8 ,
128 .Xr ifconfig 8 ,
129 .Xr sysctl 8 ,
130 .Xr wpa_supplicant 8
131 .Sh HISTORY
132 The
133 .Nm
134 driver first appeared in
135 .Dx 1.5 .
136 .Sh AUTHORS
137 .An -nosplit
138 The
139 .Nm
140 driver was written by
141 .An Sepherosa Ziehau .
142 The manual page was written by
143 .An Sascha Wildner .
144 Both are based on the
145 .Pa http://wlan.kewl.org
146 project team's original code.
147 .Pp
148 The hardware specification was reverse engineered by the good folks at
149 .Pa http://acx100.sourceforge.net .
150 Without them this driver would not have been possible.