drivers/net/spider_net.c

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