===================================================================
Lucent Technologies                                    July 2, 1999
WaveLAN/IEEE Software for Linux                        version 4.00
===================================================================

This file contains general information on the WaveLAN/IEEE PC Card,
and specific information for the Linux software.

*******************************************************************

               Table of Contents:

        1. About the Linux Driver Source/Library distribution
        2. Installation
        3. Troubleshooting
        4. Note about the IEEE 802.11 WaveLAN ISA Card
        5. Contents of the distribution
        6. Identifying the software
        7. Change History

*******************************************************************

1.  About the Linux Driver Source/Library distribution
    =======================================================

    The distribution archive wavelan2_cs-4.00.tar.gz contains driver
    source files and a library. With this software you can build and 
    install a WaveLAN/IEEE PC Card driver for your specific Linux kernel.
    Currently Linux kernel versions 2.0.x through 2.2.x for the Intel
    architecture are supported.

    The included HCF library implements an interface to the Lucent
    Technologies 802.11 MAC Controller, used in the WaveLAN/IEEE environment.


2.  Installation
    =======================================================

    1) Read the Linux PCMCIA-HOWTO by David Hinds.

    2) Extract the WaveLAN/IEEE distribution archive into the standard
       PCMCIA distribution.
       % cd pcmcia-cs-3.0.9
       % tar xzvf ../wavelan2_cs-4.00.tar.gz

    3) Build and install the PCMCIA package as normal.
       % make config
       % make all
       % make install

    4) Configure the WaveLAN/IEEE PC Card. Refer to the WaveLAN/IEEE
       manual page (wavelan2_cs.4) and the PCMCIA documentation for
       more information (network adapter sections).
       % man wavelan2_cs
       % more PCMCIA-HOWTO
       % vi /etc/pcmcia/config.opts

         For example:
           a) Attaching to an access point with the network name of
              "My Network", enter the following in the config.opts file:
   
                module "wavelan2_cs" opts "network_name=My\ Network"
   
              Notice that the space character needs to be escaped with a
              backslash.
           b) Ad-Hoc (peer-to-peer) network without an access point, enter
              the following in the config.opts file:
   
                module "wavelan2_cs" opts "port_type=3"
   
           c) Attach to an access point with the network name of "Ocean",
              and export the station name as "Wave1", enter the following
              in the config.opts file:
   
                module "wavelan2_cs" opts "network_name=Ocean station_name=Wave1"

       % vi /etc/pcmcia/network.opts
         Modify the network options for your adapter. The parameters need
         to be correct for the connected network. Check with your system
         administrator for the correct network information. Refer to the
         PCMCIA-HOWTO for more configuration information.

         For example:
              *,*,*,*)
                  IF_PORT=""
                  BOOTP="n"
                  IPADDR="10.0.0.5"
                  NETMASK="255.255.255.0"
                  NETWORK="10.0.0.0"
                  BROADCAST="10.0.0.255"
                  GATEWAY="10.0.0.1"
                  DOMAIN="domain.org"
                  DNS_1="dns1.domain.org"
                  ;;

    5) Restart the PCMCIA services.
       % /etc/rc.d/rc.pcmcia restart
         or
       % /etc/rc.d/init.d/pcmcia restart


3.  Troubleshooting
    =======================================================

    When the WaveLAN/IEEE PC Card is inserted, the card manager will emit 
    beeps in different tones to indicate success or failure of particular
    configuration steps.
      a) Two high beeps
         - The card was identified and configured successfully.
      b) One high beep followed by a low beep
         - The card was identified, but could not be configured.
         - Examine the system log (dmesg) for PCMCIA error or warning
           messages.
      c) One low beep
         - The card could not be identified.
         - Execute "cardctl ident" to display the adapter PnP information.
           Verify the PnP information matches an entry in the PCMCIA
           configuration file (/etc/pcmcia/config).
         - Examine the system log (dmesg) for PCMCIA error or warning
           messages.

    The WaveLAN/IEEE PC Card has two LEDs that indicate the state of the
    adapter and network.
      * Power LED (toward the middle of the adapter)
        - This LED indicates power has been applied, and the card is
          functional. In normal operation mode with Card Power Management
          disabled, it will be steady-on. With Card Power Management
          enabled, it will blink rapidly (several times per second).
      * Transmit/Receive LED (closer to the edge of the adapter)
        - This LED will flash when it detects transmit or receive packets.

      * Both LEDs blink at the same time every 10 seconds.
        - The adapter was unable to make contact with the named wireless
          network. Verify the network_name, in the config.opts file matches
          the network name of the access point.
      * LEDs indicate normal operation with the Power LED steady-on or
        blinking rapidly and Transmit/Receive LED flashing, but no traffic.
        - If the network is operating in normal mode (ie. port_type = 0 or
          not specified), and a network_name has been specified, verify the
          workstation network parameters (ifconfig, route, etc.) are correct
          for the wireless network.
        - If the network is operating in Ad-Hoc (peer-to-peer) mode
          (ie. port_type = 3), the adapter needs another workstation/adapter
          to communicate with. Verify the network parameters on both of the
          workstations (ifconfig, route, etc.) are correct.

    Refer to WaveLAN/IEEE manual page for additional configuration, feature
    and support information.
       % man wavelan2_cs 
         or
       % man 4 wavelan2_cs 
         or
       % nroff -man wavelan2_cs.4 | more


4.  Note about the IEEE 802.11 WaveLAN ISA Card
    =======================================================

    The swap-box that comes with the IEEE 802.11 WaveLAN ISA Card uses 
    (factory set default) I/O address 3E2. By default the i82365 module of 
    the pcmcia package only probes at 3E0. 
    To read the manual page on this, type the command:
       man i82365

    Two possible solutions are:

    1) Change the I/O address of the card. To do that see Figure C-1 
       "I/O Address Strapping of your ISA Card" in the "IEEE 802.11 WaveLAN,
       ISA Card User's Guide".

    2) Load the i82365 module with the "extra_sockets" parameter set to 1.

    On a RedHat 5.2 system, put this in the file "/etc/sysconfig/pcmcia":
       PCMCIA=yes
       PCIC=i82365
       PCIC_OPTS="extra_sockets=1"
       CORE_OPTS=
       CARDMGR_OPTS=
    Look in the PCMCIA-HOWTO for notes about the other distributions.


5.  Contents of the distribution
    =======================================================

    General information:
     README.wavelan2_cs              This file
     wavelan2_cs.mk                  Top level Makefile

    Driver source and HCF library:
     clients/wavelan2_cs.mk          Driver Makefile
     clients/wavelan2_cs.c           Driver source (v4.00)
     include/hcf/debug.h             Driver debug support
     include/hcf/libhcf.h            HCF interface definition
     lib/libhcf-i386.a               HCF library (v2.22a)

    Driver online manual page:
     man/wavelan2_cs.4               Driver manual page

    PCMCIA configuration update:
     etc/wavelan2_cs.mk              PCMCIA configuration update Makefile
     etc/wavelan2_cs.patch           PCMCIA configuration update patch file


6.  Identifying the software
    =======================================================

    The Linux Driver Source/Library distribution consist of two main
    components, the driver source and the HCF library. 

    To quickly identify the wavelan2_cs.c source, type: 
    % grep wavelan2_cs.c wavelan2_cs.c
    "wavelan2_cs.c 4.00 07/02/1999 15:00:00 (Lucent Technologies)";

    To identify the revision of the HCF library, type:
    % strings libhcf-i386.a | grep Revision
    HCF$Revision:   2.22


    To identify a compiled wavelan2_cs.o driver, goto the directory where
    the driver is located. Installed drivers are normally located in: 
    /lib/modules/<kernel-version>/pcmcia

    To retrieve the version of the source used to compile the driver, type:
    % strings wavelan2_cs.o | grep wavelan2_cs.c
    wavelan2_cs.c 4.00 07/02/1999 15:00:00 (Lucent Technologies)

    To retrieve the revision of the HCF library used to compile the driver,
    type:
    % strings wavelan2_cs.o | grep Revision
    HCF$Revision:   2.22


7.  Change History
    =======================================================

    Updates of the software and firmware are regularly made available
    via our WEB-site (www.wavelan.com).

    Following are the functional enhancements and major bug fixes of this
    PC Card software:

    Version 4.00             July 2, 1999

      * Added support for WEP encryption
      * Corrected string transfer of private ioctls used by the Wireless 
        extensions.
      * Support for signal levels in dBm; reported by the Wireless 
        extensions.
      * Support for CFG_DRV_IDENTITY moved from HCF to MSF.
      * Validate module parameters by default. This was only enabled in
        debug mode in the previous versions.
      * Fixed Card Power Management bug. Version 3.10 did not enable PM on 
        standard (2 Mbit/s) cards with STA firmware 2.00, when configured
        to enable PM.
      * Corrected module parameter type of irq_mask (h = short) and irq_list
        (1-4b = 1-4 bytes).

    Version 3.10             April 28, 1999

      * Changes to allow for the module parameter differences between
        Linux 2.0 and Linux 2.1. Linux 2.0 only allowed for 32-bit
        integer parameters, the 2.1 or later kernels allow for 8, 16
        and 32 bit parameters.
      * Added BSD clause to the GPL license.
      * Added support for Linux Wireless extensions.
      * Fixed the setting of the network_name and station_name when the
        name was empty or set to ANY for network_name.
      * The user can now enable Card Power Management:
        - This function should not be enabled until Station Functions
          firmware (v2.00 or higher) and WavePOINT-II Access Point
          software (v2.03 or higher) that supports Card Power Management,
          is installed. In case Card Power Management is nevertheless
          enabled before this firmware is installed, the driver will
          not effectuate Card Power Management.
      * Added support for transmit timeout handling.
      * Re-added channel parameter.
      * Renamed parameter receive_all_multicast to receive_all_multicasts
      * Changed the values of the parameters card_power_management and 
        receive_all_multicasts to 'Y' for Enable and 'N' for Disable. 

    Version 1.27 (Beta-2)    March 2, 1999

      First Source/Library distribution.
      * Changed module parameters names to better conform to the PCMCIA
        and 802.11 naming conventions.

    Version 1.20 (Beta-1)    February 9, 1999

      Binary only version for Slackware 3.6 (linux 2.0.35) and
      RedHat 5.2 (linux 2.0.36).

*******************************************************************
                                END OF FILE