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");
267 greth->rx_skbuff[i] = skb;
268 greth_write_bd(&rx_bd[i].addr, dma_addr);
269 greth_write_bd(&rx_bd[i].stat, GRETH_BD_EN | GRETH_BD_IE);
274 /* 10/100 MAC uses a fixed set of buffers and copy to/from SKBs */
275 for (i = 0; i < GRETH_RXBD_NUM; i++) {
277 greth->rx_bufs[i] = kmalloc(MAX_FRAME_SIZE, GFP_KERNEL);
279 if (greth->rx_bufs[i] == NULL) {
280 if (netif_msg_ifup(greth))
281 dev_err(greth->dev, "Error allocating DMA ring.\n");
285 dma_addr = dma_map_single(greth->dev,
290 if (dma_mapping_error(greth->dev, dma_addr)) {
291 if (netif_msg_ifup(greth))
292 dev_err(greth->dev, "Could not create initial DMA mapping\n");
295 greth_write_bd(&rx_bd[i].addr, dma_addr);
296 greth_write_bd(&rx_bd[i].stat, GRETH_BD_EN | GRETH_BD_IE);
298 for (i = 0; i < GRETH_TXBD_NUM; i++) {
300 greth->tx_bufs[i] = kmalloc(MAX_FRAME_SIZE, GFP_KERNEL);
302 if (greth->tx_bufs[i] == NULL) {
303 if (netif_msg_ifup(greth))
304 dev_err(greth->dev, "Error allocating DMA ring.\n");
308 dma_addr = dma_map_single(greth->dev,
313 if (dma_mapping_error(greth->dev, dma_addr)) {
314 if (netif_msg_ifup(greth))
315 dev_err(greth->dev, "Could not create initial DMA mapping\n");
318 greth_write_bd(&tx_bd[i].addr, dma_addr);
319 greth_write_bd(&tx_bd[i].stat, 0);
322 greth_write_bd(&rx_bd[GRETH_RXBD_NUM - 1].stat,
323 greth_read_bd(&rx_bd[GRETH_RXBD_NUM - 1].stat) | GRETH_BD_WR);
325 /* Initialize pointers. */
329 greth->tx_free = GRETH_TXBD_NUM;
331 /* Initialize descriptor base address */
332 GRETH_REGSAVE(greth->regs->tx_desc_p, greth->tx_bd_base_phys);
333 GRETH_REGSAVE(greth->regs->rx_desc_p, greth->rx_bd_base_phys);
338 greth_clean_rings(greth);
342 static int greth_open(struct net_device *dev)
344 struct greth_private *greth = netdev_priv(dev);
347 err = greth_init_rings(greth);
349 if (netif_msg_ifup(greth))
350 dev_err(&dev->dev, "Could not allocate memory for DMA rings\n");
354 err = request_irq(greth->irq, greth_interrupt, 0, "eth", (void *) dev);
356 if (netif_msg_ifup(greth))
357 dev_err(&dev->dev, "Could not allocate interrupt %d\n", dev->irq);
358 greth_clean_rings(greth);
362 if (netif_msg_ifup(greth))
363 dev_dbg(&dev->dev, " starting queue\n");
364 netif_start_queue(dev);
366 GRETH_REGSAVE(greth->regs->status, 0xFF);
368 napi_enable(&greth->napi);
370 greth_enable_irqs(greth);
371 greth_enable_tx(greth);
372 greth_enable_rx(greth);
377 static int greth_close(struct net_device *dev)
379 struct greth_private *greth = netdev_priv(dev);
381 napi_disable(&greth->napi);
383 greth_disable_irqs(greth);
384 greth_disable_tx(greth);
385 greth_disable_rx(greth);
387 netif_stop_queue(dev);
389 free_irq(greth->irq, (void *) dev);
391 greth_clean_rings(greth);
397 greth_start_xmit(struct sk_buff *skb, struct net_device *dev)
399 struct greth_private *greth = netdev_priv(dev);
400 struct greth_bd *bdp;
401 int err = NETDEV_TX_OK;
402 u32 status, dma_addr, ctrl;
406 greth_clean_tx(greth->netdev);
408 if (unlikely(greth->tx_free <= 0)) {
409 spin_lock_irqsave(&greth->devlock, flags);/*save from poll/irq*/
410 ctrl = GRETH_REGLOAD(greth->regs->control);
411 /* Enable TX IRQ only if not already in poll() routine */
412 if (ctrl & GRETH_RXI)
413 GRETH_REGSAVE(greth->regs->control, ctrl | GRETH_TXI);
414 netif_stop_queue(dev);
415 spin_unlock_irqrestore(&greth->devlock, flags);
416 return NETDEV_TX_BUSY;
419 if (netif_msg_pktdata(greth))
420 greth_print_tx_packet(skb);
423 if (unlikely(skb->len > MAX_FRAME_SIZE)) {
424 dev->stats.tx_errors++;
428 bdp = greth->tx_bd_base + greth->tx_next;
429 dma_addr = greth_read_bd(&bdp->addr);
431 memcpy((unsigned char *) phys_to_virt(dma_addr), skb->data, skb->len);
433 dma_sync_single_for_device(greth->dev, dma_addr, skb->len, DMA_TO_DEVICE);
435 status = GRETH_BD_EN | GRETH_BD_IE | (skb->len & GRETH_BD_LEN);
436 greth->tx_bufs_length[greth->tx_next] = skb->len & GRETH_BD_LEN;
438 /* Wrap around descriptor ring */
439 if (greth->tx_next == GRETH_TXBD_NUM_MASK) {
440 status |= GRETH_BD_WR;
443 greth->tx_next = NEXT_TX(greth->tx_next);
446 /* Write descriptor control word and enable transmission */
447 greth_write_bd(&bdp->stat, status);
448 spin_lock_irqsave(&greth->devlock, flags); /*save from poll/irq*/
449 greth_enable_tx(greth);
450 spin_unlock_irqrestore(&greth->devlock, flags);
457 static inline u16 greth_num_free_bds(u16 tx_last, u16 tx_next)
459 if (tx_next < tx_last)
460 return (tx_last - tx_next) - 1;
462 return GRETH_TXBD_NUM - (tx_next - tx_last) - 1;
466 greth_start_xmit_gbit(struct sk_buff *skb, struct net_device *dev)
468 struct greth_private *greth = netdev_priv(dev);
469 struct greth_bd *bdp;
470 u32 status, dma_addr;
471 int curr_tx, nr_frags, i, err = NETDEV_TX_OK;
475 nr_frags = skb_shinfo(skb)->nr_frags;
476 tx_last = greth->tx_last;
477 rmb(); /* tx_last is updated by the poll task */
479 if (greth_num_free_bds(tx_last, greth->tx_next) < nr_frags + 1) {
480 netif_stop_queue(dev);
481 err = NETDEV_TX_BUSY;
485 if (netif_msg_pktdata(greth))
486 greth_print_tx_packet(skb);
488 if (unlikely(skb->len > MAX_FRAME_SIZE)) {
489 dev->stats.tx_errors++;
493 /* Save skb pointer. */
494 greth->tx_skbuff[greth->tx_next] = skb;
498 status = GRETH_TXBD_MORE;
500 status = GRETH_BD_IE;
502 if (skb->ip_summed == CHECKSUM_PARTIAL)
503 status |= GRETH_TXBD_CSALL;
504 status |= skb_headlen(skb) & GRETH_BD_LEN;
505 if (greth->tx_next == GRETH_TXBD_NUM_MASK)
506 status |= GRETH_BD_WR;
509 bdp = greth->tx_bd_base + greth->tx_next;
510 greth_write_bd(&bdp->stat, status);
511 dma_addr = dma_map_single(greth->dev, skb->data, skb_headlen(skb), DMA_TO_DEVICE);
513 if (unlikely(dma_mapping_error(greth->dev, dma_addr)))
516 greth_write_bd(&bdp->addr, dma_addr);
518 curr_tx = NEXT_TX(greth->tx_next);
521 for (i = 0; i < nr_frags; i++) {
522 skb_frag_t *frag = &skb_shinfo(skb)->frags[i];
523 greth->tx_skbuff[curr_tx] = NULL;
524 bdp = greth->tx_bd_base + curr_tx;
526 status = GRETH_BD_EN;
527 if (skb->ip_summed == CHECKSUM_PARTIAL)
528 status |= GRETH_TXBD_CSALL;
529 status |= skb_frag_size(frag) & GRETH_BD_LEN;
531 /* Wrap around descriptor ring */
532 if (curr_tx == GRETH_TXBD_NUM_MASK)
533 status |= GRETH_BD_WR;
535 /* More fragments left */
536 if (i < nr_frags - 1)
537 status |= GRETH_TXBD_MORE;
539 status |= GRETH_BD_IE; /* enable IRQ on last fragment */
541 greth_write_bd(&bdp->stat, status);
543 dma_addr = skb_frag_dma_map(greth->dev, frag, 0, skb_frag_size(frag),
546 if (unlikely(dma_mapping_error(greth->dev, dma_addr)))
549 greth_write_bd(&bdp->addr, dma_addr);
551 curr_tx = NEXT_TX(curr_tx);
556 /* Enable the descriptor chain by enabling the first descriptor */
557 bdp = greth->tx_bd_base + greth->tx_next;
558 greth_write_bd(&bdp->stat,
559 greth_read_bd(&bdp->stat) | GRETH_BD_EN);
561 spin_lock_irqsave(&greth->devlock, flags); /*save from poll/irq*/
562 greth->tx_next = curr_tx;
563 greth_enable_tx_and_irq(greth);
564 spin_unlock_irqrestore(&greth->devlock, flags);
569 /* Unmap SKB mappings that succeeded and disable descriptor */
570 for (i = 0; greth->tx_next + i != curr_tx; i++) {
571 bdp = greth->tx_bd_base + greth->tx_next + i;
572 dma_unmap_single(greth->dev,
573 greth_read_bd(&bdp->addr),
574 greth_read_bd(&bdp->stat) & GRETH_BD_LEN,
576 greth_write_bd(&bdp->stat, 0);
580 dev_warn(greth->dev, "Could not create TX DMA mapping\n");
586 static irqreturn_t greth_interrupt(int irq, void *dev_id)
588 struct net_device *dev = dev_id;
589 struct greth_private *greth;
591 irqreturn_t retval = IRQ_NONE;
593 greth = netdev_priv(dev);
595 spin_lock(&greth->devlock);
597 /* Get the interrupt events that caused us to be here. */
598 status = GRETH_REGLOAD(greth->regs->status);
600 /* Must see if interrupts are enabled also, INT_TX|INT_RX flags may be
601 * set regardless of whether IRQ is enabled or not. Especially
602 * important when shared IRQ.
604 ctrl = GRETH_REGLOAD(greth->regs->control);
606 /* Handle rx and tx interrupts through poll */
607 if (((status & (GRETH_INT_RE | GRETH_INT_RX)) && (ctrl & GRETH_RXI)) ||
608 ((status & (GRETH_INT_TE | GRETH_INT_TX)) && (ctrl & GRETH_TXI))) {
609 retval = IRQ_HANDLED;
611 /* Disable interrupts and schedule poll() */
612 greth_disable_irqs(greth);
613 napi_schedule(&greth->napi);
617 spin_unlock(&greth->devlock);
622 static void greth_clean_tx(struct net_device *dev)
624 struct greth_private *greth;
625 struct greth_bd *bdp;
628 greth = netdev_priv(dev);
631 bdp = greth->tx_bd_base + greth->tx_last;
632 GRETH_REGSAVE(greth->regs->status, GRETH_INT_TE | GRETH_INT_TX);
634 stat = greth_read_bd(&bdp->stat);
636 if (unlikely(stat & GRETH_BD_EN))
639 if (greth->tx_free == GRETH_TXBD_NUM)
642 /* Check status for errors */
643 if (unlikely(stat & GRETH_TXBD_STATUS)) {
644 dev->stats.tx_errors++;
645 if (stat & GRETH_TXBD_ERR_AL)
646 dev->stats.tx_aborted_errors++;
647 if (stat & GRETH_TXBD_ERR_UE)
648 dev->stats.tx_fifo_errors++;
650 dev->stats.tx_packets++;
651 dev->stats.tx_bytes += greth->tx_bufs_length[greth->tx_last];
652 greth->tx_last = NEXT_TX(greth->tx_last);
656 if (greth->tx_free > 0) {
657 netif_wake_queue(dev);
661 static inline void greth_update_tx_stats(struct net_device *dev, u32 stat)
663 /* Check status for errors */
664 if (unlikely(stat & GRETH_TXBD_STATUS)) {
665 dev->stats.tx_errors++;
666 if (stat & GRETH_TXBD_ERR_AL)
667 dev->stats.tx_aborted_errors++;
668 if (stat & GRETH_TXBD_ERR_UE)
669 dev->stats.tx_fifo_errors++;
670 if (stat & GRETH_TXBD_ERR_LC)
671 dev->stats.tx_aborted_errors++;
673 dev->stats.tx_packets++;
676 static void greth_clean_tx_gbit(struct net_device *dev)
678 struct greth_private *greth;
679 struct greth_bd *bdp, *bdp_last_frag;
680 struct sk_buff *skb = NULL;
685 greth = netdev_priv(dev);
686 tx_last = greth->tx_last;
688 while (tx_last != greth->tx_next) {
690 skb = greth->tx_skbuff[tx_last];
692 nr_frags = skb_shinfo(skb)->nr_frags;
694 /* We only clean fully completed SKBs */
695 bdp_last_frag = greth->tx_bd_base + SKIP_TX(tx_last, nr_frags);
697 GRETH_REGSAVE(greth->regs->status, GRETH_INT_TE | GRETH_INT_TX);
699 stat = greth_read_bd(&bdp_last_frag->stat);
701 if (stat & GRETH_BD_EN)
704 greth->tx_skbuff[tx_last] = NULL;
706 greth_update_tx_stats(dev, stat);
707 dev->stats.tx_bytes += skb->len;
709 bdp = greth->tx_bd_base + tx_last;
711 tx_last = NEXT_TX(tx_last);
713 dma_unmap_single(greth->dev,
714 greth_read_bd(&bdp->addr),
718 for (i = 0; i < nr_frags; i++) {
719 skb_frag_t *frag = &skb_shinfo(skb)->frags[i];
720 bdp = greth->tx_bd_base + tx_last;
722 dma_unmap_page(greth->dev,
723 greth_read_bd(&bdp->addr),
727 tx_last = NEXT_TX(tx_last);
731 if (skb) { /* skb is set only if the above while loop was entered */
733 greth->tx_last = tx_last;
735 if (netif_queue_stopped(dev) &&
736 (greth_num_free_bds(tx_last, greth->tx_next) >
738 netif_wake_queue(dev);
742 static int greth_rx(struct net_device *dev, int limit)
744 struct greth_private *greth;
745 struct greth_bd *bdp;
749 u32 status, dma_addr;
752 greth = netdev_priv(dev);
754 for (count = 0; count < limit; ++count) {
756 bdp = greth->rx_bd_base + greth->rx_cur;
757 GRETH_REGSAVE(greth->regs->status, GRETH_INT_RE | GRETH_INT_RX);
759 status = greth_read_bd(&bdp->stat);
761 if (unlikely(status & GRETH_BD_EN)) {
765 dma_addr = greth_read_bd(&bdp->addr);
768 /* Check status for errors. */
769 if (unlikely(status & GRETH_RXBD_STATUS)) {
770 if (status & GRETH_RXBD_ERR_FT) {
771 dev->stats.rx_length_errors++;
774 if (status & (GRETH_RXBD_ERR_AE | GRETH_RXBD_ERR_OE)) {
775 dev->stats.rx_frame_errors++;
778 if (status & GRETH_RXBD_ERR_CRC) {
779 dev->stats.rx_crc_errors++;
784 dev->stats.rx_errors++;
788 pkt_len = status & GRETH_BD_LEN;
790 skb = netdev_alloc_skb(dev, pkt_len + NET_IP_ALIGN);
792 if (unlikely(skb == NULL)) {
795 dev_warn(&dev->dev, "low on memory - " "packet dropped\n");
797 dev->stats.rx_dropped++;
800 skb_reserve(skb, NET_IP_ALIGN);
802 dma_sync_single_for_cpu(greth->dev,
807 if (netif_msg_pktdata(greth))
808 greth_print_rx_packet(phys_to_virt(dma_addr), pkt_len);
810 memcpy(skb_put(skb, pkt_len), phys_to_virt(dma_addr), pkt_len);
812 skb->protocol = eth_type_trans(skb, dev);
813 dev->stats.rx_bytes += pkt_len;
814 dev->stats.rx_packets++;
815 netif_receive_skb(skb);
819 status = GRETH_BD_EN | GRETH_BD_IE;
820 if (greth->rx_cur == GRETH_RXBD_NUM_MASK) {
821 status |= GRETH_BD_WR;
825 greth_write_bd(&bdp->stat, status);
827 dma_sync_single_for_device(greth->dev, dma_addr, MAX_FRAME_SIZE, DMA_FROM_DEVICE);
829 spin_lock_irqsave(&greth->devlock, flags); /* save from XMIT */
830 greth_enable_rx(greth);
831 spin_unlock_irqrestore(&greth->devlock, flags);
833 greth->rx_cur = NEXT_RX(greth->rx_cur);
839 static inline int hw_checksummed(u32 status)
842 if (status & GRETH_RXBD_IP_FRAG)
845 if (status & GRETH_RXBD_IP && status & GRETH_RXBD_IP_CSERR)
848 if (status & GRETH_RXBD_UDP && status & GRETH_RXBD_UDP_CSERR)
851 if (status & GRETH_RXBD_TCP && status & GRETH_RXBD_TCP_CSERR)
857 static int greth_rx_gbit(struct net_device *dev, int limit)
859 struct greth_private *greth;
860 struct greth_bd *bdp;
861 struct sk_buff *skb, *newskb;
864 u32 status, dma_addr;
867 greth = netdev_priv(dev);
869 for (count = 0; count < limit; ++count) {
871 bdp = greth->rx_bd_base + greth->rx_cur;
872 skb = greth->rx_skbuff[greth->rx_cur];
873 GRETH_REGSAVE(greth->regs->status, GRETH_INT_RE | GRETH_INT_RX);
875 status = greth_read_bd(&bdp->stat);
878 if (status & GRETH_BD_EN)
881 /* Check status for errors. */
882 if (unlikely(status & GRETH_RXBD_STATUS)) {
884 if (status & GRETH_RXBD_ERR_FT) {
885 dev->stats.rx_length_errors++;
888 (GRETH_RXBD_ERR_AE | GRETH_RXBD_ERR_OE | GRETH_RXBD_ERR_LE)) {
889 dev->stats.rx_frame_errors++;
891 } else if (status & GRETH_RXBD_ERR_CRC) {
892 dev->stats.rx_crc_errors++;
897 /* Allocate new skb to replace current, not needed if the
898 * current skb can be reused */
899 if (!bad && (newskb=netdev_alloc_skb(dev, MAX_FRAME_SIZE + NET_IP_ALIGN))) {
900 skb_reserve(newskb, NET_IP_ALIGN);
902 dma_addr = dma_map_single(greth->dev,
904 MAX_FRAME_SIZE + NET_IP_ALIGN,
907 if (!dma_mapping_error(greth->dev, dma_addr)) {
908 /* Process the incoming frame. */
909 pkt_len = status & GRETH_BD_LEN;
911 dma_unmap_single(greth->dev,
912 greth_read_bd(&bdp->addr),
913 MAX_FRAME_SIZE + NET_IP_ALIGN,
916 if (netif_msg_pktdata(greth))
917 greth_print_rx_packet(phys_to_virt(greth_read_bd(&bdp->addr)), pkt_len);
919 skb_put(skb, pkt_len);
921 if (dev->features & NETIF_F_RXCSUM && hw_checksummed(status))
922 skb->ip_summed = CHECKSUM_UNNECESSARY;
924 skb_checksum_none_assert(skb);
926 skb->protocol = eth_type_trans(skb, dev);
927 dev->stats.rx_packets++;
928 dev->stats.rx_bytes += pkt_len;
929 netif_receive_skb(skb);
931 greth->rx_skbuff[greth->rx_cur] = newskb;
932 greth_write_bd(&bdp->addr, dma_addr);
935 dev_warn(greth->dev, "Could not create DMA mapping, dropping packet\n");
936 dev_kfree_skb(newskb);
937 /* reusing current skb, so it is a drop */
938 dev->stats.rx_dropped++;
941 /* Bad Frame transfer, the skb is reused */
942 dev->stats.rx_dropped++;
944 /* Failed Allocating a new skb. This is rather stupid
945 * but the current "filled" skb is reused, as if
946 * transfer failure. One could argue that RX descriptor
947 * table handling should be divided into cleaning and
948 * filling as the TX part of the driver
951 dev_warn(greth->dev, "Could not allocate SKB, dropping packet\n");
952 /* reusing current skb, so it is a drop */
953 dev->stats.rx_dropped++;
956 status = GRETH_BD_EN | GRETH_BD_IE;
957 if (greth->rx_cur == GRETH_RXBD_NUM_MASK) {
958 status |= GRETH_BD_WR;
962 greth_write_bd(&bdp->stat, status);
963 spin_lock_irqsave(&greth->devlock, flags);
964 greth_enable_rx(greth);
965 spin_unlock_irqrestore(&greth->devlock, flags);
966 greth->rx_cur = NEXT_RX(greth->rx_cur);
973 static int greth_poll(struct napi_struct *napi, int budget)
975 struct greth_private *greth;
979 greth = container_of(napi, struct greth_private, napi);
982 if (greth->gbit_mac) {
983 greth_clean_tx_gbit(greth->netdev);
984 work_done += greth_rx_gbit(greth->netdev, budget - work_done);
986 if (netif_queue_stopped(greth->netdev))
987 greth_clean_tx(greth->netdev);
988 work_done += greth_rx(greth->netdev, budget - work_done);
991 if (work_done < budget) {
993 spin_lock_irqsave(&greth->devlock, flags);
995 ctrl = GRETH_REGLOAD(greth->regs->control);
996 if ((greth->gbit_mac && (greth->tx_last != greth->tx_next)) ||
997 (!greth->gbit_mac && netif_queue_stopped(greth->netdev))) {
998 GRETH_REGSAVE(greth->regs->control,
999 ctrl | GRETH_TXI | GRETH_RXI);
1000 mask = GRETH_INT_RX | GRETH_INT_RE |
1001 GRETH_INT_TX | GRETH_INT_TE;
1003 GRETH_REGSAVE(greth->regs->control, ctrl | GRETH_RXI);
1004 mask = GRETH_INT_RX | GRETH_INT_RE;
1007 if (GRETH_REGLOAD(greth->regs->status) & mask) {
1008 GRETH_REGSAVE(greth->regs->control, ctrl);
1009 spin_unlock_irqrestore(&greth->devlock, flags);
1010 goto restart_txrx_poll;
1012 napi_complete_done(napi, work_done);
1013 spin_unlock_irqrestore(&greth->devlock, flags);
1020 static int greth_set_mac_add(struct net_device *dev, void *p)
1022 struct sockaddr *addr = p;
1023 struct greth_private *greth;
1024 struct greth_regs *regs;
1026 greth = netdev_priv(dev);
1029 if (!is_valid_ether_addr(addr->sa_data))
1030 return -EADDRNOTAVAIL;
1032 memcpy(dev->dev_addr, addr->sa_data, dev->addr_len);
1033 GRETH_REGSAVE(regs->esa_msb, dev->dev_addr[0] << 8 | dev->dev_addr[1]);
1034 GRETH_REGSAVE(regs->esa_lsb, dev->dev_addr[2] << 24 | dev->dev_addr[3] << 16 |
1035 dev->dev_addr[4] << 8 | dev->dev_addr[5]);
1040 static u32 greth_hash_get_index(__u8 *addr)
1042 return (ether_crc(6, addr)) & 0x3F;
1045 static void greth_set_hash_filter(struct net_device *dev)
1047 struct netdev_hw_addr *ha;
1048 struct greth_private *greth = netdev_priv(dev);
1049 struct greth_regs *regs = greth->regs;
1053 mc_filter[0] = mc_filter[1] = 0;
1055 netdev_for_each_mc_addr(ha, dev) {
1056 bitnr = greth_hash_get_index(ha->addr);
1057 mc_filter[bitnr >> 5] |= 1 << (bitnr & 31);
1060 GRETH_REGSAVE(regs->hash_msb, mc_filter[1]);
1061 GRETH_REGSAVE(regs->hash_lsb, mc_filter[0]);
1064 static void greth_set_multicast_list(struct net_device *dev)
1067 struct greth_private *greth = netdev_priv(dev);
1068 struct greth_regs *regs = greth->regs;
1070 cfg = GRETH_REGLOAD(regs->control);
1071 if (dev->flags & IFF_PROMISC)
1072 cfg |= GRETH_CTRL_PR;
1074 cfg &= ~GRETH_CTRL_PR;
1076 if (greth->multicast) {
1077 if (dev->flags & IFF_ALLMULTI) {
1078 GRETH_REGSAVE(regs->hash_msb, -1);
1079 GRETH_REGSAVE(regs->hash_lsb, -1);
1080 cfg |= GRETH_CTRL_MCEN;
1081 GRETH_REGSAVE(regs->control, cfg);
1085 if (netdev_mc_empty(dev)) {
1086 cfg &= ~GRETH_CTRL_MCEN;
1087 GRETH_REGSAVE(regs->control, cfg);
1091 /* Setup multicast filter */
1092 greth_set_hash_filter(dev);
1093 cfg |= GRETH_CTRL_MCEN;
1095 GRETH_REGSAVE(regs->control, cfg);
1098 static u32 greth_get_msglevel(struct net_device *dev)
1100 struct greth_private *greth = netdev_priv(dev);
1101 return greth->msg_enable;
1104 static void greth_set_msglevel(struct net_device *dev, u32 value)
1106 struct greth_private *greth = netdev_priv(dev);
1107 greth->msg_enable = value;
1110 static int greth_get_regs_len(struct net_device *dev)
1112 return sizeof(struct greth_regs);
1115 static void greth_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info)
1117 struct greth_private *greth = netdev_priv(dev);
1119 strlcpy(info->driver, dev_driver_string(greth->dev),
1120 sizeof(info->driver));
1121 strlcpy(info->version, "revision: 1.0", sizeof(info->version));
1122 strlcpy(info->bus_info, greth->dev->bus->name, sizeof(info->bus_info));
1123 strlcpy(info->fw_version, "N/A", sizeof(info->fw_version));
1126 static void greth_get_regs(struct net_device *dev, struct ethtool_regs *regs, void *p)
1129 struct greth_private *greth = netdev_priv(dev);
1130 u32 __iomem *greth_regs = (u32 __iomem *) greth->regs;
1133 for (i = 0; i < sizeof(struct greth_regs) / sizeof(u32); i++)
1134 buff[i] = greth_read_bd(&greth_regs[i]);
1137 static const struct ethtool_ops greth_ethtool_ops = {
1138 .get_msglevel = greth_get_msglevel,
1139 .set_msglevel = greth_set_msglevel,
1140 .get_drvinfo = greth_get_drvinfo,
1141 .get_regs_len = greth_get_regs_len,
1142 .get_regs = greth_get_regs,
1143 .get_link = ethtool_op_get_link,
1144 .get_link_ksettings = phy_ethtool_get_link_ksettings,
1145 .set_link_ksettings = phy_ethtool_set_link_ksettings,
1148 static struct net_device_ops greth_netdev_ops = {
1149 .ndo_open = greth_open,
1150 .ndo_stop = greth_close,
1151 .ndo_start_xmit = greth_start_xmit,
1152 .ndo_set_mac_address = greth_set_mac_add,
1153 .ndo_validate_addr = eth_validate_addr,
1156 static inline int wait_for_mdio(struct greth_private *greth)
1158 unsigned long timeout = jiffies + 4*HZ/100;
1159 while (GRETH_REGLOAD(greth->regs->mdio) & GRETH_MII_BUSY) {
1160 if (time_after(jiffies, timeout))
1166 static int greth_mdio_read(struct mii_bus *bus, int phy, int reg)
1168 struct greth_private *greth = bus->priv;
1171 if (!wait_for_mdio(greth))
1174 GRETH_REGSAVE(greth->regs->mdio, ((phy & 0x1F) << 11) | ((reg & 0x1F) << 6) | 2);
1176 if (!wait_for_mdio(greth))
1179 if (!(GRETH_REGLOAD(greth->regs->mdio) & GRETH_MII_NVALID)) {
1180 data = (GRETH_REGLOAD(greth->regs->mdio) >> 16) & 0xFFFF;
1188 static int greth_mdio_write(struct mii_bus *bus, int phy, int reg, u16 val)
1190 struct greth_private *greth = bus->priv;
1192 if (!wait_for_mdio(greth))
1195 GRETH_REGSAVE(greth->regs->mdio,
1196 ((val & 0xFFFF) << 16) | ((phy & 0x1F) << 11) | ((reg & 0x1F) << 6) | 1);
1198 if (!wait_for_mdio(greth))
1204 static void greth_link_change(struct net_device *dev)
1206 struct greth_private *greth = netdev_priv(dev);
1207 struct phy_device *phydev = dev->phydev;
1208 unsigned long flags;
1209 int status_change = 0;
1212 spin_lock_irqsave(&greth->devlock, flags);
1216 if ((greth->speed != phydev->speed) || (greth->duplex != phydev->duplex)) {
1217 ctrl = GRETH_REGLOAD(greth->regs->control) &
1218 ~(GRETH_CTRL_FD | GRETH_CTRL_SP | GRETH_CTRL_GB);
1221 ctrl |= GRETH_CTRL_FD;
1223 if (phydev->speed == SPEED_100)
1224 ctrl |= GRETH_CTRL_SP;
1225 else if (phydev->speed == SPEED_1000)
1226 ctrl |= GRETH_CTRL_GB;
1228 GRETH_REGSAVE(greth->regs->control, ctrl);
1229 greth->speed = phydev->speed;
1230 greth->duplex = phydev->duplex;
1235 if (phydev->link != greth->link) {
1236 if (!phydev->link) {
1240 greth->link = phydev->link;
1245 spin_unlock_irqrestore(&greth->devlock, flags);
1247 if (status_change) {
1249 pr_debug("%s: link up (%d/%s)\n",
1250 dev->name, phydev->speed,
1251 DUPLEX_FULL == phydev->duplex ? "Full" : "Half");
1253 pr_debug("%s: link down\n", dev->name);
1257 static int greth_mdio_probe(struct net_device *dev)
1259 struct greth_private *greth = netdev_priv(dev);
1260 struct phy_device *phy = NULL;
1263 /* Find the first PHY */
1264 phy = phy_find_first(greth->mdio);
1267 if (netif_msg_probe(greth))
1268 dev_err(&dev->dev, "no PHY found\n");
1272 ret = phy_connect_direct(dev, phy, &greth_link_change,
1273 greth->gbit_mac ? PHY_INTERFACE_MODE_GMII : PHY_INTERFACE_MODE_MII);
1275 if (netif_msg_ifup(greth))
1276 dev_err(&dev->dev, "could not attach to PHY\n");
1280 if (greth->gbit_mac)
1281 phy->supported &= PHY_GBIT_FEATURES;
1283 phy->supported &= PHY_BASIC_FEATURES;
1285 phy->advertising = phy->supported;
1294 static int greth_mdio_init(struct greth_private *greth)
1297 unsigned long timeout;
1298 struct net_device *ndev = greth->netdev;
1300 greth->mdio = mdiobus_alloc();
1305 greth->mdio->name = "greth-mdio";
1306 snprintf(greth->mdio->id, MII_BUS_ID_SIZE, "%s-%d", greth->mdio->name, greth->irq);
1307 greth->mdio->read = greth_mdio_read;
1308 greth->mdio->write = greth_mdio_write;
1309 greth->mdio->priv = greth;
1311 ret = mdiobus_register(greth->mdio);
1316 ret = greth_mdio_probe(greth->netdev);
1318 if (netif_msg_probe(greth))
1319 dev_err(&greth->netdev->dev, "failed to probe MDIO bus\n");
1323 phy_start(ndev->phydev);
1325 /* If Ethernet debug link is used make autoneg happen right away */
1326 if (greth->edcl && greth_edcl == 1) {
1327 phy_start_aneg(ndev->phydev);
1328 timeout = jiffies + 6*HZ;
1329 while (!phy_aneg_done(ndev->phydev) &&
1330 time_before(jiffies, timeout)) {
1332 phy_read_status(ndev->phydev);
1333 greth_link_change(greth->netdev);
1339 mdiobus_unregister(greth->mdio);
1341 mdiobus_free(greth->mdio);
1345 /* Initialize the GRETH MAC */
1346 static int greth_of_probe(struct platform_device *ofdev)
1348 struct net_device *dev;
1349 struct greth_private *greth;
1350 struct greth_regs *regs;
1355 unsigned long timeout;
1357 dev = alloc_etherdev(sizeof(struct greth_private));
1362 greth = netdev_priv(dev);
1363 greth->netdev = dev;
1364 greth->dev = &ofdev->dev;
1366 if (greth_debug > 0)
1367 greth->msg_enable = greth_debug;
1369 greth->msg_enable = GRETH_DEF_MSG_ENABLE;
1371 spin_lock_init(&greth->devlock);
1373 greth->regs = of_ioremap(&ofdev->resource[0], 0,
1374 resource_size(&ofdev->resource[0]),
1375 "grlib-greth regs");
1377 if (greth->regs == NULL) {
1378 if (netif_msg_probe(greth))
1379 dev_err(greth->dev, "ioremap failure.\n");
1385 greth->irq = ofdev->archdata.irqs[0];
1387 dev_set_drvdata(greth->dev, dev);
1388 SET_NETDEV_DEV(dev, greth->dev);
1390 if (netif_msg_probe(greth))
1391 dev_dbg(greth->dev, "resetting controller.\n");
1393 /* Reset the controller. */
1394 GRETH_REGSAVE(regs->control, GRETH_RESET);
1396 /* Wait for MAC to reset itself */
1397 timeout = jiffies + HZ/100;
1398 while (GRETH_REGLOAD(regs->control) & GRETH_RESET) {
1399 if (time_after(jiffies, timeout)) {
1401 if (netif_msg_probe(greth))
1402 dev_err(greth->dev, "timeout when waiting for reset.\n");
1407 /* Get default PHY address */
1408 greth->phyaddr = (GRETH_REGLOAD(regs->mdio) >> 11) & 0x1F;
1410 /* Check if we have GBIT capable MAC */
1411 tmp = GRETH_REGLOAD(regs->control);
1412 greth->gbit_mac = (tmp >> 27) & 1;
1414 /* Check for multicast capability */
1415 greth->multicast = (tmp >> 25) & 1;
1417 greth->edcl = (tmp >> 31) & 1;
1419 /* If we have EDCL we disable the EDCL speed-duplex FSM so
1420 * it doesn't interfere with the software */
1421 if (greth->edcl != 0)
1422 GRETH_REGORIN(regs->control, GRETH_CTRL_DISDUPLEX);
1424 /* Check if MAC can handle MDIO interrupts */
1425 greth->mdio_int_en = (tmp >> 26) & 1;
1427 err = greth_mdio_init(greth);
1429 if (netif_msg_probe(greth))
1430 dev_err(greth->dev, "failed to register MDIO bus\n");
1434 /* Allocate TX descriptor ring in coherent memory */
1435 greth->tx_bd_base = dma_zalloc_coherent(greth->dev, 1024,
1436 &greth->tx_bd_base_phys,
1438 if (!greth->tx_bd_base) {
1443 /* Allocate RX descriptor ring in coherent memory */
1444 greth->rx_bd_base = dma_zalloc_coherent(greth->dev, 1024,
1445 &greth->rx_bd_base_phys,
1447 if (!greth->rx_bd_base) {
1452 /* Get MAC address from: module param, OF property or ID prom */
1453 for (i = 0; i < 6; i++) {
1454 if (macaddr[i] != 0)
1460 addr = of_get_mac_address(ofdev->dev.of_node);
1462 for (i = 0; i < 6; i++)
1463 macaddr[i] = (unsigned int) addr[i];
1466 for (i = 0; i < 6; i++)
1467 macaddr[i] = (unsigned int) idprom->id_ethaddr[i];
1472 for (i = 0; i < 6; i++)
1473 dev->dev_addr[i] = macaddr[i];
1477 if (!is_valid_ether_addr(&dev->dev_addr[0])) {
1478 if (netif_msg_probe(greth))
1479 dev_err(greth->dev, "no valid ethernet address, aborting.\n");
1484 GRETH_REGSAVE(regs->esa_msb, dev->dev_addr[0] << 8 | dev->dev_addr[1]);
1485 GRETH_REGSAVE(regs->esa_lsb, dev->dev_addr[2] << 24 | dev->dev_addr[3] << 16 |
1486 dev->dev_addr[4] << 8 | dev->dev_addr[5]);
1488 /* Clear all pending interrupts except PHY irq */
1489 GRETH_REGSAVE(regs->status, 0xFF);
1491 if (greth->gbit_mac) {
1492 dev->hw_features = NETIF_F_SG | NETIF_F_IP_CSUM |
1494 dev->features = dev->hw_features | NETIF_F_HIGHDMA;
1495 greth_netdev_ops.ndo_start_xmit = greth_start_xmit_gbit;
1498 if (greth->multicast) {
1499 greth_netdev_ops.ndo_set_rx_mode = greth_set_multicast_list;
1500 dev->flags |= IFF_MULTICAST;
1502 dev->flags &= ~IFF_MULTICAST;
1505 dev->netdev_ops = &greth_netdev_ops;
1506 dev->ethtool_ops = &greth_ethtool_ops;
1508 err = register_netdev(dev);
1510 if (netif_msg_probe(greth))
1511 dev_err(greth->dev, "netdevice registration failed.\n");
1516 netif_napi_add(dev, &greth->napi, greth_poll, 64);
1521 dma_free_coherent(greth->dev, 1024, greth->rx_bd_base, greth->rx_bd_base_phys);
1523 dma_free_coherent(greth->dev, 1024, greth->tx_bd_base, greth->tx_bd_base_phys);
1525 mdiobus_unregister(greth->mdio);
1527 of_iounmap(&ofdev->resource[0], greth->regs, resource_size(&ofdev->resource[0]));
1533 static int greth_of_remove(struct platform_device *of_dev)
1535 struct net_device *ndev = platform_get_drvdata(of_dev);
1536 struct greth_private *greth = netdev_priv(ndev);
1538 /* Free descriptor areas */
1539 dma_free_coherent(&of_dev->dev, 1024, greth->rx_bd_base, greth->rx_bd_base_phys);
1541 dma_free_coherent(&of_dev->dev, 1024, greth->tx_bd_base, greth->tx_bd_base_phys);
1544 phy_stop(ndev->phydev);
1545 mdiobus_unregister(greth->mdio);
1547 unregister_netdev(ndev);
1550 of_iounmap(&of_dev->resource[0], greth->regs, resource_size(&of_dev->resource[0]));
1555 static const struct of_device_id greth_of_match[] = {
1557 .name = "GAISLER_ETHMAC",
1565 MODULE_DEVICE_TABLE(of, greth_of_match);
1567 static struct platform_driver greth_of_driver = {
1569 .name = "grlib-greth",
1570 .of_match_table = greth_of_match,
1572 .probe = greth_of_probe,
1573 .remove = greth_of_remove,
1576 module_platform_driver(greth_of_driver);
1578 MODULE_AUTHOR("Aeroflex Gaisler AB.");
1579 MODULE_DESCRIPTION("Aeroflex Gaisler Ethernet MAC driver");
1580 MODULE_LICENSE("GPL");