xref: /linux/drivers/net/ethernet/mediatek/mtk_eth_soc.h (revision 81ee0eb6c0fe34490ed92667538197d9295e899e)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  *
4  *   Copyright (C) 2009-2016 John Crispin <blogic@openwrt.org>
5  *   Copyright (C) 2009-2016 Felix Fietkau <nbd@openwrt.org>
6  *   Copyright (C) 2013-2016 Michael Lee <igvtee@gmail.com>
7  */
8 
9 #ifndef MTK_ETH_H
10 #define MTK_ETH_H
11 
12 #include <linux/dma-mapping.h>
13 #include <linux/netdevice.h>
14 #include <linux/of_net.h>
15 #include <linux/u64_stats_sync.h>
16 #include <linux/refcount.h>
17 #include <linux/phylink.h>
18 #include <linux/rhashtable.h>
19 #include <linux/dim.h>
20 #include "mtk_ppe.h"
21 
22 #define MTK_QDMA_PAGE_SIZE	2048
23 #define MTK_MAX_RX_LENGTH	1536
24 #define MTK_MAX_RX_LENGTH_2K	2048
25 #define MTK_TX_DMA_BUF_LEN	0x3fff
26 #define MTK_DMA_SIZE		512
27 #define MTK_NAPI_WEIGHT		64
28 #define MTK_MAC_COUNT		2
29 #define MTK_RX_ETH_HLEN		(ETH_HLEN + ETH_FCS_LEN)
30 #define MTK_RX_HLEN		(NET_SKB_PAD + MTK_RX_ETH_HLEN + NET_IP_ALIGN)
31 #define MTK_DMA_DUMMY_DESC	0xffffffff
32 #define MTK_DEFAULT_MSG_ENABLE	(NETIF_MSG_DRV | \
33 				 NETIF_MSG_PROBE | \
34 				 NETIF_MSG_LINK | \
35 				 NETIF_MSG_TIMER | \
36 				 NETIF_MSG_IFDOWN | \
37 				 NETIF_MSG_IFUP | \
38 				 NETIF_MSG_RX_ERR | \
39 				 NETIF_MSG_TX_ERR)
40 #define MTK_HW_FEATURES		(NETIF_F_IP_CSUM | \
41 				 NETIF_F_RXCSUM | \
42 				 NETIF_F_HW_VLAN_CTAG_TX | \
43 				 NETIF_F_HW_VLAN_CTAG_RX | \
44 				 NETIF_F_SG | NETIF_F_TSO | \
45 				 NETIF_F_TSO6 | \
46 				 NETIF_F_IPV6_CSUM |\
47 				 NETIF_F_HW_TC)
48 #define MTK_HW_FEATURES_MT7628	(NETIF_F_SG | NETIF_F_RXCSUM)
49 #define NEXT_DESP_IDX(X, Y)	(((X) + 1) & ((Y) - 1))
50 
51 #define MTK_MAX_RX_RING_NUM	4
52 #define MTK_HW_LRO_DMA_SIZE	8
53 
54 #define	MTK_MAX_LRO_RX_LENGTH		(4096 * 3)
55 #define	MTK_MAX_LRO_IP_CNT		2
56 #define	MTK_HW_LRO_TIMER_UNIT		1	/* 20 us */
57 #define	MTK_HW_LRO_REFRESH_TIME		50000	/* 1 sec. */
58 #define	MTK_HW_LRO_AGG_TIME		10	/* 200us */
59 #define	MTK_HW_LRO_AGE_TIME		50	/* 1ms */
60 #define	MTK_HW_LRO_MAX_AGG_CNT		64
61 #define	MTK_HW_LRO_BW_THRE		3000
62 #define	MTK_HW_LRO_REPLACE_DELTA	1000
63 #define	MTK_HW_LRO_SDL_REMAIN_ROOM	1522
64 
65 /* Frame Engine Global Reset Register */
66 #define MTK_RST_GL		0x04
67 #define RST_GL_PSE		BIT(0)
68 
69 /* Frame Engine Interrupt Status Register */
70 #define MTK_INT_STATUS2		0x08
71 #define MTK_GDM1_AF		BIT(28)
72 #define MTK_GDM2_AF		BIT(29)
73 
74 /* PDMA HW LRO Alter Flow Timer Register */
75 #define MTK_PDMA_LRO_ALT_REFRESH_TIMER	0x1c
76 
77 /* Frame Engine Interrupt Grouping Register */
78 #define MTK_FE_INT_GRP		0x20
79 
80 /* CDMP Ingress Control Register */
81 #define MTK_CDMQ_IG_CTRL	0x1400
82 #define MTK_CDMQ_STAG_EN	BIT(0)
83 
84 /* CDMP Exgress Control Register */
85 #define MTK_CDMP_EG_CTRL	0x404
86 
87 /* GDM Exgress Control Register */
88 #define MTK_GDMA_FWD_CFG(x)	(0x500 + (x * 0x1000))
89 #define MTK_GDMA_SPECIAL_TAG	BIT(24)
90 #define MTK_GDMA_ICS_EN		BIT(22)
91 #define MTK_GDMA_TCS_EN		BIT(21)
92 #define MTK_GDMA_UCS_EN		BIT(20)
93 #define MTK_GDMA_TO_PDMA	0x0
94 #define MTK_GDMA_TO_PPE		0x4444
95 #define MTK_GDMA_DROP_ALL       0x7777
96 
97 /* Unicast Filter MAC Address Register - Low */
98 #define MTK_GDMA_MAC_ADRL(x)	(0x508 + (x * 0x1000))
99 
100 /* Unicast Filter MAC Address Register - High */
101 #define MTK_GDMA_MAC_ADRH(x)	(0x50C + (x * 0x1000))
102 
103 /* PDMA RX Base Pointer Register */
104 #define MTK_PRX_BASE_PTR0	0x900
105 #define MTK_PRX_BASE_PTR_CFG(x)	(MTK_PRX_BASE_PTR0 + (x * 0x10))
106 
107 /* PDMA RX Maximum Count Register */
108 #define MTK_PRX_MAX_CNT0	0x904
109 #define MTK_PRX_MAX_CNT_CFG(x)	(MTK_PRX_MAX_CNT0 + (x * 0x10))
110 
111 /* PDMA RX CPU Pointer Register */
112 #define MTK_PRX_CRX_IDX0	0x908
113 #define MTK_PRX_CRX_IDX_CFG(x)	(MTK_PRX_CRX_IDX0 + (x * 0x10))
114 
115 /* PDMA HW LRO Control Registers */
116 #define MTK_PDMA_LRO_CTRL_DW0	0x980
117 #define MTK_LRO_EN			BIT(0)
118 #define MTK_L3_CKS_UPD_EN		BIT(7)
119 #define MTK_LRO_ALT_PKT_CNT_MODE	BIT(21)
120 #define MTK_LRO_RING_RELINQUISH_REQ	(0x7 << 26)
121 #define MTK_LRO_RING_RELINQUISH_DONE	(0x7 << 29)
122 
123 #define MTK_PDMA_LRO_CTRL_DW1	0x984
124 #define MTK_PDMA_LRO_CTRL_DW2	0x988
125 #define MTK_PDMA_LRO_CTRL_DW3	0x98c
126 #define MTK_ADMA_MODE		BIT(15)
127 #define MTK_LRO_MIN_RXD_SDL	(MTK_HW_LRO_SDL_REMAIN_ROOM << 16)
128 
129 /* PDMA Global Configuration Register */
130 #define MTK_PDMA_GLO_CFG	0xa04
131 #define MTK_MULTI_EN		BIT(10)
132 #define MTK_PDMA_SIZE_8DWORDS	(1 << 4)
133 
134 /* PDMA Reset Index Register */
135 #define MTK_PDMA_RST_IDX	0xa08
136 #define MTK_PST_DRX_IDX0	BIT(16)
137 #define MTK_PST_DRX_IDX_CFG(x)	(MTK_PST_DRX_IDX0 << (x))
138 
139 /* PDMA Delay Interrupt Register */
140 #define MTK_PDMA_DELAY_INT		0xa0c
141 #define MTK_PDMA_DELAY_RX_MASK		GENMASK(15, 0)
142 #define MTK_PDMA_DELAY_RX_EN		BIT(15)
143 #define MTK_PDMA_DELAY_RX_PINT_SHIFT	8
144 #define MTK_PDMA_DELAY_RX_PTIME_SHIFT	0
145 
146 #define MTK_PDMA_DELAY_TX_MASK		GENMASK(31, 16)
147 #define MTK_PDMA_DELAY_TX_EN		BIT(31)
148 #define MTK_PDMA_DELAY_TX_PINT_SHIFT	24
149 #define MTK_PDMA_DELAY_TX_PTIME_SHIFT	16
150 
151 #define MTK_PDMA_DELAY_PINT_MASK	0x7f
152 #define MTK_PDMA_DELAY_PTIME_MASK	0xff
153 
154 /* PDMA Interrupt Status Register */
155 #define MTK_PDMA_INT_STATUS	0xa20
156 
157 /* PDMA Interrupt Mask Register */
158 #define MTK_PDMA_INT_MASK	0xa28
159 
160 /* PDMA HW LRO Alter Flow Delta Register */
161 #define MTK_PDMA_LRO_ALT_SCORE_DELTA	0xa4c
162 
163 /* PDMA Interrupt grouping registers */
164 #define MTK_PDMA_INT_GRP1	0xa50
165 #define MTK_PDMA_INT_GRP2	0xa54
166 
167 /* PDMA HW LRO IP Setting Registers */
168 #define MTK_LRO_RX_RING0_DIP_DW0	0xb04
169 #define MTK_LRO_DIP_DW0_CFG(x)		(MTK_LRO_RX_RING0_DIP_DW0 + (x * 0x40))
170 #define MTK_RING_MYIP_VLD		BIT(9)
171 
172 /* PDMA HW LRO Ring Control Registers */
173 #define MTK_LRO_RX_RING0_CTRL_DW1	0xb28
174 #define MTK_LRO_RX_RING0_CTRL_DW2	0xb2c
175 #define MTK_LRO_RX_RING0_CTRL_DW3	0xb30
176 #define MTK_LRO_CTRL_DW1_CFG(x)		(MTK_LRO_RX_RING0_CTRL_DW1 + (x * 0x40))
177 #define MTK_LRO_CTRL_DW2_CFG(x)		(MTK_LRO_RX_RING0_CTRL_DW2 + (x * 0x40))
178 #define MTK_LRO_CTRL_DW3_CFG(x)		(MTK_LRO_RX_RING0_CTRL_DW3 + (x * 0x40))
179 #define MTK_RING_AGE_TIME_L		((MTK_HW_LRO_AGE_TIME & 0x3ff) << 22)
180 #define MTK_RING_AGE_TIME_H		((MTK_HW_LRO_AGE_TIME >> 10) & 0x3f)
181 #define MTK_RING_AUTO_LERAN_MODE	(3 << 6)
182 #define MTK_RING_VLD			BIT(8)
183 #define MTK_RING_MAX_AGG_TIME		((MTK_HW_LRO_AGG_TIME & 0xffff) << 10)
184 #define MTK_RING_MAX_AGG_CNT_L		((MTK_HW_LRO_MAX_AGG_CNT & 0x3f) << 26)
185 #define MTK_RING_MAX_AGG_CNT_H		((MTK_HW_LRO_MAX_AGG_CNT >> 6) & 0x3)
186 
187 /* QDMA TX Queue Configuration Registers */
188 #define MTK_QTX_CFG(x)		(0x1800 + (x * 0x10))
189 #define QDMA_RES_THRES		4
190 
191 /* QDMA TX Queue Scheduler Registers */
192 #define MTK_QTX_SCH(x)		(0x1804 + (x * 0x10))
193 
194 /* QDMA RX Base Pointer Register */
195 #define MTK_QRX_BASE_PTR0	0x1900
196 
197 /* QDMA RX Maximum Count Register */
198 #define MTK_QRX_MAX_CNT0	0x1904
199 
200 /* QDMA RX CPU Pointer Register */
201 #define MTK_QRX_CRX_IDX0	0x1908
202 
203 /* QDMA RX DMA Pointer Register */
204 #define MTK_QRX_DRX_IDX0	0x190C
205 
206 /* QDMA Global Configuration Register */
207 #define MTK_QDMA_GLO_CFG	0x1A04
208 #define MTK_RX_2B_OFFSET	BIT(31)
209 #define MTK_RX_BT_32DWORDS	(3 << 11)
210 #define MTK_NDP_CO_PRO		BIT(10)
211 #define MTK_TX_WB_DDONE		BIT(6)
212 #define MTK_TX_BT_32DWORDS	(3 << 4)
213 #define MTK_RX_DMA_BUSY		BIT(3)
214 #define MTK_TX_DMA_BUSY		BIT(1)
215 #define MTK_RX_DMA_EN		BIT(2)
216 #define MTK_TX_DMA_EN		BIT(0)
217 #define MTK_DMA_BUSY_TIMEOUT_US	1000000
218 
219 /* QDMA Reset Index Register */
220 #define MTK_QDMA_RST_IDX	0x1A08
221 
222 /* QDMA Delay Interrupt Register */
223 #define MTK_QDMA_DELAY_INT	0x1A0C
224 
225 /* QDMA Flow Control Register */
226 #define MTK_QDMA_FC_THRES	0x1A10
227 #define FC_THRES_DROP_MODE	BIT(20)
228 #define FC_THRES_DROP_EN	(7 << 16)
229 #define FC_THRES_MIN		0x4444
230 
231 /* QDMA Interrupt Status Register */
232 #define MTK_QDMA_INT_STATUS	0x1A18
233 #define MTK_RX_DONE_DLY		BIT(30)
234 #define MTK_TX_DONE_DLY		BIT(28)
235 #define MTK_RX_DONE_INT3	BIT(19)
236 #define MTK_RX_DONE_INT2	BIT(18)
237 #define MTK_RX_DONE_INT1	BIT(17)
238 #define MTK_RX_DONE_INT0	BIT(16)
239 #define MTK_TX_DONE_INT3	BIT(3)
240 #define MTK_TX_DONE_INT2	BIT(2)
241 #define MTK_TX_DONE_INT1	BIT(1)
242 #define MTK_TX_DONE_INT0	BIT(0)
243 #define MTK_RX_DONE_INT		MTK_RX_DONE_DLY
244 #define MTK_TX_DONE_INT		MTK_TX_DONE_DLY
245 
246 /* QDMA Interrupt grouping registers */
247 #define MTK_QDMA_INT_GRP1	0x1a20
248 #define MTK_QDMA_INT_GRP2	0x1a24
249 #define MTK_RLS_DONE_INT	BIT(0)
250 
251 /* QDMA Interrupt Status Register */
252 #define MTK_QDMA_INT_MASK	0x1A1C
253 
254 /* QDMA Interrupt Mask Register */
255 #define MTK_QDMA_HRED2		0x1A44
256 
257 /* QDMA TX Forward CPU Pointer Register */
258 #define MTK_QTX_CTX_PTR		0x1B00
259 
260 /* QDMA TX Forward DMA Pointer Register */
261 #define MTK_QTX_DTX_PTR		0x1B04
262 
263 /* QDMA TX Release CPU Pointer Register */
264 #define MTK_QTX_CRX_PTR		0x1B10
265 
266 /* QDMA TX Release DMA Pointer Register */
267 #define MTK_QTX_DRX_PTR		0x1B14
268 
269 /* QDMA FQ Head Pointer Register */
270 #define MTK_QDMA_FQ_HEAD	0x1B20
271 
272 /* QDMA FQ Head Pointer Register */
273 #define MTK_QDMA_FQ_TAIL	0x1B24
274 
275 /* QDMA FQ Free Page Counter Register */
276 #define MTK_QDMA_FQ_CNT		0x1B28
277 
278 /* QDMA FQ Free Page Buffer Length Register */
279 #define MTK_QDMA_FQ_BLEN	0x1B2C
280 
281 /* GMA1 counter / statics register */
282 #define MTK_GDM1_RX_GBCNT_L	0x2400
283 #define MTK_GDM1_RX_GBCNT_H	0x2404
284 #define MTK_GDM1_RX_GPCNT	0x2408
285 #define MTK_GDM1_RX_OERCNT	0x2410
286 #define MTK_GDM1_RX_FERCNT	0x2414
287 #define MTK_GDM1_RX_SERCNT	0x2418
288 #define MTK_GDM1_RX_LENCNT	0x241c
289 #define MTK_GDM1_RX_CERCNT	0x2420
290 #define MTK_GDM1_RX_FCCNT	0x2424
291 #define MTK_GDM1_TX_SKIPCNT	0x2428
292 #define MTK_GDM1_TX_COLCNT	0x242c
293 #define MTK_GDM1_TX_GBCNT_L	0x2430
294 #define MTK_GDM1_TX_GBCNT_H	0x2434
295 #define MTK_GDM1_TX_GPCNT	0x2438
296 #define MTK_STAT_OFFSET		0x40
297 
298 #define MTK_WDMA0_BASE		0x2800
299 #define MTK_WDMA1_BASE		0x2c00
300 
301 /* QDMA descriptor txd4 */
302 #define TX_DMA_CHKSUM		(0x7 << 29)
303 #define TX_DMA_TSO		BIT(28)
304 #define TX_DMA_FPORT_SHIFT	25
305 #define TX_DMA_FPORT_MASK	0x7
306 #define TX_DMA_INS_VLAN		BIT(16)
307 
308 /* QDMA descriptor txd3 */
309 #define TX_DMA_OWNER_CPU	BIT(31)
310 #define TX_DMA_LS0		BIT(30)
311 #define TX_DMA_PLEN0(_x)	(((_x) & MTK_TX_DMA_BUF_LEN) << 16)
312 #define TX_DMA_PLEN1(_x)	((_x) & MTK_TX_DMA_BUF_LEN)
313 #define TX_DMA_SWC		BIT(14)
314 #define TX_DMA_SDL(_x)		(((_x) & 0x3fff) << 16)
315 
316 /* PDMA on MT7628 */
317 #define TX_DMA_DONE		BIT(31)
318 #define TX_DMA_LS1		BIT(14)
319 #define TX_DMA_DESP2_DEF	(TX_DMA_LS0 | TX_DMA_DONE)
320 
321 /* QDMA descriptor rxd2 */
322 #define RX_DMA_DONE		BIT(31)
323 #define RX_DMA_LSO		BIT(30)
324 #define RX_DMA_PLEN0(_x)	(((_x) & 0x3fff) << 16)
325 #define RX_DMA_GET_PLEN0(_x)	(((_x) >> 16) & 0x3fff)
326 #define RX_DMA_VTAG		BIT(15)
327 
328 /* QDMA descriptor rxd3 */
329 #define RX_DMA_VID(_x)		((_x) & 0xfff)
330 
331 /* QDMA descriptor rxd4 */
332 #define MTK_RXD4_FOE_ENTRY	GENMASK(13, 0)
333 #define MTK_RXD4_PPE_CPU_REASON	GENMASK(18, 14)
334 #define MTK_RXD4_SRC_PORT	GENMASK(21, 19)
335 #define MTK_RXD4_ALG		GENMASK(31, 22)
336 
337 /* QDMA descriptor rxd4 */
338 #define RX_DMA_L4_VALID		BIT(24)
339 #define RX_DMA_L4_VALID_PDMA	BIT(30)		/* when PDMA is used */
340 #define RX_DMA_FPORT_SHIFT	19
341 #define RX_DMA_FPORT_MASK	0x7
342 #define RX_DMA_SPECIAL_TAG	BIT(22)
343 
344 /* PHY Indirect Access Control registers */
345 #define MTK_PHY_IAC		0x10004
346 #define PHY_IAC_ACCESS		BIT(31)
347 #define PHY_IAC_REG_MASK	GENMASK(29, 25)
348 #define PHY_IAC_REG(x)		FIELD_PREP(PHY_IAC_REG_MASK, (x))
349 #define PHY_IAC_ADDR_MASK	GENMASK(24, 20)
350 #define PHY_IAC_ADDR(x)		FIELD_PREP(PHY_IAC_ADDR_MASK, (x))
351 #define PHY_IAC_CMD_MASK	GENMASK(19, 18)
352 #define PHY_IAC_CMD_C45_ADDR	FIELD_PREP(PHY_IAC_CMD_MASK, 0)
353 #define PHY_IAC_CMD_WRITE	FIELD_PREP(PHY_IAC_CMD_MASK, 1)
354 #define PHY_IAC_CMD_C22_READ	FIELD_PREP(PHY_IAC_CMD_MASK, 2)
355 #define PHY_IAC_CMD_C45_READ	FIELD_PREP(PHY_IAC_CMD_MASK, 3)
356 #define PHY_IAC_START_MASK	GENMASK(17, 16)
357 #define PHY_IAC_START_C45	FIELD_PREP(PHY_IAC_START_MASK, 0)
358 #define PHY_IAC_START_C22	FIELD_PREP(PHY_IAC_START_MASK, 1)
359 #define PHY_IAC_DATA_MASK	GENMASK(15, 0)
360 #define PHY_IAC_DATA(x)		FIELD_PREP(PHY_IAC_DATA_MASK, (x))
361 #define PHY_IAC_TIMEOUT		HZ
362 
363 #define MTK_MAC_MISC		0x1000c
364 #define MTK_MUX_TO_ESW		BIT(0)
365 
366 /* Mac control registers */
367 #define MTK_MAC_MCR(x)		(0x10100 + (x * 0x100))
368 #define MAC_MCR_MAX_RX_MASK	GENMASK(25, 24)
369 #define MAC_MCR_MAX_RX(_x)	(MAC_MCR_MAX_RX_MASK & ((_x) << 24))
370 #define MAC_MCR_MAX_RX_1518	0x0
371 #define MAC_MCR_MAX_RX_1536	0x1
372 #define MAC_MCR_MAX_RX_1552	0x2
373 #define MAC_MCR_MAX_RX_2048	0x3
374 #define MAC_MCR_IPG_CFG		(BIT(18) | BIT(16))
375 #define MAC_MCR_FORCE_MODE	BIT(15)
376 #define MAC_MCR_TX_EN		BIT(14)
377 #define MAC_MCR_RX_EN		BIT(13)
378 #define MAC_MCR_BACKOFF_EN	BIT(9)
379 #define MAC_MCR_BACKPR_EN	BIT(8)
380 #define MAC_MCR_FORCE_RX_FC	BIT(5)
381 #define MAC_MCR_FORCE_TX_FC	BIT(4)
382 #define MAC_MCR_SPEED_1000	BIT(3)
383 #define MAC_MCR_SPEED_100	BIT(2)
384 #define MAC_MCR_FORCE_DPX	BIT(1)
385 #define MAC_MCR_FORCE_LINK	BIT(0)
386 #define MAC_MCR_FORCE_LINK_DOWN	(MAC_MCR_FORCE_MODE)
387 
388 /* Mac status registers */
389 #define MTK_MAC_MSR(x)		(0x10108 + (x * 0x100))
390 #define MAC_MSR_EEE1G		BIT(7)
391 #define MAC_MSR_EEE100M		BIT(6)
392 #define MAC_MSR_RX_FC		BIT(5)
393 #define MAC_MSR_TX_FC		BIT(4)
394 #define MAC_MSR_SPEED_1000	BIT(3)
395 #define MAC_MSR_SPEED_100	BIT(2)
396 #define MAC_MSR_SPEED_MASK	(MAC_MSR_SPEED_1000 | MAC_MSR_SPEED_100)
397 #define MAC_MSR_DPX		BIT(1)
398 #define MAC_MSR_LINK		BIT(0)
399 
400 /* TRGMII RXC control register */
401 #define TRGMII_RCK_CTRL		0x10300
402 #define DQSI0(x)		((x << 0) & GENMASK(6, 0))
403 #define DQSI1(x)		((x << 8) & GENMASK(14, 8))
404 #define RXCTL_DMWTLAT(x)	((x << 16) & GENMASK(18, 16))
405 #define RXC_RST			BIT(31)
406 #define RXC_DQSISEL		BIT(30)
407 #define RCK_CTRL_RGMII_1000	(RXC_DQSISEL | RXCTL_DMWTLAT(2) | DQSI1(16))
408 #define RCK_CTRL_RGMII_10_100	RXCTL_DMWTLAT(2)
409 
410 #define NUM_TRGMII_CTRL		5
411 
412 /* TRGMII RXC control register */
413 #define TRGMII_TCK_CTRL		0x10340
414 #define TXCTL_DMWTLAT(x)	((x << 16) & GENMASK(18, 16))
415 #define TXC_INV			BIT(30)
416 #define TCK_CTRL_RGMII_1000	TXCTL_DMWTLAT(2)
417 #define TCK_CTRL_RGMII_10_100	(TXC_INV | TXCTL_DMWTLAT(2))
418 
419 /* TRGMII TX Drive Strength */
420 #define TRGMII_TD_ODT(i)	(0x10354 + 8 * (i))
421 #define  TD_DM_DRVP(x)		((x) & 0xf)
422 #define  TD_DM_DRVN(x)		(((x) & 0xf) << 4)
423 
424 /* TRGMII Interface mode register */
425 #define INTF_MODE		0x10390
426 #define TRGMII_INTF_DIS		BIT(0)
427 #define TRGMII_MODE		BIT(1)
428 #define TRGMII_CENTRAL_ALIGNED	BIT(2)
429 #define INTF_MODE_RGMII_1000    (TRGMII_MODE | TRGMII_CENTRAL_ALIGNED)
430 #define INTF_MODE_RGMII_10_100  0
431 
432 /* GPIO port control registers for GMAC 2*/
433 #define GPIO_OD33_CTRL8		0x4c0
434 #define GPIO_BIAS_CTRL		0xed0
435 #define GPIO_DRV_SEL10		0xf00
436 
437 /* ethernet subsystem chip id register */
438 #define ETHSYS_CHIPID0_3	0x0
439 #define ETHSYS_CHIPID4_7	0x4
440 #define MT7623_ETH		7623
441 #define MT7622_ETH		7622
442 #define MT7621_ETH		7621
443 
444 /* ethernet system control register */
445 #define ETHSYS_SYSCFG		0x10
446 #define SYSCFG_DRAM_TYPE_DDR2	BIT(4)
447 
448 /* ethernet subsystem config register */
449 #define ETHSYS_SYSCFG0		0x14
450 #define SYSCFG0_GE_MASK		0x3
451 #define SYSCFG0_GE_MODE(x, y)	(x << (12 + (y * 2)))
452 #define SYSCFG0_SGMII_MASK     GENMASK(9, 8)
453 #define SYSCFG0_SGMII_GMAC1    ((2 << 8) & SYSCFG0_SGMII_MASK)
454 #define SYSCFG0_SGMII_GMAC2    ((3 << 8) & SYSCFG0_SGMII_MASK)
455 #define SYSCFG0_SGMII_GMAC1_V2 BIT(9)
456 #define SYSCFG0_SGMII_GMAC2_V2 BIT(8)
457 
458 
459 /* ethernet subsystem clock register */
460 #define ETHSYS_CLKCFG0		0x2c
461 #define ETHSYS_TRGMII_CLK_SEL362_5	BIT(11)
462 #define ETHSYS_TRGMII_MT7621_MASK	(BIT(5) | BIT(6))
463 #define ETHSYS_TRGMII_MT7621_APLL	BIT(6)
464 #define ETHSYS_TRGMII_MT7621_DDR_PLL	BIT(5)
465 
466 /* ethernet reset control register */
467 #define ETHSYS_RSTCTRL		0x34
468 #define RSTCTRL_FE		BIT(6)
469 #define RSTCTRL_PPE		BIT(31)
470 
471 /* ethernet dma channel agent map */
472 #define ETHSYS_DMA_AG_MAP	0x408
473 #define ETHSYS_DMA_AG_MAP_PDMA	BIT(0)
474 #define ETHSYS_DMA_AG_MAP_QDMA	BIT(1)
475 #define ETHSYS_DMA_AG_MAP_PPE	BIT(2)
476 
477 /* SGMII subsystem config registers */
478 /* Register to auto-negotiation restart */
479 #define SGMSYS_PCS_CONTROL_1	0x0
480 #define SGMII_AN_RESTART	BIT(9)
481 #define SGMII_ISOLATE		BIT(10)
482 #define SGMII_AN_ENABLE		BIT(12)
483 #define SGMII_LINK_STATYS	BIT(18)
484 #define SGMII_AN_ABILITY	BIT(19)
485 #define SGMII_AN_COMPLETE	BIT(21)
486 #define SGMII_PCS_FAULT		BIT(23)
487 #define SGMII_AN_EXPANSION_CLR	BIT(30)
488 
489 /* Register to programmable link timer, the unit in 2 * 8ns */
490 #define SGMSYS_PCS_LINK_TIMER	0x18
491 #define SGMII_LINK_TIMER_DEFAULT	(0x186a0 & GENMASK(19, 0))
492 
493 /* Register to control remote fault */
494 #define SGMSYS_SGMII_MODE		0x20
495 #define SGMII_IF_MODE_BIT0		BIT(0)
496 #define SGMII_SPEED_DUPLEX_AN		BIT(1)
497 #define SGMII_SPEED_10			0x0
498 #define SGMII_SPEED_100			BIT(2)
499 #define SGMII_SPEED_1000		BIT(3)
500 #define SGMII_DUPLEX_FULL		BIT(4)
501 #define SGMII_IF_MODE_BIT5		BIT(5)
502 #define SGMII_REMOTE_FAULT_DIS		BIT(8)
503 #define SGMII_CODE_SYNC_SET_VAL		BIT(9)
504 #define SGMII_CODE_SYNC_SET_EN		BIT(10)
505 #define SGMII_SEND_AN_ERROR_EN		BIT(11)
506 #define SGMII_IF_MODE_MASK		GENMASK(5, 1)
507 
508 /* Register to set SGMII speed, ANA RG_ Control Signals III*/
509 #define SGMSYS_ANA_RG_CS3	0x2028
510 #define RG_PHY_SPEED_MASK	(BIT(2) | BIT(3))
511 #define RG_PHY_SPEED_1_25G	0x0
512 #define RG_PHY_SPEED_3_125G	BIT(2)
513 
514 /* Register to power up QPHY */
515 #define SGMSYS_QPHY_PWR_STATE_CTRL 0xe8
516 #define	SGMII_PHYA_PWD		BIT(4)
517 
518 /* Infrasys subsystem config registers */
519 #define INFRA_MISC2            0x70c
520 #define CO_QPHY_SEL            BIT(0)
521 #define GEPHY_MAC_SEL          BIT(1)
522 
523 /* MT7628/88 specific stuff */
524 #define MT7628_PDMA_OFFSET	0x0800
525 #define MT7628_SDM_OFFSET	0x0c00
526 
527 #define MT7628_TX_BASE_PTR0	(MT7628_PDMA_OFFSET + 0x00)
528 #define MT7628_TX_MAX_CNT0	(MT7628_PDMA_OFFSET + 0x04)
529 #define MT7628_TX_CTX_IDX0	(MT7628_PDMA_OFFSET + 0x08)
530 #define MT7628_TX_DTX_IDX0	(MT7628_PDMA_OFFSET + 0x0c)
531 #define MT7628_PST_DTX_IDX0	BIT(0)
532 
533 #define MT7628_SDM_MAC_ADRL	(MT7628_SDM_OFFSET + 0x0c)
534 #define MT7628_SDM_MAC_ADRH	(MT7628_SDM_OFFSET + 0x10)
535 
536 /* Counter / stat register */
537 #define MT7628_SDM_TPCNT	(MT7628_SDM_OFFSET + 0x100)
538 #define MT7628_SDM_TBCNT	(MT7628_SDM_OFFSET + 0x104)
539 #define MT7628_SDM_RPCNT	(MT7628_SDM_OFFSET + 0x108)
540 #define MT7628_SDM_RBCNT	(MT7628_SDM_OFFSET + 0x10c)
541 #define MT7628_SDM_CS_ERR	(MT7628_SDM_OFFSET + 0x110)
542 
543 struct mtk_rx_dma {
544 	unsigned int rxd1;
545 	unsigned int rxd2;
546 	unsigned int rxd3;
547 	unsigned int rxd4;
548 } __packed __aligned(4);
549 
550 struct mtk_tx_dma {
551 	unsigned int txd1;
552 	unsigned int txd2;
553 	unsigned int txd3;
554 	unsigned int txd4;
555 } __packed __aligned(4);
556 
557 struct mtk_eth;
558 struct mtk_mac;
559 
560 /* struct mtk_hw_stats - the structure that holds the traffic statistics.
561  * @stats_lock:		make sure that stats operations are atomic
562  * @reg_offset:		the status register offset of the SoC
563  * @syncp:		the refcount
564  *
565  * All of the supported SoCs have hardware counters for traffic statistics.
566  * Whenever the status IRQ triggers we can read the latest stats from these
567  * counters and store them in this struct.
568  */
569 struct mtk_hw_stats {
570 	u64 tx_bytes;
571 	u64 tx_packets;
572 	u64 tx_skip;
573 	u64 tx_collisions;
574 	u64 rx_bytes;
575 	u64 rx_packets;
576 	u64 rx_overflow;
577 	u64 rx_fcs_errors;
578 	u64 rx_short_errors;
579 	u64 rx_long_errors;
580 	u64 rx_checksum_errors;
581 	u64 rx_flow_control_packets;
582 
583 	spinlock_t		stats_lock;
584 	u32			reg_offset;
585 	struct u64_stats_sync	syncp;
586 };
587 
588 enum mtk_tx_flags {
589 	/* PDMA descriptor can point at 1-2 segments. This enum allows us to
590 	 * track how memory was allocated so that it can be freed properly.
591 	 */
592 	MTK_TX_FLAGS_SINGLE0	= 0x01,
593 	MTK_TX_FLAGS_PAGE0	= 0x02,
594 
595 	/* MTK_TX_FLAGS_FPORTx allows tracking which port the transmitted
596 	 * SKB out instead of looking up through hardware TX descriptor.
597 	 */
598 	MTK_TX_FLAGS_FPORT0	= 0x04,
599 	MTK_TX_FLAGS_FPORT1	= 0x08,
600 };
601 
602 /* This enum allows us to identify how the clock is defined on the array of the
603  * clock in the order
604  */
605 enum mtk_clks_map {
606 	MTK_CLK_ETHIF,
607 	MTK_CLK_SGMIITOP,
608 	MTK_CLK_ESW,
609 	MTK_CLK_GP0,
610 	MTK_CLK_GP1,
611 	MTK_CLK_GP2,
612 	MTK_CLK_FE,
613 	MTK_CLK_TRGPLL,
614 	MTK_CLK_SGMII_TX_250M,
615 	MTK_CLK_SGMII_RX_250M,
616 	MTK_CLK_SGMII_CDR_REF,
617 	MTK_CLK_SGMII_CDR_FB,
618 	MTK_CLK_SGMII2_TX_250M,
619 	MTK_CLK_SGMII2_RX_250M,
620 	MTK_CLK_SGMII2_CDR_REF,
621 	MTK_CLK_SGMII2_CDR_FB,
622 	MTK_CLK_SGMII_CK,
623 	MTK_CLK_ETH2PLL,
624 	MTK_CLK_MAX
625 };
626 
627 #define MT7623_CLKS_BITMAP	(BIT(MTK_CLK_ETHIF) | BIT(MTK_CLK_ESW) |  \
628 				 BIT(MTK_CLK_GP1) | BIT(MTK_CLK_GP2) | \
629 				 BIT(MTK_CLK_TRGPLL))
630 #define MT7622_CLKS_BITMAP	(BIT(MTK_CLK_ETHIF) | BIT(MTK_CLK_ESW) |  \
631 				 BIT(MTK_CLK_GP0) | BIT(MTK_CLK_GP1) | \
632 				 BIT(MTK_CLK_GP2) | \
633 				 BIT(MTK_CLK_SGMII_TX_250M) | \
634 				 BIT(MTK_CLK_SGMII_RX_250M) | \
635 				 BIT(MTK_CLK_SGMII_CDR_REF) | \
636 				 BIT(MTK_CLK_SGMII_CDR_FB) | \
637 				 BIT(MTK_CLK_SGMII_CK) | \
638 				 BIT(MTK_CLK_ETH2PLL))
639 #define MT7621_CLKS_BITMAP	(0)
640 #define MT7628_CLKS_BITMAP	(0)
641 #define MT7629_CLKS_BITMAP	(BIT(MTK_CLK_ETHIF) | BIT(MTK_CLK_ESW) |  \
642 				 BIT(MTK_CLK_GP0) | BIT(MTK_CLK_GP1) | \
643 				 BIT(MTK_CLK_GP2) | BIT(MTK_CLK_FE) | \
644 				 BIT(MTK_CLK_SGMII_TX_250M) | \
645 				 BIT(MTK_CLK_SGMII_RX_250M) | \
646 				 BIT(MTK_CLK_SGMII_CDR_REF) | \
647 				 BIT(MTK_CLK_SGMII_CDR_FB) | \
648 				 BIT(MTK_CLK_SGMII2_TX_250M) | \
649 				 BIT(MTK_CLK_SGMII2_RX_250M) | \
650 				 BIT(MTK_CLK_SGMII2_CDR_REF) | \
651 				 BIT(MTK_CLK_SGMII2_CDR_FB) | \
652 				 BIT(MTK_CLK_SGMII_CK) | \
653 				 BIT(MTK_CLK_ETH2PLL) | BIT(MTK_CLK_SGMIITOP))
654 
655 enum mtk_dev_state {
656 	MTK_HW_INIT,
657 	MTK_RESETTING
658 };
659 
660 /* struct mtk_tx_buf -	This struct holds the pointers to the memory pointed at
661  *			by the TX descriptor	s
662  * @skb:		The SKB pointer of the packet being sent
663  * @dma_addr0:		The base addr of the first segment
664  * @dma_len0:		The length of the first segment
665  * @dma_addr1:		The base addr of the second segment
666  * @dma_len1:		The length of the second segment
667  */
668 struct mtk_tx_buf {
669 	struct sk_buff *skb;
670 	u32 flags;
671 	DEFINE_DMA_UNMAP_ADDR(dma_addr0);
672 	DEFINE_DMA_UNMAP_LEN(dma_len0);
673 	DEFINE_DMA_UNMAP_ADDR(dma_addr1);
674 	DEFINE_DMA_UNMAP_LEN(dma_len1);
675 };
676 
677 /* struct mtk_tx_ring -	This struct holds info describing a TX ring
678  * @dma:		The descriptor ring
679  * @buf:		The memory pointed at by the ring
680  * @phys:		The physical addr of tx_buf
681  * @next_free:		Pointer to the next free descriptor
682  * @last_free:		Pointer to the last free descriptor
683  * @last_free_ptr:	Hardware pointer value of the last free descriptor
684  * @thresh:		The threshold of minimum amount of free descriptors
685  * @free_count:		QDMA uses a linked list. Track how many free descriptors
686  *			are present
687  */
688 struct mtk_tx_ring {
689 	struct mtk_tx_dma *dma;
690 	struct mtk_tx_buf *buf;
691 	dma_addr_t phys;
692 	struct mtk_tx_dma *next_free;
693 	struct mtk_tx_dma *last_free;
694 	u32 last_free_ptr;
695 	u16 thresh;
696 	atomic_t free_count;
697 	int dma_size;
698 	struct mtk_tx_dma *dma_pdma;	/* For MT7628/88 PDMA handling */
699 	dma_addr_t phys_pdma;
700 	int cpu_idx;
701 };
702 
703 /* PDMA rx ring mode */
704 enum mtk_rx_flags {
705 	MTK_RX_FLAGS_NORMAL = 0,
706 	MTK_RX_FLAGS_HWLRO,
707 	MTK_RX_FLAGS_QDMA,
708 };
709 
710 /* struct mtk_rx_ring -	This struct holds info describing a RX ring
711  * @dma:		The descriptor ring
712  * @data:		The memory pointed at by the ring
713  * @phys:		The physical addr of rx_buf
714  * @frag_size:		How big can each fragment be
715  * @buf_size:		The size of each packet buffer
716  * @calc_idx:		The current head of ring
717  */
718 struct mtk_rx_ring {
719 	struct mtk_rx_dma *dma;
720 	u8 **data;
721 	dma_addr_t phys;
722 	u16 frag_size;
723 	u16 buf_size;
724 	u16 dma_size;
725 	bool calc_idx_update;
726 	u16 calc_idx;
727 	u32 crx_idx_reg;
728 };
729 
730 enum mkt_eth_capabilities {
731 	MTK_RGMII_BIT = 0,
732 	MTK_TRGMII_BIT,
733 	MTK_SGMII_BIT,
734 	MTK_ESW_BIT,
735 	MTK_GEPHY_BIT,
736 	MTK_MUX_BIT,
737 	MTK_INFRA_BIT,
738 	MTK_SHARED_SGMII_BIT,
739 	MTK_HWLRO_BIT,
740 	MTK_SHARED_INT_BIT,
741 	MTK_TRGMII_MT7621_CLK_BIT,
742 	MTK_QDMA_BIT,
743 	MTK_SOC_MT7628_BIT,
744 
745 	/* MUX BITS*/
746 	MTK_ETH_MUX_GDM1_TO_GMAC1_ESW_BIT,
747 	MTK_ETH_MUX_GMAC2_GMAC0_TO_GEPHY_BIT,
748 	MTK_ETH_MUX_U3_GMAC2_TO_QPHY_BIT,
749 	MTK_ETH_MUX_GMAC1_GMAC2_TO_SGMII_RGMII_BIT,
750 	MTK_ETH_MUX_GMAC12_TO_GEPHY_SGMII_BIT,
751 
752 	/* PATH BITS */
753 	MTK_ETH_PATH_GMAC1_RGMII_BIT,
754 	MTK_ETH_PATH_GMAC1_TRGMII_BIT,
755 	MTK_ETH_PATH_GMAC1_SGMII_BIT,
756 	MTK_ETH_PATH_GMAC2_RGMII_BIT,
757 	MTK_ETH_PATH_GMAC2_SGMII_BIT,
758 	MTK_ETH_PATH_GMAC2_GEPHY_BIT,
759 	MTK_ETH_PATH_GDM1_ESW_BIT,
760 };
761 
762 /* Supported hardware group on SoCs */
763 #define MTK_RGMII		BIT(MTK_RGMII_BIT)
764 #define MTK_TRGMII		BIT(MTK_TRGMII_BIT)
765 #define MTK_SGMII		BIT(MTK_SGMII_BIT)
766 #define MTK_ESW			BIT(MTK_ESW_BIT)
767 #define MTK_GEPHY		BIT(MTK_GEPHY_BIT)
768 #define MTK_MUX			BIT(MTK_MUX_BIT)
769 #define MTK_INFRA		BIT(MTK_INFRA_BIT)
770 #define MTK_SHARED_SGMII	BIT(MTK_SHARED_SGMII_BIT)
771 #define MTK_HWLRO		BIT(MTK_HWLRO_BIT)
772 #define MTK_SHARED_INT		BIT(MTK_SHARED_INT_BIT)
773 #define MTK_TRGMII_MT7621_CLK	BIT(MTK_TRGMII_MT7621_CLK_BIT)
774 #define MTK_QDMA		BIT(MTK_QDMA_BIT)
775 #define MTK_SOC_MT7628		BIT(MTK_SOC_MT7628_BIT)
776 
777 #define MTK_ETH_MUX_GDM1_TO_GMAC1_ESW		\
778 	BIT(MTK_ETH_MUX_GDM1_TO_GMAC1_ESW_BIT)
779 #define MTK_ETH_MUX_GMAC2_GMAC0_TO_GEPHY	\
780 	BIT(MTK_ETH_MUX_GMAC2_GMAC0_TO_GEPHY_BIT)
781 #define MTK_ETH_MUX_U3_GMAC2_TO_QPHY		\
782 	BIT(MTK_ETH_MUX_U3_GMAC2_TO_QPHY_BIT)
783 #define MTK_ETH_MUX_GMAC1_GMAC2_TO_SGMII_RGMII	\
784 	BIT(MTK_ETH_MUX_GMAC1_GMAC2_TO_SGMII_RGMII_BIT)
785 #define MTK_ETH_MUX_GMAC12_TO_GEPHY_SGMII	\
786 	BIT(MTK_ETH_MUX_GMAC12_TO_GEPHY_SGMII_BIT)
787 
788 /* Supported path present on SoCs */
789 #define MTK_ETH_PATH_GMAC1_RGMII	BIT(MTK_ETH_PATH_GMAC1_RGMII_BIT)
790 #define MTK_ETH_PATH_GMAC1_TRGMII	BIT(MTK_ETH_PATH_GMAC1_TRGMII_BIT)
791 #define MTK_ETH_PATH_GMAC1_SGMII	BIT(MTK_ETH_PATH_GMAC1_SGMII_BIT)
792 #define MTK_ETH_PATH_GMAC2_RGMII	BIT(MTK_ETH_PATH_GMAC2_RGMII_BIT)
793 #define MTK_ETH_PATH_GMAC2_SGMII	BIT(MTK_ETH_PATH_GMAC2_SGMII_BIT)
794 #define MTK_ETH_PATH_GMAC2_GEPHY	BIT(MTK_ETH_PATH_GMAC2_GEPHY_BIT)
795 #define MTK_ETH_PATH_GDM1_ESW		BIT(MTK_ETH_PATH_GDM1_ESW_BIT)
796 
797 #define MTK_GMAC1_RGMII		(MTK_ETH_PATH_GMAC1_RGMII | MTK_RGMII)
798 #define MTK_GMAC1_TRGMII	(MTK_ETH_PATH_GMAC1_TRGMII | MTK_TRGMII)
799 #define MTK_GMAC1_SGMII		(MTK_ETH_PATH_GMAC1_SGMII | MTK_SGMII)
800 #define MTK_GMAC2_RGMII		(MTK_ETH_PATH_GMAC2_RGMII | MTK_RGMII)
801 #define MTK_GMAC2_SGMII		(MTK_ETH_PATH_GMAC2_SGMII | MTK_SGMII)
802 #define MTK_GMAC2_GEPHY		(MTK_ETH_PATH_GMAC2_GEPHY | MTK_GEPHY)
803 #define MTK_GDM1_ESW		(MTK_ETH_PATH_GDM1_ESW | MTK_ESW)
804 
805 /* MUXes present on SoCs */
806 /* 0: GDM1 -> GMAC1, 1: GDM1 -> ESW */
807 #define MTK_MUX_GDM1_TO_GMAC1_ESW (MTK_ETH_MUX_GDM1_TO_GMAC1_ESW | MTK_MUX)
808 
809 /* 0: GMAC2 -> GEPHY, 1: GMAC0 -> GePHY */
810 #define MTK_MUX_GMAC2_GMAC0_TO_GEPHY    \
811 	(MTK_ETH_MUX_GMAC2_GMAC0_TO_GEPHY | MTK_MUX | MTK_INFRA)
812 
813 /* 0: U3 -> QPHY, 1: GMAC2 -> QPHY */
814 #define MTK_MUX_U3_GMAC2_TO_QPHY        \
815 	(MTK_ETH_MUX_U3_GMAC2_TO_QPHY | MTK_MUX | MTK_INFRA)
816 
817 /* 2: GMAC1 -> SGMII, 3: GMAC2 -> SGMII */
818 #define MTK_MUX_GMAC1_GMAC2_TO_SGMII_RGMII      \
819 	(MTK_ETH_MUX_GMAC1_GMAC2_TO_SGMII_RGMII | MTK_MUX | \
820 	MTK_SHARED_SGMII)
821 
822 /* 0: GMACx -> GEPHY, 1: GMACx -> SGMII where x is 1 or 2 */
823 #define MTK_MUX_GMAC12_TO_GEPHY_SGMII   \
824 	(MTK_ETH_MUX_GMAC12_TO_GEPHY_SGMII | MTK_MUX)
825 
826 #define MTK_HAS_CAPS(caps, _x)		(((caps) & (_x)) == (_x))
827 
828 #define MT7621_CAPS  (MTK_GMAC1_RGMII | MTK_GMAC1_TRGMII | \
829 		      MTK_GMAC2_RGMII | MTK_SHARED_INT | \
830 		      MTK_TRGMII_MT7621_CLK | MTK_QDMA)
831 
832 #define MT7622_CAPS  (MTK_GMAC1_RGMII | MTK_GMAC1_SGMII | MTK_GMAC2_RGMII | \
833 		      MTK_GMAC2_SGMII | MTK_GDM1_ESW | \
834 		      MTK_MUX_GDM1_TO_GMAC1_ESW | \
835 		      MTK_MUX_GMAC1_GMAC2_TO_SGMII_RGMII | MTK_QDMA)
836 
837 #define MT7623_CAPS  (MTK_GMAC1_RGMII | MTK_GMAC1_TRGMII | MTK_GMAC2_RGMII | \
838 		      MTK_QDMA)
839 
840 #define MT7628_CAPS  (MTK_SHARED_INT | MTK_SOC_MT7628)
841 
842 #define MT7629_CAPS  (MTK_GMAC1_SGMII | MTK_GMAC2_SGMII | MTK_GMAC2_GEPHY | \
843 		      MTK_GDM1_ESW | MTK_MUX_GDM1_TO_GMAC1_ESW | \
844 		      MTK_MUX_GMAC2_GMAC0_TO_GEPHY | \
845 		      MTK_MUX_U3_GMAC2_TO_QPHY | \
846 		      MTK_MUX_GMAC12_TO_GEPHY_SGMII | MTK_QDMA)
847 
848 /* struct mtk_eth_data -	This is the structure holding all differences
849  *				among various plaforms
850  * @ana_rgc3:                   The offset for register ANA_RGC3 related to
851  *				sgmiisys syscon
852  * @caps			Flags shown the extra capability for the SoC
853  * @hw_features			Flags shown HW features
854  * @required_clks		Flags shown the bitmap for required clocks on
855  *				the target SoC
856  * @required_pctl		A bool value to show whether the SoC requires
857  *				the extra setup for those pins used by GMAC.
858  */
859 struct mtk_soc_data {
860 	u32             ana_rgc3;
861 	u32		caps;
862 	u32		required_clks;
863 	bool		required_pctl;
864 	u8		offload_version;
865 	netdev_features_t hw_features;
866 };
867 
868 /* currently no SoC has more than 2 macs */
869 #define MTK_MAX_DEVS			2
870 
871 #define MTK_SGMII_PHYSPEED_AN          BIT(31)
872 #define MTK_SGMII_PHYSPEED_MASK        GENMASK(2, 0)
873 #define MTK_SGMII_PHYSPEED_1000        BIT(0)
874 #define MTK_SGMII_PHYSPEED_2500        BIT(1)
875 #define MTK_HAS_FLAGS(flags, _x)       (((flags) & (_x)) == (_x))
876 
877 /* struct mtk_sgmii -  This is the structure holding sgmii regmap and its
878  *                     characteristics
879  * @regmap:            The register map pointing at the range used to setup
880  *                     SGMII modes
881  * @flags:             The enum refers to which mode the sgmii wants to run on
882  * @ana_rgc3:          The offset refers to register ANA_RGC3 related to regmap
883  */
884 
885 struct mtk_sgmii {
886 	struct regmap   *regmap[MTK_MAX_DEVS];
887 	u32             flags[MTK_MAX_DEVS];
888 	u32             ana_rgc3;
889 };
890 
891 /* struct mtk_eth -	This is the main datasructure for holding the state
892  *			of the driver
893  * @dev:		The device pointer
894  * @dev:		The device pointer used for dma mapping/alloc
895  * @base:		The mapped register i/o base
896  * @page_lock:		Make sure that register operations are atomic
897  * @tx_irq__lock:	Make sure that IRQ register operations are atomic
898  * @rx_irq__lock:	Make sure that IRQ register operations are atomic
899  * @dim_lock:		Make sure that Net DIM operations are atomic
900  * @dummy_dev:		we run 2 netdevs on 1 physical DMA ring and need a
901  *			dummy for NAPI to work
902  * @netdev:		The netdev instances
903  * @mac:		Each netdev is linked to a physical MAC
904  * @irq:		The IRQ that we are using
905  * @msg_enable:		Ethtool msg level
906  * @ethsys:		The register map pointing at the range used to setup
907  *			MII modes
908  * @infra:              The register map pointing at the range used to setup
909  *                      SGMII and GePHY path
910  * @pctl:		The register map pointing at the range used to setup
911  *			GMAC port drive/slew values
912  * @dma_refcnt:		track how many netdevs are using the DMA engine
913  * @tx_ring:		Pointer to the memory holding info about the TX ring
914  * @rx_ring:		Pointer to the memory holding info about the RX ring
915  * @rx_ring_qdma:	Pointer to the memory holding info about the QDMA RX ring
916  * @tx_napi:		The TX NAPI struct
917  * @rx_napi:		The RX NAPI struct
918  * @rx_events:		Net DIM RX event counter
919  * @rx_packets:		Net DIM RX packet counter
920  * @rx_bytes:		Net DIM RX byte counter
921  * @rx_dim:		Net DIM RX context
922  * @tx_events:		Net DIM TX event counter
923  * @tx_packets:		Net DIM TX packet counter
924  * @tx_bytes:		Net DIM TX byte counter
925  * @tx_dim:		Net DIM TX context
926  * @scratch_ring:	Newer SoCs need memory for a second HW managed TX ring
927  * @phy_scratch_ring:	physical address of scratch_ring
928  * @scratch_head:	The scratch memory that scratch_ring points to.
929  * @clks:		clock array for all clocks required
930  * @mii_bus:		If there is a bus we need to create an instance for it
931  * @pending_work:	The workqueue used to reset the dma ring
932  * @state:		Initialization and runtime state of the device
933  * @soc:		Holding specific data among vaious SoCs
934  */
935 
936 struct mtk_eth {
937 	struct device			*dev;
938 	struct device			*dma_dev;
939 	void __iomem			*base;
940 	spinlock_t			page_lock;
941 	spinlock_t			tx_irq_lock;
942 	spinlock_t			rx_irq_lock;
943 	struct net_device		dummy_dev;
944 	struct net_device		*netdev[MTK_MAX_DEVS];
945 	struct mtk_mac			*mac[MTK_MAX_DEVS];
946 	int				irq[3];
947 	u32				msg_enable;
948 	unsigned long			sysclk;
949 	struct regmap			*ethsys;
950 	struct regmap                   *infra;
951 	struct mtk_sgmii                *sgmii;
952 	struct regmap			*pctl;
953 	bool				hwlro;
954 	refcount_t			dma_refcnt;
955 	struct mtk_tx_ring		tx_ring;
956 	struct mtk_rx_ring		rx_ring[MTK_MAX_RX_RING_NUM];
957 	struct mtk_rx_ring		rx_ring_qdma;
958 	struct napi_struct		tx_napi;
959 	struct napi_struct		rx_napi;
960 	struct mtk_tx_dma		*scratch_ring;
961 	dma_addr_t			phy_scratch_ring;
962 	void				*scratch_head;
963 	struct clk			*clks[MTK_CLK_MAX];
964 
965 	struct mii_bus			*mii_bus;
966 	struct work_struct		pending_work;
967 	unsigned long			state;
968 
969 	const struct mtk_soc_data	*soc;
970 
971 	spinlock_t			dim_lock;
972 
973 	u32				rx_events;
974 	u32				rx_packets;
975 	u32				rx_bytes;
976 	struct dim			rx_dim;
977 
978 	u32				tx_events;
979 	u32				tx_packets;
980 	u32				tx_bytes;
981 	struct dim			tx_dim;
982 
983 	u32				tx_int_mask_reg;
984 	u32				tx_int_status_reg;
985 	u32				rx_dma_l4_valid;
986 	int				ip_align;
987 
988 	struct mtk_ppe			*ppe;
989 	struct rhashtable		flow_table;
990 };
991 
992 /* struct mtk_mac -	the structure that holds the info about the MACs of the
993  *			SoC
994  * @id:			The number of the MAC
995  * @interface:		Interface mode kept for detecting change in hw settings
996  * @of_node:		Our devicetree node
997  * @hw:			Backpointer to our main datastruture
998  * @hw_stats:		Packet statistics counter
999  */
1000 struct mtk_mac {
1001 	int				id;
1002 	phy_interface_t			interface;
1003 	unsigned int			mode;
1004 	int				speed;
1005 	struct device_node		*of_node;
1006 	struct phylink			*phylink;
1007 	struct phylink_config		phylink_config;
1008 	struct mtk_eth			*hw;
1009 	struct mtk_hw_stats		*hw_stats;
1010 	__be32				hwlro_ip[MTK_MAX_LRO_IP_CNT];
1011 	int				hwlro_ip_cnt;
1012 };
1013 
1014 /* the struct describing the SoC. these are declared in the soc_xyz.c files */
1015 extern const struct of_device_id of_mtk_match[];
1016 
1017 /* read the hardware status register */
1018 void mtk_stats_update_mac(struct mtk_mac *mac);
1019 
1020 void mtk_w32(struct mtk_eth *eth, u32 val, unsigned reg);
1021 u32 mtk_r32(struct mtk_eth *eth, unsigned reg);
1022 
1023 int mtk_sgmii_init(struct mtk_sgmii *ss, struct device_node *np,
1024 		   u32 ana_rgc3);
1025 int mtk_sgmii_setup_mode_an(struct mtk_sgmii *ss, int id);
1026 int mtk_sgmii_setup_mode_force(struct mtk_sgmii *ss, int id,
1027 			       const struct phylink_link_state *state);
1028 void mtk_sgmii_restart_an(struct mtk_eth *eth, int mac_id);
1029 
1030 int mtk_gmac_sgmii_path_setup(struct mtk_eth *eth, int mac_id);
1031 int mtk_gmac_gephy_path_setup(struct mtk_eth *eth, int mac_id);
1032 int mtk_gmac_rgmii_path_setup(struct mtk_eth *eth, int mac_id);
1033 
1034 int mtk_eth_offload_init(struct mtk_eth *eth);
1035 int mtk_eth_setup_tc(struct net_device *dev, enum tc_setup_type type,
1036 		     void *type_data);
1037 void mtk_eth_set_dma_device(struct mtk_eth *eth, struct device *dma_dev);
1038 
1039 
1040 #endif /* MTK_ETH_H */
1041