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";
65 static struct platform_device
*mac_sonic_device
;
69 /* These should basically be bus-size and endian independent (since
70 the SONIC is at least smart enough that it uses the same endianness
71 as the host, unlike certain less enlightened Macintosh NICs) */
72 #define SONIC_READ(reg) (nubus_readw(dev->base_addr + (reg * 4) \
74 #define SONIC_WRITE(reg,val) (nubus_writew(val, dev->base_addr + (reg * 4) \
77 /* use 0 for production, 1 for verification, >1 for debug */
79 static unsigned int sonic_debug
= SONIC_DEBUG
;
81 static unsigned int sonic_debug
= 1;
84 static int sonic_version_printed
;
86 /* For onboard SONIC */
87 #define ONBOARD_SONIC_REGISTERS 0x50F0A000
88 #define ONBOARD_SONIC_PROM_BASE 0x50f08000
98 /* For the built-in SONIC in the Duo Dock */
99 #define DUODOCK_SONIC_REGISTERS 0xe10000
100 #define DUODOCK_SONIC_PROM_BASE 0xe12000
102 /* For Apple-style NuBus SONIC */
103 #define APPLE_SONIC_REGISTERS 0
104 #define APPLE_SONIC_PROM_BASE 0x40000
106 /* Daynalink LC SONIC */
107 #define DAYNALINK_PROM_BASE 0x400000
109 /* For Dayna-style NuBus SONIC (haven't seen one yet) */
110 #define DAYNA_SONIC_REGISTERS 0x180000
111 /* This is what OpenBSD says. However, this is definitely in NuBus
112 ROM space so we should be able to get it by walking the NuBus
113 resource directories */
114 #define DAYNA_SONIC_MAC_ADDR 0xffe004
116 #define SONIC_READ_PROM(addr) nubus_readb(prom_addr+addr)
119 * For reversing the PROM address
122 static inline void bit_reverse_addr(unsigned char addr
[6])
126 for(i
= 0; i
< 6; i
++)
127 addr
[i
] = bitrev8(addr
[i
]);
130 static irqreturn_t
macsonic_interrupt(int irq
, void *dev_id
)
135 local_irq_save(flags
);
136 result
= sonic_interrupt(irq
, dev_id
);
137 local_irq_restore(flags
);
141 static int macsonic_open(struct net_device
* dev
)
143 if (request_irq(dev
->irq
, &sonic_interrupt
, IRQ_FLG_FAST
, "sonic", dev
)) {
144 printk(KERN_ERR
"%s: unable to get IRQ %d.\n", dev
->name
, dev
->irq
);
147 /* Under the A/UX interrupt scheme, the onboard SONIC interrupt comes
148 * in at priority level 3. However, we sometimes get the level 2 inter-
149 * rupt as well, which must prevent re-entrance of the sonic handler.
151 if (dev
->irq
== IRQ_AUTO_3
)
152 if (request_irq(IRQ_NUBUS_9
, &macsonic_interrupt
, IRQ_FLG_FAST
, "sonic", dev
)) {
153 printk(KERN_ERR
"%s: unable to get IRQ %d.\n", dev
->name
, IRQ_NUBUS_9
);
154 free_irq(dev
->irq
, dev
);
157 return sonic_open(dev
);
160 static int macsonic_close(struct net_device
* dev
)
163 err
= sonic_close(dev
);
164 free_irq(dev
->irq
, dev
);
165 if (dev
->irq
== IRQ_AUTO_3
)
166 free_irq(IRQ_NUBUS_9
, dev
);
170 static int __init
macsonic_init(struct net_device
*dev
)
172 struct sonic_local
* lp
= netdev_priv(dev
);
174 /* Allocate the entire chunk of memory for the descriptors.
175 Note that this cannot cross a 64K boundary. */
176 if ((lp
->descriptors
= dma_alloc_coherent(lp
->device
,
177 SIZEOF_SONIC_DESC
* SONIC_BUS_SCALE(lp
->dma_bitmode
),
178 &lp
->descriptors_laddr
, GFP_KERNEL
)) == NULL
) {
179 printk(KERN_ERR
"%s: couldn't alloc DMA memory for descriptors.\n", lp
->device
->bus_id
);
183 /* Now set up the pointers to point to the appropriate places */
184 lp
->cda
= lp
->descriptors
;
185 lp
->tda
= lp
->cda
+ (SIZEOF_SONIC_CDA
186 * SONIC_BUS_SCALE(lp
->dma_bitmode
));
187 lp
->rda
= lp
->tda
+ (SIZEOF_SONIC_TD
* SONIC_NUM_TDS
188 * SONIC_BUS_SCALE(lp
->dma_bitmode
));
189 lp
->rra
= lp
->rda
+ (SIZEOF_SONIC_RD
* SONIC_NUM_RDS
190 * SONIC_BUS_SCALE(lp
->dma_bitmode
));
192 lp
->cda_laddr
= lp
->descriptors_laddr
;
193 lp
->tda_laddr
= lp
->cda_laddr
+ (SIZEOF_SONIC_CDA
194 * SONIC_BUS_SCALE(lp
->dma_bitmode
));
195 lp
->rda_laddr
= lp
->tda_laddr
+ (SIZEOF_SONIC_TD
* SONIC_NUM_TDS
196 * SONIC_BUS_SCALE(lp
->dma_bitmode
));
197 lp
->rra_laddr
= lp
->rda_laddr
+ (SIZEOF_SONIC_RD
* SONIC_NUM_RDS
198 * SONIC_BUS_SCALE(lp
->dma_bitmode
));
200 dev
->open
= macsonic_open
;
201 dev
->stop
= macsonic_close
;
202 dev
->hard_start_xmit
= sonic_send_packet
;
203 dev
->get_stats
= sonic_get_stats
;
204 dev
->set_multicast_list
= &sonic_multicast_list
;
205 dev
->tx_timeout
= sonic_tx_timeout
;
206 dev
->watchdog_timeo
= TX_TIMEOUT
;
209 * clear tally counter
211 SONIC_WRITE(SONIC_CRCT
, 0xffff);
212 SONIC_WRITE(SONIC_FAET
, 0xffff);
213 SONIC_WRITE(SONIC_MPT
, 0xffff);
218 static int __init
mac_onboard_sonic_ethernet_addr(struct net_device
*dev
)
220 struct sonic_local
*lp
= netdev_priv(dev
);
221 const int prom_addr
= ONBOARD_SONIC_PROM_BASE
;
224 /* On NuBus boards we can sometimes look in the ROM resources.
225 No such luck for comm-slot/onboard. */
226 for(i
= 0; i
< 6; i
++)
227 dev
->dev_addr
[i
] = SONIC_READ_PROM(i
);
229 /* Most of the time, the address is bit-reversed. The NetBSD
230 source has a rather long and detailed historical account of
232 if (memcmp(dev
->dev_addr
, "\x08\x00\x07", 3) &&
233 memcmp(dev
->dev_addr
, "\x00\xA0\x40", 3) &&
234 memcmp(dev
->dev_addr
, "\x00\x80\x19", 3) &&
235 memcmp(dev
->dev_addr
, "\x00\x05\x02", 3))
236 bit_reverse_addr(dev
->dev_addr
);
240 /* If we still have what seems to be a bogus address, we'll
241 look in the CAM. The top entry should be ours. */
242 /* Danger! This only works if MacOS has already initialized
244 if (memcmp(dev
->dev_addr
, "\x08\x00\x07", 3) &&
245 memcmp(dev
->dev_addr
, "\x00\xA0\x40", 3) &&
246 memcmp(dev
->dev_addr
, "\x00\x80\x19", 3) &&
247 memcmp(dev
->dev_addr
, "\x00\x05\x02", 3))
251 printk(KERN_INFO
"macsonic: PROM seems to be wrong, trying CAM entry 15\n");
253 SONIC_WRITE(SONIC_CMD
, SONIC_CR_RST
);
254 SONIC_WRITE(SONIC_CEP
, 15);
256 val
= SONIC_READ(SONIC_CAP2
);
257 dev
->dev_addr
[5] = val
>> 8;
258 dev
->dev_addr
[4] = val
& 0xff;
259 val
= SONIC_READ(SONIC_CAP1
);
260 dev
->dev_addr
[3] = val
>> 8;
261 dev
->dev_addr
[2] = val
& 0xff;
262 val
= SONIC_READ(SONIC_CAP0
);
263 dev
->dev_addr
[1] = val
>> 8;
264 dev
->dev_addr
[0] = val
& 0xff;
266 printk(KERN_INFO
"HW Address from CAM 15: %pM\n",
270 if (memcmp(dev
->dev_addr
, "\x08\x00\x07", 3) &&
271 memcmp(dev
->dev_addr
, "\x00\xA0\x40", 3) &&
272 memcmp(dev
->dev_addr
, "\x00\x80\x19", 3) &&
273 memcmp(dev
->dev_addr
, "\x00\x05\x02", 3))
276 * Still nonsense ... messed up someplace!
278 printk(KERN_ERR
"macsonic: ERROR (INVALID MAC)\n");
283 static int __init
mac_onboard_sonic_probe(struct net_device
*dev
)
286 static int once_is_more_than_enough
;
287 struct sonic_local
* lp
= netdev_priv(dev
);
291 if (once_is_more_than_enough
)
293 once_is_more_than_enough
= 1;
298 if (macintosh_config
->ether_type
!= MAC_ETHER_SONIC
)
301 printk(KERN_INFO
"Checking for internal Macintosh ethernet (SONIC).. ");
303 /* Bogus probing, on the models which may or may not have
304 Ethernet (BTW, the Ethernet *is* always at the same
305 address, and nothing else lives there, at least if Apple's
306 documentation is to be believed) */
307 if (macintosh_config
->ident
== MAC_MODEL_Q630
||
308 macintosh_config
->ident
== MAC_MODEL_P588
||
309 macintosh_config
->ident
== MAC_MODEL_P575
||
310 macintosh_config
->ident
== MAC_MODEL_C610
) {
314 local_irq_save(flags
);
315 card_present
= hwreg_present((void*)ONBOARD_SONIC_REGISTERS
);
316 local_irq_restore(flags
);
327 /* Danger! My arms are flailing wildly! You *must* set lp->reg_offset
328 * and dev->base_addr before using SONIC_READ() or SONIC_WRITE() */
329 dev
->base_addr
= ONBOARD_SONIC_REGISTERS
;
331 dev
->irq
= IRQ_AUTO_3
;
333 dev
->irq
= IRQ_NUBUS_9
;
335 if (!sonic_version_printed
) {
336 printk(KERN_INFO
"%s", version
);
337 sonic_version_printed
= 1;
339 printk(KERN_INFO
"%s: onboard / comm-slot SONIC at 0x%08lx\n",
340 lp
->device
->bus_id
, dev
->base_addr
);
342 /* The PowerBook's SONIC is 16 bit always. */
343 if (macintosh_config
->ident
== MAC_MODEL_PB520
) {
345 lp
->dma_bitmode
= SONIC_BITMODE16
;
346 sr
= SONIC_READ(SONIC_SR
);
347 } else if (commslot
) {
348 /* Some of the comm-slot cards are 16 bit. But some
349 of them are not. The 32-bit cards use offset 2 and
350 have known revisions, we try reading the revision
351 register at offset 2, if we don't get a known revision
352 we assume 16 bit at offset 0. */
354 lp
->dma_bitmode
= SONIC_BITMODE16
;
356 sr
= SONIC_READ(SONIC_SR
);
357 if (sr
== 0x0004 || sr
== 0x0006 || sr
== 0x0100 || sr
== 0x0101)
358 /* 83932 is 0x0004 or 0x0006, 83934 is 0x0100 or 0x0101 */
359 lp
->dma_bitmode
= SONIC_BITMODE32
;
361 lp
->dma_bitmode
= SONIC_BITMODE16
;
363 sr
= SONIC_READ(SONIC_SR
);
366 /* All onboard cards are at offset 2 with 32 bit DMA. */
368 lp
->dma_bitmode
= SONIC_BITMODE32
;
369 sr
= SONIC_READ(SONIC_SR
);
372 "%s: revision 0x%04x, using %d bit DMA and register offset %d\n",
373 lp
->device
->bus_id
, sr
, lp
->dma_bitmode
?32:16, lp
->reg_offset
);
375 #if 0 /* This is sometimes useful to find out how MacOS configured the card. */
376 printk(KERN_INFO
"%s: DCR: 0x%04x, DCR2: 0x%04x\n", lp
->device
->bus_id
,
377 SONIC_READ(SONIC_DCR
) & 0xffff, SONIC_READ(SONIC_DCR2
) & 0xffff);
380 /* Software reset, then initialize control registers. */
381 SONIC_WRITE(SONIC_CMD
, SONIC_CR_RST
);
383 SONIC_WRITE(SONIC_DCR
, SONIC_DCR_EXBUS
| SONIC_DCR_BMS
|
384 SONIC_DCR_RFT1
| SONIC_DCR_TFT0
|
385 (lp
->dma_bitmode
? SONIC_DCR_DW
: 0));
387 /* This *must* be written back to in order to restore the
388 * extended programmable output bits, as it may not have been
389 * initialised since the hardware reset. */
390 SONIC_WRITE(SONIC_DCR2
, 0);
392 /* Clear *and* disable interrupts to be on the safe side */
393 SONIC_WRITE(SONIC_IMR
, 0);
394 SONIC_WRITE(SONIC_ISR
, 0x7fff);
396 /* Now look for the MAC address. */
397 if (mac_onboard_sonic_ethernet_addr(dev
) != 0)
400 /* Shared init code */
401 return macsonic_init(dev
);
404 static int __init
mac_nubus_sonic_ethernet_addr(struct net_device
*dev
,
405 unsigned long prom_addr
,
409 for(i
= 0; i
< 6; i
++)
410 dev
->dev_addr
[i
] = SONIC_READ_PROM(i
);
412 /* Some of the addresses are bit-reversed */
413 if (id
!= MACSONIC_DAYNA
)
414 bit_reverse_addr(dev
->dev_addr
);
419 static int __init
macsonic_ident(struct nubus_dev
*ndev
)
421 if (ndev
->dr_hw
== NUBUS_DRHW_ASANTE_LC
&&
422 ndev
->dr_sw
== NUBUS_DRSW_SONIC_LC
)
423 return MACSONIC_DAYNALINK
;
424 if (ndev
->dr_hw
== NUBUS_DRHW_SONIC
&&
425 ndev
->dr_sw
== NUBUS_DRSW_APPLE
) {
426 /* There has to be a better way to do this... */
427 if (strstr(ndev
->board
->name
, "DuoDock"))
428 return MACSONIC_DUODOCK
;
430 return MACSONIC_APPLE
;
433 if (ndev
->dr_hw
== NUBUS_DRHW_SMC9194
&&
434 ndev
->dr_sw
== NUBUS_DRSW_DAYNA
)
435 return MACSONIC_DAYNA
;
437 if (ndev
->dr_hw
== NUBUS_DRHW_APPLE_SONIC_LC
&&
438 ndev
->dr_sw
== 0) { /* huh? */
439 return MACSONIC_APPLE16
;
444 static int __init
mac_nubus_sonic_probe(struct net_device
*dev
)
447 struct nubus_dev
* ndev
= NULL
;
448 struct sonic_local
* lp
= netdev_priv(dev
);
449 unsigned long base_addr
, prom_addr
;
452 int reg_offset
, dma_bitmode
;
454 /* Find the first SONIC that hasn't been initialized already */
455 while ((ndev
= nubus_find_type(NUBUS_CAT_NETWORK
,
456 NUBUS_TYPE_ETHERNET
, ndev
)) != NULL
)
458 /* Have we seen it already? */
459 if (slots
& (1<<ndev
->board
->slot
))
461 slots
|= 1<<ndev
->board
->slot
;
463 /* Is it one of ours? */
464 if ((id
= macsonic_ident(ndev
)) != -1)
472 case MACSONIC_DUODOCK
:
473 base_addr
= ndev
->board
->slot_addr
+ DUODOCK_SONIC_REGISTERS
;
474 prom_addr
= ndev
->board
->slot_addr
+ DUODOCK_SONIC_PROM_BASE
;
475 sonic_dcr
= SONIC_DCR_EXBUS
| SONIC_DCR_RFT0
| SONIC_DCR_RFT1
|
478 dma_bitmode
= SONIC_BITMODE32
;
481 base_addr
= ndev
->board
->slot_addr
+ APPLE_SONIC_REGISTERS
;
482 prom_addr
= ndev
->board
->slot_addr
+ APPLE_SONIC_PROM_BASE
;
483 sonic_dcr
= SONIC_DCR_BMS
| SONIC_DCR_RFT1
| SONIC_DCR_TFT0
;
485 dma_bitmode
= SONIC_BITMODE32
;
487 case MACSONIC_APPLE16
:
488 base_addr
= ndev
->board
->slot_addr
+ APPLE_SONIC_REGISTERS
;
489 prom_addr
= ndev
->board
->slot_addr
+ APPLE_SONIC_PROM_BASE
;
490 sonic_dcr
= SONIC_DCR_EXBUS
| SONIC_DCR_RFT1
| SONIC_DCR_TFT0
|
491 SONIC_DCR_PO1
| SONIC_DCR_BMS
;
493 dma_bitmode
= SONIC_BITMODE16
;
495 case MACSONIC_DAYNALINK
:
496 base_addr
= ndev
->board
->slot_addr
+ APPLE_SONIC_REGISTERS
;
497 prom_addr
= ndev
->board
->slot_addr
+ DAYNALINK_PROM_BASE
;
498 sonic_dcr
= SONIC_DCR_RFT1
| SONIC_DCR_TFT0
|
499 SONIC_DCR_PO1
| SONIC_DCR_BMS
;
501 dma_bitmode
= SONIC_BITMODE16
;
504 base_addr
= ndev
->board
->slot_addr
+ DAYNA_SONIC_REGISTERS
;
505 prom_addr
= ndev
->board
->slot_addr
+ DAYNA_SONIC_MAC_ADDR
;
506 sonic_dcr
= SONIC_DCR_BMS
|
507 SONIC_DCR_RFT1
| SONIC_DCR_TFT0
| SONIC_DCR_PO1
;
509 dma_bitmode
= SONIC_BITMODE16
;
512 printk(KERN_ERR
"macsonic: WTF, id is %d\n", id
);
516 /* Danger! My arms are flailing wildly! You *must* set lp->reg_offset
517 * and dev->base_addr before using SONIC_READ() or SONIC_WRITE() */
518 dev
->base_addr
= base_addr
;
519 lp
->reg_offset
= reg_offset
;
520 lp
->dma_bitmode
= dma_bitmode
;
521 dev
->irq
= SLOT2IRQ(ndev
->board
->slot
);
523 if (!sonic_version_printed
) {
524 printk(KERN_INFO
"%s", version
);
525 sonic_version_printed
= 1;
527 printk(KERN_INFO
"%s: %s in slot %X\n",
528 lp
->device
->bus_id
, ndev
->board
->name
, ndev
->board
->slot
);
529 printk(KERN_INFO
"%s: revision 0x%04x, using %d bit DMA and register offset %d\n",
530 lp
->device
->bus_id
, SONIC_READ(SONIC_SR
), dma_bitmode
?32:16, reg_offset
);
532 #if 0 /* This is sometimes useful to find out how MacOS configured the card. */
533 printk(KERN_INFO
"%s: DCR: 0x%04x, DCR2: 0x%04x\n", lp
->device
->bus_id
,
534 SONIC_READ(SONIC_DCR
) & 0xffff, SONIC_READ(SONIC_DCR2
) & 0xffff);
537 /* Software reset, then initialize control registers. */
538 SONIC_WRITE(SONIC_CMD
, SONIC_CR_RST
);
539 SONIC_WRITE(SONIC_DCR
, sonic_dcr
| (dma_bitmode
? SONIC_DCR_DW
: 0));
540 /* This *must* be written back to in order to restore the
541 * extended programmable output bits, since it may not have been
542 * initialised since the hardware reset. */
543 SONIC_WRITE(SONIC_DCR2
, 0);
545 /* Clear *and* disable interrupts to be on the safe side */
546 SONIC_WRITE(SONIC_IMR
, 0);
547 SONIC_WRITE(SONIC_ISR
, 0x7fff);
549 /* Now look for the MAC address. */
550 if (mac_nubus_sonic_ethernet_addr(dev
, prom_addr
, id
) != 0)
553 /* Shared init code */
554 return macsonic_init(dev
);
557 static int __init
mac_sonic_probe(struct platform_device
*pdev
)
559 struct net_device
*dev
;
560 struct sonic_local
*lp
;
563 dev
= alloc_etherdev(sizeof(struct sonic_local
));
567 lp
= netdev_priv(dev
);
568 lp
->device
= &pdev
->dev
;
569 SET_NETDEV_DEV(dev
, &pdev
->dev
);
571 /* This will catch fatal stuff like -ENOMEM as well as success */
572 err
= mac_onboard_sonic_probe(dev
);
577 err
= mac_nubus_sonic_probe(dev
);
581 err
= register_netdev(dev
);
585 printk("%s: MAC %pM IRQ %d\n", dev
->name
, dev
->dev_addr
, dev
->irq
);
595 MODULE_DESCRIPTION("Macintosh SONIC ethernet driver");
596 module_param(sonic_debug
, int, 0);
597 MODULE_PARM_DESC(sonic_debug
, "macsonic debug level (1-4)");
601 static int __devexit
mac_sonic_device_remove (struct platform_device
*pdev
)
603 struct net_device
*dev
= platform_get_drvdata(pdev
);
604 struct sonic_local
* lp
= netdev_priv(dev
);
606 unregister_netdev(dev
);
607 dma_free_coherent(lp
->device
, SIZEOF_SONIC_DESC
* SONIC_BUS_SCALE(lp
->dma_bitmode
),
608 lp
->descriptors
, lp
->descriptors_laddr
);
614 static struct platform_driver mac_sonic_driver
= {
615 .probe
= mac_sonic_probe
,
616 .remove
= __devexit_p(mac_sonic_device_remove
),
618 .name
= mac_sonic_string
,
622 static int __init
mac_sonic_init_module(void)
626 if ((err
= platform_driver_register(&mac_sonic_driver
))) {
627 printk(KERN_ERR
"Driver registration failed\n");
631 mac_sonic_device
= platform_device_alloc(mac_sonic_string
, 0);
632 if (!mac_sonic_device
)
635 if (platform_device_add(mac_sonic_device
)) {
636 platform_device_put(mac_sonic_device
);
637 mac_sonic_device
= NULL
;
643 platform_driver_unregister(&mac_sonic_driver
);
648 static void __exit
mac_sonic_cleanup_module(void)
650 platform_driver_unregister(&mac_sonic_driver
);
652 if (mac_sonic_device
) {
653 platform_device_unregister(mac_sonic_device
);
654 mac_sonic_device
= NULL
;
658 module_init(mac_sonic_init_module
);
659 module_exit(mac_sonic_cleanup_module
);