xref: /linux/drivers/net/ethernet/mediatek/mtk_eth_soc.h (revision 172cdcaefea5c297fdb3d20b7d5aff60ae4fbce6)
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 Received Good Byte Count Register */
282 #define MTK_GDM1_TX_GBCNT	0x2400
283 #define MTK_STAT_OFFSET		0x40
284 
285 /* QDMA descriptor txd4 */
286 #define TX_DMA_CHKSUM		(0x7 << 29)
287 #define TX_DMA_TSO		BIT(28)
288 #define TX_DMA_FPORT_SHIFT	25
289 #define TX_DMA_FPORT_MASK	0x7
290 #define TX_DMA_INS_VLAN		BIT(16)
291 
292 /* QDMA descriptor txd3 */
293 #define TX_DMA_OWNER_CPU	BIT(31)
294 #define TX_DMA_LS0		BIT(30)
295 #define TX_DMA_PLEN0(_x)	(((_x) & MTK_TX_DMA_BUF_LEN) << 16)
296 #define TX_DMA_PLEN1(_x)	((_x) & MTK_TX_DMA_BUF_LEN)
297 #define TX_DMA_SWC		BIT(14)
298 #define TX_DMA_SDL(_x)		(((_x) & 0x3fff) << 16)
299 
300 /* PDMA on MT7628 */
301 #define TX_DMA_DONE		BIT(31)
302 #define TX_DMA_LS1		BIT(14)
303 #define TX_DMA_DESP2_DEF	(TX_DMA_LS0 | TX_DMA_DONE)
304 
305 /* QDMA descriptor rxd2 */
306 #define RX_DMA_DONE		BIT(31)
307 #define RX_DMA_LSO		BIT(30)
308 #define RX_DMA_PLEN0(_x)	(((_x) & 0x3fff) << 16)
309 #define RX_DMA_GET_PLEN0(_x)	(((_x) >> 16) & 0x3fff)
310 #define RX_DMA_VTAG		BIT(15)
311 
312 /* QDMA descriptor rxd3 */
313 #define RX_DMA_VID(_x)		((_x) & 0xfff)
314 
315 /* QDMA descriptor rxd4 */
316 #define MTK_RXD4_FOE_ENTRY	GENMASK(13, 0)
317 #define MTK_RXD4_PPE_CPU_REASON	GENMASK(18, 14)
318 #define MTK_RXD4_SRC_PORT	GENMASK(21, 19)
319 #define MTK_RXD4_ALG		GENMASK(31, 22)
320 
321 /* QDMA descriptor rxd4 */
322 #define RX_DMA_L4_VALID		BIT(24)
323 #define RX_DMA_L4_VALID_PDMA	BIT(30)		/* when PDMA is used */
324 #define RX_DMA_FPORT_SHIFT	19
325 #define RX_DMA_FPORT_MASK	0x7
326 #define RX_DMA_SPECIAL_TAG	BIT(22)
327 
328 /* PHY Indirect Access Control registers */
329 #define MTK_PHY_IAC		0x10004
330 #define PHY_IAC_ACCESS		BIT(31)
331 #define PHY_IAC_READ		BIT(19)
332 #define PHY_IAC_WRITE		BIT(18)
333 #define PHY_IAC_START		BIT(16)
334 #define PHY_IAC_ADDR_SHIFT	20
335 #define PHY_IAC_REG_SHIFT	25
336 #define PHY_IAC_TIMEOUT		HZ
337 
338 #define MTK_MAC_MISC		0x1000c
339 #define MTK_MUX_TO_ESW		BIT(0)
340 
341 /* Mac control registers */
342 #define MTK_MAC_MCR(x)		(0x10100 + (x * 0x100))
343 #define MAC_MCR_MAX_RX_MASK	GENMASK(25, 24)
344 #define MAC_MCR_MAX_RX(_x)	(MAC_MCR_MAX_RX_MASK & ((_x) << 24))
345 #define MAC_MCR_MAX_RX_1518	0x0
346 #define MAC_MCR_MAX_RX_1536	0x1
347 #define MAC_MCR_MAX_RX_1552	0x2
348 #define MAC_MCR_MAX_RX_2048	0x3
349 #define MAC_MCR_IPG_CFG		(BIT(18) | BIT(16))
350 #define MAC_MCR_FORCE_MODE	BIT(15)
351 #define MAC_MCR_TX_EN		BIT(14)
352 #define MAC_MCR_RX_EN		BIT(13)
353 #define MAC_MCR_BACKOFF_EN	BIT(9)
354 #define MAC_MCR_BACKPR_EN	BIT(8)
355 #define MAC_MCR_FORCE_RX_FC	BIT(5)
356 #define MAC_MCR_FORCE_TX_FC	BIT(4)
357 #define MAC_MCR_SPEED_1000	BIT(3)
358 #define MAC_MCR_SPEED_100	BIT(2)
359 #define MAC_MCR_FORCE_DPX	BIT(1)
360 #define MAC_MCR_FORCE_LINK	BIT(0)
361 #define MAC_MCR_FORCE_LINK_DOWN	(MAC_MCR_FORCE_MODE)
362 
363 /* Mac status registers */
364 #define MTK_MAC_MSR(x)		(0x10108 + (x * 0x100))
365 #define MAC_MSR_EEE1G		BIT(7)
366 #define MAC_MSR_EEE100M		BIT(6)
367 #define MAC_MSR_RX_FC		BIT(5)
368 #define MAC_MSR_TX_FC		BIT(4)
369 #define MAC_MSR_SPEED_1000	BIT(3)
370 #define MAC_MSR_SPEED_100	BIT(2)
371 #define MAC_MSR_SPEED_MASK	(MAC_MSR_SPEED_1000 | MAC_MSR_SPEED_100)
372 #define MAC_MSR_DPX		BIT(1)
373 #define MAC_MSR_LINK		BIT(0)
374 
375 /* TRGMII RXC control register */
376 #define TRGMII_RCK_CTRL		0x10300
377 #define DQSI0(x)		((x << 0) & GENMASK(6, 0))
378 #define DQSI1(x)		((x << 8) & GENMASK(14, 8))
379 #define RXCTL_DMWTLAT(x)	((x << 16) & GENMASK(18, 16))
380 #define RXC_RST			BIT(31)
381 #define RXC_DQSISEL		BIT(30)
382 #define RCK_CTRL_RGMII_1000	(RXC_DQSISEL | RXCTL_DMWTLAT(2) | DQSI1(16))
383 #define RCK_CTRL_RGMII_10_100	RXCTL_DMWTLAT(2)
384 
385 #define NUM_TRGMII_CTRL		5
386 
387 /* TRGMII RXC control register */
388 #define TRGMII_TCK_CTRL		0x10340
389 #define TXCTL_DMWTLAT(x)	((x << 16) & GENMASK(18, 16))
390 #define TXC_INV			BIT(30)
391 #define TCK_CTRL_RGMII_1000	TXCTL_DMWTLAT(2)
392 #define TCK_CTRL_RGMII_10_100	(TXC_INV | TXCTL_DMWTLAT(2))
393 
394 /* TRGMII TX Drive Strength */
395 #define TRGMII_TD_ODT(i)	(0x10354 + 8 * (i))
396 #define  TD_DM_DRVP(x)		((x) & 0xf)
397 #define  TD_DM_DRVN(x)		(((x) & 0xf) << 4)
398 
399 /* TRGMII Interface mode register */
400 #define INTF_MODE		0x10390
401 #define TRGMII_INTF_DIS		BIT(0)
402 #define TRGMII_MODE		BIT(1)
403 #define TRGMII_CENTRAL_ALIGNED	BIT(2)
404 #define INTF_MODE_RGMII_1000    (TRGMII_MODE | TRGMII_CENTRAL_ALIGNED)
405 #define INTF_MODE_RGMII_10_100  0
406 
407 /* GPIO port control registers for GMAC 2*/
408 #define GPIO_OD33_CTRL8		0x4c0
409 #define GPIO_BIAS_CTRL		0xed0
410 #define GPIO_DRV_SEL10		0xf00
411 
412 /* ethernet subsystem chip id register */
413 #define ETHSYS_CHIPID0_3	0x0
414 #define ETHSYS_CHIPID4_7	0x4
415 #define MT7623_ETH		7623
416 #define MT7622_ETH		7622
417 #define MT7621_ETH		7621
418 
419 /* ethernet system control register */
420 #define ETHSYS_SYSCFG		0x10
421 #define SYSCFG_DRAM_TYPE_DDR2	BIT(4)
422 
423 /* ethernet subsystem config register */
424 #define ETHSYS_SYSCFG0		0x14
425 #define SYSCFG0_GE_MASK		0x3
426 #define SYSCFG0_GE_MODE(x, y)	(x << (12 + (y * 2)))
427 #define SYSCFG0_SGMII_MASK     GENMASK(9, 8)
428 #define SYSCFG0_SGMII_GMAC1    ((2 << 8) & SYSCFG0_SGMII_MASK)
429 #define SYSCFG0_SGMII_GMAC2    ((3 << 8) & SYSCFG0_SGMII_MASK)
430 #define SYSCFG0_SGMII_GMAC1_V2 BIT(9)
431 #define SYSCFG0_SGMII_GMAC2_V2 BIT(8)
432 
433 
434 /* ethernet subsystem clock register */
435 #define ETHSYS_CLKCFG0		0x2c
436 #define ETHSYS_TRGMII_CLK_SEL362_5	BIT(11)
437 #define ETHSYS_TRGMII_MT7621_MASK	(BIT(5) | BIT(6))
438 #define ETHSYS_TRGMII_MT7621_APLL	BIT(6)
439 #define ETHSYS_TRGMII_MT7621_DDR_PLL	BIT(5)
440 
441 /* ethernet reset control register */
442 #define ETHSYS_RSTCTRL		0x34
443 #define RSTCTRL_FE		BIT(6)
444 #define RSTCTRL_PPE		BIT(31)
445 
446 /* SGMII subsystem config registers */
447 /* Register to auto-negotiation restart */
448 #define SGMSYS_PCS_CONTROL_1	0x0
449 #define SGMII_AN_RESTART	BIT(9)
450 #define SGMII_ISOLATE		BIT(10)
451 #define SGMII_AN_ENABLE		BIT(12)
452 #define SGMII_LINK_STATYS	BIT(18)
453 #define SGMII_AN_ABILITY	BIT(19)
454 #define SGMII_AN_COMPLETE	BIT(21)
455 #define SGMII_PCS_FAULT		BIT(23)
456 #define SGMII_AN_EXPANSION_CLR	BIT(30)
457 
458 /* Register to programmable link timer, the unit in 2 * 8ns */
459 #define SGMSYS_PCS_LINK_TIMER	0x18
460 #define SGMII_LINK_TIMER_DEFAULT	(0x186a0 & GENMASK(19, 0))
461 
462 /* Register to control remote fault */
463 #define SGMSYS_SGMII_MODE		0x20
464 #define SGMII_IF_MODE_BIT0		BIT(0)
465 #define SGMII_SPEED_DUPLEX_AN		BIT(1)
466 #define SGMII_SPEED_10			0x0
467 #define SGMII_SPEED_100			BIT(2)
468 #define SGMII_SPEED_1000		BIT(3)
469 #define SGMII_DUPLEX_FULL		BIT(4)
470 #define SGMII_IF_MODE_BIT5		BIT(5)
471 #define SGMII_REMOTE_FAULT_DIS		BIT(8)
472 #define SGMII_CODE_SYNC_SET_VAL		BIT(9)
473 #define SGMII_CODE_SYNC_SET_EN		BIT(10)
474 #define SGMII_SEND_AN_ERROR_EN		BIT(11)
475 #define SGMII_IF_MODE_MASK		GENMASK(5, 1)
476 
477 /* Register to set SGMII speed, ANA RG_ Control Signals III*/
478 #define SGMSYS_ANA_RG_CS3	0x2028
479 #define RG_PHY_SPEED_MASK	(BIT(2) | BIT(3))
480 #define RG_PHY_SPEED_1_25G	0x0
481 #define RG_PHY_SPEED_3_125G	BIT(2)
482 
483 /* Register to power up QPHY */
484 #define SGMSYS_QPHY_PWR_STATE_CTRL 0xe8
485 #define	SGMII_PHYA_PWD		BIT(4)
486 
487 /* Infrasys subsystem config registers */
488 #define INFRA_MISC2            0x70c
489 #define CO_QPHY_SEL            BIT(0)
490 #define GEPHY_MAC_SEL          BIT(1)
491 
492 /* MT7628/88 specific stuff */
493 #define MT7628_PDMA_OFFSET	0x0800
494 #define MT7628_SDM_OFFSET	0x0c00
495 
496 #define MT7628_TX_BASE_PTR0	(MT7628_PDMA_OFFSET + 0x00)
497 #define MT7628_TX_MAX_CNT0	(MT7628_PDMA_OFFSET + 0x04)
498 #define MT7628_TX_CTX_IDX0	(MT7628_PDMA_OFFSET + 0x08)
499 #define MT7628_TX_DTX_IDX0	(MT7628_PDMA_OFFSET + 0x0c)
500 #define MT7628_PST_DTX_IDX0	BIT(0)
501 
502 #define MT7628_SDM_MAC_ADRL	(MT7628_SDM_OFFSET + 0x0c)
503 #define MT7628_SDM_MAC_ADRH	(MT7628_SDM_OFFSET + 0x10)
504 
505 struct mtk_rx_dma {
506 	unsigned int rxd1;
507 	unsigned int rxd2;
508 	unsigned int rxd3;
509 	unsigned int rxd4;
510 } __packed __aligned(4);
511 
512 struct mtk_tx_dma {
513 	unsigned int txd1;
514 	unsigned int txd2;
515 	unsigned int txd3;
516 	unsigned int txd4;
517 } __packed __aligned(4);
518 
519 struct mtk_eth;
520 struct mtk_mac;
521 
522 /* struct mtk_hw_stats - the structure that holds the traffic statistics.
523  * @stats_lock:		make sure that stats operations are atomic
524  * @reg_offset:		the status register offset of the SoC
525  * @syncp:		the refcount
526  *
527  * All of the supported SoCs have hardware counters for traffic statistics.
528  * Whenever the status IRQ triggers we can read the latest stats from these
529  * counters and store them in this struct.
530  */
531 struct mtk_hw_stats {
532 	u64 tx_bytes;
533 	u64 tx_packets;
534 	u64 tx_skip;
535 	u64 tx_collisions;
536 	u64 rx_bytes;
537 	u64 rx_packets;
538 	u64 rx_overflow;
539 	u64 rx_fcs_errors;
540 	u64 rx_short_errors;
541 	u64 rx_long_errors;
542 	u64 rx_checksum_errors;
543 	u64 rx_flow_control_packets;
544 
545 	spinlock_t		stats_lock;
546 	u32			reg_offset;
547 	struct u64_stats_sync	syncp;
548 };
549 
550 enum mtk_tx_flags {
551 	/* PDMA descriptor can point at 1-2 segments. This enum allows us to
552 	 * track how memory was allocated so that it can be freed properly.
553 	 */
554 	MTK_TX_FLAGS_SINGLE0	= 0x01,
555 	MTK_TX_FLAGS_PAGE0	= 0x02,
556 
557 	/* MTK_TX_FLAGS_FPORTx allows tracking which port the transmitted
558 	 * SKB out instead of looking up through hardware TX descriptor.
559 	 */
560 	MTK_TX_FLAGS_FPORT0	= 0x04,
561 	MTK_TX_FLAGS_FPORT1	= 0x08,
562 };
563 
564 /* This enum allows us to identify how the clock is defined on the array of the
565  * clock in the order
566  */
567 enum mtk_clks_map {
568 	MTK_CLK_ETHIF,
569 	MTK_CLK_SGMIITOP,
570 	MTK_CLK_ESW,
571 	MTK_CLK_GP0,
572 	MTK_CLK_GP1,
573 	MTK_CLK_GP2,
574 	MTK_CLK_FE,
575 	MTK_CLK_TRGPLL,
576 	MTK_CLK_SGMII_TX_250M,
577 	MTK_CLK_SGMII_RX_250M,
578 	MTK_CLK_SGMII_CDR_REF,
579 	MTK_CLK_SGMII_CDR_FB,
580 	MTK_CLK_SGMII2_TX_250M,
581 	MTK_CLK_SGMII2_RX_250M,
582 	MTK_CLK_SGMII2_CDR_REF,
583 	MTK_CLK_SGMII2_CDR_FB,
584 	MTK_CLK_SGMII_CK,
585 	MTK_CLK_ETH2PLL,
586 	MTK_CLK_MAX
587 };
588 
589 #define MT7623_CLKS_BITMAP	(BIT(MTK_CLK_ETHIF) | BIT(MTK_CLK_ESW) |  \
590 				 BIT(MTK_CLK_GP1) | BIT(MTK_CLK_GP2) | \
591 				 BIT(MTK_CLK_TRGPLL))
592 #define MT7622_CLKS_BITMAP	(BIT(MTK_CLK_ETHIF) | BIT(MTK_CLK_ESW) |  \
593 				 BIT(MTK_CLK_GP0) | BIT(MTK_CLK_GP1) | \
594 				 BIT(MTK_CLK_GP2) | \
595 				 BIT(MTK_CLK_SGMII_TX_250M) | \
596 				 BIT(MTK_CLK_SGMII_RX_250M) | \
597 				 BIT(MTK_CLK_SGMII_CDR_REF) | \
598 				 BIT(MTK_CLK_SGMII_CDR_FB) | \
599 				 BIT(MTK_CLK_SGMII_CK) | \
600 				 BIT(MTK_CLK_ETH2PLL))
601 #define MT7621_CLKS_BITMAP	(0)
602 #define MT7628_CLKS_BITMAP	(0)
603 #define MT7629_CLKS_BITMAP	(BIT(MTK_CLK_ETHIF) | BIT(MTK_CLK_ESW) |  \
604 				 BIT(MTK_CLK_GP0) | BIT(MTK_CLK_GP1) | \
605 				 BIT(MTK_CLK_GP2) | BIT(MTK_CLK_FE) | \
606 				 BIT(MTK_CLK_SGMII_TX_250M) | \
607 				 BIT(MTK_CLK_SGMII_RX_250M) | \
608 				 BIT(MTK_CLK_SGMII_CDR_REF) | \
609 				 BIT(MTK_CLK_SGMII_CDR_FB) | \
610 				 BIT(MTK_CLK_SGMII2_TX_250M) | \
611 				 BIT(MTK_CLK_SGMII2_RX_250M) | \
612 				 BIT(MTK_CLK_SGMII2_CDR_REF) | \
613 				 BIT(MTK_CLK_SGMII2_CDR_FB) | \
614 				 BIT(MTK_CLK_SGMII_CK) | \
615 				 BIT(MTK_CLK_ETH2PLL) | BIT(MTK_CLK_SGMIITOP))
616 
617 enum mtk_dev_state {
618 	MTK_HW_INIT,
619 	MTK_RESETTING
620 };
621 
622 /* struct mtk_tx_buf -	This struct holds the pointers to the memory pointed at
623  *			by the TX descriptor	s
624  * @skb:		The SKB pointer of the packet being sent
625  * @dma_addr0:		The base addr of the first segment
626  * @dma_len0:		The length of the first segment
627  * @dma_addr1:		The base addr of the second segment
628  * @dma_len1:		The length of the second segment
629  */
630 struct mtk_tx_buf {
631 	struct sk_buff *skb;
632 	u32 flags;
633 	DEFINE_DMA_UNMAP_ADDR(dma_addr0);
634 	DEFINE_DMA_UNMAP_LEN(dma_len0);
635 	DEFINE_DMA_UNMAP_ADDR(dma_addr1);
636 	DEFINE_DMA_UNMAP_LEN(dma_len1);
637 };
638 
639 /* struct mtk_tx_ring -	This struct holds info describing a TX ring
640  * @dma:		The descriptor ring
641  * @buf:		The memory pointed at by the ring
642  * @phys:		The physical addr of tx_buf
643  * @next_free:		Pointer to the next free descriptor
644  * @last_free:		Pointer to the last free descriptor
645  * @last_free_ptr:	Hardware pointer value of the last free descriptor
646  * @thresh:		The threshold of minimum amount of free descriptors
647  * @free_count:		QDMA uses a linked list. Track how many free descriptors
648  *			are present
649  */
650 struct mtk_tx_ring {
651 	struct mtk_tx_dma *dma;
652 	struct mtk_tx_buf *buf;
653 	dma_addr_t phys;
654 	struct mtk_tx_dma *next_free;
655 	struct mtk_tx_dma *last_free;
656 	u32 last_free_ptr;
657 	u16 thresh;
658 	atomic_t free_count;
659 	int dma_size;
660 	struct mtk_tx_dma *dma_pdma;	/* For MT7628/88 PDMA handling */
661 	dma_addr_t phys_pdma;
662 	int cpu_idx;
663 };
664 
665 /* PDMA rx ring mode */
666 enum mtk_rx_flags {
667 	MTK_RX_FLAGS_NORMAL = 0,
668 	MTK_RX_FLAGS_HWLRO,
669 	MTK_RX_FLAGS_QDMA,
670 };
671 
672 /* struct mtk_rx_ring -	This struct holds info describing a RX ring
673  * @dma:		The descriptor ring
674  * @data:		The memory pointed at by the ring
675  * @phys:		The physical addr of rx_buf
676  * @frag_size:		How big can each fragment be
677  * @buf_size:		The size of each packet buffer
678  * @calc_idx:		The current head of ring
679  */
680 struct mtk_rx_ring {
681 	struct mtk_rx_dma *dma;
682 	u8 **data;
683 	dma_addr_t phys;
684 	u16 frag_size;
685 	u16 buf_size;
686 	u16 dma_size;
687 	bool calc_idx_update;
688 	u16 calc_idx;
689 	u32 crx_idx_reg;
690 };
691 
692 enum mkt_eth_capabilities {
693 	MTK_RGMII_BIT = 0,
694 	MTK_TRGMII_BIT,
695 	MTK_SGMII_BIT,
696 	MTK_ESW_BIT,
697 	MTK_GEPHY_BIT,
698 	MTK_MUX_BIT,
699 	MTK_INFRA_BIT,
700 	MTK_SHARED_SGMII_BIT,
701 	MTK_HWLRO_BIT,
702 	MTK_SHARED_INT_BIT,
703 	MTK_TRGMII_MT7621_CLK_BIT,
704 	MTK_QDMA_BIT,
705 	MTK_SOC_MT7628_BIT,
706 
707 	/* MUX BITS*/
708 	MTK_ETH_MUX_GDM1_TO_GMAC1_ESW_BIT,
709 	MTK_ETH_MUX_GMAC2_GMAC0_TO_GEPHY_BIT,
710 	MTK_ETH_MUX_U3_GMAC2_TO_QPHY_BIT,
711 	MTK_ETH_MUX_GMAC1_GMAC2_TO_SGMII_RGMII_BIT,
712 	MTK_ETH_MUX_GMAC12_TO_GEPHY_SGMII_BIT,
713 
714 	/* PATH BITS */
715 	MTK_ETH_PATH_GMAC1_RGMII_BIT,
716 	MTK_ETH_PATH_GMAC1_TRGMII_BIT,
717 	MTK_ETH_PATH_GMAC1_SGMII_BIT,
718 	MTK_ETH_PATH_GMAC2_RGMII_BIT,
719 	MTK_ETH_PATH_GMAC2_SGMII_BIT,
720 	MTK_ETH_PATH_GMAC2_GEPHY_BIT,
721 	MTK_ETH_PATH_GDM1_ESW_BIT,
722 };
723 
724 /* Supported hardware group on SoCs */
725 #define MTK_RGMII		BIT(MTK_RGMII_BIT)
726 #define MTK_TRGMII		BIT(MTK_TRGMII_BIT)
727 #define MTK_SGMII		BIT(MTK_SGMII_BIT)
728 #define MTK_ESW			BIT(MTK_ESW_BIT)
729 #define MTK_GEPHY		BIT(MTK_GEPHY_BIT)
730 #define MTK_MUX			BIT(MTK_MUX_BIT)
731 #define MTK_INFRA		BIT(MTK_INFRA_BIT)
732 #define MTK_SHARED_SGMII	BIT(MTK_SHARED_SGMII_BIT)
733 #define MTK_HWLRO		BIT(MTK_HWLRO_BIT)
734 #define MTK_SHARED_INT		BIT(MTK_SHARED_INT_BIT)
735 #define MTK_TRGMII_MT7621_CLK	BIT(MTK_TRGMII_MT7621_CLK_BIT)
736 #define MTK_QDMA		BIT(MTK_QDMA_BIT)
737 #define MTK_SOC_MT7628		BIT(MTK_SOC_MT7628_BIT)
738 
739 #define MTK_ETH_MUX_GDM1_TO_GMAC1_ESW		\
740 	BIT(MTK_ETH_MUX_GDM1_TO_GMAC1_ESW_BIT)
741 #define MTK_ETH_MUX_GMAC2_GMAC0_TO_GEPHY	\
742 	BIT(MTK_ETH_MUX_GMAC2_GMAC0_TO_GEPHY_BIT)
743 #define MTK_ETH_MUX_U3_GMAC2_TO_QPHY		\
744 	BIT(MTK_ETH_MUX_U3_GMAC2_TO_QPHY_BIT)
745 #define MTK_ETH_MUX_GMAC1_GMAC2_TO_SGMII_RGMII	\
746 	BIT(MTK_ETH_MUX_GMAC1_GMAC2_TO_SGMII_RGMII_BIT)
747 #define MTK_ETH_MUX_GMAC12_TO_GEPHY_SGMII	\
748 	BIT(MTK_ETH_MUX_GMAC12_TO_GEPHY_SGMII_BIT)
749 
750 /* Supported path present on SoCs */
751 #define MTK_ETH_PATH_GMAC1_RGMII	BIT(MTK_ETH_PATH_GMAC1_RGMII_BIT)
752 #define MTK_ETH_PATH_GMAC1_TRGMII	BIT(MTK_ETH_PATH_GMAC1_TRGMII_BIT)
753 #define MTK_ETH_PATH_GMAC1_SGMII	BIT(MTK_ETH_PATH_GMAC1_SGMII_BIT)
754 #define MTK_ETH_PATH_GMAC2_RGMII	BIT(MTK_ETH_PATH_GMAC2_RGMII_BIT)
755 #define MTK_ETH_PATH_GMAC2_SGMII	BIT(MTK_ETH_PATH_GMAC2_SGMII_BIT)
756 #define MTK_ETH_PATH_GMAC2_GEPHY	BIT(MTK_ETH_PATH_GMAC2_GEPHY_BIT)
757 #define MTK_ETH_PATH_GDM1_ESW		BIT(MTK_ETH_PATH_GDM1_ESW_BIT)
758 
759 #define MTK_GMAC1_RGMII		(MTK_ETH_PATH_GMAC1_RGMII | MTK_RGMII)
760 #define MTK_GMAC1_TRGMII	(MTK_ETH_PATH_GMAC1_TRGMII | MTK_TRGMII)
761 #define MTK_GMAC1_SGMII		(MTK_ETH_PATH_GMAC1_SGMII | MTK_SGMII)
762 #define MTK_GMAC2_RGMII		(MTK_ETH_PATH_GMAC2_RGMII | MTK_RGMII)
763 #define MTK_GMAC2_SGMII		(MTK_ETH_PATH_GMAC2_SGMII | MTK_SGMII)
764 #define MTK_GMAC2_GEPHY		(MTK_ETH_PATH_GMAC2_GEPHY | MTK_GEPHY)
765 #define MTK_GDM1_ESW		(MTK_ETH_PATH_GDM1_ESW | MTK_ESW)
766 
767 /* MUXes present on SoCs */
768 /* 0: GDM1 -> GMAC1, 1: GDM1 -> ESW */
769 #define MTK_MUX_GDM1_TO_GMAC1_ESW (MTK_ETH_MUX_GDM1_TO_GMAC1_ESW | MTK_MUX)
770 
771 /* 0: GMAC2 -> GEPHY, 1: GMAC0 -> GePHY */
772 #define MTK_MUX_GMAC2_GMAC0_TO_GEPHY    \
773 	(MTK_ETH_MUX_GMAC2_GMAC0_TO_GEPHY | MTK_MUX | MTK_INFRA)
774 
775 /* 0: U3 -> QPHY, 1: GMAC2 -> QPHY */
776 #define MTK_MUX_U3_GMAC2_TO_QPHY        \
777 	(MTK_ETH_MUX_U3_GMAC2_TO_QPHY | MTK_MUX | MTK_INFRA)
778 
779 /* 2: GMAC1 -> SGMII, 3: GMAC2 -> SGMII */
780 #define MTK_MUX_GMAC1_GMAC2_TO_SGMII_RGMII      \
781 	(MTK_ETH_MUX_GMAC1_GMAC2_TO_SGMII_RGMII | MTK_MUX | \
782 	MTK_SHARED_SGMII)
783 
784 /* 0: GMACx -> GEPHY, 1: GMACx -> SGMII where x is 1 or 2 */
785 #define MTK_MUX_GMAC12_TO_GEPHY_SGMII   \
786 	(MTK_ETH_MUX_GMAC12_TO_GEPHY_SGMII | MTK_MUX)
787 
788 #define MTK_HAS_CAPS(caps, _x)		(((caps) & (_x)) == (_x))
789 
790 #define MT7621_CAPS  (MTK_GMAC1_RGMII | MTK_GMAC1_TRGMII | \
791 		      MTK_GMAC2_RGMII | MTK_SHARED_INT | \
792 		      MTK_TRGMII_MT7621_CLK | MTK_QDMA)
793 
794 #define MT7622_CAPS  (MTK_GMAC1_RGMII | MTK_GMAC1_SGMII | MTK_GMAC2_RGMII | \
795 		      MTK_GMAC2_SGMII | MTK_GDM1_ESW | \
796 		      MTK_MUX_GDM1_TO_GMAC1_ESW | \
797 		      MTK_MUX_GMAC1_GMAC2_TO_SGMII_RGMII | MTK_QDMA)
798 
799 #define MT7623_CAPS  (MTK_GMAC1_RGMII | MTK_GMAC1_TRGMII | MTK_GMAC2_RGMII | \
800 		      MTK_QDMA)
801 
802 #define MT7628_CAPS  (MTK_SHARED_INT | MTK_SOC_MT7628)
803 
804 #define MT7629_CAPS  (MTK_GMAC1_SGMII | MTK_GMAC2_SGMII | MTK_GMAC2_GEPHY | \
805 		      MTK_GDM1_ESW | MTK_MUX_GDM1_TO_GMAC1_ESW | \
806 		      MTK_MUX_GMAC2_GMAC0_TO_GEPHY | \
807 		      MTK_MUX_U3_GMAC2_TO_QPHY | \
808 		      MTK_MUX_GMAC12_TO_GEPHY_SGMII | MTK_QDMA)
809 
810 /* struct mtk_eth_data -	This is the structure holding all differences
811  *				among various plaforms
812  * @ana_rgc3:                   The offset for register ANA_RGC3 related to
813  *				sgmiisys syscon
814  * @caps			Flags shown the extra capability for the SoC
815  * @hw_features			Flags shown HW features
816  * @required_clks		Flags shown the bitmap for required clocks on
817  *				the target SoC
818  * @required_pctl		A bool value to show whether the SoC requires
819  *				the extra setup for those pins used by GMAC.
820  */
821 struct mtk_soc_data {
822 	u32             ana_rgc3;
823 	u32		caps;
824 	u32		required_clks;
825 	bool		required_pctl;
826 	u8		offload_version;
827 	netdev_features_t hw_features;
828 };
829 
830 /* currently no SoC has more than 2 macs */
831 #define MTK_MAX_DEVS			2
832 
833 #define MTK_SGMII_PHYSPEED_AN          BIT(31)
834 #define MTK_SGMII_PHYSPEED_MASK        GENMASK(2, 0)
835 #define MTK_SGMII_PHYSPEED_1000        BIT(0)
836 #define MTK_SGMII_PHYSPEED_2500        BIT(1)
837 #define MTK_HAS_FLAGS(flags, _x)       (((flags) & (_x)) == (_x))
838 
839 /* struct mtk_sgmii -  This is the structure holding sgmii regmap and its
840  *                     characteristics
841  * @regmap:            The register map pointing at the range used to setup
842  *                     SGMII modes
843  * @flags:             The enum refers to which mode the sgmii wants to run on
844  * @ana_rgc3:          The offset refers to register ANA_RGC3 related to regmap
845  */
846 
847 struct mtk_sgmii {
848 	struct regmap   *regmap[MTK_MAX_DEVS];
849 	u32             flags[MTK_MAX_DEVS];
850 	u32             ana_rgc3;
851 };
852 
853 /* struct mtk_eth -	This is the main datasructure for holding the state
854  *			of the driver
855  * @dev:		The device pointer
856  * @base:		The mapped register i/o base
857  * @page_lock:		Make sure that register operations are atomic
858  * @tx_irq__lock:	Make sure that IRQ register operations are atomic
859  * @rx_irq__lock:	Make sure that IRQ register operations are atomic
860  * @dim_lock:		Make sure that Net DIM operations are atomic
861  * @dummy_dev:		we run 2 netdevs on 1 physical DMA ring and need a
862  *			dummy for NAPI to work
863  * @netdev:		The netdev instances
864  * @mac:		Each netdev is linked to a physical MAC
865  * @irq:		The IRQ that we are using
866  * @msg_enable:		Ethtool msg level
867  * @ethsys:		The register map pointing at the range used to setup
868  *			MII modes
869  * @infra:              The register map pointing at the range used to setup
870  *                      SGMII and GePHY path
871  * @pctl:		The register map pointing at the range used to setup
872  *			GMAC port drive/slew values
873  * @dma_refcnt:		track how many netdevs are using the DMA engine
874  * @tx_ring:		Pointer to the memory holding info about the TX ring
875  * @rx_ring:		Pointer to the memory holding info about the RX ring
876  * @rx_ring_qdma:	Pointer to the memory holding info about the QDMA RX ring
877  * @tx_napi:		The TX NAPI struct
878  * @rx_napi:		The RX NAPI struct
879  * @rx_events:		Net DIM RX event counter
880  * @rx_packets:		Net DIM RX packet counter
881  * @rx_bytes:		Net DIM RX byte counter
882  * @rx_dim:		Net DIM RX context
883  * @tx_events:		Net DIM TX event counter
884  * @tx_packets:		Net DIM TX packet counter
885  * @tx_bytes:		Net DIM TX byte counter
886  * @tx_dim:		Net DIM TX context
887  * @scratch_ring:	Newer SoCs need memory for a second HW managed TX ring
888  * @phy_scratch_ring:	physical address of scratch_ring
889  * @scratch_head:	The scratch memory that scratch_ring points to.
890  * @clks:		clock array for all clocks required
891  * @mii_bus:		If there is a bus we need to create an instance for it
892  * @pending_work:	The workqueue used to reset the dma ring
893  * @state:		Initialization and runtime state of the device
894  * @soc:		Holding specific data among vaious SoCs
895  */
896 
897 struct mtk_eth {
898 	struct device			*dev;
899 	void __iomem			*base;
900 	spinlock_t			page_lock;
901 	spinlock_t			tx_irq_lock;
902 	spinlock_t			rx_irq_lock;
903 	struct net_device		dummy_dev;
904 	struct net_device		*netdev[MTK_MAX_DEVS];
905 	struct mtk_mac			*mac[MTK_MAX_DEVS];
906 	int				irq[3];
907 	u32				msg_enable;
908 	unsigned long			sysclk;
909 	struct regmap			*ethsys;
910 	struct regmap                   *infra;
911 	struct mtk_sgmii                *sgmii;
912 	struct regmap			*pctl;
913 	bool				hwlro;
914 	refcount_t			dma_refcnt;
915 	struct mtk_tx_ring		tx_ring;
916 	struct mtk_rx_ring		rx_ring[MTK_MAX_RX_RING_NUM];
917 	struct mtk_rx_ring		rx_ring_qdma;
918 	struct napi_struct		tx_napi;
919 	struct napi_struct		rx_napi;
920 	struct mtk_tx_dma		*scratch_ring;
921 	dma_addr_t			phy_scratch_ring;
922 	void				*scratch_head;
923 	struct clk			*clks[MTK_CLK_MAX];
924 
925 	struct mii_bus			*mii_bus;
926 	struct work_struct		pending_work;
927 	unsigned long			state;
928 
929 	const struct mtk_soc_data	*soc;
930 
931 	spinlock_t			dim_lock;
932 
933 	u32				rx_events;
934 	u32				rx_packets;
935 	u32				rx_bytes;
936 	struct dim			rx_dim;
937 
938 	u32				tx_events;
939 	u32				tx_packets;
940 	u32				tx_bytes;
941 	struct dim			tx_dim;
942 
943 	u32				tx_int_mask_reg;
944 	u32				tx_int_status_reg;
945 	u32				rx_dma_l4_valid;
946 	int				ip_align;
947 
948 	struct mtk_ppe			ppe;
949 	struct rhashtable		flow_table;
950 };
951 
952 /* struct mtk_mac -	the structure that holds the info about the MACs of the
953  *			SoC
954  * @id:			The number of the MAC
955  * @interface:		Interface mode kept for detecting change in hw settings
956  * @of_node:		Our devicetree node
957  * @hw:			Backpointer to our main datastruture
958  * @hw_stats:		Packet statistics counter
959  */
960 struct mtk_mac {
961 	int				id;
962 	phy_interface_t			interface;
963 	unsigned int			mode;
964 	int				speed;
965 	struct device_node		*of_node;
966 	struct phylink			*phylink;
967 	struct phylink_config		phylink_config;
968 	struct mtk_eth			*hw;
969 	struct mtk_hw_stats		*hw_stats;
970 	__be32				hwlro_ip[MTK_MAX_LRO_IP_CNT];
971 	int				hwlro_ip_cnt;
972 };
973 
974 /* the struct describing the SoC. these are declared in the soc_xyz.c files */
975 extern const struct of_device_id of_mtk_match[];
976 
977 /* read the hardware status register */
978 void mtk_stats_update_mac(struct mtk_mac *mac);
979 
980 void mtk_w32(struct mtk_eth *eth, u32 val, unsigned reg);
981 u32 mtk_r32(struct mtk_eth *eth, unsigned reg);
982 
983 int mtk_sgmii_init(struct mtk_sgmii *ss, struct device_node *np,
984 		   u32 ana_rgc3);
985 int mtk_sgmii_setup_mode_an(struct mtk_sgmii *ss, int id);
986 int mtk_sgmii_setup_mode_force(struct mtk_sgmii *ss, int id,
987 			       const struct phylink_link_state *state);
988 void mtk_sgmii_restart_an(struct mtk_eth *eth, int mac_id);
989 
990 int mtk_gmac_sgmii_path_setup(struct mtk_eth *eth, int mac_id);
991 int mtk_gmac_gephy_path_setup(struct mtk_eth *eth, int mac_id);
992 int mtk_gmac_rgmii_path_setup(struct mtk_eth *eth, int mac_id);
993 
994 int mtk_eth_offload_init(struct mtk_eth *eth);
995 int mtk_eth_setup_tc(struct net_device *dev, enum tc_setup_type type,
996 		     void *type_data);
997 
998 
999 #endif /* MTK_ETH_H */
1000