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";
68 /* These should basically be bus-size and endian independent (since
69 the SONIC is at least smart enough that it uses the same endianness
70 as the host, unlike certain less enlightened Macintosh NICs) */
71 #define SONIC_READ(reg) (nubus_readw(dev->base_addr + (reg * 4) \
73 #define SONIC_WRITE(reg,val) (nubus_writew(val, dev->base_addr + (reg * 4) \
76 /* use 0 for production, 1 for verification, >1 for debug */
78 static unsigned int sonic_debug
= SONIC_DEBUG
;
80 static unsigned int sonic_debug
= 1;
83 static int sonic_version_printed
;
85 /* For onboard SONIC */
86 #define ONBOARD_SONIC_REGISTERS 0x50F0A000
87 #define ONBOARD_SONIC_PROM_BASE 0x50f08000
97 /* For the built-in SONIC in the Duo Dock */
98 #define DUODOCK_SONIC_REGISTERS 0xe10000
99 #define DUODOCK_SONIC_PROM_BASE 0xe12000
101 /* For Apple-style NuBus SONIC */
102 #define APPLE_SONIC_REGISTERS 0
103 #define APPLE_SONIC_PROM_BASE 0x40000
105 /* Daynalink LC SONIC */
106 #define DAYNALINK_PROM_BASE 0x400000
108 /* For Dayna-style NuBus SONIC (haven't seen one yet) */
109 #define DAYNA_SONIC_REGISTERS 0x180000
110 /* This is what OpenBSD says. However, this is definitely in NuBus
111 ROM space so we should be able to get it by walking the NuBus
112 resource directories */
113 #define DAYNA_SONIC_MAC_ADDR 0xffe004
115 #define SONIC_READ_PROM(addr) nubus_readb(prom_addr+addr)
118 * For reversing the PROM address
121 static inline void bit_reverse_addr(unsigned char addr
[6])
125 for(i
= 0; i
< 6; i
++)
126 addr
[i
] = bitrev8(addr
[i
]);
129 static irqreturn_t
macsonic_interrupt(int irq
, void *dev_id
)
134 local_irq_save(flags
);
135 result
= sonic_interrupt(irq
, dev_id
);
136 local_irq_restore(flags
);
140 static int macsonic_open(struct net_device
* dev
)
142 if (request_irq(dev
->irq
, sonic_interrupt
, IRQ_FLG_FAST
, "sonic", dev
)) {
143 printk(KERN_ERR
"%s: unable to get IRQ %d.\n", dev
->name
, dev
->irq
);
146 /* Under the A/UX interrupt scheme, the onboard SONIC interrupt comes
147 * in at priority level 3. However, we sometimes get the level 2 inter-
148 * rupt as well, which must prevent re-entrance of the sonic handler.
150 if (dev
->irq
== IRQ_AUTO_3
)
151 if (request_irq(IRQ_NUBUS_9
, macsonic_interrupt
, IRQ_FLG_FAST
, "sonic", dev
)) {
152 printk(KERN_ERR
"%s: unable to get IRQ %d.\n", dev
->name
, IRQ_NUBUS_9
);
153 free_irq(dev
->irq
, dev
);
156 return sonic_open(dev
);
159 static int macsonic_close(struct net_device
* dev
)
162 err
= sonic_close(dev
);
163 free_irq(dev
->irq
, dev
);
164 if (dev
->irq
== IRQ_AUTO_3
)
165 free_irq(IRQ_NUBUS_9
, dev
);
169 static const struct net_device_ops macsonic_netdev_ops
= {
170 .ndo_open
= macsonic_open
,
171 .ndo_stop
= macsonic_close
,
172 .ndo_start_xmit
= sonic_send_packet
,
173 .ndo_set_multicast_list
= sonic_multicast_list
,
174 .ndo_tx_timeout
= sonic_tx_timeout
,
175 .ndo_get_stats
= sonic_get_stats
,
176 .ndo_validate_addr
= eth_validate_addr
,
177 .ndo_change_mtu
= eth_change_mtu
,
178 .ndo_set_mac_address
= eth_mac_addr
,
181 static int __devinit
macsonic_init(struct net_device
*dev
)
183 struct sonic_local
* lp
= netdev_priv(dev
);
185 /* Allocate the entire chunk of memory for the descriptors.
186 Note that this cannot cross a 64K boundary. */
187 if ((lp
->descriptors
= dma_alloc_coherent(lp
->device
,
188 SIZEOF_SONIC_DESC
* SONIC_BUS_SCALE(lp
->dma_bitmode
),
189 &lp
->descriptors_laddr
, GFP_KERNEL
)) == NULL
) {
190 printk(KERN_ERR
"%s: couldn't alloc DMA memory for descriptors.\n",
191 dev_name(lp
->device
));
195 /* Now set up the pointers to point to the appropriate places */
196 lp
->cda
= lp
->descriptors
;
197 lp
->tda
= lp
->cda
+ (SIZEOF_SONIC_CDA
198 * SONIC_BUS_SCALE(lp
->dma_bitmode
));
199 lp
->rda
= lp
->tda
+ (SIZEOF_SONIC_TD
* SONIC_NUM_TDS
200 * SONIC_BUS_SCALE(lp
->dma_bitmode
));
201 lp
->rra
= lp
->rda
+ (SIZEOF_SONIC_RD
* SONIC_NUM_RDS
202 * SONIC_BUS_SCALE(lp
->dma_bitmode
));
204 lp
->cda_laddr
= lp
->descriptors_laddr
;
205 lp
->tda_laddr
= lp
->cda_laddr
+ (SIZEOF_SONIC_CDA
206 * SONIC_BUS_SCALE(lp
->dma_bitmode
));
207 lp
->rda_laddr
= lp
->tda_laddr
+ (SIZEOF_SONIC_TD
* SONIC_NUM_TDS
208 * SONIC_BUS_SCALE(lp
->dma_bitmode
));
209 lp
->rra_laddr
= lp
->rda_laddr
+ (SIZEOF_SONIC_RD
* SONIC_NUM_RDS
210 * SONIC_BUS_SCALE(lp
->dma_bitmode
));
212 dev
->netdev_ops
= &macsonic_netdev_ops
;
213 dev
->watchdog_timeo
= TX_TIMEOUT
;
216 * clear tally counter
218 SONIC_WRITE(SONIC_CRCT
, 0xffff);
219 SONIC_WRITE(SONIC_FAET
, 0xffff);
220 SONIC_WRITE(SONIC_MPT
, 0xffff);
225 #define INVALID_MAC(mac) (memcmp(mac, "\x08\x00\x07", 3) && \
226 memcmp(mac, "\x00\xA0\x40", 3) && \
227 memcmp(mac, "\x00\x80\x19", 3) && \
228 memcmp(mac, "\x00\x05\x02", 3))
230 static void __devinit
mac_onboard_sonic_ethernet_addr(struct net_device
*dev
)
232 struct sonic_local
*lp
= netdev_priv(dev
);
233 const int prom_addr
= ONBOARD_SONIC_PROM_BASE
;
237 * On NuBus boards we can sometimes look in the ROM resources.
238 * No such luck for comm-slot/onboard.
239 * On the PowerBook 520, the PROM base address is a mystery.
241 if (hwreg_present((void *)prom_addr
)) {
244 for (i
= 0; i
< 6; i
++)
245 dev
->dev_addr
[i
] = SONIC_READ_PROM(i
);
246 if (!INVALID_MAC(dev
->dev_addr
))
250 * Most of the time, the address is bit-reversed. The NetBSD
251 * source has a rather long and detailed historical account of
254 bit_reverse_addr(dev
->dev_addr
);
255 if (!INVALID_MAC(dev
->dev_addr
))
259 * If we still have what seems to be a bogus address, we'll
260 * look in the CAM. The top entry should be ours.
262 printk(KERN_WARNING
"macsonic: MAC address in PROM seems "
263 "to be invalid, trying CAM\n");
265 printk(KERN_WARNING
"macsonic: cannot read MAC address from "
266 "PROM, trying CAM\n");
269 /* This only works if MacOS has already initialized the card. */
271 SONIC_WRITE(SONIC_CMD
, SONIC_CR_RST
);
272 SONIC_WRITE(SONIC_CEP
, 15);
274 val
= SONIC_READ(SONIC_CAP2
);
275 dev
->dev_addr
[5] = val
>> 8;
276 dev
->dev_addr
[4] = val
& 0xff;
277 val
= SONIC_READ(SONIC_CAP1
);
278 dev
->dev_addr
[3] = val
>> 8;
279 dev
->dev_addr
[2] = val
& 0xff;
280 val
= SONIC_READ(SONIC_CAP0
);
281 dev
->dev_addr
[1] = val
>> 8;
282 dev
->dev_addr
[0] = val
& 0xff;
284 if (!INVALID_MAC(dev
->dev_addr
))
287 /* Still nonsense ... messed up someplace! */
289 printk(KERN_WARNING
"macsonic: MAC address in CAM entry 15 "
290 "seems invalid, will use a random MAC\n");
291 random_ether_addr(dev
->dev_addr
);
294 static int __devinit
mac_onboard_sonic_probe(struct net_device
*dev
)
297 static int once_is_more_than_enough
;
298 struct sonic_local
* lp
= netdev_priv(dev
);
302 if (once_is_more_than_enough
)
304 once_is_more_than_enough
= 1;
309 if (macintosh_config
->ether_type
!= MAC_ETHER_SONIC
)
312 printk(KERN_INFO
"Checking for internal Macintosh ethernet (SONIC).. ");
314 /* Bogus probing, on the models which may or may not have
315 Ethernet (BTW, the Ethernet *is* always at the same
316 address, and nothing else lives there, at least if Apple's
317 documentation is to be believed) */
318 if (macintosh_config
->ident
== MAC_MODEL_Q630
||
319 macintosh_config
->ident
== MAC_MODEL_P588
||
320 macintosh_config
->ident
== MAC_MODEL_P575
||
321 macintosh_config
->ident
== MAC_MODEL_C610
) {
325 local_irq_save(flags
);
326 card_present
= hwreg_present((void*)ONBOARD_SONIC_REGISTERS
);
327 local_irq_restore(flags
);
338 /* Danger! My arms are flailing wildly! You *must* set lp->reg_offset
339 * and dev->base_addr before using SONIC_READ() or SONIC_WRITE() */
340 dev
->base_addr
= ONBOARD_SONIC_REGISTERS
;
342 dev
->irq
= IRQ_AUTO_3
;
344 dev
->irq
= IRQ_NUBUS_9
;
346 if (!sonic_version_printed
) {
347 printk(KERN_INFO
"%s", version
);
348 sonic_version_printed
= 1;
350 printk(KERN_INFO
"%s: onboard / comm-slot SONIC at 0x%08lx\n",
351 dev_name(lp
->device
), dev
->base_addr
);
353 /* The PowerBook's SONIC is 16 bit always. */
354 if (macintosh_config
->ident
== MAC_MODEL_PB520
) {
356 lp
->dma_bitmode
= SONIC_BITMODE16
;
357 sr
= SONIC_READ(SONIC_SR
);
358 } else if (commslot
) {
359 /* Some of the comm-slot cards are 16 bit. But some
360 of them are not. The 32-bit cards use offset 2 and
361 have known revisions, we try reading the revision
362 register at offset 2, if we don't get a known revision
363 we assume 16 bit at offset 0. */
365 lp
->dma_bitmode
= SONIC_BITMODE16
;
367 sr
= SONIC_READ(SONIC_SR
);
368 if (sr
== 0x0004 || sr
== 0x0006 || sr
== 0x0100 || sr
== 0x0101)
369 /* 83932 is 0x0004 or 0x0006, 83934 is 0x0100 or 0x0101 */
370 lp
->dma_bitmode
= SONIC_BITMODE32
;
372 lp
->dma_bitmode
= SONIC_BITMODE16
;
374 sr
= SONIC_READ(SONIC_SR
);
377 /* All onboard cards are at offset 2 with 32 bit DMA. */
379 lp
->dma_bitmode
= SONIC_BITMODE32
;
380 sr
= SONIC_READ(SONIC_SR
);
383 "%s: revision 0x%04x, using %d bit DMA and register offset %d\n",
384 dev_name(lp
->device
), sr
, lp
->dma_bitmode
?32:16, lp
->reg_offset
);
386 #if 0 /* This is sometimes useful to find out how MacOS configured the card. */
387 printk(KERN_INFO
"%s: DCR: 0x%04x, DCR2: 0x%04x\n", dev_name(lp
->device
),
388 SONIC_READ(SONIC_DCR
) & 0xffff, SONIC_READ(SONIC_DCR2
) & 0xffff);
391 /* Software reset, then initialize control registers. */
392 SONIC_WRITE(SONIC_CMD
, SONIC_CR_RST
);
394 SONIC_WRITE(SONIC_DCR
, SONIC_DCR_EXBUS
| SONIC_DCR_BMS
|
395 SONIC_DCR_RFT1
| SONIC_DCR_TFT0
|
396 (lp
->dma_bitmode
? SONIC_DCR_DW
: 0));
398 /* This *must* be written back to in order to restore the
399 * extended programmable output bits, as it may not have been
400 * initialised since the hardware reset. */
401 SONIC_WRITE(SONIC_DCR2
, 0);
403 /* Clear *and* disable interrupts to be on the safe side */
404 SONIC_WRITE(SONIC_IMR
, 0);
405 SONIC_WRITE(SONIC_ISR
, 0x7fff);
407 /* Now look for the MAC address. */
408 mac_onboard_sonic_ethernet_addr(dev
);
410 /* Shared init code */
411 return macsonic_init(dev
);
414 static int __devinit
mac_nubus_sonic_ethernet_addr(struct net_device
*dev
,
415 unsigned long prom_addr
,
419 for(i
= 0; i
< 6; i
++)
420 dev
->dev_addr
[i
] = SONIC_READ_PROM(i
);
422 /* Some of the addresses are bit-reversed */
423 if (id
!= MACSONIC_DAYNA
)
424 bit_reverse_addr(dev
->dev_addr
);
429 static int __devinit
macsonic_ident(struct nubus_dev
*ndev
)
431 if (ndev
->dr_hw
== NUBUS_DRHW_ASANTE_LC
&&
432 ndev
->dr_sw
== NUBUS_DRSW_SONIC_LC
)
433 return MACSONIC_DAYNALINK
;
434 if (ndev
->dr_hw
== NUBUS_DRHW_SONIC
&&
435 ndev
->dr_sw
== NUBUS_DRSW_APPLE
) {
436 /* There has to be a better way to do this... */
437 if (strstr(ndev
->board
->name
, "DuoDock"))
438 return MACSONIC_DUODOCK
;
440 return MACSONIC_APPLE
;
443 if (ndev
->dr_hw
== NUBUS_DRHW_SMC9194
&&
444 ndev
->dr_sw
== NUBUS_DRSW_DAYNA
)
445 return MACSONIC_DAYNA
;
447 if (ndev
->dr_hw
== NUBUS_DRHW_APPLE_SONIC_LC
&&
448 ndev
->dr_sw
== 0) { /* huh? */
449 return MACSONIC_APPLE16
;
454 static int __devinit
mac_nubus_sonic_probe(struct net_device
*dev
)
457 struct nubus_dev
* ndev
= NULL
;
458 struct sonic_local
* lp
= netdev_priv(dev
);
459 unsigned long base_addr
, prom_addr
;
462 int reg_offset
, dma_bitmode
;
464 /* Find the first SONIC that hasn't been initialized already */
465 while ((ndev
= nubus_find_type(NUBUS_CAT_NETWORK
,
466 NUBUS_TYPE_ETHERNET
, ndev
)) != NULL
)
468 /* Have we seen it already? */
469 if (slots
& (1<<ndev
->board
->slot
))
471 slots
|= 1<<ndev
->board
->slot
;
473 /* Is it one of ours? */
474 if ((id
= macsonic_ident(ndev
)) != -1)
482 case MACSONIC_DUODOCK
:
483 base_addr
= ndev
->board
->slot_addr
+ DUODOCK_SONIC_REGISTERS
;
484 prom_addr
= ndev
->board
->slot_addr
+ DUODOCK_SONIC_PROM_BASE
;
485 sonic_dcr
= SONIC_DCR_EXBUS
| SONIC_DCR_RFT0
| SONIC_DCR_RFT1
|
488 dma_bitmode
= SONIC_BITMODE32
;
491 base_addr
= ndev
->board
->slot_addr
+ APPLE_SONIC_REGISTERS
;
492 prom_addr
= ndev
->board
->slot_addr
+ APPLE_SONIC_PROM_BASE
;
493 sonic_dcr
= SONIC_DCR_BMS
| SONIC_DCR_RFT1
| SONIC_DCR_TFT0
;
495 dma_bitmode
= SONIC_BITMODE32
;
497 case MACSONIC_APPLE16
:
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_EXBUS
| SONIC_DCR_RFT1
| SONIC_DCR_TFT0
|
501 SONIC_DCR_PO1
| SONIC_DCR_BMS
;
503 dma_bitmode
= SONIC_BITMODE16
;
505 case MACSONIC_DAYNALINK
:
506 base_addr
= ndev
->board
->slot_addr
+ APPLE_SONIC_REGISTERS
;
507 prom_addr
= ndev
->board
->slot_addr
+ DAYNALINK_PROM_BASE
;
508 sonic_dcr
= SONIC_DCR_RFT1
| SONIC_DCR_TFT0
|
509 SONIC_DCR_PO1
| SONIC_DCR_BMS
;
511 dma_bitmode
= SONIC_BITMODE16
;
514 base_addr
= ndev
->board
->slot_addr
+ DAYNA_SONIC_REGISTERS
;
515 prom_addr
= ndev
->board
->slot_addr
+ DAYNA_SONIC_MAC_ADDR
;
516 sonic_dcr
= SONIC_DCR_BMS
|
517 SONIC_DCR_RFT1
| SONIC_DCR_TFT0
| SONIC_DCR_PO1
;
519 dma_bitmode
= SONIC_BITMODE16
;
522 printk(KERN_ERR
"macsonic: WTF, id is %d\n", id
);
526 /* Danger! My arms are flailing wildly! You *must* set lp->reg_offset
527 * and dev->base_addr before using SONIC_READ() or SONIC_WRITE() */
528 dev
->base_addr
= base_addr
;
529 lp
->reg_offset
= reg_offset
;
530 lp
->dma_bitmode
= dma_bitmode
;
531 dev
->irq
= SLOT2IRQ(ndev
->board
->slot
);
533 if (!sonic_version_printed
) {
534 printk(KERN_INFO
"%s", version
);
535 sonic_version_printed
= 1;
537 printk(KERN_INFO
"%s: %s in slot %X\n",
538 dev_name(lp
->device
), ndev
->board
->name
, ndev
->board
->slot
);
539 printk(KERN_INFO
"%s: revision 0x%04x, using %d bit DMA and register offset %d\n",
540 dev_name(lp
->device
), SONIC_READ(SONIC_SR
), dma_bitmode
?32:16, reg_offset
);
542 #if 0 /* This is sometimes useful to find out how MacOS configured the card. */
543 printk(KERN_INFO
"%s: DCR: 0x%04x, DCR2: 0x%04x\n", dev_name(lp
->device
),
544 SONIC_READ(SONIC_DCR
) & 0xffff, SONIC_READ(SONIC_DCR2
) & 0xffff);
547 /* Software reset, then initialize control registers. */
548 SONIC_WRITE(SONIC_CMD
, SONIC_CR_RST
);
549 SONIC_WRITE(SONIC_DCR
, sonic_dcr
| (dma_bitmode
? SONIC_DCR_DW
: 0));
550 /* This *must* be written back to in order to restore the
551 * extended programmable output bits, since it may not have been
552 * initialised since the hardware reset. */
553 SONIC_WRITE(SONIC_DCR2
, 0);
555 /* Clear *and* disable interrupts to be on the safe side */
556 SONIC_WRITE(SONIC_IMR
, 0);
557 SONIC_WRITE(SONIC_ISR
, 0x7fff);
559 /* Now look for the MAC address. */
560 if (mac_nubus_sonic_ethernet_addr(dev
, prom_addr
, id
) != 0)
563 /* Shared init code */
564 return macsonic_init(dev
);
567 static int __devinit
mac_sonic_probe(struct platform_device
*pdev
)
569 struct net_device
*dev
;
570 struct sonic_local
*lp
;
573 dev
= alloc_etherdev(sizeof(struct sonic_local
));
577 lp
= netdev_priv(dev
);
578 lp
->device
= &pdev
->dev
;
579 SET_NETDEV_DEV(dev
, &pdev
->dev
);
580 platform_set_drvdata(pdev
, dev
);
582 /* This will catch fatal stuff like -ENOMEM as well as success */
583 err
= mac_onboard_sonic_probe(dev
);
588 err
= mac_nubus_sonic_probe(dev
);
592 err
= register_netdev(dev
);
596 printk("%s: MAC %pM IRQ %d\n", dev
->name
, dev
->dev_addr
, dev
->irq
);
606 MODULE_DESCRIPTION("Macintosh SONIC ethernet driver");
607 module_param(sonic_debug
, int, 0);
608 MODULE_PARM_DESC(sonic_debug
, "macsonic debug level (1-4)");
609 MODULE_ALIAS("platform:macsonic");
613 static int __devexit
mac_sonic_device_remove (struct platform_device
*pdev
)
615 struct net_device
*dev
= platform_get_drvdata(pdev
);
616 struct sonic_local
* lp
= netdev_priv(dev
);
618 unregister_netdev(dev
);
619 dma_free_coherent(lp
->device
, SIZEOF_SONIC_DESC
* SONIC_BUS_SCALE(lp
->dma_bitmode
),
620 lp
->descriptors
, lp
->descriptors_laddr
);
626 static struct platform_driver mac_sonic_driver
= {
627 .probe
= mac_sonic_probe
,
628 .remove
= __devexit_p(mac_sonic_device_remove
),
630 .name
= mac_sonic_string
,
631 .owner
= THIS_MODULE
,
635 static int __init
mac_sonic_init_module(void)
637 return platform_driver_register(&mac_sonic_driver
);
640 static void __exit
mac_sonic_cleanup_module(void)
642 platform_driver_unregister(&mac_sonic_driver
);
645 module_init(mac_sonic_init_module
);
646 module_exit(mac_sonic_cleanup_module
);