d6d4ab3b430ccf77a25fe865384f3daaa8b6b7b4
[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 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                 BUGMSG(D_PROTO, "protocol map (default is '%c'): ",
384                        arc_proto_default->suffix);
385                 for (count = 0; count < 256; count++)
386                         BUGMSG2(D_PROTO, "%c", arc_proto_map[count]->suffix);
387                 BUGMSG2(D_PROTO, "\n");
388         }
389
390
391         BUGMSG(D_INIT, "arcnet_open: resetting card.\n");
392
393         /* try to put the card in a defined state - if it fails the first
394          * time, actually reset it.
395          */
396         error = -ENODEV;
397         if (ARCRESET(0) && ARCRESET(1))
398                 goto out_module_put;
399
400         newmtu = choose_mtu();
401         if (newmtu < dev->mtu)
402                 dev->mtu = newmtu;
403
404         BUGMSG(D_INIT, "arcnet_open: mtu: %d.\n", dev->mtu);
405
406         /* autodetect the encapsulation for each host. */
407         memset(lp->default_proto, 0, sizeof(lp->default_proto));
408
409         /* the broadcast address is special - use the 'bcast' protocol */
410         for (count = 0; count < 256; count++) {
411                 if (arc_proto_map[count] == arc_bcast_proto) {
412                         lp->default_proto[0] = count;
413                         break;
414                 }
415         }
416
417         /* initialize buffers */
418         atomic_set(&lp->buf_lock, 1);
419
420         lp->next_buf = lp->first_free_buf = 0;
421         release_arcbuf(dev, 0);
422         release_arcbuf(dev, 1);
423         release_arcbuf(dev, 2);
424         release_arcbuf(dev, 3);
425         lp->cur_tx = lp->next_tx = -1;
426         lp->cur_rx = -1;
427
428         lp->rfc1201.sequence = 1;
429
430         /* bring up the hardware driver */
431         if (lp->hw.open)
432                 lp->hw.open(dev);
433
434         if (dev->dev_addr[0] == 0)
435                 BUGMSG(D_NORMAL, "WARNING!  Station address 00 is reserved "
436                        "for broadcasts!\n");
437         else if (dev->dev_addr[0] == 255)
438                 BUGMSG(D_NORMAL, "WARNING!  Station address FF may confuse "
439                        "DOS networking programs!\n");
440
441         BUGMSG(D_DEBUG, "%s: %d: %s\n",__FILE__,__LINE__,__func__);
442         if (ASTATUS() & RESETflag) {
443                 BUGMSG(D_DEBUG, "%s: %d: %s\n",__FILE__,__LINE__,__func__);
444                 ACOMMAND(CFLAGScmd | RESETclear);
445         }
446
447
448         BUGMSG(D_DEBUG, "%s: %d: %s\n",__FILE__,__LINE__,__func__);
449         /* make sure we're ready to receive IRQ's. */
450         AINTMASK(0);
451         udelay(1);              /* give it time to set the mask before
452                                  * we reset it again. (may not even be
453                                  * necessary)
454                                  */
455         BUGMSG(D_DEBUG, "%s: %d: %s\n",__FILE__,__LINE__,__func__);
456         lp->intmask = NORXflag | RECONflag;
457         AINTMASK(lp->intmask);
458         BUGMSG(D_DEBUG, "%s: %d: %s\n",__FILE__,__LINE__,__func__);
459
460         netif_start_queue(dev);
461
462         return 0;
463
464  out_module_put:
465         module_put(lp->hw.owner);
466         return error;
467 }
468
469
470 /* The inverse routine to arcnet_open - shuts down the card. */
471 int arcnet_close(struct net_device *dev)
472 {
473         struct arcnet_local *lp = netdev_priv(dev);
474
475         netif_stop_queue(dev);
476
477         /* flush TX and disable RX */
478         AINTMASK(0);
479         ACOMMAND(NOTXcmd);      /* stop transmit */
480         ACOMMAND(NORXcmd);      /* disable receive */
481         mdelay(1);
482
483         /* shut down the card */
484         lp->hw.close(dev);
485         module_put(lp->hw.owner);
486         return 0;
487 }
488
489
490 static int arcnet_header(struct sk_buff *skb, struct net_device *dev,
491                          unsigned short type, const void *daddr,
492                          const void *saddr, unsigned len)
493 {
494         const struct arcnet_local *lp = netdev_priv(dev);
495         uint8_t _daddr, proto_num;
496         struct ArcProto *proto;
497
498         BUGMSG(D_DURING,
499             "create header from %d to %d; protocol %d (%Xh); size %u.\n",
500                saddr ? *(uint8_t *) saddr : -1,
501                daddr ? *(uint8_t *) daddr : -1,
502                type, type, len);
503
504         if (skb->len!=0 && len != skb->len)
505                 BUGMSG(D_NORMAL, "arcnet_header: Yikes!  skb->len(%d) != len(%d)!\n",
506                        skb->len, len);
507
508
509         /* Type is host order - ? */
510         if(type == ETH_P_ARCNET) {
511                 proto = arc_raw_proto;
512                 BUGMSG(D_DEBUG, "arc_raw_proto used. proto='%c'\n",proto->suffix);
513                 _daddr = daddr ? *(uint8_t *) daddr : 0;
514         }
515         else if (!daddr) {
516                 /*
517                  * if the dest addr isn't provided, we can't choose an encapsulation!
518                  * Store the packet type (eg. ETH_P_IP) for now, and we'll push on a
519                  * real header when we do rebuild_header.
520                  */
521                 *(uint16_t *) skb_push(skb, 2) = type;
522                 /*
523                  * XXX: Why not use skb->mac_len?
524                  */
525                 if (skb->network_header - skb->mac_header != 2)
526                         BUGMSG(D_NORMAL, "arcnet_header: Yikes!  diff (%d) is not 2!\n",
527                                (int)(skb->network_header - skb->mac_header));
528                 return -2;      /* return error -- can't transmit yet! */
529         }
530         else {
531                 /* otherwise, we can just add the header as usual. */
532                 _daddr = *(uint8_t *) daddr;
533                 proto_num = lp->default_proto[_daddr];
534                 proto = arc_proto_map[proto_num];
535                 BUGMSG(D_DURING, "building header for %02Xh using protocol '%c'\n",
536                        proto_num, proto->suffix);
537                 if (proto == &arc_proto_null && arc_bcast_proto != proto) {
538                         BUGMSG(D_DURING, "actually, let's use '%c' instead.\n",
539                                arc_bcast_proto->suffix);
540                         proto = arc_bcast_proto;
541                 }
542         }
543         return proto->build_header(skb, dev, type, _daddr);
544 }
545
546
547 /* 
548  * Rebuild the ARCnet hard header. This is called after an ARP (or in the
549  * future other address resolution) has completed on this sk_buff. We now
550  * let ARP fill in the destination field.
551  */
552 static int arcnet_rebuild_header(struct sk_buff *skb)
553 {
554         struct net_device *dev = skb->dev;
555         struct arcnet_local *lp = netdev_priv(dev);
556         int status = 0;         /* default is failure */
557         unsigned short type;
558         uint8_t daddr=0;
559         struct ArcProto *proto;
560         /*
561          * XXX: Why not use skb->mac_len?
562          */
563         if (skb->network_header - skb->mac_header != 2) {
564                 BUGMSG(D_NORMAL,
565                        "rebuild_header: shouldn't be here! (hdrsize=%d)\n",
566                        (int)(skb->network_header - skb->mac_header));
567                 return 0;
568         }
569         type = *(uint16_t *) skb_pull(skb, 2);
570         BUGMSG(D_DURING, "rebuild header for protocol %Xh\n", type);
571
572         if (type == ETH_P_IP) {
573 #ifdef CONFIG_INET
574                 BUGMSG(D_DURING, "rebuild header for ethernet protocol %Xh\n", type);
575                 status = arp_find(&daddr, skb) ? 1 : 0;
576                 BUGMSG(D_DURING, " rebuilt: dest is %d; protocol %Xh\n",
577                        daddr, type);
578 #endif
579         } else {
580                 BUGMSG(D_NORMAL,
581                        "I don't understand ethernet protocol %Xh addresses!\n", type);
582                 dev->stats.tx_errors++;
583                 dev->stats.tx_aborted_errors++;
584         }
585
586         /* if we couldn't resolve the address... give up. */
587         if (!status)
588                 return 0;
589
590         /* add the _real_ header this time! */
591         proto = arc_proto_map[lp->default_proto[daddr]];
592         proto->build_header(skb, dev, type, daddr);
593
594         return 1;               /* success */
595 }
596
597
598
599 /* Called by the kernel in order to transmit a packet. */
600 int arcnet_send_packet(struct sk_buff *skb, struct net_device *dev)
601 {
602         struct arcnet_local *lp = netdev_priv(dev);
603         struct archdr *pkt;
604         struct arc_rfc1201 *soft;
605         struct ArcProto *proto;
606         int txbuf;
607         unsigned long flags;
608         int freeskb, retval;
609
610         BUGMSG(D_DURING,
611                "transmit requested (status=%Xh, txbufs=%d/%d, len=%d, protocol %x)\n",
612                ASTATUS(), lp->cur_tx, lp->next_tx, skb->len,skb->protocol);
613
614         pkt = (struct archdr *) skb->data;
615         soft = &pkt->soft.rfc1201;
616         proto = arc_proto_map[soft->proto];
617
618         BUGMSG(D_SKB_SIZE, "skb: transmitting %d bytes to %02X\n",
619                 skb->len, pkt->hard.dest);
620         BUGLVL(D_SKB) arcnet_dump_skb(dev, skb, "tx");
621
622         /* fits in one packet? */
623         if (skb->len - ARC_HDR_SIZE > XMTU && !proto->continue_tx) {
624                 BUGMSG(D_NORMAL, "fixme: packet too large: compensating badly!\n");
625                 dev_kfree_skb(skb);
626                 return NETDEV_TX_OK;    /* don't try again */
627         }
628
629         /* We're busy transmitting a packet... */
630         netif_stop_queue(dev);
631
632         spin_lock_irqsave(&lp->lock, flags);
633         AINTMASK(0);
634         if(lp->next_tx == -1)
635                 txbuf = get_arcbuf(dev);
636         else {
637                 txbuf = -1;
638         }
639         if (txbuf != -1) {
640                 if (proto->prepare_tx(dev, pkt, skb->len, txbuf) &&
641                     !proto->ack_tx) {
642                         /* done right away and we don't want to acknowledge
643                            the package later - forget about it now */
644                         dev->stats.tx_bytes += skb->len;
645                         freeskb = 1;
646                 } else {
647                         /* do it the 'split' way */
648                         lp->outgoing.proto = proto;
649                         lp->outgoing.skb = skb;
650                         lp->outgoing.pkt = pkt;
651
652                         freeskb = 0;
653
654                         if (proto->continue_tx &&
655                             proto->continue_tx(dev, txbuf)) {
656                           BUGMSG(D_NORMAL,
657                                  "bug! continue_tx finished the first time! "
658                                  "(proto='%c')\n", proto->suffix);
659                         }
660                 }
661                 retval = NETDEV_TX_OK;
662                 dev->trans_start = jiffies;
663                 lp->next_tx = txbuf;
664         } else {
665                 retval = NETDEV_TX_BUSY;
666                 freeskb = 0;
667         }
668
669         BUGMSG(D_DEBUG, "%s: %d: %s, status: %x\n",__FILE__,__LINE__,__func__,ASTATUS());
670         /* make sure we didn't ignore a TX IRQ while we were in here */
671         AINTMASK(0);
672
673         BUGMSG(D_DEBUG, "%s: %d: %s\n",__FILE__,__LINE__,__func__);
674         lp->intmask |= TXFREEflag|EXCNAKflag;
675         AINTMASK(lp->intmask);
676         BUGMSG(D_DEBUG, "%s: %d: %s, status: %x\n",__FILE__,__LINE__,__func__,ASTATUS());
677
678         spin_unlock_irqrestore(&lp->lock, flags);
679         if (freeskb) {
680                 dev_kfree_skb(skb);
681         }
682         return retval;          /* no need to try again */
683 }
684
685
686 /*
687  * Actually start transmitting a packet that was loaded into a buffer
688  * by prepare_tx.  This should _only_ be called by the interrupt handler.
689  */
690 static int go_tx(struct net_device *dev)
691 {
692         struct arcnet_local *lp = netdev_priv(dev);
693
694         BUGMSG(D_DURING, "go_tx: status=%Xh, intmask=%Xh, next_tx=%d, cur_tx=%d\n",
695                ASTATUS(), lp->intmask, lp->next_tx, lp->cur_tx);
696
697         if (lp->cur_tx != -1 || lp->next_tx == -1)
698                 return 0;
699
700         BUGLVL(D_TX) arcnet_dump_packet(dev, lp->next_tx, "go_tx", 0);
701
702         lp->cur_tx = lp->next_tx;
703         lp->next_tx = -1;
704
705         /* start sending */
706         ACOMMAND(TXcmd | (lp->cur_tx << 3));
707
708         dev->stats.tx_packets++;
709         lp->lasttrans_dest = lp->lastload_dest;
710         lp->lastload_dest = 0;
711         lp->excnak_pending = 0;
712         lp->intmask |= TXFREEflag|EXCNAKflag;
713
714         return 1;
715 }
716
717
718 /* Called by the kernel when transmit times out */
719 void arcnet_timeout(struct net_device *dev)
720 {
721         unsigned long flags;
722         struct arcnet_local *lp = netdev_priv(dev);
723         int status = ASTATUS();
724         char *msg;
725
726         spin_lock_irqsave(&lp->lock, flags);
727         if (status & TXFREEflag) {      /* transmit _DID_ finish */
728                 msg = " - missed IRQ?";
729         } else {
730                 msg = "";
731                 dev->stats.tx_aborted_errors++;
732                 lp->timed_out = 1;
733                 ACOMMAND(NOTXcmd | (lp->cur_tx << 3));
734         }
735         dev->stats.tx_errors++;
736
737         /* make sure we didn't miss a TX or a EXC NAK IRQ */
738         AINTMASK(0);
739         lp->intmask |= TXFREEflag|EXCNAKflag;
740         AINTMASK(lp->intmask);
741         
742         spin_unlock_irqrestore(&lp->lock, flags);
743
744         if (time_after(jiffies, lp->last_timeout + 10*HZ)) {
745                 BUGMSG(D_EXTRA, "tx timed out%s (status=%Xh, intmask=%Xh, dest=%02Xh)\n",
746                        msg, status, lp->intmask, lp->lasttrans_dest);
747                 lp->last_timeout = jiffies;
748         }
749
750         if (lp->cur_tx == -1)
751                 netif_wake_queue(dev);
752 }
753
754
755 /*
756  * The typical workload of the driver: Handle the network interface
757  * interrupts. Establish which device needs attention, and call the correct
758  * chipset interrupt handler.
759  */
760 irqreturn_t arcnet_interrupt(int irq, void *dev_id)
761 {
762         struct net_device *dev = dev_id;
763         struct arcnet_local *lp;
764         int recbuf, status, diagstatus, didsomething, boguscount;
765         int retval = IRQ_NONE;
766
767         BUGMSG(D_DURING, "\n");
768
769         BUGMSG(D_DURING, "in arcnet_interrupt\n");
770
771         lp = netdev_priv(dev);
772         BUG_ON(!lp);
773                 
774         spin_lock(&lp->lock);
775
776         /*
777          * RESET flag was enabled - if device is not running, we must clear it right
778          * away (but nothing else).
779          */
780         if (!netif_running(dev)) {
781                 if (ASTATUS() & RESETflag)
782                         ACOMMAND(CFLAGScmd | RESETclear);
783                 AINTMASK(0);
784                 spin_unlock(&lp->lock);
785                 return IRQ_HANDLED;
786         }
787
788         BUGMSG(D_DURING, "in arcnet_inthandler (status=%Xh, intmask=%Xh)\n",
789                ASTATUS(), lp->intmask);
790
791         boguscount = 5;
792         do {
793                 status = ASTATUS();
794                 diagstatus = (status >> 8) & 0xFF;
795
796                 BUGMSG(D_DEBUG, "%s: %d: %s: status=%x\n",
797                         __FILE__,__LINE__,__func__,status);
798                 didsomething = 0;
799
800                 /*
801                  * RESET flag was enabled - card is resetting and if RX is
802                  * disabled, it's NOT because we just got a packet.
803                  * 
804                  * The card is in an undefined state.  Clear it out and start over.
805                  */
806                 if (status & RESETflag) {
807                         BUGMSG(D_NORMAL, "spurious reset (status=%Xh)\n", status);
808                         arcnet_close(dev);
809                         arcnet_open(dev);
810
811                         /* get out of the interrupt handler! */
812                         break;
813                 }
814                 /* 
815                  * RX is inhibited - we must have received something. Prepare to
816                  * receive into the next buffer.
817                  * 
818                  * We don't actually copy the received packet from the card until
819                  * after the transmit handler runs (and possibly launches the next
820                  * tx); this should improve latency slightly if we get both types
821                  * of interrupts at once. 
822                  */
823                 recbuf = -1;
824                 if (status & lp->intmask & NORXflag) {
825                         recbuf = lp->cur_rx;
826                         BUGMSG(D_DURING, "Buffer #%d: receive irq (status=%Xh)\n",
827                                recbuf, status);
828
829                         lp->cur_rx = get_arcbuf(dev);
830                         if (lp->cur_rx != -1) {
831                                 BUGMSG(D_DURING, "enabling receive to buffer #%d\n",
832                                        lp->cur_rx);
833                                 ACOMMAND(RXcmd | (lp->cur_rx << 3) | RXbcasts);
834                         }
835                         didsomething++;
836                 }
837
838                 if((diagstatus & EXCNAKflag)) {
839                         BUGMSG(D_DURING, "EXCNAK IRQ (diagstat=%Xh)\n",
840                                diagstatus);
841
842                         ACOMMAND(NOTXcmd);      /* disable transmit */
843                         lp->excnak_pending = 1;
844
845                         ACOMMAND(EXCNAKclear);
846                         lp->intmask &= ~(EXCNAKflag);
847                         didsomething++;
848                 }
849
850
851                 /* a transmit finished, and we're interested in it. */
852                 if ((status & lp->intmask & TXFREEflag) || lp->timed_out) {
853                         lp->intmask &= ~(TXFREEflag|EXCNAKflag);
854
855                         BUGMSG(D_DURING, "TX IRQ (stat=%Xh)\n", status);
856
857                         if (lp->cur_tx != -1 && !lp->timed_out) {
858                                 if(!(status & TXACKflag)) {
859                                         if (lp->lasttrans_dest != 0) {
860                                                 BUGMSG(D_EXTRA,
861                                                        "transmit was not acknowledged! "
862                                                        "(status=%Xh, dest=%02Xh)\n",
863                                                        status, lp->lasttrans_dest);
864                                                 dev->stats.tx_errors++;
865                                                 dev->stats.tx_carrier_errors++;
866                                         } else {
867                                                 BUGMSG(D_DURING,
868                                                        "broadcast was not acknowledged; that's normal "
869                                                        "(status=%Xh, dest=%02Xh)\n",
870                                                        status, lp->lasttrans_dest);
871                                         }
872                                 }
873
874                                 if (lp->outgoing.proto &&
875                                     lp->outgoing.proto->ack_tx) {
876                                   int ackstatus;
877                                   if(status & TXACKflag)
878                                     ackstatus=2;
879                                   else if(lp->excnak_pending)
880                                     ackstatus=1;
881                                   else
882                                     ackstatus=0;
883
884                                   lp->outgoing.proto
885                                     ->ack_tx(dev, ackstatus);
886                                 }
887                         }
888                         if (lp->cur_tx != -1)
889                                 release_arcbuf(dev, lp->cur_tx);
890
891                         lp->cur_tx = -1;
892                         lp->timed_out = 0;
893                         didsomething++;
894
895                         /* send another packet if there is one */
896                         go_tx(dev);
897
898                         /* continue a split packet, if any */
899                         if (lp->outgoing.proto && lp->outgoing.proto->continue_tx) {
900                                 int txbuf = get_arcbuf(dev);
901                                 if (txbuf != -1) {
902                                         if (lp->outgoing.proto->continue_tx(dev, txbuf)) {
903                                                 /* that was the last segment */
904                                                 dev->stats.tx_bytes += lp->outgoing.skb->len;
905                                                 if(!lp->outgoing.proto->ack_tx)
906                                                   {
907                                                     dev_kfree_skb_irq(lp->outgoing.skb);
908                                                     lp->outgoing.proto = NULL;
909                                                   }
910                                         }
911                                         lp->next_tx = txbuf;
912                                 }
913                         }
914                         /* inform upper layers of idleness, if necessary */
915                         if (lp->cur_tx == -1)
916                                 netif_wake_queue(dev);
917                 }
918                 /* now process the received packet, if any */
919                 if (recbuf != -1) {
920                         BUGLVL(D_RX) arcnet_dump_packet(dev, recbuf, "rx irq", 0);
921
922                         arcnet_rx(dev, recbuf);
923                         release_arcbuf(dev, recbuf);
924
925                         didsomething++;
926                 }
927                 if (status & lp->intmask & RECONflag) {
928                         ACOMMAND(CFLAGScmd | CONFIGclear);
929                         dev->stats.tx_carrier_errors++;
930
931                         BUGMSG(D_RECON, "Network reconfiguration detected (status=%Xh)\n",
932                                status);
933                         /* MYRECON bit is at bit 7 of diagstatus */
934                         if(diagstatus & 0x80)
935                                 BUGMSG(D_RECON,"Put out that recon myself\n");
936
937                         /* is the RECON info empty or old? */
938                         if (!lp->first_recon || !lp->last_recon ||
939                             time_after(jiffies, lp->last_recon + HZ * 10)) {
940                                 if (lp->network_down)
941                                         BUGMSG(D_NORMAL, "reconfiguration detected: cabling restored?\n");
942                                 lp->first_recon = lp->last_recon = jiffies;
943                                 lp->num_recons = lp->network_down = 0;
944
945                                 BUGMSG(D_DURING, "recon: clearing counters.\n");
946                         } else {        /* add to current RECON counter */
947                                 lp->last_recon = jiffies;
948                                 lp->num_recons++;
949
950                                 BUGMSG(D_DURING, "recon: counter=%d, time=%lds, net=%d\n",
951                                        lp->num_recons,
952                                  (lp->last_recon - lp->first_recon) / HZ,
953                                        lp->network_down);
954
955                                 /* if network is marked up;
956                                  * and first_recon and last_recon are 60+ apart;
957                                  * and the average no. of recons counted is
958                                  *    > RECON_THRESHOLD/min;
959                                  * then print a warning message.
960                                  */
961                                 if (!lp->network_down
962                                     && (lp->last_recon - lp->first_recon) <= HZ * 60
963                                   && lp->num_recons >= RECON_THRESHOLD) {
964                                         lp->network_down = 1;
965                                         BUGMSG(D_NORMAL, "many reconfigurations detected: cabling problem?\n");
966                                 } else if (!lp->network_down
967                                            && lp->last_recon - lp->first_recon > HZ * 60) {
968                                         /* reset counters if we've gone for over a minute. */
969                                         lp->first_recon = lp->last_recon;
970                                         lp->num_recons = 1;
971                                 }
972                         }
973                 } else if (lp->network_down &&
974                                 time_after(jiffies, lp->last_recon + HZ * 10)) {
975                         if (lp->network_down)
976                                 BUGMSG(D_NORMAL, "cabling restored?\n");
977                         lp->first_recon = lp->last_recon = 0;
978                         lp->num_recons = lp->network_down = 0;
979
980                         BUGMSG(D_DURING, "not recon: clearing counters anyway.\n");
981                 }
982
983                 if(didsomething) {
984                         retval |= IRQ_HANDLED;
985                 }
986         }
987         while (--boguscount && didsomething);
988
989         BUGMSG(D_DURING, "arcnet_interrupt complete (status=%Xh, count=%d)\n",
990                ASTATUS(), boguscount);
991         BUGMSG(D_DURING, "\n");
992
993
994         AINTMASK(0);
995         udelay(1);
996         AINTMASK(lp->intmask);
997         
998         spin_unlock(&lp->lock);
999         return retval;
1000 }
1001
1002
1003 /*
1004  * This is a generic packet receiver that calls arcnet??_rx depending on the
1005  * protocol ID found.
1006  */
1007 static void arcnet_rx(struct net_device *dev, int bufnum)
1008 {
1009         struct arcnet_local *lp = netdev_priv(dev);
1010         struct archdr pkt;
1011         struct arc_rfc1201 *soft;
1012         int length, ofs;
1013
1014         soft = &pkt.soft.rfc1201;
1015
1016         lp->hw.copy_from_card(dev, bufnum, 0, &pkt, sizeof(ARC_HDR_SIZE));
1017         if (pkt.hard.offset[0]) {
1018                 ofs = pkt.hard.offset[0];
1019                 length = 256 - ofs;
1020         } else {
1021                 ofs = pkt.hard.offset[1];
1022                 length = 512 - ofs;
1023         }
1024
1025         /* get the full header, if possible */
1026         if (sizeof(pkt.soft) <= length)
1027                 lp->hw.copy_from_card(dev, bufnum, ofs, soft, sizeof(pkt.soft));
1028         else {
1029                 memset(&pkt.soft, 0, sizeof(pkt.soft));
1030                 lp->hw.copy_from_card(dev, bufnum, ofs, soft, length);
1031         }
1032
1033         BUGMSG(D_DURING, "Buffer #%d: received packet from %02Xh to %02Xh "
1034                "(%d+4 bytes)\n",
1035                bufnum, pkt.hard.source, pkt.hard.dest, length);
1036
1037         dev->stats.rx_packets++;
1038         dev->stats.rx_bytes += length + ARC_HDR_SIZE;
1039
1040         /* call the right receiver for the protocol */
1041         if (arc_proto_map[soft->proto]->is_ip) {
1042                 BUGLVL(D_PROTO) {
1043                         struct ArcProto
1044                         *oldp = arc_proto_map[lp->default_proto[pkt.hard.source]],
1045                         *newp = arc_proto_map[soft->proto];
1046
1047                         if (oldp != newp) {
1048                                 BUGMSG(D_PROTO,
1049                                        "got protocol %02Xh; encap for host %02Xh is now '%c'"
1050                                        " (was '%c')\n", soft->proto, pkt.hard.source,
1051                                        newp->suffix, oldp->suffix);
1052                         }
1053                 }
1054
1055                 /* broadcasts will always be done with the last-used encap. */
1056                 lp->default_proto[0] = soft->proto;
1057
1058                 /* in striking contrast, the following isn't a hack. */
1059                 lp->default_proto[pkt.hard.source] = soft->proto;
1060         }
1061         /* call the protocol-specific receiver. */
1062         arc_proto_map[soft->proto]->rx(dev, bufnum, &pkt, length);
1063 }
1064
1065
1066 static void null_rx(struct net_device *dev, int bufnum,
1067                     struct archdr *pkthdr, int length)
1068 {
1069         BUGMSG(D_PROTO,
1070         "rx: don't know how to deal with proto %02Xh from host %02Xh.\n",
1071                pkthdr->soft.rfc1201.proto, pkthdr->hard.source);
1072 }
1073
1074
1075 static int null_build_header(struct sk_buff *skb, struct net_device *dev,
1076                              unsigned short type, uint8_t daddr)
1077 {
1078         struct arcnet_local *lp = netdev_priv(dev);
1079
1080         BUGMSG(D_PROTO,
1081                "tx: can't build header for encap %02Xh; load a protocol driver.\n",
1082                lp->default_proto[daddr]);
1083
1084         /* always fails */
1085         return 0;
1086 }
1087
1088
1089 /* the "do nothing" prepare_tx function warns that there's nothing to do. */
1090 static int null_prepare_tx(struct net_device *dev, struct archdr *pkt,
1091                            int length, int bufnum)
1092 {
1093         struct arcnet_local *lp = netdev_priv(dev);
1094         struct arc_hardware newpkt;
1095
1096         BUGMSG(D_PROTO, "tx: no encap for this host; load a protocol driver.\n");
1097
1098         /* send a packet to myself -- will never get received, of course */
1099         newpkt.source = newpkt.dest = dev->dev_addr[0];
1100
1101         /* only one byte of actual data (and it's random) */
1102         newpkt.offset[0] = 0xFF;
1103
1104         lp->hw.copy_to_card(dev, bufnum, 0, &newpkt, ARC_HDR_SIZE);
1105
1106         return 1;               /* done */
1107 }