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