Release Notes
                        Allied Telesyn AT-29xx Linux Driver
                             Version 1.0.3                             

Table of Contents
=================

  Introduction
  Limitations
  Packaging
  Building Driver
  Module Parameters
  Revision History
  
			       
Introduction
============

This file describes the Linux driver for the Allied Telesyn AT-29xx series
10/100/1000 Mbps Ethernet Network Controllers.


Limitations
===========

The current version of the driver has been tested as a loadable module on
Red Hat 6.2, 7.0, 7.1, and 7.2 Linux distributions for i386 and ia64. Testing
has also been done on other similar Linux distributions using 2.2.x and 2.4.x
kernels.


Packaging
=========

The driver's source files are released in a compressed tar archive.


Building Driver 
===============

Note: You must have the kernel source code and the the full GCC library installed
      in order to build and load the driver. Consult the documentation for your
      version of Linux for further information.

1. Create a directory and extract the files:

   tar xvzf at29xx-1.0.3.tar.gz

2. Build the driver at29xx.o as a loadable module for the running kernel:

   make

3. Test the driver by loading it: 

   insmod at29xx.o

4. Install the driver:

   make install

5. To configure network protocol and address, refer to Linux documentations.


Module Parameters
=================

Optional parameters for the driver can be supplied as command line arguments 
to the insmod command. Typically, these parameters are set in the file
/etc/modules.conf (see the man page for modules.conf). These parameters take
the form

    <parameter>=value[,value,...]

where the multiple values for the same parameter are for multiple NICs
installed in the system.

Note that default values will be used when invalid values are selected.

All the parameters are listed below.

line_speed

    Selects the line speed of the link. This parameter is used together with
    full_duplex to select the speed and duplexity of the link.
    
    The valid values are:
    
    0      Autonegotiate (default)
    10     10 Mbps
    100    100 Mbps
    1000   1000 Mbps

    Note that 1000 Mbps must be negotiated for copper twisted pair links.

full_duplex

    Selects the duplexity of the link. This paramter is used together with
    line_speed to select the speed and duplexity of the link. Note that this
    parameter is ignored if line_speed is 0.
    
    The valid values are:
    
    0      half duplex
    1      full duplex (default)
    
rx_flow_control

    Enables or disables receiving flow control (pause) frames. This parameter
    is used together with auto_flow_control. The valid values are:
    
    0      pause receive disabled (default)
    1      pause receive enabled if auto_flow_control is set to 0, or
           pause receive advertised if auto_flow_control is set to 1

tx_flow_control

    Enables or disables transmitting flow control (pause) frames. This parameter
    is used together with auto_flow_control. The valid values are:
    
    0      pause transmit disabled (default)
    1      pause transmit enabled if auto_flow_control is set to 0, or
           pause transmit advertised if auto_flow_control is set to 1

auto_flow_control

    Enables or disables autonegotiation of flow control. This parameter is used
    together with rx_flow_control and tx_flow_control to determine the
    advertised flow control capability. The valid values are:
    
    0      flow control autonegotiation disabled (default)
    1      flow control autonegotiation enabled with capability specified in
           rx_flow_control and tx_flow_control (only valid if line_speed is
           set to 0)


Revision History
================
v1.0.3 (12/27/01)

- Fixed compile errors in 2.2.x kernels.
- Changed to use readl/writel macros for IO accesses.

v1.0.2 (11/07/01)

- Added SIOCETHTOOL support.

v1.0.1 (09/24/01)

- First release.