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.
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";
43 #define N_TX_BUFF_ORDER 0
44 #define N_TX_RING (1 << N_TX_BUFF_ORDER)
45 #define N_RX_BUFF_ORDER 3
46 #define N_RX_RING (1 << N_RX_BUFF_ORDER)
50 #define MACE_BUFF_SIZE 0x800
52 /* Chip rev needs workaround on HW & multicast addr change */
53 #define BROKEN_ADDRCHG_REV 0x0941
55 /* The MACE is simply wired down on a Mac68K box */
57 #define MACE_BASE (void *)(0x50F1C000)
58 #define MACE_PROM (void *)(0x50F08001)
61 volatile struct mace *mace;
62 unsigned char *tx_ring;
63 dma_addr_t tx_ring_phys;
64 unsigned char *rx_ring;
65 dma_addr_t rx_ring_phys;
68 int tx_slot, tx_sloti, tx_count;
70 struct device *device;
85 /* And frame continues.. */
88 #define PRIV_BYTES sizeof(struct mace_data)
90 static int mace_open(struct net_device *dev);
91 static int mace_close(struct net_device *dev);
92 static int mace_xmit_start(struct sk_buff *skb, struct net_device *dev);
93 static void mace_set_multicast(struct net_device *dev);
94 static int mace_set_address(struct net_device *dev, void *addr);
95 static void mace_reset(struct net_device *dev);
96 static irqreturn_t mace_interrupt(int irq, void *dev_id);
97 static irqreturn_t mace_dma_intr(int irq, void *dev_id);
98 static void mace_tx_timeout(struct net_device *dev);
99 static void __mace_set_address(struct net_device *dev, void *addr);
102 * Load a receive DMA channel with a base address and ring length
105 static void mace_load_rxdma_base(struct net_device *dev, int set)
107 struct mace_data *mp = netdev_priv(dev);
109 psc_write_word(PSC_ENETRD_CMD + set, 0x0100);
110 psc_write_long(PSC_ENETRD_ADDR + set, (u32) mp->rx_ring_phys);
111 psc_write_long(PSC_ENETRD_LEN + set, N_RX_RING);
112 psc_write_word(PSC_ENETRD_CMD + set, 0x9800);
117 * Reset the receive DMA subsystem
120 static void mace_rxdma_reset(struct net_device *dev)
122 struct mace_data *mp = netdev_priv(dev);
123 volatile struct mace *mace = mp->mace;
124 u8 maccc = mace->maccc;
126 mace->maccc = maccc & ~ENRCV;
128 psc_write_word(PSC_ENETRD_CTL, 0x8800);
129 mace_load_rxdma_base(dev, 0x00);
130 psc_write_word(PSC_ENETRD_CTL, 0x0400);
132 psc_write_word(PSC_ENETRD_CTL, 0x8800);
133 mace_load_rxdma_base(dev, 0x10);
134 psc_write_word(PSC_ENETRD_CTL, 0x0400);
139 psc_write_word(PSC_ENETRD_CMD + PSC_SET0, 0x9800);
140 psc_write_word(PSC_ENETRD_CMD + PSC_SET1, 0x9800);
144 * Reset the transmit DMA subsystem
147 static void mace_txdma_reset(struct net_device *dev)
149 struct mace_data *mp = netdev_priv(dev);
150 volatile struct mace *mace = mp->mace;
153 psc_write_word(PSC_ENETWR_CTL, 0x8800);
156 mace->maccc = maccc & ~ENXMT;
158 mp->tx_slot = mp->tx_sloti = 0;
159 mp->tx_count = N_TX_RING;
161 psc_write_word(PSC_ENETWR_CTL, 0x0400);
169 static void mace_dma_off(struct net_device *dev)
171 psc_write_word(PSC_ENETRD_CTL, 0x8800);
172 psc_write_word(PSC_ENETRD_CTL, 0x1000);
173 psc_write_word(PSC_ENETRD_CMD + PSC_SET0, 0x1100);
174 psc_write_word(PSC_ENETRD_CMD + PSC_SET1, 0x1100);
176 psc_write_word(PSC_ENETWR_CTL, 0x8800);
177 psc_write_word(PSC_ENETWR_CTL, 0x1000);
178 psc_write_word(PSC_ENETWR_CMD + PSC_SET0, 0x1100);
179 psc_write_word(PSC_ENETWR_CMD + PSC_SET1, 0x1100);
182 static const struct net_device_ops mace_netdev_ops = {
183 .ndo_open = mace_open,
184 .ndo_stop = mace_close,
185 .ndo_start_xmit = mace_xmit_start,
186 .ndo_tx_timeout = mace_tx_timeout,
187 .ndo_set_multicast_list = mace_set_multicast,
188 .ndo_set_mac_address = mace_set_address,
189 .ndo_change_mtu = eth_change_mtu,
190 .ndo_validate_addr = eth_validate_addr,
194 * Not really much of a probe. The hardware table tells us if this
195 * model of Macintrash has a MACE (AV macintoshes)
198 static int __devinit mace_probe(struct platform_device *pdev)
201 struct mace_data *mp;
203 struct net_device *dev;
204 unsigned char checksum = 0;
205 static int found = 0;
208 if (found || macintosh_config->ether_type != MAC_ETHER_MACE)
211 found = 1; /* prevent 'finding' one on every device probe */
213 dev = alloc_etherdev(PRIV_BYTES);
217 mp = netdev_priv(dev);
219 mp->device = &pdev->dev;
220 SET_NETDEV_DEV(dev, &pdev->dev);
222 dev->base_addr = (u32)MACE_BASE;
223 mp->mace = (volatile struct mace *) MACE_BASE;
225 dev->irq = IRQ_MAC_MACE;
226 mp->dma_intr = IRQ_MAC_MACE_DMA;
228 mp->chipid = mp->mace->chipid_hi << 8 | mp->mace->chipid_lo;
231 * The PROM contains 8 bytes which total 0xFF when XOR'd
232 * together. Due to the usual peculiar apple brain damage
233 * the bytes are spaced out in a strange boundary and the
237 addr = (void *)MACE_PROM;
239 for (j = 0; j < 6; ++j) {
240 u8 v = bitrev8(addr[j<<4]);
242 dev->dev_addr[j] = v;
245 checksum ^= bitrev8(addr[j<<4]);
248 if (checksum != 0xFF) {
253 dev->netdev_ops = &mace_netdev_ops;
254 dev->watchdog_timeo = TX_TIMEOUT;
256 printk(KERN_INFO "%s: 68K MACE, hardware address %pM\n",
257 dev->name, dev->dev_addr);
259 err = register_netdev(dev);
271 static void mace_reset(struct net_device *dev)
273 struct mace_data *mp = netdev_priv(dev);
274 volatile struct mace *mb = mp->mace;
277 /* soft-reset the chip */
281 if (mb->biucc & SWRST) {
288 printk(KERN_ERR "macmace: cannot reset chip!\n");
292 mb->maccc = 0; /* turn off tx, rx */
293 mb->imr = 0xFF; /* disable all intrs for now */
296 mb->biucc = XMTSP_64;
298 mb->fifocc = XMTFW_8 | RCVFW_64 | XMTFWU | RCVFWU;
300 mb->xmtfc = AUTO_PAD_XMIT; /* auto-pad short frames */
303 /* load up the hardware address */
304 __mace_set_address(dev, dev->dev_addr);
306 /* clear the multicast filter */
307 if (mp->chipid == BROKEN_ADDRCHG_REV)
310 mb->iac = ADDRCHG | LOGADDR;
311 while ((mb->iac & ADDRCHG) != 0)
314 for (i = 0; i < 8; ++i)
317 /* done changing address */
318 if (mp->chipid != BROKEN_ADDRCHG_REV)
321 mb->plscc = PORTSEL_AUI;
325 * Load the address on a mace controller.
328 static void __mace_set_address(struct net_device *dev, void *addr)
330 struct mace_data *mp = netdev_priv(dev);
331 volatile struct mace *mb = mp->mace;
332 unsigned char *p = addr;
335 /* load up the hardware address */
336 if (mp->chipid == BROKEN_ADDRCHG_REV)
339 mb->iac = ADDRCHG | PHYADDR;
340 while ((mb->iac & ADDRCHG) != 0)
343 for (i = 0; i < 6; ++i)
344 mb->padr = dev->dev_addr[i] = p[i];
345 if (mp->chipid != BROKEN_ADDRCHG_REV)
349 static int mace_set_address(struct net_device *dev, void *addr)
351 struct mace_data *mp = netdev_priv(dev);
352 volatile struct mace *mb = mp->mace;
356 local_irq_save(flags);
360 __mace_set_address(dev, addr);
364 local_irq_restore(flags);
370 * Open the Macintosh MACE. Most of this is playing with the DMA
371 * engine. The ethernet chip is quite friendly.
374 static int mace_open(struct net_device *dev)
376 struct mace_data *mp = netdev_priv(dev);
377 volatile struct mace *mb = mp->mace;
382 if (request_irq(dev->irq, mace_interrupt, 0, dev->name, dev)) {
383 printk(KERN_ERR "%s: can't get irq %d\n", dev->name, dev->irq);
386 if (request_irq(mp->dma_intr, mace_dma_intr, 0, dev->name, dev)) {
387 printk(KERN_ERR "%s: can't get irq %d\n", dev->name, mp->dma_intr);
388 free_irq(dev->irq, dev);
392 /* Allocate the DMA ring buffers */
394 mp->tx_ring = dma_alloc_coherent(mp->device,
395 N_TX_RING * MACE_BUFF_SIZE,
396 &mp->tx_ring_phys, GFP_KERNEL);
397 if (mp->tx_ring == NULL) {
398 printk(KERN_ERR "%s: unable to allocate DMA tx buffers\n", dev->name);
402 mp->rx_ring = dma_alloc_coherent(mp->device,
403 N_RX_RING * MACE_BUFF_SIZE,
404 &mp->rx_ring_phys, GFP_KERNEL);
405 if (mp->rx_ring == NULL) {
406 printk(KERN_ERR "%s: unable to allocate DMA rx buffers\n", dev->name);
412 /* Not sure what these do */
414 psc_write_word(PSC_ENETWR_CTL, 0x9000);
415 psc_write_word(PSC_ENETRD_CTL, 0x9000);
416 psc_write_word(PSC_ENETWR_CTL, 0x0400);
417 psc_write_word(PSC_ENETRD_CTL, 0x0400);
419 mace_rxdma_reset(dev);
420 mace_txdma_reset(dev);
423 mb->maccc = ENXMT | ENRCV;
424 /* enable all interrupts except receive interrupts */
429 dma_free_coherent(mp->device, N_TX_RING * MACE_BUFF_SIZE,
430 mp->tx_ring, mp->tx_ring_phys);
432 free_irq(dev->irq, dev);
433 free_irq(mp->dma_intr, dev);
438 * Shut down the mace and its interrupt channel
441 static int mace_close(struct net_device *dev)
443 struct mace_data *mp = netdev_priv(dev);
444 volatile struct mace *mb = mp->mace;
446 mb->maccc = 0; /* disable rx and tx */
447 mb->imr = 0xFF; /* disable all irqs */
448 mace_dma_off(dev); /* disable rx and tx dma */
457 static int mace_xmit_start(struct sk_buff *skb, struct net_device *dev)
459 struct mace_data *mp = netdev_priv(dev);
462 /* Stop the queue since there's only the one buffer */
464 local_irq_save(flags);
465 netif_stop_queue(dev);
467 printk(KERN_ERR "macmace: tx queue running but no free buffers.\n");
468 local_irq_restore(flags);
469 return NETDEV_TX_BUSY;
472 local_irq_restore(flags);
474 dev->stats.tx_packets++;
475 dev->stats.tx_bytes += skb->len;
477 /* We need to copy into our xmit buffer to take care of alignment and caching issues */
478 skb_copy_from_linear_data(skb, mp->tx_ring, skb->len);
480 /* load the Tx DMA and fire it off */
482 psc_write_long(PSC_ENETWR_ADDR + mp->tx_slot, (u32) mp->tx_ring_phys);
483 psc_write_long(PSC_ENETWR_LEN + mp->tx_slot, skb->len);
484 psc_write_word(PSC_ENETWR_CMD + mp->tx_slot, 0x9800);
490 dev->trans_start = jiffies;
494 static void mace_set_multicast(struct net_device *dev)
496 struct mace_data *mp = netdev_priv(dev);
497 volatile struct mace *mb = mp->mace;
503 local_irq_save(flags);
507 if (dev->flags & IFF_PROMISC) {
510 unsigned char multicast_filter[8];
511 struct dev_mc_list *dmi;
513 if (dev->flags & IFF_ALLMULTI) {
514 for (i = 0; i < 8; i++) {
515 multicast_filter[i] = 0xFF;
518 for (i = 0; i < 8; i++)
519 multicast_filter[i] = 0;
520 netdev_for_each_mc_addr(dmi, dev) {
521 crc = ether_crc_le(6, dmi->dmi_addr);
522 /* bit number in multicast_filter */
524 multicast_filter[i >> 3] |= 1 << (i & 7);
528 if (mp->chipid == BROKEN_ADDRCHG_REV)
531 mb->iac = ADDRCHG | LOGADDR;
532 while ((mb->iac & ADDRCHG) != 0)
535 for (i = 0; i < 8; ++i)
536 mb->ladrf = multicast_filter[i];
537 if (mp->chipid != BROKEN_ADDRCHG_REV)
542 local_irq_restore(flags);
545 static void mace_handle_misc_intrs(struct net_device *dev, int intr)
547 struct mace_data *mp = netdev_priv(dev);
548 volatile struct mace *mb = mp->mace;
549 static int mace_babbles, mace_jabbers;
552 dev->stats.rx_missed_errors += 256;
553 dev->stats.rx_missed_errors += mb->mpc; /* reading clears it */
555 dev->stats.rx_length_errors += 256;
556 dev->stats.rx_length_errors += mb->rntpc; /* reading clears it */
558 ++dev->stats.tx_heartbeat_errors;
560 if (mace_babbles++ < 4)
561 printk(KERN_DEBUG "macmace: babbling transmitter\n");
563 if (mace_jabbers++ < 4)
564 printk(KERN_DEBUG "macmace: jabbering transceiver\n");
567 static irqreturn_t mace_interrupt(int irq, void *dev_id)
569 struct net_device *dev = (struct net_device *) dev_id;
570 struct mace_data *mp = netdev_priv(dev);
571 volatile struct mace *mb = mp->mace;
575 /* don't want the dma interrupt handler to fire */
576 local_irq_save(flags);
578 intr = mb->ir; /* read interrupt register */
579 mace_handle_misc_intrs(dev, intr);
583 if ((fs & XMTSV) == 0) {
584 printk(KERN_ERR "macmace: xmtfs not valid! (fs=%x)\n", fs);
587 * XXX mace likes to hang the machine after a xmtfs error.
588 * This is hard to reproduce, reseting *may* help
591 /* dma should have finished */
593 printk(KERN_DEBUG "macmace: tx ring ran out? (fs=%x)\n", fs);
596 if (fs & (UFLO|LCOL|LCAR|RTRY)) {
597 ++dev->stats.tx_errors;
599 ++dev->stats.tx_carrier_errors;
600 else if (fs & (UFLO|LCOL|RTRY)) {
601 ++dev->stats.tx_aborted_errors;
602 if (mb->xmtfs & UFLO) {
603 printk(KERN_ERR "%s: DMA underrun.\n", dev->name);
604 dev->stats.tx_fifo_errors++;
605 mace_txdma_reset(dev);
612 netif_wake_queue(dev);
614 local_irq_restore(flags);
619 static void mace_tx_timeout(struct net_device *dev)
621 struct mace_data *mp = netdev_priv(dev);
622 volatile struct mace *mb = mp->mace;
625 local_irq_save(flags);
627 /* turn off both tx and rx and reset the chip */
629 printk(KERN_ERR "macmace: transmit timeout - resetting\n");
630 mace_txdma_reset(dev);
634 mace_rxdma_reset(dev);
636 mp->tx_count = N_TX_RING;
637 netif_wake_queue(dev);
640 mb->maccc = ENXMT | ENRCV;
641 /* enable all interrupts except receive interrupts */
644 local_irq_restore(flags);
648 * Handle a newly arrived frame
651 static void mace_dma_rx_frame(struct net_device *dev, struct mace_frame *mf)
654 unsigned int frame_status = mf->rcvsts;
656 if (frame_status & (RS_OFLO | RS_CLSN | RS_FRAMERR | RS_FCSERR)) {
657 dev->stats.rx_errors++;
658 if (frame_status & RS_OFLO) {
659 printk(KERN_DEBUG "%s: fifo overflow.\n", dev->name);
660 dev->stats.rx_fifo_errors++;
662 if (frame_status & RS_CLSN)
663 dev->stats.collisions++;
664 if (frame_status & RS_FRAMERR)
665 dev->stats.rx_frame_errors++;
666 if (frame_status & RS_FCSERR)
667 dev->stats.rx_crc_errors++;
669 unsigned int frame_length = mf->rcvcnt + ((frame_status & 0x0F) << 8 );
671 skb = dev_alloc_skb(frame_length + 2);
673 dev->stats.rx_dropped++;
677 memcpy(skb_put(skb, frame_length), mf->data, frame_length);
679 skb->protocol = eth_type_trans(skb, dev);
681 dev->stats.rx_packets++;
682 dev->stats.rx_bytes += frame_length;
687 * The PSC has passed us a DMA interrupt event.
690 static irqreturn_t mace_dma_intr(int irq, void *dev_id)
692 struct net_device *dev = (struct net_device *) dev_id;
693 struct mace_data *mp = netdev_priv(dev);
698 /* Not sure what this does */
700 while ((baka = psc_read_long(PSC_MYSTERY)) != psc_read_long(PSC_MYSTERY));
701 if (!(baka & 0x60000000)) return IRQ_NONE;
704 * Process the read queue
707 status = psc_read_word(PSC_ENETRD_CTL);
709 if (status & 0x2000) {
710 mace_rxdma_reset(dev);
711 } else if (status & 0x0100) {
712 psc_write_word(PSC_ENETRD_CMD + mp->rx_slot, 0x1100);
714 left = psc_read_long(PSC_ENETRD_LEN + mp->rx_slot);
715 head = N_RX_RING - left;
717 /* Loop through the ring buffer and process new packages */
719 while (mp->rx_tail < head) {
720 mace_dma_rx_frame(dev, (struct mace_frame*) (mp->rx_ring
721 + (mp->rx_tail * MACE_BUFF_SIZE)));
725 /* If we're out of buffers in this ring then switch to */
726 /* the other set, otherwise just reactivate this one. */
729 mace_load_rxdma_base(dev, mp->rx_slot);
732 psc_write_word(PSC_ENETRD_CMD + mp->rx_slot, 0x9800);
737 * Process the write queue
740 status = psc_read_word(PSC_ENETWR_CTL);
742 if (status & 0x2000) {
743 mace_txdma_reset(dev);
744 } else if (status & 0x0100) {
745 psc_write_word(PSC_ENETWR_CMD + mp->tx_sloti, 0x0100);
746 mp->tx_sloti ^= 0x10;
752 MODULE_LICENSE("GPL");
753 MODULE_DESCRIPTION("Macintosh MACE ethernet driver");
754 MODULE_ALIAS("platform:macmace");
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,
781 .owner = THIS_MODULE,
785 static int __init mac_mace_init_module(void)
790 return platform_driver_register(&mac_mace_driver);
793 static void __exit mac_mace_cleanup_module(void)
795 platform_driver_unregister(&mac_mace_driver);
798 module_init(mac_mace_init_module);
799 module_exit(mac_mace_cleanup_module);