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