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