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