share/man/man4/man4.i386/ray.4

   1 .\"
   2 .\" Copyright (C) 2000
   3 .\" Dr. Duncan McLennan Barclay, dmlb@ragnet.demon.co.uk.
   4 .\"
   5 .\"  All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  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.
  18 .\"
  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
  29 .\" SUCH DAMAGE.
  30 .\"
  31 .\"  $FreeBSD: src/share/man/man4/man4.i386/ray.4,v 1.8.2.1 2001/10/23 07:25:48 ru Exp $
  32 .\"
  33 .Dd March 21, 2000
  34 .Dt RAY 4 i386
  35 .Os
  36 .Sh NAME
  37 .Nm ray
  38 .Nd Raytheon Raylink/Webgear Aviator PCCard driver
  39 .Sh SYNOPSIS
  40 .Cd "device ray"
  41 .Sh DESCRIPTION
  42 The
  43 .Nm
  44 driver provides support for
  45 .Tn "Raytheon Raylink"
  46 adapters (commonly available as
  47 .Tn "Webgear Aviator" ,
  48 .Tn "Webgear Aviator Pro"
  49 and
  50 .Tn "Raylink PC Card"
  51 devices.)
  52 The core of the
  53 .Tn Raylink
  54 cards is a frequency hopping PHY with an
  55 .Tn IEEE
  56 802.11
  57 style MAC that interacts with the host using shared memory and mailboxes.
  58 .Pp
  59 The
  60 .Nm
  61 driver currently supports ad-hoc operation mode and the
  62 .Tn Aviator
  63 cards.
  64 Infrastructure mode, interworking with
  65 .Tn "Windows 2000" Ns / Ns Tn Linux Ns / Ns Nx ,
  66 .Tn "Raylink PC Cards"
  67 and
  68 .Tn "Aviator Pros"
  69 is rudimentary and in active development.
  70 The
  71 .Nm
  72 driver currently encapsulates all IP and ARP traffic as
  73 .Tn Ethernet
  74 2 frames within an
  75 .Tn IEEE
  76 802.11
  77 frame.
  78 Other translations will be forthcoming as needed.
  79 Transmit speed is
  80 selectable between 0.5Mbps, 1Mbp , 1.5Mbps or 2Mbps all with auto fallback.
  81 .Pp
  82 By default, the
  83 .Nm
  84 driver configures the card for ad-hoc operation.
  85 In this mode,
  86 stations can communicate amongst each other without the aid of an access
  87 point.
  88 To join a managed service set, the driver must be set for infrastructure mode
  89 using the
  90 .Xr raycontrol 8
  91 utility.
  92 .Pp
  93 There are two known firmware versions; version 4 and version 5.
  94 Version 4 firmware was shipped on the orignal
  95 .Tn "Webgear Aviators"
  96 Version 5 firmware is
  97 used as part of the
  98 .Tn "Windows 2000"
  99 upgrade from
 100 .Tn Webgear
 101 and on the
 102 .Tn "Aviator Pro" ,
 103 and
 104 .Tn "Raylink PC Cards"
 105 cards.
 106 Version 4 is not likely to be 100%
 107 .Tn IEEE
 108 802.11
 109 compliant - version 5 should be.
 110 .Pp
 111 For more information on configuring this device, see
 112 .Xr ifconfig 8
 113 and
 114 .Xr raycontrol 8 .
 115 .Sh DIAGNOSTICS
 116 The following messages occur when there are problems
 117 setting up the memory mapped buffers due to nits in
 118 .Xr pccardd 8 .
 119 .Bl -diag
 120 .It "ray?: pccardd did not map CM - giving up"
 121 See the
 122 .Sx BUGS
 123 section and contact the author for help enclosing a copy
 124 of the output from
 125 .Xr dmesg 8 .
 126 This message only occurs on 3.x systems.
 127 .It "ray?: fixing up CM ..."
 128 .It "ray?: fixing up AM ..."
 129 The driver is fixing up PCCard memory management after mis-configuration
 130 by
 131 .Xr pccardd 8 ,
 132 benign.
 133 .El
 134 .Pp
 135 .Bl -diag
 136 On 4.x and -current systems the following messages can occur when the
 137 memory mapped buffers are set up.
 138 .It "ray?: allocated common memory:"
 139 .It ".  start 0xd0000 count 0xc0000 flags 0x40"
 140 Benign.
 141 .It "ray?: allocated attribute memory:"
 142 .It ".  start 0xdc000 count 0x1000 flags 0x50"
 143 Benign.
 144 .It "ray?: allocated irq:"
 145 .It ".  start 0x9 count 0x1"
 146 Benign.
 147 .It "ray?: Cannot allocate attribute memory"
 148 .It "ray?: Cannot allocate common memory"
 149 .It "ray?: Cannot allocate irq"
 150 .It "ray?: Failed to setup irq"
 151 .It "ray?: CARD_SET_MEMORY_OFFSET returned 0x??"
 152 .It "ray?: CARD_SET_RES_FLAGS returned 0x??"
 153 See the
 154 .Sx BUGS
 155 section and contact the author for help enclosing a copy
 156 of the output from
 157 .Xr dmesg 8
 158 in your email.
 159 .El
 160 .Pp
 161 .Bl -diag
 162 If the kernel is booted with the verbose flag turned on then the
 163 extra information is printed when the driver is probed.
 164 These messages are also seen when the
 165 .Dv RAY_DBG_BOOTPARAM
 166 bit in the
 167 .Dv RAY_DEBUG
 168 option is turned on, as is the case for all existing
 169 versions of the driver.
 170 .It "ray?: memory start 0x???? count 0x???? flags 0x???? offset 0x????"
 171 Description of memory map settings on entry to the driver.
 172 .It "ray?: irq start 0x???? count 0x????"
 173 Description of irq settings on entry to the driver (only on 4.1 and
 174 above).
 175 .El
 176 .Pp
 177 On start-up the driver will report hardware failures thus:
 178 .Bl -diag
 179 .It "ray?: card failed self test: status 0x??<???>"
 180 The card failed to come ready after it was plugged in to the PCCard
 181 slot.
 182 The most common cause of this message is incorrect PCCard memory
 183 management (indicated by a status of 0xff or 0x55).
 184 Bent cards might say that the receiver calibration failed.
 185 If you are brave enough removing the
 186 base of the case can resurrect cards (no warranties etc.).
 187 .It "ray?: unsupported firmware version 0x??"
 188 Self explanatory.
 189 Contact the author for help enclosing a copy
 190 of the output from
 191 .Xr dmesg 8 .
 192 .El
 193 .Pp
 194 The following messages are enabled using the
 195 .Cm debug
 196 option of
 197 .Xr ifconfig 8 .
 198 .Bl -diag
 199 .It "ray?: cannot transmit - not running"
 200 A packet was ready for transmission but the NIC is not connected to a
 201 BSS.
 202 May occur when removing the PCCard.
 203 .It "ray?: cannot transmit - no network"
 204 The wireless NIC has roamed from an access point and not connected with a new
 205 one yet.
 206 .It "ray?: cannot transmit - ECF busy"
 207 The controller firmware was busy when a packet was about to be sent out.
 208 It will be retried automatically.
 209 .It "ray?: mbuf too long ??"
 210 Should never happen, and if it does represents something wrong in the
 211 generic ethernet driver in the kernel.
 212 .It "ray?: could not pullup ether"
 213 Problem with re-aligning mbufs.
 214 Very unlikely to happen.
 215 .It "ray?: unknown framing type ??"
 216 An impossible error - mail the author.
 217 .It "ray?: could not translate packet"
 218 An error occured when trying to re-frame a packet for transmission.
 219 .It "ray?: ECF busy, dropping packet"
 220 The NIC was busy just before a packet was to be transmitted.
 221 .It "ray?: tx completed but status is fail"
 222 Typically associated with transmissions to out of range NICs.
 223 .It "ray?: packet too big or too small"
 224 A received packet was impossibly small or too large to fit into an mbuf.
 225 .It "ray?: MGETHDR failed"
 226 The driver could not get a mbuf to store a received packet into.
 227 Try increasing
 228 .Dv MAXUSERS
 229 in your kernel configuration.
 230 .It "ray?: MCLGET failed"
 231 The driver could not get a mbuf to store a received packet into.
 232 Try increasing
 233 .Dv MAXUSERS
 234 in your kernel configuration.
 235 .It "ray?: bad length current 0x?? pktlen 0x??"
 236 The lengths of a fragmented packet were inconsistent.
 237 .It "ray?: bad rcs index 0x??"
 238 The index of the buffer used for part of a fragmented packet is
 239 outside of the usable range.
 240 .It "ray?: header not version 0 fc0 0x??"
 241 The received
 242 .Tn IEEE
 243 802.11
 244 packet had an unkown header type.
 245 Represents link corruption or non standard nodes in the network.
 246 .It "ray?: unknown packet fc0 0x??"
 247 The received
 248 .Tn IEEE
 249 802.11
 250 packet type is unknown.
 251 Represents link corruption or non standard nodes in the network.
 252 .It "ray?: reserved DATA packet subtype 0x??"
 253 The received
 254 .Tn IEEE
 255 802.11
 256 data packet has a reserved (i.e. not allowed) subtype.
 257 Represents link corruption or non standard nodes in the network.
 258 .It "ray?: MGT TODS/FROMDS wrong fc1 0x??"
 259 The received
 260 .Tn IEEE
 261 802.11
 262 management packet had a malformed header.
 263 Represents link corruption or non standard nodes in the network.
 264 .It "ray?: unexpected MGT packet subtype 0x??"
 265 The received
 266 .Tn IEEE
 267 802.11
 268 management packet was of a subtype that the NIC
 269 should have processed.
 270 Benign, but might represent buggy firmware.
 271 .It "ray?: reserved MGT packet subtype 0x??"
 272 The received
 273 .Tn IEEE
 274 802.11
 275 management packet has a reserved (i.e. not allowed)
 276 subtype.
 277 Represents link corruption or non standard nodes in the network.
 278 .It "ray?: open system authentication request"
 279 Self explanatory and for testing
 280 .Tn "Aviator Pro"
 281 interworking.
 282 .It "ray?: authentication failed with status ??"
 283 Self explanatory and currently represents a bug as the driver never
 284 requests authentication.
 285 .It "ray?: shared key authentication request"
 286 Self explanatory and for testing
 287 .Tn "Aviator Pro"
 288 interworking.
 289 .It "ray?: reserved authentication subtype 0x??"
 290 An authentication request has been received for a reserved (i.e. not allowed)
 291 subtype.
 292 Represents link corruption or non standard nodes in the network.
 293 .It "ray?: CTL TODS/FROMDS wrong fc1 0x??"
 294 The received
 295 .Tn IEEE
 296 802.11
 297 management packet had a malformed header.
 298 Represents link corruption or non standard nodes in the network.
 299 .It "ray?: unexpected CTL packet subtype 0x??"
 300 The received
 301 .Tn IEEE
 302 802.11
 303 control packet was of a subtype that the NIC
 304 should have processed.
 305 Benign, but might represent buggy firmware.
 306 .It "ray?: reserved CTL packet subtype 0x??"
 307 The received
 308 .Tn IEEE
 309 802.11
 310 control packet has a reserved (i.e. not allowed)
 311 subtype.
 312 Represents link corruption or non standard nodes in the network.
 313 .It "ray?: bad ccs index 0x??"
 314 The NIC has generated an interrupt with an incorrect control block.
 315 .It "ray?: unexpected UPDATE_APM"
 316 .It "ray?: unexpected TEST_MEM"
 317 .It "ray?: unexpected SHUTDOWN"
 318 .It "ray?: unexpected DUMP_MEM"
 319 .It "ray?: unexpected START_TIMER"
 320 The NIC has generated an interrupt signalling that
 321 the indicated command has completed.
 322 At present these commands are never
 323 issued by the driver, so they represent firmware/hardware/driver bugs.
 324 .It "ray?: unknown command 0x??"
 325 The NIC has generated an interrupt for an unknown command completion.
 326 Represents firmware/hardware/driver bugs.
 327 .It "ray?: unexpected JAPAN_CALL_SIGNAL"
 328 The NIC has generated an interrupt with a control block requesting
 329 processing of a packet that is only ever used in Japanese RCR
 330 certification tests.
 331 Represents firmware/hardware/driver bugs unless you
 332 are trying to certify the NICs in Japan (in which case you would have to
 333 of modified the driver and this manual is out of date).
 334 .It "ray?: spinning"
 335 The controller firmware was busy when a command was about to be issued.
 336 If the driver spins for too long then it will panic.
 337 See the
 338 .Sx BUGS
 339 section for details.
 340 .It "ray?: freeing free ccs 0x??"
 341 Benign warning that may occur when the NIC is ejected.
 342 .El
 343 .Sh SEE ALSO
 344 .Xr arp 4 ,
 345 .Xr netintro 4 ,
 346 .Xr ifconfig 8 ,
 347 .Xr pccardd 8 ,
 348 .Xr raycontrol 8
 349 .Sh HISTORY
 350 The
 351 .Nm
 352 device driver first appeared in
 353 .Fx 3.3 .
 354 .Sh AUTHORS
 355 .An -nosplit
 356 Early versions of this
 357 .Nm
 358 driver were a port of the
 359 .Nx
 360 driver by
 361 .An "Christian E. Hopps" .
 362 The driver
 363 was re-structured by
 364 .An Duncan Barclay Aq dmlb@FreeBSD.org ,
 365 so that
 366 .Xr dhclient 8
 367 would work.
 368 .Sh BUGS
 369 Infra-structure mode is not supported yet.
 370 The driver is likely to panic if it is set into this mode.
 371 Testers are encouraged to contact the
 372 author.
 373 .Pp
 374 Currently
 375 .Fx
 376 has a small problem managing and setting up the correct memory maps.
 377 However, this driver should reset the
 378 memory maps correctly - it works around
 379 .Xr pccardd 8
 380 (where it reads the CIS for common memory, sets it all up
 381 and then throws it all away assuming the card is an
 382 .Xr ed 4
 383 driver...).
 384 Note that this could be dangerous (because it doesn't interact with
 385 .Xr pccardd 8 )
 386 if you use other memory mapped cards at the same time or have
 387 SCSI cards with on-board BIOS.
 388 .Pp
 389 More encapsulations and translations could be supported, but they have
 390 little value unless someone can demonstrate that the
 391 .Nm
 392 cards will communicate with other manufacturers cards.
 393 Version 4 and
 394 firmware is not
 395 .Tn IEEE
 396 802.11
 397 compliant, but version 5 is.
 398 .Pp
 399 To communicate with
 400 .Tn Windows
 401 machines ensure that the
 402 .Tn Windows
 403 machine
 404 creates the BSS/IBSS.
 405 .Pp
 406 The driver currently panics on some errors that it should recover from.
 407 These will be removed RSN.