6 * Converted to DMA API, converted to unified driver model, made it work as
7 * a module again, and from the mac68k project, introduced more 32-bit cards
8 * and dhd's support for 16-bit cards.
12 * Debugging Andreas Ehliar, Michael Schmitz
15 * (C) 1996 by Thomas Bogendoerfer (tsbogend@bigbug.franken.de)
17 * This driver is based on work from Andreas Busse, but most of
18 * the code is rewritten.
20 * (C) 1995 by Andreas Busse (andy@waldorf-gmbh.de)
22 * A driver for the Mac onboard Sonic ethernet chip.
24 * 98/12/21 MSch: judged from tests on Q800, it's basically working,
25 * but eating up both receive and transmit resources
26 * and duplicating packets. Needs more testing.
28 * 99/01/03 MSch: upgraded to version 0.92 of the core driver, fixed.
30 * 00/10/31 sammy@oh.verio.com: Updated driver for 2.4 kernels, fixed problems
34 #include <linux/kernel.h>
35 #include <linux/module.h>
36 #include <linux/types.h>
37 #include <linux/fcntl.h>
38 #include <linux/interrupt.h>
39 #include <linux/init.h>
40 #include <linux/ioport.h>
42 #include <linux/slab.h>
43 #include <linux/string.h>
44 #include <linux/delay.h>
45 #include <linux/nubus.h>
46 #include <linux/errno.h>
47 #include <linux/netdevice.h>
48 #include <linux/etherdevice.h>
49 #include <linux/skbuff.h>
50 #include <linux/platform_device.h>
51 #include <linux/dma-mapping.h>
52 #include <linux/bitrev.h>
54 #include <asm/bootinfo.h>
55 #include <asm/system.h>
56 #include <asm/pgtable.h>
58 #include <asm/hwtest.h>
60 #include <asm/macintosh.h>
61 #include <asm/macints.h>
62 #include <asm/mac_via.h>
64 static char mac_sonic_string[] = "macsonic";
65 static struct platform_device *mac_sonic_device;
69 /* These should basically be bus-size and endian independent (since
70 the SONIC is at least smart enough that it uses the same endianness
71 as the host, unlike certain less enlightened Macintosh NICs) */
72 #define SONIC_READ(reg) (nubus_readw(dev->base_addr + (reg * 4) \
74 #define SONIC_WRITE(reg,val) (nubus_writew(val, dev->base_addr + (reg * 4) \
77 /* use 0 for production, 1 for verification, >1 for debug */
79 static unsigned int sonic_debug = SONIC_DEBUG;
81 static unsigned int sonic_debug = 1;
84 static int sonic_version_printed;
86 /* For onboard SONIC */
87 #define ONBOARD_SONIC_REGISTERS 0x50F0A000
88 #define ONBOARD_SONIC_PROM_BASE 0x50f08000
98 /* For the built-in SONIC in the Duo Dock */
99 #define DUODOCK_SONIC_REGISTERS 0xe10000
100 #define DUODOCK_SONIC_PROM_BASE 0xe12000
102 /* For Apple-style NuBus SONIC */
103 #define APPLE_SONIC_REGISTERS 0
104 #define APPLE_SONIC_PROM_BASE 0x40000
106 /* Daynalink LC SONIC */
107 #define DAYNALINK_PROM_BASE 0x400000
109 /* For Dayna-style NuBus SONIC (haven't seen one yet) */
110 #define DAYNA_SONIC_REGISTERS 0x180000
111 /* This is what OpenBSD says. However, this is definitely in NuBus
112 ROM space so we should be able to get it by walking the NuBus
113 resource directories */
114 #define DAYNA_SONIC_MAC_ADDR 0xffe004
116 #define SONIC_READ_PROM(addr) nubus_readb(prom_addr+addr)
119 * For reversing the PROM address
122 static inline void bit_reverse_addr(unsigned char addr[6])
126 for(i = 0; i < 6; i++)
127 addr[i] = bitrev8(addr[i]);
130 static irqreturn_t macsonic_interrupt(int irq, void *dev_id)
135 local_irq_save(flags);
136 result = sonic_interrupt(irq, dev_id);
137 local_irq_restore(flags);
141 static int macsonic_open(struct net_device* dev)
143 if (request_irq(dev->irq, &sonic_interrupt, IRQ_FLG_FAST, "sonic", dev)) {
144 printk(KERN_ERR "%s: unable to get IRQ %d.\n", dev->name, dev->irq);
147 /* Under the A/UX interrupt scheme, the onboard SONIC interrupt comes
148 * in at priority level 3. However, we sometimes get the level 2 inter-
149 * rupt as well, which must prevent re-entrance of the sonic handler.
151 if (dev->irq == IRQ_AUTO_3)
152 if (request_irq(IRQ_NUBUS_9, &macsonic_interrupt, IRQ_FLG_FAST, "sonic", dev)) {
153 printk(KERN_ERR "%s: unable to get IRQ %d.\n", dev->name, IRQ_NUBUS_9);
154 free_irq(dev->irq, dev);
157 return sonic_open(dev);
160 static int macsonic_close(struct net_device* dev)
163 err = sonic_close(dev);
164 free_irq(dev->irq, dev);
165 if (dev->irq == IRQ_AUTO_3)
166 free_irq(IRQ_NUBUS_9, dev);
170 static const struct net_device_ops macsonic_netdev_ops = {
171 .ndo_open = macsonic_open,
172 .ndo_stop = macsonic_close,
173 .ndo_start_xmit = sonic_send_packet,
174 .ndo_set_multicast_list = sonic_multicast_list,
175 .ndo_tx_timeout = sonic_tx_timeout,
176 .ndo_get_stats = sonic_get_stats,
177 .ndo_validate_addr = eth_validate_addr,
178 .ndo_change_mtu = eth_change_mtu,
179 .ndo_set_mac_address = eth_mac_addr,
182 static int __devinit macsonic_init(struct net_device *dev)
184 struct sonic_local* lp = netdev_priv(dev);
186 /* Allocate the entire chunk of memory for the descriptors.
187 Note that this cannot cross a 64K boundary. */
188 if ((lp->descriptors = dma_alloc_coherent(lp->device,
189 SIZEOF_SONIC_DESC * SONIC_BUS_SCALE(lp->dma_bitmode),
190 &lp->descriptors_laddr, GFP_KERNEL)) == NULL) {
191 printk(KERN_ERR "%s: couldn't alloc DMA memory for descriptors.\n",
192 dev_name(lp->device));
196 /* Now set up the pointers to point to the appropriate places */
197 lp->cda = lp->descriptors;
198 lp->tda = lp->cda + (SIZEOF_SONIC_CDA
199 * SONIC_BUS_SCALE(lp->dma_bitmode));
200 lp->rda = lp->tda + (SIZEOF_SONIC_TD * SONIC_NUM_TDS
201 * SONIC_BUS_SCALE(lp->dma_bitmode));
202 lp->rra = lp->rda + (SIZEOF_SONIC_RD * SONIC_NUM_RDS
203 * SONIC_BUS_SCALE(lp->dma_bitmode));
205 lp->cda_laddr = lp->descriptors_laddr;
206 lp->tda_laddr = lp->cda_laddr + (SIZEOF_SONIC_CDA
207 * SONIC_BUS_SCALE(lp->dma_bitmode));
208 lp->rda_laddr = lp->tda_laddr + (SIZEOF_SONIC_TD * SONIC_NUM_TDS
209 * SONIC_BUS_SCALE(lp->dma_bitmode));
210 lp->rra_laddr = lp->rda_laddr + (SIZEOF_SONIC_RD * SONIC_NUM_RDS
211 * SONIC_BUS_SCALE(lp->dma_bitmode));
213 dev->netdev_ops = &macsonic_netdev_ops;
214 dev->watchdog_timeo = TX_TIMEOUT;
217 * clear tally counter
219 SONIC_WRITE(SONIC_CRCT, 0xffff);
220 SONIC_WRITE(SONIC_FAET, 0xffff);
221 SONIC_WRITE(SONIC_MPT, 0xffff);
226 static int __devinit mac_onboard_sonic_ethernet_addr(struct net_device *dev)
228 struct sonic_local *lp = netdev_priv(dev);
229 const int prom_addr = ONBOARD_SONIC_PROM_BASE;
232 /* On NuBus boards we can sometimes look in the ROM resources.
233 No such luck for comm-slot/onboard. */
234 for(i = 0; i < 6; i++)
235 dev->dev_addr[i] = SONIC_READ_PROM(i);
237 /* Most of the time, the address is bit-reversed. The NetBSD
238 source has a rather long and detailed historical account of
240 if (memcmp(dev->dev_addr, "\x08\x00\x07", 3) &&
241 memcmp(dev->dev_addr, "\x00\xA0\x40", 3) &&
242 memcmp(dev->dev_addr, "\x00\x80\x19", 3) &&
243 memcmp(dev->dev_addr, "\x00\x05\x02", 3))
244 bit_reverse_addr(dev->dev_addr);
248 /* If we still have what seems to be a bogus address, we'll
249 look in the CAM. The top entry should be ours. */
250 /* Danger! This only works if MacOS has already initialized
252 if (memcmp(dev->dev_addr, "\x08\x00\x07", 3) &&
253 memcmp(dev->dev_addr, "\x00\xA0\x40", 3) &&
254 memcmp(dev->dev_addr, "\x00\x80\x19", 3) &&
255 memcmp(dev->dev_addr, "\x00\x05\x02", 3))
259 printk(KERN_INFO "macsonic: PROM seems to be wrong, trying CAM entry 15\n");
261 SONIC_WRITE(SONIC_CMD, SONIC_CR_RST);
262 SONIC_WRITE(SONIC_CEP, 15);
264 val = SONIC_READ(SONIC_CAP2);
265 dev->dev_addr[5] = val >> 8;
266 dev->dev_addr[4] = val & 0xff;
267 val = SONIC_READ(SONIC_CAP1);
268 dev->dev_addr[3] = val >> 8;
269 dev->dev_addr[2] = val & 0xff;
270 val = SONIC_READ(SONIC_CAP0);
271 dev->dev_addr[1] = val >> 8;
272 dev->dev_addr[0] = val & 0xff;
274 printk(KERN_INFO "HW Address from CAM 15: %pM\n",
278 if (memcmp(dev->dev_addr, "\x08\x00\x07", 3) &&
279 memcmp(dev->dev_addr, "\x00\xA0\x40", 3) &&
280 memcmp(dev->dev_addr, "\x00\x80\x19", 3) &&
281 memcmp(dev->dev_addr, "\x00\x05\x02", 3))
284 * Still nonsense ... messed up someplace!
286 printk(KERN_ERR "macsonic: ERROR (INVALID MAC)\n");
291 static int __devinit mac_onboard_sonic_probe(struct net_device *dev)
294 static int once_is_more_than_enough;
295 struct sonic_local* lp = netdev_priv(dev);
299 if (once_is_more_than_enough)
301 once_is_more_than_enough = 1;
306 if (macintosh_config->ether_type != MAC_ETHER_SONIC)
309 printk(KERN_INFO "Checking for internal Macintosh ethernet (SONIC).. ");
311 /* Bogus probing, on the models which may or may not have
312 Ethernet (BTW, the Ethernet *is* always at the same
313 address, and nothing else lives there, at least if Apple's
314 documentation is to be believed) */
315 if (macintosh_config->ident == MAC_MODEL_Q630 ||
316 macintosh_config->ident == MAC_MODEL_P588 ||
317 macintosh_config->ident == MAC_MODEL_P575 ||
318 macintosh_config->ident == MAC_MODEL_C610) {
322 local_irq_save(flags);
323 card_present = hwreg_present((void*)ONBOARD_SONIC_REGISTERS);
324 local_irq_restore(flags);
335 /* Danger! My arms are flailing wildly! You *must* set lp->reg_offset
336 * and dev->base_addr before using SONIC_READ() or SONIC_WRITE() */
337 dev->base_addr = ONBOARD_SONIC_REGISTERS;
339 dev->irq = IRQ_AUTO_3;
341 dev->irq = IRQ_NUBUS_9;
343 if (!sonic_version_printed) {
344 printk(KERN_INFO "%s", version);
345 sonic_version_printed = 1;
347 printk(KERN_INFO "%s: onboard / comm-slot SONIC at 0x%08lx\n",
348 dev_name(lp->device), dev->base_addr);
350 /* The PowerBook's SONIC is 16 bit always. */
351 if (macintosh_config->ident == MAC_MODEL_PB520) {
353 lp->dma_bitmode = SONIC_BITMODE16;
354 sr = SONIC_READ(SONIC_SR);
355 } else if (commslot) {
356 /* Some of the comm-slot cards are 16 bit. But some
357 of them are not. The 32-bit cards use offset 2 and
358 have known revisions, we try reading the revision
359 register at offset 2, if we don't get a known revision
360 we assume 16 bit at offset 0. */
362 lp->dma_bitmode = SONIC_BITMODE16;
364 sr = SONIC_READ(SONIC_SR);
365 if (sr == 0x0004 || sr == 0x0006 || sr == 0x0100 || sr == 0x0101)
366 /* 83932 is 0x0004 or 0x0006, 83934 is 0x0100 or 0x0101 */
367 lp->dma_bitmode = SONIC_BITMODE32;
369 lp->dma_bitmode = SONIC_BITMODE16;
371 sr = SONIC_READ(SONIC_SR);
374 /* All onboard cards are at offset 2 with 32 bit DMA. */
376 lp->dma_bitmode = SONIC_BITMODE32;
377 sr = SONIC_READ(SONIC_SR);
380 "%s: revision 0x%04x, using %d bit DMA and register offset %d\n",
381 dev_name(lp->device), sr, lp->dma_bitmode?32:16, lp->reg_offset);
383 #if 0 /* This is sometimes useful to find out how MacOS configured the card. */
384 printk(KERN_INFO "%s: DCR: 0x%04x, DCR2: 0x%04x\n", dev_name(lp->device),
385 SONIC_READ(SONIC_DCR) & 0xffff, SONIC_READ(SONIC_DCR2) & 0xffff);
388 /* Software reset, then initialize control registers. */
389 SONIC_WRITE(SONIC_CMD, SONIC_CR_RST);
391 SONIC_WRITE(SONIC_DCR, SONIC_DCR_EXBUS | SONIC_DCR_BMS |
392 SONIC_DCR_RFT1 | SONIC_DCR_TFT0 |
393 (lp->dma_bitmode ? SONIC_DCR_DW : 0));
395 /* This *must* be written back to in order to restore the
396 * extended programmable output bits, as it may not have been
397 * initialised since the hardware reset. */
398 SONIC_WRITE(SONIC_DCR2, 0);
400 /* Clear *and* disable interrupts to be on the safe side */
401 SONIC_WRITE(SONIC_IMR, 0);
402 SONIC_WRITE(SONIC_ISR, 0x7fff);
404 /* Now look for the MAC address. */
405 if (mac_onboard_sonic_ethernet_addr(dev) != 0)
408 /* Shared init code */
409 return macsonic_init(dev);
412 static int __devinit mac_nubus_sonic_ethernet_addr(struct net_device *dev,
413 unsigned long prom_addr,
417 for(i = 0; i < 6; i++)
418 dev->dev_addr[i] = SONIC_READ_PROM(i);
420 /* Some of the addresses are bit-reversed */
421 if (id != MACSONIC_DAYNA)
422 bit_reverse_addr(dev->dev_addr);
427 static int __devinit macsonic_ident(struct nubus_dev *ndev)
429 if (ndev->dr_hw == NUBUS_DRHW_ASANTE_LC &&
430 ndev->dr_sw == NUBUS_DRSW_SONIC_LC)
431 return MACSONIC_DAYNALINK;
432 if (ndev->dr_hw == NUBUS_DRHW_SONIC &&
433 ndev->dr_sw == NUBUS_DRSW_APPLE) {
434 /* There has to be a better way to do this... */
435 if (strstr(ndev->board->name, "DuoDock"))
436 return MACSONIC_DUODOCK;
438 return MACSONIC_APPLE;
441 if (ndev->dr_hw == NUBUS_DRHW_SMC9194 &&
442 ndev->dr_sw == NUBUS_DRSW_DAYNA)
443 return MACSONIC_DAYNA;
445 if (ndev->dr_hw == NUBUS_DRHW_APPLE_SONIC_LC &&
446 ndev->dr_sw == 0) { /* huh? */
447 return MACSONIC_APPLE16;
452 static int __devinit mac_nubus_sonic_probe(struct net_device *dev)
455 struct nubus_dev* ndev = NULL;
456 struct sonic_local* lp = netdev_priv(dev);
457 unsigned long base_addr, prom_addr;
460 int reg_offset, dma_bitmode;
462 /* Find the first SONIC that hasn't been initialized already */
463 while ((ndev = nubus_find_type(NUBUS_CAT_NETWORK,
464 NUBUS_TYPE_ETHERNET, ndev)) != NULL)
466 /* Have we seen it already? */
467 if (slots & (1<<ndev->board->slot))
469 slots |= 1<<ndev->board->slot;
471 /* Is it one of ours? */
472 if ((id = macsonic_ident(ndev)) != -1)
480 case MACSONIC_DUODOCK:
481 base_addr = ndev->board->slot_addr + DUODOCK_SONIC_REGISTERS;
482 prom_addr = ndev->board->slot_addr + DUODOCK_SONIC_PROM_BASE;
483 sonic_dcr = SONIC_DCR_EXBUS | SONIC_DCR_RFT0 | SONIC_DCR_RFT1 |
486 dma_bitmode = SONIC_BITMODE32;
489 base_addr = ndev->board->slot_addr + APPLE_SONIC_REGISTERS;
490 prom_addr = ndev->board->slot_addr + APPLE_SONIC_PROM_BASE;
491 sonic_dcr = SONIC_DCR_BMS | SONIC_DCR_RFT1 | SONIC_DCR_TFT0;
493 dma_bitmode = SONIC_BITMODE32;
495 case MACSONIC_APPLE16:
496 base_addr = ndev->board->slot_addr + APPLE_SONIC_REGISTERS;
497 prom_addr = ndev->board->slot_addr + APPLE_SONIC_PROM_BASE;
498 sonic_dcr = SONIC_DCR_EXBUS | SONIC_DCR_RFT1 | SONIC_DCR_TFT0 |
499 SONIC_DCR_PO1 | SONIC_DCR_BMS;
501 dma_bitmode = SONIC_BITMODE16;
503 case MACSONIC_DAYNALINK:
504 base_addr = ndev->board->slot_addr + APPLE_SONIC_REGISTERS;
505 prom_addr = ndev->board->slot_addr + DAYNALINK_PROM_BASE;
506 sonic_dcr = SONIC_DCR_RFT1 | SONIC_DCR_TFT0 |
507 SONIC_DCR_PO1 | SONIC_DCR_BMS;
509 dma_bitmode = SONIC_BITMODE16;
512 base_addr = ndev->board->slot_addr + DAYNA_SONIC_REGISTERS;
513 prom_addr = ndev->board->slot_addr + DAYNA_SONIC_MAC_ADDR;
514 sonic_dcr = SONIC_DCR_BMS |
515 SONIC_DCR_RFT1 | SONIC_DCR_TFT0 | SONIC_DCR_PO1;
517 dma_bitmode = SONIC_BITMODE16;
520 printk(KERN_ERR "macsonic: WTF, id is %d\n", id);
524 /* Danger! My arms are flailing wildly! You *must* set lp->reg_offset
525 * and dev->base_addr before using SONIC_READ() or SONIC_WRITE() */
526 dev->base_addr = base_addr;
527 lp->reg_offset = reg_offset;
528 lp->dma_bitmode = dma_bitmode;
529 dev->irq = SLOT2IRQ(ndev->board->slot);
531 if (!sonic_version_printed) {
532 printk(KERN_INFO "%s", version);
533 sonic_version_printed = 1;
535 printk(KERN_INFO "%s: %s in slot %X\n",
536 dev_name(lp->device), ndev->board->name, ndev->board->slot);
537 printk(KERN_INFO "%s: revision 0x%04x, using %d bit DMA and register offset %d\n",
538 dev_name(lp->device), SONIC_READ(SONIC_SR), dma_bitmode?32:16, reg_offset);
540 #if 0 /* This is sometimes useful to find out how MacOS configured the card. */
541 printk(KERN_INFO "%s: DCR: 0x%04x, DCR2: 0x%04x\n", dev_name(lp->device),
542 SONIC_READ(SONIC_DCR) & 0xffff, SONIC_READ(SONIC_DCR2) & 0xffff);
545 /* Software reset, then initialize control registers. */
546 SONIC_WRITE(SONIC_CMD, SONIC_CR_RST);
547 SONIC_WRITE(SONIC_DCR, sonic_dcr | (dma_bitmode ? SONIC_DCR_DW : 0));
548 /* This *must* be written back to in order to restore the
549 * extended programmable output bits, since it may not have been
550 * initialised since the hardware reset. */
551 SONIC_WRITE(SONIC_DCR2, 0);
553 /* Clear *and* disable interrupts to be on the safe side */
554 SONIC_WRITE(SONIC_IMR, 0);
555 SONIC_WRITE(SONIC_ISR, 0x7fff);
557 /* Now look for the MAC address. */
558 if (mac_nubus_sonic_ethernet_addr(dev, prom_addr, id) != 0)
561 /* Shared init code */
562 return macsonic_init(dev);
565 static int __devinit mac_sonic_probe(struct platform_device *pdev)
567 struct net_device *dev;
568 struct sonic_local *lp;
571 dev = alloc_etherdev(sizeof(struct sonic_local));
575 lp = netdev_priv(dev);
576 lp->device = &pdev->dev;
577 SET_NETDEV_DEV(dev, &pdev->dev);
579 /* This will catch fatal stuff like -ENOMEM as well as success */
580 err = mac_onboard_sonic_probe(dev);
585 err = mac_nubus_sonic_probe(dev);
589 err = register_netdev(dev);
593 printk("%s: MAC %pM IRQ %d\n", dev->name, dev->dev_addr, dev->irq);
603 MODULE_DESCRIPTION("Macintosh SONIC ethernet driver");
604 module_param(sonic_debug, int, 0);
605 MODULE_PARM_DESC(sonic_debug, "macsonic debug level (1-4)");
609 static int __devexit mac_sonic_device_remove (struct platform_device *pdev)
611 struct net_device *dev = platform_get_drvdata(pdev);
612 struct sonic_local* lp = netdev_priv(dev);
614 unregister_netdev(dev);
615 dma_free_coherent(lp->device, SIZEOF_SONIC_DESC * SONIC_BUS_SCALE(lp->dma_bitmode),
616 lp->descriptors, lp->descriptors_laddr);
622 static struct platform_driver mac_sonic_driver = {
623 .probe = mac_sonic_probe,
624 .remove = __devexit_p(mac_sonic_device_remove),
626 .name = mac_sonic_string,
630 static int __init mac_sonic_init_module(void)
634 if ((err = platform_driver_register(&mac_sonic_driver))) {
635 printk(KERN_ERR "Driver registration failed\n");
639 mac_sonic_device = platform_device_alloc(mac_sonic_string, 0);
640 if (!mac_sonic_device)
643 if (platform_device_add(mac_sonic_device)) {
644 platform_device_put(mac_sonic_device);
645 mac_sonic_device = NULL;
651 platform_driver_unregister(&mac_sonic_driver);
656 static void __exit mac_sonic_cleanup_module(void)
658 platform_driver_unregister(&mac_sonic_driver);
660 if (mac_sonic_device) {
661 platform_device_unregister(mac_sonic_device);
662 mac_sonic_device = NULL;
666 module_init(mac_sonic_init_module);
667 module_exit(mac_sonic_cleanup_module);