linux/drivers/net/zorro8390.c
<<
>>
Prefs
   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
  43static 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
  74static 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
  83static int __devinit zorro8390_init_one(struct zorro_dev *z,
  84                                        const struct zorro_device_id *ent);
  85static int __devinit zorro8390_init(struct net_device *dev,
  86                                    unsigned long board, const char *name,
  87                                    unsigned long ioaddr);
  88static int zorro8390_open(struct net_device *dev);
  89static int zorro8390_close(struct net_device *dev);
  90static void zorro8390_reset_8390(struct net_device *dev);
  91static void zorro8390_get_8390_hdr(struct net_device *dev,
  92                                   struct e8390_pkt_hdr *hdr, int ring_page);
  93static void zorro8390_block_input(struct net_device *dev, int count,
  94                                  struct sk_buff *skb, int ring_offset);
  95static void zorro8390_block_output(struct net_device *dev, const int count,
  96                                   const unsigned char *buf,
  97                                   const int start_page);
  98static void __devexit zorro8390_remove_one(struct zorro_dev *z);
  99
 100static 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
 106static struct zorro_driver zorro8390_driver = {
 107    .name       = "zorro8390",
 108    .id_table   = zorro8390_zorro_tbl,
 109    .probe      = zorro8390_init_one,
 110    .remove     = __devexit_p(zorro8390_remove_one),
 111};
 112
 113static int __devinit zorro8390_init_one(struct zorro_dev *z,
 114                                        const struct zorro_device_id *ent)
 115{
 116    struct net_device *dev;
 117    unsigned long board, ioaddr;
 118    int err, i;
 119
 120    for (i = ARRAY_SIZE(cards)-1; i >= 0; i--)
 121        if (z->id == cards[i].id)
 122            break;
 123    if (i < 0)
 124        return -ENODEV;
 125
 126    board = z->resource.start;
 127    ioaddr = board+cards[i].offset;
 128    dev = alloc_ei_netdev();
 129    if (!dev)
 130        return -ENOMEM;
 131    if (!request_mem_region(ioaddr, NE_IO_EXTENT*2, DRV_NAME)) {
 132        free_netdev(dev);
 133        return -EBUSY;
 134    }
 135    if ((err = zorro8390_init(dev, board, cards[i].name,
 136                              ZTWO_VADDR(ioaddr)))) {
 137        release_mem_region(ioaddr, NE_IO_EXTENT*2);
 138        free_netdev(dev);
 139        return err;
 140    }
 141    zorro_set_drvdata(z, dev);
 142    return 0;
 143}
 144
 145static const struct net_device_ops zorro8390_netdev_ops = {
 146        .ndo_open               = zorro8390_open,
 147        .ndo_stop               = zorro8390_close,
 148        .ndo_start_xmit         = ei_start_xmit,
 149        .ndo_tx_timeout         = ei_tx_timeout,
 150        .ndo_get_stats          = ei_get_stats,
 151        .ndo_set_multicast_list = ei_set_multicast_list,
 152        .ndo_validate_addr      = eth_validate_addr,
 153        .ndo_set_mac_address    = eth_mac_addr,
 154        .ndo_change_mtu         = eth_change_mtu,
 155#ifdef CONFIG_NET_POLL_CONTROLLER
 156        .ndo_poll_controller    = ei_poll,
 157#endif
 158};
 159
 160static int __devinit zorro8390_init(struct net_device *dev,
 161                                    unsigned long board, const char *name,
 162                                    unsigned long ioaddr)
 163{
 164    int i;
 165    int err;
 166    unsigned char SA_prom[32];
 167    int start_page, stop_page;
 168    static u32 zorro8390_offsets[16] = {
 169        0x00, 0x02, 0x04, 0x06, 0x08, 0x0a, 0x0c, 0x0e,
 170        0x10, 0x12, 0x14, 0x16, 0x18, 0x1a, 0x1c, 0x1e,
 171    };
 172
 173    /* Reset card. Who knows what dain-bramaged state it was left in. */
 174    {
 175        unsigned long reset_start_time = jiffies;
 176
 177        z_writeb(z_readb(ioaddr + NE_RESET), ioaddr + NE_RESET);
 178
 179        while ((z_readb(ioaddr + NE_EN0_ISR) & ENISR_RESET) == 0)
 180            if (time_after(jiffies, reset_start_time + 2*HZ/100)) {
 181                printk(KERN_WARNING " not found (no reset ack).\n");
 182                return -ENODEV;
 183            }
 184
 185        z_writeb(0xff, ioaddr + NE_EN0_ISR);            /* Ack all intr. */
 186    }
 187
 188    /* Read the 16 bytes of station address PROM.
 189       We must first initialize registers, similar to NS8390_init(eifdev, 0).
 190       We can't reliably read the SAPROM address without this.
 191       (I learned the hard way!). */
 192    {
 193        struct {
 194            u32 value;
 195            u32 offset;
 196        } program_seq[] = {
 197            {E8390_NODMA+E8390_PAGE0+E8390_STOP, NE_CMD}, /* Select page 0*/
 198            {0x48,      NE_EN0_DCFG},   /* Set byte-wide (0x48) access. */
 199            {0x00,      NE_EN0_RCNTLO}, /* Clear the count regs. */
 200            {0x00,      NE_EN0_RCNTHI},
 201            {0x00,      NE_EN0_IMR},    /* Mask completion irq. */
 202            {0xFF,      NE_EN0_ISR},
 203            {E8390_RXOFF, NE_EN0_RXCR}, /* 0x20  Set to monitor */
 204            {E8390_TXOFF, NE_EN0_TXCR}, /* 0x02  and loopback mode. */
 205            {32,        NE_EN0_RCNTLO},
 206            {0x00,      NE_EN0_RCNTHI},
 207            {0x00,      NE_EN0_RSARLO}, /* DMA starting at 0x0000. */
 208            {0x00,      NE_EN0_RSARHI},
 209            {E8390_RREAD+E8390_START, NE_CMD},
 210        };
 211        for (i = 0; i < ARRAY_SIZE(program_seq); i++) {
 212            z_writeb(program_seq[i].value, ioaddr + program_seq[i].offset);
 213        }
 214    }
 215    for (i = 0; i < 16; i++) {
 216        SA_prom[i] = z_readb(ioaddr + NE_DATAPORT);
 217        (void)z_readb(ioaddr + NE_DATAPORT);
 218    }
 219
 220    /* We must set the 8390 for word mode. */
 221    z_writeb(0x49, ioaddr + NE_EN0_DCFG);
 222    start_page = NESM_START_PG;
 223    stop_page = NESM_STOP_PG;
 224
 225    dev->base_addr = ioaddr;
 226    dev->irq = IRQ_AMIGA_PORTS;
 227
 228    /* Install the Interrupt handler */
 229    i = request_irq(IRQ_AMIGA_PORTS, __ei_interrupt, IRQF_SHARED, DRV_NAME, dev);
 230    if (i) return i;
 231
 232    for(i = 0; i < ETHER_ADDR_LEN; i++)
 233        dev->dev_addr[i] = SA_prom[i];
 234
 235#ifdef DEBUG
 236    printk("%pM", dev->dev_addr);
 237#endif
 238
 239    ei_status.name = name;
 240    ei_status.tx_start_page = start_page;
 241    ei_status.stop_page = stop_page;
 242    ei_status.word16 = 1;
 243
 244    ei_status.rx_start_page = start_page + TX_PAGES;
 245
 246    ei_status.reset_8390 = &zorro8390_reset_8390;
 247    ei_status.block_input = &zorro8390_block_input;
 248    ei_status.block_output = &zorro8390_block_output;
 249    ei_status.get_8390_hdr = &zorro8390_get_8390_hdr;
 250    ei_status.reg_offset = zorro8390_offsets;
 251
 252    dev->netdev_ops = &zorro8390_netdev_ops;
 253    __NS8390_init(dev, 0);
 254    err = register_netdev(dev);
 255    if (err) {
 256        free_irq(IRQ_AMIGA_PORTS, dev);
 257        return err;
 258    }
 259
 260    printk(KERN_INFO "%s: %s at 0x%08lx, Ethernet Address %pM\n",
 261           dev->name, name, board, dev->dev_addr);
 262
 263    return 0;
 264}
 265
 266static int zorro8390_open(struct net_device *dev)
 267{
 268    __ei_open(dev);
 269    return 0;
 270}
 271
 272static int zorro8390_close(struct net_device *dev)
 273{
 274    if (ei_debug > 1)
 275        printk(KERN_DEBUG "%s: Shutting down ethercard.\n", dev->name);
 276    __ei_close(dev);
 277    return 0;
 278}
 279
 280/* Hard reset the card.  This used to pause for the same period that a
 281   8390 reset command required, but that shouldn't be necessary. */
 282static void zorro8390_reset_8390(struct net_device *dev)
 283{
 284    unsigned long reset_start_time = jiffies;
 285
 286    if (ei_debug > 1)
 287        printk(KERN_DEBUG "resetting the 8390 t=%ld...\n", jiffies);
 288
 289    z_writeb(z_readb(NE_BASE + NE_RESET), NE_BASE + NE_RESET);
 290
 291    ei_status.txing = 0;
 292    ei_status.dmaing = 0;
 293
 294    /* This check _should_not_ be necessary, omit eventually. */
 295    while ((z_readb(NE_BASE+NE_EN0_ISR) & ENISR_RESET) == 0)
 296        if (time_after(jiffies, reset_start_time + 2*HZ/100)) {
 297            printk(KERN_WARNING "%s: ne_reset_8390() did not complete.\n",
 298                   dev->name);
 299            break;
 300        }
 301    z_writeb(ENISR_RESET, NE_BASE + NE_EN0_ISR);        /* Ack intr. */
 302}
 303
 304/* Grab the 8390 specific header. Similar to the block_input routine, but
 305   we don't need to be concerned with ring wrap as the header will be at
 306   the start of a page, so we optimize accordingly. */
 307
 308static void zorro8390_get_8390_hdr(struct net_device *dev,
 309                                   struct e8390_pkt_hdr *hdr, int ring_page)
 310{
 311    int nic_base = dev->base_addr;
 312    int cnt;
 313    short *ptrs;
 314
 315    /* This *shouldn't* happen. If it does, it's the last thing you'll see */
 316    if (ei_status.dmaing) {
 317        printk(KERN_ERR "%s: DMAing conflict in ne_get_8390_hdr "
 318           "[DMAstat:%d][irqlock:%d].\n", dev->name, ei_status.dmaing,
 319           ei_status.irqlock);
 320        return;
 321    }
 322
 323    ei_status.dmaing |= 0x01;
 324    z_writeb(E8390_NODMA+E8390_PAGE0+E8390_START, nic_base+ NE_CMD);
 325    z_writeb(ENISR_RDC, nic_base + NE_EN0_ISR);
 326    z_writeb(sizeof(struct e8390_pkt_hdr), nic_base + NE_EN0_RCNTLO);
 327    z_writeb(0, nic_base + NE_EN0_RCNTHI);
 328    z_writeb(0, nic_base + NE_EN0_RSARLO);              /* On page boundary */
 329    z_writeb(ring_page, nic_base + NE_EN0_RSARHI);
 330    z_writeb(E8390_RREAD+E8390_START, nic_base + NE_CMD);
 331
 332    ptrs = (short*)hdr;
 333    for (cnt = 0; cnt < (sizeof(struct e8390_pkt_hdr)>>1); cnt++)
 334        *ptrs++ = z_readw(NE_BASE + NE_DATAPORT);
 335
 336    z_writeb(ENISR_RDC, nic_base + NE_EN0_ISR); /* Ack intr. */
 337
 338    hdr->count = WORDSWAP(hdr->count);
 339
 340    ei_status.dmaing &= ~0x01;
 341}
 342
 343/* Block input and output, similar to the Crynwr packet driver.  If you
 344   are porting to a new ethercard, look at the packet driver source for hints.
 345   The NEx000 doesn't share the on-board packet memory -- you have to put
 346   the packet out through the "remote DMA" dataport using z_writeb. */
 347
 348static void zorro8390_block_input(struct net_device *dev, int count,
 349                                 struct sk_buff *skb, int ring_offset)
 350{
 351    int nic_base = dev->base_addr;
 352    char *buf = skb->data;
 353    short *ptrs;
 354    int cnt;
 355
 356    /* This *shouldn't* happen. If it does, it's the last thing you'll see */
 357    if (ei_status.dmaing) {
 358        printk(KERN_ERR "%s: DMAing conflict in ne_block_input "
 359           "[DMAstat:%d][irqlock:%d].\n",
 360           dev->name, ei_status.dmaing, ei_status.irqlock);
 361        return;
 362    }
 363    ei_status.dmaing |= 0x01;
 364    z_writeb(E8390_NODMA+E8390_PAGE0+E8390_START, nic_base+ NE_CMD);
 365    z_writeb(ENISR_RDC, nic_base + NE_EN0_ISR);
 366    z_writeb(count & 0xff, nic_base + NE_EN0_RCNTLO);
 367    z_writeb(count >> 8, nic_base + NE_EN0_RCNTHI);
 368    z_writeb(ring_offset & 0xff, nic_base + NE_EN0_RSARLO);
 369    z_writeb(ring_offset >> 8, nic_base + NE_EN0_RSARHI);
 370    z_writeb(E8390_RREAD+E8390_START, nic_base + NE_CMD);
 371    ptrs = (short*)buf;
 372    for (cnt = 0; cnt < (count>>1); cnt++)
 373        *ptrs++ = z_readw(NE_BASE + NE_DATAPORT);
 374    if (count & 0x01)
 375        buf[count-1] = z_readb(NE_BASE + NE_DATAPORT);
 376
 377    z_writeb(ENISR_RDC, nic_base + NE_EN0_ISR); /* Ack intr. */
 378    ei_status.dmaing &= ~0x01;
 379}
 380
 381static void zorro8390_block_output(struct net_device *dev, int count,
 382                                   const unsigned char *buf,
 383                                   const int start_page)
 384{
 385    int nic_base = NE_BASE;
 386    unsigned long dma_start;
 387    short *ptrs;
 388    int cnt;
 389
 390    /* Round the count up for word writes.  Do we need to do this?
 391       What effect will an odd byte count have on the 8390?
 392       I should check someday. */
 393    if (count & 0x01)
 394        count++;
 395
 396    /* This *shouldn't* happen. If it does, it's the last thing you'll see */
 397    if (ei_status.dmaing) {
 398        printk(KERN_ERR "%s: DMAing conflict in ne_block_output."
 399           "[DMAstat:%d][irqlock:%d]\n", dev->name, ei_status.dmaing,
 400           ei_status.irqlock);
 401        return;
 402    }
 403    ei_status.dmaing |= 0x01;
 404    /* We should already be in page 0, but to be safe... */
 405    z_writeb(E8390_PAGE0+E8390_START+E8390_NODMA, nic_base + NE_CMD);
 406
 407    z_writeb(ENISR_RDC, nic_base + NE_EN0_ISR);
 408
 409   /* Now the normal output. */
 410    z_writeb(count & 0xff, nic_base + NE_EN0_RCNTLO);
 411    z_writeb(count >> 8,   nic_base + NE_EN0_RCNTHI);
 412    z_writeb(0x00, nic_base + NE_EN0_RSARLO);
 413    z_writeb(start_page, nic_base + NE_EN0_RSARHI);
 414
 415    z_writeb(E8390_RWRITE+E8390_START, nic_base + NE_CMD);
 416    ptrs = (short*)buf;
 417    for (cnt = 0; cnt < count>>1; cnt++)
 418        z_writew(*ptrs++, NE_BASE+NE_DATAPORT);
 419
 420    dma_start = jiffies;
 421
 422    while ((z_readb(NE_BASE + NE_EN0_ISR) & ENISR_RDC) == 0)
 423        if (time_after(jiffies, dma_start + 2*HZ/100)) {        /* 20ms */
 424                printk(KERN_ERR "%s: timeout waiting for Tx RDC.\n",
 425                       dev->name);
 426                zorro8390_reset_8390(dev);
 427                __NS8390_init(dev,1);
 428                break;
 429        }
 430
 431    z_writeb(ENISR_RDC, nic_base + NE_EN0_ISR); /* Ack intr. */
 432    ei_status.dmaing &= ~0x01;
 433    return;
 434}
 435
 436static 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
 446static int __init zorro8390_init_module(void)
 447{
 448    return zorro_register_driver(&zorro8390_driver);
 449}
 450
 451static void __exit zorro8390_cleanup_module(void)
 452{
 453    zorro_unregister_driver(&zorro8390_driver);
 454}
 455
 456module_init(zorro8390_init_module);
 457module_exit(zorro8390_cleanup_module);
 458
 459MODULE_LICENSE("GPL");
 460