drivers/net/s2io.c: fix sparse warning: symbol shadows an earlier one
[linux-3.10.git] / drivers / net / arcnet / arcnet.c
1 /*
2  * Linux ARCnet driver - device-independent routines
3  * 
4  * Written 1997 by David Woodhouse.
5  * Written 1994-1999 by Avery Pennarun.
6  * Written 1999-2000 by Martin Mares <mj@ucw.cz>.
7  * Derived from skeleton.c by Donald Becker.
8  *
9  * Special thanks to Contemporary Controls, Inc. (www.ccontrols.com)
10  *  for sponsoring the further development of this driver.
11  *
12  * **********************
13  *
14  * The original copyright was as follows:
15  *
16  * skeleton.c Written 1993 by Donald Becker.
17  * Copyright 1993 United States Government as represented by the
18  * Director, National Security Agency.  This software may only be used
19  * and distributed according to the terms of the GNU General Public License as
20  * modified by SRC, incorporated herein by reference.
21  *
22  * **********************
23  * 
24  * The change log is now in a file called ChangeLog in this directory.
25  *
26  * Sources:
27  *  - Crynwr arcnet.com/arcether.com packet drivers.
28  *  - arcnet.c v0.00 dated 1/1/94 and apparently by 
29  *     Donald Becker - it didn't work :)
30  *  - skeleton.c v0.05 dated 11/16/93 by Donald Becker
31  *     (from Linux Kernel 1.1.45)
32  *  - RFC's 1201 and 1051 - re: TCP/IP over ARCnet
33  *  - The official ARCnet COM9026 data sheets (!) thanks to
34  *     Ken Cornetet <kcornete@nyx10.cs.du.edu>
35  *  - The official ARCnet COM20020 data sheets.
36  *  - Information on some more obscure ARCnet controller chips, thanks
37  *     to the nice people at SMSC.
38  *  - net/inet/eth.c (from kernel 1.1.50) for header-building info.
39  *  - Alternate Linux ARCnet source by V.Shergin <vsher@sao.stavropol.su>
40  *  - Textual information and more alternate source from Joachim Koenig
41  *     <jojo@repas.de>
42  */
43
44 #define VERSION "arcnet: v3.94 BETA 2007/02/08 - by Avery Pennarun et al.\n"
45
46 #include <linux/module.h>
47 #include <linux/types.h>
48 #include <linux/delay.h>
49 #include <linux/netdevice.h>
50 #include <linux/if_arp.h>
51 #include <net/arp.h>
52 #include <linux/init.h>
53 #include <linux/arcdevice.h>
54 #include <linux/jiffies.h>
55
56 /* "do nothing" functions for protocol drivers */
57 static void null_rx(struct net_device *dev, int bufnum,
58                     struct archdr *pkthdr, int length);
59 static int null_build_header(struct sk_buff *skb, struct net_device *dev,
60                              unsigned short type, uint8_t daddr);
61 static int null_prepare_tx(struct net_device *dev, struct archdr *pkt,
62                            int length, int bufnum);
63
64 static void arcnet_rx(struct net_device *dev, int bufnum);
65
66 /*
67  * one ArcProto per possible proto ID.  None of the elements of
68  * arc_proto_map are allowed to be NULL; they will get set to
69  * arc_proto_default instead.  It also must not be NULL; if you would like
70  * to set it to NULL, set it to &arc_proto_null instead.
71  */
72  struct ArcProto *arc_proto_map[256], *arc_proto_default,
73    *arc_bcast_proto, *arc_raw_proto;
74
75 static struct ArcProto arc_proto_null =
76 {
77         .suffix         = '?',
78         .mtu            = XMTU,
79         .is_ip          = 0,
80         .rx             = null_rx,
81         .build_header   = null_build_header,
82         .prepare_tx     = null_prepare_tx,
83         .continue_tx    = NULL,
84         .ack_tx         = NULL
85 };
86
87 /* Exported function prototypes */
88 int arcnet_debug = ARCNET_DEBUG;
89
90 EXPORT_SYMBOL(arc_proto_map);
91 EXPORT_SYMBOL(arc_proto_default);
92 EXPORT_SYMBOL(arc_bcast_proto);
93 EXPORT_SYMBOL(arc_raw_proto);
94 EXPORT_SYMBOL(arcnet_unregister_proto);
95 EXPORT_SYMBOL(arcnet_debug);
96 EXPORT_SYMBOL(alloc_arcdev);
97 EXPORT_SYMBOL(arcnet_interrupt);
98 EXPORT_SYMBOL(arcnet_open);
99 EXPORT_SYMBOL(arcnet_close);
100 EXPORT_SYMBOL(arcnet_send_packet);
101 EXPORT_SYMBOL(arcnet_timeout);
102
103 /* Internal function prototypes */
104 static int arcnet_header(struct sk_buff *skb, struct net_device *dev,
105                          unsigned short type, const void *daddr,
106                          const void *saddr, unsigned len);
107 static int arcnet_rebuild_header(struct sk_buff *skb);
108 static int go_tx(struct net_device *dev);
109
110 static int debug = ARCNET_DEBUG;
111 module_param(debug, int, 0);
112 MODULE_LICENSE("GPL");
113
114 static int __init arcnet_init(void)
115 {
116         int count;
117
118         arcnet_debug = debug;
119
120         printk("arcnet loaded.\n");
121
122 #ifdef ALPHA_WARNING
123         BUGLVL(D_EXTRA) {
124                 printk("arcnet: ***\n"
125                 "arcnet: * Read arcnet.txt for important release notes!\n"
126                        "arcnet: *\n"
127                        "arcnet: * This is an ALPHA version! (Last stable release: v3.02)  E-mail\n"
128                        "arcnet: * me if you have any questions, comments, or bug reports.\n"
129                        "arcnet: ***\n");
130         }
131 #endif
132
133         /* initialize the protocol map */
134         arc_raw_proto = arc_proto_default = arc_bcast_proto = &arc_proto_null;
135         for (count = 0; count < 256; count++)
136                 arc_proto_map[count] = arc_proto_default;
137
138         BUGLVL(D_DURING)
139             printk("arcnet: struct sizes: %Zd %Zd %Zd %Zd %Zd\n",
140                  sizeof(struct arc_hardware), sizeof(struct arc_rfc1201),
141                 sizeof(struct arc_rfc1051), sizeof(struct arc_eth_encap),
142                    sizeof(struct archdr));
143
144         return 0;
145 }
146
147 static void __exit arcnet_exit(void)
148 {
149 }
150
151 module_init(arcnet_init);
152 module_exit(arcnet_exit);
153
154 /*
155  * Dump the contents of an sk_buff
156  */
157 #if ARCNET_DEBUG_MAX & D_SKB
158 void arcnet_dump_skb(struct net_device *dev,
159                      struct sk_buff *skb, char *desc)
160 {
161         int i;
162
163         printk(KERN_DEBUG "%6s: skb dump (%s) follows:", dev->name, desc);
164         for (i = 0; i < skb->len; i++) {
165                 if (i % 16 == 0)
166                         printk("\n" KERN_DEBUG "[%04X] ", i);
167                 printk("%02X ", ((u_char *) skb->data)[i]);
168         }
169         printk("\n");
170 }
171
172 EXPORT_SYMBOL(arcnet_dump_skb);
173 #endif
174
175
176 /*
177  * Dump the contents of an ARCnet buffer
178  */
179 #if (ARCNET_DEBUG_MAX & (D_RX | D_TX))
180 static void arcnet_dump_packet(struct net_device *dev, int bufnum,
181                                char *desc, int take_arcnet_lock)
182 {
183         struct arcnet_local *lp = netdev_priv(dev);
184         int i, length;
185         unsigned long flags = 0;
186         static uint8_t buf[512];
187
188         /* hw.copy_from_card expects IRQ context so take the IRQ lock
189            to keep it single threaded */
190         if(take_arcnet_lock)
191                 spin_lock_irqsave(&lp->lock, flags);
192
193         lp->hw.copy_from_card(dev, bufnum, 0, buf, 512);
194         if(take_arcnet_lock)
195                 spin_unlock_irqrestore(&lp->lock, flags);
196
197         /* if the offset[0] byte is nonzero, this is a 256-byte packet */
198         length = (buf[2] ? 256 : 512);
199
200         printk(KERN_DEBUG "%6s: packet dump (%s) follows:", dev->name, desc);
201         for (i = 0; i < length; i++) {
202                 if (i % 16 == 0)
203                         printk("\n" KERN_DEBUG "[%04X] ", i);
204                 printk("%02X ", buf[i]);
205         }
206         printk("\n");
207
208 }
209
210 #else
211
212 #define arcnet_dump_packet(dev, bufnum, desc,take_arcnet_lock) do { } while (0)
213
214 #endif
215
216
217 /*
218  * Unregister a protocol driver from the arc_proto_map.  Protocol drivers
219  * are responsible for registering themselves, but the unregister routine
220  * is pretty generic so we'll do it here.
221  */
222 void arcnet_unregister_proto(struct ArcProto *proto)
223 {
224         int count;
225
226         if (arc_proto_default == proto)
227                 arc_proto_default = &arc_proto_null;
228         if (arc_bcast_proto == proto)
229                 arc_bcast_proto = arc_proto_default;
230         if (arc_raw_proto == proto)
231                 arc_raw_proto = arc_proto_default;
232
233         for (count = 0; count < 256; count++) {
234                 if (arc_proto_map[count] == proto)
235                         arc_proto_map[count] = arc_proto_default;
236         }
237 }
238
239
240 /*
241  * Add a buffer to the queue.  Only the interrupt handler is allowed to do
242  * this, unless interrupts are disabled.
243  * 
244  * Note: we don't check for a full queue, since there aren't enough buffers
245  * to more than fill it.
246  */
247 static void release_arcbuf(struct net_device *dev, int bufnum)
248 {
249         struct arcnet_local *lp = netdev_priv(dev);
250         int i;
251
252         lp->buf_queue[lp->first_free_buf++] = bufnum;
253         lp->first_free_buf %= 5;
254
255         BUGLVL(D_DURING) {
256                 BUGMSG(D_DURING, "release_arcbuf: freed #%d; buffer queue is now: ",
257                        bufnum);
258                 for (i = lp->next_buf; i != lp->first_free_buf; i = (i+1) % 5)
259                         BUGMSG2(D_DURING, "#%d ", lp->buf_queue[i]);
260                 BUGMSG2(D_DURING, "\n");
261         }
262 }
263
264
265 /*
266  * Get a buffer from the queue.  If this returns -1, there are no buffers
267  * available.
268  */
269 static int get_arcbuf(struct net_device *dev)
270 {
271         struct arcnet_local *lp = netdev_priv(dev);
272         int buf = -1, i;
273
274         if (!atomic_dec_and_test(&lp->buf_lock)) {
275                 /* already in this function */
276                 BUGMSG(D_NORMAL, "get_arcbuf: overlap (%d)!\n",
277                        lp->buf_lock.counter);
278         }
279         else {                  /* we can continue */
280                 if (lp->next_buf >= 5)
281                         lp->next_buf -= 5;
282
283                 if (lp->next_buf == lp->first_free_buf)
284                         BUGMSG(D_NORMAL, "get_arcbuf: BUG: no buffers are available??\n");
285                 else {
286                         buf = lp->buf_queue[lp->next_buf++];
287                         lp->next_buf %= 5;
288                 }
289         }
290
291
292         BUGLVL(D_DURING) {
293                 BUGMSG(D_DURING, "get_arcbuf: got #%d; buffer queue is now: ", buf);
294                 for (i = lp->next_buf; i != lp->first_free_buf; i = (i+1) % 5)
295                         BUGMSG2(D_DURING, "#%d ", lp->buf_queue[i]);
296                 BUGMSG2(D_DURING, "\n");
297         }
298
299         atomic_inc(&lp->buf_lock);
300         return buf;
301 }
302
303
304 static int choose_mtu(void)
305 {
306         int count, mtu = 65535;
307
308         /* choose the smallest MTU of all available encaps */
309         for (count = 0; count < 256; count++) {
310                 if (arc_proto_map[count] != &arc_proto_null
311                     && arc_proto_map[count]->mtu < mtu) {
312                         mtu = arc_proto_map[count]->mtu;
313                 }
314         }
315
316         return mtu == 65535 ? XMTU : mtu;
317 }
318
319 static const struct header_ops arcnet_header_ops = {
320         .create = arcnet_header,
321         .rebuild = arcnet_rebuild_header,
322 };
323
324 static const struct net_device_ops arcnet_netdev_ops = {
325         .ndo_open       = arcnet_open,
326         .ndo_stop       = arcnet_close,
327         .ndo_start_xmit = arcnet_send_packet,
328         .ndo_tx_timeout = arcnet_timeout,
329 };
330
331 /* Setup a struct device for ARCnet. */
332 static void arcdev_setup(struct net_device *dev)
333 {
334         dev->type = ARPHRD_ARCNET;
335         dev->netdev_ops = &arcnet_netdev_ops;
336         dev->header_ops = &arcnet_header_ops;
337         dev->hard_header_len = sizeof(struct archdr);
338         dev->mtu = choose_mtu();
339
340         dev->addr_len = ARCNET_ALEN;
341         dev->tx_queue_len = 100;
342         dev->broadcast[0] = 0x00;       /* for us, broadcasts are address 0 */
343         dev->watchdog_timeo = TX_TIMEOUT;
344
345         /* New-style flags. */
346         dev->flags = IFF_BROADCAST;
347
348 }
349
350 struct net_device *alloc_arcdev(const char *name)
351 {
352         struct net_device *dev;
353
354         dev = alloc_netdev(sizeof(struct arcnet_local),
355                            name && *name ? name : "arc%d", arcdev_setup);
356         if(dev) {
357                 struct arcnet_local *lp = netdev_priv(dev);
358                 spin_lock_init(&lp->lock);
359         }
360
361         return dev;
362 }
363
364 /*
365  * Open/initialize the board.  This is called sometime after booting when
366  * the 'ifconfig' program is run.
367  *
368  * This routine should set everything up anew at each open, even registers
369  * that "should" only need to be set once at boot, so that there is
370  * non-reboot way to recover if something goes wrong.
371  */
372 int arcnet_open(struct net_device *dev)
373 {
374         struct arcnet_local *lp = netdev_priv(dev);
375         int count, newmtu, error;
376
377         BUGMSG(D_INIT,"opened.");
378
379         if (!try_module_get(lp->hw.owner))
380                 return -ENODEV;
381
382         BUGLVL(D_PROTO) {
383                 int count;
384                 BUGMSG(D_PROTO, "protocol map (default is '%c'): ",
385                        arc_proto_default->suffix);
386                 for (count = 0; count < 256; count++)
387                         BUGMSG2(D_PROTO, "%c", arc_proto_map[count]->suffix);
388                 BUGMSG2(D_PROTO, "\n");
389         }
390
391
392         BUGMSG(D_INIT, "arcnet_open: resetting card.\n");
393
394         /* try to put the card in a defined state - if it fails the first
395          * time, actually reset it.
396          */
397         error = -ENODEV;
398         if (ARCRESET(0) && ARCRESET(1))
399                 goto out_module_put;
400
401         newmtu = choose_mtu();
402         if (newmtu < dev->mtu)
403                 dev->mtu = newmtu;
404
405         BUGMSG(D_INIT, "arcnet_open: mtu: %d.\n", dev->mtu);
406
407         /* autodetect the encapsulation for each host. */
408         memset(lp->default_proto, 0, sizeof(lp->default_proto));
409
410         /* the broadcast address is special - use the 'bcast' protocol */
411         for (count = 0; count < 256; count++) {
412                 if (arc_proto_map[count] == arc_bcast_proto) {
413                         lp->default_proto[0] = count;
414                         break;
415                 }
416         }
417
418         /* initialize buffers */
419         atomic_set(&lp->buf_lock, 1);
420
421         lp->next_buf = lp->first_free_buf = 0;
422         release_arcbuf(dev, 0);
423         release_arcbuf(dev, 1);
424         release_arcbuf(dev, 2);
425         release_arcbuf(dev, 3);
426         lp->cur_tx = lp->next_tx = -1;
427         lp->cur_rx = -1;
428
429         lp->rfc1201.sequence = 1;
430
431         /* bring up the hardware driver */
432         if (lp->hw.open)
433                 lp->hw.open(dev);
434
435         if (dev->dev_addr[0] == 0)
436                 BUGMSG(D_NORMAL, "WARNING!  Station address 00 is reserved "
437                        "for broadcasts!\n");
438         else if (dev->dev_addr[0] == 255)
439                 BUGMSG(D_NORMAL, "WARNING!  Station address FF may confuse "
440                        "DOS networking programs!\n");
441
442         BUGMSG(D_DEBUG, "%s: %d: %s\n",__FILE__,__LINE__,__func__);
443         if (ASTATUS() & RESETflag) {
444                 BUGMSG(D_DEBUG, "%s: %d: %s\n",__FILE__,__LINE__,__func__);
445                 ACOMMAND(CFLAGScmd | RESETclear);
446         }
447
448
449         BUGMSG(D_DEBUG, "%s: %d: %s\n",__FILE__,__LINE__,__func__);
450         /* make sure we're ready to receive IRQ's. */
451         AINTMASK(0);
452         udelay(1);              /* give it time to set the mask before
453                                  * we reset it again. (may not even be
454                                  * necessary)
455                                  */
456         BUGMSG(D_DEBUG, "%s: %d: %s\n",__FILE__,__LINE__,__func__);
457         lp->intmask = NORXflag | RECONflag;
458         AINTMASK(lp->intmask);
459         BUGMSG(D_DEBUG, "%s: %d: %s\n",__FILE__,__LINE__,__func__);
460
461         netif_start_queue(dev);
462
463         return 0;
464
465  out_module_put:
466         module_put(lp->hw.owner);
467         return error;
468 }
469
470
471 /* The inverse routine to arcnet_open - shuts down the card. */
472 int arcnet_close(struct net_device *dev)
473 {
474         struct arcnet_local *lp = netdev_priv(dev);
475
476         netif_stop_queue(dev);
477
478         /* flush TX and disable RX */
479         AINTMASK(0);
480         ACOMMAND(NOTXcmd);      /* stop transmit */
481         ACOMMAND(NORXcmd);      /* disable receive */
482         mdelay(1);
483
484         /* shut down the card */
485         lp->hw.close(dev);
486         module_put(lp->hw.owner);
487         return 0;
488 }
489
490
491 static int arcnet_header(struct sk_buff *skb, struct net_device *dev,
492                          unsigned short type, const void *daddr,
493                          const void *saddr, unsigned len)
494 {
495         const struct arcnet_local *lp = netdev_priv(dev);
496         uint8_t _daddr, proto_num;
497         struct ArcProto *proto;
498
499         BUGMSG(D_DURING,
500             "create header from %d to %d; protocol %d (%Xh); size %u.\n",
501                saddr ? *(uint8_t *) saddr : -1,
502                daddr ? *(uint8_t *) daddr : -1,
503                type, type, len);
504
505         if (skb->len!=0 && len != skb->len)
506                 BUGMSG(D_NORMAL, "arcnet_header: Yikes!  skb->len(%d) != len(%d)!\n",
507                        skb->len, len);
508
509
510         /* Type is host order - ? */
511         if(type == ETH_P_ARCNET) {
512                 proto = arc_raw_proto;
513                 BUGMSG(D_DEBUG, "arc_raw_proto used. proto='%c'\n",proto->suffix);
514                 _daddr = daddr ? *(uint8_t *) daddr : 0;
515         }
516         else if (!daddr) {
517                 /*
518                  * if the dest addr isn't provided, we can't choose an encapsulation!
519                  * Store the packet type (eg. ETH_P_IP) for now, and we'll push on a
520                  * real header when we do rebuild_header.
521                  */
522                 *(uint16_t *) skb_push(skb, 2) = type;
523                 /*
524                  * XXX: Why not use skb->mac_len?
525                  */
526                 if (skb->network_header - skb->mac_header != 2)
527                         BUGMSG(D_NORMAL, "arcnet_header: Yikes!  diff (%d) is not 2!\n",
528                                (int)(skb->network_header - skb->mac_header));
529                 return -2;      /* return error -- can't transmit yet! */
530         }
531         else {
532                 /* otherwise, we can just add the header as usual. */
533                 _daddr = *(uint8_t *) daddr;
534                 proto_num = lp->default_proto[_daddr];
535                 proto = arc_proto_map[proto_num];
536                 BUGMSG(D_DURING, "building header for %02Xh using protocol '%c'\n",
537                        proto_num, proto->suffix);
538                 if (proto == &arc_proto_null && arc_bcast_proto != proto) {
539                         BUGMSG(D_DURING, "actually, let's use '%c' instead.\n",
540                                arc_bcast_proto->suffix);
541                         proto = arc_bcast_proto;
542                 }
543         }
544         return proto->build_header(skb, dev, type, _daddr);
545 }
546
547
548 /* 
549  * Rebuild the ARCnet hard header. This is called after an ARP (or in the
550  * future other address resolution) has completed on this sk_buff. We now
551  * let ARP fill in the destination field.
552  */
553 static int arcnet_rebuild_header(struct sk_buff *skb)
554 {
555         struct net_device *dev = skb->dev;
556         struct arcnet_local *lp = netdev_priv(dev);
557         int status = 0;         /* default is failure */
558         unsigned short type;
559         uint8_t daddr=0;
560         struct ArcProto *proto;
561         /*
562          * XXX: Why not use skb->mac_len?
563          */
564         if (skb->network_header - skb->mac_header != 2) {
565                 BUGMSG(D_NORMAL,
566                        "rebuild_header: shouldn't be here! (hdrsize=%d)\n",
567                        (int)(skb->network_header - skb->mac_header));
568                 return 0;
569         }
570         type = *(uint16_t *) skb_pull(skb, 2);
571         BUGMSG(D_DURING, "rebuild header for protocol %Xh\n", type);
572
573         if (type == ETH_P_IP) {
574 #ifdef CONFIG_INET
575                 BUGMSG(D_DURING, "rebuild header for ethernet protocol %Xh\n", type);
576                 status = arp_find(&daddr, skb) ? 1 : 0;
577                 BUGMSG(D_DURING, " rebuilt: dest is %d; protocol %Xh\n",
578                        daddr, type);
579 #endif
580         } else {
581                 BUGMSG(D_NORMAL,
582                        "I don't understand ethernet protocol %Xh addresses!\n", type);
583                 dev->stats.tx_errors++;
584                 dev->stats.tx_aborted_errors++;
585         }
586
587         /* if we couldn't resolve the address... give up. */
588         if (!status)
589                 return 0;
590
591         /* add the _real_ header this time! */
592         proto = arc_proto_map[lp->default_proto[daddr]];
593         proto->build_header(skb, dev, type, daddr);
594
595         return 1;               /* success */
596 }
597
598
599
600 /* Called by the kernel in order to transmit a packet. */
601 int arcnet_send_packet(struct sk_buff *skb, struct net_device *dev)
602 {
603         struct arcnet_local *lp = netdev_priv(dev);
604         struct archdr *pkt;
605         struct arc_rfc1201 *soft;
606         struct ArcProto *proto;
607         int txbuf;
608         unsigned long flags;
609         int freeskb, retval;
610
611         BUGMSG(D_DURING,
612                "transmit requested (status=%Xh, txbufs=%d/%d, len=%d, protocol %x)\n",
613                ASTATUS(), lp->cur_tx, lp->next_tx, skb->len,skb->protocol);
614
615         pkt = (struct archdr *) skb->data;
616         soft = &pkt->soft.rfc1201;
617         proto = arc_proto_map[soft->proto];
618
619         BUGMSG(D_SKB_SIZE, "skb: transmitting %d bytes to %02X\n",
620                 skb->len, pkt->hard.dest);
621         BUGLVL(D_SKB) arcnet_dump_skb(dev, skb, "tx");
622
623         /* fits in one packet? */
624         if (skb->len - ARC_HDR_SIZE > XMTU && !proto->continue_tx) {
625                 BUGMSG(D_NORMAL, "fixme: packet too large: compensating badly!\n");
626                 dev_kfree_skb(skb);
627                 return NETDEV_TX_OK;    /* don't try again */
628         }
629
630         /* We're busy transmitting a packet... */
631         netif_stop_queue(dev);
632
633         spin_lock_irqsave(&lp->lock, flags);
634         AINTMASK(0);
635         if(lp->next_tx == -1)
636                 txbuf = get_arcbuf(dev);
637         else {
638                 txbuf = -1;
639         }
640         if (txbuf != -1) {
641                 if (proto->prepare_tx(dev, pkt, skb->len, txbuf) &&
642                     !proto->ack_tx) {
643                         /* done right away and we don't want to acknowledge
644                            the package later - forget about it now */
645                         dev->stats.tx_bytes += skb->len;
646                         freeskb = 1;
647                 } else {
648                         /* do it the 'split' way */
649                         lp->outgoing.proto = proto;
650                         lp->outgoing.skb = skb;
651                         lp->outgoing.pkt = pkt;
652
653                         freeskb = 0;
654
655                         if (proto->continue_tx &&
656                             proto->continue_tx(dev, txbuf)) {
657                           BUGMSG(D_NORMAL,
658                                  "bug! continue_tx finished the first time! "
659                                  "(proto='%c')\n", proto->suffix);
660                         }
661                 }
662                 retval = NETDEV_TX_OK;
663                 dev->trans_start = jiffies;
664                 lp->next_tx = txbuf;
665         } else {
666                 retval = NETDEV_TX_BUSY;
667                 freeskb = 0;
668         }
669
670         BUGMSG(D_DEBUG, "%s: %d: %s, status: %x\n",__FILE__,__LINE__,__func__,ASTATUS());
671         /* make sure we didn't ignore a TX IRQ while we were in here */
672         AINTMASK(0);
673
674         BUGMSG(D_DEBUG, "%s: %d: %s\n",__FILE__,__LINE__,__func__);
675         lp->intmask |= TXFREEflag|EXCNAKflag;
676         AINTMASK(lp->intmask);
677         BUGMSG(D_DEBUG, "%s: %d: %s, status: %x\n",__FILE__,__LINE__,__func__,ASTATUS());
678
679         spin_unlock_irqrestore(&lp->lock, flags);
680         if (freeskb) {
681                 dev_kfree_skb(skb);
682         }
683         return retval;          /* no need to try again */
684 }
685
686
687 /*
688  * Actually start transmitting a packet that was loaded into a buffer
689  * by prepare_tx.  This should _only_ be called by the interrupt handler.
690  */
691 static int go_tx(struct net_device *dev)
692 {
693         struct arcnet_local *lp = netdev_priv(dev);
694
695         BUGMSG(D_DURING, "go_tx: status=%Xh, intmask=%Xh, next_tx=%d, cur_tx=%d\n",
696                ASTATUS(), lp->intmask, lp->next_tx, lp->cur_tx);
697
698         if (lp->cur_tx != -1 || lp->next_tx == -1)
699                 return 0;
700
701         BUGLVL(D_TX) arcnet_dump_packet(dev, lp->next_tx, "go_tx", 0);
702
703         lp->cur_tx = lp->next_tx;
704         lp->next_tx = -1;
705
706         /* start sending */
707         ACOMMAND(TXcmd | (lp->cur_tx << 3));
708
709         dev->stats.tx_packets++;
710         lp->lasttrans_dest = lp->lastload_dest;
711         lp->lastload_dest = 0;
712         lp->excnak_pending = 0;
713         lp->intmask |= TXFREEflag|EXCNAKflag;
714
715         return 1;
716 }
717
718
719 /* Called by the kernel when transmit times out */
720 void arcnet_timeout(struct net_device *dev)
721 {
722         unsigned long flags;
723         struct arcnet_local *lp = netdev_priv(dev);
724         int status = ASTATUS();
725         char *msg;
726
727         spin_lock_irqsave(&lp->lock, flags);
728         if (status & TXFREEflag) {      /* transmit _DID_ finish */
729                 msg = " - missed IRQ?";
730         } else {
731                 msg = "";
732                 dev->stats.tx_aborted_errors++;
733                 lp->timed_out = 1;
734                 ACOMMAND(NOTXcmd | (lp->cur_tx << 3));
735         }
736         dev->stats.tx_errors++;
737
738         /* make sure we didn't miss a TX or a EXC NAK IRQ */
739         AINTMASK(0);
740         lp->intmask |= TXFREEflag|EXCNAKflag;
741         AINTMASK(lp->intmask);
742         
743         spin_unlock_irqrestore(&lp->lock, flags);
744
745         if (time_after(jiffies, lp->last_timeout + 10*HZ)) {
746                 BUGMSG(D_EXTRA, "tx timed out%s (status=%Xh, intmask=%Xh, dest=%02Xh)\n",
747                        msg, status, lp->intmask, lp->lasttrans_dest);
748                 lp->last_timeout = jiffies;
749         }
750
751         if (lp->cur_tx == -1)
752                 netif_wake_queue(dev);
753 }
754
755
756 /*
757  * The typical workload of the driver: Handle the network interface
758  * interrupts. Establish which device needs attention, and call the correct
759  * chipset interrupt handler.
760  */
761 irqreturn_t arcnet_interrupt(int irq, void *dev_id)
762 {
763         struct net_device *dev = dev_id;
764         struct arcnet_local *lp;
765         int recbuf, status, diagstatus, didsomething, boguscount;
766         int retval = IRQ_NONE;
767
768         BUGMSG(D_DURING, "\n");
769
770         BUGMSG(D_DURING, "in arcnet_interrupt\n");
771
772         lp = netdev_priv(dev);
773         BUG_ON(!lp);
774                 
775         spin_lock(&lp->lock);
776
777         /*
778          * RESET flag was enabled - if device is not running, we must clear it right
779          * away (but nothing else).
780          */
781         if (!netif_running(dev)) {
782                 if (ASTATUS() & RESETflag)
783                         ACOMMAND(CFLAGScmd | RESETclear);
784                 AINTMASK(0);
785                 spin_unlock(&lp->lock);
786                 return IRQ_HANDLED;
787         }
788
789         BUGMSG(D_DURING, "in arcnet_inthandler (status=%Xh, intmask=%Xh)\n",
790                ASTATUS(), lp->intmask);
791
792         boguscount = 5;
793         do {
794                 status = ASTATUS();
795                 diagstatus = (status >> 8) & 0xFF;
796
797                 BUGMSG(D_DEBUG, "%s: %d: %s: status=%x\n",
798                         __FILE__,__LINE__,__func__,status);
799                 didsomething = 0;
800
801                 /*
802                  * RESET flag was enabled - card is resetting and if RX is
803                  * disabled, it's NOT because we just got a packet.
804                  * 
805                  * The card is in an undefined state.  Clear it out and start over.
806                  */
807                 if (status & RESETflag) {
808                         BUGMSG(D_NORMAL, "spurious reset (status=%Xh)\n", status);
809                         arcnet_close(dev);
810                         arcnet_open(dev);
811
812                         /* get out of the interrupt handler! */
813                         break;
814                 }
815                 /* 
816                  * RX is inhibited - we must have received something. Prepare to
817                  * receive into the next buffer.
818                  * 
819                  * We don't actually copy the received packet from the card until
820                  * after the transmit handler runs (and possibly launches the next
821                  * tx); this should improve latency slightly if we get both types
822                  * of interrupts at once. 
823                  */
824                 recbuf = -1;
825                 if (status & lp->intmask & NORXflag) {
826                         recbuf = lp->cur_rx;
827                         BUGMSG(D_DURING, "Buffer #%d: receive irq (status=%Xh)\n",
828                                recbuf, status);
829
830                         lp->cur_rx = get_arcbuf(dev);
831                         if (lp->cur_rx != -1) {
832                                 BUGMSG(D_DURING, "enabling receive to buffer #%d\n",
833                                        lp->cur_rx);
834                                 ACOMMAND(RXcmd | (lp->cur_rx << 3) | RXbcasts);
835                         }
836                         didsomething++;
837                 }
838
839                 if((diagstatus & EXCNAKflag)) {
840                         BUGMSG(D_DURING, "EXCNAK IRQ (diagstat=%Xh)\n",
841                                diagstatus);
842
843                         ACOMMAND(NOTXcmd);      /* disable transmit */
844                         lp->excnak_pending = 1;
845
846                         ACOMMAND(EXCNAKclear);
847                         lp->intmask &= ~(EXCNAKflag);
848                         didsomething++;
849                 }
850
851
852                 /* a transmit finished, and we're interested in it. */
853                 if ((status & lp->intmask & TXFREEflag) || lp->timed_out) {
854                         lp->intmask &= ~(TXFREEflag|EXCNAKflag);
855
856                         BUGMSG(D_DURING, "TX IRQ (stat=%Xh)\n", status);
857
858                         if (lp->cur_tx != -1 && !lp->timed_out) {
859                                 if(!(status & TXACKflag)) {
860                                         if (lp->lasttrans_dest != 0) {
861                                                 BUGMSG(D_EXTRA,
862                                                        "transmit was not acknowledged! "
863                                                        "(status=%Xh, dest=%02Xh)\n",
864                                                        status, lp->lasttrans_dest);
865                                                 dev->stats.tx_errors++;
866                                                 dev->stats.tx_carrier_errors++;
867                                         } else {
868                                                 BUGMSG(D_DURING,
869                                                        "broadcast was not acknowledged; that's normal "
870                                                        "(status=%Xh, dest=%02Xh)\n",
871                                                        status, lp->lasttrans_dest);
872                                         }
873                                 }
874
875                                 if (lp->outgoing.proto &&
876                                     lp->outgoing.proto->ack_tx) {
877                                   int ackstatus;
878                                   if(status & TXACKflag)
879                                     ackstatus=2;
880                                   else if(lp->excnak_pending)
881                                     ackstatus=1;
882                                   else
883                                     ackstatus=0;
884
885                                   lp->outgoing.proto
886                                     ->ack_tx(dev, ackstatus);
887                                 }
888                         }
889                         if (lp->cur_tx != -1)
890                                 release_arcbuf(dev, lp->cur_tx);
891
892                         lp->cur_tx = -1;
893                         lp->timed_out = 0;
894                         didsomething++;
895
896                         /* send another packet if there is one */
897                         go_tx(dev);
898
899                         /* continue a split packet, if any */
900                         if (lp->outgoing.proto && lp->outgoing.proto->continue_tx) {
901                                 int txbuf = get_arcbuf(dev);
902                                 if (txbuf != -1) {
903                                         if (lp->outgoing.proto->continue_tx(dev, txbuf)) {
904                                                 /* that was the last segment */
905                                                 dev->stats.tx_bytes += lp->outgoing.skb->len;
906                                                 if(!lp->outgoing.proto->ack_tx)
907                                                   {
908                                                     dev_kfree_skb_irq(lp->outgoing.skb);
909                                                     lp->outgoing.proto = NULL;
910                                                   }
911                                         }
912                                         lp->next_tx = txbuf;
913                                 }
914                         }
915                         /* inform upper layers of idleness, if necessary */
916                         if (lp->cur_tx == -1)
917                                 netif_wake_queue(dev);
918                 }
919                 /* now process the received packet, if any */
920                 if (recbuf != -1) {
921                         BUGLVL(D_RX) arcnet_dump_packet(dev, recbuf, "rx irq", 0);
922
923                         arcnet_rx(dev, recbuf);
924                         release_arcbuf(dev, recbuf);
925
926                         didsomething++;
927                 }
928                 if (status & lp->intmask & RECONflag) {
929                         ACOMMAND(CFLAGScmd | CONFIGclear);
930                         dev->stats.tx_carrier_errors++;
931
932                         BUGMSG(D_RECON, "Network reconfiguration detected (status=%Xh)\n",
933                                status);
934                         /* MYRECON bit is at bit 7 of diagstatus */
935                         if(diagstatus & 0x80)
936                                 BUGMSG(D_RECON,"Put out that recon myself\n");
937
938                         /* is the RECON info empty or old? */
939                         if (!lp->first_recon || !lp->last_recon ||
940                             time_after(jiffies, lp->last_recon + HZ * 10)) {
941                                 if (lp->network_down)
942                                         BUGMSG(D_NORMAL, "reconfiguration detected: cabling restored?\n");
943                                 lp->first_recon = lp->last_recon = jiffies;
944                                 lp->num_recons = lp->network_down = 0;
945
946                                 BUGMSG(D_DURING, "recon: clearing counters.\n");
947                         } else {        /* add to current RECON counter */
948                                 lp->last_recon = jiffies;
949                                 lp->num_recons++;
950
951                                 BUGMSG(D_DURING, "recon: counter=%d, time=%lds, net=%d\n",
952                                        lp->num_recons,
953                                  (lp->last_recon - lp->first_recon) / HZ,
954                                        lp->network_down);
955
956                                 /* if network is marked up;
957                                  * and first_recon and last_recon are 60+ apart;
958                                  * and the average no. of recons counted is
959                                  *    > RECON_THRESHOLD/min;
960                                  * then print a warning message.
961                                  */
962                                 if (!lp->network_down
963                                     && (lp->last_recon - lp->first_recon) <= HZ * 60
964                                   && lp->num_recons >= RECON_THRESHOLD) {
965                                         lp->network_down = 1;
966                                         BUGMSG(D_NORMAL, "many reconfigurations detected: cabling problem?\n");
967                                 } else if (!lp->network_down
968                                            && lp->last_recon - lp->first_recon > HZ * 60) {
969                                         /* reset counters if we've gone for over a minute. */
970                                         lp->first_recon = lp->last_recon;
971                                         lp->num_recons = 1;
972                                 }
973                         }
974                 } else if (lp->network_down &&
975                                 time_after(jiffies, lp->last_recon + HZ * 10)) {
976                         if (lp->network_down)
977                                 BUGMSG(D_NORMAL, "cabling restored?\n");
978                         lp->first_recon = lp->last_recon = 0;
979                         lp->num_recons = lp->network_down = 0;
980
981                         BUGMSG(D_DURING, "not recon: clearing counters anyway.\n");
982                 }
983
984                 if(didsomething) {
985                         retval |= IRQ_HANDLED;
986                 }
987         }
988         while (--boguscount && didsomething);
989
990         BUGMSG(D_DURING, "arcnet_interrupt complete (status=%Xh, count=%d)\n",
991                ASTATUS(), boguscount);
992         BUGMSG(D_DURING, "\n");
993
994
995         AINTMASK(0);
996         udelay(1);
997         AINTMASK(lp->intmask);
998         
999         spin_unlock(&lp->lock);
1000         return retval;
1001 }
1002
1003
1004 /*
1005  * This is a generic packet receiver that calls arcnet??_rx depending on the
1006  * protocol ID found.
1007  */
1008 static void arcnet_rx(struct net_device *dev, int bufnum)
1009 {
1010         struct arcnet_local *lp = netdev_priv(dev);
1011         struct archdr pkt;
1012         struct arc_rfc1201 *soft;
1013         int length, ofs;
1014
1015         soft = &pkt.soft.rfc1201;
1016
1017         lp->hw.copy_from_card(dev, bufnum, 0, &pkt, sizeof(ARC_HDR_SIZE));
1018         if (pkt.hard.offset[0]) {
1019                 ofs = pkt.hard.offset[0];
1020                 length = 256 - ofs;
1021         } else {
1022                 ofs = pkt.hard.offset[1];
1023                 length = 512 - ofs;
1024         }
1025
1026         /* get the full header, if possible */
1027         if (sizeof(pkt.soft) <= length)
1028                 lp->hw.copy_from_card(dev, bufnum, ofs, soft, sizeof(pkt.soft));
1029         else {
1030                 memset(&pkt.soft, 0, sizeof(pkt.soft));
1031                 lp->hw.copy_from_card(dev, bufnum, ofs, soft, length);
1032         }
1033
1034         BUGMSG(D_DURING, "Buffer #%d: received packet from %02Xh to %02Xh "
1035                "(%d+4 bytes)\n",
1036                bufnum, pkt.hard.source, pkt.hard.dest, length);
1037
1038         dev->stats.rx_packets++;
1039         dev->stats.rx_bytes += length + ARC_HDR_SIZE;
1040
1041         /* call the right receiver for the protocol */
1042         if (arc_proto_map[soft->proto]->is_ip) {
1043                 BUGLVL(D_PROTO) {
1044                         struct ArcProto
1045                         *oldp = arc_proto_map[lp->default_proto[pkt.hard.source]],
1046                         *newp = arc_proto_map[soft->proto];
1047
1048                         if (oldp != newp) {
1049                                 BUGMSG(D_PROTO,
1050                                        "got protocol %02Xh; encap for host %02Xh is now '%c'"
1051                                        " (was '%c')\n", soft->proto, pkt.hard.source,
1052                                        newp->suffix, oldp->suffix);
1053                         }
1054                 }
1055
1056                 /* broadcasts will always be done with the last-used encap. */
1057                 lp->default_proto[0] = soft->proto;
1058
1059                 /* in striking contrast, the following isn't a hack. */
1060                 lp->default_proto[pkt.hard.source] = soft->proto;
1061         }
1062         /* call the protocol-specific receiver. */
1063         arc_proto_map[soft->proto]->rx(dev, bufnum, &pkt, length);
1064 }
1065
1066
1067 static void null_rx(struct net_device *dev, int bufnum,
1068                     struct archdr *pkthdr, int length)
1069 {
1070         BUGMSG(D_PROTO,
1071         "rx: don't know how to deal with proto %02Xh from host %02Xh.\n",
1072                pkthdr->soft.rfc1201.proto, pkthdr->hard.source);
1073 }
1074
1075
1076 static int null_build_header(struct sk_buff *skb, struct net_device *dev,
1077                              unsigned short type, uint8_t daddr)
1078 {
1079         struct arcnet_local *lp = netdev_priv(dev);
1080
1081         BUGMSG(D_PROTO,
1082                "tx: can't build header for encap %02Xh; load a protocol driver.\n",
1083                lp->default_proto[daddr]);
1084
1085         /* always fails */
1086         return 0;
1087 }
1088
1089
1090 /* the "do nothing" prepare_tx function warns that there's nothing to do. */
1091 static int null_prepare_tx(struct net_device *dev, struct archdr *pkt,
1092                            int length, int bufnum)
1093 {
1094         struct arcnet_local *lp = netdev_priv(dev);
1095         struct arc_hardware newpkt;
1096
1097         BUGMSG(D_PROTO, "tx: no encap for this host; load a protocol driver.\n");
1098
1099         /* send a packet to myself -- will never get received, of course */
1100         newpkt.source = newpkt.dest = dev->dev_addr[0];
1101
1102         /* only one byte of actual data (and it's random) */
1103         newpkt.offset[0] = 0xFF;
1104
1105         lp->hw.copy_to_card(dev, bufnum, 0, &newpkt, ARC_HDR_SIZE);
1106
1107         return 1;               /* done */
1108 }