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 extern int mac_onboard_sonic_probe(struct net_device
* dev
);
87 extern int mac_nubus_sonic_probe(struct net_device
* dev
);
89 /* For onboard SONIC */
90 #define ONBOARD_SONIC_REGISTERS 0x50F0A000
91 #define ONBOARD_SONIC_PROM_BASE 0x50f08000
101 /* For the built-in SONIC in the Duo Dock */
102 #define DUODOCK_SONIC_REGISTERS 0xe10000
103 #define DUODOCK_SONIC_PROM_BASE 0xe12000
105 /* For Apple-style NuBus SONIC */
106 #define APPLE_SONIC_REGISTERS 0
107 #define APPLE_SONIC_PROM_BASE 0x40000
109 /* Daynalink LC SONIC */
110 #define DAYNALINK_PROM_BASE 0x400000
112 /* For Dayna-style NuBus SONIC (haven't seen one yet) */
113 #define DAYNA_SONIC_REGISTERS 0x180000
114 /* This is what OpenBSD says. However, this is definitely in NuBus
115 ROM space so we should be able to get it by walking the NuBus
116 resource directories */
117 #define DAYNA_SONIC_MAC_ADDR 0xffe004
119 #define SONIC_READ_PROM(addr) nubus_readb(prom_addr+addr)
122 * For reversing the PROM address
125 static inline void bit_reverse_addr(unsigned char addr
[6])
129 for(i
= 0; i
< 6; i
++)
130 addr
[i
] = bitrev8(addr
[i
]);
133 int __init
macsonic_init(struct net_device
* dev
)
135 struct sonic_local
* lp
= netdev_priv(dev
);
137 /* Allocate the entire chunk of memory for the descriptors.
138 Note that this cannot cross a 64K boundary. */
139 if ((lp
->descriptors
= dma_alloc_coherent(lp
->device
,
140 SIZEOF_SONIC_DESC
* SONIC_BUS_SCALE(lp
->dma_bitmode
),
141 &lp
->descriptors_laddr
, GFP_KERNEL
)) == NULL
) {
142 printk(KERN_ERR
"%s: couldn't alloc DMA memory for descriptors.\n", lp
->device
->bus_id
);
146 /* Now set up the pointers to point to the appropriate places */
147 lp
->cda
= lp
->descriptors
;
148 lp
->tda
= lp
->cda
+ (SIZEOF_SONIC_CDA
149 * SONIC_BUS_SCALE(lp
->dma_bitmode
));
150 lp
->rda
= lp
->tda
+ (SIZEOF_SONIC_TD
* SONIC_NUM_TDS
151 * SONIC_BUS_SCALE(lp
->dma_bitmode
));
152 lp
->rra
= lp
->rda
+ (SIZEOF_SONIC_RD
* SONIC_NUM_RDS
153 * SONIC_BUS_SCALE(lp
->dma_bitmode
));
155 lp
->cda_laddr
= lp
->descriptors_laddr
;
156 lp
->tda_laddr
= lp
->cda_laddr
+ (SIZEOF_SONIC_CDA
157 * SONIC_BUS_SCALE(lp
->dma_bitmode
));
158 lp
->rda_laddr
= lp
->tda_laddr
+ (SIZEOF_SONIC_TD
* SONIC_NUM_TDS
159 * SONIC_BUS_SCALE(lp
->dma_bitmode
));
160 lp
->rra_laddr
= lp
->rda_laddr
+ (SIZEOF_SONIC_RD
* SONIC_NUM_RDS
161 * SONIC_BUS_SCALE(lp
->dma_bitmode
));
163 dev
->open
= sonic_open
;
164 dev
->stop
= sonic_close
;
165 dev
->hard_start_xmit
= sonic_send_packet
;
166 dev
->get_stats
= sonic_get_stats
;
167 dev
->set_multicast_list
= &sonic_multicast_list
;
168 dev
->tx_timeout
= sonic_tx_timeout
;
169 dev
->watchdog_timeo
= TX_TIMEOUT
;
172 * clear tally counter
174 SONIC_WRITE(SONIC_CRCT
, 0xffff);
175 SONIC_WRITE(SONIC_FAET
, 0xffff);
176 SONIC_WRITE(SONIC_MPT
, 0xffff);
181 int __init
mac_onboard_sonic_ethernet_addr(struct net_device
* dev
)
183 struct sonic_local
*lp
= netdev_priv(dev
);
184 const int prom_addr
= ONBOARD_SONIC_PROM_BASE
;
187 /* On NuBus boards we can sometimes look in the ROM resources.
188 No such luck for comm-slot/onboard. */
189 for(i
= 0; i
< 6; i
++)
190 dev
->dev_addr
[i
] = SONIC_READ_PROM(i
);
192 /* Most of the time, the address is bit-reversed. The NetBSD
193 source has a rather long and detailed historical account of
195 if (memcmp(dev
->dev_addr
, "\x08\x00\x07", 3) &&
196 memcmp(dev
->dev_addr
, "\x00\xA0\x40", 3) &&
197 memcmp(dev
->dev_addr
, "\x00\x80\x19", 3) &&
198 memcmp(dev
->dev_addr
, "\x00\x05\x02", 3))
199 bit_reverse_addr(dev
->dev_addr
);
203 /* If we still have what seems to be a bogus address, we'll
204 look in the CAM. The top entry should be ours. */
205 /* Danger! This only works if MacOS has already initialized
207 if (memcmp(dev
->dev_addr
, "\x08\x00\x07", 3) &&
208 memcmp(dev
->dev_addr
, "\x00\xA0\x40", 3) &&
209 memcmp(dev
->dev_addr
, "\x00\x80\x19", 3) &&
210 memcmp(dev
->dev_addr
, "\x00\x05\x02", 3))
214 printk(KERN_INFO
"macsonic: PROM seems to be wrong, trying CAM entry 15\n");
216 SONIC_WRITE(SONIC_CMD
, SONIC_CR_RST
);
217 SONIC_WRITE(SONIC_CEP
, 15);
219 val
= SONIC_READ(SONIC_CAP2
);
220 dev
->dev_addr
[5] = val
>> 8;
221 dev
->dev_addr
[4] = val
& 0xff;
222 val
= SONIC_READ(SONIC_CAP1
);
223 dev
->dev_addr
[3] = val
>> 8;
224 dev
->dev_addr
[2] = val
& 0xff;
225 val
= SONIC_READ(SONIC_CAP0
);
226 dev
->dev_addr
[1] = val
>> 8;
227 dev
->dev_addr
[0] = val
& 0xff;
229 printk(KERN_INFO
"HW Address from CAM 15: ");
230 for (i
= 0; i
< 6; i
++) {
231 printk("%2.2x", dev
->dev_addr
[i
]);
238 if (memcmp(dev
->dev_addr
, "\x08\x00\x07", 3) &&
239 memcmp(dev
->dev_addr
, "\x00\xA0\x40", 3) &&
240 memcmp(dev
->dev_addr
, "\x00\x80\x19", 3) &&
241 memcmp(dev
->dev_addr
, "\x00\x05\x02", 3))
244 * Still nonsense ... messed up someplace!
246 printk(KERN_ERR
"macsonic: ERROR (INVALID MAC)\n");
251 int __init
mac_onboard_sonic_probe(struct net_device
* dev
)
254 static int once_is_more_than_enough
;
255 struct sonic_local
* lp
= netdev_priv(dev
);
259 if (once_is_more_than_enough
)
261 once_is_more_than_enough
= 1;
266 if (macintosh_config
->ether_type
!= MAC_ETHER_SONIC
)
269 printk(KERN_INFO
"Checking for internal Macintosh ethernet (SONIC).. ");
271 /* Bogus probing, on the models which may or may not have
272 Ethernet (BTW, the Ethernet *is* always at the same
273 address, and nothing else lives there, at least if Apple's
274 documentation is to be believed) */
275 if (macintosh_config
->ident
== MAC_MODEL_Q630
||
276 macintosh_config
->ident
== MAC_MODEL_P588
||
277 macintosh_config
->ident
== MAC_MODEL_P575
||
278 macintosh_config
->ident
== MAC_MODEL_C610
) {
282 local_irq_save(flags
);
283 card_present
= hwreg_present((void*)ONBOARD_SONIC_REGISTERS
);
284 local_irq_restore(flags
);
295 /* Danger! My arms are flailing wildly! You *must* set lp->reg_offset
296 * and dev->base_addr before using SONIC_READ() or SONIC_WRITE() */
297 dev
->base_addr
= ONBOARD_SONIC_REGISTERS
;
299 dev
->irq
= IRQ_AUTO_3
;
301 dev
->irq
= IRQ_NUBUS_9
;
303 if (!sonic_version_printed
) {
304 printk(KERN_INFO
"%s", version
);
305 sonic_version_printed
= 1;
307 printk(KERN_INFO
"%s: onboard / comm-slot SONIC at 0x%08lx\n",
308 lp
->device
->bus_id
, dev
->base_addr
);
310 /* The PowerBook's SONIC is 16 bit always. */
311 if (macintosh_config
->ident
== MAC_MODEL_PB520
) {
313 lp
->dma_bitmode
= SONIC_BITMODE16
;
314 sr
= SONIC_READ(SONIC_SR
);
315 } else if (commslot
) {
316 /* Some of the comm-slot cards are 16 bit. But some
317 of them are not. The 32-bit cards use offset 2 and
318 have known revisions, we try reading the revision
319 register at offset 2, if we don't get a known revision
320 we assume 16 bit at offset 0. */
322 lp
->dma_bitmode
= SONIC_BITMODE16
;
324 sr
= SONIC_READ(SONIC_SR
);
325 if (sr
== 0x0004 || sr
== 0x0006 || sr
== 0x0100 || sr
== 0x0101)
326 /* 83932 is 0x0004 or 0x0006, 83934 is 0x0100 or 0x0101 */
327 lp
->dma_bitmode
= SONIC_BITMODE32
;
329 lp
->dma_bitmode
= SONIC_BITMODE16
;
331 sr
= SONIC_READ(SONIC_SR
);
334 /* All onboard cards are at offset 2 with 32 bit DMA. */
336 lp
->dma_bitmode
= SONIC_BITMODE32
;
337 sr
= SONIC_READ(SONIC_SR
);
340 "%s: revision 0x%04x, using %d bit DMA and register offset %d\n",
341 lp
->device
->bus_id
, sr
, lp
->dma_bitmode
?32:16, lp
->reg_offset
);
343 #if 0 /* This is sometimes useful to find out how MacOS configured the card. */
344 printk(KERN_INFO
"%s: DCR: 0x%04x, DCR2: 0x%04x\n", lp
->device
->bus_id
,
345 SONIC_READ(SONIC_DCR
) & 0xffff, SONIC_READ(SONIC_DCR2
) & 0xffff);
348 /* Software reset, then initialize control registers. */
349 SONIC_WRITE(SONIC_CMD
, SONIC_CR_RST
);
351 SONIC_WRITE(SONIC_DCR
, SONIC_DCR_EXBUS
| SONIC_DCR_BMS
|
352 SONIC_DCR_RFT1
| SONIC_DCR_TFT0
|
353 (lp
->dma_bitmode
? SONIC_DCR_DW
: 0));
355 /* This *must* be written back to in order to restore the
356 * extended programmable output bits, as it may not have been
357 * initialised since the hardware reset. */
358 SONIC_WRITE(SONIC_DCR2
, 0);
360 /* Clear *and* disable interrupts to be on the safe side */
361 SONIC_WRITE(SONIC_IMR
, 0);
362 SONIC_WRITE(SONIC_ISR
, 0x7fff);
364 /* Now look for the MAC address. */
365 if (mac_onboard_sonic_ethernet_addr(dev
) != 0)
368 /* Shared init code */
369 return macsonic_init(dev
);
372 int __init
mac_nubus_sonic_ethernet_addr(struct net_device
* dev
,
373 unsigned long prom_addr
,
377 for(i
= 0; i
< 6; i
++)
378 dev
->dev_addr
[i
] = SONIC_READ_PROM(i
);
380 /* Some of the addresses are bit-reversed */
381 if (id
!= MACSONIC_DAYNA
)
382 bit_reverse_addr(dev
->dev_addr
);
387 int __init
macsonic_ident(struct nubus_dev
* ndev
)
389 if (ndev
->dr_hw
== NUBUS_DRHW_ASANTE_LC
&&
390 ndev
->dr_sw
== NUBUS_DRSW_SONIC_LC
)
391 return MACSONIC_DAYNALINK
;
392 if (ndev
->dr_hw
== NUBUS_DRHW_SONIC
&&
393 ndev
->dr_sw
== NUBUS_DRSW_APPLE
) {
394 /* There has to be a better way to do this... */
395 if (strstr(ndev
->board
->name
, "DuoDock"))
396 return MACSONIC_DUODOCK
;
398 return MACSONIC_APPLE
;
401 if (ndev
->dr_hw
== NUBUS_DRHW_SMC9194
&&
402 ndev
->dr_sw
== NUBUS_DRSW_DAYNA
)
403 return MACSONIC_DAYNA
;
405 if (ndev
->dr_hw
== NUBUS_DRHW_SONIC_LC
&&
406 ndev
->dr_sw
== 0) { /* huh? */
407 return MACSONIC_APPLE16
;
412 int __init
mac_nubus_sonic_probe(struct net_device
* dev
)
415 struct nubus_dev
* ndev
= NULL
;
416 struct sonic_local
* lp
= netdev_priv(dev
);
417 unsigned long base_addr
, prom_addr
;
420 int reg_offset
, dma_bitmode
;
422 /* Find the first SONIC that hasn't been initialized already */
423 while ((ndev
= nubus_find_type(NUBUS_CAT_NETWORK
,
424 NUBUS_TYPE_ETHERNET
, ndev
)) != NULL
)
426 /* Have we seen it already? */
427 if (slots
& (1<<ndev
->board
->slot
))
429 slots
|= 1<<ndev
->board
->slot
;
431 /* Is it one of ours? */
432 if ((id
= macsonic_ident(ndev
)) != -1)
440 case MACSONIC_DUODOCK
:
441 base_addr
= ndev
->board
->slot_addr
+ DUODOCK_SONIC_REGISTERS
;
442 prom_addr
= ndev
->board
->slot_addr
+ DUODOCK_SONIC_PROM_BASE
;
443 sonic_dcr
= SONIC_DCR_EXBUS
| SONIC_DCR_RFT0
| SONIC_DCR_RFT1
|
446 dma_bitmode
= SONIC_BITMODE32
;
449 base_addr
= ndev
->board
->slot_addr
+ APPLE_SONIC_REGISTERS
;
450 prom_addr
= ndev
->board
->slot_addr
+ APPLE_SONIC_PROM_BASE
;
451 sonic_dcr
= SONIC_DCR_BMS
| SONIC_DCR_RFT1
| SONIC_DCR_TFT0
;
453 dma_bitmode
= SONIC_BITMODE32
;
455 case MACSONIC_APPLE16
:
456 base_addr
= ndev
->board
->slot_addr
+ APPLE_SONIC_REGISTERS
;
457 prom_addr
= ndev
->board
->slot_addr
+ APPLE_SONIC_PROM_BASE
;
458 sonic_dcr
= SONIC_DCR_EXBUS
| SONIC_DCR_RFT1
| SONIC_DCR_TFT0
|
459 SONIC_DCR_PO1
| SONIC_DCR_BMS
;
461 dma_bitmode
= SONIC_BITMODE16
;
463 case MACSONIC_DAYNALINK
:
464 base_addr
= ndev
->board
->slot_addr
+ APPLE_SONIC_REGISTERS
;
465 prom_addr
= ndev
->board
->slot_addr
+ DAYNALINK_PROM_BASE
;
466 sonic_dcr
= SONIC_DCR_RFT1
| SONIC_DCR_TFT0
|
467 SONIC_DCR_PO1
| SONIC_DCR_BMS
;
469 dma_bitmode
= SONIC_BITMODE16
;
472 base_addr
= ndev
->board
->slot_addr
+ DAYNA_SONIC_REGISTERS
;
473 prom_addr
= ndev
->board
->slot_addr
+ DAYNA_SONIC_MAC_ADDR
;
474 sonic_dcr
= SONIC_DCR_BMS
|
475 SONIC_DCR_RFT1
| SONIC_DCR_TFT0
| SONIC_DCR_PO1
;
477 dma_bitmode
= SONIC_BITMODE16
;
480 printk(KERN_ERR
"macsonic: WTF, id is %d\n", id
);
484 /* Danger! My arms are flailing wildly! You *must* set lp->reg_offset
485 * and dev->base_addr before using SONIC_READ() or SONIC_WRITE() */
486 dev
->base_addr
= base_addr
;
487 lp
->reg_offset
= reg_offset
;
488 lp
->dma_bitmode
= dma_bitmode
;
489 dev
->irq
= SLOT2IRQ(ndev
->board
->slot
);
491 if (!sonic_version_printed
) {
492 printk(KERN_INFO
"%s", version
);
493 sonic_version_printed
= 1;
495 printk(KERN_INFO
"%s: %s in slot %X\n",
496 lp
->device
->bus_id
, ndev
->board
->name
, ndev
->board
->slot
);
497 printk(KERN_INFO
"%s: revision 0x%04x, using %d bit DMA and register offset %d\n",
498 lp
->device
->bus_id
, SONIC_READ(SONIC_SR
), dma_bitmode
?32:16, reg_offset
);
500 #if 0 /* This is sometimes useful to find out how MacOS configured the card. */
501 printk(KERN_INFO
"%s: DCR: 0x%04x, DCR2: 0x%04x\n", lp
->device
->bus_id
,
502 SONIC_READ(SONIC_DCR
) & 0xffff, SONIC_READ(SONIC_DCR2
) & 0xffff);
505 /* Software reset, then initialize control registers. */
506 SONIC_WRITE(SONIC_CMD
, SONIC_CR_RST
);
507 SONIC_WRITE(SONIC_DCR
, sonic_dcr
| (dma_bitmode
? SONIC_DCR_DW
: 0));
508 /* This *must* be written back to in order to restore the
509 * extended programmable output bits, since it may not have been
510 * initialised since the hardware reset. */
511 SONIC_WRITE(SONIC_DCR2
, 0);
513 /* Clear *and* disable interrupts to be on the safe side */
514 SONIC_WRITE(SONIC_IMR
, 0);
515 SONIC_WRITE(SONIC_ISR
, 0x7fff);
517 /* Now look for the MAC address. */
518 if (mac_nubus_sonic_ethernet_addr(dev
, prom_addr
, id
) != 0)
521 /* Shared init code */
522 return macsonic_init(dev
);
525 static int __init
mac_sonic_probe(struct platform_device
*device
)
527 struct net_device
*dev
;
528 struct sonic_local
*lp
;
532 dev
= alloc_etherdev(sizeof(struct sonic_local
));
536 lp
= netdev_priv(dev
);
537 lp
->device
= &device
->dev
;
538 SET_NETDEV_DEV(dev
, &device
->dev
);
539 SET_MODULE_OWNER(dev
);
541 /* This will catch fatal stuff like -ENOMEM as well as success */
542 err
= mac_onboard_sonic_probe(dev
);
547 err
= mac_nubus_sonic_probe(dev
);
551 err
= register_netdev(dev
);
555 printk("%s: MAC ", dev
->name
);
556 for (i
= 0; i
< 6; i
++) {
557 printk("%2.2x", dev
->dev_addr
[i
]);
561 printk(" IRQ %d\n", dev
->irq
);
571 MODULE_DESCRIPTION("Macintosh SONIC ethernet driver");
572 module_param(sonic_debug
, int, 0);
573 MODULE_PARM_DESC(sonic_debug
, "macsonic debug level (1-4)");
575 #define SONIC_IRQ_FLAG IRQ_FLG_FAST
579 static int __devexit
mac_sonic_device_remove (struct platform_device
*device
)
581 struct net_device
*dev
= platform_get_drvdata(device
);
582 struct sonic_local
* lp
= netdev_priv(dev
);
584 unregister_netdev (dev
);
585 dma_free_coherent(lp
->device
, SIZEOF_SONIC_DESC
* SONIC_BUS_SCALE(lp
->dma_bitmode
),
586 lp
->descriptors
, lp
->descriptors_laddr
);
592 static struct platform_driver mac_sonic_driver
= {
593 .probe
= mac_sonic_probe
,
594 .remove
= __devexit_p(mac_sonic_device_remove
),
596 .name
= mac_sonic_string
,
600 static int __init
mac_sonic_init_module(void)
604 if ((err
= platform_driver_register(&mac_sonic_driver
))) {
605 printk(KERN_ERR
"Driver registration failed\n");
609 mac_sonic_device
= platform_device_alloc(mac_sonic_string
, 0);
610 if (!mac_sonic_device
) {
614 if (platform_device_add(mac_sonic_device
)) {
615 platform_device_put(mac_sonic_device
);
616 mac_sonic_device
= NULL
;
622 platform_driver_unregister(&mac_sonic_driver
);
627 static void __exit
mac_sonic_cleanup_module(void)
629 platform_driver_unregister(&mac_sonic_driver
);
631 if (mac_sonic_device
) {
632 platform_device_unregister(mac_sonic_device
);
633 mac_sonic_device
= NULL
;
637 module_init(mac_sonic_init_module
);
638 module_exit(mac_sonic_cleanup_module
);