1 /****************************************************************************/ 2 3 /* 4 * fec.h -- Fast Ethernet Controller for Motorola ColdFire SoC 5 * processors. 6 * 7 * (C) Copyright 2000-2005, Greg Ungerer (gerg@snapgear.com) 8 * (C) Copyright 2000-2001, Lineo (www.lineo.com) 9 */ 10 11 /****************************************************************************/ 12 #ifndef FEC_H 13 #define FEC_H 14 /****************************************************************************/ 15 16 #ifdef CONFIG_FEC_PTP 17 #include <linux/clocksource.h> 18 #include <linux/net_tstamp.h> 19 #include <linux/ptp_clock_kernel.h> 20 #endif 21 22 #if defined(CONFIG_M523x) || defined(CONFIG_M527x) || defined(CONFIG_M528x) || \ 23 defined(CONFIG_M520x) || defined(CONFIG_M532x) || \ 24 defined(CONFIG_ARCH_MXC) || defined(CONFIG_SOC_IMX28) 25 /* 26 * Just figures, Motorola would have to change the offsets for 27 * registers in the same peripheral device on different models 28 * of the ColdFire! 29 */ 30 #define FEC_IEVENT 0x004 /* Interrupt event reg */ 31 #define FEC_IMASK 0x008 /* Interrupt mask reg */ 32 #define FEC_R_DES_ACTIVE 0x010 /* Receive descriptor reg */ 33 #define FEC_X_DES_ACTIVE 0x014 /* Transmit descriptor reg */ 34 #define FEC_ECNTRL 0x024 /* Ethernet control reg */ 35 #define FEC_MII_DATA 0x040 /* MII manage frame reg */ 36 #define FEC_MII_SPEED 0x044 /* MII speed control reg */ 37 #define FEC_MIB_CTRLSTAT 0x064 /* MIB control/status reg */ 38 #define FEC_R_CNTRL 0x084 /* Receive control reg */ 39 #define FEC_X_CNTRL 0x0c4 /* Transmit Control reg */ 40 #define FEC_ADDR_LOW 0x0e4 /* Low 32bits MAC address */ 41 #define FEC_ADDR_HIGH 0x0e8 /* High 16bits MAC address */ 42 #define FEC_OPD 0x0ec /* Opcode + Pause duration */ 43 #define FEC_HASH_TABLE_HIGH 0x118 /* High 32bits hash table */ 44 #define FEC_HASH_TABLE_LOW 0x11c /* Low 32bits hash table */ 45 #define FEC_GRP_HASH_TABLE_HIGH 0x120 /* High 32bits hash table */ 46 #define FEC_GRP_HASH_TABLE_LOW 0x124 /* Low 32bits hash table */ 47 #define FEC_X_WMRK 0x144 /* FIFO transmit water mark */ 48 #define FEC_R_BOUND 0x14c /* FIFO receive bound reg */ 49 #define FEC_R_FSTART 0x150 /* FIFO receive start reg */ 50 #define FEC_R_DES_START 0x180 /* Receive descriptor ring */ 51 #define FEC_X_DES_START 0x184 /* Transmit descriptor ring */ 52 #define FEC_R_BUFF_SIZE 0x188 /* Maximum receive buff size */ 53 #define FEC_MIIGSK_CFGR 0x300 /* MIIGSK Configuration reg */ 54 #define FEC_MIIGSK_ENR 0x308 /* MIIGSK Enable reg */ 55 56 #define BM_MIIGSK_CFGR_MII 0x00 57 #define BM_MIIGSK_CFGR_RMII 0x01 58 #define BM_MIIGSK_CFGR_FRCONT_10M 0x40 59 60 #else 61 62 #define FEC_ECNTRL 0x000 /* Ethernet control reg */ 63 #define FEC_IEVENT 0x004 /* Interrupt even reg */ 64 #define FEC_IMASK 0x008 /* Interrupt mask reg */ 65 #define FEC_IVEC 0x00c /* Interrupt vec status reg */ 66 #define FEC_R_DES_ACTIVE 0x010 /* Receive descriptor reg */ 67 #define FEC_X_DES_ACTIVE 0x014 /* Transmit descriptor reg */ 68 #define FEC_MII_DATA 0x040 /* MII manage frame reg */ 69 #define FEC_MII_SPEED 0x044 /* MII speed control reg */ 70 #define FEC_R_BOUND 0x08c /* FIFO receive bound reg */ 71 #define FEC_R_FSTART 0x090 /* FIFO receive start reg */ 72 #define FEC_X_WMRK 0x0a4 /* FIFO transmit water mark */ 73 #define FEC_X_FSTART 0x0ac /* FIFO transmit start reg */ 74 #define FEC_R_CNTRL 0x104 /* Receive control reg */ 75 #define FEC_MAX_FRM_LEN 0x108 /* Maximum frame length reg */ 76 #define FEC_X_CNTRL 0x144 /* Transmit Control reg */ 77 #define FEC_ADDR_LOW 0x3c0 /* Low 32bits MAC address */ 78 #define FEC_ADDR_HIGH 0x3c4 /* High 16bits MAC address */ 79 #define FEC_GRP_HASH_TABLE_HIGH 0x3c8 /* High 32bits hash table */ 80 #define FEC_GRP_HASH_TABLE_LOW 0x3cc /* Low 32bits hash table */ 81 #define FEC_R_DES_START 0x3d0 /* Receive descriptor ring */ 82 #define FEC_X_DES_START 0x3d4 /* Transmit descriptor ring */ 83 #define FEC_R_BUFF_SIZE 0x3d8 /* Maximum receive buff size */ 84 #define FEC_FIFO_RAM 0x400 /* FIFO RAM buffer */ 85 86 #endif /* CONFIG_M5272 */ 87 88 89 /* 90 * Define the buffer descriptor structure. 91 */ 92 #if defined(CONFIG_ARCH_MXC) || defined(CONFIG_SOC_IMX28) 93 struct bufdesc { 94 unsigned short cbd_datlen; /* Data length */ 95 unsigned short cbd_sc; /* Control and status info */ 96 unsigned long cbd_bufaddr; /* Buffer address */ 97 #ifdef CONFIG_FEC_PTP 98 unsigned long cbd_esc; 99 unsigned long cbd_prot; 100 unsigned long cbd_bdu; 101 unsigned long ts; 102 unsigned short res0[4]; 103 #endif 104 }; 105 #else 106 struct bufdesc { 107 unsigned short cbd_sc; /* Control and status info */ 108 unsigned short cbd_datlen; /* Data length */ 109 unsigned long cbd_bufaddr; /* Buffer address */ 110 }; 111 #endif 112 113 /* 114 * The following definitions courtesy of commproc.h, which where 115 * Copyright (c) 1997 Dan Malek (dmalek@jlc.net). 116 */ 117 #define BD_SC_EMPTY ((ushort)0x8000) /* Receive is empty */ 118 #define BD_SC_READY ((ushort)0x8000) /* Transmit is ready */ 119 #define BD_SC_WRAP ((ushort)0x2000) /* Last buffer descriptor */ 120 #define BD_SC_INTRPT ((ushort)0x1000) /* Interrupt on change */ 121 #define BD_SC_CM ((ushort)0x0200) /* Continuous mode */ 122 #define BD_SC_ID ((ushort)0x0100) /* Rec'd too many idles */ 123 #define BD_SC_P ((ushort)0x0100) /* xmt preamble */ 124 #define BD_SC_BR ((ushort)0x0020) /* Break received */ 125 #define BD_SC_FR ((ushort)0x0010) /* Framing error */ 126 #define BD_SC_PR ((ushort)0x0008) /* Parity error */ 127 #define BD_SC_OV ((ushort)0x0002) /* Overrun */ 128 #define BD_SC_CD ((ushort)0x0001) /* ?? */ 129 130 /* Buffer descriptor control/status used by Ethernet receive. 131 */ 132 #define BD_ENET_RX_EMPTY ((ushort)0x8000) 133 #define BD_ENET_RX_WRAP ((ushort)0x2000) 134 #define BD_ENET_RX_INTR ((ushort)0x1000) 135 #define BD_ENET_RX_LAST ((ushort)0x0800) 136 #define BD_ENET_RX_FIRST ((ushort)0x0400) 137 #define BD_ENET_RX_MISS ((ushort)0x0100) 138 #define BD_ENET_RX_LG ((ushort)0x0020) 139 #define BD_ENET_RX_NO ((ushort)0x0010) 140 #define BD_ENET_RX_SH ((ushort)0x0008) 141 #define BD_ENET_RX_CR ((ushort)0x0004) 142 #define BD_ENET_RX_OV ((ushort)0x0002) 143 #define BD_ENET_RX_CL ((ushort)0x0001) 144 #define BD_ENET_RX_STATS ((ushort)0x013f) /* All status bits */ 145 146 /* Buffer descriptor control/status used by Ethernet transmit. 147 */ 148 #define BD_ENET_TX_READY ((ushort)0x8000) 149 #define BD_ENET_TX_PAD ((ushort)0x4000) 150 #define BD_ENET_TX_WRAP ((ushort)0x2000) 151 #define BD_ENET_TX_INTR ((ushort)0x1000) 152 #define BD_ENET_TX_LAST ((ushort)0x0800) 153 #define BD_ENET_TX_TC ((ushort)0x0400) 154 #define BD_ENET_TX_DEF ((ushort)0x0200) 155 #define BD_ENET_TX_HB ((ushort)0x0100) 156 #define BD_ENET_TX_LC ((ushort)0x0080) 157 #define BD_ENET_TX_RL ((ushort)0x0040) 158 #define BD_ENET_TX_RCMASK ((ushort)0x003c) 159 #define BD_ENET_TX_UN ((ushort)0x0002) 160 #define BD_ENET_TX_CSL ((ushort)0x0001) 161 #define BD_ENET_TX_STATS ((ushort)0x03ff) /* All status bits */ 162 163 /*enhanced buffer desciptor control/status used by Ethernet transmit*/ 164 #define BD_ENET_TX_INT 0x40000000 165 #define BD_ENET_TX_TS 0x20000000 166 167 168 /* This device has up to three irqs on some platforms */ 169 #define FEC_IRQ_NUM 3 170 171 /* The number of Tx and Rx buffers. These are allocated from the page 172 * pool. The code may assume these are power of two, so it it best 173 * to keep them that size. 174 * We don't need to allocate pages for the transmitter. We just use 175 * the skbuffer directly. 176 */ 177 178 #define FEC_ENET_RX_PAGES 8 179 #define FEC_ENET_RX_FRSIZE 2048 180 #define FEC_ENET_RX_FRPPG (PAGE_SIZE / FEC_ENET_RX_FRSIZE) 181 #define RX_RING_SIZE (FEC_ENET_RX_FRPPG * FEC_ENET_RX_PAGES) 182 #define FEC_ENET_TX_FRSIZE 2048 183 #define FEC_ENET_TX_FRPPG (PAGE_SIZE / FEC_ENET_TX_FRSIZE) 184 #define TX_RING_SIZE 16 /* Must be power of two */ 185 #define TX_RING_MOD_MASK 15 /* for this to work */ 186 187 #define BD_ENET_RX_INT 0x00800000 188 #define BD_ENET_RX_PTP ((ushort)0x0400) 189 190 /* The FEC buffer descriptors track the ring buffers. The rx_bd_base and 191 * tx_bd_base always point to the base of the buffer descriptors. The 192 * cur_rx and cur_tx point to the currently available buffer. 193 * The dirty_tx tracks the current buffer that is being sent by the 194 * controller. The cur_tx and dirty_tx are equal under both completely 195 * empty and completely full conditions. The empty/ready indicator in 196 * the buffer descriptor determines the actual condition. 197 */ 198 struct fec_enet_private { 199 /* Hardware registers of the FEC device */ 200 void __iomem *hwp; 201 202 struct net_device *netdev; 203 204 struct clk *clk_ipg; 205 struct clk *clk_ahb; 206 #ifdef CONFIG_FEC_PTP 207 struct clk *clk_ptp; 208 #endif 209 210 /* The saved address of a sent-in-place packet/buffer, for skfree(). */ 211 unsigned char *tx_bounce[TX_RING_SIZE]; 212 struct sk_buff *tx_skbuff[TX_RING_SIZE]; 213 struct sk_buff *rx_skbuff[RX_RING_SIZE]; 214 ushort skb_cur; 215 ushort skb_dirty; 216 217 /* CPM dual port RAM relative addresses */ 218 dma_addr_t bd_dma; 219 /* Address of Rx and Tx buffers */ 220 struct bufdesc *rx_bd_base; 221 struct bufdesc *tx_bd_base; 222 /* The next free ring entry */ 223 struct bufdesc *cur_rx, *cur_tx; 224 /* The ring entries to be free()ed */ 225 struct bufdesc *dirty_tx; 226 227 uint tx_full; 228 /* hold while accessing the HW like ringbuffer for tx/rx but not MAC */ 229 spinlock_t hw_lock; 230 231 struct platform_device *pdev; 232 233 int opened; 234 int dev_id; 235 236 /* Phylib and MDIO interface */ 237 struct mii_bus *mii_bus; 238 struct phy_device *phy_dev; 239 int mii_timeout; 240 uint phy_speed; 241 phy_interface_t phy_interface; 242 int link; 243 int full_duplex; 244 struct completion mdio_done; 245 int irq[FEC_IRQ_NUM]; 246 247 #ifdef CONFIG_FEC_PTP 248 struct ptp_clock *ptp_clock; 249 struct ptp_clock_info ptp_caps; 250 unsigned long last_overflow_check; 251 spinlock_t tmreg_lock; 252 struct cyclecounter cc; 253 struct timecounter tc; 254 int rx_hwtstamp_filter; 255 u32 base_incval; 256 u32 cycle_speed; 257 int hwts_rx_en; 258 int hwts_tx_en; 259 struct timer_list time_keep; 260 #endif 261 262 }; 263 264 #ifdef CONFIG_FEC_PTP 265 void fec_ptp_init(struct net_device *ndev, struct platform_device *pdev); 266 void fec_ptp_start_cyclecounter(struct net_device *ndev); 267 int fec_ptp_ioctl(struct net_device *ndev, struct ifreq *ifr, int cmd); 268 #endif 269 270 /****************************************************************************/ 271 #endif /* FEC_H */ 272