drivers/net/ne3210.c

   1 /*
   2         ne3210.c
   3
   4         Linux driver for Novell NE3210 EISA Network Adapter
   5
   6         Copyright (C) 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 my other EISA 8390 drivers (lne390, es3210, smc-ultra32)
  14         2) The existing myriad of other Linux 8390 drivers by Donald Becker.
  15         3) Info for getting IRQ and sh-mem gleaned from the EISA cfg file
  16
  17         The NE3210 is an EISA shared memory NS8390 implementation.  Shared
  18         memory address > 1MB should work with this driver.
  19
  20         Note that the .cfg file (3/11/93, v1.0) has AUI and BNC switched
  21         around (or perhaps there are some defective/backwards cards ???)
  22
  23         This driver WILL NOT WORK FOR THE NE3200 - it is completely different
  24         and does not use an 8390 at all.
  25
  26         Updated to EISA probing API 5/2003 by Marc Zyngier.
  27 */
  28
  29 static const char *version =
  30         "ne3210.c: Driver revision v0.03, 30/09/98\n";
  31
  32 #include <linux/module.h>
  33 #include <linux/eisa.h>
  34 #include <linux/kernel.h>
  35 #include <linux/errno.h>
  36 #include <linux/string.h>
  37 #include <linux/delay.h>
  38 #include <linux/init.h>
  39 #include <linux/interrupt.h>
  40 #include <linux/netdevice.h>
  41 #include <linux/etherdevice.h>
  42
  43 #include <asm/io.h>
  44 #include <asm/system.h>
  45
  46 #include "8390.h"
  47
  48 static int ne3210_open(struct net_device *dev);
  49 static int ne3210_close(struct net_device *dev);
  50
  51 static void ne3210_reset_8390(struct net_device *dev);
  52
  53 static void ne3210_get_8390_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr, int ring_page);
  54 static void ne3210_block_input(struct net_device *dev, int count, struct sk_buff *skb, int ring_offset);
  55 static void ne3210_block_output(struct net_device *dev, int count, const unsigned char *buf, const int start_page);
  56
  57 #define NE3210_START_PG         0x00    /* First page of TX buffer      */
  58 #define NE3210_STOP_PG          0x80    /* Last page +1 of RX ring      */
  59
  60 #define NE3210_IO_EXTENT        0x20
  61 #define NE3210_SA_PROM          0x16    /* Start of e'net addr.         */
  62 #define NE3210_RESET_PORT       0xc84
  63 #define NE3210_NIC_OFFSET       0x00    /* Hello, the 8390 is *here*    */
  64
  65 #define NE3210_ADDR0            0x00    /* 3 byte vendor prefix         */
  66 #define NE3210_ADDR1            0x00
  67 #define NE3210_ADDR2            0x1b
  68
  69 #define NE3210_CFG1             0xc84   /* NB: 0xc84 is also "reset" port. */
  70 #define NE3210_CFG2             0xc90
  71 #define NE3210_CFG_EXTENT       (NE3210_CFG2 - NE3210_CFG1 + 1)
  72
  73 /*
  74  *      You can OR any of the following bits together and assign it
  75  *      to NE3210_DEBUG to get verbose driver info during operation.
  76  *      Currently only the probe one is implemented.
  77  */
  78
  79 #define NE3210_D_PROBE  0x01
  80 #define NE3210_D_RX_PKT 0x02
  81 #define NE3210_D_TX_PKT 0x04
  82 #define NE3210_D_IRQ    0x08
  83
  84 #define NE3210_DEBUG    0x0
  85
  86 static unsigned char irq_map[] __initdata = {15, 12, 11, 10, 9, 7, 5, 3};
  87 static unsigned int shmem_map[] __initdata = {0xff0, 0xfe0, 0xfff0, 0xd8, 0xffe0, 0xffc0, 0xd0, 0x0};
  88 static const char *ifmap[] __initdata = {"UTP", "?", "BNC", "AUI"};
  89 static int ifmap_val[] __initdata = {
  90                 IF_PORT_10BASET,
  91                 IF_PORT_UNKNOWN,
  92                 IF_PORT_10BASE2,
  93                 IF_PORT_AUI,
  94 };
  95
  96 static int __init ne3210_eisa_probe (struct device *device)
  97 {
  98         unsigned long ioaddr, phys_mem;
  99         int i, retval, port_index;
 100         struct eisa_device *edev = to_eisa_device (device);
 101         struct net_device *dev;
 102
 103         /* Allocate dev->priv and fill in 8390 specific dev fields. */
 104         if (!(dev = alloc_ei_netdev ())) {
 105                 printk ("ne3210.c: unable to allocate memory for dev!\n");
 106                 return -ENOMEM;
 107         }
 108
 109         SET_MODULE_OWNER(dev);
 110         SET_NETDEV_DEV(dev, device);
 111         device->driver_data = dev;
 112         ioaddr = edev->base_addr;
 113
 114         if (!request_region(ioaddr, NE3210_IO_EXTENT, dev->name)) {
 115                 retval = -EBUSY;
 116                 goto out;
 117         }
 118
 119         if (!request_region(ioaddr + NE3210_CFG1,
 120                             NE3210_CFG_EXTENT, dev->name)) {
 121                 retval = -EBUSY;
 122                 goto out1;
 123         }
 124
 125 #if NE3210_DEBUG & NE3210_D_PROBE
 126         printk("ne3210-debug: probe at %#x, ID %s\n", ioaddr, edev->id.sig);
 127         printk("ne3210-debug: config regs: %#x %#x\n",
 128                 inb(ioaddr + NE3210_CFG1), inb(ioaddr + NE3210_CFG2));
 129 #endif
 130
 131
 132         port_index = inb(ioaddr + NE3210_CFG2) >> 6;
 133         printk("ne3210.c: NE3210 in EISA slot %d, media: %s, addr:",
 134                 edev->slot, ifmap[port_index]);
 135         for(i = 0; i < ETHER_ADDR_LEN; i++)
 136                 printk(" %02x", (dev->dev_addr[i] = inb(ioaddr + NE3210_SA_PROM + i)));
 137
 138
 139         /* Snarf the interrupt now. CFG file has them all listed as `edge' with share=NO */
 140         dev->irq = irq_map[(inb(ioaddr + NE3210_CFG2) >> 3) & 0x07];
 141         printk(".\nne3210.c: using IRQ %d, ", dev->irq);
 142
 143         retval = request_irq(dev->irq, ei_interrupt, 0, dev->name, dev);
 144         if (retval) {
 145                 printk (" unable to get IRQ %d.\n", dev->irq);
 146                 goto out2;
 147         }
 148
 149         phys_mem = shmem_map[inb(ioaddr + NE3210_CFG2) & 0x07] * 0x1000;
 150
 151         /*
 152            BEWARE!! Some dain-bramaged EISA SCUs will allow you to put
 153            the card mem within the region covered by `normal' RAM  !!!
 154         */
 155         if (phys_mem > 1024*1024) {     /* phys addr > 1MB */
 156                 if (phys_mem < virt_to_phys(high_memory)) {
 157                         printk(KERN_CRIT "ne3210.c: Card RAM overlaps with normal memory!!!\n");
 158                         printk(KERN_CRIT "ne3210.c: Use EISA SCU to set card memory below 1MB,\n");
 159                         printk(KERN_CRIT "ne3210.c: or to an address above 0x%lx.\n", virt_to_phys(high_memory));
 160                         printk(KERN_CRIT "ne3210.c: Driver NOT installed.\n");
 161                         retval = -EINVAL;
 162                         goto out3;
 163                 }
 164         }
 165
 166         if (!request_mem_region (phys_mem, NE3210_STOP_PG*0x100, dev->name)) {
 167                 printk ("ne3210.c: Unable to request shared memory at physical address %#lx\n",
 168                         phys_mem);
 169                 goto out3;
 170         }
 171
 172         printk("%dkB memory at physical address %#lx\n",
 173                NE3210_STOP_PG/4, phys_mem);
 174
 175         dev->mem_start = (unsigned long)ioremap(phys_mem, NE3210_STOP_PG*0x100);
 176         if (dev->mem_start == 0) {
 177                 printk(KERN_ERR "ne3210.c: Unable to remap card memory !!\n");
 178                 printk(KERN_ERR "ne3210.c: Driver NOT installed.\n");
 179                 retval = -EAGAIN;
 180                 goto out4;
 181         }
 182         printk("ne3210.c: remapped %dkB card memory to virtual address %#lx\n",
 183                NE3210_STOP_PG/4, dev->mem_start);
 184         dev->mem_end = ei_status.rmem_end = dev->mem_start
 185                 + (NE3210_STOP_PG - NE3210_START_PG)*256;
 186         ei_status.rmem_start = dev->mem_start + TX_PAGES*256;
 187
 188         /* The 8390 offset is zero for the NE3210 */
 189         dev->base_addr = ioaddr;
 190
 191         ei_status.name = "NE3210";
 192         ei_status.tx_start_page = NE3210_START_PG;
 193         ei_status.rx_start_page = NE3210_START_PG + TX_PAGES;
 194         ei_status.stop_page = NE3210_STOP_PG;
 195         ei_status.word16 = 1;
 196         ei_status.priv = phys_mem;
 197
 198         if (ei_debug > 0)
 199                 printk(version);
 200
 201         ei_status.reset_8390 = &ne3210_reset_8390;
 202         ei_status.block_input = &ne3210_block_input;
 203         ei_status.block_output = &ne3210_block_output;
 204         ei_status.get_8390_hdr = &ne3210_get_8390_hdr;
 205
 206         dev->open = &ne3210_open;
 207         dev->stop = &ne3210_close;
 208 #ifdef CONFIG_NET_POLL_CONTROLLER
 209         dev->poll_controller = ei_poll;
 210 #endif
 211         dev->if_port = ifmap_val[port_index];
 212
 213         if ((retval = register_netdev (dev)))
 214                 goto out5;
 215
 216         NS8390_init(dev, 0);
 217         return 0;
 218
 219  out5:
 220         iounmap((void *)dev->mem_start);
 221  out4:
 222         release_mem_region (phys_mem, NE3210_STOP_PG*0x100);
 223  out3:
 224         free_irq (dev->irq, dev);
 225  out2:
 226         release_region (ioaddr + NE3210_CFG1, NE3210_CFG_EXTENT);
 227  out1:
 228         release_region (ioaddr, NE3210_IO_EXTENT);
 229  out:
 230         free_netdev (dev);
 231
 232         return retval;
 233 }
 234
 235 static int __devexit ne3210_eisa_remove (struct device *device)
 236 {
 237         struct net_device  *dev    = device->driver_data;
 238         unsigned long       ioaddr = to_eisa_device (device)->base_addr;
 239
 240         unregister_netdev (dev);
 241         iounmap((void *)dev->mem_start);
 242         release_mem_region (ei_status.priv, NE3210_STOP_PG*0x100);
 243         free_irq (dev->irq, dev);
 244         release_region (ioaddr + NE3210_CFG1, NE3210_CFG_EXTENT);
 245         release_region (ioaddr, NE3210_IO_EXTENT);
 246         free_netdev (dev);
 247
 248         return 0;
 249 }
 250
 251 /*
 252  *      Reset by toggling the "Board Enable" bits (bit 2 and 0).
 253  */
 254
 255 static void ne3210_reset_8390(struct net_device *dev)
 256 {
 257         unsigned short ioaddr = dev->base_addr;
 258
 259         outb(0x04, ioaddr + NE3210_RESET_PORT);
 260         if (ei_debug > 1) printk("%s: resetting the NE3210...", dev->name);
 261
 262         mdelay(2);
 263
 264         ei_status.txing = 0;
 265         outb(0x01, ioaddr + NE3210_RESET_PORT);
 266         if (ei_debug > 1) printk("reset done\n");
 267
 268         return;
 269 }
 270
 271 /*
 272  *      Note: In the following three functions is the implicit assumption
 273  *      that the associated memcpy will only use "rep; movsl" as long as
 274  *      we keep the counts as some multiple of doublewords. This is a
 275  *      requirement of the hardware, and also prevents us from using
 276  *      eth_io_copy_and_sum() since we can't guarantee it will limit
 277  *      itself to doubleword access.
 278  */
 279
 280 /*
 281  *      Grab the 8390 specific header. Similar to the block_input routine, but
 282  *      we don't need to be concerned with ring wrap as the header will be at
 283  *      the start of a page, so we optimize accordingly. (A single doubleword.)
 284  */
 285
 286 static void
 287 ne3210_get_8390_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr, int ring_page)
 288 {
 289         unsigned long hdr_start = dev->mem_start + ((ring_page - NE3210_START_PG)<<8);
 290         memcpy_fromio(hdr, hdr_start, sizeof(struct e8390_pkt_hdr));
 291         hdr->count = (hdr->count + 3) & ~3;     /* Round up allocation. */
 292 }
 293
 294 /*
 295  *      Block input and output are easy on shared memory ethercards, the only
 296  *      complication is when the ring buffer wraps. The count will already
 297  *      be rounded up to a doubleword value via ne3210_get_8390_hdr() above.
 298  */
 299
 300 static void ne3210_block_input(struct net_device *dev, int count, struct sk_buff *skb,
 301                                                   int ring_offset)
 302 {
 303         unsigned long xfer_start = dev->mem_start + ring_offset - (NE3210_START_PG<<8);
 304
 305         if (xfer_start + count > ei_status.rmem_end) {
 306                 /* Packet wraps over end of ring buffer. */
 307                 int semi_count = ei_status.rmem_end - xfer_start;
 308                 memcpy_fromio(skb->data, xfer_start, semi_count);
 309                 count -= semi_count;
 310                 memcpy_fromio(skb->data + semi_count, ei_status.rmem_start, count);
 311         } else {
 312                 /* Packet is in one chunk. */
 313                 memcpy_fromio(skb->data, xfer_start, count);
 314         }
 315 }
 316
 317 static void ne3210_block_output(struct net_device *dev, int count,
 318                                 const unsigned char *buf, int start_page)
 319 {
 320         unsigned long shmem = dev->mem_start + ((start_page - NE3210_START_PG)<<8);
 321
 322         count = (count + 3) & ~3;     /* Round up to doubleword */
 323         memcpy_toio(shmem, buf, count);
 324 }
 325
 326 static int ne3210_open(struct net_device *dev)
 327 {
 328         ei_open(dev);
 329         return 0;
 330 }
 331
 332 static int ne3210_close(struct net_device *dev)
 333 {
 334
 335         if (ei_debug > 1)
 336                 printk("%s: Shutting down ethercard.\n", dev->name);
 337
 338         ei_close(dev);
 339         return 0;
 340 }
 341
 342 static struct eisa_device_id ne3210_ids[] = {
 343         { "EGL0101" },
 344         { "NVL1801" },
 345         { "" },
 346 };
 347
 348 static struct eisa_driver ne3210_eisa_driver = {
 349         .id_table = ne3210_ids,
 350         .driver   = {
 351                 .name   = "ne3210",
 352                 .probe  = ne3210_eisa_probe,
 353                 .remove = __devexit_p (ne3210_eisa_remove),
 354         },
 355 };
 356
 357 MODULE_DESCRIPTION("NE3210 EISA Ethernet driver");
 358 MODULE_LICENSE("GPL");
 359
 360 int ne3210_init(void)
 361 {
 362         return eisa_driver_register (&ne3210_eisa_driver);
 363 }
 364
 365 void ne3210_cleanup(void)
 366 {
 367         eisa_driver_unregister (&ne3210_eisa_driver);
 368 }
 369
 370 module_init (ne3210_init);
 371 module_exit (ne3210_cleanup);