Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /****************************************************************************/ |
2 | ||
3 | /* | |
7a77d918 GU |
4 | * fec.h -- Fast Ethernet Controller for Motorola ColdFire SoC |
5 | * processors. | |
1da177e4 | 6 | * |
7a77d918 | 7 | * (C) Copyright 2000-2005, Greg Ungerer (gerg@snapgear.com) |
1da177e4 LT |
8 | * (C) Copyright 2000-2001, Lineo (www.lineo.com) |
9 | */ | |
10 | ||
11 | /****************************************************************************/ | |
12 | #ifndef FEC_H | |
13 | #define FEC_H | |
14 | /****************************************************************************/ | |
15 | ||
6605b730 FL |
16 | #include <linux/clocksource.h> |
17 | #include <linux/net_tstamp.h> | |
18 | #include <linux/ptp_clock_kernel.h> | |
74d23cc7 | 19 | #include <linux/timecounter.h> |
6605b730 | 20 | |
7a77d918 | 21 | #if defined(CONFIG_M523x) || defined(CONFIG_M527x) || defined(CONFIG_M528x) || \ |
05f3b50e | 22 | defined(CONFIG_M520x) || defined(CONFIG_M532x) || defined(CONFIG_ARM) |
1da177e4 LT |
23 | /* |
24 | * Just figures, Motorola would have to change the offsets for | |
25 | * registers in the same peripheral device on different models | |
26 | * of the ColdFire! | |
27 | */ | |
f44d6305 SH |
28 | #define FEC_IEVENT 0x004 /* Interrupt event reg */ |
29 | #define FEC_IMASK 0x008 /* Interrupt mask reg */ | |
4d494cdc FD |
30 | #define FEC_R_DES_ACTIVE_0 0x010 /* Receive descriptor reg */ |
31 | #define FEC_X_DES_ACTIVE_0 0x014 /* Transmit descriptor reg */ | |
f44d6305 SH |
32 | #define FEC_ECNTRL 0x024 /* Ethernet control reg */ |
33 | #define FEC_MII_DATA 0x040 /* MII manage frame reg */ | |
34 | #define FEC_MII_SPEED 0x044 /* MII speed control reg */ | |
35 | #define FEC_MIB_CTRLSTAT 0x064 /* MIB control/status reg */ | |
36 | #define FEC_R_CNTRL 0x084 /* Receive control reg */ | |
37 | #define FEC_X_CNTRL 0x0c4 /* Transmit Control reg */ | |
38 | #define FEC_ADDR_LOW 0x0e4 /* Low 32bits MAC address */ | |
39 | #define FEC_ADDR_HIGH 0x0e8 /* High 16bits MAC address */ | |
40 | #define FEC_OPD 0x0ec /* Opcode + Pause duration */ | |
745f42ba LW |
41 | #define FEC_TXIC0 0x0f0 /* Tx Interrupt Coalescing for ring 0 */ |
42 | #define FEC_TXIC1 0x0f4 /* Tx Interrupt Coalescing for ring 1 */ | |
43 | #define FEC_TXIC2 0x0f8 /* Tx Interrupt Coalescing for ring 2 */ | |
ce99d0d3 FL |
44 | #define FEC_RXIC0 0x100 /* Rx Interrupt Coalescing for ring 0 */ |
45 | #define FEC_RXIC1 0x104 /* Rx Interrupt Coalescing for ring 1 */ | |
46 | #define FEC_RXIC2 0x108 /* Rx Interrupt Coalescing for ring 2 */ | |
f44d6305 SH |
47 | #define FEC_HASH_TABLE_HIGH 0x118 /* High 32bits hash table */ |
48 | #define FEC_HASH_TABLE_LOW 0x11c /* Low 32bits hash table */ | |
49 | #define FEC_GRP_HASH_TABLE_HIGH 0x120 /* High 32bits hash table */ | |
50 | #define FEC_GRP_HASH_TABLE_LOW 0x124 /* Low 32bits hash table */ | |
51 | #define FEC_X_WMRK 0x144 /* FIFO transmit water mark */ | |
52 | #define FEC_R_BOUND 0x14c /* FIFO receive bound reg */ | |
53 | #define FEC_R_FSTART 0x150 /* FIFO receive start reg */ | |
4d494cdc FD |
54 | #define FEC_R_DES_START_1 0x160 /* Receive descriptor ring 1 */ |
55 | #define FEC_X_DES_START_1 0x164 /* Transmit descriptor ring 1 */ | |
d543a762 | 56 | #define FEC_R_BUFF_SIZE_1 0x168 /* Maximum receive buff ring1 size */ |
4d494cdc FD |
57 | #define FEC_R_DES_START_2 0x16c /* Receive descriptor ring 2 */ |
58 | #define FEC_X_DES_START_2 0x170 /* Transmit descriptor ring 2 */ | |
d543a762 | 59 | #define FEC_R_BUFF_SIZE_2 0x174 /* Maximum receive buff ring2 size */ |
4d494cdc FD |
60 | #define FEC_R_DES_START_0 0x180 /* Receive descriptor ring */ |
61 | #define FEC_X_DES_START_0 0x184 /* Transmit descriptor ring */ | |
d543a762 | 62 | #define FEC_R_BUFF_SIZE_0 0x188 /* Maximum receive buff size */ |
baa70a5c FL |
63 | #define FEC_R_FIFO_RSFL 0x190 /* Receive FIFO section full threshold */ |
64 | #define FEC_R_FIFO_RSEM 0x194 /* Receive FIFO section empty threshold */ | |
65 | #define FEC_R_FIFO_RAEM 0x198 /* Receive FIFO almost empty threshold */ | |
66 | #define FEC_R_FIFO_RAFL 0x19c /* Receive FIFO almost full threshold */ | |
745f42ba | 67 | #define FEC_RACC 0x1c4 /* Receive Accelerator function */ |
4d494cdc FD |
68 | #define FEC_RCMR_1 0x1c8 /* Receive classification match ring 1 */ |
69 | #define FEC_RCMR_2 0x1cc /* Receive classification match ring 2 */ | |
70 | #define FEC_DMA_CFG_1 0x1d8 /* DMA class configuration for ring 1 */ | |
71 | #define FEC_DMA_CFG_2 0x1dc /* DMA class Configuration for ring 2 */ | |
72 | #define FEC_R_DES_ACTIVE_1 0x1e0 /* Rx descriptor active for ring 1 */ | |
73 | #define FEC_X_DES_ACTIVE_1 0x1e4 /* Tx descriptor active for ring 1 */ | |
74 | #define FEC_R_DES_ACTIVE_2 0x1e8 /* Rx descriptor active for ring 2 */ | |
75 | #define FEC_X_DES_ACTIVE_2 0x1ec /* Tx descriptor active for ring 2 */ | |
ce99d0d3 | 76 | #define FEC_QOS_SCHEME 0x1f0 /* Set multi queues Qos scheme */ |
5eb32bd0 BS |
77 | #define FEC_MIIGSK_CFGR 0x300 /* MIIGSK Configuration reg */ |
78 | #define FEC_MIIGSK_ENR 0x308 /* MIIGSK Enable reg */ | |
1da177e4 | 79 | |
8d82f219 EB |
80 | #define BM_MIIGSK_CFGR_MII 0x00 |
81 | #define BM_MIIGSK_CFGR_RMII 0x01 | |
82 | #define BM_MIIGSK_CFGR_FRCONT_10M 0x40 | |
83 | ||
38ae92dc CH |
84 | #define RMON_T_DROP 0x200 /* Count of frames not cntd correctly */ |
85 | #define RMON_T_PACKETS 0x204 /* RMON TX packet count */ | |
86 | #define RMON_T_BC_PKT 0x208 /* RMON TX broadcast pkts */ | |
745f42ba | 87 | #define RMON_T_MC_PKT 0x20c /* RMON TX multicast pkts */ |
38ae92dc CH |
88 | #define RMON_T_CRC_ALIGN 0x210 /* RMON TX pkts with CRC align err */ |
89 | #define RMON_T_UNDERSIZE 0x214 /* RMON TX pkts < 64 bytes, good CRC */ | |
90 | #define RMON_T_OVERSIZE 0x218 /* RMON TX pkts > MAX_FL bytes good CRC */ | |
745f42ba | 91 | #define RMON_T_FRAG 0x21c /* RMON TX pkts < 64 bytes, bad CRC */ |
38ae92dc CH |
92 | #define RMON_T_JAB 0x220 /* RMON TX pkts > MAX_FL bytes, bad CRC */ |
93 | #define RMON_T_COL 0x224 /* RMON TX collision count */ | |
94 | #define RMON_T_P64 0x228 /* RMON TX 64 byte pkts */ | |
745f42ba | 95 | #define RMON_T_P65TO127 0x22c /* RMON TX 65 to 127 byte pkts */ |
38ae92dc CH |
96 | #define RMON_T_P128TO255 0x230 /* RMON TX 128 to 255 byte pkts */ |
97 | #define RMON_T_P256TO511 0x234 /* RMON TX 256 to 511 byte pkts */ | |
98 | #define RMON_T_P512TO1023 0x238 /* RMON TX 512 to 1023 byte pkts */ | |
745f42ba | 99 | #define RMON_T_P1024TO2047 0x23c /* RMON TX 1024 to 2047 byte pkts */ |
38ae92dc CH |
100 | #define RMON_T_P_GTE2048 0x240 /* RMON TX pkts > 2048 bytes */ |
101 | #define RMON_T_OCTETS 0x244 /* RMON TX octets */ | |
102 | #define IEEE_T_DROP 0x248 /* Count of frames not counted crtly */ | |
745f42ba | 103 | #define IEEE_T_FRAME_OK 0x24c /* Frames tx'd OK */ |
38ae92dc CH |
104 | #define IEEE_T_1COL 0x250 /* Frames tx'd with single collision */ |
105 | #define IEEE_T_MCOL 0x254 /* Frames tx'd with multiple collision */ | |
106 | #define IEEE_T_DEF 0x258 /* Frames tx'd after deferral delay */ | |
745f42ba | 107 | #define IEEE_T_LCOL 0x25c /* Frames tx'd with late collision */ |
38ae92dc CH |
108 | #define IEEE_T_EXCOL 0x260 /* Frames tx'd with excesv collisions */ |
109 | #define IEEE_T_MACERR 0x264 /* Frames tx'd with TX FIFO underrun */ | |
110 | #define IEEE_T_CSERR 0x268 /* Frames tx'd with carrier sense err */ | |
745f42ba | 111 | #define IEEE_T_SQE 0x26c /* Frames tx'd with SQE err */ |
38ae92dc CH |
112 | #define IEEE_T_FDXFC 0x270 /* Flow control pause frames tx'd */ |
113 | #define IEEE_T_OCTETS_OK 0x274 /* Octet count for frames tx'd w/o err */ | |
114 | #define RMON_R_PACKETS 0x284 /* RMON RX packet count */ | |
115 | #define RMON_R_BC_PKT 0x288 /* RMON RX broadcast pkts */ | |
745f42ba | 116 | #define RMON_R_MC_PKT 0x28c /* RMON RX multicast pkts */ |
38ae92dc CH |
117 | #define RMON_R_CRC_ALIGN 0x290 /* RMON RX pkts with CRC alignment err */ |
118 | #define RMON_R_UNDERSIZE 0x294 /* RMON RX pkts < 64 bytes, good CRC */ | |
119 | #define RMON_R_OVERSIZE 0x298 /* RMON RX pkts > MAX_FL bytes good CRC */ | |
745f42ba LW |
120 | #define RMON_R_FRAG 0x29c /* RMON RX pkts < 64 bytes, bad CRC */ |
121 | #define RMON_R_JAB 0x2a0 /* RMON RX pkts > MAX_FL bytes, bad CRC */ | |
122 | #define RMON_R_RESVD_O 0x2a4 /* Reserved */ | |
123 | #define RMON_R_P64 0x2a8 /* RMON RX 64 byte pkts */ | |
124 | #define RMON_R_P65TO127 0x2ac /* RMON RX 65 to 127 byte pkts */ | |
125 | #define RMON_R_P128TO255 0x2b0 /* RMON RX 128 to 255 byte pkts */ | |
126 | #define RMON_R_P256TO511 0x2b4 /* RMON RX 256 to 511 byte pkts */ | |
127 | #define RMON_R_P512TO1023 0x2b8 /* RMON RX 512 to 1023 byte pkts */ | |
128 | #define RMON_R_P1024TO2047 0x2bc /* RMON RX 1024 to 2047 byte pkts */ | |
129 | #define RMON_R_P_GTE2048 0x2c0 /* RMON RX pkts > 2048 bytes */ | |
130 | #define RMON_R_OCTETS 0x2c4 /* RMON RX octets */ | |
131 | #define IEEE_R_DROP 0x2c8 /* Count frames not counted correctly */ | |
132 | #define IEEE_R_FRAME_OK 0x2cc /* Frames rx'd OK */ | |
133 | #define IEEE_R_CRC 0x2d0 /* Frames rx'd with CRC err */ | |
134 | #define IEEE_R_ALIGN 0x2d4 /* Frames rx'd with alignment err */ | |
135 | #define IEEE_R_MACERR 0x2d8 /* Receive FIFO overflow count */ | |
136 | #define IEEE_R_FDXFC 0x2dc /* Flow control pause frames rx'd */ | |
137 | #define IEEE_R_OCTETS_OK 0x2e0 /* Octet cnt for frames rx'd w/o err */ | |
38ae92dc | 138 | |
1da177e4 LT |
139 | #else |
140 | ||
9ff1a91c GU |
141 | #define FEC_ECNTRL 0x000 /* Ethernet control reg */ |
142 | #define FEC_IEVENT 0x004 /* Interrupt even reg */ | |
143 | #define FEC_IMASK 0x008 /* Interrupt mask reg */ | |
144 | #define FEC_IVEC 0x00c /* Interrupt vec status reg */ | |
bf3c228d FL |
145 | #define FEC_R_DES_ACTIVE_0 0x010 /* Receive descriptor reg */ |
146 | #define FEC_R_DES_ACTIVE_1 FEC_R_DES_ACTIVE_0 | |
147 | #define FEC_R_DES_ACTIVE_2 FEC_R_DES_ACTIVE_0 | |
148 | #define FEC_X_DES_ACTIVE_0 0x014 /* Transmit descriptor reg */ | |
149 | #define FEC_X_DES_ACTIVE_1 FEC_X_DES_ACTIVE_0 | |
150 | #define FEC_X_DES_ACTIVE_2 FEC_X_DES_ACTIVE_0 | |
f44d6305 SH |
151 | #define FEC_MII_DATA 0x040 /* MII manage frame reg */ |
152 | #define FEC_MII_SPEED 0x044 /* MII speed control reg */ | |
153 | #define FEC_R_BOUND 0x08c /* FIFO receive bound reg */ | |
154 | #define FEC_R_FSTART 0x090 /* FIFO receive start reg */ | |
155 | #define FEC_X_WMRK 0x0a4 /* FIFO transmit water mark */ | |
156 | #define FEC_X_FSTART 0x0ac /* FIFO transmit start reg */ | |
157 | #define FEC_R_CNTRL 0x104 /* Receive control reg */ | |
158 | #define FEC_MAX_FRM_LEN 0x108 /* Maximum frame length reg */ | |
159 | #define FEC_X_CNTRL 0x144 /* Transmit Control reg */ | |
160 | #define FEC_ADDR_LOW 0x3c0 /* Low 32bits MAC address */ | |
161 | #define FEC_ADDR_HIGH 0x3c4 /* High 16bits MAC address */ | |
162 | #define FEC_GRP_HASH_TABLE_HIGH 0x3c8 /* High 32bits hash table */ | |
163 | #define FEC_GRP_HASH_TABLE_LOW 0x3cc /* Low 32bits hash table */ | |
bf3c228d FL |
164 | #define FEC_R_DES_START_0 0x3d0 /* Receive descriptor ring */ |
165 | #define FEC_R_DES_START_1 FEC_R_DES_START_0 | |
166 | #define FEC_R_DES_START_2 FEC_R_DES_START_0 | |
167 | #define FEC_X_DES_START_0 0x3d4 /* Transmit descriptor ring */ | |
168 | #define FEC_X_DES_START_1 FEC_X_DES_START_0 | |
169 | #define FEC_X_DES_START_2 FEC_X_DES_START_0 | |
d543a762 NA |
170 | #define FEC_R_BUFF_SIZE_0 0x3d8 /* Maximum receive buff size */ |
171 | #define FEC_R_BUFF_SIZE_1 FEC_R_BUFF_SIZE_0 | |
172 | #define FEC_R_BUFF_SIZE_2 FEC_R_BUFF_SIZE_0 | |
f44d6305 | 173 | #define FEC_FIFO_RAM 0x400 /* FIFO RAM buffer */ |
bf3c228d FL |
174 | /* Not existed in real chip |
175 | * Just for pass build. | |
176 | */ | |
745f42ba LW |
177 | #define FEC_RCMR_1 0xfff |
178 | #define FEC_RCMR_2 0xfff | |
179 | #define FEC_DMA_CFG_1 0xfff | |
180 | #define FEC_DMA_CFG_2 0xfff | |
181 | #define FEC_TXIC0 0xfff | |
182 | #define FEC_TXIC1 0xfff | |
183 | #define FEC_TXIC2 0xfff | |
184 | #define FEC_RXIC0 0xfff | |
185 | #define FEC_RXIC1 0xfff | |
186 | #define FEC_RXIC2 0xfff | |
1da177e4 LT |
187 | #endif /* CONFIG_M5272 */ |
188 | ||
189 | ||
190 | /* | |
191 | * Define the buffer descriptor structure. | |
5cfa3039 JB |
192 | * |
193 | * Evidently, ARM SoCs have the FEC block generated in a | |
05f3b50e | 194 | * little endian mode so adjust endianness accordingly. |
1da177e4 | 195 | */ |
05f3b50e | 196 | #if defined(CONFIG_ARM) |
5cfa3039 JB |
197 | #define fec32_to_cpu le32_to_cpu |
198 | #define fec16_to_cpu le16_to_cpu | |
199 | #define cpu_to_fec32 cpu_to_le32 | |
200 | #define cpu_to_fec16 cpu_to_le16 | |
201 | #define __fec32 __le32 | |
202 | #define __fec16 __le16 | |
203 | ||
2e28532f | 204 | struct bufdesc { |
5cfa3039 JB |
205 | __fec16 cbd_datlen; /* Data length */ |
206 | __fec16 cbd_sc; /* Control and status info */ | |
207 | __fec32 cbd_bufaddr; /* Buffer address */ | |
ff43da86 | 208 | }; |
acac8406 | 209 | #else |
5cfa3039 JB |
210 | #define fec32_to_cpu be32_to_cpu |
211 | #define fec16_to_cpu be16_to_cpu | |
212 | #define cpu_to_fec32 cpu_to_be32 | |
213 | #define cpu_to_fec16 cpu_to_be16 | |
214 | #define __fec32 __be32 | |
215 | #define __fec16 __be16 | |
216 | ||
acac8406 | 217 | struct bufdesc { |
5cfa3039 JB |
218 | __fec16 cbd_sc; /* Control and status info */ |
219 | __fec16 cbd_datlen; /* Data length */ | |
220 | __fec32 cbd_bufaddr; /* Buffer address */ | |
acac8406 FL |
221 | }; |
222 | #endif | |
ff43da86 FL |
223 | |
224 | struct bufdesc_ex { | |
225 | struct bufdesc desc; | |
5cfa3039 JB |
226 | __fec32 cbd_esc; |
227 | __fec32 cbd_prot; | |
228 | __fec32 cbd_bdu; | |
229 | __fec32 ts; | |
230 | __fec16 res0[4]; | |
2e28532f | 231 | }; |
ff43da86 | 232 | |
1da177e4 LT |
233 | /* |
234 | * The following definitions courtesy of commproc.h, which where | |
235 | * Copyright (c) 1997 Dan Malek (dmalek@jlc.net). | |
236 | */ | |
ea209de3 LW |
237 | #define BD_SC_EMPTY ((ushort)0x8000) /* Receive is empty */ |
238 | #define BD_SC_READY ((ushort)0x8000) /* Transmit is ready */ | |
239 | #define BD_SC_WRAP ((ushort)0x2000) /* Last buffer descriptor */ | |
240 | #define BD_SC_INTRPT ((ushort)0x1000) /* Interrupt on change */ | |
241 | #define BD_SC_CM ((ushort)0x0200) /* Continuous mode */ | |
242 | #define BD_SC_ID ((ushort)0x0100) /* Rec'd too many idles */ | |
243 | #define BD_SC_P ((ushort)0x0100) /* xmt preamble */ | |
244 | #define BD_SC_BR ((ushort)0x0020) /* Break received */ | |
245 | #define BD_SC_FR ((ushort)0x0010) /* Framing error */ | |
246 | #define BD_SC_PR ((ushort)0x0008) /* Parity error */ | |
247 | #define BD_SC_OV ((ushort)0x0002) /* Overrun */ | |
248 | #define BD_SC_CD ((ushort)0x0001) /* ?? */ | |
1da177e4 LT |
249 | |
250 | /* Buffer descriptor control/status used by Ethernet receive. | |
ea209de3 LW |
251 | */ |
252 | #define BD_ENET_RX_EMPTY ((ushort)0x8000) | |
253 | #define BD_ENET_RX_WRAP ((ushort)0x2000) | |
254 | #define BD_ENET_RX_INTR ((ushort)0x1000) | |
255 | #define BD_ENET_RX_LAST ((ushort)0x0800) | |
256 | #define BD_ENET_RX_FIRST ((ushort)0x0400) | |
257 | #define BD_ENET_RX_MISS ((ushort)0x0100) | |
258 | #define BD_ENET_RX_LG ((ushort)0x0020) | |
259 | #define BD_ENET_RX_NO ((ushort)0x0010) | |
260 | #define BD_ENET_RX_SH ((ushort)0x0008) | |
261 | #define BD_ENET_RX_CR ((ushort)0x0004) | |
262 | #define BD_ENET_RX_OV ((ushort)0x0002) | |
263 | #define BD_ENET_RX_CL ((ushort)0x0001) | |
264 | #define BD_ENET_RX_STATS ((ushort)0x013f) /* All status bits */ | |
1da177e4 | 265 | |
cdffcf1b | 266 | /* Enhanced buffer descriptor control/status used by Ethernet receive */ |
ea209de3 | 267 | #define BD_ENET_RX_VLAN 0x00000004 |
cdffcf1b | 268 | |
1da177e4 | 269 | /* Buffer descriptor control/status used by Ethernet transmit. |
ea209de3 LW |
270 | */ |
271 | #define BD_ENET_TX_READY ((ushort)0x8000) | |
272 | #define BD_ENET_TX_PAD ((ushort)0x4000) | |
273 | #define BD_ENET_TX_WRAP ((ushort)0x2000) | |
274 | #define BD_ENET_TX_INTR ((ushort)0x1000) | |
275 | #define BD_ENET_TX_LAST ((ushort)0x0800) | |
276 | #define BD_ENET_TX_TC ((ushort)0x0400) | |
277 | #define BD_ENET_TX_DEF ((ushort)0x0200) | |
278 | #define BD_ENET_TX_HB ((ushort)0x0100) | |
279 | #define BD_ENET_TX_LC ((ushort)0x0080) | |
280 | #define BD_ENET_TX_RL ((ushort)0x0040) | |
281 | #define BD_ENET_TX_RCMASK ((ushort)0x003c) | |
282 | #define BD_ENET_TX_UN ((ushort)0x0002) | |
283 | #define BD_ENET_TX_CSL ((ushort)0x0001) | |
284 | #define BD_ENET_TX_STATS ((ushort)0x0fff) /* All status bits */ | |
1da177e4 | 285 | |
ea209de3 LW |
286 | /* enhanced buffer descriptor control/status used by Ethernet transmit */ |
287 | #define BD_ENET_TX_INT 0x40000000 | |
288 | #define BD_ENET_TX_TS 0x20000000 | |
289 | #define BD_ENET_TX_PINS 0x10000000 | |
290 | #define BD_ENET_TX_IINS 0x08000000 | |
405f257f FL |
291 | |
292 | ||
293 | /* This device has up to three irqs on some platforms */ | |
294 | #define FEC_IRQ_NUM 3 | |
295 | ||
4d494cdc FD |
296 | /* Maximum number of queues supported |
297 | * ENET with AVB IP can support up to 3 independent tx queues and rx queues. | |
298 | * User can point the queue number that is less than or equal to 3. | |
299 | */ | |
300 | #define FEC_ENET_MAX_TX_QS 3 | |
301 | #define FEC_ENET_MAX_RX_QS 3 | |
302 | ||
df406bc9 LW |
303 | #define FEC_R_DES_START(X) (((X) == 1) ? FEC_R_DES_START_1 : \ |
304 | (((X) == 2) ? \ | |
4d494cdc | 305 | FEC_R_DES_START_2 : FEC_R_DES_START_0)) |
df406bc9 LW |
306 | #define FEC_X_DES_START(X) (((X) == 1) ? FEC_X_DES_START_1 : \ |
307 | (((X) == 2) ? \ | |
4d494cdc | 308 | FEC_X_DES_START_2 : FEC_X_DES_START_0)) |
d543a762 NA |
309 | #define FEC_R_BUFF_SIZE(X) (((X) == 1) ? FEC_R_BUFF_SIZE_1 : \ |
310 | (((X) == 2) ? \ | |
311 | FEC_R_BUFF_SIZE_2 : FEC_R_BUFF_SIZE_0)) | |
df406bc9 LW |
312 | #define FEC_R_DES_ACTIVE(X) (((X) == 1) ? FEC_R_DES_ACTIVE_1 : \ |
313 | (((X) == 2) ? \ | |
4d494cdc | 314 | FEC_R_DES_ACTIVE_2 : FEC_R_DES_ACTIVE_0)) |
df406bc9 LW |
315 | #define FEC_X_DES_ACTIVE(X) (((X) == 1) ? FEC_X_DES_ACTIVE_1 : \ |
316 | (((X) == 2) ? \ | |
4d494cdc FD |
317 | FEC_X_DES_ACTIVE_2 : FEC_X_DES_ACTIVE_0)) |
318 | ||
df406bc9 | 319 | #define FEC_DMA_CFG(X) (((X) == 2) ? FEC_DMA_CFG_2 : FEC_DMA_CFG_1) |
4d494cdc FD |
320 | |
321 | #define DMA_CLASS_EN (1 << 16) | |
df406bc9 | 322 | #define FEC_RCMR(X) (((X) == 2) ? FEC_RCMR_2 : FEC_RCMR_1) |
745f42ba | 323 | #define IDLE_SLOPE_MASK 0xffff |
4d494cdc FD |
324 | #define IDLE_SLOPE_1 0x200 /* BW fraction: 0.5 */ |
325 | #define IDLE_SLOPE_2 0x200 /* BW fraction: 0.5 */ | |
df406bc9 LW |
326 | #define IDLE_SLOPE(X) (((X) == 1) ? \ |
327 | (IDLE_SLOPE_1 & IDLE_SLOPE_MASK) : \ | |
4d494cdc | 328 | (IDLE_SLOPE_2 & IDLE_SLOPE_MASK)) |
ea209de3 | 329 | #define RCMR_MATCHEN (0x1 << 16) |
df406bc9 | 330 | #define RCMR_CMP_CFG(v, n) (((v) & 0x7) << (n << 2)) |
4d494cdc FD |
331 | #define RCMR_CMP_1 (RCMR_CMP_CFG(0, 0) | RCMR_CMP_CFG(1, 1) | \ |
332 | RCMR_CMP_CFG(2, 2) | RCMR_CMP_CFG(3, 3)) | |
333 | #define RCMR_CMP_2 (RCMR_CMP_CFG(4, 0) | RCMR_CMP_CFG(5, 1) | \ | |
334 | RCMR_CMP_CFG(6, 2) | RCMR_CMP_CFG(7, 3)) | |
df406bc9 LW |
335 | #define RCMR_CMP(X) (((X) == 1) ? RCMR_CMP_1 : RCMR_CMP_2) |
336 | #define FEC_TX_BD_FTYPE(X) (((X) & 0xf) << 20) | |
4d494cdc | 337 | |
405f257f FL |
338 | /* The number of Tx and Rx buffers. These are allocated from the page |
339 | * pool. The code may assume these are power of two, so it it best | |
340 | * to keep them that size. | |
341 | * We don't need to allocate pages for the transmitter. We just use | |
342 | * the skbuffer directly. | |
343 | */ | |
344 | ||
73e72289 | 345 | #define FEC_ENET_RX_PAGES 256 |
405f257f FL |
346 | #define FEC_ENET_RX_FRSIZE 2048 |
347 | #define FEC_ENET_RX_FRPPG (PAGE_SIZE / FEC_ENET_RX_FRSIZE) | |
348 | #define RX_RING_SIZE (FEC_ENET_RX_FRPPG * FEC_ENET_RX_PAGES) | |
349 | #define FEC_ENET_TX_FRSIZE 2048 | |
350 | #define FEC_ENET_TX_FRPPG (PAGE_SIZE / FEC_ENET_TX_FRSIZE) | |
55d0218a NA |
351 | #define TX_RING_SIZE 512 /* Must be power of two */ |
352 | #define TX_RING_MOD_MASK 511 /* for this to work */ | |
405f257f | 353 | |
ea209de3 LW |
354 | #define BD_ENET_RX_INT 0x00800000 |
355 | #define BD_ENET_RX_PTP ((ushort)0x0400) | |
4c09eed9 JB |
356 | #define BD_ENET_RX_ICE 0x00000020 |
357 | #define BD_ENET_RX_PCR 0x00000010 | |
358 | #define FLAG_RX_CSUM_ENABLED (BD_ENET_RX_ICE | BD_ENET_RX_PCR) | |
359 | #define FLAG_RX_CSUM_ERROR (BD_ENET_RX_ICE | BD_ENET_RX_PCR) | |
405f257f | 360 | |
ce99d0d3 FL |
361 | /* Interrupt events/masks. */ |
362 | #define FEC_ENET_HBERR ((uint)0x80000000) /* Heartbeat error */ | |
363 | #define FEC_ENET_BABR ((uint)0x40000000) /* Babbling receiver */ | |
364 | #define FEC_ENET_BABT ((uint)0x20000000) /* Babbling transmitter */ | |
365 | #define FEC_ENET_GRA ((uint)0x10000000) /* Graceful stop complete */ | |
366 | #define FEC_ENET_TXF_0 ((uint)0x08000000) /* Full frame transmitted */ | |
367 | #define FEC_ENET_TXF_1 ((uint)0x00000008) /* Full frame transmitted */ | |
368 | #define FEC_ENET_TXF_2 ((uint)0x00000080) /* Full frame transmitted */ | |
369 | #define FEC_ENET_TXB ((uint)0x04000000) /* A buffer was transmitted */ | |
370 | #define FEC_ENET_RXF_0 ((uint)0x02000000) /* Full frame received */ | |
371 | #define FEC_ENET_RXF_1 ((uint)0x00000002) /* Full frame received */ | |
372 | #define FEC_ENET_RXF_2 ((uint)0x00000020) /* Full frame received */ | |
373 | #define FEC_ENET_RXB ((uint)0x01000000) /* A buffer was received */ | |
374 | #define FEC_ENET_MII ((uint)0x00800000) /* MII interrupt */ | |
375 | #define FEC_ENET_EBERR ((uint)0x00400000) /* SDMA bus error */ | |
de40ed31 | 376 | #define FEC_ENET_WAKEUP ((uint)0x00020000) /* Wakeup request */ |
ce99d0d3 FL |
377 | #define FEC_ENET_TXF (FEC_ENET_TXF_0 | FEC_ENET_TXF_1 | FEC_ENET_TXF_2) |
378 | #define FEC_ENET_RXF (FEC_ENET_RXF_0 | FEC_ENET_RXF_1 | FEC_ENET_RXF_2) | |
379 | #define FEC_ENET_TS_AVAIL ((uint)0x00010000) | |
380 | #define FEC_ENET_TS_TIMER ((uint)0x00008000) | |
381 | ||
382 | #define FEC_DEFAULT_IMASK (FEC_ENET_TXF | FEC_ENET_RXF | FEC_ENET_MII | FEC_ENET_TS_TIMER) | |
383 | #define FEC_RX_DISABLED_IMASK (FEC_DEFAULT_IMASK & (~FEC_ENET_RXF)) | |
384 | ||
d851b47b FD |
385 | /* ENET interrupt coalescing macro define */ |
386 | #define FEC_ITR_CLK_SEL (0x1 << 30) | |
387 | #define FEC_ITR_EN (0x1 << 31) | |
df406bc9 | 388 | #define FEC_ITR_ICFT(X) (((X) & 0xff) << 20) |
745f42ba | 389 | #define FEC_ITR_ICTT(X) ((X) & 0xffff) |
d851b47b FD |
390 | #define FEC_ITR_ICFT_DEFAULT 200 /* Set 200 frame count threshold */ |
391 | #define FEC_ITR_ICTT_DEFAULT 1000 /* Set 1000us timer threshold */ | |
392 | ||
ea209de3 LW |
393 | #define FEC_VLAN_TAG_LEN 0x04 |
394 | #define FEC_ETHTYPE_LEN 0x02 | |
ce99d0d3 | 395 | |
28b5f058 NA |
396 | /* Controller is ENET-MAC */ |
397 | #define FEC_QUIRK_ENET_MAC (1 << 0) | |
398 | /* Controller needs driver to swap frame */ | |
399 | #define FEC_QUIRK_SWAP_FRAME (1 << 1) | |
400 | /* Controller uses gasket */ | |
401 | #define FEC_QUIRK_USE_GASKET (1 << 2) | |
402 | /* Controller has GBIT support */ | |
403 | #define FEC_QUIRK_HAS_GBIT (1 << 3) | |
404 | /* Controller has extend desc buffer */ | |
405 | #define FEC_QUIRK_HAS_BUFDESC_EX (1 << 4) | |
406 | /* Controller has hardware checksum support */ | |
407 | #define FEC_QUIRK_HAS_CSUM (1 << 5) | |
408 | /* Controller has hardware vlan support */ | |
409 | #define FEC_QUIRK_HAS_VLAN (1 << 6) | |
410 | /* ENET IP errata ERR006358 | |
411 | * | |
412 | * If the ready bit in the transmit buffer descriptor (TxBD[R]) is previously | |
413 | * detected as not set during a prior frame transmission, then the | |
414 | * ENET_TDAR[TDAR] bit is cleared at a later time, even if additional TxBDs | |
415 | * were added to the ring and the ENET_TDAR[TDAR] bit is set. This results in | |
416 | * frames not being transmitted until there is a 0-to-1 transition on | |
417 | * ENET_TDAR[TDAR]. | |
418 | */ | |
ea209de3 | 419 | #define FEC_QUIRK_ERR006358 (1 << 7) |
28b5f058 NA |
420 | /* ENET IP hw AVB |
421 | * | |
422 | * i.MX6SX ENET IP add Audio Video Bridging (AVB) feature support. | |
423 | * - Two class indicators on receive with configurable priority | |
424 | * - Two class indicators and line speed timer on transmit allowing | |
425 | * implementation class credit based shapers externally | |
426 | * - Additional DMA registers provisioned to allow managing up to 3 | |
427 | * independent rings | |
428 | */ | |
429 | #define FEC_QUIRK_HAS_AVB (1 << 8) | |
430 | /* There is a TDAR race condition for mutliQ when the software sets TDAR | |
431 | * and the UDMA clears TDAR simultaneously or in a small window (2-4 cycles). | |
432 | * This will cause the udma_tx and udma_tx_arbiter state machines to hang. | |
433 | * The issue exist at i.MX6SX enet IP. | |
434 | */ | |
435 | #define FEC_QUIRK_ERR007885 (1 << 9) | |
436 | /* ENET Block Guide/ Chapter for the iMX6SX (PELE) address one issue: | |
437 | * After set ENET_ATCR[Capture], there need some time cycles before the counter | |
438 | * value is capture in the register clock domain. | |
439 | * The wait-time-cycles is at least 6 clock cycles of the slower clock between | |
440 | * the register clock and the 1588 clock. The 1588 ts_clk is fixed to 25Mhz, | |
441 | * register clock is 66Mhz, so the wait-time-cycles must be greater than 240ns | |
442 | * (40ns * 6). | |
443 | */ | |
444 | #define FEC_QUIRK_BUG_CAPTURE (1 << 10) | |
3d125f9c SA |
445 | /* Controller has only one MDIO bus */ |
446 | #define FEC_QUIRK_SINGLE_MDIO (1 << 11) | |
18803495 GU |
447 | /* Controller supports RACC register */ |
448 | #define FEC_QUIRK_HAS_RACC (1 << 12) | |
28b5f058 | 449 | |
4d494cdc FD |
450 | struct fec_enet_priv_tx_q { |
451 | int index; | |
452 | unsigned char *tx_bounce[TX_RING_SIZE]; | |
453 | struct sk_buff *tx_skbuff[TX_RING_SIZE]; | |
454 | ||
455 | dma_addr_t bd_dma; | |
456 | struct bufdesc *tx_bd_base; | |
457 | uint tx_ring_size; | |
458 | ||
459 | unsigned short tx_stop_threshold; | |
460 | unsigned short tx_wake_threshold; | |
461 | ||
462 | struct bufdesc *cur_tx; | |
463 | struct bufdesc *dirty_tx; | |
464 | char *tso_hdrs; | |
465 | dma_addr_t tso_hdrs_dma; | |
466 | }; | |
467 | ||
468 | struct fec_enet_priv_rx_q { | |
469 | int index; | |
470 | struct sk_buff *rx_skbuff[RX_RING_SIZE]; | |
471 | ||
472 | dma_addr_t bd_dma; | |
473 | struct bufdesc *rx_bd_base; | |
474 | uint rx_ring_size; | |
475 | ||
476 | struct bufdesc *cur_rx; | |
477 | }; | |
478 | ||
405f257f FL |
479 | /* The FEC buffer descriptors track the ring buffers. The rx_bd_base and |
480 | * tx_bd_base always point to the base of the buffer descriptors. The | |
481 | * cur_rx and cur_tx point to the currently available buffer. | |
482 | * The dirty_tx tracks the current buffer that is being sent by the | |
483 | * controller. The cur_tx and dirty_tx are equal under both completely | |
484 | * empty and completely full conditions. The empty/ready indicator in | |
485 | * the buffer descriptor determines the actual condition. | |
486 | */ | |
487 | struct fec_enet_private { | |
488 | /* Hardware registers of the FEC device */ | |
489 | void __iomem *hwp; | |
490 | ||
491 | struct net_device *netdev; | |
492 | ||
493 | struct clk *clk_ipg; | |
494 | struct clk *clk_ahb; | |
9b5330ed | 495 | struct clk *clk_ref; |
daa7d392 | 496 | struct clk *clk_enet_out; |
6605b730 | 497 | struct clk *clk_ptp; |
405f257f | 498 | |
91c0d987 NA |
499 | bool ptp_clk_on; |
500 | struct mutex ptp_clk_mutex; | |
9fc095f1 FD |
501 | unsigned int num_tx_queues; |
502 | unsigned int num_rx_queues; | |
91c0d987 | 503 | |
405f257f | 504 | /* The saved address of a sent-in-place packet/buffer, for skfree(). */ |
4d494cdc FD |
505 | struct fec_enet_priv_tx_q *tx_queue[FEC_ENET_MAX_TX_QS]; |
506 | struct fec_enet_priv_rx_q *rx_queue[FEC_ENET_MAX_RX_QS]; | |
405f257f | 507 | |
4d494cdc FD |
508 | unsigned int total_tx_ring_size; |
509 | unsigned int total_rx_ring_size; | |
405f257f | 510 | |
4d494cdc FD |
511 | unsigned long work_tx; |
512 | unsigned long work_rx; | |
513 | unsigned long work_ts; | |
514 | unsigned long work_mdio; | |
79f33912 | 515 | |
4d494cdc | 516 | unsigned short bufdesc_size; |
36e24e2e | 517 | |
405f257f FL |
518 | struct platform_device *pdev; |
519 | ||
405f257f FL |
520 | int dev_id; |
521 | ||
522 | /* Phylib and MDIO interface */ | |
523 | struct mii_bus *mii_bus; | |
524 | struct phy_device *phy_dev; | |
525 | int mii_timeout; | |
526 | uint phy_speed; | |
527 | phy_interface_t phy_interface; | |
407066f8 | 528 | struct device_node *phy_node; |
405f257f FL |
529 | int link; |
530 | int full_duplex; | |
d97e7497 | 531 | int speed; |
405f257f FL |
532 | struct completion mdio_done; |
533 | int irq[FEC_IRQ_NUM]; | |
217b5844 | 534 | bool bufdesc_ex; |
baa70a5c | 535 | int pause_flag; |
de40ed31 | 536 | int wol_flag; |
6b7e4008 | 537 | u32 quirks; |
6605b730 | 538 | |
dc975382 | 539 | struct napi_struct napi; |
4c09eed9 | 540 | int csum_flags; |
dc975382 | 541 | |
36cdc743 RK |
542 | struct work_struct tx_timeout_work; |
543 | ||
6605b730 FL |
544 | struct ptp_clock *ptp_clock; |
545 | struct ptp_clock_info ptp_caps; | |
546 | unsigned long last_overflow_check; | |
547 | spinlock_t tmreg_lock; | |
548 | struct cyclecounter cc; | |
549 | struct timecounter tc; | |
550 | int rx_hwtstamp_filter; | |
551 | u32 base_incval; | |
552 | u32 cycle_speed; | |
553 | int hwts_rx_en; | |
554 | int hwts_tx_en; | |
91c0d987 | 555 | struct delayed_work time_keep; |
f4e9f3d2 | 556 | struct regulator *reg_phy; |
41ef84ce FD |
557 | |
558 | unsigned int tx_align; | |
559 | unsigned int rx_align; | |
d851b47b FD |
560 | |
561 | /* hw interrupt coalesce */ | |
562 | unsigned int rx_pkts_itr; | |
563 | unsigned int rx_time_itr; | |
564 | unsigned int tx_pkts_itr; | |
565 | unsigned int tx_time_itr; | |
566 | unsigned int itr_clk_rate; | |
1b7bde6d NA |
567 | |
568 | u32 rx_copybreak; | |
89bddcda LZ |
569 | |
570 | /* ptp clock period in ns*/ | |
571 | unsigned int ptp_inc; | |
278d2404 LZ |
572 | |
573 | /* pps */ | |
574 | int pps_channel; | |
575 | unsigned int reload_period; | |
576 | int pps_enable; | |
577 | unsigned int next_counter; | |
405f257f | 578 | }; |
1da177e4 | 579 | |
ca162a82 | 580 | void fec_ptp_init(struct platform_device *pdev); |
32cba57b | 581 | void fec_ptp_stop(struct platform_device *pdev); |
6605b730 | 582 | void fec_ptp_start_cyclecounter(struct net_device *ndev); |
1d5244d0 BH |
583 | int fec_ptp_set(struct net_device *ndev, struct ifreq *ifr); |
584 | int fec_ptp_get(struct net_device *ndev, struct ifreq *ifr); | |
278d2404 | 585 | uint fec_ptp_check_pps_event(struct fec_enet_private *fep); |
6605b730 | 586 | |
1da177e4 LT |
587 | /****************************************************************************/ |
588 | #endif /* FEC_H */ |