2 * Cadence MACB/GEM Ethernet Controller driver
4 * Copyright (C) 2004-2006 Atmel Corporation
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
11 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
12 #include <linux/clk.h>
13 #include <linux/module.h>
14 #include <linux/moduleparam.h>
15 #include <linux/kernel.h>
16 #include <linux/types.h>
17 #include <linux/slab.h>
18 #include <linux/init.h>
19 #include <linux/interrupt.h>
20 #include <linux/netdevice.h>
21 #include <linux/etherdevice.h>
22 #include <linux/dma-mapping.h>
23 #include <linux/platform_data/macb.h>
24 #include <linux/platform_device.h>
25 #include <linux/phy.h>
27 #include <linux/of_device.h>
28 #include <linux/of_net.h>
32 #define RX_BUFFER_SIZE 128
33 #define RX_RING_SIZE 512
34 #define RX_RING_BYTES (sizeof(struct dma_desc) * RX_RING_SIZE)
36 /* Make the IP header word-aligned (the ethernet header is 14 bytes) */
39 #define TX_RING_SIZE 128
40 #define DEF_TX_RING_PENDING (TX_RING_SIZE - 1)
41 #define TX_RING_BYTES (sizeof(struct dma_desc) * TX_RING_SIZE)
43 #define TX_RING_GAP(bp) \
44 (TX_RING_SIZE - (bp)->tx_pending)
45 #define TX_BUFFS_AVAIL(bp) \
46 (((bp)->tx_tail <= (bp)->tx_head) ? \
47 (bp)->tx_tail + (bp)->tx_pending - (bp)->tx_head : \
48 (bp)->tx_tail - (bp)->tx_head - TX_RING_GAP(bp))
49 #define NEXT_TX(n) (((n) + 1) & (TX_RING_SIZE - 1))
51 #define NEXT_RX(n) (((n) + 1) & (RX_RING_SIZE - 1))
53 /* minimum number of free TX descriptors before waking up TX process */
54 #define MACB_TX_WAKEUP_THRESH (TX_RING_SIZE / 4)
56 #define MACB_RX_INT_FLAGS (MACB_BIT(RCOMP) | MACB_BIT(RXUBR) \
59 static void __macb_set_hwaddr(struct macb
*bp
)
64 bottom
= cpu_to_le32(*((u32
*)bp
->dev
->dev_addr
));
65 macb_or_gem_writel(bp
, SA1B
, bottom
);
66 top
= cpu_to_le16(*((u16
*)(bp
->dev
->dev_addr
+ 4)));
67 macb_or_gem_writel(bp
, SA1T
, top
);
70 static void __init
macb_get_hwaddr(struct macb
*bp
)
76 bottom
= macb_or_gem_readl(bp
, SA1B
);
77 top
= macb_or_gem_readl(bp
, SA1T
);
79 addr
[0] = bottom
& 0xff;
80 addr
[1] = (bottom
>> 8) & 0xff;
81 addr
[2] = (bottom
>> 16) & 0xff;
82 addr
[3] = (bottom
>> 24) & 0xff;
84 addr
[5] = (top
>> 8) & 0xff;
86 if (is_valid_ether_addr(addr
)) {
87 memcpy(bp
->dev
->dev_addr
, addr
, sizeof(addr
));
89 netdev_info(bp
->dev
, "invalid hw address, using random\n");
90 eth_hw_addr_random(bp
->dev
);
94 static int macb_mdio_read(struct mii_bus
*bus
, int mii_id
, int regnum
)
96 struct macb
*bp
= bus
->priv
;
99 macb_writel(bp
, MAN
, (MACB_BF(SOF
, MACB_MAN_SOF
)
100 | MACB_BF(RW
, MACB_MAN_READ
)
101 | MACB_BF(PHYA
, mii_id
)
102 | MACB_BF(REGA
, regnum
)
103 | MACB_BF(CODE
, MACB_MAN_CODE
)));
105 /* wait for end of transfer */
106 while (!MACB_BFEXT(IDLE
, macb_readl(bp
, NSR
)))
109 value
= MACB_BFEXT(DATA
, macb_readl(bp
, MAN
));
114 static int macb_mdio_write(struct mii_bus
*bus
, int mii_id
, int regnum
,
117 struct macb
*bp
= bus
->priv
;
119 macb_writel(bp
, MAN
, (MACB_BF(SOF
, MACB_MAN_SOF
)
120 | MACB_BF(RW
, MACB_MAN_WRITE
)
121 | MACB_BF(PHYA
, mii_id
)
122 | MACB_BF(REGA
, regnum
)
123 | MACB_BF(CODE
, MACB_MAN_CODE
)
124 | MACB_BF(DATA
, value
)));
126 /* wait for end of transfer */
127 while (!MACB_BFEXT(IDLE
, macb_readl(bp
, NSR
)))
133 static int macb_mdio_reset(struct mii_bus
*bus
)
138 static void macb_handle_link_change(struct net_device
*dev
)
140 struct macb
*bp
= netdev_priv(dev
);
141 struct phy_device
*phydev
= bp
->phy_dev
;
144 int status_change
= 0;
146 spin_lock_irqsave(&bp
->lock
, flags
);
149 if ((bp
->speed
!= phydev
->speed
) ||
150 (bp
->duplex
!= phydev
->duplex
)) {
153 reg
= macb_readl(bp
, NCFGR
);
154 reg
&= ~(MACB_BIT(SPD
) | MACB_BIT(FD
));
158 if (phydev
->speed
== SPEED_100
)
159 reg
|= MACB_BIT(SPD
);
161 macb_writel(bp
, NCFGR
, reg
);
163 bp
->speed
= phydev
->speed
;
164 bp
->duplex
= phydev
->duplex
;
169 if (phydev
->link
!= bp
->link
) {
174 bp
->link
= phydev
->link
;
179 spin_unlock_irqrestore(&bp
->lock
, flags
);
183 netdev_info(dev
, "link up (%d/%s)\n",
185 phydev
->duplex
== DUPLEX_FULL
?
188 netdev_info(dev
, "link down\n");
192 /* based on au1000_eth. c*/
193 static int macb_mii_probe(struct net_device
*dev
)
195 struct macb
*bp
= netdev_priv(dev
);
196 struct phy_device
*phydev
;
199 phydev
= phy_find_first(bp
->mii_bus
);
201 netdev_err(dev
, "no PHY found\n");
205 /* TODO : add pin_irq */
207 /* attach the mac to the phy */
208 ret
= phy_connect_direct(dev
, phydev
, &macb_handle_link_change
, 0,
211 netdev_err(dev
, "Could not attach to PHY\n");
215 /* mask with MAC supported features */
216 phydev
->supported
&= PHY_BASIC_FEATURES
;
218 phydev
->advertising
= phydev
->supported
;
223 bp
->phy_dev
= phydev
;
228 static int macb_mii_init(struct macb
*bp
)
230 struct macb_platform_data
*pdata
;
233 /* Enable management port */
234 macb_writel(bp
, NCR
, MACB_BIT(MPE
));
236 bp
->mii_bus
= mdiobus_alloc();
237 if (bp
->mii_bus
== NULL
) {
242 bp
->mii_bus
->name
= "MACB_mii_bus";
243 bp
->mii_bus
->read
= &macb_mdio_read
;
244 bp
->mii_bus
->write
= &macb_mdio_write
;
245 bp
->mii_bus
->reset
= &macb_mdio_reset
;
246 snprintf(bp
->mii_bus
->id
, MII_BUS_ID_SIZE
, "%s-%x",
247 bp
->pdev
->name
, bp
->pdev
->id
);
248 bp
->mii_bus
->priv
= bp
;
249 bp
->mii_bus
->parent
= &bp
->dev
->dev
;
250 pdata
= bp
->pdev
->dev
.platform_data
;
253 bp
->mii_bus
->phy_mask
= pdata
->phy_mask
;
255 bp
->mii_bus
->irq
= kmalloc(sizeof(int)*PHY_MAX_ADDR
, GFP_KERNEL
);
256 if (!bp
->mii_bus
->irq
) {
258 goto err_out_free_mdiobus
;
261 for (i
= 0; i
< PHY_MAX_ADDR
; i
++)
262 bp
->mii_bus
->irq
[i
] = PHY_POLL
;
264 dev_set_drvdata(&bp
->dev
->dev
, bp
->mii_bus
);
266 if (mdiobus_register(bp
->mii_bus
))
267 goto err_out_free_mdio_irq
;
269 if (macb_mii_probe(bp
->dev
) != 0) {
270 goto err_out_unregister_bus
;
275 err_out_unregister_bus
:
276 mdiobus_unregister(bp
->mii_bus
);
277 err_out_free_mdio_irq
:
278 kfree(bp
->mii_bus
->irq
);
279 err_out_free_mdiobus
:
280 mdiobus_free(bp
->mii_bus
);
285 static void macb_update_stats(struct macb
*bp
)
287 u32 __iomem
*reg
= bp
->regs
+ MACB_PFR
;
288 u32
*p
= &bp
->hw_stats
.macb
.rx_pause_frames
;
289 u32
*end
= &bp
->hw_stats
.macb
.tx_pause_frames
+ 1;
291 WARN_ON((unsigned long)(end
- p
- 1) != (MACB_TPF
- MACB_PFR
) / 4);
293 for(; p
< end
; p
++, reg
++)
294 *p
+= __raw_readl(reg
);
297 static void macb_tx(struct macb
*bp
)
303 status
= macb_readl(bp
, TSR
);
304 macb_writel(bp
, TSR
, status
);
306 netdev_dbg(bp
->dev
, "macb_tx status = %02lx\n", (unsigned long)status
);
308 if (status
& (MACB_BIT(UND
) | MACB_BIT(TSR_RLE
))) {
310 netdev_err(bp
->dev
, "TX %s, resetting buffers\n",
311 status
& MACB_BIT(UND
) ?
312 "underrun" : "retry limit exceeded");
314 /* Transfer ongoing, disable transmitter, to avoid confusion */
315 if (status
& MACB_BIT(TGO
))
316 macb_writel(bp
, NCR
, macb_readl(bp
, NCR
) & ~MACB_BIT(TE
));
320 /*Mark all the buffer as used to avoid sending a lost buffer*/
321 for (i
= 0; i
< TX_RING_SIZE
; i
++)
322 bp
->tx_ring
[i
].ctrl
= MACB_BIT(TX_USED
);
325 bp
->tx_ring
[TX_RING_SIZE
- 1].ctrl
|= MACB_BIT(TX_WRAP
);
327 /* free transmit buffer in upper layer*/
328 for (tail
= bp
->tx_tail
; tail
!= head
; tail
= NEXT_TX(tail
)) {
329 struct ring_info
*rp
= &bp
->tx_skb
[tail
];
330 struct sk_buff
*skb
= rp
->skb
;
336 dma_unmap_single(&bp
->pdev
->dev
, rp
->mapping
, skb
->len
,
339 dev_kfree_skb_irq(skb
);
342 bp
->tx_head
= bp
->tx_tail
= 0;
344 /* Enable the transmitter again */
345 if (status
& MACB_BIT(TGO
))
346 macb_writel(bp
, NCR
, macb_readl(bp
, NCR
) | MACB_BIT(TE
));
349 if (!(status
& MACB_BIT(COMP
)))
351 * This may happen when a buffer becomes complete
352 * between reading the ISR and scanning the
353 * descriptors. Nothing to worry about.
358 for (tail
= bp
->tx_tail
; tail
!= head
; tail
= NEXT_TX(tail
)) {
359 struct ring_info
*rp
= &bp
->tx_skb
[tail
];
360 struct sk_buff
*skb
= rp
->skb
;
366 bufstat
= bp
->tx_ring
[tail
].ctrl
;
368 if (!(bufstat
& MACB_BIT(TX_USED
)))
371 netdev_dbg(bp
->dev
, "skb %u (data %p) TX complete\n",
373 dma_unmap_single(&bp
->pdev
->dev
, rp
->mapping
, skb
->len
,
375 bp
->stats
.tx_packets
++;
376 bp
->stats
.tx_bytes
+= skb
->len
;
378 dev_kfree_skb_irq(skb
);
382 if (netif_queue_stopped(bp
->dev
) &&
383 TX_BUFFS_AVAIL(bp
) > MACB_TX_WAKEUP_THRESH
)
384 netif_wake_queue(bp
->dev
);
387 static int macb_rx_frame(struct macb
*bp
, unsigned int first_frag
,
388 unsigned int last_frag
)
392 unsigned int offset
= 0;
395 len
= MACB_BFEXT(RX_FRMLEN
, bp
->rx_ring
[last_frag
].ctrl
);
397 netdev_dbg(bp
->dev
, "macb_rx_frame frags %u - %u (len %u)\n",
398 first_frag
, last_frag
, len
);
400 skb
= netdev_alloc_skb(bp
->dev
, len
+ RX_OFFSET
);
402 bp
->stats
.rx_dropped
++;
403 for (frag
= first_frag
; ; frag
= NEXT_RX(frag
)) {
404 bp
->rx_ring
[frag
].addr
&= ~MACB_BIT(RX_USED
);
405 if (frag
== last_frag
)
412 skb_reserve(skb
, RX_OFFSET
);
413 skb_checksum_none_assert(skb
);
416 for (frag
= first_frag
; ; frag
= NEXT_RX(frag
)) {
417 unsigned int frag_len
= RX_BUFFER_SIZE
;
419 if (offset
+ frag_len
> len
) {
420 BUG_ON(frag
!= last_frag
);
421 frag_len
= len
- offset
;
423 skb_copy_to_linear_data_offset(skb
, offset
,
425 (RX_BUFFER_SIZE
* frag
)),
427 offset
+= RX_BUFFER_SIZE
;
428 bp
->rx_ring
[frag
].addr
&= ~MACB_BIT(RX_USED
);
431 if (frag
== last_frag
)
435 skb
->protocol
= eth_type_trans(skb
, bp
->dev
);
437 bp
->stats
.rx_packets
++;
438 bp
->stats
.rx_bytes
+= len
;
439 netdev_dbg(bp
->dev
, "received skb of length %u, csum: %08x\n",
440 skb
->len
, skb
->csum
);
441 netif_receive_skb(skb
);
446 /* Mark DMA descriptors from begin up to and not including end as unused */
447 static void discard_partial_frame(struct macb
*bp
, unsigned int begin
,
452 for (frag
= begin
; frag
!= end
; frag
= NEXT_RX(frag
))
453 bp
->rx_ring
[frag
].addr
&= ~MACB_BIT(RX_USED
);
457 * When this happens, the hardware stats registers for
458 * whatever caused this is updated, so we don't have to record
463 static int macb_rx(struct macb
*bp
, int budget
)
466 unsigned int tail
= bp
->rx_tail
;
469 for (; budget
> 0; tail
= NEXT_RX(tail
)) {
473 addr
= bp
->rx_ring
[tail
].addr
;
474 ctrl
= bp
->rx_ring
[tail
].ctrl
;
476 if (!(addr
& MACB_BIT(RX_USED
)))
479 if (ctrl
& MACB_BIT(RX_SOF
)) {
480 if (first_frag
!= -1)
481 discard_partial_frame(bp
, first_frag
, tail
);
485 if (ctrl
& MACB_BIT(RX_EOF
)) {
487 BUG_ON(first_frag
== -1);
489 dropped
= macb_rx_frame(bp
, first_frag
, tail
);
498 if (first_frag
!= -1)
499 bp
->rx_tail
= first_frag
;
506 static int macb_poll(struct napi_struct
*napi
, int budget
)
508 struct macb
*bp
= container_of(napi
, struct macb
, napi
);
512 status
= macb_readl(bp
, RSR
);
513 macb_writel(bp
, RSR
, status
);
517 netdev_dbg(bp
->dev
, "poll: status = %08lx, budget = %d\n",
518 (unsigned long)status
, budget
);
520 work_done
= macb_rx(bp
, budget
);
521 if (work_done
< budget
) {
525 * We've done what we can to clean the buffers. Make sure we
526 * get notified when new packets arrive.
528 macb_writel(bp
, IER
, MACB_RX_INT_FLAGS
);
531 /* TODO: Handle errors */
536 static irqreturn_t
macb_interrupt(int irq
, void *dev_id
)
538 struct net_device
*dev
= dev_id
;
539 struct macb
*bp
= netdev_priv(dev
);
542 status
= macb_readl(bp
, ISR
);
544 if (unlikely(!status
))
547 spin_lock(&bp
->lock
);
550 /* close possible race with dev_close */
551 if (unlikely(!netif_running(dev
))) {
552 macb_writel(bp
, IDR
, ~0UL);
556 if (status
& MACB_RX_INT_FLAGS
) {
558 * There's no point taking any more interrupts
559 * until we have processed the buffers. The
560 * scheduling call may fail if the poll routine
561 * is already scheduled, so disable interrupts
564 macb_writel(bp
, IDR
, MACB_RX_INT_FLAGS
);
566 if (napi_schedule_prep(&bp
->napi
)) {
567 netdev_dbg(bp
->dev
, "scheduling RX softirq\n");
568 __napi_schedule(&bp
->napi
);
572 if (status
& (MACB_BIT(TCOMP
) | MACB_BIT(ISR_TUND
) |
577 * Link change detection isn't possible with RMII, so we'll
578 * add that if/when we get our hands on a full-blown MII PHY.
581 if (status
& MACB_BIT(ISR_ROVR
)) {
582 /* We missed at least one packet */
584 bp
->hw_stats
.gem
.rx_overruns
++;
586 bp
->hw_stats
.macb
.rx_overruns
++;
589 if (status
& MACB_BIT(HRESP
)) {
591 * TODO: Reset the hardware, and maybe move the
592 * netdev_err to a lower-priority context as well
595 netdev_err(dev
, "DMA bus error: HRESP not OK\n");
598 status
= macb_readl(bp
, ISR
);
601 spin_unlock(&bp
->lock
);
606 #ifdef CONFIG_NET_POLL_CONTROLLER
608 * Polling receive - used by netconsole and other diagnostic tools
609 * to allow network i/o with interrupts disabled.
611 static void macb_poll_controller(struct net_device
*dev
)
615 local_irq_save(flags
);
616 macb_interrupt(dev
->irq
, dev
);
617 local_irq_restore(flags
);
621 static int macb_start_xmit(struct sk_buff
*skb
, struct net_device
*dev
)
623 struct macb
*bp
= netdev_priv(dev
);
625 unsigned int len
, entry
;
631 "start_xmit: len %u head %p data %p tail %p end %p\n",
632 skb
->len
, skb
->head
, skb
->data
,
633 skb_tail_pointer(skb
), skb_end_pointer(skb
));
634 print_hex_dump(KERN_DEBUG
, "data: ", DUMP_PREFIX_OFFSET
, 16, 1,
635 skb
->data
, 16, true);
639 spin_lock_irqsave(&bp
->lock
, flags
);
641 /* This is a hard error, log it. */
642 if (TX_BUFFS_AVAIL(bp
) < 1) {
643 netif_stop_queue(dev
);
644 spin_unlock_irqrestore(&bp
->lock
, flags
);
645 netdev_err(bp
->dev
, "BUG! Tx Ring full when queue awake!\n");
646 netdev_dbg(bp
->dev
, "tx_head = %u, tx_tail = %u\n",
647 bp
->tx_head
, bp
->tx_tail
);
648 return NETDEV_TX_BUSY
;
652 netdev_dbg(bp
->dev
, "Allocated ring entry %u\n", entry
);
653 mapping
= dma_map_single(&bp
->pdev
->dev
, skb
->data
,
655 bp
->tx_skb
[entry
].skb
= skb
;
656 bp
->tx_skb
[entry
].mapping
= mapping
;
657 netdev_dbg(bp
->dev
, "Mapped skb data %p to DMA addr %08lx\n",
658 skb
->data
, (unsigned long)mapping
);
660 ctrl
= MACB_BF(TX_FRMLEN
, len
);
661 ctrl
|= MACB_BIT(TX_LAST
);
662 if (entry
== (TX_RING_SIZE
- 1))
663 ctrl
|= MACB_BIT(TX_WRAP
);
665 bp
->tx_ring
[entry
].addr
= mapping
;
666 bp
->tx_ring
[entry
].ctrl
= ctrl
;
669 entry
= NEXT_TX(entry
);
672 skb_tx_timestamp(skb
);
674 macb_writel(bp
, NCR
, macb_readl(bp
, NCR
) | MACB_BIT(TSTART
));
676 if (TX_BUFFS_AVAIL(bp
) < 1)
677 netif_stop_queue(dev
);
679 spin_unlock_irqrestore(&bp
->lock
, flags
);
684 static void macb_free_consistent(struct macb
*bp
)
691 dma_free_coherent(&bp
->pdev
->dev
, RX_RING_BYTES
,
692 bp
->rx_ring
, bp
->rx_ring_dma
);
696 dma_free_coherent(&bp
->pdev
->dev
, TX_RING_BYTES
,
697 bp
->tx_ring
, bp
->tx_ring_dma
);
700 if (bp
->rx_buffers
) {
701 dma_free_coherent(&bp
->pdev
->dev
,
702 RX_RING_SIZE
* RX_BUFFER_SIZE
,
703 bp
->rx_buffers
, bp
->rx_buffers_dma
);
704 bp
->rx_buffers
= NULL
;
708 static int macb_alloc_consistent(struct macb
*bp
)
712 size
= TX_RING_SIZE
* sizeof(struct ring_info
);
713 bp
->tx_skb
= kmalloc(size
, GFP_KERNEL
);
717 size
= RX_RING_BYTES
;
718 bp
->rx_ring
= dma_alloc_coherent(&bp
->pdev
->dev
, size
,
719 &bp
->rx_ring_dma
, GFP_KERNEL
);
723 "Allocated RX ring of %d bytes at %08lx (mapped %p)\n",
724 size
, (unsigned long)bp
->rx_ring_dma
, bp
->rx_ring
);
726 size
= TX_RING_BYTES
;
727 bp
->tx_ring
= dma_alloc_coherent(&bp
->pdev
->dev
, size
,
728 &bp
->tx_ring_dma
, GFP_KERNEL
);
732 "Allocated TX ring of %d bytes at %08lx (mapped %p)\n",
733 size
, (unsigned long)bp
->tx_ring_dma
, bp
->tx_ring
);
735 size
= RX_RING_SIZE
* RX_BUFFER_SIZE
;
736 bp
->rx_buffers
= dma_alloc_coherent(&bp
->pdev
->dev
, size
,
737 &bp
->rx_buffers_dma
, GFP_KERNEL
);
741 "Allocated RX buffers of %d bytes at %08lx (mapped %p)\n",
742 size
, (unsigned long)bp
->rx_buffers_dma
, bp
->rx_buffers
);
747 macb_free_consistent(bp
);
751 static void macb_init_rings(struct macb
*bp
)
756 addr
= bp
->rx_buffers_dma
;
757 for (i
= 0; i
< RX_RING_SIZE
; i
++) {
758 bp
->rx_ring
[i
].addr
= addr
;
759 bp
->rx_ring
[i
].ctrl
= 0;
760 addr
+= RX_BUFFER_SIZE
;
762 bp
->rx_ring
[RX_RING_SIZE
- 1].addr
|= MACB_BIT(RX_WRAP
);
764 for (i
= 0; i
< TX_RING_SIZE
; i
++) {
765 bp
->tx_ring
[i
].addr
= 0;
766 bp
->tx_ring
[i
].ctrl
= MACB_BIT(TX_USED
);
768 bp
->tx_ring
[TX_RING_SIZE
- 1].ctrl
|= MACB_BIT(TX_WRAP
);
770 bp
->rx_tail
= bp
->tx_head
= bp
->tx_tail
= 0;
773 static void macb_reset_hw(struct macb
*bp
)
775 /* Make sure we have the write buffer for ourselves */
779 * Disable RX and TX (XXX: Should we halt the transmission
782 macb_writel(bp
, NCR
, 0);
784 /* Clear the stats registers (XXX: Update stats first?) */
785 macb_writel(bp
, NCR
, MACB_BIT(CLRSTAT
));
787 /* Clear all status flags */
788 macb_writel(bp
, TSR
, ~0UL);
789 macb_writel(bp
, RSR
, ~0UL);
791 /* Disable all interrupts */
792 macb_writel(bp
, IDR
, ~0UL);
796 static u32
gem_mdc_clk_div(struct macb
*bp
)
799 unsigned long pclk_hz
= clk_get_rate(bp
->pclk
);
801 if (pclk_hz
<= 20000000)
802 config
= GEM_BF(CLK
, GEM_CLK_DIV8
);
803 else if (pclk_hz
<= 40000000)
804 config
= GEM_BF(CLK
, GEM_CLK_DIV16
);
805 else if (pclk_hz
<= 80000000)
806 config
= GEM_BF(CLK
, GEM_CLK_DIV32
);
807 else if (pclk_hz
<= 120000000)
808 config
= GEM_BF(CLK
, GEM_CLK_DIV48
);
809 else if (pclk_hz
<= 160000000)
810 config
= GEM_BF(CLK
, GEM_CLK_DIV64
);
812 config
= GEM_BF(CLK
, GEM_CLK_DIV96
);
817 static u32
macb_mdc_clk_div(struct macb
*bp
)
820 unsigned long pclk_hz
;
823 return gem_mdc_clk_div(bp
);
825 pclk_hz
= clk_get_rate(bp
->pclk
);
826 if (pclk_hz
<= 20000000)
827 config
= MACB_BF(CLK
, MACB_CLK_DIV8
);
828 else if (pclk_hz
<= 40000000)
829 config
= MACB_BF(CLK
, MACB_CLK_DIV16
);
830 else if (pclk_hz
<= 80000000)
831 config
= MACB_BF(CLK
, MACB_CLK_DIV32
);
833 config
= MACB_BF(CLK
, MACB_CLK_DIV64
);
839 * Get the DMA bus width field of the network configuration register that we
840 * should program. We find the width from decoding the design configuration
841 * register to find the maximum supported data bus width.
843 static u32
macb_dbw(struct macb
*bp
)
845 if (!macb_is_gem(bp
))
848 switch (GEM_BFEXT(DBWDEF
, gem_readl(bp
, DCFG1
))) {
850 return GEM_BF(DBW
, GEM_DBW128
);
852 return GEM_BF(DBW
, GEM_DBW64
);
855 return GEM_BF(DBW
, GEM_DBW32
);
860 * Configure the receive DMA engine to use the correct receive buffer size.
861 * This is a configurable parameter for GEM.
863 static void macb_configure_dma(struct macb
*bp
)
867 if (macb_is_gem(bp
)) {
868 dmacfg
= gem_readl(bp
, DMACFG
) & ~GEM_BF(RXBS
, -1L);
869 dmacfg
|= GEM_BF(RXBS
, RX_BUFFER_SIZE
/ 64);
870 gem_writel(bp
, DMACFG
, dmacfg
);
874 static void macb_init_hw(struct macb
*bp
)
879 __macb_set_hwaddr(bp
);
881 config
= macb_mdc_clk_div(bp
);
882 config
|= MACB_BIT(PAE
); /* PAuse Enable */
883 config
|= MACB_BIT(DRFCS
); /* Discard Rx FCS */
884 config
|= MACB_BIT(BIG
); /* Receive oversized frames */
885 if (bp
->dev
->flags
& IFF_PROMISC
)
886 config
|= MACB_BIT(CAF
); /* Copy All Frames */
887 if (!(bp
->dev
->flags
& IFF_BROADCAST
))
888 config
|= MACB_BIT(NBC
); /* No BroadCast */
889 config
|= macb_dbw(bp
);
890 macb_writel(bp
, NCFGR
, config
);
892 macb_configure_dma(bp
);
894 /* Initialize TX and RX buffers */
895 macb_writel(bp
, RBQP
, bp
->rx_ring_dma
);
896 macb_writel(bp
, TBQP
, bp
->tx_ring_dma
);
898 /* Enable TX and RX */
899 macb_writel(bp
, NCR
, MACB_BIT(RE
) | MACB_BIT(TE
) | MACB_BIT(MPE
));
901 /* Enable interrupts */
902 macb_writel(bp
, IER
, (MACB_BIT(RCOMP
)
914 * The hash address register is 64 bits long and takes up two
915 * locations in the memory map. The least significant bits are stored
916 * in EMAC_HSL and the most significant bits in EMAC_HSH.
918 * The unicast hash enable and the multicast hash enable bits in the
919 * network configuration register enable the reception of hash matched
920 * frames. The destination address is reduced to a 6 bit index into
921 * the 64 bit hash register using the following hash function. The
922 * hash function is an exclusive or of every sixth bit of the
923 * destination address.
925 * hi[5] = da[5] ^ da[11] ^ da[17] ^ da[23] ^ da[29] ^ da[35] ^ da[41] ^ da[47]
926 * hi[4] = da[4] ^ da[10] ^ da[16] ^ da[22] ^ da[28] ^ da[34] ^ da[40] ^ da[46]
927 * hi[3] = da[3] ^ da[09] ^ da[15] ^ da[21] ^ da[27] ^ da[33] ^ da[39] ^ da[45]
928 * hi[2] = da[2] ^ da[08] ^ da[14] ^ da[20] ^ da[26] ^ da[32] ^ da[38] ^ da[44]
929 * hi[1] = da[1] ^ da[07] ^ da[13] ^ da[19] ^ da[25] ^ da[31] ^ da[37] ^ da[43]
930 * hi[0] = da[0] ^ da[06] ^ da[12] ^ da[18] ^ da[24] ^ da[30] ^ da[36] ^ da[42]
932 * da[0] represents the least significant bit of the first byte
933 * received, that is, the multicast/unicast indicator, and da[47]
934 * represents the most significant bit of the last byte received. If
935 * the hash index, hi[n], points to a bit that is set in the hash
936 * register then the frame will be matched according to whether the
937 * frame is multicast or unicast. A multicast match will be signalled
938 * if the multicast hash enable bit is set, da[0] is 1 and the hash
939 * index points to a bit set in the hash register. A unicast match
940 * will be signalled if the unicast hash enable bit is set, da[0] is 0
941 * and the hash index points to a bit set in the hash register. To
942 * receive all multicast frames, the hash register should be set with
943 * all ones and the multicast hash enable bit should be set in the
944 * network configuration register.
947 static inline int hash_bit_value(int bitnr
, __u8
*addr
)
949 if (addr
[bitnr
/ 8] & (1 << (bitnr
% 8)))
955 * Return the hash index value for the specified address.
957 static int hash_get_index(__u8
*addr
)
962 for (j
= 0; j
< 6; j
++) {
963 for (i
= 0, bitval
= 0; i
< 8; i
++)
964 bitval
^= hash_bit_value(i
*6 + j
, addr
);
966 hash_index
|= (bitval
<< j
);
973 * Add multicast addresses to the internal multicast-hash table.
975 static void macb_sethashtable(struct net_device
*dev
)
977 struct netdev_hw_addr
*ha
;
978 unsigned long mc_filter
[2];
980 struct macb
*bp
= netdev_priv(dev
);
982 mc_filter
[0] = mc_filter
[1] = 0;
984 netdev_for_each_mc_addr(ha
, dev
) {
985 bitnr
= hash_get_index(ha
->addr
);
986 mc_filter
[bitnr
>> 5] |= 1 << (bitnr
& 31);
989 macb_or_gem_writel(bp
, HRB
, mc_filter
[0]);
990 macb_or_gem_writel(bp
, HRT
, mc_filter
[1]);
994 * Enable/Disable promiscuous and multicast modes.
996 static void macb_set_rx_mode(struct net_device
*dev
)
999 struct macb
*bp
= netdev_priv(dev
);
1001 cfg
= macb_readl(bp
, NCFGR
);
1003 if (dev
->flags
& IFF_PROMISC
)
1004 /* Enable promiscuous mode */
1005 cfg
|= MACB_BIT(CAF
);
1006 else if (dev
->flags
& (~IFF_PROMISC
))
1007 /* Disable promiscuous mode */
1008 cfg
&= ~MACB_BIT(CAF
);
1010 if (dev
->flags
& IFF_ALLMULTI
) {
1011 /* Enable all multicast mode */
1012 macb_or_gem_writel(bp
, HRB
, -1);
1013 macb_or_gem_writel(bp
, HRT
, -1);
1014 cfg
|= MACB_BIT(NCFGR_MTI
);
1015 } else if (!netdev_mc_empty(dev
)) {
1016 /* Enable specific multicasts */
1017 macb_sethashtable(dev
);
1018 cfg
|= MACB_BIT(NCFGR_MTI
);
1019 } else if (dev
->flags
& (~IFF_ALLMULTI
)) {
1020 /* Disable all multicast mode */
1021 macb_or_gem_writel(bp
, HRB
, 0);
1022 macb_or_gem_writel(bp
, HRT
, 0);
1023 cfg
&= ~MACB_BIT(NCFGR_MTI
);
1026 macb_writel(bp
, NCFGR
, cfg
);
1029 static int macb_open(struct net_device
*dev
)
1031 struct macb
*bp
= netdev_priv(dev
);
1034 netdev_dbg(bp
->dev
, "open\n");
1036 /* if the phy is not yet register, retry later*/
1040 if (!is_valid_ether_addr(dev
->dev_addr
))
1041 return -EADDRNOTAVAIL
;
1043 err
= macb_alloc_consistent(bp
);
1045 netdev_err(dev
, "Unable to allocate DMA memory (error %d)\n",
1050 napi_enable(&bp
->napi
);
1052 macb_init_rings(bp
);
1055 /* schedule a link state check */
1056 phy_start(bp
->phy_dev
);
1058 netif_start_queue(dev
);
1063 static int macb_close(struct net_device
*dev
)
1065 struct macb
*bp
= netdev_priv(dev
);
1066 unsigned long flags
;
1068 netif_stop_queue(dev
);
1069 napi_disable(&bp
->napi
);
1072 phy_stop(bp
->phy_dev
);
1074 spin_lock_irqsave(&bp
->lock
, flags
);
1076 netif_carrier_off(dev
);
1077 spin_unlock_irqrestore(&bp
->lock
, flags
);
1079 macb_free_consistent(bp
);
1084 static void gem_update_stats(struct macb
*bp
)
1086 u32 __iomem
*reg
= bp
->regs
+ GEM_OTX
;
1087 u32
*p
= &bp
->hw_stats
.gem
.tx_octets_31_0
;
1088 u32
*end
= &bp
->hw_stats
.gem
.rx_udp_checksum_errors
+ 1;
1090 for (; p
< end
; p
++, reg
++)
1091 *p
+= __raw_readl(reg
);
1094 static struct net_device_stats
*gem_get_stats(struct macb
*bp
)
1096 struct gem_stats
*hwstat
= &bp
->hw_stats
.gem
;
1097 struct net_device_stats
*nstat
= &bp
->stats
;
1099 gem_update_stats(bp
);
1101 nstat
->rx_errors
= (hwstat
->rx_frame_check_sequence_errors
+
1102 hwstat
->rx_alignment_errors
+
1103 hwstat
->rx_resource_errors
+
1104 hwstat
->rx_overruns
+
1105 hwstat
->rx_oversize_frames
+
1106 hwstat
->rx_jabbers
+
1107 hwstat
->rx_undersized_frames
+
1108 hwstat
->rx_length_field_frame_errors
);
1109 nstat
->tx_errors
= (hwstat
->tx_late_collisions
+
1110 hwstat
->tx_excessive_collisions
+
1111 hwstat
->tx_underrun
+
1112 hwstat
->tx_carrier_sense_errors
);
1113 nstat
->multicast
= hwstat
->rx_multicast_frames
;
1114 nstat
->collisions
= (hwstat
->tx_single_collision_frames
+
1115 hwstat
->tx_multiple_collision_frames
+
1116 hwstat
->tx_excessive_collisions
);
1117 nstat
->rx_length_errors
= (hwstat
->rx_oversize_frames
+
1118 hwstat
->rx_jabbers
+
1119 hwstat
->rx_undersized_frames
+
1120 hwstat
->rx_length_field_frame_errors
);
1121 nstat
->rx_over_errors
= hwstat
->rx_resource_errors
;
1122 nstat
->rx_crc_errors
= hwstat
->rx_frame_check_sequence_errors
;
1123 nstat
->rx_frame_errors
= hwstat
->rx_alignment_errors
;
1124 nstat
->rx_fifo_errors
= hwstat
->rx_overruns
;
1125 nstat
->tx_aborted_errors
= hwstat
->tx_excessive_collisions
;
1126 nstat
->tx_carrier_errors
= hwstat
->tx_carrier_sense_errors
;
1127 nstat
->tx_fifo_errors
= hwstat
->tx_underrun
;
1132 static struct net_device_stats
*macb_get_stats(struct net_device
*dev
)
1134 struct macb
*bp
= netdev_priv(dev
);
1135 struct net_device_stats
*nstat
= &bp
->stats
;
1136 struct macb_stats
*hwstat
= &bp
->hw_stats
.macb
;
1138 if (macb_is_gem(bp
))
1139 return gem_get_stats(bp
);
1141 /* read stats from hardware */
1142 macb_update_stats(bp
);
1144 /* Convert HW stats into netdevice stats */
1145 nstat
->rx_errors
= (hwstat
->rx_fcs_errors
+
1146 hwstat
->rx_align_errors
+
1147 hwstat
->rx_resource_errors
+
1148 hwstat
->rx_overruns
+
1149 hwstat
->rx_oversize_pkts
+
1150 hwstat
->rx_jabbers
+
1151 hwstat
->rx_undersize_pkts
+
1152 hwstat
->sqe_test_errors
+
1153 hwstat
->rx_length_mismatch
);
1154 nstat
->tx_errors
= (hwstat
->tx_late_cols
+
1155 hwstat
->tx_excessive_cols
+
1156 hwstat
->tx_underruns
+
1157 hwstat
->tx_carrier_errors
);
1158 nstat
->collisions
= (hwstat
->tx_single_cols
+
1159 hwstat
->tx_multiple_cols
+
1160 hwstat
->tx_excessive_cols
);
1161 nstat
->rx_length_errors
= (hwstat
->rx_oversize_pkts
+
1162 hwstat
->rx_jabbers
+
1163 hwstat
->rx_undersize_pkts
+
1164 hwstat
->rx_length_mismatch
);
1165 nstat
->rx_over_errors
= hwstat
->rx_resource_errors
+
1166 hwstat
->rx_overruns
;
1167 nstat
->rx_crc_errors
= hwstat
->rx_fcs_errors
;
1168 nstat
->rx_frame_errors
= hwstat
->rx_align_errors
;
1169 nstat
->rx_fifo_errors
= hwstat
->rx_overruns
;
1170 /* XXX: What does "missed" mean? */
1171 nstat
->tx_aborted_errors
= hwstat
->tx_excessive_cols
;
1172 nstat
->tx_carrier_errors
= hwstat
->tx_carrier_errors
;
1173 nstat
->tx_fifo_errors
= hwstat
->tx_underruns
;
1174 /* Don't know about heartbeat or window errors... */
1179 static int macb_get_settings(struct net_device
*dev
, struct ethtool_cmd
*cmd
)
1181 struct macb
*bp
= netdev_priv(dev
);
1182 struct phy_device
*phydev
= bp
->phy_dev
;
1187 return phy_ethtool_gset(phydev
, cmd
);
1190 static int macb_set_settings(struct net_device
*dev
, struct ethtool_cmd
*cmd
)
1192 struct macb
*bp
= netdev_priv(dev
);
1193 struct phy_device
*phydev
= bp
->phy_dev
;
1198 return phy_ethtool_sset(phydev
, cmd
);
1201 static void macb_get_drvinfo(struct net_device
*dev
,
1202 struct ethtool_drvinfo
*info
)
1204 struct macb
*bp
= netdev_priv(dev
);
1206 strcpy(info
->driver
, bp
->pdev
->dev
.driver
->name
);
1207 strcpy(info
->version
, "$Revision: 1.14 $");
1208 strcpy(info
->bus_info
, dev_name(&bp
->pdev
->dev
));
1211 static const struct ethtool_ops macb_ethtool_ops
= {
1212 .get_settings
= macb_get_settings
,
1213 .set_settings
= macb_set_settings
,
1214 .get_drvinfo
= macb_get_drvinfo
,
1215 .get_link
= ethtool_op_get_link
,
1218 static int macb_ioctl(struct net_device
*dev
, struct ifreq
*rq
, int cmd
)
1220 struct macb
*bp
= netdev_priv(dev
);
1221 struct phy_device
*phydev
= bp
->phy_dev
;
1223 if (!netif_running(dev
))
1229 return phy_mii_ioctl(phydev
, rq
, cmd
);
1232 static const struct net_device_ops macb_netdev_ops
= {
1233 .ndo_open
= macb_open
,
1234 .ndo_stop
= macb_close
,
1235 .ndo_start_xmit
= macb_start_xmit
,
1236 .ndo_set_rx_mode
= macb_set_rx_mode
,
1237 .ndo_get_stats
= macb_get_stats
,
1238 .ndo_do_ioctl
= macb_ioctl
,
1239 .ndo_validate_addr
= eth_validate_addr
,
1240 .ndo_change_mtu
= eth_change_mtu
,
1241 .ndo_set_mac_address
= eth_mac_addr
,
1242 #ifdef CONFIG_NET_POLL_CONTROLLER
1243 .ndo_poll_controller
= macb_poll_controller
,
1247 #if defined(CONFIG_OF)
1248 static const struct of_device_id macb_dt_ids
[] = {
1249 { .compatible
= "cdns,at32ap7000-macb" },
1250 { .compatible
= "cdns,at91sam9260-macb" },
1251 { .compatible
= "cdns,macb" },
1252 { .compatible
= "cdns,pc302-gem" },
1253 { .compatible
= "cdns,gem" },
1257 MODULE_DEVICE_TABLE(of
, macb_dt_ids
);
1259 static int __devinit
macb_get_phy_mode_dt(struct platform_device
*pdev
)
1261 struct device_node
*np
= pdev
->dev
.of_node
;
1264 return of_get_phy_mode(np
);
1269 static int __devinit
macb_get_hwaddr_dt(struct macb
*bp
)
1271 struct device_node
*np
= bp
->pdev
->dev
.of_node
;
1273 const char *mac
= of_get_mac_address(np
);
1275 memcpy(bp
->dev
->dev_addr
, mac
, ETH_ALEN
);
1283 static int __devinit
macb_get_phy_mode_dt(struct platform_device
*pdev
)
1287 static int __devinit
macb_get_hwaddr_dt(struct macb
*bp
)
1293 static int __init
macb_probe(struct platform_device
*pdev
)
1295 struct macb_platform_data
*pdata
;
1296 struct resource
*regs
;
1297 struct net_device
*dev
;
1299 struct phy_device
*phydev
;
1303 regs
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
1305 dev_err(&pdev
->dev
, "no mmio resource defined\n");
1310 dev
= alloc_etherdev(sizeof(*bp
));
1314 SET_NETDEV_DEV(dev
, &pdev
->dev
);
1316 /* TODO: Actually, we have some interesting features... */
1319 bp
= netdev_priv(dev
);
1323 spin_lock_init(&bp
->lock
);
1325 bp
->pclk
= clk_get(&pdev
->dev
, "pclk");
1326 if (IS_ERR(bp
->pclk
)) {
1327 dev_err(&pdev
->dev
, "failed to get macb_clk\n");
1328 goto err_out_free_dev
;
1330 clk_enable(bp
->pclk
);
1332 bp
->hclk
= clk_get(&pdev
->dev
, "hclk");
1333 if (IS_ERR(bp
->hclk
)) {
1334 dev_err(&pdev
->dev
, "failed to get hclk\n");
1335 goto err_out_put_pclk
;
1337 clk_enable(bp
->hclk
);
1339 bp
->regs
= ioremap(regs
->start
, resource_size(regs
));
1341 dev_err(&pdev
->dev
, "failed to map registers, aborting.\n");
1343 goto err_out_disable_clocks
;
1346 dev
->irq
= platform_get_irq(pdev
, 0);
1347 err
= request_irq(dev
->irq
, macb_interrupt
, 0, dev
->name
, dev
);
1349 dev_err(&pdev
->dev
, "Unable to request IRQ %d (error %d)\n",
1351 goto err_out_iounmap
;
1354 dev
->netdev_ops
= &macb_netdev_ops
;
1355 netif_napi_add(dev
, &bp
->napi
, macb_poll
, 64);
1356 dev
->ethtool_ops
= &macb_ethtool_ops
;
1358 dev
->base_addr
= regs
->start
;
1360 /* Set MII management clock divider */
1361 config
= macb_mdc_clk_div(bp
);
1362 config
|= macb_dbw(bp
);
1363 macb_writel(bp
, NCFGR
, config
);
1365 err
= macb_get_hwaddr_dt(bp
);
1367 macb_get_hwaddr(bp
);
1369 err
= macb_get_phy_mode_dt(pdev
);
1371 pdata
= pdev
->dev
.platform_data
;
1372 if (pdata
&& pdata
->is_rmii
)
1373 bp
->phy_interface
= PHY_INTERFACE_MODE_RMII
;
1375 bp
->phy_interface
= PHY_INTERFACE_MODE_MII
;
1377 bp
->phy_interface
= err
;
1380 if (bp
->phy_interface
== PHY_INTERFACE_MODE_RMII
)
1381 #if defined(CONFIG_ARCH_AT91)
1382 macb_or_gem_writel(bp
, USRIO
, (MACB_BIT(RMII
) |
1385 macb_or_gem_writel(bp
, USRIO
, 0);
1388 #if defined(CONFIG_ARCH_AT91)
1389 macb_or_gem_writel(bp
, USRIO
, MACB_BIT(CLKEN
));
1391 macb_or_gem_writel(bp
, USRIO
, MACB_BIT(MII
));
1394 bp
->tx_pending
= DEF_TX_RING_PENDING
;
1396 err
= register_netdev(dev
);
1398 dev_err(&pdev
->dev
, "Cannot register net device, aborting.\n");
1399 goto err_out_free_irq
;
1402 if (macb_mii_init(bp
) != 0) {
1403 goto err_out_unregister_netdev
;
1406 platform_set_drvdata(pdev
, dev
);
1408 netdev_info(dev
, "Cadence %s at 0x%08lx irq %d (%pM)\n",
1409 macb_is_gem(bp
) ? "GEM" : "MACB", dev
->base_addr
,
1410 dev
->irq
, dev
->dev_addr
);
1412 phydev
= bp
->phy_dev
;
1413 netdev_info(dev
, "attached PHY driver [%s] (mii_bus:phy_addr=%s, irq=%d)\n",
1414 phydev
->drv
->name
, dev_name(&phydev
->dev
), phydev
->irq
);
1418 err_out_unregister_netdev
:
1419 unregister_netdev(dev
);
1421 free_irq(dev
->irq
, dev
);
1424 err_out_disable_clocks
:
1425 clk_disable(bp
->hclk
);
1427 clk_disable(bp
->pclk
);
1433 platform_set_drvdata(pdev
, NULL
);
1437 static int __exit
macb_remove(struct platform_device
*pdev
)
1439 struct net_device
*dev
;
1442 dev
= platform_get_drvdata(pdev
);
1445 bp
= netdev_priv(dev
);
1447 phy_disconnect(bp
->phy_dev
);
1448 mdiobus_unregister(bp
->mii_bus
);
1449 kfree(bp
->mii_bus
->irq
);
1450 mdiobus_free(bp
->mii_bus
);
1451 unregister_netdev(dev
);
1452 free_irq(dev
->irq
, dev
);
1454 clk_disable(bp
->hclk
);
1456 clk_disable(bp
->pclk
);
1459 platform_set_drvdata(pdev
, NULL
);
1466 static int macb_suspend(struct platform_device
*pdev
, pm_message_t state
)
1468 struct net_device
*netdev
= platform_get_drvdata(pdev
);
1469 struct macb
*bp
= netdev_priv(netdev
);
1471 netif_device_detach(netdev
);
1473 clk_disable(bp
->hclk
);
1474 clk_disable(bp
->pclk
);
1479 static int macb_resume(struct platform_device
*pdev
)
1481 struct net_device
*netdev
= platform_get_drvdata(pdev
);
1482 struct macb
*bp
= netdev_priv(netdev
);
1484 clk_enable(bp
->pclk
);
1485 clk_enable(bp
->hclk
);
1487 netif_device_attach(netdev
);
1492 #define macb_suspend NULL
1493 #define macb_resume NULL
1496 static struct platform_driver macb_driver
= {
1497 .remove
= __exit_p(macb_remove
),
1498 .suspend
= macb_suspend
,
1499 .resume
= macb_resume
,
1502 .owner
= THIS_MODULE
,
1503 .of_match_table
= of_match_ptr(macb_dt_ids
),
1507 static int __init
macb_init(void)
1509 return platform_driver_probe(&macb_driver
, macb_probe
);
1512 static void __exit
macb_exit(void)
1514 platform_driver_unregister(&macb_driver
);
1517 module_init(macb_init
);
1518 module_exit(macb_exit
);
1520 MODULE_LICENSE("GPL");
1521 MODULE_DESCRIPTION("Cadence MACB/GEM Ethernet driver");
1522 MODULE_AUTHOR("Haavard Skinnemoen (Atmel)");
1523 MODULE_ALIAS("platform:macb");