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