1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* Renesas Ethernet AVB device driver
3  *
4  * Copyright (C) 2014-2015 Renesas Electronics Corporation
5  * Copyright (C) 2015 Renesas Solutions Corp.
6  * Copyright (C) 2015-2016 Cogent Embedded, Inc. <source@cogentembedded.com>
7  *
8  * Based on the SuperH Ethernet driver
9  */
10 
11 #ifndef __RAVB_H__
12 #define __RAVB_H__
13 
14 #include <linux/interrupt.h>
15 #include <linux/io.h>
16 #include <linux/kernel.h>
17 #include <linux/mdio-bitbang.h>
18 #include <linux/netdevice.h>
19 #include <linux/phy.h>
20 #include <linux/platform_device.h>
21 #include <linux/ptp_clock_kernel.h>
22 
23 #define BE_TX_RING_SIZE	64	/* TX ring size for Best Effort */
24 #define BE_RX_RING_SIZE	1024	/* RX ring size for Best Effort */
25 #define NC_TX_RING_SIZE	64	/* TX ring size for Network Control */
26 #define NC_RX_RING_SIZE	64	/* RX ring size for Network Control */
27 #define BE_TX_RING_MIN	64
28 #define BE_RX_RING_MIN	64
29 #define BE_TX_RING_MAX	1024
30 #define BE_RX_RING_MAX	2048
31 
32 #define PKT_BUF_SZ	1538
33 
34 /* Driver's parameters */
35 #define RAVB_ALIGN	128
36 
37 /* Hardware time stamp */
38 #define RAVB_TXTSTAMP_VALID	0x00000001	/* TX timestamp valid */
39 #define RAVB_TXTSTAMP_ENABLED	0x00000010	/* Enable TX timestamping */
40 
41 #define RAVB_RXTSTAMP_VALID	0x00000001	/* RX timestamp valid */
42 #define RAVB_RXTSTAMP_TYPE	0x00000006	/* RX type mask */
43 #define RAVB_RXTSTAMP_TYPE_V2_L2_EVENT 0x00000002
44 #define RAVB_RXTSTAMP_TYPE_ALL	0x00000006
45 #define RAVB_RXTSTAMP_ENABLED	0x00000010	/* Enable RX timestamping */
46 
47 enum ravb_reg {
48 	/* AVB-DMAC registers */
49 	CCC	= 0x0000,
50 	DBAT	= 0x0004,
51 	DLR	= 0x0008,
52 	CSR	= 0x000C,
53 	CDAR0	= 0x0010,
54 	CDAR1	= 0x0014,
55 	CDAR2	= 0x0018,
56 	CDAR3	= 0x001C,
57 	CDAR4	= 0x0020,
58 	CDAR5	= 0x0024,
59 	CDAR6	= 0x0028,
60 	CDAR7	= 0x002C,
61 	CDAR8	= 0x0030,
62 	CDAR9	= 0x0034,
63 	CDAR10	= 0x0038,
64 	CDAR11	= 0x003C,
65 	CDAR12	= 0x0040,
66 	CDAR13	= 0x0044,
67 	CDAR14	= 0x0048,
68 	CDAR15	= 0x004C,
69 	CDAR16	= 0x0050,
70 	CDAR17	= 0x0054,
71 	CDAR18	= 0x0058,
72 	CDAR19	= 0x005C,
73 	CDAR20	= 0x0060,
74 	CDAR21	= 0x0064,
75 	ESR	= 0x0088,
76 	APSR	= 0x008C,	/* R-Car Gen3 only */
77 	RCR	= 0x0090,
78 	RQC0	= 0x0094,
79 	RQC1	= 0x0098,
80 	RQC2	= 0x009C,
81 	RQC3	= 0x00A0,
82 	RQC4	= 0x00A4,
83 	RPC	= 0x00B0,
84 	RTC	= 0x00B4,	/* R-Car Gen3 and RZ/G2L only */
85 	UFCW	= 0x00BC,
86 	UFCS	= 0x00C0,
87 	UFCV0	= 0x00C4,
88 	UFCV1	= 0x00C8,
89 	UFCV2	= 0x00CC,
90 	UFCV3	= 0x00D0,
91 	UFCV4	= 0x00D4,
92 	UFCD0	= 0x00E0,
93 	UFCD1	= 0x00E4,
94 	UFCD2	= 0x00E8,
95 	UFCD3	= 0x00EC,
96 	UFCD4	= 0x00F0,
97 	SFO	= 0x00FC,
98 	SFP0	= 0x0100,
99 	SFP1	= 0x0104,
100 	SFP2	= 0x0108,
101 	SFP3	= 0x010C,
102 	SFP4	= 0x0110,
103 	SFP5	= 0x0114,
104 	SFP6	= 0x0118,
105 	SFP7	= 0x011C,
106 	SFP8	= 0x0120,
107 	SFP9	= 0x0124,
108 	SFP10	= 0x0128,
109 	SFP11	= 0x012C,
110 	SFP12	= 0x0130,
111 	SFP13	= 0x0134,
112 	SFP14	= 0x0138,
113 	SFP15	= 0x013C,
114 	SFP16	= 0x0140,
115 	SFP17	= 0x0144,
116 	SFP18	= 0x0148,
117 	SFP19	= 0x014C,
118 	SFP20	= 0x0150,
119 	SFP21	= 0x0154,
120 	SFP22	= 0x0158,
121 	SFP23	= 0x015C,
122 	SFP24	= 0x0160,
123 	SFP25	= 0x0164,
124 	SFP26	= 0x0168,
125 	SFP27	= 0x016C,
126 	SFP28	= 0x0170,
127 	SFP29	= 0x0174,
128 	SFP30	= 0x0178,
129 	SFP31	= 0x017C,
130 	SFM0	= 0x01C0,
131 	SFM1	= 0x01C4,
132 	TGC	= 0x0300,
133 	TCCR	= 0x0304,
134 	TSR	= 0x0308,
135 	TFA0	= 0x0310,
136 	TFA1	= 0x0314,
137 	TFA2	= 0x0318,
138 	CIVR0	= 0x0320,
139 	CIVR1	= 0x0324,
140 	CDVR0	= 0x0328,
141 	CDVR1	= 0x032C,
142 	CUL0	= 0x0330,
143 	CUL1	= 0x0334,
144 	CLL0	= 0x0338,
145 	CLL1	= 0x033C,
146 	DIC	= 0x0350,
147 	DIS	= 0x0354,
148 	EIC	= 0x0358,
149 	EIS	= 0x035C,
150 	RIC0	= 0x0360,
151 	RIS0	= 0x0364,
152 	RIC1	= 0x0368,
153 	RIS1	= 0x036C,
154 	RIC2	= 0x0370,
155 	RIS2	= 0x0374,
156 	TIC	= 0x0378,
157 	TIS	= 0x037C,
158 	ISS	= 0x0380,
159 	CIE	= 0x0384,	/* R-Car Gen3 only */
160 	GCCR	= 0x0390,
161 	GMTT	= 0x0394,
162 	GPTC	= 0x0398,
163 	GTI	= 0x039C,
164 	GTO0	= 0x03A0,
165 	GTO1	= 0x03A4,
166 	GTO2	= 0x03A8,
167 	GIC	= 0x03AC,
168 	GIS	= 0x03B0,
169 	GCPT	= 0x03B4,	/* Documented for R-Car Gen3 only */
170 	GCT0	= 0x03B8,
171 	GCT1	= 0x03BC,
172 	GCT2	= 0x03C0,
173 	GIE	= 0x03CC,	/* R-Car Gen3 only */
174 	GID	= 0x03D0,	/* R-Car Gen3 only */
175 	DIL	= 0x0440,	/* R-Car Gen3 only */
176 	RIE0	= 0x0460,	/* R-Car Gen3 only */
177 	RID0	= 0x0464,	/* R-Car Gen3 only */
178 	RIE2	= 0x0470,	/* R-Car Gen3 only */
179 	RID2	= 0x0474,	/* R-Car Gen3 only */
180 	TIE	= 0x0478,	/* R-Car Gen3 only */
181 	TID	= 0x047c,	/* R-Car Gen3 only */
182 
183 	/* E-MAC registers */
184 	ECMR	= 0x0500,
185 	RFLR	= 0x0508,
186 	ECSR	= 0x0510,
187 	ECSIPR	= 0x0518,
188 	PIR	= 0x0520,
189 	PSR	= 0x0528,
190 	PIPR	= 0x052c,
191 	CXR31	= 0x0530,	/* RZ/G2L only */
192 	MPR	= 0x0558,
193 	PFTCR	= 0x055c,
194 	PFRCR	= 0x0560,
195 	GECMR	= 0x05b0,
196 	MAHR	= 0x05c0,
197 	MALR	= 0x05c8,
198 	TROCR	= 0x0700,	/* R-Car Gen3 and RZ/G2L only */
199 	CEFCR	= 0x0740,
200 	FRECR	= 0x0748,
201 	TSFRCR	= 0x0750,
202 	TLFRCR	= 0x0758,
203 	RFCR	= 0x0760,
204 	MAFCR	= 0x0778,
205 };
206 
207 
208 /* Register bits of the Ethernet AVB */
209 /* CCC */
210 enum CCC_BIT {
211 	CCC_OPC		= 0x00000003,
212 	CCC_OPC_RESET	= 0x00000000,
213 	CCC_OPC_CONFIG	= 0x00000001,
214 	CCC_OPC_OPERATION = 0x00000002,
215 	CCC_GAC		= 0x00000080,
216 	CCC_DTSR	= 0x00000100,
217 	CCC_CSEL	= 0x00030000,
218 	CCC_CSEL_HPB	= 0x00010000,
219 	CCC_CSEL_ETH_TX	= 0x00020000,
220 	CCC_CSEL_GMII_REF = 0x00030000,
221 	CCC_LBME	= 0x01000000,
222 };
223 
224 /* CSR */
225 enum CSR_BIT {
226 	CSR_OPS		= 0x0000000F,
227 	CSR_OPS_RESET	= 0x00000001,
228 	CSR_OPS_CONFIG	= 0x00000002,
229 	CSR_OPS_OPERATION = 0x00000004,
230 	CSR_OPS_STANDBY	= 0x00000008,	/* Documented for R-Car Gen3 only */
231 	CSR_DTS		= 0x00000100,
232 	CSR_TPO0	= 0x00010000,
233 	CSR_TPO1	= 0x00020000,
234 	CSR_TPO2	= 0x00040000,
235 	CSR_TPO3	= 0x00080000,
236 	CSR_RPO		= 0x00100000,
237 };
238 
239 /* ESR */
240 enum ESR_BIT {
241 	ESR_EQN		= 0x0000001F,
242 	ESR_ET		= 0x00000F00,
243 	ESR_EIL		= 0x00001000,
244 };
245 
246 /* APSR (R-Car Gen3 only) */
247 enum APSR_BIT {
248 	APSR_MEMS	= 0x00000002,	/* Undocumented */
249 	APSR_CMSW	= 0x00000010,
250 	APSR_RDM	= 0x00002000,
251 	APSR_TDM	= 0x00004000,
252 };
253 
254 /* RCR */
255 enum RCR_BIT {
256 	RCR_EFFS	= 0x00000001,
257 	RCR_ENCF	= 0x00000002,
258 	RCR_ESF		= 0x0000000C,
259 	RCR_ETS0	= 0x00000010,
260 	RCR_ETS2	= 0x00000020,
261 	RCR_RFCL	= 0x1FFF0000,
262 };
263 
264 /* RQC0/1/2/3/4 */
265 enum RQC_BIT {
266 	RQC_RSM0	= 0x00000003,
267 	RQC_UFCC0	= 0x00000030,
268 	RQC_RSM1	= 0x00000300,
269 	RQC_UFCC1	= 0x00003000,
270 	RQC_RSM2	= 0x00030000,
271 	RQC_UFCC2	= 0x00300000,
272 	RQC_RSM3	= 0x03000000,
273 	RQC_UFCC3	= 0x30000000,
274 };
275 
276 /* RPC */
277 enum RPC_BIT {
278 	RPC_PCNT	= 0x00000700,
279 	RPC_DCNT	= 0x00FF0000,
280 };
281 
282 /* UFCW */
283 enum UFCW_BIT {
284 	UFCW_WL0	= 0x0000003F,
285 	UFCW_WL1	= 0x00003F00,
286 	UFCW_WL2	= 0x003F0000,
287 	UFCW_WL3	= 0x3F000000,
288 };
289 
290 /* UFCS */
291 enum UFCS_BIT {
292 	UFCS_SL0	= 0x0000003F,
293 	UFCS_SL1	= 0x00003F00,
294 	UFCS_SL2	= 0x003F0000,
295 	UFCS_SL3	= 0x3F000000,
296 };
297 
298 /* UFCV0/1/2/3/4 */
299 enum UFCV_BIT {
300 	UFCV_CV0	= 0x0000003F,
301 	UFCV_CV1	= 0x00003F00,
302 	UFCV_CV2	= 0x003F0000,
303 	UFCV_CV3	= 0x3F000000,
304 };
305 
306 /* UFCD0/1/2/3/4 */
307 enum UFCD_BIT {
308 	UFCD_DV0	= 0x0000003F,
309 	UFCD_DV1	= 0x00003F00,
310 	UFCD_DV2	= 0x003F0000,
311 	UFCD_DV3	= 0x3F000000,
312 };
313 
314 /* SFO */
315 enum SFO_BIT {
316 	SFO_FBP		= 0x0000003F,
317 };
318 
319 /* RTC */
320 enum RTC_BIT {
321 	RTC_MFL0	= 0x00000FFF,
322 	RTC_MFL1	= 0x0FFF0000,
323 };
324 
325 /* TGC */
326 enum TGC_BIT {
327 	TGC_TSM0	= 0x00000001,
328 	TGC_TSM1	= 0x00000002,
329 	TGC_TSM2	= 0x00000004,
330 	TGC_TSM3	= 0x00000008,
331 	TGC_TQP		= 0x00000030,
332 	TGC_TQP_NONAVB	= 0x00000000,
333 	TGC_TQP_AVBMODE1 = 0x00000010,
334 	TGC_TQP_AVBMODE2 = 0x00000030,
335 	TGC_TBD0	= 0x00000300,
336 	TGC_TBD1	= 0x00003000,
337 	TGC_TBD2	= 0x00030000,
338 	TGC_TBD3	= 0x00300000,
339 };
340 
341 /* TCCR */
342 enum TCCR_BIT {
343 	TCCR_TSRQ0	= 0x00000001,
344 	TCCR_TSRQ1	= 0x00000002,
345 	TCCR_TSRQ2	= 0x00000004,
346 	TCCR_TSRQ3	= 0x00000008,
347 	TCCR_TFEN	= 0x00000100,
348 	TCCR_TFR	= 0x00000200,
349 };
350 
351 /* TSR */
352 enum TSR_BIT {
353 	TSR_CCS0	= 0x00000003,
354 	TSR_CCS1	= 0x0000000C,
355 	TSR_TFFL	= 0x00000700,
356 };
357 
358 /* TFA2 */
359 enum TFA2_BIT {
360 	TFA2_TSV	= 0x0000FFFF,
361 	TFA2_TST	= 0x03FF0000,
362 };
363 
364 /* DIC */
365 enum DIC_BIT {
366 	DIC_DPE1	= 0x00000002,
367 	DIC_DPE2	= 0x00000004,
368 	DIC_DPE3	= 0x00000008,
369 	DIC_DPE4	= 0x00000010,
370 	DIC_DPE5	= 0x00000020,
371 	DIC_DPE6	= 0x00000040,
372 	DIC_DPE7	= 0x00000080,
373 	DIC_DPE8	= 0x00000100,
374 	DIC_DPE9	= 0x00000200,
375 	DIC_DPE10	= 0x00000400,
376 	DIC_DPE11	= 0x00000800,
377 	DIC_DPE12	= 0x00001000,
378 	DIC_DPE13	= 0x00002000,
379 	DIC_DPE14	= 0x00004000,
380 	DIC_DPE15	= 0x00008000,
381 };
382 
383 /* DIS */
384 enum DIS_BIT {
385 	DIS_DPF1	= 0x00000002,
386 	DIS_DPF2	= 0x00000004,
387 	DIS_DPF3	= 0x00000008,
388 	DIS_DPF4	= 0x00000010,
389 	DIS_DPF5	= 0x00000020,
390 	DIS_DPF6	= 0x00000040,
391 	DIS_DPF7	= 0x00000080,
392 	DIS_DPF8	= 0x00000100,
393 	DIS_DPF9	= 0x00000200,
394 	DIS_DPF10	= 0x00000400,
395 	DIS_DPF11	= 0x00000800,
396 	DIS_DPF12	= 0x00001000,
397 	DIS_DPF13	= 0x00002000,
398 	DIS_DPF14	= 0x00004000,
399 	DIS_DPF15	= 0x00008000,
400 };
401 
402 /* EIC */
403 enum EIC_BIT {
404 	EIC_MREE	= 0x00000001,
405 	EIC_MTEE	= 0x00000002,
406 	EIC_QEE		= 0x00000004,
407 	EIC_SEE		= 0x00000008,
408 	EIC_CLLE0	= 0x00000010,
409 	EIC_CLLE1	= 0x00000020,
410 	EIC_CULE0	= 0x00000040,
411 	EIC_CULE1	= 0x00000080,
412 	EIC_TFFE	= 0x00000100,
413 };
414 
415 /* EIS */
416 enum EIS_BIT {
417 	EIS_MREF	= 0x00000001,
418 	EIS_MTEF	= 0x00000002,
419 	EIS_QEF		= 0x00000004,
420 	EIS_SEF		= 0x00000008,
421 	EIS_CLLF0	= 0x00000010,
422 	EIS_CLLF1	= 0x00000020,
423 	EIS_CULF0	= 0x00000040,
424 	EIS_CULF1	= 0x00000080,
425 	EIS_TFFF	= 0x00000100,
426 	EIS_QFS		= 0x00010000,
427 	EIS_RESERVED	= (GENMASK(31, 17) | GENMASK(15, 11)),
428 };
429 
430 /* RIC0 */
431 enum RIC0_BIT {
432 	RIC0_FRE0	= 0x00000001,
433 	RIC0_FRE1	= 0x00000002,
434 	RIC0_FRE2	= 0x00000004,
435 	RIC0_FRE3	= 0x00000008,
436 	RIC0_FRE4	= 0x00000010,
437 	RIC0_FRE5	= 0x00000020,
438 	RIC0_FRE6	= 0x00000040,
439 	RIC0_FRE7	= 0x00000080,
440 	RIC0_FRE8	= 0x00000100,
441 	RIC0_FRE9	= 0x00000200,
442 	RIC0_FRE10	= 0x00000400,
443 	RIC0_FRE11	= 0x00000800,
444 	RIC0_FRE12	= 0x00001000,
445 	RIC0_FRE13	= 0x00002000,
446 	RIC0_FRE14	= 0x00004000,
447 	RIC0_FRE15	= 0x00008000,
448 	RIC0_FRE16	= 0x00010000,
449 	RIC0_FRE17	= 0x00020000,
450 };
451 
452 /* RIC0 */
453 enum RIS0_BIT {
454 	RIS0_FRF0	= 0x00000001,
455 	RIS0_FRF1	= 0x00000002,
456 	RIS0_FRF2	= 0x00000004,
457 	RIS0_FRF3	= 0x00000008,
458 	RIS0_FRF4	= 0x00000010,
459 	RIS0_FRF5	= 0x00000020,
460 	RIS0_FRF6	= 0x00000040,
461 	RIS0_FRF7	= 0x00000080,
462 	RIS0_FRF8	= 0x00000100,
463 	RIS0_FRF9	= 0x00000200,
464 	RIS0_FRF10	= 0x00000400,
465 	RIS0_FRF11	= 0x00000800,
466 	RIS0_FRF12	= 0x00001000,
467 	RIS0_FRF13	= 0x00002000,
468 	RIS0_FRF14	= 0x00004000,
469 	RIS0_FRF15	= 0x00008000,
470 	RIS0_FRF16	= 0x00010000,
471 	RIS0_FRF17	= 0x00020000,
472 	RIS0_RESERVED	= GENMASK(31, 18),
473 };
474 
475 /* RIC1 */
476 enum RIC1_BIT {
477 	RIC1_RFWE	= 0x80000000,
478 };
479 
480 /* RIS1 */
481 enum RIS1_BIT {
482 	RIS1_RFWF	= 0x80000000,
483 };
484 
485 /* RIC2 */
486 enum RIC2_BIT {
487 	RIC2_QFE0	= 0x00000001,
488 	RIC2_QFE1	= 0x00000002,
489 	RIC2_QFE2	= 0x00000004,
490 	RIC2_QFE3	= 0x00000008,
491 	RIC2_QFE4	= 0x00000010,
492 	RIC2_QFE5	= 0x00000020,
493 	RIC2_QFE6	= 0x00000040,
494 	RIC2_QFE7	= 0x00000080,
495 	RIC2_QFE8	= 0x00000100,
496 	RIC2_QFE9	= 0x00000200,
497 	RIC2_QFE10	= 0x00000400,
498 	RIC2_QFE11	= 0x00000800,
499 	RIC2_QFE12	= 0x00001000,
500 	RIC2_QFE13	= 0x00002000,
501 	RIC2_QFE14	= 0x00004000,
502 	RIC2_QFE15	= 0x00008000,
503 	RIC2_QFE16	= 0x00010000,
504 	RIC2_QFE17	= 0x00020000,
505 	RIC2_RFFE	= 0x80000000,
506 };
507 
508 /* RIS2 */
509 enum RIS2_BIT {
510 	RIS2_QFF0	= 0x00000001,
511 	RIS2_QFF1	= 0x00000002,
512 	RIS2_QFF2	= 0x00000004,
513 	RIS2_QFF3	= 0x00000008,
514 	RIS2_QFF4	= 0x00000010,
515 	RIS2_QFF5	= 0x00000020,
516 	RIS2_QFF6	= 0x00000040,
517 	RIS2_QFF7	= 0x00000080,
518 	RIS2_QFF8	= 0x00000100,
519 	RIS2_QFF9	= 0x00000200,
520 	RIS2_QFF10	= 0x00000400,
521 	RIS2_QFF11	= 0x00000800,
522 	RIS2_QFF12	= 0x00001000,
523 	RIS2_QFF13	= 0x00002000,
524 	RIS2_QFF14	= 0x00004000,
525 	RIS2_QFF15	= 0x00008000,
526 	RIS2_QFF16	= 0x00010000,
527 	RIS2_QFF17	= 0x00020000,
528 	RIS2_RFFF	= 0x80000000,
529 	RIS2_RESERVED	= GENMASK(30, 18),
530 };
531 
532 /* TIC */
533 enum TIC_BIT {
534 	TIC_FTE0	= 0x00000001,	/* Documented for R-Car Gen3 only */
535 	TIC_FTE1	= 0x00000002,	/* Documented for R-Car Gen3 only */
536 	TIC_TFUE	= 0x00000100,
537 	TIC_TFWE	= 0x00000200,
538 };
539 
540 /* TIS */
541 enum TIS_BIT {
542 	TIS_FTF0	= 0x00000001,	/* Documented for R-Car Gen3 only */
543 	TIS_FTF1	= 0x00000002,	/* Documented for R-Car Gen3 only */
544 	TIS_TFUF	= 0x00000100,
545 	TIS_TFWF	= 0x00000200,
546 	TIS_RESERVED	= (GENMASK(31, 20) | GENMASK(15, 12) | GENMASK(7, 4))
547 };
548 
549 /* ISS */
550 enum ISS_BIT {
551 	ISS_FRS		= 0x00000001,	/* Documented for R-Car Gen3 only */
552 	ISS_FTS		= 0x00000004,	/* Documented for R-Car Gen3 only */
553 	ISS_ES		= 0x00000040,
554 	ISS_MS		= 0x00000080,
555 	ISS_TFUS	= 0x00000100,
556 	ISS_TFWS	= 0x00000200,
557 	ISS_RFWS	= 0x00001000,
558 	ISS_CGIS	= 0x00002000,
559 	ISS_DPS1	= 0x00020000,
560 	ISS_DPS2	= 0x00040000,
561 	ISS_DPS3	= 0x00080000,
562 	ISS_DPS4	= 0x00100000,
563 	ISS_DPS5	= 0x00200000,
564 	ISS_DPS6	= 0x00400000,
565 	ISS_DPS7	= 0x00800000,
566 	ISS_DPS8	= 0x01000000,
567 	ISS_DPS9	= 0x02000000,
568 	ISS_DPS10	= 0x04000000,
569 	ISS_DPS11	= 0x08000000,
570 	ISS_DPS12	= 0x10000000,
571 	ISS_DPS13	= 0x20000000,
572 	ISS_DPS14	= 0x40000000,
573 	ISS_DPS15	= 0x80000000,
574 };
575 
576 /* CIE (R-Car Gen3 only) */
577 enum CIE_BIT {
578 	CIE_CRIE	= 0x00000001,
579 	CIE_CTIE	= 0x00000100,
580 	CIE_RQFM	= 0x00010000,
581 	CIE_CL0M	= 0x00020000,
582 	CIE_RFWL	= 0x00040000,
583 	CIE_RFFL	= 0x00080000,
584 };
585 
586 /* GCCR */
587 enum GCCR_BIT {
588 	GCCR_TCR	= 0x00000003,
589 	GCCR_TCR_NOREQ	= 0x00000000, /* No request */
590 	GCCR_TCR_RESET	= 0x00000001, /* gPTP/AVTP presentation timer reset */
591 	GCCR_TCR_CAPTURE = 0x00000003, /* Capture value set in GCCR.TCSS */
592 	GCCR_LTO	= 0x00000004,
593 	GCCR_LTI	= 0x00000008,
594 	GCCR_LPTC	= 0x00000010,
595 	GCCR_LMTT	= 0x00000020,
596 	GCCR_TCSS	= 0x00000300,
597 	GCCR_TCSS_GPTP	= 0x00000000,	/* gPTP timer value */
598 	GCCR_TCSS_ADJGPTP = 0x00000100, /* Adjusted gPTP timer value */
599 	GCCR_TCSS_AVTP	= 0x00000200,	/* AVTP presentation time value */
600 };
601 
602 /* GTI */
603 enum GTI_BIT {
604 	GTI_TIV		= 0x0FFFFFFF,
605 };
606 
607 #define GTI_TIV_MAX	GTI_TIV
608 #define GTI_TIV_MIN	0x20
609 
610 /* GIC */
611 enum GIC_BIT {
612 	GIC_PTCE	= 0x00000001,	/* Documented for R-Car Gen3 only */
613 	GIC_PTME	= 0x00000004,
614 };
615 
616 /* GIS */
617 enum GIS_BIT {
618 	GIS_PTCF	= 0x00000001,	/* Documented for R-Car Gen3 only */
619 	GIS_PTMF	= 0x00000004,
620 	GIS_RESERVED	= GENMASK(15, 10),
621 };
622 
623 /* GIE (R-Car Gen3 only) */
624 enum GIE_BIT {
625 	GIE_PTCS	= 0x00000001,
626 	GIE_PTOS	= 0x00000002,
627 	GIE_PTMS0	= 0x00000004,
628 	GIE_PTMS1	= 0x00000008,
629 	GIE_PTMS2	= 0x00000010,
630 	GIE_PTMS3	= 0x00000020,
631 	GIE_PTMS4	= 0x00000040,
632 	GIE_PTMS5	= 0x00000080,
633 	GIE_PTMS6	= 0x00000100,
634 	GIE_PTMS7	= 0x00000200,
635 	GIE_ATCS0	= 0x00010000,
636 	GIE_ATCS1	= 0x00020000,
637 	GIE_ATCS2	= 0x00040000,
638 	GIE_ATCS3	= 0x00080000,
639 	GIE_ATCS4	= 0x00100000,
640 	GIE_ATCS5	= 0x00200000,
641 	GIE_ATCS6	= 0x00400000,
642 	GIE_ATCS7	= 0x00800000,
643 	GIE_ATCS8	= 0x01000000,
644 	GIE_ATCS9	= 0x02000000,
645 	GIE_ATCS10	= 0x04000000,
646 	GIE_ATCS11	= 0x08000000,
647 	GIE_ATCS12	= 0x10000000,
648 	GIE_ATCS13	= 0x20000000,
649 	GIE_ATCS14	= 0x40000000,
650 	GIE_ATCS15	= 0x80000000,
651 };
652 
653 /* GID (R-Car Gen3 only) */
654 enum GID_BIT {
655 	GID_PTCD	= 0x00000001,
656 	GID_PTOD	= 0x00000002,
657 	GID_PTMD0	= 0x00000004,
658 	GID_PTMD1	= 0x00000008,
659 	GID_PTMD2	= 0x00000010,
660 	GID_PTMD3	= 0x00000020,
661 	GID_PTMD4	= 0x00000040,
662 	GID_PTMD5	= 0x00000080,
663 	GID_PTMD6	= 0x00000100,
664 	GID_PTMD7	= 0x00000200,
665 	GID_ATCD0	= 0x00010000,
666 	GID_ATCD1	= 0x00020000,
667 	GID_ATCD2	= 0x00040000,
668 	GID_ATCD3	= 0x00080000,
669 	GID_ATCD4	= 0x00100000,
670 	GID_ATCD5	= 0x00200000,
671 	GID_ATCD6	= 0x00400000,
672 	GID_ATCD7	= 0x00800000,
673 	GID_ATCD8	= 0x01000000,
674 	GID_ATCD9	= 0x02000000,
675 	GID_ATCD10	= 0x04000000,
676 	GID_ATCD11	= 0x08000000,
677 	GID_ATCD12	= 0x10000000,
678 	GID_ATCD13	= 0x20000000,
679 	GID_ATCD14	= 0x40000000,
680 	GID_ATCD15	= 0x80000000,
681 };
682 
683 /* RIE0 (R-Car Gen3 only) */
684 enum RIE0_BIT {
685 	RIE0_FRS0	= 0x00000001,
686 	RIE0_FRS1	= 0x00000002,
687 	RIE0_FRS2	= 0x00000004,
688 	RIE0_FRS3	= 0x00000008,
689 	RIE0_FRS4	= 0x00000010,
690 	RIE0_FRS5	= 0x00000020,
691 	RIE0_FRS6	= 0x00000040,
692 	RIE0_FRS7	= 0x00000080,
693 	RIE0_FRS8	= 0x00000100,
694 	RIE0_FRS9	= 0x00000200,
695 	RIE0_FRS10	= 0x00000400,
696 	RIE0_FRS11	= 0x00000800,
697 	RIE0_FRS12	= 0x00001000,
698 	RIE0_FRS13	= 0x00002000,
699 	RIE0_FRS14	= 0x00004000,
700 	RIE0_FRS15	= 0x00008000,
701 	RIE0_FRS16	= 0x00010000,
702 	RIE0_FRS17	= 0x00020000,
703 };
704 
705 /* RID0 (R-Car Gen3 only) */
706 enum RID0_BIT {
707 	RID0_FRD0	= 0x00000001,
708 	RID0_FRD1	= 0x00000002,
709 	RID0_FRD2	= 0x00000004,
710 	RID0_FRD3	= 0x00000008,
711 	RID0_FRD4	= 0x00000010,
712 	RID0_FRD5	= 0x00000020,
713 	RID0_FRD6	= 0x00000040,
714 	RID0_FRD7	= 0x00000080,
715 	RID0_FRD8	= 0x00000100,
716 	RID0_FRD9	= 0x00000200,
717 	RID0_FRD10	= 0x00000400,
718 	RID0_FRD11	= 0x00000800,
719 	RID0_FRD12	= 0x00001000,
720 	RID0_FRD13	= 0x00002000,
721 	RID0_FRD14	= 0x00004000,
722 	RID0_FRD15	= 0x00008000,
723 	RID0_FRD16	= 0x00010000,
724 	RID0_FRD17	= 0x00020000,
725 };
726 
727 /* RIE2 (R-Car Gen3 only) */
728 enum RIE2_BIT {
729 	RIE2_QFS0	= 0x00000001,
730 	RIE2_QFS1	= 0x00000002,
731 	RIE2_QFS2	= 0x00000004,
732 	RIE2_QFS3	= 0x00000008,
733 	RIE2_QFS4	= 0x00000010,
734 	RIE2_QFS5	= 0x00000020,
735 	RIE2_QFS6	= 0x00000040,
736 	RIE2_QFS7	= 0x00000080,
737 	RIE2_QFS8	= 0x00000100,
738 	RIE2_QFS9	= 0x00000200,
739 	RIE2_QFS10	= 0x00000400,
740 	RIE2_QFS11	= 0x00000800,
741 	RIE2_QFS12	= 0x00001000,
742 	RIE2_QFS13	= 0x00002000,
743 	RIE2_QFS14	= 0x00004000,
744 	RIE2_QFS15	= 0x00008000,
745 	RIE2_QFS16	= 0x00010000,
746 	RIE2_QFS17	= 0x00020000,
747 	RIE2_RFFS	= 0x80000000,
748 };
749 
750 /* RID2 (R-Car Gen3 only) */
751 enum RID2_BIT {
752 	RID2_QFD0	= 0x00000001,
753 	RID2_QFD1	= 0x00000002,
754 	RID2_QFD2	= 0x00000004,
755 	RID2_QFD3	= 0x00000008,
756 	RID2_QFD4	= 0x00000010,
757 	RID2_QFD5	= 0x00000020,
758 	RID2_QFD6	= 0x00000040,
759 	RID2_QFD7	= 0x00000080,
760 	RID2_QFD8	= 0x00000100,
761 	RID2_QFD9	= 0x00000200,
762 	RID2_QFD10	= 0x00000400,
763 	RID2_QFD11	= 0x00000800,
764 	RID2_QFD12	= 0x00001000,
765 	RID2_QFD13	= 0x00002000,
766 	RID2_QFD14	= 0x00004000,
767 	RID2_QFD15	= 0x00008000,
768 	RID2_QFD16	= 0x00010000,
769 	RID2_QFD17	= 0x00020000,
770 	RID2_RFFD	= 0x80000000,
771 };
772 
773 /* TIE (R-Car Gen3 only) */
774 enum TIE_BIT {
775 	TIE_FTS0	= 0x00000001,
776 	TIE_FTS1	= 0x00000002,
777 	TIE_FTS2	= 0x00000004,
778 	TIE_FTS3	= 0x00000008,
779 	TIE_TFUS	= 0x00000100,
780 	TIE_TFWS	= 0x00000200,
781 	TIE_MFUS	= 0x00000400,
782 	TIE_MFWS	= 0x00000800,
783 	TIE_TDPS0	= 0x00010000,
784 	TIE_TDPS1	= 0x00020000,
785 	TIE_TDPS2	= 0x00040000,
786 	TIE_TDPS3	= 0x00080000,
787 };
788 
789 /* TID (R-Car Gen3 only) */
790 enum TID_BIT {
791 	TID_FTD0	= 0x00000001,
792 	TID_FTD1	= 0x00000002,
793 	TID_FTD2	= 0x00000004,
794 	TID_FTD3	= 0x00000008,
795 	TID_TFUD	= 0x00000100,
796 	TID_TFWD	= 0x00000200,
797 	TID_MFUD	= 0x00000400,
798 	TID_MFWD	= 0x00000800,
799 	TID_TDPD0	= 0x00010000,
800 	TID_TDPD1	= 0x00020000,
801 	TID_TDPD2	= 0x00040000,
802 	TID_TDPD3	= 0x00080000,
803 };
804 
805 /* ECMR */
806 enum ECMR_BIT {
807 	ECMR_PRM	= 0x00000001,
808 	ECMR_DM		= 0x00000002,
809 	ECMR_TE		= 0x00000020,
810 	ECMR_RE		= 0x00000040,
811 	ECMR_MPDE	= 0x00000200,
812 	ECMR_TXF	= 0x00010000,	/* Documented for R-Car Gen3 only */
813 	ECMR_RXF	= 0x00020000,
814 	ECMR_PFR	= 0x00040000,
815 	ECMR_ZPF	= 0x00080000,	/* Documented for R-Car Gen3 and RZ/G2L */
816 	ECMR_RZPF	= 0x00100000,
817 	ECMR_DPAD	= 0x00200000,
818 	ECMR_RCSC	= 0x00800000,
819 	ECMR_RCPT	= 0x02000000,	/* Documented for RZ/G2L only */
820 	ECMR_TRCCM	= 0x04000000,
821 };
822 
823 /* ECSR */
824 enum ECSR_BIT {
825 	ECSR_ICD	= 0x00000001,
826 	ECSR_MPD	= 0x00000002,
827 	ECSR_LCHNG	= 0x00000004,
828 	ECSR_PHYI	= 0x00000008,
829 	ECSR_PFRI	= 0x00000010,
830 };
831 
832 /* ECSIPR */
833 enum ECSIPR_BIT {
834 	ECSIPR_ICDIP	= 0x00000001,
835 	ECSIPR_MPDIP	= 0x00000002,
836 	ECSIPR_LCHNGIP	= 0x00000004,
837 };
838 
839 /* PIR */
840 enum PIR_BIT {
841 	PIR_MDC		= 0x00000001,
842 	PIR_MMD		= 0x00000002,
843 	PIR_MDO		= 0x00000004,
844 	PIR_MDI		= 0x00000008,
845 };
846 
847 /* PSR */
848 enum PSR_BIT {
849 	PSR_LMON	= 0x00000001,
850 };
851 
852 /* PIPR */
853 enum PIPR_BIT {
854 	PIPR_PHYIP	= 0x00000001,
855 };
856 
857 /* MPR */
858 enum MPR_BIT {
859 	MPR_MP		= 0x0000ffff,
860 };
861 
862 /* GECMR */
863 enum GECMR_BIT {
864 	GECMR_SPEED		= 0x00000001,
865 	GECMR_SPEED_100		= 0x00000000,
866 	GECMR_SPEED_1000	= 0x00000001,
867 	GBETH_GECMR_SPEED	= 0x00000030,
868 	GBETH_GECMR_SPEED_10	= 0x00000000,
869 	GBETH_GECMR_SPEED_100	= 0x00000010,
870 	GBETH_GECMR_SPEED_1000	= 0x00000020,
871 };
872 
873 /* The Ethernet AVB descriptor definitions. */
874 struct ravb_desc {
875 	__le16 ds;	/* Descriptor size */
876 	u8 cc;		/* Content control MSBs (reserved) */
877 	u8 die_dt;	/* Descriptor interrupt enable and type */
878 	__le32 dptr;	/* Descriptor pointer */
879 };
880 
881 #define DPTR_ALIGN	4	/* Required descriptor pointer alignment */
882 
883 enum DIE_DT {
884 	/* Frame data */
885 	DT_FMID		= 0x40,
886 	DT_FSTART	= 0x50,
887 	DT_FEND		= 0x60,
888 	DT_FSINGLE	= 0x70,
889 	/* Chain control */
890 	DT_LINK		= 0x80,
891 	DT_LINKFIX	= 0x90,
892 	DT_EOS		= 0xa0,
893 	/* HW/SW arbitration */
894 	DT_FEMPTY	= 0xc0,
895 	DT_FEMPTY_IS	= 0xd0,
896 	DT_FEMPTY_IC	= 0xe0,
897 	DT_FEMPTY_ND	= 0xf0,
898 	DT_LEMPTY	= 0x20,
899 	DT_EEMPTY	= 0x30,
900 };
901 
902 struct ravb_rx_desc {
903 	__le16 ds_cc;	/* Descriptor size and content control LSBs */
904 	u8 msc;		/* MAC status code */
905 	u8 die_dt;	/* Descriptor interrupt enable and type */
906 	__le32 dptr;	/* Descpriptor pointer */
907 };
908 
909 struct ravb_ex_rx_desc {
910 	__le16 ds_cc;	/* Descriptor size and content control lower bits */
911 	u8 msc;		/* MAC status code */
912 	u8 die_dt;	/* Descriptor interrupt enable and type */
913 	__le32 dptr;	/* Descpriptor pointer */
914 	__le32 ts_n;	/* Timestampe nsec */
915 	__le32 ts_sl;	/* Timestamp low */
916 	__le16 ts_sh;	/* Timestamp high */
917 	__le16 res;	/* Reserved bits */
918 };
919 
920 enum RX_DS_CC_BIT {
921 	RX_DS		= 0x0fff, /* Data size */
922 	RX_TR		= 0x1000, /* Truncation indication */
923 	RX_EI		= 0x2000, /* Error indication */
924 	RX_PS		= 0xc000, /* Padding selection */
925 };
926 
927 /* E-MAC status code */
928 enum MSC_BIT {
929 	MSC_CRC		= 0x01, /* Frame CRC error */
930 	MSC_RFE		= 0x02, /* Frame reception error (flagged by PHY) */
931 	MSC_RTSF	= 0x04, /* Frame length error (frame too short) */
932 	MSC_RTLF	= 0x08, /* Frame length error (frame too long) */
933 	MSC_FRE		= 0x10, /* Fraction error (not a multiple of 8 bits) */
934 	MSC_CRL		= 0x20, /* Carrier lost */
935 	MSC_CEEF	= 0x40, /* Carrier extension error */
936 	MSC_MC		= 0x80, /* Multicast frame reception */
937 };
938 
939 struct ravb_tx_desc {
940 	__le16 ds_tagl;	/* Descriptor size and frame tag LSBs */
941 	u8 tagh_tsr;	/* Frame tag MSBs and timestamp storage request bit */
942 	u8 die_dt;	/* Descriptor interrupt enable and type */
943 	__le32 dptr;	/* Descpriptor pointer */
944 };
945 
946 enum TX_DS_TAGL_BIT {
947 	TX_DS		= 0x0fff, /* Data size */
948 	TX_TAGL		= 0xf000, /* Frame tag LSBs */
949 };
950 
951 enum TX_TAGH_TSR_BIT {
952 	TX_TAGH		= 0x3f, /* Frame tag MSBs */
953 	TX_TSR		= 0x40, /* Timestamp storage request */
954 };
955 enum RAVB_QUEUE {
956 	RAVB_BE = 0,	/* Best Effort Queue */
957 	RAVB_NC,	/* Network Control Queue */
958 };
959 
960 enum CXR31_BIT {
961 	CXR31_SEL_LINK0	= 0x00000001,
962 	CXR31_SEL_LINK1	= 0x00000008,
963 };
964 
965 #define DBAT_ENTRY_NUM	22
966 #define RX_QUEUE_OFFSET	4
967 #define NUM_RX_QUEUE	2
968 #define NUM_TX_QUEUE	2
969 
970 #define RX_BUF_SZ	(2048 - ETH_FCS_LEN + sizeof(__sum16))
971 
972 #define GBETH_RX_BUFF_MAX 8192
973 
974 struct ravb_tstamp_skb {
975 	struct list_head list;
976 	struct sk_buff *skb;
977 	u16 tag;
978 };
979 
980 struct ravb_ptp_perout {
981 	u32 target;
982 	u32 period;
983 };
984 
985 #define N_EXT_TS	1
986 #define N_PER_OUT	1
987 
988 struct ravb_ptp {
989 	struct ptp_clock *clock;
990 	struct ptp_clock_info info;
991 	u32 default_addend;
992 	u32 current_addend;
993 	int extts[N_EXT_TS];
994 	struct ravb_ptp_perout perout[N_PER_OUT];
995 };
996 
997 struct ravb_hw_info {
998 	void (*rx_ring_free)(struct net_device *ndev, int q);
999 	void (*rx_ring_format)(struct net_device *ndev, int q);
1000 	void *(*alloc_rx_desc)(struct net_device *ndev, int q);
1001 	bool (*receive)(struct net_device *ndev, int *quota, int q);
1002 	void (*set_rate)(struct net_device *ndev);
1003 	int (*set_feature)(struct net_device *ndev, netdev_features_t features);
1004 	int (*dmac_init)(struct net_device *ndev);
1005 	void (*emac_init)(struct net_device *ndev);
1006 	const char (*gstrings_stats)[ETH_GSTRING_LEN];
1007 	size_t gstrings_size;
1008 	netdev_features_t net_hw_features;
1009 	netdev_features_t net_features;
1010 	int stats_len;
1011 	size_t max_rx_len;
1012 	u32 tsrq;
1013 	unsigned aligned_tx: 1;
1014 
1015 	/* hardware features */
1016 	unsigned internal_delay:1;	/* AVB-DMAC has internal delays */
1017 	unsigned tx_counters:1;		/* E-MAC has TX counters */
1018 	unsigned multi_irqs:1;		/* AVB-DMAC and E-MAC has multiple irqs */
1019 	unsigned gptp:1;		/* AVB-DMAC has gPTP support */
1020 	unsigned ccc_gac:1;		/* AVB-DMAC has gPTP support active in config mode */
1021 	unsigned nc_queue:1;		/* AVB-DMAC has NC queue */
1022 	unsigned magic_pkt:1;		/* E-MAC supports magic packet detection */
1023 	unsigned half_duplex:1;		/* E-MAC supports half duplex mode */
1024 };
1025 
1026 struct ravb_private {
1027 	struct net_device *ndev;
1028 	struct platform_device *pdev;
1029 	void __iomem *addr;
1030 	struct clk *clk;
1031 	struct clk *refclk;
1032 	struct mdiobb_ctrl mdiobb;
1033 	u32 num_rx_ring[NUM_RX_QUEUE];
1034 	u32 num_tx_ring[NUM_TX_QUEUE];
1035 	u32 desc_bat_size;
1036 	dma_addr_t desc_bat_dma;
1037 	struct ravb_desc *desc_bat;
1038 	dma_addr_t rx_desc_dma[NUM_RX_QUEUE];
1039 	dma_addr_t tx_desc_dma[NUM_TX_QUEUE];
1040 	struct ravb_ex_rx_desc *rx_ring[NUM_RX_QUEUE];
1041 	struct ravb_tx_desc *tx_ring[NUM_TX_QUEUE];
1042 	void *tx_align[NUM_TX_QUEUE];
1043 	struct sk_buff **rx_skb[NUM_RX_QUEUE];
1044 	struct sk_buff **tx_skb[NUM_TX_QUEUE];
1045 	u32 rx_over_errors;
1046 	u32 rx_fifo_errors;
1047 	struct net_device_stats stats[NUM_RX_QUEUE];
1048 	u32 tstamp_tx_ctrl;
1049 	u32 tstamp_rx_ctrl;
1050 	struct list_head ts_skb_list;
1051 	u32 ts_skb_tag;
1052 	struct ravb_ptp ptp;
1053 	spinlock_t lock;		/* Register access lock */
1054 	u32 cur_rx[NUM_RX_QUEUE];	/* Consumer ring indices */
1055 	u32 dirty_rx[NUM_RX_QUEUE];	/* Producer ring indices */
1056 	u32 cur_tx[NUM_TX_QUEUE];
1057 	u32 dirty_tx[NUM_TX_QUEUE];
1058 	struct napi_struct napi[NUM_RX_QUEUE];
1059 	struct work_struct work;
1060 	/* MII transceiver section. */
1061 	struct mii_bus *mii_bus;	/* MDIO bus control */
1062 	int link;
1063 	phy_interface_t phy_interface;
1064 	int msg_enable;
1065 	int speed;
1066 	int emac_irq;
1067 	int rx_irqs[NUM_RX_QUEUE];
1068 	int tx_irqs[NUM_TX_QUEUE];
1069 
1070 	unsigned no_avb_link:1;
1071 	unsigned avb_link_active_low:1;
1072 	unsigned wol_enabled:1;
1073 	unsigned rxcidm:1;		/* RX Clock Internal Delay Mode */
1074 	unsigned txcidm:1;		/* TX Clock Internal Delay Mode */
1075 	unsigned rgmii_override:1;	/* Deprecated rgmii-*id behavior */
1076 	unsigned int num_tx_desc;	/* TX descriptors per packet */
1077 
1078 	int duplex;
1079 
1080 	const struct ravb_hw_info *info;
1081 	struct reset_control *rstc;
1082 };
1083 
1084 static inline u32 ravb_read(struct net_device *ndev, enum ravb_reg reg)
1085 {
1086 	struct ravb_private *priv = netdev_priv(ndev);
1087 
1088 	return ioread32(priv->addr + reg);
1089 }
1090 
1091 static inline void ravb_write(struct net_device *ndev, u32 data,
1092 			      enum ravb_reg reg)
1093 {
1094 	struct ravb_private *priv = netdev_priv(ndev);
1095 
1096 	iowrite32(data, priv->addr + reg);
1097 }
1098 
1099 void ravb_modify(struct net_device *ndev, enum ravb_reg reg, u32 clear,
1100 		 u32 set);
1101 int ravb_wait(struct net_device *ndev, enum ravb_reg reg, u32 mask, u32 value);
1102 
1103 void ravb_ptp_interrupt(struct net_device *ndev);
1104 void ravb_ptp_init(struct net_device *ndev, struct platform_device *pdev);
1105 void ravb_ptp_stop(struct net_device *ndev);
1106 
1107 #endif	/* #ifndef __RAVB_H__ */
1108