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
 652         buf = pci_map_single(card->pdev, skb->data, skb->len, PCI_DMA_TODEVICE);
 653         if (pci_dma_mapping_error(buf)) {
 654                 if (netif_msg_tx_err(card) && net_ratelimit())
 655                         pr_err("could not iommu-map packet (%p, %i). "
 656                                   "Dropping packet\n", skb->data, skb->len);
 657                 card->spider_stats.tx_iommu_map_error++;
 658                 return -ENOMEM;
 659         }
 660
 661         descr->buf_addr = buf;
 662         descr->buf_size = skb->len;
 663         descr->next_descr_addr = 0;
 664         descr->skb = skb;
 665         descr->data_status = 0;
 666
 667         descr->dmac_cmd_status =
 668                         SPIDER_NET_DESCR_CARDOWNED | SPIDER_NET_DMAC_NOCS;
 669         if (skb->protocol == htons(ETH_P_IP))
 670                 switch (skb->nh.iph->protocol) {
 671                 case IPPROTO_TCP:
 672                         descr->dmac_cmd_status |= SPIDER_NET_DMAC_TCP;
 673                         break;
 674                 case IPPROTO_UDP:
 675                         descr->dmac_cmd_status |= SPIDER_NET_DMAC_UDP;
 676                         break;
 677                 }
 678
 679         descr->prev->next_descr_addr = descr->bus_addr;
 680
 681         return 0;
 682 }
 683
 684 /**
 685  * spider_net_release_tx_descr - processes a used tx descriptor
 686  * @card: card structure
 687  * @descr: descriptor to release
 688  *
 689  * releases a used tx descriptor (unmapping, freeing of skb)
 690  */
 691 static inline void
 692 spider_net_release_tx_descr(struct spider_net_card *card)
 693 {
 694         struct spider_net_descr *descr = card->tx_chain.tail;
 695         struct sk_buff *skb;
 696
 697         card->tx_chain.tail = card->tx_chain.tail->next;
 698         descr->dmac_cmd_status |= SPIDER_NET_DESCR_NOT_IN_USE;
 699
 700         /* unmap the skb */
 701         skb = descr->skb;
 702         if (!skb)
 703                 return;
 704         pci_unmap_single(card->pdev, descr->buf_addr, skb->len,
 705                         PCI_DMA_TODEVICE);
 706         dev_kfree_skb_any(skb);
 707 }
 708
 709 /**
 710  * spider_net_release_tx_chain - processes sent tx descriptors
 711  * @card: adapter structure
 712  * @brutal: if set, don't care about whether descriptor seems to be in use
 713  *
 714  * returns 0 if the tx ring is empty, otherwise 1.
 715  *
 716  * spider_net_release_tx_chain releases the tx descriptors that spider has
 717  * finished with (if non-brutal) or simply release tx descriptors (if brutal).
 718  * If some other context is calling this function, we return 1 so that we're
 719  * scheduled again (if we were scheduled) and will not loose initiative.
 720  */
 721 static int
 722 spider_net_release_tx_chain(struct spider_net_card *card, int brutal)
 723 {
 724         struct spider_net_descr_chain *chain = &card->tx_chain;
 725         int status;
 726
 727         spider_net_read_reg(card, SPIDER_NET_GDTDMACCNTR);
 728
 729         while (chain->tail != chain->head) {
 730                 status = spider_net_get_descr_status(chain->tail);
 731                 switch (status) {
 732                 case SPIDER_NET_DESCR_COMPLETE:
 733                         card->netdev_stats.tx_packets++;
 734                         card->netdev_stats.tx_bytes += chain->tail->skb->len;
 735                         break;
 736
 737                 case SPIDER_NET_DESCR_CARDOWNED:
 738                         if (!brutal)
 739                                 return 1;
 740                         /* fallthrough, if we release the descriptors
 741                          * brutally (then we don't care about
 742                          * SPIDER_NET_DESCR_CARDOWNED) */
 743
 744                 case SPIDER_NET_DESCR_RESPONSE_ERROR:
 745                 case SPIDER_NET_DESCR_PROTECTION_ERROR:
 746                 case SPIDER_NET_DESCR_FORCE_END:
 747                         if (netif_msg_tx_err(card))
 748                                 pr_err("%s: forcing end of tx descriptor "
 749                                        "with status x%02x\n",
 750                                        card->netdev->name, status);
 751                         card->netdev_stats.tx_errors++;
 752                         break;
 753
 754                 default:
 755                         card->netdev_stats.tx_dropped++;
 756                         if (!brutal)
 757                                 return 1;
 758                 }
 759                 spider_net_release_tx_descr(card);
 760         }
 761
 762         return 0;
 763 }
 764
 765 /**
 766  * spider_net_kick_tx_dma - enables TX DMA processing
 767  * @card: card structure
 768  * @descr: descriptor address to enable TX processing at
 769  *
 770  * spider_net_kick_tx_dma writes the current tx chain head as start address
 771  * of the tx descriptor chain and enables the transmission DMA engine
 772  */
 773 static inline void
 774 spider_net_kick_tx_dma(struct spider_net_card *card)
 775 {
 776         struct spider_net_descr *descr;
 777
 778         if (spider_net_read_reg(card, SPIDER_NET_GDTDMACCNTR) &
 779                         SPIDER_NET_TX_DMA_EN)
 780                 goto out;
 781
 782         descr = card->tx_chain.tail;
 783         for (;;) {
 784                 if (spider_net_get_descr_status(descr) ==
 785                                 SPIDER_NET_DESCR_CARDOWNED) {
 786                         spider_net_write_reg(card, SPIDER_NET_GDTDCHA,
 787                                         descr->bus_addr);
 788                         spider_net_write_reg(card, SPIDER_NET_GDTDMACCNTR,
 789                                         SPIDER_NET_DMA_TX_VALUE);
 790                         break;
 791                 }
 792                 if (descr == card->tx_chain.head)
 793                         break;
 794                 descr = descr->next;
 795         }
 796
 797 out:
 798         mod_timer(&card->tx_timer, jiffies + SPIDER_NET_TX_TIMER);
 799 }
 800
 801 /**
 802  * spider_net_xmit - transmits a frame over the device
 803  * @skb: packet to send out
 804  * @netdev: interface device structure
 805  *
 806  * returns 0 on success, !0 on failure
 807  */
 808 static int
 809 spider_net_xmit(struct sk_buff *skb, struct net_device *netdev)
 810 {
 811         struct spider_net_card *card = netdev_priv(netdev);
 812         struct spider_net_descr_chain *chain = &card->tx_chain;
 813         struct spider_net_descr *descr = chain->head;
 814         unsigned long flags;
 815         int result;
 816
 817         spin_lock_irqsave(&chain->lock, flags);
 818
 819         spider_net_release_tx_chain(card, 0);
 820
 821         if (chain->head->next == chain->tail->prev) {
 822                 card->netdev_stats.tx_dropped++;
 823                 result = NETDEV_TX_LOCKED;
 824                 goto out;
 825         }
 826
 827         if (spider_net_get_descr_status(descr) != SPIDER_NET_DESCR_NOT_IN_USE) {
 828                 card->netdev_stats.tx_dropped++;
 829                 result = NETDEV_TX_LOCKED;
 830                 goto out;
 831         }
 832
 833         if (spider_net_prepare_tx_descr(card, skb) != 0) {
 834                 card->netdev_stats.tx_dropped++;
 835                 result = NETDEV_TX_BUSY;
 836                 goto out;
 837         }
 838
 839         result = NETDEV_TX_OK;
 840
 841         spider_net_kick_tx_dma(card);
 842         card->tx_chain.head = card->tx_chain.head->next;
 843
 844 out:
 845         spin_unlock_irqrestore(&chain->lock, flags);
 846         netif_wake_queue(netdev);
 847         return result;
 848 }
 849
 850 /**
 851  * spider_net_cleanup_tx_ring - cleans up the TX ring
 852  * @card: card structure
 853  *
 854  * spider_net_cleanup_tx_ring is called by the tx_timer (as we don't use
 855  * interrupts to cleanup our TX ring) and returns sent packets to the stack
 856  * by freeing them
 857  */
 858 static void
 859 spider_net_cleanup_tx_ring(struct spider_net_card *card)
 860 {
 861         unsigned long flags;
 862
 863         spin_lock_irqsave(&card->tx_chain.lock, flags);
 864
 865         if ((spider_net_release_tx_chain(card, 0) != 0) &&
 866             (card->netdev->flags & IFF_UP))
 867                 spider_net_kick_tx_dma(card);
 868
 869         spin_unlock_irqrestore(&card->tx_chain.lock, flags);
 870 }
 871
 872 /**
 873  * spider_net_do_ioctl - called for device ioctls
 874  * @netdev: interface device structure
 875  * @ifr: request parameter structure for ioctl
 876  * @cmd: command code for ioctl
 877  *
 878  * returns 0 on success, <0 on failure. Currently, we have no special ioctls.
 879  * -EOPNOTSUPP is returned, if an unknown ioctl was requested
 880  */
 881 static int
 882 spider_net_do_ioctl(struct net_device *netdev, struct ifreq *ifr, int cmd)
 883 {
 884         switch (cmd) {
 885         default:
 886                 return -EOPNOTSUPP;
 887         }
 888 }
 889
 890 /**
 891  * spider_net_pass_skb_up - takes an skb from a descriptor and passes it on
 892  * @descr: descriptor to process
 893  * @card: card structure
 894  * @napi: whether caller is in NAPI context
 895  *
 896  * returns 1 on success, 0 if no packet was passed to the stack
 897  *
 898  * iommu-unmaps the skb, fills out skb structure and passes the data to the
 899  * stack. The descriptor state is not changed.
 900  */
 901 static int
 902 spider_net_pass_skb_up(struct spider_net_descr *descr,
 903                        struct spider_net_card *card, int napi)
 904 {
 905         struct sk_buff *skb;
 906         struct net_device *netdev;
 907         u32 data_status, data_error;
 908
 909         data_status = descr->data_status;
 910         data_error = descr->data_error;
 911
 912         netdev = card->netdev;
 913
 914         /* unmap descriptor */
 915         pci_unmap_single(card->pdev, descr->buf_addr, SPIDER_NET_MAX_FRAME,
 916                         PCI_DMA_FROMDEVICE);
 917
 918         /* the cases we'll throw away the packet immediately */
 919         if (data_error & SPIDER_NET_DESTROY_RX_FLAGS) {
 920                 if (netif_msg_rx_err(card))
 921                         pr_err("error in received descriptor found, "
 922                                "data_status=x%08x, data_error=x%08x\n",
 923                                data_status, data_error);
 924                 card->spider_stats.rx_desc_error++;
 925                 return 0;
 926         }
 927
 928         skb = descr->skb;
 929         skb->dev = netdev;
 930         skb_put(skb, descr->valid_size);
 931
 932         /* the card seems to add 2 bytes of junk in front
 933          * of the ethernet frame */
 934 #define SPIDER_MISALIGN         2
 935         skb_pull(skb, SPIDER_MISALIGN);
 936         skb->protocol = eth_type_trans(skb, netdev);
 937
 938         /* checksum offload */
 939         if (card->options.rx_csum) {
 940                 if ( ( (data_status & SPIDER_NET_DATA_STATUS_CKSUM_MASK) ==
 941                        SPIDER_NET_DATA_STATUS_CKSUM_MASK) &&
 942                      !(data_error & SPIDER_NET_DATA_ERR_CKSUM_MASK))
 943                         skb->ip_summed = CHECKSUM_UNNECESSARY;
 944                 else
 945                         skb->ip_summed = CHECKSUM_NONE;
 946         } else
 947                 skb->ip_summed = CHECKSUM_NONE;
 948
 949         if (data_status & SPIDER_NET_VLAN_PACKET) {
 950                 /* further enhancements: HW-accel VLAN
 951                  * vlan_hwaccel_receive_skb
 952                  */
 953         }
 954
 955         /* pass skb up to stack */
 956         if (napi)
 957                 netif_receive_skb(skb);
 958         else
 959                 netif_rx_ni(skb);
 960
 961         /* update netdevice statistics */
 962         card->netdev_stats.rx_packets++;
 963         card->netdev_stats.rx_bytes += skb->len;
 964
 965         return 1;
 966 }
 967
 968 /**
 969  * spider_net_decode_one_descr - processes an rx descriptor
 970  * @card: card structure
 971  * @napi: whether caller is in NAPI context
 972  *
 973  * returns 1 if a packet has been sent to the stack, otherwise 0
 974  *
 975  * processes an rx descriptor by iommu-unmapping the data buffer and passing
 976  * the packet up to the stack. This function is called in softirq
 977  * context, e.g. either bottom half from interrupt or NAPI polling context
 978  */
 979 static int
 980 spider_net_decode_one_descr(struct spider_net_card *card, int napi)
 981 {
 982         struct spider_net_descr_chain *chain = &card->rx_chain;
 983         struct spider_net_descr *descr = chain->tail;
 984         int status;
 985         int result;
 986
 987         status = spider_net_get_descr_status(descr);
 988
 989         if (status == SPIDER_NET_DESCR_CARDOWNED) {
 990                 /* nothing in the descriptor yet */
 991                 result=0;
 992                 goto out;
 993         }
 994
 995         if (status == SPIDER_NET_DESCR_NOT_IN_USE) {
 996                 /* not initialized yet, the ring must be empty */
 997                 spider_net_refill_rx_chain(card);
 998                 spider_net_enable_rxdmac(card);
 999                 result=0;
1000                 goto out;
1001         }
1002
1003         /* descriptor definitively used -- move on tail */
1004         chain->tail = descr->next;
1005
1006         result = 0;
1007         if ( (status == SPIDER_NET_DESCR_RESPONSE_ERROR) ||
1008              (status == SPIDER_NET_DESCR_PROTECTION_ERROR) ||
1009              (status == SPIDER_NET_DESCR_FORCE_END) ) {
1010                 if (netif_msg_rx_err(card))
1011                         pr_err("%s: dropping RX descriptor with state %d\n",
1012                                card->netdev->name, status);
1013                 card->netdev_stats.rx_dropped++;
1014                 pci_unmap_single(card->pdev, descr->buf_addr,
1015                                 SPIDER_NET_MAX_FRAME, PCI_DMA_FROMDEVICE);
1016                 dev_kfree_skb_irq(descr->skb);
1017                 goto refill;
1018         }
1019
1020         if ( (status != SPIDER_NET_DESCR_COMPLETE) &&
1021              (status != SPIDER_NET_DESCR_FRAME_END) ) {
1022                 if (netif_msg_rx_err(card)) {
1023                         pr_err("%s: RX descriptor with state %d\n",
1024                                card->netdev->name, status);
1025                         card->spider_stats.rx_desc_unk_state++;
1026                 }
1027                 goto refill;
1028         }
1029
1030         /* ok, we've got a packet in descr */
1031         result = spider_net_pass_skb_up(descr, card, napi);
1032 refill:
1033         descr->dmac_cmd_status = SPIDER_NET_DESCR_NOT_IN_USE;
1034         /* change the descriptor state: */
1035         if (!napi)
1036                 spider_net_refill_rx_chain(card);
1037 out:
1038         return result;
1039 }
1040
1041 /**
1042  * spider_net_poll - NAPI poll function called by the stack to return packets
1043  * @netdev: interface device structure
1044  * @budget: number of packets we can pass to the stack at most
1045  *
1046  * returns 0 if no more packets available to the driver/stack. Returns 1,
1047  * if the quota is exceeded, but the driver has still packets.
1048  *
1049  * spider_net_poll returns all packets from the rx descriptors to the stack
1050  * (using netif_receive_skb). If all/enough packets are up, the driver
1051  * reenables interrupts and returns 0. If not, 1 is returned.
1052  */
1053 static int
1054 spider_net_poll(struct net_device *netdev, int *budget)
1055 {
1056         struct spider_net_card *card = netdev_priv(netdev);
1057         int packets_to_do, packets_done = 0;
1058         int no_more_packets = 0;
1059
1060         packets_to_do = min(*budget, netdev->quota);
1061
1062         while (packets_to_do) {
1063                 if (spider_net_decode_one_descr(card, 1)) {
1064                         packets_done++;
1065                         packets_to_do--;
1066                 } else {
1067                         /* no more packets for the stack */
1068                         no_more_packets = 1;
1069                         break;
1070                 }
1071         }
1072
1073         netdev->quota -= packets_done;
1074         *budget -= packets_done;
1075         spider_net_refill_rx_chain(card);
1076
1077         /* if all packets are in the stack, enable interrupts and return 0 */
1078         /* if not, return 1 */
1079         if (no_more_packets) {
1080                 netif_rx_complete(netdev);
1081                 spider_net_rx_irq_on(card);
1082                 return 0;
1083         }
1084
1085         return 1;
1086 }
1087
1088 /**
1089  * spider_net_vlan_rx_reg - initializes VLAN structures in the driver and card
1090  * @netdev: interface device structure
1091  * @grp: vlan_group structure that is registered (NULL on destroying interface)
1092  */
1093 static void
1094 spider_net_vlan_rx_reg(struct net_device *netdev, struct vlan_group *grp)
1095 {
1096         /* further enhancement... yet to do */
1097         return;
1098 }
1099
1100 /**
1101  * spider_net_vlan_rx_add - adds VLAN id to the card filter
1102  * @netdev: interface device structure
1103  * @vid: VLAN id to add
1104  */
1105 static void
1106 spider_net_vlan_rx_add(struct net_device *netdev, uint16_t vid)
1107 {
1108         /* further enhancement... yet to do */
1109         /* add vid to card's VLAN filter table */
1110         return;
1111 }
1112
1113 /**
1114  * spider_net_vlan_rx_kill - removes VLAN id to the card filter
1115  * @netdev: interface device structure
1116  * @vid: VLAN id to remove
1117  */
1118 static void
1119 spider_net_vlan_rx_kill(struct net_device *netdev, uint16_t vid)
1120 {
1121         /* further enhancement... yet to do */
1122         /* remove vid from card's VLAN filter table */
1123 }
1124
1125 /**
1126  * spider_net_get_stats - get interface statistics
1127  * @netdev: interface device structure
1128  *
1129  * returns the interface statistics residing in the spider_net_card struct
1130  */
1131 static struct net_device_stats *
1132 spider_net_get_stats(struct net_device *netdev)
1133 {
1134         struct spider_net_card *card = netdev_priv(netdev);
1135         struct net_device_stats *stats = &card->netdev_stats;
1136         return stats;
1137 }
1138
1139 /**
1140  * spider_net_change_mtu - changes the MTU of an interface
1141  * @netdev: interface device structure
1142  * @new_mtu: new MTU value
1143  *
1144  * returns 0 on success, <0 on failure
1145  */
1146 static int
1147 spider_net_change_mtu(struct net_device *netdev, int new_mtu)
1148 {
1149         /* no need to re-alloc skbs or so -- the max mtu is about 2.3k
1150          * and mtu is outbound only anyway */
1151         if ( (new_mtu < SPIDER_NET_MIN_MTU ) ||
1152                 (new_mtu > SPIDER_NET_MAX_MTU) )
1153                 return -EINVAL;
1154         netdev->mtu = new_mtu;
1155         return 0;
1156 }
1157
1158 /**
1159  * spider_net_set_mac - sets the MAC of an interface
1160  * @netdev: interface device structure
1161  * @ptr: pointer to new MAC address
1162  *
1163  * Returns 0 on success, <0 on failure. Currently, we don't support this
1164  * and will always return EOPNOTSUPP.
1165  */
1166 static int
1167 spider_net_set_mac(struct net_device *netdev, void *p)
1168 {
1169         struct spider_net_card *card = netdev_priv(netdev);
1170         u32 macl, macu, regvalue;
1171         struct sockaddr *addr = p;
1172
1173         if (!is_valid_ether_addr(addr->sa_data))
1174                 return -EADDRNOTAVAIL;
1175
1176         /* switch off GMACTPE and GMACRPE */
1177         regvalue = spider_net_read_reg(card, SPIDER_NET_GMACOPEMD);
1178         regvalue &= ~((1 << 5) | (1 << 6));
1179         spider_net_write_reg(card, SPIDER_NET_GMACOPEMD, regvalue);
1180
1181         /* write mac */
1182         macu = (addr->sa_data[0]<<24) + (addr->sa_data[1]<<16) +
1183                 (addr->sa_data[2]<<8) + (addr->sa_data[3]);
1184         macl = (addr->sa_data[4]<<8) + (addr->sa_data[5]);
1185         spider_net_write_reg(card, SPIDER_NET_GMACUNIMACU, macu);
1186         spider_net_write_reg(card, SPIDER_NET_GMACUNIMACL, macl);
1187
1188         /* switch GMACTPE and GMACRPE back on */
1189         regvalue = spider_net_read_reg(card, SPIDER_NET_GMACOPEMD);
1190         regvalue |= ((1 << 5) | (1 << 6));
1191         spider_net_write_reg(card, SPIDER_NET_GMACOPEMD, regvalue);
1192
1193         spider_net_set_promisc(card);
1194
1195         /* look up, whether we have been successful */
1196         if (spider_net_get_mac_address(netdev))
1197                 return -EADDRNOTAVAIL;
1198         if (memcmp(netdev->dev_addr,addr->sa_data,netdev->addr_len))
1199                 return -EADDRNOTAVAIL;
1200
1201         return 0;
1202 }
1203
1204 /**
1205  * spider_net_handle_rxram_full - cleans up RX ring upon RX RAM full interrupt
1206  * @card: card structure
1207  *
1208  * spider_net_handle_rxram_full empties the RX ring so that spider can put
1209  * more packets in it and empty its RX RAM. This is called in bottom half
1210  * context
1211  */
1212 static void
1213 spider_net_handle_rxram_full(struct spider_net_card *card)
1214 {
1215         while (spider_net_decode_one_descr(card, 0))
1216                 ;
1217         spider_net_enable_rxchtails(card);
1218         spider_net_enable_rxdmac(card);
1219         netif_rx_schedule(card->netdev);
1220 }
1221
1222 /**
1223  * spider_net_handle_error_irq - handles errors raised by an interrupt
1224  * @card: card structure
1225  * @status_reg: interrupt status register 0 (GHIINT0STS)
1226  *
1227  * spider_net_handle_error_irq treats or ignores all error conditions
1228  * found when an interrupt is presented
1229  */
1230 static void
1231 spider_net_handle_error_irq(struct spider_net_card *card, u32 status_reg)
1232 {
1233         u32 error_reg1, error_reg2;
1234         u32 i;
1235         int show_error = 1;
1236
1237         error_reg1 = spider_net_read_reg(card, SPIDER_NET_GHIINT1STS);
1238         error_reg2 = spider_net_read_reg(card, SPIDER_NET_GHIINT2STS);
1239
1240         /* check GHIINT0STS ************************************/
1241         if (status_reg)
1242                 for (i = 0; i < 32; i++)
1243                         if (status_reg & (1<<i))
1244                                 switch (i)
1245         {
1246         /* let error_reg1 and error_reg2 evaluation decide, what to do
1247         case SPIDER_NET_PHYINT:
1248         case SPIDER_NET_GMAC2INT:
1249         case SPIDER_NET_GMAC1INT:
1250         case SPIDER_NET_GIPSINT:
1251         case SPIDER_NET_GFIFOINT:
1252         case SPIDER_NET_DMACINT:
1253         case SPIDER_NET_GSYSINT:
1254                 break; */
1255
1256         case SPIDER_NET_GPWOPCMPINT:
1257                 /* PHY write operation completed */
1258                 show_error = 0;
1259                 break;
1260         case SPIDER_NET_GPROPCMPINT:
1261                 /* PHY read operation completed */
1262                 /* we don't use semaphores, as we poll for the completion
1263                  * of the read operation in spider_net_read_phy. Should take
1264                  * about 50 us */
1265                 show_error = 0;
1266                 break;
1267         case SPIDER_NET_GPWFFINT:
1268                 /* PHY command queue full */
1269                 if (netif_msg_intr(card))
1270                         pr_err("PHY write queue full\n");
1271                 show_error = 0;
1272                 break;
1273
1274         /* case SPIDER_NET_GRMDADRINT: not used. print a message */
1275         /* case SPIDER_NET_GRMARPINT: not used. print a message */
1276         /* case SPIDER_NET_GRMMPINT: not used. print a message */
1277
1278         case SPIDER_NET_GDTDEN0INT:
1279                 /* someone has set TX_DMA_EN to 0 */
1280                 show_error = 0;
1281                 break;
1282
1283         case SPIDER_NET_GDDDEN0INT: /* fallthrough */
1284         case SPIDER_NET_GDCDEN0INT: /* fallthrough */
1285         case SPIDER_NET_GDBDEN0INT: /* fallthrough */
1286         case SPIDER_NET_GDADEN0INT:
1287                 /* someone has set RX_DMA_EN to 0 */
1288                 show_error = 0;
1289                 break;
1290
1291         /* RX interrupts */
1292         case SPIDER_NET_GDDFDCINT:
1293         case SPIDER_NET_GDCFDCINT:
1294         case SPIDER_NET_GDBFDCINT:
1295         case SPIDER_NET_GDAFDCINT:
1296         /* case SPIDER_NET_GDNMINT: not used. print a message */
1297         /* case SPIDER_NET_GCNMINT: not used. print a message */
1298         /* case SPIDER_NET_GBNMINT: not used. print a message */
1299         /* case SPIDER_NET_GANMINT: not used. print a message */
1300         /* case SPIDER_NET_GRFNMINT: not used. print a message */
1301                 show_error = 0;
1302                 break;
1303
1304         /* TX interrupts */
1305         case SPIDER_NET_GDTFDCINT:
1306                 show_error = 0;
1307                 break;
1308         case SPIDER_NET_GTTEDINT:
1309                 show_error = 0;
1310                 break;
1311         case SPIDER_NET_GDTDCEINT:
1312                 /* chain end. If a descriptor should be sent, kick off
1313                  * tx dma
1314                 if (card->tx_chain.tail == card->tx_chain.head)
1315                         spider_net_kick_tx_dma(card);
1316                 show_error = 0; */
1317                 break;
1318
1319         /* case SPIDER_NET_G1TMCNTINT: not used. print a message */
1320         /* case SPIDER_NET_GFREECNTINT: not used. print a message */
1321         }
1322
1323         /* check GHIINT1STS ************************************/
1324         if (error_reg1)
1325                 for (i = 0; i < 32; i++)
1326                         if (error_reg1 & (1<<i))
1327                                 switch (i)
1328         {
1329         case SPIDER_NET_GTMFLLINT:
1330                 if (netif_msg_intr(card) && net_ratelimit())
1331                         pr_err("Spider TX RAM full\n");
1332                 show_error = 0;
1333                 break;
1334         case SPIDER_NET_GRFDFLLINT: /* fallthrough */
1335         case SPIDER_NET_GRFCFLLINT: /* fallthrough */
1336         case SPIDER_NET_GRFBFLLINT: /* fallthrough */
1337         case SPIDER_NET_GRFAFLLINT: /* fallthrough */
1338         case SPIDER_NET_GRMFLLINT:
1339                 if (netif_msg_intr(card) && net_ratelimit())
1340                         pr_debug("Spider RX RAM full, incoming packets "
1341                                "might be discarded!\n");
1342                 spider_net_rx_irq_off(card);
1343                 tasklet_schedule(&card->rxram_full_tl);
1344                 show_error = 0;
1345                 break;
1346
1347         /* case SPIDER_NET_GTMSHTINT: problem, print a message */
1348         case SPIDER_NET_GDTINVDINT:
1349                 /* allrighty. tx from previous descr ok */
1350                 show_error = 0;
1351                 break;
1352
1353         /* chain end */
1354         case SPIDER_NET_GDDDCEINT: /* fallthrough */
1355         case SPIDER_NET_GDCDCEINT: /* fallthrough */
1356         case SPIDER_NET_GDBDCEINT: /* fallthrough */
1357         case SPIDER_NET_GDADCEINT:
1358                 if (netif_msg_intr(card))
1359                         pr_err("got descriptor chain end interrupt, "
1360                                "restarting DMAC %c.\n",
1361                                'D'+i-SPIDER_NET_GDDDCEINT);
1362                 spider_net_refill_rx_chain(card);
1363                 spider_net_enable_rxdmac(card);
1364                 show_error = 0;
1365                 break;
1366
1367         /* invalid descriptor */
1368         case SPIDER_NET_GDDINVDINT: /* fallthrough */
1369         case SPIDER_NET_GDCINVDINT: /* fallthrough */
1370         case SPIDER_NET_GDBINVDINT: /* fallthrough */
1371         case SPIDER_NET_GDAINVDINT:
1372                 /* could happen when rx chain is full */
1373                 spider_net_refill_rx_chain(card);
1374                 spider_net_enable_rxdmac(card);
1375                 show_error = 0;
1376                 break;
1377
1378         /* case SPIDER_NET_GDTRSERINT: problem, print a message */
1379         /* case SPIDER_NET_GDDRSERINT: problem, print a message */
1380         /* case SPIDER_NET_GDCRSERINT: problem, print a message */
1381         /* case SPIDER_NET_GDBRSERINT: problem, print a message */
1382         /* case SPIDER_NET_GDARSERINT: problem, print a message */
1383         /* case SPIDER_NET_GDSERINT: problem, print a message */
1384         /* case SPIDER_NET_GDTPTERINT: problem, print a message */
1385         /* case SPIDER_NET_GDDPTERINT: problem, print a message */
1386         /* case SPIDER_NET_GDCPTERINT: problem, print a message */
1387         /* case SPIDER_NET_GDBPTERINT: problem, print a message */
1388         /* case SPIDER_NET_GDAPTERINT: problem, print a message */
1389         default:
1390                 show_error = 1;
1391                 break;
1392         }
1393
1394         /* check GHIINT2STS ************************************/
1395         if (error_reg2)
1396                 for (i = 0; i < 32; i++)
1397                         if (error_reg2 & (1<<i))
1398                                 switch (i)
1399         {
1400         /* there is nothing we can (want  to) do at this time. Log a
1401          * message, we can switch on and off the specific values later on
1402         case SPIDER_NET_GPROPERINT:
1403         case SPIDER_NET_GMCTCRSNGINT:
1404         case SPIDER_NET_GMCTLCOLINT:
1405         case SPIDER_NET_GMCTTMOTINT:
1406         case SPIDER_NET_GMCRCAERINT:
1407         case SPIDER_NET_GMCRCALERINT:
1408         case SPIDER_NET_GMCRALNERINT:
1409         case SPIDER_NET_GMCROVRINT:
1410         case SPIDER_NET_GMCRRNTINT:
1411         case SPIDER_NET_GMCRRXERINT:
1412         case SPIDER_NET_GTITCSERINT:
1413         case SPIDER_NET_GTIFMTERINT:
1414         case SPIDER_NET_GTIPKTRVKINT:
1415         case SPIDER_NET_GTISPINGINT:
1416         case SPIDER_NET_GTISADNGINT:
1417         case SPIDER_NET_GTISPDNGINT:
1418         case SPIDER_NET_GRIFMTERINT:
1419         case SPIDER_NET_GRIPKTRVKINT:
1420         case SPIDER_NET_GRISPINGINT:
1421         case SPIDER_NET_GRISADNGINT:
1422         case SPIDER_NET_GRISPDNGINT:
1423                 break;
1424         */
1425                 default:
1426                         break;
1427         }
1428
1429         if ((show_error) && (netif_msg_intr(card)))
1430                 pr_err("Got error interrupt, GHIINT0STS = 0x%08x, "
1431                        "GHIINT1STS = 0x%08x, GHIINT2STS = 0x%08x\n",
1432                        status_reg, error_reg1, error_reg2);
1433
1434         /* clear interrupt sources */
1435         spider_net_write_reg(card, SPIDER_NET_GHIINT1STS, error_reg1);
1436         spider_net_write_reg(card, SPIDER_NET_GHIINT2STS, error_reg2);
1437 }
1438
1439 /**
1440  * spider_net_interrupt - interrupt handler for spider_net
1441  * @irq: interupt number
1442  * @ptr: pointer to net_device
1443  * @regs: PU registers
1444  *
1445  * returns IRQ_HANDLED, if interrupt was for driver, or IRQ_NONE, if no
1446  * interrupt found raised by card.
1447  *
1448  * This is the interrupt handler, that turns off
1449  * interrupts for this device and makes the stack poll the driver
1450  */
1451 static irqreturn_t
1452 spider_net_interrupt(int irq, void *ptr)
1453 {
1454         struct net_device *netdev = ptr;
1455         struct spider_net_card *card = netdev_priv(netdev);
1456         u32 status_reg;
1457
1458         status_reg = spider_net_read_reg(card, SPIDER_NET_GHIINT0STS);
1459
1460         if (!status_reg)
1461                 return IRQ_NONE;
1462
1463         if (status_reg & SPIDER_NET_RXINT ) {
1464                 spider_net_rx_irq_off(card);
1465                 netif_rx_schedule(netdev);
1466         }
1467
1468         if (status_reg & SPIDER_NET_ERRINT )
1469                 spider_net_handle_error_irq(card, status_reg);
1470
1471         /* clear interrupt sources */
1472         spider_net_write_reg(card, SPIDER_NET_GHIINT0STS, status_reg);
1473
1474         return IRQ_HANDLED;
1475 }
1476
1477 #ifdef CONFIG_NET_POLL_CONTROLLER
1478 /**
1479  * spider_net_poll_controller - artificial interrupt for netconsole etc.
1480  * @netdev: interface device structure
1481  *
1482  * see Documentation/networking/netconsole.txt
1483  */
1484 static void
1485 spider_net_poll_controller(struct net_device *netdev)
1486 {
1487         disable_irq(netdev->irq);
1488         spider_net_interrupt(netdev->irq, netdev);
1489         enable_irq(netdev->irq);
1490 }
1491 #endif /* CONFIG_NET_POLL_CONTROLLER */
1492
1493 /**
1494  * spider_net_init_card - initializes the card
1495  * @card: card structure
1496  *
1497  * spider_net_init_card initializes the card so that other registers can
1498  * be used
1499  */
1500 static void
1501 spider_net_init_card(struct spider_net_card *card)
1502 {
1503         spider_net_write_reg(card, SPIDER_NET_CKRCTRL,
1504                              SPIDER_NET_CKRCTRL_STOP_VALUE);
1505
1506         spider_net_write_reg(card, SPIDER_NET_CKRCTRL,
1507                              SPIDER_NET_CKRCTRL_RUN_VALUE);
1508 }
1509
1510 /**
1511  * spider_net_enable_card - enables the card by setting all kinds of regs
1512  * @card: card structure
1513  *
1514  * spider_net_enable_card sets a lot of SMMIO registers to enable the device
1515  */
1516 static void
1517 spider_net_enable_card(struct spider_net_card *card)
1518 {
1519         int i;
1520         /* the following array consists of (register),(value) pairs
1521          * that are set in this function. A register of 0 ends the list */
1522         u32 regs[][2] = {
1523                 { SPIDER_NET_GRESUMINTNUM, 0 },
1524                 { SPIDER_NET_GREINTNUM, 0 },
1525
1526                 /* set interrupt frame number registers */
1527                 /* clear the single DMA engine registers first */
1528                 { SPIDER_NET_GFAFRMNUM, SPIDER_NET_GFXFRAMES_VALUE },
1529                 { SPIDER_NET_GFBFRMNUM, SPIDER_NET_GFXFRAMES_VALUE },
1530                 { SPIDER_NET_GFCFRMNUM, SPIDER_NET_GFXFRAMES_VALUE },
1531                 { SPIDER_NET_GFDFRMNUM, SPIDER_NET_GFXFRAMES_VALUE },
1532                 /* then set, what we really need */
1533                 { SPIDER_NET_GFFRMNUM, SPIDER_NET_FRAMENUM_VALUE },
1534
1535                 /* timer counter registers and stuff */
1536                 { SPIDER_NET_GFREECNNUM, 0 },
1537                 { SPIDER_NET_GONETIMENUM, 0 },
1538                 { SPIDER_NET_GTOUTFRMNUM, 0 },
1539
1540                 /* RX mode setting */
1541                 { SPIDER_NET_GRXMDSET, SPIDER_NET_RXMODE_VALUE },
1542                 /* TX mode setting */
1543                 { SPIDER_NET_GTXMDSET, SPIDER_NET_TXMODE_VALUE },
1544                 /* IPSEC mode setting */
1545                 { SPIDER_NET_GIPSECINIT, SPIDER_NET_IPSECINIT_VALUE },
1546
1547                 { SPIDER_NET_GFTRESTRT, SPIDER_NET_RESTART_VALUE },
1548
1549                 { SPIDER_NET_GMRWOLCTRL, 0 },
1550                 { SPIDER_NET_GTESTMD, 0x10000000 },
1551                 { SPIDER_NET_GTTQMSK, 0x00400040 },
1552
1553                 { SPIDER_NET_GMACINTEN, 0 },
1554
1555                 /* flow control stuff */
1556                 { SPIDER_NET_GMACAPAUSE, SPIDER_NET_MACAPAUSE_VALUE },
1557                 { SPIDER_NET_GMACTXPAUSE, SPIDER_NET_TXPAUSE_VALUE },
1558
1559                 { SPIDER_NET_GMACBSTLMT, SPIDER_NET_BURSTLMT_VALUE },
1560                 { 0, 0}
1561         };
1562
1563         i = 0;
1564         while (regs[i][0]) {
1565                 spider_net_write_reg(card, regs[i][0], regs[i][1]);
1566                 i++;
1567         }
1568
1569         /* clear unicast filter table entries 1 to 14 */
1570         for (i = 1; i <= 14; i++) {
1571                 spider_net_write_reg(card,
1572                                      SPIDER_NET_GMRUAFILnR + i * 8,
1573                                      0x00080000);
1574                 spider_net_write_reg(card,
1575                                      SPIDER_NET_GMRUAFILnR + i * 8 + 4,
1576                                      0x00000000);
1577         }
1578
1579         spider_net_write_reg(card, SPIDER_NET_GMRUA0FIL15R, 0x08080000);
1580
1581         spider_net_write_reg(card, SPIDER_NET_ECMODE, SPIDER_NET_ECMODE_VALUE);
1582
1583         /* set chain tail adress for RX chains and
1584          * enable DMA */
1585         spider_net_enable_rxchtails(card);
1586         spider_net_enable_rxdmac(card);
1587
1588         spider_net_write_reg(card, SPIDER_NET_GRXDMAEN, SPIDER_NET_WOL_VALUE);
1589
1590         spider_net_write_reg(card, SPIDER_NET_GMACLENLMT,
1591                              SPIDER_NET_LENLMT_VALUE);
1592         spider_net_write_reg(card, SPIDER_NET_GMACMODE,
1593                              SPIDER_NET_MACMODE_VALUE);
1594         spider_net_write_reg(card, SPIDER_NET_GMACOPEMD,
1595                              SPIDER_NET_OPMODE_VALUE);
1596
1597         /* set interrupt mask registers */
1598         spider_net_write_reg(card, SPIDER_NET_GHIINT0MSK,
1599                              SPIDER_NET_INT0_MASK_VALUE);
1600         spider_net_write_reg(card, SPIDER_NET_GHIINT1MSK,
1601                              SPIDER_NET_INT1_MASK_VALUE);
1602         spider_net_write_reg(card, SPIDER_NET_GHIINT2MSK,
1603                              SPIDER_NET_INT2_MASK_VALUE);
1604
1605         spider_net_write_reg(card, SPIDER_NET_GDTDMACCNTR,
1606                              SPIDER_NET_GDTDCEIDIS);
1607 }
1608
1609 /**
1610  * spider_net_open - called upon ifonfig up
1611  * @netdev: interface device structure
1612  *
1613  * returns 0 on success, <0 on failure
1614  *
1615  * spider_net_open allocates all the descriptors and memory needed for
1616  * operation, sets up multicast list and enables interrupts
1617  */
1618 int
1619 spider_net_open(struct net_device *netdev)
1620 {
1621         struct spider_net_card *card = netdev_priv(netdev);
1622         int result;
1623
1624         result = -ENOMEM;
1625         if (spider_net_init_chain(card, &card->tx_chain, card->descr,
1626                         PCI_DMA_TODEVICE, card->tx_desc))
1627                 goto alloc_tx_failed;
1628         if (spider_net_init_chain(card, &card->rx_chain,
1629                         card->descr + card->rx_desc,
1630                         PCI_DMA_FROMDEVICE, card->rx_desc))
1631                 goto alloc_rx_failed;
1632
1633         /* allocate rx skbs */
1634         if (spider_net_alloc_rx_skbs(card))
1635                 goto alloc_skbs_failed;
1636
1637         spider_net_set_multi(netdev);
1638
1639         /* further enhancement: setup hw vlan, if needed */
1640
1641         result = -EBUSY;
1642         if (request_irq(netdev->irq, spider_net_interrupt,
1643                              IRQF_SHARED, netdev->name, netdev))
1644                 goto register_int_failed;
1645
1646         spider_net_enable_card(card);
1647
1648         netif_start_queue(netdev);
1649         netif_carrier_on(netdev);
1650         netif_poll_enable(netdev);
1651
1652         return 0;
1653
1654 register_int_failed:
1655         spider_net_free_rx_chain_contents(card);
1656 alloc_skbs_failed:
1657         spider_net_free_chain(card, &card->rx_chain);
1658 alloc_rx_failed:
1659         spider_net_free_chain(card, &card->tx_chain);
1660 alloc_tx_failed:
1661         return result;
1662 }
1663
1664 /**
1665  * spider_net_setup_phy - setup PHY
1666  * @card: card structure
1667  *
1668  * returns 0 on success, <0 on failure
1669  *
1670  * spider_net_setup_phy is used as part of spider_net_probe. Sets
1671  * the PHY to 1000 Mbps
1672  **/
1673 static int
1674 spider_net_setup_phy(struct spider_net_card *card)
1675 {
1676         struct mii_phy *phy = &card->phy;
1677
1678         spider_net_write_reg(card, SPIDER_NET_GDTDMASEL,
1679                              SPIDER_NET_DMASEL_VALUE);
1680         spider_net_write_reg(card, SPIDER_NET_GPCCTRL,
1681                              SPIDER_NET_PHY_CTRL_VALUE);
1682         phy->mii_id = 1;
1683         phy->dev = card->netdev;
1684         phy->mdio_read = spider_net_read_phy;
1685         phy->mdio_write = spider_net_write_phy;
1686
1687         mii_phy_probe(phy, phy->mii_id);
1688
1689         if (phy->def->ops->setup_forced)
1690                 phy->def->ops->setup_forced(phy, SPEED_1000, DUPLEX_FULL);
1691
1692         phy->def->ops->enable_fiber(phy);
1693
1694         phy->def->ops->read_link(phy);
1695         pr_info("Found %s with %i Mbps, %s-duplex.\n", phy->def->name,
1696                 phy->speed, phy->duplex==1 ? "Full" : "Half");
1697
1698         return 0;
1699 }
1700
1701 /**
1702  * spider_net_download_firmware - loads firmware into the adapter
1703  * @card: card structure
1704  * @firmware_ptr: pointer to firmware data
1705  *
1706  * spider_net_download_firmware loads the firmware data into the
1707  * adapter. It assumes the length etc. to be allright.
1708  */
1709 static int
1710 spider_net_download_firmware(struct spider_net_card *card,
1711                              const void *firmware_ptr)
1712 {
1713         int sequencer, i;
1714         const u32 *fw_ptr = firmware_ptr;
1715
1716         /* stop sequencers */
1717         spider_net_write_reg(card, SPIDER_NET_GSINIT,
1718                              SPIDER_NET_STOP_SEQ_VALUE);
1719
1720         for (sequencer = 0; sequencer < SPIDER_NET_FIRMWARE_SEQS;
1721              sequencer++) {
1722                 spider_net_write_reg(card,
1723                                      SPIDER_NET_GSnPRGADR + sequencer * 8, 0);
1724                 for (i = 0; i < SPIDER_NET_FIRMWARE_SEQWORDS; i++) {
1725                         spider_net_write_reg(card, SPIDER_NET_GSnPRGDAT +
1726                                              sequencer * 8, *fw_ptr);
1727                         fw_ptr++;
1728                 }
1729         }
1730
1731         if (spider_net_read_reg(card, SPIDER_NET_GSINIT))
1732                 return -EIO;
1733
1734         spider_net_write_reg(card, SPIDER_NET_GSINIT,
1735                              SPIDER_NET_RUN_SEQ_VALUE);
1736
1737         return 0;
1738 }
1739
1740 /**
1741  * spider_net_init_firmware - reads in firmware parts
1742  * @card: card structure
1743  *
1744  * Returns 0 on success, <0 on failure
1745  *
1746  * spider_net_init_firmware opens the sequencer firmware and does some basic
1747  * checks. This function opens and releases the firmware structure. A call
1748  * to download the firmware is performed before the release.
1749  *
1750  * Firmware format
1751  * ===============
1752  * spider_fw.bin is expected to be a file containing 6*1024*4 bytes, 4k being
1753  * the program for each sequencer. Use the command
1754  *    tail -q -n +2 Seq_code1_0x088.txt Seq_code2_0x090.txt              \
1755  *         Seq_code3_0x098.txt Seq_code4_0x0A0.txt Seq_code5_0x0A8.txt   \
1756  *         Seq_code6_0x0B0.txt | xxd -r -p -c4 > spider_fw.bin
1757  *
1758  * to generate spider_fw.bin, if you have sequencer programs with something
1759  * like the following contents for each sequencer:
1760  *    <ONE LINE COMMENT>
1761  *    <FIRST 4-BYTES-WORD FOR SEQUENCER>
1762  *    <SECOND 4-BYTES-WORD FOR SEQUENCER>
1763  *     ...
1764  *    <1024th 4-BYTES-WORD FOR SEQUENCER>
1765  */
1766 static int
1767 spider_net_init_firmware(struct spider_net_card *card)
1768 {
1769         struct firmware *firmware = NULL;
1770         struct device_node *dn;
1771         const u8 *fw_prop = NULL;
1772         int err = -ENOENT;
1773         int fw_size;
1774
1775         if (request_firmware((const struct firmware **)&firmware,
1776                              SPIDER_NET_FIRMWARE_NAME, &card->pdev->dev) == 0) {
1777                 if ( (firmware->size != SPIDER_NET_FIRMWARE_LEN) &&
1778                      netif_msg_probe(card) ) {
1779                         pr_err("Incorrect size of spidernet firmware in " \
1780                                "filesystem. Looking in host firmware...\n");
1781                         goto try_host_fw;
1782                 }
1783                 err = spider_net_download_firmware(card, firmware->data);
1784
1785                 release_firmware(firmware);
1786                 if (err)
1787                         goto try_host_fw;
1788
1789                 goto done;
1790         }
1791
1792 try_host_fw:
1793         dn = pci_device_to_OF_node(card->pdev);
1794         if (!dn)
1795                 goto out_err;
1796
1797         fw_prop = get_property(dn, "firmware", &fw_size);
1798         if (!fw_prop)
1799                 goto out_err;
1800
1801         if ( (fw_size != SPIDER_NET_FIRMWARE_LEN) &&
1802              netif_msg_probe(card) ) {
1803                 pr_err("Incorrect size of spidernet firmware in " \
1804                        "host firmware\n");
1805                 goto done;
1806         }
1807
1808         err = spider_net_download_firmware(card, fw_prop);
1809
1810 done:
1811         return err;
1812 out_err:
1813         if (netif_msg_probe(card))
1814                 pr_err("Couldn't find spidernet firmware in filesystem " \
1815                        "or host firmware\n");
1816         return err;
1817 }
1818
1819 /**
1820  * spider_net_workaround_rxramfull - work around firmware bug
1821  * @card: card structure
1822  *
1823  * no return value
1824  **/
1825 static void
1826 spider_net_workaround_rxramfull(struct spider_net_card *card)
1827 {
1828         int i, sequencer = 0;
1829
1830         /* cancel reset */
1831         spider_net_write_reg(card, SPIDER_NET_CKRCTRL,
1832                              SPIDER_NET_CKRCTRL_RUN_VALUE);
1833
1834         /* empty sequencer data */
1835         for (sequencer = 0; sequencer < SPIDER_NET_FIRMWARE_SEQS;
1836              sequencer++) {
1837                 spider_net_write_reg(card, SPIDER_NET_GSnPRGADR +
1838                                      sequencer * 8, 0x0);
1839                 for (i = 0; i < SPIDER_NET_FIRMWARE_SEQWORDS; i++) {
1840                         spider_net_write_reg(card, SPIDER_NET_GSnPRGDAT +
1841                                              sequencer * 8, 0x0);
1842                 }
1843         }
1844
1845         /* set sequencer operation */
1846         spider_net_write_reg(card, SPIDER_NET_GSINIT, 0x000000fe);
1847
1848         /* reset */
1849         spider_net_write_reg(card, SPIDER_NET_CKRCTRL,
1850                              SPIDER_NET_CKRCTRL_STOP_VALUE);
1851 }
1852
1853 /**
1854  * spider_net_stop - called upon ifconfig down
1855  * @netdev: interface device structure
1856  *
1857  * always returns 0
1858  */
1859 int
1860 spider_net_stop(struct net_device *netdev)
1861 {
1862         struct spider_net_card *card = netdev_priv(netdev);
1863
1864         tasklet_kill(&card->rxram_full_tl);
1865         netif_poll_disable(netdev);
1866         netif_carrier_off(netdev);
1867         netif_stop_queue(netdev);
1868         del_timer_sync(&card->tx_timer);
1869
1870         /* disable/mask all interrupts */
1871         spider_net_write_reg(card, SPIDER_NET_GHIINT0MSK, 0);
1872         spider_net_write_reg(card, SPIDER_NET_GHIINT1MSK, 0);
1873         spider_net_write_reg(card, SPIDER_NET_GHIINT2MSK, 0);
1874
1875         /* free_irq(netdev->irq, netdev);*/
1876         free_irq(to_pci_dev(netdev->class_dev.dev)->irq, netdev);
1877
1878         spider_net_write_reg(card, SPIDER_NET_GDTDMACCNTR,
1879                              SPIDER_NET_DMA_TX_FEND_VALUE);
1880
1881         /* turn off DMA, force end */
1882         spider_net_disable_rxdmac(card);
1883
1884         /* release chains */
1885         if (spin_trylock(&card->tx_chain.lock)) {
1886                 spider_net_release_tx_chain(card, 1);
1887                 spin_unlock(&card->tx_chain.lock);
1888         }
1889
1890         spider_net_free_chain(card, &card->tx_chain);
1891         spider_net_free_chain(card, &card->rx_chain);
1892
1893         return 0;
1894 }
1895
1896 /**
1897  * spider_net_tx_timeout_task - task scheduled by the watchdog timeout
1898  * function (to be called not under interrupt status)
1899  * @data: data, is interface device structure
1900  *
1901  * called as task when tx hangs, resets interface (if interface is up)
1902  */
1903 static void
1904 spider_net_tx_timeout_task(void *data)
1905 {
1906         struct net_device *netdev = data;
1907         struct spider_net_card *card = netdev_priv(netdev);
1908
1909         if (!(netdev->flags & IFF_UP))
1910                 goto out;
1911
1912         netif_device_detach(netdev);
1913         spider_net_stop(netdev);
1914
1915         spider_net_workaround_rxramfull(card);
1916         spider_net_init_card(card);
1917
1918         if (spider_net_setup_phy(card))
1919                 goto out;
1920         if (spider_net_init_firmware(card))
1921                 goto out;
1922
1923         spider_net_open(netdev);
1924         spider_net_kick_tx_dma(card);
1925         netif_device_attach(netdev);
1926
1927 out:
1928         atomic_dec(&card->tx_timeout_task_counter);
1929 }
1930
1931 /**
1932  * spider_net_tx_timeout - called when the tx timeout watchdog kicks in.
1933  * @netdev: interface device structure
1934  *
1935  * called, if tx hangs. Schedules a task that resets the interface
1936  */
1937 static void
1938 spider_net_tx_timeout(struct net_device *netdev)
1939 {
1940         struct spider_net_card *card;
1941
1942         card = netdev_priv(netdev);
1943         atomic_inc(&card->tx_timeout_task_counter);
1944         if (netdev->flags & IFF_UP)
1945                 schedule_work(&card->tx_timeout_task);
1946         else
1947                 atomic_dec(&card->tx_timeout_task_counter);
1948         card->spider_stats.tx_timeouts++;
1949 }
1950
1951 /**
1952  * spider_net_setup_netdev_ops - initialization of net_device operations
1953  * @netdev: net_device structure
1954  *
1955  * fills out function pointers in the net_device structure
1956  */
1957 static void
1958 spider_net_setup_netdev_ops(struct net_device *netdev)
1959 {
1960         netdev->open = &spider_net_open;
1961         netdev->stop = &spider_net_stop;
1962         netdev->hard_start_xmit = &spider_net_xmit;
1963         netdev->get_stats = &spider_net_get_stats;
1964         netdev->set_multicast_list = &spider_net_set_multi;
1965         netdev->set_mac_address = &spider_net_set_mac;
1966         netdev->change_mtu = &spider_net_change_mtu;
1967         netdev->do_ioctl = &spider_net_do_ioctl;
1968         /* tx watchdog */
1969         netdev->tx_timeout = &spider_net_tx_timeout;
1970         netdev->watchdog_timeo = SPIDER_NET_WATCHDOG_TIMEOUT;
1971         /* NAPI */
1972         netdev->poll = &spider_net_poll;
1973         netdev->weight = SPIDER_NET_NAPI_WEIGHT;
1974         /* HW VLAN */
1975         netdev->vlan_rx_register = &spider_net_vlan_rx_reg;
1976         netdev->vlan_rx_add_vid = &spider_net_vlan_rx_add;
1977         netdev->vlan_rx_kill_vid = &spider_net_vlan_rx_kill;
1978 #ifdef CONFIG_NET_POLL_CONTROLLER
1979         /* poll controller */
1980         netdev->poll_controller = &spider_net_poll_controller;
1981 #endif /* CONFIG_NET_POLL_CONTROLLER */
1982         /* ethtool ops */
1983         netdev->ethtool_ops = &spider_net_ethtool_ops;
1984 }
1985
1986 /**
1987  * spider_net_setup_netdev - initialization of net_device
1988  * @card: card structure
1989  *
1990  * Returns 0 on success or <0 on failure
1991  *
1992  * spider_net_setup_netdev initializes the net_device structure
1993  **/
1994 static int
1995 spider_net_setup_netdev(struct spider_net_card *card)
1996 {
1997         int result;
1998         struct net_device *netdev = card->netdev;
1999         struct device_node *dn;
2000         struct sockaddr addr;
2001         const u8 *mac;
2002
2003         SET_MODULE_OWNER(netdev);
2004         SET_NETDEV_DEV(netdev, &card->pdev->dev);
2005
2006         pci_set_drvdata(card->pdev, netdev);
2007
2008         card->rxram_full_tl.data = (unsigned long) card;
2009         card->rxram_full_tl.func =
2010                 (void (*)(unsigned long)) spider_net_handle_rxram_full;
2011         init_timer(&card->tx_timer);
2012         card->tx_timer.function =
2013                 (void (*)(unsigned long)) spider_net_cleanup_tx_ring;
2014         card->tx_timer.data = (unsigned long) card;
2015         netdev->irq = card->pdev->irq;
2016
2017         card->options.rx_csum = SPIDER_NET_RX_CSUM_DEFAULT;
2018
2019         card->tx_desc = tx_descriptors;
2020         card->rx_desc = rx_descriptors;
2021
2022         spider_net_setup_netdev_ops(netdev);
2023
2024         netdev->features = NETIF_F_HW_CSUM | NETIF_F_LLTX;
2025         /* some time: NETIF_F_HW_VLAN_TX | NETIF_F_HW_VLAN_RX |
2026          *              NETIF_F_HW_VLAN_FILTER */
2027
2028         netdev->irq = card->pdev->irq;
2029
2030         dn = pci_device_to_OF_node(card->pdev);
2031         if (!dn)
2032                 return -EIO;
2033
2034         mac = get_property(dn, "local-mac-address", NULL);
2035         if (!mac)
2036                 return -EIO;
2037         memcpy(addr.sa_data, mac, ETH_ALEN);
2038
2039         result = spider_net_set_mac(netdev, &addr);
2040         if ((result) && (netif_msg_probe(card)))
2041                 pr_err("Failed to set MAC address: %i\n", result);
2042
2043         result = register_netdev(netdev);
2044         if (result) {
2045                 if (netif_msg_probe(card))
2046                         pr_err("Couldn't register net_device: %i\n",
2047                                   result);
2048                 return result;
2049         }
2050
2051         if (netif_msg_probe(card))
2052                 pr_info("Initialized device %s.\n", netdev->name);
2053
2054         return 0;
2055 }
2056
2057 /**
2058  * spider_net_alloc_card - allocates net_device and card structure
2059  *
2060  * returns the card structure or NULL in case of errors
2061  *
2062  * the card and net_device structures are linked to each other
2063  */
2064 static struct spider_net_card *
2065 spider_net_alloc_card(void)
2066 {
2067         struct net_device *netdev;
2068         struct spider_net_card *card;
2069         size_t alloc_size;
2070
2071         alloc_size = sizeof (*card) +
2072                 sizeof (struct spider_net_descr) * rx_descriptors +
2073                 sizeof (struct spider_net_descr) * tx_descriptors;
2074         netdev = alloc_etherdev(alloc_size);
2075         if (!netdev)
2076                 return NULL;
2077
2078         card = netdev_priv(netdev);
2079         card->netdev = netdev;
2080         card->msg_enable = SPIDER_NET_DEFAULT_MSG;
2081         INIT_WORK(&card->tx_timeout_task, spider_net_tx_timeout_task, netdev);
2082         init_waitqueue_head(&card->waitq);
2083         atomic_set(&card->tx_timeout_task_counter, 0);
2084
2085         return card;
2086 }
2087
2088 /**
2089  * spider_net_undo_pci_setup - releases PCI ressources
2090  * @card: card structure
2091  *
2092  * spider_net_undo_pci_setup releases the mapped regions
2093  */
2094 static void
2095 spider_net_undo_pci_setup(struct spider_net_card *card)
2096 {
2097         iounmap(card->regs);
2098         pci_release_regions(card->pdev);
2099 }
2100
2101 /**
2102  * spider_net_setup_pci_dev - sets up the device in terms of PCI operations
2103  * @card: card structure
2104  * @pdev: PCI device
2105  *
2106  * Returns the card structure or NULL if any errors occur
2107  *
2108  * spider_net_setup_pci_dev initializes pdev and together with the
2109  * functions called in spider_net_open configures the device so that
2110  * data can be transferred over it
2111  * The net_device structure is attached to the card structure, if the
2112  * function returns without error.
2113  **/
2114 static struct spider_net_card *
2115 spider_net_setup_pci_dev(struct pci_dev *pdev)
2116 {
2117         struct spider_net_card *card;
2118         unsigned long mmio_start, mmio_len;
2119
2120         if (pci_enable_device(pdev)) {
2121                 pr_err("Couldn't enable PCI device\n");
2122                 return NULL;
2123         }
2124
2125         if (!(pci_resource_flags(pdev, 0) & IORESOURCE_MEM)) {
2126                 pr_err("Couldn't find proper PCI device base address.\n");
2127                 goto out_disable_dev;
2128         }
2129
2130         if (pci_request_regions(pdev, spider_net_driver_name)) {
2131                 pr_err("Couldn't obtain PCI resources, aborting.\n");
2132                 goto out_disable_dev;
2133         }
2134
2135         pci_set_master(pdev);
2136
2137         card = spider_net_alloc_card();
2138         if (!card) {
2139                 pr_err("Couldn't allocate net_device structure, "
2140                           "aborting.\n");
2141                 goto out_release_regions;
2142         }
2143         card->pdev = pdev;
2144
2145         /* fetch base address and length of first resource */
2146         mmio_start = pci_resource_start(pdev, 0);
2147         mmio_len = pci_resource_len(pdev, 0);
2148
2149         card->netdev->mem_start = mmio_start;
2150         card->netdev->mem_end = mmio_start + mmio_len;
2151         card->regs = ioremap(mmio_start, mmio_len);
2152
2153         if (!card->regs) {
2154                 pr_err("Couldn't obtain PCI resources, aborting.\n");
2155                 goto out_release_regions;
2156         }
2157
2158         return card;
2159
2160 out_release_regions:
2161         pci_release_regions(pdev);
2162 out_disable_dev:
2163         pci_disable_device(pdev);
2164         pci_set_drvdata(pdev, NULL);
2165         return NULL;
2166 }
2167
2168 /**
2169  * spider_net_probe - initialization of a device
2170  * @pdev: PCI device
2171  * @ent: entry in the device id list
2172  *
2173  * Returns 0 on success, <0 on failure
2174  *
2175  * spider_net_probe initializes pdev and registers a net_device
2176  * structure for it. After that, the device can be ifconfig'ed up
2177  **/
2178 static int __devinit
2179 spider_net_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
2180 {
2181         int err = -EIO;
2182         struct spider_net_card *card;
2183
2184         card = spider_net_setup_pci_dev(pdev);
2185         if (!card)
2186                 goto out;
2187
2188         spider_net_workaround_rxramfull(card);
2189         spider_net_init_card(card);
2190
2191         err = spider_net_setup_phy(card);
2192         if (err)
2193                 goto out_undo_pci;
2194
2195         err = spider_net_init_firmware(card);
2196         if (err)
2197                 goto out_undo_pci;
2198
2199         err = spider_net_setup_netdev(card);
2200         if (err)
2201                 goto out_undo_pci;
2202
2203         return 0;
2204
2205 out_undo_pci:
2206         spider_net_undo_pci_setup(card);
2207         free_netdev(card->netdev);
2208 out:
2209         return err;
2210 }
2211
2212 /**
2213  * spider_net_remove - removal of a device
2214  * @pdev: PCI device
2215  *
2216  * Returns 0 on success, <0 on failure
2217  *
2218  * spider_net_remove is called to remove the device and unregisters the
2219  * net_device
2220  **/
2221 static void __devexit
2222 spider_net_remove(struct pci_dev *pdev)
2223 {
2224         struct net_device *netdev;
2225         struct spider_net_card *card;
2226
2227         netdev = pci_get_drvdata(pdev);
2228         card = netdev_priv(netdev);
2229
2230         wait_event(card->waitq,
2231                    atomic_read(&card->tx_timeout_task_counter) == 0);
2232
2233         unregister_netdev(netdev);
2234
2235         /* switch off card */
2236         spider_net_write_reg(card, SPIDER_NET_CKRCTRL,
2237                              SPIDER_NET_CKRCTRL_STOP_VALUE);
2238         spider_net_write_reg(card, SPIDER_NET_CKRCTRL,
2239                              SPIDER_NET_CKRCTRL_RUN_VALUE);
2240
2241         spider_net_undo_pci_setup(card);
2242         free_netdev(netdev);
2243 }
2244
2245 static struct pci_driver spider_net_driver = {
2246         .name           = spider_net_driver_name,
2247         .id_table       = spider_net_pci_tbl,
2248         .probe          = spider_net_probe,
2249         .remove         = __devexit_p(spider_net_remove)
2250 };
2251
2252 /**
2253  * spider_net_init - init function when the driver is loaded
2254  *
2255  * spider_net_init registers the device driver
2256  */
2257 static int __init spider_net_init(void)
2258 {
2259         printk(KERN_INFO "Spidernet version %s.\n", VERSION);
2260
2261         if (rx_descriptors < SPIDER_NET_RX_DESCRIPTORS_MIN) {
2262                 rx_descriptors = SPIDER_NET_RX_DESCRIPTORS_MIN;
2263                 pr_info("adjusting rx descriptors to %i.\n", rx_descriptors);
2264         }
2265         if (rx_descriptors > SPIDER_NET_RX_DESCRIPTORS_MAX) {
2266                 rx_descriptors = SPIDER_NET_RX_DESCRIPTORS_MAX;
2267                 pr_info("adjusting rx descriptors to %i.\n", rx_descriptors);
2268         }
2269         if (tx_descriptors < SPIDER_NET_TX_DESCRIPTORS_MIN) {
2270                 tx_descriptors = SPIDER_NET_TX_DESCRIPTORS_MIN;
2271                 pr_info("adjusting tx descriptors to %i.\n", tx_descriptors);
2272         }
2273         if (tx_descriptors > SPIDER_NET_TX_DESCRIPTORS_MAX) {
2274                 tx_descriptors = SPIDER_NET_TX_DESCRIPTORS_MAX;
2275                 pr_info("adjusting tx descriptors to %i.\n", tx_descriptors);
2276         }
2277
2278         return pci_register_driver(&spider_net_driver);
2279 }
2280
2281 /**
2282  * spider_net_cleanup - exit function when driver is unloaded
2283  *
2284  * spider_net_cleanup unregisters the device driver
2285  */
2286 static void __exit spider_net_cleanup(void)
2287 {
2288         pci_unregister_driver(&spider_net_driver);
2289 }
2290
2291 module_init(spider_net_init);
2292 module_exit(spider_net_cleanup);