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