1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Driver for the Macintosh 68K onboard MACE controller with PSC
4 * driven DMA. The MACE driver code is derived from mace.c. The
5 * Mac68k theory of operation is courtesy of the MacBSD wizards.
7 * Copyright (C) 1996 Paul Mackerras.
8 * Copyright (C) 1998 Alan Cox <alan@lxorguk.ukuu.org.uk>
10 * Modified heavily by Joshua M. Thompson based on Dave Huang's NetBSD driver
12 * Copyright (C) 2007 Finn Thain
14 * Converted to DMA API, converted to unified driver model,
15 * sync'd some routines with mace.c and fixed various bugs.
19 #include <linux/kernel.h>
20 #include <linux/module.h>
21 #include <linux/netdevice.h>
22 #include <linux/etherdevice.h>
23 #include <linux/delay.h>
24 #include <linux/string.h>
25 #include <linux/crc32.h>
26 #include <linux/bitrev.h>
27 #include <linux/dma-mapping.h>
28 #include <linux/platform_device.h>
29 #include <linux/gfp.h>
30 #include <linux/interrupt.h>
32 #include <asm/macints.h>
33 #include <asm/mac_psc.h>
37 static char mac_mace_string
[] = "macmace";
39 #define N_TX_BUFF_ORDER 0
40 #define N_TX_RING (1 << N_TX_BUFF_ORDER)
41 #define N_RX_BUFF_ORDER 3
42 #define N_RX_RING (1 << N_RX_BUFF_ORDER)
46 #define MACE_BUFF_SIZE 0x800
48 /* Chip rev needs workaround on HW & multicast addr change */
49 #define BROKEN_ADDRCHG_REV 0x0941
51 /* The MACE is simply wired down on a Mac68K box */
53 #define MACE_BASE (void *)(0x50F1C000)
54 #define MACE_PROM (void *)(0x50F08001)
57 volatile struct mace
*mace
;
58 unsigned char *tx_ring
;
59 dma_addr_t tx_ring_phys
;
60 unsigned char *rx_ring
;
61 dma_addr_t rx_ring_phys
;
64 int tx_slot
, tx_sloti
, tx_count
;
66 struct device
*device
;
81 /* And frame continues.. */
84 #define PRIV_BYTES sizeof(struct mace_data)
86 static int mace_open(struct net_device
*dev
);
87 static int mace_close(struct net_device
*dev
);
88 static netdev_tx_t
mace_xmit_start(struct sk_buff
*skb
, struct net_device
*dev
);
89 static void mace_set_multicast(struct net_device
*dev
);
90 static int mace_set_address(struct net_device
*dev
, void *addr
);
91 static void mace_reset(struct net_device
*dev
);
92 static irqreturn_t
mace_interrupt(int irq
, void *dev_id
);
93 static irqreturn_t
mace_dma_intr(int irq
, void *dev_id
);
94 static void mace_tx_timeout(struct net_device
*dev
, unsigned int txqueue
);
95 static void __mace_set_address(struct net_device
*dev
, void *addr
);
98 * Load a receive DMA channel with a base address and ring length
101 static void mace_load_rxdma_base(struct net_device
*dev
, int set
)
103 struct mace_data
*mp
= netdev_priv(dev
);
105 psc_write_word(PSC_ENETRD_CMD
+ set
, 0x0100);
106 psc_write_long(PSC_ENETRD_ADDR
+ set
, (u32
) mp
->rx_ring_phys
);
107 psc_write_long(PSC_ENETRD_LEN
+ set
, N_RX_RING
);
108 psc_write_word(PSC_ENETRD_CMD
+ set
, 0x9800);
113 * Reset the receive DMA subsystem
116 static void mace_rxdma_reset(struct net_device
*dev
)
118 struct mace_data
*mp
= netdev_priv(dev
);
119 volatile struct mace
*mace
= mp
->mace
;
120 u8 maccc
= mace
->maccc
;
122 mace
->maccc
= maccc
& ~ENRCV
;
124 psc_write_word(PSC_ENETRD_CTL
, 0x8800);
125 mace_load_rxdma_base(dev
, 0x00);
126 psc_write_word(PSC_ENETRD_CTL
, 0x0400);
128 psc_write_word(PSC_ENETRD_CTL
, 0x8800);
129 mace_load_rxdma_base(dev
, 0x10);
130 psc_write_word(PSC_ENETRD_CTL
, 0x0400);
135 psc_write_word(PSC_ENETRD_CMD
+ PSC_SET0
, 0x9800);
136 psc_write_word(PSC_ENETRD_CMD
+ PSC_SET1
, 0x9800);
140 * Reset the transmit DMA subsystem
143 static void mace_txdma_reset(struct net_device
*dev
)
145 struct mace_data
*mp
= netdev_priv(dev
);
146 volatile struct mace
*mace
= mp
->mace
;
149 psc_write_word(PSC_ENETWR_CTL
, 0x8800);
152 mace
->maccc
= maccc
& ~ENXMT
;
154 mp
->tx_slot
= mp
->tx_sloti
= 0;
155 mp
->tx_count
= N_TX_RING
;
157 psc_write_word(PSC_ENETWR_CTL
, 0x0400);
165 static void mace_dma_off(struct net_device
*dev
)
167 psc_write_word(PSC_ENETRD_CTL
, 0x8800);
168 psc_write_word(PSC_ENETRD_CTL
, 0x1000);
169 psc_write_word(PSC_ENETRD_CMD
+ PSC_SET0
, 0x1100);
170 psc_write_word(PSC_ENETRD_CMD
+ PSC_SET1
, 0x1100);
172 psc_write_word(PSC_ENETWR_CTL
, 0x8800);
173 psc_write_word(PSC_ENETWR_CTL
, 0x1000);
174 psc_write_word(PSC_ENETWR_CMD
+ PSC_SET0
, 0x1100);
175 psc_write_word(PSC_ENETWR_CMD
+ PSC_SET1
, 0x1100);
178 static const struct net_device_ops mace_netdev_ops
= {
179 .ndo_open
= mace_open
,
180 .ndo_stop
= mace_close
,
181 .ndo_start_xmit
= mace_xmit_start
,
182 .ndo_tx_timeout
= mace_tx_timeout
,
183 .ndo_set_rx_mode
= mace_set_multicast
,
184 .ndo_set_mac_address
= mace_set_address
,
185 .ndo_validate_addr
= eth_validate_addr
,
189 * Not really much of a probe. The hardware table tells us if this
190 * model of Macintrash has a MACE (AV macintoshes)
193 static int mace_probe(struct platform_device
*pdev
)
196 struct mace_data
*mp
;
198 struct net_device
*dev
;
199 unsigned char checksum
= 0;
202 dev
= alloc_etherdev(PRIV_BYTES
);
206 mp
= netdev_priv(dev
);
208 mp
->device
= &pdev
->dev
;
209 platform_set_drvdata(pdev
, dev
);
210 SET_NETDEV_DEV(dev
, &pdev
->dev
);
212 dev
->base_addr
= (u32
)MACE_BASE
;
213 mp
->mace
= MACE_BASE
;
215 dev
->irq
= IRQ_MAC_MACE
;
216 mp
->dma_intr
= IRQ_MAC_MACE_DMA
;
218 mp
->chipid
= mp
->mace
->chipid_hi
<< 8 | mp
->mace
->chipid_lo
;
221 * The PROM contains 8 bytes which total 0xFF when XOR'd
222 * together. Due to the usual peculiar apple brain damage
223 * the bytes are spaced out in a strange boundary and the
229 for (j
= 0; j
< 6; ++j
) {
230 u8 v
= bitrev8(addr
[j
<<4]);
232 dev
->dev_addr
[j
] = v
;
235 checksum
^= bitrev8(addr
[j
<<4]);
238 if (checksum
!= 0xFF) {
243 dev
->netdev_ops
= &mace_netdev_ops
;
244 dev
->watchdog_timeo
= TX_TIMEOUT
;
246 pr_info("Onboard MACE, hardware address %pM, chip revision 0x%04X\n",
247 dev
->dev_addr
, mp
->chipid
);
249 err
= register_netdev(dev
);
261 static void mace_reset(struct net_device
*dev
)
263 struct mace_data
*mp
= netdev_priv(dev
);
264 volatile struct mace
*mb
= mp
->mace
;
267 /* soft-reset the chip */
271 if (mb
->biucc
& SWRST
) {
278 printk(KERN_ERR
"macmace: cannot reset chip!\n");
282 mb
->maccc
= 0; /* turn off tx, rx */
283 mb
->imr
= 0xFF; /* disable all intrs for now */
286 mb
->biucc
= XMTSP_64
;
288 mb
->fifocc
= XMTFW_8
| RCVFW_64
| XMTFWU
| RCVFWU
;
290 mb
->xmtfc
= AUTO_PAD_XMIT
; /* auto-pad short frames */
293 /* load up the hardware address */
294 __mace_set_address(dev
, dev
->dev_addr
);
296 /* clear the multicast filter */
297 if (mp
->chipid
== BROKEN_ADDRCHG_REV
)
300 mb
->iac
= ADDRCHG
| LOGADDR
;
301 while ((mb
->iac
& ADDRCHG
) != 0)
304 for (i
= 0; i
< 8; ++i
)
307 /* done changing address */
308 if (mp
->chipid
!= BROKEN_ADDRCHG_REV
)
311 mb
->plscc
= PORTSEL_AUI
;
315 * Load the address on a mace controller.
318 static void __mace_set_address(struct net_device
*dev
, void *addr
)
320 struct mace_data
*mp
= netdev_priv(dev
);
321 volatile struct mace
*mb
= mp
->mace
;
322 unsigned char *p
= addr
;
325 /* load up the hardware address */
326 if (mp
->chipid
== BROKEN_ADDRCHG_REV
)
329 mb
->iac
= ADDRCHG
| PHYADDR
;
330 while ((mb
->iac
& ADDRCHG
) != 0)
333 for (i
= 0; i
< 6; ++i
)
334 mb
->padr
= dev
->dev_addr
[i
] = p
[i
];
335 if (mp
->chipid
!= BROKEN_ADDRCHG_REV
)
339 static int mace_set_address(struct net_device
*dev
, void *addr
)
341 struct mace_data
*mp
= netdev_priv(dev
);
342 volatile struct mace
*mb
= mp
->mace
;
346 local_irq_save(flags
);
350 __mace_set_address(dev
, addr
);
354 local_irq_restore(flags
);
360 * Open the Macintosh MACE. Most of this is playing with the DMA
361 * engine. The ethernet chip is quite friendly.
364 static int mace_open(struct net_device
*dev
)
366 struct mace_data
*mp
= netdev_priv(dev
);
367 volatile struct mace
*mb
= mp
->mace
;
372 if (request_irq(dev
->irq
, mace_interrupt
, 0, dev
->name
, dev
)) {
373 printk(KERN_ERR
"%s: can't get irq %d\n", dev
->name
, dev
->irq
);
376 if (request_irq(mp
->dma_intr
, mace_dma_intr
, 0, dev
->name
, dev
)) {
377 printk(KERN_ERR
"%s: can't get irq %d\n", dev
->name
, mp
->dma_intr
);
378 free_irq(dev
->irq
, dev
);
382 /* Allocate the DMA ring buffers */
384 mp
->tx_ring
= dma_alloc_coherent(mp
->device
,
385 N_TX_RING
* MACE_BUFF_SIZE
,
386 &mp
->tx_ring_phys
, GFP_KERNEL
);
387 if (mp
->tx_ring
== NULL
)
390 mp
->rx_ring
= dma_alloc_coherent(mp
->device
,
391 N_RX_RING
* MACE_BUFF_SIZE
,
392 &mp
->rx_ring_phys
, GFP_KERNEL
);
393 if (mp
->rx_ring
== NULL
)
398 /* Not sure what these do */
400 psc_write_word(PSC_ENETWR_CTL
, 0x9000);
401 psc_write_word(PSC_ENETRD_CTL
, 0x9000);
402 psc_write_word(PSC_ENETWR_CTL
, 0x0400);
403 psc_write_word(PSC_ENETRD_CTL
, 0x0400);
405 mace_rxdma_reset(dev
);
406 mace_txdma_reset(dev
);
409 mb
->maccc
= ENXMT
| ENRCV
;
410 /* enable all interrupts except receive interrupts */
415 dma_free_coherent(mp
->device
, N_TX_RING
* MACE_BUFF_SIZE
,
416 mp
->tx_ring
, mp
->tx_ring_phys
);
418 free_irq(dev
->irq
, dev
);
419 free_irq(mp
->dma_intr
, dev
);
424 * Shut down the mace and its interrupt channel
427 static int mace_close(struct net_device
*dev
)
429 struct mace_data
*mp
= netdev_priv(dev
);
430 volatile struct mace
*mb
= mp
->mace
;
432 mb
->maccc
= 0; /* disable rx and tx */
433 mb
->imr
= 0xFF; /* disable all irqs */
434 mace_dma_off(dev
); /* disable rx and tx dma */
443 static netdev_tx_t
mace_xmit_start(struct sk_buff
*skb
, struct net_device
*dev
)
445 struct mace_data
*mp
= netdev_priv(dev
);
448 /* Stop the queue since there's only the one buffer */
450 local_irq_save(flags
);
451 netif_stop_queue(dev
);
453 printk(KERN_ERR
"macmace: tx queue running but no free buffers.\n");
454 local_irq_restore(flags
);
455 return NETDEV_TX_BUSY
;
458 local_irq_restore(flags
);
460 dev
->stats
.tx_packets
++;
461 dev
->stats
.tx_bytes
+= skb
->len
;
463 /* We need to copy into our xmit buffer to take care of alignment and caching issues */
464 skb_copy_from_linear_data(skb
, mp
->tx_ring
, skb
->len
);
466 /* load the Tx DMA and fire it off */
468 psc_write_long(PSC_ENETWR_ADDR
+ mp
->tx_slot
, (u32
) mp
->tx_ring_phys
);
469 psc_write_long(PSC_ENETWR_LEN
+ mp
->tx_slot
, skb
->len
);
470 psc_write_word(PSC_ENETWR_CMD
+ mp
->tx_slot
, 0x9800);
479 static void mace_set_multicast(struct net_device
*dev
)
481 struct mace_data
*mp
= netdev_priv(dev
);
482 volatile struct mace
*mb
= mp
->mace
;
488 local_irq_save(flags
);
492 if (dev
->flags
& IFF_PROMISC
) {
495 unsigned char multicast_filter
[8];
496 struct netdev_hw_addr
*ha
;
498 if (dev
->flags
& IFF_ALLMULTI
) {
499 for (i
= 0; i
< 8; i
++) {
500 multicast_filter
[i
] = 0xFF;
503 for (i
= 0; i
< 8; i
++)
504 multicast_filter
[i
] = 0;
505 netdev_for_each_mc_addr(ha
, dev
) {
506 crc
= ether_crc_le(6, ha
->addr
);
507 /* bit number in multicast_filter */
509 multicast_filter
[i
>> 3] |= 1 << (i
& 7);
513 if (mp
->chipid
== BROKEN_ADDRCHG_REV
)
516 mb
->iac
= ADDRCHG
| LOGADDR
;
517 while ((mb
->iac
& ADDRCHG
) != 0)
520 for (i
= 0; i
< 8; ++i
)
521 mb
->ladrf
= multicast_filter
[i
];
522 if (mp
->chipid
!= BROKEN_ADDRCHG_REV
)
527 local_irq_restore(flags
);
530 static void mace_handle_misc_intrs(struct net_device
*dev
, int intr
)
532 struct mace_data
*mp
= netdev_priv(dev
);
533 volatile struct mace
*mb
= mp
->mace
;
534 static int mace_babbles
, mace_jabbers
;
537 dev
->stats
.rx_missed_errors
+= 256;
538 dev
->stats
.rx_missed_errors
+= mb
->mpc
; /* reading clears it */
540 dev
->stats
.rx_length_errors
+= 256;
541 dev
->stats
.rx_length_errors
+= mb
->rntpc
; /* reading clears it */
543 ++dev
->stats
.tx_heartbeat_errors
;
545 if (mace_babbles
++ < 4)
546 printk(KERN_DEBUG
"macmace: babbling transmitter\n");
548 if (mace_jabbers
++ < 4)
549 printk(KERN_DEBUG
"macmace: jabbering transceiver\n");
552 static irqreturn_t
mace_interrupt(int irq
, void *dev_id
)
554 struct net_device
*dev
= (struct net_device
*) dev_id
;
555 struct mace_data
*mp
= netdev_priv(dev
);
556 volatile struct mace
*mb
= mp
->mace
;
560 /* don't want the dma interrupt handler to fire */
561 local_irq_save(flags
);
563 intr
= mb
->ir
; /* read interrupt register */
564 mace_handle_misc_intrs(dev
, intr
);
568 if ((fs
& XMTSV
) == 0) {
569 printk(KERN_ERR
"macmace: xmtfs not valid! (fs=%x)\n", fs
);
572 * XXX mace likes to hang the machine after a xmtfs error.
573 * This is hard to reproduce, resetting *may* help
576 /* dma should have finished */
578 printk(KERN_DEBUG
"macmace: tx ring ran out? (fs=%x)\n", fs
);
581 if (fs
& (UFLO
|LCOL
|LCAR
|RTRY
)) {
582 ++dev
->stats
.tx_errors
;
584 ++dev
->stats
.tx_carrier_errors
;
585 else if (fs
& (UFLO
|LCOL
|RTRY
)) {
586 ++dev
->stats
.tx_aborted_errors
;
587 if (mb
->xmtfs
& UFLO
) {
588 dev
->stats
.tx_fifo_errors
++;
589 mace_txdma_reset(dev
);
596 netif_wake_queue(dev
);
598 local_irq_restore(flags
);
603 static void mace_tx_timeout(struct net_device
*dev
, unsigned int txqueue
)
605 struct mace_data
*mp
= netdev_priv(dev
);
606 volatile struct mace
*mb
= mp
->mace
;
609 local_irq_save(flags
);
611 /* turn off both tx and rx and reset the chip */
613 printk(KERN_ERR
"macmace: transmit timeout - resetting\n");
614 mace_txdma_reset(dev
);
618 mace_rxdma_reset(dev
);
620 mp
->tx_count
= N_TX_RING
;
621 netif_wake_queue(dev
);
624 mb
->maccc
= ENXMT
| ENRCV
;
625 /* enable all interrupts except receive interrupts */
628 local_irq_restore(flags
);
632 * Handle a newly arrived frame
635 static void mace_dma_rx_frame(struct net_device
*dev
, struct mace_frame
*mf
)
638 unsigned int frame_status
= mf
->rcvsts
;
640 if (frame_status
& (RS_OFLO
| RS_CLSN
| RS_FRAMERR
| RS_FCSERR
)) {
641 dev
->stats
.rx_errors
++;
642 if (frame_status
& RS_OFLO
)
643 dev
->stats
.rx_fifo_errors
++;
644 if (frame_status
& RS_CLSN
)
645 dev
->stats
.collisions
++;
646 if (frame_status
& RS_FRAMERR
)
647 dev
->stats
.rx_frame_errors
++;
648 if (frame_status
& RS_FCSERR
)
649 dev
->stats
.rx_crc_errors
++;
651 unsigned int frame_length
= mf
->rcvcnt
+ ((frame_status
& 0x0F) << 8 );
653 skb
= netdev_alloc_skb(dev
, frame_length
+ 2);
655 dev
->stats
.rx_dropped
++;
659 skb_put_data(skb
, mf
->data
, frame_length
);
661 skb
->protocol
= eth_type_trans(skb
, dev
);
663 dev
->stats
.rx_packets
++;
664 dev
->stats
.rx_bytes
+= frame_length
;
669 * The PSC has passed us a DMA interrupt event.
672 static irqreturn_t
mace_dma_intr(int irq
, void *dev_id
)
674 struct net_device
*dev
= (struct net_device
*) dev_id
;
675 struct mace_data
*mp
= netdev_priv(dev
);
680 /* Not sure what this does */
682 while ((baka
= psc_read_long(PSC_MYSTERY
)) != psc_read_long(PSC_MYSTERY
));
683 if (!(baka
& 0x60000000)) return IRQ_NONE
;
686 * Process the read queue
689 status
= psc_read_word(PSC_ENETRD_CTL
);
691 if (status
& 0x2000) {
692 mace_rxdma_reset(dev
);
693 } else if (status
& 0x0100) {
694 psc_write_word(PSC_ENETRD_CMD
+ mp
->rx_slot
, 0x1100);
696 left
= psc_read_long(PSC_ENETRD_LEN
+ mp
->rx_slot
);
697 head
= N_RX_RING
- left
;
699 /* Loop through the ring buffer and process new packages */
701 while (mp
->rx_tail
< head
) {
702 mace_dma_rx_frame(dev
, (struct mace_frame
*) (mp
->rx_ring
703 + (mp
->rx_tail
* MACE_BUFF_SIZE
)));
707 /* If we're out of buffers in this ring then switch to */
708 /* the other set, otherwise just reactivate this one. */
711 mace_load_rxdma_base(dev
, mp
->rx_slot
);
714 psc_write_word(PSC_ENETRD_CMD
+ mp
->rx_slot
, 0x9800);
719 * Process the write queue
722 status
= psc_read_word(PSC_ENETWR_CTL
);
724 if (status
& 0x2000) {
725 mace_txdma_reset(dev
);
726 } else if (status
& 0x0100) {
727 psc_write_word(PSC_ENETWR_CMD
+ mp
->tx_sloti
, 0x0100);
728 mp
->tx_sloti
^= 0x10;
734 MODULE_LICENSE("GPL");
735 MODULE_DESCRIPTION("Macintosh MACE ethernet driver");
736 MODULE_ALIAS("platform:macmace");
738 static int mac_mace_device_remove(struct platform_device
*pdev
)
740 struct net_device
*dev
= platform_get_drvdata(pdev
);
741 struct mace_data
*mp
= netdev_priv(dev
);
743 unregister_netdev(dev
);
745 free_irq(dev
->irq
, dev
);
746 free_irq(IRQ_MAC_MACE_DMA
, dev
);
748 dma_free_coherent(mp
->device
, N_RX_RING
* MACE_BUFF_SIZE
,
749 mp
->rx_ring
, mp
->rx_ring_phys
);
750 dma_free_coherent(mp
->device
, N_TX_RING
* MACE_BUFF_SIZE
,
751 mp
->tx_ring
, mp
->tx_ring_phys
);
758 static struct platform_driver mac_mace_driver
= {
760 .remove
= mac_mace_device_remove
,
762 .name
= mac_mace_string
,
766 module_platform_driver(mac_mace_driver
);