xref: /openbsd-src/share/man/man4/acx.4 (revision 91f110e064cd7c194e59e019b83bb7496c1c84d4)
1.\"	$OpenBSD: acx.4,v 1.45 2013/02/14 07:40:42 jmc Exp $
2.\"
3.\" Copyright (c) 2006 Theo de Raadt.
4.\" Copyright (c) 2006 The DragonFly Project.  All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\"
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in
14.\"    the documentation and/or other materials provided with the
15.\"    distribution.
16.\" 3. Neither the name of The DragonFly Project nor the names of its
17.\"    contributors may be used to endorse or promote products derived
18.\"    from this software without specific, prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
24.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
26.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
30.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31.\" SUCH DAMAGE.
32.\"
33.Dd $Mdocdate: February 14 2013 $
34.Dt ACX 4
35.Os
36.Sh NAME
37.Nm acx
38.Nd TI ACX100/ACX111 IEEE 802.11a/b/g wireless network device
39.Sh SYNOPSIS
40.Cd "acx* at cardbus?"
41.Cd "acx* at pci?"
42.Sh DESCRIPTION
43The
44.Nm
45driver provides support for TI TNETW1100/TNETW1100B (ACX100) and
46TNETW1130 (ACX111) based PCI/CardBus network adapters.
47.Pp
48The ACX100A and ACX100B are first generation 802.11b devices
49from TI.
50The ACX111 is a second generation device which supports 802.11b/g
51and in some cases 802.11a.
52.Pp
53These are the modes the
54.Nm
55driver can operate in:
56.Bl -tag -width "IBSS-masterXX"
57.It BSS mode
58Also known as
59.Em infrastructure
60mode, this is used when associating with an access point, through
61which all traffic passes.
62This mode is the default.
63.It IBSS mode
64Also known as
65.Em IEEE ad-hoc
66mode or
67.Em peer-to-peer
68mode.
69This is the standardized method of operating without an access point.
70Stations associate with a service set.
71However, actual connections between stations are peer-to-peer.
72.It Host AP
73In this mode the driver acts as an access point (base station)
74for other cards.
75.It monitor mode
76In this mode the driver is able to receive packets without
77associating with an access point.
78This disables the internal receive filter and enables the card to
79capture packets from networks which it wouldn't normally have access to,
80or to scan for access points.
81.El
82.Pp
83The
84.Nm
85driver can be configured to use
86Wired Equivalent Privacy (WEP)
87in software for ACX111
88or in hardware for ACX100.
89It is strongly recommended that WEP
90not be used as the sole mechanism
91to secure wireless communication,
92due to serious weaknesses in it.
93.Pp
94The transmit speed is user-selectable or can be adapted automatically by the
95driver depending on the number of hardware transmission retries.
96.Pp
97The
98.Nm
99driver can be configured at runtime with
100.Xr ifconfig 8
101or on boot with
102.Xr hostname.if 5 .
103.Sh FILES
104The driver needs a set of firmware files which are loaded when
105an interface is brought up:
106.Pp
107.Bl -tag -width Ds -offset indent -compact
108.It Pa /etc/firmware/tiacx100
109.It Pa /etc/firmware/tiacx100r0D
110.It Pa /etc/firmware/tiacx100r11
111.It Pa /etc/firmware/tiacx111
112.It Pa /etc/firmware/tiacx111c16
113.It Pa /etc/firmware/tiacx111r16
114.El
115.Pp
116These firmware files are not free because TI refuses
117to grant distribution rights.
118In fact they have rebuffed thousands
119of attempts to start a dialogue on this issue.
120As a result, even though
121.Ox
122includes the driver, the firmware files cannot be included and
123users have to download these files on their own.
124.Pp
125A prepackaged version of the firmware can be installed using
126.Xr fw_update 1 .
127.Sh HARDWARE
128The following cards are among those supported by the
129.Nm
130driver:
131.Bl -column "Microcom Travelcard" "ACX111" "CardBus" "Standard" -offset 6n
132.It Em Card Ta Em Chip Ta Em Bus Ta Em Standard
133.It "D-Link DWL-520+" Ta ACX100 Ta PCI Ta b
134.It "D-Link DWL-650+" Ta ACX100 Ta CardBus Ta b
135.It "D-Link DWL-G520+" Ta ACX111 Ta PCI Ta b/g
136.It "D-Link DWL-G630+" Ta ACX111 Ta CardBus Ta b/g
137.It "D-Link DWL-G650+" Ta ACX111 Ta CardBus Ta b/g
138.It "Digitus DN-7001G" Ta ACX111 Ta CardBus Ta b/g
139.It "Ergenic ERG WL-003" Ta ACX100 Ta CardBus Ta b
140.It "Hamlet HNWP254" Ta ACX111 Ta CardBus Ta b/g
141.It "Hawking HWP54G" Ta ACX111 Ta PCI Ta b/g
142.It "Linksys WPC54Gv2" Ta ACX111 Ta CardBus Ta b/g
143.It "Microcom Travelcard" Ta ACX111 Ta CardBus Ta b/g
144.It "Netgear WG311v2" Ta ACX111 Ta PCI Ta b/g
145.It "Sceptre SC254W+" Ta ACX111 Ta CardBus Ta b/g
146.It "Tornado/ADT 211g" Ta ACX111 Ta PCI Ta b/g
147.It "USR USR5410" Ta ACX111 Ta CardBus Ta b/g
148.It "USR USR5416" Ta ACX111 Ta PCI Ta b/g
149.It "ZyXEL G-160" Ta ACX111 Ta CardBus Ta b/g
150.It "ZyXEL G-360 EE" Ta ACX111 Ta PCI Ta b/g
151.El
152.Sh EXAMPLES
153The following example scans for available networks:
154.Pp
155.Dl # ifconfig acx0 scan
156.Pp
157The following
158.Xr hostname.if 5
159example configures acx0 to join network
160.Dq mynwid ,
161using WEP key
162.Dq mywepkey ,
163obtaining an IP address using DHCP:
164.Bd -literal -offset indent
165nwid mynwid
166nwkey mywepkey
167dhcp
168.Ed
169.Pp
170The following
171.Xr hostname.if 5
172example creates a host-based access point on boot:
173.Bd -literal -offset indent
174inet 192.168.1.1 255.255.255.0
175mediaopt hostap
176nwid mynwid
177nwkey mywepkey
178.Ed
179.Sh SEE ALSO
180.Xr arp 4 ,
181.Xr cardbus 4 ,
182.Xr ifmedia 4 ,
183.Xr intro 4 ,
184.Xr netintro 4 ,
185.Xr pci 4 ,
186.Xr hostname.if 5 ,
187.Xr hostapd 8 ,
188.Xr ifconfig 8
189.Sh HISTORY
190The
191.Nm
192driver first appeared in
193.Ox 4.0 .
194.Sh AUTHORS
195.An -nosplit
196The
197.Nm
198driver was written by
199.An Sepherosa Ziehau .
200The manual page was written by
201.An Sascha Wildner .
202Both are based on the
203.Lk http://wlan.kewl.org
204project team's original code.
205.Pp
206The hardware specification was reverse engineered by the good folks at
207.Lk http://acx100.sourceforge.net .
208Without them this driver would not have been possible.
209