drivers/net/spider_net.c

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