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