2 .\" Copyright (c) 1999-2003 Agere Systems Inc. -- http://www.agere.com
3 .\" wlags49.4 7.20-abg 04/28/2004 13:30:00
5 .TH WLAGS49 4 "04/28/2004 13:30:00" "pcmcia-cs"
7 wlags49 \- Agere Systems Wireless PC Card / PCI device drivers
9 wlags49_h2_cs.o \- Hermes-II Card Services (PCMCIA/CF) driver
11 wlags49_h2.o \- Hermes-II MiniPCI driver
13 wlags49_h25.o \- Hermes-II.5 PCI/CardBus driver
15 wlags49_h25_cs.o\- Hermes-II.5 Card Services (PCMCIA/CF) driver
20 .B insmod wlags49_[h1,h2]_[cs].o
22 .RB [ Authentication=n ]
23 .RB [ AuthKeyMngmtSuite=???? ]
27 .RB [ Configured=???? ]\p
28 .RB [ ConnectionControl=???? ]
32 .RB [ DownloadFirmware=n ]
33 .RB [ DriverEnable=???? ]\p
34 .RB [ EnableEncryption=s ]
35 .RB [ Encryption=???? ]
36 .RB [ ExcludeUnencrypted=s ]\p
37 .RB [ IntraBSSRelay=s ]
38 .RB [ IrqList=i,j,... ]
44 .RB [ LoadBalancing=s ]
45 .RB [ MaxSleepDuration=n ]
46 .RB [ MediumDistribution=s ]\p
47 .RB [ MicroWaveRobustness=s ]
48 .RB [ MulticastPMBuffering=s ]
49 .RB [ MulticastRate=n ]\p
50 .RB [ MulticastReceive=s ]
51 .RB [ NetworkAddress=n,n,n,n,n,n ]
52 .RB [ NetworkType=???? ]\p
53 .RB [ OwnATIMWindow=n ]
54 .RB [ OwnBeaconInterval=n ]
55 .RB [ OwnChannel=n ]\p
56 .RB [ OwnDTIMPeriod=n ]
61 .RB [ PMHoldoverDuration=n ]\p
63 .RB [ PowerMode=???? ]
64 .RB [ PromiscuousMode=s ]\p
66 .RB [ RTSThreshold=n ]\p
67 .RB [ RTSThreshold1=n ]
68 .RB [ RTSThreshold2=n ]
69 .RB [ RTSThreshold3=n ]\p
70 .RB [ RTSThreshold4=n ]
71 .RB [ RTSThreshold5=n ]
72 .RB [ RTSThreshold6=n ]\p
75 .RB [ SystemScale=n ]\p
77 .RB [ TxRateControl=n ]\p
78 .RB [ TxRateControl1=n ]
79 .RB [ TxRateControl2=n ]
80 .RB [ TxRateControl3=n ]\p
81 .RB [ TxRateControl4=n ]
82 .RB [ TxRateControl5=n ]
83 .RB [ TxRateControl6=n ]\p
84 .RB [ WDSAddress=n,n,n,n,n,n ]\p
85 .RB [ WDSAddress1=n,n,n,n,n,n ]
86 .RB [ WDSAddress2=n,n,n,n,n,n ]\p
87 .RB [ WDSAddress3=n,n,n,n,n,n ]
88 .RB [ WDSAddress4=n,n,n,n,n,n ]\p
89 .RB [ WDSAddress5=n,n,n,n,n,n ]
90 .RB [ WDSAddress6=n,n,n,n,n,n ]\p
97 is the low-level Card Services / PCI driver for the
98 .B Wireless PC Card, Wireless Integrated Card, Wireless Embedded Card
99 and other wireless adapters based on the Agere Systems Hermes-II, and Hermes-II.5 wireless MAC. When this driver is attached to a card, it
100 allocates the next available ethernet device (eth0..eth#). This
101 device name will be passed on to
103 or the PCI subsystem, for the card configuration, and reported in the kernel log file
104 with the I/O base address and MAC address used by the card.
107 \- Access Point and peer-to-peer communication
108 \- Card power management
109 \- Support for Hermes-II & Hermes-II.5 based PCMCIA, Mini PCI, and CardBus cards
110 \- Wired Equivalent Privacy (WEP)
111 \- WPA-PSK support (EXPERIMENTAL)
112 \- Driver utility interface (UIL)
113 \- Wireless Extensions
118 Algorithm used for Authentication.
126 .B Auth_key_mgmt_suite
130 Sets the card\'s Basic Rate Set in the 2.4GHz band. See SRSC2GHz
131 for the value\'s format.
133 Default: 15 (or 0x000F, only 11b rates to accept legacy 11b stations)
136 Sets the card\'s Basic Rate Set in the 5.0GHz band. See SRSC2GHz for the
139 Default: 4080 (or 0x0FF0, all 11a rates)
142 Used to make the 802.11a/b/g coexistence behavior more strict.
144 Default \- 0 (Use standard behavior)
146 .B ConnectionControl=n
147 Configures the card\'s connection control process in dealing with multiple
148 bands (802.11b/g vs. 802.11a).
150 0 \- Single Band operation in 2GHz
152 1 \- Single Band operation in 5GHz
154 2 \- Multiple Band operation starting with 2GHz
156 3 \- Multiple Band operation starting with 5GHz
167 Enable or disable IBSS Creation.
168 For correct operation, specification of a OwnSSID is required.
169 This mode requires firmware 6.04 or higher.
178 Selects the driver debugging level. This parameter is only available
179 if the module is compiled with debugging enabled. Refer to the
182 in the source directory for information on the flag values.
184 0x00000001L \- DBG_ERROR_ON
186 0x00000002L \- DBG_WARNING_ON
188 0x00000004L \- DBG_NOTICE_ON
190 0x00000008L \- DBG_TRACE_ON
192 0x00000010L \- DBG_VERBOSE_ON
194 0x00000020L \- DBG_PARAM_ON
196 0x00000040L \- DBG_BREAK_ON
198 0x00000100L \- DBG_RX_ON
200 0x00000200L \- DBG_TX_ON
202 0x00000400L \- DBG_DS_ON
204 If the module is compiled with debugging enabled, DebugFlag
205 defaults to DBG_ERROR_ON, DBG_WARNING_ON and DBG_BREAK_ON.
206 DebugFlag overrules pc_debug.
211 .B DownloadFirmware=n
212 This release of the driver introduces the ability to perform downloads of the STA/AP
213 firmware. In fact, this is required for Hermes-II based cards. This parameter tells
214 the driver which version of the firmware to download to the card.
216 0 \- No download performed (Hermes-I only)
218 1 \- Download STA firmware
220 2 \- Download AP firmware
222 Default: 1, when STA mode functionality is
223 included in the build
224 2, when code is built exclusively for
230 .B EnableEncryption=n
231 Set the method of Data encryption.
235 1 \- Enable WEP Encryption
237 2 \- Enable WPA with TKIP encryption
244 .B ExcludeUnencrypted=s
245 Controls how the stations must communicate with the AP.
247 Y \- Stations must enable encryption and provide
248 the proper encryption key to communicate
251 N \- Stations do not need to enable encryption
252 to communicate with the AP.
257 Controls the automatic relay of received messages that are destined for other
260 Y \- Messages are relayed to the appropriate
263 N \- Messages are passed up to the host.
268 Specifies the set of interrupts (up to 4) that may be allocated by
269 this driver. This overrides the values set in the
271 parameter. NOTE: This parameter is for PCMCIA only.
274 Specifies a mask of valid interrupts that may be allocated by this driver.
277 is also specified, the values in
279 are used instead. NOTE: This parameter is for PCMCIA only.
281 Default: 0xdeb8 (IRQ 3,4,5,7,9,10,11,12,14,15)
284 Specifies one of 4 possible keys for the Data encryption.
285 One of these keys, identified by TxKey,
286 is used for the enciphering of Data that is transmitted by this station.
287 All keys specified can be used for the deciphering of Data that is received.
289 The key value can be an ASCII character string or a hexadecimal value.
290 The length of the key value can be 5 characters or 10 hexadecimal digits for
291 the standard encryption (Silver or Gold card), or 13 characters or 26
292 hexadecimal digits for the encryption with extended keys (Gold card only).
293 The keys defined in the station must match the keys defined in the access
294 points; both on value and number (1 through 4).
296 In 2.0 series Linux kernel modules, values that begin with a number are
297 considered integers. In this case a hexadecimal value string or a character
298 string starting with a number, will need to be surrounded by escaped
299 double quotes (ie. Key1=\\"0x1122334455\\" Key2=\\"12xyz\\").
301 5 or 13, printable character string, or
303 10 or 26 hex digits if preceded by "0x".
305 If this parameter is omitted, the default of the MAC is used ( = 0-length).
317 Control for the Load Balancing algorithm for both STAs and APs. The AP
318 includes a load balancing element in the Probe Response and Beacon frames.
319 The STA uses this info to select an AP, not only based on comms quality, but
320 also on the load of that AP.
327 .B MaxSleepDuration=n
328 Set the maximum Power Management sleep duration in milliseconds.
329 Valid values are 0 to 65535 milliseconds.
333 .B MediumDistribution=s
334 Control for the distribution of medium parameters, like communication
335 thresholds, microwave robustness, RTS/CTS thresholds, by APs. The associated
336 stations replace their own values with the received values.
340 .B MicroWaveRobustness=s
341 Enable or disable Microwave Oven Robustness.
349 .B MulticastPMBuffering=s
350 Controls buffering of multicast MAC frames for transmission after DTIM. If no,
351 multicast MAC frames are directly placed in the output queue.
356 Sets the data rate for multicast message transmission.
365 For Hermes-II.5, an INTEGER CONVERTED bit mask representing the
366 rate to multicast, where the rates supported are as follows:
368 Bit : 15|14|13|12|11|10|09|08|07|06|05|04|03|02|01|00
370 ------------------------------------------------------
372 Rate : XX|XX|XX|XX|54|48|36|24|18|12| 9| 6|11|5.5|2| 1
374 Default: 4 (Translates to 0x0004 = 5.5 Mb/sec)
377 .B MulticastReceive=s
378 Enable or disable receiving of all multicast packets when Card Power Management
379 is enabled. When enabled, the station will wake up frequently
380 to receive the multicast frames. This causes less optimal power savings.
388 .B NetworkAddress=n,n,n,n,n,n
389 Sets the adapter hardware ethernet address (MAC address) to the value
390 specified. Note that this is to be used to specify a Local MAC address. Do
391 not specify this parameter if the card\'s universal address is to be used.
392 Valid values are six hexadecimal digit-pairs (prefixed with 0x).
394 Default: <factory assigned address>
400 ATIM window time used for creating an IBSS.
406 .B OwnBeaconInterval=b
407 Beacon Interval in TU
417 Sets the channel the Ad-Hoc or IBSS mode will use.
418 The default channel for Ad-Hoc mode is determined by the Wireless PC Card.
419 The default channel for IBSS is set to 10 by the driver.
420 This value has no effect when the adapter is used with an Access Point
421 (BSS network) since the Access Point automatically determines the channel.
422 Valid values are 0 to 14. However the channels allowed in
423 your region are subject to local regulations and are limited at
424 manufacturing time of the Wireless PC Card. When the provided value is
425 not allowed, the value remains unchanged.
427 0 \- Use default channel
432 The number of beacon intervals between successive Delivery Traffic Identification
440 Sets the station name to the specified string value. This parameter
441 is used for diagnostic purposes, as a user\-friendly identification
442 of this system. This parameter accepts a maximum of 32 characters.
447 Sets the card network name to the specified string value. This parameter
448 accepts a maximum of 32 characters. Whitespace in the network name
449 will need to be escaped with a backslash (ie. OwnSSID=My\\ Network).
454 Selects the PCMCIA debugging level. This parameter is only available
455 if the module is compiled with debugging enabled. A non\-zero value
456 enables debugging. Higher values yield more information, i.e. for any value all
457 lower values are implied.
461 7 \- DBG_RX_ON | DBG_TX_ON
469 If the module is compiled with debugging enabled, pc_debug defaults to 5.
470 DebugFlag overrules pc_debug.
472 The name pc_debug rather than PcDebug, since pc_debug is used by many PCMCIA driver.
475 Sets the card\'s Power Management state.
479 1 \- Enable Enhanced Mode
481 2 \- Enabled Standard Mode
483 0x8000 \- Enhanced?????? Mode (to be combined with 0x0001 or 0x0002)
485 Default: 0 (Disabled)
487 .B PMHoldoverDuration=n
488 Time that the station remains in an awake state after a MAC frame transfer if
489 Enhanced Power Save is active.
499 Selects the type of network operation.
501 1 \- Normal Operation (BSS or IBSS)
503 3 \- Ad-Hoc Demo Mode
508 Switch for promiscuous mode reception.
513 Controls how stations associate to the device.
515 Y \- Stations must provide the correct SSID to
518 N \- Stations are not required to provide the
519 correct SSID to associate to the AP.
520 Known as an \'open\' network.
525 Controls the RTS/CTS handshake threshold for transmissions in Station mode.
526 Valid values are 0 to 2347.
528 500 \- Hidden Stations
535 Same as RTSThreshold, only for port 1 of in AccessPoint mode.
538 Same as RTSThreshold1, only for port 2.
541 Same as RTSThreshold1, only for port 3.
544 Same as RTSThreshold1, only for port 4.
547 Same as RTSThreshold1, only for port 5.
550 Same as RTSThreshold1, only for port 6.
553 Sets the card\'s Supported Rate Set in the 2.4GHz band. The value
554 is an INTEGER CONVERTED bit mask representing the rates to support,
555 where the rates supported are as follows:
557 Bit : 15|14|13|12|11|10|09|08|07|06|05|04|03|02|01|00
559 ------------------------------------------------------
561 Rate : XX|XX|XX|XX|54|48|36|24|18|12| 9| 6|11|5.5|2| 1
563 Default: 4095 (or 0x0FFF, all 11b and 11g rates)
566 Sets the card\'s Supported Rate Set in the 5.0GHz band. See SRSC2GHz
567 for the value\'s format.
569 Default: 4080 (or 0x0FF0, all 11a rates)
572 Sets the distance between Access Points in the network. This value
573 influences the Modem Thresholds (EnergyDetectThreshold,
574 CarrierDetectThreshold and DeferThreshold) and
575 the Roaming Thresholds (CellSearchThreshold and OutOfRangeThreshold).
586 Sets the data rate to be used by the transmitter. For Hermes-II:
588 1 \- Fixed Low (1 Mb/sec)
590 2 \- Fixed Standard (2 Mb/sec)
592 3 \- Auto Rate Select High (11, 5.5, 2, 1 Mb/sec)
594 4 \- Fixed Medium (5.5 Mb/sec)
596 5 \- Fixed High (11 Mb/sec)
598 6 \- Auto Rate Select Standard (2, 1 Mb/sec)
600 7 \- Auto Rate Select Medium (5.5, 2, 1 Mb/sec)
604 For Hermes-II.5, an INTEGER CONVERTED bit mask representing all of the
605 rates to support, where the rates supported are as follows:
607 Bit : 15|14|13|12|11|10|09|08|07|06|05|04|03|02|01|00
609 ------------------------------------------------------
611 Rate : XX|XX|XX|XX|54|48|36|24|18|12| 9| 6|11|5.5|2| 1
613 Default: 4095 (Translates to 0xFFF, which is all rates)
616 Sets the number of octets in a message or fragment above which a
617 RTS/CTS handshake is performed.
618 Valid values are 0 to 2347.
620 500 \- Hidden Stations
627 Designates which of the keys is to be used for the enciphering of data that is
628 transmitted by this station.
630 Integer in the range 1..4.
638 Sets the data rate to be used by the transmitter in Station mode.
644 3 \- Auto Rate Select (High)
650 6 \- Auto Rate Select (Standard)
652 7 \- Auto Rate Select (Medium)
656 For Hermes-II.5, an INTEGER CONVERTED bit mask representing all of the
657 rates to support, where the rates supported are as follows:
659 Bit : 15|14|13|12|11|10|09|08|07|06|05|04|03|02|01|00
661 ------------------------------------------------------
663 Rate : XX|XX|XX|XX|54|48|36|24|18|12| 9| 6|11|5.5|2| 1
665 Default: 4095 (Translates to 0xFFF, which is all rates)
669 Same as TxRateControl, only for port 1 in AccessPoint mode.
672 Same as TxRateControl1, only for port 2.
675 Same as TxRateControl1, only for port 3.
678 Same as TxRateControl1, only for port 4.
681 Same as TxRateControl1, only for port 5.
684 Same as TxRateControl1, only for port 6.
689 .B WDSAddress=n,n,n,n,n,n
690 MAC address that identifies the corresponding node of the WDS port in Station mode.
691 Note that for WDS to work properly, a bridge interface must be setup between the device and
692 the wds network devices created by the driver. For more information on bridge
693 interfaces, please refer to the man page for \'brctl\'.
695 Default: 00:00:00:00:00:00
697 .B WDSAddress1=n,n,n,n,n,n
698 Same as WDSAddress, only for port 1 in AccessPoint mode.
700 .B WDSAddress2=n,n,n,n,n,n
701 Same as WDSAddress1, only for port 2.
703 .B WDSAddress3=n,n,n,n,n,n
704 Same as WDSAddress1, only for port 3.
706 .B WDSAddress4=n,n,n,n,n,n
707 Same as WDSAddress1, only for port 4.
709 .B WDSAddress5=n,n,n,n,n,n
710 Same as WDSAddress1, only for port 5.
712 .B WDSAddress6=n,n,n,n,n,n
713 Same as WDSAddress1, only for port 6.
715 On a multi-user system only the system administrator needs access to the WEP
716 encryption keys. In this case, consider removing the read permission for
717 normal users of the PCMCIA config.opts file, the system log file, and any
718 Agere proprietary iwconfig-eth<n> scripts.
720 If you encounter problems when installing or using this product, or would like
721 information about our other "Wireless" products, please contact your local
722 Authorized "Wireless" Reseller or Agere Systems sales office.
724 Addresses and telephone numbers of the Agere Systems sales offices are
725 listed on our Agere Systems web site.