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