include: replace linux/module.h with "struct module" wherever possible
[linux-2.6/next.git] / drivers / net / ftgmac100.c
blob54709af917e9fbd47614521dac24fdf6601fb3d2
1 /*
2 * Faraday FTGMAC100 Gigabit Ethernet
4 * (C) Copyright 2009-2011 Faraday Technology
5 * Po-Yu Chuang <ratbert@faraday-tech.com>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
24 #include <linux/dma-mapping.h>
25 #include <linux/etherdevice.h>
26 #include <linux/ethtool.h>
27 #include <linux/init.h>
28 #include <linux/io.h>
29 #include <linux/module.h>
30 #include <linux/netdevice.h>
31 #include <linux/phy.h>
32 #include <linux/platform_device.h>
33 #include <net/ip.h>
35 #include "ftgmac100.h"
37 #define DRV_NAME "ftgmac100"
38 #define DRV_VERSION "0.7"
40 #define RX_QUEUE_ENTRIES 256 /* must be power of 2 */
41 #define TX_QUEUE_ENTRIES 512 /* must be power of 2 */
43 #define MAX_PKT_SIZE 1518
44 #define RX_BUF_SIZE PAGE_SIZE /* must be smaller than 0x3fff */
46 /******************************************************************************
47 * private data
48 *****************************************************************************/
49 struct ftgmac100_descs {
50 struct ftgmac100_rxdes rxdes[RX_QUEUE_ENTRIES];
51 struct ftgmac100_txdes txdes[TX_QUEUE_ENTRIES];
54 struct ftgmac100 {
55 struct resource *res;
56 void __iomem *base;
57 int irq;
59 struct ftgmac100_descs *descs;
60 dma_addr_t descs_dma_addr;
62 unsigned int rx_pointer;
63 unsigned int tx_clean_pointer;
64 unsigned int tx_pointer;
65 unsigned int tx_pending;
67 spinlock_t tx_lock;
69 struct net_device *netdev;
70 struct device *dev;
71 struct napi_struct napi;
73 struct mii_bus *mii_bus;
74 int phy_irq[PHY_MAX_ADDR];
75 struct phy_device *phydev;
76 int old_speed;
79 static int ftgmac100_alloc_rx_page(struct ftgmac100 *priv,
80 struct ftgmac100_rxdes *rxdes, gfp_t gfp);
82 /******************************************************************************
83 * internal functions (hardware register access)
84 *****************************************************************************/
85 #define INT_MASK_ALL_ENABLED (FTGMAC100_INT_RPKT_LOST | \
86 FTGMAC100_INT_XPKT_ETH | \
87 FTGMAC100_INT_XPKT_LOST | \
88 FTGMAC100_INT_AHB_ERR | \
89 FTGMAC100_INT_PHYSTS_CHG | \
90 FTGMAC100_INT_RPKT_BUF | \
91 FTGMAC100_INT_NO_RXBUF)
93 static void ftgmac100_set_rx_ring_base(struct ftgmac100 *priv, dma_addr_t addr)
95 iowrite32(addr, priv->base + FTGMAC100_OFFSET_RXR_BADR);
98 static void ftgmac100_set_rx_buffer_size(struct ftgmac100 *priv,
99 unsigned int size)
101 size = FTGMAC100_RBSR_SIZE(size);
102 iowrite32(size, priv->base + FTGMAC100_OFFSET_RBSR);
105 static void ftgmac100_set_normal_prio_tx_ring_base(struct ftgmac100 *priv,
106 dma_addr_t addr)
108 iowrite32(addr, priv->base + FTGMAC100_OFFSET_NPTXR_BADR);
111 static void ftgmac100_txdma_normal_prio_start_polling(struct ftgmac100 *priv)
113 iowrite32(1, priv->base + FTGMAC100_OFFSET_NPTXPD);
116 static int ftgmac100_reset_hw(struct ftgmac100 *priv)
118 struct net_device *netdev = priv->netdev;
119 int i;
121 /* NOTE: reset clears all registers */
122 iowrite32(FTGMAC100_MACCR_SW_RST, priv->base + FTGMAC100_OFFSET_MACCR);
123 for (i = 0; i < 5; i++) {
124 unsigned int maccr;
126 maccr = ioread32(priv->base + FTGMAC100_OFFSET_MACCR);
127 if (!(maccr & FTGMAC100_MACCR_SW_RST))
128 return 0;
130 udelay(1000);
133 netdev_err(netdev, "software reset failed\n");
134 return -EIO;
137 static void ftgmac100_set_mac(struct ftgmac100 *priv, const unsigned char *mac)
139 unsigned int maddr = mac[0] << 8 | mac[1];
140 unsigned int laddr = mac[2] << 24 | mac[3] << 16 | mac[4] << 8 | mac[5];
142 iowrite32(maddr, priv->base + FTGMAC100_OFFSET_MAC_MADR);
143 iowrite32(laddr, priv->base + FTGMAC100_OFFSET_MAC_LADR);
146 static void ftgmac100_init_hw(struct ftgmac100 *priv)
148 /* setup ring buffer base registers */
149 ftgmac100_set_rx_ring_base(priv,
150 priv->descs_dma_addr +
151 offsetof(struct ftgmac100_descs, rxdes));
152 ftgmac100_set_normal_prio_tx_ring_base(priv,
153 priv->descs_dma_addr +
154 offsetof(struct ftgmac100_descs, txdes));
156 ftgmac100_set_rx_buffer_size(priv, RX_BUF_SIZE);
158 iowrite32(FTGMAC100_APTC_RXPOLL_CNT(1), priv->base + FTGMAC100_OFFSET_APTC);
160 ftgmac100_set_mac(priv, priv->netdev->dev_addr);
163 #define MACCR_ENABLE_ALL (FTGMAC100_MACCR_TXDMA_EN | \
164 FTGMAC100_MACCR_RXDMA_EN | \
165 FTGMAC100_MACCR_TXMAC_EN | \
166 FTGMAC100_MACCR_RXMAC_EN | \
167 FTGMAC100_MACCR_FULLDUP | \
168 FTGMAC100_MACCR_CRC_APD | \
169 FTGMAC100_MACCR_RX_RUNT | \
170 FTGMAC100_MACCR_RX_BROADPKT)
172 static void ftgmac100_start_hw(struct ftgmac100 *priv, int speed)
174 int maccr = MACCR_ENABLE_ALL;
176 switch (speed) {
177 default:
178 case 10:
179 break;
181 case 100:
182 maccr |= FTGMAC100_MACCR_FAST_MODE;
183 break;
185 case 1000:
186 maccr |= FTGMAC100_MACCR_GIGA_MODE;
187 break;
190 iowrite32(maccr, priv->base + FTGMAC100_OFFSET_MACCR);
193 static void ftgmac100_stop_hw(struct ftgmac100 *priv)
195 iowrite32(0, priv->base + FTGMAC100_OFFSET_MACCR);
198 /******************************************************************************
199 * internal functions (receive descriptor)
200 *****************************************************************************/
201 static bool ftgmac100_rxdes_first_segment(struct ftgmac100_rxdes *rxdes)
203 return rxdes->rxdes0 & cpu_to_le32(FTGMAC100_RXDES0_FRS);
206 static bool ftgmac100_rxdes_last_segment(struct ftgmac100_rxdes *rxdes)
208 return rxdes->rxdes0 & cpu_to_le32(FTGMAC100_RXDES0_LRS);
211 static bool ftgmac100_rxdes_packet_ready(struct ftgmac100_rxdes *rxdes)
213 return rxdes->rxdes0 & cpu_to_le32(FTGMAC100_RXDES0_RXPKT_RDY);
216 static void ftgmac100_rxdes_set_dma_own(struct ftgmac100_rxdes *rxdes)
218 /* clear status bits */
219 rxdes->rxdes0 &= cpu_to_le32(FTGMAC100_RXDES0_EDORR);
222 static bool ftgmac100_rxdes_rx_error(struct ftgmac100_rxdes *rxdes)
224 return rxdes->rxdes0 & cpu_to_le32(FTGMAC100_RXDES0_RX_ERR);
227 static bool ftgmac100_rxdes_crc_error(struct ftgmac100_rxdes *rxdes)
229 return rxdes->rxdes0 & cpu_to_le32(FTGMAC100_RXDES0_CRC_ERR);
232 static bool ftgmac100_rxdes_frame_too_long(struct ftgmac100_rxdes *rxdes)
234 return rxdes->rxdes0 & cpu_to_le32(FTGMAC100_RXDES0_FTL);
237 static bool ftgmac100_rxdes_runt(struct ftgmac100_rxdes *rxdes)
239 return rxdes->rxdes0 & cpu_to_le32(FTGMAC100_RXDES0_RUNT);
242 static bool ftgmac100_rxdes_odd_nibble(struct ftgmac100_rxdes *rxdes)
244 return rxdes->rxdes0 & cpu_to_le32(FTGMAC100_RXDES0_RX_ODD_NB);
247 static unsigned int ftgmac100_rxdes_data_length(struct ftgmac100_rxdes *rxdes)
249 return le32_to_cpu(rxdes->rxdes0) & FTGMAC100_RXDES0_VDBC;
252 static bool ftgmac100_rxdes_multicast(struct ftgmac100_rxdes *rxdes)
254 return rxdes->rxdes0 & cpu_to_le32(FTGMAC100_RXDES0_MULTICAST);
257 static void ftgmac100_rxdes_set_end_of_ring(struct ftgmac100_rxdes *rxdes)
259 rxdes->rxdes0 |= cpu_to_le32(FTGMAC100_RXDES0_EDORR);
262 static void ftgmac100_rxdes_set_dma_addr(struct ftgmac100_rxdes *rxdes,
263 dma_addr_t addr)
265 rxdes->rxdes3 = cpu_to_le32(addr);
268 static dma_addr_t ftgmac100_rxdes_get_dma_addr(struct ftgmac100_rxdes *rxdes)
270 return le32_to_cpu(rxdes->rxdes3);
273 static bool ftgmac100_rxdes_is_tcp(struct ftgmac100_rxdes *rxdes)
275 return (rxdes->rxdes1 & cpu_to_le32(FTGMAC100_RXDES1_PROT_MASK)) ==
276 cpu_to_le32(FTGMAC100_RXDES1_PROT_TCPIP);
279 static bool ftgmac100_rxdes_is_udp(struct ftgmac100_rxdes *rxdes)
281 return (rxdes->rxdes1 & cpu_to_le32(FTGMAC100_RXDES1_PROT_MASK)) ==
282 cpu_to_le32(FTGMAC100_RXDES1_PROT_UDPIP);
285 static bool ftgmac100_rxdes_tcpcs_err(struct ftgmac100_rxdes *rxdes)
287 return rxdes->rxdes1 & cpu_to_le32(FTGMAC100_RXDES1_TCP_CHKSUM_ERR);
290 static bool ftgmac100_rxdes_udpcs_err(struct ftgmac100_rxdes *rxdes)
292 return rxdes->rxdes1 & cpu_to_le32(FTGMAC100_RXDES1_UDP_CHKSUM_ERR);
295 static bool ftgmac100_rxdes_ipcs_err(struct ftgmac100_rxdes *rxdes)
297 return rxdes->rxdes1 & cpu_to_le32(FTGMAC100_RXDES1_IP_CHKSUM_ERR);
301 * rxdes2 is not used by hardware. We use it to keep track of page.
302 * Since hardware does not touch it, we can skip cpu_to_le32()/le32_to_cpu().
304 static void ftgmac100_rxdes_set_page(struct ftgmac100_rxdes *rxdes, struct page *page)
306 rxdes->rxdes2 = (unsigned int)page;
309 static struct page *ftgmac100_rxdes_get_page(struct ftgmac100_rxdes *rxdes)
311 return (struct page *)rxdes->rxdes2;
314 /******************************************************************************
315 * internal functions (receive)
316 *****************************************************************************/
317 static int ftgmac100_next_rx_pointer(int pointer)
319 return (pointer + 1) & (RX_QUEUE_ENTRIES - 1);
322 static void ftgmac100_rx_pointer_advance(struct ftgmac100 *priv)
324 priv->rx_pointer = ftgmac100_next_rx_pointer(priv->rx_pointer);
327 static struct ftgmac100_rxdes *ftgmac100_current_rxdes(struct ftgmac100 *priv)
329 return &priv->descs->rxdes[priv->rx_pointer];
332 static struct ftgmac100_rxdes *
333 ftgmac100_rx_locate_first_segment(struct ftgmac100 *priv)
335 struct ftgmac100_rxdes *rxdes = ftgmac100_current_rxdes(priv);
337 while (ftgmac100_rxdes_packet_ready(rxdes)) {
338 if (ftgmac100_rxdes_first_segment(rxdes))
339 return rxdes;
341 ftgmac100_rxdes_set_dma_own(rxdes);
342 ftgmac100_rx_pointer_advance(priv);
343 rxdes = ftgmac100_current_rxdes(priv);
346 return NULL;
349 static bool ftgmac100_rx_packet_error(struct ftgmac100 *priv,
350 struct ftgmac100_rxdes *rxdes)
352 struct net_device *netdev = priv->netdev;
353 bool error = false;
355 if (unlikely(ftgmac100_rxdes_rx_error(rxdes))) {
356 if (net_ratelimit())
357 netdev_info(netdev, "rx err\n");
359 netdev->stats.rx_errors++;
360 error = true;
363 if (unlikely(ftgmac100_rxdes_crc_error(rxdes))) {
364 if (net_ratelimit())
365 netdev_info(netdev, "rx crc err\n");
367 netdev->stats.rx_crc_errors++;
368 error = true;
369 } else if (unlikely(ftgmac100_rxdes_ipcs_err(rxdes))) {
370 if (net_ratelimit())
371 netdev_info(netdev, "rx IP checksum err\n");
373 error = true;
376 if (unlikely(ftgmac100_rxdes_frame_too_long(rxdes))) {
377 if (net_ratelimit())
378 netdev_info(netdev, "rx frame too long\n");
380 netdev->stats.rx_length_errors++;
381 error = true;
382 } else if (unlikely(ftgmac100_rxdes_runt(rxdes))) {
383 if (net_ratelimit())
384 netdev_info(netdev, "rx runt\n");
386 netdev->stats.rx_length_errors++;
387 error = true;
388 } else if (unlikely(ftgmac100_rxdes_odd_nibble(rxdes))) {
389 if (net_ratelimit())
390 netdev_info(netdev, "rx odd nibble\n");
392 netdev->stats.rx_length_errors++;
393 error = true;
396 return error;
399 static void ftgmac100_rx_drop_packet(struct ftgmac100 *priv)
401 struct net_device *netdev = priv->netdev;
402 struct ftgmac100_rxdes *rxdes = ftgmac100_current_rxdes(priv);
403 bool done = false;
405 if (net_ratelimit())
406 netdev_dbg(netdev, "drop packet %p\n", rxdes);
408 do {
409 if (ftgmac100_rxdes_last_segment(rxdes))
410 done = true;
412 ftgmac100_rxdes_set_dma_own(rxdes);
413 ftgmac100_rx_pointer_advance(priv);
414 rxdes = ftgmac100_current_rxdes(priv);
415 } while (!done && ftgmac100_rxdes_packet_ready(rxdes));
417 netdev->stats.rx_dropped++;
420 static bool ftgmac100_rx_packet(struct ftgmac100 *priv, int *processed)
422 struct net_device *netdev = priv->netdev;
423 struct ftgmac100_rxdes *rxdes;
424 struct sk_buff *skb;
425 bool done = false;
427 rxdes = ftgmac100_rx_locate_first_segment(priv);
428 if (!rxdes)
429 return false;
431 if (unlikely(ftgmac100_rx_packet_error(priv, rxdes))) {
432 ftgmac100_rx_drop_packet(priv);
433 return true;
436 /* start processing */
437 skb = netdev_alloc_skb_ip_align(netdev, 128);
438 if (unlikely(!skb)) {
439 if (net_ratelimit())
440 netdev_err(netdev, "rx skb alloc failed\n");
442 ftgmac100_rx_drop_packet(priv);
443 return true;
446 if (unlikely(ftgmac100_rxdes_multicast(rxdes)))
447 netdev->stats.multicast++;
450 * It seems that HW does checksum incorrectly with fragmented packets,
451 * so we are conservative here - if HW checksum error, let software do
452 * the checksum again.
454 if ((ftgmac100_rxdes_is_tcp(rxdes) && !ftgmac100_rxdes_tcpcs_err(rxdes)) ||
455 (ftgmac100_rxdes_is_udp(rxdes) && !ftgmac100_rxdes_udpcs_err(rxdes)))
456 skb->ip_summed = CHECKSUM_UNNECESSARY;
458 do {
459 dma_addr_t map = ftgmac100_rxdes_get_dma_addr(rxdes);
460 struct page *page = ftgmac100_rxdes_get_page(rxdes);
461 unsigned int size;
463 dma_unmap_page(priv->dev, map, RX_BUF_SIZE, DMA_FROM_DEVICE);
465 size = ftgmac100_rxdes_data_length(rxdes);
466 skb_fill_page_desc(skb, skb_shinfo(skb)->nr_frags, page, 0, size);
468 skb->len += size;
469 skb->data_len += size;
470 skb->truesize += size;
472 if (ftgmac100_rxdes_last_segment(rxdes))
473 done = true;
475 ftgmac100_alloc_rx_page(priv, rxdes, GFP_ATOMIC);
477 ftgmac100_rx_pointer_advance(priv);
478 rxdes = ftgmac100_current_rxdes(priv);
479 } while (!done);
481 __pskb_pull_tail(skb, min(skb->len, 64U));
482 skb->protocol = eth_type_trans(skb, netdev);
484 netdev->stats.rx_packets++;
485 netdev->stats.rx_bytes += skb->len;
487 /* push packet to protocol stack */
488 napi_gro_receive(&priv->napi, skb);
490 (*processed)++;
491 return true;
494 /******************************************************************************
495 * internal functions (transmit descriptor)
496 *****************************************************************************/
497 static void ftgmac100_txdes_reset(struct ftgmac100_txdes *txdes)
499 /* clear all except end of ring bit */
500 txdes->txdes0 &= cpu_to_le32(FTGMAC100_TXDES0_EDOTR);
501 txdes->txdes1 = 0;
502 txdes->txdes2 = 0;
503 txdes->txdes3 = 0;
506 static bool ftgmac100_txdes_owned_by_dma(struct ftgmac100_txdes *txdes)
508 return txdes->txdes0 & cpu_to_le32(FTGMAC100_TXDES0_TXDMA_OWN);
511 static void ftgmac100_txdes_set_dma_own(struct ftgmac100_txdes *txdes)
514 * Make sure dma own bit will not be set before any other
515 * descriptor fields.
517 wmb();
518 txdes->txdes0 |= cpu_to_le32(FTGMAC100_TXDES0_TXDMA_OWN);
521 static void ftgmac100_txdes_set_end_of_ring(struct ftgmac100_txdes *txdes)
523 txdes->txdes0 |= cpu_to_le32(FTGMAC100_TXDES0_EDOTR);
526 static void ftgmac100_txdes_set_first_segment(struct ftgmac100_txdes *txdes)
528 txdes->txdes0 |= cpu_to_le32(FTGMAC100_TXDES0_FTS);
531 static void ftgmac100_txdes_set_last_segment(struct ftgmac100_txdes *txdes)
533 txdes->txdes0 |= cpu_to_le32(FTGMAC100_TXDES0_LTS);
536 static void ftgmac100_txdes_set_buffer_size(struct ftgmac100_txdes *txdes,
537 unsigned int len)
539 txdes->txdes0 |= cpu_to_le32(FTGMAC100_TXDES0_TXBUF_SIZE(len));
542 static void ftgmac100_txdes_set_txint(struct ftgmac100_txdes *txdes)
544 txdes->txdes1 |= cpu_to_le32(FTGMAC100_TXDES1_TXIC);
547 static void ftgmac100_txdes_set_tcpcs(struct ftgmac100_txdes *txdes)
549 txdes->txdes1 |= cpu_to_le32(FTGMAC100_TXDES1_TCP_CHKSUM);
552 static void ftgmac100_txdes_set_udpcs(struct ftgmac100_txdes *txdes)
554 txdes->txdes1 |= cpu_to_le32(FTGMAC100_TXDES1_UDP_CHKSUM);
557 static void ftgmac100_txdes_set_ipcs(struct ftgmac100_txdes *txdes)
559 txdes->txdes1 |= cpu_to_le32(FTGMAC100_TXDES1_IP_CHKSUM);
562 static void ftgmac100_txdes_set_dma_addr(struct ftgmac100_txdes *txdes,
563 dma_addr_t addr)
565 txdes->txdes3 = cpu_to_le32(addr);
568 static dma_addr_t ftgmac100_txdes_get_dma_addr(struct ftgmac100_txdes *txdes)
570 return le32_to_cpu(txdes->txdes3);
574 * txdes2 is not used by hardware. We use it to keep track of socket buffer.
575 * Since hardware does not touch it, we can skip cpu_to_le32()/le32_to_cpu().
577 static void ftgmac100_txdes_set_skb(struct ftgmac100_txdes *txdes,
578 struct sk_buff *skb)
580 txdes->txdes2 = (unsigned int)skb;
583 static struct sk_buff *ftgmac100_txdes_get_skb(struct ftgmac100_txdes *txdes)
585 return (struct sk_buff *)txdes->txdes2;
588 /******************************************************************************
589 * internal functions (transmit)
590 *****************************************************************************/
591 static int ftgmac100_next_tx_pointer(int pointer)
593 return (pointer + 1) & (TX_QUEUE_ENTRIES - 1);
596 static void ftgmac100_tx_pointer_advance(struct ftgmac100 *priv)
598 priv->tx_pointer = ftgmac100_next_tx_pointer(priv->tx_pointer);
601 static void ftgmac100_tx_clean_pointer_advance(struct ftgmac100 *priv)
603 priv->tx_clean_pointer = ftgmac100_next_tx_pointer(priv->tx_clean_pointer);
606 static struct ftgmac100_txdes *ftgmac100_current_txdes(struct ftgmac100 *priv)
608 return &priv->descs->txdes[priv->tx_pointer];
611 static struct ftgmac100_txdes *
612 ftgmac100_current_clean_txdes(struct ftgmac100 *priv)
614 return &priv->descs->txdes[priv->tx_clean_pointer];
617 static bool ftgmac100_tx_complete_packet(struct ftgmac100 *priv)
619 struct net_device *netdev = priv->netdev;
620 struct ftgmac100_txdes *txdes;
621 struct sk_buff *skb;
622 dma_addr_t map;
624 if (priv->tx_pending == 0)
625 return false;
627 txdes = ftgmac100_current_clean_txdes(priv);
629 if (ftgmac100_txdes_owned_by_dma(txdes))
630 return false;
632 skb = ftgmac100_txdes_get_skb(txdes);
633 map = ftgmac100_txdes_get_dma_addr(txdes);
635 netdev->stats.tx_packets++;
636 netdev->stats.tx_bytes += skb->len;
638 dma_unmap_single(priv->dev, map, skb_headlen(skb), DMA_TO_DEVICE);
640 dev_kfree_skb(skb);
642 ftgmac100_txdes_reset(txdes);
644 ftgmac100_tx_clean_pointer_advance(priv);
646 spin_lock(&priv->tx_lock);
647 priv->tx_pending--;
648 spin_unlock(&priv->tx_lock);
649 netif_wake_queue(netdev);
651 return true;
654 static void ftgmac100_tx_complete(struct ftgmac100 *priv)
656 while (ftgmac100_tx_complete_packet(priv))
660 static int ftgmac100_xmit(struct ftgmac100 *priv, struct sk_buff *skb,
661 dma_addr_t map)
663 struct net_device *netdev = priv->netdev;
664 struct ftgmac100_txdes *txdes;
665 unsigned int len = (skb->len < ETH_ZLEN) ? ETH_ZLEN : skb->len;
667 txdes = ftgmac100_current_txdes(priv);
668 ftgmac100_tx_pointer_advance(priv);
670 /* setup TX descriptor */
671 ftgmac100_txdes_set_skb(txdes, skb);
672 ftgmac100_txdes_set_dma_addr(txdes, map);
673 ftgmac100_txdes_set_buffer_size(txdes, len);
675 ftgmac100_txdes_set_first_segment(txdes);
676 ftgmac100_txdes_set_last_segment(txdes);
677 ftgmac100_txdes_set_txint(txdes);
678 if (skb->ip_summed == CHECKSUM_PARTIAL) {
679 __be16 protocol = skb->protocol;
681 if (protocol == cpu_to_be16(ETH_P_IP)) {
682 u8 ip_proto = ip_hdr(skb)->protocol;
684 ftgmac100_txdes_set_ipcs(txdes);
685 if (ip_proto == IPPROTO_TCP)
686 ftgmac100_txdes_set_tcpcs(txdes);
687 else if (ip_proto == IPPROTO_UDP)
688 ftgmac100_txdes_set_udpcs(txdes);
692 spin_lock(&priv->tx_lock);
693 priv->tx_pending++;
694 if (priv->tx_pending == TX_QUEUE_ENTRIES)
695 netif_stop_queue(netdev);
697 /* start transmit */
698 ftgmac100_txdes_set_dma_own(txdes);
699 spin_unlock(&priv->tx_lock);
701 ftgmac100_txdma_normal_prio_start_polling(priv);
703 return NETDEV_TX_OK;
706 /******************************************************************************
707 * internal functions (buffer)
708 *****************************************************************************/
709 static int ftgmac100_alloc_rx_page(struct ftgmac100 *priv,
710 struct ftgmac100_rxdes *rxdes, gfp_t gfp)
712 struct net_device *netdev = priv->netdev;
713 struct page *page;
714 dma_addr_t map;
716 page = alloc_page(gfp);
717 if (!page) {
718 if (net_ratelimit())
719 netdev_err(netdev, "failed to allocate rx page\n");
720 return -ENOMEM;
723 map = dma_map_page(priv->dev, page, 0, RX_BUF_SIZE, DMA_FROM_DEVICE);
724 if (unlikely(dma_mapping_error(priv->dev, map))) {
725 if (net_ratelimit())
726 netdev_err(netdev, "failed to map rx page\n");
727 __free_page(page);
728 return -ENOMEM;
731 ftgmac100_rxdes_set_page(rxdes, page);
732 ftgmac100_rxdes_set_dma_addr(rxdes, map);
733 ftgmac100_rxdes_set_dma_own(rxdes);
734 return 0;
737 static void ftgmac100_free_buffers(struct ftgmac100 *priv)
739 int i;
741 for (i = 0; i < RX_QUEUE_ENTRIES; i++) {
742 struct ftgmac100_rxdes *rxdes = &priv->descs->rxdes[i];
743 struct page *page = ftgmac100_rxdes_get_page(rxdes);
744 dma_addr_t map = ftgmac100_rxdes_get_dma_addr(rxdes);
746 if (!page)
747 continue;
749 dma_unmap_page(priv->dev, map, RX_BUF_SIZE, DMA_FROM_DEVICE);
750 __free_page(page);
753 for (i = 0; i < TX_QUEUE_ENTRIES; i++) {
754 struct ftgmac100_txdes *txdes = &priv->descs->txdes[i];
755 struct sk_buff *skb = ftgmac100_txdes_get_skb(txdes);
756 dma_addr_t map = ftgmac100_txdes_get_dma_addr(txdes);
758 if (!skb)
759 continue;
761 dma_unmap_single(priv->dev, map, skb_headlen(skb), DMA_TO_DEVICE);
762 dev_kfree_skb(skb);
765 dma_free_coherent(priv->dev, sizeof(struct ftgmac100_descs),
766 priv->descs, priv->descs_dma_addr);
769 static int ftgmac100_alloc_buffers(struct ftgmac100 *priv)
771 int i;
773 priv->descs = dma_alloc_coherent(priv->dev,
774 sizeof(struct ftgmac100_descs),
775 &priv->descs_dma_addr, GFP_KERNEL);
776 if (!priv->descs)
777 return -ENOMEM;
779 memset(priv->descs, 0, sizeof(struct ftgmac100_descs));
781 /* initialize RX ring */
782 ftgmac100_rxdes_set_end_of_ring(&priv->descs->rxdes[RX_QUEUE_ENTRIES - 1]);
784 for (i = 0; i < RX_QUEUE_ENTRIES; i++) {
785 struct ftgmac100_rxdes *rxdes = &priv->descs->rxdes[i];
787 if (ftgmac100_alloc_rx_page(priv, rxdes, GFP_KERNEL))
788 goto err;
791 /* initialize TX ring */
792 ftgmac100_txdes_set_end_of_ring(&priv->descs->txdes[TX_QUEUE_ENTRIES - 1]);
793 return 0;
795 err:
796 ftgmac100_free_buffers(priv);
797 return -ENOMEM;
800 /******************************************************************************
801 * internal functions (mdio)
802 *****************************************************************************/
803 static void ftgmac100_adjust_link(struct net_device *netdev)
805 struct ftgmac100 *priv = netdev_priv(netdev);
806 struct phy_device *phydev = priv->phydev;
807 int ier;
809 if (phydev->speed == priv->old_speed)
810 return;
812 priv->old_speed = phydev->speed;
814 ier = ioread32(priv->base + FTGMAC100_OFFSET_IER);
816 /* disable all interrupts */
817 iowrite32(0, priv->base + FTGMAC100_OFFSET_IER);
819 netif_stop_queue(netdev);
820 ftgmac100_stop_hw(priv);
822 netif_start_queue(netdev);
823 ftgmac100_init_hw(priv);
824 ftgmac100_start_hw(priv, phydev->speed);
826 /* re-enable interrupts */
827 iowrite32(ier, priv->base + FTGMAC100_OFFSET_IER);
830 static int ftgmac100_mii_probe(struct ftgmac100 *priv)
832 struct net_device *netdev = priv->netdev;
833 struct phy_device *phydev = NULL;
834 int i;
836 /* search for connect PHY device */
837 for (i = 0; i < PHY_MAX_ADDR; i++) {
838 struct phy_device *tmp = priv->mii_bus->phy_map[i];
840 if (tmp) {
841 phydev = tmp;
842 break;
846 /* now we are supposed to have a proper phydev, to attach to... */
847 if (!phydev) {
848 netdev_info(netdev, "%s: no PHY found\n", netdev->name);
849 return -ENODEV;
852 phydev = phy_connect(netdev, dev_name(&phydev->dev),
853 &ftgmac100_adjust_link, 0,
854 PHY_INTERFACE_MODE_GMII);
856 if (IS_ERR(phydev)) {
857 netdev_err(netdev, "%s: Could not attach to PHY\n", netdev->name);
858 return PTR_ERR(phydev);
861 priv->phydev = phydev;
862 return 0;
865 /******************************************************************************
866 * struct mii_bus functions
867 *****************************************************************************/
868 static int ftgmac100_mdiobus_read(struct mii_bus *bus, int phy_addr, int regnum)
870 struct net_device *netdev = bus->priv;
871 struct ftgmac100 *priv = netdev_priv(netdev);
872 unsigned int phycr;
873 int i;
875 phycr = ioread32(priv->base + FTGMAC100_OFFSET_PHYCR);
877 /* preserve MDC cycle threshold */
878 phycr &= FTGMAC100_PHYCR_MDC_CYCTHR_MASK;
880 phycr |= FTGMAC100_PHYCR_PHYAD(phy_addr) |
881 FTGMAC100_PHYCR_REGAD(regnum) |
882 FTGMAC100_PHYCR_MIIRD;
884 iowrite32(phycr, priv->base + FTGMAC100_OFFSET_PHYCR);
886 for (i = 0; i < 10; i++) {
887 phycr = ioread32(priv->base + FTGMAC100_OFFSET_PHYCR);
889 if ((phycr & FTGMAC100_PHYCR_MIIRD) == 0) {
890 int data;
892 data = ioread32(priv->base + FTGMAC100_OFFSET_PHYDATA);
893 return FTGMAC100_PHYDATA_MIIRDATA(data);
896 udelay(100);
899 netdev_err(netdev, "mdio read timed out\n");
900 return -EIO;
903 static int ftgmac100_mdiobus_write(struct mii_bus *bus, int phy_addr,
904 int regnum, u16 value)
906 struct net_device *netdev = bus->priv;
907 struct ftgmac100 *priv = netdev_priv(netdev);
908 unsigned int phycr;
909 int data;
910 int i;
912 phycr = ioread32(priv->base + FTGMAC100_OFFSET_PHYCR);
914 /* preserve MDC cycle threshold */
915 phycr &= FTGMAC100_PHYCR_MDC_CYCTHR_MASK;
917 phycr |= FTGMAC100_PHYCR_PHYAD(phy_addr) |
918 FTGMAC100_PHYCR_REGAD(regnum) |
919 FTGMAC100_PHYCR_MIIWR;
921 data = FTGMAC100_PHYDATA_MIIWDATA(value);
923 iowrite32(data, priv->base + FTGMAC100_OFFSET_PHYDATA);
924 iowrite32(phycr, priv->base + FTGMAC100_OFFSET_PHYCR);
926 for (i = 0; i < 10; i++) {
927 phycr = ioread32(priv->base + FTGMAC100_OFFSET_PHYCR);
929 if ((phycr & FTGMAC100_PHYCR_MIIWR) == 0)
930 return 0;
932 udelay(100);
935 netdev_err(netdev, "mdio write timed out\n");
936 return -EIO;
939 static int ftgmac100_mdiobus_reset(struct mii_bus *bus)
941 return 0;
944 /******************************************************************************
945 * struct ethtool_ops functions
946 *****************************************************************************/
947 static void ftgmac100_get_drvinfo(struct net_device *netdev,
948 struct ethtool_drvinfo *info)
950 strcpy(info->driver, DRV_NAME);
951 strcpy(info->version, DRV_VERSION);
952 strcpy(info->bus_info, dev_name(&netdev->dev));
955 static int ftgmac100_get_settings(struct net_device *netdev,
956 struct ethtool_cmd *cmd)
958 struct ftgmac100 *priv = netdev_priv(netdev);
960 return phy_ethtool_gset(priv->phydev, cmd);
963 static int ftgmac100_set_settings(struct net_device *netdev,
964 struct ethtool_cmd *cmd)
966 struct ftgmac100 *priv = netdev_priv(netdev);
968 return phy_ethtool_sset(priv->phydev, cmd);
971 static const struct ethtool_ops ftgmac100_ethtool_ops = {
972 .set_settings = ftgmac100_set_settings,
973 .get_settings = ftgmac100_get_settings,
974 .get_drvinfo = ftgmac100_get_drvinfo,
975 .get_link = ethtool_op_get_link,
978 /******************************************************************************
979 * interrupt handler
980 *****************************************************************************/
981 static irqreturn_t ftgmac100_interrupt(int irq, void *dev_id)
983 struct net_device *netdev = dev_id;
984 struct ftgmac100 *priv = netdev_priv(netdev);
986 if (likely(netif_running(netdev))) {
987 /* Disable interrupts for polling */
988 iowrite32(0, priv->base + FTGMAC100_OFFSET_IER);
989 napi_schedule(&priv->napi);
992 return IRQ_HANDLED;
995 /******************************************************************************
996 * struct napi_struct functions
997 *****************************************************************************/
998 static int ftgmac100_poll(struct napi_struct *napi, int budget)
1000 struct ftgmac100 *priv = container_of(napi, struct ftgmac100, napi);
1001 struct net_device *netdev = priv->netdev;
1002 unsigned int status;
1003 bool completed = true;
1004 int rx = 0;
1006 status = ioread32(priv->base + FTGMAC100_OFFSET_ISR);
1007 iowrite32(status, priv->base + FTGMAC100_OFFSET_ISR);
1009 if (status & (FTGMAC100_INT_RPKT_BUF | FTGMAC100_INT_NO_RXBUF)) {
1011 * FTGMAC100_INT_RPKT_BUF:
1012 * RX DMA has received packets into RX buffer successfully
1014 * FTGMAC100_INT_NO_RXBUF:
1015 * RX buffer unavailable
1017 bool retry;
1019 do {
1020 retry = ftgmac100_rx_packet(priv, &rx);
1021 } while (retry && rx < budget);
1023 if (retry && rx == budget)
1024 completed = false;
1027 if (status & (FTGMAC100_INT_XPKT_ETH | FTGMAC100_INT_XPKT_LOST)) {
1029 * FTGMAC100_INT_XPKT_ETH:
1030 * packet transmitted to ethernet successfully
1032 * FTGMAC100_INT_XPKT_LOST:
1033 * packet transmitted to ethernet lost due to late
1034 * collision or excessive collision
1036 ftgmac100_tx_complete(priv);
1039 if (status & (FTGMAC100_INT_NO_RXBUF | FTGMAC100_INT_RPKT_LOST |
1040 FTGMAC100_INT_AHB_ERR | FTGMAC100_INT_PHYSTS_CHG)) {
1041 if (net_ratelimit())
1042 netdev_info(netdev, "[ISR] = 0x%x: %s%s%s%s\n", status,
1043 status & FTGMAC100_INT_NO_RXBUF ? "NO_RXBUF " : "",
1044 status & FTGMAC100_INT_RPKT_LOST ? "RPKT_LOST " : "",
1045 status & FTGMAC100_INT_AHB_ERR ? "AHB_ERR " : "",
1046 status & FTGMAC100_INT_PHYSTS_CHG ? "PHYSTS_CHG" : "");
1048 if (status & FTGMAC100_INT_NO_RXBUF) {
1049 /* RX buffer unavailable */
1050 netdev->stats.rx_over_errors++;
1053 if (status & FTGMAC100_INT_RPKT_LOST) {
1054 /* received packet lost due to RX FIFO full */
1055 netdev->stats.rx_fifo_errors++;
1059 if (completed) {
1060 napi_complete(napi);
1062 /* enable all interrupts */
1063 iowrite32(INT_MASK_ALL_ENABLED, priv->base + FTGMAC100_OFFSET_IER);
1066 return rx;
1069 /******************************************************************************
1070 * struct net_device_ops functions
1071 *****************************************************************************/
1072 static int ftgmac100_open(struct net_device *netdev)
1074 struct ftgmac100 *priv = netdev_priv(netdev);
1075 int err;
1077 err = ftgmac100_alloc_buffers(priv);
1078 if (err) {
1079 netdev_err(netdev, "failed to allocate buffers\n");
1080 goto err_alloc;
1083 err = request_irq(priv->irq, ftgmac100_interrupt, 0, netdev->name, netdev);
1084 if (err) {
1085 netdev_err(netdev, "failed to request irq %d\n", priv->irq);
1086 goto err_irq;
1089 priv->rx_pointer = 0;
1090 priv->tx_clean_pointer = 0;
1091 priv->tx_pointer = 0;
1092 priv->tx_pending = 0;
1094 err = ftgmac100_reset_hw(priv);
1095 if (err)
1096 goto err_hw;
1098 ftgmac100_init_hw(priv);
1099 ftgmac100_start_hw(priv, 10);
1101 phy_start(priv->phydev);
1103 napi_enable(&priv->napi);
1104 netif_start_queue(netdev);
1106 /* enable all interrupts */
1107 iowrite32(INT_MASK_ALL_ENABLED, priv->base + FTGMAC100_OFFSET_IER);
1108 return 0;
1110 err_hw:
1111 free_irq(priv->irq, netdev);
1112 err_irq:
1113 ftgmac100_free_buffers(priv);
1114 err_alloc:
1115 return err;
1118 static int ftgmac100_stop(struct net_device *netdev)
1120 struct ftgmac100 *priv = netdev_priv(netdev);
1122 /* disable all interrupts */
1123 iowrite32(0, priv->base + FTGMAC100_OFFSET_IER);
1125 netif_stop_queue(netdev);
1126 napi_disable(&priv->napi);
1127 phy_stop(priv->phydev);
1129 ftgmac100_stop_hw(priv);
1130 free_irq(priv->irq, netdev);
1131 ftgmac100_free_buffers(priv);
1133 return 0;
1136 static int ftgmac100_hard_start_xmit(struct sk_buff *skb,
1137 struct net_device *netdev)
1139 struct ftgmac100 *priv = netdev_priv(netdev);
1140 dma_addr_t map;
1142 if (unlikely(skb->len > MAX_PKT_SIZE)) {
1143 if (net_ratelimit())
1144 netdev_dbg(netdev, "tx packet too big\n");
1146 netdev->stats.tx_dropped++;
1147 dev_kfree_skb(skb);
1148 return NETDEV_TX_OK;
1151 map = dma_map_single(priv->dev, skb->data, skb_headlen(skb), DMA_TO_DEVICE);
1152 if (unlikely(dma_mapping_error(priv->dev, map))) {
1153 /* drop packet */
1154 if (net_ratelimit())
1155 netdev_err(netdev, "map socket buffer failed\n");
1157 netdev->stats.tx_dropped++;
1158 dev_kfree_skb(skb);
1159 return NETDEV_TX_OK;
1162 return ftgmac100_xmit(priv, skb, map);
1165 /* optional */
1166 static int ftgmac100_do_ioctl(struct net_device *netdev, struct ifreq *ifr, int cmd)
1168 struct ftgmac100 *priv = netdev_priv(netdev);
1170 return phy_mii_ioctl(priv->phydev, ifr, cmd);
1173 static const struct net_device_ops ftgmac100_netdev_ops = {
1174 .ndo_open = ftgmac100_open,
1175 .ndo_stop = ftgmac100_stop,
1176 .ndo_start_xmit = ftgmac100_hard_start_xmit,
1177 .ndo_set_mac_address = eth_mac_addr,
1178 .ndo_validate_addr = eth_validate_addr,
1179 .ndo_do_ioctl = ftgmac100_do_ioctl,
1182 /******************************************************************************
1183 * struct platform_driver functions
1184 *****************************************************************************/
1185 static int ftgmac100_probe(struct platform_device *pdev)
1187 struct resource *res;
1188 int irq;
1189 struct net_device *netdev;
1190 struct ftgmac100 *priv;
1191 int err;
1192 int i;
1194 if (!pdev)
1195 return -ENODEV;
1197 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1198 if (!res)
1199 return -ENXIO;
1201 irq = platform_get_irq(pdev, 0);
1202 if (irq < 0)
1203 return irq;
1205 /* setup net_device */
1206 netdev = alloc_etherdev(sizeof(*priv));
1207 if (!netdev) {
1208 err = -ENOMEM;
1209 goto err_alloc_etherdev;
1212 SET_NETDEV_DEV(netdev, &pdev->dev);
1214 SET_ETHTOOL_OPS(netdev, &ftgmac100_ethtool_ops);
1215 netdev->netdev_ops = &ftgmac100_netdev_ops;
1216 netdev->features = NETIF_F_IP_CSUM | NETIF_F_GRO;
1218 platform_set_drvdata(pdev, netdev);
1220 /* setup private data */
1221 priv = netdev_priv(netdev);
1222 priv->netdev = netdev;
1223 priv->dev = &pdev->dev;
1225 spin_lock_init(&priv->tx_lock);
1227 /* initialize NAPI */
1228 netif_napi_add(netdev, &priv->napi, ftgmac100_poll, 64);
1230 /* map io memory */
1231 priv->res = request_mem_region(res->start, resource_size(res),
1232 dev_name(&pdev->dev));
1233 if (!priv->res) {
1234 dev_err(&pdev->dev, "Could not reserve memory region\n");
1235 err = -ENOMEM;
1236 goto err_req_mem;
1239 priv->base = ioremap(res->start, resource_size(res));
1240 if (!priv->base) {
1241 dev_err(&pdev->dev, "Failed to ioremap ethernet registers\n");
1242 err = -EIO;
1243 goto err_ioremap;
1246 priv->irq = irq;
1248 /* initialize mdio bus */
1249 priv->mii_bus = mdiobus_alloc();
1250 if (!priv->mii_bus) {
1251 err = -EIO;
1252 goto err_alloc_mdiobus;
1255 priv->mii_bus->name = "ftgmac100_mdio";
1256 snprintf(priv->mii_bus->id, MII_BUS_ID_SIZE, "ftgmac100_mii");
1258 priv->mii_bus->priv = netdev;
1259 priv->mii_bus->read = ftgmac100_mdiobus_read;
1260 priv->mii_bus->write = ftgmac100_mdiobus_write;
1261 priv->mii_bus->reset = ftgmac100_mdiobus_reset;
1262 priv->mii_bus->irq = priv->phy_irq;
1264 for (i = 0; i < PHY_MAX_ADDR; i++)
1265 priv->mii_bus->irq[i] = PHY_POLL;
1267 err = mdiobus_register(priv->mii_bus);
1268 if (err) {
1269 dev_err(&pdev->dev, "Cannot register MDIO bus!\n");
1270 goto err_register_mdiobus;
1273 err = ftgmac100_mii_probe(priv);
1274 if (err) {
1275 dev_err(&pdev->dev, "MII Probe failed!\n");
1276 goto err_mii_probe;
1279 /* register network device */
1280 err = register_netdev(netdev);
1281 if (err) {
1282 dev_err(&pdev->dev, "Failed to register netdev\n");
1283 goto err_register_netdev;
1286 netdev_info(netdev, "irq %d, mapped at %p\n", priv->irq, priv->base);
1288 if (!is_valid_ether_addr(netdev->dev_addr)) {
1289 random_ether_addr(netdev->dev_addr);
1290 netdev_info(netdev, "generated random MAC address %pM\n",
1291 netdev->dev_addr);
1294 return 0;
1296 err_register_netdev:
1297 phy_disconnect(priv->phydev);
1298 err_mii_probe:
1299 mdiobus_unregister(priv->mii_bus);
1300 err_register_mdiobus:
1301 mdiobus_free(priv->mii_bus);
1302 err_alloc_mdiobus:
1303 iounmap(priv->base);
1304 err_ioremap:
1305 release_resource(priv->res);
1306 err_req_mem:
1307 netif_napi_del(&priv->napi);
1308 platform_set_drvdata(pdev, NULL);
1309 free_netdev(netdev);
1310 err_alloc_etherdev:
1311 return err;
1314 static int __exit ftgmac100_remove(struct platform_device *pdev)
1316 struct net_device *netdev;
1317 struct ftgmac100 *priv;
1319 netdev = platform_get_drvdata(pdev);
1320 priv = netdev_priv(netdev);
1322 unregister_netdev(netdev);
1324 phy_disconnect(priv->phydev);
1325 mdiobus_unregister(priv->mii_bus);
1326 mdiobus_free(priv->mii_bus);
1328 iounmap(priv->base);
1329 release_resource(priv->res);
1331 netif_napi_del(&priv->napi);
1332 platform_set_drvdata(pdev, NULL);
1333 free_netdev(netdev);
1334 return 0;
1337 static struct platform_driver ftgmac100_driver = {
1338 .probe = ftgmac100_probe,
1339 .remove = __exit_p(ftgmac100_remove),
1340 .driver = {
1341 .name = DRV_NAME,
1342 .owner = THIS_MODULE,
1346 /******************************************************************************
1347 * initialization / finalization
1348 *****************************************************************************/
1349 static int __init ftgmac100_init(void)
1351 pr_info("Loading version " DRV_VERSION " ...\n");
1352 return platform_driver_register(&ftgmac100_driver);
1355 static void __exit ftgmac100_exit(void)
1357 platform_driver_unregister(&ftgmac100_driver);
1360 module_init(ftgmac100_init);
1361 module_exit(ftgmac100_exit);
1363 MODULE_AUTHOR("Po-Yu Chuang <ratbert@faraday-tech.com>");
1364 MODULE_DESCRIPTION("FTGMAC100 driver");
1365 MODULE_LICENSE("GPL");