include upstream ip1000a driver version 2.09f
[linux-2.4.git] / drivers / net / ip1000a / readme.txt
diff --git a/drivers/net/ip1000a/readme.txt b/drivers/net/ip1000a/readme.txt
new file mode 100644 (file)
index 0000000..36d8cca
--- /dev/null
@@ -0,0 +1,141 @@
+\r
+            IC Plus IP1000 Gigabit Ethernet Adapter \r
+                        Linux driver \r
+\r
+Contents:\r
+-----------\r
+1. File Description\r
+2. Driver Installation for Linux\r
+3. Jumbo Support\r
+\r
+1. File Description\r
+-------------------\r
+\r
+Filename                Description\r
+====================    =======================================================\r
+ipg.c                   IC Plus IP1000 Linux Driver Source Code.\r
+                        This file is the main part of IP1000 Linux Driver.\r
+\r
+makefile                Make File For IP1000 Linux Driver.\r
+                        Using "make all", "make smp", "make bigmem" for your \r
+                        kernel.\r
+\r
+make2.2.sh              Make Shell Script For Linux 2.2.x Kernel.\r
+\r
+make2.2mod.sh           Make Shell Script For Linux 2.2.x Kernel.\r
+\r
+PhyParam.h              IP1000 Hardware Parameters modification file.\r
+                        It would have new version for new version of NIC on IC \r
+                        Plus web site.\r
+\r
+ipg_tune.h              Include File For IP1000 Linux Driver.\r
+\r
+ipg_structs.h           Include File For IP1000 Linux Driver.\r
+\r
+ipg_macros.h            Include File For IP1000 Linux Driver.\r
+\r
+ipg_constants.h         Include File For IP1000 Linux Driver.\r
+\r
+readme.txt              A summary of the contents for Linux Driver.\r
+                        This file, which you are reading me now.\r
+\r
+\r
+\r
+2. Driver Installation for Linux\r
+-----------------------------------------\r
+a. for kernel 2.4.x\r
+   a1. Redhat 7.3 (linux kernel 2.4.18)\r
+   a2. Mandrake 8.1 (kernel 2.4.8)\r
+b. for kernel 2.6.x\r
+c. for bigmem and smp.\r
+\r
+        a.for kernel 2.4.x\r
+        -------------------\r
+          a1. Redhat 7.3 (linux kernel 2.4.18)\r
+          a1.1. install way 1:\r
+              #make all =>generate ipg.o\r
+              #cp ipg.o /lib/modules/2.4.18-3/kernel/drivers/net/\r
+              #insmod ./ipg.o\r
+              #ifconfig eth0 xxx.xxx.xxx.xxx netmask yyy.yyy.yyy.yyy\r
+              eth0 is your network adapter,use "dmesg" to check it, \r
+                   ex: eth0, eth1...\r
+              xxx  is your ip address, ex: 192.168.102.211\r
+              yyy  is your netmask address, ex:255.255.255.0\r
+\r
+          a1.2.  install way 2:\r
+             #make all =>generate ipg.o\r
+             #cp ipg.o /lib/modules/2.4.18-3/kernel/drivers/net/\r
+             #insmod ./ipg.o\r
+             #setup\r
+                   [network configuration] =>to setup your ip address\r
+             #ifup eth0\r
+                 eth0 is your network adapter, ex: eth0, eth1...\r
+\r
+\r
+          a2. Mandrake 8.1 (kernel 2.4.8)\r
+             #make all  => generate ipg.o\r
+             #cp ipg.o /lib/modules/2.4.8-26mdk/kernel/drivers/net\r
+             #insmod ./ipg.o\r
+             #ifconfig eth0 xxx.xxx.xxx.xxx netmask yyy.yyy.yyy.yyy\r
+             eth0 is your network adapter,use "dmesg" to check it, \r
+                  ex: eth0, eth1...\r
+             xxx  is your ip address, ex: 192.168.102.211\r
+             yyy  is your netmask address, ex:255.255.255.0\r
+\r
+        b. for kernel 2.6.x\r
+        -------------------\r
+           #make all  => generate ipg.ko\r
+           #insmod ./ipg.ko\r
+           #ifconfig eth0 xxx.xxx.xxx.xxx netmask yyy.yyy.yyy.yyy\r
+              eth0 is your network adapter,use "dmesg" to check it, ex: eth0, eth1...\r
+              xxx  is your ip address, ex: 192.168.102.211\r
+              yyy  is your netmask address, ex:255.255.255.0 \r
+           ========================================================================\r
+           example for Mandrake 10 automatically load:\r
+           #make all  => generate ipg.ko\r
+           #uname -r\r
+           #2.6.11-6mdk  => Depending on various Linux versions\r
+           #cp ipg.o /lib/modules/2.6.11-6mdk/kernel/drivers/net  => Just for Mandrake 10 example.\r
+           #insmod ./ipg.ko (or ipg.o)\r
+           #ifconfig eth0 xxx.xxx.xxx.xxx netmask yyy.yyy.yyy.yyy\r
+           ======================================================================== \r
+\r
+        c. for bigmem and smp.\r
+        ----------------------\r
+           c1. If your kernel was in bigmem, using:\r
+             #make bigmem\r
+\r
+           c2. If your kernel was in smp, using:\r
+             #make smp\r
+\r
+\r
+3. Jumbo Support\r
+----------------------\r
+\r
+In Makefile:\r
+3.1. Open Jumbo Support:\r
+MAPPING_MODE= -DUSE_IO_OPS -DJUMBO_FRAME\r
+\r
+3.2. Close Jumbo Support\r
+MAPPING_MODE= -DUSE_IO_OPS\r
+\r
+3.3. Jumbo Support for RX 10K and TX 10K\r
+3.3.1. Change max jumbo frame support size, please change JUMBO_FRAME_SIZE_xxxx option to modify \r
+         support size, the more large frame support need more memory to use, the best performence for\r
+         IP1000A may be "JUMBO_FRAME_SIZE_4K". \r
+\r
+         Note: After changed JUMBO_FRAME_SIZE_xxxx option, please "make clean" then "make" again.\r
+\r
+in Makefile:\r
+MAPPING_MODE= -DUSE_IO_OPS -DJUMBO_FRAME -DJUMBO_FRAME_SIZE_4K\r
+\r
+Usiable options:\r
+JUMBO_FRAME_SIZE_2K\r
+JUMBO_FRAME_SIZE_3K\r
+JUMBO_FRAME_SIZE_4K\r
+JUMBO_FRAME_SIZE_5K\r
+JUMBO_FRAME_SIZE_6K\r
+JUMBO_FRAME_SIZE_7K\r
+JUMBO_FRAME_SIZE_8K\r
+JUMBO_FRAME_SIZE_9K\r
+JUMBO_FRAME_SIZE_10K
\ No newline at end of file