xref: /openbmc/linux/include/soc/mscc/ocelot.h (revision be58f710)
1 /* SPDX-License-Identifier: (GPL-2.0 OR MIT) */
2 /* Copyright (c) 2017 Microsemi Corporation
3  */
4 
5 #ifndef _SOC_MSCC_OCELOT_H
6 #define _SOC_MSCC_OCELOT_H
7 
8 #include <linux/ptp_clock_kernel.h>
9 #include <linux/net_tstamp.h>
10 #include <linux/if_vlan.h>
11 #include <linux/regmap.h>
12 #include <net/dsa.h>
13 
14 /* Port Group IDs (PGID) are masks of destination ports.
15  *
16  * For L2 forwarding, the switch performs 3 lookups in the PGID table for each
17  * frame, and forwards the frame to the ports that are present in the logical
18  * AND of all 3 PGIDs.
19  *
20  * These PGID lookups are:
21  * - In one of PGID[0-63]: for the destination masks. There are 2 paths by
22  *   which the switch selects a destination PGID:
23  *     - The {DMAC, VID} is present in the MAC table. In that case, the
24  *       destination PGID is given by the DEST_IDX field of the MAC table entry
25  *       that matched.
26  *     - The {DMAC, VID} is not present in the MAC table (it is unknown). The
27  *       frame is disseminated as being either unicast, multicast or broadcast,
28  *       and according to that, the destination PGID is chosen as being the
29  *       value contained by ANA_FLOODING_FLD_UNICAST,
30  *       ANA_FLOODING_FLD_MULTICAST or ANA_FLOODING_FLD_BROADCAST.
31  *   The destination PGID can be an unicast set: the first PGIDs, 0 to
32  *   ocelot->num_phys_ports - 1, or a multicast set: the PGIDs from
33  *   ocelot->num_phys_ports to 63. By convention, a unicast PGID corresponds to
34  *   a physical port and has a single bit set in the destination ports mask:
35  *   that corresponding to the port number itself. In contrast, a multicast
36  *   PGID will have potentially more than one single bit set in the destination
37  *   ports mask.
38  * - In one of PGID[64-79]: for the aggregation mask. The switch classifier
39  *   dissects each frame and generates a 4-bit Link Aggregation Code which is
40  *   used for this second PGID table lookup. The goal of link aggregation is to
41  *   hash multiple flows within the same LAG on to different destination ports.
42  *   The first lookup will result in a PGID with all the LAG members present in
43  *   the destination ports mask, and the second lookup, by Link Aggregation
44  *   Code, will ensure that each flow gets forwarded only to a single port out
45  *   of that mask (there are no duplicates).
46  * - In one of PGID[80-90]: for the source mask. The third time, the PGID table
47  *   is indexed with the ingress port (plus 80). These PGIDs answer the
48  *   question "is port i allowed to forward traffic to port j?" If yes, then
49  *   BIT(j) of PGID 80+i will be found set. The third PGID lookup can be used
50  *   to enforce the L2 forwarding matrix imposed by e.g. a Linux bridge.
51  */
52 
53 /* Reserve some destination PGIDs at the end of the range:
54  * PGID_BLACKHOLE: used for not forwarding the frames
55  * PGID_CPU: used for whitelisting certain MAC addresses, such as the addresses
56  *           of the switch port net devices, towards the CPU port module.
57  * PGID_UC: the flooding destinations for unknown unicast traffic.
58  * PGID_MC: the flooding destinations for non-IP multicast traffic.
59  * PGID_MCIPV4: the flooding destinations for IPv4 multicast traffic.
60  * PGID_MCIPV6: the flooding destinations for IPv6 multicast traffic.
61  * PGID_BC: the flooding destinations for broadcast traffic.
62  */
63 #define PGID_BLACKHOLE			57
64 #define PGID_CPU			58
65 #define PGID_UC				59
66 #define PGID_MC				60
67 #define PGID_MCIPV4			61
68 #define PGID_MCIPV6			62
69 #define PGID_BC				63
70 
71 #define for_each_unicast_dest_pgid(ocelot, pgid)		\
72 	for ((pgid) = 0;					\
73 	     (pgid) < (ocelot)->num_phys_ports;			\
74 	     (pgid)++)
75 
76 #define for_each_nonreserved_multicast_dest_pgid(ocelot, pgid)	\
77 	for ((pgid) = (ocelot)->num_phys_ports + 1;		\
78 	     (pgid) < PGID_BLACKHOLE;				\
79 	     (pgid)++)
80 
81 #define for_each_aggr_pgid(ocelot, pgid)			\
82 	for ((pgid) = PGID_AGGR;				\
83 	     (pgid) < PGID_SRC;					\
84 	     (pgid)++)
85 
86 /* Aggregation PGIDs, one per Link Aggregation Code */
87 #define PGID_AGGR			64
88 
89 /* Source PGIDs, one per physical port */
90 #define PGID_SRC			80
91 
92 #define IFH_TAG_TYPE_C			0
93 #define IFH_TAG_TYPE_S			1
94 
95 #define IFH_REW_OP_NOOP			0x0
96 #define IFH_REW_OP_DSCP			0x1
97 #define IFH_REW_OP_ONE_STEP_PTP		0x2
98 #define IFH_REW_OP_TWO_STEP_PTP		0x3
99 #define IFH_REW_OP_ORIGIN_PTP		0x5
100 
101 #define OCELOT_NUM_TC			8
102 
103 #define OCELOT_SPEED_2500		0
104 #define OCELOT_SPEED_1000		1
105 #define OCELOT_SPEED_100		2
106 #define OCELOT_SPEED_10			3
107 
108 #define OCELOT_PTP_PINS_NUM		4
109 
110 #define TARGET_OFFSET			24
111 #define REG_MASK			GENMASK(TARGET_OFFSET - 1, 0)
112 #define REG(reg, offset)		[reg & REG_MASK] = offset
113 
114 #define REG_RESERVED_ADDR		0xffffffff
115 #define REG_RESERVED(reg)		REG(reg, REG_RESERVED_ADDR)
116 
117 #define OCELOT_MRP_CPUQ			7
118 
119 enum ocelot_target {
120 	ANA = 1,
121 	QS,
122 	QSYS,
123 	REW,
124 	SYS,
125 	S0,
126 	S1,
127 	S2,
128 	HSIO,
129 	PTP,
130 	GCB,
131 	DEV_GMII,
132 	TARGET_MAX,
133 };
134 
135 enum ocelot_reg {
136 	ANA_ADVLEARN = ANA << TARGET_OFFSET,
137 	ANA_VLANMASK,
138 	ANA_PORT_B_DOMAIN,
139 	ANA_ANAGEFIL,
140 	ANA_ANEVENTS,
141 	ANA_STORMLIMIT_BURST,
142 	ANA_STORMLIMIT_CFG,
143 	ANA_ISOLATED_PORTS,
144 	ANA_COMMUNITY_PORTS,
145 	ANA_AUTOAGE,
146 	ANA_MACTOPTIONS,
147 	ANA_LEARNDISC,
148 	ANA_AGENCTRL,
149 	ANA_MIRRORPORTS,
150 	ANA_EMIRRORPORTS,
151 	ANA_FLOODING,
152 	ANA_FLOODING_IPMC,
153 	ANA_SFLOW_CFG,
154 	ANA_PORT_MODE,
155 	ANA_CUT_THRU_CFG,
156 	ANA_PGID_PGID,
157 	ANA_TABLES_ANMOVED,
158 	ANA_TABLES_MACHDATA,
159 	ANA_TABLES_MACLDATA,
160 	ANA_TABLES_STREAMDATA,
161 	ANA_TABLES_MACACCESS,
162 	ANA_TABLES_MACTINDX,
163 	ANA_TABLES_VLANACCESS,
164 	ANA_TABLES_VLANTIDX,
165 	ANA_TABLES_ISDXACCESS,
166 	ANA_TABLES_ISDXTIDX,
167 	ANA_TABLES_ENTRYLIM,
168 	ANA_TABLES_PTP_ID_HIGH,
169 	ANA_TABLES_PTP_ID_LOW,
170 	ANA_TABLES_STREAMACCESS,
171 	ANA_TABLES_STREAMTIDX,
172 	ANA_TABLES_SEQ_HISTORY,
173 	ANA_TABLES_SEQ_MASK,
174 	ANA_TABLES_SFID_MASK,
175 	ANA_TABLES_SFIDACCESS,
176 	ANA_TABLES_SFIDTIDX,
177 	ANA_MSTI_STATE,
178 	ANA_OAM_UPM_LM_CNT,
179 	ANA_SG_ACCESS_CTRL,
180 	ANA_SG_CONFIG_REG_1,
181 	ANA_SG_CONFIG_REG_2,
182 	ANA_SG_CONFIG_REG_3,
183 	ANA_SG_CONFIG_REG_4,
184 	ANA_SG_CONFIG_REG_5,
185 	ANA_SG_GCL_GS_CONFIG,
186 	ANA_SG_GCL_TI_CONFIG,
187 	ANA_SG_STATUS_REG_1,
188 	ANA_SG_STATUS_REG_2,
189 	ANA_SG_STATUS_REG_3,
190 	ANA_PORT_VLAN_CFG,
191 	ANA_PORT_DROP_CFG,
192 	ANA_PORT_QOS_CFG,
193 	ANA_PORT_VCAP_CFG,
194 	ANA_PORT_VCAP_S1_KEY_CFG,
195 	ANA_PORT_VCAP_S2_CFG,
196 	ANA_PORT_PCP_DEI_MAP,
197 	ANA_PORT_CPU_FWD_CFG,
198 	ANA_PORT_CPU_FWD_BPDU_CFG,
199 	ANA_PORT_CPU_FWD_GARP_CFG,
200 	ANA_PORT_CPU_FWD_CCM_CFG,
201 	ANA_PORT_PORT_CFG,
202 	ANA_PORT_POL_CFG,
203 	ANA_PORT_PTP_CFG,
204 	ANA_PORT_PTP_DLY1_CFG,
205 	ANA_PORT_PTP_DLY2_CFG,
206 	ANA_PORT_SFID_CFG,
207 	ANA_PFC_PFC_CFG,
208 	ANA_PFC_PFC_TIMER,
209 	ANA_IPT_OAM_MEP_CFG,
210 	ANA_IPT_IPT,
211 	ANA_PPT_PPT,
212 	ANA_FID_MAP_FID_MAP,
213 	ANA_AGGR_CFG,
214 	ANA_CPUQ_CFG,
215 	ANA_CPUQ_CFG2,
216 	ANA_CPUQ_8021_CFG,
217 	ANA_DSCP_CFG,
218 	ANA_DSCP_REWR_CFG,
219 	ANA_VCAP_RNG_TYPE_CFG,
220 	ANA_VCAP_RNG_VAL_CFG,
221 	ANA_VRAP_CFG,
222 	ANA_VRAP_HDR_DATA,
223 	ANA_VRAP_HDR_MASK,
224 	ANA_DISCARD_CFG,
225 	ANA_FID_CFG,
226 	ANA_POL_PIR_CFG,
227 	ANA_POL_CIR_CFG,
228 	ANA_POL_MODE_CFG,
229 	ANA_POL_PIR_STATE,
230 	ANA_POL_CIR_STATE,
231 	ANA_POL_STATE,
232 	ANA_POL_FLOWC,
233 	ANA_POL_HYST,
234 	ANA_POL_MISC_CFG,
235 	QS_XTR_GRP_CFG = QS << TARGET_OFFSET,
236 	QS_XTR_RD,
237 	QS_XTR_FRM_PRUNING,
238 	QS_XTR_FLUSH,
239 	QS_XTR_DATA_PRESENT,
240 	QS_XTR_CFG,
241 	QS_INJ_GRP_CFG,
242 	QS_INJ_WR,
243 	QS_INJ_CTRL,
244 	QS_INJ_STATUS,
245 	QS_INJ_ERR,
246 	QS_INH_DBG,
247 	QSYS_PORT_MODE = QSYS << TARGET_OFFSET,
248 	QSYS_SWITCH_PORT_MODE,
249 	QSYS_STAT_CNT_CFG,
250 	QSYS_EEE_CFG,
251 	QSYS_EEE_THRES,
252 	QSYS_IGR_NO_SHARING,
253 	QSYS_EGR_NO_SHARING,
254 	QSYS_SW_STATUS,
255 	QSYS_EXT_CPU_CFG,
256 	QSYS_PAD_CFG,
257 	QSYS_CPU_GROUP_MAP,
258 	QSYS_QMAP,
259 	QSYS_ISDX_SGRP,
260 	QSYS_TIMED_FRAME_ENTRY,
261 	QSYS_TFRM_MISC,
262 	QSYS_TFRM_PORT_DLY,
263 	QSYS_TFRM_TIMER_CFG_1,
264 	QSYS_TFRM_TIMER_CFG_2,
265 	QSYS_TFRM_TIMER_CFG_3,
266 	QSYS_TFRM_TIMER_CFG_4,
267 	QSYS_TFRM_TIMER_CFG_5,
268 	QSYS_TFRM_TIMER_CFG_6,
269 	QSYS_TFRM_TIMER_CFG_7,
270 	QSYS_TFRM_TIMER_CFG_8,
271 	QSYS_RED_PROFILE,
272 	QSYS_RES_QOS_MODE,
273 	QSYS_RES_CFG,
274 	QSYS_RES_STAT,
275 	QSYS_EGR_DROP_MODE,
276 	QSYS_EQ_CTRL,
277 	QSYS_EVENTS_CORE,
278 	QSYS_QMAXSDU_CFG_0,
279 	QSYS_QMAXSDU_CFG_1,
280 	QSYS_QMAXSDU_CFG_2,
281 	QSYS_QMAXSDU_CFG_3,
282 	QSYS_QMAXSDU_CFG_4,
283 	QSYS_QMAXSDU_CFG_5,
284 	QSYS_QMAXSDU_CFG_6,
285 	QSYS_QMAXSDU_CFG_7,
286 	QSYS_PREEMPTION_CFG,
287 	QSYS_CIR_CFG,
288 	QSYS_EIR_CFG,
289 	QSYS_SE_CFG,
290 	QSYS_SE_DWRR_CFG,
291 	QSYS_SE_CONNECT,
292 	QSYS_SE_DLB_SENSE,
293 	QSYS_CIR_STATE,
294 	QSYS_EIR_STATE,
295 	QSYS_SE_STATE,
296 	QSYS_HSCH_MISC_CFG,
297 	QSYS_TAG_CONFIG,
298 	QSYS_TAS_PARAM_CFG_CTRL,
299 	QSYS_PORT_MAX_SDU,
300 	QSYS_PARAM_CFG_REG_1,
301 	QSYS_PARAM_CFG_REG_2,
302 	QSYS_PARAM_CFG_REG_3,
303 	QSYS_PARAM_CFG_REG_4,
304 	QSYS_PARAM_CFG_REG_5,
305 	QSYS_GCL_CFG_REG_1,
306 	QSYS_GCL_CFG_REG_2,
307 	QSYS_PARAM_STATUS_REG_1,
308 	QSYS_PARAM_STATUS_REG_2,
309 	QSYS_PARAM_STATUS_REG_3,
310 	QSYS_PARAM_STATUS_REG_4,
311 	QSYS_PARAM_STATUS_REG_5,
312 	QSYS_PARAM_STATUS_REG_6,
313 	QSYS_PARAM_STATUS_REG_7,
314 	QSYS_PARAM_STATUS_REG_8,
315 	QSYS_PARAM_STATUS_REG_9,
316 	QSYS_GCL_STATUS_REG_1,
317 	QSYS_GCL_STATUS_REG_2,
318 	REW_PORT_VLAN_CFG = REW << TARGET_OFFSET,
319 	REW_TAG_CFG,
320 	REW_PORT_CFG,
321 	REW_DSCP_CFG,
322 	REW_PCP_DEI_QOS_MAP_CFG,
323 	REW_PTP_CFG,
324 	REW_PTP_DLY1_CFG,
325 	REW_RED_TAG_CFG,
326 	REW_DSCP_REMAP_DP1_CFG,
327 	REW_DSCP_REMAP_CFG,
328 	REW_STAT_CFG,
329 	REW_REW_STICKY,
330 	REW_PPT,
331 	SYS_COUNT_RX_OCTETS = SYS << TARGET_OFFSET,
332 	SYS_COUNT_RX_UNICAST,
333 	SYS_COUNT_RX_MULTICAST,
334 	SYS_COUNT_RX_BROADCAST,
335 	SYS_COUNT_RX_SHORTS,
336 	SYS_COUNT_RX_FRAGMENTS,
337 	SYS_COUNT_RX_JABBERS,
338 	SYS_COUNT_RX_CRC_ALIGN_ERRS,
339 	SYS_COUNT_RX_SYM_ERRS,
340 	SYS_COUNT_RX_64,
341 	SYS_COUNT_RX_65_127,
342 	SYS_COUNT_RX_128_255,
343 	SYS_COUNT_RX_256_1023,
344 	SYS_COUNT_RX_1024_1526,
345 	SYS_COUNT_RX_1527_MAX,
346 	SYS_COUNT_RX_PAUSE,
347 	SYS_COUNT_RX_CONTROL,
348 	SYS_COUNT_RX_LONGS,
349 	SYS_COUNT_RX_CLASSIFIED_DROPS,
350 	SYS_COUNT_TX_OCTETS,
351 	SYS_COUNT_TX_UNICAST,
352 	SYS_COUNT_TX_MULTICAST,
353 	SYS_COUNT_TX_BROADCAST,
354 	SYS_COUNT_TX_COLLISION,
355 	SYS_COUNT_TX_DROPS,
356 	SYS_COUNT_TX_PAUSE,
357 	SYS_COUNT_TX_64,
358 	SYS_COUNT_TX_65_127,
359 	SYS_COUNT_TX_128_511,
360 	SYS_COUNT_TX_512_1023,
361 	SYS_COUNT_TX_1024_1526,
362 	SYS_COUNT_TX_1527_MAX,
363 	SYS_COUNT_TX_AGING,
364 	SYS_RESET_CFG,
365 	SYS_SR_ETYPE_CFG,
366 	SYS_VLAN_ETYPE_CFG,
367 	SYS_PORT_MODE,
368 	SYS_FRONT_PORT_MODE,
369 	SYS_FRM_AGING,
370 	SYS_STAT_CFG,
371 	SYS_SW_STATUS,
372 	SYS_MISC_CFG,
373 	SYS_REW_MAC_HIGH_CFG,
374 	SYS_REW_MAC_LOW_CFG,
375 	SYS_TIMESTAMP_OFFSET,
376 	SYS_CMID,
377 	SYS_PAUSE_CFG,
378 	SYS_PAUSE_TOT_CFG,
379 	SYS_ATOP,
380 	SYS_ATOP_TOT_CFG,
381 	SYS_MAC_FC_CFG,
382 	SYS_MMGT,
383 	SYS_MMGT_FAST,
384 	SYS_EVENTS_DIF,
385 	SYS_EVENTS_CORE,
386 	SYS_CNT,
387 	SYS_PTP_STATUS,
388 	SYS_PTP_TXSTAMP,
389 	SYS_PTP_NXT,
390 	SYS_PTP_CFG,
391 	SYS_RAM_INIT,
392 	SYS_CM_ADDR,
393 	SYS_CM_DATA_WR,
394 	SYS_CM_DATA_RD,
395 	SYS_CM_OP,
396 	SYS_CM_DATA,
397 	PTP_PIN_CFG = PTP << TARGET_OFFSET,
398 	PTP_PIN_TOD_SEC_MSB,
399 	PTP_PIN_TOD_SEC_LSB,
400 	PTP_PIN_TOD_NSEC,
401 	PTP_PIN_WF_HIGH_PERIOD,
402 	PTP_PIN_WF_LOW_PERIOD,
403 	PTP_CFG_MISC,
404 	PTP_CLK_CFG_ADJ_CFG,
405 	PTP_CLK_CFG_ADJ_FREQ,
406 	GCB_SOFT_RST = GCB << TARGET_OFFSET,
407 	GCB_MIIM_MII_STATUS,
408 	GCB_MIIM_MII_CMD,
409 	GCB_MIIM_MII_DATA,
410 	DEV_CLOCK_CFG = DEV_GMII << TARGET_OFFSET,
411 	DEV_PORT_MISC,
412 	DEV_EVENTS,
413 	DEV_EEE_CFG,
414 	DEV_RX_PATH_DELAY,
415 	DEV_TX_PATH_DELAY,
416 	DEV_PTP_PREDICT_CFG,
417 	DEV_MAC_ENA_CFG,
418 	DEV_MAC_MODE_CFG,
419 	DEV_MAC_MAXLEN_CFG,
420 	DEV_MAC_TAGS_CFG,
421 	DEV_MAC_ADV_CHK_CFG,
422 	DEV_MAC_IFG_CFG,
423 	DEV_MAC_HDX_CFG,
424 	DEV_MAC_DBG_CFG,
425 	DEV_MAC_FC_MAC_LOW_CFG,
426 	DEV_MAC_FC_MAC_HIGH_CFG,
427 	DEV_MAC_STICKY,
428 	PCS1G_CFG,
429 	PCS1G_MODE_CFG,
430 	PCS1G_SD_CFG,
431 	PCS1G_ANEG_CFG,
432 	PCS1G_ANEG_NP_CFG,
433 	PCS1G_LB_CFG,
434 	PCS1G_DBG_CFG,
435 	PCS1G_CDET_CFG,
436 	PCS1G_ANEG_STATUS,
437 	PCS1G_ANEG_NP_STATUS,
438 	PCS1G_LINK_STATUS,
439 	PCS1G_LINK_DOWN_CNT,
440 	PCS1G_STICKY,
441 	PCS1G_DEBUG_STATUS,
442 	PCS1G_LPI_CFG,
443 	PCS1G_LPI_WAKE_ERROR_CNT,
444 	PCS1G_LPI_STATUS,
445 	PCS1G_TSTPAT_MODE_CFG,
446 	PCS1G_TSTPAT_STATUS,
447 	DEV_PCS_FX100_CFG,
448 	DEV_PCS_FX100_STATUS,
449 };
450 
451 enum ocelot_regfield {
452 	ANA_ADVLEARN_VLAN_CHK,
453 	ANA_ADVLEARN_LEARN_MIRROR,
454 	ANA_ANEVENTS_FLOOD_DISCARD,
455 	ANA_ANEVENTS_MSTI_DROP,
456 	ANA_ANEVENTS_ACLKILL,
457 	ANA_ANEVENTS_ACLUSED,
458 	ANA_ANEVENTS_AUTOAGE,
459 	ANA_ANEVENTS_VS2TTL1,
460 	ANA_ANEVENTS_STORM_DROP,
461 	ANA_ANEVENTS_LEARN_DROP,
462 	ANA_ANEVENTS_AGED_ENTRY,
463 	ANA_ANEVENTS_CPU_LEARN_FAILED,
464 	ANA_ANEVENTS_AUTO_LEARN_FAILED,
465 	ANA_ANEVENTS_LEARN_REMOVE,
466 	ANA_ANEVENTS_AUTO_LEARNED,
467 	ANA_ANEVENTS_AUTO_MOVED,
468 	ANA_ANEVENTS_DROPPED,
469 	ANA_ANEVENTS_CLASSIFIED_DROP,
470 	ANA_ANEVENTS_CLASSIFIED_COPY,
471 	ANA_ANEVENTS_VLAN_DISCARD,
472 	ANA_ANEVENTS_FWD_DISCARD,
473 	ANA_ANEVENTS_MULTICAST_FLOOD,
474 	ANA_ANEVENTS_UNICAST_FLOOD,
475 	ANA_ANEVENTS_DEST_KNOWN,
476 	ANA_ANEVENTS_BUCKET3_MATCH,
477 	ANA_ANEVENTS_BUCKET2_MATCH,
478 	ANA_ANEVENTS_BUCKET1_MATCH,
479 	ANA_ANEVENTS_BUCKET0_MATCH,
480 	ANA_ANEVENTS_CPU_OPERATION,
481 	ANA_ANEVENTS_DMAC_LOOKUP,
482 	ANA_ANEVENTS_SMAC_LOOKUP,
483 	ANA_ANEVENTS_SEQ_GEN_ERR_0,
484 	ANA_ANEVENTS_SEQ_GEN_ERR_1,
485 	ANA_TABLES_MACACCESS_B_DOM,
486 	ANA_TABLES_MACTINDX_BUCKET,
487 	ANA_TABLES_MACTINDX_M_INDEX,
488 	QSYS_SWITCH_PORT_MODE_PORT_ENA,
489 	QSYS_SWITCH_PORT_MODE_SCH_NEXT_CFG,
490 	QSYS_SWITCH_PORT_MODE_YEL_RSRVD,
491 	QSYS_SWITCH_PORT_MODE_INGRESS_DROP_MODE,
492 	QSYS_SWITCH_PORT_MODE_TX_PFC_ENA,
493 	QSYS_SWITCH_PORT_MODE_TX_PFC_MODE,
494 	QSYS_TIMED_FRAME_ENTRY_TFRM_VLD,
495 	QSYS_TIMED_FRAME_ENTRY_TFRM_FP,
496 	QSYS_TIMED_FRAME_ENTRY_TFRM_PORTNO,
497 	QSYS_TIMED_FRAME_ENTRY_TFRM_TM_SEL,
498 	QSYS_TIMED_FRAME_ENTRY_TFRM_TM_T,
499 	SYS_PORT_MODE_DATA_WO_TS,
500 	SYS_PORT_MODE_INCL_INJ_HDR,
501 	SYS_PORT_MODE_INCL_XTR_HDR,
502 	SYS_PORT_MODE_INCL_HDR_ERR,
503 	SYS_RESET_CFG_CORE_ENA,
504 	SYS_RESET_CFG_MEM_ENA,
505 	SYS_RESET_CFG_MEM_INIT,
506 	GCB_SOFT_RST_SWC_RST,
507 	GCB_MIIM_MII_STATUS_PENDING,
508 	GCB_MIIM_MII_STATUS_BUSY,
509 	SYS_PAUSE_CFG_PAUSE_START,
510 	SYS_PAUSE_CFG_PAUSE_STOP,
511 	SYS_PAUSE_CFG_PAUSE_ENA,
512 	REGFIELD_MAX
513 };
514 
515 enum {
516 	/* VCAP_CORE_CFG */
517 	VCAP_CORE_UPDATE_CTRL,
518 	VCAP_CORE_MV_CFG,
519 	/* VCAP_CORE_CACHE */
520 	VCAP_CACHE_ENTRY_DAT,
521 	VCAP_CACHE_MASK_DAT,
522 	VCAP_CACHE_ACTION_DAT,
523 	VCAP_CACHE_CNT_DAT,
524 	VCAP_CACHE_TG_DAT,
525 	/* VCAP_CONST */
526 	VCAP_CONST_VCAP_VER,
527 	VCAP_CONST_ENTRY_WIDTH,
528 	VCAP_CONST_ENTRY_CNT,
529 	VCAP_CONST_ENTRY_SWCNT,
530 	VCAP_CONST_ENTRY_TG_WIDTH,
531 	VCAP_CONST_ACTION_DEF_CNT,
532 	VCAP_CONST_ACTION_WIDTH,
533 	VCAP_CONST_CNT_WIDTH,
534 	VCAP_CONST_CORE_CNT,
535 	VCAP_CONST_IF_CNT,
536 };
537 
538 enum ocelot_ptp_pins {
539 	PTP_PIN_0,
540 	PTP_PIN_1,
541 	PTP_PIN_2,
542 	PTP_PIN_3,
543 	TOD_ACC_PIN
544 };
545 
546 struct ocelot_stat_layout {
547 	u32 offset;
548 	char name[ETH_GSTRING_LEN];
549 };
550 
551 enum ocelot_tag_prefix {
552 	OCELOT_TAG_PREFIX_DISABLED	= 0,
553 	OCELOT_TAG_PREFIX_NONE,
554 	OCELOT_TAG_PREFIX_SHORT,
555 	OCELOT_TAG_PREFIX_LONG,
556 };
557 
558 struct ocelot;
559 
560 struct ocelot_ops {
561 	struct net_device *(*port_to_netdev)(struct ocelot *ocelot, int port);
562 	int (*netdev_to_port)(struct net_device *dev);
563 	int (*reset)(struct ocelot *ocelot);
564 	u16 (*wm_enc)(u16 value);
565 	u16 (*wm_dec)(u16 value);
566 	void (*wm_stat)(u32 val, u32 *inuse, u32 *maxuse);
567 };
568 
569 struct ocelot_vcap_block {
570 	struct list_head rules;
571 	int count;
572 	int pol_lpr;
573 };
574 
575 struct ocelot_vlan {
576 	bool valid;
577 	u16 vid;
578 };
579 
580 enum ocelot_sb {
581 	OCELOT_SB_BUF,
582 	OCELOT_SB_REF,
583 	OCELOT_SB_NUM,
584 };
585 
586 enum ocelot_sb_pool {
587 	OCELOT_SB_POOL_ING,
588 	OCELOT_SB_POOL_EGR,
589 	OCELOT_SB_POOL_NUM,
590 };
591 
592 #define OCELOT_QUIRK_PCS_PERFORMS_RATE_ADAPTATION	BIT(0)
593 #define OCELOT_QUIRK_QSGMII_PORTS_MUST_BE_UP		BIT(1)
594 
595 struct ocelot_port {
596 	struct ocelot			*ocelot;
597 
598 	struct regmap			*target;
599 
600 	bool				vlan_aware;
601 	/* VLAN that untagged frames are classified to, on ingress */
602 	struct ocelot_vlan		pvid_vlan;
603 	/* The VLAN ID that will be transmitted as untagged, on egress */
604 	struct ocelot_vlan		native_vlan;
605 
606 	u8				ptp_cmd;
607 	struct sk_buff_head		tx_skbs;
608 	u8				ts_id;
609 	spinlock_t			ts_id_lock;
610 
611 	phy_interface_t			phy_mode;
612 
613 	u8				*xmit_template;
614 	bool				is_dsa_8021q_cpu;
615 	bool				learn_ena;
616 
617 	struct net_device		*bond;
618 	bool				lag_tx_active;
619 
620 	u16				mrp_ring_id;
621 
622 	struct net_device		*bridge;
623 	u8				stp_state;
624 };
625 
626 struct ocelot {
627 	struct device			*dev;
628 	struct devlink			*devlink;
629 	struct devlink_port		*devlink_ports;
630 
631 	const struct ocelot_ops		*ops;
632 	struct regmap			*targets[TARGET_MAX];
633 	struct regmap_field		*regfields[REGFIELD_MAX];
634 	const u32 *const		*map;
635 	const struct ocelot_stat_layout	*stats_layout;
636 	unsigned int			num_stats;
637 
638 	u32				pool_size[OCELOT_SB_NUM][OCELOT_SB_POOL_NUM];
639 	int				packet_buffer_size;
640 	int				num_frame_refs;
641 	int				num_mact_rows;
642 
643 	struct ocelot_port		**ports;
644 
645 	u8				base_mac[ETH_ALEN];
646 
647 	/* Keep track of the vlan port masks */
648 	u32				vlan_mask[VLAN_N_VID];
649 
650 	/* Switches like VSC9959 have flooding per traffic class */
651 	int				num_flooding_pgids;
652 
653 	/* In tables like ANA:PORT and the ANA:PGID:PGID mask,
654 	 * the CPU is located after the physical ports (at the
655 	 * num_phys_ports index).
656 	 */
657 	u8				num_phys_ports;
658 
659 	int				npi;
660 
661 	enum ocelot_tag_prefix		npi_inj_prefix;
662 	enum ocelot_tag_prefix		npi_xtr_prefix;
663 
664 	struct list_head		multicast;
665 	struct list_head		pgids;
666 
667 	struct list_head		dummy_rules;
668 	struct ocelot_vcap_block	block[3];
669 	struct vcap_props		*vcap;
670 
671 	/* Workqueue to check statistics for overflow with its lock */
672 	struct mutex			stats_lock;
673 	u64				*stats;
674 	struct delayed_work		stats_work;
675 	struct workqueue_struct		*stats_queue;
676 
677 	struct workqueue_struct		*owq;
678 
679 	u8				ptp:1;
680 	struct ptp_clock		*ptp_clock;
681 	struct ptp_clock_info		ptp_info;
682 	struct hwtstamp_config		hwtstamp_config;
683 	/* Protects the PTP interface state */
684 	struct mutex			ptp_lock;
685 	/* Protects the PTP clock */
686 	spinlock_t			ptp_clock_lock;
687 	struct ptp_pin_desc		ptp_pins[OCELOT_PTP_PINS_NUM];
688 };
689 
690 struct ocelot_policer {
691 	u32 rate; /* kilobit per second */
692 	u32 burst; /* bytes */
693 };
694 
695 struct ocelot_skb_cb {
696 	struct sk_buff *clone;
697 	u8 ptp_cmd;
698 	u8 ts_id;
699 };
700 
701 #define OCELOT_SKB_CB(skb) \
702 	((struct ocelot_skb_cb *)((skb)->cb))
703 
704 #define ocelot_read_ix(ocelot, reg, gi, ri) __ocelot_read_ix(ocelot, reg, reg##_GSZ * (gi) + reg##_RSZ * (ri))
705 #define ocelot_read_gix(ocelot, reg, gi) __ocelot_read_ix(ocelot, reg, reg##_GSZ * (gi))
706 #define ocelot_read_rix(ocelot, reg, ri) __ocelot_read_ix(ocelot, reg, reg##_RSZ * (ri))
707 #define ocelot_read(ocelot, reg) __ocelot_read_ix(ocelot, reg, 0)
708 
709 #define ocelot_write_ix(ocelot, val, reg, gi, ri) __ocelot_write_ix(ocelot, val, reg, reg##_GSZ * (gi) + reg##_RSZ * (ri))
710 #define ocelot_write_gix(ocelot, val, reg, gi) __ocelot_write_ix(ocelot, val, reg, reg##_GSZ * (gi))
711 #define ocelot_write_rix(ocelot, val, reg, ri) __ocelot_write_ix(ocelot, val, reg, reg##_RSZ * (ri))
712 #define ocelot_write(ocelot, val, reg) __ocelot_write_ix(ocelot, val, reg, 0)
713 
714 #define ocelot_rmw_ix(ocelot, val, m, reg, gi, ri) __ocelot_rmw_ix(ocelot, val, m, reg, reg##_GSZ * (gi) + reg##_RSZ * (ri))
715 #define ocelot_rmw_gix(ocelot, val, m, reg, gi) __ocelot_rmw_ix(ocelot, val, m, reg, reg##_GSZ * (gi))
716 #define ocelot_rmw_rix(ocelot, val, m, reg, ri) __ocelot_rmw_ix(ocelot, val, m, reg, reg##_RSZ * (ri))
717 #define ocelot_rmw(ocelot, val, m, reg) __ocelot_rmw_ix(ocelot, val, m, reg, 0)
718 
719 #define ocelot_field_write(ocelot, reg, val) regmap_field_write((ocelot)->regfields[(reg)], (val))
720 #define ocelot_field_read(ocelot, reg, val) regmap_field_read((ocelot)->regfields[(reg)], (val))
721 #define ocelot_fields_write(ocelot, id, reg, val) regmap_fields_write((ocelot)->regfields[(reg)], (id), (val))
722 #define ocelot_fields_read(ocelot, id, reg, val) regmap_fields_read((ocelot)->regfields[(reg)], (id), (val))
723 
724 #define ocelot_target_read_ix(ocelot, target, reg, gi, ri) \
725 	__ocelot_target_read_ix(ocelot, target, reg, reg##_GSZ * (gi) + reg##_RSZ * (ri))
726 #define ocelot_target_read_gix(ocelot, target, reg, gi) \
727 	__ocelot_target_read_ix(ocelot, target, reg, reg##_GSZ * (gi))
728 #define ocelot_target_read_rix(ocelot, target, reg, ri) \
729 	__ocelot_target_read_ix(ocelot, target, reg, reg##_RSZ * (ri))
730 #define ocelot_target_read(ocelot, target, reg) \
731 	__ocelot_target_read_ix(ocelot, target, reg, 0)
732 
733 #define ocelot_target_write_ix(ocelot, target, val, reg, gi, ri) \
734 	__ocelot_target_write_ix(ocelot, target, val, reg, reg##_GSZ * (gi) + reg##_RSZ * (ri))
735 #define ocelot_target_write_gix(ocelot, target, val, reg, gi) \
736 	__ocelot_target_write_ix(ocelot, target, val, reg, reg##_GSZ * (gi))
737 #define ocelot_target_write_rix(ocelot, target, val, reg, ri) \
738 	__ocelot_target_write_ix(ocelot, target, val, reg, reg##_RSZ * (ri))
739 #define ocelot_target_write(ocelot, target, val, reg) \
740 	__ocelot_target_write_ix(ocelot, target, val, reg, 0)
741 
742 /* I/O */
743 u32 ocelot_port_readl(struct ocelot_port *port, u32 reg);
744 void ocelot_port_writel(struct ocelot_port *port, u32 val, u32 reg);
745 void ocelot_port_rmwl(struct ocelot_port *port, u32 val, u32 mask, u32 reg);
746 u32 __ocelot_read_ix(struct ocelot *ocelot, u32 reg, u32 offset);
747 void __ocelot_write_ix(struct ocelot *ocelot, u32 val, u32 reg, u32 offset);
748 void __ocelot_rmw_ix(struct ocelot *ocelot, u32 val, u32 mask, u32 reg,
749 		     u32 offset);
750 u32 __ocelot_target_read_ix(struct ocelot *ocelot, enum ocelot_target target,
751 			    u32 reg, u32 offset);
752 void __ocelot_target_write_ix(struct ocelot *ocelot, enum ocelot_target target,
753 			      u32 val, u32 reg, u32 offset);
754 
755 #if IS_ENABLED(CONFIG_MSCC_OCELOT_SWITCH_LIB)
756 
757 /* Packet I/O */
758 bool ocelot_can_inject(struct ocelot *ocelot, int grp);
759 void ocelot_port_inject_frame(struct ocelot *ocelot, int port, int grp,
760 			      u32 rew_op, struct sk_buff *skb);
761 int ocelot_xtr_poll_frame(struct ocelot *ocelot, int grp, struct sk_buff **skb);
762 void ocelot_drain_cpu_queue(struct ocelot *ocelot, int grp);
763 
764 u32 ocelot_ptp_rew_op(struct sk_buff *skb);
765 #else
766 
767 static inline bool ocelot_can_inject(struct ocelot *ocelot, int grp)
768 {
769 	return false;
770 }
771 
772 static inline void ocelot_port_inject_frame(struct ocelot *ocelot, int port,
773 					    int grp, u32 rew_op,
774 					    struct sk_buff *skb)
775 {
776 }
777 
778 static inline int ocelot_xtr_poll_frame(struct ocelot *ocelot, int grp,
779 					struct sk_buff **skb)
780 {
781 	return -EIO;
782 }
783 
784 static inline void ocelot_drain_cpu_queue(struct ocelot *ocelot, int grp)
785 {
786 }
787 
788 static inline u32 ocelot_ptp_rew_op(struct sk_buff *skb)
789 {
790 	return 0;
791 }
792 #endif
793 
794 /* Hardware initialization */
795 int ocelot_regfields_init(struct ocelot *ocelot,
796 			  const struct reg_field *const regfields);
797 struct regmap *ocelot_regmap_init(struct ocelot *ocelot, struct resource *res);
798 int ocelot_init(struct ocelot *ocelot);
799 void ocelot_deinit(struct ocelot *ocelot);
800 void ocelot_init_port(struct ocelot *ocelot, int port);
801 void ocelot_deinit_port(struct ocelot *ocelot, int port);
802 
803 /* DSA callbacks */
804 void ocelot_get_strings(struct ocelot *ocelot, int port, u32 sset, u8 *data);
805 void ocelot_get_ethtool_stats(struct ocelot *ocelot, int port, u64 *data);
806 int ocelot_get_sset_count(struct ocelot *ocelot, int port, int sset);
807 int ocelot_get_ts_info(struct ocelot *ocelot, int port,
808 		       struct ethtool_ts_info *info);
809 void ocelot_set_ageing_time(struct ocelot *ocelot, unsigned int msecs);
810 int ocelot_port_vlan_filtering(struct ocelot *ocelot, int port, bool enabled,
811 			       struct netlink_ext_ack *extack);
812 void ocelot_bridge_stp_state_set(struct ocelot *ocelot, int port, u8 state);
813 void ocelot_apply_bridge_fwd_mask(struct ocelot *ocelot);
814 int ocelot_port_pre_bridge_flags(struct ocelot *ocelot, int port,
815 				 struct switchdev_brport_flags val);
816 void ocelot_port_bridge_flags(struct ocelot *ocelot, int port,
817 			      struct switchdev_brport_flags val);
818 void ocelot_port_bridge_join(struct ocelot *ocelot, int port,
819 			     struct net_device *bridge);
820 void ocelot_port_bridge_leave(struct ocelot *ocelot, int port,
821 			      struct net_device *bridge);
822 int ocelot_fdb_dump(struct ocelot *ocelot, int port,
823 		    dsa_fdb_dump_cb_t *cb, void *data);
824 int ocelot_fdb_add(struct ocelot *ocelot, int port,
825 		   const unsigned char *addr, u16 vid);
826 int ocelot_fdb_del(struct ocelot *ocelot, int port,
827 		   const unsigned char *addr, u16 vid);
828 int ocelot_vlan_prepare(struct ocelot *ocelot, int port, u16 vid, bool pvid,
829 			bool untagged, struct netlink_ext_ack *extack);
830 int ocelot_vlan_add(struct ocelot *ocelot, int port, u16 vid, bool pvid,
831 		    bool untagged);
832 int ocelot_vlan_del(struct ocelot *ocelot, int port, u16 vid);
833 int ocelot_hwstamp_get(struct ocelot *ocelot, int port, struct ifreq *ifr);
834 int ocelot_hwstamp_set(struct ocelot *ocelot, int port, struct ifreq *ifr);
835 int ocelot_port_txtstamp_request(struct ocelot *ocelot, int port,
836 				 struct sk_buff *skb,
837 				 struct sk_buff **clone);
838 void ocelot_get_txtstamp(struct ocelot *ocelot);
839 void ocelot_port_set_maxlen(struct ocelot *ocelot, int port, size_t sdu);
840 int ocelot_get_max_mtu(struct ocelot *ocelot, int port);
841 int ocelot_port_policer_add(struct ocelot *ocelot, int port,
842 			    struct ocelot_policer *pol);
843 int ocelot_port_policer_del(struct ocelot *ocelot, int port);
844 int ocelot_cls_flower_replace(struct ocelot *ocelot, int port,
845 			      struct flow_cls_offload *f, bool ingress);
846 int ocelot_cls_flower_destroy(struct ocelot *ocelot, int port,
847 			      struct flow_cls_offload *f, bool ingress);
848 int ocelot_cls_flower_stats(struct ocelot *ocelot, int port,
849 			    struct flow_cls_offload *f, bool ingress);
850 int ocelot_port_mdb_add(struct ocelot *ocelot, int port,
851 			const struct switchdev_obj_port_mdb *mdb);
852 int ocelot_port_mdb_del(struct ocelot *ocelot, int port,
853 			const struct switchdev_obj_port_mdb *mdb);
854 int ocelot_port_lag_join(struct ocelot *ocelot, int port,
855 			 struct net_device *bond,
856 			 struct netdev_lag_upper_info *info);
857 void ocelot_port_lag_leave(struct ocelot *ocelot, int port,
858 			   struct net_device *bond);
859 void ocelot_port_lag_change(struct ocelot *ocelot, int port, bool lag_tx_active);
860 
861 int ocelot_devlink_sb_register(struct ocelot *ocelot);
862 void ocelot_devlink_sb_unregister(struct ocelot *ocelot);
863 int ocelot_sb_pool_get(struct ocelot *ocelot, unsigned int sb_index,
864 		       u16 pool_index,
865 		       struct devlink_sb_pool_info *pool_info);
866 int ocelot_sb_pool_set(struct ocelot *ocelot, unsigned int sb_index,
867 		       u16 pool_index, u32 size,
868 		       enum devlink_sb_threshold_type threshold_type,
869 		       struct netlink_ext_ack *extack);
870 int ocelot_sb_port_pool_get(struct ocelot *ocelot, int port,
871 			    unsigned int sb_index, u16 pool_index,
872 			    u32 *p_threshold);
873 int ocelot_sb_port_pool_set(struct ocelot *ocelot, int port,
874 			    unsigned int sb_index, u16 pool_index,
875 			    u32 threshold, struct netlink_ext_ack *extack);
876 int ocelot_sb_tc_pool_bind_get(struct ocelot *ocelot, int port,
877 			       unsigned int sb_index, u16 tc_index,
878 			       enum devlink_sb_pool_type pool_type,
879 			       u16 *p_pool_index, u32 *p_threshold);
880 int ocelot_sb_tc_pool_bind_set(struct ocelot *ocelot, int port,
881 			       unsigned int sb_index, u16 tc_index,
882 			       enum devlink_sb_pool_type pool_type,
883 			       u16 pool_index, u32 threshold,
884 			       struct netlink_ext_ack *extack);
885 int ocelot_sb_occ_snapshot(struct ocelot *ocelot, unsigned int sb_index);
886 int ocelot_sb_occ_max_clear(struct ocelot *ocelot, unsigned int sb_index);
887 int ocelot_sb_occ_port_pool_get(struct ocelot *ocelot, int port,
888 				unsigned int sb_index, u16 pool_index,
889 				u32 *p_cur, u32 *p_max);
890 int ocelot_sb_occ_tc_port_bind_get(struct ocelot *ocelot, int port,
891 				   unsigned int sb_index, u16 tc_index,
892 				   enum devlink_sb_pool_type pool_type,
893 				   u32 *p_cur, u32 *p_max);
894 
895 void ocelot_phylink_mac_link_down(struct ocelot *ocelot, int port,
896 				  unsigned int link_an_mode,
897 				  phy_interface_t interface,
898 				  unsigned long quirks);
899 void ocelot_phylink_mac_link_up(struct ocelot *ocelot, int port,
900 				struct phy_device *phydev,
901 				unsigned int link_an_mode,
902 				phy_interface_t interface,
903 				int speed, int duplex,
904 				bool tx_pause, bool rx_pause,
905 				unsigned long quirks);
906 
907 #if IS_ENABLED(CONFIG_BRIDGE_MRP)
908 int ocelot_mrp_add(struct ocelot *ocelot, int port,
909 		   const struct switchdev_obj_mrp *mrp);
910 int ocelot_mrp_del(struct ocelot *ocelot, int port,
911 		   const struct switchdev_obj_mrp *mrp);
912 int ocelot_mrp_add_ring_role(struct ocelot *ocelot, int port,
913 			     const struct switchdev_obj_ring_role_mrp *mrp);
914 int ocelot_mrp_del_ring_role(struct ocelot *ocelot, int port,
915 			     const struct switchdev_obj_ring_role_mrp *mrp);
916 #else
917 static inline int ocelot_mrp_add(struct ocelot *ocelot, int port,
918 				 const struct switchdev_obj_mrp *mrp)
919 {
920 	return -EOPNOTSUPP;
921 }
922 
923 static inline int ocelot_mrp_del(struct ocelot *ocelot, int port,
924 				 const struct switchdev_obj_mrp *mrp)
925 {
926 	return -EOPNOTSUPP;
927 }
928 
929 static inline int
930 ocelot_mrp_add_ring_role(struct ocelot *ocelot, int port,
931 			 const struct switchdev_obj_ring_role_mrp *mrp)
932 {
933 	return -EOPNOTSUPP;
934 }
935 
936 static inline int
937 ocelot_mrp_del_ring_role(struct ocelot *ocelot, int port,
938 			 const struct switchdev_obj_ring_role_mrp *mrp)
939 {
940 	return -EOPNOTSUPP;
941 }
942 #endif
943 
944 #endif
945