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