c81befc3a7ae6efe894a9657514834b0610bf3a8
[linux-2.6.git] / drivers / net / ne.c
1 /* ne.c: A general non-shared-memory NS8390 ethernet driver for linux. */
2 /*
3     Written 1992-94 by Donald Becker.
4
5     Copyright 1993 United States Government as represented by the
6     Director, National Security Agency.
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     The author may be reached as becker@scyld.com, or C/O
12     Scyld Computing Corporation, 410 Severn Ave., Suite 210, Annapolis MD 21403
13
14     This driver should work with many programmed-I/O 8390-based ethernet
15     boards.  Currently it supports the NE1000, NE2000, many clones,
16     and some Cabletron products.
17
18     Changelog:
19
20     Paul Gortmaker      : use ENISR_RDC to monitor Tx PIO uploads, made
21                           sanity checks and bad clone support optional.
22     Paul Gortmaker      : new reset code, reset card after probe at boot.
23     Paul Gortmaker      : multiple card support for module users.
24     Paul Gortmaker      : Support for PCI ne2k clones, similar to lance.c
25     Paul Gortmaker      : Allow users with bad cards to avoid full probe.
26     Paul Gortmaker      : PCI probe changes, more PCI cards supported.
27     rjohnson@analogic.com : Changed init order so an interrupt will only
28     occur after memory is allocated for dev->priv. Deallocated memory
29     last in cleanup_modue()
30     Richard Guenther    : Added support for ISAPnP cards
31     Paul Gortmaker      : Discontinued PCI support - use ne2k-pci.c instead.
32     Hayato Fujiwara     : Add m32r support.
33
34 */
35
36 /* Routines for the NatSemi-based designs (NE[12]000). */
37
38 static const char version1[] =
39 "ne.c:v1.10 9/23/94 Donald Becker (becker@scyld.com)\n";
40 static const char version2[] =
41 "Last modified Nov 1, 2000 by Paul Gortmaker\n";
42
43
44 #include <linux/module.h>
45 #include <linux/kernel.h>
46 #include <linux/errno.h>
47 #include <linux/isapnp.h>
48 #include <linux/init.h>
49 #include <linux/interrupt.h>
50 #include <linux/delay.h>
51 #include <linux/netdevice.h>
52 #include <linux/etherdevice.h>
53 #include <linux/jiffies.h>
54 #include <linux/platform_device.h>
55
56 #include <asm/system.h>
57 #include <asm/io.h>
58
59 #include "8390.h"
60
61 #define DRV_NAME "ne"
62
63 /* Some defines that people can play with if so inclined. */
64
65 /* Do we support clones that don't adhere to 14,15 of the SAprom ? */
66 #define SUPPORT_NE_BAD_CLONES
67
68 /* Do we perform extra sanity checks on stuff ? */
69 /* #define NE_SANITY_CHECK */
70
71 /* Do we implement the read before write bugfix ? */
72 /* #define NE_RW_BUGFIX */
73
74 /* Do we have a non std. amount of memory? (in units of 256 byte pages) */
75 /* #define PACKETBUF_MEMSIZE    0x40 */
76
77 #if !defined(MODULE) && (defined(CONFIG_ISA) || defined(CONFIG_M32R))
78 /* Do we need a portlist for the ISA auto-probe ? */
79 #define NEEDS_PORTLIST
80 #endif
81
82 /* A zero-terminated list of I/O addresses to be probed at boot. */
83 #ifdef NEEDS_PORTLIST
84 static unsigned int netcard_portlist[] __initdata = {
85         0x300, 0x280, 0x320, 0x340, 0x360, 0x380, 0
86 };
87 #endif
88
89 static struct isapnp_device_id isapnp_clone_list[] __initdata = {
90         {       ISAPNP_CARD_ID('A','X','E',0x2011),
91                 ISAPNP_VENDOR('A','X','E'), ISAPNP_FUNCTION(0x2011),
92                 (long) "NetGear EA201" },
93         {       ISAPNP_ANY_ID, ISAPNP_ANY_ID,
94                 ISAPNP_VENDOR('E','D','I'), ISAPNP_FUNCTION(0x0216),
95                 (long) "NN NE2000" },
96         {       ISAPNP_ANY_ID, ISAPNP_ANY_ID,
97                 ISAPNP_VENDOR('P','N','P'), ISAPNP_FUNCTION(0x80d6),
98                 (long) "Generic PNP" },
99         { }     /* terminate list */
100 };
101
102 MODULE_DEVICE_TABLE(isapnp, isapnp_clone_list);
103
104 #ifdef SUPPORT_NE_BAD_CLONES
105 /* A list of bad clones that we none-the-less recognize. */
106 static struct { const char *name8, *name16; unsigned char SAprefix[4];}
107 bad_clone_list[] __initdata = {
108     {"DE100", "DE200", {0x00, 0xDE, 0x01,}},
109     {"DE120", "DE220", {0x00, 0x80, 0xc8,}},
110     {"DFI1000", "DFI2000", {'D', 'F', 'I',}}, /* Original, eh?  */
111     {"EtherNext UTP8", "EtherNext UTP16", {0x00, 0x00, 0x79}},
112     {"NE1000","NE2000-invalid", {0x00, 0x00, 0xd8}}, /* Ancient real NE1000. */
113     {"NN1000", "NN2000",  {0x08, 0x03, 0x08}}, /* Outlaw no-name clone. */
114     {"4-DIM8","4-DIM16", {0x00,0x00,0x4d,}},  /* Outlaw 4-Dimension cards. */
115     {"Con-Intl_8", "Con-Intl_16", {0x00, 0x00, 0x24}}, /* Connect Int'nl */
116     {"ET-100","ET-200", {0x00, 0x45, 0x54}}, /* YANG and YA clone */
117     {"COMPEX","COMPEX16",{0x00,0x80,0x48}}, /* Broken ISA Compex cards */
118     {"E-LAN100", "E-LAN200", {0x00, 0x00, 0x5d}}, /* Broken ne1000 clones */
119     {"PCM-4823", "PCM-4823", {0x00, 0xc0, 0x6c}}, /* Broken Advantech MoBo */
120     {"REALTEK", "RTL8019", {0x00, 0x00, 0xe8}}, /* no-name with Realtek chip */
121 #if defined(CONFIG_TOSHIBA_RBTX4927) || defined(CONFIG_TOSHIBA_RBTX4938)
122     {"RBHMA4X00-RTL8019", "RBHMA4X00/RTL8019", {0x00, 0x60, 0x0a}},  /* Toshiba built-in */
123 #endif
124     {"LCS-8834", "LCS-8836", {0x04, 0x04, 0x37}}, /* ShinyNet (SET) */
125     {NULL,}
126 };
127 #endif
128
129 /* ---- No user-serviceable parts below ---- */
130
131 #define NE_BASE  (dev->base_addr)
132 #define NE_CMD          0x00
133 #define NE_DATAPORT     0x10    /* NatSemi-defined port window offset. */
134 #define NE_RESET        0x1f    /* Issue a read to reset, a write to clear. */
135 #define NE_IO_EXTENT    0x20
136
137 #define NE1SM_START_PG  0x20    /* First page of TX buffer */
138 #define NE1SM_STOP_PG   0x40    /* Last page +1 of RX ring */
139 #define NESM_START_PG   0x40    /* First page of TX buffer */
140 #define NESM_STOP_PG    0x80    /* Last page +1 of RX ring */
141
142 #if defined(CONFIG_PLAT_MAPPI)
143 #  define DCR_VAL 0x4b
144 #elif defined(CONFIG_PLAT_OAKS32R)  || \
145    defined(CONFIG_TOSHIBA_RBTX4927) || defined(CONFIG_TOSHIBA_RBTX4938)
146 #  define DCR_VAL 0x48          /* 8-bit mode */
147 #else
148 #  define DCR_VAL 0x49
149 #endif
150
151 static int ne_probe1(struct net_device *dev, unsigned long ioaddr);
152 static int ne_probe_isapnp(struct net_device *dev);
153
154 static int ne_open(struct net_device *dev);
155 static int ne_close(struct net_device *dev);
156
157 static void ne_reset_8390(struct net_device *dev);
158 static void ne_get_8390_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr,
159                           int ring_page);
160 static void ne_block_input(struct net_device *dev, int count,
161                           struct sk_buff *skb, int ring_offset);
162 static void ne_block_output(struct net_device *dev, const int count,
163                 const unsigned char *buf, const int start_page);
164
165
166 /*  Probe for various non-shared-memory ethercards.
167
168    NEx000-clone boards have a Station Address PROM (SAPROM) in the packet
169    buffer memory space.  NE2000 clones have 0x57,0x57 in bytes 0x0e,0x0f of
170    the SAPROM, while other supposed NE2000 clones must be detected by their
171    SA prefix.
172
173    Reading the SAPROM from a word-wide card with the 8390 set in byte-wide
174    mode results in doubled values, which can be detected and compensated for.
175
176    The probe is also responsible for initializing the card and filling
177    in the 'dev' and 'ei_status' structures.
178
179    We use the minimum memory size for some ethercard product lines, iff we can't
180    distinguish models.  You can increase the packet buffer size by setting
181    PACKETBUF_MEMSIZE.  Reported Cabletron packet buffer locations are:
182         E1010   starts at 0x100 and ends at 0x2000.
183         E1010-x starts at 0x100 and ends at 0x8000. ("-x" means "more memory")
184         E2010    starts at 0x100 and ends at 0x4000.
185         E2010-x starts at 0x100 and ends at 0xffff.  */
186
187 static int __init do_ne_probe(struct net_device *dev)
188 {
189         unsigned long base_addr = dev->base_addr;
190 #ifdef NEEDS_PORTLIST
191         int orig_irq = dev->irq;
192 #endif
193
194         /* First check any supplied i/o locations. User knows best. <cough> */
195         if (base_addr > 0x1ff)  /* Check a single specified location. */
196                 return ne_probe1(dev, base_addr);
197         else if (base_addr != 0)        /* Don't probe at all. */
198                 return -ENXIO;
199
200         /* Then look for any installed ISAPnP clones */
201         if (isapnp_present() && (ne_probe_isapnp(dev) == 0))
202                 return 0;
203
204 #ifdef NEEDS_PORTLIST
205         /* Last resort. The semi-risky ISA auto-probe. */
206         for (base_addr = 0; netcard_portlist[base_addr] != 0; base_addr++) {
207                 int ioaddr = netcard_portlist[base_addr];
208                 dev->irq = orig_irq;
209                 if (ne_probe1(dev, ioaddr) == 0)
210                         return 0;
211         }
212 #endif
213
214         return -ENODEV;
215 }
216
217 #ifndef MODULE
218 struct net_device * __init ne_probe(int unit)
219 {
220         struct net_device *dev = alloc_ei_netdev();
221         int err;
222
223         if (!dev)
224                 return ERR_PTR(-ENOMEM);
225
226         sprintf(dev->name, "eth%d", unit);
227         netdev_boot_setup_check(dev);
228
229         err = do_ne_probe(dev);
230         if (err)
231                 goto out;
232         return dev;
233 out:
234         free_netdev(dev);
235         return ERR_PTR(err);
236 }
237 #endif
238
239 static int __init ne_probe_isapnp(struct net_device *dev)
240 {
241         int i;
242
243         for (i = 0; isapnp_clone_list[i].vendor != 0; i++) {
244                 struct pnp_dev *idev = NULL;
245
246                 while ((idev = pnp_find_dev(NULL,
247                                             isapnp_clone_list[i].vendor,
248                                             isapnp_clone_list[i].function,
249                                             idev))) {
250                         /* Avoid already found cards from previous calls */
251                         if (pnp_device_attach(idev) < 0)
252                                 continue;
253                         if (pnp_activate_dev(idev) < 0) {
254                                 pnp_device_detach(idev);
255                                 continue;
256                         }
257                         /* if no io and irq, search for next */
258                         if (!pnp_port_valid(idev, 0) || !pnp_irq_valid(idev, 0)) {
259                                 pnp_device_detach(idev);
260                                 continue;
261                         }
262                         /* found it */
263                         dev->base_addr = pnp_port_start(idev, 0);
264                         dev->irq = pnp_irq(idev, 0);
265                         printk(KERN_INFO "ne.c: ISAPnP reports %s at i/o %#lx, irq %d.\n",
266                                 (char *) isapnp_clone_list[i].driver_data,
267                                 dev->base_addr, dev->irq);
268                         if (ne_probe1(dev, dev->base_addr) != 0) {      /* Shouldn't happen. */
269                                 printk(KERN_ERR "ne.c: Probe of ISAPnP card at %#lx failed.\n", dev->base_addr);
270                                 pnp_device_detach(idev);
271                                 return -ENXIO;
272                         }
273                         ei_status.priv = (unsigned long)idev;
274                         break;
275                 }
276                 if (!idev)
277                         continue;
278                 return 0;
279         }
280
281         return -ENODEV;
282 }
283
284 static int __init ne_probe1(struct net_device *dev, unsigned long ioaddr)
285 {
286         int i;
287         unsigned char SA_prom[32];
288         int wordlength = 2;
289         const char *name = NULL;
290         int start_page, stop_page;
291         int neX000, ctron, copam, bad_card;
292         int reg0, ret;
293         static unsigned version_printed;
294
295         if (!request_region(ioaddr, NE_IO_EXTENT, DRV_NAME))
296                 return -EBUSY;
297
298         reg0 = inb_p(ioaddr);
299         if (reg0 == 0xFF) {
300                 ret = -ENODEV;
301                 goto err_out;
302         }
303
304         /* Do a preliminary verification that we have a 8390. */
305         {
306                 int regd;
307                 outb_p(E8390_NODMA+E8390_PAGE1+E8390_STOP, ioaddr + E8390_CMD);
308                 regd = inb_p(ioaddr + 0x0d);
309                 outb_p(0xff, ioaddr + 0x0d);
310                 outb_p(E8390_NODMA+E8390_PAGE0, ioaddr + E8390_CMD);
311                 inb_p(ioaddr + EN0_COUNTER0); /* Clear the counter by reading. */
312                 if (inb_p(ioaddr + EN0_COUNTER0) != 0) {
313                         outb_p(reg0, ioaddr);
314                         outb_p(regd, ioaddr + 0x0d);    /* Restore the old values. */
315                         ret = -ENODEV;
316                         goto err_out;
317                 }
318         }
319
320         if (ei_debug  &&  version_printed++ == 0)
321                 printk(KERN_INFO "%s" KERN_INFO "%s", version1, version2);
322
323         printk(KERN_INFO "NE*000 ethercard probe at %#3lx:", ioaddr);
324
325         /* A user with a poor card that fails to ack the reset, or that
326            does not have a valid 0x57,0x57 signature can still use this
327            without having to recompile. Specifying an i/o address along
328            with an otherwise unused dev->mem_end value of "0xBAD" will
329            cause the driver to skip these parts of the probe. */
330
331         bad_card = ((dev->base_addr != 0) && (dev->mem_end == 0xbad));
332
333         /* Reset card. Who knows what dain-bramaged state it was left in. */
334
335         {
336                 unsigned long reset_start_time = jiffies;
337
338                 /* DON'T change these to inb_p/outb_p or reset will fail on clones. */
339                 outb(inb(ioaddr + NE_RESET), ioaddr + NE_RESET);
340
341                 while ((inb_p(ioaddr + EN0_ISR) & ENISR_RESET) == 0)
342                 if (time_after(jiffies, reset_start_time + 2*HZ/100)) {
343                         if (bad_card) {
344                                 printk(" (warning: no reset ack)");
345                                 break;
346                         } else {
347                                 printk(" not found (no reset ack).\n");
348                                 ret = -ENODEV;
349                                 goto err_out;
350                         }
351                 }
352
353                 outb_p(0xff, ioaddr + EN0_ISR);         /* Ack all intr. */
354         }
355
356         /* Read the 16 bytes of station address PROM.
357            We must first initialize registers, similar to NS8390_init(eifdev, 0).
358            We can't reliably read the SAPROM address without this.
359            (I learned the hard way!). */
360         {
361                 struct {unsigned char value, offset; } program_seq[] =
362                 {
363                         {E8390_NODMA+E8390_PAGE0+E8390_STOP, E8390_CMD}, /* Select page 0*/
364                         {0x48,  EN0_DCFG},      /* Set byte-wide (0x48) access. */
365                         {0x00,  EN0_RCNTLO},    /* Clear the count regs. */
366                         {0x00,  EN0_RCNTHI},
367                         {0x00,  EN0_IMR},       /* Mask completion irq. */
368                         {0xFF,  EN0_ISR},
369                         {E8390_RXOFF, EN0_RXCR},        /* 0x20  Set to monitor */
370                         {E8390_TXOFF, EN0_TXCR},        /* 0x02  and loopback mode. */
371                         {32,    EN0_RCNTLO},
372                         {0x00,  EN0_RCNTHI},
373                         {0x00,  EN0_RSARLO},    /* DMA starting at 0x0000. */
374                         {0x00,  EN0_RSARHI},
375                         {E8390_RREAD+E8390_START, E8390_CMD},
376                 };
377
378                 for (i = 0; i < sizeof(program_seq)/sizeof(program_seq[0]); i++)
379                         outb_p(program_seq[i].value, ioaddr + program_seq[i].offset);
380
381         }
382         for(i = 0; i < 32 /*sizeof(SA_prom)*/; i+=2) {
383                 SA_prom[i] = inb(ioaddr + NE_DATAPORT);
384                 SA_prom[i+1] = inb(ioaddr + NE_DATAPORT);
385                 if (SA_prom[i] != SA_prom[i+1])
386                         wordlength = 1;
387         }
388
389         if (wordlength == 2)
390         {
391                 for (i = 0; i < 16; i++)
392                         SA_prom[i] = SA_prom[i+i];
393                 /* We must set the 8390 for word mode. */
394                 outb_p(DCR_VAL, ioaddr + EN0_DCFG);
395                 start_page = NESM_START_PG;
396
397                 /*
398                  * Realtek RTL8019AS datasheet says that the PSTOP register
399                  * shouldn't exceed 0x60 in 8-bit mode.
400                  * This chip can be identified by reading the signature from
401                  * the  remote byte count registers (otherwise write-only)...
402                  */
403                 if ((DCR_VAL & 0x01) == 0 &&            /* 8-bit mode */
404                     inb(ioaddr + EN0_RCNTLO) == 0x50 &&
405                     inb(ioaddr + EN0_RCNTHI) == 0x70)
406                         stop_page = 0x60;
407                 else
408                         stop_page = NESM_STOP_PG;
409         } else {
410                 start_page = NE1SM_START_PG;
411                 stop_page  = NE1SM_STOP_PG;
412         }
413
414 #if  defined(CONFIG_PLAT_MAPPI) || defined(CONFIG_PLAT_OAKS32R)
415         neX000 = ((SA_prom[14] == 0x57  &&  SA_prom[15] == 0x57)
416                 || (SA_prom[14] == 0x42 && SA_prom[15] == 0x42));
417 #else
418         neX000 = (SA_prom[14] == 0x57  &&  SA_prom[15] == 0x57);
419 #endif
420         ctron =  (SA_prom[0] == 0x00 && SA_prom[1] == 0x00 && SA_prom[2] == 0x1d);
421         copam =  (SA_prom[14] == 0x49 && SA_prom[15] == 0x00);
422
423         /* Set up the rest of the parameters. */
424         if (neX000 || bad_card || copam) {
425                 name = (wordlength == 2) ? "NE2000" : "NE1000";
426         }
427         else if (ctron)
428         {
429                 name = (wordlength == 2) ? "Ctron-8" : "Ctron-16";
430                 start_page = 0x01;
431                 stop_page = (wordlength == 2) ? 0x40 : 0x20;
432         }
433         else
434         {
435 #ifdef SUPPORT_NE_BAD_CLONES
436                 /* Ack!  Well, there might be a *bad* NE*000 clone there.
437                    Check for total bogus addresses. */
438                 for (i = 0; bad_clone_list[i].name8; i++)
439                 {
440                         if (SA_prom[0] == bad_clone_list[i].SAprefix[0] &&
441                                 SA_prom[1] == bad_clone_list[i].SAprefix[1] &&
442                                 SA_prom[2] == bad_clone_list[i].SAprefix[2])
443                         {
444                                 if (wordlength == 2)
445                                 {
446                                         name = bad_clone_list[i].name16;
447                                 } else {
448                                         name = bad_clone_list[i].name8;
449                                 }
450                                 break;
451                         }
452                 }
453                 if (bad_clone_list[i].name8 == NULL)
454                 {
455                         printk(" not found (invalid signature %2.2x %2.2x).\n",
456                                 SA_prom[14], SA_prom[15]);
457                         ret = -ENXIO;
458                         goto err_out;
459                 }
460 #else
461                 printk(" not found.\n");
462                 ret = -ENXIO;
463                 goto err_out;
464 #endif
465         }
466
467         if (dev->irq < 2)
468         {
469                 unsigned long cookie = probe_irq_on();
470                 outb_p(0x50, ioaddr + EN0_IMR); /* Enable one interrupt. */
471                 outb_p(0x00, ioaddr + EN0_RCNTLO);
472                 outb_p(0x00, ioaddr + EN0_RCNTHI);
473                 outb_p(E8390_RREAD+E8390_START, ioaddr); /* Trigger it... */
474                 mdelay(10);             /* wait 10ms for interrupt to propagate */
475                 outb_p(0x00, ioaddr + EN0_IMR);                 /* Mask it again. */
476                 dev->irq = probe_irq_off(cookie);
477                 if (ei_debug > 2)
478                         printk(" autoirq is %d\n", dev->irq);
479         } else if (dev->irq == 2)
480                 /* Fixup for users that don't know that IRQ 2 is really IRQ 9,
481                    or don't know which one to set. */
482                 dev->irq = 9;
483
484         if (! dev->irq) {
485                 printk(" failed to detect IRQ line.\n");
486                 ret = -EAGAIN;
487                 goto err_out;
488         }
489
490         /* Snarf the interrupt now.  There's no point in waiting since we cannot
491            share and the board will usually be enabled. */
492         ret = request_irq(dev->irq, ei_interrupt, 0, name, dev);
493         if (ret) {
494                 printk (" unable to get IRQ %d (errno=%d).\n", dev->irq, ret);
495                 goto err_out;
496         }
497
498         dev->base_addr = ioaddr;
499
500 #ifdef CONFIG_PLAT_MAPPI
501         outb_p(E8390_NODMA + E8390_PAGE1 + E8390_STOP,
502                 ioaddr + E8390_CMD); /* 0x61 */
503         for (i = 0 ; i < ETHER_ADDR_LEN ; i++) {
504                 dev->dev_addr[i] = SA_prom[i]
505                         = inb_p(ioaddr + EN1_PHYS_SHIFT(i));
506                 printk(" %2.2x", SA_prom[i]);
507         }
508 #else
509         for(i = 0; i < ETHER_ADDR_LEN; i++) {
510                 printk(" %2.2x", SA_prom[i]);
511                 dev->dev_addr[i] = SA_prom[i];
512         }
513 #endif
514
515         printk("\n");
516
517         ei_status.name = name;
518         ei_status.tx_start_page = start_page;
519         ei_status.stop_page = stop_page;
520
521         /* Use 16-bit mode only if this wasn't overridden by DCR_VAL */
522         ei_status.word16 = (wordlength == 2 && (DCR_VAL & 0x01));
523
524         ei_status.rx_start_page = start_page + TX_PAGES;
525 #ifdef PACKETBUF_MEMSIZE
526          /* Allow the packet buffer size to be overridden by know-it-alls. */
527         ei_status.stop_page = ei_status.tx_start_page + PACKETBUF_MEMSIZE;
528 #endif
529
530         ei_status.reset_8390 = &ne_reset_8390;
531         ei_status.block_input = &ne_block_input;
532         ei_status.block_output = &ne_block_output;
533         ei_status.get_8390_hdr = &ne_get_8390_hdr;
534         ei_status.priv = 0;
535         dev->open = &ne_open;
536         dev->stop = &ne_close;
537 #ifdef CONFIG_NET_POLL_CONTROLLER
538         dev->poll_controller = ei_poll;
539 #endif
540         NS8390_init(dev, 0);
541
542         ret = register_netdev(dev);
543         if (ret)
544                 goto out_irq;
545         printk(KERN_INFO "%s: %s found at %#lx, using IRQ %d.\n",
546                dev->name, name, ioaddr, dev->irq);
547         return 0;
548
549 out_irq:
550         free_irq(dev->irq, dev);
551 err_out:
552         release_region(ioaddr, NE_IO_EXTENT);
553         return ret;
554 }
555
556 static int ne_open(struct net_device *dev)
557 {
558         ei_open(dev);
559         return 0;
560 }
561
562 static int ne_close(struct net_device *dev)
563 {
564         if (ei_debug > 1)
565                 printk(KERN_DEBUG "%s: Shutting down ethercard.\n", dev->name);
566         ei_close(dev);
567         return 0;
568 }
569
570 /* Hard reset the card.  This used to pause for the same period that a
571    8390 reset command required, but that shouldn't be necessary. */
572
573 static void ne_reset_8390(struct net_device *dev)
574 {
575         unsigned long reset_start_time = jiffies;
576
577         if (ei_debug > 1)
578                 printk(KERN_DEBUG "resetting the 8390 t=%ld...", jiffies);
579
580         /* DON'T change these to inb_p/outb_p or reset will fail on clones. */
581         outb(inb(NE_BASE + NE_RESET), NE_BASE + NE_RESET);
582
583         ei_status.txing = 0;
584         ei_status.dmaing = 0;
585
586         /* This check _should_not_ be necessary, omit eventually. */
587         while ((inb_p(NE_BASE+EN0_ISR) & ENISR_RESET) == 0)
588                 if (time_after(jiffies, reset_start_time + 2*HZ/100)) {
589                         printk(KERN_WARNING "%s: ne_reset_8390() did not complete.\n", dev->name);
590                         break;
591                 }
592         outb_p(ENISR_RESET, NE_BASE + EN0_ISR); /* Ack intr. */
593 }
594
595 /* Grab the 8390 specific header. Similar to the block_input routine, but
596    we don't need to be concerned with ring wrap as the header will be at
597    the start of a page, so we optimize accordingly. */
598
599 static void ne_get_8390_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr, int ring_page)
600 {
601         int nic_base = dev->base_addr;
602
603         /* This *shouldn't* happen. If it does, it's the last thing you'll see */
604
605         if (ei_status.dmaing)
606         {
607                 printk(KERN_EMERG "%s: DMAing conflict in ne_get_8390_hdr "
608                         "[DMAstat:%d][irqlock:%d].\n",
609                         dev->name, ei_status.dmaing, ei_status.irqlock);
610                 return;
611         }
612
613         ei_status.dmaing |= 0x01;
614         outb_p(E8390_NODMA+E8390_PAGE0+E8390_START, nic_base+ NE_CMD);
615         outb_p(sizeof(struct e8390_pkt_hdr), nic_base + EN0_RCNTLO);
616         outb_p(0, nic_base + EN0_RCNTHI);
617         outb_p(0, nic_base + EN0_RSARLO);               /* On page boundary */
618         outb_p(ring_page, nic_base + EN0_RSARHI);
619         outb_p(E8390_RREAD+E8390_START, nic_base + NE_CMD);
620
621         if (ei_status.word16)
622                 insw(NE_BASE + NE_DATAPORT, hdr, sizeof(struct e8390_pkt_hdr)>>1);
623         else
624                 insb(NE_BASE + NE_DATAPORT, hdr, sizeof(struct e8390_pkt_hdr));
625
626         outb_p(ENISR_RDC, nic_base + EN0_ISR);  /* Ack intr. */
627         ei_status.dmaing &= ~0x01;
628
629         le16_to_cpus(&hdr->count);
630 }
631
632 /* Block input and output, similar to the Crynwr packet driver.  If you
633    are porting to a new ethercard, look at the packet driver source for hints.
634    The NEx000 doesn't share the on-board packet memory -- you have to put
635    the packet out through the "remote DMA" dataport using outb. */
636
637 static void ne_block_input(struct net_device *dev, int count, struct sk_buff *skb, int ring_offset)
638 {
639 #ifdef NE_SANITY_CHECK
640         int xfer_count = count;
641 #endif
642         int nic_base = dev->base_addr;
643         char *buf = skb->data;
644
645         /* This *shouldn't* happen. If it does, it's the last thing you'll see */
646         if (ei_status.dmaing)
647         {
648                 printk(KERN_EMERG "%s: DMAing conflict in ne_block_input "
649                         "[DMAstat:%d][irqlock:%d].\n",
650                         dev->name, ei_status.dmaing, ei_status.irqlock);
651                 return;
652         }
653         ei_status.dmaing |= 0x01;
654         outb_p(E8390_NODMA+E8390_PAGE0+E8390_START, nic_base+ NE_CMD);
655         outb_p(count & 0xff, nic_base + EN0_RCNTLO);
656         outb_p(count >> 8, nic_base + EN0_RCNTHI);
657         outb_p(ring_offset & 0xff, nic_base + EN0_RSARLO);
658         outb_p(ring_offset >> 8, nic_base + EN0_RSARHI);
659         outb_p(E8390_RREAD+E8390_START, nic_base + NE_CMD);
660         if (ei_status.word16)
661         {
662                 insw(NE_BASE + NE_DATAPORT,buf,count>>1);
663                 if (count & 0x01)
664                 {
665                         buf[count-1] = inb(NE_BASE + NE_DATAPORT);
666 #ifdef NE_SANITY_CHECK
667                         xfer_count++;
668 #endif
669                 }
670         } else {
671                 insb(NE_BASE + NE_DATAPORT, buf, count);
672         }
673
674 #ifdef NE_SANITY_CHECK
675         /* This was for the ALPHA version only, but enough people have
676            been encountering problems so it is still here.  If you see
677            this message you either 1) have a slightly incompatible clone
678            or 2) have noise/speed problems with your bus. */
679
680         if (ei_debug > 1)
681         {
682                 /* DMA termination address check... */
683                 int addr, tries = 20;
684                 do {
685                         /* DON'T check for 'inb_p(EN0_ISR) & ENISR_RDC' here
686                            -- it's broken for Rx on some cards! */
687                         int high = inb_p(nic_base + EN0_RSARHI);
688                         int low = inb_p(nic_base + EN0_RSARLO);
689                         addr = (high << 8) + low;
690                         if (((ring_offset + xfer_count) & 0xff) == low)
691                                 break;
692                 } while (--tries > 0);
693                 if (tries <= 0)
694                         printk(KERN_WARNING "%s: RX transfer address mismatch,"
695                                 "%#4.4x (expected) vs. %#4.4x (actual).\n",
696                                 dev->name, ring_offset + xfer_count, addr);
697         }
698 #endif
699         outb_p(ENISR_RDC, nic_base + EN0_ISR);  /* Ack intr. */
700         ei_status.dmaing &= ~0x01;
701 }
702
703 static void ne_block_output(struct net_device *dev, int count,
704                 const unsigned char *buf, const int start_page)
705 {
706         int nic_base = NE_BASE;
707         unsigned long dma_start;
708 #ifdef NE_SANITY_CHECK
709         int retries = 0;
710 #endif
711
712         /* Round the count up for word writes.  Do we need to do this?
713            What effect will an odd byte count have on the 8390?
714            I should check someday. */
715
716         if (ei_status.word16 && (count & 0x01))
717                 count++;
718
719         /* This *shouldn't* happen. If it does, it's the last thing you'll see */
720         if (ei_status.dmaing)
721         {
722                 printk(KERN_EMERG "%s: DMAing conflict in ne_block_output."
723                         "[DMAstat:%d][irqlock:%d]\n",
724                         dev->name, ei_status.dmaing, ei_status.irqlock);
725                 return;
726         }
727         ei_status.dmaing |= 0x01;
728         /* We should already be in page 0, but to be safe... */
729         outb_p(E8390_PAGE0+E8390_START+E8390_NODMA, nic_base + NE_CMD);
730
731 #ifdef NE_SANITY_CHECK
732 retry:
733 #endif
734
735 #ifdef NE8390_RW_BUGFIX
736         /* Handle the read-before-write bug the same way as the
737            Crynwr packet driver -- the NatSemi method doesn't work.
738            Actually this doesn't always work either, but if you have
739            problems with your NEx000 this is better than nothing! */
740
741         outb_p(0x42, nic_base + EN0_RCNTLO);
742         outb_p(0x00,   nic_base + EN0_RCNTHI);
743         outb_p(0x42, nic_base + EN0_RSARLO);
744         outb_p(0x00, nic_base + EN0_RSARHI);
745         outb_p(E8390_RREAD+E8390_START, nic_base + NE_CMD);
746         /* Make certain that the dummy read has occurred. */
747         udelay(6);
748 #endif
749
750         outb_p(ENISR_RDC, nic_base + EN0_ISR);
751
752         /* Now the normal output. */
753         outb_p(count & 0xff, nic_base + EN0_RCNTLO);
754         outb_p(count >> 8,   nic_base + EN0_RCNTHI);
755         outb_p(0x00, nic_base + EN0_RSARLO);
756         outb_p(start_page, nic_base + EN0_RSARHI);
757
758         outb_p(E8390_RWRITE+E8390_START, nic_base + NE_CMD);
759         if (ei_status.word16) {
760                 outsw(NE_BASE + NE_DATAPORT, buf, count>>1);
761         } else {
762                 outsb(NE_BASE + NE_DATAPORT, buf, count);
763         }
764
765         dma_start = jiffies;
766
767 #ifdef NE_SANITY_CHECK
768         /* This was for the ALPHA version only, but enough people have
769            been encountering problems so it is still here. */
770
771         if (ei_debug > 1)
772         {
773                 /* DMA termination address check... */
774                 int addr, tries = 20;
775                 do {
776                         int high = inb_p(nic_base + EN0_RSARHI);
777                         int low = inb_p(nic_base + EN0_RSARLO);
778                         addr = (high << 8) + low;
779                         if ((start_page << 8) + count == addr)
780                                 break;
781                 } while (--tries > 0);
782
783                 if (tries <= 0)
784                 {
785                         printk(KERN_WARNING "%s: Tx packet transfer address mismatch,"
786                                 "%#4.4x (expected) vs. %#4.4x (actual).\n",
787                                 dev->name, (start_page << 8) + count, addr);
788                         if (retries++ == 0)
789                                 goto retry;
790                 }
791         }
792 #endif
793
794         while ((inb_p(nic_base + EN0_ISR) & ENISR_RDC) == 0)
795                 if (time_after(jiffies, dma_start + 2*HZ/100)) {                /* 20ms */
796                         printk(KERN_WARNING "%s: timeout waiting for Tx RDC.\n", dev->name);
797                         ne_reset_8390(dev);
798                         NS8390_init(dev,1);
799                         break;
800                 }
801
802         outb_p(ENISR_RDC, nic_base + EN0_ISR);  /* Ack intr. */
803         ei_status.dmaing &= ~0x01;
804         return;
805 }
806
807 static int __init ne_drv_probe(struct platform_device *pdev)
808 {
809         struct net_device *dev;
810         struct resource *res;
811         int err, irq;
812
813         res = platform_get_resource(pdev, IORESOURCE_IO, 0);
814         irq = platform_get_irq(pdev, 0);
815         if (!res || irq < 0)
816                 return -ENODEV;
817
818         dev = alloc_ei_netdev();
819         if (!dev)
820                 return -ENOMEM;
821         dev->irq = irq;
822         dev->base_addr = res->start;
823         err = do_ne_probe(dev);
824         if (err) {
825                 free_netdev(dev);
826                 return err;
827         }
828         platform_set_drvdata(pdev, dev);
829         return 0;
830 }
831
832 static int __exit ne_drv_remove(struct platform_device *pdev)
833 {
834         struct net_device *dev = platform_get_drvdata(pdev);
835
836         unregister_netdev(dev);
837         free_irq(dev->irq, dev);
838         release_region(dev->base_addr, NE_IO_EXTENT);
839         free_netdev(dev);
840         return 0;
841 }
842
843 #ifdef CONFIG_PM
844 static int ne_drv_suspend(struct platform_device *pdev, pm_message_t state)
845 {
846         struct net_device *dev = platform_get_drvdata(pdev);
847
848         if (netif_running(dev))
849                 netif_device_detach(dev);
850         return 0;
851 }
852
853 static int ne_drv_resume(struct platform_device *pdev)
854 {
855         struct net_device *dev = platform_get_drvdata(pdev);
856
857         if (netif_running(dev)) {
858                 ne_reset_8390(dev);
859                 NS8390_init(dev, 1);
860                 netif_device_attach(dev);
861         }
862         return 0;
863 }
864 #else
865 #define ne_drv_suspend NULL
866 #define ne_drv_resume NULL
867 #endif
868
869 static struct platform_driver ne_driver = {
870         .remove         = __exit_p(ne_drv_remove),
871         .suspend        = ne_drv_suspend,
872         .resume         = ne_drv_resume,
873         .driver         = {
874                 .name   = DRV_NAME,
875                 .owner  = THIS_MODULE,
876         },
877 };
878
879 static int __init ne_init(void)
880 {
881         return platform_driver_probe(&ne_driver, ne_drv_probe);
882 }
883
884 static void __exit ne_exit(void)
885 {
886         platform_driver_unregister(&ne_driver);
887 }
888
889 #ifdef MODULE
890 #define MAX_NE_CARDS    4       /* Max number of NE cards per module */
891 static struct net_device *dev_ne[MAX_NE_CARDS];
892 static int io[MAX_NE_CARDS];
893 static int irq[MAX_NE_CARDS];
894 static int bad[MAX_NE_CARDS];   /* 0xbad = bad sig or no reset ack */
895
896 module_param_array(io, int, NULL, 0);
897 module_param_array(irq, int, NULL, 0);
898 module_param_array(bad, int, NULL, 0);
899 MODULE_PARM_DESC(io, "I/O base address(es),required");
900 MODULE_PARM_DESC(irq, "IRQ number(s)");
901 MODULE_PARM_DESC(bad, "Accept card(s) with bad signatures");
902 MODULE_DESCRIPTION("NE1000/NE2000 ISA/PnP Ethernet driver");
903 MODULE_LICENSE("GPL");
904
905 /* This is set up so that no ISA autoprobe takes place. We can't guarantee
906 that the ne2k probe is the last 8390 based probe to take place (as it
907 is at boot) and so the probe will get confused by any other 8390 cards.
908 ISA device autoprobes on a running machine are not recommended anyway. */
909
910 int __init init_module(void)
911 {
912         int this_dev, found = 0;
913         int plat_found = !ne_init();
914
915         for (this_dev = 0; this_dev < MAX_NE_CARDS; this_dev++) {
916                 struct net_device *dev = alloc_ei_netdev();
917                 if (!dev)
918                         break;
919                 dev->irq = irq[this_dev];
920                 dev->mem_end = bad[this_dev];
921                 dev->base_addr = io[this_dev];
922                 if (do_ne_probe(dev) == 0) {
923                         dev_ne[found++] = dev;
924                         continue;
925                 }
926                 free_netdev(dev);
927                 if (found || plat_found)
928                         break;
929                 if (io[this_dev] != 0)
930                         printk(KERN_WARNING "ne.c: No NE*000 card found at i/o = %#x\n", io[this_dev]);
931                 else
932                         printk(KERN_NOTICE "ne.c: You must supply \"io=0xNNN\" value(s) for ISA cards.\n");
933                 return -ENXIO;
934         }
935         if (found || plat_found)
936                 return 0;
937         return -ENODEV;
938 }
939
940 static void cleanup_card(struct net_device *dev)
941 {
942         struct pnp_dev *idev = (struct pnp_dev *)ei_status.priv;
943         if (idev)
944                 pnp_device_detach(idev);
945         free_irq(dev->irq, dev);
946         release_region(dev->base_addr, NE_IO_EXTENT);
947 }
948
949 void __exit cleanup_module(void)
950 {
951         int this_dev;
952
953         ne_exit();
954         for (this_dev = 0; this_dev < MAX_NE_CARDS; this_dev++) {
955                 struct net_device *dev = dev_ne[this_dev];
956                 if (dev) {
957                         unregister_netdev(dev);
958                         cleanup_card(dev);
959                         free_netdev(dev);
960                 }
961         }
962 }
963 #else /* MODULE */
964 module_init(ne_init);
965 module_exit(ne_exit);
966 #endif /* MODULE */