/drivers/net/ethernet/natsemi/macsonic.c
C | 638 lines | 430 code | 101 blank | 107 comment | 75 complexity | e5dce86b58ab9a19a858a42d63e60101 MD5 | raw file
1// SPDX-License-Identifier: GPL-2.0 2/* 3 * macsonic.c 4 * 5 * (C) 2005 Finn Thain 6 * 7 * Converted to DMA API, converted to unified driver model, made it work as 8 * a module again, and from the mac68k project, introduced more 32-bit cards 9 * and dhd's support for 16-bit cards. 10 * 11 * (C) 1998 Alan Cox 12 * 13 * Debugging Andreas Ehliar, Michael Schmitz 14 * 15 * Based on code 16 * (C) 1996 by Thomas Bogendoerfer (tsbogend@bigbug.franken.de) 17 * 18 * This driver is based on work from Andreas Busse, but most of 19 * 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 resources 27 * 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 problems 32 * 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 55#include <asm/pgtable.h> 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 (since 66 the SONIC is at least smart enough that it uses the same endianness 67 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 0x50F0A000 75#define ONBOARD_SONIC_PROM_BASE 0x50f08000 76 77enum macsonic_type { 78 MACSONIC_DUODOCK, 79 MACSONIC_APPLE, 80 MACSONIC_APPLE16, 81 MACSONIC_DAYNA, 82 MACSONIC_DAYNALINK 83}; 84 85/* For the built-in SONIC in the Duo Dock */ 86#define DUODOCK_SONIC_REGISTERS 0xe10000 87#define DUODOCK_SONIC_PROM_BASE 0xe12000 88 89/* For Apple-style NuBus SONIC */ 90#define APPLE_SONIC_REGISTERS 0 91#define APPLE_SONIC_PROM_BASE 0x40000 92 93/* Daynalink LC SONIC */ 94#define DAYNALINK_PROM_BASE 0x400000 95 96/* For Dayna-style NuBus SONIC (haven't seen one yet) */ 97#define DAYNA_SONIC_REGISTERS 0x180000 98/* This is what OpenBSD says. However, this is definitely in NuBus 99 ROM space so we should be able to get it by walking the NuBus 100 resource directories */ 101#define DAYNA_SONIC_MAC_ADDR 0xffe004 102 103#define SONIC_READ_PROM(addr) nubus_readb(prom_addr+addr) 104 105/* 106 * For reversing the PROM address 107 */ 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 gets 128 * moved from level 2 to level 3. Unfortunately we still get some 129 * 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 counter 188 */ 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 207 /* 208 * On NuBus boards we can sometimes look in the ROM resources. 209 * No such luck for comm-slot/onboard. 210 * On the PowerBook 520, the PROM base address is a mystery. 211 */ 212 if (hwreg_present((void *)prom_addr)) { 213 int i; 214 215 for (i = 0; i < 6; i++) 216 dev->dev_addr[i] = SONIC_READ_PROM(i); 217 if (!INVALID_MAC(dev->dev_addr)) 218 return; 219 220 /* 221 * Most of the time, the address is bit-reversed. The NetBSD 222 * source has a rather long and detailed historical account of 223 * why this is so. 224 */ 225 bit_reverse_addr(dev->dev_addr); 226 if (!INVALID_MAC(dev->dev_addr)) 227 return; 228 229 /* 230 * If we still have what seems to be a bogus address, we'll 231 * look in the CAM. The top entry should be ours. 232 */ 233 printk(KERN_WARNING "macsonic: MAC address in PROM seems " 234 "to be invalid, trying CAM\n"); 235 } else { 236 printk(KERN_WARNING "macsonic: cannot read MAC address from " 237 "PROM, trying CAM\n"); 238 } 239 240 /* This only works if MacOS has already initialized the card. */ 241 242 SONIC_WRITE(SONIC_CMD, SONIC_CR_RST); 243 SONIC_WRITE(SONIC_CEP, 15); 244 245 val = SONIC_READ(SONIC_CAP2); 246 dev->dev_addr[5] = val >> 8; 247 dev->dev_addr[4] = val & 0xff; 248 val = SONIC_READ(SONIC_CAP1); 249 dev->dev_addr[3] = val >> 8; 250 dev->dev_addr[2] = val & 0xff; 251 val = SONIC_READ(SONIC_CAP0); 252 dev->dev_addr[1] = val >> 8; 253 dev->dev_addr[0] = val & 0xff; 254 255 if (!INVALID_MAC(dev->dev_addr)) 256 return; 257 258 /* Still nonsense ... messed up someplace! */ 259 260 printk(KERN_WARNING "macsonic: MAC address in CAM entry 15 " 261 "seems invalid, will use a random MAC\n"); 262 eth_hw_addr_random(dev); 263} 264 265static int mac_onboard_sonic_probe(struct net_device *dev) 266{ 267 struct sonic_local* lp = netdev_priv(dev); 268 int sr; 269 bool commslot = macintosh_config->expansion_type == MAC_EXP_PDS_COMM; 270 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 (commslot || macintosh_config->ident == MAC_MODEL_C610) { 276 int card_present; 277 278 card_present = hwreg_present((void*)ONBOARD_SONIC_REGISTERS); 279 if (!card_present) { 280 pr_info("Onboard/comm-slot SONIC not found\n"); 281 return -ENODEV; 282 } 283 } 284 285 /* Danger! My arms are flailing wildly! You *must* set lp->reg_offset 286 * and dev->base_addr before using SONIC_READ() or SONIC_WRITE() */ 287 dev->base_addr = ONBOARD_SONIC_REGISTERS; 288 if (via_alt_mapping) 289 dev->irq = IRQ_AUTO_3; 290 else 291 dev->irq = IRQ_NUBUS_9; 292 293 /* The PowerBook's SONIC is 16 bit always. */ 294 if (macintosh_config->ident == MAC_MODEL_PB520) { 295 lp->reg_offset = 0; 296 lp->dma_bitmode = SONIC_BITMODE16; 297 } else if (commslot) { 298 /* Some of the comm-slot cards are 16 bit. But some 299 of them are not. The 32-bit cards use offset 2 and 300 have known revisions, we try reading the revision 301 register at offset 2, if we don't get a known revision 302 we assume 16 bit at offset 0. */ 303 lp->reg_offset = 2; 304 lp->dma_bitmode = SONIC_BITMODE16; 305 306 sr = SONIC_READ(SONIC_SR); 307 if (sr == 0x0004 || sr == 0x0006 || sr == 0x0100 || sr == 0x0101) 308 /* 83932 is 0x0004 or 0x0006, 83934 is 0x0100 or 0x0101 */ 309 lp->dma_bitmode = SONIC_BITMODE32; 310 else { 311 lp->dma_bitmode = SONIC_BITMODE16; 312 lp->reg_offset = 0; 313 } 314 } else { 315 /* All onboard cards are at offset 2 with 32 bit DMA. */ 316 lp->reg_offset = 2; 317 lp->dma_bitmode = SONIC_BITMODE32; 318 } 319 320 pr_info("Onboard/comm-slot SONIC, revision 0x%04x, %d bit DMA, register offset %d\n", 321 SONIC_READ(SONIC_SR), lp->dma_bitmode ? 32 : 16, 322 lp->reg_offset); 323 324 /* This is sometimes useful to find out how MacOS configured the card */ 325 pr_debug("%s: DCR=0x%04x, DCR2=0x%04x\n", __func__, 326 SONIC_READ(SONIC_DCR) & 0xffff, 327 SONIC_READ(SONIC_DCR2) & 0xffff); 328 329 /* Software reset, then initialize control registers. */ 330 SONIC_WRITE(SONIC_CMD, SONIC_CR_RST); 331 332 SONIC_WRITE(SONIC_DCR, SONIC_DCR_EXBUS | SONIC_DCR_BMS | 333 SONIC_DCR_RFT1 | SONIC_DCR_TFT0 | 334 (lp->dma_bitmode ? SONIC_DCR_DW : 0)); 335 336 /* This *must* be written back to in order to restore the 337 * extended programmable output bits, as it may not have been 338 * initialised since the hardware reset. */ 339 SONIC_WRITE(SONIC_DCR2, 0); 340 341 /* Clear *and* disable interrupts to be on the safe side */ 342 SONIC_WRITE(SONIC_IMR, 0); 343 SONIC_WRITE(SONIC_ISR, 0x7fff); 344 345 /* Now look for the MAC address. */ 346 mac_onboard_sonic_ethernet_addr(dev); 347 348 pr_info("SONIC ethernet @%08lx, MAC %pM, IRQ %d\n", 349 dev->base_addr, dev->dev_addr, dev->irq); 350 351 /* Shared init code */ 352 return macsonic_init(dev); 353} 354 355static int mac_sonic_nubus_ethernet_addr(struct net_device *dev, 356 unsigned long prom_addr, int id) 357{ 358 int i; 359 for(i = 0; i < 6; i++) 360 dev->dev_addr[i] = SONIC_READ_PROM(i); 361 362 /* Some of the addresses are bit-reversed */ 363 if (id != MACSONIC_DAYNA) 364 bit_reverse_addr(dev->dev_addr); 365 366 return 0; 367} 368 369static int macsonic_ident(struct nubus_rsrc *fres) 370{ 371 if (fres->dr_hw == NUBUS_DRHW_ASANTE_LC && 372 fres->dr_sw == NUBUS_DRSW_SONIC_LC) 373 return MACSONIC_DAYNALINK; 374 if (fres->dr_hw == NUBUS_DRHW_SONIC && 375 fres->dr_sw == NUBUS_DRSW_APPLE) { 376 /* There has to be a better way to do this... */ 377 if (strstr(fres->board->name, "DuoDock")) 378 return MACSONIC_DUODOCK; 379 else 380 return MACSONIC_APPLE; 381 } 382 383 if (fres->dr_hw == NUBUS_DRHW_SMC9194 && 384 fres->dr_sw == NUBUS_DRSW_DAYNA) 385 return MACSONIC_DAYNA; 386 387 if (fres->dr_hw == NUBUS_DRHW_APPLE_SONIC_LC && 388 fres->dr_sw == 0) { /* huh? */ 389 return MACSONIC_APPLE16; 390 } 391 return -1; 392} 393 394static int mac_sonic_nubus_probe_board(struct nubus_board *board, int id, 395 struct net_device *dev) 396{ 397 struct sonic_local* lp = netdev_priv(dev); 398 unsigned long base_addr, prom_addr; 399 u16 sonic_dcr; 400 int reg_offset, dma_bitmode; 401 402 switch (id) { 403 case MACSONIC_DUODOCK: 404 base_addr = board->slot_addr + DUODOCK_SONIC_REGISTERS; 405 prom_addr = board->slot_addr + DUODOCK_SONIC_PROM_BASE; 406 sonic_dcr = SONIC_DCR_EXBUS | SONIC_DCR_RFT0 | SONIC_DCR_RFT1 | 407 SONIC_DCR_TFT0; 408 reg_offset = 2; 409 dma_bitmode = SONIC_BITMODE32; 410 break; 411 case MACSONIC_APPLE: 412 base_addr = board->slot_addr + APPLE_SONIC_REGISTERS; 413 prom_addr = board->slot_addr + APPLE_SONIC_PROM_BASE; 414 sonic_dcr = SONIC_DCR_BMS | SONIC_DCR_RFT1 | SONIC_DCR_TFT0; 415 reg_offset = 0; 416 dma_bitmode = SONIC_BITMODE32; 417 break; 418 case MACSONIC_APPLE16: 419 base_addr = board->slot_addr + APPLE_SONIC_REGISTERS; 420 prom_addr = board->slot_addr + APPLE_SONIC_PROM_BASE; 421 sonic_dcr = SONIC_DCR_EXBUS | SONIC_DCR_RFT1 | SONIC_DCR_TFT0 | 422 SONIC_DCR_PO1 | SONIC_DCR_BMS; 423 reg_offset = 0; 424 dma_bitmode = SONIC_BITMODE16; 425 break; 426 case MACSONIC_DAYNALINK: 427 base_addr = board->slot_addr + APPLE_SONIC_REGISTERS; 428 prom_addr = board->slot_addr + DAYNALINK_PROM_BASE; 429 sonic_dcr = SONIC_DCR_RFT1 | SONIC_DCR_TFT0 | 430 SONIC_DCR_PO1 | SONIC_DCR_BMS; 431 reg_offset = 0; 432 dma_bitmode = SONIC_BITMODE16; 433 break; 434 case MACSONIC_DAYNA: 435 base_addr = board->slot_addr + DAYNA_SONIC_REGISTERS; 436 prom_addr = board->slot_addr + DAYNA_SONIC_MAC_ADDR; 437 sonic_dcr = SONIC_DCR_BMS | 438 SONIC_DCR_RFT1 | SONIC_DCR_TFT0 | SONIC_DCR_PO1; 439 reg_offset = 0; 440 dma_bitmode = SONIC_BITMODE16; 441 break; 442 default: 443 printk(KERN_ERR "macsonic: WTF, id is %d\n", id); 444 return -ENODEV; 445 } 446 447 /* Danger! My arms are flailing wildly! You *must* set lp->reg_offset 448 * and dev->base_addr before using SONIC_READ() or SONIC_WRITE() */ 449 dev->base_addr = base_addr; 450 lp->reg_offset = reg_offset; 451 lp->dma_bitmode = dma_bitmode; 452 dev->irq = SLOT2IRQ(board->slot); 453 454 dev_info(&board->dev, "%s, revision 0x%04x, %d bit DMA, register offset %d\n", 455 board->name, SONIC_READ(SONIC_SR), 456 lp->dma_bitmode ? 32 : 16, lp->reg_offset); 457 458 /* This is sometimes useful to find out how MacOS configured the card */ 459 dev_dbg(&board->dev, "%s: DCR=0x%04x, DCR2=0x%04x\n", __func__, 460 SONIC_READ(SONIC_DCR) & 0xffff, 461 SONIC_READ(SONIC_DCR2) & 0xffff); 462 463 /* Software reset, then initialize control registers. */ 464 SONIC_WRITE(SONIC_CMD, SONIC_CR_RST); 465 SONIC_WRITE(SONIC_DCR, sonic_dcr | (dma_bitmode ? SONIC_DCR_DW : 0)); 466 /* This *must* be written back to in order to restore the 467 * extended programmable output bits, since it may not have been 468 * initialised since the hardware reset. */ 469 SONIC_WRITE(SONIC_DCR2, 0); 470 471 /* Clear *and* disable interrupts to be on the safe side */ 472 SONIC_WRITE(SONIC_IMR, 0); 473 SONIC_WRITE(SONIC_ISR, 0x7fff); 474 475 /* Now look for the MAC address. */ 476 if (mac_sonic_nubus_ethernet_addr(dev, prom_addr, id) != 0) 477 return -ENODEV; 478 479 dev_info(&board->dev, "SONIC ethernet @%08lx, MAC %pM, IRQ %d\n", 480 dev->base_addr, dev->dev_addr, dev->irq); 481 482 /* Shared init code */ 483 return macsonic_init(dev); 484} 485 486static int mac_sonic_platform_probe(struct platform_device *pdev) 487{ 488 struct net_device *dev; 489 struct sonic_local *lp; 490 int err; 491 492 dev = alloc_etherdev(sizeof(struct sonic_local)); 493 if (!dev) 494 return -ENOMEM; 495 496 lp = netdev_priv(dev); 497 lp->device = &pdev->dev; 498 SET_NETDEV_DEV(dev, &pdev->dev); 499 platform_set_drvdata(pdev, dev); 500 501 err = mac_onboard_sonic_probe(dev); 502 if (err) 503 goto out; 504 505 sonic_msg_init(dev); 506 507 err = register_netdev(dev); 508 if (err) 509 goto out; 510 511 return 0; 512 513out: 514 free_netdev(dev); 515 516 return err; 517} 518 519MODULE_DESCRIPTION("Macintosh SONIC ethernet driver"); 520MODULE_ALIAS("platform:macsonic"); 521 522#include "sonic.c" 523 524static int mac_sonic_platform_remove(struct platform_device *pdev) 525{ 526 struct net_device *dev = platform_get_drvdata(pdev); 527 struct sonic_local* lp = netdev_priv(dev); 528 529 unregister_netdev(dev); 530 dma_free_coherent(lp->device, SIZEOF_SONIC_DESC * SONIC_BUS_SCALE(lp->dma_bitmode), 531 lp->descriptors, lp->descriptors_laddr); 532 free_netdev(dev); 533 534 return 0; 535} 536 537static struct platform_driver mac_sonic_platform_driver = { 538 .probe = mac_sonic_platform_probe, 539 .remove = mac_sonic_platform_remove, 540 .driver = { 541 .name = "macsonic", 542 }, 543}; 544 545static int mac_sonic_nubus_probe(struct nubus_board *board) 546{ 547 struct net_device *ndev; 548 struct sonic_local *lp; 549 struct nubus_rsrc *fres; 550 int id = -1; 551 int err; 552 553 /* The platform driver will handle a PDS or Comm Slot card (even if 554 * it has a pseudoslot declaration ROM). 555 */ 556 if (macintosh_config->expansion_type == MAC_EXP_PDS_COMM) 557 return -ENODEV; 558 559 for_each_board_func_rsrc(board, fres) { 560 if (fres->category != NUBUS_CAT_NETWORK || 561 fres->type != NUBUS_TYPE_ETHERNET) 562 continue; 563 564 id = macsonic_ident(fres); 565 if (id != -1) 566 break; 567 } 568 if (!fres) 569 return -ENODEV; 570 571 ndev = alloc_etherdev(sizeof(struct sonic_local)); 572 if (!ndev) 573 return -ENOMEM; 574 575 lp = netdev_priv(ndev); 576 lp->device = &board->dev; 577 SET_NETDEV_DEV(ndev, &board->dev); 578 579 err = mac_sonic_nubus_probe_board(board, id, ndev); 580 if (err) 581 goto out; 582 583 sonic_msg_init(ndev); 584 585 err = register_netdev(ndev); 586 if (err) 587 goto out; 588 589 nubus_set_drvdata(board, ndev); 590 591 return 0; 592 593out: 594 free_netdev(ndev); 595 return err; 596} 597 598static int mac_sonic_nubus_remove(struct nubus_board *board) 599{ 600 struct net_device *ndev = nubus_get_drvdata(board); 601 struct sonic_local *lp = netdev_priv(ndev); 602 603 unregister_netdev(ndev); 604 dma_free_coherent(lp->device, 605 SIZEOF_SONIC_DESC * SONIC_BUS_SCALE(lp->dma_bitmode), 606 lp->descriptors, lp->descriptors_laddr); 607 free_netdev(ndev); 608 609 return 0; 610} 611 612static struct nubus_driver mac_sonic_nubus_driver = { 613 .probe = mac_sonic_nubus_probe, 614 .remove = mac_sonic_nubus_remove, 615 .driver = { 616 .name = "macsonic-nubus", 617 .owner = THIS_MODULE, 618 }, 619}; 620 621static int perr, nerr; 622 623static int __init mac_sonic_init(void) 624{ 625 perr = platform_driver_register(&mac_sonic_platform_driver); 626 nerr = nubus_driver_register(&mac_sonic_nubus_driver); 627 return 0; 628} 629module_init(mac_sonic_init); 630 631static void __exit mac_sonic_exit(void) 632{ 633 if (!perr) 634 platform_driver_unregister(&mac_sonic_platform_driver); 635 if (!nerr) 636 nubus_driver_unregister(&mac_sonic_nubus_driver); 637} 638module_exit(mac_sonic_exit);