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         iounmap(ei_status.mem);
 153 }
 154
 155 #ifndef MODULE
 156 struct net_device * __init lne390_probe(int unit)
 157 {
 158         struct net_device *dev = alloc_ei_netdev();
 159         int err;
 160
 161         if (!dev)
 162                 return ERR_PTR(-ENOMEM);
 163
 164         sprintf(dev->name, "eth%d", unit);
 165         netdev_boot_setup_check(dev);
 166
 167         err = do_lne390_probe(dev);
 168         if (err)
 169                 goto out;
 170         err = register_netdev(dev);
 171         if (err)
 172                 goto out1;
 173         return dev;
 174 out1:
 175         cleanup_card(dev);
 176 out:
 177         free_netdev(dev);
 178         return ERR_PTR(err);
 179 }
 180 #endif
 181
 182 static int __init lne390_probe1(struct net_device *dev, int ioaddr)
 183 {
 184         int i, revision, ret;
 185         unsigned long eisa_id;
 186
 187         if (inb_p(ioaddr + LNE390_ID_PORT) == 0xff) return -ENODEV;
 188
 189 #if LNE390_DEBUG & LNE390_D_PROBE
 190         printk("lne390-debug: probe at %#x, ID %#8x\n", ioaddr, inl(ioaddr + LNE390_ID_PORT));
 191         printk("lne390-debug: config regs: %#x %#x\n",
 192                 inb(ioaddr + LNE390_CFG1), inb(ioaddr + LNE390_CFG2));
 193 #endif
 194
 195
 196 /*      Check the EISA ID of the card. */
 197         eisa_id = inl(ioaddr + LNE390_ID_PORT);
 198         if ((eisa_id != LNE390_ID0) && (eisa_id != LNE390_ID1)) {
 199                 return -ENODEV;
 200         }
 201
 202         revision = (eisa_id >> 24) & 0x01;      /* 0 = rev A, 1 rev B */
 203
 204 #if 0
 205 /*      Check the Mylex vendor ID as well. Not really required. */
 206         if (inb(ioaddr + LNE390_SA_PROM + 0) != LNE390_ADDR0
 207                 || inb(ioaddr + LNE390_SA_PROM + 1) != LNE390_ADDR1
 208                 || inb(ioaddr + LNE390_SA_PROM + 2) != LNE390_ADDR2 ) {
 209                 printk("lne390.c: card not found");
 210                 for(i = 0; i < ETHER_ADDR_LEN; i++)
 211                         printk(" %02x", inb(ioaddr + LNE390_SA_PROM + i));
 212                 printk(" (invalid prefix).\n");
 213                 return -ENODEV;
 214         }
 215 #endif
 216
 217         printk("lne390.c: LNE390%X in EISA slot %d, address", 0xa+revision, ioaddr/0x1000);
 218         for(i = 0; i < ETHER_ADDR_LEN; i++)
 219                 printk(" %02x", (dev->dev_addr[i] = inb(ioaddr + LNE390_SA_PROM + i)));
 220         printk(".\nlne390.c: ");
 221
 222         /* Snarf the interrupt now. CFG file has them all listed as `edge' with share=NO */
 223         if (dev->irq == 0) {
 224                 unsigned char irq_reg = inb(ioaddr + LNE390_CFG2) >> 3;
 225                 dev->irq = irq_map[irq_reg & 0x07];
 226                 printk("using");
 227         } else {
 228                 /* This is useless unless we reprogram the card here too */
 229                 if (dev->irq == 2) dev->irq = 9;        /* Doh! */
 230                 printk("assigning");
 231         }
 232         printk(" IRQ %d,", dev->irq);
 233
 234         if ((ret = request_irq(dev->irq, ei_interrupt, 0, DRV_NAME, dev))) {
 235                 printk (" unable to get IRQ %d.\n", dev->irq);
 236                 return ret;
 237         }
 238
 239         if (dev->mem_start == 0) {
 240                 unsigned char mem_reg = inb(ioaddr + LNE390_CFG2) & 0x07;
 241
 242                 if (revision)   /* LNE390B */
 243                         dev->mem_start = shmem_mapB[mem_reg] * 0x10000;
 244                 else            /* LNE390A */
 245                         dev->mem_start = shmem_mapA[mem_reg] * 0x10000;
 246                 printk(" using ");
 247         } else {
 248                 /* Should check for value in shmem_map and reprogram the card to use it */
 249                 dev->mem_start &= 0xfff0000;
 250                 printk(" assigning ");
 251         }
 252
 253         printk("%dkB memory at physical address %#lx\n",
 254                         LNE390_STOP_PG/4, dev->mem_start);
 255
 256         /*
 257            BEWARE!! Some dain-bramaged EISA SCUs will allow you to put
 258            the card mem within the region covered by `normal' RAM  !!!
 259
 260            ioremap() will fail in that case.
 261         */
 262         ei_status.mem = ioremap(dev->mem_start, LNE390_STOP_PG*0x100);
 263         if (!ei_status.mem) {
 264                 printk(KERN_ERR "lne390.c: Unable to remap card memory above 1MB !!\n");
 265                 printk(KERN_ERR "lne390.c: Try using EISA SCU to set memory below 1MB.\n");
 266                 printk(KERN_ERR "lne390.c: Driver NOT installed.\n");
 267                 ret = -EAGAIN;
 268                 goto cleanup;
 269         }
 270         printk("lne390.c: remapped %dkB card memory to virtual address %p\n",
 271                         LNE390_STOP_PG/4, ei_status.mem);
 272
 273         dev->mem_start = (unsigned long)ei_status.mem;
 274         dev->mem_end = dev->mem_start + (LNE390_STOP_PG - LNE390_START_PG)*256;
 275
 276         /* The 8390 offset is zero for the LNE390 */
 277         dev->base_addr = ioaddr;
 278
 279         ei_status.name = "LNE390";
 280         ei_status.tx_start_page = LNE390_START_PG;
 281         ei_status.rx_start_page = LNE390_START_PG + TX_PAGES;
 282         ei_status.stop_page = LNE390_STOP_PG;
 283         ei_status.word16 = 1;
 284
 285         if (ei_debug > 0)
 286                 printk(version);
 287
 288         ei_status.reset_8390 = &lne390_reset_8390;
 289         ei_status.block_input = &lne390_block_input;
 290         ei_status.block_output = &lne390_block_output;
 291         ei_status.get_8390_hdr = &lne390_get_8390_hdr;
 292
 293         dev->open = &lne390_open;
 294         dev->stop = &lne390_close;
 295 #ifdef CONFIG_NET_POLL_CONTROLLER
 296         dev->poll_controller = ei_poll;
 297 #endif
 298         NS8390_init(dev, 0);
 299         return 0;
 300 cleanup:
 301         free_irq(dev->irq, dev);
 302         return ret;
 303 }
 304
 305 /*
 306  *      Reset as per the packet driver method. Judging by the EISA cfg
 307  *      file, this just toggles the "Board Enable" bits (bit 2 and 0).
 308  */
 309
 310 static void lne390_reset_8390(struct net_device *dev)
 311 {
 312         unsigned short ioaddr = dev->base_addr;
 313
 314         outb(0x04, ioaddr + LNE390_RESET_PORT);
 315         if (ei_debug > 1) printk("%s: resetting the LNE390...", dev->name);
 316
 317         mdelay(2);
 318
 319         ei_status.txing = 0;
 320         outb(0x01, ioaddr + LNE390_RESET_PORT);
 321         if (ei_debug > 1) printk("reset done\n");
 322
 323         return;
 324 }
 325
 326 /*
 327  *      Note: In the following three functions is the implicit assumption
 328  *      that the associated memcpy will only use "rep; movsl" as long as
 329  *      we keep the counts as some multiple of doublewords. This is a
 330  *      requirement of the hardware, and also prevents us from using
 331  *      eth_io_copy_and_sum() since we can't guarantee it will limit
 332  *      itself to doubleword access.
 333  */
 334
 335 /*
 336  *      Grab the 8390 specific header. Similar to the block_input routine, but
 337  *      we don't need to be concerned with ring wrap as the header will be at
 338  *      the start of a page, so we optimize accordingly. (A single doubleword.)
 339  */
 340
 341 static void
 342 lne390_get_8390_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr, int ring_page)
 343 {
 344         void __iomem *hdr_start = ei_status.mem + ((ring_page - LNE390_START_PG)<<8);
 345         memcpy_fromio(hdr, hdr_start, sizeof(struct e8390_pkt_hdr));
 346         hdr->count = (hdr->count + 3) & ~3;     /* Round up allocation. */
 347 }
 348
 349 /*
 350  *      Block input and output are easy on shared memory ethercards, the only
 351  *      complication is when the ring buffer wraps. The count will already
 352  *      be rounded up to a doubleword value via lne390_get_8390_hdr() above.
 353  */
 354
 355 static void lne390_block_input(struct net_device *dev, int count, struct sk_buff *skb,
 356                                                   int ring_offset)
 357 {
 358         void __iomem *xfer_start = ei_status.mem + ring_offset - (LNE390_START_PG<<8);
 359
 360         if (ring_offset + count > (LNE390_STOP_PG<<8)) {
 361                 /* Packet wraps over end of ring buffer. */
 362                 int semi_count = (LNE390_STOP_PG<<8) - ring_offset;
 363                 memcpy_fromio(skb->data, xfer_start, semi_count);
 364                 count -= semi_count;
 365                 memcpy_fromio(skb->data + semi_count,
 366                         ei_status.mem + (TX_PAGES<<8), count);
 367         } else {
 368                 /* Packet is in one chunk. */
 369                 memcpy_fromio(skb->data, xfer_start, count);
 370         }
 371 }
 372
 373 static void lne390_block_output(struct net_device *dev, int count,
 374                                 const unsigned char *buf, int start_page)
 375 {
 376         void __iomem *shmem = ei_status.mem + ((start_page - LNE390_START_PG)<<8);
 377
 378         count = (count + 3) & ~3;     /* Round up to doubleword */
 379         memcpy_toio(shmem, buf, count);
 380 }
 381
 382 static int lne390_open(struct net_device *dev)
 383 {
 384         ei_open(dev);
 385         return 0;
 386 }
 387
 388 static int lne390_close(struct net_device *dev)
 389 {
 390
 391         if (ei_debug > 1)
 392                 printk("%s: Shutting down ethercard.\n", dev->name);
 393
 394         ei_close(dev);
 395         return 0;
 396 }
 397
 398 #ifdef MODULE
 399 #define MAX_LNE_CARDS   4       /* Max number of LNE390 cards per module */
 400 static struct net_device *dev_lne[MAX_LNE_CARDS];
 401 static int io[MAX_LNE_CARDS];
 402 static int irq[MAX_LNE_CARDS];
 403 static int mem[MAX_LNE_CARDS];
 404
 405 module_param_array(io, int, NULL, 0);
 406 module_param_array(irq, int, NULL, 0);
 407 module_param_array(mem, int, NULL, 0);
 408 MODULE_PARM_DESC(io, "I/O base address(es)");
 409 MODULE_PARM_DESC(irq, "IRQ number(s)");
 410 MODULE_PARM_DESC(mem, "memory base address(es)");
 411 MODULE_DESCRIPTION("Mylex LNE390A/B EISA Ethernet driver");
 412 MODULE_LICENSE("GPL");
 413
 414 int init_module(void)
 415 {
 416         struct net_device *dev;
 417         int this_dev, found = 0;
 418
 419         for (this_dev = 0; this_dev < MAX_LNE_CARDS; this_dev++) {
 420                 if (io[this_dev] == 0 && this_dev != 0)
 421                         break;
 422                 dev = alloc_ei_netdev();
 423                 if (!dev)
 424                         break;
 425                 dev->irq = irq[this_dev];
 426                 dev->base_addr = io[this_dev];
 427                 dev->mem_start = mem[this_dev];
 428                 if (do_lne390_probe(dev) == 0) {
 429                         if (register_netdev(dev) == 0) {
 430                                 dev_lne[found++] = dev;
 431                                 continue;
 432                         }
 433                         cleanup_card(dev);
 434                 }
 435                 free_netdev(dev);
 436                 printk(KERN_WARNING "lne390.c: No LNE390 card found (i/o = 0x%x).\n", io[this_dev]);
 437                 break;
 438         }
 439         if (found)
 440                 return 0;
 441         return -ENXIO;
 442 }
 443
 444 void cleanup_module(void)
 445 {
 446         int this_dev;
 447
 448         for (this_dev = 0; this_dev < MAX_LNE_CARDS; this_dev++) {
 449                 struct net_device *dev = dev_lne[this_dev];
 450                 if (dev) {
 451                         unregister_netdev(dev);
 452                         cleanup_card(dev);
 453                         free_netdev(dev);
 454                 }
 455         }
 456 }
 457 #endif /* MODULE */
 458