2 * Network device driver for Cell Processor-Based Blade
4 * (C) Copyright IBM Corp. 2005
6 * Authors : Utz Bacher <utz.bacher@de.ibm.com>
7 * Jens Osterkamp <Jens.Osterkamp@de.ibm.com>
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)
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.
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.
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>
32 #include <linux/init.h>
33 #include <linux/ioport.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>
52 #include "spider_net.h"
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);
60 static int rx_descriptors = SPIDER_NET_RX_DESCRIPTORS_DEFAULT;
61 static int tx_descriptors = SPIDER_NET_TX_DESCRIPTORS_DEFAULT;
63 module_param(rx_descriptors, int, 0444);
64 module_param(tx_descriptors, int, 0444);
66 MODULE_PARM_DESC(rx_descriptors, "number of descriptors used " \
68 MODULE_PARM_DESC(tx_descriptors, "number of descriptors used " \
71 char spider_net_driver_name[] = "spidernet";
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 },
79 MODULE_DEVICE_TABLE(pci, spider_net_pci_tbl);
82 * spider_net_read_reg - reads an SMMIO register of a card
83 * @card: device structure
84 * @reg: register to read from
86 * returns the content of the specified SMMIO register.
89 spider_net_read_reg(struct spider_net_card *card, u32 reg)
93 value = readl(card->regs + reg);
94 value = le32_to_cpu(value);
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
106 spider_net_write_reg(struct spider_net_card *card, u32 reg, u32 value)
108 value = cpu_to_le32(value);
109 writel(value, card->regs + reg);
112 /** spider_net_write_phy - write to phy register
113 * @netdev: adapter to be written to
116 * @val: value to be written to phy register
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).
123 spider_net_write_phy(struct net_device *netdev, int mii_id,
126 struct spider_net_card *card = netdev_priv(netdev);
129 writevalue = ((u32)mii_id << 21) |
130 ((u32)reg << 16) | ((u32)val);
132 spider_net_write_reg(card, SPIDER_NET_GPCWOPCMD, writevalue);
135 /** spider_net_read_phy - read from phy register
136 * @netdev: network device to be read from
140 * Returns value read from PHY register
142 * spider_net_write_phy reads from an arbitrary PHY
143 * register via the spider GPCROPCMD register
146 spider_net_read_phy(struct net_device *netdev, int mii_id, int reg)
148 struct spider_net_card *card = netdev_priv(netdev);
151 readvalue = ((u32)mii_id << 21) | ((u32)reg << 16);
152 spider_net_write_reg(card, SPIDER_NET_GPCROPCMD, readvalue);
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 */
158 readvalue = spider_net_read_reg(card, SPIDER_NET_GPCROPCMD);
159 } while (readvalue & SPIDER_NET_GPREXEC);
161 readvalue &= SPIDER_NET_GPRDAT_MASK;
167 * spider_net_rx_irq_off - switch off rx irq on this spider card
168 * @card: device structure
170 * switches off rx irq by masking them out in the GHIINTnMSK register
173 spider_net_rx_irq_off(struct spider_net_card *card)
177 regvalue = SPIDER_NET_INT0_MASK_VALUE & (~SPIDER_NET_RXINT);
178 spider_net_write_reg(card, SPIDER_NET_GHIINT0MSK, regvalue);
182 * spider_net_rx_irq_on - switch on rx irq on this spider card
183 * @card: device structure
185 * switches on rx irq by enabling them in the GHIINTnMSK register
188 spider_net_rx_irq_on(struct spider_net_card *card)
192 regvalue = SPIDER_NET_INT0_MASK_VALUE | SPIDER_NET_RXINT;
193 spider_net_write_reg(card, SPIDER_NET_GHIINT0MSK, regvalue);
197 * spider_net_set_promisc - sets the unicast address or the promiscuous mode
198 * @card: card structure
200 * spider_net_set_promisc sets the unicast destination address filter and
201 * thus either allows for non-promisc mode or promisc mode
204 spider_net_set_promisc(struct spider_net_card *card)
207 struct net_device *netdev = card->netdev;
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);
216 macu = netdev->dev_addr[0];
218 macu |= netdev->dev_addr[1];
219 memcpy(&macl, &netdev->dev_addr[2], sizeof(macl));
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);
230 * spider_net_get_mac_address - read mac address from spider card
231 * @card: device structure
233 * reads MAC address from GMACUNIMACU and GMACUNIMACL registers
236 spider_net_get_mac_address(struct net_device *netdev)
238 struct spider_net_card *card = netdev_priv(netdev);
241 macl = spider_net_read_reg(card, SPIDER_NET_GMACUNIMACL);
242 macu = spider_net_read_reg(card, SPIDER_NET_GMACUNIMACU);
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;
251 if (!is_valid_ether_addr(&netdev->dev_addr[0]))
258 * spider_net_get_descr_status -- returns the status of a descriptor
259 * @descr: descriptor to look at
261 * returns the status as in the dmac_cmd_status field of the descriptor
264 spider_net_get_descr_status(struct spider_net_descr *descr)
266 return descr->dmac_cmd_status & SPIDER_NET_DESCR_IND_PROC_MASK;
270 * spider_net_free_chain - free descriptor chain
271 * @card: card structure
272 * @chain: address of chain
276 spider_net_free_chain(struct spider_net_card *card,
277 struct spider_net_descr_chain *chain)
279 struct spider_net_descr *descr;
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);
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
295 * we manage a circular list that mirrors the hardware structure,
296 * except that the hardware uses bus addresses.
298 * returns 0 on success, <0 on failure
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)
307 struct spider_net_descr *descr;
311 memset(descr, 0, sizeof(*descr) * no);
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;
317 buf = pci_map_single(card->pdev, descr,
318 SPIDER_NET_DESCR_SIZE,
321 if (pci_dma_mapping_error(buf))
324 descr->bus_addr = buf;
325 descr->next = descr + 1;
326 descr->prev = descr - 1;
329 /* do actual circular list */
330 (descr-1)->next = start_descr;
331 start_descr->prev = descr-1;
334 if (direction == PCI_DMA_FROMDEVICE)
335 for (i=0; i < no; i++, descr++)
336 descr->next_descr_addr = descr->next->bus_addr;
338 spin_lock_init(&chain->lock);
339 chain->head = start_descr;
340 chain->tail = start_descr;
346 for (i=0; i < no; i++, descr++)
348 pci_unmap_single(card->pdev, descr->bus_addr,
349 SPIDER_NET_DESCR_SIZE,
355 * spider_net_free_rx_chain_contents - frees descr contents in rx chain
356 * @card: card structure
358 * returns 0 on success, <0 on failure
361 spider_net_free_rx_chain_contents(struct spider_net_card *card)
363 struct spider_net_descr *descr;
365 descr = card->rx_chain.head;
366 while (descr->next != card->rx_chain.head) {
368 dev_kfree_skb(descr->skb);
369 pci_unmap_single(card->pdev, descr->buf_addr,
370 SPIDER_NET_MAX_FRAME,
378 * spider_net_prepare_rx_descr - reinitializes a rx descriptor
379 * @card: card structure
380 * @descr: descriptor to re-init
382 * return 0 on succes, <0 on failure
384 * allocates a new rx skb, iommu-maps it and attaches it to the descriptor.
385 * Activate the descriptor state-wise
388 spider_net_prepare_rx_descr(struct spider_net_card *card,
389 struct spider_net_descr *descr)
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));
400 /* and we need to have it 128 byte aligned, therefore we allocate a
402 /* allocate an skb */
403 descr->skb = dev_alloc_skb(bufsize + SPIDER_NET_RXBUF_ALIGN - 1);
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++;
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;
416 offset = ((unsigned long)descr->skb->data) &
417 (SPIDER_NET_RXBUF_ALIGN - 1);
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;
431 descr->dmac_cmd_status = SPIDER_NET_DESCR_CARDOWNED |
432 SPIDER_NET_DMAC_NOINTR_COMPLETE;
439 * spider_net_enable_rxchtails - sets RX dmac chain tail addresses
440 * @card: card structure
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.
447 spider_net_enable_rxchtails(struct spider_net_card *card)
449 /* assume chain is aligned correctly */
450 spider_net_write_reg(card, SPIDER_NET_GDADCHA ,
451 card->rx_chain.tail->bus_addr);
455 * spider_net_enable_rxdmac - enables a receive DMA controller
456 * @card: card structure
458 * spider_net_enable_rxdmac enables the DMA controller by setting RX_DMA_EN
459 * in the GDADMACCNTR register
462 spider_net_enable_rxdmac(struct spider_net_card *card)
465 spider_net_write_reg(card, SPIDER_NET_GDADMACCNTR,
466 SPIDER_NET_DMA_RX_VALUE);
470 * spider_net_refill_rx_chain - refills descriptors/skbs in the rx chains
471 * @card: card structure
473 * refills descriptors in the rx chain: allocates skbs and iommu-maps them.
476 spider_net_refill_rx_chain(struct spider_net_card *card)
478 struct spider_net_descr_chain *chain = &card->rx_chain;
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))
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))
492 chain->head = chain->head->next;
495 spin_unlock_irqrestore(&chain->lock, flags);
499 * spider_net_alloc_rx_skbs - allocates rx skbs in rx descriptor chains
500 * @card: card structure
502 * returns 0 on success, <0 on failure
505 spider_net_alloc_rx_skbs(struct spider_net_card *card)
508 struct spider_net_descr_chain *chain;
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))
519 chain->head = chain->head->next;
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);
528 spider_net_free_rx_chain_contents(card);
533 * spider_net_get_multicast_hash - generates hash for multicast filter table
534 * @addr: multicast address
536 * returns the hash value.
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
542 spider_net_get_multicast_hash(struct net_device *netdev, __u8 *addr)
546 char addr_for_crc[ETH_ALEN] = { 0, };
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));
554 crc = crc32_be(~0, addr_for_crc, netdev->addr_len);
565 * spider_net_set_multi - sets multicast addresses and promisc flags
566 * @netdev: interface device structure
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
573 spider_net_set_multi(struct net_device *netdev)
575 struct dev_mc_list *mc;
579 struct spider_net_card *card = netdev_priv(netdev);
580 unsigned long bitmask[SPIDER_NET_MULTICAST_HASHES / BITS_PER_LONG] =
583 spider_net_set_promisc(card);
585 if (netdev->flags & IFF_ALLMULTI) {
586 for (i = 0; i < SPIDER_NET_MULTICAST_HASHES; i++) {
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);
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);
602 for (i = 0; i < SPIDER_NET_MULTICAST_HASHES / 4; i++) {
604 if (test_bit(i * 4, bitmask))
607 if (test_bit(i * 4 + 1, bitmask))
610 if (test_bit(i * 4 + 2, bitmask))
613 if (test_bit(i * 4 + 3, bitmask))
616 spider_net_write_reg(card, SPIDER_NET_GMRMHFILnR + i * 4, reg);
621 * spider_net_disable_rxdmac - disables the receive DMA controller
622 * @card: card structure
624 * spider_net_disable_rxdmac terminates processing on the DMA controller by
625 * turing off DMA and issueing a force end
628 spider_net_disable_rxdmac(struct spider_net_card *card)
630 spider_net_write_reg(card, SPIDER_NET_GDADMACCNTR,
631 SPIDER_NET_DMA_RX_FEND_VALUE);
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
640 * returns 0 on success, <0 on failure.
642 * fills out the descriptor structure with skb data and len. Copies data,
643 * if needed (32bit DMA!)
646 spider_net_prepare_tx_descr(struct spider_net_card *card,
649 struct spider_net_descr *descr = card->tx_chain.head;
654 if (length < ETH_ZLEN) {
655 if (skb_pad(skb, ETH_ZLEN-length))
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++;
669 descr->buf_addr = buf;
670 descr->buf_size = length;
671 descr->next_descr_addr = 0;
673 descr->data_status = 0;
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) {
680 descr->dmac_cmd_status |= SPIDER_NET_DMAC_TCP;
683 descr->dmac_cmd_status |= SPIDER_NET_DMAC_UDP;
687 descr->prev->next_descr_addr = descr->bus_addr;
689 card->netdev->trans_start = jiffies; /* set netdev watchdog timer */
694 * spider_net_release_tx_descr - processes a used tx descriptor
695 * @card: card structure
696 * @descr: descriptor to release
698 * releases a used tx descriptor (unmapping, freeing of skb)
701 spider_net_release_tx_descr(struct spider_net_card *card)
703 struct spider_net_descr *descr = card->tx_chain.tail;
707 card->tx_chain.tail = card->tx_chain.tail->next;
708 descr->dmac_cmd_status |= SPIDER_NET_DESCR_NOT_IN_USE;
714 len = skb->len < ETH_ZLEN ? ETH_ZLEN : skb->len;
715 pci_unmap_single(card->pdev, descr->buf_addr, len,
717 dev_kfree_skb_any(skb);
721 * spider_net_release_tx_chain - processes sent tx descriptors
722 * @card: adapter structure
723 * @brutal: if set, don't care about whether descriptor seems to be in use
725 * returns 0 if the tx ring is empty, otherwise 1.
727 * spider_net_release_tx_chain releases the tx descriptors that spider has
728 * finished with (if non-brutal) or simply release tx descriptors (if brutal).
729 * If some other context is calling this function, we return 1 so that we're
730 * scheduled again (if we were scheduled) and will not loose initiative.
733 spider_net_release_tx_chain(struct spider_net_card *card, int brutal)
735 struct spider_net_descr_chain *chain = &card->tx_chain;
738 spider_net_read_reg(card, SPIDER_NET_GDTDMACCNTR);
740 while (chain->tail != chain->head) {
741 status = spider_net_get_descr_status(chain->tail);
743 case SPIDER_NET_DESCR_COMPLETE:
744 card->netdev_stats.tx_packets++;
745 card->netdev_stats.tx_bytes += chain->tail->skb->len;
748 case SPIDER_NET_DESCR_CARDOWNED:
751 /* fallthrough, if we release the descriptors
752 * brutally (then we don't care about
753 * SPIDER_NET_DESCR_CARDOWNED) */
755 case SPIDER_NET_DESCR_RESPONSE_ERROR:
756 case SPIDER_NET_DESCR_PROTECTION_ERROR:
757 case SPIDER_NET_DESCR_FORCE_END:
758 if (netif_msg_tx_err(card))
759 pr_err("%s: forcing end of tx descriptor "
760 "with status x%02x\n",
761 card->netdev->name, status);
762 card->netdev_stats.tx_errors++;
766 card->netdev_stats.tx_dropped++;
770 spider_net_release_tx_descr(card);
777 * spider_net_kick_tx_dma - enables TX DMA processing
778 * @card: card structure
779 * @descr: descriptor address to enable TX processing at
781 * spider_net_kick_tx_dma writes the current tx chain head as start address
782 * of the tx descriptor chain and enables the transmission DMA engine
785 spider_net_kick_tx_dma(struct spider_net_card *card)
787 struct spider_net_descr *descr;
789 if (spider_net_read_reg(card, SPIDER_NET_GDTDMACCNTR) &
790 SPIDER_NET_TX_DMA_EN)
793 descr = card->tx_chain.tail;
795 if (spider_net_get_descr_status(descr) ==
796 SPIDER_NET_DESCR_CARDOWNED) {
797 spider_net_write_reg(card, SPIDER_NET_GDTDCHA,
799 spider_net_write_reg(card, SPIDER_NET_GDTDMACCNTR,
800 SPIDER_NET_DMA_TX_VALUE);
803 if (descr == card->tx_chain.head)
809 mod_timer(&card->tx_timer, jiffies + SPIDER_NET_TX_TIMER);
813 * spider_net_xmit - transmits a frame over the device
814 * @skb: packet to send out
815 * @netdev: interface device structure
817 * returns 0 on success, !0 on failure
820 spider_net_xmit(struct sk_buff *skb, struct net_device *netdev)
822 struct spider_net_card *card = netdev_priv(netdev);
823 struct spider_net_descr_chain *chain = &card->tx_chain;
824 struct spider_net_descr *descr = chain->head;
827 spin_lock_irqsave(&chain->lock, flags);
829 spider_net_release_tx_chain(card, 0);
831 if ((chain->head->next == chain->tail->prev) ||
832 (spider_net_get_descr_status(descr) != SPIDER_NET_DESCR_NOT_IN_USE) ||
833 (spider_net_prepare_tx_descr(card, skb) != 0)) {
835 card->netdev_stats.tx_dropped++;
836 spin_unlock_irqrestore(&chain->lock, flags);
837 netif_stop_queue(netdev);
838 return NETDEV_TX_BUSY;
841 spider_net_kick_tx_dma(card);
842 card->tx_chain.head = card->tx_chain.head->next;
843 spin_unlock_irqrestore(&chain->lock, flags);
848 * spider_net_cleanup_tx_ring - cleans up the TX ring
849 * @card: card structure
851 * spider_net_cleanup_tx_ring is called by the tx_timer (as we don't use
852 * interrupts to cleanup our TX ring) and returns sent packets to the stack
856 spider_net_cleanup_tx_ring(struct spider_net_card *card)
860 spin_lock_irqsave(&card->tx_chain.lock, flags);
862 if ((spider_net_release_tx_chain(card, 0) != 0) &&
863 (card->netdev->flags & IFF_UP)) {
864 spider_net_kick_tx_dma(card);
865 netif_wake_queue(card->netdev);
867 spin_unlock_irqrestore(&card->tx_chain.lock, flags);
871 * spider_net_do_ioctl - called for device ioctls
872 * @netdev: interface device structure
873 * @ifr: request parameter structure for ioctl
874 * @cmd: command code for ioctl
876 * returns 0 on success, <0 on failure. Currently, we have no special ioctls.
877 * -EOPNOTSUPP is returned, if an unknown ioctl was requested
880 spider_net_do_ioctl(struct net_device *netdev, struct ifreq *ifr, int cmd)
889 * spider_net_pass_skb_up - takes an skb from a descriptor and passes it on
890 * @descr: descriptor to process
891 * @card: card structure
892 * @napi: whether caller is in NAPI context
894 * returns 1 on success, 0 if no packet was passed to the stack
896 * iommu-unmaps the skb, fills out skb structure and passes the data to the
897 * stack. The descriptor state is not changed.
900 spider_net_pass_skb_up(struct spider_net_descr *descr,
901 struct spider_net_card *card, int napi)
904 struct net_device *netdev;
905 u32 data_status, data_error;
907 data_status = descr->data_status;
908 data_error = descr->data_error;
910 netdev = card->netdev;
912 /* unmap descriptor */
913 pci_unmap_single(card->pdev, descr->buf_addr, SPIDER_NET_MAX_FRAME,
916 /* the cases we'll throw away the packet immediately */
917 if (data_error & SPIDER_NET_DESTROY_RX_FLAGS) {
918 if (netif_msg_rx_err(card))
919 pr_err("error in received descriptor found, "
920 "data_status=x%08x, data_error=x%08x\n",
921 data_status, data_error);
922 card->spider_stats.rx_desc_error++;
928 skb_put(skb, descr->valid_size);
930 /* the card seems to add 2 bytes of junk in front
931 * of the ethernet frame */
932 #define SPIDER_MISALIGN 2
933 skb_pull(skb, SPIDER_MISALIGN);
934 skb->protocol = eth_type_trans(skb, netdev);
936 /* checksum offload */
937 if (card->options.rx_csum) {
938 if ( ( (data_status & SPIDER_NET_DATA_STATUS_CKSUM_MASK) ==
939 SPIDER_NET_DATA_STATUS_CKSUM_MASK) &&
940 !(data_error & SPIDER_NET_DATA_ERR_CKSUM_MASK))
941 skb->ip_summed = CHECKSUM_UNNECESSARY;
943 skb->ip_summed = CHECKSUM_NONE;
945 skb->ip_summed = CHECKSUM_NONE;
947 if (data_status & SPIDER_NET_VLAN_PACKET) {
948 /* further enhancements: HW-accel VLAN
949 * vlan_hwaccel_receive_skb
953 /* pass skb up to stack */
955 netif_receive_skb(skb);
959 /* update netdevice statistics */
960 card->netdev_stats.rx_packets++;
961 card->netdev_stats.rx_bytes += skb->len;
967 * spider_net_decode_one_descr - processes an rx descriptor
968 * @card: card structure
969 * @napi: whether caller is in NAPI context
971 * returns 1 if a packet has been sent to the stack, otherwise 0
973 * processes an rx descriptor by iommu-unmapping the data buffer and passing
974 * the packet up to the stack. This function is called in softirq
975 * context, e.g. either bottom half from interrupt or NAPI polling context
978 spider_net_decode_one_descr(struct spider_net_card *card, int napi)
980 struct spider_net_descr_chain *chain = &card->rx_chain;
981 struct spider_net_descr *descr = chain->tail;
985 status = spider_net_get_descr_status(descr);
987 if (status == SPIDER_NET_DESCR_CARDOWNED) {
988 /* nothing in the descriptor yet */
993 if (status == SPIDER_NET_DESCR_NOT_IN_USE) {
994 /* not initialized yet, the ring must be empty */
995 spider_net_refill_rx_chain(card);
996 spider_net_enable_rxdmac(card);
1001 /* descriptor definitively used -- move on tail */
1002 chain->tail = descr->next;
1005 if ( (status == SPIDER_NET_DESCR_RESPONSE_ERROR) ||
1006 (status == SPIDER_NET_DESCR_PROTECTION_ERROR) ||
1007 (status == SPIDER_NET_DESCR_FORCE_END) ) {
1008 if (netif_msg_rx_err(card))
1009 pr_err("%s: dropping RX descriptor with state %d\n",
1010 card->netdev->name, status);
1011 card->netdev_stats.rx_dropped++;
1012 pci_unmap_single(card->pdev, descr->buf_addr,
1013 SPIDER_NET_MAX_FRAME, PCI_DMA_FROMDEVICE);
1014 dev_kfree_skb_irq(descr->skb);
1018 if ( (status != SPIDER_NET_DESCR_COMPLETE) &&
1019 (status != SPIDER_NET_DESCR_FRAME_END) ) {
1020 if (netif_msg_rx_err(card)) {
1021 pr_err("%s: RX descriptor with state %d\n",
1022 card->netdev->name, status);
1023 card->spider_stats.rx_desc_unk_state++;
1028 /* ok, we've got a packet in descr */
1029 result = spider_net_pass_skb_up(descr, card, napi);
1031 descr->dmac_cmd_status = SPIDER_NET_DESCR_NOT_IN_USE;
1032 /* change the descriptor state: */
1034 spider_net_refill_rx_chain(card);
1040 * spider_net_poll - NAPI poll function called by the stack to return packets
1041 * @netdev: interface device structure
1042 * @budget: number of packets we can pass to the stack at most
1044 * returns 0 if no more packets available to the driver/stack. Returns 1,
1045 * if the quota is exceeded, but the driver has still packets.
1047 * spider_net_poll returns all packets from the rx descriptors to the stack
1048 * (using netif_receive_skb). If all/enough packets are up, the driver
1049 * reenables interrupts and returns 0. If not, 1 is returned.
1052 spider_net_poll(struct net_device *netdev, int *budget)
1054 struct spider_net_card *card = netdev_priv(netdev);
1055 int packets_to_do, packets_done = 0;
1056 int no_more_packets = 0;
1058 packets_to_do = min(*budget, netdev->quota);
1060 while (packets_to_do) {
1061 if (spider_net_decode_one_descr(card, 1)) {
1065 /* no more packets for the stack */
1066 no_more_packets = 1;
1071 netdev->quota -= packets_done;
1072 *budget -= packets_done;
1073 spider_net_refill_rx_chain(card);
1075 /* if all packets are in the stack, enable interrupts and return 0 */
1076 /* if not, return 1 */
1077 if (no_more_packets) {
1078 netif_rx_complete(netdev);
1079 spider_net_rx_irq_on(card);
1087 * spider_net_vlan_rx_reg - initializes VLAN structures in the driver and card
1088 * @netdev: interface device structure
1089 * @grp: vlan_group structure that is registered (NULL on destroying interface)
1092 spider_net_vlan_rx_reg(struct net_device *netdev, struct vlan_group *grp)
1094 /* further enhancement... yet to do */
1099 * spider_net_vlan_rx_add - adds VLAN id to the card filter
1100 * @netdev: interface device structure
1101 * @vid: VLAN id to add
1104 spider_net_vlan_rx_add(struct net_device *netdev, uint16_t vid)
1106 /* further enhancement... yet to do */
1107 /* add vid to card's VLAN filter table */
1112 * spider_net_vlan_rx_kill - removes VLAN id to the card filter
1113 * @netdev: interface device structure
1114 * @vid: VLAN id to remove
1117 spider_net_vlan_rx_kill(struct net_device *netdev, uint16_t vid)
1119 /* further enhancement... yet to do */
1120 /* remove vid from card's VLAN filter table */
1124 * spider_net_get_stats - get interface statistics
1125 * @netdev: interface device structure
1127 * returns the interface statistics residing in the spider_net_card struct
1129 static struct net_device_stats *
1130 spider_net_get_stats(struct net_device *netdev)
1132 struct spider_net_card *card = netdev_priv(netdev);
1133 struct net_device_stats *stats = &card->netdev_stats;
1138 * spider_net_change_mtu - changes the MTU of an interface
1139 * @netdev: interface device structure
1140 * @new_mtu: new MTU value
1142 * returns 0 on success, <0 on failure
1145 spider_net_change_mtu(struct net_device *netdev, int new_mtu)
1147 /* no need to re-alloc skbs or so -- the max mtu is about 2.3k
1148 * and mtu is outbound only anyway */
1149 if ( (new_mtu < SPIDER_NET_MIN_MTU ) ||
1150 (new_mtu > SPIDER_NET_MAX_MTU) )
1152 netdev->mtu = new_mtu;
1157 * spider_net_set_mac - sets the MAC of an interface
1158 * @netdev: interface device structure
1159 * @ptr: pointer to new MAC address
1161 * Returns 0 on success, <0 on failure. Currently, we don't support this
1162 * and will always return EOPNOTSUPP.
1165 spider_net_set_mac(struct net_device *netdev, void *p)
1167 struct spider_net_card *card = netdev_priv(netdev);
1168 u32 macl, macu, regvalue;
1169 struct sockaddr *addr = p;
1171 if (!is_valid_ether_addr(addr->sa_data))
1172 return -EADDRNOTAVAIL;
1174 /* switch off GMACTPE and GMACRPE */
1175 regvalue = spider_net_read_reg(card, SPIDER_NET_GMACOPEMD);
1176 regvalue &= ~((1 << 5) | (1 << 6));
1177 spider_net_write_reg(card, SPIDER_NET_GMACOPEMD, regvalue);
1180 macu = (addr->sa_data[0]<<24) + (addr->sa_data[1]<<16) +
1181 (addr->sa_data[2]<<8) + (addr->sa_data[3]);
1182 macl = (addr->sa_data[4]<<8) + (addr->sa_data[5]);
1183 spider_net_write_reg(card, SPIDER_NET_GMACUNIMACU, macu);
1184 spider_net_write_reg(card, SPIDER_NET_GMACUNIMACL, macl);
1186 /* switch GMACTPE and GMACRPE back on */
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);
1191 spider_net_set_promisc(card);
1193 /* look up, whether we have been successful */
1194 if (spider_net_get_mac_address(netdev))
1195 return -EADDRNOTAVAIL;
1196 if (memcmp(netdev->dev_addr,addr->sa_data,netdev->addr_len))
1197 return -EADDRNOTAVAIL;
1203 * spider_net_handle_rxram_full - cleans up RX ring upon RX RAM full interrupt
1204 * @card: card structure
1206 * spider_net_handle_rxram_full empties the RX ring so that spider can put
1207 * more packets in it and empty its RX RAM. This is called in bottom half
1211 spider_net_handle_rxram_full(struct spider_net_card *card)
1213 while (spider_net_decode_one_descr(card, 0))
1215 spider_net_enable_rxchtails(card);
1216 spider_net_enable_rxdmac(card);
1217 netif_rx_schedule(card->netdev);
1221 * spider_net_handle_error_irq - handles errors raised by an interrupt
1222 * @card: card structure
1223 * @status_reg: interrupt status register 0 (GHIINT0STS)
1225 * spider_net_handle_error_irq treats or ignores all error conditions
1226 * found when an interrupt is presented
1229 spider_net_handle_error_irq(struct spider_net_card *card, u32 status_reg)
1231 u32 error_reg1, error_reg2;
1235 error_reg1 = spider_net_read_reg(card, SPIDER_NET_GHIINT1STS);
1236 error_reg2 = spider_net_read_reg(card, SPIDER_NET_GHIINT2STS);
1238 /* check GHIINT0STS ************************************/
1240 for (i = 0; i < 32; i++)
1241 if (status_reg & (1<<i))
1244 /* let error_reg1 and error_reg2 evaluation decide, what to do
1245 case SPIDER_NET_PHYINT:
1246 case SPIDER_NET_GMAC2INT:
1247 case SPIDER_NET_GMAC1INT:
1248 case SPIDER_NET_GFIFOINT:
1249 case SPIDER_NET_DMACINT:
1250 case SPIDER_NET_GSYSINT:
1253 case SPIDER_NET_GIPSINT:
1257 case SPIDER_NET_GPWOPCMPINT:
1258 /* PHY write operation completed */
1261 case SPIDER_NET_GPROPCMPINT:
1262 /* PHY read operation completed */
1263 /* we don't use semaphores, as we poll for the completion
1264 * of the read operation in spider_net_read_phy. Should take
1268 case SPIDER_NET_GPWFFINT:
1269 /* PHY command queue full */
1270 if (netif_msg_intr(card))
1271 pr_err("PHY write queue full\n");
1275 /* case SPIDER_NET_GRMDADRINT: not used. print a message */
1276 /* case SPIDER_NET_GRMARPINT: not used. print a message */
1277 /* case SPIDER_NET_GRMMPINT: not used. print a message */
1279 case SPIDER_NET_GDTDEN0INT:
1280 /* someone has set TX_DMA_EN to 0 */
1284 case SPIDER_NET_GDDDEN0INT: /* fallthrough */
1285 case SPIDER_NET_GDCDEN0INT: /* fallthrough */
1286 case SPIDER_NET_GDBDEN0INT: /* fallthrough */
1287 case SPIDER_NET_GDADEN0INT:
1288 /* someone has set RX_DMA_EN to 0 */
1293 case SPIDER_NET_GDDFDCINT:
1294 case SPIDER_NET_GDCFDCINT:
1295 case SPIDER_NET_GDBFDCINT:
1296 case SPIDER_NET_GDAFDCINT:
1297 /* case SPIDER_NET_GDNMINT: not used. print a message */
1298 /* case SPIDER_NET_GCNMINT: not used. print a message */
1299 /* case SPIDER_NET_GBNMINT: not used. print a message */
1300 /* case SPIDER_NET_GANMINT: not used. print a message */
1301 /* case SPIDER_NET_GRFNMINT: not used. print a message */
1306 case SPIDER_NET_GDTFDCINT:
1309 case SPIDER_NET_GTTEDINT:
1312 case SPIDER_NET_GDTDCEINT:
1313 /* chain end. If a descriptor should be sent, kick off
1315 if (card->tx_chain.tail != card->tx_chain.head)
1316 spider_net_kick_tx_dma(card);
1321 /* case SPIDER_NET_G1TMCNTINT: not used. print a message */
1322 /* case SPIDER_NET_GFREECNTINT: not used. print a message */
1325 /* check GHIINT1STS ************************************/
1327 for (i = 0; i < 32; i++)
1328 if (error_reg1 & (1<<i))
1331 case SPIDER_NET_GTMFLLINT:
1332 if (netif_msg_intr(card) && net_ratelimit())
1333 pr_err("Spider TX RAM full\n");
1336 case SPIDER_NET_GRFDFLLINT: /* fallthrough */
1337 case SPIDER_NET_GRFCFLLINT: /* fallthrough */
1338 case SPIDER_NET_GRFBFLLINT: /* fallthrough */
1339 case SPIDER_NET_GRFAFLLINT: /* fallthrough */
1340 case SPIDER_NET_GRMFLLINT:
1341 if (netif_msg_intr(card) && net_ratelimit())
1342 pr_debug("Spider RX RAM full, incoming packets "
1343 "might be discarded!\n");
1344 spider_net_rx_irq_off(card);
1345 tasklet_schedule(&card->rxram_full_tl);
1349 /* case SPIDER_NET_GTMSHTINT: problem, print a message */
1350 case SPIDER_NET_GDTINVDINT:
1351 /* allrighty. tx from previous descr ok */
1356 case SPIDER_NET_GDDDCEINT: /* fallthrough */
1357 case SPIDER_NET_GDCDCEINT: /* fallthrough */
1358 case SPIDER_NET_GDBDCEINT: /* fallthrough */
1359 case SPIDER_NET_GDADCEINT:
1360 if (netif_msg_intr(card))
1361 pr_err("got descriptor chain end interrupt, "
1362 "restarting DMAC %c.\n",
1363 'D'-(i-SPIDER_NET_GDDDCEINT)/3);
1364 spider_net_refill_rx_chain(card);
1365 spider_net_enable_rxdmac(card);
1369 /* invalid descriptor */
1370 case SPIDER_NET_GDDINVDINT: /* fallthrough */
1371 case SPIDER_NET_GDCINVDINT: /* fallthrough */
1372 case SPIDER_NET_GDBINVDINT: /* fallthrough */
1373 case SPIDER_NET_GDAINVDINT:
1374 /* could happen when rx chain is full */
1375 spider_net_refill_rx_chain(card);
1376 spider_net_enable_rxdmac(card);
1380 /* case SPIDER_NET_GDTRSERINT: problem, print a message */
1381 /* case SPIDER_NET_GDDRSERINT: problem, print a message */
1382 /* case SPIDER_NET_GDCRSERINT: problem, print a message */
1383 /* case SPIDER_NET_GDBRSERINT: problem, print a message */
1384 /* case SPIDER_NET_GDARSERINT: problem, print a message */
1385 /* case SPIDER_NET_GDSERINT: problem, print a message */
1386 /* case SPIDER_NET_GDTPTERINT: problem, print a message */
1387 /* case SPIDER_NET_GDDPTERINT: problem, print a message */
1388 /* case SPIDER_NET_GDCPTERINT: problem, print a message */
1389 /* case SPIDER_NET_GDBPTERINT: problem, print a message */
1390 /* case SPIDER_NET_GDAPTERINT: problem, print a message */
1396 /* check GHIINT2STS ************************************/
1398 for (i = 0; i < 32; i++)
1399 if (error_reg2 & (1<<i))
1402 /* there is nothing we can (want to) do at this time. Log a
1403 * message, we can switch on and off the specific values later on
1404 case SPIDER_NET_GPROPERINT:
1405 case SPIDER_NET_GMCTCRSNGINT:
1406 case SPIDER_NET_GMCTLCOLINT:
1407 case SPIDER_NET_GMCTTMOTINT:
1408 case SPIDER_NET_GMCRCAERINT:
1409 case SPIDER_NET_GMCRCALERINT:
1410 case SPIDER_NET_GMCRALNERINT:
1411 case SPIDER_NET_GMCROVRINT:
1412 case SPIDER_NET_GMCRRNTINT:
1413 case SPIDER_NET_GMCRRXERINT:
1414 case SPIDER_NET_GTITCSERINT:
1415 case SPIDER_NET_GTIFMTERINT:
1416 case SPIDER_NET_GTIPKTRVKINT:
1417 case SPIDER_NET_GTISPINGINT:
1418 case SPIDER_NET_GTISADNGINT:
1419 case SPIDER_NET_GTISPDNGINT:
1420 case SPIDER_NET_GRIFMTERINT:
1421 case SPIDER_NET_GRIPKTRVKINT:
1422 case SPIDER_NET_GRISPINGINT:
1423 case SPIDER_NET_GRISADNGINT:
1424 case SPIDER_NET_GRISPDNGINT:
1431 if ((show_error) && (netif_msg_intr(card)))
1432 pr_err("Got error interrupt on %s, GHIINT0STS = 0x%08x, "
1433 "GHIINT1STS = 0x%08x, GHIINT2STS = 0x%08x\n",
1435 status_reg, error_reg1, error_reg2);
1437 /* clear interrupt sources */
1438 spider_net_write_reg(card, SPIDER_NET_GHIINT1STS, error_reg1);
1439 spider_net_write_reg(card, SPIDER_NET_GHIINT2STS, error_reg2);
1443 * spider_net_interrupt - interrupt handler for spider_net
1444 * @irq: interupt number
1445 * @ptr: pointer to net_device
1446 * @regs: PU registers
1448 * returns IRQ_HANDLED, if interrupt was for driver, or IRQ_NONE, if no
1449 * interrupt found raised by card.
1451 * This is the interrupt handler, that turns off
1452 * interrupts for this device and makes the stack poll the driver
1455 spider_net_interrupt(int irq, void *ptr)
1457 struct net_device *netdev = ptr;
1458 struct spider_net_card *card = netdev_priv(netdev);
1461 status_reg = spider_net_read_reg(card, SPIDER_NET_GHIINT0STS);
1466 if (status_reg & SPIDER_NET_RXINT ) {
1467 spider_net_rx_irq_off(card);
1468 netif_rx_schedule(netdev);
1471 if (status_reg & SPIDER_NET_ERRINT )
1472 spider_net_handle_error_irq(card, status_reg);
1474 /* clear interrupt sources */
1475 spider_net_write_reg(card, SPIDER_NET_GHIINT0STS, status_reg);
1480 #ifdef CONFIG_NET_POLL_CONTROLLER
1482 * spider_net_poll_controller - artificial interrupt for netconsole etc.
1483 * @netdev: interface device structure
1485 * see Documentation/networking/netconsole.txt
1488 spider_net_poll_controller(struct net_device *netdev)
1490 disable_irq(netdev->irq);
1491 spider_net_interrupt(netdev->irq, netdev);
1492 enable_irq(netdev->irq);
1494 #endif /* CONFIG_NET_POLL_CONTROLLER */
1497 * spider_net_init_card - initializes the card
1498 * @card: card structure
1500 * spider_net_init_card initializes the card so that other registers can
1504 spider_net_init_card(struct spider_net_card *card)
1506 spider_net_write_reg(card, SPIDER_NET_CKRCTRL,
1507 SPIDER_NET_CKRCTRL_STOP_VALUE);
1509 spider_net_write_reg(card, SPIDER_NET_CKRCTRL,
1510 SPIDER_NET_CKRCTRL_RUN_VALUE);
1514 * spider_net_enable_card - enables the card by setting all kinds of regs
1515 * @card: card structure
1517 * spider_net_enable_card sets a lot of SMMIO registers to enable the device
1520 spider_net_enable_card(struct spider_net_card *card)
1523 /* the following array consists of (register),(value) pairs
1524 * that are set in this function. A register of 0 ends the list */
1526 { SPIDER_NET_GRESUMINTNUM, 0 },
1527 { SPIDER_NET_GREINTNUM, 0 },
1529 /* set interrupt frame number registers */
1530 /* clear the single DMA engine registers first */
1531 { SPIDER_NET_GFAFRMNUM, SPIDER_NET_GFXFRAMES_VALUE },
1532 { SPIDER_NET_GFBFRMNUM, SPIDER_NET_GFXFRAMES_VALUE },
1533 { SPIDER_NET_GFCFRMNUM, SPIDER_NET_GFXFRAMES_VALUE },
1534 { SPIDER_NET_GFDFRMNUM, SPIDER_NET_GFXFRAMES_VALUE },
1535 /* then set, what we really need */
1536 { SPIDER_NET_GFFRMNUM, SPIDER_NET_FRAMENUM_VALUE },
1538 /* timer counter registers and stuff */
1539 { SPIDER_NET_GFREECNNUM, 0 },
1540 { SPIDER_NET_GONETIMENUM, 0 },
1541 { SPIDER_NET_GTOUTFRMNUM, 0 },
1543 /* RX mode setting */
1544 { SPIDER_NET_GRXMDSET, SPIDER_NET_RXMODE_VALUE },
1545 /* TX mode setting */
1546 { SPIDER_NET_GTXMDSET, SPIDER_NET_TXMODE_VALUE },
1547 /* IPSEC mode setting */
1548 { SPIDER_NET_GIPSECINIT, SPIDER_NET_IPSECINIT_VALUE },
1550 { SPIDER_NET_GFTRESTRT, SPIDER_NET_RESTART_VALUE },
1552 { SPIDER_NET_GMRWOLCTRL, 0 },
1553 { SPIDER_NET_GTESTMD, 0x10000000 },
1554 { SPIDER_NET_GTTQMSK, 0x00400040 },
1556 { SPIDER_NET_GMACINTEN, 0 },
1558 /* flow control stuff */
1559 { SPIDER_NET_GMACAPAUSE, SPIDER_NET_MACAPAUSE_VALUE },
1560 { SPIDER_NET_GMACTXPAUSE, SPIDER_NET_TXPAUSE_VALUE },
1562 { SPIDER_NET_GMACBSTLMT, SPIDER_NET_BURSTLMT_VALUE },
1567 while (regs[i][0]) {
1568 spider_net_write_reg(card, regs[i][0], regs[i][1]);
1572 /* clear unicast filter table entries 1 to 14 */
1573 for (i = 1; i <= 14; i++) {
1574 spider_net_write_reg(card,
1575 SPIDER_NET_GMRUAFILnR + i * 8,
1577 spider_net_write_reg(card,
1578 SPIDER_NET_GMRUAFILnR + i * 8 + 4,
1582 spider_net_write_reg(card, SPIDER_NET_GMRUA0FIL15R, 0x08080000);
1584 spider_net_write_reg(card, SPIDER_NET_ECMODE, SPIDER_NET_ECMODE_VALUE);
1586 /* set chain tail adress for RX chains and
1588 spider_net_enable_rxchtails(card);
1589 spider_net_enable_rxdmac(card);
1591 spider_net_write_reg(card, SPIDER_NET_GRXDMAEN, SPIDER_NET_WOL_VALUE);
1593 spider_net_write_reg(card, SPIDER_NET_GMACLENLMT,
1594 SPIDER_NET_LENLMT_VALUE);
1595 spider_net_write_reg(card, SPIDER_NET_GMACMODE,
1596 SPIDER_NET_MACMODE_VALUE);
1597 spider_net_write_reg(card, SPIDER_NET_GMACOPEMD,
1598 SPIDER_NET_OPMODE_VALUE);
1600 /* set interrupt mask registers */
1601 spider_net_write_reg(card, SPIDER_NET_GHIINT0MSK,
1602 SPIDER_NET_INT0_MASK_VALUE);
1603 spider_net_write_reg(card, SPIDER_NET_GHIINT1MSK,
1604 SPIDER_NET_INT1_MASK_VALUE);
1605 spider_net_write_reg(card, SPIDER_NET_GHIINT2MSK,
1606 SPIDER_NET_INT2_MASK_VALUE);
1608 spider_net_write_reg(card, SPIDER_NET_GDTDMACCNTR,
1609 SPIDER_NET_GDTBSTA | SPIDER_NET_GDTDCEIDIS);
1613 * spider_net_open - called upon ifonfig up
1614 * @netdev: interface device structure
1616 * returns 0 on success, <0 on failure
1618 * spider_net_open allocates all the descriptors and memory needed for
1619 * operation, sets up multicast list and enables interrupts
1622 spider_net_open(struct net_device *netdev)
1624 struct spider_net_card *card = netdev_priv(netdev);
1628 if (spider_net_init_chain(card, &card->tx_chain, card->descr,
1629 PCI_DMA_TODEVICE, card->tx_desc))
1630 goto alloc_tx_failed;
1631 if (spider_net_init_chain(card, &card->rx_chain,
1632 card->descr + card->rx_desc,
1633 PCI_DMA_FROMDEVICE, card->rx_desc))
1634 goto alloc_rx_failed;
1636 /* allocate rx skbs */
1637 if (spider_net_alloc_rx_skbs(card))
1638 goto alloc_skbs_failed;
1640 spider_net_set_multi(netdev);
1642 /* further enhancement: setup hw vlan, if needed */
1645 if (request_irq(netdev->irq, spider_net_interrupt,
1646 IRQF_SHARED, netdev->name, netdev))
1647 goto register_int_failed;
1649 spider_net_enable_card(card);
1651 netif_start_queue(netdev);
1652 netif_carrier_on(netdev);
1653 netif_poll_enable(netdev);
1657 register_int_failed:
1658 spider_net_free_rx_chain_contents(card);
1660 spider_net_free_chain(card, &card->rx_chain);
1662 spider_net_free_chain(card, &card->tx_chain);
1668 * spider_net_setup_phy - setup PHY
1669 * @card: card structure
1671 * returns 0 on success, <0 on failure
1673 * spider_net_setup_phy is used as part of spider_net_probe. Sets
1674 * the PHY to 1000 Mbps
1677 spider_net_setup_phy(struct spider_net_card *card)
1679 struct mii_phy *phy = &card->phy;
1681 spider_net_write_reg(card, SPIDER_NET_GDTDMASEL,
1682 SPIDER_NET_DMASEL_VALUE);
1683 spider_net_write_reg(card, SPIDER_NET_GPCCTRL,
1684 SPIDER_NET_PHY_CTRL_VALUE);
1686 phy->dev = card->netdev;
1687 phy->mdio_read = spider_net_read_phy;
1688 phy->mdio_write = spider_net_write_phy;
1690 mii_phy_probe(phy, phy->mii_id);
1692 if (phy->def->ops->setup_forced)
1693 phy->def->ops->setup_forced(phy, SPEED_1000, DUPLEX_FULL);
1695 phy->def->ops->enable_fiber(phy);
1697 phy->def->ops->read_link(phy);
1698 pr_info("Found %s with %i Mbps, %s-duplex.\n", phy->def->name,
1699 phy->speed, phy->duplex==1 ? "Full" : "Half");
1705 * spider_net_download_firmware - loads firmware into the adapter
1706 * @card: card structure
1707 * @firmware_ptr: pointer to firmware data
1709 * spider_net_download_firmware loads the firmware data into the
1710 * adapter. It assumes the length etc. to be allright.
1713 spider_net_download_firmware(struct spider_net_card *card,
1714 const void *firmware_ptr)
1717 const u32 *fw_ptr = firmware_ptr;
1719 /* stop sequencers */
1720 spider_net_write_reg(card, SPIDER_NET_GSINIT,
1721 SPIDER_NET_STOP_SEQ_VALUE);
1723 for (sequencer = 0; sequencer < SPIDER_NET_FIRMWARE_SEQS;
1725 spider_net_write_reg(card,
1726 SPIDER_NET_GSnPRGADR + sequencer * 8, 0);
1727 for (i = 0; i < SPIDER_NET_FIRMWARE_SEQWORDS; i++) {
1728 spider_net_write_reg(card, SPIDER_NET_GSnPRGDAT +
1729 sequencer * 8, *fw_ptr);
1734 if (spider_net_read_reg(card, SPIDER_NET_GSINIT))
1737 spider_net_write_reg(card, SPIDER_NET_GSINIT,
1738 SPIDER_NET_RUN_SEQ_VALUE);
1744 * spider_net_init_firmware - reads in firmware parts
1745 * @card: card structure
1747 * Returns 0 on success, <0 on failure
1749 * spider_net_init_firmware opens the sequencer firmware and does some basic
1750 * checks. This function opens and releases the firmware structure. A call
1751 * to download the firmware is performed before the release.
1755 * spider_fw.bin is expected to be a file containing 6*1024*4 bytes, 4k being
1756 * the program for each sequencer. Use the command
1757 * tail -q -n +2 Seq_code1_0x088.txt Seq_code2_0x090.txt \
1758 * Seq_code3_0x098.txt Seq_code4_0x0A0.txt Seq_code5_0x0A8.txt \
1759 * Seq_code6_0x0B0.txt | xxd -r -p -c4 > spider_fw.bin
1761 * to generate spider_fw.bin, if you have sequencer programs with something
1762 * like the following contents for each sequencer:
1763 * <ONE LINE COMMENT>
1764 * <FIRST 4-BYTES-WORD FOR SEQUENCER>
1765 * <SECOND 4-BYTES-WORD FOR SEQUENCER>
1767 * <1024th 4-BYTES-WORD FOR SEQUENCER>
1770 spider_net_init_firmware(struct spider_net_card *card)
1772 struct firmware *firmware = NULL;
1773 struct device_node *dn;
1774 const u8 *fw_prop = NULL;
1778 if (request_firmware((const struct firmware **)&firmware,
1779 SPIDER_NET_FIRMWARE_NAME, &card->pdev->dev) == 0) {
1780 if ( (firmware->size != SPIDER_NET_FIRMWARE_LEN) &&
1781 netif_msg_probe(card) ) {
1782 pr_err("Incorrect size of spidernet firmware in " \
1783 "filesystem. Looking in host firmware...\n");
1786 err = spider_net_download_firmware(card, firmware->data);
1788 release_firmware(firmware);
1796 dn = pci_device_to_OF_node(card->pdev);
1800 fw_prop = get_property(dn, "firmware", &fw_size);
1804 if ( (fw_size != SPIDER_NET_FIRMWARE_LEN) &&
1805 netif_msg_probe(card) ) {
1806 pr_err("Incorrect size of spidernet firmware in " \
1811 err = spider_net_download_firmware(card, fw_prop);
1816 if (netif_msg_probe(card))
1817 pr_err("Couldn't find spidernet firmware in filesystem " \
1818 "or host firmware\n");
1823 * spider_net_workaround_rxramfull - work around firmware bug
1824 * @card: card structure
1829 spider_net_workaround_rxramfull(struct spider_net_card *card)
1831 int i, sequencer = 0;
1834 spider_net_write_reg(card, SPIDER_NET_CKRCTRL,
1835 SPIDER_NET_CKRCTRL_RUN_VALUE);
1837 /* empty sequencer data */
1838 for (sequencer = 0; sequencer < SPIDER_NET_FIRMWARE_SEQS;
1840 spider_net_write_reg(card, SPIDER_NET_GSnPRGADR +
1841 sequencer * 8, 0x0);
1842 for (i = 0; i < SPIDER_NET_FIRMWARE_SEQWORDS; i++) {
1843 spider_net_write_reg(card, SPIDER_NET_GSnPRGDAT +
1844 sequencer * 8, 0x0);
1848 /* set sequencer operation */
1849 spider_net_write_reg(card, SPIDER_NET_GSINIT, 0x000000fe);
1852 spider_net_write_reg(card, SPIDER_NET_CKRCTRL,
1853 SPIDER_NET_CKRCTRL_STOP_VALUE);
1857 * spider_net_stop - called upon ifconfig down
1858 * @netdev: interface device structure
1863 spider_net_stop(struct net_device *netdev)
1865 struct spider_net_card *card = netdev_priv(netdev);
1867 tasklet_kill(&card->rxram_full_tl);
1868 netif_poll_disable(netdev);
1869 netif_carrier_off(netdev);
1870 netif_stop_queue(netdev);
1871 del_timer_sync(&card->tx_timer);
1873 /* disable/mask all interrupts */
1874 spider_net_write_reg(card, SPIDER_NET_GHIINT0MSK, 0);
1875 spider_net_write_reg(card, SPIDER_NET_GHIINT1MSK, 0);
1876 spider_net_write_reg(card, SPIDER_NET_GHIINT2MSK, 0);
1878 /* free_irq(netdev->irq, netdev);*/
1879 free_irq(to_pci_dev(netdev->class_dev.dev)->irq, netdev);
1881 spider_net_write_reg(card, SPIDER_NET_GDTDMACCNTR,
1882 SPIDER_NET_DMA_TX_FEND_VALUE);
1884 /* turn off DMA, force end */
1885 spider_net_disable_rxdmac(card);
1887 /* release chains */
1888 if (spin_trylock(&card->tx_chain.lock)) {
1889 spider_net_release_tx_chain(card, 1);
1890 spin_unlock(&card->tx_chain.lock);
1893 spider_net_free_chain(card, &card->tx_chain);
1894 spider_net_free_chain(card, &card->rx_chain);
1900 * spider_net_tx_timeout_task - task scheduled by the watchdog timeout
1901 * function (to be called not under interrupt status)
1902 * @data: data, is interface device structure
1904 * called as task when tx hangs, resets interface (if interface is up)
1907 spider_net_tx_timeout_task(void *data)
1909 struct net_device *netdev = data;
1910 struct spider_net_card *card = netdev_priv(netdev);
1912 if (!(netdev->flags & IFF_UP))
1915 netif_device_detach(netdev);
1916 spider_net_stop(netdev);
1918 spider_net_workaround_rxramfull(card);
1919 spider_net_init_card(card);
1921 if (spider_net_setup_phy(card))
1923 if (spider_net_init_firmware(card))
1926 spider_net_open(netdev);
1927 spider_net_kick_tx_dma(card);
1928 netif_device_attach(netdev);
1931 atomic_dec(&card->tx_timeout_task_counter);
1935 * spider_net_tx_timeout - called when the tx timeout watchdog kicks in.
1936 * @netdev: interface device structure
1938 * called, if tx hangs. Schedules a task that resets the interface
1941 spider_net_tx_timeout(struct net_device *netdev)
1943 struct spider_net_card *card;
1945 card = netdev_priv(netdev);
1946 atomic_inc(&card->tx_timeout_task_counter);
1947 if (netdev->flags & IFF_UP)
1948 schedule_work(&card->tx_timeout_task);
1950 atomic_dec(&card->tx_timeout_task_counter);
1951 card->spider_stats.tx_timeouts++;
1955 * spider_net_setup_netdev_ops - initialization of net_device operations
1956 * @netdev: net_device structure
1958 * fills out function pointers in the net_device structure
1961 spider_net_setup_netdev_ops(struct net_device *netdev)
1963 netdev->open = &spider_net_open;
1964 netdev->stop = &spider_net_stop;
1965 netdev->hard_start_xmit = &spider_net_xmit;
1966 netdev->get_stats = &spider_net_get_stats;
1967 netdev->set_multicast_list = &spider_net_set_multi;
1968 netdev->set_mac_address = &spider_net_set_mac;
1969 netdev->change_mtu = &spider_net_change_mtu;
1970 netdev->do_ioctl = &spider_net_do_ioctl;
1972 netdev->tx_timeout = &spider_net_tx_timeout;
1973 netdev->watchdog_timeo = SPIDER_NET_WATCHDOG_TIMEOUT;
1975 netdev->poll = &spider_net_poll;
1976 netdev->weight = SPIDER_NET_NAPI_WEIGHT;
1978 netdev->vlan_rx_register = &spider_net_vlan_rx_reg;
1979 netdev->vlan_rx_add_vid = &spider_net_vlan_rx_add;
1980 netdev->vlan_rx_kill_vid = &spider_net_vlan_rx_kill;
1981 #ifdef CONFIG_NET_POLL_CONTROLLER
1982 /* poll controller */
1983 netdev->poll_controller = &spider_net_poll_controller;
1984 #endif /* CONFIG_NET_POLL_CONTROLLER */
1986 netdev->ethtool_ops = &spider_net_ethtool_ops;
1990 * spider_net_setup_netdev - initialization of net_device
1991 * @card: card structure
1993 * Returns 0 on success or <0 on failure
1995 * spider_net_setup_netdev initializes the net_device structure
1998 spider_net_setup_netdev(struct spider_net_card *card)
2001 struct net_device *netdev = card->netdev;
2002 struct device_node *dn;
2003 struct sockaddr addr;
2006 SET_MODULE_OWNER(netdev);
2007 SET_NETDEV_DEV(netdev, &card->pdev->dev);
2009 pci_set_drvdata(card->pdev, netdev);
2011 card->rxram_full_tl.data = (unsigned long) card;
2012 card->rxram_full_tl.func =
2013 (void (*)(unsigned long)) spider_net_handle_rxram_full;
2014 init_timer(&card->tx_timer);
2015 card->tx_timer.function =
2016 (void (*)(unsigned long)) spider_net_cleanup_tx_ring;
2017 card->tx_timer.data = (unsigned long) card;
2018 netdev->irq = card->pdev->irq;
2020 card->options.rx_csum = SPIDER_NET_RX_CSUM_DEFAULT;
2022 card->tx_desc = tx_descriptors;
2023 card->rx_desc = rx_descriptors;
2025 spider_net_setup_netdev_ops(netdev);
2027 netdev->features = NETIF_F_HW_CSUM | NETIF_F_LLTX;
2028 /* some time: NETIF_F_HW_VLAN_TX | NETIF_F_HW_VLAN_RX |
2029 * NETIF_F_HW_VLAN_FILTER */
2031 netdev->irq = card->pdev->irq;
2033 dn = pci_device_to_OF_node(card->pdev);
2037 mac = get_property(dn, "local-mac-address", NULL);
2040 memcpy(addr.sa_data, mac, ETH_ALEN);
2042 result = spider_net_set_mac(netdev, &addr);
2043 if ((result) && (netif_msg_probe(card)))
2044 pr_err("Failed to set MAC address: %i\n", result);
2046 result = register_netdev(netdev);
2048 if (netif_msg_probe(card))
2049 pr_err("Couldn't register net_device: %i\n",
2054 if (netif_msg_probe(card))
2055 pr_info("Initialized device %s.\n", netdev->name);
2061 * spider_net_alloc_card - allocates net_device and card structure
2063 * returns the card structure or NULL in case of errors
2065 * the card and net_device structures are linked to each other
2067 static struct spider_net_card *
2068 spider_net_alloc_card(void)
2070 struct net_device *netdev;
2071 struct spider_net_card *card;
2074 alloc_size = sizeof (*card) +
2075 sizeof (struct spider_net_descr) * rx_descriptors +
2076 sizeof (struct spider_net_descr) * tx_descriptors;
2077 netdev = alloc_etherdev(alloc_size);
2081 card = netdev_priv(netdev);
2082 card->netdev = netdev;
2083 card->msg_enable = SPIDER_NET_DEFAULT_MSG;
2084 INIT_WORK(&card->tx_timeout_task, spider_net_tx_timeout_task, netdev);
2085 init_waitqueue_head(&card->waitq);
2086 atomic_set(&card->tx_timeout_task_counter, 0);
2092 * spider_net_undo_pci_setup - releases PCI ressources
2093 * @card: card structure
2095 * spider_net_undo_pci_setup releases the mapped regions
2098 spider_net_undo_pci_setup(struct spider_net_card *card)
2100 iounmap(card->regs);
2101 pci_release_regions(card->pdev);
2105 * spider_net_setup_pci_dev - sets up the device in terms of PCI operations
2106 * @card: card structure
2109 * Returns the card structure or NULL if any errors occur
2111 * spider_net_setup_pci_dev initializes pdev and together with the
2112 * functions called in spider_net_open configures the device so that
2113 * data can be transferred over it
2114 * The net_device structure is attached to the card structure, if the
2115 * function returns without error.
2117 static struct spider_net_card *
2118 spider_net_setup_pci_dev(struct pci_dev *pdev)
2120 struct spider_net_card *card;
2121 unsigned long mmio_start, mmio_len;
2123 if (pci_enable_device(pdev)) {
2124 pr_err("Couldn't enable PCI device\n");
2128 if (!(pci_resource_flags(pdev, 0) & IORESOURCE_MEM)) {
2129 pr_err("Couldn't find proper PCI device base address.\n");
2130 goto out_disable_dev;
2133 if (pci_request_regions(pdev, spider_net_driver_name)) {
2134 pr_err("Couldn't obtain PCI resources, aborting.\n");
2135 goto out_disable_dev;
2138 pci_set_master(pdev);
2140 card = spider_net_alloc_card();
2142 pr_err("Couldn't allocate net_device structure, "
2144 goto out_release_regions;
2148 /* fetch base address and length of first resource */
2149 mmio_start = pci_resource_start(pdev, 0);
2150 mmio_len = pci_resource_len(pdev, 0);
2152 card->netdev->mem_start = mmio_start;
2153 card->netdev->mem_end = mmio_start + mmio_len;
2154 card->regs = ioremap(mmio_start, mmio_len);
2157 pr_err("Couldn't obtain PCI resources, aborting.\n");
2158 goto out_release_regions;
2163 out_release_regions:
2164 pci_release_regions(pdev);
2166 pci_disable_device(pdev);
2167 pci_set_drvdata(pdev, NULL);
2172 * spider_net_probe - initialization of a device
2174 * @ent: entry in the device id list
2176 * Returns 0 on success, <0 on failure
2178 * spider_net_probe initializes pdev and registers a net_device
2179 * structure for it. After that, the device can be ifconfig'ed up
2181 static int __devinit
2182 spider_net_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
2185 struct spider_net_card *card;
2187 card = spider_net_setup_pci_dev(pdev);
2191 spider_net_workaround_rxramfull(card);
2192 spider_net_init_card(card);
2194 err = spider_net_setup_phy(card);
2198 err = spider_net_init_firmware(card);
2202 err = spider_net_setup_netdev(card);
2209 spider_net_undo_pci_setup(card);
2210 free_netdev(card->netdev);
2216 * spider_net_remove - removal of a device
2219 * Returns 0 on success, <0 on failure
2221 * spider_net_remove is called to remove the device and unregisters the
2224 static void __devexit
2225 spider_net_remove(struct pci_dev *pdev)
2227 struct net_device *netdev;
2228 struct spider_net_card *card;
2230 netdev = pci_get_drvdata(pdev);
2231 card = netdev_priv(netdev);
2233 wait_event(card->waitq,
2234 atomic_read(&card->tx_timeout_task_counter) == 0);
2236 unregister_netdev(netdev);
2238 /* switch off card */
2239 spider_net_write_reg(card, SPIDER_NET_CKRCTRL,
2240 SPIDER_NET_CKRCTRL_STOP_VALUE);
2241 spider_net_write_reg(card, SPIDER_NET_CKRCTRL,
2242 SPIDER_NET_CKRCTRL_RUN_VALUE);
2244 spider_net_undo_pci_setup(card);
2245 free_netdev(netdev);
2248 static struct pci_driver spider_net_driver = {
2249 .name = spider_net_driver_name,
2250 .id_table = spider_net_pci_tbl,
2251 .probe = spider_net_probe,
2252 .remove = __devexit_p(spider_net_remove)
2256 * spider_net_init - init function when the driver is loaded
2258 * spider_net_init registers the device driver
2260 static int __init spider_net_init(void)
2262 printk(KERN_INFO "Spidernet version %s.\n", VERSION);
2264 if (rx_descriptors < SPIDER_NET_RX_DESCRIPTORS_MIN) {
2265 rx_descriptors = SPIDER_NET_RX_DESCRIPTORS_MIN;
2266 pr_info("adjusting rx descriptors to %i.\n", rx_descriptors);
2268 if (rx_descriptors > SPIDER_NET_RX_DESCRIPTORS_MAX) {
2269 rx_descriptors = SPIDER_NET_RX_DESCRIPTORS_MAX;
2270 pr_info("adjusting rx descriptors to %i.\n", rx_descriptors);
2272 if (tx_descriptors < SPIDER_NET_TX_DESCRIPTORS_MIN) {
2273 tx_descriptors = SPIDER_NET_TX_DESCRIPTORS_MIN;
2274 pr_info("adjusting tx descriptors to %i.\n", tx_descriptors);
2276 if (tx_descriptors > SPIDER_NET_TX_DESCRIPTORS_MAX) {
2277 tx_descriptors = SPIDER_NET_TX_DESCRIPTORS_MAX;
2278 pr_info("adjusting tx descriptors to %i.\n", tx_descriptors);
2281 return pci_register_driver(&spider_net_driver);
2285 * spider_net_cleanup - exit function when driver is unloaded
2287 * spider_net_cleanup unregisters the device driver
2289 static void __exit spider_net_cleanup(void)
2291 pci_unregister_driver(&spider_net_driver);
2294 module_init(spider_net_init);
2295 module_exit(spider_net_cleanup);