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 - reinitializes a 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 descriptor.
377 * Activate the descriptor state-wise
380 spider_net_prepare_rx_descr(struct spider_net_card *card,
381 struct spider_net_descr *descr)
388 /* we need to round up the buffer size to a multiple of 128 */
389 bufsize = (SPIDER_NET_MAX_FRAME + SPIDER_NET_RXBUF_ALIGN - 1) &
390 (~(SPIDER_NET_RXBUF_ALIGN - 1));
392 /* and we need to have it 128 byte aligned, therefore we allocate a
394 /* allocate an skb */
395 descr->skb = dev_alloc_skb(bufsize + SPIDER_NET_RXBUF_ALIGN - 1);
397 if (netif_msg_rx_err(card) && net_ratelimit())
398 pr_err("Not enough memory to allocate rx buffer\n");
399 card->spider_stats.alloc_rx_skb_error++;
402 descr->buf_size = bufsize;
403 descr->result_size = 0;
404 descr->valid_size = 0;
405 descr->data_status = 0;
406 descr->data_error = 0;
408 offset = ((unsigned long)descr->skb->data) &
409 (SPIDER_NET_RXBUF_ALIGN - 1);
411 skb_reserve(descr->skb, SPIDER_NET_RXBUF_ALIGN - offset);
412 /* io-mmu-map the skb */
413 buf = pci_map_single(card->pdev, descr->skb->data,
414 SPIDER_NET_MAX_FRAME, PCI_DMA_FROMDEVICE);
415 descr->buf_addr = buf;
416 if (pci_dma_mapping_error(buf)) {
417 dev_kfree_skb_any(descr->skb);
418 if (netif_msg_rx_err(card) && net_ratelimit())
419 pr_err("Could not iommu-map rx buffer\n");
420 card->spider_stats.rx_iommu_map_error++;
421 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; if not, it's
514 * 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 * returns 1 on success, 0 if no packet was passed to the stack
916 * Fills out skb structure and passes the data to the stack.
917 * The descriptor state is not changed.
920 spider_net_pass_skb_up(struct spider_net_descr *descr,
921 struct spider_net_card *card)
924 struct net_device *netdev;
925 u32 data_status, data_error;
927 data_status = descr->data_status;
928 data_error = descr->data_error;
929 netdev = card->netdev;
933 skb_put(skb, descr->valid_size);
935 /* the card seems to add 2 bytes of junk in front
936 * of the ethernet frame */
937 #define SPIDER_MISALIGN 2
938 skb_pull(skb, SPIDER_MISALIGN);
939 skb->protocol = eth_type_trans(skb, netdev);
941 /* checksum offload */
942 if (card->options.rx_csum) {
943 if ( ( (data_status & SPIDER_NET_DATA_STATUS_CKSUM_MASK) ==
944 SPIDER_NET_DATA_STATUS_CKSUM_MASK) &&
945 !(data_error & SPIDER_NET_DATA_ERR_CKSUM_MASK))
946 skb->ip_summed = CHECKSUM_UNNECESSARY;
948 skb->ip_summed = CHECKSUM_NONE;
950 skb->ip_summed = CHECKSUM_NONE;
952 if (data_status & SPIDER_NET_VLAN_PACKET) {
953 /* further enhancements: HW-accel VLAN
954 * vlan_hwaccel_receive_skb
958 /* pass skb up to stack */
959 netif_receive_skb(skb);
961 /* update netdevice statistics */
962 card->netdev_stats.rx_packets++;
963 card->netdev_stats.rx_bytes += skb->len;
969 * spider_net_decode_one_descr - processes an rx descriptor
970 * @card: card structure
972 * Returns 1 if a packet has been sent to the stack, otherwise 0
974 * Processes an rx descriptor by iommu-unmapping the data buffer and passing
975 * the packet up to the stack. This function is called in softirq
976 * context, e.g. either bottom half from interrupt or NAPI polling context
979 spider_net_decode_one_descr(struct spider_net_card *card)
981 struct spider_net_descr_chain *chain = &card->rx_chain;
982 struct spider_net_descr *descr = chain->tail;
986 status = spider_net_get_descr_status(descr);
988 /* nothing in the descriptor yet */
989 if (status == SPIDER_NET_DESCR_CARDOWNED)
992 if (status == SPIDER_NET_DESCR_NOT_IN_USE) {
993 /* not initialized yet, the ring must be empty */
994 spider_net_refill_rx_chain(card);
995 spider_net_enable_rxdmac(card);
999 /* descriptor definitively used -- move on tail */
1000 chain->tail = descr->next;
1004 /* unmap descriptor */
1005 pci_unmap_single(card->pdev, descr->buf_addr,
1006 SPIDER_NET_MAX_FRAME, PCI_DMA_FROMDEVICE);
1008 if ( (status == SPIDER_NET_DESCR_RESPONSE_ERROR) ||
1009 (status == SPIDER_NET_DESCR_PROTECTION_ERROR) ||
1010 (status == SPIDER_NET_DESCR_FORCE_END) ) {
1011 if (netif_msg_rx_err(card))
1012 pr_err("%s: dropping RX descriptor with state %d\n",
1013 card->netdev->name, status);
1014 card->netdev_stats.rx_dropped++;
1015 dev_kfree_skb_irq(descr->skb);
1019 if ( (status != SPIDER_NET_DESCR_COMPLETE) &&
1020 (status != SPIDER_NET_DESCR_FRAME_END) ) {
1021 if (netif_msg_rx_err(card))
1022 pr_err("%s: RX descriptor with unkown state %d\n",
1023 card->netdev->name, status);
1024 card->spider_stats.rx_desc_unk_state++;
1025 dev_kfree_skb_irq(descr->skb);
1029 /* The cases we'll throw away the packet immediately */
1030 if (descr->data_error & SPIDER_NET_DESTROY_RX_FLAGS) {
1031 if (netif_msg_rx_err(card))
1032 pr_err("%s: error in received descriptor found, "
1033 "data_status=x%08x, data_error=x%08x\n",
1035 descr->data_status, descr->data_error);
1036 card->spider_stats.rx_desc_error++;
1037 dev_kfree_skb_irq(descr->skb);
1041 /* ok, we've got a packet in descr */
1042 result = spider_net_pass_skb_up(descr, card);
1044 /* change the descriptor state: */
1045 descr->dmac_cmd_status = SPIDER_NET_DESCR_NOT_IN_USE;
1050 * spider_net_poll - NAPI poll function called by the stack to return packets
1051 * @netdev: interface device structure
1052 * @budget: number of packets we can pass to the stack at most
1054 * returns 0 if no more packets available to the driver/stack. Returns 1,
1055 * if the quota is exceeded, but the driver has still packets.
1057 * spider_net_poll returns all packets from the rx descriptors to the stack
1058 * (using netif_receive_skb). If all/enough packets are up, the driver
1059 * reenables interrupts and returns 0. If not, 1 is returned.
1062 spider_net_poll(struct net_device *netdev, int *budget)
1064 struct spider_net_card *card = netdev_priv(netdev);
1065 int packets_to_do, packets_done = 0;
1066 int no_more_packets = 0;
1068 spider_net_cleanup_tx_ring(card);
1069 packets_to_do = min(*budget, netdev->quota);
1071 while (packets_to_do) {
1072 if (spider_net_decode_one_descr(card)) {
1076 /* no more packets for the stack */
1077 no_more_packets = 1;
1082 netdev->quota -= packets_done;
1083 *budget -= packets_done;
1084 spider_net_refill_rx_chain(card);
1086 /* if all packets are in the stack, enable interrupts and return 0 */
1087 /* if not, return 1 */
1088 if (no_more_packets) {
1089 netif_rx_complete(netdev);
1090 spider_net_rx_irq_on(card);
1098 * spider_net_vlan_rx_reg - initializes VLAN structures in the driver and card
1099 * @netdev: interface device structure
1100 * @grp: vlan_group structure that is registered (NULL on destroying interface)
1103 spider_net_vlan_rx_reg(struct net_device *netdev, struct vlan_group *grp)
1105 /* further enhancement... yet to do */
1110 * spider_net_vlan_rx_add - adds VLAN id to the card filter
1111 * @netdev: interface device structure
1112 * @vid: VLAN id to add
1115 spider_net_vlan_rx_add(struct net_device *netdev, uint16_t vid)
1117 /* further enhancement... yet to do */
1118 /* add vid to card's VLAN filter table */
1123 * spider_net_vlan_rx_kill - removes VLAN id to the card filter
1124 * @netdev: interface device structure
1125 * @vid: VLAN id to remove
1128 spider_net_vlan_rx_kill(struct net_device *netdev, uint16_t vid)
1130 /* further enhancement... yet to do */
1131 /* remove vid from card's VLAN filter table */
1135 * spider_net_get_stats - get interface statistics
1136 * @netdev: interface device structure
1138 * returns the interface statistics residing in the spider_net_card struct
1140 static struct net_device_stats *
1141 spider_net_get_stats(struct net_device *netdev)
1143 struct spider_net_card *card = netdev_priv(netdev);
1144 struct net_device_stats *stats = &card->netdev_stats;
1149 * spider_net_change_mtu - changes the MTU of an interface
1150 * @netdev: interface device structure
1151 * @new_mtu: new MTU value
1153 * returns 0 on success, <0 on failure
1156 spider_net_change_mtu(struct net_device *netdev, int new_mtu)
1158 /* no need to re-alloc skbs or so -- the max mtu is about 2.3k
1159 * and mtu is outbound only anyway */
1160 if ( (new_mtu < SPIDER_NET_MIN_MTU ) ||
1161 (new_mtu > SPIDER_NET_MAX_MTU) )
1163 netdev->mtu = new_mtu;
1168 * spider_net_set_mac - sets the MAC of an interface
1169 * @netdev: interface device structure
1170 * @ptr: pointer to new MAC address
1172 * Returns 0 on success, <0 on failure. Currently, we don't support this
1173 * and will always return EOPNOTSUPP.
1176 spider_net_set_mac(struct net_device *netdev, void *p)
1178 struct spider_net_card *card = netdev_priv(netdev);
1179 u32 macl, macu, regvalue;
1180 struct sockaddr *addr = p;
1182 if (!is_valid_ether_addr(addr->sa_data))
1183 return -EADDRNOTAVAIL;
1185 /* switch off GMACTPE and GMACRPE */
1186 regvalue = spider_net_read_reg(card, SPIDER_NET_GMACOPEMD);
1187 regvalue &= ~((1 << 5) | (1 << 6));
1188 spider_net_write_reg(card, SPIDER_NET_GMACOPEMD, regvalue);
1191 macu = (addr->sa_data[0]<<24) + (addr->sa_data[1]<<16) +
1192 (addr->sa_data[2]<<8) + (addr->sa_data[3]);
1193 macl = (addr->sa_data[4]<<8) + (addr->sa_data[5]);
1194 spider_net_write_reg(card, SPIDER_NET_GMACUNIMACU, macu);
1195 spider_net_write_reg(card, SPIDER_NET_GMACUNIMACL, macl);
1197 /* switch GMACTPE and GMACRPE back on */
1198 regvalue = spider_net_read_reg(card, SPIDER_NET_GMACOPEMD);
1199 regvalue |= ((1 << 5) | (1 << 6));
1200 spider_net_write_reg(card, SPIDER_NET_GMACOPEMD, regvalue);
1202 spider_net_set_promisc(card);
1204 /* look up, whether we have been successful */
1205 if (spider_net_get_mac_address(netdev))
1206 return -EADDRNOTAVAIL;
1207 if (memcmp(netdev->dev_addr,addr->sa_data,netdev->addr_len))
1208 return -EADDRNOTAVAIL;
1214 * spider_net_handle_error_irq - handles errors raised by an interrupt
1215 * @card: card structure
1216 * @status_reg: interrupt status register 0 (GHIINT0STS)
1218 * spider_net_handle_error_irq treats or ignores all error conditions
1219 * found when an interrupt is presented
1222 spider_net_handle_error_irq(struct spider_net_card *card, u32 status_reg)
1224 u32 error_reg1, error_reg2;
1228 error_reg1 = spider_net_read_reg(card, SPIDER_NET_GHIINT1STS);
1229 error_reg2 = spider_net_read_reg(card, SPIDER_NET_GHIINT2STS);
1231 /* check GHIINT0STS ************************************/
1233 for (i = 0; i < 32; i++)
1234 if (status_reg & (1<<i))
1237 /* let error_reg1 and error_reg2 evaluation decide, what to do
1238 case SPIDER_NET_PHYINT:
1239 case SPIDER_NET_GMAC2INT:
1240 case SPIDER_NET_GMAC1INT:
1241 case SPIDER_NET_GFIFOINT:
1242 case SPIDER_NET_DMACINT:
1243 case SPIDER_NET_GSYSINT:
1246 case SPIDER_NET_GIPSINT:
1250 case SPIDER_NET_GPWOPCMPINT:
1251 /* PHY write operation completed */
1254 case SPIDER_NET_GPROPCMPINT:
1255 /* PHY read operation completed */
1256 /* we don't use semaphores, as we poll for the completion
1257 * of the read operation in spider_net_read_phy. Should take
1261 case SPIDER_NET_GPWFFINT:
1262 /* PHY command queue full */
1263 if (netif_msg_intr(card))
1264 pr_err("PHY write queue full\n");
1268 /* case SPIDER_NET_GRMDADRINT: not used. print a message */
1269 /* case SPIDER_NET_GRMARPINT: not used. print a message */
1270 /* case SPIDER_NET_GRMMPINT: not used. print a message */
1272 case SPIDER_NET_GDTDEN0INT:
1273 /* someone has set TX_DMA_EN to 0 */
1277 case SPIDER_NET_GDDDEN0INT: /* fallthrough */
1278 case SPIDER_NET_GDCDEN0INT: /* fallthrough */
1279 case SPIDER_NET_GDBDEN0INT: /* fallthrough */
1280 case SPIDER_NET_GDADEN0INT:
1281 /* someone has set RX_DMA_EN to 0 */
1286 case SPIDER_NET_GDDFDCINT:
1287 case SPIDER_NET_GDCFDCINT:
1288 case SPIDER_NET_GDBFDCINT:
1289 case SPIDER_NET_GDAFDCINT:
1290 /* case SPIDER_NET_GDNMINT: not used. print a message */
1291 /* case SPIDER_NET_GCNMINT: not used. print a message */
1292 /* case SPIDER_NET_GBNMINT: not used. print a message */
1293 /* case SPIDER_NET_GANMINT: not used. print a message */
1294 /* case SPIDER_NET_GRFNMINT: not used. print a message */
1299 case SPIDER_NET_GDTFDCINT:
1302 case SPIDER_NET_GTTEDINT:
1305 case SPIDER_NET_GDTDCEINT:
1306 /* chain end. If a descriptor should be sent, kick off
1308 if (card->tx_chain.tail != card->tx_chain.head)
1309 spider_net_kick_tx_dma(card);
1314 /* case SPIDER_NET_G1TMCNTINT: not used. print a message */
1315 /* case SPIDER_NET_GFREECNTINT: not used. print a message */
1318 /* check GHIINT1STS ************************************/
1320 for (i = 0; i < 32; i++)
1321 if (error_reg1 & (1<<i))
1324 case SPIDER_NET_GTMFLLINT:
1325 if (netif_msg_intr(card) && net_ratelimit())
1326 pr_err("Spider TX RAM full\n");
1329 case SPIDER_NET_GRFDFLLINT: /* fallthrough */
1330 case SPIDER_NET_GRFCFLLINT: /* fallthrough */
1331 case SPIDER_NET_GRFBFLLINT: /* fallthrough */
1332 case SPIDER_NET_GRFAFLLINT: /* fallthrough */
1333 case SPIDER_NET_GRMFLLINT:
1334 if (netif_msg_intr(card) && net_ratelimit())
1335 pr_err("Spider RX RAM full, incoming packets "
1336 "might be discarded!\n");
1337 spider_net_rx_irq_off(card);
1338 netif_rx_schedule(card->netdev);
1342 /* case SPIDER_NET_GTMSHTINT: problem, print a message */
1343 case SPIDER_NET_GDTINVDINT:
1344 /* allrighty. tx from previous descr ok */
1349 case SPIDER_NET_GDDDCEINT: /* fallthrough */
1350 case SPIDER_NET_GDCDCEINT: /* fallthrough */
1351 case SPIDER_NET_GDBDCEINT: /* fallthrough */
1352 case SPIDER_NET_GDADCEINT:
1353 if (netif_msg_intr(card) && net_ratelimit())
1354 pr_err("got descriptor chain end interrupt, "
1355 "restarting DMAC %c.\n",
1356 'D'-(i-SPIDER_NET_GDDDCEINT)/3);
1357 spider_net_refill_rx_chain(card);
1358 spider_net_enable_rxdmac(card);
1362 /* invalid descriptor */
1363 case SPIDER_NET_GDDINVDINT: /* fallthrough */
1364 case SPIDER_NET_GDCINVDINT: /* fallthrough */
1365 case SPIDER_NET_GDBINVDINT: /* fallthrough */
1366 case SPIDER_NET_GDAINVDINT:
1367 /* could happen when rx chain is full */
1368 spider_net_refill_rx_chain(card);
1369 spider_net_enable_rxdmac(card);
1373 /* case SPIDER_NET_GDTRSERINT: problem, print a message */
1374 /* case SPIDER_NET_GDDRSERINT: problem, print a message */
1375 /* case SPIDER_NET_GDCRSERINT: problem, print a message */
1376 /* case SPIDER_NET_GDBRSERINT: problem, print a message */
1377 /* case SPIDER_NET_GDARSERINT: problem, print a message */
1378 /* case SPIDER_NET_GDSERINT: problem, print a message */
1379 /* case SPIDER_NET_GDTPTERINT: problem, print a message */
1380 /* case SPIDER_NET_GDDPTERINT: problem, print a message */
1381 /* case SPIDER_NET_GDCPTERINT: problem, print a message */
1382 /* case SPIDER_NET_GDBPTERINT: problem, print a message */
1383 /* case SPIDER_NET_GDAPTERINT: problem, print a message */
1389 /* check GHIINT2STS ************************************/
1391 for (i = 0; i < 32; i++)
1392 if (error_reg2 & (1<<i))
1395 /* there is nothing we can (want to) do at this time. Log a
1396 * message, we can switch on and off the specific values later on
1397 case SPIDER_NET_GPROPERINT:
1398 case SPIDER_NET_GMCTCRSNGINT:
1399 case SPIDER_NET_GMCTLCOLINT:
1400 case SPIDER_NET_GMCTTMOTINT:
1401 case SPIDER_NET_GMCRCAERINT:
1402 case SPIDER_NET_GMCRCALERINT:
1403 case SPIDER_NET_GMCRALNERINT:
1404 case SPIDER_NET_GMCROVRINT:
1405 case SPIDER_NET_GMCRRNTINT:
1406 case SPIDER_NET_GMCRRXERINT:
1407 case SPIDER_NET_GTITCSERINT:
1408 case SPIDER_NET_GTIFMTERINT:
1409 case SPIDER_NET_GTIPKTRVKINT:
1410 case SPIDER_NET_GTISPINGINT:
1411 case SPIDER_NET_GTISADNGINT:
1412 case SPIDER_NET_GTISPDNGINT:
1413 case SPIDER_NET_GRIFMTERINT:
1414 case SPIDER_NET_GRIPKTRVKINT:
1415 case SPIDER_NET_GRISPINGINT:
1416 case SPIDER_NET_GRISADNGINT:
1417 case SPIDER_NET_GRISPDNGINT:
1424 if ((show_error) && (netif_msg_intr(card)) && net_ratelimit())
1425 pr_err("Got error interrupt on %s, GHIINT0STS = 0x%08x, "
1426 "GHIINT1STS = 0x%08x, GHIINT2STS = 0x%08x\n",
1428 status_reg, error_reg1, error_reg2);
1430 /* clear interrupt sources */
1431 spider_net_write_reg(card, SPIDER_NET_GHIINT1STS, error_reg1);
1432 spider_net_write_reg(card, SPIDER_NET_GHIINT2STS, error_reg2);
1436 * spider_net_interrupt - interrupt handler for spider_net
1437 * @irq: interupt number
1438 * @ptr: pointer to net_device
1439 * @regs: PU registers
1441 * returns IRQ_HANDLED, if interrupt was for driver, or IRQ_NONE, if no
1442 * interrupt found raised by card.
1444 * This is the interrupt handler, that turns off
1445 * interrupts for this device and makes the stack poll the driver
1448 spider_net_interrupt(int irq, void *ptr)
1450 struct net_device *netdev = ptr;
1451 struct spider_net_card *card = netdev_priv(netdev);
1454 status_reg = spider_net_read_reg(card, SPIDER_NET_GHIINT0STS);
1459 if (status_reg & SPIDER_NET_RXINT ) {
1460 spider_net_rx_irq_off(card);
1461 netif_rx_schedule(netdev);
1463 if (status_reg & SPIDER_NET_TXINT)
1464 netif_rx_schedule(netdev);
1466 if (status_reg & SPIDER_NET_ERRINT )
1467 spider_net_handle_error_irq(card, status_reg);
1469 /* clear interrupt sources */
1470 spider_net_write_reg(card, SPIDER_NET_GHIINT0STS, status_reg);
1475 #ifdef CONFIG_NET_POLL_CONTROLLER
1477 * spider_net_poll_controller - artificial interrupt for netconsole etc.
1478 * @netdev: interface device structure
1480 * see Documentation/networking/netconsole.txt
1483 spider_net_poll_controller(struct net_device *netdev)
1485 disable_irq(netdev->irq);
1486 spider_net_interrupt(netdev->irq, netdev);
1487 enable_irq(netdev->irq);
1489 #endif /* CONFIG_NET_POLL_CONTROLLER */
1492 * spider_net_init_card - initializes the card
1493 * @card: card structure
1495 * spider_net_init_card initializes the card so that other registers can
1499 spider_net_init_card(struct spider_net_card *card)
1501 spider_net_write_reg(card, SPIDER_NET_CKRCTRL,
1502 SPIDER_NET_CKRCTRL_STOP_VALUE);
1504 spider_net_write_reg(card, SPIDER_NET_CKRCTRL,
1505 SPIDER_NET_CKRCTRL_RUN_VALUE);
1509 * spider_net_enable_card - enables the card by setting all kinds of regs
1510 * @card: card structure
1512 * spider_net_enable_card sets a lot of SMMIO registers to enable the device
1515 spider_net_enable_card(struct spider_net_card *card)
1518 /* the following array consists of (register),(value) pairs
1519 * that are set in this function. A register of 0 ends the list */
1521 { SPIDER_NET_GRESUMINTNUM, 0 },
1522 { SPIDER_NET_GREINTNUM, 0 },
1524 /* set interrupt frame number registers */
1525 /* clear the single DMA engine registers first */
1526 { SPIDER_NET_GFAFRMNUM, SPIDER_NET_GFXFRAMES_VALUE },
1527 { SPIDER_NET_GFBFRMNUM, SPIDER_NET_GFXFRAMES_VALUE },
1528 { SPIDER_NET_GFCFRMNUM, SPIDER_NET_GFXFRAMES_VALUE },
1529 { SPIDER_NET_GFDFRMNUM, SPIDER_NET_GFXFRAMES_VALUE },
1530 /* then set, what we really need */
1531 { SPIDER_NET_GFFRMNUM, SPIDER_NET_FRAMENUM_VALUE },
1533 /* timer counter registers and stuff */
1534 { SPIDER_NET_GFREECNNUM, 0 },
1535 { SPIDER_NET_GONETIMENUM, 0 },
1536 { SPIDER_NET_GTOUTFRMNUM, 0 },
1538 /* RX mode setting */
1539 { SPIDER_NET_GRXMDSET, SPIDER_NET_RXMODE_VALUE },
1540 /* TX mode setting */
1541 { SPIDER_NET_GTXMDSET, SPIDER_NET_TXMODE_VALUE },
1542 /* IPSEC mode setting */
1543 { SPIDER_NET_GIPSECINIT, SPIDER_NET_IPSECINIT_VALUE },
1545 { SPIDER_NET_GFTRESTRT, SPIDER_NET_RESTART_VALUE },
1547 { SPIDER_NET_GMRWOLCTRL, 0 },
1548 { SPIDER_NET_GTESTMD, 0x10000000 },
1549 { SPIDER_NET_GTTQMSK, 0x00400040 },
1551 { SPIDER_NET_GMACINTEN, 0 },
1553 /* flow control stuff */
1554 { SPIDER_NET_GMACAPAUSE, SPIDER_NET_MACAPAUSE_VALUE },
1555 { SPIDER_NET_GMACTXPAUSE, SPIDER_NET_TXPAUSE_VALUE },
1557 { SPIDER_NET_GMACBSTLMT, SPIDER_NET_BURSTLMT_VALUE },
1562 while (regs[i][0]) {
1563 spider_net_write_reg(card, regs[i][0], regs[i][1]);
1567 /* clear unicast filter table entries 1 to 14 */
1568 for (i = 1; i <= 14; i++) {
1569 spider_net_write_reg(card,
1570 SPIDER_NET_GMRUAFILnR + i * 8,
1572 spider_net_write_reg(card,
1573 SPIDER_NET_GMRUAFILnR + i * 8 + 4,
1577 spider_net_write_reg(card, SPIDER_NET_GMRUA0FIL15R, 0x08080000);
1579 spider_net_write_reg(card, SPIDER_NET_ECMODE, SPIDER_NET_ECMODE_VALUE);
1581 /* set chain tail adress for RX chains and
1583 spider_net_enable_rxchtails(card);
1584 spider_net_enable_rxdmac(card);
1586 spider_net_write_reg(card, SPIDER_NET_GRXDMAEN, SPIDER_NET_WOL_VALUE);
1588 spider_net_write_reg(card, SPIDER_NET_GMACLENLMT,
1589 SPIDER_NET_LENLMT_VALUE);
1590 spider_net_write_reg(card, SPIDER_NET_GMACMODE,
1591 SPIDER_NET_MACMODE_VALUE);
1592 spider_net_write_reg(card, SPIDER_NET_GMACOPEMD,
1593 SPIDER_NET_OPMODE_VALUE);
1595 /* set interrupt mask registers */
1596 spider_net_write_reg(card, SPIDER_NET_GHIINT0MSK,
1597 SPIDER_NET_INT0_MASK_VALUE);
1598 spider_net_write_reg(card, SPIDER_NET_GHIINT1MSK,
1599 SPIDER_NET_INT1_MASK_VALUE);
1600 spider_net_write_reg(card, SPIDER_NET_GHIINT2MSK,
1601 SPIDER_NET_INT2_MASK_VALUE);
1603 spider_net_write_reg(card, SPIDER_NET_GDTDMACCNTR,
1604 SPIDER_NET_GDTBSTA);
1608 * spider_net_open - called upon ifonfig up
1609 * @netdev: interface device structure
1611 * returns 0 on success, <0 on failure
1613 * spider_net_open allocates all the descriptors and memory needed for
1614 * operation, sets up multicast list and enables interrupts
1617 spider_net_open(struct net_device *netdev)
1619 struct spider_net_card *card = netdev_priv(netdev);
1620 struct spider_net_descr *descr;
1623 result = spider_net_init_chain(card, &card->tx_chain);
1625 goto alloc_tx_failed;
1626 card->low_watermark = NULL;
1628 result = spider_net_init_chain(card, &card->rx_chain);
1630 goto alloc_rx_failed;
1632 /* Make a ring of of bus addresses */
1633 descr = card->rx_chain.ring;
1635 descr->next_descr_addr = descr->next->bus_addr;
1636 descr = descr->next;
1637 } while (descr != card->rx_chain.ring);
1639 /* Allocate rx skbs */
1640 if (spider_net_alloc_rx_skbs(card))
1641 goto alloc_skbs_failed;
1643 spider_net_set_multi(netdev);
1645 /* further enhancement: setup hw vlan, if needed */
1648 if (request_irq(netdev->irq, spider_net_interrupt,
1649 IRQF_SHARED, netdev->name, netdev))
1650 goto register_int_failed;
1652 spider_net_enable_card(card);
1654 netif_start_queue(netdev);
1655 netif_carrier_on(netdev);
1656 netif_poll_enable(netdev);
1660 register_int_failed:
1661 spider_net_free_rx_chain_contents(card);
1663 spider_net_free_chain(card, &card->rx_chain);
1665 spider_net_free_chain(card, &card->tx_chain);
1671 * spider_net_setup_phy - setup PHY
1672 * @card: card structure
1674 * returns 0 on success, <0 on failure
1676 * spider_net_setup_phy is used as part of spider_net_probe. Sets
1677 * the PHY to 1000 Mbps
1680 spider_net_setup_phy(struct spider_net_card *card)
1682 struct mii_phy *phy = &card->phy;
1684 spider_net_write_reg(card, SPIDER_NET_GDTDMASEL,
1685 SPIDER_NET_DMASEL_VALUE);
1686 spider_net_write_reg(card, SPIDER_NET_GPCCTRL,
1687 SPIDER_NET_PHY_CTRL_VALUE);
1689 phy->dev = card->netdev;
1690 phy->mdio_read = spider_net_read_phy;
1691 phy->mdio_write = spider_net_write_phy;
1693 mii_phy_probe(phy, phy->mii_id);
1695 if (phy->def->ops->setup_forced)
1696 phy->def->ops->setup_forced(phy, SPEED_1000, DUPLEX_FULL);
1698 phy->def->ops->enable_fiber(phy);
1700 phy->def->ops->read_link(phy);
1701 pr_info("Found %s with %i Mbps, %s-duplex.\n", phy->def->name,
1702 phy->speed, phy->duplex==1 ? "Full" : "Half");
1708 * spider_net_download_firmware - loads firmware into the adapter
1709 * @card: card structure
1710 * @firmware_ptr: pointer to firmware data
1712 * spider_net_download_firmware loads the firmware data into the
1713 * adapter. It assumes the length etc. to be allright.
1716 spider_net_download_firmware(struct spider_net_card *card,
1717 const void *firmware_ptr)
1720 const u32 *fw_ptr = firmware_ptr;
1722 /* stop sequencers */
1723 spider_net_write_reg(card, SPIDER_NET_GSINIT,
1724 SPIDER_NET_STOP_SEQ_VALUE);
1726 for (sequencer = 0; sequencer < SPIDER_NET_FIRMWARE_SEQS;
1728 spider_net_write_reg(card,
1729 SPIDER_NET_GSnPRGADR + sequencer * 8, 0);
1730 for (i = 0; i < SPIDER_NET_FIRMWARE_SEQWORDS; i++) {
1731 spider_net_write_reg(card, SPIDER_NET_GSnPRGDAT +
1732 sequencer * 8, *fw_ptr);
1737 if (spider_net_read_reg(card, SPIDER_NET_GSINIT))
1740 spider_net_write_reg(card, SPIDER_NET_GSINIT,
1741 SPIDER_NET_RUN_SEQ_VALUE);
1747 * spider_net_init_firmware - reads in firmware parts
1748 * @card: card structure
1750 * Returns 0 on success, <0 on failure
1752 * spider_net_init_firmware opens the sequencer firmware and does some basic
1753 * checks. This function opens and releases the firmware structure. A call
1754 * to download the firmware is performed before the release.
1758 * spider_fw.bin is expected to be a file containing 6*1024*4 bytes, 4k being
1759 * the program for each sequencer. Use the command
1760 * tail -q -n +2 Seq_code1_0x088.txt Seq_code2_0x090.txt \
1761 * Seq_code3_0x098.txt Seq_code4_0x0A0.txt Seq_code5_0x0A8.txt \
1762 * Seq_code6_0x0B0.txt | xxd -r -p -c4 > spider_fw.bin
1764 * to generate spider_fw.bin, if you have sequencer programs with something
1765 * like the following contents for each sequencer:
1766 * <ONE LINE COMMENT>
1767 * <FIRST 4-BYTES-WORD FOR SEQUENCER>
1768 * <SECOND 4-BYTES-WORD FOR SEQUENCER>
1770 * <1024th 4-BYTES-WORD FOR SEQUENCER>
1773 spider_net_init_firmware(struct spider_net_card *card)
1775 struct firmware *firmware = NULL;
1776 struct device_node *dn;
1777 const u8 *fw_prop = NULL;
1781 if (request_firmware((const struct firmware **)&firmware,
1782 SPIDER_NET_FIRMWARE_NAME, &card->pdev->dev) == 0) {
1783 if ( (firmware->size != SPIDER_NET_FIRMWARE_LEN) &&
1784 netif_msg_probe(card) ) {
1785 pr_err("Incorrect size of spidernet firmware in " \
1786 "filesystem. Looking in host firmware...\n");
1789 err = spider_net_download_firmware(card, firmware->data);
1791 release_firmware(firmware);
1799 dn = pci_device_to_OF_node(card->pdev);
1803 fw_prop = get_property(dn, "firmware", &fw_size);
1807 if ( (fw_size != SPIDER_NET_FIRMWARE_LEN) &&
1808 netif_msg_probe(card) ) {
1809 pr_err("Incorrect size of spidernet firmware in " \
1814 err = spider_net_download_firmware(card, fw_prop);
1819 if (netif_msg_probe(card))
1820 pr_err("Couldn't find spidernet firmware in filesystem " \
1821 "or host firmware\n");
1826 * spider_net_workaround_rxramfull - work around firmware bug
1827 * @card: card structure
1832 spider_net_workaround_rxramfull(struct spider_net_card *card)
1834 int i, sequencer = 0;
1837 spider_net_write_reg(card, SPIDER_NET_CKRCTRL,
1838 SPIDER_NET_CKRCTRL_RUN_VALUE);
1840 /* empty sequencer data */
1841 for (sequencer = 0; sequencer < SPIDER_NET_FIRMWARE_SEQS;
1843 spider_net_write_reg(card, SPIDER_NET_GSnPRGADR +
1844 sequencer * 8, 0x0);
1845 for (i = 0; i < SPIDER_NET_FIRMWARE_SEQWORDS; i++) {
1846 spider_net_write_reg(card, SPIDER_NET_GSnPRGDAT +
1847 sequencer * 8, 0x0);
1851 /* set sequencer operation */
1852 spider_net_write_reg(card, SPIDER_NET_GSINIT, 0x000000fe);
1855 spider_net_write_reg(card, SPIDER_NET_CKRCTRL,
1856 SPIDER_NET_CKRCTRL_STOP_VALUE);
1860 * spider_net_stop - called upon ifconfig down
1861 * @netdev: interface device structure
1866 spider_net_stop(struct net_device *netdev)
1868 struct spider_net_card *card = netdev_priv(netdev);
1870 netif_poll_disable(netdev);
1871 netif_carrier_off(netdev);
1872 netif_stop_queue(netdev);
1873 del_timer_sync(&card->tx_timer);
1875 /* disable/mask all interrupts */
1876 spider_net_write_reg(card, SPIDER_NET_GHIINT0MSK, 0);
1877 spider_net_write_reg(card, SPIDER_NET_GHIINT1MSK, 0);
1878 spider_net_write_reg(card, SPIDER_NET_GHIINT2MSK, 0);
1880 /* free_irq(netdev->irq, netdev);*/
1881 free_irq(to_pci_dev(netdev->class_dev.dev)->irq, netdev);
1883 spider_net_write_reg(card, SPIDER_NET_GDTDMACCNTR,
1884 SPIDER_NET_DMA_TX_FEND_VALUE);
1886 /* turn off DMA, force end */
1887 spider_net_disable_rxdmac(card);
1889 /* release chains */
1890 spider_net_release_tx_chain(card, 1);
1891 spider_net_free_rx_chain_contents(card);
1893 spider_net_free_rx_chain_contents(card);
1895 spider_net_free_chain(card, &card->tx_chain);
1896 spider_net_free_chain(card, &card->rx_chain);
1902 * spider_net_tx_timeout_task - task scheduled by the watchdog timeout
1903 * function (to be called not under interrupt status)
1904 * @data: data, is interface device structure
1906 * called as task when tx hangs, resets interface (if interface is up)
1909 spider_net_tx_timeout_task(struct work_struct *work)
1911 struct spider_net_card *card =
1912 container_of(work, struct spider_net_card, tx_timeout_task);
1913 struct net_device *netdev = card->netdev;
1915 if (!(netdev->flags & IFF_UP))
1918 netif_device_detach(netdev);
1919 spider_net_stop(netdev);
1921 spider_net_workaround_rxramfull(card);
1922 spider_net_init_card(card);
1924 if (spider_net_setup_phy(card))
1926 if (spider_net_init_firmware(card))
1929 spider_net_open(netdev);
1930 spider_net_kick_tx_dma(card);
1931 netif_device_attach(netdev);
1934 atomic_dec(&card->tx_timeout_task_counter);
1938 * spider_net_tx_timeout - called when the tx timeout watchdog kicks in.
1939 * @netdev: interface device structure
1941 * called, if tx hangs. Schedules a task that resets the interface
1944 spider_net_tx_timeout(struct net_device *netdev)
1946 struct spider_net_card *card;
1948 card = netdev_priv(netdev);
1949 atomic_inc(&card->tx_timeout_task_counter);
1950 if (netdev->flags & IFF_UP)
1951 schedule_work(&card->tx_timeout_task);
1953 atomic_dec(&card->tx_timeout_task_counter);
1954 card->spider_stats.tx_timeouts++;
1958 * spider_net_setup_netdev_ops - initialization of net_device operations
1959 * @netdev: net_device structure
1961 * fills out function pointers in the net_device structure
1964 spider_net_setup_netdev_ops(struct net_device *netdev)
1966 netdev->open = &spider_net_open;
1967 netdev->stop = &spider_net_stop;
1968 netdev->hard_start_xmit = &spider_net_xmit;
1969 netdev->get_stats = &spider_net_get_stats;
1970 netdev->set_multicast_list = &spider_net_set_multi;
1971 netdev->set_mac_address = &spider_net_set_mac;
1972 netdev->change_mtu = &spider_net_change_mtu;
1973 netdev->do_ioctl = &spider_net_do_ioctl;
1975 netdev->tx_timeout = &spider_net_tx_timeout;
1976 netdev->watchdog_timeo = SPIDER_NET_WATCHDOG_TIMEOUT;
1978 netdev->poll = &spider_net_poll;
1979 netdev->weight = SPIDER_NET_NAPI_WEIGHT;
1981 netdev->vlan_rx_register = &spider_net_vlan_rx_reg;
1982 netdev->vlan_rx_add_vid = &spider_net_vlan_rx_add;
1983 netdev->vlan_rx_kill_vid = &spider_net_vlan_rx_kill;
1984 #ifdef CONFIG_NET_POLL_CONTROLLER
1985 /* poll controller */
1986 netdev->poll_controller = &spider_net_poll_controller;
1987 #endif /* CONFIG_NET_POLL_CONTROLLER */
1989 netdev->ethtool_ops = &spider_net_ethtool_ops;
1993 * spider_net_setup_netdev - initialization of net_device
1994 * @card: card structure
1996 * Returns 0 on success or <0 on failure
1998 * spider_net_setup_netdev initializes the net_device structure
2001 spider_net_setup_netdev(struct spider_net_card *card)
2004 struct net_device *netdev = card->netdev;
2005 struct device_node *dn;
2006 struct sockaddr addr;
2009 SET_MODULE_OWNER(netdev);
2010 SET_NETDEV_DEV(netdev, &card->pdev->dev);
2012 pci_set_drvdata(card->pdev, netdev);
2014 init_timer(&card->tx_timer);
2015 card->tx_timer.function =
2016 (void (*)(unsigned long)) spider_net_cleanup_tx_ring;
2017 card->tx_timer.data = (unsigned long) card;
2018 netdev->irq = card->pdev->irq;
2020 card->options.rx_csum = SPIDER_NET_RX_CSUM_DEFAULT;
2022 card->tx_chain.num_desc = tx_descriptors;
2023 card->rx_chain.num_desc = rx_descriptors;
2025 spider_net_setup_netdev_ops(netdev);
2027 netdev->features = NETIF_F_HW_CSUM | NETIF_F_LLTX;
2028 /* some time: NETIF_F_HW_VLAN_TX | NETIF_F_HW_VLAN_RX |
2029 * NETIF_F_HW_VLAN_FILTER */
2031 netdev->irq = card->pdev->irq;
2033 dn = pci_device_to_OF_node(card->pdev);
2037 mac = get_property(dn, "local-mac-address", NULL);
2040 memcpy(addr.sa_data, mac, ETH_ALEN);
2042 result = spider_net_set_mac(netdev, &addr);
2043 if ((result) && (netif_msg_probe(card)))
2044 pr_err("Failed to set MAC address: %i\n", result);
2046 result = register_netdev(netdev);
2048 if (netif_msg_probe(card))
2049 pr_err("Couldn't register net_device: %i\n",
2054 if (netif_msg_probe(card))
2055 pr_info("Initialized device %s.\n", netdev->name);
2061 * spider_net_alloc_card - allocates net_device and card structure
2063 * returns the card structure or NULL in case of errors
2065 * the card and net_device structures are linked to each other
2067 static struct spider_net_card *
2068 spider_net_alloc_card(void)
2070 struct net_device *netdev;
2071 struct spider_net_card *card;
2073 netdev = alloc_etherdev(sizeof(struct spider_net_card));
2077 card = netdev_priv(netdev);
2078 card->netdev = netdev;
2079 card->msg_enable = SPIDER_NET_DEFAULT_MSG;
2080 INIT_WORK(&card->tx_timeout_task, spider_net_tx_timeout_task);
2081 init_waitqueue_head(&card->waitq);
2082 atomic_set(&card->tx_timeout_task_counter, 0);
2088 * spider_net_undo_pci_setup - releases PCI ressources
2089 * @card: card structure
2091 * spider_net_undo_pci_setup releases the mapped regions
2094 spider_net_undo_pci_setup(struct spider_net_card *card)
2096 iounmap(card->regs);
2097 pci_release_regions(card->pdev);
2101 * spider_net_setup_pci_dev - sets up the device in terms of PCI operations
2102 * @card: card structure
2105 * Returns the card structure or NULL if any errors occur
2107 * spider_net_setup_pci_dev initializes pdev and together with the
2108 * functions called in spider_net_open configures the device so that
2109 * data can be transferred over it
2110 * The net_device structure is attached to the card structure, if the
2111 * function returns without error.
2113 static struct spider_net_card *
2114 spider_net_setup_pci_dev(struct pci_dev *pdev)
2116 struct spider_net_card *card;
2117 unsigned long mmio_start, mmio_len;
2119 if (pci_enable_device(pdev)) {
2120 pr_err("Couldn't enable PCI device\n");
2124 if (!(pci_resource_flags(pdev, 0) & IORESOURCE_MEM)) {
2125 pr_err("Couldn't find proper PCI device base address.\n");
2126 goto out_disable_dev;
2129 if (pci_request_regions(pdev, spider_net_driver_name)) {
2130 pr_err("Couldn't obtain PCI resources, aborting.\n");
2131 goto out_disable_dev;
2134 pci_set_master(pdev);
2136 card = spider_net_alloc_card();
2138 pr_err("Couldn't allocate net_device structure, "
2140 goto out_release_regions;
2144 /* fetch base address and length of first resource */
2145 mmio_start = pci_resource_start(pdev, 0);
2146 mmio_len = pci_resource_len(pdev, 0);
2148 card->netdev->mem_start = mmio_start;
2149 card->netdev->mem_end = mmio_start + mmio_len;
2150 card->regs = ioremap(mmio_start, mmio_len);
2153 pr_err("Couldn't obtain PCI resources, aborting.\n");
2154 goto out_release_regions;
2159 out_release_regions:
2160 pci_release_regions(pdev);
2162 pci_disable_device(pdev);
2163 pci_set_drvdata(pdev, NULL);
2168 * spider_net_probe - initialization of a device
2170 * @ent: entry in the device id list
2172 * Returns 0 on success, <0 on failure
2174 * spider_net_probe initializes pdev and registers a net_device
2175 * structure for it. After that, the device can be ifconfig'ed up
2177 static int __devinit
2178 spider_net_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
2181 struct spider_net_card *card;
2183 card = spider_net_setup_pci_dev(pdev);
2187 spider_net_workaround_rxramfull(card);
2188 spider_net_init_card(card);
2190 err = spider_net_setup_phy(card);
2194 err = spider_net_init_firmware(card);
2198 err = spider_net_setup_netdev(card);
2205 spider_net_undo_pci_setup(card);
2206 free_netdev(card->netdev);
2212 * spider_net_remove - removal of a device
2215 * Returns 0 on success, <0 on failure
2217 * spider_net_remove is called to remove the device and unregisters the
2220 static void __devexit
2221 spider_net_remove(struct pci_dev *pdev)
2223 struct net_device *netdev;
2224 struct spider_net_card *card;
2226 netdev = pci_get_drvdata(pdev);
2227 card = netdev_priv(netdev);
2229 wait_event(card->waitq,
2230 atomic_read(&card->tx_timeout_task_counter) == 0);
2232 unregister_netdev(netdev);
2234 /* switch off card */
2235 spider_net_write_reg(card, SPIDER_NET_CKRCTRL,
2236 SPIDER_NET_CKRCTRL_STOP_VALUE);
2237 spider_net_write_reg(card, SPIDER_NET_CKRCTRL,
2238 SPIDER_NET_CKRCTRL_RUN_VALUE);
2240 spider_net_undo_pci_setup(card);
2241 free_netdev(netdev);
2244 static struct pci_driver spider_net_driver = {
2245 .name = spider_net_driver_name,
2246 .id_table = spider_net_pci_tbl,
2247 .probe = spider_net_probe,
2248 .remove = __devexit_p(spider_net_remove)
2252 * spider_net_init - init function when the driver is loaded
2254 * spider_net_init registers the device driver
2256 static int __init spider_net_init(void)
2258 printk(KERN_INFO "Spidernet version %s.\n", VERSION);
2260 if (rx_descriptors < SPIDER_NET_RX_DESCRIPTORS_MIN) {
2261 rx_descriptors = SPIDER_NET_RX_DESCRIPTORS_MIN;
2262 pr_info("adjusting rx descriptors to %i.\n", rx_descriptors);
2264 if (rx_descriptors > SPIDER_NET_RX_DESCRIPTORS_MAX) {
2265 rx_descriptors = SPIDER_NET_RX_DESCRIPTORS_MAX;
2266 pr_info("adjusting rx descriptors to %i.\n", rx_descriptors);
2268 if (tx_descriptors < SPIDER_NET_TX_DESCRIPTORS_MIN) {
2269 tx_descriptors = SPIDER_NET_TX_DESCRIPTORS_MIN;
2270 pr_info("adjusting tx descriptors to %i.\n", tx_descriptors);
2272 if (tx_descriptors > SPIDER_NET_TX_DESCRIPTORS_MAX) {
2273 tx_descriptors = SPIDER_NET_TX_DESCRIPTORS_MAX;
2274 pr_info("adjusting tx descriptors to %i.\n", tx_descriptors);
2277 return pci_register_driver(&spider_net_driver);
2281 * spider_net_cleanup - exit function when driver is unloaded
2283 * spider_net_cleanup unregisters the device driver
2285 static void __exit spider_net_cleanup(void)
2287 pci_unregister_driver(&spider_net_driver);
2290 module_init(spider_net_init);
2291 module_exit(spider_net_cleanup);