3 .\" Dr. Duncan McLennan Barclay, dmlb@ragnet.demon.co.uk.
5 .\" All rights reserved.
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
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 the
14 .\" documentation and/or other materials provided with the distribution.
15 .\" 3. 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.
19 .\" THIS SOFTWARE IS PROVIDED BY DUNCAN BARCLAY 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 DUNCAN BARCLAY OR CONTRIBUTORS BE LIABLE
23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 .\" $FreeBSD: src/share/man/man4/man4.i386/ray.4,v 1.8.2.1 2001/10/23 07:25:48 ru Exp $
32 .\" $DragonFly: src/share/man/man4/man4.i386/Attic/ray.4,v 1.4 2007/05/13 20:29:48 hasso Exp $
39 .Nd Raytheon Raylink/Webgear Aviator PCCard driver
45 driver provides support for
46 .Tn "Raytheon Raylink"
47 adapters (commonly available as
48 .Tn "Webgear Aviator" ,
49 .Tn "Webgear Aviator Pro"
55 cards is a frequency hopping PHY with an
58 style MAC that interacts with the host using shared memory and mailboxes.
62 driver currently supports ad-hoc operation mode and the
65 Infrastructure mode, interworking with
66 .Tn "Windows 2000" Ns / Ns Tn Linux Ns / Ns Nx ,
67 .Tn "Raylink PC Cards"
70 is rudimentary and in active development.
73 driver currently encapsulates all IP and ARP traffic as
79 Other translations will be forthcoming as needed.
81 selectable between 0.5Mbps, 1Mbp , 1.5Mbps or 2Mbps all with auto fallback.
85 driver configures the card for ad-hoc operation.
87 stations can communicate amongst each other without the aid of an access
89 To join a managed service set, the driver must be set for infrastructure mode
94 There are two known firmware versions; version 4 and version 5.
95 Version 4 firmware was shipped on the original
96 .Tn "Webgear Aviators"
105 .Tn "Raylink PC Cards"
107 Version 4 is not likely to be 100%
110 compliant - version 5 should be.
112 For more information on configuring this device, see
117 The following messages occur when there are problems
118 setting up the memory mapped buffers due to nits in
121 .It "ray?: pccardd did not map CM - giving up"
124 section and contact the author for help enclosing a copy
127 This message only occurs on 3.x systems.
128 .It "ray?: fixing up CM ..."
129 .It "ray?: fixing up AM ..."
130 The driver is fixing up PCCard memory management after mis-configuration
137 On 4.x and -current systems the following messages can occur when the
138 memory mapped buffers are set up.
139 .It "ray?: allocated common memory:"
140 .It ". start 0xd0000 count 0xc0000 flags 0x40"
142 .It "ray?: allocated attribute memory:"
143 .It ". start 0xdc000 count 0x1000 flags 0x50"
145 .It "ray?: allocated irq:"
146 .It ". start 0x9 count 0x1"
148 .It "ray?: Cannot allocate attribute memory"
149 .It "ray?: Cannot allocate common memory"
150 .It "ray?: Cannot allocate irq"
151 .It "ray?: Failed to setup irq"
152 .It "ray?: CARD_SET_MEMORY_OFFSET returned 0x??"
153 .It "ray?: CARD_SET_RES_FLAGS returned 0x??"
156 section and contact the author for help enclosing a copy
163 If the kernel is booted with the verbose flag turned on then the
164 extra information is printed when the driver is probed.
165 These messages are also seen when the
166 .Dv RAY_DBG_BOOTPARAM
169 option is turned on, as is the case for all existing
170 versions of the driver.
171 .It "ray?: memory start 0x???? count 0x???? flags 0x???? offset 0x????"
172 Description of memory map settings on entry to the driver.
173 .It "ray?: irq start 0x???? count 0x????"
174 Description of irq settings on entry to the driver (only on 4.1 and
178 On start-up the driver will report hardware failures thus:
180 .It "ray?: card failed self test: status 0x??<???>"
181 The card failed to come ready after it was plugged in to the PCCard
183 The most common cause of this message is incorrect PCCard memory
184 management (indicated by a status of 0xff or 0x55).
185 Bent cards might say that the receiver calibration failed.
186 If you are brave enough removing the
187 base of the case can resurrect cards (no warranties etc.).
188 .It "ray?: unsupported firmware version 0x??"
190 Contact the author for help enclosing a copy
195 The following messages are enabled using the
200 .It "ray?: cannot transmit - not running"
201 A packet was ready for transmission but the NIC is not connected to a
203 May occur when removing the PCCard.
204 .It "ray?: cannot transmit - no network"
205 The wireless NIC has roamed from an access point and not connected with a new
207 .It "ray?: cannot transmit - ECF busy"
208 The controller firmware was busy when a packet was about to be sent out.
209 It will be retried automatically.
210 .It "ray?: mbuf too long ??"
211 Should never happen, and if it does represents something wrong in the
212 generic ethernet driver in the kernel.
213 .It "ray?: could not pullup ether"
214 Problem with re-aligning mbufs.
215 Very unlikely to happen.
216 .It "ray?: unknown framing type ??"
217 An impossible error - mail the author.
218 .It "ray?: could not translate packet"
219 An error occurred when trying to re-frame a packet for transmission.
220 .It "ray?: ECF busy, dropping packet"
221 The NIC was busy just before a packet was to be transmitted.
222 .It "ray?: tx completed but status is fail"
223 Typically associated with transmissions to out of range NICs.
224 .It "ray?: packet too big or too small"
225 A received packet was impossibly small or too large to fit into an mbuf.
226 .It "ray?: MGETHDR failed"
227 The driver could not get a mbuf to store a received packet into.
230 in your kernel configuration.
231 .It "ray?: MCLGET failed"
232 The driver could not get a mbuf to store a received packet into.
235 in your kernel configuration.
236 .It "ray?: bad length current 0x?? pktlen 0x??"
237 The lengths of a fragmented packet were inconsistent.
238 .It "ray?: bad rcs index 0x??"
239 The index of the buffer used for part of a fragmented packet is
240 outside of the usable range.
241 .It "ray?: header not version 0 fc0 0x??"
245 packet had an unknown header type.
246 Represents link corruption or non standard nodes in the network.
247 .It "ray?: unknown packet fc0 0x??"
251 packet type is unknown.
252 Represents link corruption or non standard nodes in the network.
253 .It "ray?: reserved DATA packet subtype 0x??"
257 data packet has a reserved (i.e. not allowed) subtype.
258 Represents link corruption or non standard nodes in the network.
259 .It "ray?: MGT TODS/FROMDS wrong fc1 0x??"
263 management packet had a malformed header.
264 Represents link corruption or non standard nodes in the network.
265 .It "ray?: unexpected MGT packet subtype 0x??"
269 management packet was of a subtype that the NIC
270 should have processed.
271 Benign, but might represent buggy firmware.
272 .It "ray?: reserved MGT packet subtype 0x??"
276 management packet has a reserved (i.e. not allowed)
278 Represents link corruption or non standard nodes in the network.
279 .It "ray?: open system authentication request"
280 Self explanatory and for testing
283 .It "ray?: authentication failed with status ??"
284 Self explanatory and currently represents a bug as the driver never
285 requests authentication.
286 .It "ray?: shared key authentication request"
287 Self explanatory and for testing
290 .It "ray?: reserved authentication subtype 0x??"
291 An authentication request has been received for a reserved (i.e. not allowed)
293 Represents link corruption or non standard nodes in the network.
294 .It "ray?: CTL TODS/FROMDS wrong fc1 0x??"
298 management packet had a malformed header.
299 Represents link corruption or non standard nodes in the network.
300 .It "ray?: unexpected CTL packet subtype 0x??"
304 control packet was of a subtype that the NIC
305 should have processed.
306 Benign, but might represent buggy firmware.
307 .It "ray?: reserved CTL packet subtype 0x??"
311 control packet has a reserved (i.e. not allowed)
313 Represents link corruption or non standard nodes in the network.
314 .It "ray?: bad ccs index 0x??"
315 The NIC has generated an interrupt with an incorrect control block.
316 .It "ray?: unexpected UPDATE_APM"
317 .It "ray?: unexpected TEST_MEM"
318 .It "ray?: unexpected SHUTDOWN"
319 .It "ray?: unexpected DUMP_MEM"
320 .It "ray?: unexpected START_TIMER"
321 The NIC has generated an interrupt signalling that
322 the indicated command has completed.
323 At present these commands are never
324 issued by the driver, so they represent firmware/hardware/driver bugs.
325 .It "ray?: unknown command 0x??"
326 The NIC has generated an interrupt for an unknown command completion.
327 Represents firmware/hardware/driver bugs.
328 .It "ray?: unexpected JAPAN_CALL_SIGNAL"
329 The NIC has generated an interrupt with a control block requesting
330 processing of a packet that is only ever used in Japanese RCR
332 Represents firmware/hardware/driver bugs unless you
333 are trying to certify the NICs in Japan (in which case you would have to
334 of modified the driver and this manual is out of date).
336 The controller firmware was busy when a command was about to be issued.
337 If the driver spins for too long then it will panic.
341 .It "ray?: freeing free ccs 0x??"
342 Benign warning that may occur when the NIC is ejected.
353 device driver first appeared in
357 Early versions of this
359 driver were a port of the
362 .An "Christian E. Hopps" .
365 .An Duncan Barclay Aq dmlb@FreeBSD.org ,
370 Infra-structure mode is not supported yet.
371 The driver is likely to panic if it is set into this mode.
372 Testers are encouraged to contact the
377 has a small problem managing and setting up the correct memory maps.
378 However, this driver should reset the
379 memory maps correctly - it works around
381 (where it reads the CIS for common memory, sets it all up
382 and then throws it all away assuming the card is an
385 Note that this could be dangerous (because it doesn't interact with
387 if you use other memory mapped cards at the same time or have
388 SCSI cards with on-board BIOS.
390 More encapsulations and translations could be supported, but they have
391 little value unless someone can demonstrate that the
393 cards will communicate with other manufacturers cards.
398 compliant, but version 5 is.
402 machines ensure that the
405 creates the BSS/IBSS.
407 The driver currently panics on some errors that it should recover from.
408 These will be removed RSN.