631 lines · c
1// SPDX-License-Identifier: GPL-1.0+2/* smc-ultra.c: A SMC Ultra ethernet driver for linux. */3/*4 This is a driver for the SMC Ultra and SMC EtherEZ ISA ethercards.5 6 Written 1993-1998 by Donald Becker.7 8 Copyright 1993 United States Government as represented by the9 Director, National Security Agency.10 11 The author may be reached as becker@scyld.com, or C/O12 Scyld Computing Corporation13 410 Severn Ave., Suite 21014 Annapolis MD 2140315 16 This driver uses the cards in the 8390-compatible mode.17 Most of the run-time complexity is handled by the generic code in18 8390.c. The code in this file is responsible for19 20 ultra_probe() Detecting and initializing the card.21 ultra_probe1()22 ultra_probe_isapnp()23 24 ultra_open() The card-specific details of starting, stopping25 ultra_reset_8390() and resetting the 8390 NIC core.26 ultra_close()27 28 ultra_block_input() Routines for reading and writing blocks of29 ultra_block_output() packet buffer memory.30 ultra_pio_input()31 ultra_pio_output()32 33 This driver enables the shared memory only when doing the actual data34 transfers to avoid a bug in early version of the card that corrupted35 data transferred by a AHA1542.36 37 This driver now supports the programmed-I/O (PIO) data transfer mode of38 the EtherEZ. It does not use the non-8390-compatible "Altego" mode.39 That support (if available) is in smc-ez.c.40 41 Changelog:42 43 Paul Gortmaker : multiple card support for module users.44 Donald Becker : 4/17/96 PIO support, minor potential problems avoided.45 Donald Becker : 6/6/96 correctly set auto-wrap bit.46 Alexander Sotirov : 1/20/01 Added support for ISAPnP cards47 48 Note about the ISA PnP support:49 50 This driver can not autoprobe for more than one SMC EtherEZ PnP card.51 You have to configure the second card manually through the /proc/isapnp52 interface and then load the module with an explicit io=0x___ option.53*/54 55static const char version[] =56 "smc-ultra.c:v2.02 2/3/98 Donald Becker (becker@cesdis.gsfc.nasa.gov)\n";57 58#include <linux/module.h>59#include <linux/kernel.h>60#include <linux/errno.h>61#include <linux/string.h>62#include <linux/init.h>63#include <linux/interrupt.h>64#include <linux/isapnp.h>65#include <linux/netdevice.h>66#include <linux/etherdevice.h>67#include <net/Space.h>68 69#include <asm/io.h>70#include <asm/irq.h>71 72#include "8390.h"73 74#define DRV_NAME "smc-ultra"75 76/* A zero-terminated list of I/O addresses to be probed. */77static unsigned int ultra_portlist[] __initdata =78{0x200, 0x220, 0x240, 0x280, 0x300, 0x340, 0x380, 0};79 80static int ultra_probe1(struct net_device *dev, int ioaddr);81 82#ifdef __ISAPNP__83static int ultra_probe_isapnp(struct net_device *dev);84#endif85 86static int ultra_open(struct net_device *dev);87static void ultra_reset_8390(struct net_device *dev);88static void ultra_get_8390_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr,89 int ring_page);90static void ultra_block_input(struct net_device *dev, int count,91 struct sk_buff *skb, int ring_offset);92static void ultra_block_output(struct net_device *dev, int count,93 const unsigned char *buf, const int start_page);94static void ultra_pio_get_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr,95 int ring_page);96static void ultra_pio_input(struct net_device *dev, int count,97 struct sk_buff *skb, int ring_offset);98static void ultra_pio_output(struct net_device *dev, int count,99 const unsigned char *buf, const int start_page);100static int ultra_close_card(struct net_device *dev);101 102#ifdef __ISAPNP__103static struct isapnp_device_id ultra_device_ids[] __initdata = {104 { ISAPNP_VENDOR('S','M','C'), ISAPNP_FUNCTION(0x8416),105 ISAPNP_VENDOR('S','M','C'), ISAPNP_FUNCTION(0x8416),106 (long) "SMC EtherEZ (8416)" },107 { } /* terminate list */108};109 110MODULE_DEVICE_TABLE(isapnp, ultra_device_ids);111#endif112 113static u32 ultra_msg_enable;114 115#define START_PG 0x00 /* First page of TX buffer */116 117#define ULTRA_CMDREG 0 /* Offset to ASIC command register. */118#define ULTRA_RESET 0x80 /* Board reset, in ULTRA_CMDREG. */119#define ULTRA_MEMENB 0x40 /* Enable the shared memory. */120#define IOPD 0x02 /* I/O Pipe Data (16 bits), PIO operation. */121#define IOPA 0x07 /* I/O Pipe Address for PIO operation. */122#define ULTRA_NIC_OFFSET 16 /* NIC register offset from the base_addr. */123#define ULTRA_IO_EXTENT 32124#define EN0_ERWCNT 0x08 /* Early receive warning count. */125 126#ifdef CONFIG_NET_POLL_CONTROLLER127static void ultra_poll(struct net_device *dev)128{129 disable_irq(dev->irq);130 ei_interrupt(dev->irq, dev);131 enable_irq(dev->irq);132}133#endif134/* Probe for the Ultra. This looks like a 8013 with the station135 address PROM at I/O ports <base>+8 to <base>+13, with a checksum136 following.137*/138 139static int __init do_ultra_probe(struct net_device *dev)140{141 int i;142 int base_addr = dev->base_addr;143 int irq = dev->irq;144 145 if (base_addr > 0x1ff) /* Check a single specified location. */146 return ultra_probe1(dev, base_addr);147 else if (base_addr != 0) /* Don't probe at all. */148 return -ENXIO;149 150#ifdef __ISAPNP__151 /* Look for any installed ISAPnP cards */152 if (isapnp_present() && (ultra_probe_isapnp(dev) == 0))153 return 0;154#endif155 156 for (i = 0; ultra_portlist[i]; i++) {157 dev->irq = irq;158 if (ultra_probe1(dev, ultra_portlist[i]) == 0)159 return 0;160 }161 162 return -ENODEV;163}164 165#ifndef MODULE166struct net_device * __init ultra_probe(int unit)167{168 struct net_device *dev = alloc_ei_netdev();169 int err;170 171 if (!dev)172 return ERR_PTR(-ENOMEM);173 174 sprintf(dev->name, "eth%d", unit);175 netdev_boot_setup_check(dev);176 177 err = do_ultra_probe(dev);178 if (err)179 goto out;180 return dev;181out:182 free_netdev(dev);183 return ERR_PTR(err);184}185#endif186 187static const struct net_device_ops ultra_netdev_ops = {188 .ndo_open = ultra_open,189 .ndo_stop = ultra_close_card,190 191 .ndo_start_xmit = ei_start_xmit,192 .ndo_tx_timeout = ei_tx_timeout,193 .ndo_get_stats = ei_get_stats,194 .ndo_set_rx_mode = ei_set_multicast_list,195 .ndo_validate_addr = eth_validate_addr,196 .ndo_set_mac_address = eth_mac_addr,197#ifdef CONFIG_NET_POLL_CONTROLLER198 .ndo_poll_controller = ultra_poll,199#endif200};201 202static int __init ultra_probe1(struct net_device *dev, int ioaddr)203{204 int i, retval;205 int checksum = 0;206 u8 macaddr[ETH_ALEN];207 const char *model_name;208 unsigned char eeprom_irq = 0;209 static unsigned version_printed;210 /* Values from various config regs. */211 unsigned char num_pages, irqreg, addr, piomode;212 unsigned char idreg = inb(ioaddr + 7);213 unsigned char reg4 = inb(ioaddr + 4) & 0x7f;214 struct ei_device *ei_local = netdev_priv(dev);215 216 if (!request_region(ioaddr, ULTRA_IO_EXTENT, DRV_NAME))217 return -EBUSY;218 219 /* Check the ID nibble. */220 if ((idreg & 0xF0) != 0x20 /* SMC Ultra */221 && (idreg & 0xF0) != 0x40) { /* SMC EtherEZ */222 retval = -ENODEV;223 goto out;224 }225 226 /* Select the station address register set. */227 outb(reg4, ioaddr + 4);228 229 for (i = 0; i < 8; i++)230 checksum += inb(ioaddr + 8 + i);231 if ((checksum & 0xff) != 0xFF) {232 retval = -ENODEV;233 goto out;234 }235 236 if ((ultra_msg_enable & NETIF_MSG_DRV) && (version_printed++ == 0))237 netdev_info(dev, version);238 239 model_name = (idreg & 0xF0) == 0x20 ? "SMC Ultra" : "SMC EtherEZ";240 241 for (i = 0; i < 6; i++)242 macaddr[i] = inb(ioaddr + 8 + i);243 eth_hw_addr_set(dev, macaddr);244 245 netdev_info(dev, "%s at %#3x, %pM", model_name,246 ioaddr, dev->dev_addr);247 248 /* Switch from the station address to the alternate register set and249 read the useful registers there. */250 outb(0x80 | reg4, ioaddr + 4);251 252 /* Enabled FINE16 mode to avoid BIOS ROM width mismatches @ reboot. */253 outb(0x80 | inb(ioaddr + 0x0c), ioaddr + 0x0c);254 piomode = inb(ioaddr + 0x8);255 addr = inb(ioaddr + 0xb);256 irqreg = inb(ioaddr + 0xd);257 258 /* Switch back to the station address register set so that the MS-DOS driver259 can find the card after a warm boot. */260 outb(reg4, ioaddr + 4);261 262 if (dev->irq < 2) {263 unsigned char irqmap[] = {0, 9, 3, 5, 7, 10, 11, 15};264 int irq;265 266 /* The IRQ bits are split. */267 irq = irqmap[((irqreg & 0x40) >> 4) + ((irqreg & 0x0c) >> 2)];268 269 if (irq == 0) {270 pr_cont(", failed to detect IRQ line.\n");271 retval = -EAGAIN;272 goto out;273 }274 dev->irq = irq;275 eeprom_irq = 1;276 }277 278 /* The 8390 isn't at the base address, so fake the offset */279 dev->base_addr = ioaddr+ULTRA_NIC_OFFSET;280 281 {282 static const int addr_tbl[4] = {283 0x0C0000, 0x0E0000, 0xFC0000, 0xFE0000284 };285 static const short num_pages_tbl[4] = {286 0x20, 0x40, 0x80, 0xff287 };288 289 dev->mem_start = ((addr & 0x0f) << 13) + addr_tbl[(addr >> 6) & 3] ;290 num_pages = num_pages_tbl[(addr >> 4) & 3];291 }292 293 ei_status.name = model_name;294 ei_status.word16 = 1;295 ei_status.tx_start_page = START_PG;296 ei_status.rx_start_page = START_PG + TX_PAGES;297 ei_status.stop_page = num_pages;298 299 ei_status.mem = ioremap(dev->mem_start, (ei_status.stop_page - START_PG)*256);300 if (!ei_status.mem) {301 pr_cont(", failed to ioremap.\n");302 retval = -ENOMEM;303 goto out;304 }305 306 dev->mem_end = dev->mem_start + (ei_status.stop_page - START_PG)*256;307 308 if (piomode) {309 pr_cont(", %s IRQ %d programmed-I/O mode.\n",310 eeprom_irq ? "EEPROM" : "assigned ", dev->irq);311 ei_status.block_input = &ultra_pio_input;312 ei_status.block_output = &ultra_pio_output;313 ei_status.get_8390_hdr = &ultra_pio_get_hdr;314 } else {315 pr_cont(", %s IRQ %d memory %#lx-%#lx.\n",316 eeprom_irq ? "" : "assigned ", dev->irq, dev->mem_start,317 dev->mem_end-1);318 ei_status.block_input = &ultra_block_input;319 ei_status.block_output = &ultra_block_output;320 ei_status.get_8390_hdr = &ultra_get_8390_hdr;321 }322 ei_status.reset_8390 = &ultra_reset_8390;323 324 dev->netdev_ops = &ultra_netdev_ops;325 NS8390_init(dev, 0);326 ei_local->msg_enable = ultra_msg_enable;327 328 retval = register_netdev(dev);329 if (retval)330 goto out;331 return 0;332out:333 release_region(ioaddr, ULTRA_IO_EXTENT);334 return retval;335}336 337#ifdef __ISAPNP__338static int __init ultra_probe_isapnp(struct net_device *dev)339{340 int i;341 342 for (i = 0; ultra_device_ids[i].vendor != 0; i++) {343 struct pnp_dev *idev = NULL;344 345 while ((idev = pnp_find_dev(NULL,346 ultra_device_ids[i].vendor,347 ultra_device_ids[i].function,348 idev))) {349 /* Avoid already found cards from previous calls */350 if (pnp_device_attach(idev) < 0)351 continue;352 if (pnp_activate_dev(idev) < 0) {353 __again:354 pnp_device_detach(idev);355 continue;356 }357 /* if no io and irq, search for next */358 if (!pnp_port_valid(idev, 0) || !pnp_irq_valid(idev, 0))359 goto __again;360 /* found it */361 dev->base_addr = pnp_port_start(idev, 0);362 dev->irq = pnp_irq(idev, 0);363 netdev_info(dev,364 "smc-ultra.c: ISAPnP reports %s at i/o %#lx, irq %d.\n",365 (char *) ultra_device_ids[i].driver_data,366 dev->base_addr, dev->irq);367 if (ultra_probe1(dev, dev->base_addr) != 0) { /* Shouldn't happen. */368 netdev_err(dev,369 "smc-ultra.c: Probe of ISAPnP card at %#lx failed.\n",370 dev->base_addr);371 pnp_device_detach(idev);372 return -ENXIO;373 }374 ei_status.priv = (unsigned long)idev;375 break;376 }377 if (!idev)378 continue;379 return 0;380 }381 382 return -ENODEV;383}384#endif385 386static int387ultra_open(struct net_device *dev)388{389 int retval;390 int ioaddr = dev->base_addr - ULTRA_NIC_OFFSET; /* ASIC addr */391 unsigned char irq2reg[] = {0, 0, 0x04, 0x08, 0, 0x0C, 0, 0x40,392 0, 0x04, 0x44, 0x48, 0, 0, 0, 0x4C, };393 394 retval = request_irq(dev->irq, ei_interrupt, 0, dev->name, dev);395 if (retval)396 return retval;397 398 outb(0x00, ioaddr); /* Disable shared memory for safety. */399 outb(0x80, ioaddr + 5);400 /* Set the IRQ line. */401 outb(inb(ioaddr + 4) | 0x80, ioaddr + 4);402 outb((inb(ioaddr + 13) & ~0x4C) | irq2reg[dev->irq], ioaddr + 13);403 outb(inb(ioaddr + 4) & 0x7f, ioaddr + 4);404 405 if (ei_status.block_input == &ultra_pio_input) {406 outb(0x11, ioaddr + 6); /* Enable interrupts and PIO. */407 outb(0x01, ioaddr + 0x19); /* Enable ring read auto-wrap. */408 } else409 outb(0x01, ioaddr + 6); /* Enable interrupts and memory. */410 /* Set the early receive warning level in window 0 high enough not411 to receive ERW interrupts. */412 outb_p(E8390_NODMA+E8390_PAGE0, dev->base_addr);413 outb(0xff, dev->base_addr + EN0_ERWCNT);414 ei_open(dev);415 return 0;416}417 418static void419ultra_reset_8390(struct net_device *dev)420{421 int cmd_port = dev->base_addr - ULTRA_NIC_OFFSET; /* ASIC base addr */422 struct ei_device *ei_local = netdev_priv(dev);423 424 outb(ULTRA_RESET, cmd_port);425 netif_dbg(ei_local, hw, dev, "resetting Ultra, t=%ld...\n", jiffies);426 ei_status.txing = 0;427 428 outb(0x00, cmd_port); /* Disable shared memory for safety. */429 outb(0x80, cmd_port + 5);430 if (ei_status.block_input == &ultra_pio_input)431 outb(0x11, cmd_port + 6); /* Enable interrupts and PIO. */432 else433 outb(0x01, cmd_port + 6); /* Enable interrupts and memory. */434 435 netif_dbg(ei_local, hw, dev, "reset done\n");436}437 438/* Grab the 8390 specific header. Similar to the block_input routine, but439 we don't need to be concerned with ring wrap as the header will be at440 the start of a page, so we optimize accordingly. */441 442static void443ultra_get_8390_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr, int ring_page)444{445 void __iomem *hdr_start = ei_status.mem + ((ring_page - START_PG)<<8);446 447 outb(ULTRA_MEMENB, dev->base_addr - ULTRA_NIC_OFFSET); /* shmem on */448#ifdef __BIG_ENDIAN449 /* Officially this is what we are doing, but the readl() is faster */450 /* unfortunately it isn't endian aware of the struct */451 memcpy_fromio(hdr, hdr_start, sizeof(struct e8390_pkt_hdr));452 hdr->count = le16_to_cpu(hdr->count);453#else454 ((unsigned int*)hdr)[0] = readl(hdr_start);455#endif456 outb(0x00, dev->base_addr - ULTRA_NIC_OFFSET); /* shmem off */457}458 459/* Block input and output are easy on shared memory ethercards, the only460 complication is when the ring buffer wraps. */461 462static void463ultra_block_input(struct net_device *dev, int count, struct sk_buff *skb, int ring_offset)464{465 void __iomem *xfer_start = ei_status.mem + ring_offset - (START_PG<<8);466 467 /* Enable shared memory. */468 outb(ULTRA_MEMENB, dev->base_addr - ULTRA_NIC_OFFSET);469 470 if (ring_offset + count > ei_status.stop_page*256) {471 /* We must wrap the input move. */472 int semi_count = ei_status.stop_page*256 - ring_offset;473 memcpy_fromio(skb->data, xfer_start, semi_count);474 count -= semi_count;475 memcpy_fromio(skb->data + semi_count, ei_status.mem + TX_PAGES * 256, count);476 } else {477 memcpy_fromio(skb->data, xfer_start, count);478 }479 480 outb(0x00, dev->base_addr - ULTRA_NIC_OFFSET); /* Disable memory. */481}482 483static void484ultra_block_output(struct net_device *dev, int count, const unsigned char *buf,485 int start_page)486{487 void __iomem *shmem = ei_status.mem + ((start_page - START_PG)<<8);488 489 /* Enable shared memory. */490 outb(ULTRA_MEMENB, dev->base_addr - ULTRA_NIC_OFFSET);491 492 memcpy_toio(shmem, buf, count);493 494 outb(0x00, dev->base_addr - ULTRA_NIC_OFFSET); /* Disable memory. */495}496 497/* The identical operations for programmed I/O cards.498 The PIO model is trivial to use: the 16 bit start address is written499 byte-sequentially to IOPA, with no intervening I/O operations, and the500 data is read or written to the IOPD data port.501 The only potential complication is that the address register is shared502 and must be always be rewritten between each read/write direction change.503 This is no problem for us, as the 8390 code ensures that we are single504 threaded. */505static void ultra_pio_get_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr,506 int ring_page)507{508 int ioaddr = dev->base_addr - ULTRA_NIC_OFFSET; /* ASIC addr */509 outb(0x00, ioaddr + IOPA); /* Set the address, LSB first. */510 outb(ring_page, ioaddr + IOPA);511 insw(ioaddr + IOPD, hdr, sizeof(struct e8390_pkt_hdr)>>1);512}513 514static void ultra_pio_input(struct net_device *dev, int count,515 struct sk_buff *skb, int ring_offset)516{517 int ioaddr = dev->base_addr - ULTRA_NIC_OFFSET; /* ASIC addr */518 char *buf = skb->data;519 520 /* For now set the address again, although it should already be correct. */521 outb(ring_offset, ioaddr + IOPA); /* Set the address, LSB first. */522 outb(ring_offset >> 8, ioaddr + IOPA);523 /* We know skbuffs are padded to at least word alignment. */524 insw(ioaddr + IOPD, buf, (count+1)>>1);525}526static void ultra_pio_output(struct net_device *dev, int count,527 const unsigned char *buf, const int start_page)528{529 int ioaddr = dev->base_addr - ULTRA_NIC_OFFSET; /* ASIC addr */530 outb(0x00, ioaddr + IOPA); /* Set the address, LSB first. */531 outb(start_page, ioaddr + IOPA);532 /* An extra odd byte is OK here as well. */533 outsw(ioaddr + IOPD, buf, (count+1)>>1);534}535 536static int537ultra_close_card(struct net_device *dev)538{539 int ioaddr = dev->base_addr - ULTRA_NIC_OFFSET; /* CMDREG */540 struct ei_device *ei_local = netdev_priv(dev);541 542 netif_stop_queue(dev);543 544 netif_dbg(ei_local, ifdown, dev, "Shutting down ethercard.\n");545 546 outb(0x00, ioaddr + 6); /* Disable interrupts. */547 free_irq(dev->irq, dev);548 549 NS8390_init(dev, 0);550 551 /* We should someday disable shared memory and change to 8-bit mode552 "just in case"... */553 554 return 0;555}556 557 558#ifdef MODULE559#define MAX_ULTRA_CARDS 4 /* Max number of Ultra cards per module */560static struct net_device *dev_ultra[MAX_ULTRA_CARDS];561static int io[MAX_ULTRA_CARDS];562static int irq[MAX_ULTRA_CARDS];563 564module_param_hw_array(io, int, ioport, NULL, 0);565module_param_hw_array(irq, int, irq, NULL, 0);566module_param_named(msg_enable, ultra_msg_enable, uint, 0444);567MODULE_PARM_DESC(io, "I/O base address(es)");568MODULE_PARM_DESC(irq, "IRQ number(s) (assigned)");569MODULE_PARM_DESC(msg_enable, "Debug message level (see linux/netdevice.h for bitmap)");570MODULE_DESCRIPTION("SMC Ultra/EtherEZ ISA/PnP Ethernet driver");571MODULE_LICENSE("GPL");572 573/* This is set up so that only a single autoprobe takes place per call.574ISA device autoprobes on a running machine are not recommended. */575static int __init ultra_init_module(void)576{577 struct net_device *dev;578 int this_dev, found = 0;579 580 for (this_dev = 0; this_dev < MAX_ULTRA_CARDS; this_dev++) {581 if (io[this_dev] == 0) {582 if (this_dev != 0) break; /* only autoprobe 1st one */583 printk(KERN_NOTICE "smc-ultra.c: Presently autoprobing (not recommended) for a single card.\n");584 }585 dev = alloc_ei_netdev();586 if (!dev)587 break;588 dev->irq = irq[this_dev];589 dev->base_addr = io[this_dev];590 if (do_ultra_probe(dev) == 0) {591 dev_ultra[found++] = dev;592 continue;593 }594 free_netdev(dev);595 printk(KERN_WARNING "smc-ultra.c: No SMC Ultra card found (i/o = 0x%x).\n", io[this_dev]);596 break;597 }598 if (found)599 return 0;600 return -ENXIO;601}602module_init(ultra_init_module);603 604static void cleanup_card(struct net_device *dev)605{606 /* NB: ultra_close_card() does free_irq */607#ifdef __ISAPNP__608 struct pnp_dev *idev = (struct pnp_dev *)ei_status.priv;609 if (idev)610 pnp_device_detach(idev);611#endif612 release_region(dev->base_addr - ULTRA_NIC_OFFSET, ULTRA_IO_EXTENT);613 iounmap(ei_status.mem);614}615 616static void __exit ultra_cleanup_module(void)617{618 int this_dev;619 620 for (this_dev = 0; this_dev < MAX_ULTRA_CARDS; this_dev++) {621 struct net_device *dev = dev_ultra[this_dev];622 if (dev) {623 unregister_netdev(dev);624 cleanup_card(dev);625 free_netdev(dev);626 }627 }628}629module_exit(ultra_cleanup_module);630#endif /* MODULE */631