Linux Audio

Check our new training course

Loading...
Note: File does not exist in v6.8.
   1/* 8390.c: A general NS8390 ethernet driver core for linux. */
   2/*
   3	Written 1992-94 by Donald Becker.
   4
   5	Copyright 1993 United States Government as represented by the
   6	Director, National Security Agency.
   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	The author may be reached as becker@scyld.com, or C/O
  12	Scyld Computing Corporation
  13	410 Severn Ave., Suite 210
  14	Annapolis MD 21403
  15
  16
  17  This is the chip-specific code for many 8390-based ethernet adaptors.
  18  This is not a complete driver, it must be combined with board-specific
  19  code such as ne.c, wd.c, 3c503.c, etc.
  20
  21  Seeing how at least eight drivers use this code, (not counting the
  22  PCMCIA ones either) it is easy to break some card by what seems like
  23  a simple innocent change. Please contact me or Donald if you think
  24  you have found something that needs changing. -- PG
  25
  26
  27  Changelog:
  28
  29  Paul Gortmaker	: remove set_bit lock, other cleanups.
  30  Paul Gortmaker	: add ei_get_8390_hdr() so we can pass skb's to
  31			  ei_block_input() for eth_io_copy_and_sum().
  32  Paul Gortmaker	: exchange static int ei_pingpong for a #define,
  33			  also add better Tx error handling.
  34  Paul Gortmaker	: rewrite Rx overrun handling as per NS specs.
  35  Alexey Kuznetsov	: use the 8390's six bit hash multicast filter.
  36  Paul Gortmaker	: tweak ANK's above multicast changes a bit.
  37  Paul Gortmaker	: update packet statistics for v2.1.x
  38  Alan Cox		: support arbitrary stupid port mappings on the
  39			  68K Macintosh. Support >16bit I/O spaces
  40  Paul Gortmaker	: add kmod support for auto-loading of the 8390
  41			  module by all drivers that require it.
  42  Alan Cox		: Spinlocking work, added 'BUG_83C690'
  43  Paul Gortmaker	: Separate out Tx timeout code from Tx path.
  44  Paul Gortmaker	: Remove old unused single Tx buffer code.
  45  Hayato Fujiwara	: Add m32r support.
  46  Paul Gortmaker	: use skb_padto() instead of stack scratch area
  47
  48  Sources:
  49  The National Semiconductor LAN Databook, and the 3Com 3c503 databook.
  50
  51  */
  52
  53#include <linux/module.h>
  54#include <linux/kernel.h>
  55#include <linux/jiffies.h>
  56#include <linux/fs.h>
  57#include <linux/types.h>
  58#include <linux/string.h>
  59#include <linux/bitops.h>
  60#include <asm/system.h>
  61#include <linux/uaccess.h>
  62#include <linux/io.h>
  63#include <asm/irq.h>
  64#include <linux/delay.h>
  65#include <linux/errno.h>
  66#include <linux/fcntl.h>
  67#include <linux/in.h>
  68#include <linux/interrupt.h>
  69#include <linux/init.h>
  70#include <linux/crc32.h>
  71
  72#include <linux/netdevice.h>
  73#include <linux/etherdevice.h>
  74
  75#define NS8390_CORE
  76#include "8390.h"
  77
  78#define BUG_83C690
  79
  80/* These are the operational function interfaces to board-specific
  81   routines.
  82	void reset_8390(struct net_device *dev)
  83		Resets the board associated with DEV, including a hardware reset of
  84		the 8390.  This is only called when there is a transmit timeout, and
  85		it is always followed by 8390_init().
  86	void block_output(struct net_device *dev, int count, const unsigned char *buf,
  87					  int start_page)
  88		Write the COUNT bytes of BUF to the packet buffer at START_PAGE.  The
  89		"page" value uses the 8390's 256-byte pages.
  90	void get_8390_hdr(struct net_device *dev, struct e8390_hdr *hdr, int ring_page)
  91		Read the 4 byte, page aligned 8390 header. *If* there is a
  92		subsequent read, it will be of the rest of the packet.
  93	void block_input(struct net_device *dev, int count, struct sk_buff *skb, int ring_offset)
  94		Read COUNT bytes from the packet buffer into the skb data area. Start
  95		reading from RING_OFFSET, the address as the 8390 sees it.  This will always
  96		follow the read of the 8390 header.
  97*/
  98#define ei_reset_8390 (ei_local->reset_8390)
  99#define ei_block_output (ei_local->block_output)
 100#define ei_block_input (ei_local->block_input)
 101#define ei_get_8390_hdr (ei_local->get_8390_hdr)
 102
 103/* use 0 for production, 1 for verification, >2 for debug */
 104#ifndef ei_debug
 105int ei_debug = 1;
 106#endif
 107
 108/* Index to functions. */
 109static void ei_tx_intr(struct net_device *dev);
 110static void ei_tx_err(struct net_device *dev);
 111static void ei_receive(struct net_device *dev);
 112static void ei_rx_overrun(struct net_device *dev);
 113
 114/* Routines generic to NS8390-based boards. */
 115static void NS8390_trigger_send(struct net_device *dev, unsigned int length,
 116								int start_page);
 117static void do_set_multicast_list(struct net_device *dev);
 118static void __NS8390_init(struct net_device *dev, int startp);
 119
 120/*
 121 *	SMP and the 8390 setup.
 122 *
 123 *	The 8390 isn't exactly designed to be multithreaded on RX/TX. There is
 124 *	a page register that controls bank and packet buffer access. We guard
 125 *	this with ei_local->page_lock. Nobody should assume or set the page other
 126 *	than zero when the lock is not held. Lock holders must restore page 0
 127 *	before unlocking. Even pure readers must take the lock to protect in
 128 *	page 0.
 129 *
 130 *	To make life difficult the chip can also be very slow. We therefore can't
 131 *	just use spinlocks. For the longer lockups we disable the irq the device
 132 *	sits on and hold the lock. We must hold the lock because there is a dual
 133 *	processor case other than interrupts (get stats/set multicast list in
 134 *	parallel with each other and transmit).
 135 *
 136 *	Note: in theory we can just disable the irq on the card _but_ there is
 137 *	a latency on SMP irq delivery. So we can easily go "disable irq" "sync irqs"
 138 *	enter lock, take the queued irq. So we waddle instead of flying.
 139 *
 140 *	Finally by special arrangement for the purpose of being generally
 141 *	annoying the transmit function is called bh atomic. That places
 142 *	restrictions on the user context callers as disable_irq won't save
 143 *	them.
 144 *
 145 *	Additional explanation of problems with locking by Alan Cox:
 146 *
 147 *	"The author (me) didn't use spin_lock_irqsave because the slowness of the
 148 *	card means that approach caused horrible problems like losing serial data
 149 *	at 38400 baud on some chips. Remember many 8390 nics on PCI were ISA
 150 *	chips with FPGA front ends.
 151 *
 152 *	Ok the logic behind the 8390 is very simple:
 153 *
 154 *	Things to know
 155 *		- IRQ delivery is asynchronous to the PCI bus
 156 *		- Blocking the local CPU IRQ via spin locks was too slow
 157 *		- The chip has register windows needing locking work
 158 *
 159 *	So the path was once (I say once as people appear to have changed it
 160 *	in the mean time and it now looks rather bogus if the changes to use
 161 *	disable_irq_nosync_irqsave are disabling the local IRQ)
 162 *
 163 *
 164 *		Take the page lock
 165 *		Mask the IRQ on chip
 166 *		Disable the IRQ (but not mask locally- someone seems to have
 167 *			broken this with the lock validator stuff)
 168 *			[This must be _nosync as the page lock may otherwise
 169 *				deadlock us]
 170 *		Drop the page lock and turn IRQs back on
 171 *
 172 *		At this point an existing IRQ may still be running but we can't
 173 *		get a new one
 174 *
 175 *		Take the lock (so we know the IRQ has terminated) but don't mask
 176 *	the IRQs on the processor
 177 *		Set irqlock [for debug]
 178 *
 179 *		Transmit (slow as ****)
 180 *
 181 *		re-enable the IRQ
 182 *
 183 *
 184 *	We have to use disable_irq because otherwise you will get delayed
 185 *	interrupts on the APIC bus deadlocking the transmit path.
 186 *
 187 *	Quite hairy but the chip simply wasn't designed for SMP and you can't
 188 *	even ACK an interrupt without risking corrupting other parallel
 189 *	activities on the chip." [lkml, 25 Jul 2007]
 190 */
 191
 192
 193
 194/**
 195 * ei_open - Open/initialize the board.
 196 * @dev: network device to initialize
 197 *
 198 * This routine goes all-out, setting everything
 199 * up anew at each open, even though many of these registers should only
 200 * need to be set once at boot.
 201 */
 202static int __ei_open(struct net_device *dev)
 203{
 204	unsigned long flags;
 205	struct ei_device *ei_local = netdev_priv(dev);
 206
 207	if (dev->watchdog_timeo <= 0)
 208		dev->watchdog_timeo = TX_TIMEOUT;
 209
 210	/*
 211	 *	Grab the page lock so we own the register set, then call
 212	 *	the init function.
 213	 */
 214
 215	spin_lock_irqsave(&ei_local->page_lock, flags);
 216	__NS8390_init(dev, 1);
 217	/* Set the flag before we drop the lock, That way the IRQ arrives
 218	   after its set and we get no silly warnings */
 219	netif_start_queue(dev);
 220	spin_unlock_irqrestore(&ei_local->page_lock, flags);
 221	ei_local->irqlock = 0;
 222	return 0;
 223}
 224
 225/**
 226 * ei_close - shut down network device
 227 * @dev: network device to close
 228 *
 229 * Opposite of ei_open(). Only used when "ifconfig <devname> down" is done.
 230 */
 231static int __ei_close(struct net_device *dev)
 232{
 233	struct ei_device *ei_local = netdev_priv(dev);
 234	unsigned long flags;
 235
 236	/*
 237	 *	Hold the page lock during close
 238	 */
 239
 240	spin_lock_irqsave(&ei_local->page_lock, flags);
 241	__NS8390_init(dev, 0);
 242	spin_unlock_irqrestore(&ei_local->page_lock, flags);
 243	netif_stop_queue(dev);
 244	return 0;
 245}
 246
 247/**
 248 * ei_tx_timeout - handle transmit time out condition
 249 * @dev: network device which has apparently fallen asleep
 250 *
 251 * Called by kernel when device never acknowledges a transmit has
 252 * completed (or failed) - i.e. never posted a Tx related interrupt.
 253 */
 254
 255static void __ei_tx_timeout(struct net_device *dev)
 256{
 257	unsigned long e8390_base = dev->base_addr;
 258	struct ei_device *ei_local = netdev_priv(dev);
 259	int txsr, isr, tickssofar = jiffies - dev_trans_start(dev);
 260	unsigned long flags;
 261
 262	dev->stats.tx_errors++;
 263
 264	spin_lock_irqsave(&ei_local->page_lock, flags);
 265	txsr = ei_inb(e8390_base+EN0_TSR);
 266	isr = ei_inb(e8390_base+EN0_ISR);
 267	spin_unlock_irqrestore(&ei_local->page_lock, flags);
 268
 269	netdev_dbg(dev, "Tx timed out, %s TSR=%#2x, ISR=%#2x, t=%d\n",
 270		   (txsr & ENTSR_ABT) ? "excess collisions." :
 271		   (isr) ? "lost interrupt?" : "cable problem?",
 272		   txsr, isr, tickssofar);
 273
 274	if (!isr && !dev->stats.tx_packets) {
 275		/* The 8390 probably hasn't gotten on the cable yet. */
 276		ei_local->interface_num ^= 1;   /* Try a different xcvr.  */
 277	}
 278
 279	/* Ugly but a reset can be slow, yet must be protected */
 280
 281	disable_irq_nosync_lockdep(dev->irq);
 282	spin_lock(&ei_local->page_lock);
 283
 284	/* Try to restart the card.  Perhaps the user has fixed something. */
 285	ei_reset_8390(dev);
 286	__NS8390_init(dev, 1);
 287
 288	spin_unlock(&ei_local->page_lock);
 289	enable_irq_lockdep(dev->irq);
 290	netif_wake_queue(dev);
 291}
 292
 293/**
 294 * ei_start_xmit - begin packet transmission
 295 * @skb: packet to be sent
 296 * @dev: network device to which packet is sent
 297 *
 298 * Sends a packet to an 8390 network device.
 299 */
 300
 301static netdev_tx_t __ei_start_xmit(struct sk_buff *skb,
 302				   struct net_device *dev)
 303{
 304	unsigned long e8390_base = dev->base_addr;
 305	struct ei_device *ei_local = netdev_priv(dev);
 306	int send_length = skb->len, output_page;
 307	unsigned long flags;
 308	char buf[ETH_ZLEN];
 309	char *data = skb->data;
 310
 311	if (skb->len < ETH_ZLEN) {
 312		memset(buf, 0, ETH_ZLEN);	/* more efficient than doing just the needed bits */
 313		memcpy(buf, data, skb->len);
 314		send_length = ETH_ZLEN;
 315		data = buf;
 316	}
 317
 318	/* Mask interrupts from the ethercard.
 319	   SMP: We have to grab the lock here otherwise the IRQ handler
 320	   on another CPU can flip window and race the IRQ mask set. We end
 321	   up trashing the mcast filter not disabling irqs if we don't lock */
 322
 323	spin_lock_irqsave(&ei_local->page_lock, flags);
 324	ei_outb_p(0x00, e8390_base + EN0_IMR);
 325	spin_unlock_irqrestore(&ei_local->page_lock, flags);
 326
 327
 328	/*
 329	 *	Slow phase with lock held.
 330	 */
 331
 332	disable_irq_nosync_lockdep_irqsave(dev->irq, &flags);
 333
 334	spin_lock(&ei_local->page_lock);
 335
 336	ei_local->irqlock = 1;
 337
 338	/*
 339	 * We have two Tx slots available for use. Find the first free
 340	 * slot, and then perform some sanity checks. With two Tx bufs,
 341	 * you get very close to transmitting back-to-back packets. With
 342	 * only one Tx buf, the transmitter sits idle while you reload the
 343	 * card, leaving a substantial gap between each transmitted packet.
 344	 */
 345
 346	if (ei_local->tx1 == 0) {
 347		output_page = ei_local->tx_start_page;
 348		ei_local->tx1 = send_length;
 349		if (ei_debug  &&  ei_local->tx2 > 0)
 350			netdev_dbg(dev, "idle transmitter tx2=%d, lasttx=%d, txing=%d\n",
 351				   ei_local->tx2, ei_local->lasttx, ei_local->txing);
 352	} else if (ei_local->tx2 == 0) {
 353		output_page = ei_local->tx_start_page + TX_PAGES/2;
 354		ei_local->tx2 = send_length;
 355		if (ei_debug  &&  ei_local->tx1 > 0)
 356			netdev_dbg(dev, "idle transmitter, tx1=%d, lasttx=%d, txing=%d\n",
 357				   ei_local->tx1, ei_local->lasttx, ei_local->txing);
 358	} else {			/* We should never get here. */
 359		if (ei_debug)
 360			netdev_dbg(dev, "No Tx buffers free! tx1=%d tx2=%d last=%d\n",
 361				   ei_local->tx1, ei_local->tx2, ei_local->lasttx);
 362		ei_local->irqlock = 0;
 363		netif_stop_queue(dev);
 364		ei_outb_p(ENISR_ALL, e8390_base + EN0_IMR);
 365		spin_unlock(&ei_local->page_lock);
 366		enable_irq_lockdep_irqrestore(dev->irq, &flags);
 367		dev->stats.tx_errors++;
 368		return NETDEV_TX_BUSY;
 369	}
 370
 371	/*
 372	 * Okay, now upload the packet and trigger a send if the transmitter
 373	 * isn't already sending. If it is busy, the interrupt handler will
 374	 * trigger the send later, upon receiving a Tx done interrupt.
 375	 */
 376
 377	ei_block_output(dev, send_length, data, output_page);
 378
 379	if (!ei_local->txing) {
 380		ei_local->txing = 1;
 381		NS8390_trigger_send(dev, send_length, output_page);
 382		if (output_page == ei_local->tx_start_page) {
 383			ei_local->tx1 = -1;
 384			ei_local->lasttx = -1;
 385		} else {
 386			ei_local->tx2 = -1;
 387			ei_local->lasttx = -2;
 388		}
 389	} else
 390		ei_local->txqueue++;
 391
 392	if (ei_local->tx1  &&  ei_local->tx2)
 393		netif_stop_queue(dev);
 394	else
 395		netif_start_queue(dev);
 396
 397	/* Turn 8390 interrupts back on. */
 398	ei_local->irqlock = 0;
 399	ei_outb_p(ENISR_ALL, e8390_base + EN0_IMR);
 400
 401	spin_unlock(&ei_local->page_lock);
 402	enable_irq_lockdep_irqrestore(dev->irq, &flags);
 403	skb_tx_timestamp(skb);
 404	dev_kfree_skb(skb);
 405	dev->stats.tx_bytes += send_length;
 406
 407	return NETDEV_TX_OK;
 408}
 409
 410/**
 411 * ei_interrupt - handle the interrupts from an 8390
 412 * @irq: interrupt number
 413 * @dev_id: a pointer to the net_device
 414 *
 415 * Handle the ether interface interrupts. We pull packets from
 416 * the 8390 via the card specific functions and fire them at the networking
 417 * stack. We also handle transmit completions and wake the transmit path if
 418 * necessary. We also update the counters and do other housekeeping as
 419 * needed.
 420 */
 421
 422static irqreturn_t __ei_interrupt(int irq, void *dev_id)
 423{
 424	struct net_device *dev = dev_id;
 425	unsigned long e8390_base = dev->base_addr;
 426	int interrupts, nr_serviced = 0;
 427	struct ei_device *ei_local = netdev_priv(dev);
 428
 429	/*
 430	 *	Protect the irq test too.
 431	 */
 432
 433	spin_lock(&ei_local->page_lock);
 434
 435	if (ei_local->irqlock) {
 436		/*
 437		 * This might just be an interrupt for a PCI device sharing
 438		 * this line
 439		 */
 440		netdev_err(dev, "Interrupted while interrupts are masked! isr=%#2x imr=%#2x\n",
 441			   ei_inb_p(e8390_base + EN0_ISR),
 442			   ei_inb_p(e8390_base + EN0_IMR));
 443		spin_unlock(&ei_local->page_lock);
 444		return IRQ_NONE;
 445	}
 446
 447	/* Change to page 0 and read the intr status reg. */
 448	ei_outb_p(E8390_NODMA+E8390_PAGE0, e8390_base + E8390_CMD);
 449	if (ei_debug > 3)
 450		netdev_dbg(dev, "interrupt(isr=%#2.2x)\n",
 451			   ei_inb_p(e8390_base + EN0_ISR));
 452
 453	/* !!Assumption!! -- we stay in page 0.	 Don't break this. */
 454	while ((interrupts = ei_inb_p(e8390_base + EN0_ISR)) != 0 &&
 455	       ++nr_serviced < MAX_SERVICE) {
 456		if (!netif_running(dev)) {
 457			netdev_warn(dev, "interrupt from stopped card\n");
 458			/* rmk - acknowledge the interrupts */
 459			ei_outb_p(interrupts, e8390_base + EN0_ISR);
 460			interrupts = 0;
 461			break;
 462		}
 463		if (interrupts & ENISR_OVER)
 464			ei_rx_overrun(dev);
 465		else if (interrupts & (ENISR_RX+ENISR_RX_ERR)) {
 466			/* Got a good (?) packet. */
 467			ei_receive(dev);
 468		}
 469		/* Push the next to-transmit packet through. */
 470		if (interrupts & ENISR_TX)
 471			ei_tx_intr(dev);
 472		else if (interrupts & ENISR_TX_ERR)
 473			ei_tx_err(dev);
 474
 475		if (interrupts & ENISR_COUNTERS) {
 476			dev->stats.rx_frame_errors += ei_inb_p(e8390_base + EN0_COUNTER0);
 477			dev->stats.rx_crc_errors   += ei_inb_p(e8390_base + EN0_COUNTER1);
 478			dev->stats.rx_missed_errors += ei_inb_p(e8390_base + EN0_COUNTER2);
 479			ei_outb_p(ENISR_COUNTERS, e8390_base + EN0_ISR); /* Ack intr. */
 480		}
 481
 482		/* Ignore any RDC interrupts that make it back to here. */
 483		if (interrupts & ENISR_RDC)
 484			ei_outb_p(ENISR_RDC, e8390_base + EN0_ISR);
 485
 486		ei_outb_p(E8390_NODMA+E8390_PAGE0+E8390_START, e8390_base + E8390_CMD);
 487	}
 488
 489	if (interrupts && ei_debug) {
 490		ei_outb_p(E8390_NODMA+E8390_PAGE0+E8390_START, e8390_base + E8390_CMD);
 491		if (nr_serviced >= MAX_SERVICE) {
 492			/* 0xFF is valid for a card removal */
 493			if (interrupts != 0xFF)
 494				netdev_warn(dev, "Too much work at interrupt, status %#2.2x\n",
 495					    interrupts);
 496			ei_outb_p(ENISR_ALL, e8390_base + EN0_ISR); /* Ack. most intrs. */
 497		} else {
 498			netdev_warn(dev, "unknown interrupt %#2x\n", interrupts);
 499			ei_outb_p(0xff, e8390_base + EN0_ISR); /* Ack. all intrs. */
 500		}
 501	}
 502	spin_unlock(&ei_local->page_lock);
 503	return IRQ_RETVAL(nr_serviced > 0);
 504}
 505
 506#ifdef CONFIG_NET_POLL_CONTROLLER
 507static void __ei_poll(struct net_device *dev)
 508{
 509	disable_irq(dev->irq);
 510	__ei_interrupt(dev->irq, dev);
 511	enable_irq(dev->irq);
 512}
 513#endif
 514
 515/**
 516 * ei_tx_err - handle transmitter error
 517 * @dev: network device which threw the exception
 518 *
 519 * A transmitter error has happened. Most likely excess collisions (which
 520 * is a fairly normal condition). If the error is one where the Tx will
 521 * have been aborted, we try and send another one right away, instead of
 522 * letting the failed packet sit and collect dust in the Tx buffer. This
 523 * is a much better solution as it avoids kernel based Tx timeouts, and
 524 * an unnecessary card reset.
 525 *
 526 * Called with lock held.
 527 */
 528
 529static void ei_tx_err(struct net_device *dev)
 530{
 531	unsigned long e8390_base = dev->base_addr;
 532	/* ei_local is used on some platforms via the EI_SHIFT macro */
 533	struct ei_device *ei_local __maybe_unused = netdev_priv(dev);
 534	unsigned char txsr = ei_inb_p(e8390_base+EN0_TSR);
 535	unsigned char tx_was_aborted = txsr & (ENTSR_ABT+ENTSR_FU);
 536
 537#ifdef VERBOSE_ERROR_DUMP
 538	netdev_dbg(dev, "transmitter error (%#2x):", txsr);
 539	if (txsr & ENTSR_ABT)
 540		pr_cont(" excess-collisions ");
 541	if (txsr & ENTSR_ND)
 542		pr_cont(" non-deferral ");
 543	if (txsr & ENTSR_CRS)
 544		pr_cont(" lost-carrier ");
 545	if (txsr & ENTSR_FU)
 546		pr_cont(" FIFO-underrun ");
 547	if (txsr & ENTSR_CDH)
 548		pr_cont(" lost-heartbeat ");
 549	pr_cont("\n");
 550#endif
 551
 552	ei_outb_p(ENISR_TX_ERR, e8390_base + EN0_ISR); /* Ack intr. */
 553
 554	if (tx_was_aborted)
 555		ei_tx_intr(dev);
 556	else {
 557		dev->stats.tx_errors++;
 558		if (txsr & ENTSR_CRS)
 559			dev->stats.tx_carrier_errors++;
 560		if (txsr & ENTSR_CDH)
 561			dev->stats.tx_heartbeat_errors++;
 562		if (txsr & ENTSR_OWC)
 563			dev->stats.tx_window_errors++;
 564	}
 565}
 566
 567/**
 568 * ei_tx_intr - transmit interrupt handler
 569 * @dev: network device for which tx intr is handled
 570 *
 571 * We have finished a transmit: check for errors and then trigger the next
 572 * packet to be sent. Called with lock held.
 573 */
 574
 575static void ei_tx_intr(struct net_device *dev)
 576{
 577	unsigned long e8390_base = dev->base_addr;
 578	struct ei_device *ei_local = netdev_priv(dev);
 579	int status = ei_inb(e8390_base + EN0_TSR);
 580
 581	ei_outb_p(ENISR_TX, e8390_base + EN0_ISR); /* Ack intr. */
 582
 583	/*
 584	 * There are two Tx buffers, see which one finished, and trigger
 585	 * the send of another one if it exists.
 586	 */
 587	ei_local->txqueue--;
 588
 589	if (ei_local->tx1 < 0) {
 590		if (ei_local->lasttx != 1 && ei_local->lasttx != -1)
 591			pr_err("%s: bogus last_tx_buffer %d, tx1=%d\n",
 592			       ei_local->name, ei_local->lasttx, ei_local->tx1);
 593		ei_local->tx1 = 0;
 594		if (ei_local->tx2 > 0) {
 595			ei_local->txing = 1;
 596			NS8390_trigger_send(dev, ei_local->tx2, ei_local->tx_start_page + 6);
 597			dev->trans_start = jiffies;
 598			ei_local->tx2 = -1,
 599			ei_local->lasttx = 2;
 600		} else
 601			ei_local->lasttx = 20, ei_local->txing = 0;
 602	} else if (ei_local->tx2 < 0) {
 603		if (ei_local->lasttx != 2  &&  ei_local->lasttx != -2)
 604			pr_err("%s: bogus last_tx_buffer %d, tx2=%d\n",
 605			       ei_local->name, ei_local->lasttx, ei_local->tx2);
 606		ei_local->tx2 = 0;
 607		if (ei_local->tx1 > 0) {
 608			ei_local->txing = 1;
 609			NS8390_trigger_send(dev, ei_local->tx1, ei_local->tx_start_page);
 610			dev->trans_start = jiffies;
 611			ei_local->tx1 = -1;
 612			ei_local->lasttx = 1;
 613		} else
 614			ei_local->lasttx = 10, ei_local->txing = 0;
 615	} /* else
 616		netdev_warn(dev, "unexpected TX-done interrupt, lasttx=%d\n",
 617			    ei_local->lasttx);
 618*/
 619
 620	/* Minimize Tx latency: update the statistics after we restart TXing. */
 621	if (status & ENTSR_COL)
 622		dev->stats.collisions++;
 623	if (status & ENTSR_PTX)
 624		dev->stats.tx_packets++;
 625	else {
 626		dev->stats.tx_errors++;
 627		if (status & ENTSR_ABT) {
 628			dev->stats.tx_aborted_errors++;
 629			dev->stats.collisions += 16;
 630		}
 631		if (status & ENTSR_CRS)
 632			dev->stats.tx_carrier_errors++;
 633		if (status & ENTSR_FU)
 634			dev->stats.tx_fifo_errors++;
 635		if (status & ENTSR_CDH)
 636			dev->stats.tx_heartbeat_errors++;
 637		if (status & ENTSR_OWC)
 638			dev->stats.tx_window_errors++;
 639	}
 640	netif_wake_queue(dev);
 641}
 642
 643/**
 644 * ei_receive - receive some packets
 645 * @dev: network device with which receive will be run
 646 *
 647 * We have a good packet(s), get it/them out of the buffers.
 648 * Called with lock held.
 649 */
 650
 651static void ei_receive(struct net_device *dev)
 652{
 653	unsigned long e8390_base = dev->base_addr;
 654	struct ei_device *ei_local = netdev_priv(dev);
 655	unsigned char rxing_page, this_frame, next_frame;
 656	unsigned short current_offset;
 657	int rx_pkt_count = 0;
 658	struct e8390_pkt_hdr rx_frame;
 659	int num_rx_pages = ei_local->stop_page-ei_local->rx_start_page;
 660
 661	while (++rx_pkt_count < 10) {
 662		int pkt_len, pkt_stat;
 663
 664		/* Get the rx page (incoming packet pointer). */
 665		ei_outb_p(E8390_NODMA+E8390_PAGE1, e8390_base + E8390_CMD);
 666		rxing_page = ei_inb_p(e8390_base + EN1_CURPAG);
 667		ei_outb_p(E8390_NODMA+E8390_PAGE0, e8390_base + E8390_CMD);
 668
 669		/* Remove one frame from the ring.  Boundary is always a page behind. */
 670		this_frame = ei_inb_p(e8390_base + EN0_BOUNDARY) + 1;
 671		if (this_frame >= ei_local->stop_page)
 672			this_frame = ei_local->rx_start_page;
 673
 674		/* Someday we'll omit the previous, iff we never get this message.
 675		   (There is at least one clone claimed to have a problem.)
 676
 677		   Keep quiet if it looks like a card removal. One problem here
 678		   is that some clones crash in roughly the same way.
 679		 */
 680		if (ei_debug > 0 &&
 681		    this_frame != ei_local->current_page &&
 682		    (this_frame != 0x0 || rxing_page != 0xFF))
 683			netdev_err(dev, "mismatched read page pointers %2x vs %2x\n",
 684				   this_frame, ei_local->current_page);
 685
 686		if (this_frame == rxing_page)	/* Read all the frames? */
 687			break;				/* Done for now */
 688
 689		current_offset = this_frame << 8;
 690		ei_get_8390_hdr(dev, &rx_frame, this_frame);
 691
 692		pkt_len = rx_frame.count - sizeof(struct e8390_pkt_hdr);
 693		pkt_stat = rx_frame.status;
 694
 695		next_frame = this_frame + 1 + ((pkt_len+4)>>8);
 696
 697		/* Check for bogosity warned by 3c503 book: the status byte is never
 698		   written.  This happened a lot during testing! This code should be
 699		   cleaned up someday. */
 700		if (rx_frame.next != next_frame &&
 701		    rx_frame.next != next_frame + 1 &&
 702		    rx_frame.next != next_frame - num_rx_pages &&
 703		    rx_frame.next != next_frame + 1 - num_rx_pages) {
 704			ei_local->current_page = rxing_page;
 705			ei_outb(ei_local->current_page-1, e8390_base+EN0_BOUNDARY);
 706			dev->stats.rx_errors++;
 707			continue;
 708		}
 709
 710		if (pkt_len < 60  ||  pkt_len > 1518) {
 711			if (ei_debug)
 712				netdev_dbg(dev, "bogus packet size: %d, status=%#2x nxpg=%#2x\n",
 713					   rx_frame.count, rx_frame.status,
 714					   rx_frame.next);
 715			dev->stats.rx_errors++;
 716			dev->stats.rx_length_errors++;
 717		} else if ((pkt_stat & 0x0F) == ENRSR_RXOK) {
 718			struct sk_buff *skb;
 719
 720			skb = dev_alloc_skb(pkt_len+2);
 721			if (skb == NULL) {
 722				if (ei_debug > 1)
 723					netdev_dbg(dev, "Couldn't allocate a sk_buff of size %d\n",
 724						   pkt_len);
 725				dev->stats.rx_dropped++;
 726				break;
 727			} else {
 728				skb_reserve(skb, 2);	/* IP headers on 16 byte boundaries */
 729				skb_put(skb, pkt_len);	/* Make room */
 730				ei_block_input(dev, pkt_len, skb, current_offset + sizeof(rx_frame));
 731				skb->protocol = eth_type_trans(skb, dev);
 732				if (!skb_defer_rx_timestamp(skb))
 733					netif_rx(skb);
 734				dev->stats.rx_packets++;
 735				dev->stats.rx_bytes += pkt_len;
 736				if (pkt_stat & ENRSR_PHY)
 737					dev->stats.multicast++;
 738			}
 739		} else {
 740			if (ei_debug)
 741				netdev_dbg(dev, "bogus packet: status=%#2x nxpg=%#2x size=%d\n",
 742					   rx_frame.status, rx_frame.next,
 743					   rx_frame.count);
 744			dev->stats.rx_errors++;
 745			/* NB: The NIC counts CRC, frame and missed errors. */
 746			if (pkt_stat & ENRSR_FO)
 747				dev->stats.rx_fifo_errors++;
 748		}
 749		next_frame = rx_frame.next;
 750
 751		/* This _should_ never happen: it's here for avoiding bad clones. */
 752		if (next_frame >= ei_local->stop_page) {
 753			netdev_notice(dev, "next frame inconsistency, %#2x\n",
 754				      next_frame);
 755			next_frame = ei_local->rx_start_page;
 756		}
 757		ei_local->current_page = next_frame;
 758		ei_outb_p(next_frame-1, e8390_base+EN0_BOUNDARY);
 759	}
 760
 761	/* We used to also ack ENISR_OVER here, but that would sometimes mask
 762	   a real overrun, leaving the 8390 in a stopped state with rec'vr off. */
 763	ei_outb_p(ENISR_RX+ENISR_RX_ERR, e8390_base+EN0_ISR);
 764}
 765
 766/**
 767 * ei_rx_overrun - handle receiver overrun
 768 * @dev: network device which threw exception
 769 *
 770 * We have a receiver overrun: we have to kick the 8390 to get it started
 771 * again. Problem is that you have to kick it exactly as NS prescribes in
 772 * the updated datasheets, or "the NIC may act in an unpredictable manner."
 773 * This includes causing "the NIC to defer indefinitely when it is stopped
 774 * on a busy network."  Ugh.
 775 * Called with lock held. Don't call this with the interrupts off or your
 776 * computer will hate you - it takes 10ms or so.
 777 */
 778
 779static void ei_rx_overrun(struct net_device *dev)
 780{
 781	unsigned long e8390_base = dev->base_addr;
 782	unsigned char was_txing, must_resend = 0;
 783	/* ei_local is used on some platforms via the EI_SHIFT macro */
 784	struct ei_device *ei_local __maybe_unused = netdev_priv(dev);
 785
 786	/*
 787	 * Record whether a Tx was in progress and then issue the
 788	 * stop command.
 789	 */
 790	was_txing = ei_inb_p(e8390_base+E8390_CMD) & E8390_TRANS;
 791	ei_outb_p(E8390_NODMA+E8390_PAGE0+E8390_STOP, e8390_base+E8390_CMD);
 792
 793	if (ei_debug > 1)
 794		netdev_dbg(dev, "Receiver overrun\n");
 795	dev->stats.rx_over_errors++;
 796
 797	/*
 798	 * Wait a full Tx time (1.2ms) + some guard time, NS says 1.6ms total.
 799	 * Early datasheets said to poll the reset bit, but now they say that
 800	 * it "is not a reliable indicator and subsequently should be ignored."
 801	 * We wait at least 10ms.
 802	 */
 803
 804	mdelay(10);
 805
 806	/*
 807	 * Reset RBCR[01] back to zero as per magic incantation.
 808	 */
 809	ei_outb_p(0x00, e8390_base+EN0_RCNTLO);
 810	ei_outb_p(0x00, e8390_base+EN0_RCNTHI);
 811
 812	/*
 813	 * See if any Tx was interrupted or not. According to NS, this
 814	 * step is vital, and skipping it will cause no end of havoc.
 815	 */
 816
 817	if (was_txing) {
 818		unsigned char tx_completed = ei_inb_p(e8390_base+EN0_ISR) & (ENISR_TX+ENISR_TX_ERR);
 819		if (!tx_completed)
 820			must_resend = 1;
 821	}
 822
 823	/*
 824	 * Have to enter loopback mode and then restart the NIC before
 825	 * you are allowed to slurp packets up off the ring.
 826	 */
 827	ei_outb_p(E8390_TXOFF, e8390_base + EN0_TXCR);
 828	ei_outb_p(E8390_NODMA + E8390_PAGE0 + E8390_START, e8390_base + E8390_CMD);
 829
 830	/*
 831	 * Clear the Rx ring of all the debris, and ack the interrupt.
 832	 */
 833	ei_receive(dev);
 834	ei_outb_p(ENISR_OVER, e8390_base+EN0_ISR);
 835
 836	/*
 837	 * Leave loopback mode, and resend any packet that got stopped.
 838	 */
 839	ei_outb_p(E8390_TXCONFIG, e8390_base + EN0_TXCR);
 840	if (must_resend)
 841		ei_outb_p(E8390_NODMA + E8390_PAGE0 + E8390_START + E8390_TRANS, e8390_base + E8390_CMD);
 842}
 843
 844/*
 845 *	Collect the stats. This is called unlocked and from several contexts.
 846 */
 847
 848static struct net_device_stats *__ei_get_stats(struct net_device *dev)
 849{
 850	unsigned long ioaddr = dev->base_addr;
 851	struct ei_device *ei_local = netdev_priv(dev);
 852	unsigned long flags;
 853
 854	/* If the card is stopped, just return the present stats. */
 855	if (!netif_running(dev))
 856		return &dev->stats;
 857
 858	spin_lock_irqsave(&ei_local->page_lock, flags);
 859	/* Read the counter registers, assuming we are in page 0. */
 860	dev->stats.rx_frame_errors  += ei_inb_p(ioaddr + EN0_COUNTER0);
 861	dev->stats.rx_crc_errors    += ei_inb_p(ioaddr + EN0_COUNTER1);
 862	dev->stats.rx_missed_errors += ei_inb_p(ioaddr + EN0_COUNTER2);
 863	spin_unlock_irqrestore(&ei_local->page_lock, flags);
 864
 865	return &dev->stats;
 866}
 867
 868/*
 869 * Form the 64 bit 8390 multicast table from the linked list of addresses
 870 * associated with this dev structure.
 871 */
 872
 873static inline void make_mc_bits(u8 *bits, struct net_device *dev)
 874{
 875	struct netdev_hw_addr *ha;
 876
 877	netdev_for_each_mc_addr(ha, dev) {
 878		u32 crc = ether_crc(ETH_ALEN, ha->addr);
 879		/*
 880		 * The 8390 uses the 6 most significant bits of the
 881		 * CRC to index the multicast table.
 882		 */
 883		bits[crc>>29] |= (1<<((crc>>26)&7));
 884	}
 885}
 886
 887/**
 888 * do_set_multicast_list - set/clear multicast filter
 889 * @dev: net device for which multicast filter is adjusted
 890 *
 891 *	Set or clear the multicast filter for this adaptor. May be called
 892 *	from a BH in 2.1.x. Must be called with lock held.
 893 */
 894
 895static void do_set_multicast_list(struct net_device *dev)
 896{
 897	unsigned long e8390_base = dev->base_addr;
 898	int i;
 899	struct ei_device *ei_local = netdev_priv(dev);
 900
 901	if (!(dev->flags&(IFF_PROMISC|IFF_ALLMULTI))) {
 902		memset(ei_local->mcfilter, 0, 8);
 903		if (!netdev_mc_empty(dev))
 904			make_mc_bits(ei_local->mcfilter, dev);
 905	} else
 906		memset(ei_local->mcfilter, 0xFF, 8);	/* mcast set to accept-all */
 907
 908	/*
 909	 * DP8390 manuals don't specify any magic sequence for altering
 910	 * the multicast regs on an already running card. To be safe, we
 911	 * ensure multicast mode is off prior to loading up the new hash
 912	 * table. If this proves to be not enough, we can always resort
 913	 * to stopping the NIC, loading the table and then restarting.
 914	 *
 915	 * Bug Alert!  The MC regs on the SMC 83C690 (SMC Elite and SMC
 916	 * Elite16) appear to be write-only. The NS 8390 data sheet lists
 917	 * them as r/w so this is a bug.  The SMC 83C790 (SMC Ultra and
 918	 * Ultra32 EISA) appears to have this bug fixed.
 919	 */
 920
 921	if (netif_running(dev))
 922		ei_outb_p(E8390_RXCONFIG, e8390_base + EN0_RXCR);
 923	ei_outb_p(E8390_NODMA + E8390_PAGE1, e8390_base + E8390_CMD);
 924	for (i = 0; i < 8; i++) {
 925		ei_outb_p(ei_local->mcfilter[i], e8390_base + EN1_MULT_SHIFT(i));
 926#ifndef BUG_83C690
 927		if (ei_inb_p(e8390_base + EN1_MULT_SHIFT(i)) != ei_local->mcfilter[i])
 928			netdev_err(dev, "Multicast filter read/write mismap %d\n",
 929				   i);
 930#endif
 931	}
 932	ei_outb_p(E8390_NODMA + E8390_PAGE0, e8390_base + E8390_CMD);
 933
 934	if (dev->flags&IFF_PROMISC)
 935		ei_outb_p(E8390_RXCONFIG | 0x18, e8390_base + EN0_RXCR);
 936	else if (dev->flags & IFF_ALLMULTI || !netdev_mc_empty(dev))
 937		ei_outb_p(E8390_RXCONFIG | 0x08, e8390_base + EN0_RXCR);
 938	else
 939		ei_outb_p(E8390_RXCONFIG, e8390_base + EN0_RXCR);
 940}
 941
 942/*
 943 *	Called without lock held. This is invoked from user context and may
 944 *	be parallel to just about everything else. Its also fairly quick and
 945 *	not called too often. Must protect against both bh and irq users
 946 */
 947
 948static void __ei_set_multicast_list(struct net_device *dev)
 949{
 950	unsigned long flags;
 951	struct ei_device *ei_local = netdev_priv(dev);
 952
 953	spin_lock_irqsave(&ei_local->page_lock, flags);
 954	do_set_multicast_list(dev);
 955	spin_unlock_irqrestore(&ei_local->page_lock, flags);
 956}
 957
 958/**
 959 * ethdev_setup - init rest of 8390 device struct
 960 * @dev: network device structure to init
 961 *
 962 * Initialize the rest of the 8390 device structure.  Do NOT __init
 963 * this, as it is used by 8390 based modular drivers too.
 964 */
 965
 966static void ethdev_setup(struct net_device *dev)
 967{
 968	struct ei_device *ei_local = netdev_priv(dev);
 969	if (ei_debug > 1)
 970		printk(version);
 971
 972	ether_setup(dev);
 973
 974	spin_lock_init(&ei_local->page_lock);
 975}
 976
 977/**
 978 * alloc_ei_netdev - alloc_etherdev counterpart for 8390
 979 * @size: extra bytes to allocate
 980 *
 981 * Allocate 8390-specific net_device.
 982 */
 983static struct net_device *____alloc_ei_netdev(int size)
 984{
 985	return alloc_netdev(sizeof(struct ei_device) + size, "eth%d",
 986				ethdev_setup);
 987}
 988
 989
 990
 991
 992/* This page of functions should be 8390 generic */
 993/* Follow National Semi's recommendations for initializing the "NIC". */
 994
 995/**
 996 * NS8390_init - initialize 8390 hardware
 997 * @dev: network device to initialize
 998 * @startp: boolean.  non-zero value to initiate chip processing
 999 *
1000 *	Must be called with lock held.
1001 */
1002
1003static void __NS8390_init(struct net_device *dev, int startp)
1004{
1005	unsigned long e8390_base = dev->base_addr;
1006	struct ei_device *ei_local = netdev_priv(dev);
1007	int i;
1008	int endcfg = ei_local->word16
1009	    ? (0x48 | ENDCFG_WTS | (ei_local->bigendian ? ENDCFG_BOS : 0))
1010	    : 0x48;
1011
1012	if (sizeof(struct e8390_pkt_hdr) != 4)
1013		panic("8390.c: header struct mispacked\n");
1014	/* Follow National Semi's recommendations for initing the DP83902. */
1015	ei_outb_p(E8390_NODMA+E8390_PAGE0+E8390_STOP, e8390_base+E8390_CMD); /* 0x21 */
1016	ei_outb_p(endcfg, e8390_base + EN0_DCFG);	/* 0x48 or 0x49 */
1017	/* Clear the remote byte count registers. */
1018	ei_outb_p(0x00,  e8390_base + EN0_RCNTLO);
1019	ei_outb_p(0x00,  e8390_base + EN0_RCNTHI);
1020	/* Set to monitor and loopback mode -- this is vital!. */
1021	ei_outb_p(E8390_RXOFF, e8390_base + EN0_RXCR); /* 0x20 */
1022	ei_outb_p(E8390_TXOFF, e8390_base + EN0_TXCR); /* 0x02 */
1023	/* Set the transmit page and receive ring. */
1024	ei_outb_p(ei_local->tx_start_page, e8390_base + EN0_TPSR);
1025	ei_local->tx1 = ei_local->tx2 = 0;
1026	ei_outb_p(ei_local->rx_start_page, e8390_base + EN0_STARTPG);
1027	ei_outb_p(ei_local->stop_page-1, e8390_base + EN0_BOUNDARY);	/* 3c503 says 0x3f,NS0x26*/
1028	ei_local->current_page = ei_local->rx_start_page;		/* assert boundary+1 */
1029	ei_outb_p(ei_local->stop_page, e8390_base + EN0_STOPPG);
1030	/* Clear the pending interrupts and mask. */
1031	ei_outb_p(0xFF, e8390_base + EN0_ISR);
1032	ei_outb_p(0x00,  e8390_base + EN0_IMR);
1033
1034	/* Copy the station address into the DS8390 registers. */
1035
1036	ei_outb_p(E8390_NODMA + E8390_PAGE1 + E8390_STOP, e8390_base+E8390_CMD); /* 0x61 */
1037	for (i = 0; i < 6; i++) {
1038		ei_outb_p(dev->dev_addr[i], e8390_base + EN1_PHYS_SHIFT(i));
1039		if (ei_debug > 1 &&
1040		    ei_inb_p(e8390_base + EN1_PHYS_SHIFT(i)) != dev->dev_addr[i])
1041			netdev_err(dev, "Hw. address read/write mismap %d\n", i);
1042	}
1043
1044	ei_outb_p(ei_local->rx_start_page, e8390_base + EN1_CURPAG);
1045	ei_outb_p(E8390_NODMA+E8390_PAGE0+E8390_STOP, e8390_base+E8390_CMD);
1046
1047	ei_local->tx1 = ei_local->tx2 = 0;
1048	ei_local->txing = 0;
1049
1050	if (startp) {
1051		ei_outb_p(0xff,  e8390_base + EN0_ISR);
1052		ei_outb_p(ENISR_ALL,  e8390_base + EN0_IMR);
1053		ei_outb_p(E8390_NODMA+E8390_PAGE0+E8390_START, e8390_base+E8390_CMD);
1054		ei_outb_p(E8390_TXCONFIG, e8390_base + EN0_TXCR); /* xmit on. */
1055		/* 3c503 TechMan says rxconfig only after the NIC is started. */
1056		ei_outb_p(E8390_RXCONFIG, e8390_base + EN0_RXCR); /* rx on,  */
1057		do_set_multicast_list(dev);	/* (re)load the mcast table */
1058	}
1059}
1060
1061/* Trigger a transmit start, assuming the length is valid.
1062   Always called with the page lock held */
1063
1064static void NS8390_trigger_send(struct net_device *dev, unsigned int length,
1065								int start_page)
1066{
1067	unsigned long e8390_base = dev->base_addr;
1068	struct ei_device *ei_local __attribute((unused)) = netdev_priv(dev);
1069
1070	ei_outb_p(E8390_NODMA+E8390_PAGE0, e8390_base+E8390_CMD);
1071
1072	if (ei_inb_p(e8390_base + E8390_CMD) & E8390_TRANS) {
1073		netdev_warn(dev, "trigger_send() called with the transmitter busy\n");
1074		return;
1075	}
1076	ei_outb_p(length & 0xff, e8390_base + EN0_TCNTLO);
1077	ei_outb_p(length >> 8, e8390_base + EN0_TCNTHI);
1078	ei_outb_p(start_page, e8390_base + EN0_TPSR);
1079	ei_outb_p(E8390_NODMA+E8390_TRANS+E8390_START, e8390_base+E8390_CMD);
1080}