xref: /NextBSD/share/man/man4/an.4 (revision e5d2f8730c92c4abb6de986ec4e1f39a242b9868)
1.\" Copyright (c) 1997, 1998, 1999
2.\"	Bill Paul <wpaul@ee.columbia.edu>. 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.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by Bill Paul.
15.\" 4. Neither the name of the author nor the names of any co-contributors
16.\"    may be used to endorse or promote products derived from this software
17.\"   without specific prior written permission.
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
20.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22.\" ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
23.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
29.\" THE POSSIBILITY OF SUCH DAMAGE.
30.\"
31.\" $FreeBSD$
32.\"
33.Dd July 16, 2005
34.Dt AN 4
35.Os
36.Sh NAME
37.Nm an
38.Nd "Aironet Communications 4500/4800 wireless network adapter driver"
39.Sh SYNOPSIS
40To compile this driver into the kernel,
41place the following lines in your
42kernel configuration file:
43.Bd -ragged -offset indent
44.Cd "device an"
45.Cd "device wlan"
46.Ed
47.Pp
48Alternatively, to load the driver as a
49module at boot time, place the following line in
50.Xr loader.conf 5 :
51.Bd -literal -offset indent
52if_an_load="YES"
53.Ed
54.Sh DESCRIPTION
55The
56.Nm
57driver provides support for Aironet Communications 4500 and 4800
58wireless network adapters and variants, including the following:
59.Pp
60.Bl -bullet -compact -offset indent
61.It
62Aironet Communications 4500 and 4800 series
63.It
64Cisco Aironet 340 and 350 series
65.It
66Xircom Wireless Ethernet Adapter
67.El
68.Pp
69Support for these devices include the ISA, PCI and PCMCIA
70varieties.
71The Aironet 4500 series adapters operate at 1 and 2Mbps while
72the Aironet 4800 series and Cisco adapters can operate at 1, 2, 5.5 and 11Mbps.
73The ISA, PCI
74and PCMCIA devices are all based on the same core PCMCIA modules
75and all have the same programming interface, however unlike the
76Lucent WaveLAN/IEEE cards, the ISA and PCI cards appear to the
77host as normal ISA and PCI devices and do not require any PCCARD
78support.
79.Pp
80The PCMCIA Aironet cards require PC Card support, including the
81kernel
82.Xr pccard 4
83driver.
84ISA cards can either be configured to use ISA Plug and Play
85or to use a particular I/O address and IRQ
86by properly setting the DIP switches on the board.
87(The default
88switch setting is for Plug and Play.)
89The
90.Nm
91driver has Plug and Play support and will work in either configuration,
92however when using a hard-wired I/O address and IRQ, the driver
93configuration and the NIC's switch settings must agree.
94PCI cards
95require no switch settings of any kind and will be automatically
96probed and attached.
97.Pp
98All host/device interaction with the Aironet cards is via programmed I/O.
99The Aironet devices support 802.11 and 802.3 frames, power management,
100BSS (infrastructure) and IBSS (ad-hoc) operation modes.
101The
102.Nm
103driver encapsulates all IP and ARP traffic as 802.11 frames, however
104it can receive either 802.11 or 802.3 frames.
105Transmit speed is
106selectable between 1Mbps, 2Mbps, 5.5Mbps, 11Mbps or
107"auto" (the NIC automatically chooses the best speed).
108.Pp
109By default, the
110.Nm
111driver configures the Aironet card for infrastructure operation.
112.Pp
113For more information on configuring this device, see
114.Xr ifconfig 8 .
115.Sh DIAGNOSTICS
116.Bl -diag
117.It "an%d: init failed"
118The Aironet card failed to become ready after an initialization command was
119issued.
120.It "an%d: failed to allocate %d bytes on NIC"
121The driver was unable to allocate memory for transmit frames in the
122NIC's on-board RAM.
123.It "an%d: device timeout"
124The Aironet card failed to generate an interrupt to acknowledge a transmit
125command.
126.El
127.Sh SEE ALSO
128.Xr altq 4 ,
129.Xr arp 4 ,
130.Xr miibus 4 ,
131.Xr netintro 4 ,
132.Xr wlan 4 ,
133.Xr ancontrol 8 ,
134.Xr ifconfig 8
135.Sh HISTORY
136The
137.Nm
138device driver first appeared in
139.Fx 4.0 .
140.Sh AUTHORS
141The
142.Nm
143driver was written by
144.An Bill Paul Aq Mt wpaul@ee.columbia.edu .
145