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;
655 if (length < ETH_ZLEN) {
656 if (skb_pad(skb, ETH_ZLEN-length))
661 buf = pci_map_single(card->pdev, skb->data, length, PCI_DMA_TODEVICE);
662 if (pci_dma_mapping_error(buf)) {
663 if (netif_msg_tx_err(card) && net_ratelimit())
664 pr_err("could not iommu-map packet (%p, %i). "
665 "Dropping packet\n", skb->data, length);
666 card->spider_stats.tx_iommu_map_error++;
670 spin_lock_irqsave(&card->tx_chain.lock, flags);
671 descr = card->tx_chain.head;
672 card->tx_chain.head = descr->next;
674 descr->buf_addr = buf;
675 descr->buf_size = length;
676 descr->next_descr_addr = 0;
678 descr->data_status = 0;
680 descr->dmac_cmd_status =
681 SPIDER_NET_DESCR_CARDOWNED | SPIDER_NET_DMAC_NOCS;
682 spin_unlock_irqrestore(&card->tx_chain.lock, flags);
684 if (skb->protocol == htons(ETH_P_IP))
685 switch (skb->nh.iph->protocol) {
687 descr->dmac_cmd_status |= SPIDER_NET_DMAC_TCP;
690 descr->dmac_cmd_status |= SPIDER_NET_DMAC_UDP;
694 /* Chain the bus address, so that the DMA engine finds this descr. */
695 descr->prev->next_descr_addr = descr->bus_addr;
697 card->netdev->trans_start = jiffies; /* set netdev watchdog timer */
702 spider_net_set_low_watermark(struct spider_net_card *card)
708 struct spider_net_descr *descr = card->tx_chain.tail;
710 /* Measure the length of the queue. Measurement does not
711 * need to be precise -- does not need a lock. */
712 while (descr != card->tx_chain.head) {
713 status = descr->dmac_cmd_status & SPIDER_NET_DESCR_NOT_IN_USE;
714 if (status == SPIDER_NET_DESCR_NOT_IN_USE)
720 /* If TX queue is short, don't even bother with interrupts */
721 if (cnt < card->tx_desc/4)
724 /* Set low-watermark 3/4th's of the way into the queue. */
725 descr = card->tx_chain.tail;
730 /* Set the new watermark, clear the old watermark */
731 spin_lock_irqsave(&card->tx_chain.lock, flags);
732 descr->dmac_cmd_status |= SPIDER_NET_DESCR_TXDESFLG;
733 if (card->low_watermark && card->low_watermark != descr)
734 card->low_watermark->dmac_cmd_status =
735 card->low_watermark->dmac_cmd_status & ~SPIDER_NET_DESCR_TXDESFLG;
736 card->low_watermark = descr;
737 spin_unlock_irqrestore(&card->tx_chain.lock, flags);
741 * spider_net_release_tx_chain - processes sent tx descriptors
742 * @card: adapter structure
743 * @brutal: if set, don't care about whether descriptor seems to be in use
745 * returns 0 if the tx ring is empty, otherwise 1.
747 * spider_net_release_tx_chain releases the tx descriptors that spider has
748 * finished with (if non-brutal) or simply release tx descriptors (if brutal).
749 * If some other context is calling this function, we return 1 so that we're
750 * scheduled again (if we were scheduled) and will not loose initiative.
753 spider_net_release_tx_chain(struct spider_net_card *card, int brutal)
755 struct spider_net_descr_chain *chain = &card->tx_chain;
756 struct spider_net_descr *descr;
762 spider_net_read_reg(card, SPIDER_NET_GDTDMACCNTR);
764 while (chain->tail != chain->head) {
765 spin_lock_irqsave(&chain->lock, flags);
768 status = spider_net_get_descr_status(descr);
770 case SPIDER_NET_DESCR_COMPLETE:
771 card->netdev_stats.tx_packets++;
772 card->netdev_stats.tx_bytes += descr->skb->len;
775 case SPIDER_NET_DESCR_CARDOWNED:
777 spin_unlock_irqrestore(&chain->lock, flags);
781 /* fallthrough, if we release the descriptors
782 * brutally (then we don't care about
783 * SPIDER_NET_DESCR_CARDOWNED) */
785 case SPIDER_NET_DESCR_RESPONSE_ERROR:
786 case SPIDER_NET_DESCR_PROTECTION_ERROR:
787 case SPIDER_NET_DESCR_FORCE_END:
788 if (netif_msg_tx_err(card))
789 pr_err("%s: forcing end of tx descriptor "
790 "with status x%02x\n",
791 card->netdev->name, status);
792 card->netdev_stats.tx_errors++;
796 card->netdev_stats.tx_dropped++;
798 spin_unlock_irqrestore(&chain->lock, flags);
803 chain->tail = descr->next;
804 descr->dmac_cmd_status |= SPIDER_NET_DESCR_NOT_IN_USE;
806 buf_addr = descr->buf_addr;
807 spin_unlock_irqrestore(&chain->lock, flags);
811 int len = skb->len < ETH_ZLEN ? ETH_ZLEN : skb->len;
812 pci_unmap_single(card->pdev, buf_addr, len, PCI_DMA_TODEVICE);
820 * spider_net_kick_tx_dma - enables TX DMA processing
821 * @card: card structure
822 * @descr: descriptor address to enable TX processing at
824 * spider_net_kick_tx_dma writes the current tx chain head as start address
825 * of the tx descriptor chain and enables the transmission DMA engine
828 spider_net_kick_tx_dma(struct spider_net_card *card)
830 struct spider_net_descr *descr;
832 if (spider_net_read_reg(card, SPIDER_NET_GDTDMACCNTR) &
833 SPIDER_NET_TX_DMA_EN)
836 descr = card->tx_chain.tail;
838 if (spider_net_get_descr_status(descr) ==
839 SPIDER_NET_DESCR_CARDOWNED) {
840 spider_net_write_reg(card, SPIDER_NET_GDTDCHA,
842 spider_net_write_reg(card, SPIDER_NET_GDTDMACCNTR,
843 SPIDER_NET_DMA_TX_VALUE);
846 if (descr == card->tx_chain.head)
852 mod_timer(&card->tx_timer, jiffies + SPIDER_NET_TX_TIMER);
856 * spider_net_xmit - transmits a frame over the device
857 * @skb: packet to send out
858 * @netdev: interface device structure
860 * returns 0 on success, !0 on failure
863 spider_net_xmit(struct sk_buff *skb, struct net_device *netdev)
865 struct spider_net_card *card = netdev_priv(netdev);
866 struct spider_net_descr_chain *chain = &card->tx_chain;
868 spider_net_release_tx_chain(card, 0);
870 if ((chain->head->next == chain->tail->prev) ||
871 (spider_net_prepare_tx_descr(card, skb) != 0)) {
873 card->netdev_stats.tx_dropped++;
874 netif_stop_queue(netdev);
875 return NETDEV_TX_BUSY;
878 spider_net_set_low_watermark(card);
879 spider_net_kick_tx_dma(card);
884 * spider_net_cleanup_tx_ring - cleans up the TX ring
885 * @card: card structure
887 * spider_net_cleanup_tx_ring is called by either the tx_timer
888 * or from the NAPI polling routine.
889 * This routine releases resources associted with transmitted
890 * packets, including updating the queue tail pointer.
893 spider_net_cleanup_tx_ring(struct spider_net_card *card)
895 if ((spider_net_release_tx_chain(card, 0) != 0) &&
896 (card->netdev->flags & IFF_UP)) {
897 spider_net_kick_tx_dma(card);
898 netif_wake_queue(card->netdev);
903 * spider_net_do_ioctl - called for device ioctls
904 * @netdev: interface device structure
905 * @ifr: request parameter structure for ioctl
906 * @cmd: command code for ioctl
908 * returns 0 on success, <0 on failure. Currently, we have no special ioctls.
909 * -EOPNOTSUPP is returned, if an unknown ioctl was requested
912 spider_net_do_ioctl(struct net_device *netdev, struct ifreq *ifr, int cmd)
921 * spider_net_pass_skb_up - takes an skb from a descriptor and passes it on
922 * @descr: descriptor to process
923 * @card: card structure
924 * @napi: whether caller is in NAPI context
926 * returns 1 on success, 0 if no packet was passed to the stack
928 * iommu-unmaps the skb, fills out skb structure and passes the data to the
929 * stack. The descriptor state is not changed.
932 spider_net_pass_skb_up(struct spider_net_descr *descr,
933 struct spider_net_card *card, int napi)
936 struct net_device *netdev;
937 u32 data_status, data_error;
939 data_status = descr->data_status;
940 data_error = descr->data_error;
942 netdev = card->netdev;
944 /* unmap descriptor */
945 pci_unmap_single(card->pdev, descr->buf_addr, SPIDER_NET_MAX_FRAME,
948 /* the cases we'll throw away the packet immediately */
949 if (data_error & SPIDER_NET_DESTROY_RX_FLAGS) {
950 if (netif_msg_rx_err(card))
951 pr_err("error in received descriptor found, "
952 "data_status=x%08x, data_error=x%08x\n",
953 data_status, data_error);
954 card->spider_stats.rx_desc_error++;
960 skb_put(skb, descr->valid_size);
962 /* the card seems to add 2 bytes of junk in front
963 * of the ethernet frame */
964 #define SPIDER_MISALIGN 2
965 skb_pull(skb, SPIDER_MISALIGN);
966 skb->protocol = eth_type_trans(skb, netdev);
968 /* checksum offload */
969 if (card->options.rx_csum) {
970 if ( ( (data_status & SPIDER_NET_DATA_STATUS_CKSUM_MASK) ==
971 SPIDER_NET_DATA_STATUS_CKSUM_MASK) &&
972 !(data_error & SPIDER_NET_DATA_ERR_CKSUM_MASK))
973 skb->ip_summed = CHECKSUM_UNNECESSARY;
975 skb->ip_summed = CHECKSUM_NONE;
977 skb->ip_summed = CHECKSUM_NONE;
979 if (data_status & SPIDER_NET_VLAN_PACKET) {
980 /* further enhancements: HW-accel VLAN
981 * vlan_hwaccel_receive_skb
985 /* pass skb up to stack */
987 netif_receive_skb(skb);
991 /* update netdevice statistics */
992 card->netdev_stats.rx_packets++;
993 card->netdev_stats.rx_bytes += skb->len;
999 * spider_net_decode_one_descr - processes an rx descriptor
1000 * @card: card structure
1001 * @napi: whether caller is in NAPI context
1003 * returns 1 if a packet has been sent to the stack, otherwise 0
1005 * processes an rx descriptor by iommu-unmapping the data buffer and passing
1006 * the packet up to the stack. This function is called in softirq
1007 * context, e.g. either bottom half from interrupt or NAPI polling context
1010 spider_net_decode_one_descr(struct spider_net_card *card, int napi)
1012 struct spider_net_descr_chain *chain = &card->rx_chain;
1013 struct spider_net_descr *descr = chain->tail;
1017 status = spider_net_get_descr_status(descr);
1019 if (status == SPIDER_NET_DESCR_CARDOWNED) {
1020 /* nothing in the descriptor yet */
1025 if (status == SPIDER_NET_DESCR_NOT_IN_USE) {
1026 /* not initialized yet, the ring must be empty */
1027 spider_net_refill_rx_chain(card);
1028 spider_net_enable_rxdmac(card);
1033 /* descriptor definitively used -- move on tail */
1034 chain->tail = descr->next;
1037 if ( (status == SPIDER_NET_DESCR_RESPONSE_ERROR) ||
1038 (status == SPIDER_NET_DESCR_PROTECTION_ERROR) ||
1039 (status == SPIDER_NET_DESCR_FORCE_END) ) {
1040 if (netif_msg_rx_err(card))
1041 pr_err("%s: dropping RX descriptor with state %d\n",
1042 card->netdev->name, status);
1043 card->netdev_stats.rx_dropped++;
1044 pci_unmap_single(card->pdev, descr->buf_addr,
1045 SPIDER_NET_MAX_FRAME, PCI_DMA_FROMDEVICE);
1046 dev_kfree_skb_irq(descr->skb);
1050 if ( (status != SPIDER_NET_DESCR_COMPLETE) &&
1051 (status != SPIDER_NET_DESCR_FRAME_END) ) {
1052 if (netif_msg_rx_err(card)) {
1053 pr_err("%s: RX descriptor with state %d\n",
1054 card->netdev->name, status);
1055 card->spider_stats.rx_desc_unk_state++;
1060 /* ok, we've got a packet in descr */
1061 result = spider_net_pass_skb_up(descr, card, napi);
1063 descr->dmac_cmd_status = SPIDER_NET_DESCR_NOT_IN_USE;
1064 /* change the descriptor state: */
1066 spider_net_refill_rx_chain(card);
1072 * spider_net_poll - NAPI poll function called by the stack to return packets
1073 * @netdev: interface device structure
1074 * @budget: number of packets we can pass to the stack at most
1076 * returns 0 if no more packets available to the driver/stack. Returns 1,
1077 * if the quota is exceeded, but the driver has still packets.
1079 * spider_net_poll returns all packets from the rx descriptors to the stack
1080 * (using netif_receive_skb). If all/enough packets are up, the driver
1081 * reenables interrupts and returns 0. If not, 1 is returned.
1084 spider_net_poll(struct net_device *netdev, int *budget)
1086 struct spider_net_card *card = netdev_priv(netdev);
1087 int packets_to_do, packets_done = 0;
1088 int no_more_packets = 0;
1090 spider_net_cleanup_tx_ring(card);
1091 packets_to_do = min(*budget, netdev->quota);
1093 while (packets_to_do) {
1094 if (spider_net_decode_one_descr(card, 1)) {
1098 /* no more packets for the stack */
1099 no_more_packets = 1;
1104 netdev->quota -= packets_done;
1105 *budget -= packets_done;
1106 spider_net_refill_rx_chain(card);
1108 /* if all packets are in the stack, enable interrupts and return 0 */
1109 /* if not, return 1 */
1110 if (no_more_packets) {
1111 netif_rx_complete(netdev);
1112 spider_net_rx_irq_on(card);
1120 * spider_net_vlan_rx_reg - initializes VLAN structures in the driver and card
1121 * @netdev: interface device structure
1122 * @grp: vlan_group structure that is registered (NULL on destroying interface)
1125 spider_net_vlan_rx_reg(struct net_device *netdev, struct vlan_group *grp)
1127 /* further enhancement... yet to do */
1132 * spider_net_vlan_rx_add - adds VLAN id to the card filter
1133 * @netdev: interface device structure
1134 * @vid: VLAN id to add
1137 spider_net_vlan_rx_add(struct net_device *netdev, uint16_t vid)
1139 /* further enhancement... yet to do */
1140 /* add vid to card's VLAN filter table */
1145 * spider_net_vlan_rx_kill - removes VLAN id to the card filter
1146 * @netdev: interface device structure
1147 * @vid: VLAN id to remove
1150 spider_net_vlan_rx_kill(struct net_device *netdev, uint16_t vid)
1152 /* further enhancement... yet to do */
1153 /* remove vid from card's VLAN filter table */
1157 * spider_net_get_stats - get interface statistics
1158 * @netdev: interface device structure
1160 * returns the interface statistics residing in the spider_net_card struct
1162 static struct net_device_stats *
1163 spider_net_get_stats(struct net_device *netdev)
1165 struct spider_net_card *card = netdev_priv(netdev);
1166 struct net_device_stats *stats = &card->netdev_stats;
1171 * spider_net_change_mtu - changes the MTU of an interface
1172 * @netdev: interface device structure
1173 * @new_mtu: new MTU value
1175 * returns 0 on success, <0 on failure
1178 spider_net_change_mtu(struct net_device *netdev, int new_mtu)
1180 /* no need to re-alloc skbs or so -- the max mtu is about 2.3k
1181 * and mtu is outbound only anyway */
1182 if ( (new_mtu < SPIDER_NET_MIN_MTU ) ||
1183 (new_mtu > SPIDER_NET_MAX_MTU) )
1185 netdev->mtu = new_mtu;
1190 * spider_net_set_mac - sets the MAC of an interface
1191 * @netdev: interface device structure
1192 * @ptr: pointer to new MAC address
1194 * Returns 0 on success, <0 on failure. Currently, we don't support this
1195 * and will always return EOPNOTSUPP.
1198 spider_net_set_mac(struct net_device *netdev, void *p)
1200 struct spider_net_card *card = netdev_priv(netdev);
1201 u32 macl, macu, regvalue;
1202 struct sockaddr *addr = p;
1204 if (!is_valid_ether_addr(addr->sa_data))
1205 return -EADDRNOTAVAIL;
1207 /* switch off GMACTPE and GMACRPE */
1208 regvalue = spider_net_read_reg(card, SPIDER_NET_GMACOPEMD);
1209 regvalue &= ~((1 << 5) | (1 << 6));
1210 spider_net_write_reg(card, SPIDER_NET_GMACOPEMD, regvalue);
1213 macu = (addr->sa_data[0]<<24) + (addr->sa_data[1]<<16) +
1214 (addr->sa_data[2]<<8) + (addr->sa_data[3]);
1215 macl = (addr->sa_data[4]<<8) + (addr->sa_data[5]);
1216 spider_net_write_reg(card, SPIDER_NET_GMACUNIMACU, macu);
1217 spider_net_write_reg(card, SPIDER_NET_GMACUNIMACL, macl);
1219 /* switch GMACTPE and GMACRPE back on */
1220 regvalue = spider_net_read_reg(card, SPIDER_NET_GMACOPEMD);
1221 regvalue |= ((1 << 5) | (1 << 6));
1222 spider_net_write_reg(card, SPIDER_NET_GMACOPEMD, regvalue);
1224 spider_net_set_promisc(card);
1226 /* look up, whether we have been successful */
1227 if (spider_net_get_mac_address(netdev))
1228 return -EADDRNOTAVAIL;
1229 if (memcmp(netdev->dev_addr,addr->sa_data,netdev->addr_len))
1230 return -EADDRNOTAVAIL;
1236 * spider_net_handle_rxram_full - cleans up RX ring upon RX RAM full interrupt
1237 * @card: card structure
1239 * spider_net_handle_rxram_full empties the RX ring so that spider can put
1240 * more packets in it and empty its RX RAM. This is called in bottom half
1244 spider_net_handle_rxram_full(struct spider_net_card *card)
1246 while (spider_net_decode_one_descr(card, 0))
1248 spider_net_enable_rxchtails(card);
1249 spider_net_enable_rxdmac(card);
1250 netif_rx_schedule(card->netdev);
1254 * spider_net_handle_error_irq - handles errors raised by an interrupt
1255 * @card: card structure
1256 * @status_reg: interrupt status register 0 (GHIINT0STS)
1258 * spider_net_handle_error_irq treats or ignores all error conditions
1259 * found when an interrupt is presented
1262 spider_net_handle_error_irq(struct spider_net_card *card, u32 status_reg)
1264 u32 error_reg1, error_reg2;
1268 error_reg1 = spider_net_read_reg(card, SPIDER_NET_GHIINT1STS);
1269 error_reg2 = spider_net_read_reg(card, SPIDER_NET_GHIINT2STS);
1271 /* check GHIINT0STS ************************************/
1273 for (i = 0; i < 32; i++)
1274 if (status_reg & (1<<i))
1277 /* let error_reg1 and error_reg2 evaluation decide, what to do
1278 case SPIDER_NET_PHYINT:
1279 case SPIDER_NET_GMAC2INT:
1280 case SPIDER_NET_GMAC1INT:
1281 case SPIDER_NET_GFIFOINT:
1282 case SPIDER_NET_DMACINT:
1283 case SPIDER_NET_GSYSINT:
1286 case SPIDER_NET_GIPSINT:
1290 case SPIDER_NET_GPWOPCMPINT:
1291 /* PHY write operation completed */
1294 case SPIDER_NET_GPROPCMPINT:
1295 /* PHY read operation completed */
1296 /* we don't use semaphores, as we poll for the completion
1297 * of the read operation in spider_net_read_phy. Should take
1301 case SPIDER_NET_GPWFFINT:
1302 /* PHY command queue full */
1303 if (netif_msg_intr(card))
1304 pr_err("PHY write queue full\n");
1308 /* case SPIDER_NET_GRMDADRINT: not used. print a message */
1309 /* case SPIDER_NET_GRMARPINT: not used. print a message */
1310 /* case SPIDER_NET_GRMMPINT: not used. print a message */
1312 case SPIDER_NET_GDTDEN0INT:
1313 /* someone has set TX_DMA_EN to 0 */
1317 case SPIDER_NET_GDDDEN0INT: /* fallthrough */
1318 case SPIDER_NET_GDCDEN0INT: /* fallthrough */
1319 case SPIDER_NET_GDBDEN0INT: /* fallthrough */
1320 case SPIDER_NET_GDADEN0INT:
1321 /* someone has set RX_DMA_EN to 0 */
1326 case SPIDER_NET_GDDFDCINT:
1327 case SPIDER_NET_GDCFDCINT:
1328 case SPIDER_NET_GDBFDCINT:
1329 case SPIDER_NET_GDAFDCINT:
1330 /* case SPIDER_NET_GDNMINT: not used. print a message */
1331 /* case SPIDER_NET_GCNMINT: not used. print a message */
1332 /* case SPIDER_NET_GBNMINT: not used. print a message */
1333 /* case SPIDER_NET_GANMINT: not used. print a message */
1334 /* case SPIDER_NET_GRFNMINT: not used. print a message */
1339 case SPIDER_NET_GDTFDCINT:
1342 case SPIDER_NET_GTTEDINT:
1345 case SPIDER_NET_GDTDCEINT:
1346 /* chain end. If a descriptor should be sent, kick off
1348 if (card->tx_chain.tail != card->tx_chain.head)
1349 spider_net_kick_tx_dma(card);
1354 /* case SPIDER_NET_G1TMCNTINT: not used. print a message */
1355 /* case SPIDER_NET_GFREECNTINT: not used. print a message */
1358 /* check GHIINT1STS ************************************/
1360 for (i = 0; i < 32; i++)
1361 if (error_reg1 & (1<<i))
1364 case SPIDER_NET_GTMFLLINT:
1365 if (netif_msg_intr(card) && net_ratelimit())
1366 pr_err("Spider TX RAM full\n");
1369 case SPIDER_NET_GRFDFLLINT: /* fallthrough */
1370 case SPIDER_NET_GRFCFLLINT: /* fallthrough */
1371 case SPIDER_NET_GRFBFLLINT: /* fallthrough */
1372 case SPIDER_NET_GRFAFLLINT: /* fallthrough */
1373 case SPIDER_NET_GRMFLLINT:
1374 if (netif_msg_intr(card) && net_ratelimit())
1375 pr_debug("Spider RX RAM full, incoming packets "
1376 "might be discarded!\n");
1377 spider_net_rx_irq_off(card);
1378 tasklet_schedule(&card->rxram_full_tl);
1382 /* case SPIDER_NET_GTMSHTINT: problem, print a message */
1383 case SPIDER_NET_GDTINVDINT:
1384 /* allrighty. tx from previous descr ok */
1389 case SPIDER_NET_GDDDCEINT: /* fallthrough */
1390 case SPIDER_NET_GDCDCEINT: /* fallthrough */
1391 case SPIDER_NET_GDBDCEINT: /* fallthrough */
1392 case SPIDER_NET_GDADCEINT:
1393 if (netif_msg_intr(card))
1394 pr_err("got descriptor chain end interrupt, "
1395 "restarting DMAC %c.\n",
1396 'D'-(i-SPIDER_NET_GDDDCEINT)/3);
1397 spider_net_refill_rx_chain(card);
1398 spider_net_enable_rxdmac(card);
1402 /* invalid descriptor */
1403 case SPIDER_NET_GDDINVDINT: /* fallthrough */
1404 case SPIDER_NET_GDCINVDINT: /* fallthrough */
1405 case SPIDER_NET_GDBINVDINT: /* fallthrough */
1406 case SPIDER_NET_GDAINVDINT:
1407 /* could happen when rx chain is full */
1408 spider_net_refill_rx_chain(card);
1409 spider_net_enable_rxdmac(card);
1413 /* case SPIDER_NET_GDTRSERINT: problem, print a message */
1414 /* case SPIDER_NET_GDDRSERINT: problem, print a message */
1415 /* case SPIDER_NET_GDCRSERINT: problem, print a message */
1416 /* case SPIDER_NET_GDBRSERINT: problem, print a message */
1417 /* case SPIDER_NET_GDARSERINT: problem, print a message */
1418 /* case SPIDER_NET_GDSERINT: problem, print a message */
1419 /* case SPIDER_NET_GDTPTERINT: problem, print a message */
1420 /* case SPIDER_NET_GDDPTERINT: problem, print a message */
1421 /* case SPIDER_NET_GDCPTERINT: problem, print a message */
1422 /* case SPIDER_NET_GDBPTERINT: problem, print a message */
1423 /* case SPIDER_NET_GDAPTERINT: problem, print a message */
1429 /* check GHIINT2STS ************************************/
1431 for (i = 0; i < 32; i++)
1432 if (error_reg2 & (1<<i))
1435 /* there is nothing we can (want to) do at this time. Log a
1436 * message, we can switch on and off the specific values later on
1437 case SPIDER_NET_GPROPERINT:
1438 case SPIDER_NET_GMCTCRSNGINT:
1439 case SPIDER_NET_GMCTLCOLINT:
1440 case SPIDER_NET_GMCTTMOTINT:
1441 case SPIDER_NET_GMCRCAERINT:
1442 case SPIDER_NET_GMCRCALERINT:
1443 case SPIDER_NET_GMCRALNERINT:
1444 case SPIDER_NET_GMCROVRINT:
1445 case SPIDER_NET_GMCRRNTINT:
1446 case SPIDER_NET_GMCRRXERINT:
1447 case SPIDER_NET_GTITCSERINT:
1448 case SPIDER_NET_GTIFMTERINT:
1449 case SPIDER_NET_GTIPKTRVKINT:
1450 case SPIDER_NET_GTISPINGINT:
1451 case SPIDER_NET_GTISADNGINT:
1452 case SPIDER_NET_GTISPDNGINT:
1453 case SPIDER_NET_GRIFMTERINT:
1454 case SPIDER_NET_GRIPKTRVKINT:
1455 case SPIDER_NET_GRISPINGINT:
1456 case SPIDER_NET_GRISADNGINT:
1457 case SPIDER_NET_GRISPDNGINT:
1464 if ((show_error) && (netif_msg_intr(card)))
1465 pr_err("Got error interrupt on %s, GHIINT0STS = 0x%08x, "
1466 "GHIINT1STS = 0x%08x, GHIINT2STS = 0x%08x\n",
1468 status_reg, error_reg1, error_reg2);
1470 /* clear interrupt sources */
1471 spider_net_write_reg(card, SPIDER_NET_GHIINT1STS, error_reg1);
1472 spider_net_write_reg(card, SPIDER_NET_GHIINT2STS, error_reg2);
1476 * spider_net_interrupt - interrupt handler for spider_net
1477 * @irq: interupt number
1478 * @ptr: pointer to net_device
1479 * @regs: PU registers
1481 * returns IRQ_HANDLED, if interrupt was for driver, or IRQ_NONE, if no
1482 * interrupt found raised by card.
1484 * This is the interrupt handler, that turns off
1485 * interrupts for this device and makes the stack poll the driver
1488 spider_net_interrupt(int irq, void *ptr)
1490 struct net_device *netdev = ptr;
1491 struct spider_net_card *card = netdev_priv(netdev);
1494 status_reg = spider_net_read_reg(card, SPIDER_NET_GHIINT0STS);
1499 if (status_reg & SPIDER_NET_RXINT ) {
1500 spider_net_rx_irq_off(card);
1501 netif_rx_schedule(netdev);
1503 if (status_reg & SPIDER_NET_TXINT)
1504 netif_rx_schedule(netdev);
1506 if (status_reg & SPIDER_NET_ERRINT )
1507 spider_net_handle_error_irq(card, status_reg);
1509 /* clear interrupt sources */
1510 spider_net_write_reg(card, SPIDER_NET_GHIINT0STS, status_reg);
1515 #ifdef CONFIG_NET_POLL_CONTROLLER
1517 * spider_net_poll_controller - artificial interrupt for netconsole etc.
1518 * @netdev: interface device structure
1520 * see Documentation/networking/netconsole.txt
1523 spider_net_poll_controller(struct net_device *netdev)
1525 disable_irq(netdev->irq);
1526 spider_net_interrupt(netdev->irq, netdev);
1527 enable_irq(netdev->irq);
1529 #endif /* CONFIG_NET_POLL_CONTROLLER */
1532 * spider_net_init_card - initializes the card
1533 * @card: card structure
1535 * spider_net_init_card initializes the card so that other registers can
1539 spider_net_init_card(struct spider_net_card *card)
1541 spider_net_write_reg(card, SPIDER_NET_CKRCTRL,
1542 SPIDER_NET_CKRCTRL_STOP_VALUE);
1544 spider_net_write_reg(card, SPIDER_NET_CKRCTRL,
1545 SPIDER_NET_CKRCTRL_RUN_VALUE);
1549 * spider_net_enable_card - enables the card by setting all kinds of regs
1550 * @card: card structure
1552 * spider_net_enable_card sets a lot of SMMIO registers to enable the device
1555 spider_net_enable_card(struct spider_net_card *card)
1558 /* the following array consists of (register),(value) pairs
1559 * that are set in this function. A register of 0 ends the list */
1561 { SPIDER_NET_GRESUMINTNUM, 0 },
1562 { SPIDER_NET_GREINTNUM, 0 },
1564 /* set interrupt frame number registers */
1565 /* clear the single DMA engine registers first */
1566 { SPIDER_NET_GFAFRMNUM, SPIDER_NET_GFXFRAMES_VALUE },
1567 { SPIDER_NET_GFBFRMNUM, SPIDER_NET_GFXFRAMES_VALUE },
1568 { SPIDER_NET_GFCFRMNUM, SPIDER_NET_GFXFRAMES_VALUE },
1569 { SPIDER_NET_GFDFRMNUM, SPIDER_NET_GFXFRAMES_VALUE },
1570 /* then set, what we really need */
1571 { SPIDER_NET_GFFRMNUM, SPIDER_NET_FRAMENUM_VALUE },
1573 /* timer counter registers and stuff */
1574 { SPIDER_NET_GFREECNNUM, 0 },
1575 { SPIDER_NET_GONETIMENUM, 0 },
1576 { SPIDER_NET_GTOUTFRMNUM, 0 },
1578 /* RX mode setting */
1579 { SPIDER_NET_GRXMDSET, SPIDER_NET_RXMODE_VALUE },
1580 /* TX mode setting */
1581 { SPIDER_NET_GTXMDSET, SPIDER_NET_TXMODE_VALUE },
1582 /* IPSEC mode setting */
1583 { SPIDER_NET_GIPSECINIT, SPIDER_NET_IPSECINIT_VALUE },
1585 { SPIDER_NET_GFTRESTRT, SPIDER_NET_RESTART_VALUE },
1587 { SPIDER_NET_GMRWOLCTRL, 0 },
1588 { SPIDER_NET_GTESTMD, 0x10000000 },
1589 { SPIDER_NET_GTTQMSK, 0x00400040 },
1591 { SPIDER_NET_GMACINTEN, 0 },
1593 /* flow control stuff */
1594 { SPIDER_NET_GMACAPAUSE, SPIDER_NET_MACAPAUSE_VALUE },
1595 { SPIDER_NET_GMACTXPAUSE, SPIDER_NET_TXPAUSE_VALUE },
1597 { SPIDER_NET_GMACBSTLMT, SPIDER_NET_BURSTLMT_VALUE },
1602 while (regs[i][0]) {
1603 spider_net_write_reg(card, regs[i][0], regs[i][1]);
1607 /* clear unicast filter table entries 1 to 14 */
1608 for (i = 1; i <= 14; i++) {
1609 spider_net_write_reg(card,
1610 SPIDER_NET_GMRUAFILnR + i * 8,
1612 spider_net_write_reg(card,
1613 SPIDER_NET_GMRUAFILnR + i * 8 + 4,
1617 spider_net_write_reg(card, SPIDER_NET_GMRUA0FIL15R, 0x08080000);
1619 spider_net_write_reg(card, SPIDER_NET_ECMODE, SPIDER_NET_ECMODE_VALUE);
1621 /* set chain tail adress for RX chains and
1623 spider_net_enable_rxchtails(card);
1624 spider_net_enable_rxdmac(card);
1626 spider_net_write_reg(card, SPIDER_NET_GRXDMAEN, SPIDER_NET_WOL_VALUE);
1628 spider_net_write_reg(card, SPIDER_NET_GMACLENLMT,
1629 SPIDER_NET_LENLMT_VALUE);
1630 spider_net_write_reg(card, SPIDER_NET_GMACMODE,
1631 SPIDER_NET_MACMODE_VALUE);
1632 spider_net_write_reg(card, SPIDER_NET_GMACOPEMD,
1633 SPIDER_NET_OPMODE_VALUE);
1635 /* set interrupt mask registers */
1636 spider_net_write_reg(card, SPIDER_NET_GHIINT0MSK,
1637 SPIDER_NET_INT0_MASK_VALUE);
1638 spider_net_write_reg(card, SPIDER_NET_GHIINT1MSK,
1639 SPIDER_NET_INT1_MASK_VALUE);
1640 spider_net_write_reg(card, SPIDER_NET_GHIINT2MSK,
1641 SPIDER_NET_INT2_MASK_VALUE);
1643 spider_net_write_reg(card, SPIDER_NET_GDTDMACCNTR,
1644 SPIDER_NET_GDTBSTA | SPIDER_NET_GDTDCEIDIS);
1648 * spider_net_open - called upon ifonfig up
1649 * @netdev: interface device structure
1651 * returns 0 on success, <0 on failure
1653 * spider_net_open allocates all the descriptors and memory needed for
1654 * operation, sets up multicast list and enables interrupts
1657 spider_net_open(struct net_device *netdev)
1659 struct spider_net_card *card = netdev_priv(netdev);
1663 if (spider_net_init_chain(card, &card->tx_chain, card->descr,
1664 PCI_DMA_TODEVICE, card->tx_desc))
1665 goto alloc_tx_failed;
1667 card->low_watermark = NULL;
1669 /* rx_chain is after tx_chain, so offset is descr + tx_count */
1670 if (spider_net_init_chain(card, &card->rx_chain,
1671 card->descr + card->tx_desc,
1672 PCI_DMA_FROMDEVICE, card->rx_desc))
1673 goto alloc_rx_failed;
1675 /* allocate rx skbs */
1676 if (spider_net_alloc_rx_skbs(card))
1677 goto alloc_skbs_failed;
1679 spider_net_set_multi(netdev);
1681 /* further enhancement: setup hw vlan, if needed */
1684 if (request_irq(netdev->irq, spider_net_interrupt,
1685 IRQF_SHARED, netdev->name, netdev))
1686 goto register_int_failed;
1688 spider_net_enable_card(card);
1690 netif_start_queue(netdev);
1691 netif_carrier_on(netdev);
1692 netif_poll_enable(netdev);
1696 register_int_failed:
1697 spider_net_free_rx_chain_contents(card);
1699 spider_net_free_chain(card, &card->rx_chain);
1701 spider_net_free_chain(card, &card->tx_chain);
1707 * spider_net_setup_phy - setup PHY
1708 * @card: card structure
1710 * returns 0 on success, <0 on failure
1712 * spider_net_setup_phy is used as part of spider_net_probe. Sets
1713 * the PHY to 1000 Mbps
1716 spider_net_setup_phy(struct spider_net_card *card)
1718 struct mii_phy *phy = &card->phy;
1720 spider_net_write_reg(card, SPIDER_NET_GDTDMASEL,
1721 SPIDER_NET_DMASEL_VALUE);
1722 spider_net_write_reg(card, SPIDER_NET_GPCCTRL,
1723 SPIDER_NET_PHY_CTRL_VALUE);
1725 phy->dev = card->netdev;
1726 phy->mdio_read = spider_net_read_phy;
1727 phy->mdio_write = spider_net_write_phy;
1729 mii_phy_probe(phy, phy->mii_id);
1731 if (phy->def->ops->setup_forced)
1732 phy->def->ops->setup_forced(phy, SPEED_1000, DUPLEX_FULL);
1734 phy->def->ops->enable_fiber(phy);
1736 phy->def->ops->read_link(phy);
1737 pr_info("Found %s with %i Mbps, %s-duplex.\n", phy->def->name,
1738 phy->speed, phy->duplex==1 ? "Full" : "Half");
1744 * spider_net_download_firmware - loads firmware into the adapter
1745 * @card: card structure
1746 * @firmware_ptr: pointer to firmware data
1748 * spider_net_download_firmware loads the firmware data into the
1749 * adapter. It assumes the length etc. to be allright.
1752 spider_net_download_firmware(struct spider_net_card *card,
1753 const void *firmware_ptr)
1756 const u32 *fw_ptr = firmware_ptr;
1758 /* stop sequencers */
1759 spider_net_write_reg(card, SPIDER_NET_GSINIT,
1760 SPIDER_NET_STOP_SEQ_VALUE);
1762 for (sequencer = 0; sequencer < SPIDER_NET_FIRMWARE_SEQS;
1764 spider_net_write_reg(card,
1765 SPIDER_NET_GSnPRGADR + sequencer * 8, 0);
1766 for (i = 0; i < SPIDER_NET_FIRMWARE_SEQWORDS; i++) {
1767 spider_net_write_reg(card, SPIDER_NET_GSnPRGDAT +
1768 sequencer * 8, *fw_ptr);
1773 if (spider_net_read_reg(card, SPIDER_NET_GSINIT))
1776 spider_net_write_reg(card, SPIDER_NET_GSINIT,
1777 SPIDER_NET_RUN_SEQ_VALUE);
1783 * spider_net_init_firmware - reads in firmware parts
1784 * @card: card structure
1786 * Returns 0 on success, <0 on failure
1788 * spider_net_init_firmware opens the sequencer firmware and does some basic
1789 * checks. This function opens and releases the firmware structure. A call
1790 * to download the firmware is performed before the release.
1794 * spider_fw.bin is expected to be a file containing 6*1024*4 bytes, 4k being
1795 * the program for each sequencer. Use the command
1796 * tail -q -n +2 Seq_code1_0x088.txt Seq_code2_0x090.txt \
1797 * Seq_code3_0x098.txt Seq_code4_0x0A0.txt Seq_code5_0x0A8.txt \
1798 * Seq_code6_0x0B0.txt | xxd -r -p -c4 > spider_fw.bin
1800 * to generate spider_fw.bin, if you have sequencer programs with something
1801 * like the following contents for each sequencer:
1802 * <ONE LINE COMMENT>
1803 * <FIRST 4-BYTES-WORD FOR SEQUENCER>
1804 * <SECOND 4-BYTES-WORD FOR SEQUENCER>
1806 * <1024th 4-BYTES-WORD FOR SEQUENCER>
1809 spider_net_init_firmware(struct spider_net_card *card)
1811 struct firmware *firmware = NULL;
1812 struct device_node *dn;
1813 const u8 *fw_prop = NULL;
1817 if (request_firmware((const struct firmware **)&firmware,
1818 SPIDER_NET_FIRMWARE_NAME, &card->pdev->dev) == 0) {
1819 if ( (firmware->size != SPIDER_NET_FIRMWARE_LEN) &&
1820 netif_msg_probe(card) ) {
1821 pr_err("Incorrect size of spidernet firmware in " \
1822 "filesystem. Looking in host firmware...\n");
1825 err = spider_net_download_firmware(card, firmware->data);
1827 release_firmware(firmware);
1835 dn = pci_device_to_OF_node(card->pdev);
1839 fw_prop = get_property(dn, "firmware", &fw_size);
1843 if ( (fw_size != SPIDER_NET_FIRMWARE_LEN) &&
1844 netif_msg_probe(card) ) {
1845 pr_err("Incorrect size of spidernet firmware in " \
1850 err = spider_net_download_firmware(card, fw_prop);
1855 if (netif_msg_probe(card))
1856 pr_err("Couldn't find spidernet firmware in filesystem " \
1857 "or host firmware\n");
1862 * spider_net_workaround_rxramfull - work around firmware bug
1863 * @card: card structure
1868 spider_net_workaround_rxramfull(struct spider_net_card *card)
1870 int i, sequencer = 0;
1873 spider_net_write_reg(card, SPIDER_NET_CKRCTRL,
1874 SPIDER_NET_CKRCTRL_RUN_VALUE);
1876 /* empty sequencer data */
1877 for (sequencer = 0; sequencer < SPIDER_NET_FIRMWARE_SEQS;
1879 spider_net_write_reg(card, SPIDER_NET_GSnPRGADR +
1880 sequencer * 8, 0x0);
1881 for (i = 0; i < SPIDER_NET_FIRMWARE_SEQWORDS; i++) {
1882 spider_net_write_reg(card, SPIDER_NET_GSnPRGDAT +
1883 sequencer * 8, 0x0);
1887 /* set sequencer operation */
1888 spider_net_write_reg(card, SPIDER_NET_GSINIT, 0x000000fe);
1891 spider_net_write_reg(card, SPIDER_NET_CKRCTRL,
1892 SPIDER_NET_CKRCTRL_STOP_VALUE);
1896 * spider_net_stop - called upon ifconfig down
1897 * @netdev: interface device structure
1902 spider_net_stop(struct net_device *netdev)
1904 struct spider_net_card *card = netdev_priv(netdev);
1906 tasklet_kill(&card->rxram_full_tl);
1907 netif_poll_disable(netdev);
1908 netif_carrier_off(netdev);
1909 netif_stop_queue(netdev);
1910 del_timer_sync(&card->tx_timer);
1912 /* disable/mask all interrupts */
1913 spider_net_write_reg(card, SPIDER_NET_GHIINT0MSK, 0);
1914 spider_net_write_reg(card, SPIDER_NET_GHIINT1MSK, 0);
1915 spider_net_write_reg(card, SPIDER_NET_GHIINT2MSK, 0);
1917 /* free_irq(netdev->irq, netdev);*/
1918 free_irq(to_pci_dev(netdev->class_dev.dev)->irq, netdev);
1920 spider_net_write_reg(card, SPIDER_NET_GDTDMACCNTR,
1921 SPIDER_NET_DMA_TX_FEND_VALUE);
1923 /* turn off DMA, force end */
1924 spider_net_disable_rxdmac(card);
1926 /* release chains */
1927 spider_net_release_tx_chain(card, 1);
1929 spider_net_free_chain(card, &card->tx_chain);
1930 spider_net_free_chain(card, &card->rx_chain);
1936 * spider_net_tx_timeout_task - task scheduled by the watchdog timeout
1937 * function (to be called not under interrupt status)
1938 * @data: data, is interface device structure
1940 * called as task when tx hangs, resets interface (if interface is up)
1943 spider_net_tx_timeout_task(void *data)
1945 struct net_device *netdev = data;
1946 struct spider_net_card *card = netdev_priv(netdev);
1948 if (!(netdev->flags & IFF_UP))
1951 netif_device_detach(netdev);
1952 spider_net_stop(netdev);
1954 spider_net_workaround_rxramfull(card);
1955 spider_net_init_card(card);
1957 if (spider_net_setup_phy(card))
1959 if (spider_net_init_firmware(card))
1962 spider_net_open(netdev);
1963 spider_net_kick_tx_dma(card);
1964 netif_device_attach(netdev);
1967 atomic_dec(&card->tx_timeout_task_counter);
1971 * spider_net_tx_timeout - called when the tx timeout watchdog kicks in.
1972 * @netdev: interface device structure
1974 * called, if tx hangs. Schedules a task that resets the interface
1977 spider_net_tx_timeout(struct net_device *netdev)
1979 struct spider_net_card *card;
1981 card = netdev_priv(netdev);
1982 atomic_inc(&card->tx_timeout_task_counter);
1983 if (netdev->flags & IFF_UP)
1984 schedule_work(&card->tx_timeout_task);
1986 atomic_dec(&card->tx_timeout_task_counter);
1987 card->spider_stats.tx_timeouts++;
1991 * spider_net_setup_netdev_ops - initialization of net_device operations
1992 * @netdev: net_device structure
1994 * fills out function pointers in the net_device structure
1997 spider_net_setup_netdev_ops(struct net_device *netdev)
1999 netdev->open = &spider_net_open;
2000 netdev->stop = &spider_net_stop;
2001 netdev->hard_start_xmit = &spider_net_xmit;
2002 netdev->get_stats = &spider_net_get_stats;
2003 netdev->set_multicast_list = &spider_net_set_multi;
2004 netdev->set_mac_address = &spider_net_set_mac;
2005 netdev->change_mtu = &spider_net_change_mtu;
2006 netdev->do_ioctl = &spider_net_do_ioctl;
2008 netdev->tx_timeout = &spider_net_tx_timeout;
2009 netdev->watchdog_timeo = SPIDER_NET_WATCHDOG_TIMEOUT;
2011 netdev->poll = &spider_net_poll;
2012 netdev->weight = SPIDER_NET_NAPI_WEIGHT;
2014 netdev->vlan_rx_register = &spider_net_vlan_rx_reg;
2015 netdev->vlan_rx_add_vid = &spider_net_vlan_rx_add;
2016 netdev->vlan_rx_kill_vid = &spider_net_vlan_rx_kill;
2017 #ifdef CONFIG_NET_POLL_CONTROLLER
2018 /* poll controller */
2019 netdev->poll_controller = &spider_net_poll_controller;
2020 #endif /* CONFIG_NET_POLL_CONTROLLER */
2022 netdev->ethtool_ops = &spider_net_ethtool_ops;
2026 * spider_net_setup_netdev - initialization of net_device
2027 * @card: card structure
2029 * Returns 0 on success or <0 on failure
2031 * spider_net_setup_netdev initializes the net_device structure
2034 spider_net_setup_netdev(struct spider_net_card *card)
2037 struct net_device *netdev = card->netdev;
2038 struct device_node *dn;
2039 struct sockaddr addr;
2042 SET_MODULE_OWNER(netdev);
2043 SET_NETDEV_DEV(netdev, &card->pdev->dev);
2045 pci_set_drvdata(card->pdev, netdev);
2047 card->rxram_full_tl.data = (unsigned long) card;
2048 card->rxram_full_tl.func =
2049 (void (*)(unsigned long)) spider_net_handle_rxram_full;
2050 init_timer(&card->tx_timer);
2051 card->tx_timer.function =
2052 (void (*)(unsigned long)) spider_net_cleanup_tx_ring;
2053 card->tx_timer.data = (unsigned long) card;
2054 netdev->irq = card->pdev->irq;
2056 card->options.rx_csum = SPIDER_NET_RX_CSUM_DEFAULT;
2058 card->tx_desc = tx_descriptors;
2059 card->rx_desc = rx_descriptors;
2061 spider_net_setup_netdev_ops(netdev);
2063 netdev->features = NETIF_F_HW_CSUM | NETIF_F_LLTX;
2064 /* some time: NETIF_F_HW_VLAN_TX | NETIF_F_HW_VLAN_RX |
2065 * NETIF_F_HW_VLAN_FILTER */
2067 netdev->irq = card->pdev->irq;
2069 dn = pci_device_to_OF_node(card->pdev);
2073 mac = get_property(dn, "local-mac-address", NULL);
2076 memcpy(addr.sa_data, mac, ETH_ALEN);
2078 result = spider_net_set_mac(netdev, &addr);
2079 if ((result) && (netif_msg_probe(card)))
2080 pr_err("Failed to set MAC address: %i\n", result);
2082 result = register_netdev(netdev);
2084 if (netif_msg_probe(card))
2085 pr_err("Couldn't register net_device: %i\n",
2090 if (netif_msg_probe(card))
2091 pr_info("Initialized device %s.\n", netdev->name);
2097 * spider_net_alloc_card - allocates net_device and card structure
2099 * returns the card structure or NULL in case of errors
2101 * the card and net_device structures are linked to each other
2103 static struct spider_net_card *
2104 spider_net_alloc_card(void)
2106 struct net_device *netdev;
2107 struct spider_net_card *card;
2110 alloc_size = sizeof (*card) +
2111 sizeof (struct spider_net_descr) * rx_descriptors +
2112 sizeof (struct spider_net_descr) * tx_descriptors;
2113 netdev = alloc_etherdev(alloc_size);
2117 card = netdev_priv(netdev);
2118 card->netdev = netdev;
2119 card->msg_enable = SPIDER_NET_DEFAULT_MSG;
2120 INIT_WORK(&card->tx_timeout_task, spider_net_tx_timeout_task, netdev);
2121 init_waitqueue_head(&card->waitq);
2122 atomic_set(&card->tx_timeout_task_counter, 0);
2128 * spider_net_undo_pci_setup - releases PCI ressources
2129 * @card: card structure
2131 * spider_net_undo_pci_setup releases the mapped regions
2134 spider_net_undo_pci_setup(struct spider_net_card *card)
2136 iounmap(card->regs);
2137 pci_release_regions(card->pdev);
2141 * spider_net_setup_pci_dev - sets up the device in terms of PCI operations
2142 * @card: card structure
2145 * Returns the card structure or NULL if any errors occur
2147 * spider_net_setup_pci_dev initializes pdev and together with the
2148 * functions called in spider_net_open configures the device so that
2149 * data can be transferred over it
2150 * The net_device structure is attached to the card structure, if the
2151 * function returns without error.
2153 static struct spider_net_card *
2154 spider_net_setup_pci_dev(struct pci_dev *pdev)
2156 struct spider_net_card *card;
2157 unsigned long mmio_start, mmio_len;
2159 if (pci_enable_device(pdev)) {
2160 pr_err("Couldn't enable PCI device\n");
2164 if (!(pci_resource_flags(pdev, 0) & IORESOURCE_MEM)) {
2165 pr_err("Couldn't find proper PCI device base address.\n");
2166 goto out_disable_dev;
2169 if (pci_request_regions(pdev, spider_net_driver_name)) {
2170 pr_err("Couldn't obtain PCI resources, aborting.\n");
2171 goto out_disable_dev;
2174 pci_set_master(pdev);
2176 card = spider_net_alloc_card();
2178 pr_err("Couldn't allocate net_device structure, "
2180 goto out_release_regions;
2184 /* fetch base address and length of first resource */
2185 mmio_start = pci_resource_start(pdev, 0);
2186 mmio_len = pci_resource_len(pdev, 0);
2188 card->netdev->mem_start = mmio_start;
2189 card->netdev->mem_end = mmio_start + mmio_len;
2190 card->regs = ioremap(mmio_start, mmio_len);
2193 pr_err("Couldn't obtain PCI resources, aborting.\n");
2194 goto out_release_regions;
2199 out_release_regions:
2200 pci_release_regions(pdev);
2202 pci_disable_device(pdev);
2203 pci_set_drvdata(pdev, NULL);
2208 * spider_net_probe - initialization of a device
2210 * @ent: entry in the device id list
2212 * Returns 0 on success, <0 on failure
2214 * spider_net_probe initializes pdev and registers a net_device
2215 * structure for it. After that, the device can be ifconfig'ed up
2217 static int __devinit
2218 spider_net_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
2221 struct spider_net_card *card;
2223 card = spider_net_setup_pci_dev(pdev);
2227 spider_net_workaround_rxramfull(card);
2228 spider_net_init_card(card);
2230 err = spider_net_setup_phy(card);
2234 err = spider_net_init_firmware(card);
2238 err = spider_net_setup_netdev(card);
2245 spider_net_undo_pci_setup(card);
2246 free_netdev(card->netdev);
2252 * spider_net_remove - removal of a device
2255 * Returns 0 on success, <0 on failure
2257 * spider_net_remove is called to remove the device and unregisters the
2260 static void __devexit
2261 spider_net_remove(struct pci_dev *pdev)
2263 struct net_device *netdev;
2264 struct spider_net_card *card;
2266 netdev = pci_get_drvdata(pdev);
2267 card = netdev_priv(netdev);
2269 wait_event(card->waitq,
2270 atomic_read(&card->tx_timeout_task_counter) == 0);
2272 unregister_netdev(netdev);
2274 /* switch off card */
2275 spider_net_write_reg(card, SPIDER_NET_CKRCTRL,
2276 SPIDER_NET_CKRCTRL_STOP_VALUE);
2277 spider_net_write_reg(card, SPIDER_NET_CKRCTRL,
2278 SPIDER_NET_CKRCTRL_RUN_VALUE);
2280 spider_net_undo_pci_setup(card);
2281 free_netdev(netdev);
2284 static struct pci_driver spider_net_driver = {
2285 .name = spider_net_driver_name,
2286 .id_table = spider_net_pci_tbl,
2287 .probe = spider_net_probe,
2288 .remove = __devexit_p(spider_net_remove)
2292 * spider_net_init - init function when the driver is loaded
2294 * spider_net_init registers the device driver
2296 static int __init spider_net_init(void)
2298 printk(KERN_INFO "Spidernet version %s.\n", VERSION);
2300 if (rx_descriptors < SPIDER_NET_RX_DESCRIPTORS_MIN) {
2301 rx_descriptors = SPIDER_NET_RX_DESCRIPTORS_MIN;
2302 pr_info("adjusting rx descriptors to %i.\n", rx_descriptors);
2304 if (rx_descriptors > SPIDER_NET_RX_DESCRIPTORS_MAX) {
2305 rx_descriptors = SPIDER_NET_RX_DESCRIPTORS_MAX;
2306 pr_info("adjusting rx descriptors to %i.\n", rx_descriptors);
2308 if (tx_descriptors < SPIDER_NET_TX_DESCRIPTORS_MIN) {
2309 tx_descriptors = SPIDER_NET_TX_DESCRIPTORS_MIN;
2310 pr_info("adjusting tx descriptors to %i.\n", tx_descriptors);
2312 if (tx_descriptors > SPIDER_NET_TX_DESCRIPTORS_MAX) {
2313 tx_descriptors = SPIDER_NET_TX_DESCRIPTORS_MAX;
2314 pr_info("adjusting tx descriptors to %i.\n", tx_descriptors);
2317 return pci_register_driver(&spider_net_driver);
2321 * spider_net_cleanup - exit function when driver is unloaded
2323 * spider_net_cleanup unregisters the device driver
2325 static void __exit spider_net_cleanup(void)
2327 pci_unregister_driver(&spider_net_driver);
2330 module_init(spider_net_init);
2331 module_exit(spider_net_cleanup);