drivers/net/e2100.c

   1 /* e2100.c: A Cabletron E2100 series ethernet driver for linux. */
   2 /*
   3         Written 1993-1994 by Donald Becker.
   4
   5         Copyright 1994 by Donald Becker.
   6         Copyright 1993 United States Government as represented by the
   7         Director, National Security Agency.  This software may be used and
   8         distributed according to the terms of the GNU General Public License,
   9         incorporated herein by reference.
  10
  11         This is a driver for the Cabletron E2100 series ethercards.
  12
  13         The Author may be reached as becker@scyld.com, or C/O
  14         Scyld Computing Corporation
  15         410 Severn Ave., Suite 210
  16         Annapolis MD 21403
  17
  18         The E2100 series ethercard is a fairly generic shared memory 8390
  19         implementation.  The only unusual aspect is the way the shared memory
  20         registers are set: first you do an inb() in what is normally the
  21         station address region, and the low three bits of next outb() *address*
  22         is used as the write value for that register.  Either someone wasn't
  23         too used to dem bit en bites, or they were trying to obfuscate the
  24         programming interface.
  25
  26         There is an additional complication when setting the window on the packet
  27         buffer.  You must first do a read into the packet buffer region with the
  28         low 8 address bits the address setting the page for the start of the packet
  29         buffer window, and then do the above operation.  See mem_on() for details.
  30
  31         One bug on the chip is that even a hard reset won't disable the memory
  32         window, usually resulting in a hung machine if mem_off() isn't called.
  33         If this happens, you must power down the machine for about 30 seconds.
  34 */
  35
  36 static const char version[] =
  37         "e2100.c:v1.01 7/21/94 Donald Becker (becker@cesdis.gsfc.nasa.gov)\n";
  38
  39 #include <linux/module.h>
  40 #include <linux/kernel.h>
  41 #include <linux/errno.h>
  42 #include <linux/string.h>
  43 #include <linux/ioport.h>
  44 #include <linux/netdevice.h>
  45 #include <linux/etherdevice.h>
  46 #include <linux/init.h>
  47 #include <linux/delay.h>
  48
  49 #include <asm/io.h>
  50 #include <asm/system.h>
  51
  52 #include "8390.h"
  53
  54 static int e21_probe_list[] = {0x300, 0x280, 0x380, 0x220, 0};
  55
  56 /* Offsets from the base_addr.
  57    Read from the ASIC register, and the low three bits of the next outb()
  58    address is used to set the corresponding register. */
  59 #define E21_NIC_OFFSET  0               /* Offset to the 8390 NIC. */
  60 #define E21_ASIC                0x10
  61 #define E21_MEM_ENABLE  0x10
  62 #define  E21_MEM_ON             0x05    /* Enable memory in 16 bit mode. */
  63 #define  E21_MEM_ON_8   0x07    /* Enable memory in  8 bit mode. */
  64 #define E21_MEM_BASE    0x11
  65 #define E21_IRQ_LOW             0x12    /* The low three bits of the IRQ number. */
  66 #define E21_IRQ_HIGH    0x14    /* The high IRQ bit and media select ...  */
  67 #define E21_MEDIA               0x14    /* (alias). */
  68 #define  E21_ALT_IFPORT 0x02    /* Set to use the other (BNC,AUI) port. */
  69 #define  E21_BIG_MEM    0x04    /* Use a bigger (64K) buffer (we don't) */
  70 #define E21_SAPROM              0x10    /* Offset to station address data. */
  71 #define E21_IO_EXTENT    0x20
  72
  73 static inline void mem_on(short port, volatile char *mem_base,
  74                                                   unsigned char start_page )
  75 {
  76         /* This is a little weird: set the shared memory window by doing a
  77            read.  The low address bits specify the starting page. */
  78         readb(mem_base+start_page);
  79         inb(port + E21_MEM_ENABLE);
  80         outb(E21_MEM_ON, port + E21_MEM_ENABLE + E21_MEM_ON);
  81 }
  82
  83 static inline void mem_off(short port)
  84 {
  85         inb(port + E21_MEM_ENABLE);
  86         outb(0x00, port + E21_MEM_ENABLE);
  87 }
  88
  89 /* In other drivers I put the TX pages first, but the E2100 window circuitry
  90    is designed to have a 4K Tx region last. The windowing circuitry wraps the
  91    window at 0x2fff->0x0000 so that the packets at e.g. 0x2f00 in the RX ring
  92    appear contiguously in the window. */
  93 #define E21_RX_START_PG         0x00    /* First page of RX buffer */
  94 #define E21_RX_STOP_PG          0x30    /* Last page +1 of RX ring */
  95 #define E21_BIG_RX_STOP_PG      0xF0    /* Last page +1 of RX ring */
  96 #define E21_TX_START_PG         E21_RX_STOP_PG  /* First page of TX buffer */
  97
  98 int e2100_probe(struct net_device *dev);
  99 static int e21_probe1(struct net_device *dev, int ioaddr);
 100
 101 static int e21_open(struct net_device *dev);
 102 static void e21_reset_8390(struct net_device *dev);
 103 static void e21_block_input(struct net_device *dev, int count,
 104                                                    struct sk_buff *skb, int ring_offset);
 105 static void e21_block_output(struct net_device *dev, int count,
 106                                                          const unsigned char *buf, int start_page);
 107 static void e21_get_8390_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr,
 108                                                         int ring_page);
 109
 110 static int e21_close(struct net_device *dev);
 111
 112 \f
 113 /*  Probe for the E2100 series ethercards.  These cards have an 8390 at the
 114         base address and the station address at both offset 0x10 and 0x18.  I read
 115         the station address from offset 0x18 to avoid the dataport of NE2000
 116         ethercards, and look for Ctron's unique ID (first three octets of the
 117         station address).
 118  */
 119
 120 int  __init e2100_probe(struct net_device *dev)
 121 {
 122         int *port;
 123         int base_addr = dev->base_addr;
 124
 125         SET_MODULE_OWNER(dev);
 126
 127         if (base_addr > 0x1ff)          /* Check a single specified location. */
 128                 return e21_probe1(dev, base_addr);
 129         else if (base_addr != 0)        /* Don't probe at all. */
 130                 return -ENXIO;
 131
 132         for (port = e21_probe_list; *port; port++)
 133                 if (e21_probe1(dev, *port) == 0)
 134                         return 0;
 135
 136         return -ENODEV;
 137 }
 138
 139 static int __init e21_probe1(struct net_device *dev, int ioaddr)
 140 {
 141         int i, status, retval;
 142         unsigned char *station_addr = dev->dev_addr;
 143         static unsigned version_printed;
 144
 145         if (!request_region(ioaddr, E21_IO_EXTENT, dev->name))
 146                 return -EBUSY;
 147
 148         /* First check the station address for the Ctron prefix. */
 149         if (inb(ioaddr + E21_SAPROM + 0) != 0x00
 150                 || inb(ioaddr + E21_SAPROM + 1) != 0x00
 151                 || inb(ioaddr + E21_SAPROM + 2) != 0x1d) {
 152                 retval = -ENODEV;
 153                 goto out;
 154         }
 155
 156         /* Verify by making certain that there is a 8390 at there. */
 157         outb(E8390_NODMA + E8390_STOP, ioaddr);
 158         udelay(1);      /* we want to delay one I/O cycle - which is 2MHz */
 159         status = inb(ioaddr);
 160         if (status != 0x21 && status != 0x23) {
 161                 retval = -ENODEV;
 162                 goto out;
 163         }
 164
 165         /* Read the station address PROM.  */
 166         for (i = 0; i < 6; i++)
 167                 station_addr[i] = inb(ioaddr + E21_SAPROM + i);
 168
 169         inb(ioaddr + E21_MEDIA);                /* Point to media selection. */
 170         outb(0, ioaddr + E21_ASIC);     /* and disable the secondary interface. */
 171
 172         if (ei_debug  &&  version_printed++ == 0)
 173                 printk(version);
 174
 175         for (i = 0; i < 6; i++)
 176                 printk(" %02X", station_addr[i]);
 177
 178         /* Allocate dev->priv and fill in 8390 specific dev fields. */
 179         if (ethdev_init(dev)) {
 180                 printk (" unable to get memory for dev->priv.\n");
 181                 retval = -ENOMEM;
 182                 goto out;
 183         }
 184
 185         if (dev->irq < 2) {
 186                 int irqlist[] = {15,11,10,12,5,9,3,4}, i;
 187                 for (i = 0; i < 8; i++)
 188                         if (request_irq (irqlist[i], NULL, 0, "bogus", NULL) != -EBUSY) {
 189                                 dev->irq = irqlist[i];
 190                                 break;
 191                         }
 192                 if (i >= 8) {
 193                         printk(" unable to get IRQ %d.\n", dev->irq);
 194                         kfree(dev->priv);
 195                         dev->priv = NULL;
 196                         retval = -EAGAIN;
 197                         goto out;
 198                 }
 199         } else if (dev->irq == 2)       /* Fixup luser bogosity: IRQ2 is really IRQ9 */
 200                 dev->irq = 9;
 201
 202         /* The 8390 is at the base address. */
 203         dev->base_addr = ioaddr;
 204
 205         ei_status.name = "E2100";
 206         ei_status.word16 = 1;
 207         ei_status.tx_start_page = E21_TX_START_PG;
 208         ei_status.rx_start_page = E21_RX_START_PG;
 209         ei_status.stop_page = E21_RX_STOP_PG;
 210         ei_status.saved_irq = dev->irq;
 211
 212         /* Check the media port used.  The port can be passed in on the
 213            low mem_end bits. */
 214         if (dev->mem_end & 15)
 215                 dev->if_port = dev->mem_end & 7;
 216         else {
 217                 dev->if_port = 0;
 218                 inb(ioaddr + E21_MEDIA);        /* Turn automatic media detection on. */
 219                 for(i = 0; i < 6; i++)
 220                         if (station_addr[i] != inb(ioaddr + E21_SAPROM + 8 + i)) {
 221                                 dev->if_port = 1;
 222                                 break;
 223                         }
 224         }
 225
 226         /* Never map in the E21 shared memory unless you are actively using it.
 227            Also, the shared memory has effective only one setting -- spread all
 228            over the 128K region! */
 229         if (dev->mem_start == 0)
 230                 dev->mem_start = 0xd0000;
 231
 232 #ifdef notdef
 233         /* These values are unused.  The E2100 has a 2K window into the packet
 234            buffer.  The window can be set to start on any page boundary. */
 235         ei_status.rmem_start = dev->mem_start + TX_PAGES*256;
 236         dev->mem_end = ei_status.rmem_end = dev->mem_start + 2*1024;
 237 #endif
 238
 239         printk(", IRQ %d, %s media, memory @ %#lx.\n", dev->irq,
 240                    dev->if_port ? "secondary" : "primary", dev->mem_start);
 241
 242         ei_status.reset_8390 = &e21_reset_8390;
 243         ei_status.block_input = &e21_block_input;
 244         ei_status.block_output = &e21_block_output;
 245         ei_status.get_8390_hdr = &e21_get_8390_hdr;
 246         dev->open = &e21_open;
 247         dev->stop = &e21_close;
 248         NS8390_init(dev, 0);
 249
 250         return 0;
 251 out:
 252         release_region(ioaddr, E21_IO_EXTENT);
 253         return retval;
 254 }
 255
 256 static int
 257 e21_open(struct net_device *dev)
 258 {
 259         short ioaddr = dev->base_addr;
 260         int retval;
 261
 262         if ((retval = request_irq(dev->irq, ei_interrupt, 0, dev->name, dev)))
 263                 return retval;
 264
 265         /* Set the interrupt line and memory base on the hardware. */
 266         inb(ioaddr + E21_IRQ_LOW);
 267         outb(0, ioaddr + E21_ASIC + (dev->irq & 7));
 268         inb(ioaddr + E21_IRQ_HIGH);                     /* High IRQ bit, and if_port. */
 269         outb(0, ioaddr + E21_ASIC + (dev->irq > 7 ? 1:0)
 270                    + (dev->if_port ? E21_ALT_IFPORT : 0));
 271         inb(ioaddr + E21_MEM_BASE);
 272         outb(0, ioaddr + E21_ASIC + ((dev->mem_start >> 17) & 7));
 273
 274         ei_open(dev);
 275         return 0;
 276 }
 277
 278 static void
 279 e21_reset_8390(struct net_device *dev)
 280 {
 281         short ioaddr = dev->base_addr;
 282
 283         outb(0x01, ioaddr);
 284         if (ei_debug > 1) printk("resetting the E2180x3 t=%ld...", jiffies);
 285         ei_status.txing = 0;
 286
 287         /* Set up the ASIC registers, just in case something changed them. */
 288
 289         if (ei_debug > 1) printk("reset done\n");
 290         return;
 291 }
 292
 293 /* Grab the 8390 specific header. We put the 2k window so the header page
 294    appears at the start of the shared memory. */
 295
 296 static void
 297 e21_get_8390_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr, int ring_page)
 298 {
 299
 300         short ioaddr = dev->base_addr;
 301         char *shared_mem = (char *)dev->mem_start;
 302
 303         mem_on(ioaddr, shared_mem, ring_page);
 304
 305 #ifdef notdef
 306         /* Officially this is what we are doing, but the readl() is faster */
 307         memcpy_fromio(hdr, shared_mem, sizeof(struct e8390_pkt_hdr));
 308 #else
 309         ((unsigned int*)hdr)[0] = readl(shared_mem);
 310 #endif
 311
 312         /* Turn off memory access: we would need to reprogram the window anyway. */
 313         mem_off(ioaddr);
 314
 315 }
 316
 317 /*  Block input and output are easy on shared memory ethercards.
 318         The E21xx makes block_input() especially easy by wrapping the top
 319         ring buffer to the bottom automatically. */
 320 static void
 321 e21_block_input(struct net_device *dev, int count, struct sk_buff *skb, int ring_offset)
 322 {
 323         short ioaddr = dev->base_addr;
 324         char *shared_mem = (char *)dev->mem_start;
 325
 326         mem_on(ioaddr, shared_mem, (ring_offset>>8));
 327
 328         /* Packet is always in one chunk -- we can copy + cksum. */
 329         eth_io_copy_and_sum(skb, dev->mem_start + (ring_offset & 0xff), count, 0);
 330
 331         mem_off(ioaddr);
 332 }
 333
 334 static void
 335 e21_block_output(struct net_device *dev, int count, const unsigned char *buf,
 336                                  int start_page)
 337 {
 338         short ioaddr = dev->base_addr;
 339         volatile char *shared_mem = (char *)dev->mem_start;
 340
 341         /* Set the shared memory window start by doing a read, with the low address
 342            bits specifying the starting page. */
 343         readb(shared_mem + start_page);
 344         mem_on(ioaddr, shared_mem, start_page);
 345
 346         memcpy_toio(shared_mem, buf, count);
 347         mem_off(ioaddr);
 348 }
 349
 350 static int
 351 e21_close(struct net_device *dev)
 352 {
 353         short ioaddr = dev->base_addr;
 354
 355         if (ei_debug > 1)
 356                 printk("%s: Shutting down ethercard.\n", dev->name);
 357
 358         free_irq(dev->irq, dev);
 359         dev->irq = ei_status.saved_irq;
 360
 361         /* Shut off the interrupt line and secondary interface. */
 362         inb(ioaddr + E21_IRQ_LOW);
 363         outb(0, ioaddr + E21_ASIC);
 364         inb(ioaddr + E21_IRQ_HIGH);                     /* High IRQ bit, and if_port. */
 365         outb(0, ioaddr + E21_ASIC);
 366
 367         ei_close(dev);
 368
 369         /* Double-check that the memory has been turned off, because really
 370            really bad things happen if it isn't. */
 371         mem_off(ioaddr);
 372
 373         return 0;
 374 }
 375
 376 \f
 377 #ifdef MODULE
 378 #define MAX_E21_CARDS   4       /* Max number of E21 cards per module */
 379 static struct net_device dev_e21[MAX_E21_CARDS];
 380 static int io[MAX_E21_CARDS];
 381 static int irq[MAX_E21_CARDS];
 382 static int mem[MAX_E21_CARDS];
 383 static int xcvr[MAX_E21_CARDS];         /* choose int. or ext. xcvr */
 384
 385 MODULE_PARM(io, "1-" __MODULE_STRING(MAX_E21_CARDS) "i");
 386 MODULE_PARM(irq, "1-" __MODULE_STRING(MAX_E21_CARDS) "i");
 387 MODULE_PARM(mem, "1-" __MODULE_STRING(MAX_E21_CARDS) "i");
 388 MODULE_PARM(xcvr, "1-" __MODULE_STRING(MAX_E21_CARDS) "i");
 389 MODULE_PARM_DESC(io, "I/O base address(es)");
 390 MODULE_PARM_DESC(irq, "IRQ number(s)");
 391 MODULE_PARM_DESC(mem, " memory base address(es)");
 392 MODULE_PARM_DESC(xcvr, "transceiver(s) (0=internal, 1=external)");
 393 MODULE_DESCRIPTION("Cabletron E2100 ISA ethernet driver");
 394 MODULE_LICENSE("GPL");
 395
 396 /* This is set up so that only a single autoprobe takes place per call.
 397 ISA device autoprobes on a running machine are not recommended. */
 398 int
 399 init_module(void)
 400 {
 401         int this_dev, found = 0;
 402
 403         for (this_dev = 0; this_dev < MAX_E21_CARDS; this_dev++) {
 404                 struct net_device *dev = &dev_e21[this_dev];
 405                 dev->irq = irq[this_dev];
 406                 dev->base_addr = io[this_dev];
 407                 dev->mem_start = mem[this_dev];
 408                 dev->mem_end = xcvr[this_dev];  /* low 4bits = xcvr sel. */
 409                 dev->init = e2100_probe;
 410                 if (io[this_dev] == 0)  {
 411                         if (this_dev != 0) break; /* only autoprobe 1st one */
 412                         printk(KERN_NOTICE "e2100.c: Presently autoprobing (not recommended) for a single card.\n");
 413                 }
 414                 if (register_netdev(dev) != 0) {
 415                         printk(KERN_WARNING "e2100.c: No E2100 card found (i/o = 0x%x).\n", io[this_dev]);
 416                         if (found != 0) {       /* Got at least one. */
 417                                 return 0;
 418                         }
 419                         return -ENXIO;
 420                 }
 421                 found++;
 422         }
 423         return 0;
 424 }
 425
 426 void
 427 cleanup_module(void)
 428 {
 429         int this_dev;
 430
 431         for (this_dev = 0; this_dev < MAX_E21_CARDS; this_dev++) {
 432                 struct net_device *dev = &dev_e21[this_dev];
 433                 if (dev->priv != NULL) {
 434                         void *priv = dev->priv;
 435                         /* NB: e21_close() handles free_irq */
 436                         release_region(dev->base_addr, E21_IO_EXTENT);
 437                         unregister_netdev(dev);
 438                         kfree(priv);
 439                 }
 440         }
 441 }
 442 #endif /* MODULE */
 443
 444 \f
 445 /*
 446  * Local variables:
 447  *  compile-command: "gcc -D__KERNEL__ -I/usr/src/linux/net/inet -Wall -Wstrict-prototypes -O6 -m486 -c e2100.c"
 448  *  version-control: t
 449  *  tab-width: 4
 450  *  kept-new-versions: 5
 451  * End:
 452  */