patch-2.2.16 linux/drivers/net/hamachi.c

Next file: linux/drivers/net/hd64570.h
Previous file: linux/drivers/net/eepro100.c
Back to the patch index
Back to the overall index

diff -urN v2.2.15/linux/drivers/net/hamachi.c linux/drivers/net/hamachi.c
@@ -0,0 +1,2091 @@
+/* hamachi.c: A Packet Engines GNIC-II Gigabit Ethernet driver for Linux. */
+/*
+	Written 1998-2000 by Donald Becker.
+	Updates 2000 by Keith Underwood.
+
+	This software may be used and distributed according to the terms of 
+	the GNU Public License (GPL), incorporated herein by reference.
+	Drivers based on or derived from this code fall under the GPL and must
+	retain the authorship, copyright and license notice.  This file is not
+	a complete program and may only be used when the entire operating
+	system is licensed under the GPL.
+
+	The author may be reached as becker@scyld.com, or C/O
+	Scyld Computing Corporation
+	410 Severn Ave., Suite 210
+	Annapolis MD 21403
+
+	This driver is for the Packet Engines GNIC-II PCI Gigabit Ethernet
+	adapter.
+
+	Support and updates available at
+	http://www.scyld.com/network/hamachi.html
+	or
+	http://www.parl.clemson.edu/~keithu/hamachi.html
+
+	For best viewing, set your tabs to 3.
+
+*/
+
+static const char *version =
+"hamachi.c:v1.01 5/16/2000  Written by Donald Becker\n"
+"   Some modifications by Eric kasten <kasten@nscl.msu.edu>\n"
+"   Further modifications by Keith Underwood <keithu@parl.clemson.edu>\n"
+"   Support by many others\n"
+"   http://www.scyld.com/network/hamachi.html\n"
+"   or\n"
+"   http://www.parl.clemson.edu/~keithu/drivers/hamachi.html\n";
+
+
+/* A few user-configurable values. */
+
+static int debug = 1;		/* 1 normal messages, 0 quiet .. 7 verbose.  */
+#define final_version
+#define hamachi_debug debug
+/* Maximum events (Rx packets, etc.) to handle at each interrupt. */
+static int max_interrupt_work = 40;
+static int min_pci_latency = 64;
+static int mtu = 0;
+/* Default values selected by testing on a dual processor PIII-450 */
+/* These six interrupt control parameters may be set directly when loading the
+ * module, or through the rx_params and tx_params variables
+ */
+static int max_rx_latency = 0x11;
+static int max_rx_gap = 0x05;
+static int min_rx_pkt = 0x18;
+static int max_tx_latency = 0x00; 
+static int max_tx_gap = 0x00;
+static int min_tx_pkt = 0x30;
+
+/* Set the copy breakpoint for the copy-only-tiny-frames scheme.
+   -Setting to > 1518 causes all frames to be copied
+	-Setting to 0 disables copies
+*/
+static int rx_copybreak = 0;
+
+/* An override for the hardware detection of bus width.
+	Set to 1 to force 32 bit PCI bus detection.  Set to 4 to force 64 bit.
+	Add 2 to disable parity detection.
+*/
+static int force32 = 0;
+
+
+/* Used to pass the media type, etc.
+   These exist for driver interoperability.
+   No media types are currently defined.
+		- The lower 4 bits are reserved for the media type.
+		- The next three bits may be set to one of the following:
+			0x00000000 : Autodetect PCI bus
+			0x00000010 : Force 32 bit PCI bus
+			0x00000020 : Disable parity detection
+			0x00000040 : Force 64 bit PCI bus
+			Default is autodetect
+		- The next bit can be used to force half-duplex.  This is a bad
+		  idea since no known implementations implement half-duplex, and,
+		  in general, half-duplex for gigabit ethernet is a bad idea.
+			0x00000080 : Force half-duplex 
+			Default is full-duplex.
+		- In the original driver, the ninth bit could be used to force
+		  full-duplex.  Maintain that for compatibility
+		   0x00000200 : Force full-duplex
+*/
+#define MAX_UNITS 8				/* More are supported, limit only on options */
+static int options[MAX_UNITS] = {-1, -1, -1, -1, -1, -1, -1, -1};
+static int full_duplex[MAX_UNITS] = {-1, -1, -1, -1, -1, -1, -1, -1};
+/* The Hamachi chipset supports 3 parameters each for Rx and Tx
+ * interruput management.  Parameters will be loaded as specified into
+ * the TxIntControl and RxIntControl registers.  
+ *
+ * The registers are arranged as follows:
+ *     23 - 16   15 -  8   7    -    0
+ *    _________________________________
+ *   | min_pkt | max_gap | max_latency |
+ *    ---------------------------------
+ *   min_pkt      : The minimum number of packets processed between
+ *                  interrupts. 
+ *   max_gap      : The maximum inter-packet gap in units of 8.192 us
+ *   max_latency  : The absolute time between interrupts in units of 8.192 us
+ * 
+ */
+static int rx_params[MAX_UNITS] = {-1, -1, -1, -1, -1, -1, -1, -1};
+static int tx_params[MAX_UNITS] = {-1, -1, -1, -1, -1, -1, -1, -1};
+
+/* Operational parameters that are set at compile time. */
+
+/* Keep the ring sizes a power of two for compile efficiency.
+	The compiler will convert <unsigned>'%'<2^N> into a bit mask.
+   Making the Tx ring too large decreases the effectiveness of channel
+   bonding and packet priority.
+   There are no ill effects from too-large receive rings, except for
+	excessive memory usage */
+/* Empirically it appears that the Tx ring needs to be a little bigger
+   for these Gbit adapters or you get into an overrun condition really
+   easily.  Also, things appear to work a bit better in back-to-back
+   configurations if the Rx ring is 8 times the size of the Tx ring
+*/
+#define TX_RING_SIZE	64
+#define RX_RING_SIZE	512
+
+/*
+ * Enable mii_ioctl.  Added interrupt coalescing parameter adjustment.
+ * 2/19/99 Pete Wyckoff <wyckoff@ca.sandia.gov>
+ */
+#define HAVE_PRIVATE_IOCTL
+
+/* play with 64-bit addrlen; seems to be a teensy bit slower  --pw */
+/* #define ADDRLEN 64 */
+
+/*
+ * RX_CHECKSUM turns on card-generated receive checksum generation for
+ *   TCP and UDP packets.  Otherwise the upper layers do the calculation.
+ * TX_CHECKSUM won't do anything too useful, even if it works.  There's no
+ *   easy mechanism by which to tell the TCP/UDP stack that it need not
+ *   generate checksums for this device.  But if somebody can find a way
+ *   to get that to work, most of the card work is in here already.
+ * 3/10/1999 Pete Wyckoff <wyckoff@ca.sandia.gov>
+ */
+#undef  TX_CHECKSUM
+#define RX_CHECKSUM
+
+/* Operational parameters that usually are not changed. */
+/* Time in jiffies before concluding the transmitter is hung. */
+#define TX_TIMEOUT  (2*HZ)
+
+#include <linux/config.h>
+#ifdef MODULE
+#ifdef MODVERSIONS
+#include <linux/modversions.h>
+#endif
+#include <linux/module.h>
+#include <linux/version.h>
+#else
+#define MOD_INC_USE_COUNT
+#define MOD_DEC_USE_COUNT
+#endif
+
+#include <linux/kernel.h>
+#include <linux/sched.h>
+#include <linux/string.h>
+#include <linux/timer.h>
+#include <linux/time.h>
+#include <linux/ptrace.h>
+#include <linux/errno.h>
+#include <linux/ioport.h>
+#include <linux/malloc.h>
+#include <linux/interrupt.h>
+#include <linux/pci.h>
+
+#if LINUX_VERSION_CODE < 0x20155
+#include <linux/bios32.h>
+#endif
+
+#include <asm/processor.h>	/* Processor type for cache alignment. */
+#include <asm/bitops.h>
+#include <asm/io.h>
+#include <asm/unaligned.h>
+#include <asm/cache.h>
+
+#include <linux/netdevice.h>
+#include <linux/etherdevice.h>
+#include <linux/skbuff.h>
+#include <linux/ip.h>
+#include <linux/delay.h>
+
+/* IP_MF appears to be only defined in <netinet/ip.h>, however,
+   we need it for hardware checksumming support.  FYI... some of
+   the definitions in <netinet/ip.h> conflict/duplicate those in
+   other linux headers causing many compiler warnings.
+*/
+#ifndef IP_MF
+  #define IP_MF 0x2000   /* IP more frags from <netinet/ip.h> */ 
+#endif
+
+/* Define IP_OFFSET to be IPOPT_OFFSET */
+#ifndef IP_OFFSET
+  #ifdef IPOPT_OFFSET
+    #define IP_OFFSET IPOPT_OFFSET
+  #else
+    #define IP_OFFSET 2
+  #endif
+#endif
+
+/* Kernel compatibility defines, some common to David Hind's PCMCIA package.
+   This is only in the support-all-kernels source code. */
+#include <linux/version.h>		/* Evil, but neccessary */
+
+#define RUN_AT(x) (jiffies + (x))
+
+/* Condensed bus+endian portability operations. */
+#if ADDRLEN == 64
+#define virt_to_desc(addr)  cpu_to_le64(virt_to_bus(addr))
+#else 
+#define virt_to_desc(addr)  cpu_to_le32(virt_to_bus(addr))
+#define le32desc_to_virt(addr)  bus_to_virt(le32_to_cpu(addr))
+#endif   
+
+
+#if (LINUX_VERSION_CODE >= 0x20100)
+static char kernel_version[] = UTS_RELEASE;
+#else
+#ifndef __alpha__
+#define ioremap vremap
+#define iounmap vfree
+#endif
+#endif
+#if LINUX_VERSION_CODE < 0x20123
+#define test_and_set_bit(val, addr) set_bit(val, addr)
+#endif
+#if LINUX_VERSION_CODE <= 0x20139
+#define	net_device_stats enet_statistics
+#define NETSTATS_VER2
+#endif
+#if LINUX_VERSION_CODE < 0x20155
+#define PCI_SUPPORT_VER1
+#endif
+#if LINUX_VERSION_CODE < 0x20159
+#define DEV_FREE_SKB(skb) dev_kfree_skb(skb, FREE_WRITE);
+#else  /* Grrr, unneeded incompatible change. */
+#define DEV_FREE_SKB(skb) dev_kfree_skb(skb);
+#endif
+#if ! defined(CAP_NET_ADMIN)
+#define capable(CAP_XXX) (suser())
+#endif
+#if ! defined(HAS_NETIF_QUEUE)
+#define netif_wake_queue(dev) mark_bh(NET_BH);
+#endif
+
+/*
+				Theory of Operation
+
+I. Board Compatibility
+
+This device driver is designed for the Packet Engines "Hamachi"
+Gigabit Ethernet chip.  The only PCA currently supported is the GNIC-II 64-bit
+66Mhz PCI card.
+
+II. Board-specific settings
+
+No jumpers exist on the board.  The chip supports software correction of
+various motherboard wiring errors, however this driver does not support
+that feature.
+
+III. Driver operation
+
+IIIa. Ring buffers
+
+The Hamachi uses a typical descriptor based bus-master architecture.
+The descriptor list is similar to that used by the Digital Tulip.
+This driver uses two statically allocated fixed-size descriptor lists
+formed into rings by a branch from the final descriptor to the beginning of
+the list.  The ring sizes are set at compile time by RX/TX_RING_SIZE.
+
+This driver uses a zero-copy receive and transmit scheme similar my other
+network drivers.
+The driver allocates full frame size skbuffs for the Rx ring buffers at
+open() time and passes the skb->data field to the Hamachi as receive data
+buffers.  When an incoming frame is less than RX_COPYBREAK bytes long,
+a fresh skbuff is allocated and the frame is copied to the new skbuff.
+When the incoming frame is larger, the skbuff is passed directly up the
+protocol stack and replaced by a newly allocated skbuff.
+
+The RX_COPYBREAK value is chosen to trade-off the memory wasted by
+using a full-sized skbuff for small frames vs. the copying costs of larger
+frames.  Gigabit cards are typically used on generously configured machines
+and the underfilled buffers have negligible impact compared to the benefit of
+a single allocation size, so the default value of zero results in never
+copying packets.
+
+IIIb/c. Transmit/Receive Structure
+
+The Rx and Tx descriptor structure are straight-forward, with no historical
+baggage that must be explained.  Unlike the awkward DBDMA structure, there
+are no unused fields or option bits that had only one allowable setting.
+
+Two details should be noted about the descriptors: The chip supports both 32
+bit and 64 bit address structures, and the length field is overwritten on
+the receive descriptors.  The descriptor length is set in the control word
+for each channel. The development driver uses 32 bit addresses only, however
+64 bit addresses may be enabled for 64 bit architectures e.g. the Alpha.
+
+IIId. Synchronization
+
+This driver is very similar to my other network drivers.
+The driver runs as two independent, single-threaded flows of control.  One
+is the send-packet routine, which enforces single-threaded use by the
+dev->tbusy flag.  The other thread is the interrupt handler, which is single
+threaded by the hardware and other software.
+
+The send packet thread has partial control over the Tx ring and 'dev->tbusy'
+flag.  It sets the tbusy flag whenever it's queuing a Tx packet. If the next
+queue slot is empty, it clears the tbusy flag when finished otherwise it sets
+the 'hmp->tx_full' flag.
+
+The interrupt handler has exclusive control over the Rx ring and records stats
+from the Tx ring.  After reaping the stats, it marks the Tx queue entry as
+empty by incrementing the dirty_tx mark. Iff the 'hmp->tx_full' flag is set, it
+clears both the tx_full and tbusy flags.
+
+IV. Notes
+
+Thanks to Kim Stearns of Packet Engines for providing a pair of GNIC-II boards.
+
+IVb. References
+
+Hamachi Engineering Design Specification, 5/15/97
+(Note: This version was marked "Confidential".)
+
+IVc. Errata
+
+None noted.  
+
+V.  Recent Changes
+
+01/15/1999 EPK  Enlargement of the TX and RX ring sizes.  This appears 
+    to help avoid some stall conditions -- this needs further research.
+
+01/15/1999 EPK  Creation of the hamachi_tx function.  This function cleans 
+    the Tx ring and is called from hamachi_start_xmit (this used to be
+    called from hamachi_interrupt but it tends to delay execution of the
+    interrupt handler and thus reduce bandwidth by reducing the latency
+    between hamachi_rx()'s).  Notably, some modification has been made so 
+    that the cleaning loop checks only to make sure that the DescOwn bit 
+    isn't set in the status flag since the card is not required 
+    to set the entire flag to zero after processing.
+
+01/15/1999 EPK In the hamachi_start_tx function, the Tx ring full flag is 
+    checked before attempting to add a buffer to the ring.  If the ring is full
+    an attempt is made to free any dirty buffers and thus find space for
+    the new buffer or the function returns non-zero which should case the
+    scheduler to reschedule the buffer later.
+
+01/15/1999 EPK Some adjustments were made to the chip intialization.  
+    End-to-end flow control should now be fully active and the interrupt 
+    algorithm vars have been changed.  These could probably use further tuning.
+
+01/15/1999 EPK Added the max_{rx,tx}_latency options.  These are used to
+    set the rx and tx latencies for the Hamachi interrupts. If you're having
+    problems with network stalls, try setting these to higher values.
+    Valid values are 0x00 through 0xff.
+
+01/15/1999 EPK In general, the overall bandwidth has increased and 
+    latencies are better (sometimes by a factor of 2).  Stalls are rare at
+    this point, however there still appears to be a bug somewhere between the
+    hardware and driver.  TCP checksum errors under load also appear to be
+    eliminated at this point.
+
+01/18/1999 EPK Ensured that the DescEndRing bit was being set on both the
+    Rx and Tx rings.  This appears to have been affecting whether a particular
+    peer-to-peer connection would hang under high load.  I believe the Rx
+    rings was typically getting set correctly, but the Tx ring wasn't getting
+    the DescEndRing bit set during initialization. ??? Does this mean the
+    hamachi card is using the DescEndRing in processing even if a particular
+    slot isn't in use -- hypothetically, the card might be searching the 
+    entire Tx ring for slots with the DescOwn bit set and then processing
+    them.  If the DescEndRing bit isn't set, then it might just wander off
+    through memory until it hits a chunk of data with that bit set
+    and then looping back.
+
+02/09/1999 EPK Added Michel Mueller's TxDMA Interrupt and Tx-timeout 
+    problem (TxCmd and RxCmd need only to be set when idle or stopped.
+
+02/09/1999 EPK Added code to check/reset dev->tbusy in hamachi_interrupt.
+    (Michel Mueller pointed out the ``permanently busy'' potential 
+    problem here).
+
+02/22/1999 EPK Added Pete Wyckoff's ioctl to control the Tx/Rx latencies. 
+
+02/23/1999 EPK Verified that the interrupt status field bits for Tx were
+    incorrectly defined and corrected (as per Michel Mueller).
+
+02/23/1999 EPK Corrected the Tx full check to check that at least 4 slots
+    were available before reseting the tbusy and tx_full flags
+    (as per Michel Mueller).
+
+03/11/1999 EPK Added Pete Wyckoff's hardware checksumming support.
+
+12/31/1999 KDU Cleaned up assorted things and added Don's code to force
+32 bit.
+
+02/20/2000 KDU Some of the control was just plain odd.  Cleaned up the
+hamachi_start_xmit() and hamachi_interrupt() code.  There is still some
+re-structuring I would like to do.  
+
+03/01/2000 KDU Experimenting with a WIDE range of interrupt mitigation
+parameters on a dual P3-450 setup yielded the new default interrupt
+mitigation parameters.  Tx should interrupt VERY infrequently due to
+Eric's scheme.  Rx should be more often...
+
+03/13/2000 KDU Added a patch to make the Rx Checksum code interact
+nicely with non-linux machines.  
+
+03/13/2000 KDU Experimented with some of the configuration values:  
+
+	-It seems that enabling PCI performance commands for descriptors
+	(changing RxDMACtrl and TxDMACtrl lower nibble from 5 to D) has minimal 
+	performance impact for any of my tests. (ttcp, netpipe, netperf)  I will 
+	leave them that way until I hear further feedback.
+
+	-Increasing the PCI_LATENCY_TIMER to 130 
+	(2 + (burst size of 128 * (0 wait states + 1))) seems to slightly
+	degrade performance.  Leaving default at 64 pending further information.
+
+03/14/2000 KDU Further tuning:  
+
+	-adjusted boguscnt in hamachi_rx() to depend on interrupt
+	mitigation parameters chosen.
+
+	-Selected a set of interrupt parameters based on some extensive testing.  
+	These may change with more testing.
+
+TO DO:
+
+-Consider borrowing from the acenic driver code to check PCI_COMMAND for
+PCI_COMMAND_INVALIDATE.  Set maximum burst size to cache line size in
+that case.
+
+-fix the reset procedure.  It doesn't quite work.  
+*/
+
+/* A few values that may be tweaked. */
+/* Size of each temporary Rx buffer, calculated as:
+ * 1518 bytes (ethernet packet) + 2 bytes (to get 8 byte alignment for
+ * the card) + 8 bytes of status info + 8 bytes for the Rx Checksum +
+ * 2 more because we use skb_reserve.  
+ */
+#define PKT_BUF_SZ		1538
+
+/* For now, this is going to be set to the maximum size of an ethernet
+ * packet.  Eventually, we may want to make it a variable that is
+ * related to the MTU
+ */
+#define MAX_FRAME_SIZE  1518
+
+/* The rest of these values should never change. */
+
+static void hamachi_timer(unsigned long data);
+
+enum capability_flags {CanHaveMII=1, };
+struct chip_info {
+	u16	vendor_id, device_id, device_id_mask, pad;
+	const char *name;
+	void (*media_timer)(unsigned long data);
+	int flags;
+} chip_tbl[] = {
+	{0x1318, 0x0911, 0xffff, 0, "Hamachi GNIC-II", hamachi_timer, 0},
+	{0,},
+};
+
+/* Offsets to the Hamachi registers.  Various sizes. */
+enum hamachi_offsets {
+	TxDMACtrl=0x00, TxCmd=0x04, TxStatus=0x06, TxPtr=0x08, TxCurPtr=0x10,
+	RxDMACtrl=0x20, RxCmd=0x24, RxStatus=0x26, RxPtr=0x28, RxCurPtr=0x30,
+	PCIClkMeas=0x060, MiscStatus=0x066, ChipRev=0x68, ChipReset=0x06B,
+	LEDCtrl=0x06C, VirtualJumpers=0x06D, GPIO=0x6E,
+	TxChecksum=0x074, RxChecksum=0x076,
+	TxIntrCtrl=0x078, RxIntrCtrl=0x07C,
+	InterruptEnable=0x080, InterruptClear=0x084, IntrStatus=0x088,
+	EventStatus=0x08C,
+	MACCnfg=0x0A0, FrameGap0=0x0A2, FrameGap1=0x0A4,
+	/* See enum MII_offsets below. */
+	MACCnfg2=0x0B0, RxDepth=0x0B8, FlowCtrl=0x0BC, MaxFrameSize=0x0CE,
+	AddrMode=0x0D0, StationAddr=0x0D2,
+	/* Gigabit AutoNegotiation. */
+	ANCtrl=0x0E0, ANStatus=0x0E2, ANXchngCtrl=0x0E4, ANAdvertise=0x0E8,
+	ANLinkPartnerAbility=0x0EA,
+	EECmdStatus=0x0F0, EEData=0x0F1, EEAddr=0x0F2,
+	FIFOcfg=0x0F8,
+};
+
+/* Offsets to the MII-mode registers. */
+enum MII_offsets {
+	MII_Cmd=0xA6, MII_Addr=0xA8, MII_Wr_Data=0xAA, MII_Rd_Data=0xAC,
+	MII_Status=0xAE,
+};
+
+/* Bits in the interrupt status/mask registers. */
+enum intr_status_bits {
+	IntrRxDone=0x01, IntrRxPCIFault=0x02, IntrRxPCIErr=0x04,
+	IntrTxDone=0x100, IntrTxPCIFault=0x200, IntrTxPCIErr=0x400,
+	LinkChange=0x10000, NegotiationChange=0x20000, StatsMax=0x40000, };
+
+/* The Hamachi Rx and Tx buffer descriptors. */
+struct hamachi_desc {
+	u32 status_n_length;			
+#if ADDRLEN == 64
+	u32 pad;
+	u64 addr;
+#else
+	u32 addr;
+#endif
+};
+
+/* Bits in hamachi_desc.status_n_length */
+enum desc_status_bits {
+	DescOwn=0x80000000, DescEndPacket=0x40000000, DescEndRing=0x20000000, 
+	DescIntr=0x10000000,
+};
+
+#define PRIV_ALIGN   15    				/* Required alignment mask */
+struct hamachi_private {
+	/* Descriptor rings first for alignment.  Tx requires a second descriptor
+	   for status. */
+	struct hamachi_desc rx_ring[RX_RING_SIZE];
+	struct hamachi_desc tx_ring[TX_RING_SIZE];
+	/* The addresses of receive-in-place skbuffs. */
+	struct sk_buff* rx_skbuff[RX_RING_SIZE];
+	/* The saved address of a sent-in-place packet/buffer, for skfree(). */
+	struct sk_buff* tx_skbuff[TX_RING_SIZE];
+	struct device *next_module;
+	void *priv_addr; /* Unaligned address for kfree */
+	struct net_device_stats stats;
+	struct timer_list timer;				/* Media selection timer. */
+	/* Frequently used and paired value: keep adjacent for cache effect. */
+	int chip_id;
+	int in_interrupt;
+	struct hamachi_desc *rx_head_desc;
+	unsigned int cur_rx, dirty_rx;		/* Producer/consumer ring indices */
+	unsigned int cur_tx, dirty_tx;
+	unsigned int rx_buf_sz;					/* Based on MTU+slack. */
+	unsigned int tx_full:1;					/* The Tx queue is full. */
+	unsigned int full_duplex:1;			/* Full-duplex operation requested. */
+	unsigned int duplex_lock:1;
+	unsigned int medialock:1;				/* Do not sense media. */
+	unsigned int default_port:4;			/* Last dev->if_port value. */
+	/* MII transceiver section. */
+	int mii_cnt;								/* MII device addresses. */
+	u16 advertising;							/* NWay media advertisement */
+	unsigned char phys[2];					/* MII device addresses. */
+	u_int32_t rx_int_var, tx_int_var;	/* interrupt control variables */
+	u_int32_t option;							/* Hold on to a copy of the options */
+	u_int8_t pad[16];							/* Used for 32-byte alignment */
+};
+
+#ifdef MODULE
+
+#if LINUX_VERSION_CODE > 0x20115
+MODULE_AUTHOR("Donald Becker <becker@cesdis.gsfc.nasa.gov>, Eric Kasten <kasten@nscl.msu.edu>, Keith Underwood <keithu@parl.clemson.edu>");
+MODULE_DESCRIPTION("Packet Engines 'Hamachi' GNIC-II Gigabit Ethernet driver");
+MODULE_PARM(max_interrupt_work, "i");
+MODULE_PARM(min_pci_latency, "i");
+MODULE_PARM(mtu, "i");
+MODULE_PARM(debug, "i");
+MODULE_PARM(min_rx_pkt, "i");
+MODULE_PARM(max_rx_gap, "i");
+MODULE_PARM(max_rx_latency, "i");
+MODULE_PARM(min_tx_pkt, "i");
+MODULE_PARM(max_tx_gap, "i");
+MODULE_PARM(max_tx_latency, "i");
+MODULE_PARM(rx_copybreak, "i");
+MODULE_PARM(rx_params, "1-" __MODULE_STRING(MAX_UNITS) "i");
+MODULE_PARM(tx_params, "1-" __MODULE_STRING(MAX_UNITS) "i");
+MODULE_PARM(options, "1-" __MODULE_STRING(MAX_UNITS) "i");
+MODULE_PARM(full_duplex, "1-" __MODULE_STRING(MAX_UNITS) "i");
+MODULE_PARM(force32, "i");
+#endif
+
+#endif
+
+static struct device *hamachi_probe1(struct device *dev, long ioaddr,
+									   int irq, int chip_id, int options);
+static int read_eeprom(long ioaddr, int location);
+static int mdio_read(long ioaddr, int phy_id, int location);
+static void mdio_write(long ioaddr, int phy_id, int location, int value);
+static int hamachi_open(struct device *dev);
+#ifdef HAVE_PRIVATE_IOCTL
+static int mii_ioctl(struct device *dev, struct ifreq *rq, int cmd);
+#endif
+static void hamachi_timer(unsigned long data);
+static void hamachi_tx_timeout(struct device *dev);
+static void hamachi_init_ring(struct device *dev);
+static int hamachi_start_xmit(struct sk_buff *skb, struct device *dev);
+static void hamachi_interrupt(int irq, void *dev_instance, struct pt_regs *regs);
+static inline int hamachi_rx(struct device *dev);
+static inline int hamachi_tx(struct device *dev);
+static void hamachi_error(struct device *dev, int intr_status);
+static int hamachi_close(struct device *dev);
+static struct net_device_stats *hamachi_get_stats(struct device *dev);
+static void set_rx_mode(struct device *dev);
+
+/* A list of our installed devices, for removing the driver module. */
+static struct device *root_hamachi_dev = NULL;
+
+int hamachi_probe(struct device *dev)
+{
+	int cards_found = 0;
+	int pci_index = 0;
+	unsigned char pci_bus, pci_device_fn;
+
+	if ( ! pcibios_present())
+		return -ENODEV;
+
+	for (;pci_index < 0xff; pci_index++) {
+		u16 pci_command, new_command, vendor, device;
+		int chip_idx;
+		int irq;
+		long pciaddr;
+		long ioaddr;
+
+		if (pcibios_find_class (PCI_CLASS_NETWORK_ETHERNET << 8,
+								pci_index, &pci_bus, &pci_device_fn)
+			!= PCIBIOS_SUCCESSFUL)
+			break;
+		pcibios_read_config_word(pci_bus, pci_device_fn,
+								 PCI_VENDOR_ID, &vendor);
+		pcibios_read_config_word(pci_bus, pci_device_fn,
+								 PCI_DEVICE_ID, &device);
+
+		for (chip_idx = 0; chip_tbl[chip_idx].vendor_id; chip_idx++)
+			if (vendor == chip_tbl[chip_idx].vendor_id
+				&& (device & chip_tbl[chip_idx].device_id_mask) ==
+				chip_tbl[chip_idx].device_id)
+				break;
+		if (chip_tbl[chip_idx].vendor_id == 0) 		/* Compiled out! */
+			continue;
+
+		{
+#if LINUX_VERSION_CODE > 0x20155  ||  PCI_SUPPORT_1
+			struct pci_dev *pdev = pci_find_slot(pci_bus, pci_device_fn);
+			pciaddr = pdev->base_address[0];
+#ifdef __alpha__				/* Really "64 bit addrs" */
+			pciaddr |= ((long)pdev->base_address[1]) << 32;
+#endif
+			irq = pdev->irq;
+			printk(KERN_INFO "Found %s at PCI address %#lx, IRQ %d.\n",
+				   chip_tbl[chip_idx].name, pciaddr, irq);
+#else
+			u32 pci_memaddr, pci_memaddr_hi = 0;
+			u8 pci_irq_line;
+			pcibios_read_config_byte(pci_bus, pci_device_fn,
+									 PCI_INTERRUPT_LINE, &pci_irq_line);
+			pcibios_read_config_dword(pci_bus, pci_device_fn,
+									  PCI_BASE_ADDRESS_0, &pci_memaddr);
+			pciaddr = pci_memaddr;
+#ifdef __alpha__				/* Really "64 bit addrs" */
+			pcibios_read_config_dword(pci_bus, pci_device_fn,
+									  PCI_BASE_ADDRESS_1, &pci_memaddr_hi);
+			pciaddr = pci_memaddr + ((long)pci_memaddr_hi<<32);
+#endif
+			irq = pci_irq_line;
+			printk(KERN_INFO "Found %s at PCI address %#8.8x %8.8x, IRQ %d.\n",
+				   chip_tbl[chip_idx].name, pci_memaddr_hi, pci_memaddr, irq);
+#endif
+		}
+
+		if (hamachi_debug > 2)
+			printk(KERN_INFO "Found %s at PCI address %#lx, IRQ %d.\n",
+				   chip_tbl[chip_idx].name, pciaddr, irq);
+		ioaddr = (long)ioremap(pciaddr & ~0xf, 0x400);
+
+		if (ioaddr == 0) {
+			printk(KERN_INFO "Failed to map PCI address %#lx.\n",
+				   pciaddr);
+			continue;
+		}
+
+		pcibios_read_config_word(pci_bus, pci_device_fn,
+								 PCI_COMMAND, &pci_command);
+		new_command = pci_command | PCI_COMMAND_MASTER|PCI_COMMAND_MEMORY;
+
+		
+		if (pci_command != new_command) {
+			printk(KERN_INFO "  The PCI BIOS has not enabled the"
+				   " device at %d/%d!  Updating PCI command %4.4x->%4.4x.\n",
+				   pci_bus, pci_device_fn, pci_command, new_command);
+			pcibios_write_config_word(pci_bus, pci_device_fn,
+									  PCI_COMMAND, new_command);
+		}
+
+		dev = hamachi_probe1(dev, ioaddr, irq, chip_idx, cards_found);
+
+		if (dev) {
+			u8 pci_latency, pci_cache_line_size, cache_line_size_guess;
+			cache_line_size_guess = L1_CACHE_BYTES >> 2;
+			/* Disable timeouts (errata), check PCI latency values. */
+			pcibios_write_config_byte(pci_bus, pci_device_fn, 0x40, 0);
+			pcibios_write_config_byte(pci_bus, pci_device_fn, 0x41, 0);
+			pcibios_read_config_byte(pci_bus, pci_device_fn,
+									 PCI_LATENCY_TIMER, &pci_latency);
+			if (pci_latency < min_pci_latency) {
+				printk(KERN_INFO "  PCI latency timer (CFLT) is "
+					   "unreasonably low at %d.  Setting to %d clocks.\n",
+					   pci_latency, min_pci_latency);
+				pcibios_write_config_byte(pci_bus, pci_device_fn,
+										  PCI_LATENCY_TIMER, min_pci_latency);
+			} else if (hamachi_debug > 1)
+				printk(KERN_INFO "  PCI latency timer (CFLT) is %#x.\n",
+					   pci_latency);
+			pcibios_read_config_byte(pci_bus, pci_device_fn,
+				PCI_CACHE_LINE_SIZE, &pci_cache_line_size);
+			if (pci_cache_line_size == 0){
+				printk(KERN_INFO "  PCI cache line size was %d.  Setting to
+					%d\n", pci_cache_line_size, cache_line_size_guess);
+				pcibios_write_config_byte(pci_bus, pci_device_fn,
+					PCI_CACHE_LINE_SIZE, cache_line_size_guess);
+			}
+		}
+		dev = 0;
+		cards_found++;
+	}
+
+	return cards_found ? 0 : -ENODEV;
+}
+
+static struct device *hamachi_probe1(struct device *dev, long ioaddr,
+									   int irq, int chip_id, int card_idx)
+{
+	static int did_version = 0;			/* Already printed version info. */
+	struct hamachi_private *hmp;
+	int option, i, rx_int_var, tx_int_var, boguscnt;
+
+	if (hamachi_debug > 0  &&  did_version++ == 0)
+		printk(version);
+
+	dev = init_etherdev(dev, sizeof(struct hamachi_private));
+#ifdef TX_CHECKSUM
+	printk("check that skbcopy in ip_queue_xmit isn't happening\n");
+	dev->hard_header_len += 8;  /* for cksum tag */
+#endif
+
+	printk(KERN_INFO "%s: %s type %x at 0x%lx, ",
+		   dev->name, chip_tbl[chip_id].name, readl(ioaddr + ChipRev),
+		   ioaddr);
+
+	for (i = 0; i < 6; i++)
+		dev->dev_addr[i] = 1 ? read_eeprom(ioaddr, 4 + i)
+			: readb(ioaddr + StationAddr + i);
+	for (i = 0; i < 5; i++)
+			printk("%2.2x:", dev->dev_addr[i]);
+	printk("%2.2x, IRQ %d.\n", dev->dev_addr[i], irq);
+
+#if ! defined(final_version)
+	if (hamachi_debug > 4)
+		for (i = 0; i < 0x10; i++)
+			printk("%2.2x%s",
+				   read_eeprom(ioaddr, i), i % 16 != 15 ? " " : "\n");
+#endif
+
+#if 0 /* Moving this until after the force 32 check and reset. */
+	i = readb(ioaddr + PCIClkMeas);
+	printk(KERN_INFO "%s:  %d-bit %d Mhz PCI bus (%d), Virtual Jumpers "
+		   "%2.2x, LPA %4.4x.\n",
+		   dev->name, readw(ioaddr + MiscStatus) & 1 ? 64 : 32,
+		   i ? 2000/(i&0x7f) : 0, i&0x7f, (int)readb(ioaddr + VirtualJumpers),
+		   readw(ioaddr + ANLinkPartnerAbility));
+#endif
+
+	/* Make certain the descriptor lists are aligned. */
+	{
+		void *mem = kmalloc(sizeof(*hmp) + PRIV_ALIGN, GFP_KERNEL);
+		hmp =  (void *)(((long)mem + PRIV_ALIGN) & ~PRIV_ALIGN);
+		dev->priv = hmp;
+		hmp->priv_addr = mem;
+	}
+   memset(hmp, 0, sizeof(*hmp));
+
+	/* Check for options being passed in */
+	option = card_idx < MAX_UNITS ? options[card_idx] : 0;
+	if (dev->mem_start)
+		option = dev->mem_start;
+
+	/* If the bus size is misidentified, do the following. */
+	force32 = force32 ? force32 : 
+		((option  >= 0) ? ((option & 0x00000070) >> 4) : 0 );
+	if (force32)
+		writeb(force32, ioaddr + VirtualJumpers);
+
+	/* Hmmm, do we really need to reset the chip???. */
+	writeb(0x01, ioaddr + ChipReset);
+
+	/* After a reset, the clock speed measurement of the PCI bus will not
+	 * be valid for a moment.  Wait for a little while until it is.  If
+	 * it takes more than 10ms, forget it.
+	 */
+	udelay(10);	
+	i = readb(ioaddr + PCIClkMeas);
+	for (boguscnt = 0; (!(i & 0x080)) && boguscnt < 1000; boguscnt++){
+		udelay(10);	
+		i = readb(ioaddr + PCIClkMeas);	
+	}
+
+	printk(KERN_INFO "%s:  %d-bit %d Mhz PCI bus (%d), Virtual Jumpers "
+		   "%2.2x, LPA %4.4x.\n",
+		   dev->name, readw(ioaddr + MiscStatus) & 1 ? 64 : 32,
+		   i ? 2000/(i&0x7f) : 0, i&0x7f, (int)readb(ioaddr + VirtualJumpers),
+		   readw(ioaddr + ANLinkPartnerAbility));
+
+	dev->base_addr = ioaddr;
+	dev->irq = irq;
+
+
+	hmp->next_module = root_hamachi_dev;
+	root_hamachi_dev = dev;
+
+	hmp->chip_id = chip_id;
+
+	/* The lower four bits are the media type. */
+	if (option > 0) {
+		hmp->option = option;
+		if (option & 0x200)
+			hmp->full_duplex = 1;
+		else if (option & 0x080)
+			hmp->full_duplex = 0;
+		hmp->default_port = option & 15;
+		if (hmp->default_port)
+			hmp->medialock = 1;
+	}
+	if (card_idx < MAX_UNITS  &&  full_duplex[card_idx] > 0)
+		hmp->full_duplex = 1;
+
+	/* lock the duplex mode if someone specified a value */
+	if (hmp->full_duplex || (option & 0x080))
+		hmp->duplex_lock = 1;
+
+	/* Set interrupt tuning parameters */
+	max_rx_latency = max_rx_latency & 0x00ff;
+	max_rx_gap = max_rx_gap & 0x00ff;
+	min_rx_pkt = min_rx_pkt & 0x00ff;
+	max_tx_latency = max_tx_latency & 0x00ff;
+	max_tx_gap = max_tx_gap & 0x00ff;
+	min_tx_pkt = min_tx_pkt & 0x00ff;
+
+	rx_int_var = card_idx < MAX_UNITS ? rx_params[card_idx] : -1;
+	tx_int_var = card_idx < MAX_UNITS ? tx_params[card_idx] : -1;
+	hmp->rx_int_var = rx_int_var >= 0 ? rx_int_var : 
+		(min_rx_pkt << 16 | max_rx_gap << 8 | max_rx_latency);
+	hmp->tx_int_var = tx_int_var >= 0 ? tx_int_var : 
+		(min_tx_pkt << 16 | max_tx_gap << 8 | max_tx_latency);
+
+
+	/* The Hamachi-specific entries in the device structure. */
+	dev->open = &hamachi_open;
+	dev->hard_start_xmit = &hamachi_start_xmit;
+	dev->stop = &hamachi_close;
+	dev->get_stats = &hamachi_get_stats;
+	dev->set_multicast_list = &set_rx_mode;
+#ifdef HAVE_PRIVATE_IOCTL
+	dev->do_ioctl = &mii_ioctl;
+#endif
+	if (mtu)
+		dev->mtu = mtu;
+
+	if (chip_tbl[hmp->chip_id].flags & CanHaveMII) {
+		int phy, phy_idx = 0;
+		for (phy = 0; phy < 32 && phy_idx < 4; phy++) {
+			int mii_status = mdio_read(ioaddr, phy, 1);
+			if (mii_status != 0xffff  &&
+				mii_status != 0x0000) {
+				hmp->phys[phy_idx++] = phy;
+				hmp->advertising = mdio_read(ioaddr, phy, 4);
+				printk(KERN_INFO "%s: MII PHY found at address %d, status "
+					   "0x%4.4x advertising %4.4x.\n",
+					   dev->name, phy, mii_status, hmp->advertising);
+			}
+		}
+		hmp->mii_cnt = phy_idx;
+	}
+	/* Configure gigabit autonegotiation. */
+	writew(0x0400, ioaddr + ANXchngCtrl);	/* Enable legacy links. */
+	writew(0x08e0, ioaddr + ANAdvertise);	/* Set our advertise word. */
+	writew(0x1000, ioaddr + ANCtrl);			/* Enable negotiation */
+	return dev;
+}
+
+static int read_eeprom(long ioaddr, int location)
+{
+	int bogus_cnt = 1000;
+
+	/* We should check busy first - per docs -KDU */
+	while ((readb(ioaddr + EECmdStatus) & 0x40)  && --bogus_cnt > 0);
+	writew(location, ioaddr + EEAddr);
+	writeb(0x02, ioaddr + EECmdStatus);
+	bogus_cnt = 1000;
+	while ((readb(ioaddr + EECmdStatus) & 0x40)  && --bogus_cnt > 0);
+	if (hamachi_debug > 5)
+		printk("   EEPROM status is %2.2x after %d ticks.\n",
+			   (int)readb(ioaddr + EECmdStatus), 1000- bogus_cnt);
+	return readb(ioaddr + EEData);
+}
+
+/* MII Managemen Data I/O accesses.
+   These routines assume the MDIO controller is idle, and do not exit until
+   the command is finished. */
+
+static int mdio_read(long ioaddr, int phy_id, int location)
+{
+	int i;
+
+	/* We should check busy first - per docs -KDU */
+	for (i = 10000; i >= 0; i--)
+		if ((readw(ioaddr + MII_Status) & 1) == 0)
+			break;
+	writew((phy_id<<8) + location, ioaddr + MII_Addr);
+	writew(0x0001, ioaddr + MII_Cmd);
+	for (i = 10000; i >= 0; i--)
+		if ((readw(ioaddr + MII_Status) & 1) == 0)
+			break;
+	return readw(ioaddr + MII_Rd_Data);
+}
+
+static void mdio_write(long ioaddr, int phy_id, int location, int value)
+{
+	int i;
+
+	/* We should check busy first - per docs -KDU */
+	for (i = 10000; i >= 0; i--)
+		if ((readw(ioaddr + MII_Status) & 1) == 0)
+			break;
+	writew((phy_id<<8) + location, ioaddr + MII_Addr);
+	writew(value, ioaddr + MII_Wr_Data);
+
+	/* Wait for the command to finish. */
+	for (i = 10000; i >= 0; i--)
+		if ((readw(ioaddr + MII_Status) & 1) == 0)
+			break;
+	return;
+}
+
+
+static int hamachi_open(struct device *dev)
+{
+	struct hamachi_private *hmp = (struct hamachi_private *)dev->priv;
+	long ioaddr = dev->base_addr;
+	int i;
+	u_int32_t rx_int_var, tx_int_var;
+	u_int16_t fifo_info;
+
+	if (request_irq(dev->irq, &hamachi_interrupt, SA_SHIRQ, dev->name, dev))
+		return -EAGAIN;
+
+	if (hamachi_debug > 1)
+		printk(KERN_DEBUG "%s: hamachi_open() irq %d.\n",
+			   dev->name, dev->irq);
+
+	MOD_INC_USE_COUNT;
+
+	hamachi_init_ring(dev);
+
+#if ADDRLEN == 64
+	writel(virt_to_bus(hmp->rx_ring), ioaddr + RxPtr);
+	writel(virt_to_bus(hmp->rx_ring) >> 32, ioaddr + RxPtr + 4);
+	writel(virt_to_bus(hmp->tx_ring), ioaddr + TxPtr);
+	writel(virt_to_bus(hmp->tx_ring) >> 32, ioaddr + TxPtr + 4);
+#else
+	writel(virt_to_bus(hmp->rx_ring), ioaddr + RxPtr);
+	writel(virt_to_bus(hmp->tx_ring), ioaddr + TxPtr);
+#endif
+
+	/* TODO:  It would make sense to organize this as words since the card 
+	 * documentation does. -KDU
+	 */
+	for (i = 0; i < 6; i++)
+		writeb(dev->dev_addr[i], ioaddr + StationAddr + i);
+
+	/* Initialize other registers: with so many this eventually this will
+	   converted to an offset/value list. */
+
+	/* Configure the FIFO */
+	fifo_info = (readw(ioaddr + GPIO) & 0x00C0) >> 6;
+	switch (fifo_info){
+		case 0 : 
+			/* No FIFO */
+			writew(0x0000, ioaddr + FIFOcfg);
+			break;
+		case 1 : 
+			/* Configure the FIFO for 512K external, 16K used for Tx. */
+			writew(0x0028, ioaddr + FIFOcfg);
+			break;
+		case 2 : 
+			/* Configure the FIFO for 1024 external, 32K used for Tx. */
+			writew(0x004C, ioaddr + FIFOcfg);
+			break;
+		case 3 : 
+			/* Configure the FIFO for 2048 external, 32K used for Tx. */
+			writew(0x006C, ioaddr + FIFOcfg);
+			break;
+		default : 
+			printk(KERN_WARNING "%s:  Unsupported external memory config!\n",
+				dev->name);
+			/* Default to no FIFO */
+			writew(0x0000, ioaddr + FIFOcfg);
+			break;
+	}
+	
+	if (dev->if_port == 0)
+		dev->if_port = hmp->default_port;
+
+	dev->tbusy = 0;
+	dev->interrupt = 0;
+	hmp->in_interrupt = 0;
+
+	/* Setting the Rx mode will start the Rx process. */
+	/* If someone didn't choose a duplex, default to full-duplex */ 
+	if (hmp->duplex_lock != 1)
+		hmp->full_duplex = 1;
+
+	/* always 1, takes no more time to do it */
+	writew(0x0001, ioaddr + RxChecksum);
+#ifdef TX_CHECKSUM
+	writew(0x0001, ioaddr + TxChecksum);
+#else
+	writew(0x0000, ioaddr + TxChecksum);
+#endif
+	writew(0x8000, ioaddr + MACCnfg); /* Soft reset the MAC */
+	writew(0x215F, ioaddr + MACCnfg);
+	writew(0x000C, ioaddr + FrameGap0); 
+	/* WHAT?!?!?  Why isn't this documented somewhere? -KDU */
+	writew(0x1018, ioaddr + FrameGap1);
+	/* Why do we enable receives/transmits here? -KDU */
+	writew(0x0780, ioaddr + MACCnfg2); /* Upper 16 bits control LEDs. */
+	/* Enable automatic generation of flow control frames, period 0xffff. */
+	writel(0x0030FFFF, ioaddr + FlowCtrl);
+	writew(MAX_FRAME_SIZE, ioaddr + MaxFrameSize); 	/* dev->mtu+14 ??? */
+
+	/* Enable legacy links. */
+	writew(0x0400, ioaddr + ANXchngCtrl);	/* Enable legacy links. */
+	/* Initial Link LED to blinking red. */
+	writeb(0x03, ioaddr + LEDCtrl);
+
+	/* Configure interrupt mitigation.  This has a great effect on
+	   performance, so systems tuning should start here!. */
+
+	rx_int_var = hmp->rx_int_var;
+	tx_int_var = hmp->tx_int_var;
+
+	if (hamachi_debug > 1) {
+		printk("max_tx_latency: %d, max_tx_gap: %d, min_tx_pkt: %d\n",
+			tx_int_var & 0x00ff, (tx_int_var & 0x00ff00) >> 8, 
+			(tx_int_var & 0x00ff0000) >> 16);
+		printk("max_rx_latency: %d, max_rx_gap: %d, min_rx_pkt: %d\n",
+			rx_int_var & 0x00ff, (rx_int_var & 0x00ff00) >> 8, 
+			(rx_int_var & 0x00ff0000) >> 16);
+		printk("rx_int_var: %x, tx_int_var: %x\n", rx_int_var, tx_int_var);
+	}
+
+	writel(tx_int_var, ioaddr + TxIntrCtrl); 
+	writel(rx_int_var, ioaddr + RxIntrCtrl); 
+
+	set_rx_mode(dev);
+
+	dev->start = 1;
+
+	/* Enable interrupts by setting the interrupt mask. */
+	writel(0x80878787, ioaddr + InterruptEnable);
+	writew(0x0000, ioaddr + EventStatus);	/* Clear non-interrupting events */
+
+	/* Configure and start the DMA channels. */
+	/* Burst sizes are in the low three bits: size = 4<<(val&7) */
+#if ADDRLEN == 64
+	writew(0x005D, ioaddr + RxDMACtrl); 		/* 128 dword bursts */
+	writew(0x005D, ioaddr + TxDMACtrl);
+#else
+	writew(0x001D, ioaddr + RxDMACtrl);
+	writew(0x001D, ioaddr + TxDMACtrl);
+#endif
+	writew(0x0001, dev->base_addr + RxCmd);
+
+	if (hamachi_debug > 2) {
+		printk(KERN_DEBUG "%s: Done hamachi_open(), status: Rx %x Tx %x.\n",
+			   dev->name, readw(ioaddr + RxStatus), readw(ioaddr + TxStatus));
+	}
+	/* Set the timer to check for link beat. */
+	init_timer(&hmp->timer);
+	hmp->timer.expires = RUN_AT((24*HZ)/10);			/* 2.4 sec. */
+	hmp->timer.data = (unsigned long)dev;
+	hmp->timer.function = &hamachi_timer;				/* timer handler */
+	add_timer(&hmp->timer);
+
+	return 0;
+}
+
+static inline int hamachi_tx(struct device *dev)
+{
+	struct hamachi_private *hmp = (struct hamachi_private *)dev->priv;
+
+	/* Update the dirty pointer until we find an entry that is
+		still owned by the card */
+	for (; hmp->cur_tx - hmp->dirty_tx > 0; hmp->dirty_tx++) {
+		int entry = hmp->dirty_tx % TX_RING_SIZE;
+		if (hmp->tx_ring[entry].status_n_length & cpu_to_le32(DescOwn)) 
+			break;
+		/* Free the original skb. */
+		if (hmp->tx_skbuff[entry] != 0) {
+			DEV_FREE_SKB(hmp->tx_skbuff[entry]);
+			hmp->tx_skbuff[entry] = 0;
+		}
+		hmp->tx_ring[entry].status_n_length = 0;
+		if (entry >= TX_RING_SIZE-1) 
+			hmp->tx_ring[TX_RING_SIZE-1].status_n_length |=
+				cpu_to_le32(DescEndRing);   
+		hmp->stats.tx_packets++;
+	}
+
+	return 0;
+}
+
+static void hamachi_timer(unsigned long data)
+{
+	struct device *dev = (struct device *)data;
+	struct hamachi_private *hmp = (struct hamachi_private *)dev->priv;
+	long ioaddr = dev->base_addr;
+	int next_tick = 10*HZ;
+
+	if (hamachi_debug > 2) {
+		printk(KERN_INFO "%s: Hamachi Autonegotiation status %4.4x, LPA "
+			   "%4.4x.\n", dev->name, readw(ioaddr + ANStatus),
+			   readw(ioaddr + ANLinkPartnerAbility));
+		printk(KERN_INFO "%s: Autonegotiation regs %4.4x %4.4x %4.4x "
+		       "%4.4x %4.4x %4.4x.\n", dev->name,
+		       readw(ioaddr + 0x0e0),
+		       readw(ioaddr + 0x0e2),
+		       readw(ioaddr + 0x0e4),
+		       readw(ioaddr + 0x0e6),
+		       readw(ioaddr + 0x0e8),
+		       readw(ioaddr + 0x0eA));
+	}
+	/* We could do something here... nah. */
+	hmp->timer.expires = RUN_AT(next_tick);
+	add_timer(&hmp->timer);
+}
+
+static void hamachi_tx_timeout(struct device *dev)
+{
+	int i;
+	struct hamachi_private *hmp = (struct hamachi_private *)dev->priv;
+	long ioaddr = dev->base_addr;
+
+	/* no one else should act on this device while we are in here */
+	set_bit(0, (void *)&dev->tbusy);
+
+	printk(KERN_WARNING "%s: Hamachi transmit timed out, status %8.8x,"
+		   " resetting...\n", dev->name, (int)readw(ioaddr + TxStatus));
+
+#ifndef __alpha__
+	{
+		int i;
+		printk(KERN_DEBUG "  Rx ring %8.8x: ", (int)hmp->rx_ring);
+		for (i = 0; i < RX_RING_SIZE; i++)
+			printk(" %8.8x", (unsigned int)hmp->rx_ring[i].status_n_length);
+		printk("\n"KERN_DEBUG"  Tx ring %8.8x: ", (int)hmp->tx_ring);
+		for (i = 0; i < TX_RING_SIZE; i++)
+			printk(" %4.4x", hmp->tx_ring[i].status_n_length);
+		printk("\n");
+	}
+#endif
+
+	/* Reinit the hardware and make sure the Rx and Tx processes 
+		are up and running.
+	 */
+	dev->if_port = 0;
+	/* The right way to do Reset. -KDU
+	 *		-Clear OWN bit in all Rx/Tx descriptors
+	 *		-Wait 50 uS for channels to go idle
+	 *		-Turn off MAC receiver
+	 *		-Issue Reset
+	 */
+	
+	for (i = 0; i < RX_RING_SIZE; i++)
+		hmp->rx_ring[i].status_n_length &= ~DescOwn;
+
+	/* Presume that all packets in the Tx queue are gone if we have to
+	 * re-init the hardware.
+	 */
+	for (i = 0; i < TX_RING_SIZE; i++){
+		if (i >= TX_RING_SIZE - 1)
+			hmp->tx_ring[i].status_n_length = DescEndRing |
+				(hmp->tx_ring[i].status_n_length & 0x0000FFFF);
+		else	
+			hmp->tx_ring[i].status_n_length &= 0x0000ffff;
+		if (hmp->tx_skbuff[i]){
+			DEV_FREE_SKB(hmp->tx_skbuff[i]);
+			hmp->tx_skbuff[i] = 0;
+		}
+	}
+
+	udelay(60); /* Sleep 60 us just for safety sake */
+	writew(0x0002, dev->base_addr + RxCmd); /* STOP Rx */
+		
+	writeb(0x01, ioaddr + ChipReset);  /* Reinit the hardware */ 
+
+	hmp->tx_full = 0;
+	hmp->cur_rx = hmp->cur_tx = 0;
+	hmp->dirty_rx = hmp->dirty_tx = 0;
+	hmp->rx_head_desc = &hmp->rx_ring[0];
+	/* Rx packets are also presumed lost; however, we need to make sure a
+	 * ring of buffers is in tact. -KDU
+	 */ 
+	for (i = 0; i < RX_RING_SIZE; i++){
+		if (hmp->rx_skbuff[i]){
+			DEV_FREE_SKB(hmp->rx_skbuff[i]);
+			hmp->rx_skbuff[i] = 0;
+		}
+	}
+	/* Fill in the Rx buffers.  Handle allocation failure gracefully. */
+	for (i = 0; i < RX_RING_SIZE; i++) {
+		struct sk_buff *skb = dev_alloc_skb(hmp->rx_buf_sz);
+		hmp->rx_skbuff[i] = skb;
+		if (skb == NULL)
+			break;
+		skb->dev = dev;         /* Mark as being used by this device. */
+		skb_reserve(skb, 2); /* 16 byte align the IP header. */
+		hmp->rx_ring[i].addr = virt_to_desc(skb->tail);
+		hmp->rx_ring[i].status_n_length =
+			cpu_to_le32(DescOwn | DescEndPacket | DescIntr | (hmp->rx_buf_sz - 2));
+	}
+	hmp->dirty_rx = (unsigned int)(i - RX_RING_SIZE);
+	/* Mark the last entry as wrapping the ring. */
+	hmp->rx_ring[RX_RING_SIZE-1].status_n_length |= cpu_to_le32(DescEndRing);
+
+
+	/* Trigger an immediate transmit demand. */
+	dev->trans_start = jiffies;
+	hmp->stats.tx_errors++;
+
+	/* Restart the chip's Tx/Rx processes . */
+	writew(0x0002, dev->base_addr + TxCmd); /* STOP Tx */
+	writew(0x0001, dev->base_addr + TxCmd); /* START Tx */
+	writew(0x0001, dev->base_addr + RxCmd); /* START Rx */
+
+	clear_bit(0, (void *)&dev->tbusy);
+
+	return;
+}
+
+
+/* Initialize the Rx and Tx rings, along with various 'dev' bits. */
+static void hamachi_init_ring(struct device *dev)
+{
+	struct hamachi_private *hmp = (struct hamachi_private *)dev->priv;
+	int i;
+
+	hmp->tx_full = 0;
+	hmp->cur_rx = hmp->cur_tx = 0;
+	hmp->dirty_rx = hmp->dirty_tx = 0;
+
+#if 0
+	/* This is wrong.  I'm not sure what the original plan was, but this
+	 * is wrong.  An MTU of 1 gets you a buffer of 1536, while an MTU
+	 * of 1501 gets a buffer of 1533? -KDU
+	 */
+	hmp->rx_buf_sz = (dev->mtu <= 1500 ? PKT_BUF_SZ : dev->mtu + 32);
+#endif
+	/* My attempt at a reasonable correction */
+	/* +26 gets the maximum ethernet encapsulation, +7 & ~7 because the
+	 * card needs room to do 8 byte alignment, +2 so we can reserve 
+	 * the first 2 bytes, and +16 gets room for the status word from the 
+	 * card.  -KDU
+	 */
+	hmp->rx_buf_sz = (dev->mtu <= 1492 ? PKT_BUF_SZ : 
+		(((dev->mtu+26+7) & ~7) + 2 + 16));
+
+	hmp->rx_head_desc = &hmp->rx_ring[0];
+
+	/* Initialize all Rx descriptors. */
+	for (i = 0; i < RX_RING_SIZE; i++) {
+		hmp->rx_ring[i].status_n_length = 0;
+		hmp->rx_skbuff[i] = 0;
+	}
+	/* Fill in the Rx buffers.  Handle allocation failure gracefully. */
+	for (i = 0; i < RX_RING_SIZE; i++) {
+		struct sk_buff *skb = dev_alloc_skb(hmp->rx_buf_sz);
+		hmp->rx_skbuff[i] = skb;
+		if (skb == NULL)
+			break;
+		skb->dev = dev;         /* Mark as being used by this device. */
+		skb_reserve(skb, 2); /* 16 byte align the IP header. */
+		hmp->rx_ring[i].addr = virt_to_desc(skb->tail);
+		/* -2 because it doesn't REALLY have that first 2 bytes -KDU */
+		hmp->rx_ring[i].status_n_length =
+			cpu_to_le32(DescOwn | DescEndPacket | DescIntr | (hmp->rx_buf_sz -2));
+	}
+	hmp->dirty_rx = (unsigned int)(i - RX_RING_SIZE);
+	/* Mark the last entry as wrapping the ring. */
+	hmp->rx_ring[RX_RING_SIZE-1].status_n_length |= cpu_to_le32(DescEndRing);
+
+
+	/* Mark the last entry as wrapping the ring. */
+	hmp->rx_ring[RX_RING_SIZE-1].status_n_length |= DescEndRing;
+
+	for (i = 0; i < TX_RING_SIZE; i++) {
+		hmp->tx_skbuff[i] = 0;
+		hmp->tx_ring[i].status_n_length = 0;
+	}
+	/* Mark the last entry as wrapping the ring. */
+	hmp->tx_ring[TX_RING_SIZE-1].status_n_length |= cpu_to_le32(DescEndRing);
+
+	return;
+}
+
+
+#ifdef TX_CHECKSUM
+#define csum_add(it, val) \
+do { \
+    it += (u16) (val); \
+    if (it & 0xffff0000) { \
+	it &= 0xffff; \
+	++it; \
+    } \
+} while (0)
+    /* printk("add %04x --> %04x\n", val, it); \ */
+
+/* uh->len already network format, do not swap */
+#define pseudo_csum_udp(sum,ih,uh) do { \
+    sum = 0; \
+    csum_add(sum, (ih)->saddr >> 16); \
+    csum_add(sum, (ih)->saddr & 0xffff); \
+    csum_add(sum, (ih)->daddr >> 16); \
+    csum_add(sum, (ih)->daddr & 0xffff); \
+    csum_add(sum, __constant_htons(IPPROTO_UDP)); \
+    csum_add(sum, (uh)->len); \
+} while (0)
+
+/* swap len */
+#define pseudo_csum_tcp(sum,ih,len) do { \
+    sum = 0; \
+    csum_add(sum, (ih)->saddr >> 16); \
+    csum_add(sum, (ih)->saddr & 0xffff); \
+    csum_add(sum, (ih)->daddr >> 16); \
+    csum_add(sum, (ih)->daddr & 0xffff); \
+    csum_add(sum, __constant_htons(IPPROTO_TCP)); \
+    csum_add(sum, htons(len)); \
+} while (0)
+#endif
+
+static int hamachi_start_xmit(struct sk_buff *skb, struct device *dev)
+{
+	struct hamachi_private *hmp = (struct hamachi_private *)dev->priv;
+	unsigned entry;
+	u16 status;
+
+	/* Block a timer-based transmit from overlapping.  This could better be
+	   done with atomic_swap(1, dev->tbusy), but set_bit() works as well. */
+	if (test_and_set_bit(0, (void*)&dev->tbusy)) {
+		if (jiffies - dev->trans_start < TX_TIMEOUT)
+			return 1;
+		hamachi_tx_timeout(dev);
+		return 1;
+	}
+
+	/* Ok, now make sure that the queue has space before trying to 
+		add another skbuff.  if we return non-zero the scheduler
+		should interpret this as a queue full and requeue the buffer
+		for later.
+	 */
+	if (hmp->tx_full) {
+		/* We should NEVER reach this point -KDU */
+		printk(KERN_WARNING "%s: Hamachi transmit queue full at slot %d.\n",dev->name, hmp->cur_tx);
+
+		/* Wake the potentially-idle transmit channel. */
+		/* If we don't need to read status, DON'T -KDU */
+		status=readw(dev->base_addr + TxStatus);
+		if( !(status & 0x0001) || (status & 0x0002))
+			writew(0x0001, dev->base_addr + TxCmd);
+		return 1;
+	} 
+
+	/* Caution: the write order is important here, set the field
+	   with the "ownership" bits last. */
+
+	/* Calculate the next Tx descriptor entry. */
+	entry = hmp->cur_tx % TX_RING_SIZE;
+
+	hmp->tx_skbuff[entry] = skb;
+
+#ifdef TX_CHECKSUM
+	{
+	    /* tack on checksum tag */
+	    u32 tagval = 0;
+	    struct ethhdr *eh = (struct ethhdr *)skb->data;
+	    if (eh->h_proto == __constant_htons(ETH_P_IP)) {
+		struct iphdr *ih = (struct iphdr *)((char *)eh + ETH_HLEN);
+		if (ih->protocol == IPPROTO_UDP) {
+		    struct udphdr *uh
+		      = (struct udphdr *)((char *)ih + ih->ihl*4);
+		    u32 offset = ((unsigned char *)uh + 6) - skb->data;
+		    u32 pseudo;
+		    pseudo_csum_udp(pseudo, ih, uh);
+		    pseudo = htons(pseudo);
+		    printk("udp cksum was %04x, sending pseudo %04x\n",
+		      uh->check, pseudo);
+		    uh->check = 0;  /* zero out uh->check before card calc */
+		    /*
+		     * start at 14 (skip ethhdr), store at offset (uh->check),
+		     * use pseudo value given.
+		     */
+		    tagval = (14 << 24) | (offset << 16) | pseudo;
+		} else if (ih->protocol == IPPROTO_TCP) {
+		    printk("tcp, no auto cksum\n");
+		}
+	    }
+	    *(u32 *)skb_push(skb, 8) = tagval;
+	}
+#endif
+
+	hmp->tx_ring[entry].addr = virt_to_desc(skb->data);
+    
+	/* Hmmmm, could probably put a DescIntr on these, but the way
+		the driver is currently coded makes Tx interrupts unnecessary
+		since the clearing of the Tx ring is handled by the start_xmit
+		routine.  This organization helps mitigate the interrupts a
+		bit and probably renders the max_tx_latency param useless.
+		
+		Update: Putting a DescIntr bit on all of the descriptors and
+		mitigating interrupt frequency with the tx_min_pkt parameter. -KDU
+	*/
+	if (entry >= TX_RING_SIZE-1)		 /* Wrap ring */
+		hmp->tx_ring[entry].status_n_length = 
+			cpu_to_le32(DescOwn|DescEndPacket|DescEndRing|DescIntr | skb->len);
+	else
+		hmp->tx_ring[entry].status_n_length = 
+			cpu_to_le32(DescOwn|DescEndPacket|DescIntr | skb->len);
+	hmp->cur_tx++;
+
+	/* Non-x86 Todo: explicitly flush cache lines here. */
+
+	/* Wake the potentially-idle transmit channel. */
+	/* If we don't need to read status, DON'T -KDU */
+	status=readw(dev->base_addr + TxStatus);
+	if( !(status & 0x0001) || (status & 0x0002))
+		writew(0x0001, dev->base_addr + TxCmd);
+
+	/* Immediately before returning, let's clear as many entries as we can. */
+	hamachi_tx(dev);
+
+	if ((hmp->cur_tx - hmp->dirty_tx) < (TX_RING_SIZE - 4)) 
+		clear_bit(0, (void*)&dev->tbusy);  /* Typical path */
+	else 
+		hmp->tx_full = 1;
+	dev->trans_start = jiffies;
+
+	if (hamachi_debug > 4) {
+		printk(KERN_DEBUG "%s: Hamachi transmit frame #%d queued in slot %d.\n",
+			   dev->name, hmp->cur_tx, entry);
+	}
+	/* We should kick the bottom half here, since we are not accepting
+	 * interrupts with every packet.  i.e. realize that Gigabit ethernet
+	 * can transmit faster than ordinary machines can load packets;
+	 * hence, any packet that got put off because we were in the transmit
+	 * routine should IMMEDIATELY get a chance to be re-queued. -KDU
+	 */
+	netif_wake_queue(dev); 
+	return 0;
+}
+
+/* The interrupt handler does all of the Rx thread work and cleans up
+   after the Tx thread. */
+static void hamachi_interrupt(int irq, void *dev_instance, struct pt_regs *rgs)
+{
+	struct device *dev = (struct device *)dev_instance;
+	struct hamachi_private *hmp;
+	long ioaddr, boguscnt = max_interrupt_work;
+
+#ifndef final_version			/* Can never occur. */
+	if (dev == NULL) {
+		printk (KERN_ERR "hamachi_interrupt(): irq %d for unknown device.\n", irq);
+		return;
+	}
+#endif
+
+	ioaddr = dev->base_addr;
+	hmp = (struct hamachi_private *)dev->priv;
+	if (test_and_set_bit(0, (void*)&hmp->in_interrupt)) {
+		printk(KERN_ERR "%s: Re-entering the interrupt handler.\n", dev->name);
+		clear_bit(0, (void *)&hmp->in_interrupt);	/* Avoid future hang on bug */
+		return;
+	}
+
+	do {
+		u32 intr_status = readl(ioaddr + InterruptClear);
+
+		if (hamachi_debug > 4)
+			printk(KERN_DEBUG "%s: Hamachi interrupt, status %4.4x.\n",
+				   dev->name, intr_status);
+
+		if (intr_status == 0)
+			break;
+
+		if (intr_status & IntrRxDone)
+			hamachi_rx(dev);
+
+		if (intr_status & IntrTxDone){
+			/* This code should RARELY need to execute. After all, this is
+			 * a gigabit link, it should consume packets as fast as we put
+			 * them in AND we clear the Tx ring in hamachi_start_xmit().
+			 */ 
+			if (hmp->tx_full){
+				for (; hmp->cur_tx - hmp->dirty_tx > 0; hmp->dirty_tx++){
+					int entry = hmp->dirty_tx % TX_RING_SIZE;
+					if (hmp->tx_ring[entry].status_n_length & cpu_to_le32(DescOwn)) 
+						break;
+					/* Free the original skb. */
+					if (hmp->tx_skbuff[entry]){
+						DEV_FREE_SKB(hmp->tx_skbuff[entry]);
+						hmp->tx_skbuff[entry] = 0;
+					}
+					hmp->tx_ring[entry].status_n_length = 0;
+					if (entry >= TX_RING_SIZE-1)  
+						hmp->tx_ring[TX_RING_SIZE-1].status_n_length |= 
+							cpu_to_le32(DescEndRing);
+					hmp->stats.tx_packets++;
+				}
+				if (hmp->cur_tx - hmp->dirty_tx < TX_RING_SIZE - 4){
+					/* The ring is no longer full, clear tbusy. */
+					hmp->tx_full = 0;
+					if (test_bit(0, (void*)&dev->tbusy))
+						clear_bit(0, (void*)&dev->tbusy);
+					else /* We should NEVER come down this path. */
+						printk(KERN_WARNING "tx_full, but not tbusy!\n");
+				}
+			}
+			netif_wake_queue(dev);
+		}
+
+
+		/* Abnormal error summary/uncommon events handlers. */
+		if (intr_status &
+			(IntrTxPCIFault | IntrTxPCIErr | IntrRxPCIFault | IntrRxPCIErr |
+			 LinkChange | NegotiationChange | StatsMax))
+			hamachi_error(dev, intr_status);
+
+		if (--boguscnt < 0) {
+			printk(KERN_WARNING "%s: Too much work at interrupt, status=0x%4.4x.\n",
+				   dev->name, intr_status);
+			break;
+		}
+	} while (1);
+
+	if (hamachi_debug > 3)
+		printk(KERN_DEBUG "%s: exiting interrupt, status=%#4.4x.\n",
+			   dev->name, readl(ioaddr + IntrStatus));
+
+#ifndef final_version
+	/* Code that should never be run!  Perhaps remove after testing.. */
+	{
+		static int stopit = 10;
+		if (dev->start == 0  &&  --stopit < 0) {
+			printk(KERN_ERR "%s: Emergency stop, looping startup interrupt.\n",
+				   dev->name);
+			free_irq(irq, dev);
+		}
+	}
+#endif
+
+	dev->interrupt = 0;
+	clear_bit(0, (void*)&hmp->in_interrupt);
+	return;
+}
+
+#ifdef TX_CHECKSUM
+/*
+ * Copied from eth_type_trans(), with reduced header, since we don't
+ * get it on RX, only on TX.
+ */
+static unsigned short hamachi_eth_type_trans(struct sk_buff *skb,
+  struct device *dev)
+{
+	struct ethhdr *eth;
+	unsigned char *rawp;
+	
+	skb->mac.raw=skb->data;
+	skb_pull(skb,dev->hard_header_len-8);  /* artificially enlarged on tx */
+	eth= skb->mac.ethernet;
+	
+	if(*eth->h_dest&1)
+	{
+		if(memcmp(eth->h_dest,dev->broadcast, ETH_ALEN)==0)
+			skb->pkt_type=PACKET_BROADCAST;
+		else
+			skb->pkt_type=PACKET_MULTICAST;
+	}
+	
+	/*
+	 *	This ALLMULTI check should be redundant by 1.4
+	 *	so don't forget to remove it.
+	 *
+	 *	Seems, you forgot to remove it. All silly devices
+	 *	seems to set IFF_PROMISC.
+	 */
+	 
+	else if(dev->flags&(IFF_PROMISC/*|IFF_ALLMULTI*/))
+	{
+		if(memcmp(eth->h_dest,dev->dev_addr, ETH_ALEN))
+			skb->pkt_type=PACKET_OTHERHOST;
+	}
+	
+	if (ntohs(eth->h_proto) >= 1536)
+		return eth->h_proto;
+		
+	rawp = skb->data;
+	
+	/*
+	 *	This is a magic hack to spot IPX packets. Older Novell breaks
+	 *	the protocol design and runs IPX over 802.3 without an 802.2 LLC
+	 *	layer. We look for FFFF which isn't a used 802.2 SSAP/DSAP. This
+	 *	won't work for fault tolerant netware but does for the rest.
+	 */
+	if (*(unsigned short *)rawp == 0xFFFF)
+		return htons(ETH_P_802_3);
+		
+	/*
+	 *	Real 802.2 LLC
+	 */
+	return htons(ETH_P_802_2);
+}
+#endif  /* TX_CHECKSUM */
+
+/* This routine is logically part of the interrupt handler, but seperated
+   for clarity and better register allocation. */
+static int hamachi_rx(struct device *dev)
+{
+	struct hamachi_private *hmp = (struct hamachi_private *)dev->priv;
+	int entry = hmp->cur_rx % RX_RING_SIZE;
+	int boguscnt = (hmp->dirty_rx + RX_RING_SIZE) - hmp->cur_rx;
+
+	if (hamachi_debug > 4) {
+		printk(KERN_DEBUG " In hamachi_rx(), entry %d status %4.4x.\n",
+			   entry, hmp->rx_ring[entry].status_n_length);
+	}
+
+	/* If EOP is set on the next entry, it's a new packet. Send it up. */
+	while ( ! (hmp->rx_head_desc->status_n_length & cpu_to_le32(DescOwn))) {
+		struct hamachi_desc *desc = hmp->rx_head_desc;
+		u32 desc_status = le32_to_cpu(desc->status_n_length);
+		u16 data_size = desc_status;			/* Implicit truncate */
+		u8 *buf_addr = le32desc_to_virt(desc->addr);
+		s32 frame_status = 
+			le32_to_cpu(get_unaligned((s32*)&(buf_addr[data_size - 12])));
+		
+		if (hamachi_debug > 4)
+			printk(KERN_DEBUG "  hamachi_rx() status was %8.8x.\n",
+				frame_status);
+		if (--boguscnt < 0)
+			break;
+		if ( ! (desc_status & DescEndPacket)) {
+			printk(KERN_WARNING "%s: Oversized Ethernet frame spanned "
+				   "multiple buffers, entry %#x length %d status %4.4x!\n",
+				   dev->name, hmp->cur_rx, data_size, desc_status);
+			printk(KERN_WARNING "%s: Oversized Ethernet frame %p vs %p.\n",
+				   dev->name, desc, &hmp->rx_ring[hmp->cur_rx % RX_RING_SIZE]);
+			printk(KERN_WARNING "%s: Oversized Ethernet frame -- next status %x/%x last status %x.\n",
+				   dev->name,
+				   hmp->rx_ring[(hmp->cur_rx+1) % RX_RING_SIZE].status_n_length & 0xffff0000,
+				   hmp->rx_ring[(hmp->cur_rx+1) % RX_RING_SIZE].status_n_length & 0x0000ffff,
+				   hmp->rx_ring[(hmp->cur_rx-1) % RX_RING_SIZE].status_n_length);
+			hmp->stats.rx_length_errors++;
+		} /* else  Omit for prototype errata??? */
+		if (frame_status & 0x00380000) {
+			/* There was an error. */
+			if (hamachi_debug > 2)
+				printk(KERN_DEBUG "  hamachi_rx() Rx error was %8.8x.\n",
+					   frame_status);
+			hmp->stats.rx_errors++;
+			if (frame_status & 0x00600000) hmp->stats.rx_length_errors++;
+			if (frame_status & 0x00080000) hmp->stats.rx_frame_errors++;
+			if (frame_status & 0x00100000) hmp->stats.rx_crc_errors++;
+			if (frame_status < 0) hmp->stats.rx_dropped++;
+		} else {
+			struct sk_buff *skb;
+			/* Omit CRC */
+			u16 pkt_len = (frame_status & 0x07ff) - 4;	
+#ifdef RX_CHECKSUM
+			u32 pfck = *(u32 *) &buf_addr[data_size - 8];
+#endif
+
+
+#ifndef final_version
+			if (hamachi_debug > 4)
+				printk(KERN_DEBUG "  hamachi_rx() normal Rx pkt length %d"
+					   " of %d, bogus_cnt %d.\n",
+					   pkt_len, data_size, boguscnt);
+			if (hamachi_debug > 5)
+				printk(KERN_DEBUG"%s:  rx status %8.8x %8.8x %8.8x %8.8x %8.8x.\n",
+					   dev->name,
+					   *(s32*)&(buf_addr[data_size - 20]),
+					   *(s32*)&(buf_addr[data_size - 16]),
+					   *(s32*)&(buf_addr[data_size - 12]),
+					   *(s32*)&(buf_addr[data_size - 8]),
+					   *(s32*)&(buf_addr[data_size - 4]));
+#endif
+			/* Check if the packet is long enough to accept without copying
+			   to a minimally-sized skbuff. */
+			if (pkt_len < rx_copybreak
+				&& (skb = dev_alloc_skb(pkt_len + 2)) != NULL) {
+#ifdef RX_CHECKSUM
+				printk(KERN_ERR "%s: rx_copybreak non-zero "
+				  "not good with RX_CHECKSUM\n", dev->name);
+#endif
+				skb->dev = dev;
+				skb_reserve(skb, 2);	/* 16 byte align the IP header */
+				/* Call copy + cksum if available. */
+#if 1 || USE_IP_COPYSUM
+				eth_copy_and_sum(skb, bus_to_virt(desc->addr), pkt_len, 0);
+				skb_put(skb, pkt_len);
+#else
+				memcpy(skb_put(skb, pkt_len), bus_to_virt(desc->addr),pkt_len);
+#endif
+			} else {
+				char *temp = skb_put(skb = hmp->rx_skbuff[entry], pkt_len);
+				hmp->rx_skbuff[entry] = NULL;
+#ifndef final_version				/* Remove after testing. */
+				if (bus_to_virt(desc->addr) != temp)
+					printk(KERN_ERR "%s: Internal fault: The skbuff addresses "
+						   "do not match in hamachi_rx: %p vs. %p / %p.\n",
+						   dev->name, bus_to_virt(desc->addr),
+						   skb->head, temp);
+#endif
+			}
+#ifdef TX_CHECKSUM
+			/* account for extra TX hard_header bytes */
+			skb->protocol = hamachi_eth_type_trans(skb, dev);
+#else
+			skb->protocol = eth_type_trans(skb, dev);
+#endif
+
+
+#ifdef RX_CHECKSUM
+			/* TCP or UDP on ipv4, DIX encoding */
+			if (pfck>>24 == 0x91 || pfck>>24 == 0x51) {
+				struct iphdr *ih = (struct iphdr *) skb->data;
+				/* Check that IP packet is at least 46 bytes, otherwise,
+				 * there may be pad bytes included in the hardware checksum.
+				 * This wouldn't happen if everyone padded with 0.
+				 */
+				if (ntohs(ih->tot_len) >= 46){
+					/* don't worry about frags */
+					if (!(ih->frag_off & __constant_htons(IP_MF|IP_OFFSET))) {
+						u32 inv = *(u32 *) &buf_addr[data_size - 16];
+						u32 *p = (u32 *) &buf_addr[data_size - 20];
+						register u32 crc, p_r, p_r1;
+
+						if (inv & 4) {
+							inv &= ~4;
+							--p;
+						}
+						p_r = *p;
+						p_r1 = *(p-1);
+						switch (inv) {
+							case 0:	
+										crc = (p_r & 0xffff) + (p_r >> 16);
+										break;
+							case 1:	
+										crc = (p_r >> 16) + (p_r & 0xffff)
+											+ (p_r1 >> 16 & 0xff00); 
+										break;
+							case 2:	
+										crc = p_r + (p_r1 >> 16); 
+										break;
+							case 3:	
+										crc = p_r + (p_r1 & 0xff00) + (p_r1 >> 16); 
+										break;
+							default:	/*NOTREACHED*/ crc = 0;
+						}
+						if (crc & 0xffff0000) {
+							crc &= 0xffff;
+							++crc;
+						}
+						/* tcp/udp will add in pseudo */
+						skb->csum = ntohs(pfck & 0xffff);
+						if (skb->csum > crc)
+							skb->csum -= crc;
+						else
+							skb->csum += (~crc & 0xffff);
+						/*
+						* could do the pseudo myself and return
+						* CHECKSUM_UNNECESSARY
+						*/
+						skb->ip_summed = CHECKSUM_HW;
+					}
+				}	
+			}
+#endif  /* RX_CHECKSUM */
+
+			netif_rx(skb);
+			dev->last_rx = jiffies;
+			hmp->stats.rx_packets++;
+		}
+		entry = (++hmp->cur_rx) % RX_RING_SIZE;
+		hmp->rx_head_desc = &hmp->rx_ring[entry];
+	}
+
+	/* Refill the Rx ring buffers. */
+	for (; hmp->cur_rx - hmp->dirty_rx > 0; hmp->dirty_rx++) {
+		struct sk_buff *skb;
+		entry = hmp->dirty_rx % RX_RING_SIZE;
+		if (hmp->rx_skbuff[entry] == NULL) {
+			skb = dev_alloc_skb(hmp->rx_buf_sz);
+			hmp->rx_skbuff[entry] = skb;
+			if (skb == NULL)
+				break;					/* Better luck next round. */
+			skb->dev = dev;			/* Mark as being used by this device. */
+			skb_reserve(skb, 2);		/* Align IP on 16 byte boundaries */
+			hmp->rx_ring[entry].addr = virt_to_desc(skb->tail);
+		}
+		hmp->rx_ring[entry].status_n_length = cpu_to_le32(hmp->rx_buf_sz);
+		if (entry >= RX_RING_SIZE-1)
+			hmp->rx_ring[entry].status_n_length |=
+				cpu_to_le32(DescOwn | DescEndPacket | DescEndRing | DescIntr);
+		else
+			hmp->rx_ring[entry].status_n_length |= 
+				cpu_to_le32(DescOwn | DescEndPacket | DescIntr);
+	}
+
+	/* Restart Rx engine if stopped. */
+	/* If we don't need to check status, don't. -KDU */
+	if (readw(dev->base_addr + RxStatus) & 0x0002)
+		writew(0x0001, dev->base_addr + RxCmd);
+
+	return 0;
+}
+
+/* This is more properly named "uncommon interrupt events", as it covers more
+   than just errors. */
+static void hamachi_error(struct device *dev, int intr_status)
+{
+	long ioaddr = dev->base_addr;
+	struct hamachi_private *hmp = (struct hamachi_private *)dev->priv;
+
+	if (intr_status & (LinkChange|NegotiationChange)) {
+		if (hamachi_debug > 1)
+			printk(KERN_INFO "%s: Link changed: AutoNegotiation Ctrl"
+				   " %4.4x, Status %4.4x %4.4x Intr status %4.4x.\n",
+				   dev->name, readw(ioaddr + 0x0E0), readw(ioaddr + 0x0E2),
+				   readw(ioaddr + ANLinkPartnerAbility),
+				   readl(ioaddr + IntrStatus));
+		if (readw(ioaddr + ANStatus) & 0x20)
+			writeb(0x01, ioaddr + LEDCtrl);
+		else
+			writeb(0x03, ioaddr + LEDCtrl);
+	}
+	if (intr_status & StatsMax) {
+		hamachi_get_stats(dev);
+		/* Read the overflow bits to clear. */
+		readl(ioaddr + 0x370);
+		readl(ioaddr + 0x3F0);
+	}
+	if ((intr_status & ~(LinkChange|StatsMax|NegotiationChange|IntrRxDone|IntrTxDone))
+		&& hamachi_debug)
+		printk(KERN_ERR "%s: Something Wicked happened! %4.4x.\n",
+			   dev->name, intr_status);
+	/* Hmmmmm, it's not clear how to recover from PCI faults. */
+	if (intr_status & (IntrTxPCIErr | IntrTxPCIFault))
+		hmp->stats.tx_fifo_errors++;
+	if (intr_status & (IntrRxPCIErr | IntrRxPCIFault))
+		hmp->stats.rx_fifo_errors++;
+}
+
+static int hamachi_close(struct device *dev)
+{
+	long ioaddr = dev->base_addr;
+	struct hamachi_private *hmp = (struct hamachi_private *)dev->priv;
+	int i;
+
+	dev->start = 0;
+	dev->tbusy = 1;
+
+	if (hamachi_debug > 1) {
+		printk(KERN_DEBUG "%s: Shutting down ethercard, status was Tx %4.4x Rx %4.4x Int %2.2x.\n",
+			   dev->name, readw(ioaddr + TxStatus),
+			   readw(ioaddr + RxStatus), readl(ioaddr + IntrStatus));
+		printk(KERN_DEBUG "%s: Queue pointers were Tx %d / %d,  Rx %d / %d.\n",
+			   dev->name, hmp->cur_tx, hmp->dirty_tx, hmp->cur_rx, hmp->dirty_rx);
+	}
+
+	/* Disable interrupts by clearing the interrupt mask. */
+	writel(0x0000, ioaddr + InterruptEnable);
+
+	/* Stop the chip's Tx and Rx processes. */
+	writel(2, ioaddr + RxCmd);
+	writew(2, ioaddr + TxCmd);
+
+	del_timer(&hmp->timer);
+
+#ifdef __i386__
+	if (hamachi_debug > 2) {
+		printk("\n"KERN_DEBUG"  Tx ring at %8.8x:\n",
+			   (int)virt_to_bus(hmp->tx_ring));
+		for (i = 0; i < TX_RING_SIZE; i++)
+			printk(" %c #%d desc. %8.8x %8.8x.\n",
+				   readl(ioaddr + TxCurPtr) == (long)&hmp->tx_ring[i] ? '>' : ' ',
+				   i, hmp->tx_ring[i].status_n_length, hmp->tx_ring[i].addr);
+		printk("\n"KERN_DEBUG "  Rx ring %8.8x:\n",
+			   (int)virt_to_bus(hmp->rx_ring));
+		for (i = 0; i < RX_RING_SIZE; i++) {
+			printk(KERN_DEBUG " %c #%d desc. %4.4x %8.8x\n",
+				   readl(ioaddr + RxCurPtr) == (long)&hmp->rx_ring[i] ? '>' : ' ',
+				   i, hmp->rx_ring[i].status_n_length, hmp->rx_ring[i].addr);
+			if (hamachi_debug > 6) {
+				if (*(u8*)bus_to_virt(hmp->rx_ring[i].addr) != 0x69) {
+					int j;
+					for (j = 0; j < 0x50; j++)
+						printk(" %4.4x",((u16*)le32desc_to_virt(hmp->rx_ring[i].addr))[j]);
+					printk("\n");
+				}
+			}
+		}
+	}
+#endif /* __i386__ debugging only */
+
+	free_irq(dev->irq, dev);
+
+	/* Free all the skbuffs in the Rx queue. */
+	for (i = 0; i < RX_RING_SIZE; i++) {
+		hmp->rx_ring[i].status_n_length = 0;
+		hmp->rx_ring[i].addr = 0xBADF00D0; /* An invalid address. */
+		if (hmp->rx_skbuff[i]) {
+#if LINUX_VERSION_CODE < 0x20100
+			hmp->rx_skbuff[i]->free = 1;
+#endif
+			DEV_FREE_SKB(hmp->rx_skbuff[i]);
+		}
+		hmp->rx_skbuff[i] = 0;
+	}
+	for (i = 0; i < TX_RING_SIZE; i++) {
+		if (hmp->tx_skbuff[i])
+			DEV_FREE_SKB(hmp->tx_skbuff[i]);
+		hmp->tx_skbuff[i] = 0;
+	}
+
+	writeb(0x00, ioaddr + LEDCtrl);
+
+	MOD_DEC_USE_COUNT;
+
+	return 0;
+}
+
+static struct enet_statistics *hamachi_get_stats(struct device *dev)
+{
+	long ioaddr = dev->base_addr;
+	struct hamachi_private *hmp = (struct hamachi_private *)dev->priv;
+
+	/* We should lock this segment of code for SMP eventually, although
+	   the vulnerability window is very small and statistics are
+	   non-critical. */
+        /* Ok, what goes here?  This appears to be stuck at 21 packets
+           according to ifconfig.  It does get incremented in hamachi_tx(),
+           so I think I'll comment it out here and see if better things
+           happen.
+        */ 
+	/* hmp->stats.tx_packets	= readl(ioaddr + 0x000); */
+
+#if LINUX_VERSION_CODE >= 0x20119
+	hmp->stats.rx_bytes = readl(ioaddr + 0x330); /* Total Uni+Brd+Multi */
+	hmp->stats.tx_bytes = readl(ioaddr + 0x3B0); /* Total Uni+Brd+Multi */
+#endif
+	hmp->stats.multicast		= readl(ioaddr + 0x320); /* Multicast Rx */
+
+	hmp->stats.rx_length_errors	= readl(ioaddr + 0x368); /* Over+Undersized */
+	hmp->stats.rx_over_errors	= readl(ioaddr + 0x35C); /* Jabber */
+	hmp->stats.rx_crc_errors	= readl(ioaddr + 0x360); /* Jabber */
+	hmp->stats.rx_frame_errors	= readl(ioaddr + 0x364); /* Symbol Errs */
+	hmp->stats.rx_missed_errors	= readl(ioaddr + 0x36C); /* Dropped */
+
+	return &hmp->stats;
+}
+
+static void set_rx_mode(struct device *dev)
+{
+	long ioaddr = dev->base_addr;
+
+	if (dev->flags & IFF_PROMISC) {			/* Set promiscuous. */
+		/* Unconditionally log net taps. */
+		printk(KERN_NOTICE "%s: Promiscuous mode enabled.\n", dev->name);
+		writew(0x000F, ioaddr + AddrMode);
+	} else if ((dev->mc_count > 63)  ||  (dev->flags & IFF_ALLMULTI)) {
+		/* Too many to match, or accept all multicasts. */
+		writew(0x000B, ioaddr + AddrMode);
+	} else if (dev->mc_count > 0) { /* Must use the CAM filter. */
+		struct dev_mc_list *mclist;
+		int i;
+		for (i = 0, mclist = dev->mc_list; mclist && i < dev->mc_count;
+			 i++, mclist = mclist->next) {
+			writel(*(u32*)(mclist->dmi_addr), ioaddr + 0x100 + i*8);
+			writel(0x20000 | (*(u16*)&mclist->dmi_addr[4]),
+				   ioaddr + 0x104 + i*8);
+		}
+		/* Clear remaining entries. */
+		for (; i < 64; i++)
+			writel(0, ioaddr + 0x104 + i*8);
+		writew(0x0003, ioaddr + AddrMode);
+	} else {					/* Normal, unicast/broadcast-only mode. */
+		writew(0x0001, ioaddr + AddrMode);
+	}
+}
+
+#ifdef HAVE_PRIVATE_IOCTL
+static int mii_ioctl(struct device *dev, struct ifreq *rq, int cmd)
+{
+	long ioaddr = dev->base_addr;
+	u16 *data = (u16 *)&rq->ifr_data;
+
+	switch(cmd) {
+	case SIOCDEVPRIVATE:		/* Get the address of the PHY in use. */
+		data[0] = ((struct hamachi_private *)dev->priv)->phys[0] & 0x1f;
+		/* Fall Through */
+	case SIOCDEVPRIVATE+1:		/* Read the specified MII register. */
+		data[3] = mdio_read(ioaddr, data[0] & 0x1f, data[1] & 0x1f);
+		return 0;
+	case SIOCDEVPRIVATE+2:		/* Write the specified MII register */
+		/* TODO: Check the sequencing of this.  Might need to stop and
+		 * restart Rx and Tx engines. -KDU
+		 */
+		if (!capable(CAP_NET_ADMIN))
+			return -EPERM;
+		mdio_write(ioaddr, data[0] & 0x1f, data[1] & 0x1f, data[2]);
+		return 0;
+	case SIOCDEVPRIVATE+3: { /* set rx,tx intr params */
+		u32 *d = (u32 *)&rq->ifr_data;
+		/* Should add this check here or an ordinary user can do nasty
+		 * things. -KDU
+		 *
+		 * TODO: Shut down the Rx and Tx engines while doing this.
+		 */
+		if (!capable(CAP_NET_ADMIN))
+			return -EPERM;
+		writel(d[0], dev->base_addr + TxIntrCtrl);
+		writel(d[1], dev->base_addr + RxIntrCtrl);
+		printk(KERN_NOTICE "%s: tx %08x, rx %08x intr\n", dev->name,
+		  (u32) readl(dev->base_addr + TxIntrCtrl),
+		  (u32) readl(dev->base_addr + RxIntrCtrl));
+		return 0;
+	    }
+	default:
+		return -EOPNOTSUPP;
+	}
+}
+#endif  /* HAVE_PRIVATE_IOCTL */
+
+
+#ifdef MODULE
+
+int init_module(void)
+{
+	return hamachi_probe(0);
+}
+
+void cleanup_module(void)
+{
+	struct device *next_dev;
+
+	/* No need to check MOD_IN_USE, as sys_delete_module() checks. */
+	while (root_hamachi_dev) {
+		struct hamachi_private *hmp = (void *)(root_hamachi_dev->priv);
+		unregister_netdev(root_hamachi_dev);
+		iounmap((char *)root_hamachi_dev->base_addr);
+		next_dev = hmp->next_module;
+		if (hmp->priv_addr)
+			kfree(hmp->priv_addr);
+		kfree(root_hamachi_dev);
+		root_hamachi_dev = next_dev;
+	}
+}
+
+#endif  /* MODULE */
+
+/*
+ * Local variables:
+ *  compile-command: "gcc -DMODULE -D__KERNEL__ -I/usr/src/linux/net/inet -Wall -Wstrict-prototypes -O6 -c hamachi.c `[ -f /usr/include/linux/modversions.h ] && echo -DMODVERSIONS`"
+ *  SMP-compile-command: "gcc -D__SMP__ -DMODULE -D__KERNEL__ -I/usr/src/linux/net/inet -Wall -Wstrict-prototypes -O6 -c hamachi.c `[ -f /usr/include/linux/modversions.h ] && echo -DMODVERSIONS`"
+ *  c-indent-level: 4
+ *  c-basic-offset: 4
+ *  tab-width: 4
+ * End:
+ */

FUNET's LINUX-ADM group, linux-adm@nic.funet.fi
TCL-scripts by Sam Shen (who was at: slshen@lbl.gov)