an, awi, cue and kue don't use the miibus interface.
[dragonfly.git] / share / man / man4 / an.4
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: src/share/man/man4/an.4,v 1.5.2.6 2003/02/17 21:20:39 trhodes Exp $
32 .\" $DragonFly: src/share/man/man4/an.4,v 1.3 2006/11/18 10:00:19 swildner Exp $
33 .\"
34 .Dd September 10, 1999
35 .Dt AN 4
36 .Os
37 .Sh NAME
38 .Nm an
39 .Nd "Aironet Communications 4500/4800 wireless network adapter driver"
40 .Sh SYNOPSIS
41 .Cd "device an"
42 .Cd "device an0 at isa? port 0x140 irq 5"
43 .Sh DESCRIPTION
44 The
45 .Nm
46 driver provides support for Aironet Communications 4500 and 4800
47 wireless network adapters.
48 This includes the ISA, PCI and PCMCIA
49 varieties.
50 The 4500 series adapters operate at 1 and 2Mbps while
51 the 4800 series can operate at 1, 2, 5.5 and 11Mbps.
52 The ISA, PCI
53 and PCMCIA devices are all based on the same core PCMCIA modules
54 and all have the same programming interface, however unlike the
55 Lucent WaveLAN/IEEE cards, the ISA and PCI cards appear to the
56 host as normal ISA and PCI devices and do not require any PCCARD
57 support.
58 .Pp
59 The PCMCIA Aironet cards require pccard support, including the
60 kernel pccard driver support and the
61 .Xr pccardd 8
62 daemon.
63 ISA cards can either be configured to use ISA Plug and Play
64 or to use a particular I/O address and IRQ
65 by properly setting the DIP switches on the board.
66 (The default
67 switch setting is for plug and play.)
68 The
69 .Nm
70 driver has Plug and Play support and will work in either configuration,
71 however when using a hard-wired I/O address and IRQ, the driver
72 configuration and the NIC's switch settings must agree.
73 PCI cards
74 require no switch settings of any kind and will be automatically
75 probed and attached.
76 .Pp
77 All host/device interaction with the Aironet cards is via programmed I/O.
78 The Aironet devices support 802.11 and 802.3 frames, power management,
79 BSS (infrastructure) and IBSS (ad-hoc) operation modes.
80 The
81 .Nm
82 driver encapsulates all IP and ARP traffic as 802.11 frames, however
83 it can receive either 802.11 or 802.3 frames.
84 Transmit speed is
85 selectable between 1Mbps, 2Mbps, 5.5Mbps, 11Mbps or
86 "auto" (the NIC automatically chooses the best speed).
87 .Pp
88 By default, the
89 .Nm
90 driver configures the Aironet card for infrastructure operation.
91 .Pp
92 For more information on configuring this device, see
93 .Xr ifconfig 8
94 .Sh DIAGNOSTICS
95 .Bl -diag
96 .It "an%d: init failed"
97 The Aironet card failed to come ready after an initialization command was
98 issued.
99 .It "an%d: failed to allocate %d bytes on NIC"
100 The driver was unable to allocate memory for transmit frames in the
101 NIC's on-board RAM.
102 .It "an%d: device timeout"
103 The Aironet card failed to generate an interrupt to acknowledge a transmit
104 command.
105 .El
106 .Sh SEE ALSO
107 .Xr arp 4 ,
108 .Xr netintro 4 ,
109 .Xr ancontrol 8 ,
110 .Xr ifconfig 8
111 .Sh HISTORY
112 The
113 .Nm
114 device driver first appeared in
115 .Fx 4.0 .
116 .Sh AUTHORS
117 The
118 .Nm
119 driver was written by
120 .An Bill Paul Aq wpaul@ee.columbia.edu .