include upstream ip1000a driver version 2.09f
[linux-2.4.git] / drivers / net / ip1000a / readme.txt
1 \r
2             IC Plus IP1000 Gigabit Ethernet Adapter \r
3                         Linux driver \r
4 \r
5 Contents:\r
6 -----------\r
7 1. File Description\r
8 2. Driver Installation for Linux\r
9 3. Jumbo Support\r
10 \r
11 1. File Description\r
12 -------------------\r
13 \r
14 Filename                Description\r
15 ====================    =======================================================\r
16 ipg.c                   IC Plus IP1000 Linux Driver Source Code.\r
17                         This file is the main part of IP1000 Linux Driver.\r
18 \r
19 makefile                Make File For IP1000 Linux Driver.\r
20                         Using "make all", "make smp", "make bigmem" for your \r
21                         kernel.\r
22 \r
23 make2.2.sh              Make Shell Script For Linux 2.2.x Kernel.\r
24 \r
25 make2.2mod.sh           Make Shell Script For Linux 2.2.x Kernel.\r
26 \r
27 PhyParam.h              IP1000 Hardware Parameters modification file.\r
28                         It would have new version for new version of NIC on IC \r
29                         Plus web site.\r
30 \r
31 ipg_tune.h              Include File For IP1000 Linux Driver.\r
32 \r
33 ipg_structs.h           Include File For IP1000 Linux Driver.\r
34 \r
35 ipg_macros.h            Include File For IP1000 Linux Driver.\r
36 \r
37 ipg_constants.h         Include File For IP1000 Linux Driver.\r
38 \r
39 readme.txt              A summary of the contents for Linux Driver.\r
40                         This file, which you are reading me now.\r
41 \r
42 \r
43 \r
44 2. Driver Installation for Linux\r
45 -----------------------------------------\r
46 a. for kernel 2.4.x\r
47    a1. Redhat 7.3 (linux kernel 2.4.18)\r
48    a2. Mandrake 8.1 (kernel 2.4.8)\r
49 b. for kernel 2.6.x\r
50 c. for bigmem and smp.\r
51 \r
52         a.for kernel 2.4.x\r
53         -------------------\r
54           a1. Redhat 7.3 (linux kernel 2.4.18)\r
55           a1.1. install way 1:\r
56               #make all =>generate ipg.o\r
57               #cp ipg.o /lib/modules/2.4.18-3/kernel/drivers/net/\r
58               #insmod ./ipg.o\r
59               #ifconfig eth0 xxx.xxx.xxx.xxx netmask yyy.yyy.yyy.yyy\r
60               eth0 is your network adapter,use "dmesg" to check it, \r
61                    ex: eth0, eth1...\r
62               xxx  is your ip address, ex: 192.168.102.211\r
63               yyy  is your netmask address, ex:255.255.255.0\r
64 \r
65           a1.2.  install way 2:\r
66              #make all =>generate ipg.o\r
67              #cp ipg.o /lib/modules/2.4.18-3/kernel/drivers/net/\r
68              #insmod ./ipg.o\r
69              #setup\r
70                    [network configuration] =>to setup your ip address\r
71              #ifup eth0\r
72                  eth0 is your network adapter, ex: eth0, eth1...\r
73 \r
74 \r
75           a2. Mandrake 8.1 (kernel 2.4.8)\r
76              #make all  => generate ipg.o\r
77              #cp ipg.o /lib/modules/2.4.8-26mdk/kernel/drivers/net\r
78              #insmod ./ipg.o\r
79              #ifconfig eth0 xxx.xxx.xxx.xxx netmask yyy.yyy.yyy.yyy\r
80              eth0 is your network adapter,use "dmesg" to check it, \r
81                   ex: eth0, eth1...\r
82              xxx  is your ip address, ex: 192.168.102.211\r
83              yyy  is your netmask address, ex:255.255.255.0\r
84 \r
85         b. for kernel 2.6.x\r
86         -------------------\r
87            #make all  => generate ipg.ko\r
88            #insmod ./ipg.ko\r
89            #ifconfig eth0 xxx.xxx.xxx.xxx netmask yyy.yyy.yyy.yyy\r
90               eth0 is your network adapter,use "dmesg" to check it, ex: eth0, eth1...\r
91               xxx  is your ip address, ex: 192.168.102.211\r
92               yyy  is your netmask address, ex:255.255.255.0 \r
93            ========================================================================\r
94            example for Mandrake 10 automatically load:\r
95            #make all  => generate ipg.ko\r
96            #uname -r\r
97            #2.6.11-6mdk  => Depending on various Linux versions\r
98            #cp ipg.o /lib/modules/2.6.11-6mdk/kernel/drivers/net  => Just for Mandrake 10 example.\r
99            #insmod ./ipg.ko (or ipg.o)\r
100            #ifconfig eth0 xxx.xxx.xxx.xxx netmask yyy.yyy.yyy.yyy\r
101            ======================================================================== \r
102 \r
103         c. for bigmem and smp.\r
104         ----------------------\r
105            c1. If your kernel was in bigmem, using:\r
106              #make bigmem\r
107 \r
108            c2. If your kernel was in smp, using:\r
109              #make smp\r
110 \r
111 \r
112 3. Jumbo Support\r
113 ----------------------\r
114 \r
115 In Makefile:\r
116 3.1. Open Jumbo Support:\r
117 MAPPING_MODE= -DUSE_IO_OPS -DJUMBO_FRAME\r
118 \r
119 3.2. Close Jumbo Support\r
120 MAPPING_MODE= -DUSE_IO_OPS\r
121 \r
122 3.3. Jumbo Support for RX 10K and TX 10K\r
123 3.3.1. Change max jumbo frame support size, please change JUMBO_FRAME_SIZE_xxxx option to modify \r
124          support size, the more large frame support need more memory to use, the best performence for\r
125          IP1000A may be "JUMBO_FRAME_SIZE_4K". \r
126 \r
127          Note: After changed JUMBO_FRAME_SIZE_xxxx option, please "make clean" then "make" again.\r
128 \r
129 in Makefile:\r
130 MAPPING_MODE= -DUSE_IO_OPS -DJUMBO_FRAME -DJUMBO_FRAME_SIZE_4K\r
131 \r
132 Usiable options:\r
133 JUMBO_FRAME_SIZE_2K\r
134 JUMBO_FRAME_SIZE_3K\r
135 JUMBO_FRAME_SIZE_4K\r
136 JUMBO_FRAME_SIZE_5K\r
137 JUMBO_FRAME_SIZE_6K\r
138 JUMBO_FRAME_SIZE_7K\r
139 JUMBO_FRAME_SIZE_8K\r
140 JUMBO_FRAME_SIZE_9K\r
141 JUMBO_FRAME_SIZE_10K