1 /*
2  * macsonic.c
3  *
4  * (C) 2005 Finn Thain
5  *
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.
9  *
10  * (C) 1998 Alan Cox
11  *
12  * Debugging Andreas Ehliar, Michael Schmitz
13  *
14  * Based on code
15  * (C) 1996 by Thomas Bogendoerfer (tsbogend@bigbug.franken.de)
16  *
17  * This driver is based on work from Andreas Busse, but most of
18  * the code is rewritten.
19  *
20  * (C) 1995 by Andreas Busse (andy@waldorf-gmbh.de)
21  *
22  * A driver for the Mac onboard Sonic ethernet chip.
23  *
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.
27  *
28  * 99/01/03 MSch: upgraded to version 0.92 of the core driver, fixed.
29  *
30  * 00/10/31 sammy@oh.verio.com: Updated driver for 2.4 kernels, fixed problems
31  *          on centris.
32  */
33 
34 #include <linux/kernel.h>
35 #include <linux/module.h>
36 #include <linux/types.h>
37 #include <linux/fcntl.h>
38 #include <linux/gfp.h>
39 #include <linux/interrupt.h>
40 #include <linux/ioport.h>
41 #include <linux/in.h>
42 #include <linux/string.h>
43 #include <linux/delay.h>
44 #include <linux/nubus.h>
45 #include <linux/errno.h>
46 #include <linux/netdevice.h>
47 #include <linux/etherdevice.h>
48 #include <linux/skbuff.h>
49 #include <linux/platform_device.h>
50 #include <linux/dma-mapping.h>
51 #include <linux/bitrev.h>
52 #include <linux/slab.h>
53 
54 #include <asm/pgtable.h>
55 #include <asm/io.h>
56 #include <asm/hwtest.h>
57 #include <asm/dma.h>
58 #include <asm/macintosh.h>
59 #include <asm/macints.h>
60 #include <asm/mac_via.h>
61 
62 static char mac_sonic_string[] = "macsonic";
63 
64 #include "sonic.h"
65 
66 /* These should basically be bus-size and endian independent (since
67    the SONIC is at least smart enough that it uses the same endianness
68    as the host, unlike certain less enlightened Macintosh NICs) */
69 #define SONIC_READ(reg) (nubus_readw(dev->base_addr + (reg * 4) \
70 	      + lp->reg_offset))
71 #define SONIC_WRITE(reg,val) (nubus_writew(val, dev->base_addr + (reg * 4) \
72 	      + lp->reg_offset))
73 
74 /* use 0 for production, 1 for verification, >1 for debug */
75 #ifdef SONIC_DEBUG
76 static unsigned int sonic_debug = SONIC_DEBUG;
77 #else
78 static unsigned int sonic_debug = 1;
79 #endif
80 
81 static int sonic_version_printed;
82 
83 /* For onboard SONIC */
84 #define ONBOARD_SONIC_REGISTERS	0x50F0A000
85 #define ONBOARD_SONIC_PROM_BASE	0x50f08000
86 
87 enum macsonic_type {
88 	MACSONIC_DUODOCK,
89 	MACSONIC_APPLE,
90 	MACSONIC_APPLE16,
91 	MACSONIC_DAYNA,
92 	MACSONIC_DAYNALINK
93 };
94 
95 /* For the built-in SONIC in the Duo Dock */
96 #define DUODOCK_SONIC_REGISTERS 0xe10000
97 #define DUODOCK_SONIC_PROM_BASE 0xe12000
98 
99 /* For Apple-style NuBus SONIC */
100 #define APPLE_SONIC_REGISTERS	0
101 #define APPLE_SONIC_PROM_BASE	0x40000
102 
103 /* Daynalink LC SONIC */
104 #define DAYNALINK_PROM_BASE 0x400000
105 
106 /* For Dayna-style NuBus SONIC (haven't seen one yet) */
107 #define DAYNA_SONIC_REGISTERS   0x180000
108 /* This is what OpenBSD says.  However, this is definitely in NuBus
109    ROM space so we should be able to get it by walking the NuBus
110    resource directories */
111 #define DAYNA_SONIC_MAC_ADDR	0xffe004
112 
113 #define SONIC_READ_PROM(addr) nubus_readb(prom_addr+addr)
114 
115 /*
116  * For reversing the PROM address
117  */
118 
119 static inline void bit_reverse_addr(unsigned char addr[6])
120 {
121 	int i;
122 
123 	for(i = 0; i < 6; i++)
124 		addr[i] = bitrev8(addr[i]);
125 }
126 
127 static irqreturn_t macsonic_interrupt(int irq, void *dev_id)
128 {
129 	irqreturn_t result;
130 	unsigned long flags;
131 
132 	local_irq_save(flags);
133 	result = sonic_interrupt(irq, dev_id);
134 	local_irq_restore(flags);
135 	return result;
136 }
137 
138 static int macsonic_open(struct net_device* dev)
139 {
140 	int retval;
141 
142 	retval = request_irq(dev->irq, sonic_interrupt, 0, "sonic", dev);
143 	if (retval) {
144 		printk(KERN_ERR "%s: unable to get IRQ %d.\n",
145 				dev->name, dev->irq);
146 		goto err;
147 	}
148 	/* Under the A/UX interrupt scheme, the onboard SONIC interrupt comes
149 	 * in at priority level 3. However, we sometimes get the level 2 inter-
150 	 * rupt as well, which must prevent re-entrance of the sonic handler.
151 	 */
152 	if (dev->irq == IRQ_AUTO_3) {
153 		retval = request_irq(IRQ_NUBUS_9, macsonic_interrupt, 0,
154 				     "sonic", dev);
155 		if (retval) {
156 			printk(KERN_ERR "%s: unable to get IRQ %d.\n",
157 					dev->name, IRQ_NUBUS_9);
158 			goto err_irq;
159 		}
160 	}
161 	retval = sonic_open(dev);
162 	if (retval)
163 		goto err_irq_nubus;
164 	return 0;
165 
166 err_irq_nubus:
167 	if (dev->irq == IRQ_AUTO_3)
168 		free_irq(IRQ_NUBUS_9, dev);
169 err_irq:
170 	free_irq(dev->irq, dev);
171 err:
172 	return retval;
173 }
174 
175 static int macsonic_close(struct net_device* dev)
176 {
177 	int err;
178 	err = sonic_close(dev);
179 	free_irq(dev->irq, dev);
180 	if (dev->irq == IRQ_AUTO_3)
181 		free_irq(IRQ_NUBUS_9, dev);
182 	return err;
183 }
184 
185 static const struct net_device_ops macsonic_netdev_ops = {
186 	.ndo_open		= macsonic_open,
187 	.ndo_stop		= macsonic_close,
188 	.ndo_start_xmit		= sonic_send_packet,
189 	.ndo_set_rx_mode	= sonic_multicast_list,
190 	.ndo_tx_timeout		= sonic_tx_timeout,
191 	.ndo_get_stats		= sonic_get_stats,
192 	.ndo_validate_addr	= eth_validate_addr,
193 	.ndo_change_mtu		= eth_change_mtu,
194 	.ndo_set_mac_address	= eth_mac_addr,
195 };
196 
197 static int macsonic_init(struct net_device *dev)
198 {
199 	struct sonic_local* lp = netdev_priv(dev);
200 
201 	/* Allocate the entire chunk of memory for the descriptors.
202            Note that this cannot cross a 64K boundary. */
203 	lp->descriptors = dma_alloc_coherent(lp->device,
204 					     SIZEOF_SONIC_DESC *
205 					     SONIC_BUS_SCALE(lp->dma_bitmode),
206 					     &lp->descriptors_laddr,
207 					     GFP_KERNEL);
208 	if (lp->descriptors == NULL)
209 		return -ENOMEM;
210 
211 	/* Now set up the pointers to point to the appropriate places */
212 	lp->cda = lp->descriptors;
213 	lp->tda = lp->cda + (SIZEOF_SONIC_CDA
214 	                     * SONIC_BUS_SCALE(lp->dma_bitmode));
215 	lp->rda = lp->tda + (SIZEOF_SONIC_TD * SONIC_NUM_TDS
216 	                     * SONIC_BUS_SCALE(lp->dma_bitmode));
217 	lp->rra = lp->rda + (SIZEOF_SONIC_RD * SONIC_NUM_RDS
218 	                     * SONIC_BUS_SCALE(lp->dma_bitmode));
219 
220 	lp->cda_laddr = lp->descriptors_laddr;
221 	lp->tda_laddr = lp->cda_laddr + (SIZEOF_SONIC_CDA
222 	                     * SONIC_BUS_SCALE(lp->dma_bitmode));
223 	lp->rda_laddr = lp->tda_laddr + (SIZEOF_SONIC_TD * SONIC_NUM_TDS
224 	                     * SONIC_BUS_SCALE(lp->dma_bitmode));
225 	lp->rra_laddr = lp->rda_laddr + (SIZEOF_SONIC_RD * SONIC_NUM_RDS
226 	                     * SONIC_BUS_SCALE(lp->dma_bitmode));
227 
228 	dev->netdev_ops = &macsonic_netdev_ops;
229 	dev->watchdog_timeo = TX_TIMEOUT;
230 
231 	/*
232 	 * clear tally counter
233 	 */
234 	SONIC_WRITE(SONIC_CRCT, 0xffff);
235 	SONIC_WRITE(SONIC_FAET, 0xffff);
236 	SONIC_WRITE(SONIC_MPT, 0xffff);
237 
238 	return 0;
239 }
240 
241 #define INVALID_MAC(mac) (memcmp(mac, "\x08\x00\x07", 3) && \
242                           memcmp(mac, "\x00\xA0\x40", 3) && \
243                           memcmp(mac, "\x00\x80\x19", 3) && \
244                           memcmp(mac, "\x00\x05\x02", 3))
245 
246 static void mac_onboard_sonic_ethernet_addr(struct net_device *dev)
247 {
248 	struct sonic_local *lp = netdev_priv(dev);
249 	const int prom_addr = ONBOARD_SONIC_PROM_BASE;
250 	unsigned short val;
251 
252 	/*
253 	 * On NuBus boards we can sometimes look in the ROM resources.
254 	 * No such luck for comm-slot/onboard.
255 	 * On the PowerBook 520, the PROM base address is a mystery.
256 	 */
257 	if (hwreg_present((void *)prom_addr)) {
258 		int i;
259 
260 		for (i = 0; i < 6; i++)
261 			dev->dev_addr[i] = SONIC_READ_PROM(i);
262 		if (!INVALID_MAC(dev->dev_addr))
263 			return;
264 
265 		/*
266 		 * Most of the time, the address is bit-reversed. The NetBSD
267 		 * source has a rather long and detailed historical account of
268 		 * why this is so.
269 		 */
270 		bit_reverse_addr(dev->dev_addr);
271 		if (!INVALID_MAC(dev->dev_addr))
272 			return;
273 
274 		/*
275 		 * If we still have what seems to be a bogus address, we'll
276 		 * look in the CAM. The top entry should be ours.
277 		 */
278 		printk(KERN_WARNING "macsonic: MAC address in PROM seems "
279 		                    "to be invalid, trying CAM\n");
280 	} else {
281 		printk(KERN_WARNING "macsonic: cannot read MAC address from "
282 		                    "PROM, trying CAM\n");
283 	}
284 
285 	/* This only works if MacOS has already initialized the card. */
286 
287 	SONIC_WRITE(SONIC_CMD, SONIC_CR_RST);
288 	SONIC_WRITE(SONIC_CEP, 15);
289 
290 	val = SONIC_READ(SONIC_CAP2);
291 	dev->dev_addr[5] = val >> 8;
292 	dev->dev_addr[4] = val & 0xff;
293 	val = SONIC_READ(SONIC_CAP1);
294 	dev->dev_addr[3] = val >> 8;
295 	dev->dev_addr[2] = val & 0xff;
296 	val = SONIC_READ(SONIC_CAP0);
297 	dev->dev_addr[1] = val >> 8;
298 	dev->dev_addr[0] = val & 0xff;
299 
300 	if (!INVALID_MAC(dev->dev_addr))
301 		return;
302 
303 	/* Still nonsense ... messed up someplace! */
304 
305 	printk(KERN_WARNING "macsonic: MAC address in CAM entry 15 "
306 	                    "seems invalid, will use a random MAC\n");
307 	eth_hw_addr_random(dev);
308 }
309 
310 static int mac_onboard_sonic_probe(struct net_device *dev)
311 {
312 	struct sonic_local* lp = netdev_priv(dev);
313 	int sr;
314 	int commslot = 0;
315 
316 	if (!MACH_IS_MAC)
317 		return -ENODEV;
318 
319 	printk(KERN_INFO "Checking for internal Macintosh ethernet (SONIC).. ");
320 
321 	/* Bogus probing, on the models which may or may not have
322 	   Ethernet (BTW, the Ethernet *is* always at the same
323 	   address, and nothing else lives there, at least if Apple's
324 	   documentation is to be believed) */
325 	if (macintosh_config->ident == MAC_MODEL_Q630 ||
326 	    macintosh_config->ident == MAC_MODEL_P588 ||
327 	    macintosh_config->ident == MAC_MODEL_P575 ||
328 	    macintosh_config->ident == MAC_MODEL_C610) {
329 		unsigned long flags;
330 		int card_present;
331 
332 		local_irq_save(flags);
333 		card_present = hwreg_present((void*)ONBOARD_SONIC_REGISTERS);
334 		local_irq_restore(flags);
335 
336 		if (!card_present) {
337 			printk("none.\n");
338 			return -ENODEV;
339 		}
340 		commslot = 1;
341 	}
342 
343 	printk("yes\n");
344 
345 	/* Danger!  My arms are flailing wildly!  You *must* set lp->reg_offset
346 	 * and dev->base_addr before using SONIC_READ() or SONIC_WRITE() */
347 	dev->base_addr = ONBOARD_SONIC_REGISTERS;
348 	if (via_alt_mapping)
349 		dev->irq = IRQ_AUTO_3;
350 	else
351 		dev->irq = IRQ_NUBUS_9;
352 
353 	if (!sonic_version_printed) {
354 		printk(KERN_INFO "%s", version);
355 		sonic_version_printed = 1;
356 	}
357 	printk(KERN_INFO "%s: onboard / comm-slot SONIC at 0x%08lx\n",
358 	       dev_name(lp->device), dev->base_addr);
359 
360 	/* The PowerBook's SONIC is 16 bit always. */
361 	if (macintosh_config->ident == MAC_MODEL_PB520) {
362 		lp->reg_offset = 0;
363 		lp->dma_bitmode = SONIC_BITMODE16;
364 		sr = SONIC_READ(SONIC_SR);
365 	} else if (commslot) {
366 		/* Some of the comm-slot cards are 16 bit.  But some
367 		   of them are not.  The 32-bit cards use offset 2 and
368 		   have known revisions, we try reading the revision
369 		   register at offset 2, if we don't get a known revision
370 		   we assume 16 bit at offset 0.  */
371 		lp->reg_offset = 2;
372 		lp->dma_bitmode = SONIC_BITMODE16;
373 
374 		sr = SONIC_READ(SONIC_SR);
375 		if (sr == 0x0004 || sr == 0x0006 || sr == 0x0100 || sr == 0x0101)
376 			/* 83932 is 0x0004 or 0x0006, 83934 is 0x0100 or 0x0101 */
377 			lp->dma_bitmode = SONIC_BITMODE32;
378 		else {
379 			lp->dma_bitmode = SONIC_BITMODE16;
380 			lp->reg_offset = 0;
381 			sr = SONIC_READ(SONIC_SR);
382 		}
383 	} else {
384 		/* All onboard cards are at offset 2 with 32 bit DMA. */
385 		lp->reg_offset = 2;
386 		lp->dma_bitmode = SONIC_BITMODE32;
387 		sr = SONIC_READ(SONIC_SR);
388 	}
389 	printk(KERN_INFO
390 	       "%s: revision 0x%04x, using %d bit DMA and register offset %d\n",
391 	       dev_name(lp->device), sr, lp->dma_bitmode?32:16, lp->reg_offset);
392 
393 #if 0 /* This is sometimes useful to find out how MacOS configured the card. */
394 	printk(KERN_INFO "%s: DCR: 0x%04x, DCR2: 0x%04x\n", dev_name(lp->device),
395 	       SONIC_READ(SONIC_DCR) & 0xffff, SONIC_READ(SONIC_DCR2) & 0xffff);
396 #endif
397 
398 	/* Software reset, then initialize control registers. */
399 	SONIC_WRITE(SONIC_CMD, SONIC_CR_RST);
400 
401 	SONIC_WRITE(SONIC_DCR, SONIC_DCR_EXBUS | SONIC_DCR_BMS |
402 	                       SONIC_DCR_RFT1  | SONIC_DCR_TFT0 |
403 	                       (lp->dma_bitmode ? SONIC_DCR_DW : 0));
404 
405 	/* This *must* be written back to in order to restore the
406 	 * extended programmable output bits, as it may not have been
407 	 * initialised since the hardware reset. */
408 	SONIC_WRITE(SONIC_DCR2, 0);
409 
410 	/* Clear *and* disable interrupts to be on the safe side */
411 	SONIC_WRITE(SONIC_IMR, 0);
412 	SONIC_WRITE(SONIC_ISR, 0x7fff);
413 
414 	/* Now look for the MAC address. */
415 	mac_onboard_sonic_ethernet_addr(dev);
416 
417 	/* Shared init code */
418 	return macsonic_init(dev);
419 }
420 
421 static int mac_nubus_sonic_ethernet_addr(struct net_device *dev,
422 					 unsigned long prom_addr, int id)
423 {
424 	int i;
425 	for(i = 0; i < 6; i++)
426 		dev->dev_addr[i] = SONIC_READ_PROM(i);
427 
428 	/* Some of the addresses are bit-reversed */
429 	if (id != MACSONIC_DAYNA)
430 		bit_reverse_addr(dev->dev_addr);
431 
432 	return 0;
433 }
434 
435 static int macsonic_ident(struct nubus_dev *ndev)
436 {
437 	if (ndev->dr_hw == NUBUS_DRHW_ASANTE_LC &&
438 	    ndev->dr_sw == NUBUS_DRSW_SONIC_LC)
439 		return MACSONIC_DAYNALINK;
440 	if (ndev->dr_hw == NUBUS_DRHW_SONIC &&
441 	    ndev->dr_sw == NUBUS_DRSW_APPLE) {
442 		/* There has to be a better way to do this... */
443 		if (strstr(ndev->board->name, "DuoDock"))
444 			return MACSONIC_DUODOCK;
445 		else
446 			return MACSONIC_APPLE;
447 	}
448 
449 	if (ndev->dr_hw == NUBUS_DRHW_SMC9194 &&
450 	    ndev->dr_sw == NUBUS_DRSW_DAYNA)
451 		return MACSONIC_DAYNA;
452 
453 	if (ndev->dr_hw == NUBUS_DRHW_APPLE_SONIC_LC &&
454 	    ndev->dr_sw == 0) { /* huh? */
455 		return MACSONIC_APPLE16;
456 	}
457 	return -1;
458 }
459 
460 static int mac_nubus_sonic_probe(struct net_device *dev)
461 {
462 	static int slots;
463 	struct nubus_dev* ndev = NULL;
464 	struct sonic_local* lp = netdev_priv(dev);
465 	unsigned long base_addr, prom_addr;
466 	u16 sonic_dcr;
467 	int id = -1;
468 	int reg_offset, dma_bitmode;
469 
470 	/* Find the first SONIC that hasn't been initialized already */
471 	while ((ndev = nubus_find_type(NUBUS_CAT_NETWORK,
472 				       NUBUS_TYPE_ETHERNET, ndev)) != NULL)
473 	{
474 		/* Have we seen it already? */
475 		if (slots & (1<<ndev->board->slot))
476 			continue;
477 		slots |= 1<<ndev->board->slot;
478 
479 		/* Is it one of ours? */
480 		if ((id = macsonic_ident(ndev)) != -1)
481 			break;
482 	}
483 
484 	if (ndev == NULL)
485 		return -ENODEV;
486 
487 	switch (id) {
488 	case MACSONIC_DUODOCK:
489 		base_addr = ndev->board->slot_addr + DUODOCK_SONIC_REGISTERS;
490 		prom_addr = ndev->board->slot_addr + DUODOCK_SONIC_PROM_BASE;
491 		sonic_dcr = SONIC_DCR_EXBUS | SONIC_DCR_RFT0 | SONIC_DCR_RFT1 |
492 		            SONIC_DCR_TFT0;
493 		reg_offset = 2;
494 		dma_bitmode = SONIC_BITMODE32;
495 		break;
496 	case MACSONIC_APPLE:
497 		base_addr = ndev->board->slot_addr + APPLE_SONIC_REGISTERS;
498 		prom_addr = ndev->board->slot_addr + APPLE_SONIC_PROM_BASE;
499 		sonic_dcr = SONIC_DCR_BMS | SONIC_DCR_RFT1 | SONIC_DCR_TFT0;
500 		reg_offset = 0;
501 		dma_bitmode = SONIC_BITMODE32;
502 		break;
503 	case MACSONIC_APPLE16:
504 		base_addr = ndev->board->slot_addr + APPLE_SONIC_REGISTERS;
505 		prom_addr = ndev->board->slot_addr + APPLE_SONIC_PROM_BASE;
506 		sonic_dcr = SONIC_DCR_EXBUS | SONIC_DCR_RFT1 | SONIC_DCR_TFT0 |
507 		            SONIC_DCR_PO1 | SONIC_DCR_BMS;
508 		reg_offset = 0;
509 		dma_bitmode = SONIC_BITMODE16;
510 		break;
511 	case MACSONIC_DAYNALINK:
512 		base_addr = ndev->board->slot_addr + APPLE_SONIC_REGISTERS;
513 		prom_addr = ndev->board->slot_addr + DAYNALINK_PROM_BASE;
514 		sonic_dcr = SONIC_DCR_RFT1 | SONIC_DCR_TFT0 |
515 		            SONIC_DCR_PO1 | SONIC_DCR_BMS;
516 		reg_offset = 0;
517 		dma_bitmode = SONIC_BITMODE16;
518 		break;
519 	case MACSONIC_DAYNA:
520 		base_addr = ndev->board->slot_addr + DAYNA_SONIC_REGISTERS;
521 		prom_addr = ndev->board->slot_addr + DAYNA_SONIC_MAC_ADDR;
522 		sonic_dcr = SONIC_DCR_BMS |
523 		            SONIC_DCR_RFT1 | SONIC_DCR_TFT0 | SONIC_DCR_PO1;
524 		reg_offset = 0;
525 		dma_bitmode = SONIC_BITMODE16;
526 		break;
527 	default:
528 		printk(KERN_ERR "macsonic: WTF, id is %d\n", id);
529 		return -ENODEV;
530 	}
531 
532 	/* Danger!  My arms are flailing wildly!  You *must* set lp->reg_offset
533 	 * and dev->base_addr before using SONIC_READ() or SONIC_WRITE() */
534 	dev->base_addr = base_addr;
535 	lp->reg_offset = reg_offset;
536 	lp->dma_bitmode = dma_bitmode;
537 	dev->irq = SLOT2IRQ(ndev->board->slot);
538 
539 	if (!sonic_version_printed) {
540 		printk(KERN_INFO "%s", version);
541 		sonic_version_printed = 1;
542 	}
543 	printk(KERN_INFO "%s: %s in slot %X\n",
544 	       dev_name(lp->device), ndev->board->name, ndev->board->slot);
545 	printk(KERN_INFO "%s: revision 0x%04x, using %d bit DMA and register offset %d\n",
546 	       dev_name(lp->device), SONIC_READ(SONIC_SR), dma_bitmode?32:16, reg_offset);
547 
548 #if 0 /* This is sometimes useful to find out how MacOS configured the card. */
549 	printk(KERN_INFO "%s: DCR: 0x%04x, DCR2: 0x%04x\n", dev_name(lp->device),
550 	       SONIC_READ(SONIC_DCR) & 0xffff, SONIC_READ(SONIC_DCR2) & 0xffff);
551 #endif
552 
553 	/* Software reset, then initialize control registers. */
554 	SONIC_WRITE(SONIC_CMD, SONIC_CR_RST);
555 	SONIC_WRITE(SONIC_DCR, sonic_dcr | (dma_bitmode ? SONIC_DCR_DW : 0));
556 	/* This *must* be written back to in order to restore the
557 	 * extended programmable output bits, since it may not have been
558 	 * initialised since the hardware reset. */
559 	SONIC_WRITE(SONIC_DCR2, 0);
560 
561 	/* Clear *and* disable interrupts to be on the safe side */
562 	SONIC_WRITE(SONIC_IMR, 0);
563 	SONIC_WRITE(SONIC_ISR, 0x7fff);
564 
565 	/* Now look for the MAC address. */
566 	if (mac_nubus_sonic_ethernet_addr(dev, prom_addr, id) != 0)
567 		return -ENODEV;
568 
569 	/* Shared init code */
570 	return macsonic_init(dev);
571 }
572 
573 static int mac_sonic_probe(struct platform_device *pdev)
574 {
575 	struct net_device *dev;
576 	struct sonic_local *lp;
577 	int err;
578 
579 	dev = alloc_etherdev(sizeof(struct sonic_local));
580 	if (!dev)
581 		return -ENOMEM;
582 
583 	lp = netdev_priv(dev);
584 	lp->device = &pdev->dev;
585 	SET_NETDEV_DEV(dev, &pdev->dev);
586 	platform_set_drvdata(pdev, dev);
587 
588 	/* This will catch fatal stuff like -ENOMEM as well as success */
589 	err = mac_onboard_sonic_probe(dev);
590 	if (err == 0)
591 		goto found;
592 	if (err != -ENODEV)
593 		goto out;
594 	err = mac_nubus_sonic_probe(dev);
595 	if (err)
596 		goto out;
597 found:
598 	err = register_netdev(dev);
599 	if (err)
600 		goto out;
601 
602 	printk("%s: MAC %pM IRQ %d\n", dev->name, dev->dev_addr, dev->irq);
603 
604 	return 0;
605 
606 out:
607 	free_netdev(dev);
608 
609 	return err;
610 }
611 
612 MODULE_DESCRIPTION("Macintosh SONIC ethernet driver");
613 module_param(sonic_debug, int, 0);
614 MODULE_PARM_DESC(sonic_debug, "macsonic debug level (1-4)");
615 MODULE_ALIAS("platform:macsonic");
616 
617 #include "sonic.c"
618 
619 static int mac_sonic_device_remove(struct platform_device *pdev)
620 {
621 	struct net_device *dev = platform_get_drvdata(pdev);
622 	struct sonic_local* lp = netdev_priv(dev);
623 
624 	unregister_netdev(dev);
625 	dma_free_coherent(lp->device, SIZEOF_SONIC_DESC * SONIC_BUS_SCALE(lp->dma_bitmode),
626 	                  lp->descriptors, lp->descriptors_laddr);
627 	free_netdev(dev);
628 
629 	return 0;
630 }
631 
632 static struct platform_driver mac_sonic_driver = {
633 	.probe  = mac_sonic_probe,
634 	.remove = mac_sonic_device_remove,
635 	.driver	= {
636 		.name	= mac_sonic_string,
637 		.owner	= THIS_MODULE,
638 	},
639 };
640 
641 module_platform_driver(mac_sonic_driver);
642