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 extern int mac_onboard_sonic_probe(struct net_device* dev);
87 extern int mac_nubus_sonic_probe(struct net_device* dev);
89 /* For onboard SONIC */
90 #define ONBOARD_SONIC_REGISTERS 0x50F0A000
91 #define ONBOARD_SONIC_PROM_BASE 0x50f08000
101 /* For the built-in SONIC in the Duo Dock */
102 #define DUODOCK_SONIC_REGISTERS 0xe10000
103 #define DUODOCK_SONIC_PROM_BASE 0xe12000
105 /* For Apple-style NuBus SONIC */
106 #define APPLE_SONIC_REGISTERS 0
107 #define APPLE_SONIC_PROM_BASE 0x40000
109 /* Daynalink LC SONIC */
110 #define DAYNALINK_PROM_BASE 0x400000
112 /* For Dayna-style NuBus SONIC (haven't seen one yet) */
113 #define DAYNA_SONIC_REGISTERS 0x180000
114 /* This is what OpenBSD says. However, this is definitely in NuBus
115 ROM space so we should be able to get it by walking the NuBus
116 resource directories */
117 #define DAYNA_SONIC_MAC_ADDR 0xffe004
119 #define SONIC_READ_PROM(addr) nubus_readb(prom_addr+addr)
122 * For reversing the PROM address
125 static inline void bit_reverse_addr(unsigned char addr[6])
129 for(i = 0; i < 6; i++)
130 addr[i] = bitrev8(addr[i]);
133 static irqreturn_t macsonic_interrupt(int irq, void *dev_id)
138 local_irq_save(flags);
139 result = sonic_interrupt(irq, dev_id);
140 local_irq_restore(flags);
144 static int macsonic_open(struct net_device* dev)
146 if (request_irq(dev->irq, &sonic_interrupt, IRQ_FLG_FAST, "sonic", dev)) {
147 printk(KERN_ERR "%s: unable to get IRQ %d.\n", dev->name, dev->irq);
150 /* Under the A/UX interrupt scheme, the onboard SONIC interrupt comes
151 * in at priority level 3. However, we sometimes get the level 2 inter-
152 * rupt as well, which must prevent re-entrance of the sonic handler.
154 if (dev->irq == IRQ_AUTO_3)
155 if (request_irq(IRQ_NUBUS_9, &macsonic_interrupt, IRQ_FLG_FAST, "sonic", dev)) {
156 printk(KERN_ERR "%s: unable to get IRQ %d.\n", dev->name, IRQ_NUBUS_9);
157 free_irq(dev->irq, dev);
160 return sonic_open(dev);
163 static int macsonic_close(struct net_device* dev)
166 err = sonic_close(dev);
167 free_irq(dev->irq, dev);
168 if (dev->irq == IRQ_AUTO_3)
169 free_irq(IRQ_NUBUS_9, dev);
173 int __init macsonic_init(struct net_device* dev)
175 struct sonic_local* lp = netdev_priv(dev);
177 /* Allocate the entire chunk of memory for the descriptors.
178 Note that this cannot cross a 64K boundary. */
179 if ((lp->descriptors = dma_alloc_coherent(lp->device,
180 SIZEOF_SONIC_DESC * SONIC_BUS_SCALE(lp->dma_bitmode),
181 &lp->descriptors_laddr, GFP_KERNEL)) == NULL) {
182 printk(KERN_ERR "%s: couldn't alloc DMA memory for descriptors.\n", lp->device->bus_id);
186 /* Now set up the pointers to point to the appropriate places */
187 lp->cda = lp->descriptors;
188 lp->tda = lp->cda + (SIZEOF_SONIC_CDA
189 * SONIC_BUS_SCALE(lp->dma_bitmode));
190 lp->rda = lp->tda + (SIZEOF_SONIC_TD * SONIC_NUM_TDS
191 * SONIC_BUS_SCALE(lp->dma_bitmode));
192 lp->rra = lp->rda + (SIZEOF_SONIC_RD * SONIC_NUM_RDS
193 * SONIC_BUS_SCALE(lp->dma_bitmode));
195 lp->cda_laddr = lp->descriptors_laddr;
196 lp->tda_laddr = lp->cda_laddr + (SIZEOF_SONIC_CDA
197 * SONIC_BUS_SCALE(lp->dma_bitmode));
198 lp->rda_laddr = lp->tda_laddr + (SIZEOF_SONIC_TD * SONIC_NUM_TDS
199 * SONIC_BUS_SCALE(lp->dma_bitmode));
200 lp->rra_laddr = lp->rda_laddr + (SIZEOF_SONIC_RD * SONIC_NUM_RDS
201 * SONIC_BUS_SCALE(lp->dma_bitmode));
203 dev->open = macsonic_open;
204 dev->stop = macsonic_close;
205 dev->hard_start_xmit = sonic_send_packet;
206 dev->get_stats = sonic_get_stats;
207 dev->set_multicast_list = &sonic_multicast_list;
208 dev->tx_timeout = sonic_tx_timeout;
209 dev->watchdog_timeo = TX_TIMEOUT;
212 * clear tally counter
214 SONIC_WRITE(SONIC_CRCT, 0xffff);
215 SONIC_WRITE(SONIC_FAET, 0xffff);
216 SONIC_WRITE(SONIC_MPT, 0xffff);
221 int __init mac_onboard_sonic_ethernet_addr(struct net_device* dev)
223 struct sonic_local *lp = netdev_priv(dev);
224 const int prom_addr = ONBOARD_SONIC_PROM_BASE;
226 DECLARE_MAC_BUF(mac);
228 /* On NuBus boards we can sometimes look in the ROM resources.
229 No such luck for comm-slot/onboard. */
230 for(i = 0; i < 6; i++)
231 dev->dev_addr[i] = SONIC_READ_PROM(i);
233 /* Most of the time, the address is bit-reversed. The NetBSD
234 source has a rather long and detailed historical account of
236 if (memcmp(dev->dev_addr, "\x08\x00\x07", 3) &&
237 memcmp(dev->dev_addr, "\x00\xA0\x40", 3) &&
238 memcmp(dev->dev_addr, "\x00\x80\x19", 3) &&
239 memcmp(dev->dev_addr, "\x00\x05\x02", 3))
240 bit_reverse_addr(dev->dev_addr);
244 /* If we still have what seems to be a bogus address, we'll
245 look in the CAM. The top entry should be ours. */
246 /* Danger! This only works if MacOS has already initialized
248 if (memcmp(dev->dev_addr, "\x08\x00\x07", 3) &&
249 memcmp(dev->dev_addr, "\x00\xA0\x40", 3) &&
250 memcmp(dev->dev_addr, "\x00\x80\x19", 3) &&
251 memcmp(dev->dev_addr, "\x00\x05\x02", 3))
255 printk(KERN_INFO "macsonic: PROM seems to be wrong, trying CAM entry 15\n");
257 SONIC_WRITE(SONIC_CMD, SONIC_CR_RST);
258 SONIC_WRITE(SONIC_CEP, 15);
260 val = SONIC_READ(SONIC_CAP2);
261 dev->dev_addr[5] = val >> 8;
262 dev->dev_addr[4] = val & 0xff;
263 val = SONIC_READ(SONIC_CAP1);
264 dev->dev_addr[3] = val >> 8;
265 dev->dev_addr[2] = val & 0xff;
266 val = SONIC_READ(SONIC_CAP0);
267 dev->dev_addr[1] = val >> 8;
268 dev->dev_addr[0] = val & 0xff;
270 printk(KERN_INFO "HW Address from CAM 15: %s\n",
271 print_mac(mac, dev->dev_addr));
274 if (memcmp(dev->dev_addr, "\x08\x00\x07", 3) &&
275 memcmp(dev->dev_addr, "\x00\xA0\x40", 3) &&
276 memcmp(dev->dev_addr, "\x00\x80\x19", 3) &&
277 memcmp(dev->dev_addr, "\x00\x05\x02", 3))
280 * Still nonsense ... messed up someplace!
282 printk(KERN_ERR "macsonic: ERROR (INVALID MAC)\n");
287 int __init mac_onboard_sonic_probe(struct net_device* dev)
290 static int once_is_more_than_enough;
291 struct sonic_local* lp = netdev_priv(dev);
295 if (once_is_more_than_enough)
297 once_is_more_than_enough = 1;
302 if (macintosh_config->ether_type != MAC_ETHER_SONIC)
305 printk(KERN_INFO "Checking for internal Macintosh ethernet (SONIC).. ");
307 /* Bogus probing, on the models which may or may not have
308 Ethernet (BTW, the Ethernet *is* always at the same
309 address, and nothing else lives there, at least if Apple's
310 documentation is to be believed) */
311 if (macintosh_config->ident == MAC_MODEL_Q630 ||
312 macintosh_config->ident == MAC_MODEL_P588 ||
313 macintosh_config->ident == MAC_MODEL_P575 ||
314 macintosh_config->ident == MAC_MODEL_C610) {
318 local_irq_save(flags);
319 card_present = hwreg_present((void*)ONBOARD_SONIC_REGISTERS);
320 local_irq_restore(flags);
331 /* Danger! My arms are flailing wildly! You *must* set lp->reg_offset
332 * and dev->base_addr before using SONIC_READ() or SONIC_WRITE() */
333 dev->base_addr = ONBOARD_SONIC_REGISTERS;
335 dev->irq = IRQ_AUTO_3;
337 dev->irq = IRQ_NUBUS_9;
339 if (!sonic_version_printed) {
340 printk(KERN_INFO "%s", version);
341 sonic_version_printed = 1;
343 printk(KERN_INFO "%s: onboard / comm-slot SONIC at 0x%08lx\n",
344 lp->device->bus_id, dev->base_addr);
346 /* The PowerBook's SONIC is 16 bit always. */
347 if (macintosh_config->ident == MAC_MODEL_PB520) {
349 lp->dma_bitmode = SONIC_BITMODE16;
350 sr = SONIC_READ(SONIC_SR);
351 } else if (commslot) {
352 /* Some of the comm-slot cards are 16 bit. But some
353 of them are not. The 32-bit cards use offset 2 and
354 have known revisions, we try reading the revision
355 register at offset 2, if we don't get a known revision
356 we assume 16 bit at offset 0. */
358 lp->dma_bitmode = SONIC_BITMODE16;
360 sr = SONIC_READ(SONIC_SR);
361 if (sr == 0x0004 || sr == 0x0006 || sr == 0x0100 || sr == 0x0101)
362 /* 83932 is 0x0004 or 0x0006, 83934 is 0x0100 or 0x0101 */
363 lp->dma_bitmode = SONIC_BITMODE32;
365 lp->dma_bitmode = SONIC_BITMODE16;
367 sr = SONIC_READ(SONIC_SR);
370 /* All onboard cards are at offset 2 with 32 bit DMA. */
372 lp->dma_bitmode = SONIC_BITMODE32;
373 sr = SONIC_READ(SONIC_SR);
376 "%s: revision 0x%04x, using %d bit DMA and register offset %d\n",
377 lp->device->bus_id, sr, lp->dma_bitmode?32:16, lp->reg_offset);
379 #if 0 /* This is sometimes useful to find out how MacOS configured the card. */
380 printk(KERN_INFO "%s: DCR: 0x%04x, DCR2: 0x%04x\n", lp->device->bus_id,
381 SONIC_READ(SONIC_DCR) & 0xffff, SONIC_READ(SONIC_DCR2) & 0xffff);
384 /* Software reset, then initialize control registers. */
385 SONIC_WRITE(SONIC_CMD, SONIC_CR_RST);
387 SONIC_WRITE(SONIC_DCR, SONIC_DCR_EXBUS | SONIC_DCR_BMS |
388 SONIC_DCR_RFT1 | SONIC_DCR_TFT0 |
389 (lp->dma_bitmode ? SONIC_DCR_DW : 0));
391 /* This *must* be written back to in order to restore the
392 * extended programmable output bits, as it may not have been
393 * initialised since the hardware reset. */
394 SONIC_WRITE(SONIC_DCR2, 0);
396 /* Clear *and* disable interrupts to be on the safe side */
397 SONIC_WRITE(SONIC_IMR, 0);
398 SONIC_WRITE(SONIC_ISR, 0x7fff);
400 /* Now look for the MAC address. */
401 if (mac_onboard_sonic_ethernet_addr(dev) != 0)
404 /* Shared init code */
405 return macsonic_init(dev);
408 int __init mac_nubus_sonic_ethernet_addr(struct net_device* dev,
409 unsigned long prom_addr,
413 for(i = 0; i < 6; i++)
414 dev->dev_addr[i] = SONIC_READ_PROM(i);
416 /* Some of the addresses are bit-reversed */
417 if (id != MACSONIC_DAYNA)
418 bit_reverse_addr(dev->dev_addr);
423 int __init macsonic_ident(struct nubus_dev* ndev)
425 if (ndev->dr_hw == NUBUS_DRHW_ASANTE_LC &&
426 ndev->dr_sw == NUBUS_DRSW_SONIC_LC)
427 return MACSONIC_DAYNALINK;
428 if (ndev->dr_hw == NUBUS_DRHW_SONIC &&
429 ndev->dr_sw == NUBUS_DRSW_APPLE) {
430 /* There has to be a better way to do this... */
431 if (strstr(ndev->board->name, "DuoDock"))
432 return MACSONIC_DUODOCK;
434 return MACSONIC_APPLE;
437 if (ndev->dr_hw == NUBUS_DRHW_SMC9194 &&
438 ndev->dr_sw == NUBUS_DRSW_DAYNA)
439 return MACSONIC_DAYNA;
441 if (ndev->dr_hw == NUBUS_DRHW_APPLE_SONIC_LC &&
442 ndev->dr_sw == 0) { /* huh? */
443 return MACSONIC_APPLE16;
448 int __init mac_nubus_sonic_probe(struct net_device* dev)
451 struct nubus_dev* ndev = NULL;
452 struct sonic_local* lp = netdev_priv(dev);
453 unsigned long base_addr, prom_addr;
456 int reg_offset, dma_bitmode;
458 /* Find the first SONIC that hasn't been initialized already */
459 while ((ndev = nubus_find_type(NUBUS_CAT_NETWORK,
460 NUBUS_TYPE_ETHERNET, ndev)) != NULL)
462 /* Have we seen it already? */
463 if (slots & (1<<ndev->board->slot))
465 slots |= 1<<ndev->board->slot;
467 /* Is it one of ours? */
468 if ((id = macsonic_ident(ndev)) != -1)
476 case MACSONIC_DUODOCK:
477 base_addr = ndev->board->slot_addr + DUODOCK_SONIC_REGISTERS;
478 prom_addr = ndev->board->slot_addr + DUODOCK_SONIC_PROM_BASE;
479 sonic_dcr = SONIC_DCR_EXBUS | SONIC_DCR_RFT0 | SONIC_DCR_RFT1 |
482 dma_bitmode = SONIC_BITMODE32;
485 base_addr = ndev->board->slot_addr + APPLE_SONIC_REGISTERS;
486 prom_addr = ndev->board->slot_addr + APPLE_SONIC_PROM_BASE;
487 sonic_dcr = SONIC_DCR_BMS | SONIC_DCR_RFT1 | SONIC_DCR_TFT0;
489 dma_bitmode = SONIC_BITMODE32;
491 case MACSONIC_APPLE16:
492 base_addr = ndev->board->slot_addr + APPLE_SONIC_REGISTERS;
493 prom_addr = ndev->board->slot_addr + APPLE_SONIC_PROM_BASE;
494 sonic_dcr = SONIC_DCR_EXBUS | SONIC_DCR_RFT1 | SONIC_DCR_TFT0 |
495 SONIC_DCR_PO1 | SONIC_DCR_BMS;
497 dma_bitmode = SONIC_BITMODE16;
499 case MACSONIC_DAYNALINK:
500 base_addr = ndev->board->slot_addr + APPLE_SONIC_REGISTERS;
501 prom_addr = ndev->board->slot_addr + DAYNALINK_PROM_BASE;
502 sonic_dcr = SONIC_DCR_RFT1 | SONIC_DCR_TFT0 |
503 SONIC_DCR_PO1 | SONIC_DCR_BMS;
505 dma_bitmode = SONIC_BITMODE16;
508 base_addr = ndev->board->slot_addr + DAYNA_SONIC_REGISTERS;
509 prom_addr = ndev->board->slot_addr + DAYNA_SONIC_MAC_ADDR;
510 sonic_dcr = SONIC_DCR_BMS |
511 SONIC_DCR_RFT1 | SONIC_DCR_TFT0 | SONIC_DCR_PO1;
513 dma_bitmode = SONIC_BITMODE16;
516 printk(KERN_ERR "macsonic: WTF, id is %d\n", id);
520 /* Danger! My arms are flailing wildly! You *must* set lp->reg_offset
521 * and dev->base_addr before using SONIC_READ() or SONIC_WRITE() */
522 dev->base_addr = base_addr;
523 lp->reg_offset = reg_offset;
524 lp->dma_bitmode = dma_bitmode;
525 dev->irq = SLOT2IRQ(ndev->board->slot);
527 if (!sonic_version_printed) {
528 printk(KERN_INFO "%s", version);
529 sonic_version_printed = 1;
531 printk(KERN_INFO "%s: %s in slot %X\n",
532 lp->device->bus_id, ndev->board->name, ndev->board->slot);
533 printk(KERN_INFO "%s: revision 0x%04x, using %d bit DMA and register offset %d\n",
534 lp->device->bus_id, SONIC_READ(SONIC_SR), dma_bitmode?32:16, reg_offset);
536 #if 0 /* This is sometimes useful to find out how MacOS configured the card. */
537 printk(KERN_INFO "%s: DCR: 0x%04x, DCR2: 0x%04x\n", lp->device->bus_id,
538 SONIC_READ(SONIC_DCR) & 0xffff, SONIC_READ(SONIC_DCR2) & 0xffff);
541 /* Software reset, then initialize control registers. */
542 SONIC_WRITE(SONIC_CMD, SONIC_CR_RST);
543 SONIC_WRITE(SONIC_DCR, sonic_dcr | (dma_bitmode ? SONIC_DCR_DW : 0));
544 /* This *must* be written back to in order to restore the
545 * extended programmable output bits, since it may not have been
546 * initialised since the hardware reset. */
547 SONIC_WRITE(SONIC_DCR2, 0);
549 /* Clear *and* disable interrupts to be on the safe side */
550 SONIC_WRITE(SONIC_IMR, 0);
551 SONIC_WRITE(SONIC_ISR, 0x7fff);
553 /* Now look for the MAC address. */
554 if (mac_nubus_sonic_ethernet_addr(dev, prom_addr, id) != 0)
557 /* Shared init code */
558 return macsonic_init(dev);
561 static int __init mac_sonic_probe(struct platform_device *pdev)
563 struct net_device *dev;
564 struct sonic_local *lp;
566 DECLARE_MAC_BUF(mac);
568 dev = alloc_etherdev(sizeof(struct sonic_local));
572 lp = netdev_priv(dev);
573 lp->device = &pdev->dev;
574 SET_NETDEV_DEV(dev, &pdev->dev);
576 /* This will catch fatal stuff like -ENOMEM as well as success */
577 err = mac_onboard_sonic_probe(dev);
582 err = mac_nubus_sonic_probe(dev);
586 err = register_netdev(dev);
590 printk("%s: MAC %s IRQ %d\n",
591 dev->name, print_mac(mac, dev->dev_addr), dev->irq);
601 MODULE_DESCRIPTION("Macintosh SONIC ethernet driver");
602 module_param(sonic_debug, int, 0);
603 MODULE_PARM_DESC(sonic_debug, "macsonic debug level (1-4)");
607 static int __devexit mac_sonic_device_remove (struct platform_device *pdev)
609 struct net_device *dev = platform_get_drvdata(pdev);
610 struct sonic_local* lp = netdev_priv(dev);
612 unregister_netdev(dev);
613 dma_free_coherent(lp->device, SIZEOF_SONIC_DESC * SONIC_BUS_SCALE(lp->dma_bitmode),
614 lp->descriptors, lp->descriptors_laddr);
620 static struct platform_driver mac_sonic_driver = {
621 .probe = mac_sonic_probe,
622 .remove = __devexit_p(mac_sonic_device_remove),
624 .name = mac_sonic_string,
628 static int __init mac_sonic_init_module(void)
632 if ((err = platform_driver_register(&mac_sonic_driver))) {
633 printk(KERN_ERR "Driver registration failed\n");
637 mac_sonic_device = platform_device_alloc(mac_sonic_string, 0);
638 if (!mac_sonic_device)
641 if (platform_device_add(mac_sonic_device)) {
642 platform_device_put(mac_sonic_device);
643 mac_sonic_device = NULL;
649 platform_driver_unregister(&mac_sonic_driver);
654 static void __exit mac_sonic_cleanup_module(void)
656 platform_driver_unregister(&mac_sonic_driver);
658 if (mac_sonic_device) {
659 platform_device_unregister(mac_sonic_device);
660 mac_sonic_device = NULL;
664 module_init(mac_sonic_init_module);
665 module_exit(mac_sonic_cleanup_module);