xref: /linux/include/net/dsa.h (revision a3a02a52bcfcbcc4a637d4b68bf1bc391c9fad02)
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  * include/net/dsa.h - Driver for Distributed Switch Architecture switch chips
4  * Copyright (c) 2008-2009 Marvell Semiconductor
5  */
6 
7 #ifndef __LINUX_NET_DSA_H
8 #define __LINUX_NET_DSA_H
9 
10 #include <linux/if.h>
11 #include <linux/if_ether.h>
12 #include <linux/list.h>
13 #include <linux/notifier.h>
14 #include <linux/timer.h>
15 #include <linux/workqueue.h>
16 #include <linux/of.h>
17 #include <linux/ethtool.h>
18 #include <linux/net_tstamp.h>
19 #include <linux/phy.h>
20 #include <linux/platform_data/dsa.h>
21 #include <linux/phylink.h>
22 #include <net/devlink.h>
23 #include <net/switchdev.h>
24 
25 struct dsa_8021q_context;
26 struct tc_action;
27 
28 #define DSA_TAG_PROTO_NONE_VALUE		0
29 #define DSA_TAG_PROTO_BRCM_VALUE		1
30 #define DSA_TAG_PROTO_BRCM_PREPEND_VALUE	2
31 #define DSA_TAG_PROTO_DSA_VALUE			3
32 #define DSA_TAG_PROTO_EDSA_VALUE		4
33 #define DSA_TAG_PROTO_GSWIP_VALUE		5
34 #define DSA_TAG_PROTO_KSZ9477_VALUE		6
35 #define DSA_TAG_PROTO_KSZ9893_VALUE		7
36 #define DSA_TAG_PROTO_LAN9303_VALUE		8
37 #define DSA_TAG_PROTO_MTK_VALUE			9
38 #define DSA_TAG_PROTO_QCA_VALUE			10
39 #define DSA_TAG_PROTO_TRAILER_VALUE		11
40 #define DSA_TAG_PROTO_8021Q_VALUE		12
41 #define DSA_TAG_PROTO_SJA1105_VALUE		13
42 #define DSA_TAG_PROTO_KSZ8795_VALUE		14
43 #define DSA_TAG_PROTO_OCELOT_VALUE		15
44 #define DSA_TAG_PROTO_AR9331_VALUE		16
45 #define DSA_TAG_PROTO_RTL4_A_VALUE		17
46 #define DSA_TAG_PROTO_HELLCREEK_VALUE		18
47 #define DSA_TAG_PROTO_XRS700X_VALUE		19
48 #define DSA_TAG_PROTO_OCELOT_8021Q_VALUE	20
49 #define DSA_TAG_PROTO_SEVILLE_VALUE		21
50 #define DSA_TAG_PROTO_BRCM_LEGACY_VALUE		22
51 #define DSA_TAG_PROTO_SJA1110_VALUE		23
52 #define DSA_TAG_PROTO_RTL8_4_VALUE		24
53 #define DSA_TAG_PROTO_RTL8_4T_VALUE		25
54 #define DSA_TAG_PROTO_RZN1_A5PSW_VALUE		26
55 #define DSA_TAG_PROTO_LAN937X_VALUE		27
56 #define DSA_TAG_PROTO_VSC73XX_8021Q_VALUE	28
57 
58 enum dsa_tag_protocol {
59 	DSA_TAG_PROTO_NONE		= DSA_TAG_PROTO_NONE_VALUE,
60 	DSA_TAG_PROTO_BRCM		= DSA_TAG_PROTO_BRCM_VALUE,
61 	DSA_TAG_PROTO_BRCM_LEGACY	= DSA_TAG_PROTO_BRCM_LEGACY_VALUE,
62 	DSA_TAG_PROTO_BRCM_PREPEND	= DSA_TAG_PROTO_BRCM_PREPEND_VALUE,
63 	DSA_TAG_PROTO_DSA		= DSA_TAG_PROTO_DSA_VALUE,
64 	DSA_TAG_PROTO_EDSA		= DSA_TAG_PROTO_EDSA_VALUE,
65 	DSA_TAG_PROTO_GSWIP		= DSA_TAG_PROTO_GSWIP_VALUE,
66 	DSA_TAG_PROTO_KSZ9477		= DSA_TAG_PROTO_KSZ9477_VALUE,
67 	DSA_TAG_PROTO_KSZ9893		= DSA_TAG_PROTO_KSZ9893_VALUE,
68 	DSA_TAG_PROTO_LAN9303		= DSA_TAG_PROTO_LAN9303_VALUE,
69 	DSA_TAG_PROTO_MTK		= DSA_TAG_PROTO_MTK_VALUE,
70 	DSA_TAG_PROTO_QCA		= DSA_TAG_PROTO_QCA_VALUE,
71 	DSA_TAG_PROTO_TRAILER		= DSA_TAG_PROTO_TRAILER_VALUE,
72 	DSA_TAG_PROTO_8021Q		= DSA_TAG_PROTO_8021Q_VALUE,
73 	DSA_TAG_PROTO_SJA1105		= DSA_TAG_PROTO_SJA1105_VALUE,
74 	DSA_TAG_PROTO_KSZ8795		= DSA_TAG_PROTO_KSZ8795_VALUE,
75 	DSA_TAG_PROTO_OCELOT		= DSA_TAG_PROTO_OCELOT_VALUE,
76 	DSA_TAG_PROTO_AR9331		= DSA_TAG_PROTO_AR9331_VALUE,
77 	DSA_TAG_PROTO_RTL4_A		= DSA_TAG_PROTO_RTL4_A_VALUE,
78 	DSA_TAG_PROTO_HELLCREEK		= DSA_TAG_PROTO_HELLCREEK_VALUE,
79 	DSA_TAG_PROTO_XRS700X		= DSA_TAG_PROTO_XRS700X_VALUE,
80 	DSA_TAG_PROTO_OCELOT_8021Q	= DSA_TAG_PROTO_OCELOT_8021Q_VALUE,
81 	DSA_TAG_PROTO_SEVILLE		= DSA_TAG_PROTO_SEVILLE_VALUE,
82 	DSA_TAG_PROTO_SJA1110		= DSA_TAG_PROTO_SJA1110_VALUE,
83 	DSA_TAG_PROTO_RTL8_4		= DSA_TAG_PROTO_RTL8_4_VALUE,
84 	DSA_TAG_PROTO_RTL8_4T		= DSA_TAG_PROTO_RTL8_4T_VALUE,
85 	DSA_TAG_PROTO_RZN1_A5PSW	= DSA_TAG_PROTO_RZN1_A5PSW_VALUE,
86 	DSA_TAG_PROTO_LAN937X		= DSA_TAG_PROTO_LAN937X_VALUE,
87 	DSA_TAG_PROTO_VSC73XX_8021Q	= DSA_TAG_PROTO_VSC73XX_8021Q_VALUE,
88 };
89 
90 struct dsa_switch;
91 
92 struct dsa_device_ops {
93 	struct sk_buff *(*xmit)(struct sk_buff *skb, struct net_device *dev);
94 	struct sk_buff *(*rcv)(struct sk_buff *skb, struct net_device *dev);
95 	void (*flow_dissect)(const struct sk_buff *skb, __be16 *proto,
96 			     int *offset);
97 	int (*connect)(struct dsa_switch *ds);
98 	void (*disconnect)(struct dsa_switch *ds);
99 	unsigned int needed_headroom;
100 	unsigned int needed_tailroom;
101 	const char *name;
102 	enum dsa_tag_protocol proto;
103 	/* Some tagging protocols either mangle or shift the destination MAC
104 	 * address, in which case the DSA conduit would drop packets on ingress
105 	 * if what it understands out of the destination MAC address is not in
106 	 * its RX filter.
107 	 */
108 	bool promisc_on_conduit;
109 };
110 
111 struct dsa_lag {
112 	struct net_device *dev;
113 	unsigned int id;
114 	struct mutex fdb_lock;
115 	struct list_head fdbs;
116 	refcount_t refcount;
117 };
118 
119 struct dsa_switch_tree {
120 	struct list_head	list;
121 
122 	/* List of switch ports */
123 	struct list_head ports;
124 
125 	/* Notifier chain for switch-wide events */
126 	struct raw_notifier_head	nh;
127 
128 	/* Tree identifier */
129 	unsigned int index;
130 
131 	/* Number of switches attached to this tree */
132 	struct kref refcount;
133 
134 	/* Maps offloaded LAG netdevs to a zero-based linear ID for
135 	 * drivers that need it.
136 	 */
137 	struct dsa_lag **lags;
138 
139 	/* Tagging protocol operations */
140 	const struct dsa_device_ops *tag_ops;
141 
142 	/* Default tagging protocol preferred by the switches in this
143 	 * tree.
144 	 */
145 	enum dsa_tag_protocol default_proto;
146 
147 	/* Has this tree been applied to the hardware? */
148 	bool setup;
149 
150 	/*
151 	 * Configuration data for the platform device that owns
152 	 * this dsa switch tree instance.
153 	 */
154 	struct dsa_platform_data	*pd;
155 
156 	/* List of DSA links composing the routing table */
157 	struct list_head rtable;
158 
159 	/* Length of "lags" array */
160 	unsigned int lags_len;
161 
162 	/* Track the largest switch index within a tree */
163 	unsigned int last_switch;
164 };
165 
166 /* LAG IDs are one-based, the dst->lags array is zero-based */
167 #define dsa_lags_foreach_id(_id, _dst)				\
168 	for ((_id) = 1; (_id) <= (_dst)->lags_len; (_id)++)	\
169 		if ((_dst)->lags[(_id) - 1])
170 
171 #define dsa_lag_foreach_port(_dp, _dst, _lag)			\
172 	list_for_each_entry((_dp), &(_dst)->ports, list)	\
173 		if (dsa_port_offloads_lag((_dp), (_lag)))
174 
175 #define dsa_hsr_foreach_port(_dp, _ds, _hsr)			\
176 	list_for_each_entry((_dp), &(_ds)->dst->ports, list)	\
177 		if ((_dp)->ds == (_ds) && (_dp)->hsr_dev == (_hsr))
178 
179 static inline struct dsa_lag *dsa_lag_by_id(struct dsa_switch_tree *dst,
180 					    unsigned int id)
181 {
182 	/* DSA LAG IDs are one-based, dst->lags is zero-based */
183 	return dst->lags[id - 1];
184 }
185 
186 static inline int dsa_lag_id(struct dsa_switch_tree *dst,
187 			     struct net_device *lag_dev)
188 {
189 	unsigned int id;
190 
191 	dsa_lags_foreach_id(id, dst) {
192 		struct dsa_lag *lag = dsa_lag_by_id(dst, id);
193 
194 		if (lag->dev == lag_dev)
195 			return lag->id;
196 	}
197 
198 	return -ENODEV;
199 }
200 
201 /* TC matchall action types */
202 enum dsa_port_mall_action_type {
203 	DSA_PORT_MALL_MIRROR,
204 	DSA_PORT_MALL_POLICER,
205 };
206 
207 /* TC mirroring entry */
208 struct dsa_mall_mirror_tc_entry {
209 	u8 to_local_port;
210 	bool ingress;
211 };
212 
213 /* TC port policer entry */
214 struct dsa_mall_policer_tc_entry {
215 	u32 burst;
216 	u64 rate_bytes_per_sec;
217 };
218 
219 /* TC matchall entry */
220 struct dsa_mall_tc_entry {
221 	struct list_head list;
222 	unsigned long cookie;
223 	enum dsa_port_mall_action_type type;
224 	union {
225 		struct dsa_mall_mirror_tc_entry mirror;
226 		struct dsa_mall_policer_tc_entry policer;
227 	};
228 };
229 
230 struct dsa_bridge {
231 	struct net_device *dev;
232 	unsigned int num;
233 	bool tx_fwd_offload;
234 	refcount_t refcount;
235 };
236 
237 struct dsa_port {
238 	/* A CPU port is physically connected to a conduit device. A user port
239 	 * exposes a network device to user-space, called 'user' here.
240 	 */
241 	union {
242 		struct net_device *conduit;
243 		struct net_device *user;
244 	};
245 
246 	/* Copy of the tagging protocol operations, for quicker access
247 	 * in the data path. Valid only for the CPU ports.
248 	 */
249 	const struct dsa_device_ops *tag_ops;
250 
251 	/* Copies for faster access in conduit receive hot path */
252 	struct dsa_switch_tree *dst;
253 	struct sk_buff *(*rcv)(struct sk_buff *skb, struct net_device *dev);
254 
255 	struct dsa_switch	*ds;
256 
257 	unsigned int		index;
258 
259 	enum {
260 		DSA_PORT_TYPE_UNUSED = 0,
261 		DSA_PORT_TYPE_CPU,
262 		DSA_PORT_TYPE_DSA,
263 		DSA_PORT_TYPE_USER,
264 	} type;
265 
266 	const char		*name;
267 	struct dsa_port		*cpu_dp;
268 	u8			mac[ETH_ALEN];
269 
270 	u8			stp_state;
271 
272 	/* Warning: the following bit fields are not atomic, and updating them
273 	 * can only be done from code paths where concurrency is not possible
274 	 * (probe time or under rtnl_lock).
275 	 */
276 	u8			vlan_filtering:1;
277 
278 	/* Managed by DSA on user ports and by drivers on CPU and DSA ports */
279 	u8			learning:1;
280 
281 	u8			lag_tx_enabled:1;
282 
283 	/* conduit state bits, valid only on CPU ports */
284 	u8			conduit_admin_up:1;
285 	u8			conduit_oper_up:1;
286 
287 	/* Valid only on user ports */
288 	u8			cpu_port_in_lag:1;
289 
290 	u8			setup:1;
291 
292 	struct device_node	*dn;
293 	unsigned int		ageing_time;
294 
295 	struct dsa_bridge	*bridge;
296 	struct devlink_port	devlink_port;
297 	struct phylink		*pl;
298 	struct phylink_config	pl_config;
299 	struct dsa_lag		*lag;
300 	struct net_device	*hsr_dev;
301 
302 	struct list_head list;
303 
304 	/*
305 	 * Original copy of the conduit netdev ethtool_ops
306 	 */
307 	const struct ethtool_ops *orig_ethtool_ops;
308 
309 	/* List of MAC addresses that must be forwarded on this port.
310 	 * These are only valid on CPU ports and DSA links.
311 	 */
312 	struct mutex		addr_lists_lock;
313 	struct list_head	fdbs;
314 	struct list_head	mdbs;
315 
316 	struct mutex		vlans_lock;
317 	union {
318 		/* List of VLANs that CPU and DSA ports are members of.
319 		 * Access to this is serialized by the sleepable @vlans_lock.
320 		 */
321 		struct list_head	vlans;
322 		/* List of VLANs that user ports are members of.
323 		 * Access to this is serialized by netif_addr_lock_bh().
324 		 */
325 		struct list_head	user_vlans;
326 	};
327 };
328 
329 static inline struct dsa_port *
330 dsa_phylink_to_port(struct phylink_config *config)
331 {
332 	return container_of(config, struct dsa_port, pl_config);
333 }
334 
335 /* TODO: ideally DSA ports would have a single dp->link_dp member,
336  * and no dst->rtable nor this struct dsa_link would be needed,
337  * but this would require some more complex tree walking,
338  * so keep it stupid at the moment and list them all.
339  */
340 struct dsa_link {
341 	struct dsa_port *dp;
342 	struct dsa_port *link_dp;
343 	struct list_head list;
344 };
345 
346 enum dsa_db_type {
347 	DSA_DB_PORT,
348 	DSA_DB_LAG,
349 	DSA_DB_BRIDGE,
350 };
351 
352 struct dsa_db {
353 	enum dsa_db_type type;
354 
355 	union {
356 		const struct dsa_port *dp;
357 		struct dsa_lag lag;
358 		struct dsa_bridge bridge;
359 	};
360 };
361 
362 struct dsa_mac_addr {
363 	unsigned char addr[ETH_ALEN];
364 	u16 vid;
365 	refcount_t refcount;
366 	struct list_head list;
367 	struct dsa_db db;
368 };
369 
370 struct dsa_vlan {
371 	u16 vid;
372 	refcount_t refcount;
373 	struct list_head list;
374 };
375 
376 struct dsa_switch {
377 	struct device *dev;
378 
379 	/*
380 	 * Parent switch tree, and switch index.
381 	 */
382 	struct dsa_switch_tree	*dst;
383 	unsigned int		index;
384 
385 	/* Warning: the following bit fields are not atomic, and updating them
386 	 * can only be done from code paths where concurrency is not possible
387 	 * (probe time or under rtnl_lock).
388 	 */
389 	u32			setup:1;
390 
391 	/* Disallow bridge core from requesting different VLAN awareness
392 	 * settings on ports if not hardware-supported
393 	 */
394 	u32			vlan_filtering_is_global:1;
395 
396 	/* Keep VLAN filtering enabled on ports not offloading any upper */
397 	u32			needs_standalone_vlan_filtering:1;
398 
399 	/* Pass .port_vlan_add and .port_vlan_del to drivers even for bridges
400 	 * that have vlan_filtering=0. All drivers should ideally set this (and
401 	 * then the option would get removed), but it is unknown whether this
402 	 * would break things or not.
403 	 */
404 	u32			configure_vlan_while_not_filtering:1;
405 
406 	/* If the switch driver always programs the CPU port as egress tagged
407 	 * despite the VLAN configuration indicating otherwise, then setting
408 	 * @untag_bridge_pvid will force the DSA receive path to pop the
409 	 * bridge's default_pvid VLAN tagged frames to offer a consistent
410 	 * behavior between a vlan_filtering=0 and vlan_filtering=1 bridge
411 	 * device.
412 	 */
413 	u32			untag_bridge_pvid:1;
414 
415 	/* Let DSA manage the FDB entries towards the
416 	 * CPU, based on the software bridge database.
417 	 */
418 	u32			assisted_learning_on_cpu_port:1;
419 
420 	/* In case vlan_filtering_is_global is set, the VLAN awareness state
421 	 * should be retrieved from here and not from the per-port settings.
422 	 */
423 	u32			vlan_filtering:1;
424 
425 	/* For switches that only have the MRU configurable. To ensure the
426 	 * configured MTU is not exceeded, normalization of MRU on all bridged
427 	 * interfaces is needed.
428 	 */
429 	u32			mtu_enforcement_ingress:1;
430 
431 	/* Drivers that isolate the FDBs of multiple bridges must set this
432 	 * to true to receive the bridge as an argument in .port_fdb_{add,del}
433 	 * and .port_mdb_{add,del}. Otherwise, the bridge.num will always be
434 	 * passed as zero.
435 	 */
436 	u32			fdb_isolation:1;
437 
438 	/* Drivers that have global DSCP mapping settings must set this to
439 	 * true to automatically apply the settings to all ports.
440 	 */
441 	u32			dscp_prio_mapping_is_global:1;
442 
443 	/* Listener for switch fabric events */
444 	struct notifier_block	nb;
445 
446 	/*
447 	 * Give the switch driver somewhere to hang its private data
448 	 * structure.
449 	 */
450 	void *priv;
451 
452 	void *tagger_data;
453 
454 	/*
455 	 * Configuration data for this switch.
456 	 */
457 	struct dsa_chip_data	*cd;
458 
459 	/*
460 	 * The switch operations.
461 	 */
462 	const struct dsa_switch_ops	*ops;
463 
464 	/*
465 	 * Allow a DSA switch driver to override the phylink MAC ops
466 	 */
467 	const struct phylink_mac_ops	*phylink_mac_ops;
468 
469 	/*
470 	 * User mii_bus and devices for the individual ports.
471 	 */
472 	u32			phys_mii_mask;
473 	struct mii_bus		*user_mii_bus;
474 
475 	/* Ageing Time limits in msecs */
476 	unsigned int ageing_time_min;
477 	unsigned int ageing_time_max;
478 
479 	/* Storage for drivers using tag_8021q */
480 	struct dsa_8021q_context *tag_8021q_ctx;
481 
482 	/* devlink used to represent this switch device */
483 	struct devlink		*devlink;
484 
485 	/* Number of switch port queues */
486 	unsigned int		num_tx_queues;
487 
488 	/* Drivers that benefit from having an ID associated with each
489 	 * offloaded LAG should set this to the maximum number of
490 	 * supported IDs. DSA will then maintain a mapping of _at
491 	 * least_ these many IDs, accessible to drivers via
492 	 * dsa_lag_id().
493 	 */
494 	unsigned int		num_lag_ids;
495 
496 	/* Drivers that support bridge forwarding offload or FDB isolation
497 	 * should set this to the maximum number of bridges spanning the same
498 	 * switch tree (or all trees, in the case of cross-tree bridging
499 	 * support) that can be offloaded.
500 	 */
501 	unsigned int		max_num_bridges;
502 
503 	unsigned int		num_ports;
504 };
505 
506 static inline struct dsa_port *dsa_to_port(struct dsa_switch *ds, int p)
507 {
508 	struct dsa_switch_tree *dst = ds->dst;
509 	struct dsa_port *dp;
510 
511 	list_for_each_entry(dp, &dst->ports, list)
512 		if (dp->ds == ds && dp->index == p)
513 			return dp;
514 
515 	return NULL;
516 }
517 
518 static inline bool dsa_port_is_dsa(struct dsa_port *port)
519 {
520 	return port->type == DSA_PORT_TYPE_DSA;
521 }
522 
523 static inline bool dsa_port_is_cpu(struct dsa_port *port)
524 {
525 	return port->type == DSA_PORT_TYPE_CPU;
526 }
527 
528 static inline bool dsa_port_is_user(struct dsa_port *dp)
529 {
530 	return dp->type == DSA_PORT_TYPE_USER;
531 }
532 
533 static inline bool dsa_port_is_unused(struct dsa_port *dp)
534 {
535 	return dp->type == DSA_PORT_TYPE_UNUSED;
536 }
537 
538 static inline bool dsa_port_conduit_is_operational(struct dsa_port *dp)
539 {
540 	return dsa_port_is_cpu(dp) && dp->conduit_admin_up &&
541 	       dp->conduit_oper_up;
542 }
543 
544 static inline bool dsa_is_unused_port(struct dsa_switch *ds, int p)
545 {
546 	return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_UNUSED;
547 }
548 
549 static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p)
550 {
551 	return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_CPU;
552 }
553 
554 static inline bool dsa_is_dsa_port(struct dsa_switch *ds, int p)
555 {
556 	return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_DSA;
557 }
558 
559 static inline bool dsa_is_user_port(struct dsa_switch *ds, int p)
560 {
561 	return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_USER;
562 }
563 
564 #define dsa_tree_for_each_user_port(_dp, _dst) \
565 	list_for_each_entry((_dp), &(_dst)->ports, list) \
566 		if (dsa_port_is_user((_dp)))
567 
568 #define dsa_tree_for_each_user_port_continue_reverse(_dp, _dst) \
569 	list_for_each_entry_continue_reverse((_dp), &(_dst)->ports, list) \
570 		if (dsa_port_is_user((_dp)))
571 
572 #define dsa_tree_for_each_cpu_port(_dp, _dst) \
573 	list_for_each_entry((_dp), &(_dst)->ports, list) \
574 		if (dsa_port_is_cpu((_dp)))
575 
576 #define dsa_switch_for_each_port(_dp, _ds) \
577 	list_for_each_entry((_dp), &(_ds)->dst->ports, list) \
578 		if ((_dp)->ds == (_ds))
579 
580 #define dsa_switch_for_each_port_safe(_dp, _next, _ds) \
581 	list_for_each_entry_safe((_dp), (_next), &(_ds)->dst->ports, list) \
582 		if ((_dp)->ds == (_ds))
583 
584 #define dsa_switch_for_each_port_continue_reverse(_dp, _ds) \
585 	list_for_each_entry_continue_reverse((_dp), &(_ds)->dst->ports, list) \
586 		if ((_dp)->ds == (_ds))
587 
588 #define dsa_switch_for_each_available_port(_dp, _ds) \
589 	dsa_switch_for_each_port((_dp), (_ds)) \
590 		if (!dsa_port_is_unused((_dp)))
591 
592 #define dsa_switch_for_each_user_port(_dp, _ds) \
593 	dsa_switch_for_each_port((_dp), (_ds)) \
594 		if (dsa_port_is_user((_dp)))
595 
596 #define dsa_switch_for_each_user_port_continue_reverse(_dp, _ds) \
597 	dsa_switch_for_each_port_continue_reverse((_dp), (_ds)) \
598 		if (dsa_port_is_user((_dp)))
599 
600 #define dsa_switch_for_each_cpu_port(_dp, _ds) \
601 	dsa_switch_for_each_port((_dp), (_ds)) \
602 		if (dsa_port_is_cpu((_dp)))
603 
604 #define dsa_switch_for_each_cpu_port_continue_reverse(_dp, _ds) \
605 	dsa_switch_for_each_port_continue_reverse((_dp), (_ds)) \
606 		if (dsa_port_is_cpu((_dp)))
607 
608 static inline u32 dsa_user_ports(struct dsa_switch *ds)
609 {
610 	struct dsa_port *dp;
611 	u32 mask = 0;
612 
613 	dsa_switch_for_each_user_port(dp, ds)
614 		mask |= BIT(dp->index);
615 
616 	return mask;
617 }
618 
619 static inline u32 dsa_cpu_ports(struct dsa_switch *ds)
620 {
621 	struct dsa_port *cpu_dp;
622 	u32 mask = 0;
623 
624 	dsa_switch_for_each_cpu_port(cpu_dp, ds)
625 		mask |= BIT(cpu_dp->index);
626 
627 	return mask;
628 }
629 
630 /* Return the local port used to reach an arbitrary switch device */
631 static inline unsigned int dsa_routing_port(struct dsa_switch *ds, int device)
632 {
633 	struct dsa_switch_tree *dst = ds->dst;
634 	struct dsa_link *dl;
635 
636 	list_for_each_entry(dl, &dst->rtable, list)
637 		if (dl->dp->ds == ds && dl->link_dp->ds->index == device)
638 			return dl->dp->index;
639 
640 	return ds->num_ports;
641 }
642 
643 /* Return the local port used to reach an arbitrary switch port */
644 static inline unsigned int dsa_towards_port(struct dsa_switch *ds, int device,
645 					    int port)
646 {
647 	if (device == ds->index)
648 		return port;
649 	else
650 		return dsa_routing_port(ds, device);
651 }
652 
653 /* Return the local port used to reach the dedicated CPU port */
654 static inline unsigned int dsa_upstream_port(struct dsa_switch *ds, int port)
655 {
656 	const struct dsa_port *dp = dsa_to_port(ds, port);
657 	const struct dsa_port *cpu_dp = dp->cpu_dp;
658 
659 	if (!cpu_dp)
660 		return port;
661 
662 	return dsa_towards_port(ds, cpu_dp->ds->index, cpu_dp->index);
663 }
664 
665 /* Return true if this is the local port used to reach the CPU port */
666 static inline bool dsa_is_upstream_port(struct dsa_switch *ds, int port)
667 {
668 	if (dsa_is_unused_port(ds, port))
669 		return false;
670 
671 	return port == dsa_upstream_port(ds, port);
672 }
673 
674 /* Return true if this is a DSA port leading away from the CPU */
675 static inline bool dsa_is_downstream_port(struct dsa_switch *ds, int port)
676 {
677 	return dsa_is_dsa_port(ds, port) && !dsa_is_upstream_port(ds, port);
678 }
679 
680 /* Return the local port used to reach the CPU port */
681 static inline unsigned int dsa_switch_upstream_port(struct dsa_switch *ds)
682 {
683 	struct dsa_port *dp;
684 
685 	dsa_switch_for_each_available_port(dp, ds) {
686 		return dsa_upstream_port(ds, dp->index);
687 	}
688 
689 	return ds->num_ports;
690 }
691 
692 /* Return true if @upstream_ds is an upstream switch of @downstream_ds, meaning
693  * that the routing port from @downstream_ds to @upstream_ds is also the port
694  * which @downstream_ds uses to reach its dedicated CPU.
695  */
696 static inline bool dsa_switch_is_upstream_of(struct dsa_switch *upstream_ds,
697 					     struct dsa_switch *downstream_ds)
698 {
699 	int routing_port;
700 
701 	if (upstream_ds == downstream_ds)
702 		return true;
703 
704 	routing_port = dsa_routing_port(downstream_ds, upstream_ds->index);
705 
706 	return dsa_is_upstream_port(downstream_ds, routing_port);
707 }
708 
709 static inline bool dsa_port_is_vlan_filtering(const struct dsa_port *dp)
710 {
711 	const struct dsa_switch *ds = dp->ds;
712 
713 	if (ds->vlan_filtering_is_global)
714 		return ds->vlan_filtering;
715 	else
716 		return dp->vlan_filtering;
717 }
718 
719 static inline unsigned int dsa_port_lag_id_get(struct dsa_port *dp)
720 {
721 	return dp->lag ? dp->lag->id : 0;
722 }
723 
724 static inline struct net_device *dsa_port_lag_dev_get(struct dsa_port *dp)
725 {
726 	return dp->lag ? dp->lag->dev : NULL;
727 }
728 
729 static inline bool dsa_port_offloads_lag(struct dsa_port *dp,
730 					 const struct dsa_lag *lag)
731 {
732 	return dsa_port_lag_dev_get(dp) == lag->dev;
733 }
734 
735 static inline struct net_device *dsa_port_to_conduit(const struct dsa_port *dp)
736 {
737 	if (dp->cpu_port_in_lag)
738 		return dsa_port_lag_dev_get(dp->cpu_dp);
739 
740 	return dp->cpu_dp->conduit;
741 }
742 
743 static inline
744 struct net_device *dsa_port_to_bridge_port(const struct dsa_port *dp)
745 {
746 	if (!dp->bridge)
747 		return NULL;
748 
749 	if (dp->lag)
750 		return dp->lag->dev;
751 	else if (dp->hsr_dev)
752 		return dp->hsr_dev;
753 
754 	return dp->user;
755 }
756 
757 static inline struct net_device *
758 dsa_port_bridge_dev_get(const struct dsa_port *dp)
759 {
760 	return dp->bridge ? dp->bridge->dev : NULL;
761 }
762 
763 static inline unsigned int dsa_port_bridge_num_get(struct dsa_port *dp)
764 {
765 	return dp->bridge ? dp->bridge->num : 0;
766 }
767 
768 static inline bool dsa_port_bridge_same(const struct dsa_port *a,
769 					const struct dsa_port *b)
770 {
771 	struct net_device *br_a = dsa_port_bridge_dev_get(a);
772 	struct net_device *br_b = dsa_port_bridge_dev_get(b);
773 
774 	/* Standalone ports are not in the same bridge with one another */
775 	return (!br_a || !br_b) ? false : (br_a == br_b);
776 }
777 
778 static inline bool dsa_port_offloads_bridge_port(struct dsa_port *dp,
779 						 const struct net_device *dev)
780 {
781 	return dsa_port_to_bridge_port(dp) == dev;
782 }
783 
784 static inline bool
785 dsa_port_offloads_bridge_dev(struct dsa_port *dp,
786 			     const struct net_device *bridge_dev)
787 {
788 	/* DSA ports connected to a bridge, and event was emitted
789 	 * for the bridge.
790 	 */
791 	return dsa_port_bridge_dev_get(dp) == bridge_dev;
792 }
793 
794 static inline bool dsa_port_offloads_bridge(struct dsa_port *dp,
795 					    const struct dsa_bridge *bridge)
796 {
797 	return dsa_port_bridge_dev_get(dp) == bridge->dev;
798 }
799 
800 /* Returns true if any port of this tree offloads the given net_device */
801 static inline bool dsa_tree_offloads_bridge_port(struct dsa_switch_tree *dst,
802 						 const struct net_device *dev)
803 {
804 	struct dsa_port *dp;
805 
806 	list_for_each_entry(dp, &dst->ports, list)
807 		if (dsa_port_offloads_bridge_port(dp, dev))
808 			return true;
809 
810 	return false;
811 }
812 
813 /* Returns true if any port of this tree offloads the given bridge */
814 static inline bool
815 dsa_tree_offloads_bridge_dev(struct dsa_switch_tree *dst,
816 			     const struct net_device *bridge_dev)
817 {
818 	struct dsa_port *dp;
819 
820 	list_for_each_entry(dp, &dst->ports, list)
821 		if (dsa_port_offloads_bridge_dev(dp, bridge_dev))
822 			return true;
823 
824 	return false;
825 }
826 
827 static inline bool dsa_port_tree_same(const struct dsa_port *a,
828 				      const struct dsa_port *b)
829 {
830 	return a->ds->dst == b->ds->dst;
831 }
832 
833 typedef int dsa_fdb_dump_cb_t(const unsigned char *addr, u16 vid,
834 			      bool is_static, void *data);
835 struct dsa_switch_ops {
836 	/*
837 	 * Tagging protocol helpers called for the CPU ports and DSA links.
838 	 * @get_tag_protocol retrieves the initial tagging protocol and is
839 	 * mandatory. Switches which can operate using multiple tagging
840 	 * protocols should implement @change_tag_protocol and report in
841 	 * @get_tag_protocol the tagger in current use.
842 	 */
843 	enum dsa_tag_protocol (*get_tag_protocol)(struct dsa_switch *ds,
844 						  int port,
845 						  enum dsa_tag_protocol mprot);
846 	int	(*change_tag_protocol)(struct dsa_switch *ds,
847 				       enum dsa_tag_protocol proto);
848 	/*
849 	 * Method for switch drivers to connect to the tagging protocol driver
850 	 * in current use. The switch driver can provide handlers for certain
851 	 * types of packets for switch management.
852 	 */
853 	int	(*connect_tag_protocol)(struct dsa_switch *ds,
854 					enum dsa_tag_protocol proto);
855 
856 	int	(*port_change_conduit)(struct dsa_switch *ds, int port,
857 				       struct net_device *conduit,
858 				       struct netlink_ext_ack *extack);
859 
860 	/* Optional switch-wide initialization and destruction methods */
861 	int	(*setup)(struct dsa_switch *ds);
862 	void	(*teardown)(struct dsa_switch *ds);
863 
864 	/* Per-port initialization and destruction methods. Mandatory if the
865 	 * driver registers devlink port regions, optional otherwise.
866 	 */
867 	int	(*port_setup)(struct dsa_switch *ds, int port);
868 	void	(*port_teardown)(struct dsa_switch *ds, int port);
869 
870 	u32	(*get_phy_flags)(struct dsa_switch *ds, int port);
871 
872 	/*
873 	 * Access to the switch's PHY registers.
874 	 */
875 	int	(*phy_read)(struct dsa_switch *ds, int port, int regnum);
876 	int	(*phy_write)(struct dsa_switch *ds, int port,
877 			     int regnum, u16 val);
878 
879 	/*
880 	 * PHYLINK integration
881 	 */
882 	void	(*phylink_get_caps)(struct dsa_switch *ds, int port,
883 				    struct phylink_config *config);
884 	struct phylink_pcs *(*phylink_mac_select_pcs)(struct dsa_switch *ds,
885 						      int port,
886 						      phy_interface_t iface);
887 	void	(*phylink_mac_config)(struct dsa_switch *ds, int port,
888 				      unsigned int mode,
889 				      const struct phylink_link_state *state);
890 	void	(*phylink_mac_link_down)(struct dsa_switch *ds, int port,
891 					 unsigned int mode,
892 					 phy_interface_t interface);
893 	void	(*phylink_mac_link_up)(struct dsa_switch *ds, int port,
894 				       unsigned int mode,
895 				       phy_interface_t interface,
896 				       struct phy_device *phydev,
897 				       int speed, int duplex,
898 				       bool tx_pause, bool rx_pause);
899 	void	(*phylink_fixed_state)(struct dsa_switch *ds, int port,
900 				       struct phylink_link_state *state);
901 	/*
902 	 * Port statistics counters.
903 	 */
904 	void	(*get_strings)(struct dsa_switch *ds, int port,
905 			       u32 stringset, uint8_t *data);
906 	void	(*get_ethtool_stats)(struct dsa_switch *ds,
907 				     int port, uint64_t *data);
908 	int	(*get_sset_count)(struct dsa_switch *ds, int port, int sset);
909 	void	(*get_ethtool_phy_stats)(struct dsa_switch *ds,
910 					 int port, uint64_t *data);
911 	void	(*get_eth_phy_stats)(struct dsa_switch *ds, int port,
912 				     struct ethtool_eth_phy_stats *phy_stats);
913 	void	(*get_eth_mac_stats)(struct dsa_switch *ds, int port,
914 				     struct ethtool_eth_mac_stats *mac_stats);
915 	void	(*get_eth_ctrl_stats)(struct dsa_switch *ds, int port,
916 				      struct ethtool_eth_ctrl_stats *ctrl_stats);
917 	void	(*get_rmon_stats)(struct dsa_switch *ds, int port,
918 				  struct ethtool_rmon_stats *rmon_stats,
919 				  const struct ethtool_rmon_hist_range **ranges);
920 	void	(*get_stats64)(struct dsa_switch *ds, int port,
921 				   struct rtnl_link_stats64 *s);
922 	void	(*get_pause_stats)(struct dsa_switch *ds, int port,
923 				   struct ethtool_pause_stats *pause_stats);
924 	void	(*self_test)(struct dsa_switch *ds, int port,
925 			     struct ethtool_test *etest, u64 *data);
926 
927 	/*
928 	 * ethtool Wake-on-LAN
929 	 */
930 	void	(*get_wol)(struct dsa_switch *ds, int port,
931 			   struct ethtool_wolinfo *w);
932 	int	(*set_wol)(struct dsa_switch *ds, int port,
933 			   struct ethtool_wolinfo *w);
934 
935 	/*
936 	 * ethtool timestamp info
937 	 */
938 	int	(*get_ts_info)(struct dsa_switch *ds, int port,
939 			       struct kernel_ethtool_ts_info *ts);
940 
941 	/*
942 	 * ethtool MAC merge layer
943 	 */
944 	int	(*get_mm)(struct dsa_switch *ds, int port,
945 			  struct ethtool_mm_state *state);
946 	int	(*set_mm)(struct dsa_switch *ds, int port,
947 			  struct ethtool_mm_cfg *cfg,
948 			  struct netlink_ext_ack *extack);
949 	void	(*get_mm_stats)(struct dsa_switch *ds, int port,
950 				struct ethtool_mm_stats *stats);
951 
952 	/*
953 	 * DCB ops
954 	 */
955 	int	(*port_get_default_prio)(struct dsa_switch *ds, int port);
956 	int	(*port_set_default_prio)(struct dsa_switch *ds, int port,
957 					 u8 prio);
958 	int	(*port_get_dscp_prio)(struct dsa_switch *ds, int port, u8 dscp);
959 	int	(*port_add_dscp_prio)(struct dsa_switch *ds, int port, u8 dscp,
960 				      u8 prio);
961 	int	(*port_del_dscp_prio)(struct dsa_switch *ds, int port, u8 dscp,
962 				      u8 prio);
963 	int	(*port_set_apptrust)(struct dsa_switch *ds, int port,
964 				     const u8 *sel, int nsel);
965 	int	(*port_get_apptrust)(struct dsa_switch *ds, int port, u8 *sel,
966 				     int *nsel);
967 
968 	/*
969 	 * Suspend and resume
970 	 */
971 	int	(*suspend)(struct dsa_switch *ds);
972 	int	(*resume)(struct dsa_switch *ds);
973 
974 	/*
975 	 * Port enable/disable
976 	 */
977 	int	(*port_enable)(struct dsa_switch *ds, int port,
978 			       struct phy_device *phy);
979 	void	(*port_disable)(struct dsa_switch *ds, int port);
980 
981 
982 	/*
983 	 * Notification for MAC address changes on user ports. Drivers can
984 	 * currently only veto operations. They should not use the method to
985 	 * program the hardware, since the operation is not rolled back in case
986 	 * of other errors.
987 	 */
988 	int	(*port_set_mac_address)(struct dsa_switch *ds, int port,
989 					const unsigned char *addr);
990 
991 	/*
992 	 * Compatibility between device trees defining multiple CPU ports and
993 	 * drivers which are not OK to use by default the numerically smallest
994 	 * CPU port of a switch for its local ports. This can return NULL,
995 	 * meaning "don't know/don't care".
996 	 */
997 	struct dsa_port *(*preferred_default_local_cpu_port)(struct dsa_switch *ds);
998 
999 	/*
1000 	 * Port's MAC EEE settings
1001 	 */
1002 	int	(*set_mac_eee)(struct dsa_switch *ds, int port,
1003 			       struct ethtool_keee *e);
1004 	int	(*get_mac_eee)(struct dsa_switch *ds, int port,
1005 			       struct ethtool_keee *e);
1006 
1007 	/* EEPROM access */
1008 	int	(*get_eeprom_len)(struct dsa_switch *ds);
1009 	int	(*get_eeprom)(struct dsa_switch *ds,
1010 			      struct ethtool_eeprom *eeprom, u8 *data);
1011 	int	(*set_eeprom)(struct dsa_switch *ds,
1012 			      struct ethtool_eeprom *eeprom, u8 *data);
1013 
1014 	/*
1015 	 * Register access.
1016 	 */
1017 	int	(*get_regs_len)(struct dsa_switch *ds, int port);
1018 	void	(*get_regs)(struct dsa_switch *ds, int port,
1019 			    struct ethtool_regs *regs, void *p);
1020 
1021 	/*
1022 	 * Upper device tracking.
1023 	 */
1024 	int	(*port_prechangeupper)(struct dsa_switch *ds, int port,
1025 				       struct netdev_notifier_changeupper_info *info);
1026 
1027 	/*
1028 	 * Bridge integration
1029 	 */
1030 	int	(*set_ageing_time)(struct dsa_switch *ds, unsigned int msecs);
1031 	int	(*port_bridge_join)(struct dsa_switch *ds, int port,
1032 				    struct dsa_bridge bridge,
1033 				    bool *tx_fwd_offload,
1034 				    struct netlink_ext_ack *extack);
1035 	void	(*port_bridge_leave)(struct dsa_switch *ds, int port,
1036 				     struct dsa_bridge bridge);
1037 	void	(*port_stp_state_set)(struct dsa_switch *ds, int port,
1038 				      u8 state);
1039 	int	(*port_mst_state_set)(struct dsa_switch *ds, int port,
1040 				      const struct switchdev_mst_state *state);
1041 	void	(*port_fast_age)(struct dsa_switch *ds, int port);
1042 	int	(*port_vlan_fast_age)(struct dsa_switch *ds, int port, u16 vid);
1043 	int	(*port_pre_bridge_flags)(struct dsa_switch *ds, int port,
1044 					 struct switchdev_brport_flags flags,
1045 					 struct netlink_ext_ack *extack);
1046 	int	(*port_bridge_flags)(struct dsa_switch *ds, int port,
1047 				     struct switchdev_brport_flags flags,
1048 				     struct netlink_ext_ack *extack);
1049 	void	(*port_set_host_flood)(struct dsa_switch *ds, int port,
1050 				       bool uc, bool mc);
1051 
1052 	/*
1053 	 * VLAN support
1054 	 */
1055 	int	(*port_vlan_filtering)(struct dsa_switch *ds, int port,
1056 				       bool vlan_filtering,
1057 				       struct netlink_ext_ack *extack);
1058 	int	(*port_vlan_add)(struct dsa_switch *ds, int port,
1059 				 const struct switchdev_obj_port_vlan *vlan,
1060 				 struct netlink_ext_ack *extack);
1061 	int	(*port_vlan_del)(struct dsa_switch *ds, int port,
1062 				 const struct switchdev_obj_port_vlan *vlan);
1063 	int	(*vlan_msti_set)(struct dsa_switch *ds, struct dsa_bridge bridge,
1064 				 const struct switchdev_vlan_msti *msti);
1065 
1066 	/*
1067 	 * Forwarding database
1068 	 */
1069 	int	(*port_fdb_add)(struct dsa_switch *ds, int port,
1070 				const unsigned char *addr, u16 vid,
1071 				struct dsa_db db);
1072 	int	(*port_fdb_del)(struct dsa_switch *ds, int port,
1073 				const unsigned char *addr, u16 vid,
1074 				struct dsa_db db);
1075 	int	(*port_fdb_dump)(struct dsa_switch *ds, int port,
1076 				 dsa_fdb_dump_cb_t *cb, void *data);
1077 	int	(*lag_fdb_add)(struct dsa_switch *ds, struct dsa_lag lag,
1078 			       const unsigned char *addr, u16 vid,
1079 			       struct dsa_db db);
1080 	int	(*lag_fdb_del)(struct dsa_switch *ds, struct dsa_lag lag,
1081 			       const unsigned char *addr, u16 vid,
1082 			       struct dsa_db db);
1083 
1084 	/*
1085 	 * Multicast database
1086 	 */
1087 	int	(*port_mdb_add)(struct dsa_switch *ds, int port,
1088 				const struct switchdev_obj_port_mdb *mdb,
1089 				struct dsa_db db);
1090 	int	(*port_mdb_del)(struct dsa_switch *ds, int port,
1091 				const struct switchdev_obj_port_mdb *mdb,
1092 				struct dsa_db db);
1093 	/*
1094 	 * RXNFC
1095 	 */
1096 	int	(*get_rxnfc)(struct dsa_switch *ds, int port,
1097 			     struct ethtool_rxnfc *nfc, u32 *rule_locs);
1098 	int	(*set_rxnfc)(struct dsa_switch *ds, int port,
1099 			     struct ethtool_rxnfc *nfc);
1100 
1101 	/*
1102 	 * TC integration
1103 	 */
1104 	int	(*cls_flower_add)(struct dsa_switch *ds, int port,
1105 				  struct flow_cls_offload *cls, bool ingress);
1106 	int	(*cls_flower_del)(struct dsa_switch *ds, int port,
1107 				  struct flow_cls_offload *cls, bool ingress);
1108 	int	(*cls_flower_stats)(struct dsa_switch *ds, int port,
1109 				    struct flow_cls_offload *cls, bool ingress);
1110 	int	(*port_mirror_add)(struct dsa_switch *ds, int port,
1111 				   struct dsa_mall_mirror_tc_entry *mirror,
1112 				   bool ingress, struct netlink_ext_ack *extack);
1113 	void	(*port_mirror_del)(struct dsa_switch *ds, int port,
1114 				   struct dsa_mall_mirror_tc_entry *mirror);
1115 	int	(*port_policer_add)(struct dsa_switch *ds, int port,
1116 				    struct dsa_mall_policer_tc_entry *policer);
1117 	void	(*port_policer_del)(struct dsa_switch *ds, int port);
1118 	int	(*port_setup_tc)(struct dsa_switch *ds, int port,
1119 				 enum tc_setup_type type, void *type_data);
1120 
1121 	/*
1122 	 * Cross-chip operations
1123 	 */
1124 	int	(*crosschip_bridge_join)(struct dsa_switch *ds, int tree_index,
1125 					 int sw_index, int port,
1126 					 struct dsa_bridge bridge,
1127 					 struct netlink_ext_ack *extack);
1128 	void	(*crosschip_bridge_leave)(struct dsa_switch *ds, int tree_index,
1129 					  int sw_index, int port,
1130 					  struct dsa_bridge bridge);
1131 	int	(*crosschip_lag_change)(struct dsa_switch *ds, int sw_index,
1132 					int port);
1133 	int	(*crosschip_lag_join)(struct dsa_switch *ds, int sw_index,
1134 				      int port, struct dsa_lag lag,
1135 				      struct netdev_lag_upper_info *info,
1136 				      struct netlink_ext_ack *extack);
1137 	int	(*crosschip_lag_leave)(struct dsa_switch *ds, int sw_index,
1138 				       int port, struct dsa_lag lag);
1139 
1140 	/*
1141 	 * PTP functionality
1142 	 */
1143 	int	(*port_hwtstamp_get)(struct dsa_switch *ds, int port,
1144 				     struct ifreq *ifr);
1145 	int	(*port_hwtstamp_set)(struct dsa_switch *ds, int port,
1146 				     struct ifreq *ifr);
1147 	void	(*port_txtstamp)(struct dsa_switch *ds, int port,
1148 				 struct sk_buff *skb);
1149 	bool	(*port_rxtstamp)(struct dsa_switch *ds, int port,
1150 				 struct sk_buff *skb, unsigned int type);
1151 
1152 	/* Devlink parameters, etc */
1153 	int	(*devlink_param_get)(struct dsa_switch *ds, u32 id,
1154 				     struct devlink_param_gset_ctx *ctx);
1155 	int	(*devlink_param_set)(struct dsa_switch *ds, u32 id,
1156 				     struct devlink_param_gset_ctx *ctx);
1157 	int	(*devlink_info_get)(struct dsa_switch *ds,
1158 				    struct devlink_info_req *req,
1159 				    struct netlink_ext_ack *extack);
1160 	int	(*devlink_sb_pool_get)(struct dsa_switch *ds,
1161 				       unsigned int sb_index, u16 pool_index,
1162 				       struct devlink_sb_pool_info *pool_info);
1163 	int	(*devlink_sb_pool_set)(struct dsa_switch *ds, unsigned int sb_index,
1164 				       u16 pool_index, u32 size,
1165 				       enum devlink_sb_threshold_type threshold_type,
1166 				       struct netlink_ext_ack *extack);
1167 	int	(*devlink_sb_port_pool_get)(struct dsa_switch *ds, int port,
1168 					    unsigned int sb_index, u16 pool_index,
1169 					    u32 *p_threshold);
1170 	int	(*devlink_sb_port_pool_set)(struct dsa_switch *ds, int port,
1171 					    unsigned int sb_index, u16 pool_index,
1172 					    u32 threshold,
1173 					    struct netlink_ext_ack *extack);
1174 	int	(*devlink_sb_tc_pool_bind_get)(struct dsa_switch *ds, int port,
1175 					       unsigned int sb_index, u16 tc_index,
1176 					       enum devlink_sb_pool_type pool_type,
1177 					       u16 *p_pool_index, u32 *p_threshold);
1178 	int	(*devlink_sb_tc_pool_bind_set)(struct dsa_switch *ds, int port,
1179 					       unsigned int sb_index, u16 tc_index,
1180 					       enum devlink_sb_pool_type pool_type,
1181 					       u16 pool_index, u32 threshold,
1182 					       struct netlink_ext_ack *extack);
1183 	int	(*devlink_sb_occ_snapshot)(struct dsa_switch *ds,
1184 					   unsigned int sb_index);
1185 	int	(*devlink_sb_occ_max_clear)(struct dsa_switch *ds,
1186 					    unsigned int sb_index);
1187 	int	(*devlink_sb_occ_port_pool_get)(struct dsa_switch *ds, int port,
1188 						unsigned int sb_index, u16 pool_index,
1189 						u32 *p_cur, u32 *p_max);
1190 	int	(*devlink_sb_occ_tc_port_bind_get)(struct dsa_switch *ds, int port,
1191 						   unsigned int sb_index, u16 tc_index,
1192 						   enum devlink_sb_pool_type pool_type,
1193 						   u32 *p_cur, u32 *p_max);
1194 
1195 	/*
1196 	 * MTU change functionality. Switches can also adjust their MRU through
1197 	 * this method. By MTU, one understands the SDU (L2 payload) length.
1198 	 * If the switch needs to account for the DSA tag on the CPU port, this
1199 	 * method needs to do so privately.
1200 	 */
1201 	int	(*port_change_mtu)(struct dsa_switch *ds, int port,
1202 				   int new_mtu);
1203 	int	(*port_max_mtu)(struct dsa_switch *ds, int port);
1204 
1205 	/*
1206 	 * LAG integration
1207 	 */
1208 	int	(*port_lag_change)(struct dsa_switch *ds, int port);
1209 	int	(*port_lag_join)(struct dsa_switch *ds, int port,
1210 				 struct dsa_lag lag,
1211 				 struct netdev_lag_upper_info *info,
1212 				 struct netlink_ext_ack *extack);
1213 	int	(*port_lag_leave)(struct dsa_switch *ds, int port,
1214 				  struct dsa_lag lag);
1215 
1216 	/*
1217 	 * HSR integration
1218 	 */
1219 	int	(*port_hsr_join)(struct dsa_switch *ds, int port,
1220 				 struct net_device *hsr,
1221 				 struct netlink_ext_ack *extack);
1222 	int	(*port_hsr_leave)(struct dsa_switch *ds, int port,
1223 				  struct net_device *hsr);
1224 
1225 	/*
1226 	 * MRP integration
1227 	 */
1228 	int	(*port_mrp_add)(struct dsa_switch *ds, int port,
1229 				const struct switchdev_obj_mrp *mrp);
1230 	int	(*port_mrp_del)(struct dsa_switch *ds, int port,
1231 				const struct switchdev_obj_mrp *mrp);
1232 	int	(*port_mrp_add_ring_role)(struct dsa_switch *ds, int port,
1233 					  const struct switchdev_obj_ring_role_mrp *mrp);
1234 	int	(*port_mrp_del_ring_role)(struct dsa_switch *ds, int port,
1235 					  const struct switchdev_obj_ring_role_mrp *mrp);
1236 
1237 	/*
1238 	 * tag_8021q operations
1239 	 */
1240 	int	(*tag_8021q_vlan_add)(struct dsa_switch *ds, int port, u16 vid,
1241 				      u16 flags);
1242 	int	(*tag_8021q_vlan_del)(struct dsa_switch *ds, int port, u16 vid);
1243 
1244 	/*
1245 	 * DSA conduit tracking operations
1246 	 */
1247 	void	(*conduit_state_change)(struct dsa_switch *ds,
1248 					const struct net_device *conduit,
1249 					bool operational);
1250 };
1251 
1252 #define DSA_DEVLINK_PARAM_DRIVER(_id, _name, _type, _cmodes)		\
1253 	DEVLINK_PARAM_DRIVER(_id, _name, _type, _cmodes,		\
1254 			     dsa_devlink_param_get, dsa_devlink_param_set, NULL)
1255 
1256 int dsa_devlink_param_get(struct devlink *dl, u32 id,
1257 			  struct devlink_param_gset_ctx *ctx);
1258 int dsa_devlink_param_set(struct devlink *dl, u32 id,
1259 			  struct devlink_param_gset_ctx *ctx,
1260 			  struct netlink_ext_ack *extack);
1261 int dsa_devlink_params_register(struct dsa_switch *ds,
1262 				const struct devlink_param *params,
1263 				size_t params_count);
1264 void dsa_devlink_params_unregister(struct dsa_switch *ds,
1265 				   const struct devlink_param *params,
1266 				   size_t params_count);
1267 int dsa_devlink_resource_register(struct dsa_switch *ds,
1268 				  const char *resource_name,
1269 				  u64 resource_size,
1270 				  u64 resource_id,
1271 				  u64 parent_resource_id,
1272 				  const struct devlink_resource_size_params *size_params);
1273 
1274 void dsa_devlink_resources_unregister(struct dsa_switch *ds);
1275 
1276 void dsa_devlink_resource_occ_get_register(struct dsa_switch *ds,
1277 					   u64 resource_id,
1278 					   devlink_resource_occ_get_t *occ_get,
1279 					   void *occ_get_priv);
1280 void dsa_devlink_resource_occ_get_unregister(struct dsa_switch *ds,
1281 					     u64 resource_id);
1282 struct devlink_region *
1283 dsa_devlink_region_create(struct dsa_switch *ds,
1284 			  const struct devlink_region_ops *ops,
1285 			  u32 region_max_snapshots, u64 region_size);
1286 struct devlink_region *
1287 dsa_devlink_port_region_create(struct dsa_switch *ds,
1288 			       int port,
1289 			       const struct devlink_port_region_ops *ops,
1290 			       u32 region_max_snapshots, u64 region_size);
1291 void dsa_devlink_region_destroy(struct devlink_region *region);
1292 
1293 struct dsa_port *dsa_port_from_netdev(struct net_device *netdev);
1294 
1295 struct dsa_devlink_priv {
1296 	struct dsa_switch *ds;
1297 };
1298 
1299 static inline struct dsa_switch *dsa_devlink_to_ds(struct devlink *dl)
1300 {
1301 	struct dsa_devlink_priv *dl_priv = devlink_priv(dl);
1302 
1303 	return dl_priv->ds;
1304 }
1305 
1306 static inline
1307 struct dsa_switch *dsa_devlink_port_to_ds(struct devlink_port *port)
1308 {
1309 	struct devlink *dl = port->devlink;
1310 	struct dsa_devlink_priv *dl_priv = devlink_priv(dl);
1311 
1312 	return dl_priv->ds;
1313 }
1314 
1315 static inline int dsa_devlink_port_to_port(struct devlink_port *port)
1316 {
1317 	return port->index;
1318 }
1319 
1320 struct dsa_switch_driver {
1321 	struct list_head	list;
1322 	const struct dsa_switch_ops *ops;
1323 };
1324 
1325 bool dsa_fdb_present_in_other_db(struct dsa_switch *ds, int port,
1326 				 const unsigned char *addr, u16 vid,
1327 				 struct dsa_db db);
1328 bool dsa_mdb_present_in_other_db(struct dsa_switch *ds, int port,
1329 				 const struct switchdev_obj_port_mdb *mdb,
1330 				 struct dsa_db db);
1331 
1332 /* Keep inline for faster access in hot path */
1333 static inline bool netdev_uses_dsa(const struct net_device *dev)
1334 {
1335 #if IS_ENABLED(CONFIG_NET_DSA)
1336 	return dev->dsa_ptr && dev->dsa_ptr->rcv;
1337 #endif
1338 	return false;
1339 }
1340 
1341 /* All DSA tags that push the EtherType to the right (basically all except tail
1342  * tags, which don't break dissection) can be treated the same from the
1343  * perspective of the flow dissector.
1344  *
1345  * We need to return:
1346  *  - offset: the (B - A) difference between:
1347  *    A. the position of the real EtherType and
1348  *    B. the current skb->data (aka ETH_HLEN bytes into the frame, aka 2 bytes
1349  *       after the normal EtherType was supposed to be)
1350  *    The offset in bytes is exactly equal to the tagger overhead (and half of
1351  *    that, in __be16 shorts).
1352  *
1353  *  - proto: the value of the real EtherType.
1354  */
1355 static inline void dsa_tag_generic_flow_dissect(const struct sk_buff *skb,
1356 						__be16 *proto, int *offset)
1357 {
1358 #if IS_ENABLED(CONFIG_NET_DSA)
1359 	const struct dsa_device_ops *ops = skb->dev->dsa_ptr->tag_ops;
1360 	int tag_len = ops->needed_headroom;
1361 
1362 	*offset = tag_len;
1363 	*proto = ((__be16 *)skb->data)[(tag_len / 2) - 1];
1364 #endif
1365 }
1366 
1367 void dsa_unregister_switch(struct dsa_switch *ds);
1368 int dsa_register_switch(struct dsa_switch *ds);
1369 void dsa_switch_shutdown(struct dsa_switch *ds);
1370 struct dsa_switch *dsa_switch_find(int tree_index, int sw_index);
1371 void dsa_flush_workqueue(void);
1372 #ifdef CONFIG_PM_SLEEP
1373 int dsa_switch_suspend(struct dsa_switch *ds);
1374 int dsa_switch_resume(struct dsa_switch *ds);
1375 #else
1376 static inline int dsa_switch_suspend(struct dsa_switch *ds)
1377 {
1378 	return 0;
1379 }
1380 static inline int dsa_switch_resume(struct dsa_switch *ds)
1381 {
1382 	return 0;
1383 }
1384 #endif /* CONFIG_PM_SLEEP */
1385 
1386 #if IS_ENABLED(CONFIG_NET_DSA)
1387 bool dsa_user_dev_check(const struct net_device *dev);
1388 #else
1389 static inline bool dsa_user_dev_check(const struct net_device *dev)
1390 {
1391 	return false;
1392 }
1393 #endif
1394 
1395 netdev_tx_t dsa_enqueue_skb(struct sk_buff *skb, struct net_device *dev);
1396 void dsa_port_phylink_mac_change(struct dsa_switch *ds, int port, bool up);
1397 
1398 #endif
1399