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