Merge branch 'master' of ssh://master.kernel.org/pub/scm/linux/kernel/git/mchehab...
[linux-2.6] / drivers / net / hamachi.c
1 /* hamachi.c: A Packet Engines GNIC-II Gigabit Ethernet driver for Linux. */
2 /*
3         Written 1998-2000 by Donald Becker.
4         Updates 2000 by Keith Underwood.
5
6         This software may be used and distributed according to the terms of
7         the GNU General Public License (GPL), incorporated herein by reference.
8         Drivers based on or derived from this code fall under the GPL and must
9         retain the authorship, copyright and license notice.  This file is not
10         a complete program and may only be used when the entire operating
11         system is licensed under the GPL.
12
13         The author may be reached as becker@scyld.com, or C/O
14         Scyld Computing Corporation
15         410 Severn Ave., Suite 210
16         Annapolis MD 21403
17
18         This driver is for the Packet Engines GNIC-II PCI Gigabit Ethernet
19         adapter.
20
21         Support and updates available at
22         http://www.scyld.com/network/hamachi.html
23         [link no longer provides useful info -jgarzik]
24         or
25         http://www.parl.clemson.edu/~keithu/hamachi.html
26
27 */
28
29 #define DRV_NAME        "hamachi"
30 #define DRV_VERSION     "2.1"
31 #define DRV_RELDATE     "Sept 11, 2006"
32
33
34 /* A few user-configurable values. */
35
36 static int debug = 1;           /* 1 normal messages, 0 quiet .. 7 verbose.  */
37 #define final_version
38 #define hamachi_debug debug
39 /* Maximum events (Rx packets, etc.) to handle at each interrupt. */
40 static int max_interrupt_work = 40;
41 static int mtu;
42 /* Default values selected by testing on a dual processor PIII-450 */
43 /* These six interrupt control parameters may be set directly when loading the
44  * module, or through the rx_params and tx_params variables
45  */
46 static int max_rx_latency = 0x11;
47 static int max_rx_gap = 0x05;
48 static int min_rx_pkt = 0x18;
49 static int max_tx_latency = 0x00;
50 static int max_tx_gap = 0x00;
51 static int min_tx_pkt = 0x30;
52
53 /* Set the copy breakpoint for the copy-only-tiny-frames scheme.
54    -Setting to > 1518 causes all frames to be copied
55         -Setting to 0 disables copies
56 */
57 static int rx_copybreak;
58
59 /* An override for the hardware detection of bus width.
60         Set to 1 to force 32 bit PCI bus detection.  Set to 4 to force 64 bit.
61         Add 2 to disable parity detection.
62 */
63 static int force32;
64
65
66 /* Used to pass the media type, etc.
67    These exist for driver interoperability.
68    No media types are currently defined.
69                 - The lower 4 bits are reserved for the media type.
70                 - The next three bits may be set to one of the following:
71                         0x00000000 : Autodetect PCI bus
72                         0x00000010 : Force 32 bit PCI bus
73                         0x00000020 : Disable parity detection
74                         0x00000040 : Force 64 bit PCI bus
75                         Default is autodetect
76                 - The next bit can be used to force half-duplex.  This is a bad
77                   idea since no known implementations implement half-duplex, and,
78                   in general, half-duplex for gigabit ethernet is a bad idea.
79                         0x00000080 : Force half-duplex
80                         Default is full-duplex.
81                 - In the original driver, the ninth bit could be used to force
82                   full-duplex.  Maintain that for compatibility
83                    0x00000200 : Force full-duplex
84 */
85 #define MAX_UNITS 8                             /* More are supported, limit only on options */
86 static int options[MAX_UNITS] = {-1, -1, -1, -1, -1, -1, -1, -1};
87 static int full_duplex[MAX_UNITS] = {-1, -1, -1, -1, -1, -1, -1, -1};
88 /* The Hamachi chipset supports 3 parameters each for Rx and Tx
89  * interruput management.  Parameters will be loaded as specified into
90  * the TxIntControl and RxIntControl registers.
91  *
92  * The registers are arranged as follows:
93  *     23 - 16   15 -  8   7    -    0
94  *    _________________________________
95  *   | min_pkt | max_gap | max_latency |
96  *    ---------------------------------
97  *   min_pkt      : The minimum number of packets processed between
98  *                  interrupts.
99  *   max_gap      : The maximum inter-packet gap in units of 8.192 us
100  *   max_latency  : The absolute time between interrupts in units of 8.192 us
101  *
102  */
103 static int rx_params[MAX_UNITS] = {-1, -1, -1, -1, -1, -1, -1, -1};
104 static int tx_params[MAX_UNITS] = {-1, -1, -1, -1, -1, -1, -1, -1};
105
106 /* Operational parameters that are set at compile time. */
107
108 /* Keep the ring sizes a power of two for compile efficiency.
109         The compiler will convert <unsigned>'%'<2^N> into a bit mask.
110    Making the Tx ring too large decreases the effectiveness of channel
111    bonding and packet priority.
112    There are no ill effects from too-large receive rings, except for
113         excessive memory usage */
114 /* Empirically it appears that the Tx ring needs to be a little bigger
115    for these Gbit adapters or you get into an overrun condition really
116    easily.  Also, things appear to work a bit better in back-to-back
117    configurations if the Rx ring is 8 times the size of the Tx ring
118 */
119 #define TX_RING_SIZE    64
120 #define RX_RING_SIZE    512
121 #define TX_TOTAL_SIZE   TX_RING_SIZE*sizeof(struct hamachi_desc)
122 #define RX_TOTAL_SIZE   RX_RING_SIZE*sizeof(struct hamachi_desc)
123
124 /*
125  * Enable netdev_ioctl.  Added interrupt coalescing parameter adjustment.
126  * 2/19/99 Pete Wyckoff <wyckoff@ca.sandia.gov>
127  */
128
129 /* play with 64-bit addrlen; seems to be a teensy bit slower  --pw */
130 /* #define ADDRLEN 64 */
131
132 /*
133  * RX_CHECKSUM turns on card-generated receive checksum generation for
134  *   TCP and UDP packets.  Otherwise the upper layers do the calculation.
135  * TX_CHECKSUM won't do anything too useful, even if it works.  There's no
136  *   easy mechanism by which to tell the TCP/UDP stack that it need not
137  *   generate checksums for this device.  But if somebody can find a way
138  *   to get that to work, most of the card work is in here already.
139  * 3/10/1999 Pete Wyckoff <wyckoff@ca.sandia.gov>
140  */
141 #undef  TX_CHECKSUM
142 #define RX_CHECKSUM
143
144 /* Operational parameters that usually are not changed. */
145 /* Time in jiffies before concluding the transmitter is hung. */
146 #define TX_TIMEOUT  (5*HZ)
147
148 #include <linux/module.h>
149 #include <linux/kernel.h>
150 #include <linux/string.h>
151 #include <linux/timer.h>
152 #include <linux/time.h>
153 #include <linux/errno.h>
154 #include <linux/ioport.h>
155 #include <linux/slab.h>
156 #include <linux/interrupt.h>
157 #include <linux/pci.h>
158 #include <linux/init.h>
159 #include <linux/ethtool.h>
160 #include <linux/mii.h>
161 #include <linux/netdevice.h>
162 #include <linux/etherdevice.h>
163 #include <linux/skbuff.h>
164 #include <linux/ip.h>
165 #include <linux/delay.h>
166 #include <linux/bitops.h>
167
168 #include <asm/uaccess.h>
169 #include <asm/processor.h>      /* Processor type for cache alignment. */
170 #include <asm/io.h>
171 #include <asm/unaligned.h>
172 #include <asm/cache.h>
173
174 static char version[] __devinitdata =
175 KERN_INFO DRV_NAME ".c:v" DRV_VERSION " " DRV_RELDATE "  Written by Donald Becker\n"
176 KERN_INFO "   Some modifications by Eric kasten <kasten@nscl.msu.edu>\n"
177 KERN_INFO "   Further modifications by Keith Underwood <keithu@parl.clemson.edu>\n";
178
179
180 /* IP_MF appears to be only defined in <netinet/ip.h>, however,
181    we need it for hardware checksumming support.  FYI... some of
182    the definitions in <netinet/ip.h> conflict/duplicate those in
183    other linux headers causing many compiler warnings.
184 */
185 #ifndef IP_MF
186   #define IP_MF 0x2000   /* IP more frags from <netinet/ip.h> */
187 #endif
188
189 /* Define IP_OFFSET to be IPOPT_OFFSET */
190 #ifndef IP_OFFSET
191   #ifdef IPOPT_OFFSET
192     #define IP_OFFSET IPOPT_OFFSET
193   #else
194     #define IP_OFFSET 2
195   #endif
196 #endif
197
198 #define RUN_AT(x) (jiffies + (x))
199
200 #ifndef ADDRLEN
201 #define ADDRLEN 32
202 #endif
203
204 /* Condensed bus+endian portability operations. */
205 #if ADDRLEN == 64
206 #define cpu_to_leXX(addr)       cpu_to_le64(addr)
207 #else
208 #define cpu_to_leXX(addr)       cpu_to_le32(addr)
209 #endif
210
211
212 /*
213                                 Theory of Operation
214
215 I. Board Compatibility
216
217 This device driver is designed for the Packet Engines "Hamachi"
218 Gigabit Ethernet chip.  The only PCA currently supported is the GNIC-II 64-bit
219 66Mhz PCI card.
220
221 II. Board-specific settings
222
223 No jumpers exist on the board.  The chip supports software correction of
224 various motherboard wiring errors, however this driver does not support
225 that feature.
226
227 III. Driver operation
228
229 IIIa. Ring buffers
230
231 The Hamachi uses a typical descriptor based bus-master architecture.
232 The descriptor list is similar to that used by the Digital Tulip.
233 This driver uses two statically allocated fixed-size descriptor lists
234 formed into rings by a branch from the final descriptor to the beginning of
235 the list.  The ring sizes are set at compile time by RX/TX_RING_SIZE.
236
237 This driver uses a zero-copy receive and transmit scheme similar my other
238 network drivers.
239 The driver allocates full frame size skbuffs for the Rx ring buffers at
240 open() time and passes the skb->data field to the Hamachi as receive data
241 buffers.  When an incoming frame is less than RX_COPYBREAK bytes long,
242 a fresh skbuff is allocated and the frame is copied to the new skbuff.
243 When the incoming frame is larger, the skbuff is passed directly up the
244 protocol stack and replaced by a newly allocated skbuff.
245
246 The RX_COPYBREAK value is chosen to trade-off the memory wasted by
247 using a full-sized skbuff for small frames vs. the copying costs of larger
248 frames.  Gigabit cards are typically used on generously configured machines
249 and the underfilled buffers have negligible impact compared to the benefit of
250 a single allocation size, so the default value of zero results in never
251 copying packets.
252
253 IIIb/c. Transmit/Receive Structure
254
255 The Rx and Tx descriptor structure are straight-forward, with no historical
256 baggage that must be explained.  Unlike the awkward DBDMA structure, there
257 are no unused fields or option bits that had only one allowable setting.
258
259 Two details should be noted about the descriptors: The chip supports both 32
260 bit and 64 bit address structures, and the length field is overwritten on
261 the receive descriptors.  The descriptor length is set in the control word
262 for each channel. The development driver uses 32 bit addresses only, however
263 64 bit addresses may be enabled for 64 bit architectures e.g. the Alpha.
264
265 IIId. Synchronization
266
267 This driver is very similar to my other network drivers.
268 The driver runs as two independent, single-threaded flows of control.  One
269 is the send-packet routine, which enforces single-threaded use by the
270 dev->tbusy flag.  The other thread is the interrupt handler, which is single
271 threaded by the hardware and other software.
272
273 The send packet thread has partial control over the Tx ring and 'dev->tbusy'
274 flag.  It sets the tbusy flag whenever it's queuing a Tx packet. If the next
275 queue slot is empty, it clears the tbusy flag when finished otherwise it sets
276 the 'hmp->tx_full' flag.
277
278 The interrupt handler has exclusive control over the Rx ring and records stats
279 from the Tx ring.  After reaping the stats, it marks the Tx queue entry as
280 empty by incrementing the dirty_tx mark. Iff the 'hmp->tx_full' flag is set, it
281 clears both the tx_full and tbusy flags.
282
283 IV. Notes
284
285 Thanks to Kim Stearns of Packet Engines for providing a pair of GNIC-II boards.
286
287 IVb. References
288
289 Hamachi Engineering Design Specification, 5/15/97
290 (Note: This version was marked "Confidential".)
291
292 IVc. Errata
293
294 None noted.
295
296 V.  Recent Changes
297
298 01/15/1999 EPK  Enlargement of the TX and RX ring sizes.  This appears
299     to help avoid some stall conditions -- this needs further research.
300
301 01/15/1999 EPK  Creation of the hamachi_tx function.  This function cleans
302     the Tx ring and is called from hamachi_start_xmit (this used to be
303     called from hamachi_interrupt but it tends to delay execution of the
304     interrupt handler and thus reduce bandwidth by reducing the latency
305     between hamachi_rx()'s).  Notably, some modification has been made so
306     that the cleaning loop checks only to make sure that the DescOwn bit
307     isn't set in the status flag since the card is not required
308     to set the entire flag to zero after processing.
309
310 01/15/1999 EPK In the hamachi_start_tx function, the Tx ring full flag is
311     checked before attempting to add a buffer to the ring.  If the ring is full
312     an attempt is made to free any dirty buffers and thus find space for
313     the new buffer or the function returns non-zero which should case the
314     scheduler to reschedule the buffer later.
315
316 01/15/1999 EPK Some adjustments were made to the chip initialization.
317     End-to-end flow control should now be fully active and the interrupt
318     algorithm vars have been changed.  These could probably use further tuning.
319
320 01/15/1999 EPK Added the max_{rx,tx}_latency options.  These are used to
321     set the rx and tx latencies for the Hamachi interrupts. If you're having
322     problems with network stalls, try setting these to higher values.
323     Valid values are 0x00 through 0xff.
324
325 01/15/1999 EPK In general, the overall bandwidth has increased and
326     latencies are better (sometimes by a factor of 2).  Stalls are rare at
327     this point, however there still appears to be a bug somewhere between the
328     hardware and driver.  TCP checksum errors under load also appear to be
329     eliminated at this point.
330
331 01/18/1999 EPK Ensured that the DescEndRing bit was being set on both the
332     Rx and Tx rings.  This appears to have been affecting whether a particular
333     peer-to-peer connection would hang under high load.  I believe the Rx
334     rings was typically getting set correctly, but the Tx ring wasn't getting
335     the DescEndRing bit set during initialization. ??? Does this mean the
336     hamachi card is using the DescEndRing in processing even if a particular
337     slot isn't in use -- hypothetically, the card might be searching the
338     entire Tx ring for slots with the DescOwn bit set and then processing
339     them.  If the DescEndRing bit isn't set, then it might just wander off
340     through memory until it hits a chunk of data with that bit set
341     and then looping back.
342
343 02/09/1999 EPK Added Michel Mueller's TxDMA Interrupt and Tx-timeout
344     problem (TxCmd and RxCmd need only to be set when idle or stopped.
345
346 02/09/1999 EPK Added code to check/reset dev->tbusy in hamachi_interrupt.
347     (Michel Mueller pointed out the ``permanently busy'' potential
348     problem here).
349
350 02/22/1999 EPK Added Pete Wyckoff's ioctl to control the Tx/Rx latencies.
351
352 02/23/1999 EPK Verified that the interrupt status field bits for Tx were
353     incorrectly defined and corrected (as per Michel Mueller).
354
355 02/23/1999 EPK Corrected the Tx full check to check that at least 4 slots
356     were available before reseting the tbusy and tx_full flags
357     (as per Michel Mueller).
358
359 03/11/1999 EPK Added Pete Wyckoff's hardware checksumming support.
360
361 12/31/1999 KDU Cleaned up assorted things and added Don's code to force
362 32 bit.
363
364 02/20/2000 KDU Some of the control was just plain odd.  Cleaned up the
365 hamachi_start_xmit() and hamachi_interrupt() code.  There is still some
366 re-structuring I would like to do.
367
368 03/01/2000 KDU Experimenting with a WIDE range of interrupt mitigation
369 parameters on a dual P3-450 setup yielded the new default interrupt
370 mitigation parameters.  Tx should interrupt VERY infrequently due to
371 Eric's scheme.  Rx should be more often...
372
373 03/13/2000 KDU Added a patch to make the Rx Checksum code interact
374 nicely with non-linux machines.
375
376 03/13/2000 KDU Experimented with some of the configuration values:
377
378         -It seems that enabling PCI performance commands for descriptors
379         (changing RxDMACtrl and TxDMACtrl lower nibble from 5 to D) has minimal
380         performance impact for any of my tests. (ttcp, netpipe, netperf)  I will
381         leave them that way until I hear further feedback.
382
383         -Increasing the PCI_LATENCY_TIMER to 130
384         (2 + (burst size of 128 * (0 wait states + 1))) seems to slightly
385         degrade performance.  Leaving default at 64 pending further information.
386
387 03/14/2000 KDU Further tuning:
388
389         -adjusted boguscnt in hamachi_rx() to depend on interrupt
390         mitigation parameters chosen.
391
392         -Selected a set of interrupt parameters based on some extensive testing.
393         These may change with more testing.
394
395 TO DO:
396
397 -Consider borrowing from the acenic driver code to check PCI_COMMAND for
398 PCI_COMMAND_INVALIDATE.  Set maximum burst size to cache line size in
399 that case.
400
401 -fix the reset procedure.  It doesn't quite work.
402 */
403
404 /* A few values that may be tweaked. */
405 /* Size of each temporary Rx buffer, calculated as:
406  * 1518 bytes (ethernet packet) + 2 bytes (to get 8 byte alignment for
407  * the card) + 8 bytes of status info + 8 bytes for the Rx Checksum +
408  * 2 more because we use skb_reserve.
409  */
410 #define PKT_BUF_SZ              1538
411
412 /* For now, this is going to be set to the maximum size of an ethernet
413  * packet.  Eventually, we may want to make it a variable that is
414  * related to the MTU
415  */
416 #define MAX_FRAME_SIZE  1518
417
418 /* The rest of these values should never change. */
419
420 static void hamachi_timer(unsigned long data);
421
422 enum capability_flags {CanHaveMII=1, };
423 static const struct chip_info {
424         u16     vendor_id, device_id, device_id_mask, pad;
425         const char *name;
426         void (*media_timer)(unsigned long data);
427         int flags;
428 } chip_tbl[] = {
429         {0x1318, 0x0911, 0xffff, 0, "Hamachi GNIC-II", hamachi_timer, 0},
430         {0,},
431 };
432
433 /* Offsets to the Hamachi registers.  Various sizes. */
434 enum hamachi_offsets {
435         TxDMACtrl=0x00, TxCmd=0x04, TxStatus=0x06, TxPtr=0x08, TxCurPtr=0x10,
436         RxDMACtrl=0x20, RxCmd=0x24, RxStatus=0x26, RxPtr=0x28, RxCurPtr=0x30,
437         PCIClkMeas=0x060, MiscStatus=0x066, ChipRev=0x68, ChipReset=0x06B,
438         LEDCtrl=0x06C, VirtualJumpers=0x06D, GPIO=0x6E,
439         TxChecksum=0x074, RxChecksum=0x076,
440         TxIntrCtrl=0x078, RxIntrCtrl=0x07C,
441         InterruptEnable=0x080, InterruptClear=0x084, IntrStatus=0x088,
442         EventStatus=0x08C,
443         MACCnfg=0x0A0, FrameGap0=0x0A2, FrameGap1=0x0A4,
444         /* See enum MII_offsets below. */
445         MACCnfg2=0x0B0, RxDepth=0x0B8, FlowCtrl=0x0BC, MaxFrameSize=0x0CE,
446         AddrMode=0x0D0, StationAddr=0x0D2,
447         /* Gigabit AutoNegotiation. */
448         ANCtrl=0x0E0, ANStatus=0x0E2, ANXchngCtrl=0x0E4, ANAdvertise=0x0E8,
449         ANLinkPartnerAbility=0x0EA,
450         EECmdStatus=0x0F0, EEData=0x0F1, EEAddr=0x0F2,
451         FIFOcfg=0x0F8,
452 };
453
454 /* Offsets to the MII-mode registers. */
455 enum MII_offsets {
456         MII_Cmd=0xA6, MII_Addr=0xA8, MII_Wr_Data=0xAA, MII_Rd_Data=0xAC,
457         MII_Status=0xAE,
458 };
459
460 /* Bits in the interrupt status/mask registers. */
461 enum intr_status_bits {
462         IntrRxDone=0x01, IntrRxPCIFault=0x02, IntrRxPCIErr=0x04,
463         IntrTxDone=0x100, IntrTxPCIFault=0x200, IntrTxPCIErr=0x400,
464         LinkChange=0x10000, NegotiationChange=0x20000, StatsMax=0x40000, };
465
466 /* The Hamachi Rx and Tx buffer descriptors. */
467 struct hamachi_desc {
468         u32 status_n_length;
469 #if ADDRLEN == 64
470         u32 pad;
471         u64 addr;
472 #else
473         u32 addr;
474 #endif
475 };
476
477 /* Bits in hamachi_desc.status_n_length */
478 enum desc_status_bits {
479         DescOwn=0x80000000, DescEndPacket=0x40000000, DescEndRing=0x20000000,
480         DescIntr=0x10000000,
481 };
482
483 #define PRIV_ALIGN      15                      /* Required alignment mask */
484 #define MII_CNT         4
485 struct hamachi_private {
486         /* Descriptor rings first for alignment.  Tx requires a second descriptor
487            for status. */
488         struct hamachi_desc *rx_ring;
489         struct hamachi_desc *tx_ring;
490         struct sk_buff* rx_skbuff[RX_RING_SIZE];
491         struct sk_buff* tx_skbuff[TX_RING_SIZE];
492         dma_addr_t tx_ring_dma;
493         dma_addr_t rx_ring_dma;
494         struct net_device_stats stats;
495         struct timer_list timer;                /* Media selection timer. */
496         /* Frequently used and paired value: keep adjacent for cache effect. */
497         spinlock_t lock;
498         int chip_id;
499         unsigned int cur_rx, dirty_rx;          /* Producer/consumer ring indices */
500         unsigned int cur_tx, dirty_tx;
501         unsigned int rx_buf_sz;                 /* Based on MTU+slack. */
502         unsigned int tx_full:1;                 /* The Tx queue is full. */
503         unsigned int duplex_lock:1;
504         unsigned int default_port:4;            /* Last dev->if_port value. */
505         /* MII transceiver section. */
506         int mii_cnt;                                                            /* MII device addresses. */
507         struct mii_if_info mii_if;              /* MII lib hooks/info */
508         unsigned char phys[MII_CNT];            /* MII device addresses, only first one used. */
509         u32 rx_int_var, tx_int_var;     /* interrupt control variables */
510         u32 option;                                                     /* Hold on to a copy of the options */
511         struct pci_dev *pci_dev;
512         void __iomem *base;
513 };
514
515 MODULE_AUTHOR("Donald Becker <becker@scyld.com>, Eric Kasten <kasten@nscl.msu.edu>, Keith Underwood <keithu@parl.clemson.edu>");
516 MODULE_DESCRIPTION("Packet Engines 'Hamachi' GNIC-II Gigabit Ethernet driver");
517 MODULE_LICENSE("GPL");
518
519 module_param(max_interrupt_work, int, 0);
520 module_param(mtu, int, 0);
521 module_param(debug, int, 0);
522 module_param(min_rx_pkt, int, 0);
523 module_param(max_rx_gap, int, 0);
524 module_param(max_rx_latency, int, 0);
525 module_param(min_tx_pkt, int, 0);
526 module_param(max_tx_gap, int, 0);
527 module_param(max_tx_latency, int, 0);
528 module_param(rx_copybreak, int, 0);
529 module_param_array(rx_params, int, NULL, 0);
530 module_param_array(tx_params, int, NULL, 0);
531 module_param_array(options, int, NULL, 0);
532 module_param_array(full_duplex, int, NULL, 0);
533 module_param(force32, int, 0);
534 MODULE_PARM_DESC(max_interrupt_work, "GNIC-II maximum events handled per interrupt");
535 MODULE_PARM_DESC(mtu, "GNIC-II MTU (all boards)");
536 MODULE_PARM_DESC(debug, "GNIC-II debug level (0-7)");
537 MODULE_PARM_DESC(min_rx_pkt, "GNIC-II minimum Rx packets processed between interrupts");
538 MODULE_PARM_DESC(max_rx_gap, "GNIC-II maximum Rx inter-packet gap in 8.192 microsecond units");
539 MODULE_PARM_DESC(max_rx_latency, "GNIC-II time between Rx interrupts in 8.192 microsecond units");
540 MODULE_PARM_DESC(min_tx_pkt, "GNIC-II minimum Tx packets processed between interrupts");
541 MODULE_PARM_DESC(max_tx_gap, "GNIC-II maximum Tx inter-packet gap in 8.192 microsecond units");
542 MODULE_PARM_DESC(max_tx_latency, "GNIC-II time between Tx interrupts in 8.192 microsecond units");
543 MODULE_PARM_DESC(rx_copybreak, "GNIC-II copy breakpoint for copy-only-tiny-frames");
544 MODULE_PARM_DESC(rx_params, "GNIC-II min_rx_pkt+max_rx_gap+max_rx_latency");
545 MODULE_PARM_DESC(tx_params, "GNIC-II min_tx_pkt+max_tx_gap+max_tx_latency");
546 MODULE_PARM_DESC(options, "GNIC-II Bits 0-3: media type, bits 4-6: as force32, bit 7: half duplex, bit 9 full duplex");
547 MODULE_PARM_DESC(full_duplex, "GNIC-II full duplex setting(s) (1)");
548 MODULE_PARM_DESC(force32, "GNIC-II: Bit 0: 32 bit PCI, bit 1: disable parity, bit 2: 64 bit PCI (all boards)");
549
550 static int read_eeprom(void __iomem *ioaddr, int location);
551 static int mdio_read(struct net_device *dev, int phy_id, int location);
552 static void mdio_write(struct net_device *dev, int phy_id, int location, int value);
553 static int hamachi_open(struct net_device *dev);
554 static int netdev_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
555 static void hamachi_timer(unsigned long data);
556 static void hamachi_tx_timeout(struct net_device *dev);
557 static void hamachi_init_ring(struct net_device *dev);
558 static int hamachi_start_xmit(struct sk_buff *skb, struct net_device *dev);
559 static irqreturn_t hamachi_interrupt(int irq, void *dev_instance);
560 static int hamachi_rx(struct net_device *dev);
561 static inline int hamachi_tx(struct net_device *dev);
562 static void hamachi_error(struct net_device *dev, int intr_status);
563 static int hamachi_close(struct net_device *dev);
564 static struct net_device_stats *hamachi_get_stats(struct net_device *dev);
565 static void set_rx_mode(struct net_device *dev);
566 static const struct ethtool_ops ethtool_ops;
567 static const struct ethtool_ops ethtool_ops_no_mii;
568
569 static int __devinit hamachi_init_one (struct pci_dev *pdev,
570                                     const struct pci_device_id *ent)
571 {
572         struct hamachi_private *hmp;
573         int option, i, rx_int_var, tx_int_var, boguscnt;
574         int chip_id = ent->driver_data;
575         int irq;
576         void __iomem *ioaddr;
577         unsigned long base;
578         static int card_idx;
579         struct net_device *dev;
580         void *ring_space;
581         dma_addr_t ring_dma;
582         int ret = -ENOMEM;
583
584 /* when built into the kernel, we only print version if device is found */
585 #ifndef MODULE
586         static int printed_version;
587         if (!printed_version++)
588                 printk(version);
589 #endif
590
591         if (pci_enable_device(pdev)) {
592                 ret = -EIO;
593                 goto err_out;
594         }
595
596         base = pci_resource_start(pdev, 0);
597 #ifdef __alpha__                                /* Really "64 bit addrs" */
598         base |= (pci_resource_start(pdev, 1) << 32);
599 #endif
600
601         pci_set_master(pdev);
602
603         i = pci_request_regions(pdev, DRV_NAME);
604         if (i)
605                 return i;
606
607         irq = pdev->irq;
608         ioaddr = ioremap(base, 0x400);
609         if (!ioaddr)
610                 goto err_out_release;
611
612         dev = alloc_etherdev(sizeof(struct hamachi_private));
613         if (!dev)
614                 goto err_out_iounmap;
615
616         SET_MODULE_OWNER(dev);
617         SET_NETDEV_DEV(dev, &pdev->dev);
618
619 #ifdef TX_CHECKSUM
620         printk("check that skbcopy in ip_queue_xmit isn't happening\n");
621         dev->hard_header_len += 8;  /* for cksum tag */
622 #endif
623
624         for (i = 0; i < 6; i++)
625                 dev->dev_addr[i] = 1 ? read_eeprom(ioaddr, 4 + i)
626                         : readb(ioaddr + StationAddr + i);
627
628 #if ! defined(final_version)
629         if (hamachi_debug > 4)
630                 for (i = 0; i < 0x10; i++)
631                         printk("%2.2x%s",
632                                    read_eeprom(ioaddr, i), i % 16 != 15 ? " " : "\n");
633 #endif
634
635         hmp = netdev_priv(dev);
636         spin_lock_init(&hmp->lock);
637
638         hmp->mii_if.dev = dev;
639         hmp->mii_if.mdio_read = mdio_read;
640         hmp->mii_if.mdio_write = mdio_write;
641         hmp->mii_if.phy_id_mask = 0x1f;
642         hmp->mii_if.reg_num_mask = 0x1f;
643
644         ring_space = pci_alloc_consistent(pdev, TX_TOTAL_SIZE, &ring_dma);
645         if (!ring_space)
646                 goto err_out_cleardev;
647         hmp->tx_ring = (struct hamachi_desc *)ring_space;
648         hmp->tx_ring_dma = ring_dma;
649
650         ring_space = pci_alloc_consistent(pdev, RX_TOTAL_SIZE, &ring_dma);
651         if (!ring_space)
652                 goto err_out_unmap_tx;
653         hmp->rx_ring = (struct hamachi_desc *)ring_space;
654         hmp->rx_ring_dma = ring_dma;
655
656         /* Check for options being passed in */
657         option = card_idx < MAX_UNITS ? options[card_idx] : 0;
658         if (dev->mem_start)
659                 option = dev->mem_start;
660
661         /* If the bus size is misidentified, do the following. */
662         force32 = force32 ? force32 :
663                 ((option  >= 0) ? ((option & 0x00000070) >> 4) : 0 );
664         if (force32)
665                 writeb(force32, ioaddr + VirtualJumpers);
666
667         /* Hmmm, do we really need to reset the chip???. */
668         writeb(0x01, ioaddr + ChipReset);
669
670         /* After a reset, the clock speed measurement of the PCI bus will not
671          * be valid for a moment.  Wait for a little while until it is.  If
672          * it takes more than 10ms, forget it.
673          */
674         udelay(10);
675         i = readb(ioaddr + PCIClkMeas);
676         for (boguscnt = 0; (!(i & 0x080)) && boguscnt < 1000; boguscnt++){
677                 udelay(10);
678                 i = readb(ioaddr + PCIClkMeas);
679         }
680
681         hmp->base = ioaddr;
682         dev->base_addr = (unsigned long)ioaddr;
683         dev->irq = irq;
684         pci_set_drvdata(pdev, dev);
685
686         hmp->chip_id = chip_id;
687         hmp->pci_dev = pdev;
688
689         /* The lower four bits are the media type. */
690         if (option > 0) {
691                 hmp->option = option;
692                 if (option & 0x200)
693                         hmp->mii_if.full_duplex = 1;
694                 else if (option & 0x080)
695                         hmp->mii_if.full_duplex = 0;
696                 hmp->default_port = option & 15;
697                 if (hmp->default_port)
698                         hmp->mii_if.force_media = 1;
699         }
700         if (card_idx < MAX_UNITS  &&  full_duplex[card_idx] > 0)
701                 hmp->mii_if.full_duplex = 1;
702
703         /* lock the duplex mode if someone specified a value */
704         if (hmp->mii_if.full_duplex || (option & 0x080))
705                 hmp->duplex_lock = 1;
706
707         /* Set interrupt tuning parameters */
708         max_rx_latency = max_rx_latency & 0x00ff;
709         max_rx_gap = max_rx_gap & 0x00ff;
710         min_rx_pkt = min_rx_pkt & 0x00ff;
711         max_tx_latency = max_tx_latency & 0x00ff;
712         max_tx_gap = max_tx_gap & 0x00ff;
713         min_tx_pkt = min_tx_pkt & 0x00ff;
714
715         rx_int_var = card_idx < MAX_UNITS ? rx_params[card_idx] : -1;
716         tx_int_var = card_idx < MAX_UNITS ? tx_params[card_idx] : -1;
717         hmp->rx_int_var = rx_int_var >= 0 ? rx_int_var :
718                 (min_rx_pkt << 16 | max_rx_gap << 8 | max_rx_latency);
719         hmp->tx_int_var = tx_int_var >= 0 ? tx_int_var :
720                 (min_tx_pkt << 16 | max_tx_gap << 8 | max_tx_latency);
721
722
723         /* The Hamachi-specific entries in the device structure. */
724         dev->open = &hamachi_open;
725         dev->hard_start_xmit = &hamachi_start_xmit;
726         dev->stop = &hamachi_close;
727         dev->get_stats = &hamachi_get_stats;
728         dev->set_multicast_list = &set_rx_mode;
729         dev->do_ioctl = &netdev_ioctl;
730         if (chip_tbl[hmp->chip_id].flags & CanHaveMII)
731                 SET_ETHTOOL_OPS(dev, &ethtool_ops);
732         else
733                 SET_ETHTOOL_OPS(dev, &ethtool_ops_no_mii);
734         dev->tx_timeout = &hamachi_tx_timeout;
735         dev->watchdog_timeo = TX_TIMEOUT;
736         if (mtu)
737                 dev->mtu = mtu;
738
739         i = register_netdev(dev);
740         if (i) {
741                 ret = i;
742                 goto err_out_unmap_rx;
743         }
744
745         printk(KERN_INFO "%s: %s type %x at %p, ",
746                    dev->name, chip_tbl[chip_id].name, readl(ioaddr + ChipRev),
747                    ioaddr);
748         for (i = 0; i < 5; i++)
749                         printk("%2.2x:", dev->dev_addr[i]);
750         printk("%2.2x, IRQ %d.\n", dev->dev_addr[i], irq);
751         i = readb(ioaddr + PCIClkMeas);
752         printk(KERN_INFO "%s:  %d-bit %d Mhz PCI bus (%d), Virtual Jumpers "
753                    "%2.2x, LPA %4.4x.\n",
754                    dev->name, readw(ioaddr + MiscStatus) & 1 ? 64 : 32,
755                    i ? 2000/(i&0x7f) : 0, i&0x7f, (int)readb(ioaddr + VirtualJumpers),
756                    readw(ioaddr + ANLinkPartnerAbility));
757
758         if (chip_tbl[hmp->chip_id].flags & CanHaveMII) {
759                 int phy, phy_idx = 0;
760                 for (phy = 0; phy < 32 && phy_idx < MII_CNT; phy++) {
761                         int mii_status = mdio_read(dev, phy, MII_BMSR);
762                         if (mii_status != 0xffff  &&
763                                 mii_status != 0x0000) {
764                                 hmp->phys[phy_idx++] = phy;
765                                 hmp->mii_if.advertising = mdio_read(dev, phy, MII_ADVERTISE);
766                                 printk(KERN_INFO "%s: MII PHY found at address %d, status "
767                                            "0x%4.4x advertising %4.4x.\n",
768                                            dev->name, phy, mii_status, hmp->mii_if.advertising);
769                         }
770                 }
771                 hmp->mii_cnt = phy_idx;
772                 if (hmp->mii_cnt > 0)
773                         hmp->mii_if.phy_id = hmp->phys[0];
774                 else
775                         memset(&hmp->mii_if, 0, sizeof(hmp->mii_if));
776         }
777         /* Configure gigabit autonegotiation. */
778         writew(0x0400, ioaddr + ANXchngCtrl);   /* Enable legacy links. */
779         writew(0x08e0, ioaddr + ANAdvertise);   /* Set our advertise word. */
780         writew(0x1000, ioaddr + ANCtrl);                        /* Enable negotiation */
781
782         card_idx++;
783         return 0;
784
785 err_out_unmap_rx:
786         pci_free_consistent(pdev, RX_TOTAL_SIZE, hmp->rx_ring,
787                 hmp->rx_ring_dma);
788 err_out_unmap_tx:
789         pci_free_consistent(pdev, TX_TOTAL_SIZE, hmp->tx_ring,
790                 hmp->tx_ring_dma);
791 err_out_cleardev:
792         free_netdev (dev);
793 err_out_iounmap:
794         iounmap(ioaddr);
795 err_out_release:
796         pci_release_regions(pdev);
797 err_out:
798         return ret;
799 }
800
801 static int __devinit read_eeprom(void __iomem *ioaddr, int location)
802 {
803         int bogus_cnt = 1000;
804
805         /* We should check busy first - per docs -KDU */
806         while ((readb(ioaddr + EECmdStatus) & 0x40)  && --bogus_cnt > 0);
807         writew(location, ioaddr + EEAddr);
808         writeb(0x02, ioaddr + EECmdStatus);
809         bogus_cnt = 1000;
810         while ((readb(ioaddr + EECmdStatus) & 0x40)  && --bogus_cnt > 0);
811         if (hamachi_debug > 5)
812                 printk("   EEPROM status is %2.2x after %d ticks.\n",
813                            (int)readb(ioaddr + EECmdStatus), 1000- bogus_cnt);
814         return readb(ioaddr + EEData);
815 }
816
817 /* MII Managemen Data I/O accesses.
818    These routines assume the MDIO controller is idle, and do not exit until
819    the command is finished. */
820
821 static int mdio_read(struct net_device *dev, int phy_id, int location)
822 {
823         struct hamachi_private *hmp = netdev_priv(dev);
824         void __iomem *ioaddr = hmp->base;
825         int i;
826
827         /* We should check busy first - per docs -KDU */
828         for (i = 10000; i >= 0; i--)
829                 if ((readw(ioaddr + MII_Status) & 1) == 0)
830                         break;
831         writew((phy_id<<8) + location, ioaddr + MII_Addr);
832         writew(0x0001, ioaddr + MII_Cmd);
833         for (i = 10000; i >= 0; i--)
834                 if ((readw(ioaddr + MII_Status) & 1) == 0)
835                         break;
836         return readw(ioaddr + MII_Rd_Data);
837 }
838
839 static void mdio_write(struct net_device *dev, int phy_id, int location, int value)
840 {
841         struct hamachi_private *hmp = netdev_priv(dev);
842         void __iomem *ioaddr = hmp->base;
843         int i;
844
845         /* We should check busy first - per docs -KDU */
846         for (i = 10000; i >= 0; i--)
847                 if ((readw(ioaddr + MII_Status) & 1) == 0)
848                         break;
849         writew((phy_id<<8) + location, ioaddr + MII_Addr);
850         writew(value, ioaddr + MII_Wr_Data);
851
852         /* Wait for the command to finish. */
853         for (i = 10000; i >= 0; i--)
854                 if ((readw(ioaddr + MII_Status) & 1) == 0)
855                         break;
856         return;
857 }
858
859
860 static int hamachi_open(struct net_device *dev)
861 {
862         struct hamachi_private *hmp = netdev_priv(dev);
863         void __iomem *ioaddr = hmp->base;
864         int i;
865         u32 rx_int_var, tx_int_var;
866         u16 fifo_info;
867
868         i = request_irq(dev->irq, &hamachi_interrupt, IRQF_SHARED, dev->name, dev);
869         if (i)
870                 return i;
871
872         if (hamachi_debug > 1)
873                 printk(KERN_DEBUG "%s: hamachi_open() irq %d.\n",
874                            dev->name, dev->irq);
875
876         hamachi_init_ring(dev);
877
878 #if ADDRLEN == 64
879         /* writellll anyone ? */
880         writel(cpu_to_le64(hmp->rx_ring_dma), ioaddr + RxPtr);
881         writel(cpu_to_le64(hmp->rx_ring_dma) >> 32, ioaddr + RxPtr + 4);
882         writel(cpu_to_le64(hmp->tx_ring_dma), ioaddr + TxPtr);
883         writel(cpu_to_le64(hmp->tx_ring_dma) >> 32, ioaddr + TxPtr + 4);
884 #else
885         writel(cpu_to_le32(hmp->rx_ring_dma), ioaddr + RxPtr);
886         writel(cpu_to_le32(hmp->tx_ring_dma), ioaddr + TxPtr);
887 #endif
888
889         /* TODO:  It would make sense to organize this as words since the card
890          * documentation does. -KDU
891          */
892         for (i = 0; i < 6; i++)
893                 writeb(dev->dev_addr[i], ioaddr + StationAddr + i);
894
895         /* Initialize other registers: with so many this eventually this will
896            converted to an offset/value list. */
897
898         /* Configure the FIFO */
899         fifo_info = (readw(ioaddr + GPIO) & 0x00C0) >> 6;
900         switch (fifo_info){
901                 case 0 :
902                         /* No FIFO */
903                         writew(0x0000, ioaddr + FIFOcfg);
904                         break;
905                 case 1 :
906                         /* Configure the FIFO for 512K external, 16K used for Tx. */
907                         writew(0x0028, ioaddr + FIFOcfg);
908                         break;
909                 case 2 :
910                         /* Configure the FIFO for 1024 external, 32K used for Tx. */
911                         writew(0x004C, ioaddr + FIFOcfg);
912                         break;
913                 case 3 :
914                         /* Configure the FIFO for 2048 external, 32K used for Tx. */
915                         writew(0x006C, ioaddr + FIFOcfg);
916                         break;
917                 default :
918                         printk(KERN_WARNING "%s:  Unsupported external memory config!\n",
919                                 dev->name);
920                         /* Default to no FIFO */
921                         writew(0x0000, ioaddr + FIFOcfg);
922                         break;
923         }
924
925         if (dev->if_port == 0)
926                 dev->if_port = hmp->default_port;
927
928
929         /* Setting the Rx mode will start the Rx process. */
930         /* If someone didn't choose a duplex, default to full-duplex */
931         if (hmp->duplex_lock != 1)
932                 hmp->mii_if.full_duplex = 1;
933
934         /* always 1, takes no more time to do it */
935         writew(0x0001, ioaddr + RxChecksum);
936 #ifdef TX_CHECKSUM
937         writew(0x0001, ioaddr + TxChecksum);
938 #else
939         writew(0x0000, ioaddr + TxChecksum);
940 #endif
941         writew(0x8000, ioaddr + MACCnfg); /* Soft reset the MAC */
942         writew(0x215F, ioaddr + MACCnfg);
943         writew(0x000C, ioaddr + FrameGap0);
944         /* WHAT?!?!?  Why isn't this documented somewhere? -KDU */
945         writew(0x1018, ioaddr + FrameGap1);
946         /* Why do we enable receives/transmits here? -KDU */
947         writew(0x0780, ioaddr + MACCnfg2); /* Upper 16 bits control LEDs. */
948         /* Enable automatic generation of flow control frames, period 0xffff. */
949         writel(0x0030FFFF, ioaddr + FlowCtrl);
950         writew(MAX_FRAME_SIZE, ioaddr + MaxFrameSize);  /* dev->mtu+14 ??? */
951
952         /* Enable legacy links. */
953         writew(0x0400, ioaddr + ANXchngCtrl);   /* Enable legacy links. */
954         /* Initial Link LED to blinking red. */
955         writeb(0x03, ioaddr + LEDCtrl);
956
957         /* Configure interrupt mitigation.  This has a great effect on
958            performance, so systems tuning should start here!. */
959
960         rx_int_var = hmp->rx_int_var;
961         tx_int_var = hmp->tx_int_var;
962
963         if (hamachi_debug > 1) {
964                 printk("max_tx_latency: %d, max_tx_gap: %d, min_tx_pkt: %d\n",
965                         tx_int_var & 0x00ff, (tx_int_var & 0x00ff00) >> 8,
966                         (tx_int_var & 0x00ff0000) >> 16);
967                 printk("max_rx_latency: %d, max_rx_gap: %d, min_rx_pkt: %d\n",
968                         rx_int_var & 0x00ff, (rx_int_var & 0x00ff00) >> 8,
969                         (rx_int_var & 0x00ff0000) >> 16);
970                 printk("rx_int_var: %x, tx_int_var: %x\n", rx_int_var, tx_int_var);
971         }
972
973         writel(tx_int_var, ioaddr + TxIntrCtrl);
974         writel(rx_int_var, ioaddr + RxIntrCtrl);
975
976         set_rx_mode(dev);
977
978         netif_start_queue(dev);
979
980         /* Enable interrupts by setting the interrupt mask. */
981         writel(0x80878787, ioaddr + InterruptEnable);
982         writew(0x0000, ioaddr + EventStatus);   /* Clear non-interrupting events */
983
984         /* Configure and start the DMA channels. */
985         /* Burst sizes are in the low three bits: size = 4<<(val&7) */
986 #if ADDRLEN == 64
987         writew(0x005D, ioaddr + RxDMACtrl);             /* 128 dword bursts */
988         writew(0x005D, ioaddr + TxDMACtrl);
989 #else
990         writew(0x001D, ioaddr + RxDMACtrl);
991         writew(0x001D, ioaddr + TxDMACtrl);
992 #endif
993         writew(0x0001, ioaddr + RxCmd);
994
995         if (hamachi_debug > 2) {
996                 printk(KERN_DEBUG "%s: Done hamachi_open(), status: Rx %x Tx %x.\n",
997                            dev->name, readw(ioaddr + RxStatus), readw(ioaddr + TxStatus));
998         }
999         /* Set the timer to check for link beat. */
1000         init_timer(&hmp->timer);
1001         hmp->timer.expires = RUN_AT((24*HZ)/10);                        /* 2.4 sec. */
1002         hmp->timer.data = (unsigned long)dev;
1003         hmp->timer.function = &hamachi_timer;                           /* timer handler */
1004         add_timer(&hmp->timer);
1005
1006         return 0;
1007 }
1008
1009 static inline int hamachi_tx(struct net_device *dev)
1010 {
1011         struct hamachi_private *hmp = netdev_priv(dev);
1012
1013         /* Update the dirty pointer until we find an entry that is
1014                 still owned by the card */
1015         for (; hmp->cur_tx - hmp->dirty_tx > 0; hmp->dirty_tx++) {
1016                 int entry = hmp->dirty_tx % TX_RING_SIZE;
1017                 struct sk_buff *skb;
1018
1019                 if (hmp->tx_ring[entry].status_n_length & cpu_to_le32(DescOwn))
1020                         break;
1021                 /* Free the original skb. */
1022                 skb = hmp->tx_skbuff[entry];
1023                 if (skb != 0) {
1024                         pci_unmap_single(hmp->pci_dev,
1025                                 hmp->tx_ring[entry].addr, skb->len,
1026                                 PCI_DMA_TODEVICE);
1027                         dev_kfree_skb(skb);
1028                         hmp->tx_skbuff[entry] = NULL;
1029                 }
1030                 hmp->tx_ring[entry].status_n_length = 0;
1031                 if (entry >= TX_RING_SIZE-1)
1032                         hmp->tx_ring[TX_RING_SIZE-1].status_n_length |=
1033                                 cpu_to_le32(DescEndRing);
1034                 hmp->stats.tx_packets++;
1035         }
1036
1037         return 0;
1038 }
1039
1040 static void hamachi_timer(unsigned long data)
1041 {
1042         struct net_device *dev = (struct net_device *)data;
1043         struct hamachi_private *hmp = netdev_priv(dev);
1044         void __iomem *ioaddr = hmp->base;
1045         int next_tick = 10*HZ;
1046
1047         if (hamachi_debug > 2) {
1048                 printk(KERN_INFO "%s: Hamachi Autonegotiation status %4.4x, LPA "
1049                            "%4.4x.\n", dev->name, readw(ioaddr + ANStatus),
1050                            readw(ioaddr + ANLinkPartnerAbility));
1051                 printk(KERN_INFO "%s: Autonegotiation regs %4.4x %4.4x %4.4x "
1052                        "%4.4x %4.4x %4.4x.\n", dev->name,
1053                        readw(ioaddr + 0x0e0),
1054                        readw(ioaddr + 0x0e2),
1055                        readw(ioaddr + 0x0e4),
1056                        readw(ioaddr + 0x0e6),
1057                        readw(ioaddr + 0x0e8),
1058                        readw(ioaddr + 0x0eA));
1059         }
1060         /* We could do something here... nah. */
1061         hmp->timer.expires = RUN_AT(next_tick);
1062         add_timer(&hmp->timer);
1063 }
1064
1065 static void hamachi_tx_timeout(struct net_device *dev)
1066 {
1067         int i;
1068         struct hamachi_private *hmp = netdev_priv(dev);
1069         void __iomem *ioaddr = hmp->base;
1070
1071         printk(KERN_WARNING "%s: Hamachi transmit timed out, status %8.8x,"
1072                    " resetting...\n", dev->name, (int)readw(ioaddr + TxStatus));
1073
1074         {
1075                 int i;
1076                 printk(KERN_DEBUG "  Rx ring %p: ", hmp->rx_ring);
1077                 for (i = 0; i < RX_RING_SIZE; i++)
1078                         printk(" %8.8x", (unsigned int)hmp->rx_ring[i].status_n_length);
1079                 printk("\n"KERN_DEBUG"  Tx ring %p: ", hmp->tx_ring);
1080                 for (i = 0; i < TX_RING_SIZE; i++)
1081                         printk(" %4.4x", hmp->tx_ring[i].status_n_length);
1082                 printk("\n");
1083         }
1084
1085         /* Reinit the hardware and make sure the Rx and Tx processes
1086                 are up and running.
1087          */
1088         dev->if_port = 0;
1089         /* The right way to do Reset. -KDU
1090          *              -Clear OWN bit in all Rx/Tx descriptors
1091          *              -Wait 50 uS for channels to go idle
1092          *              -Turn off MAC receiver
1093          *              -Issue Reset
1094          */
1095
1096         for (i = 0; i < RX_RING_SIZE; i++)
1097                 hmp->rx_ring[i].status_n_length &= cpu_to_le32(~DescOwn);
1098
1099         /* Presume that all packets in the Tx queue are gone if we have to
1100          * re-init the hardware.
1101          */
1102         for (i = 0; i < TX_RING_SIZE; i++){
1103                 struct sk_buff *skb;
1104
1105                 if (i >= TX_RING_SIZE - 1)
1106                         hmp->tx_ring[i].status_n_length = cpu_to_le32(
1107                                 DescEndRing |
1108                                 (hmp->tx_ring[i].status_n_length & 0x0000FFFF));
1109                 else
1110                         hmp->tx_ring[i].status_n_length &= 0x0000ffff;
1111                 skb = hmp->tx_skbuff[i];
1112                 if (skb){
1113                         pci_unmap_single(hmp->pci_dev, hmp->tx_ring[i].addr,
1114                                 skb->len, PCI_DMA_TODEVICE);
1115                         dev_kfree_skb(skb);
1116                         hmp->tx_skbuff[i] = NULL;
1117                 }
1118         }
1119
1120         udelay(60); /* Sleep 60 us just for safety sake */
1121         writew(0x0002, ioaddr + RxCmd); /* STOP Rx */
1122
1123         writeb(0x01, ioaddr + ChipReset);  /* Reinit the hardware */
1124
1125         hmp->tx_full = 0;
1126         hmp->cur_rx = hmp->cur_tx = 0;
1127         hmp->dirty_rx = hmp->dirty_tx = 0;
1128         /* Rx packets are also presumed lost; however, we need to make sure a
1129          * ring of buffers is in tact. -KDU
1130          */
1131         for (i = 0; i < RX_RING_SIZE; i++){
1132                 struct sk_buff *skb = hmp->rx_skbuff[i];
1133
1134                 if (skb){
1135                         pci_unmap_single(hmp->pci_dev, hmp->rx_ring[i].addr,
1136                                 hmp->rx_buf_sz, PCI_DMA_FROMDEVICE);
1137                         dev_kfree_skb(skb);
1138                         hmp->rx_skbuff[i] = NULL;
1139                 }
1140         }
1141         /* Fill in the Rx buffers.  Handle allocation failure gracefully. */
1142         for (i = 0; i < RX_RING_SIZE; i++) {
1143                 struct sk_buff *skb = dev_alloc_skb(hmp->rx_buf_sz);
1144                 hmp->rx_skbuff[i] = skb;
1145                 if (skb == NULL)
1146                         break;
1147                 skb->dev = dev;         /* Mark as being used by this device. */
1148                 skb_reserve(skb, 2); /* 16 byte align the IP header. */
1149                 hmp->rx_ring[i].addr = cpu_to_leXX(pci_map_single(hmp->pci_dev,
1150                         skb->data, hmp->rx_buf_sz, PCI_DMA_FROMDEVICE));
1151                 hmp->rx_ring[i].status_n_length = cpu_to_le32(DescOwn |
1152                         DescEndPacket | DescIntr | (hmp->rx_buf_sz - 2));
1153         }
1154         hmp->dirty_rx = (unsigned int)(i - RX_RING_SIZE);
1155         /* Mark the last entry as wrapping the ring. */
1156         hmp->rx_ring[RX_RING_SIZE-1].status_n_length |= cpu_to_le32(DescEndRing);
1157
1158         /* Trigger an immediate transmit demand. */
1159         dev->trans_start = jiffies;
1160         hmp->stats.tx_errors++;
1161
1162         /* Restart the chip's Tx/Rx processes . */
1163         writew(0x0002, ioaddr + TxCmd); /* STOP Tx */
1164         writew(0x0001, ioaddr + TxCmd); /* START Tx */
1165         writew(0x0001, ioaddr + RxCmd); /* START Rx */
1166
1167         netif_wake_queue(dev);
1168 }
1169
1170
1171 /* Initialize the Rx and Tx rings, along with various 'dev' bits. */
1172 static void hamachi_init_ring(struct net_device *dev)
1173 {
1174         struct hamachi_private *hmp = netdev_priv(dev);
1175         int i;
1176
1177         hmp->tx_full = 0;
1178         hmp->cur_rx = hmp->cur_tx = 0;
1179         hmp->dirty_rx = hmp->dirty_tx = 0;
1180
1181 #if 0
1182         /* This is wrong.  I'm not sure what the original plan was, but this
1183          * is wrong.  An MTU of 1 gets you a buffer of 1536, while an MTU
1184          * of 1501 gets a buffer of 1533? -KDU
1185          */
1186         hmp->rx_buf_sz = (dev->mtu <= 1500 ? PKT_BUF_SZ : dev->mtu + 32);
1187 #endif
1188         /* My attempt at a reasonable correction */
1189         /* +26 gets the maximum ethernet encapsulation, +7 & ~7 because the
1190          * card needs room to do 8 byte alignment, +2 so we can reserve
1191          * the first 2 bytes, and +16 gets room for the status word from the
1192          * card.  -KDU
1193          */
1194         hmp->rx_buf_sz = (dev->mtu <= 1492 ? PKT_BUF_SZ :
1195                 (((dev->mtu+26+7) & ~7) + 2 + 16));
1196
1197         /* Initialize all Rx descriptors. */
1198         for (i = 0; i < RX_RING_SIZE; i++) {
1199                 hmp->rx_ring[i].status_n_length = 0;
1200                 hmp->rx_skbuff[i] = NULL;
1201         }
1202         /* Fill in the Rx buffers.  Handle allocation failure gracefully. */
1203         for (i = 0; i < RX_RING_SIZE; i++) {
1204                 struct sk_buff *skb = dev_alloc_skb(hmp->rx_buf_sz);
1205                 hmp->rx_skbuff[i] = skb;
1206                 if (skb == NULL)
1207                         break;
1208                 skb->dev = dev;         /* Mark as being used by this device. */
1209                 skb_reserve(skb, 2); /* 16 byte align the IP header. */
1210                 hmp->rx_ring[i].addr = cpu_to_leXX(pci_map_single(hmp->pci_dev,
1211                         skb->data, hmp->rx_buf_sz, PCI_DMA_FROMDEVICE));
1212                 /* -2 because it doesn't REALLY have that first 2 bytes -KDU */
1213                 hmp->rx_ring[i].status_n_length = cpu_to_le32(DescOwn |
1214                         DescEndPacket | DescIntr | (hmp->rx_buf_sz -2));
1215         }
1216         hmp->dirty_rx = (unsigned int)(i - RX_RING_SIZE);
1217         hmp->rx_ring[RX_RING_SIZE-1].status_n_length |= cpu_to_le32(DescEndRing);
1218
1219         for (i = 0; i < TX_RING_SIZE; i++) {
1220                 hmp->tx_skbuff[i] = NULL;
1221                 hmp->tx_ring[i].status_n_length = 0;
1222         }
1223         /* Mark the last entry of the ring */
1224         hmp->tx_ring[TX_RING_SIZE-1].status_n_length |= cpu_to_le32(DescEndRing);
1225
1226         return;
1227 }
1228
1229
1230 #ifdef TX_CHECKSUM
1231 #define csum_add(it, val) \
1232 do { \
1233     it += (u16) (val); \
1234     if (it & 0xffff0000) { \
1235         it &= 0xffff; \
1236         ++it; \
1237     } \
1238 } while (0)
1239     /* printk("add %04x --> %04x\n", val, it); \ */
1240
1241 /* uh->len already network format, do not swap */
1242 #define pseudo_csum_udp(sum,ih,uh) do { \
1243     sum = 0; \
1244     csum_add(sum, (ih)->saddr >> 16); \
1245     csum_add(sum, (ih)->saddr & 0xffff); \
1246     csum_add(sum, (ih)->daddr >> 16); \
1247     csum_add(sum, (ih)->daddr & 0xffff); \
1248     csum_add(sum, __constant_htons(IPPROTO_UDP)); \
1249     csum_add(sum, (uh)->len); \
1250 } while (0)
1251
1252 /* swap len */
1253 #define pseudo_csum_tcp(sum,ih,len) do { \
1254     sum = 0; \
1255     csum_add(sum, (ih)->saddr >> 16); \
1256     csum_add(sum, (ih)->saddr & 0xffff); \
1257     csum_add(sum, (ih)->daddr >> 16); \
1258     csum_add(sum, (ih)->daddr & 0xffff); \
1259     csum_add(sum, __constant_htons(IPPROTO_TCP)); \
1260     csum_add(sum, htons(len)); \
1261 } while (0)
1262 #endif
1263
1264 static int hamachi_start_xmit(struct sk_buff *skb, struct net_device *dev)
1265 {
1266         struct hamachi_private *hmp = netdev_priv(dev);
1267         unsigned entry;
1268         u16 status;
1269
1270         /* Ok, now make sure that the queue has space before trying to
1271                 add another skbuff.  if we return non-zero the scheduler
1272                 should interpret this as a queue full and requeue the buffer
1273                 for later.
1274          */
1275         if (hmp->tx_full) {
1276                 /* We should NEVER reach this point -KDU */
1277                 printk(KERN_WARNING "%s: Hamachi transmit queue full at slot %d.\n",dev->name, hmp->cur_tx);
1278
1279                 /* Wake the potentially-idle transmit channel. */
1280                 /* If we don't need to read status, DON'T -KDU */
1281                 status=readw(hmp->base + TxStatus);
1282                 if( !(status & 0x0001) || (status & 0x0002))
1283                         writew(0x0001, hmp->base + TxCmd);
1284                 return 1;
1285         }
1286
1287         /* Caution: the write order is important here, set the field
1288            with the "ownership" bits last. */
1289
1290         /* Calculate the next Tx descriptor entry. */
1291         entry = hmp->cur_tx % TX_RING_SIZE;
1292
1293         hmp->tx_skbuff[entry] = skb;
1294
1295 #ifdef TX_CHECKSUM
1296         {
1297             /* tack on checksum tag */
1298             u32 tagval = 0;
1299             struct ethhdr *eh = (struct ethhdr *)skb->data;
1300             if (eh->h_proto == __constant_htons(ETH_P_IP)) {
1301                 struct iphdr *ih = (struct iphdr *)((char *)eh + ETH_HLEN);
1302                 if (ih->protocol == IPPROTO_UDP) {
1303                     struct udphdr *uh
1304                       = (struct udphdr *)((char *)ih + ih->ihl*4);
1305                     u32 offset = ((unsigned char *)uh + 6) - skb->data;
1306                     u32 pseudo;
1307                     pseudo_csum_udp(pseudo, ih, uh);
1308                     pseudo = htons(pseudo);
1309                     printk("udp cksum was %04x, sending pseudo %04x\n",
1310                       uh->check, pseudo);
1311                     uh->check = 0;  /* zero out uh->check before card calc */
1312                     /*
1313                      * start at 14 (skip ethhdr), store at offset (uh->check),
1314                      * use pseudo value given.
1315                      */
1316                     tagval = (14 << 24) | (offset << 16) | pseudo;
1317                 } else if (ih->protocol == IPPROTO_TCP) {
1318                     printk("tcp, no auto cksum\n");
1319                 }
1320             }
1321             *(u32 *)skb_push(skb, 8) = tagval;
1322         }
1323 #endif
1324
1325         hmp->tx_ring[entry].addr = cpu_to_leXX(pci_map_single(hmp->pci_dev,
1326                 skb->data, skb->len, PCI_DMA_TODEVICE));
1327
1328         /* Hmmmm, could probably put a DescIntr on these, but the way
1329                 the driver is currently coded makes Tx interrupts unnecessary
1330                 since the clearing of the Tx ring is handled by the start_xmit
1331                 routine.  This organization helps mitigate the interrupts a
1332                 bit and probably renders the max_tx_latency param useless.
1333
1334                 Update: Putting a DescIntr bit on all of the descriptors and
1335                 mitigating interrupt frequency with the tx_min_pkt parameter. -KDU
1336         */
1337         if (entry >= TX_RING_SIZE-1)             /* Wrap ring */
1338                 hmp->tx_ring[entry].status_n_length = cpu_to_le32(DescOwn |
1339                         DescEndPacket | DescEndRing | DescIntr | skb->len);
1340         else
1341                 hmp->tx_ring[entry].status_n_length = cpu_to_le32(DescOwn |
1342                         DescEndPacket | DescIntr | skb->len);
1343         hmp->cur_tx++;
1344
1345         /* Non-x86 Todo: explicitly flush cache lines here. */
1346
1347         /* Wake the potentially-idle transmit channel. */
1348         /* If we don't need to read status, DON'T -KDU */
1349         status=readw(hmp->base + TxStatus);
1350         if( !(status & 0x0001) || (status & 0x0002))
1351                 writew(0x0001, hmp->base + TxCmd);
1352
1353         /* Immediately before returning, let's clear as many entries as we can. */
1354         hamachi_tx(dev);
1355
1356         /* We should kick the bottom half here, since we are not accepting
1357          * interrupts with every packet.  i.e. realize that Gigabit ethernet
1358          * can transmit faster than ordinary machines can load packets;
1359          * hence, any packet that got put off because we were in the transmit
1360          * routine should IMMEDIATELY get a chance to be re-queued. -KDU
1361          */
1362         if ((hmp->cur_tx - hmp->dirty_tx) < (TX_RING_SIZE - 4))
1363                 netif_wake_queue(dev);  /* Typical path */
1364         else {
1365                 hmp->tx_full = 1;
1366                 netif_stop_queue(dev);
1367         }
1368         dev->trans_start = jiffies;
1369
1370         if (hamachi_debug > 4) {
1371                 printk(KERN_DEBUG "%s: Hamachi transmit frame #%d queued in slot %d.\n",
1372                            dev->name, hmp->cur_tx, entry);
1373         }
1374         return 0;
1375 }
1376
1377 /* The interrupt handler does all of the Rx thread work and cleans up
1378    after the Tx thread. */
1379 static irqreturn_t hamachi_interrupt(int irq, void *dev_instance)
1380 {
1381         struct net_device *dev = dev_instance;
1382         struct hamachi_private *hmp = netdev_priv(dev);
1383         void __iomem *ioaddr = hmp->base;
1384         long boguscnt = max_interrupt_work;
1385         int handled = 0;
1386
1387 #ifndef final_version                   /* Can never occur. */
1388         if (dev == NULL) {
1389                 printk (KERN_ERR "hamachi_interrupt(): irq %d for unknown device.\n", irq);
1390                 return IRQ_NONE;
1391         }
1392 #endif
1393
1394         spin_lock(&hmp->lock);
1395
1396         do {
1397                 u32 intr_status = readl(ioaddr + InterruptClear);
1398
1399                 if (hamachi_debug > 4)
1400                         printk(KERN_DEBUG "%s: Hamachi interrupt, status %4.4x.\n",
1401                                    dev->name, intr_status);
1402
1403                 if (intr_status == 0)
1404                         break;
1405
1406                 handled = 1;
1407
1408                 if (intr_status & IntrRxDone)
1409                         hamachi_rx(dev);
1410
1411                 if (intr_status & IntrTxDone){
1412                         /* This code should RARELY need to execute. After all, this is
1413                          * a gigabit link, it should consume packets as fast as we put
1414                          * them in AND we clear the Tx ring in hamachi_start_xmit().
1415                          */
1416                         if (hmp->tx_full){
1417                                 for (; hmp->cur_tx - hmp->dirty_tx > 0; hmp->dirty_tx++){
1418                                         int entry = hmp->dirty_tx % TX_RING_SIZE;
1419                                         struct sk_buff *skb;
1420
1421                                         if (hmp->tx_ring[entry].status_n_length & cpu_to_le32(DescOwn))
1422                                                 break;
1423                                         skb = hmp->tx_skbuff[entry];
1424                                         /* Free the original skb. */
1425                                         if (skb){
1426                                                 pci_unmap_single(hmp->pci_dev,
1427                                                         hmp->tx_ring[entry].addr,
1428                                                         skb->len,
1429                                                         PCI_DMA_TODEVICE);
1430                                                 dev_kfree_skb_irq(skb);
1431                                                 hmp->tx_skbuff[entry] = NULL;
1432                                         }
1433                                         hmp->tx_ring[entry].status_n_length = 0;
1434                                         if (entry >= TX_RING_SIZE-1)
1435                                                 hmp->tx_ring[TX_RING_SIZE-1].status_n_length |=
1436                                                         cpu_to_le32(DescEndRing);
1437                                         hmp->stats.tx_packets++;
1438                                 }
1439                                 if (hmp->cur_tx - hmp->dirty_tx < TX_RING_SIZE - 4){
1440                                         /* The ring is no longer full */
1441                                         hmp->tx_full = 0;
1442                                         netif_wake_queue(dev);
1443                                 }
1444                         } else {
1445                                 netif_wake_queue(dev);
1446                         }
1447                 }
1448
1449
1450                 /* Abnormal error summary/uncommon events handlers. */
1451                 if (intr_status &
1452                         (IntrTxPCIFault | IntrTxPCIErr | IntrRxPCIFault | IntrRxPCIErr |
1453                          LinkChange | NegotiationChange | StatsMax))
1454                         hamachi_error(dev, intr_status);
1455
1456                 if (--boguscnt < 0) {
1457                         printk(KERN_WARNING "%s: Too much work at interrupt, status=0x%4.4x.\n",
1458                                    dev->name, intr_status);
1459                         break;
1460                 }
1461         } while (1);
1462
1463         if (hamachi_debug > 3)
1464                 printk(KERN_DEBUG "%s: exiting interrupt, status=%#4.4x.\n",
1465                            dev->name, readl(ioaddr + IntrStatus));
1466
1467 #ifndef final_version
1468         /* Code that should never be run!  Perhaps remove after testing.. */
1469         {
1470                 static int stopit = 10;
1471                 if (dev->start == 0  &&  --stopit < 0) {
1472                         printk(KERN_ERR "%s: Emergency stop, looping startup interrupt.\n",
1473                                    dev->name);
1474                         free_irq(irq, dev);
1475                 }
1476         }
1477 #endif
1478
1479         spin_unlock(&hmp->lock);
1480         return IRQ_RETVAL(handled);
1481 }
1482
1483 /* This routine is logically part of the interrupt handler, but separated
1484    for clarity and better register allocation. */
1485 static int hamachi_rx(struct net_device *dev)
1486 {
1487         struct hamachi_private *hmp = netdev_priv(dev);
1488         int entry = hmp->cur_rx % RX_RING_SIZE;
1489         int boguscnt = (hmp->dirty_rx + RX_RING_SIZE) - hmp->cur_rx;
1490
1491         if (hamachi_debug > 4) {
1492                 printk(KERN_DEBUG " In hamachi_rx(), entry %d status %4.4x.\n",
1493                            entry, hmp->rx_ring[entry].status_n_length);
1494         }
1495
1496         /* If EOP is set on the next entry, it's a new packet. Send it up. */
1497         while (1) {
1498                 struct hamachi_desc *desc = &(hmp->rx_ring[entry]);
1499                 u32 desc_status = le32_to_cpu(desc->status_n_length);
1500                 u16 data_size = desc_status;    /* Implicit truncate */
1501                 u8 *buf_addr;
1502                 s32 frame_status;
1503
1504                 if (desc_status & DescOwn)
1505                         break;
1506                 pci_dma_sync_single_for_cpu(hmp->pci_dev,
1507                                             desc->addr,
1508                                             hmp->rx_buf_sz,
1509                                             PCI_DMA_FROMDEVICE);
1510                 buf_addr = (u8 *) hmp->rx_skbuff[entry]->data;
1511                 frame_status = le32_to_cpu(get_unaligned((s32*)&(buf_addr[data_size - 12])));
1512                 if (hamachi_debug > 4)
1513                         printk(KERN_DEBUG "  hamachi_rx() status was %8.8x.\n",
1514                                 frame_status);
1515                 if (--boguscnt < 0)
1516                         break;
1517                 if ( ! (desc_status & DescEndPacket)) {
1518                         printk(KERN_WARNING "%s: Oversized Ethernet frame spanned "
1519                                    "multiple buffers, entry %#x length %d status %4.4x!\n",
1520                                    dev->name, hmp->cur_rx, data_size, desc_status);
1521                         printk(KERN_WARNING "%s: Oversized Ethernet frame %p vs %p.\n",
1522                                    dev->name, desc, &hmp->rx_ring[hmp->cur_rx % RX_RING_SIZE]);
1523                         printk(KERN_WARNING "%s: Oversized Ethernet frame -- next status %x/%x last status %x.\n",
1524                                    dev->name,
1525                                    hmp->rx_ring[(hmp->cur_rx+1) % RX_RING_SIZE].status_n_length & 0xffff0000,
1526                                    hmp->rx_ring[(hmp->cur_rx+1) % RX_RING_SIZE].status_n_length & 0x0000ffff,
1527                                    hmp->rx_ring[(hmp->cur_rx-1) % RX_RING_SIZE].status_n_length);
1528                         hmp->stats.rx_length_errors++;
1529                 } /* else  Omit for prototype errata??? */
1530                 if (frame_status & 0x00380000) {
1531                         /* There was an error. */
1532                         if (hamachi_debug > 2)
1533                                 printk(KERN_DEBUG "  hamachi_rx() Rx error was %8.8x.\n",
1534                                            frame_status);
1535                         hmp->stats.rx_errors++;
1536                         if (frame_status & 0x00600000) hmp->stats.rx_length_errors++;
1537                         if (frame_status & 0x00080000) hmp->stats.rx_frame_errors++;
1538                         if (frame_status & 0x00100000) hmp->stats.rx_crc_errors++;
1539                         if (frame_status < 0) hmp->stats.rx_dropped++;
1540                 } else {
1541                         struct sk_buff *skb;
1542                         /* Omit CRC */
1543                         u16 pkt_len = (frame_status & 0x07ff) - 4;
1544 #ifdef RX_CHECKSUM
1545                         u32 pfck = *(u32 *) &buf_addr[data_size - 8];
1546 #endif
1547
1548
1549 #ifndef final_version
1550                         if (hamachi_debug > 4)
1551                                 printk(KERN_DEBUG "  hamachi_rx() normal Rx pkt length %d"
1552                                            " of %d, bogus_cnt %d.\n",
1553                                            pkt_len, data_size, boguscnt);
1554                         if (hamachi_debug > 5)
1555                                 printk(KERN_DEBUG"%s:  rx status %8.8x %8.8x %8.8x %8.8x %8.8x.\n",
1556                                            dev->name,
1557                                            *(s32*)&(buf_addr[data_size - 20]),
1558                                            *(s32*)&(buf_addr[data_size - 16]),
1559                                            *(s32*)&(buf_addr[data_size - 12]),
1560                                            *(s32*)&(buf_addr[data_size - 8]),
1561                                            *(s32*)&(buf_addr[data_size - 4]));
1562 #endif
1563                         /* Check if the packet is long enough to accept without copying
1564                            to a minimally-sized skbuff. */
1565                         if (pkt_len < rx_copybreak
1566                                 && (skb = dev_alloc_skb(pkt_len + 2)) != NULL) {
1567 #ifdef RX_CHECKSUM
1568                                 printk(KERN_ERR "%s: rx_copybreak non-zero "
1569                                   "not good with RX_CHECKSUM\n", dev->name);
1570 #endif
1571                                 skb_reserve(skb, 2);    /* 16 byte align the IP header */
1572                                 pci_dma_sync_single_for_cpu(hmp->pci_dev,
1573                                                             hmp->rx_ring[entry].addr,
1574                                                             hmp->rx_buf_sz,
1575                                                             PCI_DMA_FROMDEVICE);
1576                                 /* Call copy + cksum if available. */
1577 #if 1 || USE_IP_COPYSUM
1578                                 skb_copy_to_linear_data(skb,
1579                                         hmp->rx_skbuff[entry]->data, pkt_len);
1580                                 skb_put(skb, pkt_len);
1581 #else
1582                                 memcpy(skb_put(skb, pkt_len), hmp->rx_ring_dma
1583                                         + entry*sizeof(*desc), pkt_len);
1584 #endif
1585                                 pci_dma_sync_single_for_device(hmp->pci_dev,
1586                                                                hmp->rx_ring[entry].addr,
1587                                                                hmp->rx_buf_sz,
1588                                                                PCI_DMA_FROMDEVICE);
1589                         } else {
1590                                 pci_unmap_single(hmp->pci_dev,
1591                                                  hmp->rx_ring[entry].addr,
1592                                                  hmp->rx_buf_sz, PCI_DMA_FROMDEVICE);
1593                                 skb_put(skb = hmp->rx_skbuff[entry], pkt_len);
1594                                 hmp->rx_skbuff[entry] = NULL;
1595                         }
1596                         skb->protocol = eth_type_trans(skb, dev);
1597
1598
1599 #ifdef RX_CHECKSUM
1600                         /* TCP or UDP on ipv4, DIX encoding */
1601                         if (pfck>>24 == 0x91 || pfck>>24 == 0x51) {
1602                                 struct iphdr *ih = (struct iphdr *) skb->data;
1603                                 /* Check that IP packet is at least 46 bytes, otherwise,
1604                                  * there may be pad bytes included in the hardware checksum.
1605                                  * This wouldn't happen if everyone padded with 0.
1606                                  */
1607                                 if (ntohs(ih->tot_len) >= 46){
1608                                         /* don't worry about frags */
1609                                         if (!(ih->frag_off & __constant_htons(IP_MF|IP_OFFSET))) {
1610                                                 u32 inv = *(u32 *) &buf_addr[data_size - 16];
1611                                                 u32 *p = (u32 *) &buf_addr[data_size - 20];
1612                                                 register u32 crc, p_r, p_r1;
1613
1614                                                 if (inv & 4) {
1615                                                         inv &= ~4;
1616                                                         --p;
1617                                                 }
1618                                                 p_r = *p;
1619                                                 p_r1 = *(p-1);
1620                                                 switch (inv) {
1621                                                         case 0:
1622                                                                 crc = (p_r & 0xffff) + (p_r >> 16);
1623                                                                 break;
1624                                                         case 1:
1625                                                                 crc = (p_r >> 16) + (p_r & 0xffff)
1626                                                                         + (p_r1 >> 16 & 0xff00);
1627                                                                 break;
1628                                                         case 2:
1629                                                                 crc = p_r + (p_r1 >> 16);
1630                                                                 break;
1631                                                         case 3:
1632                                                                 crc = p_r + (p_r1 & 0xff00) + (p_r1 >> 16);
1633                                                                 break;
1634                                                         default:        /*NOTREACHED*/ crc = 0;
1635                                                 }
1636                                                 if (crc & 0xffff0000) {
1637                                                         crc &= 0xffff;
1638                                                         ++crc;
1639                                                 }
1640                                                 /* tcp/udp will add in pseudo */
1641                                                 skb->csum = ntohs(pfck & 0xffff);
1642                                                 if (skb->csum > crc)
1643                                                         skb->csum -= crc;
1644                                                 else
1645                                                         skb->csum += (~crc & 0xffff);
1646                                                 /*
1647                                                 * could do the pseudo myself and return
1648                                                 * CHECKSUM_UNNECESSARY
1649                                                 */
1650                                                 skb->ip_summed = CHECKSUM_COMPLETE;
1651                                         }
1652                                 }
1653                         }
1654 #endif  /* RX_CHECKSUM */
1655
1656                         netif_rx(skb);
1657                         dev->last_rx = jiffies;
1658                         hmp->stats.rx_packets++;
1659                 }
1660                 entry = (++hmp->cur_rx) % RX_RING_SIZE;
1661         }
1662
1663         /* Refill the Rx ring buffers. */
1664         for (; hmp->cur_rx - hmp->dirty_rx > 0; hmp->dirty_rx++) {
1665                 struct hamachi_desc *desc;
1666
1667                 entry = hmp->dirty_rx % RX_RING_SIZE;
1668                 desc = &(hmp->rx_ring[entry]);
1669                 if (hmp->rx_skbuff[entry] == NULL) {
1670                         struct sk_buff *skb = dev_alloc_skb(hmp->rx_buf_sz);
1671
1672                         hmp->rx_skbuff[entry] = skb;
1673                         if (skb == NULL)
1674                                 break;          /* Better luck next round. */
1675                         skb->dev = dev;         /* Mark as being used by this device. */
1676                         skb_reserve(skb, 2);    /* Align IP on 16 byte boundaries */
1677                         desc->addr = cpu_to_leXX(pci_map_single(hmp->pci_dev,
1678                                 skb->data, hmp->rx_buf_sz, PCI_DMA_FROMDEVICE));
1679                 }
1680                 desc->status_n_length = cpu_to_le32(hmp->rx_buf_sz);
1681                 if (entry >= RX_RING_SIZE-1)
1682                         desc->status_n_length |= cpu_to_le32(DescOwn |
1683                                 DescEndPacket | DescEndRing | DescIntr);
1684                 else
1685                         desc->status_n_length |= cpu_to_le32(DescOwn |
1686                                 DescEndPacket | DescIntr);
1687         }
1688
1689         /* Restart Rx engine if stopped. */
1690         /* If we don't need to check status, don't. -KDU */
1691         if (readw(hmp->base + RxStatus) & 0x0002)
1692                 writew(0x0001, hmp->base + RxCmd);
1693
1694         return 0;
1695 }
1696
1697 /* This is more properly named "uncommon interrupt events", as it covers more
1698    than just errors. */
1699 static void hamachi_error(struct net_device *dev, int intr_status)
1700 {
1701         struct hamachi_private *hmp = netdev_priv(dev);
1702         void __iomem *ioaddr = hmp->base;
1703
1704         if (intr_status & (LinkChange|NegotiationChange)) {
1705                 if (hamachi_debug > 1)
1706                         printk(KERN_INFO "%s: Link changed: AutoNegotiation Ctrl"
1707                                    " %4.4x, Status %4.4x %4.4x Intr status %4.4x.\n",
1708                                    dev->name, readw(ioaddr + 0x0E0), readw(ioaddr + 0x0E2),
1709                                    readw(ioaddr + ANLinkPartnerAbility),
1710                                    readl(ioaddr + IntrStatus));
1711                 if (readw(ioaddr + ANStatus) & 0x20)
1712                         writeb(0x01, ioaddr + LEDCtrl);
1713                 else
1714                         writeb(0x03, ioaddr + LEDCtrl);
1715         }
1716         if (intr_status & StatsMax) {
1717                 hamachi_get_stats(dev);
1718                 /* Read the overflow bits to clear. */
1719                 readl(ioaddr + 0x370);
1720                 readl(ioaddr + 0x3F0);
1721         }
1722         if ((intr_status & ~(LinkChange|StatsMax|NegotiationChange|IntrRxDone|IntrTxDone))
1723                 && hamachi_debug)
1724                 printk(KERN_ERR "%s: Something Wicked happened! %4.4x.\n",
1725                            dev->name, intr_status);
1726         /* Hmmmmm, it's not clear how to recover from PCI faults. */
1727         if (intr_status & (IntrTxPCIErr | IntrTxPCIFault))
1728                 hmp->stats.tx_fifo_errors++;
1729         if (intr_status & (IntrRxPCIErr | IntrRxPCIFault))
1730                 hmp->stats.rx_fifo_errors++;
1731 }
1732
1733 static int hamachi_close(struct net_device *dev)
1734 {
1735         struct hamachi_private *hmp = netdev_priv(dev);
1736         void __iomem *ioaddr = hmp->base;
1737         struct sk_buff *skb;
1738         int i;
1739
1740         netif_stop_queue(dev);
1741
1742         if (hamachi_debug > 1) {
1743                 printk(KERN_DEBUG "%s: Shutting down ethercard, status was Tx %4.4x Rx %4.4x Int %2.2x.\n",
1744                            dev->name, readw(ioaddr + TxStatus),
1745                            readw(ioaddr + RxStatus), readl(ioaddr + IntrStatus));
1746                 printk(KERN_DEBUG "%s: Queue pointers were Tx %d / %d,  Rx %d / %d.\n",
1747                            dev->name, hmp->cur_tx, hmp->dirty_tx, hmp->cur_rx, hmp->dirty_rx);
1748         }
1749
1750         /* Disable interrupts by clearing the interrupt mask. */
1751         writel(0x0000, ioaddr + InterruptEnable);
1752
1753         /* Stop the chip's Tx and Rx processes. */
1754         writel(2, ioaddr + RxCmd);
1755         writew(2, ioaddr + TxCmd);
1756
1757 #ifdef __i386__
1758         if (hamachi_debug > 2) {
1759                 printk("\n"KERN_DEBUG"  Tx ring at %8.8x:\n",
1760                            (int)hmp->tx_ring_dma);
1761                 for (i = 0; i < TX_RING_SIZE; i++)
1762                         printk(" %c #%d desc. %8.8x %8.8x.\n",
1763                                    readl(ioaddr + TxCurPtr) == (long)&hmp->tx_ring[i] ? '>' : ' ',
1764                                    i, hmp->tx_ring[i].status_n_length, hmp->tx_ring[i].addr);
1765                 printk("\n"KERN_DEBUG "  Rx ring %8.8x:\n",
1766                            (int)hmp->rx_ring_dma);
1767                 for (i = 0; i < RX_RING_SIZE; i++) {
1768                         printk(KERN_DEBUG " %c #%d desc. %4.4x %8.8x\n",
1769                                    readl(ioaddr + RxCurPtr) == (long)&hmp->rx_ring[i] ? '>' : ' ',
1770                                    i, hmp->rx_ring[i].status_n_length, hmp->rx_ring[i].addr);
1771                         if (hamachi_debug > 6) {
1772                                 if (*(u8*)hmp->rx_skbuff[i]->data != 0x69) {
1773                                         u16 *addr = (u16 *)
1774                                                 hmp->rx_skbuff[i]->data;
1775                                         int j;
1776
1777                                         for (j = 0; j < 0x50; j++)
1778                                                 printk(" %4.4x", addr[j]);
1779                                         printk("\n");
1780                                 }
1781                         }
1782                 }
1783         }
1784 #endif /* __i386__ debugging only */
1785
1786         free_irq(dev->irq, dev);
1787
1788         del_timer_sync(&hmp->timer);
1789
1790         /* Free all the skbuffs in the Rx queue. */
1791         for (i = 0; i < RX_RING_SIZE; i++) {
1792                 skb = hmp->rx_skbuff[i];
1793                 hmp->rx_ring[i].status_n_length = 0;
1794                 hmp->rx_ring[i].addr = 0xBADF00D0; /* An invalid address. */
1795                 if (skb) {
1796                         pci_unmap_single(hmp->pci_dev,
1797                                 hmp->rx_ring[i].addr, hmp->rx_buf_sz,
1798                                 PCI_DMA_FROMDEVICE);
1799                         dev_kfree_skb(skb);
1800                         hmp->rx_skbuff[i] = NULL;
1801                 }
1802         }
1803         for (i = 0; i < TX_RING_SIZE; i++) {
1804                 skb = hmp->tx_skbuff[i];
1805                 if (skb) {
1806                         pci_unmap_single(hmp->pci_dev,
1807                                 hmp->tx_ring[i].addr, skb->len,
1808                                 PCI_DMA_TODEVICE);
1809                         dev_kfree_skb(skb);
1810                         hmp->tx_skbuff[i] = NULL;
1811                 }
1812         }
1813
1814         writeb(0x00, ioaddr + LEDCtrl);
1815
1816         return 0;
1817 }
1818
1819 static struct net_device_stats *hamachi_get_stats(struct net_device *dev)
1820 {
1821         struct hamachi_private *hmp = netdev_priv(dev);
1822         void __iomem *ioaddr = hmp->base;
1823
1824         /* We should lock this segment of code for SMP eventually, although
1825            the vulnerability window is very small and statistics are
1826            non-critical. */
1827         /* Ok, what goes here?  This appears to be stuck at 21 packets
1828            according to ifconfig.  It does get incremented in hamachi_tx(),
1829            so I think I'll comment it out here and see if better things
1830            happen.
1831         */
1832         /* hmp->stats.tx_packets        = readl(ioaddr + 0x000); */
1833
1834         hmp->stats.rx_bytes = readl(ioaddr + 0x330); /* Total Uni+Brd+Multi */
1835         hmp->stats.tx_bytes = readl(ioaddr + 0x3B0); /* Total Uni+Brd+Multi */
1836         hmp->stats.multicast            = readl(ioaddr + 0x320); /* Multicast Rx */
1837
1838         hmp->stats.rx_length_errors     = readl(ioaddr + 0x368); /* Over+Undersized */
1839         hmp->stats.rx_over_errors       = readl(ioaddr + 0x35C); /* Jabber */
1840         hmp->stats.rx_crc_errors        = readl(ioaddr + 0x360); /* Jabber */
1841         hmp->stats.rx_frame_errors      = readl(ioaddr + 0x364); /* Symbol Errs */
1842         hmp->stats.rx_missed_errors     = readl(ioaddr + 0x36C); /* Dropped */
1843
1844         return &hmp->stats;
1845 }
1846
1847 static void set_rx_mode(struct net_device *dev)
1848 {
1849         struct hamachi_private *hmp = netdev_priv(dev);
1850         void __iomem *ioaddr = hmp->base;
1851
1852         if (dev->flags & IFF_PROMISC) {                 /* Set promiscuous. */
1853                 writew(0x000F, ioaddr + AddrMode);
1854         } else if ((dev->mc_count > 63)  ||  (dev->flags & IFF_ALLMULTI)) {
1855                 /* Too many to match, or accept all multicasts. */
1856                 writew(0x000B, ioaddr + AddrMode);
1857         } else if (dev->mc_count > 0) { /* Must use the CAM filter. */
1858                 struct dev_mc_list *mclist;
1859                 int i;
1860                 for (i = 0, mclist = dev->mc_list; mclist && i < dev->mc_count;
1861                          i++, mclist = mclist->next) {
1862                         writel(*(u32*)(mclist->dmi_addr), ioaddr + 0x100 + i*8);
1863                         writel(0x20000 | (*(u16*)&mclist->dmi_addr[4]),
1864                                    ioaddr + 0x104 + i*8);
1865                 }
1866                 /* Clear remaining entries. */
1867                 for (; i < 64; i++)
1868                         writel(0, ioaddr + 0x104 + i*8);
1869                 writew(0x0003, ioaddr + AddrMode);
1870         } else {                                        /* Normal, unicast/broadcast-only mode. */
1871                 writew(0x0001, ioaddr + AddrMode);
1872         }
1873 }
1874
1875 static int check_if_running(struct net_device *dev)
1876 {
1877         if (!netif_running(dev))
1878                 return -EINVAL;
1879         return 0;
1880 }
1881
1882 static void hamachi_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info)
1883 {
1884         struct hamachi_private *np = netdev_priv(dev);
1885         strcpy(info->driver, DRV_NAME);
1886         strcpy(info->version, DRV_VERSION);
1887         strcpy(info->bus_info, pci_name(np->pci_dev));
1888 }
1889
1890 static int hamachi_get_settings(struct net_device *dev, struct ethtool_cmd *ecmd)
1891 {
1892         struct hamachi_private *np = netdev_priv(dev);
1893         spin_lock_irq(&np->lock);
1894         mii_ethtool_gset(&np->mii_if, ecmd);
1895         spin_unlock_irq(&np->lock);
1896         return 0;
1897 }
1898
1899 static int hamachi_set_settings(struct net_device *dev, struct ethtool_cmd *ecmd)
1900 {
1901         struct hamachi_private *np = netdev_priv(dev);
1902         int res;
1903         spin_lock_irq(&np->lock);
1904         res = mii_ethtool_sset(&np->mii_if, ecmd);
1905         spin_unlock_irq(&np->lock);
1906         return res;
1907 }
1908
1909 static int hamachi_nway_reset(struct net_device *dev)
1910 {
1911         struct hamachi_private *np = netdev_priv(dev);
1912         return mii_nway_restart(&np->mii_if);
1913 }
1914
1915 static u32 hamachi_get_link(struct net_device *dev)
1916 {
1917         struct hamachi_private *np = netdev_priv(dev);
1918         return mii_link_ok(&np->mii_if);
1919 }
1920
1921 static const struct ethtool_ops ethtool_ops = {
1922         .begin = check_if_running,
1923         .get_drvinfo = hamachi_get_drvinfo,
1924         .get_settings = hamachi_get_settings,
1925         .set_settings = hamachi_set_settings,
1926         .nway_reset = hamachi_nway_reset,
1927         .get_link = hamachi_get_link,
1928 };
1929
1930 static const struct ethtool_ops ethtool_ops_no_mii = {
1931         .begin = check_if_running,
1932         .get_drvinfo = hamachi_get_drvinfo,
1933 };
1934
1935 static int netdev_ioctl(struct net_device *dev, struct ifreq *rq, int cmd)
1936 {
1937         struct hamachi_private *np = netdev_priv(dev);
1938         struct mii_ioctl_data *data = if_mii(rq);
1939         int rc;
1940
1941         if (!netif_running(dev))
1942                 return -EINVAL;
1943
1944         if (cmd == (SIOCDEVPRIVATE+3)) { /* set rx,tx intr params */
1945                 u32 *d = (u32 *)&rq->ifr_ifru;
1946                 /* Should add this check here or an ordinary user can do nasty
1947                  * things. -KDU
1948                  *
1949                  * TODO: Shut down the Rx and Tx engines while doing this.
1950                  */
1951                 if (!capable(CAP_NET_ADMIN))
1952                         return -EPERM;
1953                 writel(d[0], np->base + TxIntrCtrl);
1954                 writel(d[1], np->base + RxIntrCtrl);
1955                 printk(KERN_NOTICE "%s: tx %08x, rx %08x intr\n", dev->name,
1956                   (u32) readl(np->base + TxIntrCtrl),
1957                   (u32) readl(np->base + RxIntrCtrl));
1958                 rc = 0;
1959         }
1960
1961         else {
1962                 spin_lock_irq(&np->lock);
1963                 rc = generic_mii_ioctl(&np->mii_if, data, cmd, NULL);
1964                 spin_unlock_irq(&np->lock);
1965         }
1966
1967         return rc;
1968 }
1969
1970
1971 static void __devexit hamachi_remove_one (struct pci_dev *pdev)
1972 {
1973         struct net_device *dev = pci_get_drvdata(pdev);
1974
1975         if (dev) {
1976                 struct hamachi_private *hmp = netdev_priv(dev);
1977
1978                 pci_free_consistent(pdev, RX_TOTAL_SIZE, hmp->rx_ring,
1979                         hmp->rx_ring_dma);
1980                 pci_free_consistent(pdev, TX_TOTAL_SIZE, hmp->tx_ring,
1981                         hmp->tx_ring_dma);
1982                 unregister_netdev(dev);
1983                 iounmap(hmp->base);
1984                 free_netdev(dev);
1985                 pci_release_regions(pdev);
1986                 pci_set_drvdata(pdev, NULL);
1987         }
1988 }
1989
1990 static struct pci_device_id hamachi_pci_tbl[] = {
1991         { 0x1318, 0x0911, PCI_ANY_ID, PCI_ANY_ID, },
1992         { 0, }
1993 };
1994 MODULE_DEVICE_TABLE(pci, hamachi_pci_tbl);
1995
1996 static struct pci_driver hamachi_driver = {
1997         .name           = DRV_NAME,
1998         .id_table       = hamachi_pci_tbl,
1999         .probe          = hamachi_init_one,
2000         .remove         = __devexit_p(hamachi_remove_one),
2001 };
2002
2003 static int __init hamachi_init (void)
2004 {
2005 /* when a module, this is printed whether or not devices are found in probe */
2006 #ifdef MODULE
2007         printk(version);
2008 #endif
2009         return pci_register_driver(&hamachi_driver);
2010 }
2011
2012 static void __exit hamachi_exit (void)
2013 {
2014         pci_unregister_driver(&hamachi_driver);
2015 }
2016
2017
2018 module_init(hamachi_init);
2019 module_exit(hamachi_exit);