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/gfp.h>
39 #include <linux/interrupt.h>
40 #include <linux/ioport.h>
42 #include <linux/string.h>
43 #include <linux/delay.h>
44 #include <linux/nubus.h>
45 #include <linux/errno.h>
46 #include <linux/netdevice.h>
47 #include <linux/etherdevice.h>
48 #include <linux/skbuff.h>
49 #include <linux/platform_device.h>
50 #include <linux/dma-mapping.h>
51 #include <linux/bitrev.h>
52 #include <linux/slab.h>
54 #include <asm/bootinfo.h>
55 #include <asm/pgtable.h>
57 #include <asm/hwtest.h>
59 #include <asm/macintosh.h>
60 #include <asm/macints.h>
61 #include <asm/mac_via.h>
63 static char mac_sonic_string[] = "macsonic";
67 /* These should basically be bus-size and endian independent (since
68 the SONIC is at least smart enough that it uses the same endianness
69 as the host, unlike certain less enlightened Macintosh NICs) */
70 #define SONIC_READ(reg) (nubus_readw(dev->base_addr + (reg * 4) \
72 #define SONIC_WRITE(reg,val) (nubus_writew(val, dev->base_addr + (reg * 4) \
75 /* use 0 for production, 1 for verification, >1 for debug */
77 static unsigned int sonic_debug = SONIC_DEBUG;
79 static unsigned int sonic_debug = 1;
82 static int sonic_version_printed;
84 /* For onboard SONIC */
85 #define ONBOARD_SONIC_REGISTERS 0x50F0A000
86 #define ONBOARD_SONIC_PROM_BASE 0x50f08000
96 /* For the built-in SONIC in the Duo Dock */
97 #define DUODOCK_SONIC_REGISTERS 0xe10000
98 #define DUODOCK_SONIC_PROM_BASE 0xe12000
100 /* For Apple-style NuBus SONIC */
101 #define APPLE_SONIC_REGISTERS 0
102 #define APPLE_SONIC_PROM_BASE 0x40000
104 /* Daynalink LC SONIC */
105 #define DAYNALINK_PROM_BASE 0x400000
107 /* For Dayna-style NuBus SONIC (haven't seen one yet) */
108 #define DAYNA_SONIC_REGISTERS 0x180000
109 /* This is what OpenBSD says. However, this is definitely in NuBus
110 ROM space so we should be able to get it by walking the NuBus
111 resource directories */
112 #define DAYNA_SONIC_MAC_ADDR 0xffe004
114 #define SONIC_READ_PROM(addr) nubus_readb(prom_addr+addr)
117 * For reversing the PROM address
120 static inline void bit_reverse_addr(unsigned char addr[6])
124 for(i = 0; i < 6; i++)
125 addr[i] = bitrev8(addr[i]);
128 static irqreturn_t macsonic_interrupt(int irq, void *dev_id)
133 local_irq_save(flags);
134 result = sonic_interrupt(irq, dev_id);
135 local_irq_restore(flags);
139 static int macsonic_open(struct net_device* dev)
143 retval = request_irq(dev->irq, sonic_interrupt, 0, "sonic", dev);
145 printk(KERN_ERR "%s: unable to get IRQ %d.\n",
146 dev->name, dev->irq);
149 /* Under the A/UX interrupt scheme, the onboard SONIC interrupt comes
150 * in at priority level 3. However, we sometimes get the level 2 inter-
151 * rupt as well, which must prevent re-entrance of the sonic handler.
153 if (dev->irq == IRQ_AUTO_3) {
154 retval = request_irq(IRQ_NUBUS_9, macsonic_interrupt, 0,
157 printk(KERN_ERR "%s: unable to get IRQ %d.\n",
158 dev->name, IRQ_NUBUS_9);
162 retval = sonic_open(dev);
168 if (dev->irq == IRQ_AUTO_3)
169 free_irq(IRQ_NUBUS_9, dev);
171 free_irq(dev->irq, dev);
176 static int macsonic_close(struct net_device* dev)
179 err = sonic_close(dev);
180 free_irq(dev->irq, dev);
181 if (dev->irq == IRQ_AUTO_3)
182 free_irq(IRQ_NUBUS_9, dev);
186 static const struct net_device_ops macsonic_netdev_ops = {
187 .ndo_open = macsonic_open,
188 .ndo_stop = macsonic_close,
189 .ndo_start_xmit = sonic_send_packet,
190 .ndo_set_rx_mode = sonic_multicast_list,
191 .ndo_tx_timeout = sonic_tx_timeout,
192 .ndo_get_stats = sonic_get_stats,
193 .ndo_validate_addr = eth_validate_addr,
194 .ndo_change_mtu = eth_change_mtu,
195 .ndo_set_mac_address = eth_mac_addr,
198 static int macsonic_init(struct net_device *dev)
200 struct sonic_local* lp = netdev_priv(dev);
202 /* Allocate the entire chunk of memory for the descriptors.
203 Note that this cannot cross a 64K boundary. */
204 lp->descriptors = dma_alloc_coherent(lp->device,
206 SONIC_BUS_SCALE(lp->dma_bitmode),
207 &lp->descriptors_laddr,
209 if (lp->descriptors == NULL)
212 /* Now set up the pointers to point to the appropriate places */
213 lp->cda = lp->descriptors;
214 lp->tda = lp->cda + (SIZEOF_SONIC_CDA
215 * SONIC_BUS_SCALE(lp->dma_bitmode));
216 lp->rda = lp->tda + (SIZEOF_SONIC_TD * SONIC_NUM_TDS
217 * SONIC_BUS_SCALE(lp->dma_bitmode));
218 lp->rra = lp->rda + (SIZEOF_SONIC_RD * SONIC_NUM_RDS
219 * SONIC_BUS_SCALE(lp->dma_bitmode));
221 lp->cda_laddr = lp->descriptors_laddr;
222 lp->tda_laddr = lp->cda_laddr + (SIZEOF_SONIC_CDA
223 * SONIC_BUS_SCALE(lp->dma_bitmode));
224 lp->rda_laddr = lp->tda_laddr + (SIZEOF_SONIC_TD * SONIC_NUM_TDS
225 * SONIC_BUS_SCALE(lp->dma_bitmode));
226 lp->rra_laddr = lp->rda_laddr + (SIZEOF_SONIC_RD * SONIC_NUM_RDS
227 * SONIC_BUS_SCALE(lp->dma_bitmode));
229 dev->netdev_ops = &macsonic_netdev_ops;
230 dev->watchdog_timeo = TX_TIMEOUT;
233 * clear tally counter
235 SONIC_WRITE(SONIC_CRCT, 0xffff);
236 SONIC_WRITE(SONIC_FAET, 0xffff);
237 SONIC_WRITE(SONIC_MPT, 0xffff);
242 #define INVALID_MAC(mac) (memcmp(mac, "\x08\x00\x07", 3) && \
243 memcmp(mac, "\x00\xA0\x40", 3) && \
244 memcmp(mac, "\x00\x80\x19", 3) && \
245 memcmp(mac, "\x00\x05\x02", 3))
247 static void mac_onboard_sonic_ethernet_addr(struct net_device *dev)
249 struct sonic_local *lp = netdev_priv(dev);
250 const int prom_addr = ONBOARD_SONIC_PROM_BASE;
254 * On NuBus boards we can sometimes look in the ROM resources.
255 * No such luck for comm-slot/onboard.
256 * On the PowerBook 520, the PROM base address is a mystery.
258 if (hwreg_present((void *)prom_addr)) {
261 for (i = 0; i < 6; i++)
262 dev->dev_addr[i] = SONIC_READ_PROM(i);
263 if (!INVALID_MAC(dev->dev_addr))
267 * Most of the time, the address is bit-reversed. The NetBSD
268 * source has a rather long and detailed historical account of
271 bit_reverse_addr(dev->dev_addr);
272 if (!INVALID_MAC(dev->dev_addr))
276 * If we still have what seems to be a bogus address, we'll
277 * look in the CAM. The top entry should be ours.
279 printk(KERN_WARNING "macsonic: MAC address in PROM seems "
280 "to be invalid, trying CAM\n");
282 printk(KERN_WARNING "macsonic: cannot read MAC address from "
283 "PROM, trying CAM\n");
286 /* This only works if MacOS has already initialized the card. */
288 SONIC_WRITE(SONIC_CMD, SONIC_CR_RST);
289 SONIC_WRITE(SONIC_CEP, 15);
291 val = SONIC_READ(SONIC_CAP2);
292 dev->dev_addr[5] = val >> 8;
293 dev->dev_addr[4] = val & 0xff;
294 val = SONIC_READ(SONIC_CAP1);
295 dev->dev_addr[3] = val >> 8;
296 dev->dev_addr[2] = val & 0xff;
297 val = SONIC_READ(SONIC_CAP0);
298 dev->dev_addr[1] = val >> 8;
299 dev->dev_addr[0] = val & 0xff;
301 if (!INVALID_MAC(dev->dev_addr))
304 /* Still nonsense ... messed up someplace! */
306 printk(KERN_WARNING "macsonic: MAC address in CAM entry 15 "
307 "seems invalid, will use a random MAC\n");
308 eth_hw_addr_random(dev);
311 static int mac_onboard_sonic_probe(struct net_device *dev)
313 struct sonic_local* lp = netdev_priv(dev);
320 printk(KERN_INFO "Checking for internal Macintosh ethernet (SONIC).. ");
322 /* Bogus probing, on the models which may or may not have
323 Ethernet (BTW, the Ethernet *is* always at the same
324 address, and nothing else lives there, at least if Apple's
325 documentation is to be believed) */
326 if (macintosh_config->ident == MAC_MODEL_Q630 ||
327 macintosh_config->ident == MAC_MODEL_P588 ||
328 macintosh_config->ident == MAC_MODEL_P575 ||
329 macintosh_config->ident == MAC_MODEL_C610) {
333 local_irq_save(flags);
334 card_present = hwreg_present((void*)ONBOARD_SONIC_REGISTERS);
335 local_irq_restore(flags);
346 /* Danger! My arms are flailing wildly! You *must* set lp->reg_offset
347 * and dev->base_addr before using SONIC_READ() or SONIC_WRITE() */
348 dev->base_addr = ONBOARD_SONIC_REGISTERS;
350 dev->irq = IRQ_AUTO_3;
352 dev->irq = IRQ_NUBUS_9;
354 if (!sonic_version_printed) {
355 printk(KERN_INFO "%s", version);
356 sonic_version_printed = 1;
358 printk(KERN_INFO "%s: onboard / comm-slot SONIC at 0x%08lx\n",
359 dev_name(lp->device), dev->base_addr);
361 /* The PowerBook's SONIC is 16 bit always. */
362 if (macintosh_config->ident == MAC_MODEL_PB520) {
364 lp->dma_bitmode = SONIC_BITMODE16;
365 sr = SONIC_READ(SONIC_SR);
366 } else if (commslot) {
367 /* Some of the comm-slot cards are 16 bit. But some
368 of them are not. The 32-bit cards use offset 2 and
369 have known revisions, we try reading the revision
370 register at offset 2, if we don't get a known revision
371 we assume 16 bit at offset 0. */
373 lp->dma_bitmode = SONIC_BITMODE16;
375 sr = SONIC_READ(SONIC_SR);
376 if (sr == 0x0004 || sr == 0x0006 || sr == 0x0100 || sr == 0x0101)
377 /* 83932 is 0x0004 or 0x0006, 83934 is 0x0100 or 0x0101 */
378 lp->dma_bitmode = SONIC_BITMODE32;
380 lp->dma_bitmode = SONIC_BITMODE16;
382 sr = SONIC_READ(SONIC_SR);
385 /* All onboard cards are at offset 2 with 32 bit DMA. */
387 lp->dma_bitmode = SONIC_BITMODE32;
388 sr = SONIC_READ(SONIC_SR);
391 "%s: revision 0x%04x, using %d bit DMA and register offset %d\n",
392 dev_name(lp->device), sr, lp->dma_bitmode?32:16, lp->reg_offset);
394 #if 0 /* This is sometimes useful to find out how MacOS configured the card. */
395 printk(KERN_INFO "%s: DCR: 0x%04x, DCR2: 0x%04x\n", dev_name(lp->device),
396 SONIC_READ(SONIC_DCR) & 0xffff, SONIC_READ(SONIC_DCR2) & 0xffff);
399 /* Software reset, then initialize control registers. */
400 SONIC_WRITE(SONIC_CMD, SONIC_CR_RST);
402 SONIC_WRITE(SONIC_DCR, SONIC_DCR_EXBUS | SONIC_DCR_BMS |
403 SONIC_DCR_RFT1 | SONIC_DCR_TFT0 |
404 (lp->dma_bitmode ? SONIC_DCR_DW : 0));
406 /* This *must* be written back to in order to restore the
407 * extended programmable output bits, as it may not have been
408 * initialised since the hardware reset. */
409 SONIC_WRITE(SONIC_DCR2, 0);
411 /* Clear *and* disable interrupts to be on the safe side */
412 SONIC_WRITE(SONIC_IMR, 0);
413 SONIC_WRITE(SONIC_ISR, 0x7fff);
415 /* Now look for the MAC address. */
416 mac_onboard_sonic_ethernet_addr(dev);
418 /* Shared init code */
419 return macsonic_init(dev);
422 static int mac_nubus_sonic_ethernet_addr(struct net_device *dev,
423 unsigned long prom_addr, int id)
426 for(i = 0; i < 6; i++)
427 dev->dev_addr[i] = SONIC_READ_PROM(i);
429 /* Some of the addresses are bit-reversed */
430 if (id != MACSONIC_DAYNA)
431 bit_reverse_addr(dev->dev_addr);
436 static int macsonic_ident(struct nubus_dev *ndev)
438 if (ndev->dr_hw == NUBUS_DRHW_ASANTE_LC &&
439 ndev->dr_sw == NUBUS_DRSW_SONIC_LC)
440 return MACSONIC_DAYNALINK;
441 if (ndev->dr_hw == NUBUS_DRHW_SONIC &&
442 ndev->dr_sw == NUBUS_DRSW_APPLE) {
443 /* There has to be a better way to do this... */
444 if (strstr(ndev->board->name, "DuoDock"))
445 return MACSONIC_DUODOCK;
447 return MACSONIC_APPLE;
450 if (ndev->dr_hw == NUBUS_DRHW_SMC9194 &&
451 ndev->dr_sw == NUBUS_DRSW_DAYNA)
452 return MACSONIC_DAYNA;
454 if (ndev->dr_hw == NUBUS_DRHW_APPLE_SONIC_LC &&
455 ndev->dr_sw == 0) { /* huh? */
456 return MACSONIC_APPLE16;
461 static int mac_nubus_sonic_probe(struct net_device *dev)
464 struct nubus_dev* ndev = NULL;
465 struct sonic_local* lp = netdev_priv(dev);
466 unsigned long base_addr, prom_addr;
469 int reg_offset, dma_bitmode;
471 /* Find the first SONIC that hasn't been initialized already */
472 while ((ndev = nubus_find_type(NUBUS_CAT_NETWORK,
473 NUBUS_TYPE_ETHERNET, ndev)) != NULL)
475 /* Have we seen it already? */
476 if (slots & (1<<ndev->board->slot))
478 slots |= 1<<ndev->board->slot;
480 /* Is it one of ours? */
481 if ((id = macsonic_ident(ndev)) != -1)
489 case MACSONIC_DUODOCK:
490 base_addr = ndev->board->slot_addr + DUODOCK_SONIC_REGISTERS;
491 prom_addr = ndev->board->slot_addr + DUODOCK_SONIC_PROM_BASE;
492 sonic_dcr = SONIC_DCR_EXBUS | SONIC_DCR_RFT0 | SONIC_DCR_RFT1 |
495 dma_bitmode = SONIC_BITMODE32;
498 base_addr = ndev->board->slot_addr + APPLE_SONIC_REGISTERS;
499 prom_addr = ndev->board->slot_addr + APPLE_SONIC_PROM_BASE;
500 sonic_dcr = SONIC_DCR_BMS | SONIC_DCR_RFT1 | SONIC_DCR_TFT0;
502 dma_bitmode = SONIC_BITMODE32;
504 case MACSONIC_APPLE16:
505 base_addr = ndev->board->slot_addr + APPLE_SONIC_REGISTERS;
506 prom_addr = ndev->board->slot_addr + APPLE_SONIC_PROM_BASE;
507 sonic_dcr = SONIC_DCR_EXBUS | SONIC_DCR_RFT1 | SONIC_DCR_TFT0 |
508 SONIC_DCR_PO1 | SONIC_DCR_BMS;
510 dma_bitmode = SONIC_BITMODE16;
512 case MACSONIC_DAYNALINK:
513 base_addr = ndev->board->slot_addr + APPLE_SONIC_REGISTERS;
514 prom_addr = ndev->board->slot_addr + DAYNALINK_PROM_BASE;
515 sonic_dcr = SONIC_DCR_RFT1 | SONIC_DCR_TFT0 |
516 SONIC_DCR_PO1 | SONIC_DCR_BMS;
518 dma_bitmode = SONIC_BITMODE16;
521 base_addr = ndev->board->slot_addr + DAYNA_SONIC_REGISTERS;
522 prom_addr = ndev->board->slot_addr + DAYNA_SONIC_MAC_ADDR;
523 sonic_dcr = SONIC_DCR_BMS |
524 SONIC_DCR_RFT1 | SONIC_DCR_TFT0 | SONIC_DCR_PO1;
526 dma_bitmode = SONIC_BITMODE16;
529 printk(KERN_ERR "macsonic: WTF, id is %d\n", id);
533 /* Danger! My arms are flailing wildly! You *must* set lp->reg_offset
534 * and dev->base_addr before using SONIC_READ() or SONIC_WRITE() */
535 dev->base_addr = base_addr;
536 lp->reg_offset = reg_offset;
537 lp->dma_bitmode = dma_bitmode;
538 dev->irq = SLOT2IRQ(ndev->board->slot);
540 if (!sonic_version_printed) {
541 printk(KERN_INFO "%s", version);
542 sonic_version_printed = 1;
544 printk(KERN_INFO "%s: %s in slot %X\n",
545 dev_name(lp->device), ndev->board->name, ndev->board->slot);
546 printk(KERN_INFO "%s: revision 0x%04x, using %d bit DMA and register offset %d\n",
547 dev_name(lp->device), SONIC_READ(SONIC_SR), dma_bitmode?32:16, reg_offset);
549 #if 0 /* This is sometimes useful to find out how MacOS configured the card. */
550 printk(KERN_INFO "%s: DCR: 0x%04x, DCR2: 0x%04x\n", dev_name(lp->device),
551 SONIC_READ(SONIC_DCR) & 0xffff, SONIC_READ(SONIC_DCR2) & 0xffff);
554 /* Software reset, then initialize control registers. */
555 SONIC_WRITE(SONIC_CMD, SONIC_CR_RST);
556 SONIC_WRITE(SONIC_DCR, sonic_dcr | (dma_bitmode ? SONIC_DCR_DW : 0));
557 /* This *must* be written back to in order to restore the
558 * extended programmable output bits, since it may not have been
559 * initialised since the hardware reset. */
560 SONIC_WRITE(SONIC_DCR2, 0);
562 /* Clear *and* disable interrupts to be on the safe side */
563 SONIC_WRITE(SONIC_IMR, 0);
564 SONIC_WRITE(SONIC_ISR, 0x7fff);
566 /* Now look for the MAC address. */
567 if (mac_nubus_sonic_ethernet_addr(dev, prom_addr, id) != 0)
570 /* Shared init code */
571 return macsonic_init(dev);
574 static int mac_sonic_probe(struct platform_device *pdev)
576 struct net_device *dev;
577 struct sonic_local *lp;
580 dev = alloc_etherdev(sizeof(struct sonic_local));
584 lp = netdev_priv(dev);
585 lp->device = &pdev->dev;
586 SET_NETDEV_DEV(dev, &pdev->dev);
587 platform_set_drvdata(pdev, dev);
589 /* This will catch fatal stuff like -ENOMEM as well as success */
590 err = mac_onboard_sonic_probe(dev);
595 err = mac_nubus_sonic_probe(dev);
599 err = register_netdev(dev);
603 printk("%s: MAC %pM IRQ %d\n", dev->name, dev->dev_addr, dev->irq);
613 MODULE_DESCRIPTION("Macintosh SONIC ethernet driver");
614 module_param(sonic_debug, int, 0);
615 MODULE_PARM_DESC(sonic_debug, "macsonic debug level (1-4)");
616 MODULE_ALIAS("platform:macsonic");
620 static int mac_sonic_device_remove(struct platform_device *pdev)
622 struct net_device *dev = platform_get_drvdata(pdev);
623 struct sonic_local* lp = netdev_priv(dev);
625 unregister_netdev(dev);
626 dma_free_coherent(lp->device, SIZEOF_SONIC_DESC * SONIC_BUS_SCALE(lp->dma_bitmode),
627 lp->descriptors, lp->descriptors_laddr);
633 static struct platform_driver mac_sonic_driver = {
634 .probe = mac_sonic_probe,
635 .remove = mac_sonic_device_remove,
637 .name = mac_sonic_string,
638 .owner = THIS_MODULE,
642 module_platform_driver(mac_sonic_driver);