2 * Ethernet driver for the Atmel AT91RM9200 (Thunder)
4 * Copyright (C) 2003 SAN People (Pty) Ltd
6 * Based on an earlier Atmel EMAC macrocell driver by Atmel and Lineo Inc.
7 * Initial version by Rick Bronson 01/11/2003
9 * Intel LXT971A PHY support by Christopher Bahns & David Knickerbocker
10 * (Polaroid Corporation)
12 * Realtek RTL8201(B)L PHY support by Roman Avramenko <roman@imsystems.ru>
14 * This program is free software; you can redistribute it and/or
15 * modify it under the terms of the GNU General Public License
16 * as published by the Free Software Foundation; either version
17 * 2 of the License, or (at your option) any later version.
20 #include <linux/module.h>
21 #include <linux/init.h>
22 #include <linux/mii.h>
23 #include <linux/netdevice.h>
24 #include <linux/etherdevice.h>
25 #include <linux/skbuff.h>
26 #include <linux/dma-mapping.h>
27 #include <linux/ethtool.h>
28 #include <linux/platform_device.h>
29 #include <linux/clk.h>
32 #include <asm/uaccess.h>
33 #include <asm/mach-types.h>
35 #include <asm/arch/at91rm9200_emac.h>
36 #include <asm/arch/gpio.h>
37 #include <asm/arch/board.h>
39 #include "at91_ether.h"
41 #define DRV_NAME "at91_ether"
42 #define DRV_VERSION "1.0"
44 static struct net_device *at91_dev;
46 static struct timer_list check_timer;
47 #define LINK_POLL_INTERVAL (HZ)
49 /* ..................................................................... */
52 * Read from a EMAC register.
54 static inline unsigned long at91_emac_read(unsigned int reg)
56 void __iomem *emac_base = (void __iomem *)AT91_VA_BASE_EMAC;
58 return __raw_readl(emac_base + reg);
62 * Write to a EMAC register.
64 static inline void at91_emac_write(unsigned int reg, unsigned long value)
66 void __iomem *emac_base = (void __iomem *)AT91_VA_BASE_EMAC;
68 __raw_writel(value, emac_base + reg);
71 /* ........................... PHY INTERFACE ........................... */
74 * Enable the MDIO bit in MAC control register
75 * When not called from an interrupt-handler, access to the PHY must be
76 * protected by a spinlock.
78 static void enable_mdi(void)
82 ctl = at91_emac_read(AT91_EMAC_CTL);
83 at91_emac_write(AT91_EMAC_CTL, ctl | AT91_EMAC_MPE); /* enable management port */
87 * Disable the MDIO bit in the MAC control register
89 static void disable_mdi(void)
93 ctl = at91_emac_read(AT91_EMAC_CTL);
94 at91_emac_write(AT91_EMAC_CTL, ctl & ~AT91_EMAC_MPE); /* disable management port */
98 * Wait until the PHY operation is complete.
100 static inline void at91_phy_wait(void) {
101 unsigned long timeout = jiffies + 2;
103 while (!(at91_emac_read(AT91_EMAC_SR) & AT91_EMAC_SR_IDLE)) {
104 if (time_after(jiffies, timeout)) {
105 printk("at91_ether: MIO timeout\n");
113 * Write value to the a PHY register
114 * Note: MDI interface is assumed to already have been enabled.
116 static void write_phy(unsigned char phy_addr, unsigned char address, unsigned int value)
118 at91_emac_write(AT91_EMAC_MAN, AT91_EMAC_MAN_802_3 | AT91_EMAC_RW_W
119 | ((phy_addr & 0x1f) << 23) | (address << 18) | (value & AT91_EMAC_DATA));
121 /* Wait until IDLE bit in Network Status register is cleared */
126 * Read value stored in a PHY register.
127 * Note: MDI interface is assumed to already have been enabled.
129 static void read_phy(unsigned char phy_addr, unsigned char address, unsigned int *value)
131 at91_emac_write(AT91_EMAC_MAN, AT91_EMAC_MAN_802_3 | AT91_EMAC_RW_R
132 | ((phy_addr & 0x1f) << 23) | (address << 18));
134 /* Wait until IDLE bit in Network Status register is cleared */
137 *value = at91_emac_read(AT91_EMAC_MAN) & AT91_EMAC_DATA;
140 /* ........................... PHY MANAGEMENT .......................... */
143 * Access the PHY to determine the current link speed and mode, and update the
145 * If no link or auto-negotiation is busy, then no changes are made.
147 static void update_linkspeed(struct net_device *dev, int silent)
149 struct at91_private *lp = (struct at91_private *) dev->priv;
150 unsigned int bmsr, bmcr, lpa, mac_cfg;
151 unsigned int speed, duplex;
153 if (!mii_link_ok(&lp->mii)) { /* no link */
154 netif_carrier_off(dev);
156 printk(KERN_INFO "%s: Link down.\n", dev->name);
160 /* Link up, or auto-negotiation still in progress */
161 read_phy(lp->phy_address, MII_BMSR, &bmsr);
162 read_phy(lp->phy_address, MII_BMCR, &bmcr);
163 if (bmcr & BMCR_ANENABLE) { /* AutoNegotiation is enabled */
164 if (!(bmsr & BMSR_ANEGCOMPLETE))
165 return; /* Do nothing - another interrupt generated when negotiation complete */
167 read_phy(lp->phy_address, MII_LPA, &lpa);
168 if ((lpa & LPA_100FULL) || (lpa & LPA_100HALF)) speed = SPEED_100;
169 else speed = SPEED_10;
170 if ((lpa & LPA_100FULL) || (lpa & LPA_10FULL)) duplex = DUPLEX_FULL;
171 else duplex = DUPLEX_HALF;
173 speed = (bmcr & BMCR_SPEED100) ? SPEED_100 : SPEED_10;
174 duplex = (bmcr & BMCR_FULLDPLX) ? DUPLEX_FULL : DUPLEX_HALF;
178 mac_cfg = at91_emac_read(AT91_EMAC_CFG) & ~(AT91_EMAC_SPD | AT91_EMAC_FD);
179 if (speed == SPEED_100) {
180 if (duplex == DUPLEX_FULL) /* 100 Full Duplex */
181 mac_cfg |= AT91_EMAC_SPD | AT91_EMAC_FD;
182 else /* 100 Half Duplex */
183 mac_cfg |= AT91_EMAC_SPD;
185 if (duplex == DUPLEX_FULL) /* 10 Full Duplex */
186 mac_cfg |= AT91_EMAC_FD;
187 else {} /* 10 Half Duplex */
189 at91_emac_write(AT91_EMAC_CFG, mac_cfg);
192 printk(KERN_INFO "%s: Link now %i-%s\n", dev->name, speed, (duplex == DUPLEX_FULL) ? "FullDuplex" : "HalfDuplex");
193 netif_carrier_on(dev);
197 * Handle interrupts from the PHY
199 static irqreturn_t at91ether_phy_interrupt(int irq, void *dev_id, struct pt_regs *regs)
201 struct net_device *dev = (struct net_device *) dev_id;
202 struct at91_private *lp = (struct at91_private *) dev->priv;
206 * This hander is triggered on both edges, but the PHY chips expect
207 * level-triggering. We therefore have to check if the PHY actually has
211 if ((lp->phy_type == MII_DM9161_ID) || (lp->phy_type == MII_DM9161A_ID)) {
212 read_phy(lp->phy_address, MII_DSINTR_REG, &phy); /* ack interrupt in Davicom PHY */
213 if (!(phy & (1 << 0)))
216 else if (lp->phy_type == MII_LXT971A_ID) {
217 read_phy(lp->phy_address, MII_ISINTS_REG, &phy); /* ack interrupt in Intel PHY */
218 if (!(phy & (1 << 2)))
221 else if (lp->phy_type == MII_BCM5221_ID) {
222 read_phy(lp->phy_address, MII_BCMINTR_REG, &phy); /* ack interrupt in Broadcom PHY */
223 if (!(phy & (1 << 0)))
226 else if (lp->phy_type == MII_KS8721_ID) {
227 read_phy(lp->phy_address, MII_TPISTATUS, &phy); /* ack interrupt in Micrel PHY */
228 if (!(phy & ((1 << 2) | 1)))
232 update_linkspeed(dev, 0);
241 * Initialize and enable the PHY interrupt for link-state changes
243 static void enable_phyirq(struct net_device *dev)
245 struct at91_private *lp = (struct at91_private *) dev->priv;
246 unsigned int dsintr, irq_number;
249 irq_number = lp->board_data.phy_irq_pin;
252 * PHY doesn't have an IRQ pin (RTL8201, DP83847, AC101L),
253 * or board does not have it connected.
255 check_timer.expires = jiffies + LINK_POLL_INTERVAL;
256 add_timer(&check_timer);
260 status = request_irq(irq_number, at91ether_phy_interrupt, 0, dev->name, dev);
262 printk(KERN_ERR "at91_ether: PHY IRQ %d request failed - status %d!\n", irq_number, status);
266 spin_lock_irq(&lp->lock);
269 if ((lp->phy_type == MII_DM9161_ID) || (lp->phy_type == MII_DM9161A_ID)) { /* for Davicom PHY */
270 read_phy(lp->phy_address, MII_DSINTR_REG, &dsintr);
271 dsintr = dsintr & ~0xf00; /* clear bits 8..11 */
272 write_phy(lp->phy_address, MII_DSINTR_REG, dsintr);
274 else if (lp->phy_type == MII_LXT971A_ID) { /* for Intel PHY */
275 read_phy(lp->phy_address, MII_ISINTE_REG, &dsintr);
276 dsintr = dsintr | 0xf2; /* set bits 1, 4..7 */
277 write_phy(lp->phy_address, MII_ISINTE_REG, dsintr);
279 else if (lp->phy_type == MII_BCM5221_ID) { /* for Broadcom PHY */
280 dsintr = (1 << 15) | ( 1 << 14);
281 write_phy(lp->phy_address, MII_BCMINTR_REG, dsintr);
283 else if (lp->phy_type == MII_KS8721_ID) { /* for Micrel PHY */
284 dsintr = (1 << 10) | ( 1 << 8);
285 write_phy(lp->phy_address, MII_TPISTATUS, dsintr);
289 spin_unlock_irq(&lp->lock);
293 * Disable the PHY interrupt
295 static void disable_phyirq(struct net_device *dev)
297 struct at91_private *lp = (struct at91_private *) dev->priv;
299 unsigned int irq_number;
301 irq_number = lp->board_data.phy_irq_pin;
303 del_timer_sync(&check_timer);
307 spin_lock_irq(&lp->lock);
310 if ((lp->phy_type == MII_DM9161_ID) || (lp->phy_type == MII_DM9161A_ID)) { /* for Davicom PHY */
311 read_phy(lp->phy_address, MII_DSINTR_REG, &dsintr);
312 dsintr = dsintr | 0xf00; /* set bits 8..11 */
313 write_phy(lp->phy_address, MII_DSINTR_REG, dsintr);
315 else if (lp->phy_type == MII_LXT971A_ID) { /* for Intel PHY */
316 read_phy(lp->phy_address, MII_ISINTE_REG, &dsintr);
317 dsintr = dsintr & ~0xf2; /* clear bits 1, 4..7 */
318 write_phy(lp->phy_address, MII_ISINTE_REG, dsintr);
320 else if (lp->phy_type == MII_BCM5221_ID) { /* for Broadcom PHY */
321 read_phy(lp->phy_address, MII_BCMINTR_REG, &dsintr);
323 write_phy(lp->phy_address, MII_BCMINTR_REG, dsintr);
325 else if (lp->phy_type == MII_KS8721_ID) { /* for Micrel PHY */
326 read_phy(lp->phy_address, MII_TPISTATUS, &dsintr);
327 dsintr = ~((1 << 10) | (1 << 8));
328 write_phy(lp->phy_address, MII_TPISTATUS, dsintr);
332 spin_unlock_irq(&lp->lock);
334 free_irq(irq_number, dev); /* Free interrupt handler */
338 * Perform a software reset of the PHY.
341 static void reset_phy(struct net_device *dev)
343 struct at91_private *lp = (struct at91_private *) dev->priv;
346 spin_lock_irq(&lp->lock);
349 /* Perform PHY reset */
350 write_phy(lp->phy_address, MII_BMCR, BMCR_RESET);
352 /* Wait until PHY reset is complete */
354 read_phy(lp->phy_address, MII_BMCR, &bmcr);
355 } while (!(bmcr && BMCR_RESET));
358 spin_unlock_irq(&lp->lock);
362 static void at91ether_check_link(unsigned long dev_id)
364 struct net_device *dev = (struct net_device *) dev_id;
367 update_linkspeed(dev, 1);
370 check_timer.expires = jiffies + LINK_POLL_INTERVAL;
371 add_timer(&check_timer);
374 /* ......................... ADDRESS MANAGEMENT ........................ */
377 * NOTE: Your bootloader must always set the MAC address correctly before
378 * booting into Linux.
380 * - It must always set the MAC address after reset, even if it doesn't
381 * happen to access the Ethernet while it's booting. Some versions of
382 * U-Boot on the AT91RM9200-DK do not do this.
384 * - Likewise it must store the addresses in the correct byte order.
385 * MicroMonitor (uMon) on the CSB337 does this incorrectly (and
386 * continues to do so, for bug-compatibility).
389 static short __init unpack_mac_address(struct net_device *dev, unsigned int hi, unsigned int lo)
393 if (machine_is_csb337()) {
394 addr[5] = (lo & 0xff); /* The CSB337 bootloader stores the MAC the wrong-way around */
395 addr[4] = (lo & 0xff00) >> 8;
396 addr[3] = (lo & 0xff0000) >> 16;
397 addr[2] = (lo & 0xff000000) >> 24;
398 addr[1] = (hi & 0xff);
399 addr[0] = (hi & 0xff00) >> 8;
402 addr[0] = (lo & 0xff);
403 addr[1] = (lo & 0xff00) >> 8;
404 addr[2] = (lo & 0xff0000) >> 16;
405 addr[3] = (lo & 0xff000000) >> 24;
406 addr[4] = (hi & 0xff);
407 addr[5] = (hi & 0xff00) >> 8;
410 if (is_valid_ether_addr(addr)) {
411 memcpy(dev->dev_addr, &addr, 6);
418 * Set the ethernet MAC address in dev->dev_addr
420 static void __init get_mac_address(struct net_device *dev)
422 /* Check Specific-Address 1 */
423 if (unpack_mac_address(dev, at91_emac_read(AT91_EMAC_SA1H), at91_emac_read(AT91_EMAC_SA1L)))
425 /* Check Specific-Address 2 */
426 if (unpack_mac_address(dev, at91_emac_read(AT91_EMAC_SA2H), at91_emac_read(AT91_EMAC_SA2L)))
428 /* Check Specific-Address 3 */
429 if (unpack_mac_address(dev, at91_emac_read(AT91_EMAC_SA3H), at91_emac_read(AT91_EMAC_SA3L)))
431 /* Check Specific-Address 4 */
432 if (unpack_mac_address(dev, at91_emac_read(AT91_EMAC_SA4H), at91_emac_read(AT91_EMAC_SA4L)))
435 printk(KERN_ERR "at91_ether: Your bootloader did not configure a MAC address.\n");
439 * Program the hardware MAC address from dev->dev_addr.
441 static void update_mac_address(struct net_device *dev)
443 at91_emac_write(AT91_EMAC_SA1L, (dev->dev_addr[3] << 24) | (dev->dev_addr[2] << 16) | (dev->dev_addr[1] << 8) | (dev->dev_addr[0]));
444 at91_emac_write(AT91_EMAC_SA1H, (dev->dev_addr[5] << 8) | (dev->dev_addr[4]));
446 at91_emac_write(AT91_EMAC_SA2L, 0);
447 at91_emac_write(AT91_EMAC_SA2H, 0);
451 * Store the new hardware address in dev->dev_addr, and update the MAC.
453 static int set_mac_address(struct net_device *dev, void* addr)
455 struct sockaddr *address = addr;
457 if (!is_valid_ether_addr(address->sa_data))
458 return -EADDRNOTAVAIL;
460 memcpy(dev->dev_addr, address->sa_data, dev->addr_len);
461 update_mac_address(dev);
463 printk("%s: Setting MAC address to %02x:%02x:%02x:%02x:%02x:%02x\n", dev->name,
464 dev->dev_addr[0], dev->dev_addr[1], dev->dev_addr[2],
465 dev->dev_addr[3], dev->dev_addr[4], dev->dev_addr[5]);
470 static int inline hash_bit_value(int bitnr, __u8 *addr)
472 if (addr[bitnr / 8] & (1 << (bitnr % 8)))
478 * The hash address register is 64 bits long and takes up two locations in the memory map.
479 * The least significant bits are stored in EMAC_HSL and the most significant
482 * The unicast hash enable and the multicast hash enable bits in the network configuration
483 * register enable the reception of hash matched frames. The destination address is
484 * reduced to a 6 bit index into the 64 bit hash register using the following hash function.
485 * The hash function is an exclusive or of every sixth bit of the destination address.
486 * hash_index[5] = da[5] ^ da[11] ^ da[17] ^ da[23] ^ da[29] ^ da[35] ^ da[41] ^ da[47]
487 * hash_index[4] = da[4] ^ da[10] ^ da[16] ^ da[22] ^ da[28] ^ da[34] ^ da[40] ^ da[46]
488 * hash_index[3] = da[3] ^ da[09] ^ da[15] ^ da[21] ^ da[27] ^ da[33] ^ da[39] ^ da[45]
489 * hash_index[2] = da[2] ^ da[08] ^ da[14] ^ da[20] ^ da[26] ^ da[32] ^ da[38] ^ da[44]
490 * hash_index[1] = da[1] ^ da[07] ^ da[13] ^ da[19] ^ da[25] ^ da[31] ^ da[37] ^ da[43]
491 * hash_index[0] = da[0] ^ da[06] ^ da[12] ^ da[18] ^ da[24] ^ da[30] ^ da[36] ^ da[42]
492 * da[0] represents the least significant bit of the first byte received, that is, the multicast/
493 * unicast indicator, and da[47] represents the most significant bit of the last byte
495 * If the hash index points to a bit that is set in the hash register then the frame will be
496 * matched according to whether the frame is multicast or unicast.
497 * A multicast match will be signalled if the multicast hash enable bit is set, da[0] is 1 and
498 * the hash index points to a bit set in the hash register.
499 * A unicast match will be signalled if the unicast hash enable bit is set, da[0] is 0 and the
500 * hash index points to a bit set in the hash register.
501 * To receive all multicast frames, the hash register should be set with all ones and the
502 * multicast hash enable bit should be set in the network configuration register.
506 * Return the hash index value for the specified address.
508 static int hash_get_index(__u8 *addr)
513 for (j = 0; j < 6; j++) {
514 for (i = 0, bitval = 0; i < 8; i++)
515 bitval ^= hash_bit_value(i*6 + j, addr);
517 hash_index |= (bitval << j);
524 * Add multicast addresses to the internal multicast-hash table.
526 static void at91ether_sethashtable(struct net_device *dev)
528 struct dev_mc_list *curr;
529 unsigned long mc_filter[2];
530 unsigned int i, bitnr;
532 mc_filter[0] = mc_filter[1] = 0;
535 for (i = 0; i < dev->mc_count; i++, curr = curr->next) {
536 if (!curr) break; /* unexpected end of list */
538 bitnr = hash_get_index(curr->dmi_addr);
539 mc_filter[bitnr >> 5] |= 1 << (bitnr & 31);
542 at91_emac_write(AT91_EMAC_HSH, mc_filter[0]);
543 at91_emac_write(AT91_EMAC_HSL, mc_filter[1]);
547 * Enable/Disable promiscuous and multicast modes.
549 static void at91ether_set_rx_mode(struct net_device *dev)
553 cfg = at91_emac_read(AT91_EMAC_CFG);
555 if (dev->flags & IFF_PROMISC) /* Enable promiscuous mode */
556 cfg |= AT91_EMAC_CAF;
557 else if (dev->flags & (~IFF_PROMISC)) /* Disable promiscuous mode */
558 cfg &= ~AT91_EMAC_CAF;
560 if (dev->flags & IFF_ALLMULTI) { /* Enable all multicast mode */
561 at91_emac_write(AT91_EMAC_HSH, -1);
562 at91_emac_write(AT91_EMAC_HSL, -1);
563 cfg |= AT91_EMAC_MTI;
564 } else if (dev->mc_count > 0) { /* Enable specific multicasts */
565 at91ether_sethashtable(dev);
566 cfg |= AT91_EMAC_MTI;
567 } else if (dev->flags & (~IFF_ALLMULTI)) { /* Disable all multicast mode */
568 at91_emac_write(AT91_EMAC_HSH, 0);
569 at91_emac_write(AT91_EMAC_HSL, 0);
570 cfg &= ~AT91_EMAC_MTI;
573 at91_emac_write(AT91_EMAC_CFG, cfg);
576 /* ......................... ETHTOOL SUPPORT ........................... */
578 static int mdio_read(struct net_device *dev, int phy_id, int location)
582 read_phy(phy_id, location, &value);
586 static void mdio_write(struct net_device *dev, int phy_id, int location, int value)
588 write_phy(phy_id, location, value);
591 static int at91ether_get_settings(struct net_device *dev, struct ethtool_cmd *cmd)
593 struct at91_private *lp = (struct at91_private *) dev->priv;
596 spin_lock_irq(&lp->lock);
599 ret = mii_ethtool_gset(&lp->mii, cmd);
602 spin_unlock_irq(&lp->lock);
604 if (lp->phy_media == PORT_FIBRE) { /* override media type since mii.c doesn't know */
605 cmd->supported = SUPPORTED_FIBRE;
606 cmd->port = PORT_FIBRE;
612 static int at91ether_set_settings(struct net_device *dev, struct ethtool_cmd *cmd)
614 struct at91_private *lp = (struct at91_private *) dev->priv;
617 spin_lock_irq(&lp->lock);
620 ret = mii_ethtool_sset(&lp->mii, cmd);
623 spin_unlock_irq(&lp->lock);
628 static int at91ether_nwayreset(struct net_device *dev)
630 struct at91_private *lp = (struct at91_private *) dev->priv;
633 spin_lock_irq(&lp->lock);
636 ret = mii_nway_restart(&lp->mii);
639 spin_unlock_irq(&lp->lock);
644 static void at91ether_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info)
646 strlcpy(info->driver, DRV_NAME, sizeof(info->driver));
647 strlcpy(info->version, DRV_VERSION, sizeof(info->version));
648 strlcpy(info->bus_info, dev->class_dev.dev->bus_id, sizeof(info->bus_info));
651 static const struct ethtool_ops at91ether_ethtool_ops = {
652 .get_settings = at91ether_get_settings,
653 .set_settings = at91ether_set_settings,
654 .get_drvinfo = at91ether_get_drvinfo,
655 .nway_reset = at91ether_nwayreset,
656 .get_link = ethtool_op_get_link,
659 static int at91ether_ioctl(struct net_device *dev, struct ifreq *rq, int cmd)
661 struct at91_private *lp = (struct at91_private *) dev->priv;
664 if (!netif_running(dev))
667 spin_lock_irq(&lp->lock);
669 res = generic_mii_ioctl(&lp->mii, if_mii(rq), cmd, NULL);
671 spin_unlock_irq(&lp->lock);
676 /* ................................ MAC ................................ */
679 * Initialize and start the Receiver and Transmit subsystems
681 static void at91ether_start(struct net_device *dev)
683 struct at91_private *lp = (struct at91_private *) dev->priv;
684 struct recv_desc_bufs *dlist, *dlist_phys;
689 dlist_phys = lp->dlist_phys;
691 for (i = 0; i < MAX_RX_DESCR; i++) {
692 dlist->descriptors[i].addr = (unsigned int) &dlist_phys->recv_buf[i][0];
693 dlist->descriptors[i].size = 0;
696 /* Set the Wrap bit on the last descriptor */
697 dlist->descriptors[i-1].addr |= EMAC_DESC_WRAP;
699 /* Reset buffer index */
702 /* Program address of descriptor list in Rx Buffer Queue register */
703 at91_emac_write(AT91_EMAC_RBQP, (unsigned long) dlist_phys);
705 /* Enable Receive and Transmit */
706 ctl = at91_emac_read(AT91_EMAC_CTL);
707 at91_emac_write(AT91_EMAC_CTL, ctl | AT91_EMAC_RE | AT91_EMAC_TE);
711 * Open the ethernet interface
713 static int at91ether_open(struct net_device *dev)
715 struct at91_private *lp = (struct at91_private *) dev->priv;
718 if (!is_valid_ether_addr(dev->dev_addr))
719 return -EADDRNOTAVAIL;
721 clk_enable(lp->ether_clk); /* Re-enable Peripheral clock */
723 /* Clear internal statistics */
724 ctl = at91_emac_read(AT91_EMAC_CTL);
725 at91_emac_write(AT91_EMAC_CTL, ctl | AT91_EMAC_CSR);
727 /* Update the MAC address (incase user has changed it) */
728 update_mac_address(dev);
730 /* Enable PHY interrupt */
733 /* Enable MAC interrupts */
734 at91_emac_write(AT91_EMAC_IER, AT91_EMAC_RCOM | AT91_EMAC_RBNA
735 | AT91_EMAC_TUND | AT91_EMAC_RTRY | AT91_EMAC_TCOM
736 | AT91_EMAC_ROVR | AT91_EMAC_ABT);
738 /* Determine current link speed */
739 spin_lock_irq(&lp->lock);
741 update_linkspeed(dev, 0);
743 spin_unlock_irq(&lp->lock);
745 at91ether_start(dev);
746 netif_start_queue(dev);
751 * Close the interface
753 static int at91ether_close(struct net_device *dev)
755 struct at91_private *lp = (struct at91_private *) dev->priv;
758 /* Disable Receiver and Transmitter */
759 ctl = at91_emac_read(AT91_EMAC_CTL);
760 at91_emac_write(AT91_EMAC_CTL, ctl & ~(AT91_EMAC_TE | AT91_EMAC_RE));
762 /* Disable PHY interrupt */
765 /* Disable MAC interrupts */
766 at91_emac_write(AT91_EMAC_IDR, AT91_EMAC_RCOM | AT91_EMAC_RBNA
767 | AT91_EMAC_TUND | AT91_EMAC_RTRY | AT91_EMAC_TCOM
768 | AT91_EMAC_ROVR | AT91_EMAC_ABT);
770 netif_stop_queue(dev);
772 clk_disable(lp->ether_clk); /* Disable Peripheral clock */
780 static int at91ether_tx(struct sk_buff *skb, struct net_device *dev)
782 struct at91_private *lp = (struct at91_private *) dev->priv;
784 if (at91_emac_read(AT91_EMAC_TSR) & AT91_EMAC_TSR_BNQ) {
785 netif_stop_queue(dev);
787 /* Store packet information (to free when Tx completed) */
789 lp->skb_length = skb->len;
790 lp->skb_physaddr = dma_map_single(NULL, skb->data, skb->len, DMA_TO_DEVICE);
791 lp->stats.tx_bytes += skb->len;
793 /* Set address of the data in the Transmit Address register */
794 at91_emac_write(AT91_EMAC_TAR, lp->skb_physaddr);
795 /* Set length of the packet in the Transmit Control register */
796 at91_emac_write(AT91_EMAC_TCR, skb->len);
798 dev->trans_start = jiffies;
800 printk(KERN_ERR "at91_ether.c: at91ether_tx() called, but device is busy!\n");
801 return 1; /* if we return anything but zero, dev.c:1055 calls kfree_skb(skb)
802 on this skb, he also reports -ENETDOWN and printk's, so either
803 we free and return(0) or don't free and return 1 */
810 * Update the current statistics from the internal statistics registers.
812 static struct net_device_stats *at91ether_stats(struct net_device *dev)
814 struct at91_private *lp = (struct at91_private *) dev->priv;
815 int ale, lenerr, seqe, lcol, ecol;
817 if (netif_running(dev)) {
818 lp->stats.rx_packets += at91_emac_read(AT91_EMAC_OK); /* Good frames received */
819 ale = at91_emac_read(AT91_EMAC_ALE);
820 lp->stats.rx_frame_errors += ale; /* Alignment errors */
821 lenerr = at91_emac_read(AT91_EMAC_ELR) + at91_emac_read(AT91_EMAC_USF);
822 lp->stats.rx_length_errors += lenerr; /* Excessive Length or Undersize Frame error */
823 seqe = at91_emac_read(AT91_EMAC_SEQE);
824 lp->stats.rx_crc_errors += seqe; /* CRC error */
825 lp->stats.rx_fifo_errors += at91_emac_read(AT91_EMAC_DRFC); /* Receive buffer not available */
826 lp->stats.rx_errors += (ale + lenerr + seqe
827 + at91_emac_read(AT91_EMAC_CDE) + at91_emac_read(AT91_EMAC_RJB));
829 lp->stats.tx_packets += at91_emac_read(AT91_EMAC_FRA); /* Frames successfully transmitted */
830 lp->stats.tx_fifo_errors += at91_emac_read(AT91_EMAC_TUE); /* Transmit FIFO underruns */
831 lp->stats.tx_carrier_errors += at91_emac_read(AT91_EMAC_CSE); /* Carrier Sense errors */
832 lp->stats.tx_heartbeat_errors += at91_emac_read(AT91_EMAC_SQEE);/* Heartbeat error */
834 lcol = at91_emac_read(AT91_EMAC_LCOL);
835 ecol = at91_emac_read(AT91_EMAC_ECOL);
836 lp->stats.tx_window_errors += lcol; /* Late collisions */
837 lp->stats.tx_aborted_errors += ecol; /* 16 collisions */
839 lp->stats.collisions += (at91_emac_read(AT91_EMAC_SCOL) + at91_emac_read(AT91_EMAC_MCOL) + lcol + ecol);
845 * Extract received frame from buffer descriptors and sent to upper layers.
846 * (Called from interrupt context)
848 static void at91ether_rx(struct net_device *dev)
850 struct at91_private *lp = (struct at91_private *) dev->priv;
851 struct recv_desc_bufs *dlist;
852 unsigned char *p_recv;
857 while (dlist->descriptors[lp->rxBuffIndex].addr & EMAC_DESC_DONE) {
858 p_recv = dlist->recv_buf[lp->rxBuffIndex];
859 pktlen = dlist->descriptors[lp->rxBuffIndex].size & 0x7ff; /* Length of frame including FCS */
860 skb = alloc_skb(pktlen + 2, GFP_ATOMIC);
863 memcpy(skb_put(skb, pktlen), p_recv, pktlen);
866 skb->protocol = eth_type_trans(skb, dev);
868 dev->last_rx = jiffies;
869 lp->stats.rx_bytes += pktlen;
873 lp->stats.rx_dropped += 1;
874 printk(KERN_NOTICE "%s: Memory squeeze, dropping packet.\n", dev->name);
877 if (dlist->descriptors[lp->rxBuffIndex].size & EMAC_MULTICAST)
878 lp->stats.multicast++;
880 dlist->descriptors[lp->rxBuffIndex].addr &= ~EMAC_DESC_DONE; /* reset ownership bit */
881 if (lp->rxBuffIndex == MAX_RX_DESCR-1) /* wrap after last buffer */
889 * MAC interrupt handler
891 static irqreturn_t at91ether_interrupt(int irq, void *dev_id, struct pt_regs *regs)
893 struct net_device *dev = (struct net_device *) dev_id;
894 struct at91_private *lp = (struct at91_private *) dev->priv;
895 unsigned long intstatus, ctl;
897 /* MAC Interrupt Status register indicates what interrupts are pending.
898 It is automatically cleared once read. */
899 intstatus = at91_emac_read(AT91_EMAC_ISR);
901 if (intstatus & AT91_EMAC_RCOM) /* Receive complete */
904 if (intstatus & AT91_EMAC_TCOM) { /* Transmit complete */
905 /* The TCOM bit is set even if the transmission failed. */
906 if (intstatus & (AT91_EMAC_TUND | AT91_EMAC_RTRY))
907 lp->stats.tx_errors += 1;
910 dev_kfree_skb_irq(lp->skb);
912 dma_unmap_single(NULL, lp->skb_physaddr, lp->skb_length, DMA_TO_DEVICE);
914 netif_wake_queue(dev);
917 /* Work-around for Errata #11 */
918 if (intstatus & AT91_EMAC_RBNA) {
919 ctl = at91_emac_read(AT91_EMAC_CTL);
920 at91_emac_write(AT91_EMAC_CTL, ctl & ~AT91_EMAC_RE);
921 at91_emac_write(AT91_EMAC_CTL, ctl | AT91_EMAC_RE);
924 if (intstatus & AT91_EMAC_ROVR)
925 printk("%s: ROVR error\n", dev->name);
931 * Initialize the ethernet interface
933 static int __init at91ether_setup(unsigned long phy_type, unsigned short phy_address,
934 struct platform_device *pdev, struct clk *ether_clk)
936 struct at91_eth_data *board_data = pdev->dev.platform_data;
937 struct net_device *dev;
938 struct at91_private *lp;
942 if (at91_dev) /* already initialized */
945 dev = alloc_etherdev(sizeof(struct at91_private));
949 dev->base_addr = AT91_VA_BASE_EMAC;
950 dev->irq = AT91_ID_EMAC;
951 SET_MODULE_OWNER(dev);
953 /* Install the interrupt handler */
954 if (request_irq(dev->irq, at91ether_interrupt, 0, dev->name, dev)) {
959 /* Allocate memory for DMA Receive descriptors */
960 lp = (struct at91_private *)dev->priv;
961 lp->dlist = (struct recv_desc_bufs *) dma_alloc_coherent(NULL, sizeof(struct recv_desc_bufs), (dma_addr_t *) &lp->dlist_phys, GFP_KERNEL);
962 if (lp->dlist == NULL) {
963 free_irq(dev->irq, dev);
967 lp->board_data = *board_data;
968 lp->ether_clk = ether_clk;
969 platform_set_drvdata(pdev, dev);
971 spin_lock_init(&lp->lock);
974 dev->open = at91ether_open;
975 dev->stop = at91ether_close;
976 dev->hard_start_xmit = at91ether_tx;
977 dev->get_stats = at91ether_stats;
978 dev->set_multicast_list = at91ether_set_rx_mode;
979 dev->set_mac_address = set_mac_address;
980 dev->ethtool_ops = &at91ether_ethtool_ops;
981 dev->do_ioctl = at91ether_ioctl;
983 SET_NETDEV_DEV(dev, &pdev->dev);
985 get_mac_address(dev); /* Get ethernet address and store it in dev->dev_addr */
986 update_mac_address(dev); /* Program ethernet address into MAC */
988 at91_emac_write(AT91_EMAC_CTL, 0);
990 if (lp->board_data.is_rmii)
991 at91_emac_write(AT91_EMAC_CFG, AT91_EMAC_CLK_DIV32 | AT91_EMAC_BIG | AT91_EMAC_RMII);
993 at91_emac_write(AT91_EMAC_CFG, AT91_EMAC_CLK_DIV32 | AT91_EMAC_BIG);
995 /* Perform PHY-specific initialization */
996 spin_lock_irq(&lp->lock);
998 if ((phy_type == MII_DM9161_ID) || (lp->phy_type == MII_DM9161A_ID)) {
999 read_phy(phy_address, MII_DSCR_REG, &val);
1000 if ((val & (1 << 10)) == 0) /* DSCR bit 10 is 0 -- fiber mode */
1001 lp->phy_media = PORT_FIBRE;
1002 } else if (machine_is_csb337()) {
1003 /* mix link activity status into LED2 link state */
1004 write_phy(phy_address, MII_LEDCTRL_REG, 0x0d22);
1007 spin_unlock_irq(&lp->lock);
1009 lp->mii.dev = dev; /* Support for ethtool */
1010 lp->mii.mdio_read = mdio_read;
1011 lp->mii.mdio_write = mdio_write;
1012 lp->mii.phy_id = phy_address;
1013 lp->mii.phy_id_mask = 0x1f;
1014 lp->mii.reg_num_mask = 0x1f;
1016 lp->phy_type = phy_type; /* Type of PHY connected */
1017 lp->phy_address = phy_address; /* MDI address of PHY */
1019 /* Register the network interface */
1020 res = register_netdev(dev);
1022 free_irq(dev->irq, dev);
1024 dma_free_coherent(NULL, sizeof(struct recv_desc_bufs), lp->dlist, (dma_addr_t)lp->dlist_phys);
1029 /* Determine current link speed */
1030 spin_lock_irq(&lp->lock);
1032 update_linkspeed(dev, 0);
1034 spin_unlock_irq(&lp->lock);
1035 netif_carrier_off(dev); /* will be enabled in open() */
1037 /* If board has no PHY IRQ, use a timer to poll the PHY */
1038 if (!lp->board_data.phy_irq_pin) {
1039 init_timer(&check_timer);
1040 check_timer.data = (unsigned long)dev;
1041 check_timer.function = at91ether_check_link;
1044 /* Display ethernet banner */
1045 printk(KERN_INFO "%s: AT91 ethernet at 0x%08x int=%d %s%s (%02x:%02x:%02x:%02x:%02x:%02x)\n",
1046 dev->name, (uint) dev->base_addr, dev->irq,
1047 at91_emac_read(AT91_EMAC_CFG) & AT91_EMAC_SPD ? "100-" : "10-",
1048 at91_emac_read(AT91_EMAC_CFG) & AT91_EMAC_FD ? "FullDuplex" : "HalfDuplex",
1049 dev->dev_addr[0], dev->dev_addr[1], dev->dev_addr[2],
1050 dev->dev_addr[3], dev->dev_addr[4], dev->dev_addr[5]);
1051 if ((phy_type == MII_DM9161_ID) || (lp->phy_type == MII_DM9161A_ID))
1052 printk(KERN_INFO "%s: Davicom 9161 PHY %s\n", dev->name, (lp->phy_media == PORT_FIBRE) ? "(Fiber)" : "(Copper)");
1053 else if (phy_type == MII_LXT971A_ID)
1054 printk(KERN_INFO "%s: Intel LXT971A PHY\n", dev->name);
1055 else if (phy_type == MII_RTL8201_ID)
1056 printk(KERN_INFO "%s: Realtek RTL8201(B)L PHY\n", dev->name);
1057 else if (phy_type == MII_BCM5221_ID)
1058 printk(KERN_INFO "%s: Broadcom BCM5221 PHY\n", dev->name);
1059 else if (phy_type == MII_DP83847_ID)
1060 printk(KERN_INFO "%s: National Semiconductor DP83847 PHY\n", dev->name);
1061 else if (phy_type == MII_AC101L_ID)
1062 printk(KERN_INFO "%s: Altima AC101L PHY\n", dev->name);
1063 else if (phy_type == MII_KS8721_ID)
1064 printk(KERN_INFO "%s: Micrel KS8721 PHY\n", dev->name);
1070 * Detect MAC and PHY and perform initialization
1072 static int __init at91ether_probe(struct platform_device *pdev)
1074 unsigned int phyid1, phyid2;
1076 unsigned long phy_id;
1077 unsigned short phy_address = 0;
1078 struct clk *ether_clk;
1080 ether_clk = clk_get(&pdev->dev, "ether_clk");
1081 if (IS_ERR(ether_clk)) {
1082 printk(KERN_ERR "at91_ether: no clock defined\n");
1085 clk_enable(ether_clk); /* Enable Peripheral clock */
1087 while ((detected != 0) && (phy_address < 32)) {
1088 /* Read the PHY ID registers */
1090 read_phy(phy_address, MII_PHYSID1, &phyid1);
1091 read_phy(phy_address, MII_PHYSID2, &phyid2);
1094 phy_id = (phyid1 << 16) | (phyid2 & 0xfff0);
1096 case MII_DM9161_ID: /* Davicom 9161: PHY_ID1 = 0x181, PHY_ID2 = B881 */
1097 case MII_DM9161A_ID: /* Davicom 9161A: PHY_ID1 = 0x181, PHY_ID2 = B8A0 */
1098 case MII_LXT971A_ID: /* Intel LXT971A: PHY_ID1 = 0x13, PHY_ID2 = 78E0 */
1099 case MII_RTL8201_ID: /* Realtek RTL8201: PHY_ID1 = 0, PHY_ID2 = 0x8201 */
1100 case MII_BCM5221_ID: /* Broadcom BCM5221: PHY_ID1 = 0x40, PHY_ID2 = 0x61e0 */
1101 case MII_DP83847_ID: /* National Semiconductor DP83847: */
1102 case MII_AC101L_ID: /* Altima AC101L: PHY_ID1 = 0x22, PHY_ID2 = 0x5520 */
1103 case MII_KS8721_ID: /* Micrel KS8721: PHY_ID1 = 0x22, PHY_ID2 = 0x1610 */
1104 detected = at91ether_setup(phy_id, phy_address, pdev, ether_clk);
1111 clk_disable(ether_clk); /* Disable Peripheral clock */
1116 static int __devexit at91ether_remove(struct platform_device *pdev)
1118 struct at91_private *lp = (struct at91_private *) at91_dev->priv;
1120 unregister_netdev(at91_dev);
1121 free_irq(at91_dev->irq, at91_dev);
1122 dma_free_coherent(NULL, sizeof(struct recv_desc_bufs), lp->dlist, (dma_addr_t)lp->dlist_phys);
1123 clk_put(lp->ether_clk);
1125 free_netdev(at91_dev);
1132 static int at91ether_suspend(struct platform_device *pdev, pm_message_t mesg)
1134 struct at91_private *lp = (struct at91_private *) at91_dev->priv;
1135 struct net_device *net_dev = platform_get_drvdata(pdev);
1136 int phy_irq = lp->board_data.phy_irq_pin;
1138 if (netif_running(net_dev)) {
1140 disable_irq(phy_irq);
1142 netif_stop_queue(net_dev);
1143 netif_device_detach(net_dev);
1145 clk_disable(lp->ether_clk);
1150 static int at91ether_resume(struct platform_device *pdev)
1152 struct at91_private *lp = (struct at91_private *) at91_dev->priv;
1153 struct net_device *net_dev = platform_get_drvdata(pdev);
1154 int phy_irq = lp->board_data.phy_irq_pin;
1156 if (netif_running(net_dev)) {
1157 clk_enable(lp->ether_clk);
1159 netif_device_attach(net_dev);
1160 netif_start_queue(net_dev);
1163 enable_irq(phy_irq);
1169 #define at91ether_suspend NULL
1170 #define at91ether_resume NULL
1173 static struct platform_driver at91ether_driver = {
1174 .probe = at91ether_probe,
1175 .remove = __devexit_p(at91ether_remove),
1176 .suspend = at91ether_suspend,
1177 .resume = at91ether_resume,
1180 .owner = THIS_MODULE,
1184 static int __init at91ether_init(void)
1186 return platform_driver_register(&at91ether_driver);
1189 static void __exit at91ether_exit(void)
1191 platform_driver_unregister(&at91ether_driver);
1194 module_init(at91ether_init)
1195 module_exit(at91ether_exit)
1197 MODULE_LICENSE("GPL");
1198 MODULE_DESCRIPTION("AT91RM9200 EMAC Ethernet driver");
1199 MODULE_AUTHOR("Andrew Victor");