drivers/net/zorro8390.c

   1 /*
   2  *  Amiga Linux/m68k and Linux/PPC Zorro NS8390 Ethernet Driver
   3  *
   4  *  (C) Copyright 1998-2000 by some Elitist 680x0 Users(TM)
   5  *
   6  *  ---------------------------------------------------------------------------
   7  *
   8  *  This program is based on all the other NE2000 drivers for Linux
   9  *
  10  *  ---------------------------------------------------------------------------
  11  *
  12  *  This file is subject to the terms and conditions of the GNU General Public
  13  *  License.  See the file COPYING in the main directory of the Linux
  14  *  distribution for more details.
  15  *
  16  *  ---------------------------------------------------------------------------
  17  *
  18  *  The Ariadne II and X-Surf are Zorro-II boards containing Realtek RTL8019AS
  19  *  Ethernet Controllers.
  20  */
  21
  22 #include <linux/module.h>
  23 #include <linux/kernel.h>
  24 #include <linux/errno.h>
  25 #include <linux/init.h>
  26 #include <linux/delay.h>
  27 #include <linux/netdevice.h>
  28 #include <linux/etherdevice.h>
  29 #include <linux/zorro.h>
  30 #include <linux/jiffies.h>
  31
  32 #include <asm/system.h>
  33 #include <asm/irq.h>
  34 #include <asm/amigaints.h>
  35 #include <asm/amigahw.h>
  36
  37 #define EI_SHIFT(x)     (ei_local->reg_offset[x])
  38 #define ei_inb(port)   in_8(port)
  39 #define ei_outb(val,port)  out_8(port,val)
  40 #define ei_inb_p(port)   in_8(port)
  41 #define ei_outb_p(val,port)  out_8(port,val)
  42
  43 static const char version[] =
  44     "8390.c:v1.10cvs 9/23/94 Donald Becker (becker@cesdis.gsfc.nasa.gov)\n";
  45
  46 #include "lib8390.c"
  47
  48 #define DRV_NAME        "zorro8390"
  49
  50 #define NE_BASE         (dev->base_addr)
  51 #define NE_CMD          (0x00*2)
  52 #define NE_DATAPORT     (0x10*2)        /* NatSemi-defined port window offset. */
  53 #define NE_RESET        (0x1f*2)        /* Issue a read to reset, a write to clear. */
  54 #define NE_IO_EXTENT    (0x20*2)
  55
  56 #define NE_EN0_ISR      (0x07*2)
  57 #define NE_EN0_DCFG     (0x0e*2)
  58
  59 #define NE_EN0_RSARLO   (0x08*2)
  60 #define NE_EN0_RSARHI   (0x09*2)
  61 #define NE_EN0_RCNTLO   (0x0a*2)
  62 #define NE_EN0_RXCR     (0x0c*2)
  63 #define NE_EN0_TXCR     (0x0d*2)
  64 #define NE_EN0_RCNTHI   (0x0b*2)
  65 #define NE_EN0_IMR      (0x0f*2)
  66
  67 #define NESM_START_PG   0x40    /* First page of TX buffer */
  68 #define NESM_STOP_PG    0x80    /* Last page +1 of RX ring */
  69
  70
  71 #define WORDSWAP(a)     ((((a)>>8)&0xff) | ((a)<<8))
  72
  73
  74 static struct card_info {
  75     zorro_id id;
  76     const char *name;
  77     unsigned int offset;
  78 } cards[] __devinitdata = {
  79     { ZORRO_PROD_VILLAGE_TRONIC_ARIADNE2, "Ariadne II", 0x0600 },
  80     { ZORRO_PROD_INDIVIDUAL_COMPUTERS_X_SURF, "X-Surf", 0x8600 },
  81 };
  82
  83 static int __devinit zorro8390_init_one(struct zorro_dev *z,
  84                                         const struct zorro_device_id *ent);
  85 static int __devinit zorro8390_init(struct net_device *dev,
  86                                     unsigned long board, const char *name,
  87                                     unsigned long ioaddr);
  88 static int zorro8390_open(struct net_device *dev);
  89 static int zorro8390_close(struct net_device *dev);
  90 static void zorro8390_reset_8390(struct net_device *dev);
  91 static void zorro8390_get_8390_hdr(struct net_device *dev,
  92                                    struct e8390_pkt_hdr *hdr, int ring_page);
  93 static void zorro8390_block_input(struct net_device *dev, int count,
  94                                   struct sk_buff *skb, int ring_offset);
  95 static void zorro8390_block_output(struct net_device *dev, const int count,
  96                                    const unsigned char *buf,
  97                                    const int start_page);
  98 static void __devexit zorro8390_remove_one(struct zorro_dev *z);
  99
 100 static struct zorro_device_id zorro8390_zorro_tbl[] __devinitdata = {
 101     { ZORRO_PROD_VILLAGE_TRONIC_ARIADNE2, },
 102     { ZORRO_PROD_INDIVIDUAL_COMPUTERS_X_SURF, },
 103     { 0 }
 104 };
 105 MODULE_DEVICE_TABLE(zorro, zorro8390_zorro_tbl);
 106
 107 static struct zorro_driver zorro8390_driver = {
 108     .name       = "zorro8390",
 109     .id_table   = zorro8390_zorro_tbl,
 110     .probe      = zorro8390_init_one,
 111     .remove     = __devexit_p(zorro8390_remove_one),
 112 };
 113
 114 static int __devinit zorro8390_init_one(struct zorro_dev *z,
 115                                         const struct zorro_device_id *ent)
 116 {
 117     struct net_device *dev;
 118     unsigned long board, ioaddr;
 119     int err, i;
 120
 121     for (i = ARRAY_SIZE(cards)-1; i >= 0; i--)
 122         if (z->id == cards[i].id)
 123             break;
 124     if (i < 0)
 125         return -ENODEV;
 126
 127     board = z->resource.start;
 128     ioaddr = board+cards[i].offset;
 129     dev = alloc_ei_netdev();
 130     if (!dev)
 131         return -ENOMEM;
 132     if (!request_mem_region(ioaddr, NE_IO_EXTENT*2, DRV_NAME)) {
 133         free_netdev(dev);
 134         return -EBUSY;
 135     }
 136     if ((err = zorro8390_init(dev, board, cards[i].name,
 137                               ZTWO_VADDR(ioaddr)))) {
 138         release_mem_region(ioaddr, NE_IO_EXTENT*2);
 139         free_netdev(dev);
 140         return err;
 141     }
 142     zorro_set_drvdata(z, dev);
 143     return 0;
 144 }
 145
 146 static const struct net_device_ops zorro8390_netdev_ops = {
 147         .ndo_open               = zorro8390_open,
 148         .ndo_stop               = zorro8390_close,
 149         .ndo_start_xmit         = ei_start_xmit,
 150         .ndo_tx_timeout         = ei_tx_timeout,
 151         .ndo_get_stats          = ei_get_stats,
 152         .ndo_set_multicast_list = ei_set_multicast_list,
 153         .ndo_validate_addr      = eth_validate_addr,
 154         .ndo_set_mac_address    = eth_mac_addr,
 155         .ndo_change_mtu         = eth_change_mtu,
 156 #ifdef CONFIG_NET_POLL_CONTROLLER
 157         .ndo_poll_controller    = ei_poll,
 158 #endif
 159 };
 160
 161 static int __devinit zorro8390_init(struct net_device *dev,
 162                                     unsigned long board, const char *name,
 163                                     unsigned long ioaddr)
 164 {
 165     int i;
 166     int err;
 167     unsigned char SA_prom[32];
 168     int start_page, stop_page;
 169     static u32 zorro8390_offsets[16] = {
 170         0x00, 0x02, 0x04, 0x06, 0x08, 0x0a, 0x0c, 0x0e,
 171         0x10, 0x12, 0x14, 0x16, 0x18, 0x1a, 0x1c, 0x1e,
 172     };
 173
 174     /* Reset card. Who knows what dain-bramaged state it was left in. */
 175     {
 176         unsigned long reset_start_time = jiffies;
 177
 178         z_writeb(z_readb(ioaddr + NE_RESET), ioaddr + NE_RESET);
 179
 180         while ((z_readb(ioaddr + NE_EN0_ISR) & ENISR_RESET) == 0)
 181             if (time_after(jiffies, reset_start_time + 2*HZ/100)) {
 182                 printk(KERN_WARNING " not found (no reset ack).\n");
 183                 return -ENODEV;
 184             }
 185
 186         z_writeb(0xff, ioaddr + NE_EN0_ISR);            /* Ack all intr. */
 187     }
 188
 189     /* Read the 16 bytes of station address PROM.
 190        We must first initialize registers, similar to NS8390_init(eifdev, 0).
 191        We can't reliably read the SAPROM address without this.
 192        (I learned the hard way!). */
 193     {
 194         struct {
 195             u32 value;
 196             u32 offset;
 197         } program_seq[] = {
 198             {E8390_NODMA+E8390_PAGE0+E8390_STOP, NE_CMD}, /* Select page 0*/
 199             {0x48,      NE_EN0_DCFG},   /* Set byte-wide (0x48) access. */
 200             {0x00,      NE_EN0_RCNTLO}, /* Clear the count regs. */
 201             {0x00,      NE_EN0_RCNTHI},
 202             {0x00,      NE_EN0_IMR},    /* Mask completion irq. */
 203             {0xFF,      NE_EN0_ISR},
 204             {E8390_RXOFF, NE_EN0_RXCR}, /* 0x20  Set to monitor */
 205             {E8390_TXOFF, NE_EN0_TXCR}, /* 0x02  and loopback mode. */
 206             {32,        NE_EN0_RCNTLO},
 207             {0x00,      NE_EN0_RCNTHI},
 208             {0x00,      NE_EN0_RSARLO}, /* DMA starting at 0x0000. */
 209             {0x00,      NE_EN0_RSARHI},
 210             {E8390_RREAD+E8390_START, NE_CMD},
 211         };
 212         for (i = 0; i < ARRAY_SIZE(program_seq); i++) {
 213             z_writeb(program_seq[i].value, ioaddr + program_seq[i].offset);
 214         }
 215     }
 216     for (i = 0; i < 16; i++) {
 217         SA_prom[i] = z_readb(ioaddr + NE_DATAPORT);
 218         (void)z_readb(ioaddr + NE_DATAPORT);
 219     }
 220
 221     /* We must set the 8390 for word mode. */
 222     z_writeb(0x49, ioaddr + NE_EN0_DCFG);
 223     start_page = NESM_START_PG;
 224     stop_page = NESM_STOP_PG;
 225
 226     dev->base_addr = ioaddr;
 227     dev->irq = IRQ_AMIGA_PORTS;
 228
 229     /* Install the Interrupt handler */
 230     i = request_irq(IRQ_AMIGA_PORTS, __ei_interrupt, IRQF_SHARED, DRV_NAME, dev);
 231     if (i) return i;
 232
 233     for(i = 0; i < ETHER_ADDR_LEN; i++)
 234         dev->dev_addr[i] = SA_prom[i];
 235
 236 #ifdef DEBUG
 237     printk("%pM", dev->dev_addr);
 238 #endif
 239
 240     ei_status.name = name;
 241     ei_status.tx_start_page = start_page;
 242     ei_status.stop_page = stop_page;
 243     ei_status.word16 = 1;
 244
 245     ei_status.rx_start_page = start_page + TX_PAGES;
 246
 247     ei_status.reset_8390 = &zorro8390_reset_8390;
 248     ei_status.block_input = &zorro8390_block_input;
 249     ei_status.block_output = &zorro8390_block_output;
 250     ei_status.get_8390_hdr = &zorro8390_get_8390_hdr;
 251     ei_status.reg_offset = zorro8390_offsets;
 252
 253     dev->netdev_ops = &zorro8390_netdev_ops;
 254     __NS8390_init(dev, 0);
 255     err = register_netdev(dev);
 256     if (err) {
 257         free_irq(IRQ_AMIGA_PORTS, dev);
 258         return err;
 259     }
 260
 261     printk(KERN_INFO "%s: %s at 0x%08lx, Ethernet Address %pM\n",
 262            dev->name, name, board, dev->dev_addr);
 263
 264     return 0;
 265 }
 266
 267 static int zorro8390_open(struct net_device *dev)
 268 {
 269     __ei_open(dev);
 270     return 0;
 271 }
 272
 273 static int zorro8390_close(struct net_device *dev)
 274 {
 275     if (ei_debug > 1)
 276         printk(KERN_DEBUG "%s: Shutting down ethercard.\n", dev->name);
 277     __ei_close(dev);
 278     return 0;
 279 }
 280
 281 /* Hard reset the card.  This used to pause for the same period that a
 282    8390 reset command required, but that shouldn't be necessary. */
 283 static void zorro8390_reset_8390(struct net_device *dev)
 284 {
 285     unsigned long reset_start_time = jiffies;
 286
 287     if (ei_debug > 1)
 288         printk(KERN_DEBUG "resetting the 8390 t=%ld...\n", jiffies);
 289
 290     z_writeb(z_readb(NE_BASE + NE_RESET), NE_BASE + NE_RESET);
 291
 292     ei_status.txing = 0;
 293     ei_status.dmaing = 0;
 294
 295     /* This check _should_not_ be necessary, omit eventually. */
 296     while ((z_readb(NE_BASE+NE_EN0_ISR) & ENISR_RESET) == 0)
 297         if (time_after(jiffies, reset_start_time + 2*HZ/100)) {
 298             printk(KERN_WARNING "%s: ne_reset_8390() did not complete.\n",
 299                    dev->name);
 300             break;
 301         }
 302     z_writeb(ENISR_RESET, NE_BASE + NE_EN0_ISR);        /* Ack intr. */
 303 }
 304
 305 /* Grab the 8390 specific header. Similar to the block_input routine, but
 306    we don't need to be concerned with ring wrap as the header will be at
 307    the start of a page, so we optimize accordingly. */
 308
 309 static void zorro8390_get_8390_hdr(struct net_device *dev,
 310                                    struct e8390_pkt_hdr *hdr, int ring_page)
 311 {
 312     int nic_base = dev->base_addr;
 313     int cnt;
 314     short *ptrs;
 315
 316     /* This *shouldn't* happen. If it does, it's the last thing you'll see */
 317     if (ei_status.dmaing) {
 318         printk(KERN_ERR "%s: DMAing conflict in ne_get_8390_hdr "
 319            "[DMAstat:%d][irqlock:%d].\n", dev->name, ei_status.dmaing,
 320            ei_status.irqlock);
 321         return;
 322     }
 323
 324     ei_status.dmaing |= 0x01;
 325     z_writeb(E8390_NODMA+E8390_PAGE0+E8390_START, nic_base+ NE_CMD);
 326     z_writeb(ENISR_RDC, nic_base + NE_EN0_ISR);
 327     z_writeb(sizeof(struct e8390_pkt_hdr), nic_base + NE_EN0_RCNTLO);
 328     z_writeb(0, nic_base + NE_EN0_RCNTHI);
 329     z_writeb(0, nic_base + NE_EN0_RSARLO);              /* On page boundary */
 330     z_writeb(ring_page, nic_base + NE_EN0_RSARHI);
 331     z_writeb(E8390_RREAD+E8390_START, nic_base + NE_CMD);
 332
 333     ptrs = (short*)hdr;
 334     for (cnt = 0; cnt < (sizeof(struct e8390_pkt_hdr)>>1); cnt++)
 335         *ptrs++ = z_readw(NE_BASE + NE_DATAPORT);
 336
 337     z_writeb(ENISR_RDC, nic_base + NE_EN0_ISR); /* Ack intr. */
 338
 339     hdr->count = WORDSWAP(hdr->count);
 340
 341     ei_status.dmaing &= ~0x01;
 342 }
 343
 344 /* Block input and output, similar to the Crynwr packet driver.  If you
 345    are porting to a new ethercard, look at the packet driver source for hints.
 346    The NEx000 doesn't share the on-board packet memory -- you have to put
 347    the packet out through the "remote DMA" dataport using z_writeb. */
 348
 349 static void zorro8390_block_input(struct net_device *dev, int count,
 350                                  struct sk_buff *skb, int ring_offset)
 351 {
 352     int nic_base = dev->base_addr;
 353     char *buf = skb->data;
 354     short *ptrs;
 355     int cnt;
 356
 357     /* This *shouldn't* happen. If it does, it's the last thing you'll see */
 358     if (ei_status.dmaing) {
 359         printk(KERN_ERR "%s: DMAing conflict in ne_block_input "
 360            "[DMAstat:%d][irqlock:%d].\n",
 361            dev->name, ei_status.dmaing, ei_status.irqlock);
 362         return;
 363     }
 364     ei_status.dmaing |= 0x01;
 365     z_writeb(E8390_NODMA+E8390_PAGE0+E8390_START, nic_base+ NE_CMD);
 366     z_writeb(ENISR_RDC, nic_base + NE_EN0_ISR);
 367     z_writeb(count & 0xff, nic_base + NE_EN0_RCNTLO);
 368     z_writeb(count >> 8, nic_base + NE_EN0_RCNTHI);
 369     z_writeb(ring_offset & 0xff, nic_base + NE_EN0_RSARLO);
 370     z_writeb(ring_offset >> 8, nic_base + NE_EN0_RSARHI);
 371     z_writeb(E8390_RREAD+E8390_START, nic_base + NE_CMD);
 372     ptrs = (short*)buf;
 373     for (cnt = 0; cnt < (count>>1); cnt++)
 374         *ptrs++ = z_readw(NE_BASE + NE_DATAPORT);
 375     if (count & 0x01)
 376         buf[count-1] = z_readb(NE_BASE + NE_DATAPORT);
 377
 378     z_writeb(ENISR_RDC, nic_base + NE_EN0_ISR); /* Ack intr. */
 379     ei_status.dmaing &= ~0x01;
 380 }
 381
 382 static void zorro8390_block_output(struct net_device *dev, int count,
 383                                    const unsigned char *buf,
 384                                    const int start_page)
 385 {
 386     int nic_base = NE_BASE;
 387     unsigned long dma_start;
 388     short *ptrs;
 389     int cnt;
 390
 391     /* Round the count up for word writes.  Do we need to do this?
 392        What effect will an odd byte count have on the 8390?
 393        I should check someday. */
 394     if (count & 0x01)
 395         count++;
 396
 397     /* This *shouldn't* happen. If it does, it's the last thing you'll see */
 398     if (ei_status.dmaing) {
 399         printk(KERN_ERR "%s: DMAing conflict in ne_block_output."
 400            "[DMAstat:%d][irqlock:%d]\n", dev->name, ei_status.dmaing,
 401            ei_status.irqlock);
 402         return;
 403     }
 404     ei_status.dmaing |= 0x01;
 405     /* We should already be in page 0, but to be safe... */
 406     z_writeb(E8390_PAGE0+E8390_START+E8390_NODMA, nic_base + NE_CMD);
 407
 408     z_writeb(ENISR_RDC, nic_base + NE_EN0_ISR);
 409
 410    /* Now the normal output. */
 411     z_writeb(count & 0xff, nic_base + NE_EN0_RCNTLO);
 412     z_writeb(count >> 8,   nic_base + NE_EN0_RCNTHI);
 413     z_writeb(0x00, nic_base + NE_EN0_RSARLO);
 414     z_writeb(start_page, nic_base + NE_EN0_RSARHI);
 415
 416     z_writeb(E8390_RWRITE+E8390_START, nic_base + NE_CMD);
 417     ptrs = (short*)buf;
 418     for (cnt = 0; cnt < count>>1; cnt++)
 419         z_writew(*ptrs++, NE_BASE+NE_DATAPORT);
 420
 421     dma_start = jiffies;
 422
 423     while ((z_readb(NE_BASE + NE_EN0_ISR) & ENISR_RDC) == 0)
 424         if (time_after(jiffies, dma_start + 2*HZ/100)) {        /* 20ms */
 425                 printk(KERN_ERR "%s: timeout waiting for Tx RDC.\n",
 426                        dev->name);
 427                 zorro8390_reset_8390(dev);
 428                 __NS8390_init(dev,1);
 429                 break;
 430         }
 431
 432     z_writeb(ENISR_RDC, nic_base + NE_EN0_ISR); /* Ack intr. */
 433     ei_status.dmaing &= ~0x01;
 434 }
 435
 436 static void __devexit zorro8390_remove_one(struct zorro_dev *z)
 437 {
 438     struct net_device *dev = zorro_get_drvdata(z);
 439
 440     unregister_netdev(dev);
 441     free_irq(IRQ_AMIGA_PORTS, dev);
 442     release_mem_region(ZTWO_PADDR(dev->base_addr), NE_IO_EXTENT*2);
 443     free_netdev(dev);
 444 }
 445
 446 static int __init zorro8390_init_module(void)
 447 {
 448     return zorro_register_driver(&zorro8390_driver);
 449 }
 450
 451 static void __exit zorro8390_cleanup_module(void)
 452 {
 453     zorro_unregister_driver(&zorro8390_driver);
 454 }
 455
 456 module_init(zorro8390_init_module);
 457 module_exit(zorro8390_cleanup_module);
 458
 459 MODULE_LICENSE("GPL");