2 * Aeroflex Gaisler GRETH 10/100/1G Ethernet MAC.
4 * 2005-2010 (c) Aeroflex Gaisler AB
6 * This driver supports GRETH 10/100 and GRETH 10/100/1G Ethernet MACs
7 * available in the GRLIB VHDL IP core library.
9 * Full documentation of both cores can be found here:
10 * http://www.gaisler.com/products/grlib/grip.pdf
12 * The Gigabit version supports scatter/gather DMA, any alignment of
13 * buffers and checksum offloading.
15 * This program is free software; you can redistribute it and/or modify it
16 * under the terms of the GNU General Public License as published by the
17 * Free Software Foundation; either version 2 of the License, or (at your
18 * option) any later version.
20 * Contributors: Kristoffer Glembo
25 #include <linux/dma-mapping.h>
26 #include <linux/module.h>
27 #include <linux/uaccess.h>
28 #include <linux/interrupt.h>
29 #include <linux/netdevice.h>
30 #include <linux/etherdevice.h>
31 #include <linux/ethtool.h>
32 #include <linux/skbuff.h>
34 #include <linux/crc32.h>
35 #include <linux/mii.h>
36 #include <linux/of_device.h>
37 #include <linux/of_net.h>
38 #include <linux/of_platform.h>
39 #include <linux/slab.h>
40 #include <asm/cacheflush.h>
41 #include <asm/byteorder.h>
44 #include <asm/idprom.h>
49 #define GRETH_DEF_MSG_ENABLE \
58 static int greth_debug = -1; /* -1 == use GRETH_DEF_MSG_ENABLE as value */
59 module_param(greth_debug, int, 0);
60 MODULE_PARM_DESC(greth_debug, "GRETH bitmapped debugging message enable value");
62 /* Accept MAC address of the form macaddr=0x08,0x00,0x20,0x30,0x40,0x50 */
63 static int macaddr[6];
64 module_param_array(macaddr, int, NULL, 0);
65 MODULE_PARM_DESC(macaddr, "GRETH Ethernet MAC address");
67 static int greth_edcl = 1;
68 module_param(greth_edcl, int, 0);
69 MODULE_PARM_DESC(greth_edcl, "GRETH EDCL usage indicator. Set to 1 if EDCL is used.");
71 static int greth_open(struct net_device *dev);
72 static netdev_tx_t greth_start_xmit(struct sk_buff *skb,
73 struct net_device *dev);
74 static netdev_tx_t greth_start_xmit_gbit(struct sk_buff *skb,
75 struct net_device *dev);
76 static int greth_rx(struct net_device *dev, int limit);
77 static int greth_rx_gbit(struct net_device *dev, int limit);
78 static void greth_clean_tx(struct net_device *dev);
79 static void greth_clean_tx_gbit(struct net_device *dev);
80 static irqreturn_t greth_interrupt(int irq, void *dev_id);
81 static int greth_close(struct net_device *dev);
82 static int greth_set_mac_add(struct net_device *dev, void *p);
83 static void greth_set_multicast_list(struct net_device *dev);
85 #define GRETH_REGLOAD(a) (be32_to_cpu(__raw_readl(&(a))))
86 #define GRETH_REGSAVE(a, v) (__raw_writel(cpu_to_be32(v), &(a)))
87 #define GRETH_REGORIN(a, v) (GRETH_REGSAVE(a, (GRETH_REGLOAD(a) | (v))))
88 #define GRETH_REGANDIN(a, v) (GRETH_REGSAVE(a, (GRETH_REGLOAD(a) & (v))))
90 #define NEXT_TX(N) (((N) + 1) & GRETH_TXBD_NUM_MASK)
91 #define SKIP_TX(N, C) (((N) + C) & GRETH_TXBD_NUM_MASK)
92 #define NEXT_RX(N) (((N) + 1) & GRETH_RXBD_NUM_MASK)
94 static void greth_print_rx_packet(void *addr, int len)
96 print_hex_dump(KERN_DEBUG, "RX: ", DUMP_PREFIX_OFFSET, 16, 1,
100 static void greth_print_tx_packet(struct sk_buff *skb)
105 if (skb_shinfo(skb)->nr_frags == 0)
108 length = skb_headlen(skb);
110 print_hex_dump(KERN_DEBUG, "TX: ", DUMP_PREFIX_OFFSET, 16, 1,
111 skb->data, length, true);
113 for (i = 0; i < skb_shinfo(skb)->nr_frags; i++) {
115 print_hex_dump(KERN_DEBUG, "TX: ", DUMP_PREFIX_OFFSET, 16, 1,
116 skb_frag_address(&skb_shinfo(skb)->frags[i]),
117 skb_shinfo(skb)->frags[i].size, true);
121 static inline void greth_enable_tx(struct greth_private *greth)
124 GRETH_REGORIN(greth->regs->control, GRETH_TXEN);
127 static inline void greth_enable_tx_and_irq(struct greth_private *greth)
129 wmb(); /* BDs must been written to memory before enabling TX */
130 GRETH_REGORIN(greth->regs->control, GRETH_TXEN | GRETH_TXI);
133 static inline void greth_disable_tx(struct greth_private *greth)
135 GRETH_REGANDIN(greth->regs->control, ~GRETH_TXEN);
138 static inline void greth_enable_rx(struct greth_private *greth)
141 GRETH_REGORIN(greth->regs->control, GRETH_RXEN);
144 static inline void greth_disable_rx(struct greth_private *greth)
146 GRETH_REGANDIN(greth->regs->control, ~GRETH_RXEN);
149 static inline void greth_enable_irqs(struct greth_private *greth)
151 GRETH_REGORIN(greth->regs->control, GRETH_RXI | GRETH_TXI);
154 static inline void greth_disable_irqs(struct greth_private *greth)
156 GRETH_REGANDIN(greth->regs->control, ~(GRETH_RXI|GRETH_TXI));
159 static inline void greth_write_bd(u32 *bd, u32 val)
161 __raw_writel(cpu_to_be32(val), bd);
164 static inline u32 greth_read_bd(u32 *bd)
166 return be32_to_cpu(__raw_readl(bd));
169 static void greth_clean_rings(struct greth_private *greth)
172 struct greth_bd *rx_bdp = greth->rx_bd_base;
173 struct greth_bd *tx_bdp = greth->tx_bd_base;
175 if (greth->gbit_mac) {
177 /* Free and unmap RX buffers */
178 for (i = 0; i < GRETH_RXBD_NUM; i++, rx_bdp++) {
179 if (greth->rx_skbuff[i] != NULL) {
180 dev_kfree_skb(greth->rx_skbuff[i]);
181 dma_unmap_single(greth->dev,
182 greth_read_bd(&rx_bdp->addr),
183 MAX_FRAME_SIZE+NET_IP_ALIGN,
189 while (greth->tx_free < GRETH_TXBD_NUM) {
191 struct sk_buff *skb = greth->tx_skbuff[greth->tx_last];
192 int nr_frags = skb_shinfo(skb)->nr_frags;
193 tx_bdp = greth->tx_bd_base + greth->tx_last;
194 greth->tx_last = NEXT_TX(greth->tx_last);
196 dma_unmap_single(greth->dev,
197 greth_read_bd(&tx_bdp->addr),
201 for (i = 0; i < nr_frags; i++) {
202 skb_frag_t *frag = &skb_shinfo(skb)->frags[i];
203 tx_bdp = greth->tx_bd_base + greth->tx_last;
205 dma_unmap_page(greth->dev,
206 greth_read_bd(&tx_bdp->addr),
210 greth->tx_last = NEXT_TX(greth->tx_last);
212 greth->tx_free += nr_frags+1;
217 } else { /* 10/100 Mbps MAC */
219 for (i = 0; i < GRETH_RXBD_NUM; i++, rx_bdp++) {
220 kfree(greth->rx_bufs[i]);
221 dma_unmap_single(greth->dev,
222 greth_read_bd(&rx_bdp->addr),
226 for (i = 0; i < GRETH_TXBD_NUM; i++, tx_bdp++) {
227 kfree(greth->tx_bufs[i]);
228 dma_unmap_single(greth->dev,
229 greth_read_bd(&tx_bdp->addr),
236 static int greth_init_rings(struct greth_private *greth)
239 struct greth_bd *rx_bd, *tx_bd;
243 rx_bd = greth->rx_bd_base;
244 tx_bd = greth->tx_bd_base;
246 /* Initialize descriptor rings and buffers */
247 if (greth->gbit_mac) {
249 for (i = 0; i < GRETH_RXBD_NUM; i++) {
250 skb = netdev_alloc_skb(greth->netdev, MAX_FRAME_SIZE+NET_IP_ALIGN);
252 if (netif_msg_ifup(greth))
253 dev_err(greth->dev, "Error allocating DMA ring.\n");
256 skb_reserve(skb, NET_IP_ALIGN);
257 dma_addr = dma_map_single(greth->dev,
259 MAX_FRAME_SIZE+NET_IP_ALIGN,
262 if (dma_mapping_error(greth->dev, dma_addr)) {
263 if (netif_msg_ifup(greth))
264 dev_err(greth->dev, "Could not create initial DMA mapping\n");
268 greth->rx_skbuff[i] = skb;
269 greth_write_bd(&rx_bd[i].addr, dma_addr);
270 greth_write_bd(&rx_bd[i].stat, GRETH_BD_EN | GRETH_BD_IE);
275 /* 10/100 MAC uses a fixed set of buffers and copy to/from SKBs */
276 for (i = 0; i < GRETH_RXBD_NUM; i++) {
278 greth->rx_bufs[i] = kmalloc(MAX_FRAME_SIZE, GFP_KERNEL);
280 if (greth->rx_bufs[i] == NULL) {
281 if (netif_msg_ifup(greth))
282 dev_err(greth->dev, "Error allocating DMA ring.\n");
286 dma_addr = dma_map_single(greth->dev,
291 if (dma_mapping_error(greth->dev, dma_addr)) {
292 if (netif_msg_ifup(greth))
293 dev_err(greth->dev, "Could not create initial DMA mapping\n");
296 greth_write_bd(&rx_bd[i].addr, dma_addr);
297 greth_write_bd(&rx_bd[i].stat, GRETH_BD_EN | GRETH_BD_IE);
299 for (i = 0; i < GRETH_TXBD_NUM; i++) {
301 greth->tx_bufs[i] = kmalloc(MAX_FRAME_SIZE, GFP_KERNEL);
303 if (greth->tx_bufs[i] == NULL) {
304 if (netif_msg_ifup(greth))
305 dev_err(greth->dev, "Error allocating DMA ring.\n");
309 dma_addr = dma_map_single(greth->dev,
314 if (dma_mapping_error(greth->dev, dma_addr)) {
315 if (netif_msg_ifup(greth))
316 dev_err(greth->dev, "Could not create initial DMA mapping\n");
319 greth_write_bd(&tx_bd[i].addr, dma_addr);
320 greth_write_bd(&tx_bd[i].stat, 0);
323 greth_write_bd(&rx_bd[GRETH_RXBD_NUM - 1].stat,
324 greth_read_bd(&rx_bd[GRETH_RXBD_NUM - 1].stat) | GRETH_BD_WR);
326 /* Initialize pointers. */
330 greth->tx_free = GRETH_TXBD_NUM;
332 /* Initialize descriptor base address */
333 GRETH_REGSAVE(greth->regs->tx_desc_p, greth->tx_bd_base_phys);
334 GRETH_REGSAVE(greth->regs->rx_desc_p, greth->rx_bd_base_phys);
339 greth_clean_rings(greth);
343 static int greth_open(struct net_device *dev)
345 struct greth_private *greth = netdev_priv(dev);
348 err = greth_init_rings(greth);
350 if (netif_msg_ifup(greth))
351 dev_err(&dev->dev, "Could not allocate memory for DMA rings\n");
355 err = request_irq(greth->irq, greth_interrupt, 0, "eth", (void *) dev);
357 if (netif_msg_ifup(greth))
358 dev_err(&dev->dev, "Could not allocate interrupt %d\n", dev->irq);
359 greth_clean_rings(greth);
363 if (netif_msg_ifup(greth))
364 dev_dbg(&dev->dev, " starting queue\n");
365 netif_start_queue(dev);
367 GRETH_REGSAVE(greth->regs->status, 0xFF);
369 napi_enable(&greth->napi);
371 greth_enable_irqs(greth);
372 greth_enable_tx(greth);
373 greth_enable_rx(greth);
378 static int greth_close(struct net_device *dev)
380 struct greth_private *greth = netdev_priv(dev);
382 napi_disable(&greth->napi);
384 greth_disable_irqs(greth);
385 greth_disable_tx(greth);
386 greth_disable_rx(greth);
388 netif_stop_queue(dev);
390 free_irq(greth->irq, (void *) dev);
392 greth_clean_rings(greth);
398 greth_start_xmit(struct sk_buff *skb, struct net_device *dev)
400 struct greth_private *greth = netdev_priv(dev);
401 struct greth_bd *bdp;
402 int err = NETDEV_TX_OK;
403 u32 status, dma_addr, ctrl;
407 greth_clean_tx(greth->netdev);
409 if (unlikely(greth->tx_free <= 0)) {
410 spin_lock_irqsave(&greth->devlock, flags);/*save from poll/irq*/
411 ctrl = GRETH_REGLOAD(greth->regs->control);
412 /* Enable TX IRQ only if not already in poll() routine */
413 if (ctrl & GRETH_RXI)
414 GRETH_REGSAVE(greth->regs->control, ctrl | GRETH_TXI);
415 netif_stop_queue(dev);
416 spin_unlock_irqrestore(&greth->devlock, flags);
417 return NETDEV_TX_BUSY;
420 if (netif_msg_pktdata(greth))
421 greth_print_tx_packet(skb);
424 if (unlikely(skb->len > MAX_FRAME_SIZE)) {
425 dev->stats.tx_errors++;
429 bdp = greth->tx_bd_base + greth->tx_next;
430 dma_addr = greth_read_bd(&bdp->addr);
432 memcpy((unsigned char *) phys_to_virt(dma_addr), skb->data, skb->len);
434 dma_sync_single_for_device(greth->dev, dma_addr, skb->len, DMA_TO_DEVICE);
436 status = GRETH_BD_EN | GRETH_BD_IE | (skb->len & GRETH_BD_LEN);
437 greth->tx_bufs_length[greth->tx_next] = skb->len & GRETH_BD_LEN;
439 /* Wrap around descriptor ring */
440 if (greth->tx_next == GRETH_TXBD_NUM_MASK) {
441 status |= GRETH_BD_WR;
444 greth->tx_next = NEXT_TX(greth->tx_next);
447 /* Write descriptor control word and enable transmission */
448 greth_write_bd(&bdp->stat, status);
449 spin_lock_irqsave(&greth->devlock, flags); /*save from poll/irq*/
450 greth_enable_tx(greth);
451 spin_unlock_irqrestore(&greth->devlock, flags);
458 static inline u16 greth_num_free_bds(u16 tx_last, u16 tx_next)
460 if (tx_next < tx_last)
461 return (tx_last - tx_next) - 1;
463 return GRETH_TXBD_NUM - (tx_next - tx_last) - 1;
467 greth_start_xmit_gbit(struct sk_buff *skb, struct net_device *dev)
469 struct greth_private *greth = netdev_priv(dev);
470 struct greth_bd *bdp;
471 u32 status, dma_addr;
472 int curr_tx, nr_frags, i, err = NETDEV_TX_OK;
476 nr_frags = skb_shinfo(skb)->nr_frags;
477 tx_last = greth->tx_last;
478 rmb(); /* tx_last is updated by the poll task */
480 if (greth_num_free_bds(tx_last, greth->tx_next) < nr_frags + 1) {
481 netif_stop_queue(dev);
482 err = NETDEV_TX_BUSY;
486 if (netif_msg_pktdata(greth))
487 greth_print_tx_packet(skb);
489 if (unlikely(skb->len > MAX_FRAME_SIZE)) {
490 dev->stats.tx_errors++;
494 /* Save skb pointer. */
495 greth->tx_skbuff[greth->tx_next] = skb;
499 status = GRETH_TXBD_MORE;
501 status = GRETH_BD_IE;
503 if (skb->ip_summed == CHECKSUM_PARTIAL)
504 status |= GRETH_TXBD_CSALL;
505 status |= skb_headlen(skb) & GRETH_BD_LEN;
506 if (greth->tx_next == GRETH_TXBD_NUM_MASK)
507 status |= GRETH_BD_WR;
510 bdp = greth->tx_bd_base + greth->tx_next;
511 greth_write_bd(&bdp->stat, status);
512 dma_addr = dma_map_single(greth->dev, skb->data, skb_headlen(skb), DMA_TO_DEVICE);
514 if (unlikely(dma_mapping_error(greth->dev, dma_addr)))
517 greth_write_bd(&bdp->addr, dma_addr);
519 curr_tx = NEXT_TX(greth->tx_next);
522 for (i = 0; i < nr_frags; i++) {
523 skb_frag_t *frag = &skb_shinfo(skb)->frags[i];
524 greth->tx_skbuff[curr_tx] = NULL;
525 bdp = greth->tx_bd_base + curr_tx;
527 status = GRETH_BD_EN;
528 if (skb->ip_summed == CHECKSUM_PARTIAL)
529 status |= GRETH_TXBD_CSALL;
530 status |= skb_frag_size(frag) & GRETH_BD_LEN;
532 /* Wrap around descriptor ring */
533 if (curr_tx == GRETH_TXBD_NUM_MASK)
534 status |= GRETH_BD_WR;
536 /* More fragments left */
537 if (i < nr_frags - 1)
538 status |= GRETH_TXBD_MORE;
540 status |= GRETH_BD_IE; /* enable IRQ on last fragment */
542 greth_write_bd(&bdp->stat, status);
544 dma_addr = skb_frag_dma_map(greth->dev, frag, 0, skb_frag_size(frag),
547 if (unlikely(dma_mapping_error(greth->dev, dma_addr)))
550 greth_write_bd(&bdp->addr, dma_addr);
552 curr_tx = NEXT_TX(curr_tx);
557 /* Enable the descriptor chain by enabling the first descriptor */
558 bdp = greth->tx_bd_base + greth->tx_next;
559 greth_write_bd(&bdp->stat,
560 greth_read_bd(&bdp->stat) | GRETH_BD_EN);
562 spin_lock_irqsave(&greth->devlock, flags); /*save from poll/irq*/
563 greth->tx_next = curr_tx;
564 greth_enable_tx_and_irq(greth);
565 spin_unlock_irqrestore(&greth->devlock, flags);
570 /* Unmap SKB mappings that succeeded and disable descriptor */
571 for (i = 0; greth->tx_next + i != curr_tx; i++) {
572 bdp = greth->tx_bd_base + greth->tx_next + i;
573 dma_unmap_single(greth->dev,
574 greth_read_bd(&bdp->addr),
575 greth_read_bd(&bdp->stat) & GRETH_BD_LEN,
577 greth_write_bd(&bdp->stat, 0);
581 dev_warn(greth->dev, "Could not create TX DMA mapping\n");
587 static irqreturn_t greth_interrupt(int irq, void *dev_id)
589 struct net_device *dev = dev_id;
590 struct greth_private *greth;
592 irqreturn_t retval = IRQ_NONE;
594 greth = netdev_priv(dev);
596 spin_lock(&greth->devlock);
598 /* Get the interrupt events that caused us to be here. */
599 status = GRETH_REGLOAD(greth->regs->status);
601 /* Must see if interrupts are enabled also, INT_TX|INT_RX flags may be
602 * set regardless of whether IRQ is enabled or not. Especially
603 * important when shared IRQ.
605 ctrl = GRETH_REGLOAD(greth->regs->control);
607 /* Handle rx and tx interrupts through poll */
608 if (((status & (GRETH_INT_RE | GRETH_INT_RX)) && (ctrl & GRETH_RXI)) ||
609 ((status & (GRETH_INT_TE | GRETH_INT_TX)) && (ctrl & GRETH_TXI))) {
610 retval = IRQ_HANDLED;
612 /* Disable interrupts and schedule poll() */
613 greth_disable_irqs(greth);
614 napi_schedule(&greth->napi);
618 spin_unlock(&greth->devlock);
623 static void greth_clean_tx(struct net_device *dev)
625 struct greth_private *greth;
626 struct greth_bd *bdp;
629 greth = netdev_priv(dev);
632 bdp = greth->tx_bd_base + greth->tx_last;
633 GRETH_REGSAVE(greth->regs->status, GRETH_INT_TE | GRETH_INT_TX);
635 stat = greth_read_bd(&bdp->stat);
637 if (unlikely(stat & GRETH_BD_EN))
640 if (greth->tx_free == GRETH_TXBD_NUM)
643 /* Check status for errors */
644 if (unlikely(stat & GRETH_TXBD_STATUS)) {
645 dev->stats.tx_errors++;
646 if (stat & GRETH_TXBD_ERR_AL)
647 dev->stats.tx_aborted_errors++;
648 if (stat & GRETH_TXBD_ERR_UE)
649 dev->stats.tx_fifo_errors++;
651 dev->stats.tx_packets++;
652 dev->stats.tx_bytes += greth->tx_bufs_length[greth->tx_last];
653 greth->tx_last = NEXT_TX(greth->tx_last);
657 if (greth->tx_free > 0) {
658 netif_wake_queue(dev);
662 static inline void greth_update_tx_stats(struct net_device *dev, u32 stat)
664 /* Check status for errors */
665 if (unlikely(stat & GRETH_TXBD_STATUS)) {
666 dev->stats.tx_errors++;
667 if (stat & GRETH_TXBD_ERR_AL)
668 dev->stats.tx_aborted_errors++;
669 if (stat & GRETH_TXBD_ERR_UE)
670 dev->stats.tx_fifo_errors++;
671 if (stat & GRETH_TXBD_ERR_LC)
672 dev->stats.tx_aborted_errors++;
674 dev->stats.tx_packets++;
677 static void greth_clean_tx_gbit(struct net_device *dev)
679 struct greth_private *greth;
680 struct greth_bd *bdp, *bdp_last_frag;
681 struct sk_buff *skb = NULL;
686 greth = netdev_priv(dev);
687 tx_last = greth->tx_last;
689 while (tx_last != greth->tx_next) {
691 skb = greth->tx_skbuff[tx_last];
693 nr_frags = skb_shinfo(skb)->nr_frags;
695 /* We only clean fully completed SKBs */
696 bdp_last_frag = greth->tx_bd_base + SKIP_TX(tx_last, nr_frags);
698 GRETH_REGSAVE(greth->regs->status, GRETH_INT_TE | GRETH_INT_TX);
700 stat = greth_read_bd(&bdp_last_frag->stat);
702 if (stat & GRETH_BD_EN)
705 greth->tx_skbuff[tx_last] = NULL;
707 greth_update_tx_stats(dev, stat);
708 dev->stats.tx_bytes += skb->len;
710 bdp = greth->tx_bd_base + tx_last;
712 tx_last = NEXT_TX(tx_last);
714 dma_unmap_single(greth->dev,
715 greth_read_bd(&bdp->addr),
719 for (i = 0; i < nr_frags; i++) {
720 skb_frag_t *frag = &skb_shinfo(skb)->frags[i];
721 bdp = greth->tx_bd_base + tx_last;
723 dma_unmap_page(greth->dev,
724 greth_read_bd(&bdp->addr),
728 tx_last = NEXT_TX(tx_last);
732 if (skb) { /* skb is set only if the above while loop was entered */
734 greth->tx_last = tx_last;
736 if (netif_queue_stopped(dev) &&
737 (greth_num_free_bds(tx_last, greth->tx_next) >
739 netif_wake_queue(dev);
743 static int greth_rx(struct net_device *dev, int limit)
745 struct greth_private *greth;
746 struct greth_bd *bdp;
750 u32 status, dma_addr;
753 greth = netdev_priv(dev);
755 for (count = 0; count < limit; ++count) {
757 bdp = greth->rx_bd_base + greth->rx_cur;
758 GRETH_REGSAVE(greth->regs->status, GRETH_INT_RE | GRETH_INT_RX);
760 status = greth_read_bd(&bdp->stat);
762 if (unlikely(status & GRETH_BD_EN)) {
766 dma_addr = greth_read_bd(&bdp->addr);
769 /* Check status for errors. */
770 if (unlikely(status & GRETH_RXBD_STATUS)) {
771 if (status & GRETH_RXBD_ERR_FT) {
772 dev->stats.rx_length_errors++;
775 if (status & (GRETH_RXBD_ERR_AE | GRETH_RXBD_ERR_OE)) {
776 dev->stats.rx_frame_errors++;
779 if (status & GRETH_RXBD_ERR_CRC) {
780 dev->stats.rx_crc_errors++;
785 dev->stats.rx_errors++;
789 pkt_len = status & GRETH_BD_LEN;
791 skb = netdev_alloc_skb(dev, pkt_len + NET_IP_ALIGN);
793 if (unlikely(skb == NULL)) {
796 dev_warn(&dev->dev, "low on memory - " "packet dropped\n");
798 dev->stats.rx_dropped++;
801 skb_reserve(skb, NET_IP_ALIGN);
803 dma_sync_single_for_cpu(greth->dev,
808 if (netif_msg_pktdata(greth))
809 greth_print_rx_packet(phys_to_virt(dma_addr), pkt_len);
811 skb_put_data(skb, phys_to_virt(dma_addr),
814 skb->protocol = eth_type_trans(skb, dev);
815 dev->stats.rx_bytes += pkt_len;
816 dev->stats.rx_packets++;
817 netif_receive_skb(skb);
821 status = GRETH_BD_EN | GRETH_BD_IE;
822 if (greth->rx_cur == GRETH_RXBD_NUM_MASK) {
823 status |= GRETH_BD_WR;
827 greth_write_bd(&bdp->stat, status);
829 dma_sync_single_for_device(greth->dev, dma_addr, MAX_FRAME_SIZE, DMA_FROM_DEVICE);
831 spin_lock_irqsave(&greth->devlock, flags); /* save from XMIT */
832 greth_enable_rx(greth);
833 spin_unlock_irqrestore(&greth->devlock, flags);
835 greth->rx_cur = NEXT_RX(greth->rx_cur);
841 static inline int hw_checksummed(u32 status)
844 if (status & GRETH_RXBD_IP_FRAG)
847 if (status & GRETH_RXBD_IP && status & GRETH_RXBD_IP_CSERR)
850 if (status & GRETH_RXBD_UDP && status & GRETH_RXBD_UDP_CSERR)
853 if (status & GRETH_RXBD_TCP && status & GRETH_RXBD_TCP_CSERR)
859 static int greth_rx_gbit(struct net_device *dev, int limit)
861 struct greth_private *greth;
862 struct greth_bd *bdp;
863 struct sk_buff *skb, *newskb;
866 u32 status, dma_addr;
869 greth = netdev_priv(dev);
871 for (count = 0; count < limit; ++count) {
873 bdp = greth->rx_bd_base + greth->rx_cur;
874 skb = greth->rx_skbuff[greth->rx_cur];
875 GRETH_REGSAVE(greth->regs->status, GRETH_INT_RE | GRETH_INT_RX);
877 status = greth_read_bd(&bdp->stat);
880 if (status & GRETH_BD_EN)
883 /* Check status for errors. */
884 if (unlikely(status & GRETH_RXBD_STATUS)) {
886 if (status & GRETH_RXBD_ERR_FT) {
887 dev->stats.rx_length_errors++;
890 (GRETH_RXBD_ERR_AE | GRETH_RXBD_ERR_OE | GRETH_RXBD_ERR_LE)) {
891 dev->stats.rx_frame_errors++;
893 } else if (status & GRETH_RXBD_ERR_CRC) {
894 dev->stats.rx_crc_errors++;
899 /* Allocate new skb to replace current, not needed if the
900 * current skb can be reused */
901 if (!bad && (newskb=netdev_alloc_skb(dev, MAX_FRAME_SIZE + NET_IP_ALIGN))) {
902 skb_reserve(newskb, NET_IP_ALIGN);
904 dma_addr = dma_map_single(greth->dev,
906 MAX_FRAME_SIZE + NET_IP_ALIGN,
909 if (!dma_mapping_error(greth->dev, dma_addr)) {
910 /* Process the incoming frame. */
911 pkt_len = status & GRETH_BD_LEN;
913 dma_unmap_single(greth->dev,
914 greth_read_bd(&bdp->addr),
915 MAX_FRAME_SIZE + NET_IP_ALIGN,
918 if (netif_msg_pktdata(greth))
919 greth_print_rx_packet(phys_to_virt(greth_read_bd(&bdp->addr)), pkt_len);
921 skb_put(skb, pkt_len);
923 if (dev->features & NETIF_F_RXCSUM && hw_checksummed(status))
924 skb->ip_summed = CHECKSUM_UNNECESSARY;
926 skb_checksum_none_assert(skb);
928 skb->protocol = eth_type_trans(skb, dev);
929 dev->stats.rx_packets++;
930 dev->stats.rx_bytes += pkt_len;
931 netif_receive_skb(skb);
933 greth->rx_skbuff[greth->rx_cur] = newskb;
934 greth_write_bd(&bdp->addr, dma_addr);
937 dev_warn(greth->dev, "Could not create DMA mapping, dropping packet\n");
938 dev_kfree_skb(newskb);
939 /* reusing current skb, so it is a drop */
940 dev->stats.rx_dropped++;
943 /* Bad Frame transfer, the skb is reused */
944 dev->stats.rx_dropped++;
946 /* Failed Allocating a new skb. This is rather stupid
947 * but the current "filled" skb is reused, as if
948 * transfer failure. One could argue that RX descriptor
949 * table handling should be divided into cleaning and
950 * filling as the TX part of the driver
953 dev_warn(greth->dev, "Could not allocate SKB, dropping packet\n");
954 /* reusing current skb, so it is a drop */
955 dev->stats.rx_dropped++;
958 status = GRETH_BD_EN | GRETH_BD_IE;
959 if (greth->rx_cur == GRETH_RXBD_NUM_MASK) {
960 status |= GRETH_BD_WR;
964 greth_write_bd(&bdp->stat, status);
965 spin_lock_irqsave(&greth->devlock, flags);
966 greth_enable_rx(greth);
967 spin_unlock_irqrestore(&greth->devlock, flags);
968 greth->rx_cur = NEXT_RX(greth->rx_cur);
975 static int greth_poll(struct napi_struct *napi, int budget)
977 struct greth_private *greth;
981 greth = container_of(napi, struct greth_private, napi);
984 if (greth->gbit_mac) {
985 greth_clean_tx_gbit(greth->netdev);
986 work_done += greth_rx_gbit(greth->netdev, budget - work_done);
988 if (netif_queue_stopped(greth->netdev))
989 greth_clean_tx(greth->netdev);
990 work_done += greth_rx(greth->netdev, budget - work_done);
993 if (work_done < budget) {
995 spin_lock_irqsave(&greth->devlock, flags);
997 ctrl = GRETH_REGLOAD(greth->regs->control);
998 if ((greth->gbit_mac && (greth->tx_last != greth->tx_next)) ||
999 (!greth->gbit_mac && netif_queue_stopped(greth->netdev))) {
1000 GRETH_REGSAVE(greth->regs->control,
1001 ctrl | GRETH_TXI | GRETH_RXI);
1002 mask = GRETH_INT_RX | GRETH_INT_RE |
1003 GRETH_INT_TX | GRETH_INT_TE;
1005 GRETH_REGSAVE(greth->regs->control, ctrl | GRETH_RXI);
1006 mask = GRETH_INT_RX | GRETH_INT_RE;
1009 if (GRETH_REGLOAD(greth->regs->status) & mask) {
1010 GRETH_REGSAVE(greth->regs->control, ctrl);
1011 spin_unlock_irqrestore(&greth->devlock, flags);
1012 goto restart_txrx_poll;
1014 napi_complete_done(napi, work_done);
1015 spin_unlock_irqrestore(&greth->devlock, flags);
1022 static int greth_set_mac_add(struct net_device *dev, void *p)
1024 struct sockaddr *addr = p;
1025 struct greth_private *greth;
1026 struct greth_regs *regs;
1028 greth = netdev_priv(dev);
1031 if (!is_valid_ether_addr(addr->sa_data))
1032 return -EADDRNOTAVAIL;
1034 memcpy(dev->dev_addr, addr->sa_data, dev->addr_len);
1035 GRETH_REGSAVE(regs->esa_msb, dev->dev_addr[0] << 8 | dev->dev_addr[1]);
1036 GRETH_REGSAVE(regs->esa_lsb, dev->dev_addr[2] << 24 | dev->dev_addr[3] << 16 |
1037 dev->dev_addr[4] << 8 | dev->dev_addr[5]);
1042 static u32 greth_hash_get_index(__u8 *addr)
1044 return (ether_crc(6, addr)) & 0x3F;
1047 static void greth_set_hash_filter(struct net_device *dev)
1049 struct netdev_hw_addr *ha;
1050 struct greth_private *greth = netdev_priv(dev);
1051 struct greth_regs *regs = greth->regs;
1055 mc_filter[0] = mc_filter[1] = 0;
1057 netdev_for_each_mc_addr(ha, dev) {
1058 bitnr = greth_hash_get_index(ha->addr);
1059 mc_filter[bitnr >> 5] |= 1 << (bitnr & 31);
1062 GRETH_REGSAVE(regs->hash_msb, mc_filter[1]);
1063 GRETH_REGSAVE(regs->hash_lsb, mc_filter[0]);
1066 static void greth_set_multicast_list(struct net_device *dev)
1069 struct greth_private *greth = netdev_priv(dev);
1070 struct greth_regs *regs = greth->regs;
1072 cfg = GRETH_REGLOAD(regs->control);
1073 if (dev->flags & IFF_PROMISC)
1074 cfg |= GRETH_CTRL_PR;
1076 cfg &= ~GRETH_CTRL_PR;
1078 if (greth->multicast) {
1079 if (dev->flags & IFF_ALLMULTI) {
1080 GRETH_REGSAVE(regs->hash_msb, -1);
1081 GRETH_REGSAVE(regs->hash_lsb, -1);
1082 cfg |= GRETH_CTRL_MCEN;
1083 GRETH_REGSAVE(regs->control, cfg);
1087 if (netdev_mc_empty(dev)) {
1088 cfg &= ~GRETH_CTRL_MCEN;
1089 GRETH_REGSAVE(regs->control, cfg);
1093 /* Setup multicast filter */
1094 greth_set_hash_filter(dev);
1095 cfg |= GRETH_CTRL_MCEN;
1097 GRETH_REGSAVE(regs->control, cfg);
1100 static u32 greth_get_msglevel(struct net_device *dev)
1102 struct greth_private *greth = netdev_priv(dev);
1103 return greth->msg_enable;
1106 static void greth_set_msglevel(struct net_device *dev, u32 value)
1108 struct greth_private *greth = netdev_priv(dev);
1109 greth->msg_enable = value;
1112 static int greth_get_regs_len(struct net_device *dev)
1114 return sizeof(struct greth_regs);
1117 static void greth_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info)
1119 struct greth_private *greth = netdev_priv(dev);
1121 strlcpy(info->driver, dev_driver_string(greth->dev),
1122 sizeof(info->driver));
1123 strlcpy(info->version, "revision: 1.0", sizeof(info->version));
1124 strlcpy(info->bus_info, greth->dev->bus->name, sizeof(info->bus_info));
1125 strlcpy(info->fw_version, "N/A", sizeof(info->fw_version));
1128 static void greth_get_regs(struct net_device *dev, struct ethtool_regs *regs, void *p)
1131 struct greth_private *greth = netdev_priv(dev);
1132 u32 __iomem *greth_regs = (u32 __iomem *) greth->regs;
1135 for (i = 0; i < sizeof(struct greth_regs) / sizeof(u32); i++)
1136 buff[i] = greth_read_bd(&greth_regs[i]);
1139 static const struct ethtool_ops greth_ethtool_ops = {
1140 .get_msglevel = greth_get_msglevel,
1141 .set_msglevel = greth_set_msglevel,
1142 .get_drvinfo = greth_get_drvinfo,
1143 .get_regs_len = greth_get_regs_len,
1144 .get_regs = greth_get_regs,
1145 .get_link = ethtool_op_get_link,
1146 .get_link_ksettings = phy_ethtool_get_link_ksettings,
1147 .set_link_ksettings = phy_ethtool_set_link_ksettings,
1150 static struct net_device_ops greth_netdev_ops = {
1151 .ndo_open = greth_open,
1152 .ndo_stop = greth_close,
1153 .ndo_start_xmit = greth_start_xmit,
1154 .ndo_set_mac_address = greth_set_mac_add,
1155 .ndo_validate_addr = eth_validate_addr,
1158 static inline int wait_for_mdio(struct greth_private *greth)
1160 unsigned long timeout = jiffies + 4*HZ/100;
1161 while (GRETH_REGLOAD(greth->regs->mdio) & GRETH_MII_BUSY) {
1162 if (time_after(jiffies, timeout))
1168 static int greth_mdio_read(struct mii_bus *bus, int phy, int reg)
1170 struct greth_private *greth = bus->priv;
1173 if (!wait_for_mdio(greth))
1176 GRETH_REGSAVE(greth->regs->mdio, ((phy & 0x1F) << 11) | ((reg & 0x1F) << 6) | 2);
1178 if (!wait_for_mdio(greth))
1181 if (!(GRETH_REGLOAD(greth->regs->mdio) & GRETH_MII_NVALID)) {
1182 data = (GRETH_REGLOAD(greth->regs->mdio) >> 16) & 0xFFFF;
1190 static int greth_mdio_write(struct mii_bus *bus, int phy, int reg, u16 val)
1192 struct greth_private *greth = bus->priv;
1194 if (!wait_for_mdio(greth))
1197 GRETH_REGSAVE(greth->regs->mdio,
1198 ((val & 0xFFFF) << 16) | ((phy & 0x1F) << 11) | ((reg & 0x1F) << 6) | 1);
1200 if (!wait_for_mdio(greth))
1206 static void greth_link_change(struct net_device *dev)
1208 struct greth_private *greth = netdev_priv(dev);
1209 struct phy_device *phydev = dev->phydev;
1210 unsigned long flags;
1211 int status_change = 0;
1214 spin_lock_irqsave(&greth->devlock, flags);
1218 if ((greth->speed != phydev->speed) || (greth->duplex != phydev->duplex)) {
1219 ctrl = GRETH_REGLOAD(greth->regs->control) &
1220 ~(GRETH_CTRL_FD | GRETH_CTRL_SP | GRETH_CTRL_GB);
1223 ctrl |= GRETH_CTRL_FD;
1225 if (phydev->speed == SPEED_100)
1226 ctrl |= GRETH_CTRL_SP;
1227 else if (phydev->speed == SPEED_1000)
1228 ctrl |= GRETH_CTRL_GB;
1230 GRETH_REGSAVE(greth->regs->control, ctrl);
1231 greth->speed = phydev->speed;
1232 greth->duplex = phydev->duplex;
1237 if (phydev->link != greth->link) {
1238 if (!phydev->link) {
1242 greth->link = phydev->link;
1247 spin_unlock_irqrestore(&greth->devlock, flags);
1249 if (status_change) {
1251 pr_debug("%s: link up (%d/%s)\n",
1252 dev->name, phydev->speed,
1253 DUPLEX_FULL == phydev->duplex ? "Full" : "Half");
1255 pr_debug("%s: link down\n", dev->name);
1259 static int greth_mdio_probe(struct net_device *dev)
1261 struct greth_private *greth = netdev_priv(dev);
1262 struct phy_device *phy = NULL;
1265 /* Find the first PHY */
1266 phy = phy_find_first(greth->mdio);
1269 if (netif_msg_probe(greth))
1270 dev_err(&dev->dev, "no PHY found\n");
1274 ret = phy_connect_direct(dev, phy, &greth_link_change,
1275 greth->gbit_mac ? PHY_INTERFACE_MODE_GMII : PHY_INTERFACE_MODE_MII);
1277 if (netif_msg_ifup(greth))
1278 dev_err(&dev->dev, "could not attach to PHY\n");
1282 if (greth->gbit_mac)
1283 phy->supported &= PHY_GBIT_FEATURES;
1285 phy->supported &= PHY_BASIC_FEATURES;
1287 phy->advertising = phy->supported;
1296 static int greth_mdio_init(struct greth_private *greth)
1299 unsigned long timeout;
1300 struct net_device *ndev = greth->netdev;
1302 greth->mdio = mdiobus_alloc();
1307 greth->mdio->name = "greth-mdio";
1308 snprintf(greth->mdio->id, MII_BUS_ID_SIZE, "%s-%d", greth->mdio->name, greth->irq);
1309 greth->mdio->read = greth_mdio_read;
1310 greth->mdio->write = greth_mdio_write;
1311 greth->mdio->priv = greth;
1313 ret = mdiobus_register(greth->mdio);
1318 ret = greth_mdio_probe(greth->netdev);
1320 if (netif_msg_probe(greth))
1321 dev_err(&greth->netdev->dev, "failed to probe MDIO bus\n");
1325 phy_start(ndev->phydev);
1327 /* If Ethernet debug link is used make autoneg happen right away */
1328 if (greth->edcl && greth_edcl == 1) {
1329 phy_start_aneg(ndev->phydev);
1330 timeout = jiffies + 6*HZ;
1331 while (!phy_aneg_done(ndev->phydev) &&
1332 time_before(jiffies, timeout)) {
1334 phy_read_status(ndev->phydev);
1335 greth_link_change(greth->netdev);
1341 mdiobus_unregister(greth->mdio);
1343 mdiobus_free(greth->mdio);
1347 /* Initialize the GRETH MAC */
1348 static int greth_of_probe(struct platform_device *ofdev)
1350 struct net_device *dev;
1351 struct greth_private *greth;
1352 struct greth_regs *regs;
1357 unsigned long timeout;
1359 dev = alloc_etherdev(sizeof(struct greth_private));
1364 greth = netdev_priv(dev);
1365 greth->netdev = dev;
1366 greth->dev = &ofdev->dev;
1368 if (greth_debug > 0)
1369 greth->msg_enable = greth_debug;
1371 greth->msg_enable = GRETH_DEF_MSG_ENABLE;
1373 spin_lock_init(&greth->devlock);
1375 greth->regs = of_ioremap(&ofdev->resource[0], 0,
1376 resource_size(&ofdev->resource[0]),
1377 "grlib-greth regs");
1379 if (greth->regs == NULL) {
1380 if (netif_msg_probe(greth))
1381 dev_err(greth->dev, "ioremap failure.\n");
1387 greth->irq = ofdev->archdata.irqs[0];
1389 dev_set_drvdata(greth->dev, dev);
1390 SET_NETDEV_DEV(dev, greth->dev);
1392 if (netif_msg_probe(greth))
1393 dev_dbg(greth->dev, "resetting controller.\n");
1395 /* Reset the controller. */
1396 GRETH_REGSAVE(regs->control, GRETH_RESET);
1398 /* Wait for MAC to reset itself */
1399 timeout = jiffies + HZ/100;
1400 while (GRETH_REGLOAD(regs->control) & GRETH_RESET) {
1401 if (time_after(jiffies, timeout)) {
1403 if (netif_msg_probe(greth))
1404 dev_err(greth->dev, "timeout when waiting for reset.\n");
1409 /* Get default PHY address */
1410 greth->phyaddr = (GRETH_REGLOAD(regs->mdio) >> 11) & 0x1F;
1412 /* Check if we have GBIT capable MAC */
1413 tmp = GRETH_REGLOAD(regs->control);
1414 greth->gbit_mac = (tmp >> 27) & 1;
1416 /* Check for multicast capability */
1417 greth->multicast = (tmp >> 25) & 1;
1419 greth->edcl = (tmp >> 31) & 1;
1421 /* If we have EDCL we disable the EDCL speed-duplex FSM so
1422 * it doesn't interfere with the software */
1423 if (greth->edcl != 0)
1424 GRETH_REGORIN(regs->control, GRETH_CTRL_DISDUPLEX);
1426 /* Check if MAC can handle MDIO interrupts */
1427 greth->mdio_int_en = (tmp >> 26) & 1;
1429 err = greth_mdio_init(greth);
1431 if (netif_msg_probe(greth))
1432 dev_err(greth->dev, "failed to register MDIO bus\n");
1436 /* Allocate TX descriptor ring in coherent memory */
1437 greth->tx_bd_base = dma_zalloc_coherent(greth->dev, 1024,
1438 &greth->tx_bd_base_phys,
1440 if (!greth->tx_bd_base) {
1445 /* Allocate RX descriptor ring in coherent memory */
1446 greth->rx_bd_base = dma_zalloc_coherent(greth->dev, 1024,
1447 &greth->rx_bd_base_phys,
1449 if (!greth->rx_bd_base) {
1454 /* Get MAC address from: module param, OF property or ID prom */
1455 for (i = 0; i < 6; i++) {
1456 if (macaddr[i] != 0)
1462 addr = of_get_mac_address(ofdev->dev.of_node);
1464 for (i = 0; i < 6; i++)
1465 macaddr[i] = (unsigned int) addr[i];
1468 for (i = 0; i < 6; i++)
1469 macaddr[i] = (unsigned int) idprom->id_ethaddr[i];
1474 for (i = 0; i < 6; i++)
1475 dev->dev_addr[i] = macaddr[i];
1479 if (!is_valid_ether_addr(&dev->dev_addr[0])) {
1480 if (netif_msg_probe(greth))
1481 dev_err(greth->dev, "no valid ethernet address, aborting.\n");
1486 GRETH_REGSAVE(regs->esa_msb, dev->dev_addr[0] << 8 | dev->dev_addr[1]);
1487 GRETH_REGSAVE(regs->esa_lsb, dev->dev_addr[2] << 24 | dev->dev_addr[3] << 16 |
1488 dev->dev_addr[4] << 8 | dev->dev_addr[5]);
1490 /* Clear all pending interrupts except PHY irq */
1491 GRETH_REGSAVE(regs->status, 0xFF);
1493 if (greth->gbit_mac) {
1494 dev->hw_features = NETIF_F_SG | NETIF_F_IP_CSUM |
1496 dev->features = dev->hw_features | NETIF_F_HIGHDMA;
1497 greth_netdev_ops.ndo_start_xmit = greth_start_xmit_gbit;
1500 if (greth->multicast) {
1501 greth_netdev_ops.ndo_set_rx_mode = greth_set_multicast_list;
1502 dev->flags |= IFF_MULTICAST;
1504 dev->flags &= ~IFF_MULTICAST;
1507 dev->netdev_ops = &greth_netdev_ops;
1508 dev->ethtool_ops = &greth_ethtool_ops;
1510 err = register_netdev(dev);
1512 if (netif_msg_probe(greth))
1513 dev_err(greth->dev, "netdevice registration failed.\n");
1518 netif_napi_add(dev, &greth->napi, greth_poll, 64);
1523 dma_free_coherent(greth->dev, 1024, greth->rx_bd_base, greth->rx_bd_base_phys);
1525 dma_free_coherent(greth->dev, 1024, greth->tx_bd_base, greth->tx_bd_base_phys);
1527 mdiobus_unregister(greth->mdio);
1529 of_iounmap(&ofdev->resource[0], greth->regs, resource_size(&ofdev->resource[0]));
1535 static int greth_of_remove(struct platform_device *of_dev)
1537 struct net_device *ndev = platform_get_drvdata(of_dev);
1538 struct greth_private *greth = netdev_priv(ndev);
1540 /* Free descriptor areas */
1541 dma_free_coherent(&of_dev->dev, 1024, greth->rx_bd_base, greth->rx_bd_base_phys);
1543 dma_free_coherent(&of_dev->dev, 1024, greth->tx_bd_base, greth->tx_bd_base_phys);
1546 phy_stop(ndev->phydev);
1547 mdiobus_unregister(greth->mdio);
1549 unregister_netdev(ndev);
1551 of_iounmap(&of_dev->resource[0], greth->regs, resource_size(&of_dev->resource[0]));
1558 static const struct of_device_id greth_of_match[] = {
1560 .name = "GAISLER_ETHMAC",
1568 MODULE_DEVICE_TABLE(of, greth_of_match);
1570 static struct platform_driver greth_of_driver = {
1572 .name = "grlib-greth",
1573 .of_match_table = greth_of_match,
1575 .probe = greth_of_probe,
1576 .remove = greth_of_remove,
1579 module_platform_driver(greth_of_driver);
1581 MODULE_AUTHOR("Aeroflex Gaisler AB.");
1582 MODULE_DESCRIPTION("Aeroflex Gaisler Ethernet MAC driver");
1583 MODULE_LICENSE("GPL");