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