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