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