drivers/net/lne390.c

   1 /*
   2         lne390.c
   3
   4         Linux driver for Mylex LNE390 EISA Network Adapter
   5
   6         Copyright (C) 1996-1998, Paul Gortmaker.
   7
   8         This software may be used and distributed according to the terms
   9         of the GNU General Public License, incorporated herein by reference.
  10
  11         Information and Code Sources:
  12
  13         1) Based upon framework of es3210 driver.
  14         2) The existing myriad of other Linux 8390 drivers by Donald Becker.
  15         3) Russ Nelson's asm packet driver provided additional info.
  16         4) Info for getting IRQ and sh-mem gleaned from the EISA cfg files.
  17
  18         The LNE390 is an EISA shared memory NS8390 implementation. Note
  19         that all memory copies to/from the board must be 32bit transfers.
  20         There are two versions of the card: the lne390a and the lne390b.
  21         Going by the EISA cfg files, the "a" has jumpers to select between
  22         BNC/AUI, but the "b" also has RJ-45 and selection is via the SCU.
  23         The shared memory address selection is also slightly different.
  24         Note that shared memory address > 1MB are supported with this driver.
  25
  26         You can try <http://www.mylex.com> if you want more info, as I've
  27         never even seen one of these cards.  :)
  28
  29         Arnaldo Carvalho de Melo <acme@conectiva.com.br> - 2000/09/01
  30         - get rid of check_region
  31         - no need to check if dev == NULL in lne390_probe1
  32 */
  33
  34 static const char *version =
  35         "lne390.c: Driver revision v0.99.1, 01/09/2000\n";
  36
  37 #include <linux/module.h>
  38 #include <linux/kernel.h>
  39 #include <linux/errno.h>
  40 #include <linux/string.h>
  41 #include <linux/delay.h>
  42 #include <linux/init.h>
  43 #include <linux/netdevice.h>
  44 #include <linux/etherdevice.h>
  45
  46 #include <asm/io.h>
  47 #include <asm/system.h>
  48
  49 #include "8390.h"
  50
  51 int lne390_probe(struct net_device *dev);
  52 static int lne390_probe1(struct net_device *dev, int ioaddr);
  53
  54 static int lne390_open(struct net_device *dev);
  55 static int lne390_close(struct net_device *dev);
  56
  57 static void lne390_reset_8390(struct net_device *dev);
  58
  59 static void lne390_get_8390_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr, int ring_page);
  60 static void lne390_block_input(struct net_device *dev, int count, struct sk_buff *skb, int ring_offset);
  61 static void lne390_block_output(struct net_device *dev, int count, const unsigned char *buf, const int start_page);
  62
  63 #define LNE390_START_PG         0x00    /* First page of TX buffer      */
  64 #define LNE390_STOP_PG          0x80    /* Last page +1 of RX ring      */
  65
  66 #define LNE390_ID_PORT          0xc80   /* Same for all EISA cards      */
  67 #define LNE390_IO_EXTENT        0x20
  68 #define LNE390_SA_PROM          0x16    /* Start of e'net addr.         */
  69 #define LNE390_RESET_PORT       0xc84   /* From the pkt driver source   */
  70 #define LNE390_NIC_OFFSET       0x00    /* Hello, the 8390 is *here*    */
  71
  72 #define LNE390_ADDR0            0x00    /* 3 byte vendor prefix         */
  73 #define LNE390_ADDR1            0x80
  74 #define LNE390_ADDR2            0xe5
  75
  76 #define LNE390_ID0      0x10009835      /* 0x3598 = 01101 01100 11000 = mlx */
  77 #define LNE390_ID1      0x11009835      /* above is the 390A, this is 390B  */
  78
  79 #define LNE390_CFG1             0xc84   /* NB: 0xc84 is also "reset" port. */
  80 #define LNE390_CFG2             0xc90
  81
  82 /*
  83  *      You can OR any of the following bits together and assign it
  84  *      to LNE390_DEBUG to get verbose driver info during operation.
  85  *      Currently only the probe one is implemented.
  86  */
  87
  88 #define LNE390_D_PROBE  0x01
  89 #define LNE390_D_RX_PKT 0x02
  90 #define LNE390_D_TX_PKT 0x04
  91 #define LNE390_D_IRQ    0x08
  92
  93 #define LNE390_DEBUG    0
  94
  95 static unsigned char irq_map[] __initdata = {15, 12, 11, 10, 9, 7, 5, 3};
  96 static unsigned int shmem_mapA[] __initdata = {0xff, 0xfe, 0xfd, 0xfff, 0xffe, 0xffc, 0x0d, 0x0};
  97 static unsigned int shmem_mapB[] __initdata = {0xff, 0xfe, 0x0e, 0xfff, 0xffe, 0xffc, 0x0d, 0x0};
  98
  99 /*
 100  *      Probe for the card. The best way is to read the EISA ID if it
 101  *      is known. Then we can check the prefix of the station address
 102  *      PROM for a match against the value assigned to Mylex.
 103  */
 104
 105 int __init lne390_probe(struct net_device *dev)
 106 {
 107         unsigned short ioaddr = dev->base_addr;
 108         int ret;
 109
 110         SET_MODULE_OWNER(dev);
 111
 112         if (ioaddr > 0x1ff) {           /* Check a single specified location. */
 113                 if (!request_region(ioaddr, LNE390_IO_EXTENT, dev->name))
 114                         return -EBUSY;
 115                 ret = lne390_probe1(dev, ioaddr);
 116                 if (ret)
 117                         release_region(ioaddr, LNE390_IO_EXTENT);
 118                 return ret;
 119         }
 120         else if (ioaddr > 0)            /* Don't probe at all. */
 121                 return -ENXIO;
 122
 123         if (!EISA_bus) {
 124 #if LNE390_DEBUG & LNE390_D_PROBE
 125                 printk("lne390-debug: Not an EISA bus. Not probing high ports.\n");
 126 #endif
 127                 return -ENXIO;
 128         }
 129
 130         /* EISA spec allows for up to 16 slots, but 8 is typical. */
 131         for (ioaddr = 0x1000; ioaddr < 0x9000; ioaddr += 0x1000) {
 132                 if (!request_region(ioaddr, LNE390_IO_EXTENT, dev->name))
 133                         continue;
 134                 if (lne390_probe1(dev, ioaddr) == 0)
 135                         return 0;
 136                 release_region(ioaddr, LNE390_IO_EXTENT);
 137         }
 138
 139         return -ENODEV;
 140 }
 141
 142 static int __init lne390_probe1(struct net_device *dev, int ioaddr)
 143 {
 144         int i, revision, ret;
 145         unsigned long eisa_id;
 146
 147         if (inb_p(ioaddr + LNE390_ID_PORT) == 0xff) return -ENODEV;
 148
 149 #if LNE390_DEBUG & LNE390_D_PROBE
 150         printk("lne390-debug: probe at %#x, ID %#8x\n", ioaddr, inl(ioaddr + LNE390_ID_PORT));
 151         printk("lne390-debug: config regs: %#x %#x\n",
 152                 inb(ioaddr + LNE390_CFG1), inb(ioaddr + LNE390_CFG2));
 153 #endif
 154
 155
 156 /*      Check the EISA ID of the card. */
 157         eisa_id = inl(ioaddr + LNE390_ID_PORT);
 158         if ((eisa_id != LNE390_ID0) && (eisa_id != LNE390_ID1)) {
 159                 return -ENODEV;
 160         }
 161
 162         revision = (eisa_id >> 24) & 0x01;      /* 0 = rev A, 1 rev B */
 163
 164 #if 0
 165 /*      Check the Mylex vendor ID as well. Not really required. */
 166         if (inb(ioaddr + LNE390_SA_PROM + 0) != LNE390_ADDR0
 167                 || inb(ioaddr + LNE390_SA_PROM + 1) != LNE390_ADDR1
 168                 || inb(ioaddr + LNE390_SA_PROM + 2) != LNE390_ADDR2 ) {
 169                 printk("lne390.c: card not found");
 170                 for(i = 0; i < ETHER_ADDR_LEN; i++)
 171                         printk(" %02x", inb(ioaddr + LNE390_SA_PROM + i));
 172                 printk(" (invalid prefix).\n");
 173                 return -ENODEV;
 174         }
 175 #endif
 176         /* Allocate dev->priv and fill in 8390 specific dev fields. */
 177         if (ethdev_init(dev)) {
 178                 printk ("lne390.c: unable to allocate memory for dev->priv!\n");
 179                 return -ENOMEM;
 180         }
 181
 182         printk("lne390.c: LNE390%X in EISA slot %d, address", 0xa+revision, ioaddr/0x1000);
 183         for(i = 0; i < ETHER_ADDR_LEN; i++)
 184                 printk(" %02x", (dev->dev_addr[i] = inb(ioaddr + LNE390_SA_PROM + i)));
 185         printk(".\nlne390.c: ");
 186
 187         /* Snarf the interrupt now. CFG file has them all listed as `edge' with share=NO */
 188         if (dev->irq == 0) {
 189                 unsigned char irq_reg = inb(ioaddr + LNE390_CFG2) >> 3;
 190                 dev->irq = irq_map[irq_reg & 0x07];
 191                 printk("using");
 192         } else {
 193                 /* This is useless unless we reprogram the card here too */
 194                 if (dev->irq == 2) dev->irq = 9;        /* Doh! */
 195                 printk("assigning");
 196         }
 197         printk(" IRQ %d,", dev->irq);
 198
 199         if ((ret = request_irq(dev->irq, ei_interrupt, 0, dev->name, dev))) {
 200                 printk (" unable to get IRQ %d.\n", dev->irq);
 201                 kfree(dev->priv);
 202                 dev->priv = NULL;
 203                 return ret;
 204         }
 205
 206         if (dev->mem_start == 0) {
 207                 unsigned char mem_reg = inb(ioaddr + LNE390_CFG2) & 0x07;
 208
 209                 if (revision)   /* LNE390B */
 210                         dev->mem_start = shmem_mapB[mem_reg] * 0x10000;
 211                 else            /* LNE390A */
 212                         dev->mem_start = shmem_mapA[mem_reg] * 0x10000;
 213                 printk(" using ");
 214         } else {
 215                 /* Should check for value in shmem_map and reprogram the card to use it */
 216                 dev->mem_start &= 0xfff0000;
 217                 printk(" assigning ");
 218         }
 219
 220         printk("%dkB memory at physical address %#lx\n",
 221                         LNE390_STOP_PG/4, dev->mem_start);
 222
 223         /*
 224            BEWARE!! Some dain-bramaged EISA SCUs will allow you to put
 225            the card mem within the region covered by `normal' RAM  !!!
 226         */
 227         if (dev->mem_start > 1024*1024) {       /* phys addr > 1MB */
 228                 if (dev->mem_start < virt_to_phys(high_memory)) {
 229                         printk(KERN_CRIT "lne390.c: Card RAM overlaps with normal memory!!!\n");
 230                         printk(KERN_CRIT "lne390.c: Use EISA SCU to set card memory below 1MB,\n");
 231                         printk(KERN_CRIT "lne390.c: or to an address above 0x%lx.\n", virt_to_phys(high_memory));
 232                         printk(KERN_CRIT "lne390.c: Driver NOT installed.\n");
 233                         ret = -EINVAL;
 234                         goto cleanup;
 235                 }
 236                 dev->mem_start = (unsigned long)ioremap(dev->mem_start, LNE390_STOP_PG*0x100);
 237                 if (dev->mem_start == 0) {
 238                         printk(KERN_ERR "lne390.c: Unable to remap card memory above 1MB !!\n");
 239                         printk(KERN_ERR "lne390.c: Try using EISA SCU to set memory below 1MB.\n");
 240                         printk(KERN_ERR "lne390.c: Driver NOT installed.\n");
 241                         ret = -EAGAIN;
 242                         goto cleanup;
 243                 }
 244                 ei_status.reg0 = 1;     /* Use as remap flag */
 245                 printk("lne390.c: remapped %dkB card memory to virtual address %#lx\n",
 246                                 LNE390_STOP_PG/4, dev->mem_start);
 247         }
 248
 249         dev->mem_end = ei_status.rmem_end = dev->mem_start
 250                 + (LNE390_STOP_PG - LNE390_START_PG)*256;
 251         ei_status.rmem_start = dev->mem_start + TX_PAGES*256;
 252
 253         /* The 8390 offset is zero for the LNE390 */
 254         dev->base_addr = ioaddr;
 255
 256         ei_status.name = "LNE390";
 257         ei_status.tx_start_page = LNE390_START_PG;
 258         ei_status.rx_start_page = LNE390_START_PG + TX_PAGES;
 259         ei_status.stop_page = LNE390_STOP_PG;
 260         ei_status.word16 = 1;
 261
 262         if (ei_debug > 0)
 263                 printk(version);
 264
 265         ei_status.reset_8390 = &lne390_reset_8390;
 266         ei_status.block_input = &lne390_block_input;
 267         ei_status.block_output = &lne390_block_output;
 268         ei_status.get_8390_hdr = &lne390_get_8390_hdr;
 269
 270         dev->open = &lne390_open;
 271         dev->stop = &lne390_close;
 272         NS8390_init(dev, 0);
 273         return 0;
 274 cleanup:
 275         free_irq(dev->irq, dev);
 276         kfree(dev->priv);
 277         dev->priv = NULL;
 278         return ret;
 279 }
 280
 281 /*
 282  *      Reset as per the packet driver method. Judging by the EISA cfg
 283  *      file, this just toggles the "Board Enable" bits (bit 2 and 0).
 284  */
 285
 286 static void lne390_reset_8390(struct net_device *dev)
 287 {
 288         unsigned short ioaddr = dev->base_addr;
 289
 290         outb(0x04, ioaddr + LNE390_RESET_PORT);
 291         if (ei_debug > 1) printk("%s: resetting the LNE390...", dev->name);
 292
 293         mdelay(2);
 294
 295         ei_status.txing = 0;
 296         outb(0x01, ioaddr + LNE390_RESET_PORT);
 297         if (ei_debug > 1) printk("reset done\n");
 298
 299         return;
 300 }
 301
 302 /*
 303  *      Note: In the following three functions is the implicit assumption
 304  *      that the associated memcpy will only use "rep; movsl" as long as
 305  *      we keep the counts as some multiple of doublewords. This is a
 306  *      requirement of the hardware, and also prevents us from using
 307  *      eth_io_copy_and_sum() since we can't guarantee it will limit
 308  *      itself to doubleword access.
 309  */
 310
 311 /*
 312  *      Grab the 8390 specific header. Similar to the block_input routine, but
 313  *      we don't need to be concerned with ring wrap as the header will be at
 314  *      the start of a page, so we optimize accordingly. (A single doubleword.)
 315  */
 316
 317 static void
 318 lne390_get_8390_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr, int ring_page)
 319 {
 320         unsigned long hdr_start = dev->mem_start + ((ring_page - LNE390_START_PG)<<8);
 321         isa_memcpy_fromio(hdr, hdr_start, sizeof(struct e8390_pkt_hdr));
 322         hdr->count = (hdr->count + 3) & ~3;     /* Round up allocation. */
 323 }
 324
 325 /*
 326  *      Block input and output are easy on shared memory ethercards, the only
 327  *      complication is when the ring buffer wraps. The count will already
 328  *      be rounded up to a doubleword value via lne390_get_8390_hdr() above.
 329  */
 330
 331 static void lne390_block_input(struct net_device *dev, int count, struct sk_buff *skb,
 332                                                   int ring_offset)
 333 {
 334         unsigned long xfer_start = dev->mem_start + ring_offset - (LNE390_START_PG<<8);
 335
 336         if (xfer_start + count > ei_status.rmem_end) {
 337                 /* Packet wraps over end of ring buffer. */
 338                 int semi_count = ei_status.rmem_end - xfer_start;
 339                 isa_memcpy_fromio(skb->data, xfer_start, semi_count);
 340                 count -= semi_count;
 341                 isa_memcpy_fromio(skb->data + semi_count, ei_status.rmem_start, count);
 342         } else {
 343                 /* Packet is in one chunk. */
 344                 isa_memcpy_fromio(skb->data, xfer_start, count);
 345         }
 346 }
 347
 348 static void lne390_block_output(struct net_device *dev, int count,
 349                                 const unsigned char *buf, int start_page)
 350 {
 351         unsigned long shmem = dev->mem_start + ((start_page - LNE390_START_PG)<<8);
 352
 353         count = (count + 3) & ~3;     /* Round up to doubleword */
 354         isa_memcpy_toio(shmem, buf, count);
 355 }
 356
 357 static int lne390_open(struct net_device *dev)
 358 {
 359         ei_open(dev);
 360         return 0;
 361 }
 362
 363 static int lne390_close(struct net_device *dev)
 364 {
 365
 366         if (ei_debug > 1)
 367                 printk("%s: Shutting down ethercard.\n", dev->name);
 368
 369         ei_close(dev);
 370         return 0;
 371 }
 372
 373 #ifdef MODULE
 374 #define MAX_LNE_CARDS   4       /* Max number of LNE390 cards per module */
 375 static struct net_device dev_lne[MAX_LNE_CARDS];
 376 static int io[MAX_LNE_CARDS];
 377 static int irq[MAX_LNE_CARDS];
 378 static int mem[MAX_LNE_CARDS];
 379
 380 MODULE_PARM(io, "1-" __MODULE_STRING(MAX_LNE_CARDS) "i");
 381 MODULE_PARM(irq, "1-" __MODULE_STRING(MAX_LNE_CARDS) "i");
 382 MODULE_PARM(mem, "1-" __MODULE_STRING(MAX_LNE_CARDS) "i");
 383 MODULE_PARM_DESC(io, "I/O base address(es)");
 384 MODULE_PARM_DESC(irq, "IRQ number(s)");
 385 MODULE_PARM_DESC(mem, "memory base address(es)");
 386 MODULE_DESCRIPTION("Mylex LNE390A/B EISA Ethernet driver");
 387 MODULE_LICENSE("GPL");
 388
 389 int init_module(void)
 390 {
 391         int this_dev, found = 0;
 392
 393         for (this_dev = 0; this_dev < MAX_LNE_CARDS; this_dev++) {
 394                 struct net_device *dev = &dev_lne[this_dev];
 395                 dev->irq = irq[this_dev];
 396                 dev->base_addr = io[this_dev];
 397                 dev->mem_start = mem[this_dev];
 398                 dev->init = lne390_probe;
 399                 /* Default is to only install one card. */
 400                 if (io[this_dev] == 0 && this_dev != 0) break;
 401                 if (register_netdev(dev) != 0) {
 402                         printk(KERN_WARNING "lne390.c: No LNE390 card found (i/o = 0x%x).\n", io[this_dev]);
 403                         if (found != 0) {       /* Got at least one. */
 404                                 return 0;
 405                         }
 406                         return -ENXIO;
 407                 }
 408                 found++;
 409         }
 410         return 0;
 411 }
 412
 413 void cleanup_module(void)
 414 {
 415         int this_dev;
 416
 417         for (this_dev = 0; this_dev < MAX_LNE_CARDS; this_dev++) {
 418                 struct net_device *dev = &dev_lne[this_dev];
 419                 if (dev->priv != NULL) {
 420                         void *priv = dev->priv;
 421                         free_irq(dev->irq, dev);
 422                         release_region(dev->base_addr, LNE390_IO_EXTENT);
 423                         if (ei_status.reg0)
 424                                 iounmap((void *)dev->mem_start);
 425                         unregister_netdev(dev);
 426                         kfree(priv);
 427                 }
 428         }
 429 }
 430 #endif /* MODULE */
 431