.\" wavelan2_cs.4 6.16 2001/11/23 13:00:00
.\"
.TH WAVELAN2_CS 4 "2001/11/23 13:00:00" "pcmcia-cs"
.SH NAME
wavelan2_cs \- Avaya Wireless PC Card device driver
.SH SYNOPSIS
.B insmod wavelan2_cs.o
.RB [ irq_mask=n ]
.RB [ irq_list=i,j,... ]
.RB [ pc_debug=n ]
.RB [ debug_flags=n ]
.RB [ network_name=s ]
.RB [ port_type=n ]
.RB [ channel=n ]
.RB [ create_ibss=s ]
.RB [ distance_between_aps=n ]
.RB [ transmit_rate=n ]
.RB [ medium_reservation=n ]
.RB [ card_power_management=s ]
.RB [ microwave_robustness=s ]
.RB [ receive_all_multicasts=s ]
.RB [ maximum_sleep_duration=n ]
.RB [ mac_address=n,n,n,n,n,n ]
.RB [ station_name=s ]
.RB [ enable_encryption=s ]
.RB [ key_1=s ]
.RB [ key_2=s ]
.RB [ key_3=s ]
.RB [ key_4=s ]
.RB [ transmit_key_id=n ]
.SH DESCRIPTION
.I wavelan2_cs
is the low-level Card Services driver for the
.B Avaya Wireless PC Card
adapters. When this driver is attached to a card, it
allocates the next available ethernet device (eth0..eth#). This
device name will be passed on to
.IR cardmgr (8)
for the card configuration, and reported in the kernel log file with
the I/O base address and MAC address used by the card.
.SH FEATURES
 \- Hot plug/unplug
 \- Access Point and peer-to-peer communication
 \- Card power management
 \- Standard, Turbo and Turbo 11Mb cards (with firmware 4.x or higher)
 \- Wired Equivalent Privacy (WEP)
 \- Driver utility interface (UIL)
.SH PARAMETERS
.TP
.B irq_mask=n
Specifies a mask of valid interrupts that may be allocated by this driver.
If
.B irq_list
is also specified, the values in
.B irq_list
are used instead.
.BR
    Default: 0xdeb8 (IRQ 3,4,5,7,9,10,11,12,14,15)
.TP
.B irq_list=i,j,...
Specifies the set of interrupts (up to 4) that may be allocated by
this driver. This overrides the values set in the
.B irq_mask
parameter.
.TP
.B pc_debug=n
Selects the PCMCIA debugging level. This parameter is only available
if the module is compiled with debugging enabled. A non\-zero value
enables debugging.
.TP
.B debug_flags=n
Selects the driver debugging level. This parameter is only available
if the module is compiled with debugging enabled. Refer to the
file
.B debug.h
in the source directory for information on the flag values.
.TP
.B network_name=s
Sets the card network name to the specified string value. This parameter
accepts a maximum of 32 characters. Whitespace in the network name
will need to be escaped with a backslash (ie. network_name=My\\ Network).
.BR
    Default: ANY
.TP
.B port_type=n
Selects the type of network operation.
.BR
    1 \- Normal Operation (BSS or IBSS)
.BR
    3 \- Ad-Hoc Demo Mode
.BR
    Default: 1
.TP
.B channel=n
Sets the channel the Ad-Hoc or IBSS mode will use. 
The default channel for Ad-Hoc mode is determined by the Wireless PC Card.
The default channel for IBSS is set to 10 by the driver.
This value has no effect when the adapter is used with an Access Point
(BSS network) since the Access Point automatically determines the channel. 
Valid values are 0 to 14. However the channels allowed in
your region are subject to local regulations and are limited at
manufacturing time of the Wireless PC Card. When the provided value is
not allowed, the value remains unchanged. 
.BR
    0 \- Use default channel
.BR
    Default: 0
.TP
.B create_ibss=s
Enable or disable IBSS Creation. 
For correct operation, specification of a network_name is required. 
This mode requires firmware 6.04 or higher.
.BR
    N \- Disable
.BR
    Y \- Enable
.BR
    Default: N
.TP
.B distance_between_aps=n
Sets the distance between Access Points in the network. This value
influences the Modem Thresholds (EnergyDetectThreshold,
CarrierDetectThreshold and DeferThreshold) and
the Roaming Thresholds (CellSearchThreshold and OutOfRangeThreshold).
.BR
    1 \- Large
.BR
    2 \- Medium
.BR
    3 \- Small
.BR
    Default: 1
.TP
.B transmit_rate=n
Sets the data rate to be used by the transmitter.
.BR
    1 \- Fixed Low
.BR
    2 \- Fixed Standard
.BR
    3 \- Auto Rate Select (High)
.BR
    4 \- Fixed Medium
.BR
    5 \- Fixed High
.BR
    6 \- Auto Rate Select (Standard)
.BR
    7 \- Auto Rate Select (Medium)
.BR
    Default: 3
.TP
.B medium_reservation=n
Sets the number of octets in a message or fragment above which a
RTS/CTS handshake is performed.
Valid values are 0 to 2347.
.BR
    500  \- Hidden Stations
.BR
    2347 \- No RTS/CTS
.BR
    Default: 2347
.TP
.B card_power_management=s
Enable or disable card Power Management.
.BR
    N \- Disable
.BR
    Y \- Enable
.BR
    Default: N
.TP
.B microwave_robustness=s
Enable or disable Microwave Oven Robustness.
.BR
    N \- Disable
.BR
    Y \- Enable
.BR
    Default: N
.TP
.B receive_all_multicasts=s
Enable or disable receiving of all multicast packets when Card Power Management
is enabled. When enabled, the station will wake up frequently
to receive the multicast frames. This causes less optimal power savings.
.BR
    N \- Disable
.BR
    Y \- Enable
.BR
    Default: Y
.TP
.B maximum_sleep_duration=n
Set the maximum Power Management sleep duration in milliseconds.
Valid values are 0 to 65535 milliseconds.
.BR
    Default: 100
.TP
.B mac_address=n,n,n,n,n,n
Sets the adapter hardware ethernet address (MAC address) to the value
specified. Note that this is to be used to specify a Local MAC address. Do
not specify this parameter if the card's universal address is to be used.
Valid values are six hexadecimal digit-pairs (prefixed with 0x).
.BR
    Default: <factory assigned address>
.TP
.B station_name=s
Sets the station name to the specified string value. This parameter
is used for diagnostic purposes, as a user\-friendly identification
of this system. This parameter accepts a maximum of 32 characters.
.BR
    Default: Linux
.TP
.B enable_encryption=s
Enables or disables encryption of Data, provided the card supports
Data Encryption (i.e. Silver or Gold card).
.BR
    N \- Disable
.BR
    Y \- Enable
.BR
    Default: N
.TP
.B key_1=s
Specifies one of 4 possible keys for the Data encryption. 
One of these keys, identified by Transmit_Key_ID, 
is used for the enciphering of Data that is transmitted by this station. 
All keys specified can be used for the deciphering of Data that is received.
.BR
The key value can be an ASCII character string or a hexadecimal value. 
The length of the key value can be 5 characters or 10 hexadecimal digits for 
the standard encryption (Silver or Gold card), or 13 characters or 26 
hexadecimal digits for the encryption with extended keys (Gold card only).
The keys defined in the station must match the keys defined in the access 
points; both on value and number (1 through 4).
.BR
In 2.0 series Linux kernel modules, values that begin with a number are
considered integers. In this case a hexadecimal value string or a character
string starting with a number, will need to be surrounded by escaped 
double quotes (ie. key_1=\\"0x1122334455\\" key_2=\\"12xyz\\").
.BR
    5 or 13, printable character string, or 
.BR
    10 or 26 hex digits if preceded by "0x".
.BR
    If this parameter is omitted, the default of the MAC is used ( = 0-length).
.TP
.B key_2=s
Same as key_1.
.TP
.B key_3=s
Same as key_1.
.TP
.B key_4=s
Same as key_1.
.TP
.B transmit_key_id=n
Designates which of the keys is to be used for the enciphering of data that is
transmitted by this station.
.BR
    Integer in the range 1..4.
.BR
    Default: 1
.SH SECURITY
On a multi-user system only the system administrator needs access to the WEP
encryption keys. In this case, consider to remove the read permission for
normal users of the PCMCIA config.opts file and the system log file.
.SH CONTACT
If you encounter problems when installing or using this product, or would like
information about our other Avaya Wireless products, please contact your local
reseller or Avaya Sales office.
    
Addresses and telephone numbers of the Avaya Sales offices are 
listed on our web site.
.TP
.B WWW
http://www.avaya.com
.SH SEE ALSO
.BR cardmgr (8),
.BR pcmcia (5),
.BR ifconfig (8),
.BR insmod (8).