AX88180 32-bit Mode Linux Kernel 2.4.x and 2.6.x Driver Release Note
===============================================

***************************************************************************
*  This program is free software; you can distribute it and/or modify it
*  under the terms of the GNU General Public License (Version 2) as
*  published by the Free Software Foundation.
*
*  This program is distributed in the hope it will be useful, but WITHOUT
*  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
*  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
*  for more details.
*
*  You should have received a copy of the GNU General Public License along
*  with this program; if not, write to the Free Software Foundation, Inc.,
*  59 Temple Place - Suite 330, Boston MA 02111-1307, USA.
***************************************************************************

Current Driver Version: 	1.1.0
Release Date:		Sep 20, 2006
Authur:			Allan Chou

Index:
======
1. Revision History
2. Product Description
3. File Description
4. Driver Compilation Commands
5. Driver Parameters
6. Driver Modification Notes
7. Known Issues
8. Support Information


1. Revision History
===================
Version	1.0.0		Dec. 07, 2005
 * New Release.

Version	1.0.1		June 15, 2006
 * 1.Modify to support AX88180 US2 chip. 
 * 2.Modify to support AX88180 US2 burst data access function.

Version	1.1.0		Sep 20, 2006
 * 1.Fixups initial functions.
 * 2.Ported to support kernel 2.6.x. 

2. Product Description
======================
The AX88180 Gigabit Ethernet controller is a high performance 
and highly integrated local CPU bus Ethernet controller with embedded 
40K bytes SRAM and supports both 16-bit and 32-bit SRAM-Like interfaces 
for any embedded systems. The AX88180 is a 10/100/1000Mbps Gigabit 
Ethernet controller that supports both MII and RGMII interfaces and 
is compliant to IEEE802.3, IEEE802.3u and IEEE802.3z standards.

The AX88180 32-bit mode Linux driver is developed and qualified under
a simplified SMDK2440 Linux kernel 2.6.17.11(2.4.20) environment by
running a long-time multi-section large-packet-size ping test.
There is no packet loss in the overnight testing. We will complete more
testing on this driver later.


3. File Description
===================
The AX88180 32-bit mode Linux driver is released in source code form
because there are too many different platforms in customers' site.
The driver designer should modify the source code to match the real
requirement of your platforms.  

RELEASE.TXT     This file
AX88180.C       AX88180 Linux driver main file
AX88180.H       AX88180 Linux driver header file
Makefile        AX88180 driver make file
COPYING	GNU GENERAL PUBLIC LICENSE


4. Driver Compilation
=====================
The following are the AX88180 Linux driver compilation commands 
for your reference,

4-1. Extracting the driver source file by executing the following command.
     [root@localhost]# tar jxvf ax88180-arm-linux-verxxx.tar.bz2

4-2. Edit the makefile to specify the path of target platform Kernel source.
     example for kernel 2.6.x:
         CURRENT = 2.6.x
         KDIR = /work/linux-2.6.x
     example for kernel 2.4.x:
         CURRENT = 2.4.x
         KDIR = /work/linux-2.4.x/include

4-3. For kernel 2.4.x , you need to specify the path of Cross-Compiler
     example
         CROSS_COMPILE = /usr/local/arm/<versions>/bin/arm-linux-

4-4. Executing 'make' command to compiler AX88180 Driver.

4-5. If the compilation well, the ax88180.ko(ax88180.o) will be created under the     current directory.



5. Driver Parameters
====================
AX88180 Linux driver supports the "mem", "irq", "media" and "jumbo" parameters. 
The "mem" and "irq" parameters are used to assign AX88180 memory base address 
and IRQ number that are dependent on different platforms. The default memory 
base address (0x08000000) and IRQ (0x27) of AX88180 Linux driver are worked 
under SMDK2440 platform only. The "media" parameter is used to configure 
AX88180 internal PHY media mode, and the "jumbo" parameter is used to 
enable/disable Jumbo frame function. The Jumbo frame function is only supported 
for 1000Mbps Full-duplex mode. The max RX Jumbo frame size of AX88180 is 
15K bytes and the max TX Jumbo frame size is 4088 bytes when the Jumbo frame 
function is enabled.

5-1. AX88180 module mode driver
      
     insmod ax88180.ko(ax88180.o) mem=0xXXXXXXXX irq=0xXX media=<media_type> jumbo=x

     mem	Set memory base address (default is 0x08000000)
     irq	Set IRQ number (default is 0x27)
     media	Set media mode (0=auto, 1=100full, 2=100half, 3=10full, 4=10half) (default is 0)
     jumbo	Enable/disable Jumbo frame (1=enable, 0=disable)(default is 0)

     example: insmod ax88180.ko(ax88180.o) mem=0x08000000 irq=0x27 media=0 jumbo=0


6. Driver Modification Notes
============================
AX88180 supports system reference clock from 40MHZ to 100MHZ, but the 
default HCLK clock of SMDK2440 is 125MHZ. So the driver need to configure 
the HCLK clock of SMDK2440 to 100MHZ. 

/* Set HCLK=FCLK/4, PCLK=HCLK/2 when CAMDIVN[9]=0 */
#define	CLKDIVN_100MHZ 		0x0000000D 
#define	CAMDIVN_100MHZ		0x00000000	

/* Set UART Baud Rate divisor for 100MHZ HCLK */
#define UBRDIV0_100MHZ		0x0000001B	

/* Set Bank 1 access timing 6 clocks with page access */
#define	BANKCON1_6CLKS_PAGE	0x0000040F


CLKDIVN = CLKDIVN_100MHZ;
CAMDIVN = CAMDIVN_100MHZ;
UBRDIV0 = UBRDIV0_100MHZ;
BANKCON1 = BANKCON1_6CLKS_PAGE;


7. Known Issues
===============
None.


8. Support Information
======================
4F, No.8, Hsin Ann Rd., Hsinchu Science Park,
Hsinchu, Taiwan, R.O.C.

TEL: +886-3-5799500
FAX: +886-3-5799558

Email:  support@asix.com.tw
Web:  http://www.asix.com.tw/