/* wd.c: A WD80x3 ethernet driver for linux. */
/*
    Written 1993 by Donald Becker. This is alpha test code.
    This is a extension to the Linux operating system, and is covered by
    same Gnu Public License that covers that work.
    
    This is a driver for the WD8003 and WD8013 ethercards.

    The Author may be reached as becker@super.org or
    C/O Supercomputing Research Ctr., 17100 Science Dr., Bowie MD 20715

    Thanks to Russ Nelson (nelson@crnwyr.com) for loaning me a WD8013.
*/

static char *version =
    "wd.c:v0.28a 1/28/93 Donald Becker (becker@super.org)\n";

#include <linux/config.h>
#include <linux/kernel.h>
#include <linux/sched.h>
#include <asm/io.h>
#include <asm/system.h>
#include <memory.h>

#include "dev.h"
#include "8390.h"


extern void NS8390_init(struct device *dev, int startp);
extern int ei_debug;
extern struct sigaction ei_sigaction;
extern struct ei_device ei_status;

int wdprobe(int ioaddr, struct device *dev);
int wdprobe1(int ioaddr, struct device *dev);

static void wd_reset_8390(struct device *dev);
static int wd_block_input(struct device *dev, int count,
			  char *buf, int ring_offset);
static void wd_block_output(struct device *dev, int count,
			    const unsigned char *buf, const start_page);
static int wd_close_card(struct device *dev);


/* The stop page doesn't use the whole packet buffer RAM for the
   16 bit versions.  This could be changed for the final version. */
#define WD_START_PG	0x00	/* First page of TX buffer */
#define WD_STOP_PG	0x40	/* Last page +1 of RX ring */

#define WD_CMDREG	0	/* Offset to ASIC command register. */
#define  WD_RESET	0x80	/* Board reset, in WD_CMDREG. */
#define  WD_MEMENB	0x40	/* Enable the shared memory. */
#define WD_CMDREG5	5	/* Offset to 16-bit-only ASIC register 5. */
#define  ISA16		0x80	/* Enable 16 bit access from the ISA bus. */
#define  NIC16		0x40	/* Enable 16 bit access from the 8390. */
#define WD_NIC_OFFSET	16	/* Offset to the 8390 NIC from the base_addr. */

/*  Probe for the WD8003 and WD8013.  These cards have the station
    address PROM at I/O ports <base>+8 to <base>+13, with a checksum
    following. The routine also initializes the card and fills the
    station address field. */

int wdprobe(int ioaddr,  struct device *dev)
{
    int *port, ports[] = {0x300, 0x280, 0};

    if (ioaddr > 0x100)
	return wdprobe1(ioaddr, dev);

    for (port = &ports[0]; *port; port++)
	if (inb_p(*port) != 0xff && wdprobe1(*port, dev))
	    return dev->base_addr;
    return 0;
}

int wdprobe1(int ioaddr, struct device *dev)
{
  int i;
  unsigned char *station_addr = dev->dev_addr;
  int checksum = 0;
  int bits16 = 0;

#if defined(EI_DEBUG) && EI_DEBUG > 2
  printk("WD80x3 ethercard at %#3x:", ioaddr);
  for (i = 0; i < 16; i++) {
      printk(" %2.2X", inb(ioaddr+i));
  }  
  printk("\n");
  printk("WD80x3 ethercard at %#3x:", ioaddr+i);
  for (;i < 33; i++) {
      printk(" %2.2X", inb(ioaddr+i));
  }  
  printk("\n");
#endif
  printk("WD80x3 ethercard probe at %#3x:", ioaddr);
  for (i = 0; i < 8; i++) {
      int inval = inb(ioaddr + 8 + i);
      checksum += inval;
      if (i < 6)
	  printk(" %2.2X", (station_addr[i] = inval));
  }
  
  if ((checksum & 0xff) != 0xFF) {
    printk(" not found (%#2.2x).\n", checksum);
    return 0;
  }

  ei_status.name = "WD8003";
  ei_status.word16 = 0;

  
  /* This method of checking for a 16-bit board is borrowed from the
     we.c driver.  A simpler method is just to look in ASIC reg. 0x03.
     I'm comparing the two method in alpha test to make certain they
     return the same result. */
#ifndef FORCE_8BIT		/* Same define as we.c. */
  /* check for 16 bit board - it doesn't have register 0/8 aliasing */
  for (i = 0; i < 8; i++) {
      int tmp;
	if( inb_p(ioaddr+8+i) != inb_p(ioaddr+i) ){
	    tmp = inb_p(ioaddr+1); /* fiddle with 16bit bit */
	    outb( tmp ^ 0x01, ioaddr+1 ); /* attempt to clear 16bit bit */
	    if ((tmp & 0x01) == (inb_p( ioaddr+1) & 0x01)) {
		int asic_reg5 = inb(ioaddr+WD_CMDREG5);
		bits16 = 1; /* use word mode of operation */
		/* Magic to set ASIC to word-wide mode. */
		outb( ISA16 | NIC16 | (asic_reg5&0x1f), ioaddr+WD_CMDREG5);
		outb(tmp, ioaddr+1);
		ei_status.name = "WD8013";
		ei_status.word16 = 1;
		break; /* We have a 16bit board here! */
	    }
	    outb(tmp, ioaddr+1);
	}
    }
#else
  bits8 = 1;
#endif /* FORCE_8BIT */

#ifndef final_version
  if ((inb(ioaddr+1) & 0x01) != (ei_status.word16 & 0x01))
      printk("\nWD80x3: Bus width conflict, %d (probe) != %d (reg report).\n",
	     ei_status.word16 ? 16:8, (inb(ioaddr+1) & 0x01) ? 16 : 8);
#endif

  ei_status.tx_start_page = WD_START_PG;
  ei_status.rx_start_page = WD_START_PG + TX_PAGES;
  ei_status.stop_page = WD_STOP_PG;

#if defined(WD_SHMEM) && WD_SHMEM > 0x80000
  /* Allow an override for alpha testing.  */
  dev->mem_start = WD_SHMEM;
#else
  if (dev->mem_start == 0) {
      dev->mem_start = ((inb(ioaddr)&0x3f) << 13) +
	  (ei_status.word16 ? (inb(ioaddr+WD_CMDREG5)&0x1f)<<19 : 0x80000);
      printk(" address %#x,", dev->mem_start);
  }
#endif

  dev->rmem_start = dev->mem_start + TX_PAGES*256;
  dev->mem_end = dev->rmem_end
      = dev->mem_start + (WD_STOP_PG - WD_START_PG)*256;
#if defined(EI_DEBUG) && EI_DEBUG > 3
  memset((void*)dev->mem_start, 0x42424242, (WD_STOP_PG - WD_START_PG)*256);
#endif

  /* The 8390 isn't at the base address -- the ASIC regs are there! */
  dev->base_addr = ioaddr+WD_NIC_OFFSET;

  if (dev->irq < 2) {
      int nic_base = dev->base_addr;
      outb(WD_RESET, ioaddr);
      autoirq_setup(1);
      outb_p((((dev->mem_start>>13) & 0x3f)|WD_MEMENB), ioaddr); /* WD_CMDREG */
      if (ei_status.word16)
	  outb_p( ISA16 | NIC16 | ((dev->mem_start>>19) & 0x1f), ioaddr+WD_CMDREG5);
      /* This doesn't reliably generate an interrupt! */
      outb_p(0xff, nic_base + EN0_ISR); /* Ack. all intrs. */
      outb_p(0x50, nic_base + EN0_IMR);	/* Enable "DMA complete" interrupt. */
      outb_p(0x00, nic_base + EN0_RCNTLO);
      outb_p(0x00, nic_base + EN0_RCNTHI);
      outb_p(E8390_RREAD+E8390_START, nic_base); /* Trigger it... */
      outb_p(E8390_RWRITE+E8390_START, nic_base); /* Trigger it again... */
      dev->irq = autoirq_report(1);
      outb_p(0x00, nic_base + EN0_IMR); 		/* Mask it again. */
      if (ei_debug > 2)
	  printk(" autoIRQ %d", dev->irq);
      if (dev->irq == 0) {
	  printk(" autoIRQ failed, isr=%02x", inb(nic_base + EN0_ISR));
	  dev->irq = 10;
      }
  } else if (dev->irq == 2)
      /* Fixup for users that don't know that IRQ 2 is really IRQ 9,
	 or don't know which one to set. */
      dev->irq = 9;

  /* Snarf the interrupt now.  There's no point in waiting since we cannot
     share and the board will usually be enabled. */
  { int irqval = irqaction (dev->irq, &ei_sigaction);
    if (irqval) {
	printk (" unable to get IRQ %d (irqval=%d).\n", dev->irq, irqval);
	return 0;
    }
  }

  printk(" %s found, using IRQ %d.\n", ei_status.name, dev->irq);
  if (ei_debug > 1)
      printk(version);

  if (ei_debug > 1)
      printk("%s: Address read from register is %#x, setting address %#x\n",
	     ei_status.name,
	     ((inb(ioaddr+WD_CMDREG5)&0x1f)<<19) + ((inb(ioaddr)&0x3f) << 13),
	     dev->mem_start);
  /* Map in the shared memory.  This is a little risky, since using
     the stuff the user supplied is probably a bad idea. */
  outb_p((((dev->mem_start>>13) & 0x3f)|WD_MEMENB), ioaddr); /* WD_CMDREG */
  if (ei_status.word16)
      outb_p( ISA16 | NIC16 | ((dev->mem_start>>19) & 0x1f), ioaddr+WD_CMDREG5);

  ei_status.reset_8390 = &wd_reset_8390;
  ei_status.block_input = &wd_block_input;
  ei_status.block_output = &wd_block_output;
  dev->stop = &wd_close_card;
  NS8390_init(dev, 0);

  return dev->base_addr;
}

static void
wd_reset_8390(struct device *dev)
{
    int wd_cmd_port = dev->base_addr - WD_NIC_OFFSET; /* WD_CMDREG */
    int reset_start_time = jiffies;

    outb(WD_RESET, wd_cmd_port);
    if (ei_debug > 1) printk("resetting the WD80x3 t=%d...", jiffies);
    ei_status.txing = 0;

    sti();
    /* We shouldn't use the boguscount for timing, but this hasn't been
       checked yet, and you could hang your machine if jiffies break... */
    {
	int boguscount = 150000;
	while(jiffies - reset_start_time < 2)
	    if (boguscount-- < 0) {
		printk("jiffy failure (t=%d)...", jiffies);
		break;
	    }
    }

    outb(0x00, wd_cmd_port);
    while ((inb_p(dev->base_addr+EN0_ISR) & ENISR_RESET) == 0)
	if (jiffies - reset_start_time > 2) {
	    printk(EI_NAME": wd_reset_8390() did not complete.\n");
	    break;
	}
#if defined(EI_DEBUG) && EI_DEBUG > 2
    {
	int i;
	printk("WD80x3 ethercard at %#3x:", wd_cmd_port);
	for (i = 0; i < 16; i++) {
	    printk(" %2.2X", inb(wd_cmd_port+i));
	}  
	printk("\nWD80x3 ethercard at %#3x:", wd_cmd_port);
	for (;i < 33; i++) {
	    printk(" %2.2X", inb(wd_cmd_port+i));
	}  
	printk("\n");
    }
#endif
    /* Set up the ASIC registers, just in case something changed them. */
    outb_p((((dev->mem_start>>13) & 0x3f)|WD_MEMENB), wd_cmd_port); /* WD_CMDREG */
    if (ei_status.word16)
	outb_p( ISA16 | NIC16 | ((dev->mem_start>>19) & 0x1f), wd_cmd_port+WD_CMDREG5);

}

/* Block input and output are easy on shared memory ethercards, and trivial
   on the Western digital card where there is no choice of how to do it. */

static int
wd_block_input(struct device *dev, int count, char *buf, int ring_offset)
{
    void *xfer_start = (void *)(dev->mem_start + ring_offset - (WD_START_PG<<8));
#ifdef mapout
    int wd_cmdreg = dev->base_addr - WD_NIC_OFFSET; /* WD_CMDREG */
    /* Map in the shared memory. */
    outb_p((((dev->mem_start>>13) & 0x3f)|WD_MEMENB), wd_cmdreg);
#endif
    if (xfer_start + count > (void*) dev->rmem_end) {
	/* We must wrap the input move. */
	int semi_count = (void*)dev->rmem_end - xfer_start;
	memcpy(buf, xfer_start, semi_count);
	count -= semi_count;
	memcpy(buf + semi_count, (char *)dev->rmem_start, count);
	return dev->rmem_start + count;
    }
    memcpy(buf, xfer_start, count);
    if (ei_debug > 4) {
	unsigned short *board = xfer_start;
	printk("wd8013: wd_block_input(cnt=%d offset=%3x addr=%#x) = %2x %2x %2x...\n",
	       count, ring_offset, xfer_start, board[-1], board[0], board[1]);
    }
#ifdef mapout
    outb(0, wd_cmdreg); /* WD_CMDREG: Map out the shared memory. */
#endif
    return ring_offset + count;
}

/* This could only be outputting to the transmit buffer.  The
   ping-pong transmit setup doesn't work with this yet. */
static void
wd_block_output(struct device *dev, int count, const unsigned char *buf, int start_page)
{
    unsigned char *shmem = (void *)dev->mem_start + ((start_page - WD_START_PG)<<8);
#ifdef mapout
    int wd_cmdreg = dev->base_addr - WD_NIC_OFFSET; /* WD_CMDREG */
    /* Map in the shared memory. */
    outb_p((((dev->mem_start>>13) & 0x3f)|WD_MEMENB), wd_cmdreg);
#endif
    memcpy(shmem, buf, count);
    if (ei_debug > 4)
	printk("wd8013: wd_block_output(addr=%#x cnt=%d) -> %2x=%2x %2x=%2x %d...\n",
	       shmem, count, shmem[23], buf[23], shmem[24], buf[24], memcmp(shmem,buf,count));
#ifdef mapout
    outb(0, wd_cmdreg); /* WD_CMDREG: Map out the shared memory. */
#endif
}

/* This function resets the ethercard if something screws up. */
static int
wd_close_card(struct device *dev)
{
    if (ei_debug > 1)
	printk("%s: shutting down ethercard.\n", ei_status.name);
    NS8390_init(dev, 0);
    /* Turn off the shared memory. */
    outb_p((((dev->mem_start>>13) & 0x3f)),
	   dev->base_addr-WD_NIC_OFFSET); /* WD_CMDREG */
    return 0;
}


/*
 * Local variables:
 *  compile-command: "gcc -DKERNEL -Wall -O6 -fomit-frame-pointer -I/usr/src/linux/net/tcp -c wd.c"
 *  version-control: t
 *  kept-new-versions: 5
 * End:
 */