1 /* mac8390.c: New driver for 8390-based Nubus (or Nubus-alike)
2 Ethernet cards on Linux */
3 /* Based on the former daynaport.c driver, by Alan Cox. Some code
4 taken from or inspired by skeleton.c by Donald Becker, acenic.c by
5 Jes Sorensen, and ne2k-pci.c by Donald Becker and Paul Gortmaker.
7 This software may be used and distributed according to the terms of
8 the GNU Public License, incorporated herein by reference. */
10 /* 2000-02-28: support added for Dayna and Kinetics cards by
11 A.G.deWijn@phys.uu.nl */
12 /* 2000-04-04: support added for Dayna2 by bart@etpmod.phys.tue.nl */
13 /* 2001-04-18: support for DaynaPort E/LC-M by rayk@knightsmanor.org */
14 /* 2001-05-15: support for Cabletron ported from old daynaport driver
15 * and fixed access to Sonic Sys card which masquerades as a Farallon
16 * by rayk@knightsmanor.org */
18 #include <linux/module.h>
19 #include <linux/kernel.h>
20 #include <linux/types.h>
21 #include <linux/fcntl.h>
22 #include <linux/interrupt.h>
23 #include <linux/ptrace.h>
24 #include <linux/ioport.h>
25 #include <linux/nubus.h>
27 #include <linux/slab.h>
28 #include <linux/string.h>
29 #include <linux/errno.h>
30 #include <linux/init.h>
31 #include <linux/netdevice.h>
32 #include <linux/etherdevice.h>
33 #include <linux/skbuff.h>
34 #include <linux/bitops.h>
36 #include <asm/system.h>
39 #include <asm/hwtest.h>
40 #include <asm/macints.h>
42 static char version[] =
43 "mac8390.c: v0.4 2001-05-15 David Huggins-Daines <dhd@debian.org> and others\n";
45 #define EI_SHIFT(x) (ei_local->reg_offset[x])
46 #define ei_inb(port) in_8(port)
47 #define ei_outb(val,port) out_8(port,val)
48 #define ei_inb_p(port) in_8(port)
49 #define ei_outb_p(val,port) out_8(port,val)
53 #define WD_START_PG 0x00 /* First page of TX buffer */
54 #define CABLETRON_RX_START_PG 0x00 /* First page of RX buffer */
55 #define CABLETRON_RX_STOP_PG 0x30 /* Last page +1 of RX ring */
56 #define CABLETRON_TX_START_PG CABLETRON_RX_STOP_PG /* First page of TX buffer */
58 /* Unfortunately it seems we have to hardcode these for the moment */
59 /* Shouldn't the card know about this? Does anyone know where to read it off the card? Do we trust the data provided by the card? */
61 #define DAYNA_8390_BASE 0x80000
62 #define DAYNA_8390_MEM 0x00000
64 #define KINETICS_8390_BASE 0x80000
65 #define KINETICS_8390_MEM 0x00000
67 #define CABLETRON_8390_BASE 0x90000
68 #define CABLETRON_8390_MEM 0x00000
74 MAC8390_FARALLON, /* Apple, Asante, and Farallon are all compatible */
85 static const char * cardname[] = {
99 static int word16[] = {
108 1, /* sonic systems */
113 /* on which cards do we use NuBus resources? */
114 static int useresources[] = {
123 1, /* sonic systems */
128 extern enum mac8390_type mac8390_ident(struct nubus_dev * dev);
129 extern int mac8390_memsize(unsigned long membase);
130 extern int mac8390_memtest(struct net_device * dev);
131 static int mac8390_initdev(struct net_device * dev, struct nubus_dev * ndev,
132 enum mac8390_type type);
134 static int mac8390_open(struct net_device * dev);
135 static int mac8390_close(struct net_device * dev);
136 static void mac8390_no_reset(struct net_device *dev);
138 /* Sane (32-bit chunk memory read/write) - Apple/Asante/Farallon do this*/
139 static void sane_get_8390_hdr(struct net_device *dev,
140 struct e8390_pkt_hdr *hdr, int ring_page);
141 static void sane_block_input(struct net_device * dev, int count,
142 struct sk_buff * skb, int ring_offset);
143 static void sane_block_output(struct net_device * dev, int count,
144 const unsigned char * buf, const int start_page);
146 /* dayna_memcpy to and from card */
147 static void dayna_memcpy_fromcard(struct net_device *dev, void *to,
148 int from, int count);
149 static void dayna_memcpy_tocard(struct net_device *dev, int to,
150 const void *from, int count);
152 /* Dayna - Dayna/Kinetics use this */
153 static void dayna_get_8390_hdr(struct net_device *dev,
154 struct e8390_pkt_hdr *hdr, int ring_page);
155 static void dayna_block_input(struct net_device *dev, int count,
156 struct sk_buff *skb, int ring_offset);
157 static void dayna_block_output(struct net_device *dev, int count,
158 const unsigned char *buf, int start_page);
160 #define memcpy_fromio(a,b,c) memcpy((a),(void *)(b),(c))
161 #define memcpy_toio(a,b,c) memcpy((void *)(a),(b),(c))
163 /* Slow Sane (16-bit chunk memory read/write) Cabletron uses this */
164 static void slow_sane_get_8390_hdr(struct net_device *dev,
165 struct e8390_pkt_hdr *hdr, int ring_page);
166 static void slow_sane_block_input(struct net_device *dev, int count,
167 struct sk_buff *skb, int ring_offset);
168 static void slow_sane_block_output(struct net_device *dev, int count,
169 const unsigned char *buf, int start_page);
170 static void word_memcpy_tocard(void *tp, const void *fp, int count);
171 static void word_memcpy_fromcard(void *tp, const void *fp, int count);
173 enum mac8390_type __init mac8390_ident(struct nubus_dev * dev)
175 if (dev->dr_sw == NUBUS_DRSW_ASANTE)
176 return MAC8390_ASANTE;
177 if (dev->dr_sw == NUBUS_DRSW_FARALLON)
178 return MAC8390_FARALLON;
179 if (dev->dr_sw == NUBUS_DRSW_KINETICS)
180 return MAC8390_KINETICS;
181 if (dev->dr_sw == NUBUS_DRSW_DAYNA)
182 return MAC8390_DAYNA;
183 if (dev->dr_sw == NUBUS_DRSW_DAYNA2)
184 return MAC8390_DAYNA2;
185 if (dev->dr_sw == NUBUS_DRSW_DAYNA_LC)
186 return MAC8390_DAYNA3;
187 if (dev->dr_hw == NUBUS_DRHW_CABLETRON)
188 return MAC8390_CABLETRON;
192 int __init mac8390_memsize(unsigned long membase)
197 local_irq_save(flags);
198 /* Check up to 32K in 4K increments */
199 for (i = 0; i < 8; i++) {
200 volatile unsigned short *m = (unsigned short *) (membase + (i * 0x1000));
202 /* Unwriteable - we have a fully decoded card and the
204 if (hwreg_present(m) == 0)
207 /* write a distinctive byte */
209 /* check that we read back what we wrote */
210 if (*m != (0xA5A0 | i))
213 /* check for partial decode and wrap */
214 for (j = 0; j < i; j++) {
215 volatile unsigned short *p = (unsigned short *) (membase + (j * 0x1000));
216 if (*p != (0xA5A0 | j))
220 local_irq_restore(flags);
221 /* in any case, we stopped once we tried one block too many,
222 or once we reached 32K */
226 struct net_device * __init mac8390_probe(int unit)
228 struct net_device *dev;
229 volatile unsigned short *i;
230 int version_disp = 0;
231 struct nubus_dev * ndev = NULL;
234 struct nubus_dir dir;
235 struct nubus_dirent ent;
237 static unsigned int slots;
239 enum mac8390_type cardtype;
241 /* probably should check for Nubus instead */
244 return ERR_PTR(-ENODEV);
246 dev = ____alloc_ei_netdev(0);
248 return ERR_PTR(-ENOMEM);
251 sprintf(dev->name, "eth%d", unit);
253 SET_MODULE_OWNER(dev);
255 while ((ndev = nubus_find_type(NUBUS_CAT_NETWORK, NUBUS_TYPE_ETHERNET, ndev))) {
256 /* Have we seen it already? */
257 if (slots & (1<<ndev->board->slot))
259 slots |= 1<<ndev->board->slot;
261 if ((cardtype = mac8390_ident(ndev)) == MAC8390_NONE)
264 if (version_disp == 0) {
269 dev->irq = SLOT2IRQ(ndev->board->slot);
270 /* This is getting to be a habit */
271 dev->base_addr = ndev->board->slot_addr | ((ndev->board->slot&0xf) << 20);
273 /* Get some Nubus info - we will trust the card's idea
274 of where its memory and registers are. */
276 if (nubus_get_func_dir(ndev, &dir) == -1) {
277 printk(KERN_ERR "%s: Unable to get Nubus functional"
278 " directory for slot %X!\n",
279 dev->name, ndev->board->slot);
283 /* Get the MAC address */
284 if ((nubus_find_rsrc(&dir, NUBUS_RESID_MAC_ADDRESS, &ent)) == -1) {
285 printk(KERN_INFO "%s: Couldn't get MAC address!\n",
289 nubus_get_rsrc_mem(dev->dev_addr, &ent, 6);
290 /* Some Sonic Sys cards masquerade as Farallon */
291 if (cardtype == MAC8390_FARALLON &&
292 dev->dev_addr[0] == 0x0 &&
293 dev->dev_addr[1] == 0x40 &&
294 dev->dev_addr[2] == 0x10) {
295 /* This is really Sonic Sys card */
296 cardtype = MAC8390_SONICSYS;
300 if (useresources[cardtype] == 1) {
301 nubus_rewinddir(&dir);
302 if (nubus_find_rsrc(&dir, NUBUS_RESID_MINOR_BASEOS, &ent) == -1) {
303 printk(KERN_ERR "%s: Memory offset resource"
304 " for slot %X not found!\n",
305 dev->name, ndev->board->slot);
308 nubus_get_rsrc_mem(&offset, &ent, 4);
309 dev->mem_start = dev->base_addr + offset;
310 /* yes, this is how the Apple driver does it */
311 dev->base_addr = dev->mem_start + 0x10000;
312 nubus_rewinddir(&dir);
313 if (nubus_find_rsrc(&dir, NUBUS_RESID_MINOR_LENGTH, &ent) == -1) {
314 printk(KERN_INFO "%s: Memory length resource"
315 " for slot %X not found"
317 dev->name, ndev->board->slot);
318 offset = mac8390_memsize(dev->mem_start);
320 nubus_get_rsrc_mem(&offset, &ent, 4);
322 dev->mem_end = dev->mem_start + offset;
325 case MAC8390_KINETICS:
326 case MAC8390_DAYNA: /* it's the same */
328 (int)(ndev->board->slot_addr +
331 (int)(ndev->board->slot_addr +
335 mac8390_memsize(dev->mem_start);
337 case MAC8390_CABLETRON:
339 (int)(ndev->board->slot_addr +
340 CABLETRON_8390_BASE);
342 (int)(ndev->board->slot_addr +
344 /* The base address is unreadable if 0x00
345 * has been written to the command register
346 * Reset the chip by writing E8390_NODMA +
347 * E8390_PAGE0 + E8390_STOP just to be
350 i = (void *)dev->base_addr;
354 mac8390_memsize(dev->mem_start);
358 printk(KERN_ERR "Card type %s is"
359 " unsupported, sorry\n",
365 /* Do the nasty 8390 stuff */
366 if (!mac8390_initdev(dev, ndev, cardtype))
372 err = register_netdev(dev);
383 MODULE_AUTHOR("David Huggins-Daines <dhd@debian.org> and others");
384 MODULE_DESCRIPTION("Macintosh NS8390-based Nubus Ethernet driver");
385 MODULE_LICENSE("GPL");
387 /* overkill, of course */
388 static struct net_device *dev_mac8390[15];
389 int init_module(void)
392 for (i = 0; i < 15; i++) {
393 struct net_device *dev = mac8390_probe(-1);
399 printk(KERN_NOTICE "mac8390.c: No useable cards found, driver NOT installed.\n");
405 void cleanup_module(void)
408 for (i = 0; i < 15; i++) {
409 struct net_device *dev = dev_mac890[i];
411 unregister_netdev(dev);
419 static int __init mac8390_initdev(struct net_device * dev, struct nubus_dev * ndev,
420 enum mac8390_type type)
422 static u32 fwrd4_offsets[16]={
428 static u32 back4_offsets[16]={
434 static u32 fwrd2_offsets[16]={
443 /* Now fill in our stuff */
444 dev->open = &mac8390_open;
445 dev->stop = &mac8390_close;
446 #ifdef CONFIG_NET_POLL_CONTROLLER
447 dev->poll_controller = __ei_poll;
450 /* GAR, ei_status is actually a macro even though it looks global */
451 ei_status.name = cardname[type];
452 ei_status.word16 = word16[type];
454 /* Cabletron's TX/RX buffers are backwards */
455 if (type == MAC8390_CABLETRON) {
456 ei_status.tx_start_page = CABLETRON_TX_START_PG;
457 ei_status.rx_start_page = CABLETRON_RX_START_PG;
458 ei_status.stop_page = CABLETRON_RX_STOP_PG;
459 ei_status.rmem_start = dev->mem_start;
460 ei_status.rmem_end = dev->mem_start + CABLETRON_RX_STOP_PG*256;
462 ei_status.tx_start_page = WD_START_PG;
463 ei_status.rx_start_page = WD_START_PG + TX_PAGES;
464 ei_status.stop_page = (dev->mem_end - dev->mem_start)/256;
465 ei_status.rmem_start = dev->mem_start + TX_PAGES*256;
466 ei_status.rmem_end = dev->mem_end;
469 /* Fill in model-specific information and functions */
471 case MAC8390_SONICSYS:
472 /* 16 bit card, register map is reversed */
473 ei_status.reset_8390 = &mac8390_no_reset;
474 ei_status.block_input = &slow_sane_block_input;
475 ei_status.block_output = &slow_sane_block_output;
476 ei_status.get_8390_hdr = &slow_sane_get_8390_hdr;
477 ei_status.reg_offset = back4_offsets;
480 case MAC8390_FARALLON:
485 /* 32 bit card, register map is reversed */
487 ei_status.reset_8390 = &mac8390_no_reset;
488 ei_status.block_input = &sane_block_input;
489 ei_status.block_output = &sane_block_output;
490 ei_status.get_8390_hdr = &sane_get_8390_hdr;
491 ei_status.reg_offset = back4_offsets;
494 case MAC8390_CABLETRON:
495 /* 16 bit card, register map is short forward */
496 ei_status.reset_8390 = &mac8390_no_reset;
497 ei_status.block_input = &slow_sane_block_input;
498 ei_status.block_output = &slow_sane_block_output;
499 ei_status.get_8390_hdr = &slow_sane_get_8390_hdr;
500 ei_status.reg_offset = fwrd2_offsets;
504 case MAC8390_KINETICS:
506 /* dayna and similar */
507 ei_status.reset_8390 = &mac8390_no_reset;
508 ei_status.block_input = &dayna_block_input;
509 ei_status.block_output = &dayna_block_output;
510 ei_status.get_8390_hdr = &dayna_get_8390_hdr;
511 ei_status.reg_offset = fwrd4_offsets;
515 printk(KERN_ERR "Card type %s is unsupported, sorry\n", cardname[type]);
519 __NS8390_init(dev, 0);
521 /* Good, done, now spit out some messages */
522 printk(KERN_INFO "%s: %s in slot %X (type %s)\n",
523 dev->name, ndev->board->name, ndev->board->slot, cardname[type]);
524 printk(KERN_INFO "MAC ");
527 for (i = 0; i < 6; i++) {
528 printk("%2.2x", dev->dev_addr[i]);
533 printk(" IRQ %d, shared memory at %#lx-%#lx, %d-bit access.\n",
534 dev->irq, dev->mem_start, dev->mem_end-1,
535 access_bitmode?32:16);
539 static int mac8390_open(struct net_device *dev)
542 if (request_irq(dev->irq, __ei_interrupt, 0, "8390 Ethernet", dev)) {
543 printk ("%s: unable to get IRQ %d.\n", dev->name, dev->irq);
549 static int mac8390_close(struct net_device *dev)
551 free_irq(dev->irq, dev);
556 static void mac8390_no_reset(struct net_device *dev)
560 printk("reset not supported\n");
564 /* dayna_memcpy_fromio/dayna_memcpy_toio */
565 /* directly from daynaport.c by Alan Cox */
566 static void dayna_memcpy_fromcard(struct net_device *dev, void *to, int from, int count)
568 volatile unsigned char *ptr;
569 unsigned char *target=to;
570 from<<=1; /* word, skip overhead */
571 ptr=(unsigned char *)(dev->mem_start+from);
580 *(unsigned short *)target = *(unsigned short volatile *)ptr;
581 ptr += 4; /* skip cruft */
590 static void dayna_memcpy_tocard(struct net_device *dev, int to, const void *from, int count)
592 volatile unsigned short *ptr;
593 const unsigned char *src=from;
594 to<<=1; /* word, skip overhead */
595 ptr=(unsigned short *)(dev->mem_start+to);
597 if (to&2) { /* avoid a byte write (stomps on other data) */
598 ptr[-1] = (ptr[-1]&0xFF00)|*src++;
604 *ptr++=*(unsigned short *)src; /* Copy and */
605 ptr++; /* skip cruft */
612 /* card doesn't like byte writes */
613 *ptr=(*ptr&0x00FF)|(*src << 8);
617 /* sane block input/output */
618 static void sane_get_8390_hdr(struct net_device *dev,
619 struct e8390_pkt_hdr *hdr, int ring_page)
621 unsigned long hdr_start = (ring_page - WD_START_PG)<<8;
622 memcpy_fromio((void *)hdr, (char *)dev->mem_start + hdr_start, 4);
624 hdr->count = swab16(hdr->count);
627 static void sane_block_input(struct net_device *dev, int count,
628 struct sk_buff *skb, int ring_offset)
630 unsigned long xfer_base = ring_offset - (WD_START_PG<<8);
631 unsigned long xfer_start = xfer_base + dev->mem_start;
633 if (xfer_start + count > ei_status.rmem_end) {
634 /* We must wrap the input move. */
635 int semi_count = ei_status.rmem_end - xfer_start;
636 memcpy_fromio(skb->data, (char *)dev->mem_start + xfer_base, semi_count);
638 memcpy_toio(skb->data + semi_count, (char *)ei_status.rmem_start, count);
640 memcpy_fromio(skb->data, (char *)dev->mem_start + xfer_base, count);
644 static void sane_block_output(struct net_device *dev, int count,
645 const unsigned char *buf, int start_page)
647 long shmem = (start_page - WD_START_PG)<<8;
649 memcpy_toio((char *)dev->mem_start + shmem, buf, count);
652 /* dayna block input/output */
653 static void dayna_get_8390_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr, int ring_page)
655 unsigned long hdr_start = (ring_page - WD_START_PG)<<8;
657 dayna_memcpy_fromcard(dev, (void *)hdr, hdr_start, 4);
659 hdr->count=(hdr->count&0xFF)<<8|(hdr->count>>8);
662 static void dayna_block_input(struct net_device *dev, int count, struct sk_buff *skb, int ring_offset)
664 unsigned long xfer_base = ring_offset - (WD_START_PG<<8);
665 unsigned long xfer_start = xfer_base+dev->mem_start;
667 /* Note the offset math is done in card memory space which is word
668 per long onto our space. */
670 if (xfer_start + count > ei_status.rmem_end)
672 /* We must wrap the input move. */
673 int semi_count = ei_status.rmem_end - xfer_start;
674 dayna_memcpy_fromcard(dev, skb->data, xfer_base, semi_count);
676 dayna_memcpy_fromcard(dev, skb->data + semi_count,
677 ei_status.rmem_start - dev->mem_start,
682 dayna_memcpy_fromcard(dev, skb->data, xfer_base, count);
686 static void dayna_block_output(struct net_device *dev, int count, const unsigned char *buf,
689 long shmem = (start_page - WD_START_PG)<<8;
691 dayna_memcpy_tocard(dev, shmem, buf, count);
694 /* Cabletron block I/O */
695 static void slow_sane_get_8390_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr,
698 unsigned long hdr_start = (ring_page - WD_START_PG)<<8;
699 word_memcpy_fromcard((void *)hdr, (char *)dev->mem_start+hdr_start, 4);
700 /* Register endianism - fix here rather than 8390.c */
701 hdr->count = (hdr->count&0xFF)<<8|(hdr->count>>8);
704 static void slow_sane_block_input(struct net_device *dev, int count, struct sk_buff *skb,
707 unsigned long xfer_base = ring_offset - (WD_START_PG<<8);
708 unsigned long xfer_start = xfer_base+dev->mem_start;
710 if (xfer_start + count > ei_status.rmem_end)
712 /* We must wrap the input move. */
713 int semi_count = ei_status.rmem_end - xfer_start;
714 word_memcpy_fromcard(skb->data, (char *)dev->mem_start +
715 xfer_base, semi_count);
717 word_memcpy_fromcard(skb->data + semi_count,
718 (char *)ei_status.rmem_start, count);
722 word_memcpy_fromcard(skb->data, (char *)dev->mem_start +
727 static void slow_sane_block_output(struct net_device *dev, int count, const unsigned char *buf,
730 long shmem = (start_page - WD_START_PG)<<8;
732 word_memcpy_tocard((char *)dev->mem_start + shmem, buf, count);
735 static void word_memcpy_tocard(void *tp, const void *fp, int count)
737 volatile unsigned short *to = tp;
738 const unsigned short *from = fp;
747 static void word_memcpy_fromcard(void *tp, const void *fp, int count)
749 unsigned short *to = tp;
750 const volatile unsigned short *from = fp;