GNU Linux-libre 4.9.309-gnu1
[releases.git] / drivers / net / ethernet / amd / atarilance.c
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)
4
5         This software may be used and distributed according to the terms
6         of the GNU General Public License, incorporated herein by reference.
7
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
14
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).
42
43 */
44
45 static char version[] = "atarilance.c: v1.3 04/04/96 "
46                                            "Roman.Hodek@informatik.uni-erlangen.de\n";
47
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/interrupt.h>
57 #include <linux/init.h>
58 #include <linux/bitops.h>
59
60 #include <asm/setup.h>
61 #include <asm/irq.h>
62 #include <asm/atarihw.h>
63 #include <asm/atariints.h>
64 #include <asm/io.h>
65
66 /* Debug level:
67  *  0 = silent, print only serious errors
68  *  1 = normal, print error messages
69  *  2 = debug, print debug infos
70  *  3 = debug, print even more debug infos (packet data)
71  */
72
73 #define LANCE_DEBUG     1
74
75 #ifdef LANCE_DEBUG
76 static int lance_debug = LANCE_DEBUG;
77 #else
78 static int lance_debug = 1;
79 #endif
80 module_param(lance_debug, int, 0);
81 MODULE_PARM_DESC(lance_debug, "atarilance debug level (0-3)");
82 MODULE_LICENSE("GPL");
83
84 /* Print debug messages on probing? */
85 #undef LANCE_DEBUG_PROBE
86
87 #define DPRINTK(n,a)                                                    \
88         do {                                                                            \
89                 if (lance_debug >= n)                                   \
90                         printk a;                                                       \
91         } while( 0 )
92
93 #ifdef LANCE_DEBUG_PROBE
94 # define PROBE_PRINT(a) printk a
95 #else
96 # define PROBE_PRINT(a)
97 #endif
98
99 /* These define the number of Rx and Tx buffers as log2. (Only powers
100  * of two are valid)
101  * Much more rx buffers (32) are reserved than tx buffers (8), since receiving
102  * is more time critical then sending and packets may have to remain in the
103  * board's memory when main memory is low.
104  */
105
106 #define TX_LOG_RING_SIZE                        3
107 #define RX_LOG_RING_SIZE                        5
108
109 /* These are the derived values */
110
111 #define TX_RING_SIZE                    (1 << TX_LOG_RING_SIZE)
112 #define TX_RING_LEN_BITS                (TX_LOG_RING_SIZE << 5)
113 #define TX_RING_MOD_MASK                (TX_RING_SIZE - 1)
114
115 #define RX_RING_SIZE                    (1 << RX_LOG_RING_SIZE)
116 #define RX_RING_LEN_BITS                (RX_LOG_RING_SIZE << 5)
117 #define RX_RING_MOD_MASK                (RX_RING_SIZE - 1)
118
119 #define TX_TIMEOUT      (HZ/5)
120
121 /* The LANCE Rx and Tx ring descriptors. */
122 struct lance_rx_head {
123         unsigned short                  base;           /* Low word of base addr */
124         volatile unsigned char  flag;
125         unsigned char                   base_hi;        /* High word of base addr (unused) */
126         short                                   buf_length;     /* This length is 2s complement! */
127         volatile short                  msg_length;     /* This length is "normal". */
128 };
129
130 struct lance_tx_head {
131         unsigned short                  base;           /* Low word of base addr */
132         volatile unsigned char  flag;
133         unsigned char                   base_hi;        /* High word of base addr (unused) */
134         short                                   length;         /* Length is 2s complement! */
135         volatile short                  misc;
136 };
137
138 struct ringdesc {
139         unsigned short  adr_lo;         /* Low 16 bits of address */
140         unsigned char   len;            /* Length bits */
141         unsigned char   adr_hi;         /* High 8 bits of address (unused) */
142 };
143
144 /* The LANCE initialization block, described in databook. */
145 struct lance_init_block {
146         unsigned short  mode;           /* Pre-set mode */
147         unsigned char   hwaddr[6];      /* Physical ethernet address */
148         unsigned                filter[2];      /* Multicast filter (unused). */
149         /* Receive and transmit ring base, along with length bits. */
150         struct ringdesc rx_ring;
151         struct ringdesc tx_ring;
152 };
153
154 /* The whole layout of the Lance shared memory */
155 struct lance_memory {
156         struct lance_init_block init;
157         struct lance_tx_head    tx_head[TX_RING_SIZE];
158         struct lance_rx_head    rx_head[RX_RING_SIZE];
159         char                                    packet_area[0]; /* packet data follow after the
160                                                                                          * init block and the ring
161                                                                                          * descriptors and are located
162                                                                                          * at runtime */
163 };
164
165 /* RieblCard specifics:
166  * The original TOS driver for these cards reserves the area from offset
167  * 0xee70 to 0xeebb for storing configuration data. Of interest to us is the
168  * Ethernet address there, and the magic for verifying the data's validity.
169  * The reserved area isn't touch by packet buffers. Furthermore, offset 0xfffe
170  * is reserved for the interrupt vector number.
171  */
172 #define RIEBL_RSVD_START        0xee70
173 #define RIEBL_RSVD_END          0xeec0
174 #define RIEBL_MAGIC                     0x09051990
175 #define RIEBL_MAGIC_ADDR        ((unsigned long *)(((char *)MEM) + 0xee8a))
176 #define RIEBL_HWADDR_ADDR       ((unsigned char *)(((char *)MEM) + 0xee8e))
177 #define RIEBL_IVEC_ADDR         ((unsigned short *)(((char *)MEM) + 0xfffe))
178
179 /* This is a default address for the old RieblCards without a battery
180  * that have no ethernet address at boot time. 00:00:36:04 is the
181  * prefix for Riebl cards, the 00:00 at the end is arbitrary.
182  */
183
184 static unsigned char OldRieblDefHwaddr[6] = {
185         0x00, 0x00, 0x36, 0x04, 0x00, 0x00
186 };
187
188
189 /* I/O registers of the Lance chip */
190
191 struct lance_ioreg {
192 /* base+0x0 */  volatile unsigned short data;
193 /* base+0x2 */  volatile unsigned short addr;
194                                 unsigned char                   _dummy1[3];
195 /* base+0x7 */  volatile unsigned char  ivec;
196                                 unsigned char                   _dummy2[5];
197 /* base+0xd */  volatile unsigned char  eeprom;
198                                 unsigned char                   _dummy3;
199 /* base+0xf */  volatile unsigned char  mem;
200 };
201
202 /* Types of boards this driver supports */
203
204 enum lance_type {
205         OLD_RIEBL,              /* old Riebl card without battery */
206         NEW_RIEBL,              /* new Riebl card with battery */
207         PAM_CARD                /* PAM card with EEPROM */
208 };
209
210 static char *lance_names[] = {
211         "Riebl-Card (without battery)",
212         "Riebl-Card (with battery)",
213         "PAM intern card"
214 };
215
216 /* The driver's private device structure */
217
218 struct lance_private {
219         enum lance_type         cardtype;
220         struct lance_ioreg      *iobase;
221         struct lance_memory     *mem;
222         int                     cur_rx, cur_tx; /* The next free ring entry */
223         int                     dirty_tx;               /* Ring entries to be freed. */
224                                 /* copy function */
225         void                    *(*memcpy_f)( void *, const void *, size_t );
226 /* This must be long for set_bit() */
227         long                    tx_full;
228         spinlock_t              devlock;
229 };
230
231 /* I/O register access macros */
232
233 #define MEM             lp->mem
234 #define DREG    IO->data
235 #define AREG    IO->addr
236 #define REGA(a) (*( AREG = (a), &DREG ))
237
238 /* Definitions for packet buffer access: */
239 #define PKT_BUF_SZ              1544
240 /* Get the address of a packet buffer corresponding to a given buffer head */
241 #define PKTBUF_ADDR(head)       (((unsigned char *)(MEM)) + (head)->base)
242
243 /* Possible memory/IO addresses for probing */
244
245 static struct lance_addr {
246         unsigned long   memaddr;
247         unsigned long   ioaddr;
248         int                             slow_flag;
249 } lance_addr_list[] = {
250         { 0xfe010000, 0xfe00fff0, 0 },  /* RieblCard VME in TT */
251         { 0xffc10000, 0xffc0fff0, 0 },  /* RieblCard VME in MegaSTE
252                                                                            (highest byte stripped) */
253         { 0xffe00000, 0xffff7000, 1 },  /* RieblCard in ST
254                                                                            (highest byte stripped) */
255         { 0xffd00000, 0xffff7000, 1 },  /* RieblCard in ST with hw modif. to
256                                                                            avoid conflict with ROM
257                                                                            (highest byte stripped) */
258         { 0xffcf0000, 0xffcffff0, 0 },  /* PAMCard VME in TT and MSTE
259                                                                            (highest byte stripped) */
260         { 0xfecf0000, 0xfecffff0, 0 },  /* Rhotron's PAMCard VME in TT and MSTE
261                                                                            (highest byte stripped) */
262 };
263
264 #define N_LANCE_ADDR    ARRAY_SIZE(lance_addr_list)
265
266
267 /* Definitions for the Lance */
268
269 /* tx_head flags */
270 #define TMD1_ENP                0x01    /* end of packet */
271 #define TMD1_STP                0x02    /* start of packet */
272 #define TMD1_DEF                0x04    /* deferred */
273 #define TMD1_ONE                0x08    /* one retry needed */
274 #define TMD1_MORE               0x10    /* more than one retry needed */
275 #define TMD1_ERR                0x40    /* error summary */
276 #define TMD1_OWN                0x80    /* ownership (set: chip owns) */
277
278 #define TMD1_OWN_CHIP   TMD1_OWN
279 #define TMD1_OWN_HOST   0
280
281 /* tx_head misc field */
282 #define TMD3_TDR                0x03FF  /* Time Domain Reflectometry counter */
283 #define TMD3_RTRY               0x0400  /* failed after 16 retries */
284 #define TMD3_LCAR               0x0800  /* carrier lost */
285 #define TMD3_LCOL               0x1000  /* late collision */
286 #define TMD3_UFLO               0x4000  /* underflow (late memory) */
287 #define TMD3_BUFF               0x8000  /* buffering error (no ENP) */
288
289 /* rx_head flags */
290 #define RMD1_ENP                0x01    /* end of packet */
291 #define RMD1_STP                0x02    /* start of packet */
292 #define RMD1_BUFF               0x04    /* buffer error */
293 #define RMD1_CRC                0x08    /* CRC error */
294 #define RMD1_OFLO               0x10    /* overflow */
295 #define RMD1_FRAM               0x20    /* framing error */
296 #define RMD1_ERR                0x40    /* error summary */
297 #define RMD1_OWN                0x80    /* ownership (set: ship owns) */
298
299 #define RMD1_OWN_CHIP   RMD1_OWN
300 #define RMD1_OWN_HOST   0
301
302 /* register names */
303 #define CSR0    0               /* mode/status */
304 #define CSR1    1               /* init block addr (low) */
305 #define CSR2    2               /* init block addr (high) */
306 #define CSR3    3               /* misc */
307 #define CSR8    8               /* address filter */
308 #define CSR15   15              /* promiscuous mode */
309
310 /* CSR0 */
311 /* (R=readable, W=writeable, S=set on write, C=clear on write) */
312 #define CSR0_INIT       0x0001          /* initialize (RS) */
313 #define CSR0_STRT       0x0002          /* start (RS) */
314 #define CSR0_STOP       0x0004          /* stop (RS) */
315 #define CSR0_TDMD       0x0008          /* transmit demand (RS) */
316 #define CSR0_TXON       0x0010          /* transmitter on (R) */
317 #define CSR0_RXON       0x0020          /* receiver on (R) */
318 #define CSR0_INEA       0x0040          /* interrupt enable (RW) */
319 #define CSR0_INTR       0x0080          /* interrupt active (R) */
320 #define CSR0_IDON       0x0100          /* initialization done (RC) */
321 #define CSR0_TINT       0x0200          /* transmitter interrupt (RC) */
322 #define CSR0_RINT       0x0400          /* receiver interrupt (RC) */
323 #define CSR0_MERR       0x0800          /* memory error (RC) */
324 #define CSR0_MISS       0x1000          /* missed frame (RC) */
325 #define CSR0_CERR       0x2000          /* carrier error (no heartbeat :-) (RC) */
326 #define CSR0_BABL       0x4000          /* babble: tx-ed too many bits (RC) */
327 #define CSR0_ERR        0x8000          /* error (RC) */
328
329 /* CSR3 */
330 #define CSR3_BCON       0x0001          /* byte control */
331 #define CSR3_ACON       0x0002          /* ALE control */
332 #define CSR3_BSWP       0x0004          /* byte swap (1=big endian) */
333
334
335
336 /***************************** Prototypes *****************************/
337
338 static unsigned long lance_probe1( struct net_device *dev, struct lance_addr
339                                    *init_rec );
340 static int lance_open( struct net_device *dev );
341 static void lance_init_ring( struct net_device *dev );
342 static netdev_tx_t lance_start_xmit(struct sk_buff *skb,
343                                     struct net_device *dev);
344 static irqreturn_t lance_interrupt( int irq, void *dev_id );
345 static int lance_rx( struct net_device *dev );
346 static int lance_close( struct net_device *dev );
347 static void set_multicast_list( struct net_device *dev );
348 static int lance_set_mac_address( struct net_device *dev, void *addr );
349 static void lance_tx_timeout (struct net_device *dev);
350
351 /************************* End of Prototypes **************************/
352
353
354
355
356
357 static void *slow_memcpy( void *dst, const void *src, size_t len )
358
359 {       char *cto = dst;
360         const char *cfrom = src;
361
362         while( len-- ) {
363                 *cto++ = *cfrom++;
364                 MFPDELAY();
365         }
366         return dst;
367 }
368
369
370 struct net_device * __init atarilance_probe(int unit)
371 {
372         int i;
373         static int found;
374         struct net_device *dev;
375         int err = -ENODEV;
376
377         if (!MACH_IS_ATARI || found)
378                 /* Assume there's only one board possible... That seems true, since
379                  * the Riebl/PAM board's address cannot be changed. */
380                 return ERR_PTR(-ENODEV);
381
382         dev = alloc_etherdev(sizeof(struct lance_private));
383         if (!dev)
384                 return ERR_PTR(-ENOMEM);
385         if (unit >= 0) {
386                 sprintf(dev->name, "eth%d", unit);
387                 netdev_boot_setup_check(dev);
388         }
389
390         for( i = 0; i < N_LANCE_ADDR; ++i ) {
391                 if (lance_probe1( dev, &lance_addr_list[i] )) {
392                         found = 1;
393                         err = register_netdev(dev);
394                         if (!err)
395                                 return dev;
396                         free_irq(dev->irq, dev);
397                         break;
398                 }
399         }
400         free_netdev(dev);
401         return ERR_PTR(err);
402 }
403
404
405 /* Derived from hwreg_present() in atari/config.c: */
406
407 static noinline int __init addr_accessible(volatile void *regp, int wordflag,
408                                            int writeflag)
409 {
410         int             ret;
411         unsigned long   flags;
412         long    *vbr, save_berr;
413
414         local_irq_save(flags);
415
416         __asm__ __volatile__ ( "movec   %/vbr,%0" : "=r" (vbr) : );
417         save_berr = vbr[2];
418
419         __asm__ __volatile__
420         (       "movel  %/sp,%/d1\n\t"
421                 "movel  #Lberr,%2@\n\t"
422                 "moveq  #0,%0\n\t"
423                 "tstl   %3\n\t"
424                 "bne    1f\n\t"
425                 "moveb  %1@,%/d0\n\t"
426                 "nop    \n\t"
427                 "bra    2f\n"
428 "1:              movew  %1@,%/d0\n\t"
429                 "nop    \n"
430 "2:              tstl   %4\n\t"
431                 "beq    2f\n\t"
432                 "tstl   %3\n\t"
433                 "bne    1f\n\t"
434                 "clrb   %1@\n\t"
435                 "nop    \n\t"
436                 "moveb  %/d0,%1@\n\t"
437                 "nop    \n\t"
438                 "bra    2f\n"
439 "1:              clrw   %1@\n\t"
440                 "nop    \n\t"
441                 "movew  %/d0,%1@\n\t"
442                 "nop    \n"
443 "2:              moveq  #1,%0\n"
444 "Lberr:  movel  %/d1,%/sp"
445                 : "=&d" (ret)
446                 : "a" (regp), "a" (&vbr[2]), "rm" (wordflag), "rm" (writeflag)
447                 : "d0", "d1", "memory"
448         );
449
450         vbr[2] = save_berr;
451         local_irq_restore(flags);
452
453         return ret;
454 }
455
456 static const struct net_device_ops lance_netdev_ops = {
457         .ndo_open               = lance_open,
458         .ndo_stop               = lance_close,
459         .ndo_start_xmit         = lance_start_xmit,
460         .ndo_set_rx_mode        = set_multicast_list,
461         .ndo_set_mac_address    = lance_set_mac_address,
462         .ndo_tx_timeout         = lance_tx_timeout,
463         .ndo_validate_addr      = eth_validate_addr,
464         .ndo_change_mtu         = eth_change_mtu,
465 };
466
467 static unsigned long __init lance_probe1( struct net_device *dev,
468                                            struct lance_addr *init_rec )
469 {
470         volatile unsigned short *memaddr =
471                 (volatile unsigned short *)init_rec->memaddr;
472         volatile unsigned short *ioaddr =
473                 (volatile unsigned short *)init_rec->ioaddr;
474         struct lance_private    *lp;
475         struct lance_ioreg              *IO;
476         int                                     i;
477         static int                              did_version;
478         unsigned short                  save1, save2;
479
480         PROBE_PRINT(( "Probing for Lance card at mem %#lx io %#lx\n",
481                                   (long)memaddr, (long)ioaddr ));
482
483         /* Test whether memory readable and writable */
484         PROBE_PRINT(( "lance_probe1: testing memory to be accessible\n" ));
485         if (!addr_accessible( memaddr, 1, 1 )) goto probe_fail;
486
487         /* Written values should come back... */
488         PROBE_PRINT(( "lance_probe1: testing memory to be writable (1)\n" ));
489         save1 = *memaddr;
490         *memaddr = 0x0001;
491         if (*memaddr != 0x0001) goto probe_fail;
492         PROBE_PRINT(( "lance_probe1: testing memory to be writable (2)\n" ));
493         *memaddr = 0x0000;
494         if (*memaddr != 0x0000) goto probe_fail;
495         *memaddr = save1;
496
497         /* First port should be readable and writable */
498         PROBE_PRINT(( "lance_probe1: testing ioport to be accessible\n" ));
499         if (!addr_accessible( ioaddr, 1, 1 )) goto probe_fail;
500
501         /* and written values should be readable */
502         PROBE_PRINT(( "lance_probe1: testing ioport to be writeable\n" ));
503         save2 = ioaddr[1];
504         ioaddr[1] = 0x0001;
505         if (ioaddr[1] != 0x0001) goto probe_fail;
506
507         /* The CSR0_INIT bit should not be readable */
508         PROBE_PRINT(( "lance_probe1: testing CSR0 register function (1)\n" ));
509         save1 = ioaddr[0];
510         ioaddr[1] = CSR0;
511         ioaddr[0] = CSR0_INIT | CSR0_STOP;
512         if (ioaddr[0] != CSR0_STOP) {
513                 ioaddr[0] = save1;
514                 ioaddr[1] = save2;
515                 goto probe_fail;
516         }
517         PROBE_PRINT(( "lance_probe1: testing CSR0 register function (2)\n" ));
518         ioaddr[0] = CSR0_STOP;
519         if (ioaddr[0] != CSR0_STOP) {
520                 ioaddr[0] = save1;
521                 ioaddr[1] = save2;
522                 goto probe_fail;
523         }
524
525         /* Now ok... */
526         PROBE_PRINT(( "lance_probe1: Lance card detected\n" ));
527         goto probe_ok;
528
529   probe_fail:
530         return 0;
531
532   probe_ok:
533         lp = netdev_priv(dev);
534         MEM = (struct lance_memory *)memaddr;
535         IO = lp->iobase = (struct lance_ioreg *)ioaddr;
536         dev->base_addr = (unsigned long)ioaddr; /* informational only */
537         lp->memcpy_f = init_rec->slow_flag ? slow_memcpy : memcpy;
538
539         REGA( CSR0 ) = CSR0_STOP;
540
541         /* Now test for type: If the eeprom I/O port is readable, it is a
542          * PAM card */
543         if (addr_accessible( &(IO->eeprom), 0, 0 )) {
544                 /* Switch back to Ram */
545                 i = IO->mem;
546                 lp->cardtype = PAM_CARD;
547         }
548         else if (*RIEBL_MAGIC_ADDR == RIEBL_MAGIC) {
549                 lp->cardtype = NEW_RIEBL;
550         }
551         else
552                 lp->cardtype = OLD_RIEBL;
553
554         if (lp->cardtype == PAM_CARD ||
555                 memaddr == (unsigned short *)0xffe00000) {
556                 /* PAMs card and Riebl on ST use level 5 autovector */
557                 if (request_irq(IRQ_AUTO_5, lance_interrupt, 0,
558                                 "PAM,Riebl-ST Ethernet", dev)) {
559                         printk( "Lance: request for irq %d failed\n", IRQ_AUTO_5 );
560                         return 0;
561                 }
562                 dev->irq = IRQ_AUTO_5;
563         }
564         else {
565                 /* For VME-RieblCards, request a free VME int */
566                 unsigned int irq = atari_register_vme_int();
567                 if (!irq) {
568                         printk( "Lance: request for VME interrupt failed\n" );
569                         return 0;
570                 }
571                 if (request_irq(irq, lance_interrupt, 0, "Riebl-VME Ethernet",
572                                 dev)) {
573                         printk( "Lance: request for irq %u failed\n", irq );
574                         return 0;
575                 }
576                 dev->irq = irq;
577         }
578
579         printk("%s: %s at io %#lx, mem %#lx, irq %d%s, hwaddr ",
580                    dev->name, lance_names[lp->cardtype],
581                    (unsigned long)ioaddr,
582                    (unsigned long)memaddr,
583                    dev->irq,
584                    init_rec->slow_flag ? " (slow memcpy)" : "" );
585
586         /* Get the ethernet address */
587         switch( lp->cardtype ) {
588           case OLD_RIEBL:
589                 /* No ethernet address! (Set some default address) */
590                 memcpy(dev->dev_addr, OldRieblDefHwaddr, ETH_ALEN);
591                 break;
592           case NEW_RIEBL:
593                 lp->memcpy_f(dev->dev_addr, RIEBL_HWADDR_ADDR, ETH_ALEN);
594                 break;
595           case PAM_CARD:
596                 i = IO->eeprom;
597                 for( i = 0; i < 6; ++i )
598                         dev->dev_addr[i] =
599                                 ((((unsigned short *)MEM)[i*2] & 0x0f) << 4) |
600                                 ((((unsigned short *)MEM)[i*2+1] & 0x0f));
601                 i = IO->mem;
602                 break;
603         }
604         printk("%pM\n", dev->dev_addr);
605         if (lp->cardtype == OLD_RIEBL) {
606                 printk( "%s: Warning: This is a default ethernet address!\n",
607                                 dev->name );
608                 printk( "      Use \"ifconfig hw ether ...\" to set the address.\n" );
609         }
610
611         spin_lock_init(&lp->devlock);
612
613         MEM->init.mode = 0x0000;                /* Disable Rx and Tx. */
614         for( i = 0; i < 6; i++ )
615                 MEM->init.hwaddr[i] = dev->dev_addr[i^1]; /* <- 16 bit swap! */
616         MEM->init.filter[0] = 0x00000000;
617         MEM->init.filter[1] = 0x00000000;
618         MEM->init.rx_ring.adr_lo = offsetof( struct lance_memory, rx_head );
619         MEM->init.rx_ring.adr_hi = 0;
620         MEM->init.rx_ring.len    = RX_RING_LEN_BITS;
621         MEM->init.tx_ring.adr_lo = offsetof( struct lance_memory, tx_head );
622         MEM->init.tx_ring.adr_hi = 0;
623         MEM->init.tx_ring.len    = TX_RING_LEN_BITS;
624
625         if (lp->cardtype == PAM_CARD)
626                 IO->ivec = IRQ_SOURCE_TO_VECTOR(dev->irq);
627         else
628                 *RIEBL_IVEC_ADDR = IRQ_SOURCE_TO_VECTOR(dev->irq);
629
630         if (did_version++ == 0)
631                 DPRINTK( 1, ( version ));
632
633         dev->netdev_ops = &lance_netdev_ops;
634
635         /* XXX MSch */
636         dev->watchdog_timeo = TX_TIMEOUT;
637
638         return 1;
639 }
640
641
642 static int lance_open( struct net_device *dev )
643 {
644         struct lance_private *lp = netdev_priv(dev);
645         struct lance_ioreg       *IO = lp->iobase;
646         int i;
647
648         DPRINTK( 2, ( "%s: lance_open()\n", dev->name ));
649
650         lance_init_ring(dev);
651         /* Re-initialize the LANCE, and start it when done. */
652
653         REGA( CSR3 ) = CSR3_BSWP | (lp->cardtype == PAM_CARD ? CSR3_ACON : 0);
654         REGA( CSR2 ) = 0;
655         REGA( CSR1 ) = 0;
656         REGA( CSR0 ) = CSR0_INIT;
657         /* From now on, AREG is kept to point to CSR0 */
658
659         i = 1000000;
660         while (--i > 0)
661                 if (DREG & CSR0_IDON)
662                         break;
663         if (i <= 0 || (DREG & CSR0_ERR)) {
664                 DPRINTK( 2, ( "lance_open(): opening %s failed, i=%d, csr0=%04x\n",
665                                           dev->name, i, DREG ));
666                 DREG = CSR0_STOP;
667                 return -EIO;
668         }
669         DREG = CSR0_IDON;
670         DREG = CSR0_STRT;
671         DREG = CSR0_INEA;
672
673         netif_start_queue (dev);
674
675         DPRINTK( 2, ( "%s: LANCE is open, csr0 %04x\n", dev->name, DREG ));
676
677         return 0;
678 }
679
680
681 /* Initialize the LANCE Rx and Tx rings. */
682
683 static void lance_init_ring( struct net_device *dev )
684 {
685         struct lance_private *lp = netdev_priv(dev);
686         int i;
687         unsigned offset;
688
689         lp->tx_full = 0;
690         lp->cur_rx = lp->cur_tx = 0;
691         lp->dirty_tx = 0;
692
693         offset = offsetof( struct lance_memory, packet_area );
694
695 /* If the packet buffer at offset 'o' would conflict with the reserved area
696  * of RieblCards, advance it */
697 #define CHECK_OFFSET(o)                                                                                                          \
698         do {                                                                                                                                     \
699                 if (lp->cardtype == OLD_RIEBL || lp->cardtype == NEW_RIEBL) {            \
700                         if (((o) < RIEBL_RSVD_START) ? (o)+PKT_BUF_SZ > RIEBL_RSVD_START \
701                                                                                  : (o) < RIEBL_RSVD_END)                         \
702                                 (o) = RIEBL_RSVD_END;                                                                            \
703                 }                                                                                                                                        \
704         } while(0)
705
706         for( i = 0; i < TX_RING_SIZE; i++ ) {
707                 CHECK_OFFSET(offset);
708                 MEM->tx_head[i].base = offset;
709                 MEM->tx_head[i].flag = TMD1_OWN_HOST;
710                 MEM->tx_head[i].base_hi = 0;
711                 MEM->tx_head[i].length = 0;
712                 MEM->tx_head[i].misc = 0;
713                 offset += PKT_BUF_SZ;
714         }
715
716         for( i = 0; i < RX_RING_SIZE; i++ ) {
717                 CHECK_OFFSET(offset);
718                 MEM->rx_head[i].base = offset;
719                 MEM->rx_head[i].flag = TMD1_OWN_CHIP;
720                 MEM->rx_head[i].base_hi = 0;
721                 MEM->rx_head[i].buf_length = -PKT_BUF_SZ;
722                 MEM->rx_head[i].msg_length = 0;
723                 offset += PKT_BUF_SZ;
724         }
725 }
726
727
728 /* XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX */
729
730
731 static void lance_tx_timeout (struct net_device *dev)
732 {
733         struct lance_private *lp = netdev_priv(dev);
734         struct lance_ioreg       *IO = lp->iobase;
735
736         AREG = CSR0;
737         DPRINTK( 1, ( "%s: transmit timed out, status %04x, resetting.\n",
738                           dev->name, DREG ));
739         DREG = CSR0_STOP;
740         /*
741          * Always set BSWP after a STOP as STOP puts it back into
742          * little endian mode.
743          */
744         REGA( CSR3 ) = CSR3_BSWP | (lp->cardtype == PAM_CARD ? CSR3_ACON : 0);
745         dev->stats.tx_errors++;
746 #ifndef final_version
747                 {       int i;
748                         DPRINTK( 2, ( "Ring data: dirty_tx %d cur_tx %d%s cur_rx %d\n",
749                                                   lp->dirty_tx, lp->cur_tx,
750                                                   lp->tx_full ? " (full)" : "",
751                                                   lp->cur_rx ));
752                         for( i = 0 ; i < RX_RING_SIZE; i++ )
753                                 DPRINTK( 2, ( "rx #%d: base=%04x blen=%04x mlen=%04x\n",
754                                                           i, MEM->rx_head[i].base,
755                                                           -MEM->rx_head[i].buf_length,
756                                                           MEM->rx_head[i].msg_length ));
757                         for( i = 0 ; i < TX_RING_SIZE; i++ )
758                                 DPRINTK( 2, ( "tx #%d: base=%04x len=%04x misc=%04x\n",
759                                                           i, MEM->tx_head[i].base,
760                                                           -MEM->tx_head[i].length,
761                                                           MEM->tx_head[i].misc ));
762                 }
763 #endif
764         /* XXX MSch: maybe purge/reinit ring here */
765         /* lance_restart, essentially */
766         lance_init_ring(dev);
767         REGA( CSR0 ) = CSR0_INEA | CSR0_INIT | CSR0_STRT;
768         netif_trans_update(dev); /* prevent tx timeout */
769         netif_wake_queue(dev);
770 }
771
772 /* XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX */
773
774 static netdev_tx_t
775 lance_start_xmit(struct sk_buff *skb, struct net_device *dev)
776 {
777         struct lance_private *lp = netdev_priv(dev);
778         struct lance_ioreg       *IO = lp->iobase;
779         int entry, len;
780         struct lance_tx_head *head;
781         unsigned long flags;
782
783         DPRINTK( 2, ( "%s: lance_start_xmit() called, csr0 %4.4x.\n",
784                                   dev->name, DREG ));
785
786
787         /* The old LANCE chips doesn't automatically pad buffers to min. size. */
788         len = skb->len;
789         if (len < ETH_ZLEN)
790                 len = ETH_ZLEN;
791         /* PAM-Card has a bug: Can only send packets with even number of bytes! */
792         else if (lp->cardtype == PAM_CARD && (len & 1))
793                 ++len;
794
795         if (len > skb->len) {
796                 if (skb_padto(skb, len))
797                         return NETDEV_TX_OK;
798         }
799
800         netif_stop_queue (dev);
801
802         /* Fill in a Tx ring entry */
803         if (lance_debug >= 3) {
804                 printk( "%s: TX pkt type 0x%04x from %pM to %pM"
805                                 " data at 0x%08x len %d\n",
806                                 dev->name, ((u_short *)skb->data)[6],
807                                 &skb->data[6], skb->data,
808                                 (int)skb->data, (int)skb->len );
809         }
810
811         /* We're not prepared for the int until the last flags are set/reset. And
812          * the int may happen already after setting the OWN_CHIP... */
813         spin_lock_irqsave (&lp->devlock, flags);
814
815         /* Mask to ring buffer boundary. */
816         entry = lp->cur_tx & TX_RING_MOD_MASK;
817         head  = &(MEM->tx_head[entry]);
818
819         /* Caution: the write order is important here, set the "ownership" bits
820          * last.
821          */
822
823
824         head->length = -len;
825         head->misc = 0;
826         lp->memcpy_f( PKTBUF_ADDR(head), (void *)skb->data, skb->len );
827         head->flag = TMD1_OWN_CHIP | TMD1_ENP | TMD1_STP;
828         dev->stats.tx_bytes += skb->len;
829         dev_kfree_skb( skb );
830         lp->cur_tx++;
831         while( lp->cur_tx >= TX_RING_SIZE && lp->dirty_tx >= TX_RING_SIZE ) {
832                 lp->cur_tx -= TX_RING_SIZE;
833                 lp->dirty_tx -= TX_RING_SIZE;
834         }
835
836         /* Trigger an immediate send poll. */
837         DREG = CSR0_INEA | CSR0_TDMD;
838
839         if ((MEM->tx_head[(entry+1) & TX_RING_MOD_MASK].flag & TMD1_OWN) ==
840                 TMD1_OWN_HOST)
841                 netif_start_queue (dev);
842         else
843                 lp->tx_full = 1;
844         spin_unlock_irqrestore (&lp->devlock, flags);
845
846         return NETDEV_TX_OK;
847 }
848
849 /* The LANCE interrupt handler. */
850
851 static irqreturn_t lance_interrupt( int irq, void *dev_id )
852 {
853         struct net_device *dev = dev_id;
854         struct lance_private *lp;
855         struct lance_ioreg       *IO;
856         int csr0, boguscnt = 10;
857         int handled = 0;
858
859         if (dev == NULL) {
860                 DPRINTK( 1, ( "lance_interrupt(): interrupt for unknown device.\n" ));
861                 return IRQ_NONE;
862         }
863
864         lp = netdev_priv(dev);
865         IO = lp->iobase;
866         spin_lock (&lp->devlock);
867
868         AREG = CSR0;
869
870         while( ((csr0 = DREG) & (CSR0_ERR | CSR0_TINT | CSR0_RINT)) &&
871                    --boguscnt >= 0) {
872                 handled = 1;
873                 /* Acknowledge all of the current interrupt sources ASAP. */
874                 DREG = csr0 & ~(CSR0_INIT | CSR0_STRT | CSR0_STOP |
875                                                                         CSR0_TDMD | CSR0_INEA);
876
877                 DPRINTK( 2, ( "%s: interrupt  csr0=%04x new csr=%04x.\n",
878                                           dev->name, csr0, DREG ));
879
880                 if (csr0 & CSR0_RINT)                   /* Rx interrupt */
881                         lance_rx( dev );
882
883                 if (csr0 & CSR0_TINT) {                 /* Tx-done interrupt */
884                         int dirty_tx = lp->dirty_tx;
885
886                         while( dirty_tx < lp->cur_tx) {
887                                 int entry = dirty_tx & TX_RING_MOD_MASK;
888                                 int status = MEM->tx_head[entry].flag;
889
890                                 if (status & TMD1_OWN_CHIP)
891                                         break;                  /* It still hasn't been Txed */
892
893                                 MEM->tx_head[entry].flag = 0;
894
895                                 if (status & TMD1_ERR) {
896                                         /* There was an major error, log it. */
897                                         int err_status = MEM->tx_head[entry].misc;
898                                         dev->stats.tx_errors++;
899                                         if (err_status & TMD3_RTRY) dev->stats.tx_aborted_errors++;
900                                         if (err_status & TMD3_LCAR) dev->stats.tx_carrier_errors++;
901                                         if (err_status & TMD3_LCOL) dev->stats.tx_window_errors++;
902                                         if (err_status & TMD3_UFLO) {
903                                                 /* Ackk!  On FIFO errors the Tx unit is turned off! */
904                                                 dev->stats.tx_fifo_errors++;
905                                                 /* Remove this verbosity later! */
906                                                 DPRINTK( 1, ( "%s: Tx FIFO error! Status %04x\n",
907                                                                           dev->name, csr0 ));
908                                                 /* Restart the chip. */
909                                                 DREG = CSR0_STRT;
910                                         }
911                                 } else {
912                                         if (status & (TMD1_MORE | TMD1_ONE | TMD1_DEF))
913                                                 dev->stats.collisions++;
914                                         dev->stats.tx_packets++;
915                                 }
916
917                                 /* XXX MSch: free skb?? */
918                                 dirty_tx++;
919                         }
920
921 #ifndef final_version
922                         if (lp->cur_tx - dirty_tx >= TX_RING_SIZE) {
923                                 DPRINTK( 0, ( "out-of-sync dirty pointer,"
924                                                           " %d vs. %d, full=%ld.\n",
925                                                           dirty_tx, lp->cur_tx, lp->tx_full ));
926                                 dirty_tx += TX_RING_SIZE;
927                         }
928 #endif
929
930                         if (lp->tx_full && (netif_queue_stopped(dev)) &&
931                                 dirty_tx > lp->cur_tx - TX_RING_SIZE + 2) {
932                                 /* The ring is no longer full, clear tbusy. */
933                                 lp->tx_full = 0;
934                                 netif_wake_queue (dev);
935                         }
936
937                         lp->dirty_tx = dirty_tx;
938                 }
939
940                 /* Log misc errors. */
941                 if (csr0 & CSR0_BABL) dev->stats.tx_errors++; /* Tx babble. */
942                 if (csr0 & CSR0_MISS) dev->stats.rx_errors++; /* Missed a Rx frame. */
943                 if (csr0 & CSR0_MERR) {
944                         DPRINTK( 1, ( "%s: Bus master arbitration failure (?!?), "
945                                                   "status %04x.\n", dev->name, csr0 ));
946                         /* Restart the chip. */
947                         DREG = CSR0_STRT;
948                 }
949         }
950
951     /* Clear any other interrupt, and set interrupt enable. */
952         DREG = CSR0_BABL | CSR0_CERR | CSR0_MISS | CSR0_MERR |
953                    CSR0_IDON | CSR0_INEA;
954
955         DPRINTK( 2, ( "%s: exiting interrupt, csr0=%#04x.\n",
956                                   dev->name, DREG ));
957
958         spin_unlock (&lp->devlock);
959         return IRQ_RETVAL(handled);
960 }
961
962
963 static int lance_rx( struct net_device *dev )
964 {
965         struct lance_private *lp = netdev_priv(dev);
966         int entry = lp->cur_rx & RX_RING_MOD_MASK;
967         int i;
968
969         DPRINTK( 2, ( "%s: rx int, flag=%04x\n", dev->name,
970                                   MEM->rx_head[entry].flag ));
971
972         /* If we own the next entry, it's a new packet. Send it up. */
973         while( (MEM->rx_head[entry].flag & RMD1_OWN) == RMD1_OWN_HOST ) {
974                 struct lance_rx_head *head = &(MEM->rx_head[entry]);
975                 int status = head->flag;
976
977                 if (status != (RMD1_ENP|RMD1_STP)) {            /* There was an error. */
978                         /* There is a tricky error noted by John Murphy,
979                            <murf@perftech.com> to Russ Nelson: Even with full-sized
980                            buffers it's possible for a jabber packet to use two
981                            buffers, with only the last correctly noting the error. */
982                         if (status & RMD1_ENP)  /* Only count a general error at the */
983                                 dev->stats.rx_errors++; /* end of a packet.*/
984                         if (status & RMD1_FRAM) dev->stats.rx_frame_errors++;
985                         if (status & RMD1_OFLO) dev->stats.rx_over_errors++;
986                         if (status & RMD1_CRC) dev->stats.rx_crc_errors++;
987                         if (status & RMD1_BUFF) dev->stats.rx_fifo_errors++;
988                         head->flag &= (RMD1_ENP|RMD1_STP);
989                 } else {
990                         /* Malloc up new buffer, compatible with net-3. */
991                         short pkt_len = head->msg_length & 0xfff;
992                         struct sk_buff *skb;
993
994                         if (pkt_len < 60) {
995                                 printk( "%s: Runt packet!\n", dev->name );
996                                 dev->stats.rx_errors++;
997                         }
998                         else {
999                                 skb = netdev_alloc_skb(dev, pkt_len + 2);
1000                                 if (skb == NULL) {
1001                                         for( i = 0; i < RX_RING_SIZE; i++ )
1002                                                 if (MEM->rx_head[(entry+i) & RX_RING_MOD_MASK].flag &
1003                                                         RMD1_OWN_CHIP)
1004                                                         break;
1005
1006                                         if (i > RX_RING_SIZE - 2) {
1007                                                 dev->stats.rx_dropped++;
1008                                                 head->flag |= RMD1_OWN_CHIP;
1009                                                 lp->cur_rx++;
1010                                         }
1011                                         break;
1012                                 }
1013
1014                                 if (lance_debug >= 3) {
1015                                         u_char *data = PKTBUF_ADDR(head);
1016
1017                                         printk(KERN_DEBUG "%s: RX pkt type 0x%04x from %pM to %pM "
1018                                                    "data %02x %02x %02x %02x %02x %02x %02x %02x "
1019                                                    "len %d\n",
1020                                                    dev->name, ((u_short *)data)[6],
1021                                                    &data[6], data,
1022                                                    data[15], data[16], data[17], data[18],
1023                                                    data[19], data[20], data[21], data[22],
1024                                                    pkt_len);
1025                                 }
1026
1027                                 skb_reserve( skb, 2 );  /* 16 byte align */
1028                                 skb_put( skb, pkt_len );        /* Make room */
1029                                 lp->memcpy_f( skb->data, PKTBUF_ADDR(head), pkt_len );
1030                                 skb->protocol = eth_type_trans( skb, dev );
1031                                 netif_rx( skb );
1032                                 dev->stats.rx_packets++;
1033                                 dev->stats.rx_bytes += pkt_len;
1034                         }
1035                 }
1036
1037                 head->flag |= RMD1_OWN_CHIP;
1038                 entry = (++lp->cur_rx) & RX_RING_MOD_MASK;
1039         }
1040         lp->cur_rx &= RX_RING_MOD_MASK;
1041
1042         /* From lance.c (Donald Becker): */
1043         /* We should check that at least two ring entries are free.      If not,
1044            we should free one and mark stats->rx_dropped++. */
1045
1046         return 0;
1047 }
1048
1049
1050 static int lance_close( struct net_device *dev )
1051 {
1052         struct lance_private *lp = netdev_priv(dev);
1053         struct lance_ioreg       *IO = lp->iobase;
1054
1055         netif_stop_queue (dev);
1056
1057         AREG = CSR0;
1058
1059         DPRINTK( 2, ( "%s: Shutting down ethercard, status was %2.2x.\n",
1060                                   dev->name, DREG ));
1061
1062         /* We stop the LANCE here -- it occasionally polls
1063            memory if we don't. */
1064         DREG = CSR0_STOP;
1065
1066         return 0;
1067 }
1068
1069
1070 /* Set or clear the multicast filter for this adaptor.
1071    num_addrs == -1              Promiscuous mode, receive all packets
1072    num_addrs == 0               Normal mode, clear multicast list
1073    num_addrs > 0                Multicast mode, receive normal and MC packets, and do
1074                                                 best-effort filtering.
1075  */
1076
1077 static void set_multicast_list( struct net_device *dev )
1078 {
1079         struct lance_private *lp = netdev_priv(dev);
1080         struct lance_ioreg       *IO = lp->iobase;
1081
1082         if (netif_running(dev))
1083                 /* Only possible if board is already started */
1084                 return;
1085
1086         /* We take the simple way out and always enable promiscuous mode. */
1087         DREG = CSR0_STOP; /* Temporarily stop the lance. */
1088
1089         if (dev->flags & IFF_PROMISC) {
1090                 /* Log any net taps. */
1091                 DPRINTK( 2, ( "%s: Promiscuous mode enabled.\n", dev->name ));
1092                 REGA( CSR15 ) = 0x8000; /* Set promiscuous mode */
1093         } else {
1094                 short multicast_table[4];
1095                 int num_addrs = netdev_mc_count(dev);
1096                 int i;
1097                 /* We don't use the multicast table, but rely on upper-layer
1098                  * filtering. */
1099                 memset( multicast_table, (num_addrs == 0) ? 0 : -1,
1100                                 sizeof(multicast_table) );
1101                 for( i = 0; i < 4; i++ )
1102                         REGA( CSR8+i ) = multicast_table[i];
1103                 REGA( CSR15 ) = 0; /* Unset promiscuous mode */
1104         }
1105
1106         /*
1107          * Always set BSWP after a STOP as STOP puts it back into
1108          * little endian mode.
1109          */
1110         REGA( CSR3 ) = CSR3_BSWP | (lp->cardtype == PAM_CARD ? CSR3_ACON : 0);
1111
1112         /* Resume normal operation and reset AREG to CSR0 */
1113         REGA( CSR0 ) = CSR0_IDON | CSR0_INEA | CSR0_STRT;
1114 }
1115
1116
1117 /* This is needed for old RieblCards and possible for new RieblCards */
1118
1119 static int lance_set_mac_address( struct net_device *dev, void *addr )
1120 {
1121         struct lance_private *lp = netdev_priv(dev);
1122         struct sockaddr *saddr = addr;
1123         int i;
1124
1125         if (lp->cardtype != OLD_RIEBL && lp->cardtype != NEW_RIEBL)
1126                 return -EOPNOTSUPP;
1127
1128         if (netif_running(dev)) {
1129                 /* Only possible while card isn't started */
1130                 DPRINTK( 1, ( "%s: hwaddr can be set only while card isn't open.\n",
1131                                           dev->name ));
1132                 return -EIO;
1133         }
1134
1135         memcpy( dev->dev_addr, saddr->sa_data, dev->addr_len );
1136         for( i = 0; i < 6; i++ )
1137                 MEM->init.hwaddr[i] = dev->dev_addr[i^1]; /* <- 16 bit swap! */
1138         lp->memcpy_f( RIEBL_HWADDR_ADDR, dev->dev_addr, 6 );
1139         /* set also the magic for future sessions */
1140         *RIEBL_MAGIC_ADDR = RIEBL_MAGIC;
1141
1142         return 0;
1143 }
1144
1145
1146 #ifdef MODULE
1147 static struct net_device *atarilance_dev;
1148
1149 static int __init atarilance_module_init(void)
1150 {
1151         atarilance_dev = atarilance_probe(-1);
1152         return PTR_ERR_OR_ZERO(atarilance_dev);
1153 }
1154
1155 static void __exit atarilance_module_exit(void)
1156 {
1157         unregister_netdev(atarilance_dev);
1158         free_irq(atarilance_dev->irq, atarilance_dev);
1159         free_netdev(atarilance_dev);
1160 }
1161 module_init(atarilance_module_init);
1162 module_exit(atarilance_module_exit);
1163 #endif /* MODULE */
1164
1165
1166 /*
1167  * Local variables:
1168  *  c-indent-level: 4
1169  *  tab-width: 4
1170  * End:
1171  */