manual/pcmcia-cs/draft/man4/ray_cs.4

   1 .\"
   2 .\" Man page for ray_cs Raylink wireless LAN Card Services
   3 .\"
   4 .\" Copyright (c) 1999 Corey Thomas
   5 .\"
   6 .\" You may distribute under the terms of the GNU General Public
   7 .\" License version 2 only
   8 .\"
   9 .\" Corey Thomas
  10 .\" corey@world.std.com
  11 .\"
  12 .\"O .TH ray_cs "January 20, 1999"
  13 .\"O .LO 4
  14 .\"O .SH NAME
  15 .\"O ray_cs \- Raylink wireless LAN \- PCMCIA card device driver
  16 .\"O .br
  17 .\"O .SH SYNOPSIS
  18 .\"O .B insmod ray_cs
  19 .\"O .RB [essid=string]
  20 .\"O .RB [irq_mask=n]
  21 .\"O .RB [net_type=[0-1]]
  22 .\"O .RB [ray_debug=[0-5]]
  23 .\"O .RB [phy_addr=xNNNNNNNNNNNN]
  24 .\"O .RB [hop_dwell=n]
  25 .\"O .RB [beacon_period=n]
  26 .\"O .RB [psm=[0-1]]
  27 .\"O .RB [translate=[0-1]]
  28 .\"O .RB [country=[1-8]]
  29 .\"O .RB [sniffer=[0-1]]
  30 .\"O .RB [bc=[0-1]]
  31 .\"O .SH DESCRIPTION
  32 .\"O .B ray_cs
  33 .\"O is the low level Card Services device driver for the Raylink wireless
  34 .\"O LAN PCMCIA adapter.  It is normally loaded automatically by card
  35 .\"O services according to the parameters specified in
  36 .\"O .IR /etc/pcmcia/ray_cs.opts .
  37 .\"O .SH PARAMETERS
  38 .\"O .TP
  39 .\"O .B essid=string
  40 .\"O ESS ID - network name to join string with maximum length of 32 chars
  41 .\"O default value = "LINUX"
  42 .\"O
  43 .\"O .TP
  44 .\"O .B irq_mask=n
  45 .\"O linux standard 16 bit value 1bit/IRQ lsb is IRQ 0, bit 1 is IRQ 1 etc.
  46 .\"O Used to restrict choice of IRQ's to use.
  47 .\"O
  48 .\"O .TP
  49 .\"O .B net_type=n
  50 .\"O 0 = adhoc network (default)
  51 .\"O 1 = infrastructure
  52 .\"O
  53 .\"O .TP
  54 .\"O .B ray_debug=n
  55 .\"O (0-5) larger values for more verbose logging.
  56 .\"O .TP
  57 .\"O .B phy_addr=string
  58 .\"O string of 12 hex digits containing new MAC address.
  59 .\"O must be started with x e.g. x00008f123456
  60 .\"O
  61 .\"O .TP
  62 .\"O .B hop_dwell=n
  63 .\"O hop dwell time in Kilo-microseconds legal values = 16,32,64,128(default),256
  64 .\"O
  65 .\"O .TP
  66 .\"O .B beacon_period=n
  67 .\"O Beacon period in Kilo-microseconds.
  68 .\"O .br
  69 .\"O Legal values = 16,32,64,128,256(default)
  70 .\"O must be integer multiple of hop dwell.
  71 .\"O
  72 .\"O .TP
  73 .\"O .B psm=n
  74 .\"O Power save mode
  75 .\"O .br
  76 .\"O 0 = continuously active
  77 .\"O .br
  78 .\"O 1 = power save mode (significantly slower)
  79 .\"O
  80 .\"O .TP
  81 .\"O .B bc=n
  82 .\"O Power save mode
  83 .\"O .br
  84 .\"O 0 = 802.11 timing
  85 .\"O .br
  86 .\"O 1 = 802.11 modified timing.  Interframe spacing is slowed down for
  87 .\"O compatibility with older Breezecom access points.
  88 .\"O
  89 .\"O .TP
  90 .\"O .B translate
  91 .\"O .br
  92 .\"O 0 = no translation (encapsulate frames)
  93 .\"O .br
  94 .\"O 1 = translation (default)
  95 .\"O
  96 .\"O .TP
  97 .\"O .B country=n
  98 .\"O .br
  99 .\"O Country code
 100 .\"O .br
 101 .\"O 1 = USA (default)
 102 .\"O .br
 103 .\"O 2 = Europe
 104 .\"O .br
 105 .\"O 3 = Japan
 106 .\"O .br
 107 .\"O 4 = Korea
 108 .\"O .br
 109 .\"O 5 = Spain
 110 .\"O .br
 111 .\"O 6 = France
 112 .\"O .br
 113 .\"O 7 = Israel
 114 .\"O .br
 115 .\"O 8 = Australia
 116 .\"O
 117 .\"O .TP
 118 .\"O .B sniffer=n
 119 .\"O .br
 120 .\"O 0 = normal network interface - not sniffer (default)
 121 .\"O .br
 122 .\"O 1 = sniffer which can be used to record all network traffic using
 123 .\"O tcpdump or similar, but no normal network use is allowed.  This is
 124 .\"O because linux has no knowledge of 802.11 headers and cannot parse them
 125 .\"O correctly.  Note that tcpdump does not understand 802.11 headers,
 126 .\"O either so it can't interpret the contents, but it can record to a
 127 .\"O file.
 128 .\"O
 129 .\"O .TP
 130 .\"O .SH BUGS
 131 .\"O ray_cs can lock the machine if the card is pulled out while active.
 132 .\"O I have never observed a crash if card is deactivated as follows before
 133 .\"O removal:
 134 .\"O .br
 135 .\"O .B ifconfig eth0 down
 136 .\"O .br
 137 .\"O The above command assumes that the Raylink card is configured as eth0.
 138 .\"O
 139 .\"O This driver only does encapsulation of ethernet frames within 802.11
 140 .\"O frames.  Most vendors, including Raytheon, are moving to a frame
 141 .\"O translation method.  Translation support has been started, but is not
 142 .\"O yet functional.
 143 .\"O
 144 .\"O Support for defragmenting frames is not yet tested.
 145 .\"O
 146 .\"O The ioctl support is incomplete.  The hardware address cannot be set
 147 .\"O using ifconfig yet.  If a different hardware address is needed, it may
 148 .\"O be set using the phy_addr parameter in ray_cs.opts.
 149 .\"O
 150 .\"O .SH AUTHOR
 151 .\"O Corey Thomas \- corey@world.std.com
 152 .\"O .SH "SEE ALSO"
 153 .\"O cardmgr(8), pcmcia(5), ifconfig(8).