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