b43: Add firmware information to modinfo
[linux-2.6/sactl.git] / drivers / net / atarilance.c
blobb74dbeef805018f2d64f246130239f147fce8191
1 /* atarilance.c: Ethernet driver for VME Lance cards on the Atari */
2 /*
3 Written 1995/96 by Roman Hodek (Roman.Hodek@informatik.uni-erlangen.de)
5 This software may be used and distributed according to the terms
6 of the GNU General Public License, incorporated herein by reference.
8 This drivers was written with the following sources of reference:
9 - The driver for the Riebl Lance card by the TU Vienna.
10 - The modified TUW driver for PAM's VME cards
11 - The PC-Linux driver for Lance cards (but this is for bus master
12 cards, not the shared memory ones)
13 - The Amiga Ariadne driver
15 v1.0: (in 1.2.13pl4/0.9.13)
16 Initial version
17 v1.1: (in 1.2.13pl5)
18 more comments
19 deleted some debugging stuff
20 optimized register access (keep AREG pointing to CSR0)
21 following AMD, CSR0_STRT should be set only after IDON is detected
22 use memcpy() for data transfers, that also employs long word moves
23 better probe procedure for 24-bit systems
24 non-VME-RieblCards need extra delays in memcpy
25 must also do write test, since 0xfxe00000 may hit ROM
26 use 8/32 tx/rx buffers, which should give better NFS performance;
27 this is made possible by shifting the last packet buffer after the
28 RieblCard reserved area
29 v1.2: (in 1.2.13pl8)
30 again fixed probing for the Falcon; 0xfe01000 hits phys. 0x00010000
31 and thus RAM, in case of no Lance found all memory contents have to
32 be restored!
33 Now possible to compile as module.
34 v1.3: 03/30/96 Jes Sorensen, Roman (in 1.3)
35 Several little 1.3 adaptions
36 When the lance is stopped it jumps back into little-endian
37 mode. It is therefore necessary to put it back where it
38 belongs, in big endian mode, in order to make things work.
39 This might be the reason why multicast-mode didn't work
40 before, but I'm not able to test it as I only got an Amiga
41 (we had similar problems with the A2065 driver).
45 static char version[] = "atarilance.c: v1.3 04/04/96 "
46 "Roman.Hodek@informatik.uni-erlangen.de\n";
48 #include <linux/netdevice.h>
49 #include <linux/etherdevice.h>
50 #include <linux/module.h>
51 #include <linux/stddef.h>
52 #include <linux/kernel.h>
53 #include <linux/string.h>
54 #include <linux/errno.h>
55 #include <linux/skbuff.h>
56 #include <linux/slab.h>
57 #include <linux/interrupt.h>
58 #include <linux/init.h>
59 #include <linux/bitops.h>
61 #include <asm/setup.h>
62 #include <asm/irq.h>
63 #include <asm/atarihw.h>
64 #include <asm/atariints.h>
65 #include <asm/io.h>
67 /* Debug level:
68 * 0 = silent, print only serious errors
69 * 1 = normal, print error messages
70 * 2 = debug, print debug infos
71 * 3 = debug, print even more debug infos (packet data)
74 #define LANCE_DEBUG 1
76 #ifdef LANCE_DEBUG
77 static int lance_debug = LANCE_DEBUG;
78 #else
79 static int lance_debug = 1;
80 #endif
81 module_param(lance_debug, int, 0);
82 MODULE_PARM_DESC(lance_debug, "atarilance debug level (0-3)");
83 MODULE_LICENSE("GPL");
85 /* Print debug messages on probing? */
86 #undef LANCE_DEBUG_PROBE
88 #define DPRINTK(n,a) \
89 do { \
90 if (lance_debug >= n) \
91 printk a; \
92 } while( 0 )
94 #ifdef LANCE_DEBUG_PROBE
95 # define PROBE_PRINT(a) printk a
96 #else
97 # define PROBE_PRINT(a)
98 #endif
100 /* These define the number of Rx and Tx buffers as log2. (Only powers
101 * of two are valid)
102 * Much more rx buffers (32) are reserved than tx buffers (8), since receiving
103 * is more time critical then sending and packets may have to remain in the
104 * board's memory when main memory is low.
107 #define TX_LOG_RING_SIZE 3
108 #define RX_LOG_RING_SIZE 5
110 /* These are the derived values */
112 #define TX_RING_SIZE (1 << TX_LOG_RING_SIZE)
113 #define TX_RING_LEN_BITS (TX_LOG_RING_SIZE << 5)
114 #define TX_RING_MOD_MASK (TX_RING_SIZE - 1)
116 #define RX_RING_SIZE (1 << RX_LOG_RING_SIZE)
117 #define RX_RING_LEN_BITS (RX_LOG_RING_SIZE << 5)
118 #define RX_RING_MOD_MASK (RX_RING_SIZE - 1)
120 #define TX_TIMEOUT 20
122 /* The LANCE Rx and Tx ring descriptors. */
123 struct lance_rx_head {
124 unsigned short base; /* Low word of base addr */
125 volatile unsigned char flag;
126 unsigned char base_hi; /* High word of base addr (unused) */
127 short buf_length; /* This length is 2s complement! */
128 volatile short msg_length; /* This length is "normal". */
131 struct lance_tx_head {
132 unsigned short base; /* Low word of base addr */
133 volatile unsigned char flag;
134 unsigned char base_hi; /* High word of base addr (unused) */
135 short length; /* Length is 2s complement! */
136 volatile short misc;
139 struct ringdesc {
140 unsigned short adr_lo; /* Low 16 bits of address */
141 unsigned char len; /* Length bits */
142 unsigned char adr_hi; /* High 8 bits of address (unused) */
145 /* The LANCE initialization block, described in databook. */
146 struct lance_init_block {
147 unsigned short mode; /* Pre-set mode */
148 unsigned char hwaddr[6]; /* Physical ethernet address */
149 unsigned filter[2]; /* Multicast filter (unused). */
150 /* Receive and transmit ring base, along with length bits. */
151 struct ringdesc rx_ring;
152 struct ringdesc tx_ring;
155 /* The whole layout of the Lance shared memory */
156 struct lance_memory {
157 struct lance_init_block init;
158 struct lance_tx_head tx_head[TX_RING_SIZE];
159 struct lance_rx_head rx_head[RX_RING_SIZE];
160 char packet_area[0]; /* packet data follow after the
161 * init block and the ring
162 * descriptors and are located
163 * at runtime */
166 /* RieblCard specifics:
167 * The original TOS driver for these cards reserves the area from offset
168 * 0xee70 to 0xeebb for storing configuration data. Of interest to us is the
169 * Ethernet address there, and the magic for verifying the data's validity.
170 * The reserved area isn't touch by packet buffers. Furthermore, offset 0xfffe
171 * is reserved for the interrupt vector number.
173 #define RIEBL_RSVD_START 0xee70
174 #define RIEBL_RSVD_END 0xeec0
175 #define RIEBL_MAGIC 0x09051990
176 #define RIEBL_MAGIC_ADDR ((unsigned long *)(((char *)MEM) + 0xee8a))
177 #define RIEBL_HWADDR_ADDR ((unsigned char *)(((char *)MEM) + 0xee8e))
178 #define RIEBL_IVEC_ADDR ((unsigned short *)(((char *)MEM) + 0xfffe))
180 /* This is a default address for the old RieblCards without a battery
181 * that have no ethernet address at boot time. 00:00:36:04 is the
182 * prefix for Riebl cards, the 00:00 at the end is arbitrary.
185 static unsigned char OldRieblDefHwaddr[6] = {
186 0x00, 0x00, 0x36, 0x04, 0x00, 0x00
190 /* I/O registers of the Lance chip */
192 struct lance_ioreg {
193 /* base+0x0 */ volatile unsigned short data;
194 /* base+0x2 */ volatile unsigned short addr;
195 unsigned char _dummy1[3];
196 /* base+0x7 */ volatile unsigned char ivec;
197 unsigned char _dummy2[5];
198 /* base+0xd */ volatile unsigned char eeprom;
199 unsigned char _dummy3;
200 /* base+0xf */ volatile unsigned char mem;
203 /* Types of boards this driver supports */
205 enum lance_type {
206 OLD_RIEBL, /* old Riebl card without battery */
207 NEW_RIEBL, /* new Riebl card with battery */
208 PAM_CARD /* PAM card with EEPROM */
211 static char *lance_names[] = {
212 "Riebl-Card (without battery)",
213 "Riebl-Card (with battery)",
214 "PAM intern card"
217 /* The driver's private device structure */
219 struct lance_private {
220 enum lance_type cardtype;
221 struct lance_ioreg *iobase;
222 struct lance_memory *mem;
223 int cur_rx, cur_tx; /* The next free ring entry */
224 int dirty_tx; /* Ring entries to be freed. */
225 /* copy function */
226 void *(*memcpy_f)( void *, const void *, size_t );
227 /* This must be long for set_bit() */
228 long tx_full;
229 spinlock_t devlock;
232 /* I/O register access macros */
234 #define MEM lp->mem
235 #define DREG IO->data
236 #define AREG IO->addr
237 #define REGA(a) (*( AREG = (a), &DREG ))
239 /* Definitions for packet buffer access: */
240 #define PKT_BUF_SZ 1544
241 /* Get the address of a packet buffer corresponding to a given buffer head */
242 #define PKTBUF_ADDR(head) (((unsigned char *)(MEM)) + (head)->base)
244 /* Possible memory/IO addresses for probing */
246 struct lance_addr {
247 unsigned long memaddr;
248 unsigned long ioaddr;
249 int slow_flag;
250 } lance_addr_list[] = {
251 { 0xfe010000, 0xfe00fff0, 0 }, /* RieblCard VME in TT */
252 { 0xffc10000, 0xffc0fff0, 0 }, /* RieblCard VME in MegaSTE
253 (highest byte stripped) */
254 { 0xffe00000, 0xffff7000, 1 }, /* RieblCard in ST
255 (highest byte stripped) */
256 { 0xffd00000, 0xffff7000, 1 }, /* RieblCard in ST with hw modif. to
257 avoid conflict with ROM
258 (highest byte stripped) */
259 { 0xffcf0000, 0xffcffff0, 0 }, /* PAMCard VME in TT and MSTE
260 (highest byte stripped) */
261 { 0xfecf0000, 0xfecffff0, 0 }, /* Rhotron's PAMCard VME in TT and MSTE
262 (highest byte stripped) */
265 #define N_LANCE_ADDR ARRAY_SIZE(lance_addr_list)
268 /* Definitions for the Lance */
270 /* tx_head flags */
271 #define TMD1_ENP 0x01 /* end of packet */
272 #define TMD1_STP 0x02 /* start of packet */
273 #define TMD1_DEF 0x04 /* deferred */
274 #define TMD1_ONE 0x08 /* one retry needed */
275 #define TMD1_MORE 0x10 /* more than one retry needed */
276 #define TMD1_ERR 0x40 /* error summary */
277 #define TMD1_OWN 0x80 /* ownership (set: chip owns) */
279 #define TMD1_OWN_CHIP TMD1_OWN
280 #define TMD1_OWN_HOST 0
282 /* tx_head misc field */
283 #define TMD3_TDR 0x03FF /* Time Domain Reflectometry counter */
284 #define TMD3_RTRY 0x0400 /* failed after 16 retries */
285 #define TMD3_LCAR 0x0800 /* carrier lost */
286 #define TMD3_LCOL 0x1000 /* late collision */
287 #define TMD3_UFLO 0x4000 /* underflow (late memory) */
288 #define TMD3_BUFF 0x8000 /* buffering error (no ENP) */
290 /* rx_head flags */
291 #define RMD1_ENP 0x01 /* end of packet */
292 #define RMD1_STP 0x02 /* start of packet */
293 #define RMD1_BUFF 0x04 /* buffer error */
294 #define RMD1_CRC 0x08 /* CRC error */
295 #define RMD1_OFLO 0x10 /* overflow */
296 #define RMD1_FRAM 0x20 /* framing error */
297 #define RMD1_ERR 0x40 /* error summary */
298 #define RMD1_OWN 0x80 /* ownership (set: ship owns) */
300 #define RMD1_OWN_CHIP RMD1_OWN
301 #define RMD1_OWN_HOST 0
303 /* register names */
304 #define CSR0 0 /* mode/status */
305 #define CSR1 1 /* init block addr (low) */
306 #define CSR2 2 /* init block addr (high) */
307 #define CSR3 3 /* misc */
308 #define CSR8 8 /* address filter */
309 #define CSR15 15 /* promiscuous mode */
311 /* CSR0 */
312 /* (R=readable, W=writeable, S=set on write, C=clear on write) */
313 #define CSR0_INIT 0x0001 /* initialize (RS) */
314 #define CSR0_STRT 0x0002 /* start (RS) */
315 #define CSR0_STOP 0x0004 /* stop (RS) */
316 #define CSR0_TDMD 0x0008 /* transmit demand (RS) */
317 #define CSR0_TXON 0x0010 /* transmitter on (R) */
318 #define CSR0_RXON 0x0020 /* receiver on (R) */
319 #define CSR0_INEA 0x0040 /* interrupt enable (RW) */
320 #define CSR0_INTR 0x0080 /* interrupt active (R) */
321 #define CSR0_IDON 0x0100 /* initialization done (RC) */
322 #define CSR0_TINT 0x0200 /* transmitter interrupt (RC) */
323 #define CSR0_RINT 0x0400 /* receiver interrupt (RC) */
324 #define CSR0_MERR 0x0800 /* memory error (RC) */
325 #define CSR0_MISS 0x1000 /* missed frame (RC) */
326 #define CSR0_CERR 0x2000 /* carrier error (no heartbeat :-) (RC) */
327 #define CSR0_BABL 0x4000 /* babble: tx-ed too many bits (RC) */
328 #define CSR0_ERR 0x8000 /* error (RC) */
330 /* CSR3 */
331 #define CSR3_BCON 0x0001 /* byte control */
332 #define CSR3_ACON 0x0002 /* ALE control */
333 #define CSR3_BSWP 0x0004 /* byte swap (1=big endian) */
337 /***************************** Prototypes *****************************/
339 static int addr_accessible( volatile void *regp, int wordflag, int
340 writeflag );
341 static unsigned long lance_probe1( struct net_device *dev, struct lance_addr
342 *init_rec );
343 static int lance_open( struct net_device *dev );
344 static void lance_init_ring( struct net_device *dev );
345 static int lance_start_xmit( struct sk_buff *skb, struct net_device *dev );
346 static irqreturn_t lance_interrupt( int irq, void *dev_id );
347 static int lance_rx( struct net_device *dev );
348 static int lance_close( struct net_device *dev );
349 static void set_multicast_list( struct net_device *dev );
350 static int lance_set_mac_address( struct net_device *dev, void *addr );
351 static void lance_tx_timeout (struct net_device *dev);
353 /************************* End of Prototypes **************************/
359 static void *slow_memcpy( void *dst, const void *src, size_t len )
361 { char *cto = dst;
362 const char *cfrom = src;
364 while( len-- ) {
365 *cto++ = *cfrom++;
366 MFPDELAY();
368 return( dst );
372 struct net_device * __init atarilance_probe(int unit)
374 int i;
375 static int found;
376 struct net_device *dev;
377 int err = -ENODEV;
379 if (!MACH_IS_ATARI || found)
380 /* Assume there's only one board possible... That seems true, since
381 * the Riebl/PAM board's address cannot be changed. */
382 return ERR_PTR(-ENODEV);
384 dev = alloc_etherdev(sizeof(struct lance_private));
385 if (!dev)
386 return ERR_PTR(-ENOMEM);
387 if (unit >= 0) {
388 sprintf(dev->name, "eth%d", unit);
389 netdev_boot_setup_check(dev);
392 for( i = 0; i < N_LANCE_ADDR; ++i ) {
393 if (lance_probe1( dev, &lance_addr_list[i] )) {
394 found = 1;
395 err = register_netdev(dev);
396 if (!err)
397 return dev;
398 free_irq(dev->irq, dev);
399 break;
402 free_netdev(dev);
403 return ERR_PTR(err);
407 /* Derived from hwreg_present() in atari/config.c: */
409 static int __init addr_accessible( volatile void *regp, int wordflag, int writeflag )
411 int ret;
412 long flags;
413 long *vbr, save_berr;
415 local_irq_save(flags);
417 __asm__ __volatile__ ( "movec %/vbr,%0" : "=r" (vbr) : );
418 save_berr = vbr[2];
420 __asm__ __volatile__
421 ( "movel %/sp,%/d1\n\t"
422 "movel #Lberr,%2@\n\t"
423 "moveq #0,%0\n\t"
424 "tstl %3\n\t"
425 "bne 1f\n\t"
426 "moveb %1@,%/d0\n\t"
427 "nop \n\t"
428 "bra 2f\n"
429 "1: movew %1@,%/d0\n\t"
430 "nop \n"
431 "2: tstl %4\n\t"
432 "beq 2f\n\t"
433 "tstl %3\n\t"
434 "bne 1f\n\t"
435 "clrb %1@\n\t"
436 "nop \n\t"
437 "moveb %/d0,%1@\n\t"
438 "nop \n\t"
439 "bra 2f\n"
440 "1: clrw %1@\n\t"
441 "nop \n\t"
442 "movew %/d0,%1@\n\t"
443 "nop \n"
444 "2: moveq #1,%0\n"
445 "Lberr: movel %/d1,%/sp"
446 : "=&d" (ret)
447 : "a" (regp), "a" (&vbr[2]), "rm" (wordflag), "rm" (writeflag)
448 : "d0", "d1", "memory"
451 vbr[2] = save_berr;
452 local_irq_restore(flags);
454 return( ret );
458 static unsigned long __init lance_probe1( struct net_device *dev,
459 struct lance_addr *init_rec )
461 volatile unsigned short *memaddr =
462 (volatile unsigned short *)init_rec->memaddr;
463 volatile unsigned short *ioaddr =
464 (volatile unsigned short *)init_rec->ioaddr;
465 struct lance_private *lp;
466 struct lance_ioreg *IO;
467 int i;
468 static int did_version;
469 unsigned short save1, save2;
470 DECLARE_MAC_BUF(mac);
472 PROBE_PRINT(( "Probing for Lance card at mem %#lx io %#lx\n",
473 (long)memaddr, (long)ioaddr ));
475 /* Test whether memory readable and writable */
476 PROBE_PRINT(( "lance_probe1: testing memory to be accessible\n" ));
477 if (!addr_accessible( memaddr, 1, 1 )) goto probe_fail;
479 /* Written values should come back... */
480 PROBE_PRINT(( "lance_probe1: testing memory to be writable (1)\n" ));
481 save1 = *memaddr;
482 *memaddr = 0x0001;
483 if (*memaddr != 0x0001) goto probe_fail;
484 PROBE_PRINT(( "lance_probe1: testing memory to be writable (2)\n" ));
485 *memaddr = 0x0000;
486 if (*memaddr != 0x0000) goto probe_fail;
487 *memaddr = save1;
489 /* First port should be readable and writable */
490 PROBE_PRINT(( "lance_probe1: testing ioport to be accessible\n" ));
491 if (!addr_accessible( ioaddr, 1, 1 )) goto probe_fail;
493 /* and written values should be readable */
494 PROBE_PRINT(( "lance_probe1: testing ioport to be writeable\n" ));
495 save2 = ioaddr[1];
496 ioaddr[1] = 0x0001;
497 if (ioaddr[1] != 0x0001) goto probe_fail;
499 /* The CSR0_INIT bit should not be readable */
500 PROBE_PRINT(( "lance_probe1: testing CSR0 register function (1)\n" ));
501 save1 = ioaddr[0];
502 ioaddr[1] = CSR0;
503 ioaddr[0] = CSR0_INIT | CSR0_STOP;
504 if (ioaddr[0] != CSR0_STOP) {
505 ioaddr[0] = save1;
506 ioaddr[1] = save2;
507 goto probe_fail;
509 PROBE_PRINT(( "lance_probe1: testing CSR0 register function (2)\n" ));
510 ioaddr[0] = CSR0_STOP;
511 if (ioaddr[0] != CSR0_STOP) {
512 ioaddr[0] = save1;
513 ioaddr[1] = save2;
514 goto probe_fail;
517 /* Now ok... */
518 PROBE_PRINT(( "lance_probe1: Lance card detected\n" ));
519 goto probe_ok;
521 probe_fail:
522 return( 0 );
524 probe_ok:
525 lp = (struct lance_private *)dev->priv;
526 MEM = (struct lance_memory *)memaddr;
527 IO = lp->iobase = (struct lance_ioreg *)ioaddr;
528 dev->base_addr = (unsigned long)ioaddr; /* informational only */
529 lp->memcpy_f = init_rec->slow_flag ? slow_memcpy : memcpy;
531 REGA( CSR0 ) = CSR0_STOP;
533 /* Now test for type: If the eeprom I/O port is readable, it is a
534 * PAM card */
535 if (addr_accessible( &(IO->eeprom), 0, 0 )) {
536 /* Switch back to Ram */
537 i = IO->mem;
538 lp->cardtype = PAM_CARD;
540 else if (*RIEBL_MAGIC_ADDR == RIEBL_MAGIC) {
541 lp->cardtype = NEW_RIEBL;
543 else
544 lp->cardtype = OLD_RIEBL;
546 if (lp->cardtype == PAM_CARD ||
547 memaddr == (unsigned short *)0xffe00000) {
548 /* PAMs card and Riebl on ST use level 5 autovector */
549 if (request_irq(IRQ_AUTO_5, lance_interrupt, IRQ_TYPE_PRIO,
550 "PAM/Riebl-ST Ethernet", dev)) {
551 printk( "Lance: request for irq %d failed\n", IRQ_AUTO_5 );
552 return( 0 );
554 dev->irq = (unsigned short)IRQ_AUTO_5;
556 else {
557 /* For VME-RieblCards, request a free VME int;
558 * (This must be unsigned long, since dev->irq is short and the
559 * IRQ_MACHSPEC bit would be cut off...)
561 unsigned long irq = atari_register_vme_int();
562 if (!irq) {
563 printk( "Lance: request for VME interrupt failed\n" );
564 return( 0 );
566 if (request_irq(irq, lance_interrupt, IRQ_TYPE_PRIO,
567 "Riebl-VME Ethernet", dev)) {
568 printk( "Lance: request for irq %ld failed\n", irq );
569 return( 0 );
571 dev->irq = irq;
574 printk("%s: %s at io %#lx, mem %#lx, irq %d%s, hwaddr ",
575 dev->name, lance_names[lp->cardtype],
576 (unsigned long)ioaddr,
577 (unsigned long)memaddr,
578 dev->irq,
579 init_rec->slow_flag ? " (slow memcpy)" : "" );
581 /* Get the ethernet address */
582 switch( lp->cardtype ) {
583 case OLD_RIEBL:
584 /* No ethernet address! (Set some default address) */
585 memcpy( dev->dev_addr, OldRieblDefHwaddr, 6 );
586 break;
587 case NEW_RIEBL:
588 lp->memcpy_f( dev->dev_addr, RIEBL_HWADDR_ADDR, 6 );
589 break;
590 case PAM_CARD:
591 i = IO->eeprom;
592 for( i = 0; i < 6; ++i )
593 dev->dev_addr[i] =
594 ((((unsigned short *)MEM)[i*2] & 0x0f) << 4) |
595 ((((unsigned short *)MEM)[i*2+1] & 0x0f));
596 i = IO->mem;
597 break;
599 printk("%s\n", print_mac(mac, dev->dev_addr));
600 if (lp->cardtype == OLD_RIEBL) {
601 printk( "%s: Warning: This is a default ethernet address!\n",
602 dev->name );
603 printk( " Use \"ifconfig hw ether ...\" to set the address.\n" );
606 spin_lock_init(&lp->devlock);
608 MEM->init.mode = 0x0000; /* Disable Rx and Tx. */
609 for( i = 0; i < 6; i++ )
610 MEM->init.hwaddr[i] = dev->dev_addr[i^1]; /* <- 16 bit swap! */
611 MEM->init.filter[0] = 0x00000000;
612 MEM->init.filter[1] = 0x00000000;
613 MEM->init.rx_ring.adr_lo = offsetof( struct lance_memory, rx_head );
614 MEM->init.rx_ring.adr_hi = 0;
615 MEM->init.rx_ring.len = RX_RING_LEN_BITS;
616 MEM->init.tx_ring.adr_lo = offsetof( struct lance_memory, tx_head );
617 MEM->init.tx_ring.adr_hi = 0;
618 MEM->init.tx_ring.len = TX_RING_LEN_BITS;
620 if (lp->cardtype == PAM_CARD)
621 IO->ivec = IRQ_SOURCE_TO_VECTOR(dev->irq);
622 else
623 *RIEBL_IVEC_ADDR = IRQ_SOURCE_TO_VECTOR(dev->irq);
625 if (did_version++ == 0)
626 DPRINTK( 1, ( version ));
628 /* The LANCE-specific entries in the device structure. */
629 dev->open = &lance_open;
630 dev->hard_start_xmit = &lance_start_xmit;
631 dev->stop = &lance_close;
632 dev->set_multicast_list = &set_multicast_list;
633 dev->set_mac_address = &lance_set_mac_address;
635 /* XXX MSch */
636 dev->tx_timeout = lance_tx_timeout;
637 dev->watchdog_timeo = TX_TIMEOUT;
639 return( 1 );
643 static int lance_open( struct net_device *dev )
645 { struct lance_private *lp = (struct lance_private *)dev->priv;
646 struct lance_ioreg *IO = lp->iobase;
647 int i;
649 DPRINTK( 2, ( "%s: lance_open()\n", dev->name ));
651 lance_init_ring(dev);
652 /* Re-initialize the LANCE, and start it when done. */
654 REGA( CSR3 ) = CSR3_BSWP | (lp->cardtype == PAM_CARD ? CSR3_ACON : 0);
655 REGA( CSR2 ) = 0;
656 REGA( CSR1 ) = 0;
657 REGA( CSR0 ) = CSR0_INIT;
658 /* From now on, AREG is kept to point to CSR0 */
660 i = 1000000;
661 while (--i > 0)
662 if (DREG & CSR0_IDON)
663 break;
664 if (i < 0 || (DREG & CSR0_ERR)) {
665 DPRINTK( 2, ( "lance_open(): opening %s failed, i=%d, csr0=%04x\n",
666 dev->name, i, DREG ));
667 DREG = CSR0_STOP;
668 return( -EIO );
670 DREG = CSR0_IDON;
671 DREG = CSR0_STRT;
672 DREG = CSR0_INEA;
674 netif_start_queue (dev);
676 DPRINTK( 2, ( "%s: LANCE is open, csr0 %04x\n", dev->name, DREG ));
678 return( 0 );
682 /* Initialize the LANCE Rx and Tx rings. */
684 static void lance_init_ring( struct net_device *dev )
686 { struct lance_private *lp = (struct lance_private *)dev->priv;
687 int i;
688 unsigned offset;
690 lp->tx_full = 0;
691 lp->cur_rx = lp->cur_tx = 0;
692 lp->dirty_tx = 0;
694 offset = offsetof( struct lance_memory, packet_area );
696 /* If the packet buffer at offset 'o' would conflict with the reserved area
697 * of RieblCards, advance it */
698 #define CHECK_OFFSET(o) \
699 do { \
700 if (lp->cardtype == OLD_RIEBL || lp->cardtype == NEW_RIEBL) { \
701 if (((o) < RIEBL_RSVD_START) ? (o)+PKT_BUF_SZ > RIEBL_RSVD_START \
702 : (o) < RIEBL_RSVD_END) \
703 (o) = RIEBL_RSVD_END; \
705 } while(0)
707 for( i = 0; i < TX_RING_SIZE; i++ ) {
708 CHECK_OFFSET(offset);
709 MEM->tx_head[i].base = offset;
710 MEM->tx_head[i].flag = TMD1_OWN_HOST;
711 MEM->tx_head[i].base_hi = 0;
712 MEM->tx_head[i].length = 0;
713 MEM->tx_head[i].misc = 0;
714 offset += PKT_BUF_SZ;
717 for( i = 0; i < RX_RING_SIZE; i++ ) {
718 CHECK_OFFSET(offset);
719 MEM->rx_head[i].base = offset;
720 MEM->rx_head[i].flag = TMD1_OWN_CHIP;
721 MEM->rx_head[i].base_hi = 0;
722 MEM->rx_head[i].buf_length = -PKT_BUF_SZ;
723 MEM->rx_head[i].msg_length = 0;
724 offset += PKT_BUF_SZ;
729 /* XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX */
732 static void lance_tx_timeout (struct net_device *dev)
734 struct lance_private *lp = (struct lance_private *) dev->priv;
735 struct lance_ioreg *IO = lp->iobase;
737 AREG = CSR0;
738 DPRINTK( 1, ( "%s: transmit timed out, status %04x, resetting.\n",
739 dev->name, DREG ));
740 DREG = CSR0_STOP;
742 * Always set BSWP after a STOP as STOP puts it back into
743 * little endian mode.
745 REGA( CSR3 ) = CSR3_BSWP | (lp->cardtype == PAM_CARD ? CSR3_ACON : 0);
746 dev->stats.tx_errors++;
747 #ifndef final_version
748 { int i;
749 DPRINTK( 2, ( "Ring data: dirty_tx %d cur_tx %d%s cur_rx %d\n",
750 lp->dirty_tx, lp->cur_tx,
751 lp->tx_full ? " (full)" : "",
752 lp->cur_rx ));
753 for( i = 0 ; i < RX_RING_SIZE; i++ )
754 DPRINTK( 2, ( "rx #%d: base=%04x blen=%04x mlen=%04x\n",
755 i, MEM->rx_head[i].base,
756 -MEM->rx_head[i].buf_length,
757 MEM->rx_head[i].msg_length ));
758 for( i = 0 ; i < TX_RING_SIZE; i++ )
759 DPRINTK( 2, ( "tx #%d: base=%04x len=%04x misc=%04x\n",
760 i, MEM->tx_head[i].base,
761 -MEM->tx_head[i].length,
762 MEM->tx_head[i].misc ));
764 #endif
765 /* XXX MSch: maybe purge/reinit ring here */
766 /* lance_restart, essentially */
767 lance_init_ring(dev);
768 REGA( CSR0 ) = CSR0_INEA | CSR0_INIT | CSR0_STRT;
769 dev->trans_start = jiffies;
770 netif_wake_queue (dev);
773 /* XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX */
775 static int lance_start_xmit( struct sk_buff *skb, struct net_device *dev )
777 { struct lance_private *lp = (struct lance_private *)dev->priv;
778 struct lance_ioreg *IO = lp->iobase;
779 int entry, len;
780 struct lance_tx_head *head;
781 unsigned long flags;
782 DECLARE_MAC_BUF(mac);
783 DECLARE_MAC_BUF(mac2);
785 DPRINTK( 2, ( "%s: lance_start_xmit() called, csr0 %4.4x.\n",
786 dev->name, DREG ));
789 /* The old LANCE chips doesn't automatically pad buffers to min. size. */
790 len = skb->len;
791 if (len < ETH_ZLEN)
792 len = ETH_ZLEN;
793 /* PAM-Card has a bug: Can only send packets with even number of bytes! */
794 else if (lp->cardtype == PAM_CARD && (len & 1))
795 ++len;
797 if (len > skb->len) {
798 if (skb_padto(skb, len))
799 return 0;
802 netif_stop_queue (dev);
804 /* Fill in a Tx ring entry */
805 if (lance_debug >= 3) {
806 printk( "%s: TX pkt type 0x%04x from "
807 "%s to %s"
808 " data at 0x%08x len %d\n",
809 dev->name, ((u_short *)skb->data)[6],
810 print_mac(mac, &skb->data[6]),
811 print_mac(mac2, skb->data),
812 (int)skb->data, (int)skb->len );
815 /* We're not prepared for the int until the last flags are set/reset. And
816 * the int may happen already after setting the OWN_CHIP... */
817 spin_lock_irqsave (&lp->devlock, flags);
819 /* Mask to ring buffer boundary. */
820 entry = lp->cur_tx & TX_RING_MOD_MASK;
821 head = &(MEM->tx_head[entry]);
823 /* Caution: the write order is important here, set the "ownership" bits
824 * last.
828 head->length = -len;
829 head->misc = 0;
830 lp->memcpy_f( PKTBUF_ADDR(head), (void *)skb->data, skb->len );
831 head->flag = TMD1_OWN_CHIP | TMD1_ENP | TMD1_STP;
832 dev->stats.tx_bytes += skb->len;
833 dev_kfree_skb( skb );
834 lp->cur_tx++;
835 while( lp->cur_tx >= TX_RING_SIZE && lp->dirty_tx >= TX_RING_SIZE ) {
836 lp->cur_tx -= TX_RING_SIZE;
837 lp->dirty_tx -= TX_RING_SIZE;
840 /* Trigger an immediate send poll. */
841 DREG = CSR0_INEA | CSR0_TDMD;
842 dev->trans_start = jiffies;
844 if ((MEM->tx_head[(entry+1) & TX_RING_MOD_MASK].flag & TMD1_OWN) ==
845 TMD1_OWN_HOST)
846 netif_start_queue (dev);
847 else
848 lp->tx_full = 1;
849 spin_unlock_irqrestore (&lp->devlock, flags);
851 return 0;
854 /* The LANCE interrupt handler. */
856 static irqreturn_t lance_interrupt( int irq, void *dev_id )
858 struct net_device *dev = dev_id;
859 struct lance_private *lp;
860 struct lance_ioreg *IO;
861 int csr0, boguscnt = 10;
862 int handled = 0;
864 if (dev == NULL) {
865 DPRINTK( 1, ( "lance_interrupt(): interrupt for unknown device.\n" ));
866 return IRQ_NONE;
869 lp = (struct lance_private *)dev->priv;
870 IO = lp->iobase;
871 spin_lock (&lp->devlock);
873 AREG = CSR0;
875 while( ((csr0 = DREG) & (CSR0_ERR | CSR0_TINT | CSR0_RINT)) &&
876 --boguscnt >= 0) {
877 handled = 1;
878 /* Acknowledge all of the current interrupt sources ASAP. */
879 DREG = csr0 & ~(CSR0_INIT | CSR0_STRT | CSR0_STOP |
880 CSR0_TDMD | CSR0_INEA);
882 DPRINTK( 2, ( "%s: interrupt csr0=%04x new csr=%04x.\n",
883 dev->name, csr0, DREG ));
885 if (csr0 & CSR0_RINT) /* Rx interrupt */
886 lance_rx( dev );
888 if (csr0 & CSR0_TINT) { /* Tx-done interrupt */
889 int dirty_tx = lp->dirty_tx;
891 while( dirty_tx < lp->cur_tx) {
892 int entry = dirty_tx & TX_RING_MOD_MASK;
893 int status = MEM->tx_head[entry].flag;
895 if (status & TMD1_OWN_CHIP)
896 break; /* It still hasn't been Txed */
898 MEM->tx_head[entry].flag = 0;
900 if (status & TMD1_ERR) {
901 /* There was an major error, log it. */
902 int err_status = MEM->tx_head[entry].misc;
903 dev->stats.tx_errors++;
904 if (err_status & TMD3_RTRY) dev->stats.tx_aborted_errors++;
905 if (err_status & TMD3_LCAR) dev->stats.tx_carrier_errors++;
906 if (err_status & TMD3_LCOL) dev->stats.tx_window_errors++;
907 if (err_status & TMD3_UFLO) {
908 /* Ackk! On FIFO errors the Tx unit is turned off! */
909 dev->stats.tx_fifo_errors++;
910 /* Remove this verbosity later! */
911 DPRINTK( 1, ( "%s: Tx FIFO error! Status %04x\n",
912 dev->name, csr0 ));
913 /* Restart the chip. */
914 DREG = CSR0_STRT;
916 } else {
917 if (status & (TMD1_MORE | TMD1_ONE | TMD1_DEF))
918 dev->stats.collisions++;
919 dev->stats.tx_packets++;
922 /* XXX MSch: free skb?? */
923 dirty_tx++;
926 #ifndef final_version
927 if (lp->cur_tx - dirty_tx >= TX_RING_SIZE) {
928 DPRINTK( 0, ( "out-of-sync dirty pointer,"
929 " %d vs. %d, full=%ld.\n",
930 dirty_tx, lp->cur_tx, lp->tx_full ));
931 dirty_tx += TX_RING_SIZE;
933 #endif
935 if (lp->tx_full && (netif_queue_stopped(dev))
936 && dirty_tx > lp->cur_tx - TX_RING_SIZE + 2) {
937 /* The ring is no longer full, clear tbusy. */
938 lp->tx_full = 0;
939 netif_wake_queue (dev);
942 lp->dirty_tx = dirty_tx;
945 /* Log misc errors. */
946 if (csr0 & CSR0_BABL) dev->stats.tx_errors++; /* Tx babble. */
947 if (csr0 & CSR0_MISS) dev->stats.rx_errors++; /* Missed a Rx frame. */
948 if (csr0 & CSR0_MERR) {
949 DPRINTK( 1, ( "%s: Bus master arbitration failure (?!?), "
950 "status %04x.\n", dev->name, csr0 ));
951 /* Restart the chip. */
952 DREG = CSR0_STRT;
956 /* Clear any other interrupt, and set interrupt enable. */
957 DREG = CSR0_BABL | CSR0_CERR | CSR0_MISS | CSR0_MERR |
958 CSR0_IDON | CSR0_INEA;
960 DPRINTK( 2, ( "%s: exiting interrupt, csr0=%#04x.\n",
961 dev->name, DREG ));
963 spin_unlock (&lp->devlock);
964 return IRQ_RETVAL(handled);
968 static int lance_rx( struct net_device *dev )
970 { struct lance_private *lp = (struct lance_private *)dev->priv;
971 int entry = lp->cur_rx & RX_RING_MOD_MASK;
972 int i;
974 DPRINTK( 2, ( "%s: rx int, flag=%04x\n", dev->name,
975 MEM->rx_head[entry].flag ));
977 /* If we own the next entry, it's a new packet. Send it up. */
978 while( (MEM->rx_head[entry].flag & RMD1_OWN) == RMD1_OWN_HOST ) {
979 struct lance_rx_head *head = &(MEM->rx_head[entry]);
980 int status = head->flag;
982 if (status != (RMD1_ENP|RMD1_STP)) { /* There was an error. */
983 /* There is a tricky error noted by John Murphy,
984 <murf@perftech.com> to Russ Nelson: Even with full-sized
985 buffers it's possible for a jabber packet to use two
986 buffers, with only the last correctly noting the error. */
987 if (status & RMD1_ENP) /* Only count a general error at the */
988 dev->stats.rx_errors++; /* end of a packet.*/
989 if (status & RMD1_FRAM) dev->stats.rx_frame_errors++;
990 if (status & RMD1_OFLO) dev->stats.rx_over_errors++;
991 if (status & RMD1_CRC) dev->stats.rx_crc_errors++;
992 if (status & RMD1_BUFF) dev->stats.rx_fifo_errors++;
993 head->flag &= (RMD1_ENP|RMD1_STP);
994 } else {
995 /* Malloc up new buffer, compatible with net-3. */
996 short pkt_len = head->msg_length & 0xfff;
997 struct sk_buff *skb;
999 if (pkt_len < 60) {
1000 printk( "%s: Runt packet!\n", dev->name );
1001 dev->stats.rx_errors++;
1003 else {
1004 skb = dev_alloc_skb( pkt_len+2 );
1005 if (skb == NULL) {
1006 DPRINTK( 1, ( "%s: Memory squeeze, deferring packet.\n",
1007 dev->name ));
1008 for( i = 0; i < RX_RING_SIZE; i++ )
1009 if (MEM->rx_head[(entry+i) & RX_RING_MOD_MASK].flag &
1010 RMD1_OWN_CHIP)
1011 break;
1013 if (i > RX_RING_SIZE - 2) {
1014 dev->stats.rx_dropped++;
1015 head->flag |= RMD1_OWN_CHIP;
1016 lp->cur_rx++;
1018 break;
1021 if (lance_debug >= 3) {
1022 u_char *data = PKTBUF_ADDR(head);
1023 DECLARE_MAC_BUF(mac);
1024 DECLARE_MAC_BUF(mac2);
1026 printk(KERN_DEBUG "%s: RX pkt type 0x%04x from %s to %s "
1027 "data %02x %02x %02x %02x %02x %02x %02x %02x "
1028 "len %d\n",
1029 dev->name, ((u_short *)data)[6],
1030 print_mac(mac, &data[6]), print_mac(mac2, data),
1031 data[15], data[16], data[17], data[18],
1032 data[19], data[20], data[21], data[22],
1033 pkt_len);
1036 skb_reserve( skb, 2 ); /* 16 byte align */
1037 skb_put( skb, pkt_len ); /* Make room */
1038 lp->memcpy_f( skb->data, PKTBUF_ADDR(head), pkt_len );
1039 skb->protocol = eth_type_trans( skb, dev );
1040 netif_rx( skb );
1041 dev->last_rx = jiffies;
1042 dev->stats.rx_packets++;
1043 dev->stats.rx_bytes += pkt_len;
1047 head->flag |= RMD1_OWN_CHIP;
1048 entry = (++lp->cur_rx) & RX_RING_MOD_MASK;
1050 lp->cur_rx &= RX_RING_MOD_MASK;
1052 /* From lance.c (Donald Becker): */
1053 /* We should check that at least two ring entries are free. If not,
1054 we should free one and mark stats->rx_dropped++. */
1056 return 0;
1060 static int lance_close( struct net_device *dev )
1062 { struct lance_private *lp = (struct lance_private *)dev->priv;
1063 struct lance_ioreg *IO = lp->iobase;
1065 netif_stop_queue (dev);
1067 AREG = CSR0;
1069 DPRINTK( 2, ( "%s: Shutting down ethercard, status was %2.2x.\n",
1070 dev->name, DREG ));
1072 /* We stop the LANCE here -- it occasionally polls
1073 memory if we don't. */
1074 DREG = CSR0_STOP;
1076 return 0;
1080 /* Set or clear the multicast filter for this adaptor.
1081 num_addrs == -1 Promiscuous mode, receive all packets
1082 num_addrs == 0 Normal mode, clear multicast list
1083 num_addrs > 0 Multicast mode, receive normal and MC packets, and do
1084 best-effort filtering.
1087 static void set_multicast_list( struct net_device *dev )
1089 { struct lance_private *lp = (struct lance_private *)dev->priv;
1090 struct lance_ioreg *IO = lp->iobase;
1092 if (netif_running(dev))
1093 /* Only possible if board is already started */
1094 return;
1096 /* We take the simple way out and always enable promiscuous mode. */
1097 DREG = CSR0_STOP; /* Temporarily stop the lance. */
1099 if (dev->flags & IFF_PROMISC) {
1100 /* Log any net taps. */
1101 DPRINTK( 2, ( "%s: Promiscuous mode enabled.\n", dev->name ));
1102 REGA( CSR15 ) = 0x8000; /* Set promiscuous mode */
1103 } else {
1104 short multicast_table[4];
1105 int num_addrs = dev->mc_count;
1106 int i;
1107 /* We don't use the multicast table, but rely on upper-layer
1108 * filtering. */
1109 memset( multicast_table, (num_addrs == 0) ? 0 : -1,
1110 sizeof(multicast_table) );
1111 for( i = 0; i < 4; i++ )
1112 REGA( CSR8+i ) = multicast_table[i];
1113 REGA( CSR15 ) = 0; /* Unset promiscuous mode */
1117 * Always set BSWP after a STOP as STOP puts it back into
1118 * little endian mode.
1120 REGA( CSR3 ) = CSR3_BSWP | (lp->cardtype == PAM_CARD ? CSR3_ACON : 0);
1122 /* Resume normal operation and reset AREG to CSR0 */
1123 REGA( CSR0 ) = CSR0_IDON | CSR0_INEA | CSR0_STRT;
1127 /* This is needed for old RieblCards and possible for new RieblCards */
1129 static int lance_set_mac_address( struct net_device *dev, void *addr )
1131 { struct lance_private *lp = (struct lance_private *)dev->priv;
1132 struct sockaddr *saddr = addr;
1133 int i;
1135 if (lp->cardtype != OLD_RIEBL && lp->cardtype != NEW_RIEBL)
1136 return( -EOPNOTSUPP );
1138 if (netif_running(dev)) {
1139 /* Only possible while card isn't started */
1140 DPRINTK( 1, ( "%s: hwaddr can be set only while card isn't open.\n",
1141 dev->name ));
1142 return( -EIO );
1145 memcpy( dev->dev_addr, saddr->sa_data, dev->addr_len );
1146 for( i = 0; i < 6; i++ )
1147 MEM->init.hwaddr[i] = dev->dev_addr[i^1]; /* <- 16 bit swap! */
1148 lp->memcpy_f( RIEBL_HWADDR_ADDR, dev->dev_addr, 6 );
1149 /* set also the magic for future sessions */
1150 *RIEBL_MAGIC_ADDR = RIEBL_MAGIC;
1152 return( 0 );
1156 #ifdef MODULE
1157 static struct net_device *atarilance_dev;
1159 int __init init_module(void)
1161 atarilance_dev = atarilance_probe(-1);
1162 if (IS_ERR(atarilance_dev))
1163 return PTR_ERR(atarilance_dev);
1164 return 0;
1167 void __exit cleanup_module(void)
1169 unregister_netdev(atarilance_dev);
1170 free_irq(atarilance_dev->irq, atarilance_dev);
1171 free_netdev(atarilance_dev);
1174 #endif /* MODULE */
1178 * Local variables:
1179 * c-indent-level: 4
1180 * tab-width: 4
1181 * End: