drivers/net/spider_net.c

   1 /*
   2  * Network device driver for Cell Processor-Based Blade
   3  *
   4  * (C) Copyright IBM Corp. 2005
   5  *
   6  * Authors : Utz Bacher <utz.bacher@de.ibm.com>
   7  *           Jens Osterkamp <Jens.Osterkamp@de.ibm.com>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2, or (at your option)
  12  * any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  22  */
  23
  24 #include <linux/compiler.h>
  25 #include <linux/crc32.h>
  26 #include <linux/delay.h>
  27 #include <linux/etherdevice.h>
  28 #include <linux/ethtool.h>
  29 #include <linux/firmware.h>
  30 #include <linux/if_vlan.h>
  31 #include <linux/in.h>
  32 #include <linux/init.h>
  33 #include <linux/ioport.h>
  34 #include <linux/ip.h>
  35 #include <linux/kernel.h>
  36 #include <linux/mii.h>
  37 #include <linux/module.h>
  38 #include <linux/netdevice.h>
  39 #include <linux/device.h>
  40 #include <linux/pci.h>
  41 #include <linux/skbuff.h>
  42 #include <linux/slab.h>
  43 #include <linux/tcp.h>
  44 #include <linux/types.h>
  45 #include <linux/vmalloc.h>
  46 #include <linux/wait.h>
  47 #include <linux/workqueue.h>
  48 #include <asm/bitops.h>
  49 #include <asm/pci-bridge.h>
  50 #include <net/checksum.h>
  51
  52 #include "spider_net.h"
  53
  54 MODULE_AUTHOR("Utz Bacher <utz.bacher@de.ibm.com> and Jens Osterkamp " \
  55               "<Jens.Osterkamp@de.ibm.com>");
  56 MODULE_DESCRIPTION("Spider Southbridge Gigabit Ethernet driver");
  57 MODULE_LICENSE("GPL");
  58 MODULE_VERSION(VERSION);
  59
  60 static int rx_descriptors = SPIDER_NET_RX_DESCRIPTORS_DEFAULT;
  61 static int tx_descriptors = SPIDER_NET_TX_DESCRIPTORS_DEFAULT;
  62
  63 module_param(rx_descriptors, int, 0444);
  64 module_param(tx_descriptors, int, 0444);
  65
  66 MODULE_PARM_DESC(rx_descriptors, "number of descriptors used " \
  67                  "in rx chains");
  68 MODULE_PARM_DESC(tx_descriptors, "number of descriptors used " \
  69                  "in tx chain");
  70
  71 char spider_net_driver_name[] = "spidernet";
  72
  73 static struct pci_device_id spider_net_pci_tbl[] = {
  74         { PCI_VENDOR_ID_TOSHIBA_2, PCI_DEVICE_ID_TOSHIBA_SPIDER_NET,
  75           PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0UL },
  76         { 0, }
  77 };
  78
  79 MODULE_DEVICE_TABLE(pci, spider_net_pci_tbl);
  80
  81 /**
  82  * spider_net_read_reg - reads an SMMIO register of a card
  83  * @card: device structure
  84  * @reg: register to read from
  85  *
  86  * returns the content of the specified SMMIO register.
  87  */
  88 static inline u32
  89 spider_net_read_reg(struct spider_net_card *card, u32 reg)
  90 {
  91         /* We use the powerpc specific variants instead of readl_be() because
  92          * we know spidernet is not a real PCI device and we can thus avoid the
  93          * performance hit caused by the PCI workarounds.
  94          */
  95         return in_be32(card->regs + reg);
  96 }
  97
  98 /**
  99  * spider_net_write_reg - writes to an SMMIO register of a card
 100  * @card: device structure
 101  * @reg: register to write to
 102  * @value: value to write into the specified SMMIO register
 103  */
 104 static inline void
 105 spider_net_write_reg(struct spider_net_card *card, u32 reg, u32 value)
 106 {
 107         /* We use the powerpc specific variants instead of writel_be() because
 108          * we know spidernet is not a real PCI device and we can thus avoid the
 109          * performance hit caused by the PCI workarounds.
 110          */
 111         out_be32(card->regs + reg, value);
 112 }
 113
 114 /** spider_net_write_phy - write to phy register
 115  * @netdev: adapter to be written to
 116  * @mii_id: id of MII
 117  * @reg: PHY register
 118  * @val: value to be written to phy register
 119  *
 120  * spider_net_write_phy_register writes to an arbitrary PHY
 121  * register via the spider GPCWOPCMD register. We assume the queue does
 122  * not run full (not more than 15 commands outstanding).
 123  **/
 124 static void
 125 spider_net_write_phy(struct net_device *netdev, int mii_id,
 126                      int reg, int val)
 127 {
 128         struct spider_net_card *card = netdev_priv(netdev);
 129         u32 writevalue;
 130
 131         writevalue = ((u32)mii_id << 21) |
 132                 ((u32)reg << 16) | ((u32)val);
 133
 134         spider_net_write_reg(card, SPIDER_NET_GPCWOPCMD, writevalue);
 135 }
 136
 137 /** spider_net_read_phy - read from phy register
 138  * @netdev: network device to be read from
 139  * @mii_id: id of MII
 140  * @reg: PHY register
 141  *
 142  * Returns value read from PHY register
 143  *
 144  * spider_net_write_phy reads from an arbitrary PHY
 145  * register via the spider GPCROPCMD register
 146  **/
 147 static int
 148 spider_net_read_phy(struct net_device *netdev, int mii_id, int reg)
 149 {
 150         struct spider_net_card *card = netdev_priv(netdev);
 151         u32 readvalue;
 152
 153         readvalue = ((u32)mii_id << 21) | ((u32)reg << 16);
 154         spider_net_write_reg(card, SPIDER_NET_GPCROPCMD, readvalue);
 155
 156         /* we don't use semaphores to wait for an SPIDER_NET_GPROPCMPINT
 157          * interrupt, as we poll for the completion of the read operation
 158          * in spider_net_read_phy. Should take about 50 us */
 159         do {
 160                 readvalue = spider_net_read_reg(card, SPIDER_NET_GPCROPCMD);
 161         } while (readvalue & SPIDER_NET_GPREXEC);
 162
 163         readvalue &= SPIDER_NET_GPRDAT_MASK;
 164
 165         return readvalue;
 166 }
 167
 168 /**
 169  * spider_net_rx_irq_off - switch off rx irq on this spider card
 170  * @card: device structure
 171  *
 172  * switches off rx irq by masking them out in the GHIINTnMSK register
 173  */
 174 static void
 175 spider_net_rx_irq_off(struct spider_net_card *card)
 176 {
 177         u32 regvalue;
 178
 179         regvalue = SPIDER_NET_INT0_MASK_VALUE & (~SPIDER_NET_RXINT);
 180         spider_net_write_reg(card, SPIDER_NET_GHIINT0MSK, regvalue);
 181 }
 182
 183 /**
 184  * spider_net_rx_irq_on - switch on rx irq on this spider card
 185  * @card: device structure
 186  *
 187  * switches on rx irq by enabling them in the GHIINTnMSK register
 188  */
 189 static void
 190 spider_net_rx_irq_on(struct spider_net_card *card)
 191 {
 192         u32 regvalue;
 193
 194         regvalue = SPIDER_NET_INT0_MASK_VALUE | SPIDER_NET_RXINT;
 195         spider_net_write_reg(card, SPIDER_NET_GHIINT0MSK, regvalue);
 196 }
 197
 198 /**
 199  * spider_net_set_promisc - sets the unicast address or the promiscuous mode
 200  * @card: card structure
 201  *
 202  * spider_net_set_promisc sets the unicast destination address filter and
 203  * thus either allows for non-promisc mode or promisc mode
 204  */
 205 static void
 206 spider_net_set_promisc(struct spider_net_card *card)
 207 {
 208         u32 macu, macl;
 209         struct net_device *netdev = card->netdev;
 210
 211         if (netdev->flags & IFF_PROMISC) {
 212                 /* clear destination entry 0 */
 213                 spider_net_write_reg(card, SPIDER_NET_GMRUAFILnR, 0);
 214                 spider_net_write_reg(card, SPIDER_NET_GMRUAFILnR + 0x04, 0);
 215                 spider_net_write_reg(card, SPIDER_NET_GMRUA0FIL15R,
 216                                      SPIDER_NET_PROMISC_VALUE);
 217         } else {
 218                 macu = netdev->dev_addr[0];
 219                 macu <<= 8;
 220                 macu |= netdev->dev_addr[1];
 221                 memcpy(&macl, &netdev->dev_addr[2], sizeof(macl));
 222
 223                 macu |= SPIDER_NET_UA_DESCR_VALUE;
 224                 spider_net_write_reg(card, SPIDER_NET_GMRUAFILnR, macu);
 225                 spider_net_write_reg(card, SPIDER_NET_GMRUAFILnR + 0x04, macl);
 226                 spider_net_write_reg(card, SPIDER_NET_GMRUA0FIL15R,
 227                                      SPIDER_NET_NONPROMISC_VALUE);
 228         }
 229 }
 230
 231 /**
 232  * spider_net_get_mac_address - read mac address from spider card
 233  * @card: device structure
 234  *
 235  * reads MAC address from GMACUNIMACU and GMACUNIMACL registers
 236  */
 237 static int
 238 spider_net_get_mac_address(struct net_device *netdev)
 239 {
 240         struct spider_net_card *card = netdev_priv(netdev);
 241         u32 macl, macu;
 242
 243         macl = spider_net_read_reg(card, SPIDER_NET_GMACUNIMACL);
 244         macu = spider_net_read_reg(card, SPIDER_NET_GMACUNIMACU);
 245
 246         netdev->dev_addr[0] = (macu >> 24) & 0xff;
 247         netdev->dev_addr[1] = (macu >> 16) & 0xff;
 248         netdev->dev_addr[2] = (macu >> 8) & 0xff;
 249         netdev->dev_addr[3] = macu & 0xff;
 250         netdev->dev_addr[4] = (macl >> 8) & 0xff;
 251         netdev->dev_addr[5] = macl & 0xff;
 252
 253         if (!is_valid_ether_addr(&netdev->dev_addr[0]))
 254                 return -EINVAL;
 255
 256         return 0;
 257 }
 258
 259 /**
 260  * spider_net_get_descr_status -- returns the status of a descriptor
 261  * @descr: descriptor to look at
 262  *
 263  * returns the status as in the dmac_cmd_status field of the descriptor
 264  */
 265 static inline int
 266 spider_net_get_descr_status(struct spider_net_descr *descr)
 267 {
 268         return descr->dmac_cmd_status & SPIDER_NET_DESCR_IND_PROC_MASK;
 269 }
 270
 271 /**
 272  * spider_net_free_chain - free descriptor chain
 273  * @card: card structure
 274  * @chain: address of chain
 275  *
 276  */
 277 static void
 278 spider_net_free_chain(struct spider_net_card *card,
 279                       struct spider_net_descr_chain *chain)
 280 {
 281         struct spider_net_descr *descr;
 282
 283         descr = chain->ring;
 284         do {
 285                 descr->bus_addr = 0;
 286                 descr->next_descr_addr = 0;
 287                 descr = descr->next;
 288         } while (descr != chain->ring);
 289
 290         dma_free_coherent(&card->pdev->dev, chain->num_desc,
 291             chain->ring, chain->dma_addr);
 292 }
 293
 294 /**
 295  * spider_net_init_chain - alloc and link descriptor chain
 296  * @card: card structure
 297  * @chain: address of chain
 298  *
 299  * We manage a circular list that mirrors the hardware structure,
 300  * except that the hardware uses bus addresses.
 301  *
 302  * Returns 0 on success, <0 on failure
 303  */
 304 static int
 305 spider_net_init_chain(struct spider_net_card *card,
 306                        struct spider_net_descr_chain *chain)
 307 {
 308         int i;
 309         struct spider_net_descr *descr;
 310         dma_addr_t buf;
 311         size_t alloc_size;
 312
 313         alloc_size = chain->num_desc * sizeof (struct spider_net_descr);
 314
 315         chain->ring = dma_alloc_coherent(&card->pdev->dev, alloc_size,
 316                 &chain->dma_addr, GFP_KERNEL);
 317
 318         if (!chain->ring)
 319                 return -ENOMEM;
 320
 321         descr = chain->ring;
 322         memset(descr, 0, alloc_size);
 323
 324         /* Set up the hardware pointers in each descriptor */
 325         buf = chain->dma_addr;
 326         for (i=0; i < chain->num_desc; i++, descr++) {
 327                 descr->dmac_cmd_status = SPIDER_NET_DESCR_NOT_IN_USE;
 328
 329                 descr->bus_addr = buf;
 330                 descr->next_descr_addr = 0;
 331                 descr->next = descr + 1;
 332                 descr->prev = descr - 1;
 333
 334                 buf += sizeof(struct spider_net_descr);
 335         }
 336         /* do actual circular list */
 337         (descr-1)->next = chain->ring;
 338         chain->ring->prev = descr-1;
 339
 340         spin_lock_init(&chain->lock);
 341         chain->head = chain->ring;
 342         chain->tail = chain->ring;
 343         return 0;
 344 }
 345
 346 /**
 347  * spider_net_free_rx_chain_contents - frees descr contents in rx chain
 348  * @card: card structure
 349  *
 350  * returns 0 on success, <0 on failure
 351  */
 352 static void
 353 spider_net_free_rx_chain_contents(struct spider_net_card *card)
 354 {
 355         struct spider_net_descr *descr;
 356
 357         descr = card->rx_chain.head;
 358         do {
 359                 if (descr->skb) {
 360                         dev_kfree_skb(descr->skb);
 361                         pci_unmap_single(card->pdev, descr->buf_addr,
 362                                          SPIDER_NET_MAX_FRAME,
 363                                          PCI_DMA_BIDIRECTIONAL);
 364                 }
 365                 descr = descr->next;
 366         } while (descr != card->rx_chain.head);
 367 }
 368
 369 /**
 370  * spider_net_prepare_rx_descr - reinitializes a rx descriptor
 371  * @card: card structure
 372  * @descr: descriptor to re-init
 373  *
 374  * return 0 on succes, <0 on failure
 375  *
 376  * allocates a new rx skb, iommu-maps it and attaches it to the descriptor.
 377  * Activate the descriptor state-wise
 378  */
 379 static int
 380 spider_net_prepare_rx_descr(struct spider_net_card *card,
 381                             struct spider_net_descr *descr)
 382 {
 383         dma_addr_t buf;
 384         int error = 0;
 385         int offset;
 386         int bufsize;
 387
 388         /* we need to round up the buffer size to a multiple of 128 */
 389         bufsize = (SPIDER_NET_MAX_FRAME + SPIDER_NET_RXBUF_ALIGN - 1) &
 390                 (~(SPIDER_NET_RXBUF_ALIGN - 1));
 391
 392         /* and we need to have it 128 byte aligned, therefore we allocate a
 393          * bit more */
 394         /* allocate an skb */
 395         descr->skb = dev_alloc_skb(bufsize + SPIDER_NET_RXBUF_ALIGN - 1);
 396         if (!descr->skb) {
 397                 if (netif_msg_rx_err(card) && net_ratelimit())
 398                         pr_err("Not enough memory to allocate rx buffer\n");
 399                 card->spider_stats.alloc_rx_skb_error++;
 400                 return -ENOMEM;
 401         }
 402         descr->buf_size = bufsize;
 403         descr->result_size = 0;
 404         descr->valid_size = 0;
 405         descr->data_status = 0;
 406         descr->data_error = 0;
 407
 408         offset = ((unsigned long)descr->skb->data) &
 409                 (SPIDER_NET_RXBUF_ALIGN - 1);
 410         if (offset)
 411                 skb_reserve(descr->skb, SPIDER_NET_RXBUF_ALIGN - offset);
 412         /* io-mmu-map the skb */
 413         buf = pci_map_single(card->pdev, descr->skb->data,
 414                         SPIDER_NET_MAX_FRAME, PCI_DMA_FROMDEVICE);
 415         descr->buf_addr = buf;
 416         if (pci_dma_mapping_error(buf)) {
 417                 dev_kfree_skb_any(descr->skb);
 418                 if (netif_msg_rx_err(card) && net_ratelimit())
 419                         pr_err("Could not iommu-map rx buffer\n");
 420                 card->spider_stats.rx_iommu_map_error++;
 421                 descr->dmac_cmd_status = SPIDER_NET_DESCR_NOT_IN_USE;
 422         } else {
 423                 descr->dmac_cmd_status = SPIDER_NET_DESCR_CARDOWNED |
 424                                          SPIDER_NET_DMAC_NOINTR_COMPLETE;
 425         }
 426
 427         return error;
 428 }
 429
 430 /**
 431  * spider_net_enable_rxchtails - sets RX dmac chain tail addresses
 432  * @card: card structure
 433  *
 434  * spider_net_enable_rxchtails sets the RX DMAC chain tail adresses in the
 435  * chip by writing to the appropriate register. DMA is enabled in
 436  * spider_net_enable_rxdmac.
 437  */
 438 static inline void
 439 spider_net_enable_rxchtails(struct spider_net_card *card)
 440 {
 441         /* assume chain is aligned correctly */
 442         spider_net_write_reg(card, SPIDER_NET_GDADCHA ,
 443                              card->rx_chain.tail->bus_addr);
 444 }
 445
 446 /**
 447  * spider_net_enable_rxdmac - enables a receive DMA controller
 448  * @card: card structure
 449  *
 450  * spider_net_enable_rxdmac enables the DMA controller by setting RX_DMA_EN
 451  * in the GDADMACCNTR register
 452  */
 453 static inline void
 454 spider_net_enable_rxdmac(struct spider_net_card *card)
 455 {
 456         wmb();
 457         spider_net_write_reg(card, SPIDER_NET_GDADMACCNTR,
 458                              SPIDER_NET_DMA_RX_VALUE);
 459 }
 460
 461 /**
 462  * spider_net_refill_rx_chain - refills descriptors/skbs in the rx chains
 463  * @card: card structure
 464  *
 465  * refills descriptors in the rx chain: allocates skbs and iommu-maps them.
 466  */
 467 static void
 468 spider_net_refill_rx_chain(struct spider_net_card *card)
 469 {
 470         struct spider_net_descr_chain *chain = &card->rx_chain;
 471         unsigned long flags;
 472
 473         /* one context doing the refill (and a second context seeing that
 474          * and omitting it) is ok. If called by NAPI, we'll be called again
 475          * as spider_net_decode_one_descr is called several times. If some
 476          * interrupt calls us, the NAPI is about to clean up anyway. */
 477         if (!spin_trylock_irqsave(&chain->lock, flags))
 478                 return;
 479
 480         while (spider_net_get_descr_status(chain->head) ==
 481                         SPIDER_NET_DESCR_NOT_IN_USE) {
 482                 if (spider_net_prepare_rx_descr(card, chain->head))
 483                         break;
 484                 chain->head = chain->head->next;
 485         }
 486
 487         spin_unlock_irqrestore(&chain->lock, flags);
 488 }
 489
 490 /**
 491  * spider_net_alloc_rx_skbs - allocates rx skbs in rx descriptor chains
 492  * @card: card structure
 493  *
 494  * returns 0 on success, <0 on failure
 495  */
 496 static int
 497 spider_net_alloc_rx_skbs(struct spider_net_card *card)
 498 {
 499         int result;
 500         struct spider_net_descr_chain *chain;
 501
 502         result = -ENOMEM;
 503
 504         chain = &card->rx_chain;
 505         /* put at least one buffer into the chain. if this fails,
 506          * we've got a problem. if not, spider_net_refill_rx_chain
 507          * will do the rest at the end of this function */
 508         if (spider_net_prepare_rx_descr(card, chain->head))
 509                 goto error;
 510         else
 511                 chain->head = chain->head->next;
 512
 513         /* this will allocate the rest of the rx buffers; if not, it's
 514          * business as usual later on */
 515         spider_net_refill_rx_chain(card);
 516         spider_net_enable_rxdmac(card);
 517         return 0;
 518
 519 error:
 520         spider_net_free_rx_chain_contents(card);
 521         return result;
 522 }
 523
 524 /**
 525  * spider_net_get_multicast_hash - generates hash for multicast filter table
 526  * @addr: multicast address
 527  *
 528  * returns the hash value.
 529  *
 530  * spider_net_get_multicast_hash calculates a hash value for a given multicast
 531  * address, that is used to set the multicast filter tables
 532  */
 533 static u8
 534 spider_net_get_multicast_hash(struct net_device *netdev, __u8 *addr)
 535 {
 536         u32 crc;
 537         u8 hash;
 538         char addr_for_crc[ETH_ALEN] = { 0, };
 539         int i, bit;
 540
 541         for (i = 0; i < ETH_ALEN * 8; i++) {
 542                 bit = (addr[i / 8] >> (i % 8)) & 1;
 543                 addr_for_crc[ETH_ALEN - 1 - i / 8] += bit << (7 - (i % 8));
 544         }
 545
 546         crc = crc32_be(~0, addr_for_crc, netdev->addr_len);
 547
 548         hash = (crc >> 27);
 549         hash <<= 3;
 550         hash |= crc & 7;
 551         hash &= 0xff;
 552
 553         return hash;
 554 }
 555
 556 /**
 557  * spider_net_set_multi - sets multicast addresses and promisc flags
 558  * @netdev: interface device structure
 559  *
 560  * spider_net_set_multi configures multicast addresses as needed for the
 561  * netdev interface. It also sets up multicast, allmulti and promisc
 562  * flags appropriately
 563  */
 564 static void
 565 spider_net_set_multi(struct net_device *netdev)
 566 {
 567         struct dev_mc_list *mc;
 568         u8 hash;
 569         int i;
 570         u32 reg;
 571         struct spider_net_card *card = netdev_priv(netdev);
 572         unsigned long bitmask[SPIDER_NET_MULTICAST_HASHES / BITS_PER_LONG] =
 573                 {0, };
 574
 575         spider_net_set_promisc(card);
 576
 577         if (netdev->flags & IFF_ALLMULTI) {
 578                 for (i = 0; i < SPIDER_NET_MULTICAST_HASHES; i++) {
 579                         set_bit(i, bitmask);
 580                 }
 581                 goto write_hash;
 582         }
 583
 584         /* well, we know, what the broadcast hash value is: it's xfd
 585         hash = spider_net_get_multicast_hash(netdev, netdev->broadcast); */
 586         set_bit(0xfd, bitmask);
 587
 588         for (mc = netdev->mc_list; mc; mc = mc->next) {
 589                 hash = spider_net_get_multicast_hash(netdev, mc->dmi_addr);
 590                 set_bit(hash, bitmask);
 591         }
 592
 593 write_hash:
 594         for (i = 0; i < SPIDER_NET_MULTICAST_HASHES / 4; i++) {
 595                 reg = 0;
 596                 if (test_bit(i * 4, bitmask))
 597                         reg += 0x08;
 598                 reg <<= 8;
 599                 if (test_bit(i * 4 + 1, bitmask))
 600                         reg += 0x08;
 601                 reg <<= 8;
 602                 if (test_bit(i * 4 + 2, bitmask))
 603                         reg += 0x08;
 604                 reg <<= 8;
 605                 if (test_bit(i * 4 + 3, bitmask))
 606                         reg += 0x08;
 607
 608                 spider_net_write_reg(card, SPIDER_NET_GMRMHFILnR + i * 4, reg);
 609         }
 610 }
 611
 612 /**
 613  * spider_net_disable_rxdmac - disables the receive DMA controller
 614  * @card: card structure
 615  *
 616  * spider_net_disable_rxdmac terminates processing on the DMA controller by
 617  * turing off DMA and issueing a force end
 618  */
 619 static void
 620 spider_net_disable_rxdmac(struct spider_net_card *card)
 621 {
 622         spider_net_write_reg(card, SPIDER_NET_GDADMACCNTR,
 623                              SPIDER_NET_DMA_RX_FEND_VALUE);
 624 }
 625
 626 /**
 627  * spider_net_prepare_tx_descr - fill tx descriptor with skb data
 628  * @card: card structure
 629  * @descr: descriptor structure to fill out
 630  * @skb: packet to use
 631  *
 632  * returns 0 on success, <0 on failure.
 633  *
 634  * fills out the descriptor structure with skb data and len. Copies data,
 635  * if needed (32bit DMA!)
 636  */
 637 static int
 638 spider_net_prepare_tx_descr(struct spider_net_card *card,
 639                             struct sk_buff *skb)
 640 {
 641         struct spider_net_descr *descr;
 642         dma_addr_t buf;
 643         unsigned long flags;
 644
 645         buf = pci_map_single(card->pdev, skb->data, skb->len, PCI_DMA_TODEVICE);
 646         if (pci_dma_mapping_error(buf)) {
 647                 if (netif_msg_tx_err(card) && net_ratelimit())
 648                         pr_err("could not iommu-map packet (%p, %i). "
 649                                   "Dropping packet\n", skb->data, skb->len);
 650                 card->spider_stats.tx_iommu_map_error++;
 651                 return -ENOMEM;
 652         }
 653
 654         spin_lock_irqsave(&card->tx_chain.lock, flags);
 655         descr = card->tx_chain.head;
 656         card->tx_chain.head = descr->next;
 657
 658         descr->buf_addr = buf;
 659         descr->buf_size = skb->len;
 660         descr->next_descr_addr = 0;
 661         descr->skb = skb;
 662         descr->data_status = 0;
 663
 664         descr->dmac_cmd_status =
 665                         SPIDER_NET_DESCR_CARDOWNED | SPIDER_NET_DMAC_NOCS;
 666         spin_unlock_irqrestore(&card->tx_chain.lock, flags);
 667
 668         if (skb->protocol == htons(ETH_P_IP))
 669                 switch (skb->nh.iph->protocol) {
 670                 case IPPROTO_TCP:
 671                         descr->dmac_cmd_status |= SPIDER_NET_DMAC_TCP;
 672                         break;
 673                 case IPPROTO_UDP:
 674                         descr->dmac_cmd_status |= SPIDER_NET_DMAC_UDP;
 675                         break;
 676                 }
 677
 678         /* Chain the bus address, so that the DMA engine finds this descr. */
 679         descr->prev->next_descr_addr = descr->bus_addr;
 680
 681         card->netdev->trans_start = jiffies; /* set netdev watchdog timer */
 682         return 0;
 683 }
 684
 685 static int
 686 spider_net_set_low_watermark(struct spider_net_card *card)
 687 {
 688         unsigned long flags;
 689         int status;
 690         int cnt=0;
 691         int i;
 692         struct spider_net_descr *descr = card->tx_chain.tail;
 693
 694         /* Measure the length of the queue. Measurement does not
 695          * need to be precise -- does not need a lock. */
 696         while (descr != card->tx_chain.head) {
 697                 status = descr->dmac_cmd_status & SPIDER_NET_DESCR_NOT_IN_USE;
 698                 if (status == SPIDER_NET_DESCR_NOT_IN_USE)
 699                         break;
 700                 descr = descr->next;
 701                 cnt++;
 702         }
 703
 704         /* If TX queue is short, don't even bother with interrupts */
 705         if (cnt < card->tx_chain.num_desc/4)
 706                 return cnt;
 707
 708         /* Set low-watermark 3/4th's of the way into the queue. */
 709         descr = card->tx_chain.tail;
 710         cnt = (cnt*3)/4;
 711         for (i=0;i<cnt; i++)
 712                 descr = descr->next;
 713
 714         /* Set the new watermark, clear the old watermark */
 715         spin_lock_irqsave(&card->tx_chain.lock, flags);
 716         descr->dmac_cmd_status |= SPIDER_NET_DESCR_TXDESFLG;
 717         if (card->low_watermark && card->low_watermark != descr)
 718                 card->low_watermark->dmac_cmd_status =
 719                      card->low_watermark->dmac_cmd_status & ~SPIDER_NET_DESCR_TXDESFLG;
 720         card->low_watermark = descr;
 721         spin_unlock_irqrestore(&card->tx_chain.lock, flags);
 722         return cnt;
 723 }
 724
 725 /**
 726  * spider_net_release_tx_chain - processes sent tx descriptors
 727  * @card: adapter structure
 728  * @brutal: if set, don't care about whether descriptor seems to be in use
 729  *
 730  * returns 0 if the tx ring is empty, otherwise 1.
 731  *
 732  * spider_net_release_tx_chain releases the tx descriptors that spider has
 733  * finished with (if non-brutal) or simply release tx descriptors (if brutal).
 734  * If some other context is calling this function, we return 1 so that we're
 735  * scheduled again (if we were scheduled) and will not loose initiative.
 736  */
 737 static int
 738 spider_net_release_tx_chain(struct spider_net_card *card, int brutal)
 739 {
 740         struct spider_net_descr_chain *chain = &card->tx_chain;
 741         struct spider_net_descr *descr;
 742         struct sk_buff *skb;
 743         u32 buf_addr;
 744         unsigned long flags;
 745         int status;
 746
 747         while (chain->tail != chain->head) {
 748                 spin_lock_irqsave(&chain->lock, flags);
 749                 descr = chain->tail;
 750
 751                 status = spider_net_get_descr_status(descr);
 752                 switch (status) {
 753                 case SPIDER_NET_DESCR_COMPLETE:
 754                         card->netdev_stats.tx_packets++;
 755                         card->netdev_stats.tx_bytes += descr->skb->len;
 756                         break;
 757
 758                 case SPIDER_NET_DESCR_CARDOWNED:
 759                         if (!brutal) {
 760                                 spin_unlock_irqrestore(&chain->lock, flags);
 761                                 return 1;
 762                         }
 763
 764                         /* fallthrough, if we release the descriptors
 765                          * brutally (then we don't care about
 766                          * SPIDER_NET_DESCR_CARDOWNED) */
 767
 768                 case SPIDER_NET_DESCR_RESPONSE_ERROR:
 769                 case SPIDER_NET_DESCR_PROTECTION_ERROR:
 770                 case SPIDER_NET_DESCR_FORCE_END:
 771                         if (netif_msg_tx_err(card))
 772                                 pr_err("%s: forcing end of tx descriptor "
 773                                        "with status x%02x\n",
 774                                        card->netdev->name, status);
 775                         card->netdev_stats.tx_errors++;
 776                         break;
 777
 778                 default:
 779                         card->netdev_stats.tx_dropped++;
 780                         if (!brutal) {
 781                                 spin_unlock_irqrestore(&chain->lock, flags);
 782                                 return 1;
 783                         }
 784                 }
 785
 786                 chain->tail = descr->next;
 787                 descr->dmac_cmd_status |= SPIDER_NET_DESCR_NOT_IN_USE;
 788                 skb = descr->skb;
 789                 buf_addr = descr->buf_addr;
 790                 spin_unlock_irqrestore(&chain->lock, flags);
 791
 792                 /* unmap the skb */
 793                 if (skb) {
 794                         pci_unmap_single(card->pdev, buf_addr, skb->len,
 795                                         PCI_DMA_TODEVICE);
 796                         dev_kfree_skb(skb);
 797                 }
 798         }
 799         return 0;
 800 }
 801
 802 /**
 803  * spider_net_kick_tx_dma - enables TX DMA processing
 804  * @card: card structure
 805  * @descr: descriptor address to enable TX processing at
 806  *
 807  * This routine will start the transmit DMA running if
 808  * it is not already running. This routine ned only be
 809  * called when queueing a new packet to an empty tx queue.
 810  * Writes the current tx chain head as start address
 811  * of the tx descriptor chain and enables the transmission
 812  * DMA engine.
 813  */
 814 static inline void
 815 spider_net_kick_tx_dma(struct spider_net_card *card)
 816 {
 817         struct spider_net_descr *descr;
 818
 819         if (spider_net_read_reg(card, SPIDER_NET_GDTDMACCNTR) &
 820                         SPIDER_NET_TX_DMA_EN)
 821                 goto out;
 822
 823         descr = card->tx_chain.tail;
 824         for (;;) {
 825                 if (spider_net_get_descr_status(descr) ==
 826                                 SPIDER_NET_DESCR_CARDOWNED) {
 827                         spider_net_write_reg(card, SPIDER_NET_GDTDCHA,
 828                                         descr->bus_addr);
 829                         spider_net_write_reg(card, SPIDER_NET_GDTDMACCNTR,
 830                                         SPIDER_NET_DMA_TX_VALUE);
 831                         break;
 832                 }
 833                 if (descr == card->tx_chain.head)
 834                         break;
 835                 descr = descr->next;
 836         }
 837
 838 out:
 839         mod_timer(&card->tx_timer, jiffies + SPIDER_NET_TX_TIMER);
 840 }
 841
 842 /**
 843  * spider_net_xmit - transmits a frame over the device
 844  * @skb: packet to send out
 845  * @netdev: interface device structure
 846  *
 847  * returns 0 on success, !0 on failure
 848  */
 849 static int
 850 spider_net_xmit(struct sk_buff *skb, struct net_device *netdev)
 851 {
 852         int cnt;
 853         struct spider_net_card *card = netdev_priv(netdev);
 854         struct spider_net_descr_chain *chain = &card->tx_chain;
 855
 856         spider_net_release_tx_chain(card, 0);
 857
 858         if ((chain->head->next == chain->tail->prev) ||
 859            (spider_net_prepare_tx_descr(card, skb) != 0)) {
 860
 861                 card->netdev_stats.tx_dropped++;
 862                 netif_stop_queue(netdev);
 863                 return NETDEV_TX_BUSY;
 864         }
 865
 866         cnt = spider_net_set_low_watermark(card);
 867         if (cnt < 5)
 868                 spider_net_kick_tx_dma(card);
 869         return NETDEV_TX_OK;
 870 }
 871
 872 /**
 873  * spider_net_cleanup_tx_ring - cleans up the TX ring
 874  * @card: card structure
 875  *
 876  * spider_net_cleanup_tx_ring is called by either the tx_timer
 877  * or from the NAPI polling routine.
 878  * This routine releases resources associted with transmitted
 879  * packets, including updating the queue tail pointer.
 880  */
 881 static void
 882 spider_net_cleanup_tx_ring(struct spider_net_card *card)
 883 {
 884         if ((spider_net_release_tx_chain(card, 0) != 0) &&
 885             (card->netdev->flags & IFF_UP)) {
 886                 spider_net_kick_tx_dma(card);
 887                 netif_wake_queue(card->netdev);
 888         }
 889 }
 890
 891 /**
 892  * spider_net_do_ioctl - called for device ioctls
 893  * @netdev: interface device structure
 894  * @ifr: request parameter structure for ioctl
 895  * @cmd: command code for ioctl
 896  *
 897  * returns 0 on success, <0 on failure. Currently, we have no special ioctls.
 898  * -EOPNOTSUPP is returned, if an unknown ioctl was requested
 899  */
 900 static int
 901 spider_net_do_ioctl(struct net_device *netdev, struct ifreq *ifr, int cmd)
 902 {
 903         switch (cmd) {
 904         default:
 905                 return -EOPNOTSUPP;
 906         }
 907 }
 908
 909 /**
 910  * spider_net_pass_skb_up - takes an skb from a descriptor and passes it on
 911  * @descr: descriptor to process
 912  * @card: card structure
 913  * @napi: whether caller is in NAPI context
 914  *
 915  * returns 1 on success, 0 if no packet was passed to the stack
 916  *
 917  * iommu-unmaps the skb, fills out skb structure and passes the data to the
 918  * stack. The descriptor state is not changed.
 919  */
 920 static int
 921 spider_net_pass_skb_up(struct spider_net_descr *descr,
 922                        struct spider_net_card *card, int napi)
 923 {
 924         struct sk_buff *skb;
 925         struct net_device *netdev;
 926         u32 data_status, data_error;
 927
 928         data_status = descr->data_status;
 929         data_error = descr->data_error;
 930
 931         netdev = card->netdev;
 932
 933         /* unmap descriptor */
 934         pci_unmap_single(card->pdev, descr->buf_addr, SPIDER_NET_MAX_FRAME,
 935                         PCI_DMA_FROMDEVICE);
 936
 937         /* the cases we'll throw away the packet immediately */
 938         if (data_error & SPIDER_NET_DESTROY_RX_FLAGS) {
 939                 if (netif_msg_rx_err(card))
 940                         pr_err("error in received descriptor found, "
 941                                "data_status=x%08x, data_error=x%08x\n",
 942                                data_status, data_error);
 943                 card->spider_stats.rx_desc_error++;
 944                 return 0;
 945         }
 946
 947         skb = descr->skb;
 948         skb->dev = netdev;
 949         skb_put(skb, descr->valid_size);
 950
 951         /* the card seems to add 2 bytes of junk in front
 952          * of the ethernet frame */
 953 #define SPIDER_MISALIGN         2
 954         skb_pull(skb, SPIDER_MISALIGN);
 955         skb->protocol = eth_type_trans(skb, netdev);
 956
 957         /* checksum offload */
 958         if (card->options.rx_csum) {
 959                 if ( ( (data_status & SPIDER_NET_DATA_STATUS_CKSUM_MASK) ==
 960                        SPIDER_NET_DATA_STATUS_CKSUM_MASK) &&
 961                      !(data_error & SPIDER_NET_DATA_ERR_CKSUM_MASK))
 962                         skb->ip_summed = CHECKSUM_UNNECESSARY;
 963                 else
 964                         skb->ip_summed = CHECKSUM_NONE;
 965         } else
 966                 skb->ip_summed = CHECKSUM_NONE;
 967
 968         if (data_status & SPIDER_NET_VLAN_PACKET) {
 969                 /* further enhancements: HW-accel VLAN
 970                  * vlan_hwaccel_receive_skb
 971                  */
 972         }
 973
 974         /* pass skb up to stack */
 975         if (napi)
 976                 netif_receive_skb(skb);
 977         else
 978                 netif_rx_ni(skb);
 979
 980         /* update netdevice statistics */
 981         card->netdev_stats.rx_packets++;
 982         card->netdev_stats.rx_bytes += skb->len;
 983
 984         return 1;
 985 }
 986
 987 /**
 988  * spider_net_decode_one_descr - processes an rx descriptor
 989  * @card: card structure
 990  * @napi: whether caller is in NAPI context
 991  *
 992  * returns 1 if a packet has been sent to the stack, otherwise 0
 993  *
 994  * processes an rx descriptor by iommu-unmapping the data buffer and passing
 995  * the packet up to the stack. This function is called in softirq
 996  * context, e.g. either bottom half from interrupt or NAPI polling context
 997  */
 998 static int
 999 spider_net_decode_one_descr(struct spider_net_card *card, int napi)
1000 {
1001         struct spider_net_descr_chain *chain = &card->rx_chain;
1002         struct spider_net_descr *descr = chain->tail;
1003         int status;
1004         int result;
1005
1006         status = spider_net_get_descr_status(descr);
1007
1008         if (status == SPIDER_NET_DESCR_CARDOWNED) {
1009                 /* nothing in the descriptor yet */
1010                 result=0;
1011                 goto out;
1012         }
1013
1014         if (status == SPIDER_NET_DESCR_NOT_IN_USE) {
1015                 /* not initialized yet, the ring must be empty */
1016                 spider_net_refill_rx_chain(card);
1017                 spider_net_enable_rxdmac(card);
1018                 result=0;
1019                 goto out;
1020         }
1021
1022         /* descriptor definitively used -- move on tail */
1023         chain->tail = descr->next;
1024
1025         result = 0;
1026         if ( (status == SPIDER_NET_DESCR_RESPONSE_ERROR) ||
1027              (status == SPIDER_NET_DESCR_PROTECTION_ERROR) ||
1028              (status == SPIDER_NET_DESCR_FORCE_END) ) {
1029                 if (netif_msg_rx_err(card))
1030                         pr_err("%s: dropping RX descriptor with state %d\n",
1031                                card->netdev->name, status);
1032                 card->netdev_stats.rx_dropped++;
1033                 pci_unmap_single(card->pdev, descr->buf_addr,
1034                                 SPIDER_NET_MAX_FRAME, PCI_DMA_FROMDEVICE);
1035                 dev_kfree_skb_irq(descr->skb);
1036                 goto refill;
1037         }
1038
1039         if ( (status != SPIDER_NET_DESCR_COMPLETE) &&
1040              (status != SPIDER_NET_DESCR_FRAME_END) ) {
1041                 if (netif_msg_rx_err(card))
1042                         pr_err("%s: RX descriptor with state %d\n",
1043                                card->netdev->name, status);
1044                 card->spider_stats.rx_desc_unk_state++;
1045                 goto refill;
1046         }
1047
1048         /* ok, we've got a packet in descr */
1049         result = spider_net_pass_skb_up(descr, card, napi);
1050 refill:
1051         descr->dmac_cmd_status = SPIDER_NET_DESCR_NOT_IN_USE;
1052         /* change the descriptor state: */
1053         if (!napi)
1054                 spider_net_refill_rx_chain(card);
1055 out:
1056         return result;
1057 }
1058
1059 /**
1060  * spider_net_poll - NAPI poll function called by the stack to return packets
1061  * @netdev: interface device structure
1062  * @budget: number of packets we can pass to the stack at most
1063  *
1064  * returns 0 if no more packets available to the driver/stack. Returns 1,
1065  * if the quota is exceeded, but the driver has still packets.
1066  *
1067  * spider_net_poll returns all packets from the rx descriptors to the stack
1068  * (using netif_receive_skb). If all/enough packets are up, the driver
1069  * reenables interrupts and returns 0. If not, 1 is returned.
1070  */
1071 static int
1072 spider_net_poll(struct net_device *netdev, int *budget)
1073 {
1074         struct spider_net_card *card = netdev_priv(netdev);
1075         int packets_to_do, packets_done = 0;
1076         int no_more_packets = 0;
1077
1078         spider_net_cleanup_tx_ring(card);
1079         packets_to_do = min(*budget, netdev->quota);
1080
1081         while (packets_to_do) {
1082                 if (spider_net_decode_one_descr(card, 1)) {
1083                         packets_done++;
1084                         packets_to_do--;
1085                 } else {
1086                         /* no more packets for the stack */
1087                         no_more_packets = 1;
1088                         break;
1089                 }
1090         }
1091
1092         netdev->quota -= packets_done;
1093         *budget -= packets_done;
1094         spider_net_refill_rx_chain(card);
1095
1096         /* if all packets are in the stack, enable interrupts and return 0 */
1097         /* if not, return 1 */
1098         if (no_more_packets) {
1099                 netif_rx_complete(netdev);
1100                 spider_net_rx_irq_on(card);
1101                 return 0;
1102         }
1103
1104         return 1;
1105 }
1106
1107 /**
1108  * spider_net_vlan_rx_reg - initializes VLAN structures in the driver and card
1109  * @netdev: interface device structure
1110  * @grp: vlan_group structure that is registered (NULL on destroying interface)
1111  */
1112 static void
1113 spider_net_vlan_rx_reg(struct net_device *netdev, struct vlan_group *grp)
1114 {
1115         /* further enhancement... yet to do */
1116         return;
1117 }
1118
1119 /**
1120  * spider_net_vlan_rx_add - adds VLAN id to the card filter
1121  * @netdev: interface device structure
1122  * @vid: VLAN id to add
1123  */
1124 static void
1125 spider_net_vlan_rx_add(struct net_device *netdev, uint16_t vid)
1126 {
1127         /* further enhancement... yet to do */
1128         /* add vid to card's VLAN filter table */
1129         return;
1130 }
1131
1132 /**
1133  * spider_net_vlan_rx_kill - removes VLAN id to the card filter
1134  * @netdev: interface device structure
1135  * @vid: VLAN id to remove
1136  */
1137 static void
1138 spider_net_vlan_rx_kill(struct net_device *netdev, uint16_t vid)
1139 {
1140         /* further enhancement... yet to do */
1141         /* remove vid from card's VLAN filter table */
1142 }
1143
1144 /**
1145  * spider_net_get_stats - get interface statistics
1146  * @netdev: interface device structure
1147  *
1148  * returns the interface statistics residing in the spider_net_card struct
1149  */
1150 static struct net_device_stats *
1151 spider_net_get_stats(struct net_device *netdev)
1152 {
1153         struct spider_net_card *card = netdev_priv(netdev);
1154         struct net_device_stats *stats = &card->netdev_stats;
1155         return stats;
1156 }
1157
1158 /**
1159  * spider_net_change_mtu - changes the MTU of an interface
1160  * @netdev: interface device structure
1161  * @new_mtu: new MTU value
1162  *
1163  * returns 0 on success, <0 on failure
1164  */
1165 static int
1166 spider_net_change_mtu(struct net_device *netdev, int new_mtu)
1167 {
1168         /* no need to re-alloc skbs or so -- the max mtu is about 2.3k
1169          * and mtu is outbound only anyway */
1170         if ( (new_mtu < SPIDER_NET_MIN_MTU ) ||
1171                 (new_mtu > SPIDER_NET_MAX_MTU) )
1172                 return -EINVAL;
1173         netdev->mtu = new_mtu;
1174         return 0;
1175 }
1176
1177 /**
1178  * spider_net_set_mac - sets the MAC of an interface
1179  * @netdev: interface device structure
1180  * @ptr: pointer to new MAC address
1181  *
1182  * Returns 0 on success, <0 on failure. Currently, we don't support this
1183  * and will always return EOPNOTSUPP.
1184  */
1185 static int
1186 spider_net_set_mac(struct net_device *netdev, void *p)
1187 {
1188         struct spider_net_card *card = netdev_priv(netdev);
1189         u32 macl, macu, regvalue;
1190         struct sockaddr *addr = p;
1191
1192         if (!is_valid_ether_addr(addr->sa_data))
1193                 return -EADDRNOTAVAIL;
1194
1195         /* switch off GMACTPE and GMACRPE */
1196         regvalue = spider_net_read_reg(card, SPIDER_NET_GMACOPEMD);
1197         regvalue &= ~((1 << 5) | (1 << 6));
1198         spider_net_write_reg(card, SPIDER_NET_GMACOPEMD, regvalue);
1199
1200         /* write mac */
1201         macu = (addr->sa_data[0]<<24) + (addr->sa_data[1]<<16) +
1202                 (addr->sa_data[2]<<8) + (addr->sa_data[3]);
1203         macl = (addr->sa_data[4]<<8) + (addr->sa_data[5]);
1204         spider_net_write_reg(card, SPIDER_NET_GMACUNIMACU, macu);
1205         spider_net_write_reg(card, SPIDER_NET_GMACUNIMACL, macl);
1206
1207         /* switch GMACTPE and GMACRPE back on */
1208         regvalue = spider_net_read_reg(card, SPIDER_NET_GMACOPEMD);
1209         regvalue |= ((1 << 5) | (1 << 6));
1210         spider_net_write_reg(card, SPIDER_NET_GMACOPEMD, regvalue);
1211
1212         spider_net_set_promisc(card);
1213
1214         /* look up, whether we have been successful */
1215         if (spider_net_get_mac_address(netdev))
1216                 return -EADDRNOTAVAIL;
1217         if (memcmp(netdev->dev_addr,addr->sa_data,netdev->addr_len))
1218                 return -EADDRNOTAVAIL;
1219
1220         return 0;
1221 }
1222
1223 /**
1224  * spider_net_handle_rxram_full - cleans up RX ring upon RX RAM full interrupt
1225  * @card: card structure
1226  *
1227  * spider_net_handle_rxram_full empties the RX ring so that spider can put
1228  * more packets in it and empty its RX RAM. This is called in bottom half
1229  * context
1230  */
1231 static void
1232 spider_net_handle_rxram_full(struct spider_net_card *card)
1233 {
1234         while (spider_net_decode_one_descr(card, 0))
1235                 ;
1236         spider_net_enable_rxchtails(card);
1237         spider_net_enable_rxdmac(card);
1238         netif_rx_schedule(card->netdev);
1239 }
1240
1241 /**
1242  * spider_net_handle_error_irq - handles errors raised by an interrupt
1243  * @card: card structure
1244  * @status_reg: interrupt status register 0 (GHIINT0STS)
1245  *
1246  * spider_net_handle_error_irq treats or ignores all error conditions
1247  * found when an interrupt is presented
1248  */
1249 static void
1250 spider_net_handle_error_irq(struct spider_net_card *card, u32 status_reg)
1251 {
1252         u32 error_reg1, error_reg2;
1253         u32 i;
1254         int show_error = 1;
1255
1256         error_reg1 = spider_net_read_reg(card, SPIDER_NET_GHIINT1STS);
1257         error_reg2 = spider_net_read_reg(card, SPIDER_NET_GHIINT2STS);
1258
1259         /* check GHIINT0STS ************************************/
1260         if (status_reg)
1261                 for (i = 0; i < 32; i++)
1262                         if (status_reg & (1<<i))
1263                                 switch (i)
1264         {
1265         /* let error_reg1 and error_reg2 evaluation decide, what to do
1266         case SPIDER_NET_PHYINT:
1267         case SPIDER_NET_GMAC2INT:
1268         case SPIDER_NET_GMAC1INT:
1269         case SPIDER_NET_GFIFOINT:
1270         case SPIDER_NET_DMACINT:
1271         case SPIDER_NET_GSYSINT:
1272                 break; */
1273
1274         case SPIDER_NET_GIPSINT:
1275                 show_error = 0;
1276                 break;
1277
1278         case SPIDER_NET_GPWOPCMPINT:
1279                 /* PHY write operation completed */
1280                 show_error = 0;
1281                 break;
1282         case SPIDER_NET_GPROPCMPINT:
1283                 /* PHY read operation completed */
1284                 /* we don't use semaphores, as we poll for the completion
1285                  * of the read operation in spider_net_read_phy. Should take
1286                  * about 50 us */
1287                 show_error = 0;
1288                 break;
1289         case SPIDER_NET_GPWFFINT:
1290                 /* PHY command queue full */
1291                 if (netif_msg_intr(card))
1292                         pr_err("PHY write queue full\n");
1293                 show_error = 0;
1294                 break;
1295
1296         /* case SPIDER_NET_GRMDADRINT: not used. print a message */
1297         /* case SPIDER_NET_GRMARPINT: not used. print a message */
1298         /* case SPIDER_NET_GRMMPINT: not used. print a message */
1299
1300         case SPIDER_NET_GDTDEN0INT:
1301                 /* someone has set TX_DMA_EN to 0 */
1302                 show_error = 0;
1303                 break;
1304
1305         case SPIDER_NET_GDDDEN0INT: /* fallthrough */
1306         case SPIDER_NET_GDCDEN0INT: /* fallthrough */
1307         case SPIDER_NET_GDBDEN0INT: /* fallthrough */
1308         case SPIDER_NET_GDADEN0INT:
1309                 /* someone has set RX_DMA_EN to 0 */
1310                 show_error = 0;
1311                 break;
1312
1313         /* RX interrupts */
1314         case SPIDER_NET_GDDFDCINT:
1315         case SPIDER_NET_GDCFDCINT:
1316         case SPIDER_NET_GDBFDCINT:
1317         case SPIDER_NET_GDAFDCINT:
1318         /* case SPIDER_NET_GDNMINT: not used. print a message */
1319         /* case SPIDER_NET_GCNMINT: not used. print a message */
1320         /* case SPIDER_NET_GBNMINT: not used. print a message */
1321         /* case SPIDER_NET_GANMINT: not used. print a message */
1322         /* case SPIDER_NET_GRFNMINT: not used. print a message */
1323                 show_error = 0;
1324                 break;
1325
1326         /* TX interrupts */
1327         case SPIDER_NET_GDTFDCINT:
1328                 show_error = 0;
1329                 break;
1330         case SPIDER_NET_GTTEDINT:
1331                 show_error = 0;
1332                 break;
1333         case SPIDER_NET_GDTDCEINT:
1334                 /* chain end. If a descriptor should be sent, kick off
1335                  * tx dma
1336                 if (card->tx_chain.tail != card->tx_chain.head)
1337                         spider_net_kick_tx_dma(card);
1338                 */
1339                 show_error = 0;
1340                 break;
1341
1342         /* case SPIDER_NET_G1TMCNTINT: not used. print a message */
1343         /* case SPIDER_NET_GFREECNTINT: not used. print a message */
1344         }
1345
1346         /* check GHIINT1STS ************************************/
1347         if (error_reg1)
1348                 for (i = 0; i < 32; i++)
1349                         if (error_reg1 & (1<<i))
1350                                 switch (i)
1351         {
1352         case SPIDER_NET_GTMFLLINT:
1353                 if (netif_msg_intr(card) && net_ratelimit())
1354                         pr_err("Spider TX RAM full\n");
1355                 show_error = 0;
1356                 break;
1357         case SPIDER_NET_GRFDFLLINT: /* fallthrough */
1358         case SPIDER_NET_GRFCFLLINT: /* fallthrough */
1359         case SPIDER_NET_GRFBFLLINT: /* fallthrough */
1360         case SPIDER_NET_GRFAFLLINT: /* fallthrough */
1361         case SPIDER_NET_GRMFLLINT:
1362                 if (netif_msg_intr(card) && net_ratelimit())
1363                         pr_err("Spider RX RAM full, incoming packets "
1364                                "might be discarded!\n");
1365                 spider_net_rx_irq_off(card);
1366                 tasklet_schedule(&card->rxram_full_tl);
1367                 show_error = 0;
1368                 break;
1369
1370         /* case SPIDER_NET_GTMSHTINT: problem, print a message */
1371         case SPIDER_NET_GDTINVDINT:
1372                 /* allrighty. tx from previous descr ok */
1373                 show_error = 0;
1374                 break;
1375
1376         /* chain end */
1377         case SPIDER_NET_GDDDCEINT: /* fallthrough */
1378         case SPIDER_NET_GDCDCEINT: /* fallthrough */
1379         case SPIDER_NET_GDBDCEINT: /* fallthrough */
1380         case SPIDER_NET_GDADCEINT:
1381                 if (netif_msg_intr(card) && net_ratelimit())
1382                         pr_err("got descriptor chain end interrupt, "
1383                                "restarting DMAC %c.\n",
1384                                'D'-(i-SPIDER_NET_GDDDCEINT)/3);
1385                 spider_net_refill_rx_chain(card);
1386                 spider_net_enable_rxdmac(card);
1387                 show_error = 0;
1388                 break;
1389
1390         /* invalid descriptor */
1391         case SPIDER_NET_GDDINVDINT: /* fallthrough */
1392         case SPIDER_NET_GDCINVDINT: /* fallthrough */
1393         case SPIDER_NET_GDBINVDINT: /* fallthrough */
1394         case SPIDER_NET_GDAINVDINT:
1395                 /* could happen when rx chain is full */
1396                 spider_net_refill_rx_chain(card);
1397                 spider_net_enable_rxdmac(card);
1398                 show_error = 0;
1399                 break;
1400
1401         /* case SPIDER_NET_GDTRSERINT: problem, print a message */
1402         /* case SPIDER_NET_GDDRSERINT: problem, print a message */
1403         /* case SPIDER_NET_GDCRSERINT: problem, print a message */
1404         /* case SPIDER_NET_GDBRSERINT: problem, print a message */
1405         /* case SPIDER_NET_GDARSERINT: problem, print a message */
1406         /* case SPIDER_NET_GDSERINT: problem, print a message */
1407         /* case SPIDER_NET_GDTPTERINT: problem, print a message */
1408         /* case SPIDER_NET_GDDPTERINT: problem, print a message */
1409         /* case SPIDER_NET_GDCPTERINT: problem, print a message */
1410         /* case SPIDER_NET_GDBPTERINT: problem, print a message */
1411         /* case SPIDER_NET_GDAPTERINT: problem, print a message */
1412         default:
1413                 show_error = 1;
1414                 break;
1415         }
1416
1417         /* check GHIINT2STS ************************************/
1418         if (error_reg2)
1419                 for (i = 0; i < 32; i++)
1420                         if (error_reg2 & (1<<i))
1421                                 switch (i)
1422         {
1423         /* there is nothing we can (want  to) do at this time. Log a
1424          * message, we can switch on and off the specific values later on
1425         case SPIDER_NET_GPROPERINT:
1426         case SPIDER_NET_GMCTCRSNGINT:
1427         case SPIDER_NET_GMCTLCOLINT:
1428         case SPIDER_NET_GMCTTMOTINT:
1429         case SPIDER_NET_GMCRCAERINT:
1430         case SPIDER_NET_GMCRCALERINT:
1431         case SPIDER_NET_GMCRALNERINT:
1432         case SPIDER_NET_GMCROVRINT:
1433         case SPIDER_NET_GMCRRNTINT:
1434         case SPIDER_NET_GMCRRXERINT:
1435         case SPIDER_NET_GTITCSERINT:
1436         case SPIDER_NET_GTIFMTERINT:
1437         case SPIDER_NET_GTIPKTRVKINT:
1438         case SPIDER_NET_GTISPINGINT:
1439         case SPIDER_NET_GTISADNGINT:
1440         case SPIDER_NET_GTISPDNGINT:
1441         case SPIDER_NET_GRIFMTERINT:
1442         case SPIDER_NET_GRIPKTRVKINT:
1443         case SPIDER_NET_GRISPINGINT:
1444         case SPIDER_NET_GRISADNGINT:
1445         case SPIDER_NET_GRISPDNGINT:
1446                 break;
1447         */
1448                 default:
1449                         break;
1450         }
1451
1452         if ((show_error) && (netif_msg_intr(card)) && net_ratelimit())
1453                 pr_err("Got error interrupt on %s, GHIINT0STS = 0x%08x, "
1454                        "GHIINT1STS = 0x%08x, GHIINT2STS = 0x%08x\n",
1455                        card->netdev->name,
1456                        status_reg, error_reg1, error_reg2);
1457
1458         /* clear interrupt sources */
1459         spider_net_write_reg(card, SPIDER_NET_GHIINT1STS, error_reg1);
1460         spider_net_write_reg(card, SPIDER_NET_GHIINT2STS, error_reg2);
1461 }
1462
1463 /**
1464  * spider_net_interrupt - interrupt handler for spider_net
1465  * @irq: interupt number
1466  * @ptr: pointer to net_device
1467  * @regs: PU registers
1468  *
1469  * returns IRQ_HANDLED, if interrupt was for driver, or IRQ_NONE, if no
1470  * interrupt found raised by card.
1471  *
1472  * This is the interrupt handler, that turns off
1473  * interrupts for this device and makes the stack poll the driver
1474  */
1475 static irqreturn_t
1476 spider_net_interrupt(int irq, void *ptr)
1477 {
1478         struct net_device *netdev = ptr;
1479         struct spider_net_card *card = netdev_priv(netdev);
1480         u32 status_reg;
1481
1482         status_reg = spider_net_read_reg(card, SPIDER_NET_GHIINT0STS);
1483
1484         if (!status_reg)
1485                 return IRQ_NONE;
1486
1487         if (status_reg & SPIDER_NET_RXINT ) {
1488                 spider_net_rx_irq_off(card);
1489                 netif_rx_schedule(netdev);
1490         }
1491         if (status_reg & SPIDER_NET_TXINT)
1492                 netif_rx_schedule(netdev);
1493
1494         if (status_reg & SPIDER_NET_ERRINT )
1495                 spider_net_handle_error_irq(card, status_reg);
1496
1497         /* clear interrupt sources */
1498         spider_net_write_reg(card, SPIDER_NET_GHIINT0STS, status_reg);
1499
1500         return IRQ_HANDLED;
1501 }
1502
1503 #ifdef CONFIG_NET_POLL_CONTROLLER
1504 /**
1505  * spider_net_poll_controller - artificial interrupt for netconsole etc.
1506  * @netdev: interface device structure
1507  *
1508  * see Documentation/networking/netconsole.txt
1509  */
1510 static void
1511 spider_net_poll_controller(struct net_device *netdev)
1512 {
1513         disable_irq(netdev->irq);
1514         spider_net_interrupt(netdev->irq, netdev);
1515         enable_irq(netdev->irq);
1516 }
1517 #endif /* CONFIG_NET_POLL_CONTROLLER */
1518
1519 /**
1520  * spider_net_init_card - initializes the card
1521  * @card: card structure
1522  *
1523  * spider_net_init_card initializes the card so that other registers can
1524  * be used
1525  */
1526 static void
1527 spider_net_init_card(struct spider_net_card *card)
1528 {
1529         spider_net_write_reg(card, SPIDER_NET_CKRCTRL,
1530                              SPIDER_NET_CKRCTRL_STOP_VALUE);
1531
1532         spider_net_write_reg(card, SPIDER_NET_CKRCTRL,
1533                              SPIDER_NET_CKRCTRL_RUN_VALUE);
1534 }
1535
1536 /**
1537  * spider_net_enable_card - enables the card by setting all kinds of regs
1538  * @card: card structure
1539  *
1540  * spider_net_enable_card sets a lot of SMMIO registers to enable the device
1541  */
1542 static void
1543 spider_net_enable_card(struct spider_net_card *card)
1544 {
1545         int i;
1546         /* the following array consists of (register),(value) pairs
1547          * that are set in this function. A register of 0 ends the list */
1548         u32 regs[][2] = {
1549                 { SPIDER_NET_GRESUMINTNUM, 0 },
1550                 { SPIDER_NET_GREINTNUM, 0 },
1551
1552                 /* set interrupt frame number registers */
1553                 /* clear the single DMA engine registers first */
1554                 { SPIDER_NET_GFAFRMNUM, SPIDER_NET_GFXFRAMES_VALUE },
1555                 { SPIDER_NET_GFBFRMNUM, SPIDER_NET_GFXFRAMES_VALUE },
1556                 { SPIDER_NET_GFCFRMNUM, SPIDER_NET_GFXFRAMES_VALUE },
1557                 { SPIDER_NET_GFDFRMNUM, SPIDER_NET_GFXFRAMES_VALUE },
1558                 /* then set, what we really need */
1559                 { SPIDER_NET_GFFRMNUM, SPIDER_NET_FRAMENUM_VALUE },
1560
1561                 /* timer counter registers and stuff */
1562                 { SPIDER_NET_GFREECNNUM, 0 },
1563                 { SPIDER_NET_GONETIMENUM, 0 },
1564                 { SPIDER_NET_GTOUTFRMNUM, 0 },
1565
1566                 /* RX mode setting */
1567                 { SPIDER_NET_GRXMDSET, SPIDER_NET_RXMODE_VALUE },
1568                 /* TX mode setting */
1569                 { SPIDER_NET_GTXMDSET, SPIDER_NET_TXMODE_VALUE },
1570                 /* IPSEC mode setting */
1571                 { SPIDER_NET_GIPSECINIT, SPIDER_NET_IPSECINIT_VALUE },
1572
1573                 { SPIDER_NET_GFTRESTRT, SPIDER_NET_RESTART_VALUE },
1574
1575                 { SPIDER_NET_GMRWOLCTRL, 0 },
1576                 { SPIDER_NET_GTESTMD, 0x10000000 },
1577                 { SPIDER_NET_GTTQMSK, 0x00400040 },
1578
1579                 { SPIDER_NET_GMACINTEN, 0 },
1580
1581                 /* flow control stuff */
1582                 { SPIDER_NET_GMACAPAUSE, SPIDER_NET_MACAPAUSE_VALUE },
1583                 { SPIDER_NET_GMACTXPAUSE, SPIDER_NET_TXPAUSE_VALUE },
1584
1585                 { SPIDER_NET_GMACBSTLMT, SPIDER_NET_BURSTLMT_VALUE },
1586                 { 0, 0}
1587         };
1588
1589         i = 0;
1590         while (regs[i][0]) {
1591                 spider_net_write_reg(card, regs[i][0], regs[i][1]);
1592                 i++;
1593         }
1594
1595         /* clear unicast filter table entries 1 to 14 */
1596         for (i = 1; i <= 14; i++) {
1597                 spider_net_write_reg(card,
1598                                      SPIDER_NET_GMRUAFILnR + i * 8,
1599                                      0x00080000);
1600                 spider_net_write_reg(card,
1601                                      SPIDER_NET_GMRUAFILnR + i * 8 + 4,
1602                                      0x00000000);
1603         }
1604
1605         spider_net_write_reg(card, SPIDER_NET_GMRUA0FIL15R, 0x08080000);
1606
1607         spider_net_write_reg(card, SPIDER_NET_ECMODE, SPIDER_NET_ECMODE_VALUE);
1608
1609         /* set chain tail adress for RX chains and
1610          * enable DMA */
1611         spider_net_enable_rxchtails(card);
1612         spider_net_enable_rxdmac(card);
1613
1614         spider_net_write_reg(card, SPIDER_NET_GRXDMAEN, SPIDER_NET_WOL_VALUE);
1615
1616         spider_net_write_reg(card, SPIDER_NET_GMACLENLMT,
1617                              SPIDER_NET_LENLMT_VALUE);
1618         spider_net_write_reg(card, SPIDER_NET_GMACMODE,
1619                              SPIDER_NET_MACMODE_VALUE);
1620         spider_net_write_reg(card, SPIDER_NET_GMACOPEMD,
1621                              SPIDER_NET_OPMODE_VALUE);
1622
1623         /* set interrupt mask registers */
1624         spider_net_write_reg(card, SPIDER_NET_GHIINT0MSK,
1625                              SPIDER_NET_INT0_MASK_VALUE);
1626         spider_net_write_reg(card, SPIDER_NET_GHIINT1MSK,
1627                              SPIDER_NET_INT1_MASK_VALUE);
1628         spider_net_write_reg(card, SPIDER_NET_GHIINT2MSK,
1629                              SPIDER_NET_INT2_MASK_VALUE);
1630
1631         spider_net_write_reg(card, SPIDER_NET_GDTDMACCNTR,
1632                              SPIDER_NET_GDTBSTA);
1633 }
1634
1635 /**
1636  * spider_net_open - called upon ifonfig up
1637  * @netdev: interface device structure
1638  *
1639  * returns 0 on success, <0 on failure
1640  *
1641  * spider_net_open allocates all the descriptors and memory needed for
1642  * operation, sets up multicast list and enables interrupts
1643  */
1644 int
1645 spider_net_open(struct net_device *netdev)
1646 {
1647         struct spider_net_card *card = netdev_priv(netdev);
1648         struct spider_net_descr *descr;
1649         int result;
1650
1651         result = spider_net_init_chain(card, &card->tx_chain);
1652         if (result)
1653                 goto alloc_tx_failed;
1654         card->low_watermark = NULL;
1655
1656         result = spider_net_init_chain(card, &card->rx_chain);
1657         if (result)
1658                 goto alloc_rx_failed;
1659
1660         /* Make a ring of of bus addresses */
1661         descr = card->rx_chain.ring;
1662         do {
1663                 descr->next_descr_addr = descr->next->bus_addr;
1664                 descr = descr->next;
1665         } while (descr != card->rx_chain.ring);
1666
1667         /* Allocate rx skbs */
1668         if (spider_net_alloc_rx_skbs(card))
1669                 goto alloc_skbs_failed;
1670
1671         spider_net_set_multi(netdev);
1672
1673         /* further enhancement: setup hw vlan, if needed */
1674
1675         result = -EBUSY;
1676         if (request_irq(netdev->irq, spider_net_interrupt,
1677                              IRQF_SHARED, netdev->name, netdev))
1678                 goto register_int_failed;
1679
1680         spider_net_enable_card(card);
1681
1682         netif_start_queue(netdev);
1683         netif_carrier_on(netdev);
1684         netif_poll_enable(netdev);
1685
1686         return 0;
1687
1688 register_int_failed:
1689         spider_net_free_rx_chain_contents(card);
1690 alloc_skbs_failed:
1691         spider_net_free_chain(card, &card->rx_chain);
1692 alloc_rx_failed:
1693         spider_net_free_chain(card, &card->tx_chain);
1694 alloc_tx_failed:
1695         return result;
1696 }
1697
1698 /**
1699  * spider_net_setup_phy - setup PHY
1700  * @card: card structure
1701  *
1702  * returns 0 on success, <0 on failure
1703  *
1704  * spider_net_setup_phy is used as part of spider_net_probe. Sets
1705  * the PHY to 1000 Mbps
1706  **/
1707 static int
1708 spider_net_setup_phy(struct spider_net_card *card)
1709 {
1710         struct mii_phy *phy = &card->phy;
1711
1712         spider_net_write_reg(card, SPIDER_NET_GDTDMASEL,
1713                              SPIDER_NET_DMASEL_VALUE);
1714         spider_net_write_reg(card, SPIDER_NET_GPCCTRL,
1715                              SPIDER_NET_PHY_CTRL_VALUE);
1716         phy->mii_id = 1;
1717         phy->dev = card->netdev;
1718         phy->mdio_read = spider_net_read_phy;
1719         phy->mdio_write = spider_net_write_phy;
1720
1721         mii_phy_probe(phy, phy->mii_id);
1722
1723         if (phy->def->ops->setup_forced)
1724                 phy->def->ops->setup_forced(phy, SPEED_1000, DUPLEX_FULL);
1725
1726         phy->def->ops->enable_fiber(phy);
1727
1728         phy->def->ops->read_link(phy);
1729         pr_info("Found %s with %i Mbps, %s-duplex.\n", phy->def->name,
1730                 phy->speed, phy->duplex==1 ? "Full" : "Half");
1731
1732         return 0;
1733 }
1734
1735 /**
1736  * spider_net_download_firmware - loads firmware into the adapter
1737  * @card: card structure
1738  * @firmware_ptr: pointer to firmware data
1739  *
1740  * spider_net_download_firmware loads the firmware data into the
1741  * adapter. It assumes the length etc. to be allright.
1742  */
1743 static int
1744 spider_net_download_firmware(struct spider_net_card *card,
1745                              const void *firmware_ptr)
1746 {
1747         int sequencer, i;
1748         const u32 *fw_ptr = firmware_ptr;
1749
1750         /* stop sequencers */
1751         spider_net_write_reg(card, SPIDER_NET_GSINIT,
1752                              SPIDER_NET_STOP_SEQ_VALUE);
1753
1754         for (sequencer = 0; sequencer < SPIDER_NET_FIRMWARE_SEQS;
1755              sequencer++) {
1756                 spider_net_write_reg(card,
1757                                      SPIDER_NET_GSnPRGADR + sequencer * 8, 0);
1758                 for (i = 0; i < SPIDER_NET_FIRMWARE_SEQWORDS; i++) {
1759                         spider_net_write_reg(card, SPIDER_NET_GSnPRGDAT +
1760                                              sequencer * 8, *fw_ptr);
1761                         fw_ptr++;
1762                 }
1763         }
1764
1765         if (spider_net_read_reg(card, SPIDER_NET_GSINIT))
1766                 return -EIO;
1767
1768         spider_net_write_reg(card, SPIDER_NET_GSINIT,
1769                              SPIDER_NET_RUN_SEQ_VALUE);
1770
1771         return 0;
1772 }
1773
1774 /**
1775  * spider_net_init_firmware - reads in firmware parts
1776  * @card: card structure
1777  *
1778  * Returns 0 on success, <0 on failure
1779  *
1780  * spider_net_init_firmware opens the sequencer firmware and does some basic
1781  * checks. This function opens and releases the firmware structure. A call
1782  * to download the firmware is performed before the release.
1783  *
1784  * Firmware format
1785  * ===============
1786  * spider_fw.bin is expected to be a file containing 6*1024*4 bytes, 4k being
1787  * the program for each sequencer. Use the command
1788  *    tail -q -n +2 Seq_code1_0x088.txt Seq_code2_0x090.txt              \
1789  *         Seq_code3_0x098.txt Seq_code4_0x0A0.txt Seq_code5_0x0A8.txt   \
1790  *         Seq_code6_0x0B0.txt | xxd -r -p -c4 > spider_fw.bin
1791  *
1792  * to generate spider_fw.bin, if you have sequencer programs with something
1793  * like the following contents for each sequencer:
1794  *    <ONE LINE COMMENT>
1795  *    <FIRST 4-BYTES-WORD FOR SEQUENCER>
1796  *    <SECOND 4-BYTES-WORD FOR SEQUENCER>
1797  *     ...
1798  *    <1024th 4-BYTES-WORD FOR SEQUENCER>
1799  */
1800 static int
1801 spider_net_init_firmware(struct spider_net_card *card)
1802 {
1803         struct firmware *firmware = NULL;
1804         struct device_node *dn;
1805         const u8 *fw_prop = NULL;
1806         int err = -ENOENT;
1807         int fw_size;
1808
1809         if (request_firmware((const struct firmware **)&firmware,
1810                              SPIDER_NET_FIRMWARE_NAME, &card->pdev->dev) == 0) {
1811                 if ( (firmware->size != SPIDER_NET_FIRMWARE_LEN) &&
1812                      netif_msg_probe(card) ) {
1813                         pr_err("Incorrect size of spidernet firmware in " \
1814                                "filesystem. Looking in host firmware...\n");
1815                         goto try_host_fw;
1816                 }
1817                 err = spider_net_download_firmware(card, firmware->data);
1818
1819                 release_firmware(firmware);
1820                 if (err)
1821                         goto try_host_fw;
1822
1823                 goto done;
1824         }
1825
1826 try_host_fw:
1827         dn = pci_device_to_OF_node(card->pdev);
1828         if (!dn)
1829                 goto out_err;
1830
1831         fw_prop = get_property(dn, "firmware", &fw_size);
1832         if (!fw_prop)
1833                 goto out_err;
1834
1835         if ( (fw_size != SPIDER_NET_FIRMWARE_LEN) &&
1836              netif_msg_probe(card) ) {
1837                 pr_err("Incorrect size of spidernet firmware in " \
1838                        "host firmware\n");
1839                 goto done;
1840         }
1841
1842         err = spider_net_download_firmware(card, fw_prop);
1843
1844 done:
1845         return err;
1846 out_err:
1847         if (netif_msg_probe(card))
1848                 pr_err("Couldn't find spidernet firmware in filesystem " \
1849                        "or host firmware\n");
1850         return err;
1851 }
1852
1853 /**
1854  * spider_net_workaround_rxramfull - work around firmware bug
1855  * @card: card structure
1856  *
1857  * no return value
1858  **/
1859 static void
1860 spider_net_workaround_rxramfull(struct spider_net_card *card)
1861 {
1862         int i, sequencer = 0;
1863
1864         /* cancel reset */
1865         spider_net_write_reg(card, SPIDER_NET_CKRCTRL,
1866                              SPIDER_NET_CKRCTRL_RUN_VALUE);
1867
1868         /* empty sequencer data */
1869         for (sequencer = 0; sequencer < SPIDER_NET_FIRMWARE_SEQS;
1870              sequencer++) {
1871                 spider_net_write_reg(card, SPIDER_NET_GSnPRGADR +
1872                                      sequencer * 8, 0x0);
1873                 for (i = 0; i < SPIDER_NET_FIRMWARE_SEQWORDS; i++) {
1874                         spider_net_write_reg(card, SPIDER_NET_GSnPRGDAT +
1875                                              sequencer * 8, 0x0);
1876                 }
1877         }
1878
1879         /* set sequencer operation */
1880         spider_net_write_reg(card, SPIDER_NET_GSINIT, 0x000000fe);
1881
1882         /* reset */
1883         spider_net_write_reg(card, SPIDER_NET_CKRCTRL,
1884                              SPIDER_NET_CKRCTRL_STOP_VALUE);
1885 }
1886
1887 /**
1888  * spider_net_stop - called upon ifconfig down
1889  * @netdev: interface device structure
1890  *
1891  * always returns 0
1892  */
1893 int
1894 spider_net_stop(struct net_device *netdev)
1895 {
1896         struct spider_net_card *card = netdev_priv(netdev);
1897
1898         tasklet_kill(&card->rxram_full_tl);
1899         netif_poll_disable(netdev);
1900         netif_carrier_off(netdev);
1901         netif_stop_queue(netdev);
1902         del_timer_sync(&card->tx_timer);
1903
1904         /* disable/mask all interrupts */
1905         spider_net_write_reg(card, SPIDER_NET_GHIINT0MSK, 0);
1906         spider_net_write_reg(card, SPIDER_NET_GHIINT1MSK, 0);
1907         spider_net_write_reg(card, SPIDER_NET_GHIINT2MSK, 0);
1908
1909         /* free_irq(netdev->irq, netdev);*/
1910         free_irq(to_pci_dev(netdev->class_dev.dev)->irq, netdev);
1911
1912         spider_net_write_reg(card, SPIDER_NET_GDTDMACCNTR,
1913                              SPIDER_NET_DMA_TX_FEND_VALUE);
1914
1915         /* turn off DMA, force end */
1916         spider_net_disable_rxdmac(card);
1917
1918         /* release chains */
1919         spider_net_release_tx_chain(card, 1);
1920         spider_net_free_rx_chain_contents(card);
1921
1922         spider_net_free_rx_chain_contents(card);
1923
1924         spider_net_free_chain(card, &card->tx_chain);
1925         spider_net_free_chain(card, &card->rx_chain);
1926
1927         return 0;
1928 }
1929
1930 /**
1931  * spider_net_tx_timeout_task - task scheduled by the watchdog timeout
1932  * function (to be called not under interrupt status)
1933  * @data: data, is interface device structure
1934  *
1935  * called as task when tx hangs, resets interface (if interface is up)
1936  */
1937 static void
1938 spider_net_tx_timeout_task(struct work_struct *work)
1939 {
1940         struct spider_net_card *card =
1941                 container_of(work, struct spider_net_card, tx_timeout_task);
1942         struct net_device *netdev = card->netdev;
1943
1944         if (!(netdev->flags & IFF_UP))
1945                 goto out;
1946
1947         netif_device_detach(netdev);
1948         spider_net_stop(netdev);
1949
1950         spider_net_workaround_rxramfull(card);
1951         spider_net_init_card(card);
1952
1953         if (spider_net_setup_phy(card))
1954                 goto out;
1955         if (spider_net_init_firmware(card))
1956                 goto out;
1957
1958         spider_net_open(netdev);
1959         spider_net_kick_tx_dma(card);
1960         netif_device_attach(netdev);
1961
1962 out:
1963         atomic_dec(&card->tx_timeout_task_counter);
1964 }
1965
1966 /**
1967  * spider_net_tx_timeout - called when the tx timeout watchdog kicks in.
1968  * @netdev: interface device structure
1969  *
1970  * called, if tx hangs. Schedules a task that resets the interface
1971  */
1972 static void
1973 spider_net_tx_timeout(struct net_device *netdev)
1974 {
1975         struct spider_net_card *card;
1976
1977         card = netdev_priv(netdev);
1978         atomic_inc(&card->tx_timeout_task_counter);
1979         if (netdev->flags & IFF_UP)
1980                 schedule_work(&card->tx_timeout_task);
1981         else
1982                 atomic_dec(&card->tx_timeout_task_counter);
1983         card->spider_stats.tx_timeouts++;
1984 }
1985
1986 /**
1987  * spider_net_setup_netdev_ops - initialization of net_device operations
1988  * @netdev: net_device structure
1989  *
1990  * fills out function pointers in the net_device structure
1991  */
1992 static void
1993 spider_net_setup_netdev_ops(struct net_device *netdev)
1994 {
1995         netdev->open = &spider_net_open;
1996         netdev->stop = &spider_net_stop;
1997         netdev->hard_start_xmit = &spider_net_xmit;
1998         netdev->get_stats = &spider_net_get_stats;
1999         netdev->set_multicast_list = &spider_net_set_multi;
2000         netdev->set_mac_address = &spider_net_set_mac;
2001         netdev->change_mtu = &spider_net_change_mtu;
2002         netdev->do_ioctl = &spider_net_do_ioctl;
2003         /* tx watchdog */
2004         netdev->tx_timeout = &spider_net_tx_timeout;
2005         netdev->watchdog_timeo = SPIDER_NET_WATCHDOG_TIMEOUT;
2006         /* NAPI */
2007         netdev->poll = &spider_net_poll;
2008         netdev->weight = SPIDER_NET_NAPI_WEIGHT;
2009         /* HW VLAN */
2010         netdev->vlan_rx_register = &spider_net_vlan_rx_reg;
2011         netdev->vlan_rx_add_vid = &spider_net_vlan_rx_add;
2012         netdev->vlan_rx_kill_vid = &spider_net_vlan_rx_kill;
2013 #ifdef CONFIG_NET_POLL_CONTROLLER
2014         /* poll controller */
2015         netdev->poll_controller = &spider_net_poll_controller;
2016 #endif /* CONFIG_NET_POLL_CONTROLLER */
2017         /* ethtool ops */
2018         netdev->ethtool_ops = &spider_net_ethtool_ops;
2019 }
2020
2021 /**
2022  * spider_net_setup_netdev - initialization of net_device
2023  * @card: card structure
2024  *
2025  * Returns 0 on success or <0 on failure
2026  *
2027  * spider_net_setup_netdev initializes the net_device structure
2028  **/
2029 static int
2030 spider_net_setup_netdev(struct spider_net_card *card)
2031 {
2032         int result;
2033         struct net_device *netdev = card->netdev;
2034         struct device_node *dn;
2035         struct sockaddr addr;
2036         const u8 *mac;
2037
2038         SET_MODULE_OWNER(netdev);
2039         SET_NETDEV_DEV(netdev, &card->pdev->dev);
2040
2041         pci_set_drvdata(card->pdev, netdev);
2042
2043         card->rxram_full_tl.data = (unsigned long) card;
2044         card->rxram_full_tl.func =
2045                 (void (*)(unsigned long)) spider_net_handle_rxram_full;
2046         init_timer(&card->tx_timer);
2047         card->tx_timer.function =
2048                 (void (*)(unsigned long)) spider_net_cleanup_tx_ring;
2049         card->tx_timer.data = (unsigned long) card;
2050         netdev->irq = card->pdev->irq;
2051
2052         card->options.rx_csum = SPIDER_NET_RX_CSUM_DEFAULT;
2053
2054         card->tx_chain.num_desc = tx_descriptors;
2055         card->rx_chain.num_desc = rx_descriptors;
2056
2057         spider_net_setup_netdev_ops(netdev);
2058
2059         netdev->features = NETIF_F_HW_CSUM | NETIF_F_LLTX;
2060         /* some time: NETIF_F_HW_VLAN_TX | NETIF_F_HW_VLAN_RX |
2061          *              NETIF_F_HW_VLAN_FILTER */
2062
2063         netdev->irq = card->pdev->irq;
2064
2065         dn = pci_device_to_OF_node(card->pdev);
2066         if (!dn)
2067                 return -EIO;
2068
2069         mac = get_property(dn, "local-mac-address", NULL);
2070         if (!mac)
2071                 return -EIO;
2072         memcpy(addr.sa_data, mac, ETH_ALEN);
2073
2074         result = spider_net_set_mac(netdev, &addr);
2075         if ((result) && (netif_msg_probe(card)))
2076                 pr_err("Failed to set MAC address: %i\n", result);
2077
2078         result = register_netdev(netdev);
2079         if (result) {
2080                 if (netif_msg_probe(card))
2081                         pr_err("Couldn't register net_device: %i\n",
2082                                   result);
2083                 return result;
2084         }
2085
2086         if (netif_msg_probe(card))
2087                 pr_info("Initialized device %s.\n", netdev->name);
2088
2089         return 0;
2090 }
2091
2092 /**
2093  * spider_net_alloc_card - allocates net_device and card structure
2094  *
2095  * returns the card structure or NULL in case of errors
2096  *
2097  * the card and net_device structures are linked to each other
2098  */
2099 static struct spider_net_card *
2100 spider_net_alloc_card(void)
2101 {
2102         struct net_device *netdev;
2103         struct spider_net_card *card;
2104
2105         netdev = alloc_etherdev(sizeof(struct spider_net_card));
2106         if (!netdev)
2107                 return NULL;
2108
2109         card = netdev_priv(netdev);
2110         card->netdev = netdev;
2111         card->msg_enable = SPIDER_NET_DEFAULT_MSG;
2112         INIT_WORK(&card->tx_timeout_task, spider_net_tx_timeout_task);
2113         init_waitqueue_head(&card->waitq);
2114         atomic_set(&card->tx_timeout_task_counter, 0);
2115
2116         return card;
2117 }
2118
2119 /**
2120  * spider_net_undo_pci_setup - releases PCI ressources
2121  * @card: card structure
2122  *
2123  * spider_net_undo_pci_setup releases the mapped regions
2124  */
2125 static void
2126 spider_net_undo_pci_setup(struct spider_net_card *card)
2127 {
2128         iounmap(card->regs);
2129         pci_release_regions(card->pdev);
2130 }
2131
2132 /**
2133  * spider_net_setup_pci_dev - sets up the device in terms of PCI operations
2134  * @card: card structure
2135  * @pdev: PCI device
2136  *
2137  * Returns the card structure or NULL if any errors occur
2138  *
2139  * spider_net_setup_pci_dev initializes pdev and together with the
2140  * functions called in spider_net_open configures the device so that
2141  * data can be transferred over it
2142  * The net_device structure is attached to the card structure, if the
2143  * function returns without error.
2144  **/
2145 static struct spider_net_card *
2146 spider_net_setup_pci_dev(struct pci_dev *pdev)
2147 {
2148         struct spider_net_card *card;
2149         unsigned long mmio_start, mmio_len;
2150
2151         if (pci_enable_device(pdev)) {
2152                 pr_err("Couldn't enable PCI device\n");
2153                 return NULL;
2154         }
2155
2156         if (!(pci_resource_flags(pdev, 0) & IORESOURCE_MEM)) {
2157                 pr_err("Couldn't find proper PCI device base address.\n");
2158                 goto out_disable_dev;
2159         }
2160
2161         if (pci_request_regions(pdev, spider_net_driver_name)) {
2162                 pr_err("Couldn't obtain PCI resources, aborting.\n");
2163                 goto out_disable_dev;
2164         }
2165
2166         pci_set_master(pdev);
2167
2168         card = spider_net_alloc_card();
2169         if (!card) {
2170                 pr_err("Couldn't allocate net_device structure, "
2171                           "aborting.\n");
2172                 goto out_release_regions;
2173         }
2174         card->pdev = pdev;
2175
2176         /* fetch base address and length of first resource */
2177         mmio_start = pci_resource_start(pdev, 0);
2178         mmio_len = pci_resource_len(pdev, 0);
2179
2180         card->netdev->mem_start = mmio_start;
2181         card->netdev->mem_end = mmio_start + mmio_len;
2182         card->regs = ioremap(mmio_start, mmio_len);
2183
2184         if (!card->regs) {
2185                 pr_err("Couldn't obtain PCI resources, aborting.\n");
2186                 goto out_release_regions;
2187         }
2188
2189         return card;
2190
2191 out_release_regions:
2192         pci_release_regions(pdev);
2193 out_disable_dev:
2194         pci_disable_device(pdev);
2195         pci_set_drvdata(pdev, NULL);
2196         return NULL;
2197 }
2198
2199 /**
2200  * spider_net_probe - initialization of a device
2201  * @pdev: PCI device
2202  * @ent: entry in the device id list
2203  *
2204  * Returns 0 on success, <0 on failure
2205  *
2206  * spider_net_probe initializes pdev and registers a net_device
2207  * structure for it. After that, the device can be ifconfig'ed up
2208  **/
2209 static int __devinit
2210 spider_net_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
2211 {
2212         int err = -EIO;
2213         struct spider_net_card *card;
2214
2215         card = spider_net_setup_pci_dev(pdev);
2216         if (!card)
2217                 goto out;
2218
2219         spider_net_workaround_rxramfull(card);
2220         spider_net_init_card(card);
2221
2222         err = spider_net_setup_phy(card);
2223         if (err)
2224                 goto out_undo_pci;
2225
2226         err = spider_net_init_firmware(card);
2227         if (err)
2228                 goto out_undo_pci;
2229
2230         err = spider_net_setup_netdev(card);
2231         if (err)
2232                 goto out_undo_pci;
2233
2234         return 0;
2235
2236 out_undo_pci:
2237         spider_net_undo_pci_setup(card);
2238         free_netdev(card->netdev);
2239 out:
2240         return err;
2241 }
2242
2243 /**
2244  * spider_net_remove - removal of a device
2245  * @pdev: PCI device
2246  *
2247  * Returns 0 on success, <0 on failure
2248  *
2249  * spider_net_remove is called to remove the device and unregisters the
2250  * net_device
2251  **/
2252 static void __devexit
2253 spider_net_remove(struct pci_dev *pdev)
2254 {
2255         struct net_device *netdev;
2256         struct spider_net_card *card;
2257
2258         netdev = pci_get_drvdata(pdev);
2259         card = netdev_priv(netdev);
2260
2261         wait_event(card->waitq,
2262                    atomic_read(&card->tx_timeout_task_counter) == 0);
2263
2264         unregister_netdev(netdev);
2265
2266         /* switch off card */
2267         spider_net_write_reg(card, SPIDER_NET_CKRCTRL,
2268                              SPIDER_NET_CKRCTRL_STOP_VALUE);
2269         spider_net_write_reg(card, SPIDER_NET_CKRCTRL,
2270                              SPIDER_NET_CKRCTRL_RUN_VALUE);
2271
2272         spider_net_undo_pci_setup(card);
2273         free_netdev(netdev);
2274 }
2275
2276 static struct pci_driver spider_net_driver = {
2277         .name           = spider_net_driver_name,
2278         .id_table       = spider_net_pci_tbl,
2279         .probe          = spider_net_probe,
2280         .remove         = __devexit_p(spider_net_remove)
2281 };
2282
2283 /**
2284  * spider_net_init - init function when the driver is loaded
2285  *
2286  * spider_net_init registers the device driver
2287  */
2288 static int __init spider_net_init(void)
2289 {
2290         printk(KERN_INFO "Spidernet version %s.\n", VERSION);
2291
2292         if (rx_descriptors < SPIDER_NET_RX_DESCRIPTORS_MIN) {
2293                 rx_descriptors = SPIDER_NET_RX_DESCRIPTORS_MIN;
2294                 pr_info("adjusting rx descriptors to %i.\n", rx_descriptors);
2295         }
2296         if (rx_descriptors > SPIDER_NET_RX_DESCRIPTORS_MAX) {
2297                 rx_descriptors = SPIDER_NET_RX_DESCRIPTORS_MAX;
2298                 pr_info("adjusting rx descriptors to %i.\n", rx_descriptors);
2299         }
2300         if (tx_descriptors < SPIDER_NET_TX_DESCRIPTORS_MIN) {
2301                 tx_descriptors = SPIDER_NET_TX_DESCRIPTORS_MIN;
2302                 pr_info("adjusting tx descriptors to %i.\n", tx_descriptors);
2303         }
2304         if (tx_descriptors > SPIDER_NET_TX_DESCRIPTORS_MAX) {
2305                 tx_descriptors = SPIDER_NET_TX_DESCRIPTORS_MAX;
2306                 pr_info("adjusting tx descriptors to %i.\n", tx_descriptors);
2307         }
2308
2309         return pci_register_driver(&spider_net_driver);
2310 }
2311
2312 /**
2313  * spider_net_cleanup - exit function when driver is unloaded
2314  *
2315  * spider_net_cleanup unregisters the device driver
2316  */
2317 static void __exit spider_net_cleanup(void)
2318 {
2319         pci_unregister_driver(&spider_net_driver);
2320 }
2321
2322 module_init(spider_net_init);
2323 module_exit(spider_net_cleanup);