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