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 <mach/board.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;
193 struct eth_platform_data *pdata;
196 phydev = phy_find_first(bp->mii_bus);
198 printk (KERN_ERR "%s: no PHY found\n", dev->name);
202 pdata = bp->pdev->dev.platform_data;
203 /* TODO : add pin_irq */
205 /* attach the mac to the phy */
206 ret = phy_connect_direct(dev, phydev, &macb_handle_link_change, 0,
207 pdata && pdata->is_rmii ?
208 PHY_INTERFACE_MODE_RMII :
209 PHY_INTERFACE_MODE_MII);
211 printk(KERN_ERR "%s: Could not attach to PHY\n", dev->name);
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 eth_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, "%x", bp->pdev->id);
247 bp->mii_bus->priv = bp;
248 bp->mii_bus->parent = &bp->dev->dev;
249 pdata = bp->pdev->dev.platform_data;
252 bp->mii_bus->phy_mask = pdata->phy_mask;
254 bp->mii_bus->irq = kmalloc(sizeof(int)*PHY_MAX_ADDR, GFP_KERNEL);
255 if (!bp->mii_bus->irq) {
257 goto err_out_free_mdiobus;
260 for (i = 0; i < PHY_MAX_ADDR; i++)
261 bp->mii_bus->irq[i] = PHY_POLL;
263 platform_set_drvdata(bp->dev, bp->mii_bus);
265 if (mdiobus_register(bp->mii_bus))
266 goto err_out_free_mdio_irq;
268 if (macb_mii_probe(bp->dev) != 0) {
269 goto err_out_unregister_bus;
274 err_out_unregister_bus:
275 mdiobus_unregister(bp->mii_bus);
276 err_out_free_mdio_irq:
277 kfree(bp->mii_bus->irq);
278 err_out_free_mdiobus:
279 mdiobus_free(bp->mii_bus);
284 static void macb_update_stats(struct macb *bp)
286 u32 __iomem *reg = bp->regs + MACB_PFR;
287 u32 *p = &bp->hw_stats.rx_pause_frames;
288 u32 *end = &bp->hw_stats.tx_pause_frames + 1;
290 WARN_ON((unsigned long)(end - p - 1) != (MACB_TPF - MACB_PFR) / 4);
292 for(; p < end; p++, reg++)
293 *p += __raw_readl(reg);
296 static void macb_tx(struct macb *bp)
302 status = macb_readl(bp, TSR);
303 macb_writel(bp, TSR, status);
305 dev_dbg(&bp->pdev->dev, "macb_tx status = %02lx\n",
306 (unsigned long)status);
308 if (status & (MACB_BIT(UND) | MACB_BIT(TSR_RLE))) {
310 printk(KERN_ERR "%s: TX %s, resetting buffers\n",
311 bp->dev->name, 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);
324 /* free transmit buffer in upper layer*/
325 for (tail = bp->tx_tail; tail != head; tail = NEXT_TX(tail)) {
326 struct ring_info *rp = &bp->tx_skb[tail];
327 struct sk_buff *skb = rp->skb;
333 dma_unmap_single(&bp->pdev->dev, rp->mapping, skb->len,
336 dev_kfree_skb_irq(skb);
339 bp->tx_head = bp->tx_tail = 0;
341 /* Enable the transmitter again */
342 if (status & MACB_BIT(TGO))
343 macb_writel(bp, NCR, macb_readl(bp, NCR) | MACB_BIT(TE));
346 if (!(status & MACB_BIT(COMP)))
348 * This may happen when a buffer becomes complete
349 * between reading the ISR and scanning the
350 * descriptors. Nothing to worry about.
355 for (tail = bp->tx_tail; tail != head; tail = NEXT_TX(tail)) {
356 struct ring_info *rp = &bp->tx_skb[tail];
357 struct sk_buff *skb = rp->skb;
363 bufstat = bp->tx_ring[tail].ctrl;
365 if (!(bufstat & MACB_BIT(TX_USED)))
368 dev_dbg(&bp->pdev->dev, "skb %u (data %p) TX complete\n",
370 dma_unmap_single(&bp->pdev->dev, rp->mapping, skb->len,
372 bp->stats.tx_packets++;
373 bp->stats.tx_bytes += skb->len;
375 dev_kfree_skb_irq(skb);
379 if (netif_queue_stopped(bp->dev) &&
380 TX_BUFFS_AVAIL(bp) > MACB_TX_WAKEUP_THRESH)
381 netif_wake_queue(bp->dev);
384 static int macb_rx_frame(struct macb *bp, unsigned int first_frag,
385 unsigned int last_frag)
389 unsigned int offset = 0;
392 len = MACB_BFEXT(RX_FRMLEN, bp->rx_ring[last_frag].ctrl);
394 dev_dbg(&bp->pdev->dev, "macb_rx_frame frags %u - %u (len %u)\n",
395 first_frag, last_frag, len);
397 skb = dev_alloc_skb(len + RX_OFFSET);
399 bp->stats.rx_dropped++;
400 for (frag = first_frag; ; frag = NEXT_RX(frag)) {
401 bp->rx_ring[frag].addr &= ~MACB_BIT(RX_USED);
402 if (frag == last_frag)
409 skb_reserve(skb, RX_OFFSET);
410 skb->ip_summed = CHECKSUM_NONE;
413 for (frag = first_frag; ; frag = NEXT_RX(frag)) {
414 unsigned int frag_len = RX_BUFFER_SIZE;
416 if (offset + frag_len > len) {
417 BUG_ON(frag != last_frag);
418 frag_len = len - offset;
420 skb_copy_to_linear_data_offset(skb, offset,
422 (RX_BUFFER_SIZE * frag)),
424 offset += RX_BUFFER_SIZE;
425 bp->rx_ring[frag].addr &= ~MACB_BIT(RX_USED);
428 if (frag == last_frag)
432 skb->protocol = eth_type_trans(skb, bp->dev);
434 bp->stats.rx_packets++;
435 bp->stats.rx_bytes += len;
436 dev_dbg(&bp->pdev->dev, "received skb of length %u, csum: %08x\n",
437 skb->len, skb->csum);
438 netif_receive_skb(skb);
443 /* Mark DMA descriptors from begin up to and not including end as unused */
444 static void discard_partial_frame(struct macb *bp, unsigned int begin,
449 for (frag = begin; frag != end; frag = NEXT_RX(frag))
450 bp->rx_ring[frag].addr &= ~MACB_BIT(RX_USED);
454 * When this happens, the hardware stats registers for
455 * whatever caused this is updated, so we don't have to record
460 static int macb_rx(struct macb *bp, int budget)
463 unsigned int tail = bp->rx_tail;
466 for (; budget > 0; tail = NEXT_RX(tail)) {
470 addr = bp->rx_ring[tail].addr;
471 ctrl = bp->rx_ring[tail].ctrl;
473 if (!(addr & MACB_BIT(RX_USED)))
476 if (ctrl & MACB_BIT(RX_SOF)) {
477 if (first_frag != -1)
478 discard_partial_frame(bp, first_frag, tail);
482 if (ctrl & MACB_BIT(RX_EOF)) {
484 BUG_ON(first_frag == -1);
486 dropped = macb_rx_frame(bp, first_frag, tail);
495 if (first_frag != -1)
496 bp->rx_tail = first_frag;
503 static int macb_poll(struct napi_struct *napi, int budget)
505 struct macb *bp = container_of(napi, struct macb, napi);
509 status = macb_readl(bp, RSR);
510 macb_writel(bp, RSR, status);
514 dev_dbg(&bp->pdev->dev, "poll: status = %08lx, budget = %d\n",
515 (unsigned long)status, budget);
517 work_done = macb_rx(bp, budget);
518 if (work_done < budget)
522 * We've done what we can to clean the buffers. Make sure we
523 * get notified when new packets arrive.
525 macb_writel(bp, IER, MACB_RX_INT_FLAGS);
527 /* TODO: Handle errors */
532 static irqreturn_t macb_interrupt(int irq, void *dev_id)
534 struct net_device *dev = dev_id;
535 struct macb *bp = netdev_priv(dev);
538 status = macb_readl(bp, ISR);
540 if (unlikely(!status))
543 spin_lock(&bp->lock);
546 /* close possible race with dev_close */
547 if (unlikely(!netif_running(dev))) {
548 macb_writel(bp, IDR, ~0UL);
552 if (status & MACB_RX_INT_FLAGS) {
553 if (napi_schedule_prep(&bp->napi)) {
555 * There's no point taking any more interrupts
556 * until we have processed the buffers
558 macb_writel(bp, IDR, MACB_RX_INT_FLAGS);
559 dev_dbg(&bp->pdev->dev,
560 "scheduling RX softirq\n");
561 __napi_schedule(&bp->napi);
565 if (status & (MACB_BIT(TCOMP) | MACB_BIT(ISR_TUND) |
570 * Link change detection isn't possible with RMII, so we'll
571 * add that if/when we get our hands on a full-blown MII PHY.
574 if (status & MACB_BIT(HRESP)) {
576 * TODO: Reset the hardware, and maybe move the printk
577 * to a lower-priority context as well (work queue?)
579 printk(KERN_ERR "%s: DMA bus error: HRESP not OK\n",
583 status = macb_readl(bp, ISR);
586 spin_unlock(&bp->lock);
591 #ifdef CONFIG_NET_POLL_CONTROLLER
593 * Polling receive - used by netconsole and other diagnostic tools
594 * to allow network i/o with interrupts disabled.
596 static void macb_poll_controller(struct net_device *dev)
600 local_irq_save(flags);
601 macb_interrupt(dev->irq, dev);
602 local_irq_restore(flags);
606 static int macb_start_xmit(struct sk_buff *skb, struct net_device *dev)
608 struct macb *bp = netdev_priv(dev);
610 unsigned int len, entry;
616 dev_dbg(&bp->pdev->dev,
617 "start_xmit: len %u head %p data %p tail %p end %p\n",
618 skb->len, skb->head, skb->data,
619 skb_tail_pointer(skb), skb_end_pointer(skb));
620 dev_dbg(&bp->pdev->dev,
622 for (i = 0; i < 16; i++)
623 printk(" %02x", (unsigned int)skb->data[i]);
628 spin_lock_irqsave(&bp->lock, flags);
630 /* This is a hard error, log it. */
631 if (TX_BUFFS_AVAIL(bp) < 1) {
632 netif_stop_queue(dev);
633 spin_unlock_irqrestore(&bp->lock, flags);
634 dev_err(&bp->pdev->dev,
635 "BUG! Tx Ring full when queue awake!\n");
636 dev_dbg(&bp->pdev->dev, "tx_head = %u, tx_tail = %u\n",
637 bp->tx_head, bp->tx_tail);
638 return NETDEV_TX_BUSY;
642 dev_dbg(&bp->pdev->dev, "Allocated ring entry %u\n", entry);
643 mapping = dma_map_single(&bp->pdev->dev, skb->data,
645 bp->tx_skb[entry].skb = skb;
646 bp->tx_skb[entry].mapping = mapping;
647 dev_dbg(&bp->pdev->dev, "Mapped skb data %p to DMA addr %08lx\n",
648 skb->data, (unsigned long)mapping);
650 ctrl = MACB_BF(TX_FRMLEN, len);
651 ctrl |= MACB_BIT(TX_LAST);
652 if (entry == (TX_RING_SIZE - 1))
653 ctrl |= MACB_BIT(TX_WRAP);
655 bp->tx_ring[entry].addr = mapping;
656 bp->tx_ring[entry].ctrl = ctrl;
659 entry = NEXT_TX(entry);
662 macb_writel(bp, NCR, macb_readl(bp, NCR) | MACB_BIT(TSTART));
664 if (TX_BUFFS_AVAIL(bp) < 1)
665 netif_stop_queue(dev);
667 spin_unlock_irqrestore(&bp->lock, flags);
672 static void macb_free_consistent(struct macb *bp)
679 dma_free_coherent(&bp->pdev->dev, RX_RING_BYTES,
680 bp->rx_ring, bp->rx_ring_dma);
684 dma_free_coherent(&bp->pdev->dev, TX_RING_BYTES,
685 bp->tx_ring, bp->tx_ring_dma);
688 if (bp->rx_buffers) {
689 dma_free_coherent(&bp->pdev->dev,
690 RX_RING_SIZE * RX_BUFFER_SIZE,
691 bp->rx_buffers, bp->rx_buffers_dma);
692 bp->rx_buffers = NULL;
696 static int macb_alloc_consistent(struct macb *bp)
700 size = TX_RING_SIZE * sizeof(struct ring_info);
701 bp->tx_skb = kmalloc(size, GFP_KERNEL);
705 size = RX_RING_BYTES;
706 bp->rx_ring = dma_alloc_coherent(&bp->pdev->dev, size,
707 &bp->rx_ring_dma, GFP_KERNEL);
710 dev_dbg(&bp->pdev->dev,
711 "Allocated RX ring of %d bytes at %08lx (mapped %p)\n",
712 size, (unsigned long)bp->rx_ring_dma, bp->rx_ring);
714 size = TX_RING_BYTES;
715 bp->tx_ring = dma_alloc_coherent(&bp->pdev->dev, size,
716 &bp->tx_ring_dma, GFP_KERNEL);
719 dev_dbg(&bp->pdev->dev,
720 "Allocated TX ring of %d bytes at %08lx (mapped %p)\n",
721 size, (unsigned long)bp->tx_ring_dma, bp->tx_ring);
723 size = RX_RING_SIZE * RX_BUFFER_SIZE;
724 bp->rx_buffers = dma_alloc_coherent(&bp->pdev->dev, size,
725 &bp->rx_buffers_dma, GFP_KERNEL);
728 dev_dbg(&bp->pdev->dev,
729 "Allocated RX buffers of %d bytes at %08lx (mapped %p)\n",
730 size, (unsigned long)bp->rx_buffers_dma, bp->rx_buffers);
735 macb_free_consistent(bp);
739 static void macb_init_rings(struct macb *bp)
744 addr = bp->rx_buffers_dma;
745 for (i = 0; i < RX_RING_SIZE; i++) {
746 bp->rx_ring[i].addr = addr;
747 bp->rx_ring[i].ctrl = 0;
748 addr += RX_BUFFER_SIZE;
750 bp->rx_ring[RX_RING_SIZE - 1].addr |= MACB_BIT(RX_WRAP);
752 for (i = 0; i < TX_RING_SIZE; i++) {
753 bp->tx_ring[i].addr = 0;
754 bp->tx_ring[i].ctrl = MACB_BIT(TX_USED);
756 bp->tx_ring[TX_RING_SIZE - 1].ctrl |= MACB_BIT(TX_WRAP);
758 bp->rx_tail = bp->tx_head = bp->tx_tail = 0;
761 static void macb_reset_hw(struct macb *bp)
763 /* Make sure we have the write buffer for ourselves */
767 * Disable RX and TX (XXX: Should we halt the transmission
770 macb_writel(bp, NCR, 0);
772 /* Clear the stats registers (XXX: Update stats first?) */
773 macb_writel(bp, NCR, MACB_BIT(CLRSTAT));
775 /* Clear all status flags */
776 macb_writel(bp, TSR, ~0UL);
777 macb_writel(bp, RSR, ~0UL);
779 /* Disable all interrupts */
780 macb_writel(bp, IDR, ~0UL);
784 static void macb_init_hw(struct macb *bp)
789 __macb_set_hwaddr(bp);
791 config = macb_readl(bp, NCFGR) & MACB_BF(CLK, -1L);
792 config |= MACB_BIT(PAE); /* PAuse Enable */
793 config |= MACB_BIT(DRFCS); /* Discard Rx FCS */
794 config |= MACB_BIT(BIG); /* Receive oversized frames */
795 if (bp->dev->flags & IFF_PROMISC)
796 config |= MACB_BIT(CAF); /* Copy All Frames */
797 if (!(bp->dev->flags & IFF_BROADCAST))
798 config |= MACB_BIT(NBC); /* No BroadCast */
799 macb_writel(bp, NCFGR, config);
801 /* Initialize TX and RX buffers */
802 macb_writel(bp, RBQP, bp->rx_ring_dma);
803 macb_writel(bp, TBQP, bp->tx_ring_dma);
805 /* Enable TX and RX */
806 macb_writel(bp, NCR, MACB_BIT(RE) | MACB_BIT(TE) | MACB_BIT(MPE));
808 /* Enable interrupts */
809 macb_writel(bp, IER, (MACB_BIT(RCOMP)
821 * The hash address register is 64 bits long and takes up two
822 * locations in the memory map. The least significant bits are stored
823 * in EMAC_HSL and the most significant bits in EMAC_HSH.
825 * The unicast hash enable and the multicast hash enable bits in the
826 * network configuration register enable the reception of hash matched
827 * frames. The destination address is reduced to a 6 bit index into
828 * the 64 bit hash register using the following hash function. The
829 * hash function is an exclusive or of every sixth bit of the
830 * destination address.
832 * hi[5] = da[5] ^ da[11] ^ da[17] ^ da[23] ^ da[29] ^ da[35] ^ da[41] ^ da[47]
833 * hi[4] = da[4] ^ da[10] ^ da[16] ^ da[22] ^ da[28] ^ da[34] ^ da[40] ^ da[46]
834 * hi[3] = da[3] ^ da[09] ^ da[15] ^ da[21] ^ da[27] ^ da[33] ^ da[39] ^ da[45]
835 * hi[2] = da[2] ^ da[08] ^ da[14] ^ da[20] ^ da[26] ^ da[32] ^ da[38] ^ da[44]
836 * hi[1] = da[1] ^ da[07] ^ da[13] ^ da[19] ^ da[25] ^ da[31] ^ da[37] ^ da[43]
837 * hi[0] = da[0] ^ da[06] ^ da[12] ^ da[18] ^ da[24] ^ da[30] ^ da[36] ^ da[42]
839 * da[0] represents the least significant bit of the first byte
840 * received, that is, the multicast/unicast indicator, and da[47]
841 * represents the most significant bit of the last byte received. If
842 * the hash index, hi[n], points to a bit that is set in the hash
843 * register then the frame will be matched according to whether the
844 * frame is multicast or unicast. A multicast match will be signalled
845 * if the multicast hash enable bit is set, da[0] is 1 and the hash
846 * index points to a bit set in the hash register. A unicast match
847 * will be signalled if the unicast hash enable bit is set, da[0] is 0
848 * and the hash index points to a bit set in the hash register. To
849 * receive all multicast frames, the hash register should be set with
850 * all ones and the multicast hash enable bit should be set in the
851 * network configuration register.
854 static inline int hash_bit_value(int bitnr, __u8 *addr)
856 if (addr[bitnr / 8] & (1 << (bitnr % 8)))
862 * Return the hash index value for the specified address.
864 static int hash_get_index(__u8 *addr)
869 for (j = 0; j < 6; j++) {
870 for (i = 0, bitval = 0; i < 8; i++)
871 bitval ^= hash_bit_value(i*6 + j, addr);
873 hash_index |= (bitval << j);
880 * Add multicast addresses to the internal multicast-hash table.
882 static void macb_sethashtable(struct net_device *dev)
884 struct netdev_hw_addr *ha;
885 unsigned long mc_filter[2];
887 struct macb *bp = netdev_priv(dev);
889 mc_filter[0] = mc_filter[1] = 0;
891 netdev_for_each_mc_addr(ha, dev) {
892 bitnr = hash_get_index(ha->addr);
893 mc_filter[bitnr >> 5] |= 1 << (bitnr & 31);
896 macb_writel(bp, HRB, mc_filter[0]);
897 macb_writel(bp, HRT, mc_filter[1]);
901 * Enable/Disable promiscuous and multicast modes.
903 static void macb_set_rx_mode(struct net_device *dev)
906 struct macb *bp = netdev_priv(dev);
908 cfg = macb_readl(bp, NCFGR);
910 if (dev->flags & IFF_PROMISC)
911 /* Enable promiscuous mode */
912 cfg |= MACB_BIT(CAF);
913 else if (dev->flags & (~IFF_PROMISC))
914 /* Disable promiscuous mode */
915 cfg &= ~MACB_BIT(CAF);
917 if (dev->flags & IFF_ALLMULTI) {
918 /* Enable all multicast mode */
919 macb_writel(bp, HRB, -1);
920 macb_writel(bp, HRT, -1);
921 cfg |= MACB_BIT(NCFGR_MTI);
922 } else if (!netdev_mc_empty(dev)) {
923 /* Enable specific multicasts */
924 macb_sethashtable(dev);
925 cfg |= MACB_BIT(NCFGR_MTI);
926 } else if (dev->flags & (~IFF_ALLMULTI)) {
927 /* Disable all multicast mode */
928 macb_writel(bp, HRB, 0);
929 macb_writel(bp, HRT, 0);
930 cfg &= ~MACB_BIT(NCFGR_MTI);
933 macb_writel(bp, NCFGR, cfg);
936 static int macb_open(struct net_device *dev)
938 struct macb *bp = netdev_priv(dev);
941 dev_dbg(&bp->pdev->dev, "open\n");
943 /* if the phy is not yet register, retry later*/
947 if (!is_valid_ether_addr(dev->dev_addr))
948 return -EADDRNOTAVAIL;
950 err = macb_alloc_consistent(bp);
953 "%s: Unable to allocate DMA memory (error %d)\n",
958 napi_enable(&bp->napi);
963 /* schedule a link state check */
964 phy_start(bp->phy_dev);
966 netif_start_queue(dev);
971 static int macb_close(struct net_device *dev)
973 struct macb *bp = netdev_priv(dev);
976 netif_stop_queue(dev);
977 napi_disable(&bp->napi);
980 phy_stop(bp->phy_dev);
982 spin_lock_irqsave(&bp->lock, flags);
984 netif_carrier_off(dev);
985 spin_unlock_irqrestore(&bp->lock, flags);
987 macb_free_consistent(bp);
992 static struct net_device_stats *macb_get_stats(struct net_device *dev)
994 struct macb *bp = netdev_priv(dev);
995 struct net_device_stats *nstat = &bp->stats;
996 struct macb_stats *hwstat = &bp->hw_stats;
998 /* read stats from hardware */
999 macb_update_stats(bp);
1001 /* Convert HW stats into netdevice stats */
1002 nstat->rx_errors = (hwstat->rx_fcs_errors +
1003 hwstat->rx_align_errors +
1004 hwstat->rx_resource_errors +
1005 hwstat->rx_overruns +
1006 hwstat->rx_oversize_pkts +
1007 hwstat->rx_jabbers +
1008 hwstat->rx_undersize_pkts +
1009 hwstat->sqe_test_errors +
1010 hwstat->rx_length_mismatch);
1011 nstat->tx_errors = (hwstat->tx_late_cols +
1012 hwstat->tx_excessive_cols +
1013 hwstat->tx_underruns +
1014 hwstat->tx_carrier_errors);
1015 nstat->collisions = (hwstat->tx_single_cols +
1016 hwstat->tx_multiple_cols +
1017 hwstat->tx_excessive_cols);
1018 nstat->rx_length_errors = (hwstat->rx_oversize_pkts +
1019 hwstat->rx_jabbers +
1020 hwstat->rx_undersize_pkts +
1021 hwstat->rx_length_mismatch);
1022 nstat->rx_over_errors = hwstat->rx_resource_errors;
1023 nstat->rx_crc_errors = hwstat->rx_fcs_errors;
1024 nstat->rx_frame_errors = hwstat->rx_align_errors;
1025 nstat->rx_fifo_errors = hwstat->rx_overruns;
1026 /* XXX: What does "missed" mean? */
1027 nstat->tx_aborted_errors = hwstat->tx_excessive_cols;
1028 nstat->tx_carrier_errors = hwstat->tx_carrier_errors;
1029 nstat->tx_fifo_errors = hwstat->tx_underruns;
1030 /* Don't know about heartbeat or window errors... */
1035 static int macb_get_settings(struct net_device *dev, struct ethtool_cmd *cmd)
1037 struct macb *bp = netdev_priv(dev);
1038 struct phy_device *phydev = bp->phy_dev;
1043 return phy_ethtool_gset(phydev, cmd);
1046 static int macb_set_settings(struct net_device *dev, struct ethtool_cmd *cmd)
1048 struct macb *bp = netdev_priv(dev);
1049 struct phy_device *phydev = bp->phy_dev;
1054 return phy_ethtool_sset(phydev, cmd);
1057 static void macb_get_drvinfo(struct net_device *dev,
1058 struct ethtool_drvinfo *info)
1060 struct macb *bp = netdev_priv(dev);
1062 strcpy(info->driver, bp->pdev->dev.driver->name);
1063 strcpy(info->version, "$Revision: 1.14 $");
1064 strcpy(info->bus_info, dev_name(&bp->pdev->dev));
1067 static const struct ethtool_ops macb_ethtool_ops = {
1068 .get_settings = macb_get_settings,
1069 .set_settings = macb_set_settings,
1070 .get_drvinfo = macb_get_drvinfo,
1071 .get_link = ethtool_op_get_link,
1074 static int macb_ioctl(struct net_device *dev, struct ifreq *rq, int cmd)
1076 struct macb *bp = netdev_priv(dev);
1077 struct phy_device *phydev = bp->phy_dev;
1079 if (!netif_running(dev))
1085 return phy_mii_ioctl(phydev, rq, cmd);
1088 static const struct net_device_ops macb_netdev_ops = {
1089 .ndo_open = macb_open,
1090 .ndo_stop = macb_close,
1091 .ndo_start_xmit = macb_start_xmit,
1092 .ndo_set_multicast_list = macb_set_rx_mode,
1093 .ndo_get_stats = macb_get_stats,
1094 .ndo_do_ioctl = macb_ioctl,
1095 .ndo_validate_addr = eth_validate_addr,
1096 .ndo_change_mtu = eth_change_mtu,
1097 .ndo_set_mac_address = eth_mac_addr,
1098 #ifdef CONFIG_NET_POLL_CONTROLLER
1099 .ndo_poll_controller = macb_poll_controller,
1103 static int __init macb_probe(struct platform_device *pdev)
1105 struct eth_platform_data *pdata;
1106 struct resource *regs;
1107 struct net_device *dev;
1109 struct phy_device *phydev;
1110 unsigned long pclk_hz;
1114 regs = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1116 dev_err(&pdev->dev, "no mmio resource defined\n");
1121 dev = alloc_etherdev(sizeof(*bp));
1123 dev_err(&pdev->dev, "etherdev alloc failed, aborting.\n");
1127 SET_NETDEV_DEV(dev, &pdev->dev);
1129 /* TODO: Actually, we have some interesting features... */
1132 bp = netdev_priv(dev);
1136 spin_lock_init(&bp->lock);
1138 #if defined(CONFIG_ARCH_AT91)
1139 bp->pclk = clk_get(&pdev->dev, "macb_clk");
1140 if (IS_ERR(bp->pclk)) {
1141 dev_err(&pdev->dev, "failed to get macb_clk\n");
1142 goto err_out_free_dev;
1144 clk_enable(bp->pclk);
1146 bp->pclk = clk_get(&pdev->dev, "pclk");
1147 if (IS_ERR(bp->pclk)) {
1148 dev_err(&pdev->dev, "failed to get pclk\n");
1149 goto err_out_free_dev;
1151 bp->hclk = clk_get(&pdev->dev, "hclk");
1152 if (IS_ERR(bp->hclk)) {
1153 dev_err(&pdev->dev, "failed to get hclk\n");
1154 goto err_out_put_pclk;
1157 clk_enable(bp->pclk);
1158 clk_enable(bp->hclk);
1161 bp->regs = ioremap(regs->start, regs->end - regs->start + 1);
1163 dev_err(&pdev->dev, "failed to map registers, aborting.\n");
1165 goto err_out_disable_clocks;
1168 dev->irq = platform_get_irq(pdev, 0);
1169 err = request_irq(dev->irq, macb_interrupt, IRQF_SAMPLE_RANDOM,
1173 "%s: Unable to request IRQ %d (error %d)\n",
1174 dev->name, dev->irq, err);
1175 goto err_out_iounmap;
1178 dev->netdev_ops = &macb_netdev_ops;
1179 netif_napi_add(dev, &bp->napi, macb_poll, 64);
1180 dev->ethtool_ops = &macb_ethtool_ops;
1182 dev->base_addr = regs->start;
1184 /* Set MII management clock divider */
1185 pclk_hz = clk_get_rate(bp->pclk);
1186 if (pclk_hz <= 20000000)
1187 config = MACB_BF(CLK, MACB_CLK_DIV8);
1188 else if (pclk_hz <= 40000000)
1189 config = MACB_BF(CLK, MACB_CLK_DIV16);
1190 else if (pclk_hz <= 80000000)
1191 config = MACB_BF(CLK, MACB_CLK_DIV32);
1193 config = MACB_BF(CLK, MACB_CLK_DIV64);
1194 macb_writel(bp, NCFGR, config);
1196 macb_get_hwaddr(bp);
1197 pdata = pdev->dev.platform_data;
1199 if (pdata && pdata->is_rmii)
1200 #if defined(CONFIG_ARCH_AT91)
1201 macb_writel(bp, USRIO, (MACB_BIT(RMII) | MACB_BIT(CLKEN)) );
1203 macb_writel(bp, USRIO, 0);
1206 #if defined(CONFIG_ARCH_AT91)
1207 macb_writel(bp, USRIO, MACB_BIT(CLKEN));
1209 macb_writel(bp, USRIO, MACB_BIT(MII));
1212 bp->tx_pending = DEF_TX_RING_PENDING;
1214 err = register_netdev(dev);
1216 dev_err(&pdev->dev, "Cannot register net device, aborting.\n");
1217 goto err_out_free_irq;
1220 if (macb_mii_init(bp) != 0) {
1221 goto err_out_unregister_netdev;
1224 platform_set_drvdata(pdev, dev);
1226 printk(KERN_INFO "%s: Atmel MACB at 0x%08lx irq %d (%pM)\n",
1227 dev->name, dev->base_addr, dev->irq, dev->dev_addr);
1229 phydev = bp->phy_dev;
1230 printk(KERN_INFO "%s: attached PHY driver [%s] "
1231 "(mii_bus:phy_addr=%s, irq=%d)\n", dev->name,
1232 phydev->drv->name, dev_name(&phydev->dev), phydev->irq);
1236 err_out_unregister_netdev:
1237 unregister_netdev(dev);
1239 free_irq(dev->irq, dev);
1242 err_out_disable_clocks:
1243 #ifndef CONFIG_ARCH_AT91
1244 clk_disable(bp->hclk);
1247 clk_disable(bp->pclk);
1248 #ifndef CONFIG_ARCH_AT91
1255 platform_set_drvdata(pdev, NULL);
1259 static int __exit macb_remove(struct platform_device *pdev)
1261 struct net_device *dev;
1264 dev = platform_get_drvdata(pdev);
1267 bp = netdev_priv(dev);
1269 phy_disconnect(bp->phy_dev);
1270 mdiobus_unregister(bp->mii_bus);
1271 kfree(bp->mii_bus->irq);
1272 mdiobus_free(bp->mii_bus);
1273 unregister_netdev(dev);
1274 free_irq(dev->irq, dev);
1276 #ifndef CONFIG_ARCH_AT91
1277 clk_disable(bp->hclk);
1280 clk_disable(bp->pclk);
1283 platform_set_drvdata(pdev, NULL);
1290 static int macb_suspend(struct platform_device *pdev, pm_message_t state)
1292 struct net_device *netdev = platform_get_drvdata(pdev);
1293 struct macb *bp = netdev_priv(netdev);
1295 netif_device_detach(netdev);
1297 #ifndef CONFIG_ARCH_AT91
1298 clk_disable(bp->hclk);
1300 clk_disable(bp->pclk);
1305 static int macb_resume(struct platform_device *pdev)
1307 struct net_device *netdev = platform_get_drvdata(pdev);
1308 struct macb *bp = netdev_priv(netdev);
1310 clk_enable(bp->pclk);
1311 #ifndef CONFIG_ARCH_AT91
1312 clk_enable(bp->hclk);
1315 netif_device_attach(netdev);
1320 #define macb_suspend NULL
1321 #define macb_resume NULL
1324 static struct platform_driver macb_driver = {
1325 .remove = __exit_p(macb_remove),
1326 .suspend = macb_suspend,
1327 .resume = macb_resume,
1330 .owner = THIS_MODULE,
1334 static int __init macb_init(void)
1336 return platform_driver_probe(&macb_driver, macb_probe);
1339 static void __exit macb_exit(void)
1341 platform_driver_unregister(&macb_driver);
1344 module_init(macb_init);
1345 module_exit(macb_exit);
1347 MODULE_LICENSE("GPL");
1348 MODULE_DESCRIPTION("Atmel MACB Ethernet driver");
1349 MODULE_AUTHOR("Haavard Skinnemoen <hskinnemoen@atmel.com>");
1350 MODULE_ALIAS("platform:macb");