No empty .Rs/.Re
[netbsd-mini2440.git] / share / man / man4 / awi.4
blobff18a3e46087deea50f016d2576119702c1fbb29
1 .\"     $NetBSD: awi.4,v 1.26 2006/01/12 21:05:18 wiz Exp $
2 .\"
3 .\" Copyright (c) 1999,2000,2001 The NetBSD Foundation, Inc.
4 .\" All rights reserved.
5 .\"
6 .\" This code is derived from software contributed to The NetBSD Foundation
7 .\" by Bill Sommerfeld
8 .\"
9 .\" Redistribution and use in source and binary forms, with or without
10 .\" modification, are permitted provided that the following conditions
11 .\" are met:
12 .\" 1. Redistributions of source code must retain the above copyright
13 .\"    notice, this list of conditions and the following disclaimer.
14 .\" 2. Redistributions in binary form must reproduce the above copyright
15 .\"    notice, this list of conditions and the following disclaimer in the
16 .\"    documentation and/or other materials provided with the distribution.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 .\" POSSIBILITY OF SUCH DAMAGE.
29 .Dd January 2, 2006
30 .Dt AWI 4
31 .Os
32 .Sh NAME
33 .Nm awi
34 .Nd
35 AMD PCnetMobile IEEE 802.11 PCMCIA wireless network driver
36 .Sh SYNOPSIS
37 .Cd "awi*     at pcmcia? function ?"
38 .Sh DESCRIPTION
39 The
40 .Nm
41 driver supports various IEEE 802.11 wireless cards
42 that run AMD PCnetMobile firmware based on the AMD 79c930 controller
43 with the Intersil (formerly Harris) PRISM radio chipset.
44 It provides access to 32kb of memory shared between the controller
45 and the host.
46 All host/device interaction is accomplished via this shared memory, which
47 can be accessed either via PCMCIA or I/O memory spaces.
48 The
49 .Nm
50 driver encapsulates all IP and ARP traffic in 802.11 frames.
51 .Pp
52 The driver works both in infrastructure mode and in ad-hoc (independent
53 BSS) mode.
54 .Pp
55 In infrastructure mode, it communicates with an Access Point,
56 which serves as a link-layer bridge between an Ethernet segment and
57 the wireless network.
58 An access point also provides roaming capability,
59 which allows a wireless node to move between access points.
60 .Pp
61 In ad-hoc mode, the device communicates peer to peer.
62 Although it is more efficient to communicate between wireless nodes,
63 the coverage is limited spatially due to the lack of roaming capability.
64 .Pp
65 In addition to these two modes in the IEEE 802.11 specification, the
66 .Nm
67 driver also supports a variant of ad-hoc mode outside of the spec for
68 DS radio cards.
69 This makes it possible to communicate with the WaveLAN ad-hoc mode of
70 .Xr wi 4
71 driver.
72 The NWID has no effect in this mode.
73 .Pp
74 Another mode added to the
75 .Nm
76 driver can be used with old Melco access points with 2Mbps cards.
77 This mode actually uses the IEEE 802.11 ad-hoc mode with encapsulation of
78 raw Ethernet packets (including headers) in 802.11 frames.
79 .Pp
80 For more information on configuring this device, see
81 .Xr ifconfig 8
82 and
83 .Xr ifmedia 4 .
84 .Sh HARDWARE
85 Cards supported by the
86 .Nm
87 driver include:
88 .Pp
89 .Bl -tag -width BayStack_650x -offset indent -compact
90 .It BayStack 650
91 1Mbps Frequency Hopping PCCARD adapter
92 .It BayStack 660
93 2Mbps Direct Sequence PCCARD adapter
94 .It Icom SL-200
95 2Mbps Direct Sequence PCCARD adapter
96 .It Melco WLI-PCM
97 2Mbps Direct Sequence PCCARD adapter
98 .It NEL SSMagic
99 2Mbps Direct Sequence PCCARD adapter
100 .It Netwave AirSurfer Plus
101 1Mbps Frequency Hopping PCCARD adapter
102 .It Netwave AirSurfer Pro
103 2Mbps Direct Sequence PCCARD adapter
104 .It Nokia C020 WLAN
105 2Mbps Direct Sequence PCCARD adapter
106 .It Farallon SkyLINE
107 2Mbps Direct Sequence PCCARD adapter
108 .It Zoom Air Model 4000
111 The original Xircom Netwave AirSurfer is supported by the
112 .Xr cnw 4
113 driver, and the PRISM-II cards are supported by the
114 .Xr wi 4
115 driver.
116 .Sh MEDIA SELECTION
117 In addition to default
118 .Em Auto
119 media type,
120 the DS cards support
121 .Em DS1
123 .Em DS2
124 media types, while the FH cards support the
125 .Em FH1
126 media type.
127 For each media type, the
128 .Em adhoc
129 mediaopt can be used to indicate to the driver to operate in ad-hoc mode.
131 .Em flag0
132 mediaopt
133 should be used only with old access points, which operate in IBSS mode.
134 For DS radio cards, the
135 .Em adhoc,flag0
136 mediaopt can be used for
137 .Xr wi 4
138 compatible WaveLAN ad-hoc mode.
139 .Sh DIAGNOSTICS
140 .Bl -diag
141 .It "awi0: no suitable CIS info found"
142 The device cannot be mapped due to a resource conflict.
143 Or, the device failed to initialize its firmware.
144 .It "awi0: failed to complete selftest (%s)"
145 The device failed to complete its self test.
146 In some circumstances, resetting device after power on fails.
147 Re-inserting the card or setting the interface up and then down again
148 (using
149 .Xr ifconfig 8 )
150 may also be helpful.
151 .It "awi0: transmit timeout"
152 The device failed to generate an interrupt to acknowledge a
153 transmitted packet.
154 .It "awi0: failed to lock interrupt"
155 The system was unable to obtain the lock to access shared memory.
156 .It "awi0: command %d failed %x"
157 The device failed to complete the request from the system.
159 .Sh SEE ALSO
160 .Xr arp 4 ,
161 .Xr cnw 4 ,
162 .Xr ifmedia 4 ,
163 .Xr netintro 4 ,
164 .Xr pcmcia 4 ,
165 .Xr wi 4 ,
166 .Xr ifconfig 8 ,
167 .Xr wiconfig 8
169 .%T Am79C930 PCnet Mobile Single-Chip Wireless LAN Media Access Controller
170 .%O http://www.amd.com
172 .Sh HISTORY
175 device driver first appeared in
176 .Nx 1.5 .
177 .Sh AUTHORS
178 The initial version of the
180 driver was written by
181 .An Bill Sommerfeld
182 .Aq sommerfeld@NetBSD.org .
183 It was then completely rewritten to support cards with the DS phy and
184 ad-hoc mode by
185 .An Atsushi Onoe
186 .Aq onoe@NetBSD.org .