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