Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | lne390.c | |
3 | ||
4 | Linux driver for Mylex LNE390 EISA Network Adapter | |
5 | ||
6 | Copyright (C) 1996-1998, Paul Gortmaker. | |
7 | ||
8 | This software may be used and distributed according to the terms | |
9 | of the GNU General Public License, incorporated herein by reference. | |
10 | ||
11 | Information and Code Sources: | |
12 | ||
13 | 1) Based upon framework of es3210 driver. | |
14 | 2) The existing myriad of other Linux 8390 drivers by Donald Becker. | |
15 | 3) Russ Nelson's asm packet driver provided additional info. | |
16 | 4) Info for getting IRQ and sh-mem gleaned from the EISA cfg files. | |
17 | ||
18 | The LNE390 is an EISA shared memory NS8390 implementation. Note | |
19 | that all memory copies to/from the board must be 32bit transfers. | |
20 | There are two versions of the card: the lne390a and the lne390b. | |
21 | Going by the EISA cfg files, the "a" has jumpers to select between | |
22 | BNC/AUI, but the "b" also has RJ-45 and selection is via the SCU. | |
23 | The shared memory address selection is also slightly different. | |
24 | Note that shared memory address > 1MB are supported with this driver. | |
25 | ||
26 | You can try <http://www.mylex.com> if you want more info, as I've | |
27 | never even seen one of these cards. :) | |
28 | ||
29 | Arnaldo Carvalho de Melo <acme@conectiva.com.br> - 2000/09/01 | |
30 | - get rid of check_region | |
31 | - no need to check if dev == NULL in lne390_probe1 | |
32 | */ | |
33 | ||
34 | static const char *version = | |
35 | "lne390.c: Driver revision v0.99.1, 01/09/2000\n"; | |
36 | ||
37 | #include <linux/module.h> | |
38 | #include <linux/eisa.h> | |
39 | #include <linux/kernel.h> | |
40 | #include <linux/errno.h> | |
41 | #include <linux/string.h> | |
42 | #include <linux/delay.h> | |
43 | #include <linux/init.h> | |
a6b7a407 | 44 | #include <linux/interrupt.h> |
1da177e4 LT |
45 | #include <linux/netdevice.h> |
46 | #include <linux/etherdevice.h> | |
47 | ||
48 | #include <asm/io.h> | |
49 | #include <asm/system.h> | |
50 | ||
51 | #include "8390.h" | |
52 | ||
53 | #define DRV_NAME "lne390" | |
54 | ||
55 | static int lne390_probe1(struct net_device *dev, int ioaddr); | |
56 | ||
1da177e4 LT |
57 | static void lne390_reset_8390(struct net_device *dev); |
58 | ||
59 | static void lne390_get_8390_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr, int ring_page); | |
60 | static void lne390_block_input(struct net_device *dev, int count, struct sk_buff *skb, int ring_offset); | |
61 | static void lne390_block_output(struct net_device *dev, int count, const unsigned char *buf, const int start_page); | |
62 | ||
63 | #define LNE390_START_PG 0x00 /* First page of TX buffer */ | |
64 | #define LNE390_STOP_PG 0x80 /* Last page +1 of RX ring */ | |
65 | ||
66 | #define LNE390_ID_PORT 0xc80 /* Same for all EISA cards */ | |
67 | #define LNE390_IO_EXTENT 0x20 | |
68 | #define LNE390_SA_PROM 0x16 /* Start of e'net addr. */ | |
69 | #define LNE390_RESET_PORT 0xc84 /* From the pkt driver source */ | |
70 | #define LNE390_NIC_OFFSET 0x00 /* Hello, the 8390 is *here* */ | |
71 | ||
72 | #define LNE390_ADDR0 0x00 /* 3 byte vendor prefix */ | |
73 | #define LNE390_ADDR1 0x80 | |
74 | #define LNE390_ADDR2 0xe5 | |
75 | ||
76 | #define LNE390_ID0 0x10009835 /* 0x3598 = 01101 01100 11000 = mlx */ | |
77 | #define LNE390_ID1 0x11009835 /* above is the 390A, this is 390B */ | |
78 | ||
79 | #define LNE390_CFG1 0xc84 /* NB: 0xc84 is also "reset" port. */ | |
80 | #define LNE390_CFG2 0xc90 | |
81 | ||
82 | /* | |
83 | * You can OR any of the following bits together and assign it | |
84 | * to LNE390_DEBUG to get verbose driver info during operation. | |
85 | * Currently only the probe one is implemented. | |
86 | */ | |
87 | ||
88 | #define LNE390_D_PROBE 0x01 | |
89 | #define LNE390_D_RX_PKT 0x02 | |
90 | #define LNE390_D_TX_PKT 0x04 | |
91 | #define LNE390_D_IRQ 0x08 | |
92 | ||
93 | #define LNE390_DEBUG 0 | |
94 | ||
95 | static unsigned char irq_map[] __initdata = {15, 12, 11, 10, 9, 7, 5, 3}; | |
96 | static unsigned int shmem_mapA[] __initdata = {0xff, 0xfe, 0xfd, 0xfff, 0xffe, 0xffc, 0x0d, 0x0}; | |
97 | static unsigned int shmem_mapB[] __initdata = {0xff, 0xfe, 0x0e, 0xfff, 0xffe, 0xffc, 0x0d, 0x0}; | |
98 | ||
99 | /* | |
100 | * Probe for the card. The best way is to read the EISA ID if it | |
101 | * is known. Then we can check the prefix of the station address | |
102 | * PROM for a match against the value assigned to Mylex. | |
103 | */ | |
104 | ||
105 | static int __init do_lne390_probe(struct net_device *dev) | |
106 | { | |
107 | unsigned short ioaddr = dev->base_addr; | |
108 | int irq = dev->irq; | |
109 | int mem_start = dev->mem_start; | |
110 | int ret; | |
111 | ||
1da177e4 LT |
112 | if (ioaddr > 0x1ff) { /* Check a single specified location. */ |
113 | if (!request_region(ioaddr, LNE390_IO_EXTENT, DRV_NAME)) | |
114 | return -EBUSY; | |
115 | ret = lne390_probe1(dev, ioaddr); | |
116 | if (ret) | |
117 | release_region(ioaddr, LNE390_IO_EXTENT); | |
118 | return ret; | |
119 | } | |
120 | else if (ioaddr > 0) /* Don't probe at all. */ | |
121 | return -ENXIO; | |
122 | ||
123 | if (!EISA_bus) { | |
124 | #if LNE390_DEBUG & LNE390_D_PROBE | |
125 | printk("lne390-debug: Not an EISA bus. Not probing high ports.\n"); | |
126 | #endif | |
127 | return -ENXIO; | |
128 | } | |
129 | ||
130 | /* EISA spec allows for up to 16 slots, but 8 is typical. */ | |
131 | for (ioaddr = 0x1000; ioaddr < 0x9000; ioaddr += 0x1000) { | |
132 | if (!request_region(ioaddr, LNE390_IO_EXTENT, DRV_NAME)) | |
133 | continue; | |
134 | if (lne390_probe1(dev, ioaddr) == 0) | |
135 | return 0; | |
136 | release_region(ioaddr, LNE390_IO_EXTENT); | |
137 | dev->irq = irq; | |
138 | dev->mem_start = mem_start; | |
139 | } | |
140 | ||
141 | return -ENODEV; | |
142 | } | |
143 | ||
1da177e4 LT |
144 | #ifndef MODULE |
145 | struct net_device * __init lne390_probe(int unit) | |
146 | { | |
147 | struct net_device *dev = alloc_ei_netdev(); | |
148 | int err; | |
149 | ||
150 | if (!dev) | |
151 | return ERR_PTR(-ENOMEM); | |
152 | ||
153 | sprintf(dev->name, "eth%d", unit); | |
154 | netdev_boot_setup_check(dev); | |
155 | ||
156 | err = do_lne390_probe(dev); | |
157 | if (err) | |
158 | goto out; | |
1da177e4 | 159 | return dev; |
1da177e4 LT |
160 | out: |
161 | free_netdev(dev); | |
162 | return ERR_PTR(err); | |
163 | } | |
164 | #endif | |
165 | ||
166 | static int __init lne390_probe1(struct net_device *dev, int ioaddr) | |
167 | { | |
168 | int i, revision, ret; | |
169 | unsigned long eisa_id; | |
170 | ||
171 | if (inb_p(ioaddr + LNE390_ID_PORT) == 0xff) return -ENODEV; | |
172 | ||
173 | #if LNE390_DEBUG & LNE390_D_PROBE | |
174 | printk("lne390-debug: probe at %#x, ID %#8x\n", ioaddr, inl(ioaddr + LNE390_ID_PORT)); | |
175 | printk("lne390-debug: config regs: %#x %#x\n", | |
176 | inb(ioaddr + LNE390_CFG1), inb(ioaddr + LNE390_CFG2)); | |
177 | #endif | |
178 | ||
179 | ||
180 | /* Check the EISA ID of the card. */ | |
181 | eisa_id = inl(ioaddr + LNE390_ID_PORT); | |
182 | if ((eisa_id != LNE390_ID0) && (eisa_id != LNE390_ID1)) { | |
183 | return -ENODEV; | |
184 | } | |
185 | ||
186 | revision = (eisa_id >> 24) & 0x01; /* 0 = rev A, 1 rev B */ | |
6aa20a22 | 187 | |
1da177e4 LT |
188 | #if 0 |
189 | /* Check the Mylex vendor ID as well. Not really required. */ | |
190 | if (inb(ioaddr + LNE390_SA_PROM + 0) != LNE390_ADDR0 | |
191 | || inb(ioaddr + LNE390_SA_PROM + 1) != LNE390_ADDR1 | |
192 | || inb(ioaddr + LNE390_SA_PROM + 2) != LNE390_ADDR2 ) { | |
193 | printk("lne390.c: card not found"); | |
194 | for(i = 0; i < ETHER_ADDR_LEN; i++) | |
195 | printk(" %02x", inb(ioaddr + LNE390_SA_PROM + i)); | |
196 | printk(" (invalid prefix).\n"); | |
197 | return -ENODEV; | |
198 | } | |
199 | #endif | |
200 | ||
1da177e4 | 201 | for(i = 0; i < ETHER_ADDR_LEN; i++) |
0795af57 | 202 | dev->dev_addr[i] = inb(ioaddr + LNE390_SA_PROM + i); |
e174961c JB |
203 | printk("lne390.c: LNE390%X in EISA slot %d, address %pM.\n", |
204 | 0xa+revision, ioaddr/0x1000, dev->dev_addr); | |
0795af57 JP |
205 | |
206 | printk("lne390.c: "); | |
1da177e4 LT |
207 | |
208 | /* Snarf the interrupt now. CFG file has them all listed as `edge' with share=NO */ | |
209 | if (dev->irq == 0) { | |
210 | unsigned char irq_reg = inb(ioaddr + LNE390_CFG2) >> 3; | |
211 | dev->irq = irq_map[irq_reg & 0x07]; | |
212 | printk("using"); | |
213 | } else { | |
214 | /* This is useless unless we reprogram the card here too */ | |
215 | if (dev->irq == 2) dev->irq = 9; /* Doh! */ | |
216 | printk("assigning"); | |
217 | } | |
218 | printk(" IRQ %d,", dev->irq); | |
219 | ||
220 | if ((ret = request_irq(dev->irq, ei_interrupt, 0, DRV_NAME, dev))) { | |
221 | printk (" unable to get IRQ %d.\n", dev->irq); | |
222 | return ret; | |
223 | } | |
224 | ||
225 | if (dev->mem_start == 0) { | |
226 | unsigned char mem_reg = inb(ioaddr + LNE390_CFG2) & 0x07; | |
227 | ||
228 | if (revision) /* LNE390B */ | |
229 | dev->mem_start = shmem_mapB[mem_reg] * 0x10000; | |
230 | else /* LNE390A */ | |
231 | dev->mem_start = shmem_mapA[mem_reg] * 0x10000; | |
232 | printk(" using "); | |
233 | } else { | |
234 | /* Should check for value in shmem_map and reprogram the card to use it */ | |
235 | dev->mem_start &= 0xfff0000; | |
236 | printk(" assigning "); | |
237 | } | |
238 | ||
239 | printk("%dkB memory at physical address %#lx\n", | |
240 | LNE390_STOP_PG/4, dev->mem_start); | |
241 | ||
242 | /* | |
243 | BEWARE!! Some dain-bramaged EISA SCUs will allow you to put | |
244 | the card mem within the region covered by `normal' RAM !!! | |
245 | ||
246 | ioremap() will fail in that case. | |
247 | */ | |
248 | ei_status.mem = ioremap(dev->mem_start, LNE390_STOP_PG*0x100); | |
249 | if (!ei_status.mem) { | |
250 | printk(KERN_ERR "lne390.c: Unable to remap card memory above 1MB !!\n"); | |
251 | printk(KERN_ERR "lne390.c: Try using EISA SCU to set memory below 1MB.\n"); | |
252 | printk(KERN_ERR "lne390.c: Driver NOT installed.\n"); | |
253 | ret = -EAGAIN; | |
254 | goto cleanup; | |
255 | } | |
256 | printk("lne390.c: remapped %dkB card memory to virtual address %p\n", | |
257 | LNE390_STOP_PG/4, ei_status.mem); | |
258 | ||
259 | dev->mem_start = (unsigned long)ei_status.mem; | |
260 | dev->mem_end = dev->mem_start + (LNE390_STOP_PG - LNE390_START_PG)*256; | |
261 | ||
262 | /* The 8390 offset is zero for the LNE390 */ | |
263 | dev->base_addr = ioaddr; | |
264 | ||
265 | ei_status.name = "LNE390"; | |
266 | ei_status.tx_start_page = LNE390_START_PG; | |
267 | ei_status.rx_start_page = LNE390_START_PG + TX_PAGES; | |
268 | ei_status.stop_page = LNE390_STOP_PG; | |
269 | ei_status.word16 = 1; | |
270 | ||
271 | if (ei_debug > 0) | |
272 | printk(version); | |
273 | ||
274 | ei_status.reset_8390 = &lne390_reset_8390; | |
275 | ei_status.block_input = &lne390_block_input; | |
276 | ei_status.block_output = &lne390_block_output; | |
277 | ei_status.get_8390_hdr = &lne390_get_8390_hdr; | |
278 | ||
0ec4d4fe | 279 | dev->netdev_ops = &ei_netdev_ops; |
1da177e4 | 280 | NS8390_init(dev, 0); |
b1fc5505 | 281 | |
282 | ret = register_netdev(dev); | |
283 | if (ret) | |
284 | goto unmap; | |
1da177e4 | 285 | return 0; |
b1fc5505 | 286 | unmap: |
287 | if (ei_status.reg0) | |
387d890d | 288 | iounmap(ei_status.mem); |
1da177e4 LT |
289 | cleanup: |
290 | free_irq(dev->irq, dev); | |
291 | return ret; | |
292 | } | |
293 | ||
294 | /* | |
295 | * Reset as per the packet driver method. Judging by the EISA cfg | |
296 | * file, this just toggles the "Board Enable" bits (bit 2 and 0). | |
297 | */ | |
298 | ||
299 | static void lne390_reset_8390(struct net_device *dev) | |
300 | { | |
301 | unsigned short ioaddr = dev->base_addr; | |
302 | ||
303 | outb(0x04, ioaddr + LNE390_RESET_PORT); | |
304 | if (ei_debug > 1) printk("%s: resetting the LNE390...", dev->name); | |
305 | ||
306 | mdelay(2); | |
307 | ||
308 | ei_status.txing = 0; | |
309 | outb(0x01, ioaddr + LNE390_RESET_PORT); | |
310 | if (ei_debug > 1) printk("reset done\n"); | |
1da177e4 LT |
311 | } |
312 | ||
313 | /* | |
314 | * Note: In the following three functions is the implicit assumption | |
315 | * that the associated memcpy will only use "rep; movsl" as long as | |
316 | * we keep the counts as some multiple of doublewords. This is a | |
317 | * requirement of the hardware, and also prevents us from using | |
318 | * eth_io_copy_and_sum() since we can't guarantee it will limit | |
319 | * itself to doubleword access. | |
320 | */ | |
321 | ||
322 | /* | |
323 | * Grab the 8390 specific header. Similar to the block_input routine, but | |
324 | * we don't need to be concerned with ring wrap as the header will be at | |
325 | * the start of a page, so we optimize accordingly. (A single doubleword.) | |
326 | */ | |
327 | ||
328 | static void | |
329 | lne390_get_8390_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr, int ring_page) | |
330 | { | |
331 | void __iomem *hdr_start = ei_status.mem + ((ring_page - LNE390_START_PG)<<8); | |
332 | memcpy_fromio(hdr, hdr_start, sizeof(struct e8390_pkt_hdr)); | |
333 | hdr->count = (hdr->count + 3) & ~3; /* Round up allocation. */ | |
334 | } | |
335 | ||
6aa20a22 | 336 | /* |
1da177e4 LT |
337 | * Block input and output are easy on shared memory ethercards, the only |
338 | * complication is when the ring buffer wraps. The count will already | |
339 | * be rounded up to a doubleword value via lne390_get_8390_hdr() above. | |
340 | */ | |
341 | ||
342 | static void lne390_block_input(struct net_device *dev, int count, struct sk_buff *skb, | |
343 | int ring_offset) | |
344 | { | |
345 | void __iomem *xfer_start = ei_status.mem + ring_offset - (LNE390_START_PG<<8); | |
346 | ||
347 | if (ring_offset + count > (LNE390_STOP_PG<<8)) { | |
348 | /* Packet wraps over end of ring buffer. */ | |
349 | int semi_count = (LNE390_STOP_PG<<8) - ring_offset; | |
350 | memcpy_fromio(skb->data, xfer_start, semi_count); | |
351 | count -= semi_count; | |
352 | memcpy_fromio(skb->data + semi_count, | |
353 | ei_status.mem + (TX_PAGES<<8), count); | |
354 | } else { | |
355 | /* Packet is in one chunk. */ | |
356 | memcpy_fromio(skb->data, xfer_start, count); | |
357 | } | |
358 | } | |
359 | ||
360 | static void lne390_block_output(struct net_device *dev, int count, | |
361 | const unsigned char *buf, int start_page) | |
362 | { | |
363 | void __iomem *shmem = ei_status.mem + ((start_page - LNE390_START_PG)<<8); | |
364 | ||
365 | count = (count + 3) & ~3; /* Round up to doubleword */ | |
366 | memcpy_toio(shmem, buf, count); | |
367 | } | |
368 | ||
1da177e4 LT |
369 | |
370 | #ifdef MODULE | |
371 | #define MAX_LNE_CARDS 4 /* Max number of LNE390 cards per module */ | |
372 | static struct net_device *dev_lne[MAX_LNE_CARDS]; | |
373 | static int io[MAX_LNE_CARDS]; | |
374 | static int irq[MAX_LNE_CARDS]; | |
375 | static int mem[MAX_LNE_CARDS]; | |
376 | ||
377 | module_param_array(io, int, NULL, 0); | |
378 | module_param_array(irq, int, NULL, 0); | |
379 | module_param_array(mem, int, NULL, 0); | |
380 | MODULE_PARM_DESC(io, "I/O base address(es)"); | |
381 | MODULE_PARM_DESC(irq, "IRQ number(s)"); | |
382 | MODULE_PARM_DESC(mem, "memory base address(es)"); | |
383 | MODULE_DESCRIPTION("Mylex LNE390A/B EISA Ethernet driver"); | |
384 | MODULE_LICENSE("GPL"); | |
385 | ||
dab3d02e | 386 | int __init init_module(void) |
1da177e4 LT |
387 | { |
388 | struct net_device *dev; | |
389 | int this_dev, found = 0; | |
390 | ||
391 | for (this_dev = 0; this_dev < MAX_LNE_CARDS; this_dev++) { | |
392 | if (io[this_dev] == 0 && this_dev != 0) | |
393 | break; | |
394 | dev = alloc_ei_netdev(); | |
395 | if (!dev) | |
396 | break; | |
397 | dev->irq = irq[this_dev]; | |
398 | dev->base_addr = io[this_dev]; | |
399 | dev->mem_start = mem[this_dev]; | |
400 | if (do_lne390_probe(dev) == 0) { | |
b1fc5505 | 401 | dev_lne[found++] = dev; |
402 | continue; | |
1da177e4 LT |
403 | } |
404 | free_netdev(dev); | |
405 | printk(KERN_WARNING "lne390.c: No LNE390 card found (i/o = 0x%x).\n", io[this_dev]); | |
406 | break; | |
407 | } | |
408 | if (found) | |
409 | return 0; | |
410 | return -ENXIO; | |
411 | } | |
412 | ||
64916f1e DV |
413 | static void cleanup_card(struct net_device *dev) |
414 | { | |
415 | free_irq(dev->irq, dev); | |
416 | release_region(dev->base_addr, LNE390_IO_EXTENT); | |
417 | iounmap(ei_status.mem); | |
418 | } | |
419 | ||
afc8eb46 | 420 | void __exit cleanup_module(void) |
1da177e4 LT |
421 | { |
422 | int this_dev; | |
423 | ||
424 | for (this_dev = 0; this_dev < MAX_LNE_CARDS; this_dev++) { | |
425 | struct net_device *dev = dev_lne[this_dev]; | |
426 | if (dev) { | |
427 | unregister_netdev(dev); | |
428 | cleanup_card(dev); | |
429 | free_netdev(dev); | |
430 | } | |
431 | } | |
432 | } | |
433 | #endif /* MODULE */ | |
434 |