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)
91 /* We use the powerpc specific variants instead of readl_be() because
92 * we know spidernet is not a real PCI device and we can thus avoid the
93 * performance hit caused by the PCI workarounds.
95 return in_be32(card->regs + reg);
99 * spider_net_write_reg - writes to an SMMIO register of a card
100 * @card: device structure
101 * @reg: register to write to
102 * @value: value to write into the specified SMMIO register
105 spider_net_write_reg(struct spider_net_card *card, u32 reg, u32 value)
107 /* We use the powerpc specific variants instead of writel_be() because
108 * we know spidernet is not a real PCI device and we can thus avoid the
109 * performance hit caused by the PCI workarounds.
111 out_be32(card->regs + reg, value);
114 /** spider_net_write_phy - write to phy register
115 * @netdev: adapter to be written to
118 * @val: value to be written to phy register
120 * spider_net_write_phy_register writes to an arbitrary PHY
121 * register via the spider GPCWOPCMD register. We assume the queue does
122 * not run full (not more than 15 commands outstanding).
125 spider_net_write_phy(struct net_device *netdev, int mii_id,
128 struct spider_net_card *card = netdev_priv(netdev);
131 writevalue = ((u32)mii_id << 21) |
132 ((u32)reg << 16) | ((u32)val);
134 spider_net_write_reg(card, SPIDER_NET_GPCWOPCMD, writevalue);
137 /** spider_net_read_phy - read from phy register
138 * @netdev: network device to be read from
142 * Returns value read from PHY register
144 * spider_net_write_phy reads from an arbitrary PHY
145 * register via the spider GPCROPCMD register
148 spider_net_read_phy(struct net_device *netdev, int mii_id, int reg)
150 struct spider_net_card *card = netdev_priv(netdev);
153 readvalue = ((u32)mii_id << 21) | ((u32)reg << 16);
154 spider_net_write_reg(card, SPIDER_NET_GPCROPCMD, readvalue);
156 /* we don't use semaphores to wait for an SPIDER_NET_GPROPCMPINT
157 * interrupt, as we poll for the completion of the read operation
158 * in spider_net_read_phy. Should take about 50 us */
160 readvalue = spider_net_read_reg(card, SPIDER_NET_GPCROPCMD);
161 } while (readvalue & SPIDER_NET_GPREXEC);
163 readvalue &= SPIDER_NET_GPRDAT_MASK;
169 * spider_net_rx_irq_off - switch off rx irq on this spider card
170 * @card: device structure
172 * switches off rx irq by masking them out in the GHIINTnMSK register
175 spider_net_rx_irq_off(struct spider_net_card *card)
179 regvalue = SPIDER_NET_INT0_MASK_VALUE & (~SPIDER_NET_RXINT);
180 spider_net_write_reg(card, SPIDER_NET_GHIINT0MSK, regvalue);
184 * spider_net_rx_irq_on - switch on rx irq on this spider card
185 * @card: device structure
187 * switches on rx irq by enabling them in the GHIINTnMSK register
190 spider_net_rx_irq_on(struct spider_net_card *card)
194 regvalue = SPIDER_NET_INT0_MASK_VALUE | SPIDER_NET_RXINT;
195 spider_net_write_reg(card, SPIDER_NET_GHIINT0MSK, regvalue);
199 * spider_net_set_promisc - sets the unicast address or the promiscuous mode
200 * @card: card structure
202 * spider_net_set_promisc sets the unicast destination address filter and
203 * thus either allows for non-promisc mode or promisc mode
206 spider_net_set_promisc(struct spider_net_card *card)
209 struct net_device *netdev = card->netdev;
211 if (netdev->flags & IFF_PROMISC) {
212 /* clear destination entry 0 */
213 spider_net_write_reg(card, SPIDER_NET_GMRUAFILnR, 0);
214 spider_net_write_reg(card, SPIDER_NET_GMRUAFILnR + 0x04, 0);
215 spider_net_write_reg(card, SPIDER_NET_GMRUA0FIL15R,
216 SPIDER_NET_PROMISC_VALUE);
218 macu = netdev->dev_addr[0];
220 macu |= netdev->dev_addr[1];
221 memcpy(&macl, &netdev->dev_addr[2], sizeof(macl));
223 macu |= SPIDER_NET_UA_DESCR_VALUE;
224 spider_net_write_reg(card, SPIDER_NET_GMRUAFILnR, macu);
225 spider_net_write_reg(card, SPIDER_NET_GMRUAFILnR + 0x04, macl);
226 spider_net_write_reg(card, SPIDER_NET_GMRUA0FIL15R,
227 SPIDER_NET_NONPROMISC_VALUE);
232 * spider_net_get_mac_address - read mac address from spider card
233 * @card: device structure
235 * reads MAC address from GMACUNIMACU and GMACUNIMACL registers
238 spider_net_get_mac_address(struct net_device *netdev)
240 struct spider_net_card *card = netdev_priv(netdev);
243 macl = spider_net_read_reg(card, SPIDER_NET_GMACUNIMACL);
244 macu = spider_net_read_reg(card, SPIDER_NET_GMACUNIMACU);
246 netdev->dev_addr[0] = (macu >> 24) & 0xff;
247 netdev->dev_addr[1] = (macu >> 16) & 0xff;
248 netdev->dev_addr[2] = (macu >> 8) & 0xff;
249 netdev->dev_addr[3] = macu & 0xff;
250 netdev->dev_addr[4] = (macl >> 8) & 0xff;
251 netdev->dev_addr[5] = macl & 0xff;
253 if (!is_valid_ether_addr(&netdev->dev_addr[0]))
260 * spider_net_get_descr_status -- returns the status of a descriptor
261 * @descr: descriptor to look at
263 * returns the status as in the dmac_cmd_status field of the descriptor
266 spider_net_get_descr_status(struct spider_net_descr *descr)
268 return descr->dmac_cmd_status & SPIDER_NET_DESCR_IND_PROC_MASK;
272 * spider_net_free_chain - free descriptor chain
273 * @card: card structure
274 * @chain: address of chain
278 spider_net_free_chain(struct spider_net_card *card,
279 struct spider_net_descr_chain *chain)
281 struct spider_net_descr *descr;
286 descr->next_descr_addr = 0;
288 } while (descr != chain->ring);
290 dma_free_coherent(&card->pdev->dev, chain->num_desc,
291 chain->ring, chain->dma_addr);
295 * spider_net_init_chain - alloc and link descriptor chain
296 * @card: card structure
297 * @chain: address of chain
299 * We manage a circular list that mirrors the hardware structure,
300 * except that the hardware uses bus addresses.
302 * Returns 0 on success, <0 on failure
305 spider_net_init_chain(struct spider_net_card *card,
306 struct spider_net_descr_chain *chain)
309 struct spider_net_descr *descr;
313 alloc_size = chain->num_desc * sizeof (struct spider_net_descr);
315 chain->ring = dma_alloc_coherent(&card->pdev->dev, alloc_size,
316 &chain->dma_addr, GFP_KERNEL);
322 memset(descr, 0, alloc_size);
324 /* Set up the hardware pointers in each descriptor */
325 buf = chain->dma_addr;
326 for (i=0; i < chain->num_desc; i++, descr++) {
327 descr->dmac_cmd_status = SPIDER_NET_DESCR_NOT_IN_USE;
329 descr->bus_addr = buf;
330 descr->next_descr_addr = 0;
331 descr->next = descr + 1;
332 descr->prev = descr - 1;
334 buf += sizeof(struct spider_net_descr);
336 /* do actual circular list */
337 (descr-1)->next = chain->ring;
338 chain->ring->prev = descr-1;
340 spin_lock_init(&chain->lock);
341 chain->head = chain->ring;
342 chain->tail = chain->ring;
347 * spider_net_free_rx_chain_contents - frees descr contents in rx chain
348 * @card: card structure
350 * returns 0 on success, <0 on failure
353 spider_net_free_rx_chain_contents(struct spider_net_card *card)
355 struct spider_net_descr *descr;
357 descr = card->rx_chain.head;
360 dev_kfree_skb(descr->skb);
361 pci_unmap_single(card->pdev, descr->buf_addr,
362 SPIDER_NET_MAX_FRAME,
363 PCI_DMA_BIDIRECTIONAL);
366 } while (descr != card->rx_chain.head);
370 * spider_net_prepare_rx_descr - Reinitialize RX descriptor
371 * @card: card structure
372 * @descr: descriptor to re-init
374 * Return 0 on succes, <0 on failure.
376 * Allocates a new rx skb, iommu-maps it and attaches it to the
377 * descriptor. Mark the descriptor as activated, ready-to-use.
380 spider_net_prepare_rx_descr(struct spider_net_card *card,
381 struct spider_net_descr *descr)
387 /* we need to round up the buffer size to a multiple of 128 */
388 bufsize = (SPIDER_NET_MAX_FRAME + SPIDER_NET_RXBUF_ALIGN - 1) &
389 (~(SPIDER_NET_RXBUF_ALIGN - 1));
391 /* and we need to have it 128 byte aligned, therefore we allocate a
393 /* allocate an skb */
394 descr->skb = dev_alloc_skb(bufsize + SPIDER_NET_RXBUF_ALIGN - 1);
396 if (netif_msg_rx_err(card) && net_ratelimit())
397 pr_err("Not enough memory to allocate rx buffer\n");
398 card->spider_stats.alloc_rx_skb_error++;
401 descr->buf_size = bufsize;
402 descr->result_size = 0;
403 descr->valid_size = 0;
404 descr->data_status = 0;
405 descr->data_error = 0;
407 offset = ((unsigned long)descr->skb->data) &
408 (SPIDER_NET_RXBUF_ALIGN - 1);
410 skb_reserve(descr->skb, SPIDER_NET_RXBUF_ALIGN - offset);
411 /* iommu-map the skb */
412 buf = pci_map_single(card->pdev, descr->skb->data,
413 SPIDER_NET_MAX_FRAME, PCI_DMA_FROMDEVICE);
414 descr->buf_addr = buf;
415 if (pci_dma_mapping_error(buf)) {
416 dev_kfree_skb_any(descr->skb);
417 if (netif_msg_rx_err(card) && net_ratelimit())
418 pr_err("Could not iommu-map rx buffer\n");
419 card->spider_stats.rx_iommu_map_error++;
420 descr->dmac_cmd_status = SPIDER_NET_DESCR_NOT_IN_USE;
423 descr->dmac_cmd_status = SPIDER_NET_DESCR_CARDOWNED |
424 SPIDER_NET_DMAC_NOINTR_COMPLETE;
431 * spider_net_enable_rxchtails - sets RX dmac chain tail addresses
432 * @card: card structure
434 * spider_net_enable_rxchtails sets the RX DMAC chain tail adresses in the
435 * chip by writing to the appropriate register. DMA is enabled in
436 * spider_net_enable_rxdmac.
439 spider_net_enable_rxchtails(struct spider_net_card *card)
441 /* assume chain is aligned correctly */
442 spider_net_write_reg(card, SPIDER_NET_GDADCHA ,
443 card->rx_chain.tail->bus_addr);
447 * spider_net_enable_rxdmac - enables a receive DMA controller
448 * @card: card structure
450 * spider_net_enable_rxdmac enables the DMA controller by setting RX_DMA_EN
451 * in the GDADMACCNTR register
454 spider_net_enable_rxdmac(struct spider_net_card *card)
457 spider_net_write_reg(card, SPIDER_NET_GDADMACCNTR,
458 SPIDER_NET_DMA_RX_VALUE);
462 * spider_net_refill_rx_chain - refills descriptors/skbs in the rx chains
463 * @card: card structure
465 * refills descriptors in the rx chain: allocates skbs and iommu-maps them.
468 spider_net_refill_rx_chain(struct spider_net_card *card)
470 struct spider_net_descr_chain *chain = &card->rx_chain;
473 /* one context doing the refill (and a second context seeing that
474 * and omitting it) is ok. If called by NAPI, we'll be called again
475 * as spider_net_decode_one_descr is called several times. If some
476 * interrupt calls us, the NAPI is about to clean up anyway. */
477 if (!spin_trylock_irqsave(&chain->lock, flags))
480 while (spider_net_get_descr_status(chain->head) ==
481 SPIDER_NET_DESCR_NOT_IN_USE) {
482 if (spider_net_prepare_rx_descr(card, chain->head))
484 chain->head = chain->head->next;
487 spin_unlock_irqrestore(&chain->lock, flags);
491 * spider_net_alloc_rx_skbs - Allocates rx skbs in rx descriptor chains
492 * @card: card structure
494 * Returns 0 on success, <0 on failure.
497 spider_net_alloc_rx_skbs(struct spider_net_card *card)
500 struct spider_net_descr_chain *chain;
504 chain = &card->rx_chain;
505 /* Put at least one buffer into the chain. if this fails,
506 * we've got a problem. If not, spider_net_refill_rx_chain
507 * will do the rest at the end of this function. */
508 if (spider_net_prepare_rx_descr(card, chain->head))
511 chain->head = chain->head->next;
513 /* This will allocate the rest of the rx buffers;
514 * if not, it's business as usual later on. */
515 spider_net_refill_rx_chain(card);
516 spider_net_enable_rxdmac(card);
520 spider_net_free_rx_chain_contents(card);
525 * spider_net_get_multicast_hash - generates hash for multicast filter table
526 * @addr: multicast address
528 * returns the hash value.
530 * spider_net_get_multicast_hash calculates a hash value for a given multicast
531 * address, that is used to set the multicast filter tables
534 spider_net_get_multicast_hash(struct net_device *netdev, __u8 *addr)
538 char addr_for_crc[ETH_ALEN] = { 0, };
541 for (i = 0; i < ETH_ALEN * 8; i++) {
542 bit = (addr[i / 8] >> (i % 8)) & 1;
543 addr_for_crc[ETH_ALEN - 1 - i / 8] += bit << (7 - (i % 8));
546 crc = crc32_be(~0, addr_for_crc, netdev->addr_len);
557 * spider_net_set_multi - sets multicast addresses and promisc flags
558 * @netdev: interface device structure
560 * spider_net_set_multi configures multicast addresses as needed for the
561 * netdev interface. It also sets up multicast, allmulti and promisc
562 * flags appropriately
565 spider_net_set_multi(struct net_device *netdev)
567 struct dev_mc_list *mc;
571 struct spider_net_card *card = netdev_priv(netdev);
572 unsigned long bitmask[SPIDER_NET_MULTICAST_HASHES / BITS_PER_LONG] =
575 spider_net_set_promisc(card);
577 if (netdev->flags & IFF_ALLMULTI) {
578 for (i = 0; i < SPIDER_NET_MULTICAST_HASHES; i++) {
584 /* well, we know, what the broadcast hash value is: it's xfd
585 hash = spider_net_get_multicast_hash(netdev, netdev->broadcast); */
586 set_bit(0xfd, bitmask);
588 for (mc = netdev->mc_list; mc; mc = mc->next) {
589 hash = spider_net_get_multicast_hash(netdev, mc->dmi_addr);
590 set_bit(hash, bitmask);
594 for (i = 0; i < SPIDER_NET_MULTICAST_HASHES / 4; i++) {
596 if (test_bit(i * 4, bitmask))
599 if (test_bit(i * 4 + 1, bitmask))
602 if (test_bit(i * 4 + 2, bitmask))
605 if (test_bit(i * 4 + 3, bitmask))
608 spider_net_write_reg(card, SPIDER_NET_GMRMHFILnR + i * 4, reg);
613 * spider_net_disable_rxdmac - disables the receive DMA controller
614 * @card: card structure
616 * spider_net_disable_rxdmac terminates processing on the DMA controller by
617 * turing off DMA and issueing a force end
620 spider_net_disable_rxdmac(struct spider_net_card *card)
622 spider_net_write_reg(card, SPIDER_NET_GDADMACCNTR,
623 SPIDER_NET_DMA_RX_FEND_VALUE);
627 * spider_net_prepare_tx_descr - fill tx descriptor with skb data
628 * @card: card structure
629 * @descr: descriptor structure to fill out
630 * @skb: packet to use
632 * returns 0 on success, <0 on failure.
634 * fills out the descriptor structure with skb data and len. Copies data,
635 * if needed (32bit DMA!)
638 spider_net_prepare_tx_descr(struct spider_net_card *card,
641 struct spider_net_descr *descr;
645 buf = pci_map_single(card->pdev, skb->data, skb->len, PCI_DMA_TODEVICE);
646 if (pci_dma_mapping_error(buf)) {
647 if (netif_msg_tx_err(card) && net_ratelimit())
648 pr_err("could not iommu-map packet (%p, %i). "
649 "Dropping packet\n", skb->data, skb->len);
650 card->spider_stats.tx_iommu_map_error++;
654 spin_lock_irqsave(&card->tx_chain.lock, flags);
655 descr = card->tx_chain.head;
656 card->tx_chain.head = descr->next;
658 descr->buf_addr = buf;
659 descr->buf_size = skb->len;
660 descr->next_descr_addr = 0;
662 descr->data_status = 0;
664 descr->dmac_cmd_status =
665 SPIDER_NET_DESCR_CARDOWNED | SPIDER_NET_DMAC_NOCS;
666 spin_unlock_irqrestore(&card->tx_chain.lock, flags);
668 if (skb->protocol == htons(ETH_P_IP))
669 switch (skb->nh.iph->protocol) {
671 descr->dmac_cmd_status |= SPIDER_NET_DMAC_TCP;
674 descr->dmac_cmd_status |= SPIDER_NET_DMAC_UDP;
678 /* Chain the bus address, so that the DMA engine finds this descr. */
679 descr->prev->next_descr_addr = descr->bus_addr;
681 card->netdev->trans_start = jiffies; /* set netdev watchdog timer */
686 spider_net_set_low_watermark(struct spider_net_card *card)
692 struct spider_net_descr *descr = card->tx_chain.tail;
694 /* Measure the length of the queue. Measurement does not
695 * need to be precise -- does not need a lock. */
696 while (descr != card->tx_chain.head) {
697 status = descr->dmac_cmd_status & SPIDER_NET_DESCR_NOT_IN_USE;
698 if (status == SPIDER_NET_DESCR_NOT_IN_USE)
704 /* If TX queue is short, don't even bother with interrupts */
705 if (cnt < card->tx_chain.num_desc/4)
708 /* Set low-watermark 3/4th's of the way into the queue. */
709 descr = card->tx_chain.tail;
714 /* Set the new watermark, clear the old watermark */
715 spin_lock_irqsave(&card->tx_chain.lock, flags);
716 descr->dmac_cmd_status |= SPIDER_NET_DESCR_TXDESFLG;
717 if (card->low_watermark && card->low_watermark != descr)
718 card->low_watermark->dmac_cmd_status =
719 card->low_watermark->dmac_cmd_status & ~SPIDER_NET_DESCR_TXDESFLG;
720 card->low_watermark = descr;
721 spin_unlock_irqrestore(&card->tx_chain.lock, flags);
726 * spider_net_release_tx_chain - processes sent tx descriptors
727 * @card: adapter structure
728 * @brutal: if set, don't care about whether descriptor seems to be in use
730 * returns 0 if the tx ring is empty, otherwise 1.
732 * spider_net_release_tx_chain releases the tx descriptors that spider has
733 * finished with (if non-brutal) or simply release tx descriptors (if brutal).
734 * If some other context is calling this function, we return 1 so that we're
735 * scheduled again (if we were scheduled) and will not loose initiative.
738 spider_net_release_tx_chain(struct spider_net_card *card, int brutal)
740 struct spider_net_descr_chain *chain = &card->tx_chain;
741 struct spider_net_descr *descr;
747 while (chain->tail != chain->head) {
748 spin_lock_irqsave(&chain->lock, flags);
751 status = spider_net_get_descr_status(descr);
753 case SPIDER_NET_DESCR_COMPLETE:
754 card->netdev_stats.tx_packets++;
755 card->netdev_stats.tx_bytes += descr->skb->len;
758 case SPIDER_NET_DESCR_CARDOWNED:
760 spin_unlock_irqrestore(&chain->lock, flags);
764 /* fallthrough, if we release the descriptors
765 * brutally (then we don't care about
766 * SPIDER_NET_DESCR_CARDOWNED) */
768 case SPIDER_NET_DESCR_RESPONSE_ERROR:
769 case SPIDER_NET_DESCR_PROTECTION_ERROR:
770 case SPIDER_NET_DESCR_FORCE_END:
771 if (netif_msg_tx_err(card))
772 pr_err("%s: forcing end of tx descriptor "
773 "with status x%02x\n",
774 card->netdev->name, status);
775 card->netdev_stats.tx_errors++;
779 card->netdev_stats.tx_dropped++;
781 spin_unlock_irqrestore(&chain->lock, flags);
786 chain->tail = descr->next;
787 descr->dmac_cmd_status |= SPIDER_NET_DESCR_NOT_IN_USE;
789 buf_addr = descr->buf_addr;
790 spin_unlock_irqrestore(&chain->lock, flags);
794 pci_unmap_single(card->pdev, buf_addr, skb->len,
803 * spider_net_kick_tx_dma - enables TX DMA processing
804 * @card: card structure
805 * @descr: descriptor address to enable TX processing at
807 * This routine will start the transmit DMA running if
808 * it is not already running. This routine ned only be
809 * called when queueing a new packet to an empty tx queue.
810 * Writes the current tx chain head as start address
811 * of the tx descriptor chain and enables the transmission
815 spider_net_kick_tx_dma(struct spider_net_card *card)
817 struct spider_net_descr *descr;
819 if (spider_net_read_reg(card, SPIDER_NET_GDTDMACCNTR) &
820 SPIDER_NET_TX_DMA_EN)
823 descr = card->tx_chain.tail;
825 if (spider_net_get_descr_status(descr) ==
826 SPIDER_NET_DESCR_CARDOWNED) {
827 spider_net_write_reg(card, SPIDER_NET_GDTDCHA,
829 spider_net_write_reg(card, SPIDER_NET_GDTDMACCNTR,
830 SPIDER_NET_DMA_TX_VALUE);
833 if (descr == card->tx_chain.head)
839 mod_timer(&card->tx_timer, jiffies + SPIDER_NET_TX_TIMER);
843 * spider_net_xmit - transmits a frame over the device
844 * @skb: packet to send out
845 * @netdev: interface device structure
847 * returns 0 on success, !0 on failure
850 spider_net_xmit(struct sk_buff *skb, struct net_device *netdev)
853 struct spider_net_card *card = netdev_priv(netdev);
854 struct spider_net_descr_chain *chain = &card->tx_chain;
856 spider_net_release_tx_chain(card, 0);
858 if ((chain->head->next == chain->tail->prev) ||
859 (spider_net_prepare_tx_descr(card, skb) != 0)) {
861 card->netdev_stats.tx_dropped++;
862 netif_stop_queue(netdev);
863 return NETDEV_TX_BUSY;
866 cnt = spider_net_set_low_watermark(card);
868 spider_net_kick_tx_dma(card);
873 * spider_net_cleanup_tx_ring - cleans up the TX ring
874 * @card: card structure
876 * spider_net_cleanup_tx_ring is called by either the tx_timer
877 * or from the NAPI polling routine.
878 * This routine releases resources associted with transmitted
879 * packets, including updating the queue tail pointer.
882 spider_net_cleanup_tx_ring(struct spider_net_card *card)
884 if ((spider_net_release_tx_chain(card, 0) != 0) &&
885 (card->netdev->flags & IFF_UP)) {
886 spider_net_kick_tx_dma(card);
887 netif_wake_queue(card->netdev);
892 * spider_net_do_ioctl - called for device ioctls
893 * @netdev: interface device structure
894 * @ifr: request parameter structure for ioctl
895 * @cmd: command code for ioctl
897 * returns 0 on success, <0 on failure. Currently, we have no special ioctls.
898 * -EOPNOTSUPP is returned, if an unknown ioctl was requested
901 spider_net_do_ioctl(struct net_device *netdev, struct ifreq *ifr, int cmd)
910 * spider_net_pass_skb_up - takes an skb from a descriptor and passes it on
911 * @descr: descriptor to process
912 * @card: card structure
914 * Fills out skb structure and passes the data to the stack.
915 * The descriptor state is not changed.
918 spider_net_pass_skb_up(struct spider_net_descr *descr,
919 struct spider_net_card *card)
922 struct net_device *netdev;
923 u32 data_status, data_error;
925 data_status = descr->data_status;
926 data_error = descr->data_error;
927 netdev = card->netdev;
931 skb_put(skb, descr->valid_size);
933 /* the card seems to add 2 bytes of junk in front
934 * of the ethernet frame */
935 #define SPIDER_MISALIGN 2
936 skb_pull(skb, SPIDER_MISALIGN);
937 skb->protocol = eth_type_trans(skb, netdev);
939 /* checksum offload */
940 if (card->options.rx_csum) {
941 if ( ( (data_status & SPIDER_NET_DATA_STATUS_CKSUM_MASK) ==
942 SPIDER_NET_DATA_STATUS_CKSUM_MASK) &&
943 !(data_error & SPIDER_NET_DATA_ERR_CKSUM_MASK))
944 skb->ip_summed = CHECKSUM_UNNECESSARY;
946 skb->ip_summed = CHECKSUM_NONE;
948 skb->ip_summed = CHECKSUM_NONE;
950 if (data_status & SPIDER_NET_VLAN_PACKET) {
951 /* further enhancements: HW-accel VLAN
952 * vlan_hwaccel_receive_skb
956 /* pass skb up to stack */
957 netif_receive_skb(skb);
959 /* update netdevice statistics */
960 card->netdev_stats.rx_packets++;
961 card->netdev_stats.rx_bytes += skb->len;
965 static void show_rx_chain(struct spider_net_card *card)
967 struct spider_net_descr_chain *chain = &card->rx_chain;
968 struct spider_net_descr *start= chain->tail;
969 struct spider_net_descr *descr= start;
973 int cstat = spider_net_get_descr_status(descr);
974 printk(KERN_INFO "RX chain tail at descr=%ld\n",
975 (start - card->descr) - card->tx_chain.num_desc);
979 status = spider_net_get_descr_status(descr);
980 if (cstat != status) {
981 printk(KERN_INFO "Have %d descrs with stat=x%08x\n", cnt, cstat);
987 } while (descr != start);
988 printk(KERN_INFO "Last %d descrs with stat=x%08x\n", cnt, cstat);
993 * spider_net_decode_one_descr - processes an rx descriptor
994 * @card: card structure
996 * Returns 1 if a packet has been sent to the stack, otherwise 0
998 * Processes an rx descriptor by iommu-unmapping the data buffer and passing
999 * the packet up to the stack. This function is called in softirq
1000 * context, e.g. either bottom half from interrupt or NAPI polling context
1003 spider_net_decode_one_descr(struct spider_net_card *card)
1005 struct spider_net_descr_chain *chain = &card->rx_chain;
1006 struct spider_net_descr *descr = chain->tail;
1009 status = spider_net_get_descr_status(descr);
1011 /* Nothing in the descriptor, or ring must be empty */
1012 if ((status == SPIDER_NET_DESCR_CARDOWNED) ||
1013 (status == SPIDER_NET_DESCR_NOT_IN_USE))
1016 /* descriptor definitively used -- move on tail */
1017 chain->tail = descr->next;
1019 /* unmap descriptor */
1020 pci_unmap_single(card->pdev, descr->buf_addr,
1021 SPIDER_NET_MAX_FRAME, PCI_DMA_FROMDEVICE);
1023 if ( (status == SPIDER_NET_DESCR_RESPONSE_ERROR) ||
1024 (status == SPIDER_NET_DESCR_PROTECTION_ERROR) ||
1025 (status == SPIDER_NET_DESCR_FORCE_END) ) {
1026 if (netif_msg_rx_err(card))
1027 pr_err("%s: dropping RX descriptor with state %d\n",
1028 card->netdev->name, status);
1029 card->netdev_stats.rx_dropped++;
1033 if ( (status != SPIDER_NET_DESCR_COMPLETE) &&
1034 (status != SPIDER_NET_DESCR_FRAME_END) ) {
1035 if (netif_msg_rx_err(card))
1036 pr_err("%s: RX descriptor with unkown state %d\n",
1037 card->netdev->name, status);
1038 card->spider_stats.rx_desc_unk_state++;
1042 /* The cases we'll throw away the packet immediately */
1043 if (descr->data_error & SPIDER_NET_DESTROY_RX_FLAGS) {
1044 if (netif_msg_rx_err(card))
1045 pr_err("%s: error in received descriptor found, "
1046 "data_status=x%08x, data_error=x%08x\n",
1048 descr->data_status, descr->data_error);
1052 if (descr->dmac_cmd_status & 0xfefe) {
1053 pr_err("%s: bad status, cmd_status=x%08x\n",
1055 descr->dmac_cmd_status);
1056 pr_err("buf_addr=x%08x\n", descr->buf_addr);
1057 pr_err("buf_size=x%08x\n", descr->buf_size);
1058 pr_err("next_descr_addr=x%08x\n", descr->next_descr_addr);
1059 pr_err("result_size=x%08x\n", descr->result_size);
1060 pr_err("valid_size=x%08x\n", descr->valid_size);
1061 pr_err("data_status=x%08x\n", descr->data_status);
1062 pr_err("data_error=x%08x\n", descr->data_error);
1063 pr_err("bus_addr=x%08x\n", descr->bus_addr);
1064 pr_err("which=%ld\n", descr - card->rx_chain.ring);
1066 card->spider_stats.rx_desc_error++;
1070 /* Ok, we've got a packet in descr */
1071 spider_net_pass_skb_up(descr, card);
1072 descr->dmac_cmd_status = SPIDER_NET_DESCR_NOT_IN_USE;
1076 dev_kfree_skb_irq(descr->skb);
1077 descr->dmac_cmd_status = SPIDER_NET_DESCR_NOT_IN_USE;
1082 * spider_net_poll - NAPI poll function called by the stack to return packets
1083 * @netdev: interface device structure
1084 * @budget: number of packets we can pass to the stack at most
1086 * returns 0 if no more packets available to the driver/stack. Returns 1,
1087 * if the quota is exceeded, but the driver has still packets.
1089 * spider_net_poll returns all packets from the rx descriptors to the stack
1090 * (using netif_receive_skb). If all/enough packets are up, the driver
1091 * reenables interrupts and returns 0. If not, 1 is returned.
1094 spider_net_poll(struct net_device *netdev, int *budget)
1096 struct spider_net_card *card = netdev_priv(netdev);
1097 int packets_to_do, packets_done = 0;
1098 int no_more_packets = 0;
1100 spider_net_cleanup_tx_ring(card);
1101 packets_to_do = min(*budget, netdev->quota);
1103 while (packets_to_do) {
1104 if (spider_net_decode_one_descr(card)) {
1108 /* no more packets for the stack */
1109 no_more_packets = 1;
1114 netdev->quota -= packets_done;
1115 *budget -= packets_done;
1116 spider_net_refill_rx_chain(card);
1117 spider_net_enable_rxdmac(card);
1119 /* if all packets are in the stack, enable interrupts and return 0 */
1120 /* if not, return 1 */
1121 if (no_more_packets) {
1122 netif_rx_complete(netdev);
1123 spider_net_rx_irq_on(card);
1131 * spider_net_vlan_rx_reg - initializes VLAN structures in the driver and card
1132 * @netdev: interface device structure
1133 * @grp: vlan_group structure that is registered (NULL on destroying interface)
1136 spider_net_vlan_rx_reg(struct net_device *netdev, struct vlan_group *grp)
1138 /* further enhancement... yet to do */
1143 * spider_net_vlan_rx_add - adds VLAN id to the card filter
1144 * @netdev: interface device structure
1145 * @vid: VLAN id to add
1148 spider_net_vlan_rx_add(struct net_device *netdev, uint16_t vid)
1150 /* further enhancement... yet to do */
1151 /* add vid to card's VLAN filter table */
1156 * spider_net_vlan_rx_kill - removes VLAN id to the card filter
1157 * @netdev: interface device structure
1158 * @vid: VLAN id to remove
1161 spider_net_vlan_rx_kill(struct net_device *netdev, uint16_t vid)
1163 /* further enhancement... yet to do */
1164 /* remove vid from card's VLAN filter table */
1168 * spider_net_get_stats - get interface statistics
1169 * @netdev: interface device structure
1171 * returns the interface statistics residing in the spider_net_card struct
1173 static struct net_device_stats *
1174 spider_net_get_stats(struct net_device *netdev)
1176 struct spider_net_card *card = netdev_priv(netdev);
1177 struct net_device_stats *stats = &card->netdev_stats;
1182 * spider_net_change_mtu - changes the MTU of an interface
1183 * @netdev: interface device structure
1184 * @new_mtu: new MTU value
1186 * returns 0 on success, <0 on failure
1189 spider_net_change_mtu(struct net_device *netdev, int new_mtu)
1191 /* no need to re-alloc skbs or so -- the max mtu is about 2.3k
1192 * and mtu is outbound only anyway */
1193 if ( (new_mtu < SPIDER_NET_MIN_MTU ) ||
1194 (new_mtu > SPIDER_NET_MAX_MTU) )
1196 netdev->mtu = new_mtu;
1201 * spider_net_set_mac - sets the MAC of an interface
1202 * @netdev: interface device structure
1203 * @ptr: pointer to new MAC address
1205 * Returns 0 on success, <0 on failure. Currently, we don't support this
1206 * and will always return EOPNOTSUPP.
1209 spider_net_set_mac(struct net_device *netdev, void *p)
1211 struct spider_net_card *card = netdev_priv(netdev);
1212 u32 macl, macu, regvalue;
1213 struct sockaddr *addr = p;
1215 if (!is_valid_ether_addr(addr->sa_data))
1216 return -EADDRNOTAVAIL;
1218 /* switch off GMACTPE and GMACRPE */
1219 regvalue = spider_net_read_reg(card, SPIDER_NET_GMACOPEMD);
1220 regvalue &= ~((1 << 5) | (1 << 6));
1221 spider_net_write_reg(card, SPIDER_NET_GMACOPEMD, regvalue);
1224 macu = (addr->sa_data[0]<<24) + (addr->sa_data[1]<<16) +
1225 (addr->sa_data[2]<<8) + (addr->sa_data[3]);
1226 macl = (addr->sa_data[4]<<8) + (addr->sa_data[5]);
1227 spider_net_write_reg(card, SPIDER_NET_GMACUNIMACU, macu);
1228 spider_net_write_reg(card, SPIDER_NET_GMACUNIMACL, macl);
1230 /* switch GMACTPE and GMACRPE back on */
1231 regvalue = spider_net_read_reg(card, SPIDER_NET_GMACOPEMD);
1232 regvalue |= ((1 << 5) | (1 << 6));
1233 spider_net_write_reg(card, SPIDER_NET_GMACOPEMD, regvalue);
1235 spider_net_set_promisc(card);
1237 /* look up, whether we have been successful */
1238 if (spider_net_get_mac_address(netdev))
1239 return -EADDRNOTAVAIL;
1240 if (memcmp(netdev->dev_addr,addr->sa_data,netdev->addr_len))
1241 return -EADDRNOTAVAIL;
1247 * spider_net_handle_error_irq - handles errors raised by an interrupt
1248 * @card: card structure
1249 * @status_reg: interrupt status register 0 (GHIINT0STS)
1251 * spider_net_handle_error_irq treats or ignores all error conditions
1252 * found when an interrupt is presented
1255 spider_net_handle_error_irq(struct spider_net_card *card, u32 status_reg)
1257 u32 error_reg1, error_reg2;
1261 error_reg1 = spider_net_read_reg(card, SPIDER_NET_GHIINT1STS);
1262 error_reg2 = spider_net_read_reg(card, SPIDER_NET_GHIINT2STS);
1264 /* check GHIINT0STS ************************************/
1266 for (i = 0; i < 32; i++)
1267 if (status_reg & (1<<i))
1270 /* let error_reg1 and error_reg2 evaluation decide, what to do
1271 case SPIDER_NET_PHYINT:
1272 case SPIDER_NET_GMAC2INT:
1273 case SPIDER_NET_GMAC1INT:
1274 case SPIDER_NET_GFIFOINT:
1275 case SPIDER_NET_DMACINT:
1276 case SPIDER_NET_GSYSINT:
1279 case SPIDER_NET_GIPSINT:
1283 case SPIDER_NET_GPWOPCMPINT:
1284 /* PHY write operation completed */
1287 case SPIDER_NET_GPROPCMPINT:
1288 /* PHY read operation completed */
1289 /* we don't use semaphores, as we poll for the completion
1290 * of the read operation in spider_net_read_phy. Should take
1294 case SPIDER_NET_GPWFFINT:
1295 /* PHY command queue full */
1296 if (netif_msg_intr(card))
1297 pr_err("PHY write queue full\n");
1301 /* case SPIDER_NET_GRMDADRINT: not used. print a message */
1302 /* case SPIDER_NET_GRMARPINT: not used. print a message */
1303 /* case SPIDER_NET_GRMMPINT: not used. print a message */
1305 case SPIDER_NET_GDTDEN0INT:
1306 /* someone has set TX_DMA_EN to 0 */
1310 case SPIDER_NET_GDDDEN0INT: /* fallthrough */
1311 case SPIDER_NET_GDCDEN0INT: /* fallthrough */
1312 case SPIDER_NET_GDBDEN0INT: /* fallthrough */
1313 case SPIDER_NET_GDADEN0INT:
1314 /* someone has set RX_DMA_EN to 0 */
1319 case SPIDER_NET_GDDFDCINT:
1320 case SPIDER_NET_GDCFDCINT:
1321 case SPIDER_NET_GDBFDCINT:
1322 case SPIDER_NET_GDAFDCINT:
1323 /* case SPIDER_NET_GDNMINT: not used. print a message */
1324 /* case SPIDER_NET_GCNMINT: not used. print a message */
1325 /* case SPIDER_NET_GBNMINT: not used. print a message */
1326 /* case SPIDER_NET_GANMINT: not used. print a message */
1327 /* case SPIDER_NET_GRFNMINT: not used. print a message */
1332 case SPIDER_NET_GDTFDCINT:
1335 case SPIDER_NET_GTTEDINT:
1338 case SPIDER_NET_GDTDCEINT:
1339 /* chain end. If a descriptor should be sent, kick off
1341 if (card->tx_chain.tail != card->tx_chain.head)
1342 spider_net_kick_tx_dma(card);
1347 /* case SPIDER_NET_G1TMCNTINT: not used. print a message */
1348 /* case SPIDER_NET_GFREECNTINT: not used. print a message */
1351 /* check GHIINT1STS ************************************/
1353 for (i = 0; i < 32; i++)
1354 if (error_reg1 & (1<<i))
1357 case SPIDER_NET_GTMFLLINT:
1358 if (netif_msg_intr(card) && net_ratelimit())
1359 pr_err("Spider TX RAM full\n");
1362 case SPIDER_NET_GRFDFLLINT: /* fallthrough */
1363 case SPIDER_NET_GRFCFLLINT: /* fallthrough */
1364 case SPIDER_NET_GRFBFLLINT: /* fallthrough */
1365 case SPIDER_NET_GRFAFLLINT: /* fallthrough */
1366 case SPIDER_NET_GRMFLLINT:
1367 if (netif_msg_intr(card) && net_ratelimit())
1368 pr_err("Spider RX RAM full, incoming packets "
1369 "might be discarded!\n");
1370 spider_net_rx_irq_off(card);
1371 netif_rx_schedule(card->netdev);
1375 /* case SPIDER_NET_GTMSHTINT: problem, print a message */
1376 case SPIDER_NET_GDTINVDINT:
1377 /* allrighty. tx from previous descr ok */
1382 case SPIDER_NET_GDDDCEINT: /* fallthrough */
1383 case SPIDER_NET_GDCDCEINT: /* fallthrough */
1384 case SPIDER_NET_GDBDCEINT: /* fallthrough */
1385 case SPIDER_NET_GDADCEINT:
1386 if (netif_msg_intr(card) && net_ratelimit())
1387 pr_err("got descriptor chain end interrupt, "
1388 "restarting DMAC %c.\n",
1389 'D'-(i-SPIDER_NET_GDDDCEINT)/3);
1390 spider_net_refill_rx_chain(card);
1391 spider_net_enable_rxdmac(card);
1395 /* invalid descriptor */
1396 case SPIDER_NET_GDDINVDINT: /* fallthrough */
1397 case SPIDER_NET_GDCINVDINT: /* fallthrough */
1398 case SPIDER_NET_GDBINVDINT: /* fallthrough */
1399 case SPIDER_NET_GDAINVDINT:
1400 /* could happen when rx chain is full */
1401 spider_net_refill_rx_chain(card);
1402 spider_net_enable_rxdmac(card);
1406 /* case SPIDER_NET_GDTRSERINT: problem, print a message */
1407 /* case SPIDER_NET_GDDRSERINT: problem, print a message */
1408 /* case SPIDER_NET_GDCRSERINT: problem, print a message */
1409 /* case SPIDER_NET_GDBRSERINT: problem, print a message */
1410 /* case SPIDER_NET_GDARSERINT: problem, print a message */
1411 /* case SPIDER_NET_GDSERINT: problem, print a message */
1412 /* case SPIDER_NET_GDTPTERINT: problem, print a message */
1413 /* case SPIDER_NET_GDDPTERINT: problem, print a message */
1414 /* case SPIDER_NET_GDCPTERINT: problem, print a message */
1415 /* case SPIDER_NET_GDBPTERINT: problem, print a message */
1416 /* case SPIDER_NET_GDAPTERINT: problem, print a message */
1422 /* check GHIINT2STS ************************************/
1424 for (i = 0; i < 32; i++)
1425 if (error_reg2 & (1<<i))
1428 /* there is nothing we can (want to) do at this time. Log a
1429 * message, we can switch on and off the specific values later on
1430 case SPIDER_NET_GPROPERINT:
1431 case SPIDER_NET_GMCTCRSNGINT:
1432 case SPIDER_NET_GMCTLCOLINT:
1433 case SPIDER_NET_GMCTTMOTINT:
1434 case SPIDER_NET_GMCRCAERINT:
1435 case SPIDER_NET_GMCRCALERINT:
1436 case SPIDER_NET_GMCRALNERINT:
1437 case SPIDER_NET_GMCROVRINT:
1438 case SPIDER_NET_GMCRRNTINT:
1439 case SPIDER_NET_GMCRRXERINT:
1440 case SPIDER_NET_GTITCSERINT:
1441 case SPIDER_NET_GTIFMTERINT:
1442 case SPIDER_NET_GTIPKTRVKINT:
1443 case SPIDER_NET_GTISPINGINT:
1444 case SPIDER_NET_GTISADNGINT:
1445 case SPIDER_NET_GTISPDNGINT:
1446 case SPIDER_NET_GRIFMTERINT:
1447 case SPIDER_NET_GRIPKTRVKINT:
1448 case SPIDER_NET_GRISPINGINT:
1449 case SPIDER_NET_GRISADNGINT:
1450 case SPIDER_NET_GRISPDNGINT:
1457 if ((show_error) && (netif_msg_intr(card)) && net_ratelimit())
1458 pr_err("Got error interrupt on %s, GHIINT0STS = 0x%08x, "
1459 "GHIINT1STS = 0x%08x, GHIINT2STS = 0x%08x\n",
1461 status_reg, error_reg1, error_reg2);
1463 /* clear interrupt sources */
1464 spider_net_write_reg(card, SPIDER_NET_GHIINT1STS, error_reg1);
1465 spider_net_write_reg(card, SPIDER_NET_GHIINT2STS, error_reg2);
1469 * spider_net_interrupt - interrupt handler for spider_net
1470 * @irq: interupt number
1471 * @ptr: pointer to net_device
1472 * @regs: PU registers
1474 * returns IRQ_HANDLED, if interrupt was for driver, or IRQ_NONE, if no
1475 * interrupt found raised by card.
1477 * This is the interrupt handler, that turns off
1478 * interrupts for this device and makes the stack poll the driver
1481 spider_net_interrupt(int irq, void *ptr)
1483 struct net_device *netdev = ptr;
1484 struct spider_net_card *card = netdev_priv(netdev);
1487 status_reg = spider_net_read_reg(card, SPIDER_NET_GHIINT0STS);
1492 if (status_reg & SPIDER_NET_RXINT ) {
1493 spider_net_rx_irq_off(card);
1494 netif_rx_schedule(netdev);
1496 if (status_reg & SPIDER_NET_TXINT)
1497 netif_rx_schedule(netdev);
1499 if (status_reg & SPIDER_NET_ERRINT )
1500 spider_net_handle_error_irq(card, status_reg);
1502 /* clear interrupt sources */
1503 spider_net_write_reg(card, SPIDER_NET_GHIINT0STS, status_reg);
1508 #ifdef CONFIG_NET_POLL_CONTROLLER
1510 * spider_net_poll_controller - artificial interrupt for netconsole etc.
1511 * @netdev: interface device structure
1513 * see Documentation/networking/netconsole.txt
1516 spider_net_poll_controller(struct net_device *netdev)
1518 disable_irq(netdev->irq);
1519 spider_net_interrupt(netdev->irq, netdev);
1520 enable_irq(netdev->irq);
1522 #endif /* CONFIG_NET_POLL_CONTROLLER */
1525 * spider_net_init_card - initializes the card
1526 * @card: card structure
1528 * spider_net_init_card initializes the card so that other registers can
1532 spider_net_init_card(struct spider_net_card *card)
1534 spider_net_write_reg(card, SPIDER_NET_CKRCTRL,
1535 SPIDER_NET_CKRCTRL_STOP_VALUE);
1537 spider_net_write_reg(card, SPIDER_NET_CKRCTRL,
1538 SPIDER_NET_CKRCTRL_RUN_VALUE);
1542 * spider_net_enable_card - enables the card by setting all kinds of regs
1543 * @card: card structure
1545 * spider_net_enable_card sets a lot of SMMIO registers to enable the device
1548 spider_net_enable_card(struct spider_net_card *card)
1551 /* the following array consists of (register),(value) pairs
1552 * that are set in this function. A register of 0 ends the list */
1554 { SPIDER_NET_GRESUMINTNUM, 0 },
1555 { SPIDER_NET_GREINTNUM, 0 },
1557 /* set interrupt frame number registers */
1558 /* clear the single DMA engine registers first */
1559 { SPIDER_NET_GFAFRMNUM, SPIDER_NET_GFXFRAMES_VALUE },
1560 { SPIDER_NET_GFBFRMNUM, SPIDER_NET_GFXFRAMES_VALUE },
1561 { SPIDER_NET_GFCFRMNUM, SPIDER_NET_GFXFRAMES_VALUE },
1562 { SPIDER_NET_GFDFRMNUM, SPIDER_NET_GFXFRAMES_VALUE },
1563 /* then set, what we really need */
1564 { SPIDER_NET_GFFRMNUM, SPIDER_NET_FRAMENUM_VALUE },
1566 /* timer counter registers and stuff */
1567 { SPIDER_NET_GFREECNNUM, 0 },
1568 { SPIDER_NET_GONETIMENUM, 0 },
1569 { SPIDER_NET_GTOUTFRMNUM, 0 },
1571 /* RX mode setting */
1572 { SPIDER_NET_GRXMDSET, SPIDER_NET_RXMODE_VALUE },
1573 /* TX mode setting */
1574 { SPIDER_NET_GTXMDSET, SPIDER_NET_TXMODE_VALUE },
1575 /* IPSEC mode setting */
1576 { SPIDER_NET_GIPSECINIT, SPIDER_NET_IPSECINIT_VALUE },
1578 { SPIDER_NET_GFTRESTRT, SPIDER_NET_RESTART_VALUE },
1580 { SPIDER_NET_GMRWOLCTRL, 0 },
1581 { SPIDER_NET_GTESTMD, 0x10000000 },
1582 { SPIDER_NET_GTTQMSK, 0x00400040 },
1584 { SPIDER_NET_GMACINTEN, 0 },
1586 /* flow control stuff */
1587 { SPIDER_NET_GMACAPAUSE, SPIDER_NET_MACAPAUSE_VALUE },
1588 { SPIDER_NET_GMACTXPAUSE, SPIDER_NET_TXPAUSE_VALUE },
1590 { SPIDER_NET_GMACBSTLMT, SPIDER_NET_BURSTLMT_VALUE },
1595 while (regs[i][0]) {
1596 spider_net_write_reg(card, regs[i][0], regs[i][1]);
1600 /* clear unicast filter table entries 1 to 14 */
1601 for (i = 1; i <= 14; i++) {
1602 spider_net_write_reg(card,
1603 SPIDER_NET_GMRUAFILnR + i * 8,
1605 spider_net_write_reg(card,
1606 SPIDER_NET_GMRUAFILnR + i * 8 + 4,
1610 spider_net_write_reg(card, SPIDER_NET_GMRUA0FIL15R, 0x08080000);
1612 spider_net_write_reg(card, SPIDER_NET_ECMODE, SPIDER_NET_ECMODE_VALUE);
1614 /* set chain tail adress for RX chains and
1616 spider_net_enable_rxchtails(card);
1617 spider_net_enable_rxdmac(card);
1619 spider_net_write_reg(card, SPIDER_NET_GRXDMAEN, SPIDER_NET_WOL_VALUE);
1621 spider_net_write_reg(card, SPIDER_NET_GMACLENLMT,
1622 SPIDER_NET_LENLMT_VALUE);
1623 spider_net_write_reg(card, SPIDER_NET_GMACMODE,
1624 SPIDER_NET_MACMODE_VALUE);
1625 spider_net_write_reg(card, SPIDER_NET_GMACOPEMD,
1626 SPIDER_NET_OPMODE_VALUE);
1628 /* set interrupt mask registers */
1629 spider_net_write_reg(card, SPIDER_NET_GHIINT0MSK,
1630 SPIDER_NET_INT0_MASK_VALUE);
1631 spider_net_write_reg(card, SPIDER_NET_GHIINT1MSK,
1632 SPIDER_NET_INT1_MASK_VALUE);
1633 spider_net_write_reg(card, SPIDER_NET_GHIINT2MSK,
1634 SPIDER_NET_INT2_MASK_VALUE);
1636 spider_net_write_reg(card, SPIDER_NET_GDTDMACCNTR,
1637 SPIDER_NET_GDTBSTA);
1641 * spider_net_open - called upon ifonfig up
1642 * @netdev: interface device structure
1644 * returns 0 on success, <0 on failure
1646 * spider_net_open allocates all the descriptors and memory needed for
1647 * operation, sets up multicast list and enables interrupts
1650 spider_net_open(struct net_device *netdev)
1652 struct spider_net_card *card = netdev_priv(netdev);
1653 struct spider_net_descr *descr;
1656 result = spider_net_init_chain(card, &card->tx_chain);
1658 goto alloc_tx_failed;
1659 card->low_watermark = NULL;
1661 result = spider_net_init_chain(card, &card->rx_chain);
1663 goto alloc_rx_failed;
1665 /* Make a ring of of bus addresses */
1666 descr = card->rx_chain.ring;
1668 descr->next_descr_addr = descr->next->bus_addr;
1669 descr = descr->next;
1670 } while (descr != card->rx_chain.ring);
1672 /* Allocate rx skbs */
1673 if (spider_net_alloc_rx_skbs(card))
1674 goto alloc_skbs_failed;
1676 spider_net_set_multi(netdev);
1678 /* further enhancement: setup hw vlan, if needed */
1681 if (request_irq(netdev->irq, spider_net_interrupt,
1682 IRQF_SHARED, netdev->name, netdev))
1683 goto register_int_failed;
1685 spider_net_enable_card(card);
1687 netif_start_queue(netdev);
1688 netif_carrier_on(netdev);
1689 netif_poll_enable(netdev);
1693 register_int_failed:
1694 spider_net_free_rx_chain_contents(card);
1696 spider_net_free_chain(card, &card->rx_chain);
1698 spider_net_free_chain(card, &card->tx_chain);
1704 * spider_net_setup_phy - setup PHY
1705 * @card: card structure
1707 * returns 0 on success, <0 on failure
1709 * spider_net_setup_phy is used as part of spider_net_probe. Sets
1710 * the PHY to 1000 Mbps
1713 spider_net_setup_phy(struct spider_net_card *card)
1715 struct mii_phy *phy = &card->phy;
1717 spider_net_write_reg(card, SPIDER_NET_GDTDMASEL,
1718 SPIDER_NET_DMASEL_VALUE);
1719 spider_net_write_reg(card, SPIDER_NET_GPCCTRL,
1720 SPIDER_NET_PHY_CTRL_VALUE);
1722 phy->dev = card->netdev;
1723 phy->mdio_read = spider_net_read_phy;
1724 phy->mdio_write = spider_net_write_phy;
1726 mii_phy_probe(phy, phy->mii_id);
1728 if (phy->def->ops->setup_forced)
1729 phy->def->ops->setup_forced(phy, SPEED_1000, DUPLEX_FULL);
1731 phy->def->ops->enable_fiber(phy);
1733 phy->def->ops->read_link(phy);
1734 pr_info("Found %s with %i Mbps, %s-duplex.\n", phy->def->name,
1735 phy->speed, phy->duplex==1 ? "Full" : "Half");
1741 * spider_net_download_firmware - loads firmware into the adapter
1742 * @card: card structure
1743 * @firmware_ptr: pointer to firmware data
1745 * spider_net_download_firmware loads the firmware data into the
1746 * adapter. It assumes the length etc. to be allright.
1749 spider_net_download_firmware(struct spider_net_card *card,
1750 const void *firmware_ptr)
1753 const u32 *fw_ptr = firmware_ptr;
1755 /* stop sequencers */
1756 spider_net_write_reg(card, SPIDER_NET_GSINIT,
1757 SPIDER_NET_STOP_SEQ_VALUE);
1759 for (sequencer = 0; sequencer < SPIDER_NET_FIRMWARE_SEQS;
1761 spider_net_write_reg(card,
1762 SPIDER_NET_GSnPRGADR + sequencer * 8, 0);
1763 for (i = 0; i < SPIDER_NET_FIRMWARE_SEQWORDS; i++) {
1764 spider_net_write_reg(card, SPIDER_NET_GSnPRGDAT +
1765 sequencer * 8, *fw_ptr);
1770 if (spider_net_read_reg(card, SPIDER_NET_GSINIT))
1773 spider_net_write_reg(card, SPIDER_NET_GSINIT,
1774 SPIDER_NET_RUN_SEQ_VALUE);
1780 * spider_net_init_firmware - reads in firmware parts
1781 * @card: card structure
1783 * Returns 0 on success, <0 on failure
1785 * spider_net_init_firmware opens the sequencer firmware and does some basic
1786 * checks. This function opens and releases the firmware structure. A call
1787 * to download the firmware is performed before the release.
1791 * spider_fw.bin is expected to be a file containing 6*1024*4 bytes, 4k being
1792 * the program for each sequencer. Use the command
1793 * tail -q -n +2 Seq_code1_0x088.txt Seq_code2_0x090.txt \
1794 * Seq_code3_0x098.txt Seq_code4_0x0A0.txt Seq_code5_0x0A8.txt \
1795 * Seq_code6_0x0B0.txt | xxd -r -p -c4 > spider_fw.bin
1797 * to generate spider_fw.bin, if you have sequencer programs with something
1798 * like the following contents for each sequencer:
1799 * <ONE LINE COMMENT>
1800 * <FIRST 4-BYTES-WORD FOR SEQUENCER>
1801 * <SECOND 4-BYTES-WORD FOR SEQUENCER>
1803 * <1024th 4-BYTES-WORD FOR SEQUENCER>
1806 spider_net_init_firmware(struct spider_net_card *card)
1808 struct firmware *firmware = NULL;
1809 struct device_node *dn;
1810 const u8 *fw_prop = NULL;
1814 if (request_firmware((const struct firmware **)&firmware,
1815 SPIDER_NET_FIRMWARE_NAME, &card->pdev->dev) == 0) {
1816 if ( (firmware->size != SPIDER_NET_FIRMWARE_LEN) &&
1817 netif_msg_probe(card) ) {
1818 pr_err("Incorrect size of spidernet firmware in " \
1819 "filesystem. Looking in host firmware...\n");
1822 err = spider_net_download_firmware(card, firmware->data);
1824 release_firmware(firmware);
1832 dn = pci_device_to_OF_node(card->pdev);
1836 fw_prop = get_property(dn, "firmware", &fw_size);
1840 if ( (fw_size != SPIDER_NET_FIRMWARE_LEN) &&
1841 netif_msg_probe(card) ) {
1842 pr_err("Incorrect size of spidernet firmware in " \
1847 err = spider_net_download_firmware(card, fw_prop);
1852 if (netif_msg_probe(card))
1853 pr_err("Couldn't find spidernet firmware in filesystem " \
1854 "or host firmware\n");
1859 * spider_net_workaround_rxramfull - work around firmware bug
1860 * @card: card structure
1865 spider_net_workaround_rxramfull(struct spider_net_card *card)
1867 int i, sequencer = 0;
1870 spider_net_write_reg(card, SPIDER_NET_CKRCTRL,
1871 SPIDER_NET_CKRCTRL_RUN_VALUE);
1873 /* empty sequencer data */
1874 for (sequencer = 0; sequencer < SPIDER_NET_FIRMWARE_SEQS;
1876 spider_net_write_reg(card, SPIDER_NET_GSnPRGADR +
1877 sequencer * 8, 0x0);
1878 for (i = 0; i < SPIDER_NET_FIRMWARE_SEQWORDS; i++) {
1879 spider_net_write_reg(card, SPIDER_NET_GSnPRGDAT +
1880 sequencer * 8, 0x0);
1884 /* set sequencer operation */
1885 spider_net_write_reg(card, SPIDER_NET_GSINIT, 0x000000fe);
1888 spider_net_write_reg(card, SPIDER_NET_CKRCTRL,
1889 SPIDER_NET_CKRCTRL_STOP_VALUE);
1893 * spider_net_stop - called upon ifconfig down
1894 * @netdev: interface device structure
1899 spider_net_stop(struct net_device *netdev)
1901 struct spider_net_card *card = netdev_priv(netdev);
1903 netif_poll_disable(netdev);
1904 netif_carrier_off(netdev);
1905 netif_stop_queue(netdev);
1906 del_timer_sync(&card->tx_timer);
1908 /* disable/mask all interrupts */
1909 spider_net_write_reg(card, SPIDER_NET_GHIINT0MSK, 0);
1910 spider_net_write_reg(card, SPIDER_NET_GHIINT1MSK, 0);
1911 spider_net_write_reg(card, SPIDER_NET_GHIINT2MSK, 0);
1913 /* free_irq(netdev->irq, netdev);*/
1914 free_irq(to_pci_dev(netdev->class_dev.dev)->irq, netdev);
1916 spider_net_write_reg(card, SPIDER_NET_GDTDMACCNTR,
1917 SPIDER_NET_DMA_TX_FEND_VALUE);
1919 /* turn off DMA, force end */
1920 spider_net_disable_rxdmac(card);
1922 /* release chains */
1923 spider_net_release_tx_chain(card, 1);
1924 spider_net_free_rx_chain_contents(card);
1926 spider_net_free_rx_chain_contents(card);
1928 spider_net_free_chain(card, &card->tx_chain);
1929 spider_net_free_chain(card, &card->rx_chain);
1935 * spider_net_tx_timeout_task - task scheduled by the watchdog timeout
1936 * function (to be called not under interrupt status)
1937 * @data: data, is interface device structure
1939 * called as task when tx hangs, resets interface (if interface is up)
1942 spider_net_tx_timeout_task(struct work_struct *work)
1944 struct spider_net_card *card =
1945 container_of(work, struct spider_net_card, tx_timeout_task);
1946 struct net_device *netdev = card->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 init_timer(&card->tx_timer);
2048 card->tx_timer.function =
2049 (void (*)(unsigned long)) spider_net_cleanup_tx_ring;
2050 card->tx_timer.data = (unsigned long) card;
2051 netdev->irq = card->pdev->irq;
2053 card->options.rx_csum = SPIDER_NET_RX_CSUM_DEFAULT;
2055 card->tx_chain.num_desc = tx_descriptors;
2056 card->rx_chain.num_desc = rx_descriptors;
2058 spider_net_setup_netdev_ops(netdev);
2060 netdev->features = NETIF_F_HW_CSUM | NETIF_F_LLTX;
2061 /* some time: NETIF_F_HW_VLAN_TX | NETIF_F_HW_VLAN_RX |
2062 * NETIF_F_HW_VLAN_FILTER */
2064 netdev->irq = card->pdev->irq;
2066 dn = pci_device_to_OF_node(card->pdev);
2070 mac = get_property(dn, "local-mac-address", NULL);
2073 memcpy(addr.sa_data, mac, ETH_ALEN);
2075 result = spider_net_set_mac(netdev, &addr);
2076 if ((result) && (netif_msg_probe(card)))
2077 pr_err("Failed to set MAC address: %i\n", result);
2079 result = register_netdev(netdev);
2081 if (netif_msg_probe(card))
2082 pr_err("Couldn't register net_device: %i\n",
2087 if (netif_msg_probe(card))
2088 pr_info("Initialized device %s.\n", netdev->name);
2094 * spider_net_alloc_card - allocates net_device and card structure
2096 * returns the card structure or NULL in case of errors
2098 * the card and net_device structures are linked to each other
2100 static struct spider_net_card *
2101 spider_net_alloc_card(void)
2103 struct net_device *netdev;
2104 struct spider_net_card *card;
2106 netdev = alloc_etherdev(sizeof(struct spider_net_card));
2110 card = netdev_priv(netdev);
2111 card->netdev = netdev;
2112 card->msg_enable = SPIDER_NET_DEFAULT_MSG;
2113 INIT_WORK(&card->tx_timeout_task, spider_net_tx_timeout_task);
2114 init_waitqueue_head(&card->waitq);
2115 atomic_set(&card->tx_timeout_task_counter, 0);
2121 * spider_net_undo_pci_setup - releases PCI ressources
2122 * @card: card structure
2124 * spider_net_undo_pci_setup releases the mapped regions
2127 spider_net_undo_pci_setup(struct spider_net_card *card)
2129 iounmap(card->regs);
2130 pci_release_regions(card->pdev);
2134 * spider_net_setup_pci_dev - sets up the device in terms of PCI operations
2135 * @card: card structure
2138 * Returns the card structure or NULL if any errors occur
2140 * spider_net_setup_pci_dev initializes pdev and together with the
2141 * functions called in spider_net_open configures the device so that
2142 * data can be transferred over it
2143 * The net_device structure is attached to the card structure, if the
2144 * function returns without error.
2146 static struct spider_net_card *
2147 spider_net_setup_pci_dev(struct pci_dev *pdev)
2149 struct spider_net_card *card;
2150 unsigned long mmio_start, mmio_len;
2152 if (pci_enable_device(pdev)) {
2153 pr_err("Couldn't enable PCI device\n");
2157 if (!(pci_resource_flags(pdev, 0) & IORESOURCE_MEM)) {
2158 pr_err("Couldn't find proper PCI device base address.\n");
2159 goto out_disable_dev;
2162 if (pci_request_regions(pdev, spider_net_driver_name)) {
2163 pr_err("Couldn't obtain PCI resources, aborting.\n");
2164 goto out_disable_dev;
2167 pci_set_master(pdev);
2169 card = spider_net_alloc_card();
2171 pr_err("Couldn't allocate net_device structure, "
2173 goto out_release_regions;
2177 /* fetch base address and length of first resource */
2178 mmio_start = pci_resource_start(pdev, 0);
2179 mmio_len = pci_resource_len(pdev, 0);
2181 card->netdev->mem_start = mmio_start;
2182 card->netdev->mem_end = mmio_start + mmio_len;
2183 card->regs = ioremap(mmio_start, mmio_len);
2186 pr_err("Couldn't obtain PCI resources, aborting.\n");
2187 goto out_release_regions;
2192 out_release_regions:
2193 pci_release_regions(pdev);
2195 pci_disable_device(pdev);
2196 pci_set_drvdata(pdev, NULL);
2201 * spider_net_probe - initialization of a device
2203 * @ent: entry in the device id list
2205 * Returns 0 on success, <0 on failure
2207 * spider_net_probe initializes pdev and registers a net_device
2208 * structure for it. After that, the device can be ifconfig'ed up
2210 static int __devinit
2211 spider_net_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
2214 struct spider_net_card *card;
2216 card = spider_net_setup_pci_dev(pdev);
2220 spider_net_workaround_rxramfull(card);
2221 spider_net_init_card(card);
2223 err = spider_net_setup_phy(card);
2227 err = spider_net_init_firmware(card);
2231 err = spider_net_setup_netdev(card);
2238 spider_net_undo_pci_setup(card);
2239 free_netdev(card->netdev);
2245 * spider_net_remove - removal of a device
2248 * Returns 0 on success, <0 on failure
2250 * spider_net_remove is called to remove the device and unregisters the
2253 static void __devexit
2254 spider_net_remove(struct pci_dev *pdev)
2256 struct net_device *netdev;
2257 struct spider_net_card *card;
2259 netdev = pci_get_drvdata(pdev);
2260 card = netdev_priv(netdev);
2262 wait_event(card->waitq,
2263 atomic_read(&card->tx_timeout_task_counter) == 0);
2265 unregister_netdev(netdev);
2267 /* switch off card */
2268 spider_net_write_reg(card, SPIDER_NET_CKRCTRL,
2269 SPIDER_NET_CKRCTRL_STOP_VALUE);
2270 spider_net_write_reg(card, SPIDER_NET_CKRCTRL,
2271 SPIDER_NET_CKRCTRL_RUN_VALUE);
2273 spider_net_undo_pci_setup(card);
2274 free_netdev(netdev);
2277 static struct pci_driver spider_net_driver = {
2278 .name = spider_net_driver_name,
2279 .id_table = spider_net_pci_tbl,
2280 .probe = spider_net_probe,
2281 .remove = __devexit_p(spider_net_remove)
2285 * spider_net_init - init function when the driver is loaded
2287 * spider_net_init registers the device driver
2289 static int __init spider_net_init(void)
2291 printk(KERN_INFO "Spidernet version %s.\n", VERSION);
2293 if (rx_descriptors < SPIDER_NET_RX_DESCRIPTORS_MIN) {
2294 rx_descriptors = SPIDER_NET_RX_DESCRIPTORS_MIN;
2295 pr_info("adjusting rx descriptors to %i.\n", rx_descriptors);
2297 if (rx_descriptors > SPIDER_NET_RX_DESCRIPTORS_MAX) {
2298 rx_descriptors = SPIDER_NET_RX_DESCRIPTORS_MAX;
2299 pr_info("adjusting rx descriptors to %i.\n", rx_descriptors);
2301 if (tx_descriptors < SPIDER_NET_TX_DESCRIPTORS_MIN) {
2302 tx_descriptors = SPIDER_NET_TX_DESCRIPTORS_MIN;
2303 pr_info("adjusting tx descriptors to %i.\n", tx_descriptors);
2305 if (tx_descriptors > SPIDER_NET_TX_DESCRIPTORS_MAX) {
2306 tx_descriptors = SPIDER_NET_TX_DESCRIPTORS_MAX;
2307 pr_info("adjusting tx descriptors to %i.\n", tx_descriptors);
2310 return pci_register_driver(&spider_net_driver);
2314 * spider_net_cleanup - exit function when driver is unloaded
2316 * spider_net_cleanup unregisters the device driver
2318 static void __exit spider_net_cleanup(void)
2320 pci_unregister_driver(&spider_net_driver);
2323 module_init(spider_net_init);
2324 module_exit(spider_net_cleanup);