2 * Driver for the Macintosh 68K onboard MACE controller with PSC
3 * driven DMA. The MACE driver code is derived from mace.c. The
4 * Mac68k theory of operation is courtesy of the MacBSD wizards.
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
11 * Copyright (C) 1996 Paul Mackerras.
12 * Copyright (C) 1998 Alan Cox <alan@lxorguk.ukuu.org.uk>
14 * Modified heavily by Joshua M. Thompson based on Dave Huang's NetBSD driver
16 * Copyright (C) 2007 Finn Thain
18 * Converted to DMA API, converted to unified driver model,
19 * sync'd some routines with mace.c and fixed various bugs.
23 #include <linux/kernel.h>
24 #include <linux/module.h>
25 #include <linux/netdevice.h>
26 #include <linux/etherdevice.h>
27 #include <linux/delay.h>
28 #include <linux/string.h>
29 #include <linux/crc32.h>
30 #include <linux/bitrev.h>
31 #include <linux/dma-mapping.h>
32 #include <linux/platform_device.h>
35 #include <asm/macintosh.h>
36 #include <asm/macints.h>
37 #include <asm/mac_psc.h>
41 static char mac_mace_string[] = "macmace";
42 static struct platform_device *mac_mace_device;
44 #define N_TX_BUFF_ORDER 0
45 #define N_TX_RING (1 << N_TX_BUFF_ORDER)
46 #define N_RX_BUFF_ORDER 3
47 #define N_RX_RING (1 << N_RX_BUFF_ORDER)
51 #define MACE_BUFF_SIZE 0x800
53 /* Chip rev needs workaround on HW & multicast addr change */
54 #define BROKEN_ADDRCHG_REV 0x0941
56 /* The MACE is simply wired down on a Mac68K box */
58 #define MACE_BASE (void *)(0x50F1C000)
59 #define MACE_PROM (void *)(0x50F08001)
62 volatile struct mace *mace;
63 unsigned char *tx_ring;
64 dma_addr_t tx_ring_phys;
65 unsigned char *rx_ring;
66 dma_addr_t rx_ring_phys;
69 int tx_slot, tx_sloti, tx_count;
71 struct device *device;
86 /* And frame continues.. */
89 #define PRIV_BYTES sizeof(struct mace_data)
91 static int mace_open(struct net_device *dev);
92 static int mace_close(struct net_device *dev);
93 static int mace_xmit_start(struct sk_buff *skb, struct net_device *dev);
94 static void mace_set_multicast(struct net_device *dev);
95 static int mace_set_address(struct net_device *dev, void *addr);
96 static void mace_reset(struct net_device *dev);
97 static irqreturn_t mace_interrupt(int irq, void *dev_id);
98 static irqreturn_t mace_dma_intr(int irq, void *dev_id);
99 static void mace_tx_timeout(struct net_device *dev);
100 static void __mace_set_address(struct net_device *dev, void *addr);
103 * Load a receive DMA channel with a base address and ring length
106 static void mace_load_rxdma_base(struct net_device *dev, int set)
108 struct mace_data *mp = netdev_priv(dev);
110 psc_write_word(PSC_ENETRD_CMD + set, 0x0100);
111 psc_write_long(PSC_ENETRD_ADDR + set, (u32) mp->rx_ring_phys);
112 psc_write_long(PSC_ENETRD_LEN + set, N_RX_RING);
113 psc_write_word(PSC_ENETRD_CMD + set, 0x9800);
118 * Reset the receive DMA subsystem
121 static void mace_rxdma_reset(struct net_device *dev)
123 struct mace_data *mp = netdev_priv(dev);
124 volatile struct mace *mace = mp->mace;
125 u8 maccc = mace->maccc;
127 mace->maccc = maccc & ~ENRCV;
129 psc_write_word(PSC_ENETRD_CTL, 0x8800);
130 mace_load_rxdma_base(dev, 0x00);
131 psc_write_word(PSC_ENETRD_CTL, 0x0400);
133 psc_write_word(PSC_ENETRD_CTL, 0x8800);
134 mace_load_rxdma_base(dev, 0x10);
135 psc_write_word(PSC_ENETRD_CTL, 0x0400);
140 psc_write_word(PSC_ENETRD_CMD + PSC_SET0, 0x9800);
141 psc_write_word(PSC_ENETRD_CMD + PSC_SET1, 0x9800);
145 * Reset the transmit DMA subsystem
148 static void mace_txdma_reset(struct net_device *dev)
150 struct mace_data *mp = netdev_priv(dev);
151 volatile struct mace *mace = mp->mace;
154 psc_write_word(PSC_ENETWR_CTL, 0x8800);
157 mace->maccc = maccc & ~ENXMT;
159 mp->tx_slot = mp->tx_sloti = 0;
160 mp->tx_count = N_TX_RING;
162 psc_write_word(PSC_ENETWR_CTL, 0x0400);
170 static void mace_dma_off(struct net_device *dev)
172 psc_write_word(PSC_ENETRD_CTL, 0x8800);
173 psc_write_word(PSC_ENETRD_CTL, 0x1000);
174 psc_write_word(PSC_ENETRD_CMD + PSC_SET0, 0x1100);
175 psc_write_word(PSC_ENETRD_CMD + PSC_SET1, 0x1100);
177 psc_write_word(PSC_ENETWR_CTL, 0x8800);
178 psc_write_word(PSC_ENETWR_CTL, 0x1000);
179 psc_write_word(PSC_ENETWR_CMD + PSC_SET0, 0x1100);
180 psc_write_word(PSC_ENETWR_CMD + PSC_SET1, 0x1100);
183 static const struct net_device_ops mace_netdev_ops = {
184 .ndo_open = mace_open,
185 .ndo_stop = mace_close,
186 .ndo_start_xmit = mace_xmit_start,
187 .ndo_tx_timeout = mace_tx_timeout,
188 .ndo_set_multicast_list = mace_set_multicast,
189 .ndo_set_mac_address = mace_set_address,
190 .ndo_change_mtu = eth_change_mtu,
191 .ndo_validate_addr = eth_validate_addr,
195 * Not really much of a probe. The hardware table tells us if this
196 * model of Macintrash has a MACE (AV macintoshes)
199 static int __devinit mace_probe(struct platform_device *pdev)
202 struct mace_data *mp;
204 struct net_device *dev;
205 unsigned char checksum = 0;
206 static int found = 0;
209 if (found || macintosh_config->ether_type != MAC_ETHER_MACE)
212 found = 1; /* prevent 'finding' one on every device probe */
214 dev = alloc_etherdev(PRIV_BYTES);
218 mp = netdev_priv(dev);
220 mp->device = &pdev->dev;
221 SET_NETDEV_DEV(dev, &pdev->dev);
223 dev->base_addr = (u32)MACE_BASE;
224 mp->mace = (volatile struct mace *) MACE_BASE;
226 dev->irq = IRQ_MAC_MACE;
227 mp->dma_intr = IRQ_MAC_MACE_DMA;
229 mp->chipid = mp->mace->chipid_hi << 8 | mp->mace->chipid_lo;
232 * The PROM contains 8 bytes which total 0xFF when XOR'd
233 * together. Due to the usual peculiar apple brain damage
234 * the bytes are spaced out in a strange boundary and the
238 addr = (void *)MACE_PROM;
240 for (j = 0; j < 6; ++j) {
241 u8 v = bitrev8(addr[j<<4]);
243 dev->dev_addr[j] = v;
246 checksum ^= bitrev8(addr[j<<4]);
249 if (checksum != 0xFF) {
254 dev->netdev_ops = &mace_netdev_ops;
255 dev->watchdog_timeo = TX_TIMEOUT;
257 printk(KERN_INFO "%s: 68K MACE, hardware address %pM\n",
258 dev->name, dev->dev_addr);
260 err = register_netdev(dev);
272 static void mace_reset(struct net_device *dev)
274 struct mace_data *mp = netdev_priv(dev);
275 volatile struct mace *mb = mp->mace;
278 /* soft-reset the chip */
282 if (mb->biucc & SWRST) {
289 printk(KERN_ERR "macmace: cannot reset chip!\n");
293 mb->maccc = 0; /* turn off tx, rx */
294 mb->imr = 0xFF; /* disable all intrs for now */
297 mb->biucc = XMTSP_64;
299 mb->fifocc = XMTFW_8 | RCVFW_64 | XMTFWU | RCVFWU;
301 mb->xmtfc = AUTO_PAD_XMIT; /* auto-pad short frames */
304 /* load up the hardware address */
305 __mace_set_address(dev, dev->dev_addr);
307 /* clear the multicast filter */
308 if (mp->chipid == BROKEN_ADDRCHG_REV)
311 mb->iac = ADDRCHG | LOGADDR;
312 while ((mb->iac & ADDRCHG) != 0)
315 for (i = 0; i < 8; ++i)
318 /* done changing address */
319 if (mp->chipid != BROKEN_ADDRCHG_REV)
322 mb->plscc = PORTSEL_AUI;
326 * Load the address on a mace controller.
329 static void __mace_set_address(struct net_device *dev, void *addr)
331 struct mace_data *mp = netdev_priv(dev);
332 volatile struct mace *mb = mp->mace;
333 unsigned char *p = addr;
336 /* load up the hardware address */
337 if (mp->chipid == BROKEN_ADDRCHG_REV)
340 mb->iac = ADDRCHG | PHYADDR;
341 while ((mb->iac & ADDRCHG) != 0)
344 for (i = 0; i < 6; ++i)
345 mb->padr = dev->dev_addr[i] = p[i];
346 if (mp->chipid != BROKEN_ADDRCHG_REV)
350 static int mace_set_address(struct net_device *dev, void *addr)
352 struct mace_data *mp = netdev_priv(dev);
353 volatile struct mace *mb = mp->mace;
357 local_irq_save(flags);
361 __mace_set_address(dev, addr);
365 local_irq_restore(flags);
371 * Open the Macintosh MACE. Most of this is playing with the DMA
372 * engine. The ethernet chip is quite friendly.
375 static int mace_open(struct net_device *dev)
377 struct mace_data *mp = netdev_priv(dev);
378 volatile struct mace *mb = mp->mace;
383 if (request_irq(dev->irq, mace_interrupt, 0, dev->name, dev)) {
384 printk(KERN_ERR "%s: can't get irq %d\n", dev->name, dev->irq);
387 if (request_irq(mp->dma_intr, mace_dma_intr, 0, dev->name, dev)) {
388 printk(KERN_ERR "%s: can't get irq %d\n", dev->name, mp->dma_intr);
389 free_irq(dev->irq, dev);
393 /* Allocate the DMA ring buffers */
395 mp->tx_ring = dma_alloc_coherent(mp->device,
396 N_TX_RING * MACE_BUFF_SIZE,
397 &mp->tx_ring_phys, GFP_KERNEL);
398 if (mp->tx_ring == NULL) {
399 printk(KERN_ERR "%s: unable to allocate DMA tx buffers\n", dev->name);
403 mp->rx_ring = dma_alloc_coherent(mp->device,
404 N_RX_RING * MACE_BUFF_SIZE,
405 &mp->rx_ring_phys, GFP_KERNEL);
406 if (mp->rx_ring == NULL) {
407 printk(KERN_ERR "%s: unable to allocate DMA rx buffers\n", dev->name);
413 /* Not sure what these do */
415 psc_write_word(PSC_ENETWR_CTL, 0x9000);
416 psc_write_word(PSC_ENETRD_CTL, 0x9000);
417 psc_write_word(PSC_ENETWR_CTL, 0x0400);
418 psc_write_word(PSC_ENETRD_CTL, 0x0400);
420 mace_rxdma_reset(dev);
421 mace_txdma_reset(dev);
424 mb->maccc = ENXMT | ENRCV;
425 /* enable all interrupts except receive interrupts */
430 dma_free_coherent(mp->device, N_TX_RING * MACE_BUFF_SIZE,
431 mp->tx_ring, mp->tx_ring_phys);
433 free_irq(dev->irq, dev);
434 free_irq(mp->dma_intr, dev);
439 * Shut down the mace and its interrupt channel
442 static int mace_close(struct net_device *dev)
444 struct mace_data *mp = netdev_priv(dev);
445 volatile struct mace *mb = mp->mace;
447 mb->maccc = 0; /* disable rx and tx */
448 mb->imr = 0xFF; /* disable all irqs */
449 mace_dma_off(dev); /* disable rx and tx dma */
458 static int mace_xmit_start(struct sk_buff *skb, struct net_device *dev)
460 struct mace_data *mp = netdev_priv(dev);
463 /* Stop the queue since there's only the one buffer */
465 local_irq_save(flags);
466 netif_stop_queue(dev);
468 printk(KERN_ERR "macmace: tx queue running but no free buffers.\n");
469 local_irq_restore(flags);
470 return NETDEV_TX_BUSY;
473 local_irq_restore(flags);
475 dev->stats.tx_packets++;
476 dev->stats.tx_bytes += skb->len;
478 /* We need to copy into our xmit buffer to take care of alignment and caching issues */
479 skb_copy_from_linear_data(skb, mp->tx_ring, skb->len);
481 /* load the Tx DMA and fire it off */
483 psc_write_long(PSC_ENETWR_ADDR + mp->tx_slot, (u32) mp->tx_ring_phys);
484 psc_write_long(PSC_ENETWR_LEN + mp->tx_slot, skb->len);
485 psc_write_word(PSC_ENETWR_CMD + mp->tx_slot, 0x9800);
491 dev->trans_start = jiffies;
495 static void mace_set_multicast(struct net_device *dev)
497 struct mace_data *mp = netdev_priv(dev);
498 volatile struct mace *mb = mp->mace;
504 local_irq_save(flags);
508 if (dev->flags & IFF_PROMISC) {
511 unsigned char multicast_filter[8];
512 struct dev_mc_list *dmi = dev->mc_list;
514 if (dev->flags & IFF_ALLMULTI) {
515 for (i = 0; i < 8; i++) {
516 multicast_filter[i] = 0xFF;
519 for (i = 0; i < 8; i++)
520 multicast_filter[i] = 0;
521 for (i = 0; i < dev->mc_count; i++) {
522 crc = ether_crc_le(6, dmi->dmi_addr);
523 j = crc >> 26; /* bit number in multicast_filter */
524 multicast_filter[j >> 3] |= 1 << (j & 7);
529 if (mp->chipid == BROKEN_ADDRCHG_REV)
532 mb->iac = ADDRCHG | LOGADDR;
533 while ((mb->iac & ADDRCHG) != 0)
536 for (i = 0; i < 8; ++i)
537 mb->ladrf = multicast_filter[i];
538 if (mp->chipid != BROKEN_ADDRCHG_REV)
543 local_irq_restore(flags);
546 static void mace_handle_misc_intrs(struct net_device *dev, int intr)
548 struct mace_data *mp = netdev_priv(dev);
549 volatile struct mace *mb = mp->mace;
550 static int mace_babbles, mace_jabbers;
553 dev->stats.rx_missed_errors += 256;
554 dev->stats.rx_missed_errors += mb->mpc; /* reading clears it */
556 dev->stats.rx_length_errors += 256;
557 dev->stats.rx_length_errors += mb->rntpc; /* reading clears it */
559 ++dev->stats.tx_heartbeat_errors;
561 if (mace_babbles++ < 4)
562 printk(KERN_DEBUG "macmace: babbling transmitter\n");
564 if (mace_jabbers++ < 4)
565 printk(KERN_DEBUG "macmace: jabbering transceiver\n");
568 static irqreturn_t mace_interrupt(int irq, void *dev_id)
570 struct net_device *dev = (struct net_device *) dev_id;
571 struct mace_data *mp = netdev_priv(dev);
572 volatile struct mace *mb = mp->mace;
576 /* don't want the dma interrupt handler to fire */
577 local_irq_save(flags);
579 intr = mb->ir; /* read interrupt register */
580 mace_handle_misc_intrs(dev, intr);
584 if ((fs & XMTSV) == 0) {
585 printk(KERN_ERR "macmace: xmtfs not valid! (fs=%x)\n", fs);
588 * XXX mace likes to hang the machine after a xmtfs error.
589 * This is hard to reproduce, reseting *may* help
592 /* dma should have finished */
594 printk(KERN_DEBUG "macmace: tx ring ran out? (fs=%x)\n", fs);
597 if (fs & (UFLO|LCOL|LCAR|RTRY)) {
598 ++dev->stats.tx_errors;
600 ++dev->stats.tx_carrier_errors;
601 else if (fs & (UFLO|LCOL|RTRY)) {
602 ++dev->stats.tx_aborted_errors;
603 if (mb->xmtfs & UFLO) {
604 printk(KERN_ERR "%s: DMA underrun.\n", dev->name);
605 dev->stats.tx_fifo_errors++;
606 mace_txdma_reset(dev);
613 netif_wake_queue(dev);
615 local_irq_restore(flags);
620 static void mace_tx_timeout(struct net_device *dev)
622 struct mace_data *mp = netdev_priv(dev);
623 volatile struct mace *mb = mp->mace;
626 local_irq_save(flags);
628 /* turn off both tx and rx and reset the chip */
630 printk(KERN_ERR "macmace: transmit timeout - resetting\n");
631 mace_txdma_reset(dev);
635 mace_rxdma_reset(dev);
637 mp->tx_count = N_TX_RING;
638 netif_wake_queue(dev);
641 mb->maccc = ENXMT | ENRCV;
642 /* enable all interrupts except receive interrupts */
645 local_irq_restore(flags);
649 * Handle a newly arrived frame
652 static void mace_dma_rx_frame(struct net_device *dev, struct mace_frame *mf)
655 unsigned int frame_status = mf->rcvsts;
657 if (frame_status & (RS_OFLO | RS_CLSN | RS_FRAMERR | RS_FCSERR)) {
658 dev->stats.rx_errors++;
659 if (frame_status & RS_OFLO) {
660 printk(KERN_DEBUG "%s: fifo overflow.\n", dev->name);
661 dev->stats.rx_fifo_errors++;
663 if (frame_status & RS_CLSN)
664 dev->stats.collisions++;
665 if (frame_status & RS_FRAMERR)
666 dev->stats.rx_frame_errors++;
667 if (frame_status & RS_FCSERR)
668 dev->stats.rx_crc_errors++;
670 unsigned int frame_length = mf->rcvcnt + ((frame_status & 0x0F) << 8 );
672 skb = dev_alloc_skb(frame_length + 2);
674 dev->stats.rx_dropped++;
678 memcpy(skb_put(skb, frame_length), mf->data, frame_length);
680 skb->protocol = eth_type_trans(skb, dev);
682 dev->stats.rx_packets++;
683 dev->stats.rx_bytes += frame_length;
688 * The PSC has passed us a DMA interrupt event.
691 static irqreturn_t mace_dma_intr(int irq, void *dev_id)
693 struct net_device *dev = (struct net_device *) dev_id;
694 struct mace_data *mp = netdev_priv(dev);
699 /* Not sure what this does */
701 while ((baka = psc_read_long(PSC_MYSTERY)) != psc_read_long(PSC_MYSTERY));
702 if (!(baka & 0x60000000)) return IRQ_NONE;
705 * Process the read queue
708 status = psc_read_word(PSC_ENETRD_CTL);
710 if (status & 0x2000) {
711 mace_rxdma_reset(dev);
712 } else if (status & 0x0100) {
713 psc_write_word(PSC_ENETRD_CMD + mp->rx_slot, 0x1100);
715 left = psc_read_long(PSC_ENETRD_LEN + mp->rx_slot);
716 head = N_RX_RING - left;
718 /* Loop through the ring buffer and process new packages */
720 while (mp->rx_tail < head) {
721 mace_dma_rx_frame(dev, (struct mace_frame*) (mp->rx_ring
722 + (mp->rx_tail * MACE_BUFF_SIZE)));
726 /* If we're out of buffers in this ring then switch to */
727 /* the other set, otherwise just reactivate this one. */
730 mace_load_rxdma_base(dev, mp->rx_slot);
733 psc_write_word(PSC_ENETRD_CMD + mp->rx_slot, 0x9800);
738 * Process the write queue
741 status = psc_read_word(PSC_ENETWR_CTL);
743 if (status & 0x2000) {
744 mace_txdma_reset(dev);
745 } else if (status & 0x0100) {
746 psc_write_word(PSC_ENETWR_CMD + mp->tx_sloti, 0x0100);
747 mp->tx_sloti ^= 0x10;
753 MODULE_LICENSE("GPL");
754 MODULE_DESCRIPTION("Macintosh MACE ethernet driver");
756 static int __devexit mac_mace_device_remove (struct platform_device *pdev)
758 struct net_device *dev = platform_get_drvdata(pdev);
759 struct mace_data *mp = netdev_priv(dev);
761 unregister_netdev(dev);
763 free_irq(dev->irq, dev);
764 free_irq(IRQ_MAC_MACE_DMA, dev);
766 dma_free_coherent(mp->device, N_RX_RING * MACE_BUFF_SIZE,
767 mp->rx_ring, mp->rx_ring_phys);
768 dma_free_coherent(mp->device, N_TX_RING * MACE_BUFF_SIZE,
769 mp->tx_ring, mp->tx_ring_phys);
776 static struct platform_driver mac_mace_driver = {
778 .remove = __devexit_p(mac_mace_device_remove),
780 .name = mac_mace_string,
784 static int __init mac_mace_init_module(void)
791 if ((err = platform_driver_register(&mac_mace_driver))) {
792 printk(KERN_ERR "Driver registration failed\n");
796 mac_mace_device = platform_device_alloc(mac_mace_string, 0);
797 if (!mac_mace_device)
800 if (platform_device_add(mac_mace_device)) {
801 platform_device_put(mac_mace_device);
802 mac_mace_device = NULL;
808 platform_driver_unregister(&mac_mace_driver);
813 static void __exit mac_mace_cleanup_module(void)
815 platform_driver_unregister(&mac_mace_driver);
817 if (mac_mace_device) {
818 platform_device_unregister(mac_mace_device);
819 mac_mace_device = NULL;
823 module_init(mac_mace_init_module);
824 module_exit(mac_mace_cleanup_module);