650 lines · c
1// SPDX-License-Identifier: GPL-2.02/*3 * macsonic.c4 *5 * (C) 2005 Finn Thain6 *7 * Converted to DMA API, converted to unified driver model, made it work as8 * a module again, and from the mac68k project, introduced more 32-bit cards9 * and dhd's support for 16-bit cards.10 *11 * (C) 1998 Alan Cox12 *13 * Debugging Andreas Ehliar, Michael Schmitz14 *15 * Based on code16 * (C) 1996 by Thomas Bogendoerfer (tsbogend@bigbug.franken.de)17 *18 * This driver is based on work from Andreas Busse, but most of19 * the code is rewritten.20 *21 * (C) 1995 by Andreas Busse (andy@waldorf-gmbh.de)22 *23 * A driver for the Mac onboard Sonic ethernet chip.24 *25 * 98/12/21 MSch: judged from tests on Q800, it's basically working,26 * but eating up both receive and transmit resources27 * and duplicating packets. Needs more testing.28 *29 * 99/01/03 MSch: upgraded to version 0.92 of the core driver, fixed.30 *31 * 00/10/31 sammy@oh.verio.com: Updated driver for 2.4 kernels, fixed problems32 * on centris.33 */34 35#include <linux/kernel.h>36#include <linux/module.h>37#include <linux/types.h>38#include <linux/fcntl.h>39#include <linux/gfp.h>40#include <linux/interrupt.h>41#include <linux/ioport.h>42#include <linux/in.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>53#include <linux/slab.h>54#include <linux/pgtable.h>55 56#include <asm/io.h>57#include <asm/hwtest.h>58#include <asm/dma.h>59#include <asm/macintosh.h>60#include <asm/macints.h>61#include <asm/mac_via.h>62 63#include "sonic.h"64 65/* These should basically be bus-size and endian independent (since66 the SONIC is at least smart enough that it uses the same endianness67 as the host, unlike certain less enlightened Macintosh NICs) */68#define SONIC_READ(reg) (nubus_readw(dev->base_addr + (reg * 4) \69 + lp->reg_offset))70#define SONIC_WRITE(reg,val) (nubus_writew(val, dev->base_addr + (reg * 4) \71 + lp->reg_offset))72 73/* For onboard SONIC */74#define ONBOARD_SONIC_REGISTERS 0x50F0A00075#define ONBOARD_SONIC_PROM_BASE 0x50f0800076 77enum macsonic_type {78 MACSONIC_DUODOCK,79 MACSONIC_APPLE,80 MACSONIC_APPLE16,81 MACSONIC_DAYNA,82 MACSONIC_DAYNALINK83};84 85/* For the built-in SONIC in the Duo Dock */86#define DUODOCK_SONIC_REGISTERS 0xe1000087#define DUODOCK_SONIC_PROM_BASE 0xe1200088 89/* For Apple-style NuBus SONIC */90#define APPLE_SONIC_REGISTERS 091#define APPLE_SONIC_PROM_BASE 0x4000092 93/* Daynalink LC SONIC */94#define DAYNALINK_PROM_BASE 0x40000095 96/* For Dayna-style NuBus SONIC (haven't seen one yet) */97#define DAYNA_SONIC_REGISTERS 0x18000098/* This is what OpenBSD says. However, this is definitely in NuBus99 ROM space so we should be able to get it by walking the NuBus100 resource directories */101#define DAYNA_SONIC_MAC_ADDR 0xffe004102 103#define SONIC_READ_PROM(addr) nubus_readb(prom_addr+addr)104 105/*106 * For reversing the PROM address107 */108 109static inline void bit_reverse_addr(unsigned char addr[6])110{111 int i;112 113 for(i = 0; i < 6; i++)114 addr[i] = bitrev8(addr[i]);115}116 117static int macsonic_open(struct net_device* dev)118{119 int retval;120 121 retval = request_irq(dev->irq, sonic_interrupt, 0, "sonic", dev);122 if (retval) {123 printk(KERN_ERR "%s: unable to get IRQ %d.\n",124 dev->name, dev->irq);125 goto err;126 }127 /* Under the A/UX interrupt scheme, the onboard SONIC interrupt gets128 * moved from level 2 to level 3. Unfortunately we still get some129 * level 2 interrupts so register the handler for both.130 */131 if (dev->irq == IRQ_AUTO_3) {132 retval = request_irq(IRQ_NUBUS_9, sonic_interrupt, 0,133 "sonic", dev);134 if (retval) {135 printk(KERN_ERR "%s: unable to get IRQ %d.\n",136 dev->name, IRQ_NUBUS_9);137 goto err_irq;138 }139 }140 retval = sonic_open(dev);141 if (retval)142 goto err_irq_nubus;143 return 0;144 145err_irq_nubus:146 if (dev->irq == IRQ_AUTO_3)147 free_irq(IRQ_NUBUS_9, dev);148err_irq:149 free_irq(dev->irq, dev);150err:151 return retval;152}153 154static int macsonic_close(struct net_device* dev)155{156 int err;157 err = sonic_close(dev);158 free_irq(dev->irq, dev);159 if (dev->irq == IRQ_AUTO_3)160 free_irq(IRQ_NUBUS_9, dev);161 return err;162}163 164static const struct net_device_ops macsonic_netdev_ops = {165 .ndo_open = macsonic_open,166 .ndo_stop = macsonic_close,167 .ndo_start_xmit = sonic_send_packet,168 .ndo_set_rx_mode = sonic_multicast_list,169 .ndo_tx_timeout = sonic_tx_timeout,170 .ndo_get_stats = sonic_get_stats,171 .ndo_validate_addr = eth_validate_addr,172 .ndo_set_mac_address = eth_mac_addr,173};174 175static int macsonic_init(struct net_device *dev)176{177 struct sonic_local* lp = netdev_priv(dev);178 int err = sonic_alloc_descriptors(dev);179 180 if (err)181 return err;182 183 dev->netdev_ops = &macsonic_netdev_ops;184 dev->watchdog_timeo = TX_TIMEOUT;185 186 /*187 * clear tally counter188 */189 SONIC_WRITE(SONIC_CRCT, 0xffff);190 SONIC_WRITE(SONIC_FAET, 0xffff);191 SONIC_WRITE(SONIC_MPT, 0xffff);192 193 return 0;194}195 196#define INVALID_MAC(mac) (memcmp(mac, "\x08\x00\x07", 3) && \197 memcmp(mac, "\x00\xA0\x40", 3) && \198 memcmp(mac, "\x00\x80\x19", 3) && \199 memcmp(mac, "\x00\x05\x02", 3))200 201static void mac_onboard_sonic_ethernet_addr(struct net_device *dev)202{203 struct sonic_local *lp = netdev_priv(dev);204 const int prom_addr = ONBOARD_SONIC_PROM_BASE;205 unsigned short val;206 u8 addr[ETH_ALEN];207 208 /*209 * On NuBus boards we can sometimes look in the ROM resources.210 * No such luck for comm-slot/onboard.211 * On the PowerBook 520, the PROM base address is a mystery.212 */213 if (hwreg_present((void *)prom_addr)) {214 int i;215 216 for (i = 0; i < 6; i++)217 addr[i] = SONIC_READ_PROM(i);218 eth_hw_addr_set(dev, addr);219 if (!INVALID_MAC(dev->dev_addr))220 return;221 222 /*223 * Most of the time, the address is bit-reversed. The NetBSD224 * source has a rather long and detailed historical account of225 * why this is so.226 */227 bit_reverse_addr(addr);228 eth_hw_addr_set(dev, addr);229 if (!INVALID_MAC(dev->dev_addr))230 return;231 232 /*233 * If we still have what seems to be a bogus address, we'll234 * look in the CAM. The top entry should be ours.235 */236 printk(KERN_WARNING "macsonic: MAC address in PROM seems "237 "to be invalid, trying CAM\n");238 } else {239 printk(KERN_WARNING "macsonic: cannot read MAC address from "240 "PROM, trying CAM\n");241 }242 243 /* This only works if MacOS has already initialized the card. */244 245 SONIC_WRITE(SONIC_CMD, SONIC_CR_RST);246 SONIC_WRITE(SONIC_CEP, 15);247 248 val = SONIC_READ(SONIC_CAP2);249 addr[5] = val >> 8;250 addr[4] = val & 0xff;251 val = SONIC_READ(SONIC_CAP1);252 addr[3] = val >> 8;253 addr[2] = val & 0xff;254 val = SONIC_READ(SONIC_CAP0);255 addr[1] = val >> 8;256 addr[0] = val & 0xff;257 eth_hw_addr_set(dev, addr);258 259 if (!INVALID_MAC(dev->dev_addr))260 return;261 262 /* Still nonsense ... messed up someplace! */263 264 printk(KERN_WARNING "macsonic: MAC address in CAM entry 15 "265 "seems invalid, will use a random MAC\n");266 eth_hw_addr_random(dev);267}268 269static int mac_onboard_sonic_probe(struct net_device *dev)270{271 struct sonic_local* lp = netdev_priv(dev);272 int sr;273 bool commslot = macintosh_config->expansion_type == MAC_EXP_PDS_COMM;274 275 /* Bogus probing, on the models which may or may not have276 Ethernet (BTW, the Ethernet *is* always at the same277 address, and nothing else lives there, at least if Apple's278 documentation is to be believed) */279 if (commslot || macintosh_config->ident == MAC_MODEL_C610) {280 int card_present;281 282 card_present = hwreg_present((void*)ONBOARD_SONIC_REGISTERS);283 if (!card_present) {284 pr_info("Onboard/comm-slot SONIC not found\n");285 return -ENODEV;286 }287 }288 289 /* Danger! My arms are flailing wildly! You *must* set lp->reg_offset290 * and dev->base_addr before using SONIC_READ() or SONIC_WRITE() */291 dev->base_addr = ONBOARD_SONIC_REGISTERS;292 if (via_alt_mapping)293 dev->irq = IRQ_AUTO_3;294 else295 dev->irq = IRQ_NUBUS_9;296 297 /* The PowerBook's SONIC is 16 bit always. */298 if (macintosh_config->ident == MAC_MODEL_PB520) {299 lp->reg_offset = 0;300 lp->dma_bitmode = SONIC_BITMODE16;301 } else if (commslot) {302 /* Some of the comm-slot cards are 16 bit. But some303 of them are not. The 32-bit cards use offset 2 and304 have known revisions, we try reading the revision305 register at offset 2, if we don't get a known revision306 we assume 16 bit at offset 0. */307 lp->reg_offset = 2;308 lp->dma_bitmode = SONIC_BITMODE16;309 310 sr = SONIC_READ(SONIC_SR);311 if (sr == 0x0004 || sr == 0x0006 || sr == 0x0100 || sr == 0x0101)312 /* 83932 is 0x0004 or 0x0006, 83934 is 0x0100 or 0x0101 */313 lp->dma_bitmode = SONIC_BITMODE32;314 else {315 lp->dma_bitmode = SONIC_BITMODE16;316 lp->reg_offset = 0;317 }318 } else {319 /* All onboard cards are at offset 2 with 32 bit DMA. */320 lp->reg_offset = 2;321 lp->dma_bitmode = SONIC_BITMODE32;322 }323 324 pr_info("Onboard/comm-slot SONIC, revision 0x%04x, %d bit DMA, register offset %d\n",325 SONIC_READ(SONIC_SR), lp->dma_bitmode ? 32 : 16,326 lp->reg_offset);327 328 /* This is sometimes useful to find out how MacOS configured the card */329 pr_debug("%s: DCR=0x%04x, DCR2=0x%04x\n", __func__,330 SONIC_READ(SONIC_DCR) & 0xffff,331 SONIC_READ(SONIC_DCR2) & 0xffff);332 333 /* Software reset, then initialize control registers. */334 SONIC_WRITE(SONIC_CMD, SONIC_CR_RST);335 336 SONIC_WRITE(SONIC_DCR, SONIC_DCR_EXBUS | SONIC_DCR_BMS |337 SONIC_DCR_RFT1 | SONIC_DCR_TFT0 |338 (lp->dma_bitmode ? SONIC_DCR_DW : 0));339 340 /* This *must* be written back to in order to restore the341 * extended programmable output bits, as it may not have been342 * initialised since the hardware reset. */343 SONIC_WRITE(SONIC_DCR2, 0);344 345 /* Clear *and* disable interrupts to be on the safe side */346 SONIC_WRITE(SONIC_IMR, 0);347 SONIC_WRITE(SONIC_ISR, 0x7fff);348 349 /* Now look for the MAC address. */350 mac_onboard_sonic_ethernet_addr(dev);351 352 pr_info("SONIC ethernet @%08lx, MAC %pM, IRQ %d\n",353 dev->base_addr, dev->dev_addr, dev->irq);354 355 /* Shared init code */356 return macsonic_init(dev);357}358 359static int mac_sonic_nubus_ethernet_addr(struct net_device *dev,360 unsigned long prom_addr, int id)361{362 u8 addr[ETH_ALEN];363 int i;364 365 for(i = 0; i < 6; i++)366 addr[i] = SONIC_READ_PROM(i);367 368 /* Some of the addresses are bit-reversed */369 if (id != MACSONIC_DAYNA)370 bit_reverse_addr(addr);371 eth_hw_addr_set(dev, addr);372 373 return 0;374}375 376static int macsonic_ident(struct nubus_rsrc *fres)377{378 if (fres->dr_hw == NUBUS_DRHW_ASANTE_LC &&379 fres->dr_sw == NUBUS_DRSW_SONIC_LC)380 return MACSONIC_DAYNALINK;381 if (fres->dr_hw == NUBUS_DRHW_SONIC &&382 fres->dr_sw == NUBUS_DRSW_APPLE) {383 /* There has to be a better way to do this... */384 if (strstr(fres->board->name, "DuoDock"))385 return MACSONIC_DUODOCK;386 else387 return MACSONIC_APPLE;388 }389 390 if (fres->dr_hw == NUBUS_DRHW_SMC9194 &&391 fres->dr_sw == NUBUS_DRSW_DAYNA)392 return MACSONIC_DAYNA;393 394 if (fres->dr_hw == NUBUS_DRHW_APPLE_SONIC_LC &&395 fres->dr_sw == 0) { /* huh? */396 return MACSONIC_APPLE16;397 }398 return -1;399}400 401static int mac_sonic_nubus_probe_board(struct nubus_board *board, int id,402 struct net_device *dev)403{404 struct sonic_local* lp = netdev_priv(dev);405 unsigned long base_addr, prom_addr;406 u16 sonic_dcr;407 int reg_offset, dma_bitmode;408 409 switch (id) {410 case MACSONIC_DUODOCK:411 base_addr = board->slot_addr + DUODOCK_SONIC_REGISTERS;412 prom_addr = board->slot_addr + DUODOCK_SONIC_PROM_BASE;413 sonic_dcr = SONIC_DCR_EXBUS | SONIC_DCR_RFT0 | SONIC_DCR_RFT1 |414 SONIC_DCR_TFT0;415 reg_offset = 2;416 dma_bitmode = SONIC_BITMODE32;417 break;418 case MACSONIC_APPLE:419 base_addr = board->slot_addr + APPLE_SONIC_REGISTERS;420 prom_addr = board->slot_addr + APPLE_SONIC_PROM_BASE;421 sonic_dcr = SONIC_DCR_BMS | SONIC_DCR_RFT1 | SONIC_DCR_TFT0;422 reg_offset = 0;423 dma_bitmode = SONIC_BITMODE32;424 break;425 case MACSONIC_APPLE16:426 base_addr = board->slot_addr + APPLE_SONIC_REGISTERS;427 prom_addr = board->slot_addr + APPLE_SONIC_PROM_BASE;428 sonic_dcr = SONIC_DCR_EXBUS | SONIC_DCR_RFT1 | SONIC_DCR_TFT0 |429 SONIC_DCR_PO1 | SONIC_DCR_BMS;430 reg_offset = 0;431 dma_bitmode = SONIC_BITMODE16;432 break;433 case MACSONIC_DAYNALINK:434 base_addr = board->slot_addr + APPLE_SONIC_REGISTERS;435 prom_addr = board->slot_addr + DAYNALINK_PROM_BASE;436 sonic_dcr = SONIC_DCR_RFT1 | SONIC_DCR_TFT0 |437 SONIC_DCR_PO1 | SONIC_DCR_BMS;438 reg_offset = 0;439 dma_bitmode = SONIC_BITMODE16;440 break;441 case MACSONIC_DAYNA:442 base_addr = board->slot_addr + DAYNA_SONIC_REGISTERS;443 prom_addr = board->slot_addr + DAYNA_SONIC_MAC_ADDR;444 sonic_dcr = SONIC_DCR_BMS |445 SONIC_DCR_RFT1 | SONIC_DCR_TFT0 | SONIC_DCR_PO1;446 reg_offset = 0;447 dma_bitmode = SONIC_BITMODE16;448 break;449 default:450 printk(KERN_ERR "macsonic: WTF, id is %d\n", id);451 return -ENODEV;452 }453 454 /* Danger! My arms are flailing wildly! You *must* set lp->reg_offset455 * and dev->base_addr before using SONIC_READ() or SONIC_WRITE() */456 dev->base_addr = base_addr;457 lp->reg_offset = reg_offset;458 lp->dma_bitmode = dma_bitmode;459 dev->irq = SLOT2IRQ(board->slot);460 461 dev_info(&board->dev, "%s, revision 0x%04x, %d bit DMA, register offset %d\n",462 board->name, SONIC_READ(SONIC_SR),463 lp->dma_bitmode ? 32 : 16, lp->reg_offset);464 465 /* This is sometimes useful to find out how MacOS configured the card */466 dev_dbg(&board->dev, "%s: DCR=0x%04x, DCR2=0x%04x\n", __func__,467 SONIC_READ(SONIC_DCR) & 0xffff,468 SONIC_READ(SONIC_DCR2) & 0xffff);469 470 /* Software reset, then initialize control registers. */471 SONIC_WRITE(SONIC_CMD, SONIC_CR_RST);472 SONIC_WRITE(SONIC_DCR, sonic_dcr | (dma_bitmode ? SONIC_DCR_DW : 0));473 /* This *must* be written back to in order to restore the474 * extended programmable output bits, since it may not have been475 * initialised since the hardware reset. */476 SONIC_WRITE(SONIC_DCR2, 0);477 478 /* Clear *and* disable interrupts to be on the safe side */479 SONIC_WRITE(SONIC_IMR, 0);480 SONIC_WRITE(SONIC_ISR, 0x7fff);481 482 /* Now look for the MAC address. */483 if (mac_sonic_nubus_ethernet_addr(dev, prom_addr, id) != 0)484 return -ENODEV;485 486 dev_info(&board->dev, "SONIC ethernet @%08lx, MAC %pM, IRQ %d\n",487 dev->base_addr, dev->dev_addr, dev->irq);488 489 /* Shared init code */490 return macsonic_init(dev);491}492 493static int mac_sonic_platform_probe(struct platform_device *pdev)494{495 struct net_device *dev;496 struct sonic_local *lp;497 int err;498 499 dev = alloc_etherdev(sizeof(struct sonic_local));500 if (!dev)501 return -ENOMEM;502 503 lp = netdev_priv(dev);504 lp->device = &pdev->dev;505 SET_NETDEV_DEV(dev, &pdev->dev);506 platform_set_drvdata(pdev, dev);507 508 err = mac_onboard_sonic_probe(dev);509 if (err)510 goto out;511 512 sonic_msg_init(dev);513 514 err = register_netdev(dev);515 if (err)516 goto undo_probe;517 518 return 0;519 520undo_probe:521 dma_free_coherent(lp->device,522 SIZEOF_SONIC_DESC * SONIC_BUS_SCALE(lp->dma_bitmode),523 lp->descriptors, lp->descriptors_laddr);524out:525 free_netdev(dev);526 527 return err;528}529 530MODULE_DESCRIPTION("Macintosh SONIC ethernet driver");531MODULE_ALIAS("platform:macsonic");532 533#include "sonic.c"534 535static void mac_sonic_platform_remove(struct platform_device *pdev)536{537 struct net_device *dev = platform_get_drvdata(pdev);538 struct sonic_local* lp = netdev_priv(dev);539 540 unregister_netdev(dev);541 dma_free_coherent(lp->device, SIZEOF_SONIC_DESC * SONIC_BUS_SCALE(lp->dma_bitmode),542 lp->descriptors, lp->descriptors_laddr);543 free_netdev(dev);544}545 546static struct platform_driver mac_sonic_platform_driver = {547 .probe = mac_sonic_platform_probe,548 .remove_new = mac_sonic_platform_remove,549 .driver = {550 .name = "macsonic",551 },552};553 554static int mac_sonic_nubus_probe(struct nubus_board *board)555{556 struct net_device *ndev;557 struct sonic_local *lp;558 struct nubus_rsrc *fres;559 int id = -1;560 int err;561 562 /* The platform driver will handle a PDS or Comm Slot card (even if563 * it has a pseudoslot declaration ROM).564 */565 if (macintosh_config->expansion_type == MAC_EXP_PDS_COMM)566 return -ENODEV;567 568 for_each_board_func_rsrc(board, fres) {569 if (fres->category != NUBUS_CAT_NETWORK ||570 fres->type != NUBUS_TYPE_ETHERNET)571 continue;572 573 id = macsonic_ident(fres);574 if (id != -1)575 break;576 }577 if (!fres)578 return -ENODEV;579 580 ndev = alloc_etherdev(sizeof(struct sonic_local));581 if (!ndev)582 return -ENOMEM;583 584 lp = netdev_priv(ndev);585 lp->device = &board->dev;586 SET_NETDEV_DEV(ndev, &board->dev);587 588 err = mac_sonic_nubus_probe_board(board, id, ndev);589 if (err)590 goto out;591 592 sonic_msg_init(ndev);593 594 err = register_netdev(ndev);595 if (err)596 goto undo_probe;597 598 nubus_set_drvdata(board, ndev);599 600 return 0;601 602undo_probe:603 dma_free_coherent(lp->device,604 SIZEOF_SONIC_DESC * SONIC_BUS_SCALE(lp->dma_bitmode),605 lp->descriptors, lp->descriptors_laddr);606out:607 free_netdev(ndev);608 return err;609}610 611static void mac_sonic_nubus_remove(struct nubus_board *board)612{613 struct net_device *ndev = nubus_get_drvdata(board);614 struct sonic_local *lp = netdev_priv(ndev);615 616 unregister_netdev(ndev);617 dma_free_coherent(lp->device,618 SIZEOF_SONIC_DESC * SONIC_BUS_SCALE(lp->dma_bitmode),619 lp->descriptors, lp->descriptors_laddr);620 free_netdev(ndev);621}622 623static struct nubus_driver mac_sonic_nubus_driver = {624 .probe = mac_sonic_nubus_probe,625 .remove = mac_sonic_nubus_remove,626 .driver = {627 .name = "macsonic-nubus",628 .owner = THIS_MODULE,629 },630};631 632static int perr, nerr;633 634static int __init mac_sonic_init(void)635{636 perr = platform_driver_register(&mac_sonic_platform_driver);637 nerr = nubus_driver_register(&mac_sonic_nubus_driver);638 return 0;639}640module_init(mac_sonic_init);641 642static void __exit mac_sonic_exit(void)643{644 if (!perr)645 platform_driver_unregister(&mac_sonic_platform_driver);646 if (!nerr)647 nubus_driver_unregister(&mac_sonic_nubus_driver);648}649module_exit(mac_sonic_exit);650