OSDN Git Service

Import translated manuals from JM CVS Repository.
[linuxjm/jm.git] / manual / pcmcia-cs / original / man4 / wvlan_cs.4
1 .\" Copyright (c) 1999 Andreas Neuhaus <andy@fasta.fh-dortmund.de>
2 .\" wvlan_cs.c.4
3 .\"
4 .TH WVLAN_CS 4 "27/12/99" ""
5
6 .SH NAME
7 wvlan_cs \- Lucent WaveLAN/IEEE 802.11 device driver
8
9 .SH SYNOPSIS
10 .B insmod wvlan_cs.o
11 .RB [ irq_list=\c
12 .IR i,j,... ]
13 .RB [ port_type=\c
14 .IR n ]
15 .RB [ station_name=\c
16 .IR s ]
17 .RB [ network_name=\c
18 .IR s ]
19 .RB [ channel=\c
20 .IR n ]
21 .RB [ ap_density=\c
22 .IR n ]
23 .RB [ medium_reservation=\c
24 .IR n ]
25 .RB [ frag_threshold=\c
26 .IR n ]
27 .RB [ transmit_rate=\c
28 .IR n ]
29 .RB [ eth=\c
30 .IR n ]
31 .RB [ mtu=\c
32 .IR n ]
33
34 .SH DESCRIPTION
35 \fBwvlan_cs\fR is the low-level Card Services driver for the Lucent
36 WaveLAN/IEEE 802.11 and compatible (the NCR WaveLAN/IEEE 802.11, the
37 Cabletron RoamAbout 802.11 DS, the Melco WLI-PCM-L11) wireless
38 ethernet adapters.  When this driver is attached to a card, it
39 allocates the next available device (eth0..eth#).  This device name
40 will be passed on to \fBcardmgr\fR(8) for the card configuration, and
41 reported in the kernel log.
42
43 .SH PARAMETERS
44 .TP
45 .BI irq_list= i,j,...
46 Specifies the set of interrupts that may be allocated by this driver.
47 .TP
48 .BI port_type= n
49 Select WaveLAN port type:
50 .RI [ 1 ]
51 BSS - Basic Service Set (default),
52 .RI [ 2 ]
53 WDS - Wireless Distribution System,
54 .RI [ 3 ]
55 Pseudo-IBSS - ad-hoc network (no AccessPoint, PtP).
56 .TP
57 .BI station_name= s
58 Sets the station name.
59 The default is card-configured.
60 .TP
61 .BI network_name= s
62 Sets the independent network name in ad-hoc mode.
63 Sets the desired network (desired ESSID) to connect to if using an access point.
64 The default is card-configured.
65 .TP
66 .BI channel= n
67 Channel (frequency) for ad-hoc networks and is useless if using an
68 access point.  Valid range:
69 .RI [ 0 - 14 ]
70 (depends on local restrictions) and defaults to
71 .RI [ 3 ]
72 .TP
73 .BI ap_density= n
74 Sets the access point density (sensitivity). This affects modem and
75 roaming thresholds.
76 .RI [ 1 ]
77 low density (default),
78 .RI [ 2 ]
79 medium density,
80 .RI [ 3 ]
81 high density.
82 .TP
83 .BI medium_reservation= n
84 Sets the medium reservation (RTS/CTS frame length), which affects the
85 number of octets in a message or fragment above which a RTS/CTS
86 handshake is performed. 
87 .RI [ 500 ]
88 hidden stations,
89 .RI [ 2347 ]
90 no RTS/CTS (default). Valid range:
91 .RI [ 0 - 2347]
92 .TP
93 .BI frag_threshold= n
94 Defines the number of bytes used for the fragmentation boundary for
95 directed messages (Fragmentation length unicast message
96 transmission). 
97 .RI [ 2346 ]
98 is the default, valid range:
99 .RI [ 256 - 2346 ]
100 (even numbers only!).
101 .TP
102 .BI transmit_rate= n
103 Transmit rate control.
104 .RI [ 1 ]
105 fixed low,
106 .RI [ 2 ]
107 fixed high,
108 .RI [ 3 ]
109 auto select high (default),
110 .RI [ 4 ]
111 fixed medium,
112 .RI [ 5 ]
113 fixed high,
114 .RI [ 6 ]
115 auto select standard,
116 .RI [ 7 ]
117 auto select medium.
118 .TP
119 .BI eth= n
120 Network device naming. By default
121 .RI [ 1 ]
122 devices are named eth#, set this to
123 .RI [ 0 ]
124 to have devices named wvlan#.
125 .TP
126 .BI mtu= n
127 Maximum transfer unit.
128 .RI [ 1500 ]
129 is the default, valid range:
130 .RI [ 256 - 2296 ]
131
132 .SH WIRELESS EXTENSIONS
133 Use \fBiwconfig\fR(8) to manipulate wireless extensions. 
134 You need a kernel which was compiled with CONFIG_NET_RADIO set.
135 It is recommended that you run at least Linux kernel 2.2.11 and use wireless_tools 19.
136 Older version do not support all of the current commands.
137 .\"     ESSID sub part
138 .SS ESSID (network ID)
139 Set the network ID of the desired network to connect to (with access point)
140 or the name of your private ad-hoc network (no access point).
141 .\"     mode sub part
142 .SS Mode
143 Set the operating mode to
144 .I Ad-Hoc
145 or
146 .IR Managed .
147 In managed mode, the card will try to connect to an Access Point, to
148 get access to the infrastructure. In Ad-Hoc mode, the card doesn't
149 require an Access Point and can communicate directly with its peers.
150 .\"     Frequency sub part
151 .SS Frequency & channels
152 Channel (frequency) for ad-hoc networks. The frequency is changed
153 immediately and is only changeable in ad-hoc network mode. You may
154 enter a frequency value in the 2.4 GHz band or the channel number.
155 .br
156 Valid values:
157 .I 2.412, 2.417, 2.422, 2.427, 2.432, 2.437, 2.442, 2.447, 2.452, 2.457, 2.462,
158 .I 2.467, 2.472
159 or
160 .I 2.484
161 GHz (depends on local restrictions) and defaults to
162 .I 2.422
163 GHz
164 .\"     Sens sub part
165 .SS Sens
166 Set the Access Point density (sensitivity). This affects modem and
167 roaming thresholds.
168 .RI [ 1 ]
169 low density (default),
170 .RI [ 2 ]
171 medium density,
172 .RI [ 3 ]
173 high density.
174 .\"     Rts sub part
175 .SS Rts
176 Sets the medium reservation threshold (RTS/CTS frame length), which
177 affects the number of octets in a message or fragment above which a
178 RTS/CTS handshake is performed.
179 .br
180 Use
181 .RI [ 500 ]
182 when there are hidden stations or large number of nodes and
183 .RI [ 2347 ]
184 for no RTS/CTS (default). Valid range:
185 .RI [ 0 - 2347]
186 .\"     Frag sub part
187 .SS Frag
188 Defines the number of bytes used for the fragmentation boundary for
189 directed messages (Fragmentation length unicast message
190 transmission). To be used when you have interference on the radio,
191 because it significantly decreases the performance.
192 .br
193 .RI [ 2346 ]
194 is the default, valid range:
195 .RI [ 256 - 2346 ].
196 .\"     Rate sub part
197 .SS Rate
198 Set the rate used for transmission (but not reception). You may want
199 to set it to a fixed value for high number of nodes.
200 .br
201 The default is
202 .IR auto ,
203 or you may use
204 .IR 1 ", " 2  ", " 5.5 " or " 11
205 Mb/s (of course, 2 Mb/s cards cannot get the higher speeds).
206 .\"     Enc sub part
207 .SS Enc
208 Set the encryption key
209 .RI [ 0
210 to
211 .IR FFFF-FFFF-FF ].
212 Use
213 .RI [ off ]
214 and
215 .RI [ on ]
216 to disable and reenable the hardware encryption. This feature works
217 only for device with encryption option (Silver or Gold).
218 .br
219 The card has 4 different keys that you may select, and you can choose
220 the default key for transmission (see \fBiwconfig\fR(8)).
221 .\"     Nick sub part
222 .SS Nick (station name)
223 Set the station name (only used for debugging purpose).
224 .\"     Spy sub part
225 .SS Statistics spy
226 Set a list of MAC addresses in the driver (up to 8) and get the last
227 quality of link for each of those (see \fBiwspy\fR(8)).
228 .\"     /proc/net/wireless part
229 .SS /proc/net/wireless
230 .I status
231 is the status reported by the modem.
232 .I Level
233 and
234 .I Noise
235 refer to the signal level and noise level in dBm.
236
237 .SH PRIVATE IOCTL
238 You may use \fBiwpriv\fR(8) to manipulate private ioctls.
239 .\"     Histogram part
240 .SS Histogram
241 This functionality allow to set a number of signal level intervals and
242 to count the number of packets received in each of those defined
243 intervals. This distribution might be used to calculate the mean value
244 and standard deviation of the signal level.
245
246 .SH SPECIFIC NOTES
247 Some of the mentioned features are optional. You may enable to disable
248 them by changing flags in the driver header and recompile.
249 .PP
250 It's currently not possible to use the WaveLAN/IEEE as a bridge (MAC
251 level). This is not a restriction of the driver, the NIC firmware
252 doesn't allow to send out packets with another source MAC address
253 than its own (which is mandatory required for bridgeing to work).
254 .PP
255 Also the WaveLAN/IEEE can be used to connect to an Access Point, but
256 cannot be an Access Point itself (because lack of bridgeing).
257
258 .SH AUTHOR
259 Andreas Neuhaus <andy@fasta.fh-dortmund.de>
260 .br
261 http://www.fasta.fh-dortmund.de/users/andy/wvlan
262
263 .SH THANKS
264 I would like to thank Lucent Technology for making the necessary information
265 available to public. Thanks to Nico Valster and Jan Martejin at Lucent for
266 technical support. Thanks to Frank Bruegmann, who managed to get additional
267 hardware for me so that I can now do tests in different environments. And
268 thanks to Jean Tourrilhes for many patches and wireless kernel extensions.
269 Also many thanks to everybody who tested and helped me developing this
270 driver :-)
271
272 .SH SEE ALSO
273 .BR cardmgr (8),
274 .BR pcmcia (5),
275 .BR ifconfig (8),
276 .BR insmod (1),
277 .BR iwconfig (8),
278 .BR iwspy (8),
279 .BR iwpriv (8).