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