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