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