[PATCH] Atmel MACB ethernet driver

Driver for the Atmel MACB on-chip ethernet module.

Tested on AVR32/AT32AP7000/ATSTK1000. I've heard rumours that it works
with AT91SAM9260 as well, and it may be possible to share some code with
the at91_ether driver for AT91RM9200.

Hardware documentation can be found in the AT32AP7000 data sheet,
which can be downloaded from

http://www.atmel.com/dyn/products/datasheets.asp?family_id=682

Changes since previous version:
  * Probe for PHY ID instead of depending on it being provided through
    platform_data.
  * Grab initial ethernet address from the MACB registers instead
    of depending on platform_data.
  * Set MII/RMII mode correctly.

These changes are mostly about making the driver more compatible with
the at91 infrastructure.

Signed-off-by: Haavard Skinnemoen <hskinnemoen@atmel.com>
Signed-off-by: Jeff Garzik <jeff@garzik.org>

1 files changed, 387 insertions, 0 deletions

diff --git a/drivers/net/macb.h b/drivers/net/macb.h
new file mode 100644
index 000000000000..8c253db69881
--- /dev/null
+++ b/drivers/net/macb.h
@@ -0,0 +1,387 @@
+/*
+ * Atmel MACB Ethernet Controller driver
+ *
+ * Copyright (C) 2004-2006 Atmel Corporation
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 as
+ * published by the Free Software Foundation.
+ */
+#ifndef _MACB_H
+#define _MACB_H
+
+/* MACB register offsets */
+#define MACB_NCR                                0x0000
+#define MACB_NCFGR                              0x0004
+#define MACB_NSR                                0x0008
+#define MACB_TSR                                0x0014
+#define MACB_RBQP                               0x0018
+#define MACB_TBQP                               0x001c
+#define MACB_RSR                                0x0020
+#define MACB_ISR                                0x0024
+#define MACB_IER                                0x0028
+#define MACB_IDR                                0x002c
+#define MACB_IMR                                0x0030
+#define MACB_MAN                                0x0034
+#define MACB_PTR                                0x0038
+#define MACB_PFR                                0x003c
+#define MACB_FTO                                0x0040
+#define MACB_SCF                                0x0044
+#define MACB_MCF                                0x0048
+#define MACB_FRO                                0x004c
+#define MACB_FCSE                               0x0050
+#define MACB_ALE                                0x0054
+#define MACB_DTF                                0x0058
+#define MACB_LCOL                               0x005c
+#define MACB_EXCOL                              0x0060
+#define MACB_TUND                               0x0064
+#define MACB_CSE                                0x0068
+#define MACB_RRE                                0x006c
+#define MACB_ROVR                               0x0070
+#define MACB_RSE                                0x0074
+#define MACB_ELE                                0x0078
+#define MACB_RJA                                0x007c
+#define MACB_USF                                0x0080
+#define MACB_STE                                0x0084
+#define MACB_RLE                                0x0088
+#define MACB_TPF                                0x008c
+#define MACB_HRB                                0x0090
+#define MACB_HRT                                0x0094
+#define MACB_SA1B                               0x0098
+#define MACB_SA1T                               0x009c
+#define MACB_SA2B                               0x00a0
+#define MACB_SA2T                               0x00a4
+#define MACB_SA3B                               0x00a8
+#define MACB_SA3T                               0x00ac
+#define MACB_SA4B                               0x00b0
+#define MACB_SA4T                               0x00b4
+#define MACB_TID                                0x00b8
+#define MACB_TPQ                                0x00bc
+#define MACB_USRIO                              0x00c0
+#define MACB_WOL                                0x00c4
+
+/* Bitfields in NCR */
+#define MACB_LB_OFFSET                          0
+#define MACB_LB_SIZE                            1
+#define MACB_LLB_OFFSET                         1
+#define MACB_LLB_SIZE                           1
+#define MACB_RE_OFFSET                          2
+#define MACB_RE_SIZE                            1
+#define MACB_TE_OFFSET                          3
+#define MACB_TE_SIZE                            1
+#define MACB_MPE_OFFSET                         4
+#define MACB_MPE_SIZE                           1
+#define MACB_CLRSTAT_OFFSET                     5
+#define MACB_CLRSTAT_SIZE                       1
+#define MACB_INCSTAT_OFFSET                     6
+#define MACB_INCSTAT_SIZE                       1
+#define MACB_WESTAT_OFFSET                      7
+#define MACB_WESTAT_SIZE                        1
+#define MACB_BP_OFFSET                          8
+#define MACB_BP_SIZE                            1
+#define MACB_TSTART_OFFSET                      9
+#define MACB_TSTART_SIZE                        1
+#define MACB_THALT_OFFSET                       10
+#define MACB_THALT_SIZE                         1
+#define MACB_NCR_TPF_OFFSET                     11
+#define MACB_NCR_TPF_SIZE                       1
+#define MACB_TZQ_OFFSET                         12
+#define MACB_TZQ_SIZE                           1
+
+/* Bitfields in NCFGR */
+#define MACB_SPD_OFFSET                         0
+#define MACB_SPD_SIZE                           1
+#define MACB_FD_OFFSET                          1
+#define MACB_FD_SIZE                            1
+#define MACB_BIT_RATE_OFFSET                    2
+#define MACB_BIT_RATE_SIZE                      1
+#define MACB_JFRAME_OFFSET                      3
+#define MACB_JFRAME_SIZE                        1
+#define MACB_CAF_OFFSET                         4
+#define MACB_CAF_SIZE                           1
+#define MACB_NBC_OFFSET                         5
+#define MACB_NBC_SIZE                           1
+#define MACB_NCFGR_MTI_OFFSET                   6
+#define MACB_NCFGR_MTI_SIZE                     1
+#define MACB_UNI_OFFSET                         7
+#define MACB_UNI_SIZE                           1
+#define MACB_BIG_OFFSET                         8
+#define MACB_BIG_SIZE                           1
+#define MACB_EAE_OFFSET                         9
+#define MACB_EAE_SIZE                           1
+#define MACB_CLK_OFFSET                         10
+#define MACB_CLK_SIZE                           2
+#define MACB_RTY_OFFSET                         12
+#define MACB_RTY_SIZE                           1
+#define MACB_PAE_OFFSET                         13
+#define MACB_PAE_SIZE                           1
+#define MACB_RBOF_OFFSET                        14
+#define MACB_RBOF_SIZE                          2
+#define MACB_RLCE_OFFSET                        16
+#define MACB_RLCE_SIZE                          1
+#define MACB_DRFCS_OFFSET                       17
+#define MACB_DRFCS_SIZE                         1
+#define MACB_EFRHD_OFFSET                       18
+#define MACB_EFRHD_SIZE                         1
+#define MACB_IRXFCS_OFFSET                      19
+#define MACB_IRXFCS_SIZE                        1
+
+/* Bitfields in NSR */
+#define MACB_NSR_LINK_OFFSET                    0
+#define MACB_NSR_LINK_SIZE                      1
+#define MACB_MDIO_OFFSET                        1
+#define MACB_MDIO_SIZE                          1
+#define MACB_IDLE_OFFSET                        2
+#define MACB_IDLE_SIZE                          1
+
+/* Bitfields in TSR */
+#define MACB_UBR_OFFSET                         0
+#define MACB_UBR_SIZE                           1
+#define MACB_COL_OFFSET                         1
+#define MACB_COL_SIZE                           1
+#define MACB_TSR_RLE_OFFSET                     2
+#define MACB_TSR_RLE_SIZE                       1
+#define MACB_TGO_OFFSET                         3
+#define MACB_TGO_SIZE                           1
+#define MACB_BEX_OFFSET                         4
+#define MACB_BEX_SIZE                           1
+#define MACB_COMP_OFFSET                        5
+#define MACB_COMP_SIZE                          1
+#define MACB_UND_OFFSET                         6
+#define MACB_UND_SIZE                           1
+
+/* Bitfields in RSR */
+#define MACB_BNA_OFFSET                         0
+#define MACB_BNA_SIZE                           1
+#define MACB_REC_OFFSET                         1
+#define MACB_REC_SIZE                           1
+#define MACB_OVR_OFFSET                         2
+#define MACB_OVR_SIZE                           1
+
+/* Bitfields in ISR/IER/IDR/IMR */
+#define MACB_MFD_OFFSET                         0
+#define MACB_MFD_SIZE                           1
+#define MACB_RCOMP_OFFSET                       1
+#define MACB_RCOMP_SIZE                         1
+#define MACB_RXUBR_OFFSET                       2
+#define MACB_RXUBR_SIZE                         1
+#define MACB_TXUBR_OFFSET                       3
+#define MACB_TXUBR_SIZE                         1
+#define MACB_ISR_TUND_OFFSET                    4
+#define MACB_ISR_TUND_SIZE                      1
+#define MACB_ISR_RLE_OFFSET                     5
+#define MACB_ISR_RLE_SIZE                       1
+#define MACB_TXERR_OFFSET                       6
+#define MACB_TXERR_SIZE                         1
+#define MACB_TCOMP_OFFSET                       7
+#define MACB_TCOMP_SIZE                         1
+#define MACB_ISR_LINK_OFFSET                    9
+#define MACB_ISR_LINK_SIZE                      1
+#define MACB_ISR_ROVR_OFFSET                    10
+#define MACB_ISR_ROVR_SIZE                      1
+#define MACB_HRESP_OFFSET                       11
+#define MACB_HRESP_SIZE                         1
+#define MACB_PFR_OFFSET                         12
+#define MACB_PFR_SIZE                           1
+#define MACB_PTZ_OFFSET                         13
+#define MACB_PTZ_SIZE                           1
+
+/* Bitfields in MAN */
+#define MACB_DATA_OFFSET                        0
+#define MACB_DATA_SIZE                          16
+#define MACB_CODE_OFFSET                        16
+#define MACB_CODE_SIZE                          2
+#define MACB_REGA_OFFSET                        18
+#define MACB_REGA_SIZE                          5
+#define MACB_PHYA_OFFSET                        23
+#define MACB_PHYA_SIZE                          5
+#define MACB_RW_OFFSET                          28
+#define MACB_RW_SIZE                            2
+#define MACB_SOF_OFFSET                         30
+#define MACB_SOF_SIZE                           2
+
+/* Bitfields in USRIO */
+#define MACB_MII_OFFSET                         0
+#define MACB_MII_SIZE                           1
+#define MACB_EAM_OFFSET                         1
+#define MACB_EAM_SIZE                           1
+#define MACB_TX_PAUSE_OFFSET                    2
+#define MACB_TX_PAUSE_SIZE                      1
+#define MACB_TX_PAUSE_ZERO_OFFSET               3
+#define MACB_TX_PAUSE_ZERO_SIZE                 1
+
+/* Bitfields in WOL */
+#define MACB_IP_OFFSET                          0
+#define MACB_IP_SIZE                            16
+#define MACB_MAG_OFFSET                         16
+#define MACB_MAG_SIZE                           1
+#define MACB_ARP_OFFSET                         17
+#define MACB_ARP_SIZE                           1
+#define MACB_SA1_OFFSET                         18
+#define MACB_SA1_SIZE                           1
+#define MACB_WOL_MTI_OFFSET                     19
+#define MACB_WOL_MTI_SIZE                       1
+
+/* Constants for CLK */
+#define MACB_CLK_DIV8                           0
+#define MACB_CLK_DIV16                          1
+#define MACB_CLK_DIV32                          2
+#define MACB_CLK_DIV64                          3
+
+/* Constants for MAN register */
+#define MACB_MAN_SOF                            1
+#define MACB_MAN_WRITE                          1
+#define MACB_MAN_READ                           2
+#define MACB_MAN_CODE                           2
+
+/* Bit manipulation macros */
+#define MACB_BIT(name)                                  \
+        (1 << MACB_##name##_OFFSET)
+#define MACB_BF(name,value)                             \
+        (((value) & ((1 << MACB_##name##_SIZE) - 1))    \
+         << MACB_##name##_OFFSET)
+#define MACB_BFEXT(name,value)\
+        (((value) >> MACB_##name##_OFFSET)              \
+         & ((1 << MACB_##name##_SIZE) - 1))
+#define MACB_BFINS(name,value,old)                      \
+        (((old) & ~(((1 << MACB_##name##_SIZE) - 1)     \
+                    << MACB_##name##_OFFSET))           \
+         | MACB_BF(name,value))
+
+/* Register access macros */
+#define macb_readl(port,reg)                            \
+        readl((port)->regs + MACB_##reg)
+#define macb_writel(port,reg,value)                     \
+        writel((value), (port)->regs + MACB_##reg)
+
+struct dma_desc {
+        u32     addr;
+        u32     ctrl;
+};
+
+/* DMA descriptor bitfields */
+#define MACB_RX_USED_OFFSET                     0
+#define MACB_RX_USED_SIZE                       1
+#define MACB_RX_WRAP_OFFSET                     1
+#define MACB_RX_WRAP_SIZE                       1
+#define MACB_RX_WADDR_OFFSET                    2
+#define MACB_RX_WADDR_SIZE                      30
+
+#define MACB_RX_FRMLEN_OFFSET                   0
+#define MACB_RX_FRMLEN_SIZE                     12
+#define MACB_RX_OFFSET_OFFSET                   12
+#define MACB_RX_OFFSET_SIZE                     2
+#define MACB_RX_SOF_OFFSET                      14
+#define MACB_RX_SOF_SIZE                        1
+#define MACB_RX_EOF_OFFSET                      15
+#define MACB_RX_EOF_SIZE                        1
+#define MACB_RX_CFI_OFFSET                      16
+#define MACB_RX_CFI_SIZE                        1
+#define MACB_RX_VLAN_PRI_OFFSET                 17
+#define MACB_RX_VLAN_PRI_SIZE                   3
+#define MACB_RX_PRI_TAG_OFFSET                  20
+#define MACB_RX_PRI_TAG_SIZE                    1
+#define MACB_RX_VLAN_TAG_OFFSET                 21
+#define MACB_RX_VLAN_TAG_SIZE                   1
+#define MACB_RX_TYPEID_MATCH_OFFSET             22
+#define MACB_RX_TYPEID_MATCH_SIZE               1
+#define MACB_RX_SA4_MATCH_OFFSET                23
+#define MACB_RX_SA4_MATCH_SIZE                  1
+#define MACB_RX_SA3_MATCH_OFFSET                24
+#define MACB_RX_SA3_MATCH_SIZE                  1
+#define MACB_RX_SA2_MATCH_OFFSET                25
+#define MACB_RX_SA2_MATCH_SIZE                  1
+#define MACB_RX_SA1_MATCH_OFFSET                26
+#define MACB_RX_SA1_MATCH_SIZE                  1
+#define MACB_RX_EXT_MATCH_OFFSET                28
+#define MACB_RX_EXT_MATCH_SIZE                  1
+#define MACB_RX_UHASH_MATCH_OFFSET              29
+#define MACB_RX_UHASH_MATCH_SIZE                1
+#define MACB_RX_MHASH_MATCH_OFFSET              30
+#define MACB_RX_MHASH_MATCH_SIZE                1
+#define MACB_RX_BROADCAST_OFFSET                31
+#define MACB_RX_BROADCAST_SIZE                  1
+
+#define MACB_TX_FRMLEN_OFFSET                   0
+#define MACB_TX_FRMLEN_SIZE                     11
+#define MACB_TX_LAST_OFFSET                     15
+#define MACB_TX_LAST_SIZE                       1
+#define MACB_TX_NOCRC_OFFSET                    16
+#define MACB_TX_NOCRC_SIZE                      1
+#define MACB_TX_BUF_EXHAUSTED_OFFSET            27
+#define MACB_TX_BUF_EXHAUSTED_SIZE              1
+#define MACB_TX_UNDERRUN_OFFSET                 28
+#define MACB_TX_UNDERRUN_SIZE                   1
+#define MACB_TX_ERROR_OFFSET                    29
+#define MACB_TX_ERROR_SIZE                      1
+#define MACB_TX_WRAP_OFFSET                     30
+#define MACB_TX_WRAP_SIZE                       1
+#define MACB_TX_USED_OFFSET                     31
+#define MACB_TX_USED_SIZE                       1
+
+struct ring_info {
+        struct sk_buff          *skb;
+        dma_addr_t              mapping;
+};
+
+/*
+ * Hardware-collected statistics. Used when updating the network
+ * device stats by a periodic timer.
+ */
+struct macb_stats {
+        u32     rx_pause_frames;
+        u32     tx_ok;
+        u32     tx_single_cols;
+        u32     tx_multiple_cols;
+        u32     rx_ok;
+        u32     rx_fcs_errors;
+        u32     rx_align_errors;
+        u32     tx_deferred;
+        u32     tx_late_cols;
+        u32     tx_excessive_cols;
+        u32     tx_underruns;
+        u32     tx_carrier_errors;
+        u32     rx_resource_errors;
+        u32     rx_overruns;
+        u32     rx_symbol_errors;
+        u32     rx_oversize_pkts;
+        u32     rx_jabbers;
+        u32     rx_undersize_pkts;
+        u32     sqe_test_errors;
+        u32     rx_length_mismatch;
+        u32     tx_pause_frames;
+};
+
+struct macb {
+        void __iomem            *regs;
+
+        unsigned int            rx_tail;
+        struct dma_desc         *rx_ring;
+        void                    *rx_buffers;
+
+        unsigned int            tx_head, tx_tail;
+        struct dma_desc         *tx_ring;
+        struct ring_info        *tx_skb;
+
+        spinlock_t              lock;
+        struct platform_device  *pdev;
+        struct clk              *pclk;
+        struct clk              *hclk;
+        struct net_device       *dev;
+        struct net_device_stats stats;
+        struct macb_stats       hw_stats;
+
+        dma_addr_t              rx_ring_dma;
+        dma_addr_t              tx_ring_dma;
+        dma_addr_t              rx_buffers_dma;
+
+        unsigned int            rx_pending, tx_pending;
+
+        struct work_struct      periodic_task;
+
+        struct mutex            mdio_mutex;
+        struct completion       mdio_complete;
+        struct mii_if_info      mii;
+};
+
+#endif /* _MACB_H */