blob: bc70d5e79ab1727e5b74f1183d88f26a554388cd [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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
34static 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>
44#include <linux/netdevice.h>
45#include <linux/etherdevice.h>
46
47#include <asm/io.h>
48#include <asm/system.h>
49
50#include "8390.h"
51
52#define DRV_NAME "lne390"
53
54static int lne390_probe1(struct net_device *dev, int ioaddr);
55
56static int lne390_open(struct net_device *dev);
57static int lne390_close(struct net_device *dev);
58
59static void lne390_reset_8390(struct net_device *dev);
60
61static void lne390_get_8390_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr, int ring_page);
62static void lne390_block_input(struct net_device *dev, int count, struct sk_buff *skb, int ring_offset);
63static void lne390_block_output(struct net_device *dev, int count, const unsigned char *buf, const int start_page);
64
65#define LNE390_START_PG 0x00 /* First page of TX buffer */
66#define LNE390_STOP_PG 0x80 /* Last page +1 of RX ring */
67
68#define LNE390_ID_PORT 0xc80 /* Same for all EISA cards */
69#define LNE390_IO_EXTENT 0x20
70#define LNE390_SA_PROM 0x16 /* Start of e'net addr. */
71#define LNE390_RESET_PORT 0xc84 /* From the pkt driver source */
72#define LNE390_NIC_OFFSET 0x00 /* Hello, the 8390 is *here* */
73
74#define LNE390_ADDR0 0x00 /* 3 byte vendor prefix */
75#define LNE390_ADDR1 0x80
76#define LNE390_ADDR2 0xe5
77
78#define LNE390_ID0 0x10009835 /* 0x3598 = 01101 01100 11000 = mlx */
79#define LNE390_ID1 0x11009835 /* above is the 390A, this is 390B */
80
81#define LNE390_CFG1 0xc84 /* NB: 0xc84 is also "reset" port. */
82#define LNE390_CFG2 0xc90
83
84/*
85 * You can OR any of the following bits together and assign it
86 * to LNE390_DEBUG to get verbose driver info during operation.
87 * Currently only the probe one is implemented.
88 */
89
90#define LNE390_D_PROBE 0x01
91#define LNE390_D_RX_PKT 0x02
92#define LNE390_D_TX_PKT 0x04
93#define LNE390_D_IRQ 0x08
94
95#define LNE390_DEBUG 0
96
97static unsigned char irq_map[] __initdata = {15, 12, 11, 10, 9, 7, 5, 3};
98static unsigned int shmem_mapA[] __initdata = {0xff, 0xfe, 0xfd, 0xfff, 0xffe, 0xffc, 0x0d, 0x0};
99static unsigned int shmem_mapB[] __initdata = {0xff, 0xfe, 0x0e, 0xfff, 0xffe, 0xffc, 0x0d, 0x0};
100
101/*
102 * Probe for the card. The best way is to read the EISA ID if it
103 * is known. Then we can check the prefix of the station address
104 * PROM for a match against the value assigned to Mylex.
105 */
106
107static int __init do_lne390_probe(struct net_device *dev)
108{
109 unsigned short ioaddr = dev->base_addr;
110 int irq = dev->irq;
111 int mem_start = dev->mem_start;
112 int ret;
113
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 if (ioaddr > 0x1ff) { /* Check a single specified location. */
115 if (!request_region(ioaddr, LNE390_IO_EXTENT, DRV_NAME))
116 return -EBUSY;
117 ret = lne390_probe1(dev, ioaddr);
118 if (ret)
119 release_region(ioaddr, LNE390_IO_EXTENT);
120 return ret;
121 }
122 else if (ioaddr > 0) /* Don't probe at all. */
123 return -ENXIO;
124
125 if (!EISA_bus) {
126#if LNE390_DEBUG & LNE390_D_PROBE
127 printk("lne390-debug: Not an EISA bus. Not probing high ports.\n");
128#endif
129 return -ENXIO;
130 }
131
132 /* EISA spec allows for up to 16 slots, but 8 is typical. */
133 for (ioaddr = 0x1000; ioaddr < 0x9000; ioaddr += 0x1000) {
134 if (!request_region(ioaddr, LNE390_IO_EXTENT, DRV_NAME))
135 continue;
136 if (lne390_probe1(dev, ioaddr) == 0)
137 return 0;
138 release_region(ioaddr, LNE390_IO_EXTENT);
139 dev->irq = irq;
140 dev->mem_start = mem_start;
141 }
142
143 return -ENODEV;
144}
145
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146#ifndef MODULE
147struct net_device * __init lne390_probe(int unit)
148{
149 struct net_device *dev = alloc_ei_netdev();
150 int err;
151
152 if (!dev)
153 return ERR_PTR(-ENOMEM);
154
155 sprintf(dev->name, "eth%d", unit);
156 netdev_boot_setup_check(dev);
157
158 err = do_lne390_probe(dev);
159 if (err)
160 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161 return dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162out:
163 free_netdev(dev);
164 return ERR_PTR(err);
165}
166#endif
167
168static int __init lne390_probe1(struct net_device *dev, int ioaddr)
169{
170 int i, revision, ret;
171 unsigned long eisa_id;
172
173 if (inb_p(ioaddr + LNE390_ID_PORT) == 0xff) return -ENODEV;
174
175#if LNE390_DEBUG & LNE390_D_PROBE
176 printk("lne390-debug: probe at %#x, ID %#8x\n", ioaddr, inl(ioaddr + LNE390_ID_PORT));
177 printk("lne390-debug: config regs: %#x %#x\n",
178 inb(ioaddr + LNE390_CFG1), inb(ioaddr + LNE390_CFG2));
179#endif
180
181
182/* Check the EISA ID of the card. */
183 eisa_id = inl(ioaddr + LNE390_ID_PORT);
184 if ((eisa_id != LNE390_ID0) && (eisa_id != LNE390_ID1)) {
185 return -ENODEV;
186 }
187
188 revision = (eisa_id >> 24) & 0x01; /* 0 = rev A, 1 rev B */
Jeff Garzik6aa20a22006-09-13 13:24:59 -0400189
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190#if 0
191/* Check the Mylex vendor ID as well. Not really required. */
192 if (inb(ioaddr + LNE390_SA_PROM + 0) != LNE390_ADDR0
193 || inb(ioaddr + LNE390_SA_PROM + 1) != LNE390_ADDR1
194 || inb(ioaddr + LNE390_SA_PROM + 2) != LNE390_ADDR2 ) {
195 printk("lne390.c: card not found");
196 for(i = 0; i < ETHER_ADDR_LEN; i++)
197 printk(" %02x", inb(ioaddr + LNE390_SA_PROM + i));
198 printk(" (invalid prefix).\n");
199 return -ENODEV;
200 }
201#endif
202
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203 for(i = 0; i < ETHER_ADDR_LEN; i++)
Joe Perches0795af52007-10-03 17:59:30 -0700204 dev->dev_addr[i] = inb(ioaddr + LNE390_SA_PROM + i);
Johannes Berge1749612008-10-27 15:59:26 -0700205 printk("lne390.c: LNE390%X in EISA slot %d, address %pM.\n",
206 0xa+revision, ioaddr/0x1000, dev->dev_addr);
Joe Perches0795af52007-10-03 17:59:30 -0700207
208 printk("lne390.c: ");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209
210 /* Snarf the interrupt now. CFG file has them all listed as `edge' with share=NO */
211 if (dev->irq == 0) {
212 unsigned char irq_reg = inb(ioaddr + LNE390_CFG2) >> 3;
213 dev->irq = irq_map[irq_reg & 0x07];
214 printk("using");
215 } else {
216 /* This is useless unless we reprogram the card here too */
217 if (dev->irq == 2) dev->irq = 9; /* Doh! */
218 printk("assigning");
219 }
220 printk(" IRQ %d,", dev->irq);
221
222 if ((ret = request_irq(dev->irq, ei_interrupt, 0, DRV_NAME, dev))) {
223 printk (" unable to get IRQ %d.\n", dev->irq);
224 return ret;
225 }
226
227 if (dev->mem_start == 0) {
228 unsigned char mem_reg = inb(ioaddr + LNE390_CFG2) & 0x07;
229
230 if (revision) /* LNE390B */
231 dev->mem_start = shmem_mapB[mem_reg] * 0x10000;
232 else /* LNE390A */
233 dev->mem_start = shmem_mapA[mem_reg] * 0x10000;
234 printk(" using ");
235 } else {
236 /* Should check for value in shmem_map and reprogram the card to use it */
237 dev->mem_start &= 0xfff0000;
238 printk(" assigning ");
239 }
240
241 printk("%dkB memory at physical address %#lx\n",
242 LNE390_STOP_PG/4, dev->mem_start);
243
244 /*
245 BEWARE!! Some dain-bramaged EISA SCUs will allow you to put
246 the card mem within the region covered by `normal' RAM !!!
247
248 ioremap() will fail in that case.
249 */
250 ei_status.mem = ioremap(dev->mem_start, LNE390_STOP_PG*0x100);
251 if (!ei_status.mem) {
252 printk(KERN_ERR "lne390.c: Unable to remap card memory above 1MB !!\n");
253 printk(KERN_ERR "lne390.c: Try using EISA SCU to set memory below 1MB.\n");
254 printk(KERN_ERR "lne390.c: Driver NOT installed.\n");
255 ret = -EAGAIN;
256 goto cleanup;
257 }
258 printk("lne390.c: remapped %dkB card memory to virtual address %p\n",
259 LNE390_STOP_PG/4, ei_status.mem);
260
261 dev->mem_start = (unsigned long)ei_status.mem;
262 dev->mem_end = dev->mem_start + (LNE390_STOP_PG - LNE390_START_PG)*256;
263
264 /* The 8390 offset is zero for the LNE390 */
265 dev->base_addr = ioaddr;
266
267 ei_status.name = "LNE390";
268 ei_status.tx_start_page = LNE390_START_PG;
269 ei_status.rx_start_page = LNE390_START_PG + TX_PAGES;
270 ei_status.stop_page = LNE390_STOP_PG;
271 ei_status.word16 = 1;
272
273 if (ei_debug > 0)
274 printk(version);
275
276 ei_status.reset_8390 = &lne390_reset_8390;
277 ei_status.block_input = &lne390_block_input;
278 ei_status.block_output = &lne390_block_output;
279 ei_status.get_8390_hdr = &lne390_get_8390_hdr;
280
281 dev->open = &lne390_open;
282 dev->stop = &lne390_close;
283#ifdef CONFIG_NET_POLL_CONTROLLER
284 dev->poll_controller = ei_poll;
285#endif
286 NS8390_init(dev, 0);
b1fc5502005-05-12 20:11:55 -0400287
288 ret = register_netdev(dev);
289 if (ret)
290 goto unmap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291 return 0;
b1fc5502005-05-12 20:11:55 -0400292unmap:
293 if (ei_status.reg0)
viro@ZenIV.linux.org.uk387d8902005-09-09 17:22:14 +0100294 iounmap(ei_status.mem);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295cleanup:
296 free_irq(dev->irq, dev);
297 return ret;
298}
299
300/*
301 * Reset as per the packet driver method. Judging by the EISA cfg
302 * file, this just toggles the "Board Enable" bits (bit 2 and 0).
303 */
304
305static void lne390_reset_8390(struct net_device *dev)
306{
307 unsigned short ioaddr = dev->base_addr;
308
309 outb(0x04, ioaddr + LNE390_RESET_PORT);
310 if (ei_debug > 1) printk("%s: resetting the LNE390...", dev->name);
311
312 mdelay(2);
313
314 ei_status.txing = 0;
315 outb(0x01, ioaddr + LNE390_RESET_PORT);
316 if (ei_debug > 1) printk("reset done\n");
317
318 return;
319}
320
321/*
322 * Note: In the following three functions is the implicit assumption
323 * that the associated memcpy will only use "rep; movsl" as long as
324 * we keep the counts as some multiple of doublewords. This is a
325 * requirement of the hardware, and also prevents us from using
326 * eth_io_copy_and_sum() since we can't guarantee it will limit
327 * itself to doubleword access.
328 */
329
330/*
331 * Grab the 8390 specific header. Similar to the block_input routine, but
332 * we don't need to be concerned with ring wrap as the header will be at
333 * the start of a page, so we optimize accordingly. (A single doubleword.)
334 */
335
336static void
337lne390_get_8390_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr, int ring_page)
338{
339 void __iomem *hdr_start = ei_status.mem + ((ring_page - LNE390_START_PG)<<8);
340 memcpy_fromio(hdr, hdr_start, sizeof(struct e8390_pkt_hdr));
341 hdr->count = (hdr->count + 3) & ~3; /* Round up allocation. */
342}
343
Jeff Garzik6aa20a22006-09-13 13:24:59 -0400344/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345 * Block input and output are easy on shared memory ethercards, the only
346 * complication is when the ring buffer wraps. The count will already
347 * be rounded up to a doubleword value via lne390_get_8390_hdr() above.
348 */
349
350static void lne390_block_input(struct net_device *dev, int count, struct sk_buff *skb,
351 int ring_offset)
352{
353 void __iomem *xfer_start = ei_status.mem + ring_offset - (LNE390_START_PG<<8);
354
355 if (ring_offset + count > (LNE390_STOP_PG<<8)) {
356 /* Packet wraps over end of ring buffer. */
357 int semi_count = (LNE390_STOP_PG<<8) - ring_offset;
358 memcpy_fromio(skb->data, xfer_start, semi_count);
359 count -= semi_count;
360 memcpy_fromio(skb->data + semi_count,
361 ei_status.mem + (TX_PAGES<<8), count);
362 } else {
363 /* Packet is in one chunk. */
364 memcpy_fromio(skb->data, xfer_start, count);
365 }
366}
367
368static void lne390_block_output(struct net_device *dev, int count,
369 const unsigned char *buf, int start_page)
370{
371 void __iomem *shmem = ei_status.mem + ((start_page - LNE390_START_PG)<<8);
372
373 count = (count + 3) & ~3; /* Round up to doubleword */
374 memcpy_toio(shmem, buf, count);
375}
376
377static int lne390_open(struct net_device *dev)
378{
379 ei_open(dev);
380 return 0;
381}
382
383static int lne390_close(struct net_device *dev)
384{
385
386 if (ei_debug > 1)
387 printk("%s: Shutting down ethercard.\n", dev->name);
388
389 ei_close(dev);
390 return 0;
391}
392
393#ifdef MODULE
394#define MAX_LNE_CARDS 4 /* Max number of LNE390 cards per module */
395static struct net_device *dev_lne[MAX_LNE_CARDS];
396static int io[MAX_LNE_CARDS];
397static int irq[MAX_LNE_CARDS];
398static int mem[MAX_LNE_CARDS];
399
400module_param_array(io, int, NULL, 0);
401module_param_array(irq, int, NULL, 0);
402module_param_array(mem, int, NULL, 0);
403MODULE_PARM_DESC(io, "I/O base address(es)");
404MODULE_PARM_DESC(irq, "IRQ number(s)");
405MODULE_PARM_DESC(mem, "memory base address(es)");
406MODULE_DESCRIPTION("Mylex LNE390A/B EISA Ethernet driver");
407MODULE_LICENSE("GPL");
408
Andrew Mortondab3d022006-08-14 23:00:04 -0700409int __init init_module(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410{
411 struct net_device *dev;
412 int this_dev, found = 0;
413
414 for (this_dev = 0; this_dev < MAX_LNE_CARDS; this_dev++) {
415 if (io[this_dev] == 0 && this_dev != 0)
416 break;
417 dev = alloc_ei_netdev();
418 if (!dev)
419 break;
420 dev->irq = irq[this_dev];
421 dev->base_addr = io[this_dev];
422 dev->mem_start = mem[this_dev];
423 if (do_lne390_probe(dev) == 0) {
b1fc5502005-05-12 20:11:55 -0400424 dev_lne[found++] = dev;
425 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 }
427 free_netdev(dev);
428 printk(KERN_WARNING "lne390.c: No LNE390 card found (i/o = 0x%x).\n", io[this_dev]);
429 break;
430 }
431 if (found)
432 return 0;
433 return -ENXIO;
434}
435
Denis Vlasenko64916f12006-01-05 22:45:47 -0800436static void cleanup_card(struct net_device *dev)
437{
438 free_irq(dev->irq, dev);
439 release_region(dev->base_addr, LNE390_IO_EXTENT);
440 iounmap(ei_status.mem);
441}
442
Al Viroafc8eb42006-06-14 18:50:53 -0400443void __exit cleanup_module(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444{
445 int this_dev;
446
447 for (this_dev = 0; this_dev < MAX_LNE_CARDS; this_dev++) {
448 struct net_device *dev = dev_lne[this_dev];
449 if (dev) {
450 unregister_netdev(dev);
451 cleanup_card(dev);
452 free_netdev(dev);
453 }
454 }
455}
456#endif /* MODULE */
457