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