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