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