2 * Atmel MACB 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 #include <linux/clk.h>
12 #include <linux/module.h>
13 #include <linux/moduleparam.h>
14 #include <linux/kernel.h>
15 #include <linux/types.h>
16 #include <linux/slab.h>
17 #include <linux/init.h>
18 #include <linux/netdevice.h>
19 #include <linux/etherdevice.h>
20 #include <linux/dma-mapping.h>
21 #include <linux/platform_device.h>
22 #include <linux/phy.h>
24 #include <asm/arch/board.h>
25 #include <asm/arch/cpu.h>
29 #define RX_BUFFER_SIZE 128
30 #define RX_RING_SIZE 512
31 #define RX_RING_BYTES (sizeof(struct dma_desc) * RX_RING_SIZE)
33 /* Make the IP header word-aligned (the ethernet header is 14 bytes) */
36 #define TX_RING_SIZE 128
37 #define DEF_TX_RING_PENDING (TX_RING_SIZE - 1)
38 #define TX_RING_BYTES (sizeof(struct dma_desc) * TX_RING_SIZE)
40 #define TX_RING_GAP(bp) \
41 (TX_RING_SIZE - (bp)->tx_pending)
42 #define TX_BUFFS_AVAIL(bp) \
43 (((bp)->tx_tail <= (bp)->tx_head) ? \
44 (bp)->tx_tail + (bp)->tx_pending - (bp)->tx_head : \
45 (bp)->tx_tail - (bp)->tx_head - TX_RING_GAP(bp))
46 #define NEXT_TX(n) (((n) + 1) & (TX_RING_SIZE - 1))
48 #define NEXT_RX(n) (((n) + 1) & (RX_RING_SIZE - 1))
50 /* minimum number of free TX descriptors before waking up TX process */
51 #define MACB_TX_WAKEUP_THRESH (TX_RING_SIZE / 4)
53 #define MACB_RX_INT_FLAGS (MACB_BIT(RCOMP) | MACB_BIT(RXUBR) \
56 static void __macb_set_hwaddr(struct macb *bp)
61 bottom = cpu_to_le32(*((u32 *)bp->dev->dev_addr));
62 macb_writel(bp, SA1B, bottom);
63 top = cpu_to_le16(*((u16 *)(bp->dev->dev_addr + 4)));
64 macb_writel(bp, SA1T, top);
67 static void __init macb_get_hwaddr(struct macb *bp)
73 bottom = macb_readl(bp, SA1B);
74 top = macb_readl(bp, SA1T);
76 addr[0] = bottom & 0xff;
77 addr[1] = (bottom >> 8) & 0xff;
78 addr[2] = (bottom >> 16) & 0xff;
79 addr[3] = (bottom >> 24) & 0xff;
81 addr[5] = (top >> 8) & 0xff;
83 if (is_valid_ether_addr(addr)) {
84 memcpy(bp->dev->dev_addr, addr, sizeof(addr));
86 dev_info(&bp->pdev->dev, "invalid hw address, using random\n");
87 random_ether_addr(bp->dev->dev_addr);
91 static int macb_mdio_read(struct mii_bus *bus, int mii_id, int regnum)
93 struct macb *bp = bus->priv;
96 macb_writel(bp, MAN, (MACB_BF(SOF, MACB_MAN_SOF)
97 | MACB_BF(RW, MACB_MAN_READ)
98 | MACB_BF(PHYA, mii_id)
99 | MACB_BF(REGA, regnum)
100 | MACB_BF(CODE, MACB_MAN_CODE)));
102 /* wait for end of transfer */
103 while (!MACB_BFEXT(IDLE, macb_readl(bp, NSR)))
106 value = MACB_BFEXT(DATA, macb_readl(bp, MAN));
111 static int macb_mdio_write(struct mii_bus *bus, int mii_id, int regnum,
114 struct macb *bp = bus->priv;
116 macb_writel(bp, MAN, (MACB_BF(SOF, MACB_MAN_SOF)
117 | MACB_BF(RW, MACB_MAN_WRITE)
118 | MACB_BF(PHYA, mii_id)
119 | MACB_BF(REGA, regnum)
120 | MACB_BF(CODE, MACB_MAN_CODE)
121 | MACB_BF(DATA, value)));
123 /* wait for end of transfer */
124 while (!MACB_BFEXT(IDLE, macb_readl(bp, NSR)))
130 static int macb_mdio_reset(struct mii_bus *bus)
135 static void macb_handle_link_change(struct net_device *dev)
137 struct macb *bp = netdev_priv(dev);
138 struct phy_device *phydev = bp->phy_dev;
141 int status_change = 0;
143 spin_lock_irqsave(&bp->lock, flags);
146 if ((bp->speed != phydev->speed) ||
147 (bp->duplex != phydev->duplex)) {
150 reg = macb_readl(bp, NCFGR);
151 reg &= ~(MACB_BIT(SPD) | MACB_BIT(FD));
155 if (phydev->speed == SPEED_100)
156 reg |= MACB_BIT(SPD);
158 macb_writel(bp, NCFGR, reg);
160 bp->speed = phydev->speed;
161 bp->duplex = phydev->duplex;
166 if (phydev->link != bp->link) {
171 bp->link = phydev->link;
176 spin_unlock_irqrestore(&bp->lock, flags);
180 printk(KERN_INFO "%s: link up (%d/%s)\n",
181 dev->name, phydev->speed,
182 DUPLEX_FULL == phydev->duplex ? "Full":"Half");
184 printk(KERN_INFO "%s: link down\n", dev->name);
188 /* based on au1000_eth. c*/
189 static int macb_mii_probe(struct net_device *dev)
191 struct macb *bp = netdev_priv(dev);
192 struct phy_device *phydev = NULL;
193 struct eth_platform_data *pdata;
196 /* find the first phy */
197 for (phy_addr = 0; phy_addr < PHY_MAX_ADDR; phy_addr++) {
198 if (bp->mii_bus.phy_map[phy_addr]) {
199 phydev = bp->mii_bus.phy_map[phy_addr];
205 printk (KERN_ERR "%s: no PHY found\n", dev->name);
209 pdata = bp->pdev->dev.platform_data;
210 /* TODO : add pin_irq */
212 /* attach the mac to the phy */
213 if (pdata && pdata->is_rmii) {
214 phydev = phy_connect(dev, phydev->dev.bus_id,
215 &macb_handle_link_change, 0, PHY_INTERFACE_MODE_RMII);
217 phydev = phy_connect(dev, phydev->dev.bus_id,
218 &macb_handle_link_change, 0, PHY_INTERFACE_MODE_MII);
221 if (IS_ERR(phydev)) {
222 printk(KERN_ERR "%s: Could not attach to PHY\n", dev->name);
223 return PTR_ERR(phydev);
226 /* mask with MAC supported features */
227 phydev->supported &= PHY_BASIC_FEATURES;
229 phydev->advertising = phydev->supported;
234 bp->phy_dev = phydev;
239 static int macb_mii_init(struct macb *bp)
241 struct eth_platform_data *pdata;
244 /* Enable managment port */
245 macb_writel(bp, NCR, MACB_BIT(MPE));
247 bp->mii_bus.name = "MACB_mii_bus";
248 bp->mii_bus.read = &macb_mdio_read;
249 bp->mii_bus.write = &macb_mdio_write;
250 bp->mii_bus.reset = &macb_mdio_reset;
251 snprintf(bp->mii_bus.id, MII_BUS_ID_SIZE, "%x", bp->pdev->id);
252 bp->mii_bus.priv = bp;
253 bp->mii_bus.dev = &bp->dev->dev;
254 pdata = bp->pdev->dev.platform_data;
257 bp->mii_bus.phy_mask = pdata->phy_mask;
259 bp->mii_bus.irq = kmalloc(sizeof(int)*PHY_MAX_ADDR, GFP_KERNEL);
260 if (!bp->mii_bus.irq) {
265 for (i = 0; i < PHY_MAX_ADDR; i++)
266 bp->mii_bus.irq[i] = PHY_POLL;
268 platform_set_drvdata(bp->dev, &bp->mii_bus);
270 if (mdiobus_register(&bp->mii_bus))
271 goto err_out_free_mdio_irq;
273 if (macb_mii_probe(bp->dev) != 0) {
274 goto err_out_unregister_bus;
279 err_out_unregister_bus:
280 mdiobus_unregister(&bp->mii_bus);
281 err_out_free_mdio_irq:
282 kfree(bp->mii_bus.irq);
287 static void macb_update_stats(struct macb *bp)
289 u32 __iomem *reg = bp->regs + MACB_PFR;
290 u32 *p = &bp->hw_stats.rx_pause_frames;
291 u32 *end = &bp->hw_stats.tx_pause_frames + 1;
293 WARN_ON((unsigned long)(end - p - 1) != (MACB_TPF - MACB_PFR) / 4);
295 for(; p < end; p++, reg++)
296 *p += __raw_readl(reg);
299 static void macb_tx(struct macb *bp)
305 status = macb_readl(bp, TSR);
306 macb_writel(bp, TSR, status);
308 dev_dbg(&bp->pdev->dev, "macb_tx status = %02lx\n",
309 (unsigned long)status);
311 if (status & MACB_BIT(UND)) {
313 printk(KERN_ERR "%s: TX underrun, resetting buffers\n",
318 /*Mark all the buffer as used to avoid sending a lost buffer*/
319 for (i = 0; i < TX_RING_SIZE; i++)
320 bp->tx_ring[i].ctrl = MACB_BIT(TX_USED);
322 /* free transmit buffer in upper layer*/
323 for (tail = bp->tx_tail; tail != head; tail = NEXT_TX(tail)) {
324 struct ring_info *rp = &bp->tx_skb[tail];
325 struct sk_buff *skb = rp->skb;
331 dma_unmap_single(&bp->pdev->dev, rp->mapping, skb->len,
334 dev_kfree_skb_irq(skb);
337 bp->tx_head = bp->tx_tail = 0;
340 if (!(status & MACB_BIT(COMP)))
342 * This may happen when a buffer becomes complete
343 * between reading the ISR and scanning the
344 * descriptors. Nothing to worry about.
349 for (tail = bp->tx_tail; tail != head; tail = NEXT_TX(tail)) {
350 struct ring_info *rp = &bp->tx_skb[tail];
351 struct sk_buff *skb = rp->skb;
357 bufstat = bp->tx_ring[tail].ctrl;
359 if (!(bufstat & MACB_BIT(TX_USED)))
362 dev_dbg(&bp->pdev->dev, "skb %u (data %p) TX complete\n",
364 dma_unmap_single(&bp->pdev->dev, rp->mapping, skb->len,
366 bp->stats.tx_packets++;
367 bp->stats.tx_bytes += skb->len;
369 dev_kfree_skb_irq(skb);
373 if (netif_queue_stopped(bp->dev) &&
374 TX_BUFFS_AVAIL(bp) > MACB_TX_WAKEUP_THRESH)
375 netif_wake_queue(bp->dev);
378 static int macb_rx_frame(struct macb *bp, unsigned int first_frag,
379 unsigned int last_frag)
383 unsigned int offset = 0;
386 len = MACB_BFEXT(RX_FRMLEN, bp->rx_ring[last_frag].ctrl);
388 dev_dbg(&bp->pdev->dev, "macb_rx_frame frags %u - %u (len %u)\n",
389 first_frag, last_frag, len);
391 skb = dev_alloc_skb(len + RX_OFFSET);
393 bp->stats.rx_dropped++;
394 for (frag = first_frag; ; frag = NEXT_RX(frag)) {
395 bp->rx_ring[frag].addr &= ~MACB_BIT(RX_USED);
396 if (frag == last_frag)
403 skb_reserve(skb, RX_OFFSET);
404 skb->ip_summed = CHECKSUM_NONE;
407 for (frag = first_frag; ; frag = NEXT_RX(frag)) {
408 unsigned int frag_len = RX_BUFFER_SIZE;
410 if (offset + frag_len > len) {
411 BUG_ON(frag != last_frag);
412 frag_len = len - offset;
414 skb_copy_to_linear_data_offset(skb, offset,
416 (RX_BUFFER_SIZE * frag)),
418 offset += RX_BUFFER_SIZE;
419 bp->rx_ring[frag].addr &= ~MACB_BIT(RX_USED);
422 if (frag == last_frag)
426 skb->protocol = eth_type_trans(skb, bp->dev);
428 bp->stats.rx_packets++;
429 bp->stats.rx_bytes += len;
430 bp->dev->last_rx = jiffies;
431 dev_dbg(&bp->pdev->dev, "received skb of length %u, csum: %08x\n",
432 skb->len, skb->csum);
433 netif_receive_skb(skb);
438 /* Mark DMA descriptors from begin up to and not including end as unused */
439 static void discard_partial_frame(struct macb *bp, unsigned int begin,
444 for (frag = begin; frag != end; frag = NEXT_RX(frag))
445 bp->rx_ring[frag].addr &= ~MACB_BIT(RX_USED);
449 * When this happens, the hardware stats registers for
450 * whatever caused this is updated, so we don't have to record
455 static int macb_rx(struct macb *bp, int budget)
458 unsigned int tail = bp->rx_tail;
461 for (; budget > 0; tail = NEXT_RX(tail)) {
465 addr = bp->rx_ring[tail].addr;
466 ctrl = bp->rx_ring[tail].ctrl;
468 if (!(addr & MACB_BIT(RX_USED)))
471 if (ctrl & MACB_BIT(RX_SOF)) {
472 if (first_frag != -1)
473 discard_partial_frame(bp, first_frag, tail);
477 if (ctrl & MACB_BIT(RX_EOF)) {
479 BUG_ON(first_frag == -1);
481 dropped = macb_rx_frame(bp, first_frag, tail);
490 if (first_frag != -1)
491 bp->rx_tail = first_frag;
498 static int macb_poll(struct napi_struct *napi, int budget)
500 struct macb *bp = container_of(napi, struct macb, napi);
501 struct net_device *dev = bp->dev;
505 status = macb_readl(bp, RSR);
506 macb_writel(bp, RSR, status);
511 * This may happen if an interrupt was pending before
512 * this function was called last time, and no packets
513 * have been received since.
515 netif_rx_complete(dev, napi);
519 dev_dbg(&bp->pdev->dev, "poll: status = %08lx, budget = %d\n",
520 (unsigned long)status, budget);
522 if (!(status & MACB_BIT(REC))) {
523 dev_warn(&bp->pdev->dev,
524 "No RX buffers complete, status = %02lx\n",
525 (unsigned long)status);
526 netif_rx_complete(dev, napi);
530 work_done = macb_rx(bp, budget);
531 if (work_done < budget)
532 netif_rx_complete(dev, napi);
535 * We've done what we can to clean the buffers. Make sure we
536 * get notified when new packets arrive.
539 macb_writel(bp, IER, MACB_RX_INT_FLAGS);
541 /* TODO: Handle errors */
546 static irqreturn_t macb_interrupt(int irq, void *dev_id)
548 struct net_device *dev = dev_id;
549 struct macb *bp = netdev_priv(dev);
552 status = macb_readl(bp, ISR);
554 if (unlikely(!status))
557 spin_lock(&bp->lock);
560 /* close possible race with dev_close */
561 if (unlikely(!netif_running(dev))) {
562 macb_writel(bp, IDR, ~0UL);
566 if (status & MACB_RX_INT_FLAGS) {
567 if (netif_rx_schedule_prep(dev, &bp->napi)) {
569 * There's no point taking any more interrupts
570 * until we have processed the buffers
572 macb_writel(bp, IDR, MACB_RX_INT_FLAGS);
573 dev_dbg(&bp->pdev->dev,
574 "scheduling RX softirq\n");
575 __netif_rx_schedule(dev, &bp->napi);
579 if (status & (MACB_BIT(TCOMP) | MACB_BIT(ISR_TUND)))
583 * Link change detection isn't possible with RMII, so we'll
584 * add that if/when we get our hands on a full-blown MII PHY.
587 if (status & MACB_BIT(HRESP)) {
589 * TODO: Reset the hardware, and maybe move the printk
590 * to a lower-priority context as well (work queue?)
592 printk(KERN_ERR "%s: DMA bus error: HRESP not OK\n",
596 status = macb_readl(bp, ISR);
599 spin_unlock(&bp->lock);
604 static int macb_start_xmit(struct sk_buff *skb, struct net_device *dev)
606 struct macb *bp = netdev_priv(dev);
608 unsigned int len, entry;
613 dev_dbg(&bp->pdev->dev,
614 "start_xmit: len %u head %p data %p tail %p end %p\n",
615 skb->len, skb->head, skb->data,
616 skb_tail_pointer(skb), skb_end_pointer(skb));
617 dev_dbg(&bp->pdev->dev,
619 for (i = 0; i < 16; i++)
620 printk(" %02x", (unsigned int)skb->data[i]);
625 spin_lock_irq(&bp->lock);
627 /* This is a hard error, log it. */
628 if (TX_BUFFS_AVAIL(bp) < 1) {
629 netif_stop_queue(dev);
630 spin_unlock_irq(&bp->lock);
631 dev_err(&bp->pdev->dev,
632 "BUG! Tx Ring full when queue awake!\n");
633 dev_dbg(&bp->pdev->dev, "tx_head = %u, tx_tail = %u\n",
634 bp->tx_head, bp->tx_tail);
639 dev_dbg(&bp->pdev->dev, "Allocated ring entry %u\n", entry);
640 mapping = dma_map_single(&bp->pdev->dev, skb->data,
642 bp->tx_skb[entry].skb = skb;
643 bp->tx_skb[entry].mapping = mapping;
644 dev_dbg(&bp->pdev->dev, "Mapped skb data %p to DMA addr %08lx\n",
645 skb->data, (unsigned long)mapping);
647 ctrl = MACB_BF(TX_FRMLEN, len);
648 ctrl |= MACB_BIT(TX_LAST);
649 if (entry == (TX_RING_SIZE - 1))
650 ctrl |= MACB_BIT(TX_WRAP);
652 bp->tx_ring[entry].addr = mapping;
653 bp->tx_ring[entry].ctrl = ctrl;
656 entry = NEXT_TX(entry);
659 macb_writel(bp, NCR, macb_readl(bp, NCR) | MACB_BIT(TSTART));
661 if (TX_BUFFS_AVAIL(bp) < 1)
662 netif_stop_queue(dev);
664 spin_unlock_irq(&bp->lock);
666 dev->trans_start = jiffies;
671 static void macb_free_consistent(struct macb *bp)
678 dma_free_coherent(&bp->pdev->dev, RX_RING_BYTES,
679 bp->rx_ring, bp->rx_ring_dma);
683 dma_free_coherent(&bp->pdev->dev, TX_RING_BYTES,
684 bp->tx_ring, bp->tx_ring_dma);
687 if (bp->rx_buffers) {
688 dma_free_coherent(&bp->pdev->dev,
689 RX_RING_SIZE * RX_BUFFER_SIZE,
690 bp->rx_buffers, bp->rx_buffers_dma);
691 bp->rx_buffers = NULL;
695 static int macb_alloc_consistent(struct macb *bp)
699 size = TX_RING_SIZE * sizeof(struct ring_info);
700 bp->tx_skb = kmalloc(size, GFP_KERNEL);
704 size = RX_RING_BYTES;
705 bp->rx_ring = dma_alloc_coherent(&bp->pdev->dev, size,
706 &bp->rx_ring_dma, GFP_KERNEL);
709 dev_dbg(&bp->pdev->dev,
710 "Allocated RX ring of %d bytes at %08lx (mapped %p)\n",
711 size, (unsigned long)bp->rx_ring_dma, bp->rx_ring);
713 size = TX_RING_BYTES;
714 bp->tx_ring = dma_alloc_coherent(&bp->pdev->dev, size,
715 &bp->tx_ring_dma, GFP_KERNEL);
718 dev_dbg(&bp->pdev->dev,
719 "Allocated TX ring of %d bytes at %08lx (mapped %p)\n",
720 size, (unsigned long)bp->tx_ring_dma, bp->tx_ring);
722 size = RX_RING_SIZE * RX_BUFFER_SIZE;
723 bp->rx_buffers = dma_alloc_coherent(&bp->pdev->dev, size,
724 &bp->rx_buffers_dma, GFP_KERNEL);
727 dev_dbg(&bp->pdev->dev,
728 "Allocated RX buffers of %d bytes at %08lx (mapped %p)\n",
729 size, (unsigned long)bp->rx_buffers_dma, bp->rx_buffers);
734 macb_free_consistent(bp);
738 static void macb_init_rings(struct macb *bp)
743 addr = bp->rx_buffers_dma;
744 for (i = 0; i < RX_RING_SIZE; i++) {
745 bp->rx_ring[i].addr = addr;
746 bp->rx_ring[i].ctrl = 0;
747 addr += RX_BUFFER_SIZE;
749 bp->rx_ring[RX_RING_SIZE - 1].addr |= MACB_BIT(RX_WRAP);
751 for (i = 0; i < TX_RING_SIZE; i++) {
752 bp->tx_ring[i].addr = 0;
753 bp->tx_ring[i].ctrl = MACB_BIT(TX_USED);
755 bp->tx_ring[TX_RING_SIZE - 1].ctrl |= MACB_BIT(TX_WRAP);
757 bp->rx_tail = bp->tx_head = bp->tx_tail = 0;
760 static void macb_reset_hw(struct macb *bp)
762 /* Make sure we have the write buffer for ourselves */
766 * Disable RX and TX (XXX: Should we halt the transmission
769 macb_writel(bp, NCR, 0);
771 /* Clear the stats registers (XXX: Update stats first?) */
772 macb_writel(bp, NCR, MACB_BIT(CLRSTAT));
774 /* Clear all status flags */
775 macb_writel(bp, TSR, ~0UL);
776 macb_writel(bp, RSR, ~0UL);
778 /* Disable all interrupts */
779 macb_writel(bp, IDR, ~0UL);
783 static void macb_init_hw(struct macb *bp)
788 __macb_set_hwaddr(bp);
790 config = macb_readl(bp, NCFGR) & MACB_BF(CLK, -1L);
791 config |= MACB_BIT(PAE); /* PAuse Enable */
792 config |= MACB_BIT(DRFCS); /* Discard Rx FCS */
793 if (bp->dev->flags & IFF_PROMISC)
794 config |= MACB_BIT(CAF); /* Copy All Frames */
795 if (!(bp->dev->flags & IFF_BROADCAST))
796 config |= MACB_BIT(NBC); /* No BroadCast */
797 macb_writel(bp, NCFGR, config);
799 /* Initialize TX and RX buffers */
800 macb_writel(bp, RBQP, bp->rx_ring_dma);
801 macb_writel(bp, TBQP, bp->tx_ring_dma);
803 /* Enable TX and RX */
804 macb_writel(bp, NCR, MACB_BIT(RE) | MACB_BIT(TE) | MACB_BIT(MPE));
806 /* Enable interrupts */
807 macb_writel(bp, IER, (MACB_BIT(RCOMP)
819 * The hash address register is 64 bits long and takes up two
820 * locations in the memory map. The least significant bits are stored
821 * in EMAC_HSL and the most significant bits in EMAC_HSH.
823 * The unicast hash enable and the multicast hash enable bits in the
824 * network configuration register enable the reception of hash matched
825 * frames. The destination address is reduced to a 6 bit index into
826 * the 64 bit hash register using the following hash function. The
827 * hash function is an exclusive or of every sixth bit of the
828 * destination address.
830 * hi[5] = da[5] ^ da[11] ^ da[17] ^ da[23] ^ da[29] ^ da[35] ^ da[41] ^ da[47]
831 * hi[4] = da[4] ^ da[10] ^ da[16] ^ da[22] ^ da[28] ^ da[34] ^ da[40] ^ da[46]
832 * hi[3] = da[3] ^ da[09] ^ da[15] ^ da[21] ^ da[27] ^ da[33] ^ da[39] ^ da[45]
833 * hi[2] = da[2] ^ da[08] ^ da[14] ^ da[20] ^ da[26] ^ da[32] ^ da[38] ^ da[44]
834 * hi[1] = da[1] ^ da[07] ^ da[13] ^ da[19] ^ da[25] ^ da[31] ^ da[37] ^ da[43]
835 * hi[0] = da[0] ^ da[06] ^ da[12] ^ da[18] ^ da[24] ^ da[30] ^ da[36] ^ da[42]
837 * da[0] represents the least significant bit of the first byte
838 * received, that is, the multicast/unicast indicator, and da[47]
839 * represents the most significant bit of the last byte received. If
840 * the hash index, hi[n], points to a bit that is set in the hash
841 * register then the frame will be matched according to whether the
842 * frame is multicast or unicast. A multicast match will be signalled
843 * if the multicast hash enable bit is set, da[0] is 1 and the hash
844 * index points to a bit set in the hash register. A unicast match
845 * will be signalled if the unicast hash enable bit is set, da[0] is 0
846 * and the hash index points to a bit set in the hash register. To
847 * receive all multicast frames, the hash register should be set with
848 * all ones and the multicast hash enable bit should be set in the
849 * network configuration register.
852 static inline int hash_bit_value(int bitnr, __u8 *addr)
854 if (addr[bitnr / 8] & (1 << (bitnr % 8)))
860 * Return the hash index value for the specified address.
862 static int hash_get_index(__u8 *addr)
867 for (j = 0; j < 6; j++) {
868 for (i = 0, bitval = 0; i < 8; i++)
869 bitval ^= hash_bit_value(i*6 + j, addr);
871 hash_index |= (bitval << j);
878 * Add multicast addresses to the internal multicast-hash table.
880 static void macb_sethashtable(struct net_device *dev)
882 struct dev_mc_list *curr;
883 unsigned long mc_filter[2];
884 unsigned int i, bitnr;
885 struct macb *bp = netdev_priv(dev);
887 mc_filter[0] = mc_filter[1] = 0;
890 for (i = 0; i < dev->mc_count; i++, curr = curr->next) {
891 if (!curr) break; /* unexpected end of list */
893 bitnr = hash_get_index(curr->dmi_addr);
894 mc_filter[bitnr >> 5] |= 1 << (bitnr & 31);
897 macb_writel(bp, HRB, mc_filter[0]);
898 macb_writel(bp, HRT, mc_filter[1]);
902 * Enable/Disable promiscuous and multicast modes.
904 static void macb_set_rx_mode(struct net_device *dev)
907 struct macb *bp = netdev_priv(dev);
909 cfg = macb_readl(bp, NCFGR);
911 if (dev->flags & IFF_PROMISC)
912 /* Enable promiscuous mode */
913 cfg |= MACB_BIT(CAF);
914 else if (dev->flags & (~IFF_PROMISC))
915 /* Disable promiscuous mode */
916 cfg &= ~MACB_BIT(CAF);
918 if (dev->flags & IFF_ALLMULTI) {
919 /* Enable all multicast mode */
920 macb_writel(bp, HRB, -1);
921 macb_writel(bp, HRT, -1);
922 cfg |= MACB_BIT(NCFGR_MTI);
923 } else if (dev->mc_count > 0) {
924 /* Enable specific multicasts */
925 macb_sethashtable(dev);
926 cfg |= MACB_BIT(NCFGR_MTI);
927 } else if (dev->flags & (~IFF_ALLMULTI)) {
928 /* Disable all multicast mode */
929 macb_writel(bp, HRB, 0);
930 macb_writel(bp, HRT, 0);
931 cfg &= ~MACB_BIT(NCFGR_MTI);
934 macb_writel(bp, NCFGR, cfg);
937 static int macb_open(struct net_device *dev)
939 struct macb *bp = netdev_priv(dev);
942 dev_dbg(&bp->pdev->dev, "open\n");
944 /* if the phy is not yet register, retry later*/
948 if (!is_valid_ether_addr(dev->dev_addr))
949 return -EADDRNOTAVAIL;
951 err = macb_alloc_consistent(bp);
954 "%s: Unable to allocate DMA memory (error %d)\n",
959 napi_enable(&bp->napi);
964 /* schedule a link state check */
965 phy_start(bp->phy_dev);
967 netif_start_queue(dev);
972 static int macb_close(struct net_device *dev)
974 struct macb *bp = netdev_priv(dev);
977 netif_stop_queue(dev);
978 napi_disable(&bp->napi);
981 phy_stop(bp->phy_dev);
983 spin_lock_irqsave(&bp->lock, flags);
985 netif_carrier_off(dev);
986 spin_unlock_irqrestore(&bp->lock, flags);
988 macb_free_consistent(bp);
993 static struct net_device_stats *macb_get_stats(struct net_device *dev)
995 struct macb *bp = netdev_priv(dev);
996 struct net_device_stats *nstat = &bp->stats;
997 struct macb_stats *hwstat = &bp->hw_stats;
999 /* read stats from hardware */
1000 macb_update_stats(bp);
1002 /* Convert HW stats into netdevice stats */
1003 nstat->rx_errors = (hwstat->rx_fcs_errors +
1004 hwstat->rx_align_errors +
1005 hwstat->rx_resource_errors +
1006 hwstat->rx_overruns +
1007 hwstat->rx_oversize_pkts +
1008 hwstat->rx_jabbers +
1009 hwstat->rx_undersize_pkts +
1010 hwstat->sqe_test_errors +
1011 hwstat->rx_length_mismatch);
1012 nstat->tx_errors = (hwstat->tx_late_cols +
1013 hwstat->tx_excessive_cols +
1014 hwstat->tx_underruns +
1015 hwstat->tx_carrier_errors);
1016 nstat->collisions = (hwstat->tx_single_cols +
1017 hwstat->tx_multiple_cols +
1018 hwstat->tx_excessive_cols);
1019 nstat->rx_length_errors = (hwstat->rx_oversize_pkts +
1020 hwstat->rx_jabbers +
1021 hwstat->rx_undersize_pkts +
1022 hwstat->rx_length_mismatch);
1023 nstat->rx_over_errors = hwstat->rx_resource_errors;
1024 nstat->rx_crc_errors = hwstat->rx_fcs_errors;
1025 nstat->rx_frame_errors = hwstat->rx_align_errors;
1026 nstat->rx_fifo_errors = hwstat->rx_overruns;
1027 /* XXX: What does "missed" mean? */
1028 nstat->tx_aborted_errors = hwstat->tx_excessive_cols;
1029 nstat->tx_carrier_errors = hwstat->tx_carrier_errors;
1030 nstat->tx_fifo_errors = hwstat->tx_underruns;
1031 /* Don't know about heartbeat or window errors... */
1036 static int macb_get_settings(struct net_device *dev, struct ethtool_cmd *cmd)
1038 struct macb *bp = netdev_priv(dev);
1039 struct phy_device *phydev = bp->phy_dev;
1044 return phy_ethtool_gset(phydev, cmd);
1047 static int macb_set_settings(struct net_device *dev, struct ethtool_cmd *cmd)
1049 struct macb *bp = netdev_priv(dev);
1050 struct phy_device *phydev = bp->phy_dev;
1055 return phy_ethtool_sset(phydev, cmd);
1058 static void macb_get_drvinfo(struct net_device *dev,
1059 struct ethtool_drvinfo *info)
1061 struct macb *bp = netdev_priv(dev);
1063 strcpy(info->driver, bp->pdev->dev.driver->name);
1064 strcpy(info->version, "$Revision: 1.14 $");
1065 strcpy(info->bus_info, bp->pdev->dev.bus_id);
1068 static struct ethtool_ops macb_ethtool_ops = {
1069 .get_settings = macb_get_settings,
1070 .set_settings = macb_set_settings,
1071 .get_drvinfo = macb_get_drvinfo,
1072 .get_link = ethtool_op_get_link,
1075 static int macb_ioctl(struct net_device *dev, struct ifreq *rq, int cmd)
1077 struct macb *bp = netdev_priv(dev);
1078 struct phy_device *phydev = bp->phy_dev;
1080 if (!netif_running(dev))
1086 return phy_mii_ioctl(phydev, if_mii(rq), cmd);
1089 static int __init macb_probe(struct platform_device *pdev)
1091 struct eth_platform_data *pdata;
1092 struct resource *regs;
1093 struct net_device *dev;
1095 struct phy_device *phydev;
1096 unsigned long pclk_hz;
1099 DECLARE_MAC_BUF(mac);
1101 regs = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1103 dev_err(&pdev->dev, "no mmio resource defined\n");
1108 dev = alloc_etherdev(sizeof(*bp));
1110 dev_err(&pdev->dev, "etherdev alloc failed, aborting.\n");
1114 SET_NETDEV_DEV(dev, &pdev->dev);
1116 /* TODO: Actually, we have some interesting features... */
1119 bp = netdev_priv(dev);
1123 spin_lock_init(&bp->lock);
1125 #if defined(CONFIG_ARCH_AT91)
1126 bp->pclk = clk_get(&pdev->dev, "macb_clk");
1127 if (IS_ERR(bp->pclk)) {
1128 dev_err(&pdev->dev, "failed to get macb_clk\n");
1129 goto err_out_free_dev;
1131 clk_enable(bp->pclk);
1133 bp->pclk = clk_get(&pdev->dev, "pclk");
1134 if (IS_ERR(bp->pclk)) {
1135 dev_err(&pdev->dev, "failed to get pclk\n");
1136 goto err_out_free_dev;
1138 bp->hclk = clk_get(&pdev->dev, "hclk");
1139 if (IS_ERR(bp->hclk)) {
1140 dev_err(&pdev->dev, "failed to get hclk\n");
1141 goto err_out_put_pclk;
1144 clk_enable(bp->pclk);
1145 clk_enable(bp->hclk);
1148 bp->regs = ioremap(regs->start, regs->end - regs->start + 1);
1150 dev_err(&pdev->dev, "failed to map registers, aborting.\n");
1152 goto err_out_disable_clocks;
1155 dev->irq = platform_get_irq(pdev, 0);
1156 err = request_irq(dev->irq, macb_interrupt, IRQF_SAMPLE_RANDOM,
1160 "%s: Unable to request IRQ %d (error %d)\n",
1161 dev->name, dev->irq, err);
1162 goto err_out_iounmap;
1165 dev->open = macb_open;
1166 dev->stop = macb_close;
1167 dev->hard_start_xmit = macb_start_xmit;
1168 dev->get_stats = macb_get_stats;
1169 dev->set_multicast_list = macb_set_rx_mode;
1170 dev->do_ioctl = macb_ioctl;
1171 netif_napi_add(dev, &bp->napi, macb_poll, 64);
1172 dev->ethtool_ops = &macb_ethtool_ops;
1174 dev->base_addr = regs->start;
1176 /* Set MII management clock divider */
1177 pclk_hz = clk_get_rate(bp->pclk);
1178 if (pclk_hz <= 20000000)
1179 config = MACB_BF(CLK, MACB_CLK_DIV8);
1180 else if (pclk_hz <= 40000000)
1181 config = MACB_BF(CLK, MACB_CLK_DIV16);
1182 else if (pclk_hz <= 80000000)
1183 config = MACB_BF(CLK, MACB_CLK_DIV32);
1185 config = MACB_BF(CLK, MACB_CLK_DIV64);
1186 macb_writel(bp, NCFGR, config);
1188 macb_get_hwaddr(bp);
1189 pdata = pdev->dev.platform_data;
1191 if (pdata && pdata->is_rmii)
1192 #if defined(CONFIG_ARCH_AT91)
1193 macb_writel(bp, USRIO, (MACB_BIT(RMII) | MACB_BIT(CLKEN)) );
1195 macb_writel(bp, USRIO, 0);
1198 #if defined(CONFIG_ARCH_AT91)
1199 macb_writel(bp, USRIO, MACB_BIT(CLKEN));
1201 macb_writel(bp, USRIO, MACB_BIT(MII));
1204 bp->tx_pending = DEF_TX_RING_PENDING;
1206 err = register_netdev(dev);
1208 dev_err(&pdev->dev, "Cannot register net device, aborting.\n");
1209 goto err_out_free_irq;
1212 if (macb_mii_init(bp) != 0) {
1213 goto err_out_unregister_netdev;
1216 platform_set_drvdata(pdev, dev);
1218 printk(KERN_INFO "%s: Atmel MACB at 0x%08lx irq %d "
1220 dev->name, dev->base_addr, dev->irq,
1221 print_mac(mac, dev->dev_addr));
1223 phydev = bp->phy_dev;
1224 printk(KERN_INFO "%s: attached PHY driver [%s] "
1225 "(mii_bus:phy_addr=%s, irq=%d)\n",
1226 dev->name, phydev->drv->name, phydev->dev.bus_id, phydev->irq);
1230 err_out_unregister_netdev:
1231 unregister_netdev(dev);
1233 free_irq(dev->irq, dev);
1236 err_out_disable_clocks:
1237 #ifndef CONFIG_ARCH_AT91
1238 clk_disable(bp->hclk);
1241 clk_disable(bp->pclk);
1242 #ifndef CONFIG_ARCH_AT91
1249 platform_set_drvdata(pdev, NULL);
1253 static int __exit macb_remove(struct platform_device *pdev)
1255 struct net_device *dev;
1258 dev = platform_get_drvdata(pdev);
1261 bp = netdev_priv(dev);
1263 phy_disconnect(bp->phy_dev);
1264 mdiobus_unregister(&bp->mii_bus);
1265 kfree(bp->mii_bus.irq);
1266 unregister_netdev(dev);
1267 free_irq(dev->irq, dev);
1269 #ifndef CONFIG_ARCH_AT91
1270 clk_disable(bp->hclk);
1273 clk_disable(bp->pclk);
1276 platform_set_drvdata(pdev, NULL);
1283 static int macb_suspend(struct platform_device *pdev, pm_message_t state)
1285 struct net_device *netdev = platform_get_drvdata(pdev);
1286 struct macb *bp = netdev_priv(netdev);
1288 netif_device_detach(netdev);
1290 #ifndef CONFIG_ARCH_AT91
1291 clk_disable(bp->hclk);
1293 clk_disable(bp->pclk);
1298 static int macb_resume(struct platform_device *pdev)
1300 struct net_device *netdev = platform_get_drvdata(pdev);
1301 struct macb *bp = netdev_priv(netdev);
1303 clk_enable(bp->pclk);
1304 #ifndef CONFIG_ARCH_AT91
1305 clk_enable(bp->hclk);
1308 netif_device_attach(netdev);
1313 #define macb_suspend NULL
1314 #define macb_resume NULL
1317 static struct platform_driver macb_driver = {
1318 .remove = __exit_p(macb_remove),
1319 .suspend = macb_suspend,
1320 .resume = macb_resume,
1323 .owner = THIS_MODULE,
1327 static int __init macb_init(void)
1329 return platform_driver_probe(&macb_driver, macb_probe);
1332 static void __exit macb_exit(void)
1334 platform_driver_unregister(&macb_driver);
1337 module_init(macb_init);
1338 module_exit(macb_exit);
1340 MODULE_LICENSE("GPL");
1341 MODULE_DESCRIPTION("Atmel MACB Ethernet driver");
1342 MODULE_AUTHOR("Haavard Skinnemoen <hskinnemoen@atmel.com>");
1343 MODULE_ALIAS("platform:macb");