Merge branch 'i2c/for-4.19' of git://git.kernel.org/pub/scm/linux/kernel/git/wsa...
[sfrench/cifs-2.6.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 const 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 int lance_start_xmit( struct sk_buff *skb, struct net_device *dev );
343 static irqreturn_t lance_interrupt( int irq, void *dev_id );
344 static int lance_rx( struct net_device *dev );
345 static int lance_close( struct net_device *dev );
346 static void set_multicast_list( struct net_device *dev );
347 static int lance_set_mac_address( struct net_device *dev, void *addr );
348 static void lance_tx_timeout (struct net_device *dev);
349
350 /************************* End of Prototypes **************************/
351
352
353
354
355
356 static void *slow_memcpy( void *dst, const void *src, size_t len )
357
358 {       char *cto = dst;
359         const char *cfrom = src;
360
361         while( len-- ) {
362                 *cto++ = *cfrom++;
363                 MFPDELAY();
364         }
365         return dst;
366 }
367
368
369 struct net_device * __init atarilance_probe(int unit)
370 {
371         int i;
372         static int found;
373         struct net_device *dev;
374         int err = -ENODEV;
375
376         if (!MACH_IS_ATARI || found)
377                 /* Assume there's only one board possible... That seems true, since
378                  * the Riebl/PAM board's address cannot be changed. */
379                 return ERR_PTR(-ENODEV);
380
381         dev = alloc_etherdev(sizeof(struct lance_private));
382         if (!dev)
383                 return ERR_PTR(-ENOMEM);
384         if (unit >= 0) {
385                 sprintf(dev->name, "eth%d", unit);
386                 netdev_boot_setup_check(dev);
387         }
388
389         for( i = 0; i < N_LANCE_ADDR; ++i ) {
390                 if (lance_probe1( dev, &lance_addr_list[i] )) {
391                         found = 1;
392                         err = register_netdev(dev);
393                         if (!err)
394                                 return dev;
395                         free_irq(dev->irq, dev);
396                         break;
397                 }
398         }
399         free_netdev(dev);
400         return ERR_PTR(err);
401 }
402
403
404 /* Derived from hwreg_present() in atari/config.c: */
405
406 static noinline int __init addr_accessible(volatile void *regp, int wordflag,
407                                            int writeflag)
408 {
409         int             ret;
410         unsigned long   flags;
411         long    *vbr, save_berr;
412
413         local_irq_save(flags);
414
415         __asm__ __volatile__ ( "movec   %/vbr,%0" : "=r" (vbr) : );
416         save_berr = vbr[2];
417
418         __asm__ __volatile__
419         (       "movel  %/sp,%/d1\n\t"
420                 "movel  #Lberr,%2@\n\t"
421                 "moveq  #0,%0\n\t"
422                 "tstl   %3\n\t"
423                 "bne    1f\n\t"
424                 "moveb  %1@,%/d0\n\t"
425                 "nop    \n\t"
426                 "bra    2f\n"
427 "1:              movew  %1@,%/d0\n\t"
428                 "nop    \n"
429 "2:              tstl   %4\n\t"
430                 "beq    2f\n\t"
431                 "tstl   %3\n\t"
432                 "bne    1f\n\t"
433                 "clrb   %1@\n\t"
434                 "nop    \n\t"
435                 "moveb  %/d0,%1@\n\t"
436                 "nop    \n\t"
437                 "bra    2f\n"
438 "1:              clrw   %1@\n\t"
439                 "nop    \n\t"
440                 "movew  %/d0,%1@\n\t"
441                 "nop    \n"
442 "2:              moveq  #1,%0\n"
443 "Lberr:  movel  %/d1,%/sp"
444                 : "=&d" (ret)
445                 : "a" (regp), "a" (&vbr[2]), "rm" (wordflag), "rm" (writeflag)
446                 : "d0", "d1", "memory"
447         );
448
449         vbr[2] = save_berr;
450         local_irq_restore(flags);
451
452         return ret;
453 }
454
455 static const struct net_device_ops lance_netdev_ops = {
456         .ndo_open               = lance_open,
457         .ndo_stop               = lance_close,
458         .ndo_start_xmit         = lance_start_xmit,
459         .ndo_set_rx_mode        = set_multicast_list,
460         .ndo_set_mac_address    = lance_set_mac_address,
461         .ndo_tx_timeout         = lance_tx_timeout,
462         .ndo_validate_addr      = eth_validate_addr,
463 };
464
465 static unsigned long __init lance_probe1( struct net_device *dev,
466                                            struct lance_addr *init_rec )
467 {
468         volatile unsigned short *memaddr =
469                 (volatile unsigned short *)init_rec->memaddr;
470         volatile unsigned short *ioaddr =
471                 (volatile unsigned short *)init_rec->ioaddr;
472         struct lance_private    *lp;
473         struct lance_ioreg              *IO;
474         int                                     i;
475         static int                              did_version;
476         unsigned short                  save1, save2;
477
478         PROBE_PRINT(( "Probing for Lance card at mem %#lx io %#lx\n",
479                                   (long)memaddr, (long)ioaddr ));
480
481         /* Test whether memory readable and writable */
482         PROBE_PRINT(( "lance_probe1: testing memory to be accessible\n" ));
483         if (!addr_accessible( memaddr, 1, 1 )) goto probe_fail;
484
485         /* Written values should come back... */
486         PROBE_PRINT(( "lance_probe1: testing memory to be writable (1)\n" ));
487         save1 = *memaddr;
488         *memaddr = 0x0001;
489         if (*memaddr != 0x0001) goto probe_fail;
490         PROBE_PRINT(( "lance_probe1: testing memory to be writable (2)\n" ));
491         *memaddr = 0x0000;
492         if (*memaddr != 0x0000) goto probe_fail;
493         *memaddr = save1;
494
495         /* First port should be readable and writable */
496         PROBE_PRINT(( "lance_probe1: testing ioport to be accessible\n" ));
497         if (!addr_accessible( ioaddr, 1, 1 )) goto probe_fail;
498
499         /* and written values should be readable */
500         PROBE_PRINT(( "lance_probe1: testing ioport to be writeable\n" ));
501         save2 = ioaddr[1];
502         ioaddr[1] = 0x0001;
503         if (ioaddr[1] != 0x0001) goto probe_fail;
504
505         /* The CSR0_INIT bit should not be readable */
506         PROBE_PRINT(( "lance_probe1: testing CSR0 register function (1)\n" ));
507         save1 = ioaddr[0];
508         ioaddr[1] = CSR0;
509         ioaddr[0] = CSR0_INIT | CSR0_STOP;
510         if (ioaddr[0] != CSR0_STOP) {
511                 ioaddr[0] = save1;
512                 ioaddr[1] = save2;
513                 goto probe_fail;
514         }
515         PROBE_PRINT(( "lance_probe1: testing CSR0 register function (2)\n" ));
516         ioaddr[0] = CSR0_STOP;
517         if (ioaddr[0] != CSR0_STOP) {
518                 ioaddr[0] = save1;
519                 ioaddr[1] = save2;
520                 goto probe_fail;
521         }
522
523         /* Now ok... */
524         PROBE_PRINT(( "lance_probe1: Lance card detected\n" ));
525         goto probe_ok;
526
527   probe_fail:
528         return 0;
529
530   probe_ok:
531         lp = netdev_priv(dev);
532         MEM = (struct lance_memory *)memaddr;
533         IO = lp->iobase = (struct lance_ioreg *)ioaddr;
534         dev->base_addr = (unsigned long)ioaddr; /* informational only */
535         lp->memcpy_f = init_rec->slow_flag ? slow_memcpy : memcpy;
536
537         REGA( CSR0 ) = CSR0_STOP;
538
539         /* Now test for type: If the eeprom I/O port is readable, it is a
540          * PAM card */
541         if (addr_accessible( &(IO->eeprom), 0, 0 )) {
542                 /* Switch back to Ram */
543                 i = IO->mem;
544                 lp->cardtype = PAM_CARD;
545         }
546         else if (*RIEBL_MAGIC_ADDR == RIEBL_MAGIC) {
547                 lp->cardtype = NEW_RIEBL;
548         }
549         else
550                 lp->cardtype = OLD_RIEBL;
551
552         if (lp->cardtype == PAM_CARD ||
553                 memaddr == (unsigned short *)0xffe00000) {
554                 /* PAMs card and Riebl on ST use level 5 autovector */
555                 if (request_irq(IRQ_AUTO_5, lance_interrupt, 0,
556                                 "PAM,Riebl-ST Ethernet", dev)) {
557                         printk( "Lance: request for irq %d failed\n", IRQ_AUTO_5 );
558                         return 0;
559                 }
560                 dev->irq = IRQ_AUTO_5;
561         }
562         else {
563                 /* For VME-RieblCards, request a free VME int */
564                 unsigned int irq = atari_register_vme_int();
565                 if (!irq) {
566                         printk( "Lance: request for VME interrupt failed\n" );
567                         return 0;
568                 }
569                 if (request_irq(irq, lance_interrupt, 0, "Riebl-VME Ethernet",
570                                 dev)) {
571                         printk( "Lance: request for irq %u failed\n", irq );
572                         return 0;
573                 }
574                 dev->irq = irq;
575         }
576
577         printk("%s: %s at io %#lx, mem %#lx, irq %d%s, hwaddr ",
578                    dev->name, lance_names[lp->cardtype],
579                    (unsigned long)ioaddr,
580                    (unsigned long)memaddr,
581                    dev->irq,
582                    init_rec->slow_flag ? " (slow memcpy)" : "" );
583
584         /* Get the ethernet address */
585         switch( lp->cardtype ) {
586           case OLD_RIEBL:
587                 /* No ethernet address! (Set some default address) */
588                 memcpy(dev->dev_addr, OldRieblDefHwaddr, ETH_ALEN);
589                 break;
590           case NEW_RIEBL:
591                 lp->memcpy_f(dev->dev_addr, RIEBL_HWADDR_ADDR, ETH_ALEN);
592                 break;
593           case PAM_CARD:
594                 i = IO->eeprom;
595                 for( i = 0; i < 6; ++i )
596                         dev->dev_addr[i] =
597                                 ((((unsigned short *)MEM)[i*2] & 0x0f) << 4) |
598                                 ((((unsigned short *)MEM)[i*2+1] & 0x0f));
599                 i = IO->mem;
600                 break;
601         }
602         printk("%pM\n", dev->dev_addr);
603         if (lp->cardtype == OLD_RIEBL) {
604                 printk( "%s: Warning: This is a default ethernet address!\n",
605                                 dev->name );
606                 printk( "      Use \"ifconfig hw ether ...\" to set the address.\n" );
607         }
608
609         spin_lock_init(&lp->devlock);
610
611         MEM->init.mode = 0x0000;                /* Disable Rx and Tx. */
612         for( i = 0; i < 6; i++ )
613                 MEM->init.hwaddr[i] = dev->dev_addr[i^1]; /* <- 16 bit swap! */
614         MEM->init.filter[0] = 0x00000000;
615         MEM->init.filter[1] = 0x00000000;
616         MEM->init.rx_ring.adr_lo = offsetof( struct lance_memory, rx_head );
617         MEM->init.rx_ring.adr_hi = 0;
618         MEM->init.rx_ring.len    = RX_RING_LEN_BITS;
619         MEM->init.tx_ring.adr_lo = offsetof( struct lance_memory, tx_head );
620         MEM->init.tx_ring.adr_hi = 0;
621         MEM->init.tx_ring.len    = TX_RING_LEN_BITS;
622
623         if (lp->cardtype == PAM_CARD)
624                 IO->ivec = IRQ_SOURCE_TO_VECTOR(dev->irq);
625         else
626                 *RIEBL_IVEC_ADDR = IRQ_SOURCE_TO_VECTOR(dev->irq);
627
628         if (did_version++ == 0)
629                 DPRINTK( 1, ( version ));
630
631         dev->netdev_ops = &lance_netdev_ops;
632
633         /* XXX MSch */
634         dev->watchdog_timeo = TX_TIMEOUT;
635
636         return 1;
637 }
638
639
640 static int lance_open( struct net_device *dev )
641 {
642         struct lance_private *lp = netdev_priv(dev);
643         struct lance_ioreg       *IO = lp->iobase;
644         int i;
645
646         DPRINTK( 2, ( "%s: lance_open()\n", dev->name ));
647
648         lance_init_ring(dev);
649         /* Re-initialize the LANCE, and start it when done. */
650
651         REGA( CSR3 ) = CSR3_BSWP | (lp->cardtype == PAM_CARD ? CSR3_ACON : 0);
652         REGA( CSR2 ) = 0;
653         REGA( CSR1 ) = 0;
654         REGA( CSR0 ) = CSR0_INIT;
655         /* From now on, AREG is kept to point to CSR0 */
656
657         i = 1000000;
658         while (--i > 0)
659                 if (DREG & CSR0_IDON)
660                         break;
661         if (i <= 0 || (DREG & CSR0_ERR)) {
662                 DPRINTK( 2, ( "lance_open(): opening %s failed, i=%d, csr0=%04x\n",
663                                           dev->name, i, DREG ));
664                 DREG = CSR0_STOP;
665                 return -EIO;
666         }
667         DREG = CSR0_IDON;
668         DREG = CSR0_STRT;
669         DREG = CSR0_INEA;
670
671         netif_start_queue (dev);
672
673         DPRINTK( 2, ( "%s: LANCE is open, csr0 %04x\n", dev->name, DREG ));
674
675         return 0;
676 }
677
678
679 /* Initialize the LANCE Rx and Tx rings. */
680
681 static void lance_init_ring( struct net_device *dev )
682 {
683         struct lance_private *lp = netdev_priv(dev);
684         int i;
685         unsigned offset;
686
687         lp->tx_full = 0;
688         lp->cur_rx = lp->cur_tx = 0;
689         lp->dirty_tx = 0;
690
691         offset = offsetof( struct lance_memory, packet_area );
692
693 /* If the packet buffer at offset 'o' would conflict with the reserved area
694  * of RieblCards, advance it */
695 #define CHECK_OFFSET(o)                                                                                                          \
696         do {                                                                                                                                     \
697                 if (lp->cardtype == OLD_RIEBL || lp->cardtype == NEW_RIEBL) {            \
698                         if (((o) < RIEBL_RSVD_START) ? (o)+PKT_BUF_SZ > RIEBL_RSVD_START \
699                                                                                  : (o) < RIEBL_RSVD_END)                         \
700                                 (o) = RIEBL_RSVD_END;                                                                            \
701                 }                                                                                                                                        \
702         } while(0)
703
704         for( i = 0; i < TX_RING_SIZE; i++ ) {
705                 CHECK_OFFSET(offset);
706                 MEM->tx_head[i].base = offset;
707                 MEM->tx_head[i].flag = TMD1_OWN_HOST;
708                 MEM->tx_head[i].base_hi = 0;
709                 MEM->tx_head[i].length = 0;
710                 MEM->tx_head[i].misc = 0;
711                 offset += PKT_BUF_SZ;
712         }
713
714         for( i = 0; i < RX_RING_SIZE; i++ ) {
715                 CHECK_OFFSET(offset);
716                 MEM->rx_head[i].base = offset;
717                 MEM->rx_head[i].flag = TMD1_OWN_CHIP;
718                 MEM->rx_head[i].base_hi = 0;
719                 MEM->rx_head[i].buf_length = -PKT_BUF_SZ;
720                 MEM->rx_head[i].msg_length = 0;
721                 offset += PKT_BUF_SZ;
722         }
723 }
724
725
726 /* XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX */
727
728
729 static void lance_tx_timeout (struct net_device *dev)
730 {
731         struct lance_private *lp = netdev_priv(dev);
732         struct lance_ioreg       *IO = lp->iobase;
733
734         AREG = CSR0;
735         DPRINTK( 1, ( "%s: transmit timed out, status %04x, resetting.\n",
736                           dev->name, DREG ));
737         DREG = CSR0_STOP;
738         /*
739          * Always set BSWP after a STOP as STOP puts it back into
740          * little endian mode.
741          */
742         REGA( CSR3 ) = CSR3_BSWP | (lp->cardtype == PAM_CARD ? CSR3_ACON : 0);
743         dev->stats.tx_errors++;
744 #ifndef final_version
745                 {       int i;
746                         DPRINTK( 2, ( "Ring data: dirty_tx %d cur_tx %d%s cur_rx %d\n",
747                                                   lp->dirty_tx, lp->cur_tx,
748                                                   lp->tx_full ? " (full)" : "",
749                                                   lp->cur_rx ));
750                         for( i = 0 ; i < RX_RING_SIZE; i++ )
751                                 DPRINTK( 2, ( "rx #%d: base=%04x blen=%04x mlen=%04x\n",
752                                                           i, MEM->rx_head[i].base,
753                                                           -MEM->rx_head[i].buf_length,
754                                                           MEM->rx_head[i].msg_length ));
755                         for( i = 0 ; i < TX_RING_SIZE; i++ )
756                                 DPRINTK( 2, ( "tx #%d: base=%04x len=%04x misc=%04x\n",
757                                                           i, MEM->tx_head[i].base,
758                                                           -MEM->tx_head[i].length,
759                                                           MEM->tx_head[i].misc ));
760                 }
761 #endif
762         /* XXX MSch: maybe purge/reinit ring here */
763         /* lance_restart, essentially */
764         lance_init_ring(dev);
765         REGA( CSR0 ) = CSR0_INEA | CSR0_INIT | CSR0_STRT;
766         netif_trans_update(dev); /* prevent tx timeout */
767         netif_wake_queue(dev);
768 }
769
770 /* XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX */
771
772 static int lance_start_xmit( struct sk_buff *skb, struct net_device *dev )
773 {
774         struct lance_private *lp = netdev_priv(dev);
775         struct lance_ioreg       *IO = lp->iobase;
776         int entry, len;
777         struct lance_tx_head *head;
778         unsigned long flags;
779
780         DPRINTK( 2, ( "%s: lance_start_xmit() called, csr0 %4.4x.\n",
781                                   dev->name, DREG ));
782
783
784         /* The old LANCE chips doesn't automatically pad buffers to min. size. */
785         len = skb->len;
786         if (len < ETH_ZLEN)
787                 len = ETH_ZLEN;
788         /* PAM-Card has a bug: Can only send packets with even number of bytes! */
789         else if (lp->cardtype == PAM_CARD && (len & 1))
790                 ++len;
791
792         if (len > skb->len) {
793                 if (skb_padto(skb, len))
794                         return NETDEV_TX_OK;
795         }
796
797         netif_stop_queue (dev);
798
799         /* Fill in a Tx ring entry */
800         if (lance_debug >= 3) {
801                 printk( "%s: TX pkt type 0x%04x from %pM to %pM"
802                                 " data at 0x%08x len %d\n",
803                                 dev->name, ((u_short *)skb->data)[6],
804                                 &skb->data[6], skb->data,
805                                 (int)skb->data, (int)skb->len );
806         }
807
808         /* We're not prepared for the int until the last flags are set/reset. And
809          * the int may happen already after setting the OWN_CHIP... */
810         spin_lock_irqsave (&lp->devlock, flags);
811
812         /* Mask to ring buffer boundary. */
813         entry = lp->cur_tx & TX_RING_MOD_MASK;
814         head  = &(MEM->tx_head[entry]);
815
816         /* Caution: the write order is important here, set the "ownership" bits
817          * last.
818          */
819
820
821         head->length = -len;
822         head->misc = 0;
823         lp->memcpy_f( PKTBUF_ADDR(head), (void *)skb->data, skb->len );
824         head->flag = TMD1_OWN_CHIP | TMD1_ENP | TMD1_STP;
825         dev->stats.tx_bytes += skb->len;
826         dev_kfree_skb( skb );
827         lp->cur_tx++;
828         while( lp->cur_tx >= TX_RING_SIZE && lp->dirty_tx >= TX_RING_SIZE ) {
829                 lp->cur_tx -= TX_RING_SIZE;
830                 lp->dirty_tx -= TX_RING_SIZE;
831         }
832
833         /* Trigger an immediate send poll. */
834         DREG = CSR0_INEA | CSR0_TDMD;
835
836         if ((MEM->tx_head[(entry+1) & TX_RING_MOD_MASK].flag & TMD1_OWN) ==
837                 TMD1_OWN_HOST)
838                 netif_start_queue (dev);
839         else
840                 lp->tx_full = 1;
841         spin_unlock_irqrestore (&lp->devlock, flags);
842
843         return NETDEV_TX_OK;
844 }
845
846 /* The LANCE interrupt handler. */
847
848 static irqreturn_t lance_interrupt( int irq, void *dev_id )
849 {
850         struct net_device *dev = dev_id;
851         struct lance_private *lp;
852         struct lance_ioreg       *IO;
853         int csr0, boguscnt = 10;
854         int handled = 0;
855
856         if (dev == NULL) {
857                 DPRINTK( 1, ( "lance_interrupt(): interrupt for unknown device.\n" ));
858                 return IRQ_NONE;
859         }
860
861         lp = netdev_priv(dev);
862         IO = lp->iobase;
863         spin_lock (&lp->devlock);
864
865         AREG = CSR0;
866
867         while( ((csr0 = DREG) & (CSR0_ERR | CSR0_TINT | CSR0_RINT)) &&
868                    --boguscnt >= 0) {
869                 handled = 1;
870                 /* Acknowledge all of the current interrupt sources ASAP. */
871                 DREG = csr0 & ~(CSR0_INIT | CSR0_STRT | CSR0_STOP |
872                                                                         CSR0_TDMD | CSR0_INEA);
873
874                 DPRINTK( 2, ( "%s: interrupt  csr0=%04x new csr=%04x.\n",
875                                           dev->name, csr0, DREG ));
876
877                 if (csr0 & CSR0_RINT)                   /* Rx interrupt */
878                         lance_rx( dev );
879
880                 if (csr0 & CSR0_TINT) {                 /* Tx-done interrupt */
881                         int dirty_tx = lp->dirty_tx;
882
883                         while( dirty_tx < lp->cur_tx) {
884                                 int entry = dirty_tx & TX_RING_MOD_MASK;
885                                 int status = MEM->tx_head[entry].flag;
886
887                                 if (status & TMD1_OWN_CHIP)
888                                         break;                  /* It still hasn't been Txed */
889
890                                 MEM->tx_head[entry].flag = 0;
891
892                                 if (status & TMD1_ERR) {
893                                         /* There was an major error, log it. */
894                                         int err_status = MEM->tx_head[entry].misc;
895                                         dev->stats.tx_errors++;
896                                         if (err_status & TMD3_RTRY) dev->stats.tx_aborted_errors++;
897                                         if (err_status & TMD3_LCAR) dev->stats.tx_carrier_errors++;
898                                         if (err_status & TMD3_LCOL) dev->stats.tx_window_errors++;
899                                         if (err_status & TMD3_UFLO) {
900                                                 /* Ackk!  On FIFO errors the Tx unit is turned off! */
901                                                 dev->stats.tx_fifo_errors++;
902                                                 /* Remove this verbosity later! */
903                                                 DPRINTK( 1, ( "%s: Tx FIFO error! Status %04x\n",
904                                                                           dev->name, csr0 ));
905                                                 /* Restart the chip. */
906                                                 DREG = CSR0_STRT;
907                                         }
908                                 } else {
909                                         if (status & (TMD1_MORE | TMD1_ONE | TMD1_DEF))
910                                                 dev->stats.collisions++;
911                                         dev->stats.tx_packets++;
912                                 }
913
914                                 /* XXX MSch: free skb?? */
915                                 dirty_tx++;
916                         }
917
918 #ifndef final_version
919                         if (lp->cur_tx - dirty_tx >= TX_RING_SIZE) {
920                                 DPRINTK( 0, ( "out-of-sync dirty pointer,"
921                                                           " %d vs. %d, full=%ld.\n",
922                                                           dirty_tx, lp->cur_tx, lp->tx_full ));
923                                 dirty_tx += TX_RING_SIZE;
924                         }
925 #endif
926
927                         if (lp->tx_full && (netif_queue_stopped(dev)) &&
928                                 dirty_tx > lp->cur_tx - TX_RING_SIZE + 2) {
929                                 /* The ring is no longer full, clear tbusy. */
930                                 lp->tx_full = 0;
931                                 netif_wake_queue (dev);
932                         }
933
934                         lp->dirty_tx = dirty_tx;
935                 }
936
937                 /* Log misc errors. */
938                 if (csr0 & CSR0_BABL) dev->stats.tx_errors++; /* Tx babble. */
939                 if (csr0 & CSR0_MISS) dev->stats.rx_errors++; /* Missed a Rx frame. */
940                 if (csr0 & CSR0_MERR) {
941                         DPRINTK( 1, ( "%s: Bus master arbitration failure (?!?), "
942                                                   "status %04x.\n", dev->name, csr0 ));
943                         /* Restart the chip. */
944                         DREG = CSR0_STRT;
945                 }
946         }
947
948     /* Clear any other interrupt, and set interrupt enable. */
949         DREG = CSR0_BABL | CSR0_CERR | CSR0_MISS | CSR0_MERR |
950                    CSR0_IDON | CSR0_INEA;
951
952         DPRINTK( 2, ( "%s: exiting interrupt, csr0=%#04x.\n",
953                                   dev->name, DREG ));
954
955         spin_unlock (&lp->devlock);
956         return IRQ_RETVAL(handled);
957 }
958
959
960 static int lance_rx( struct net_device *dev )
961 {
962         struct lance_private *lp = netdev_priv(dev);
963         int entry = lp->cur_rx & RX_RING_MOD_MASK;
964         int i;
965
966         DPRINTK( 2, ( "%s: rx int, flag=%04x\n", dev->name,
967                                   MEM->rx_head[entry].flag ));
968
969         /* If we own the next entry, it's a new packet. Send it up. */
970         while( (MEM->rx_head[entry].flag & RMD1_OWN) == RMD1_OWN_HOST ) {
971                 struct lance_rx_head *head = &(MEM->rx_head[entry]);
972                 int status = head->flag;
973
974                 if (status != (RMD1_ENP|RMD1_STP)) {            /* There was an error. */
975                         /* There is a tricky error noted by John Murphy,
976                            <murf@perftech.com> to Russ Nelson: Even with full-sized
977                            buffers it's possible for a jabber packet to use two
978                            buffers, with only the last correctly noting the error. */
979                         if (status & RMD1_ENP)  /* Only count a general error at the */
980                                 dev->stats.rx_errors++; /* end of a packet.*/
981                         if (status & RMD1_FRAM) dev->stats.rx_frame_errors++;
982                         if (status & RMD1_OFLO) dev->stats.rx_over_errors++;
983                         if (status & RMD1_CRC) dev->stats.rx_crc_errors++;
984                         if (status & RMD1_BUFF) dev->stats.rx_fifo_errors++;
985                         head->flag &= (RMD1_ENP|RMD1_STP);
986                 } else {
987                         /* Malloc up new buffer, compatible with net-3. */
988                         short pkt_len = head->msg_length & 0xfff;
989                         struct sk_buff *skb;
990
991                         if (pkt_len < 60) {
992                                 printk( "%s: Runt packet!\n", dev->name );
993                                 dev->stats.rx_errors++;
994                         }
995                         else {
996                                 skb = netdev_alloc_skb(dev, pkt_len + 2);
997                                 if (skb == NULL) {
998                                         for( i = 0; i < RX_RING_SIZE; i++ )
999                                                 if (MEM->rx_head[(entry+i) & RX_RING_MOD_MASK].flag &
1000                                                         RMD1_OWN_CHIP)
1001                                                         break;
1002
1003                                         if (i > RX_RING_SIZE - 2) {
1004                                                 dev->stats.rx_dropped++;
1005                                                 head->flag |= RMD1_OWN_CHIP;
1006                                                 lp->cur_rx++;
1007                                         }
1008                                         break;
1009                                 }
1010
1011                                 if (lance_debug >= 3) {
1012                                         u_char *data = PKTBUF_ADDR(head);
1013
1014                                         printk(KERN_DEBUG "%s: RX pkt type 0x%04x from %pM to %pM "
1015                                                    "data %8ph len %d\n",
1016                                                    dev->name, ((u_short *)data)[6],
1017                                                    &data[6], data, &data[15], pkt_len);
1018                                 }
1019
1020                                 skb_reserve( skb, 2 );  /* 16 byte align */
1021                                 skb_put( skb, pkt_len );        /* Make room */
1022                                 lp->memcpy_f( skb->data, PKTBUF_ADDR(head), pkt_len );
1023                                 skb->protocol = eth_type_trans( skb, dev );
1024                                 netif_rx( skb );
1025                                 dev->stats.rx_packets++;
1026                                 dev->stats.rx_bytes += pkt_len;
1027                         }
1028                 }
1029
1030                 head->flag |= RMD1_OWN_CHIP;
1031                 entry = (++lp->cur_rx) & RX_RING_MOD_MASK;
1032         }
1033         lp->cur_rx &= RX_RING_MOD_MASK;
1034
1035         /* From lance.c (Donald Becker): */
1036         /* We should check that at least two ring entries are free.      If not,
1037            we should free one and mark stats->rx_dropped++. */
1038
1039         return 0;
1040 }
1041
1042
1043 static int lance_close( struct net_device *dev )
1044 {
1045         struct lance_private *lp = netdev_priv(dev);
1046         struct lance_ioreg       *IO = lp->iobase;
1047
1048         netif_stop_queue (dev);
1049
1050         AREG = CSR0;
1051
1052         DPRINTK( 2, ( "%s: Shutting down ethercard, status was %2.2x.\n",
1053                                   dev->name, DREG ));
1054
1055         /* We stop the LANCE here -- it occasionally polls
1056            memory if we don't. */
1057         DREG = CSR0_STOP;
1058
1059         return 0;
1060 }
1061
1062
1063 /* Set or clear the multicast filter for this adaptor.
1064    num_addrs == -1              Promiscuous mode, receive all packets
1065    num_addrs == 0               Normal mode, clear multicast list
1066    num_addrs > 0                Multicast mode, receive normal and MC packets, and do
1067                                                 best-effort filtering.
1068  */
1069
1070 static void set_multicast_list( struct net_device *dev )
1071 {
1072         struct lance_private *lp = netdev_priv(dev);
1073         struct lance_ioreg       *IO = lp->iobase;
1074
1075         if (netif_running(dev))
1076                 /* Only possible if board is already started */
1077                 return;
1078
1079         /* We take the simple way out and always enable promiscuous mode. */
1080         DREG = CSR0_STOP; /* Temporarily stop the lance. */
1081
1082         if (dev->flags & IFF_PROMISC) {
1083                 /* Log any net taps. */
1084                 DPRINTK( 2, ( "%s: Promiscuous mode enabled.\n", dev->name ));
1085                 REGA( CSR15 ) = 0x8000; /* Set promiscuous mode */
1086         } else {
1087                 short multicast_table[4];
1088                 int num_addrs = netdev_mc_count(dev);
1089                 int i;
1090                 /* We don't use the multicast table, but rely on upper-layer
1091                  * filtering. */
1092                 memset( multicast_table, (num_addrs == 0) ? 0 : -1,
1093                                 sizeof(multicast_table) );
1094                 for( i = 0; i < 4; i++ )
1095                         REGA( CSR8+i ) = multicast_table[i];
1096                 REGA( CSR15 ) = 0; /* Unset promiscuous mode */
1097         }
1098
1099         /*
1100          * Always set BSWP after a STOP as STOP puts it back into
1101          * little endian mode.
1102          */
1103         REGA( CSR3 ) = CSR3_BSWP | (lp->cardtype == PAM_CARD ? CSR3_ACON : 0);
1104
1105         /* Resume normal operation and reset AREG to CSR0 */
1106         REGA( CSR0 ) = CSR0_IDON | CSR0_INEA | CSR0_STRT;
1107 }
1108
1109
1110 /* This is needed for old RieblCards and possible for new RieblCards */
1111
1112 static int lance_set_mac_address( struct net_device *dev, void *addr )
1113 {
1114         struct lance_private *lp = netdev_priv(dev);
1115         struct sockaddr *saddr = addr;
1116         int i;
1117
1118         if (lp->cardtype != OLD_RIEBL && lp->cardtype != NEW_RIEBL)
1119                 return -EOPNOTSUPP;
1120
1121         if (netif_running(dev)) {
1122                 /* Only possible while card isn't started */
1123                 DPRINTK( 1, ( "%s: hwaddr can be set only while card isn't open.\n",
1124                                           dev->name ));
1125                 return -EIO;
1126         }
1127
1128         memcpy( dev->dev_addr, saddr->sa_data, dev->addr_len );
1129         for( i = 0; i < 6; i++ )
1130                 MEM->init.hwaddr[i] = dev->dev_addr[i^1]; /* <- 16 bit swap! */
1131         lp->memcpy_f( RIEBL_HWADDR_ADDR, dev->dev_addr, 6 );
1132         /* set also the magic for future sessions */
1133         *RIEBL_MAGIC_ADDR = RIEBL_MAGIC;
1134
1135         return 0;
1136 }
1137
1138
1139 #ifdef MODULE
1140 static struct net_device *atarilance_dev;
1141
1142 static int __init atarilance_module_init(void)
1143 {
1144         atarilance_dev = atarilance_probe(-1);
1145         return PTR_ERR_OR_ZERO(atarilance_dev);
1146 }
1147
1148 static void __exit atarilance_module_exit(void)
1149 {
1150         unregister_netdev(atarilance_dev);
1151         free_irq(atarilance_dev->irq, atarilance_dev);
1152         free_netdev(atarilance_dev);
1153 }
1154 module_init(atarilance_module_init);
1155 module_exit(atarilance_module_exit);
1156 #endif /* MODULE */
1157
1158
1159 /*
1160  * Local variables:
1161  *  c-indent-level: 4
1162  *  tab-width: 4
1163  * End:
1164  */