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