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