xref: /linux/include/net/dsa.h (revision 132db93572821ec2fdf81e354cc40f558faf7e4f)
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 
48 enum dsa_tag_protocol {
49 	DSA_TAG_PROTO_NONE		= DSA_TAG_PROTO_NONE_VALUE,
50 	DSA_TAG_PROTO_BRCM		= DSA_TAG_PROTO_BRCM_VALUE,
51 	DSA_TAG_PROTO_BRCM_PREPEND	= DSA_TAG_PROTO_BRCM_PREPEND_VALUE,
52 	DSA_TAG_PROTO_DSA		= DSA_TAG_PROTO_DSA_VALUE,
53 	DSA_TAG_PROTO_EDSA		= DSA_TAG_PROTO_EDSA_VALUE,
54 	DSA_TAG_PROTO_GSWIP		= DSA_TAG_PROTO_GSWIP_VALUE,
55 	DSA_TAG_PROTO_KSZ9477		= DSA_TAG_PROTO_KSZ9477_VALUE,
56 	DSA_TAG_PROTO_KSZ9893		= DSA_TAG_PROTO_KSZ9893_VALUE,
57 	DSA_TAG_PROTO_LAN9303		= DSA_TAG_PROTO_LAN9303_VALUE,
58 	DSA_TAG_PROTO_MTK		= DSA_TAG_PROTO_MTK_VALUE,
59 	DSA_TAG_PROTO_QCA		= DSA_TAG_PROTO_QCA_VALUE,
60 	DSA_TAG_PROTO_TRAILER		= DSA_TAG_PROTO_TRAILER_VALUE,
61 	DSA_TAG_PROTO_8021Q		= DSA_TAG_PROTO_8021Q_VALUE,
62 	DSA_TAG_PROTO_SJA1105		= DSA_TAG_PROTO_SJA1105_VALUE,
63 	DSA_TAG_PROTO_KSZ8795		= DSA_TAG_PROTO_KSZ8795_VALUE,
64 	DSA_TAG_PROTO_OCELOT		= DSA_TAG_PROTO_OCELOT_VALUE,
65 	DSA_TAG_PROTO_AR9331		= DSA_TAG_PROTO_AR9331_VALUE,
66 };
67 
68 struct packet_type;
69 struct dsa_switch;
70 
71 struct dsa_device_ops {
72 	struct sk_buff *(*xmit)(struct sk_buff *skb, struct net_device *dev);
73 	struct sk_buff *(*rcv)(struct sk_buff *skb, struct net_device *dev,
74 			       struct packet_type *pt);
75 	int (*flow_dissect)(const struct sk_buff *skb, __be16 *proto,
76 			    int *offset);
77 	/* Used to determine which traffic should match the DSA filter in
78 	 * eth_type_trans, and which, if any, should bypass it and be processed
79 	 * as regular on the master net device.
80 	 */
81 	bool (*filter)(const struct sk_buff *skb, struct net_device *dev);
82 	unsigned int overhead;
83 	const char *name;
84 	enum dsa_tag_protocol proto;
85 };
86 
87 #define DSA_TAG_DRIVER_ALIAS "dsa_tag-"
88 #define MODULE_ALIAS_DSA_TAG_DRIVER(__proto)				\
89 	MODULE_ALIAS(DSA_TAG_DRIVER_ALIAS __stringify(__proto##_VALUE))
90 
91 struct dsa_skb_cb {
92 	struct sk_buff *clone;
93 };
94 
95 struct __dsa_skb_cb {
96 	struct dsa_skb_cb cb;
97 	u8 priv[48 - sizeof(struct dsa_skb_cb)];
98 };
99 
100 #define DSA_SKB_CB(skb) ((struct dsa_skb_cb *)((skb)->cb))
101 
102 #define DSA_SKB_CB_PRIV(skb)			\
103 	((void *)(skb)->cb + offsetof(struct __dsa_skb_cb, priv))
104 
105 struct dsa_switch_tree {
106 	struct list_head	list;
107 
108 	/* Notifier chain for switch-wide events */
109 	struct raw_notifier_head	nh;
110 
111 	/* Tree identifier */
112 	unsigned int index;
113 
114 	/* Number of switches attached to this tree */
115 	struct kref refcount;
116 
117 	/* Has this tree been applied to the hardware? */
118 	bool setup;
119 
120 	/*
121 	 * Configuration data for the platform device that owns
122 	 * this dsa switch tree instance.
123 	 */
124 	struct dsa_platform_data	*pd;
125 
126 	/* List of switch ports */
127 	struct list_head ports;
128 
129 	/* List of DSA links composing the routing table */
130 	struct list_head rtable;
131 };
132 
133 /* TC matchall action types */
134 enum dsa_port_mall_action_type {
135 	DSA_PORT_MALL_MIRROR,
136 	DSA_PORT_MALL_POLICER,
137 };
138 
139 /* TC mirroring entry */
140 struct dsa_mall_mirror_tc_entry {
141 	u8 to_local_port;
142 	bool ingress;
143 };
144 
145 /* TC port policer entry */
146 struct dsa_mall_policer_tc_entry {
147 	s64 burst;
148 	u64 rate_bytes_per_sec;
149 };
150 
151 /* TC matchall entry */
152 struct dsa_mall_tc_entry {
153 	struct list_head list;
154 	unsigned long cookie;
155 	enum dsa_port_mall_action_type type;
156 	union {
157 		struct dsa_mall_mirror_tc_entry mirror;
158 		struct dsa_mall_policer_tc_entry policer;
159 	};
160 };
161 
162 
163 struct dsa_port {
164 	/* A CPU port is physically connected to a master device.
165 	 * A user port exposed to userspace has a slave device.
166 	 */
167 	union {
168 		struct net_device *master;
169 		struct net_device *slave;
170 	};
171 
172 	/* CPU port tagging operations used by master or slave devices */
173 	const struct dsa_device_ops *tag_ops;
174 
175 	/* Copies for faster access in master receive hot path */
176 	struct dsa_switch_tree *dst;
177 	struct sk_buff *(*rcv)(struct sk_buff *skb, struct net_device *dev,
178 			       struct packet_type *pt);
179 	bool (*filter)(const struct sk_buff *skb, struct net_device *dev);
180 
181 	enum {
182 		DSA_PORT_TYPE_UNUSED = 0,
183 		DSA_PORT_TYPE_CPU,
184 		DSA_PORT_TYPE_DSA,
185 		DSA_PORT_TYPE_USER,
186 	} type;
187 
188 	struct dsa_switch	*ds;
189 	unsigned int		index;
190 	const char		*name;
191 	struct dsa_port		*cpu_dp;
192 	const char		*mac;
193 	struct device_node	*dn;
194 	unsigned int		ageing_time;
195 	bool			vlan_filtering;
196 	u8			stp_state;
197 	struct net_device	*bridge_dev;
198 	struct devlink_port	devlink_port;
199 	struct phylink		*pl;
200 	struct phylink_config	pl_config;
201 
202 	struct list_head list;
203 
204 	/*
205 	 * Give the switch driver somewhere to hang its per-port private data
206 	 * structures (accessible from the tagger).
207 	 */
208 	void *priv;
209 
210 	/*
211 	 * Original copy of the master netdev ethtool_ops
212 	 */
213 	const struct ethtool_ops *orig_ethtool_ops;
214 
215 	/*
216 	 * Original copy of the master netdev net_device_ops
217 	 */
218 	const struct net_device_ops *orig_ndo_ops;
219 
220 	bool setup;
221 };
222 
223 /* TODO: ideally DSA ports would have a single dp->link_dp member,
224  * and no dst->rtable nor this struct dsa_link would be needed,
225  * but this would require some more complex tree walking,
226  * so keep it stupid at the moment and list them all.
227  */
228 struct dsa_link {
229 	struct dsa_port *dp;
230 	struct dsa_port *link_dp;
231 	struct list_head list;
232 };
233 
234 struct dsa_switch {
235 	bool setup;
236 
237 	struct device *dev;
238 
239 	/*
240 	 * Parent switch tree, and switch index.
241 	 */
242 	struct dsa_switch_tree	*dst;
243 	unsigned int		index;
244 
245 	/* Listener for switch fabric events */
246 	struct notifier_block	nb;
247 
248 	/*
249 	 * Give the switch driver somewhere to hang its private data
250 	 * structure.
251 	 */
252 	void *priv;
253 
254 	/*
255 	 * Configuration data for this switch.
256 	 */
257 	struct dsa_chip_data	*cd;
258 
259 	/*
260 	 * The switch operations.
261 	 */
262 	const struct dsa_switch_ops	*ops;
263 
264 	/*
265 	 * Slave mii_bus and devices for the individual ports.
266 	 */
267 	u32			phys_mii_mask;
268 	struct mii_bus		*slave_mii_bus;
269 
270 	/* Ageing Time limits in msecs */
271 	unsigned int ageing_time_min;
272 	unsigned int ageing_time_max;
273 
274 	/* devlink used to represent this switch device */
275 	struct devlink		*devlink;
276 
277 	/* Number of switch port queues */
278 	unsigned int		num_tx_queues;
279 
280 	/* Disallow bridge core from requesting different VLAN awareness
281 	 * settings on ports if not hardware-supported
282 	 */
283 	bool			vlan_filtering_is_global;
284 
285 	/* Pass .port_vlan_add and .port_vlan_del to drivers even for bridges
286 	 * that have vlan_filtering=0. All drivers should ideally set this (and
287 	 * then the option would get removed), but it is unknown whether this
288 	 * would break things or not.
289 	 */
290 	bool			configure_vlan_while_not_filtering;
291 
292 	/* In case vlan_filtering_is_global is set, the VLAN awareness state
293 	 * should be retrieved from here and not from the per-port settings.
294 	 */
295 	bool			vlan_filtering;
296 
297 	/* MAC PCS does not provide link state change interrupt, and requires
298 	 * polling. Flag passed on to PHYLINK.
299 	 */
300 	bool			pcs_poll;
301 
302 	/* For switches that only have the MRU configurable. To ensure the
303 	 * configured MTU is not exceeded, normalization of MRU on all bridged
304 	 * interfaces is needed.
305 	 */
306 	bool			mtu_enforcement_ingress;
307 
308 	size_t num_ports;
309 };
310 
311 static inline struct dsa_port *dsa_to_port(struct dsa_switch *ds, int p)
312 {
313 	struct dsa_switch_tree *dst = ds->dst;
314 	struct dsa_port *dp;
315 
316 	list_for_each_entry(dp, &dst->ports, list)
317 		if (dp->ds == ds && dp->index == p)
318 			return dp;
319 
320 	return NULL;
321 }
322 
323 static inline bool dsa_is_unused_port(struct dsa_switch *ds, int p)
324 {
325 	return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_UNUSED;
326 }
327 
328 static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p)
329 {
330 	return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_CPU;
331 }
332 
333 static inline bool dsa_is_dsa_port(struct dsa_switch *ds, int p)
334 {
335 	return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_DSA;
336 }
337 
338 static inline bool dsa_is_user_port(struct dsa_switch *ds, int p)
339 {
340 	return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_USER;
341 }
342 
343 static inline u32 dsa_user_ports(struct dsa_switch *ds)
344 {
345 	u32 mask = 0;
346 	int p;
347 
348 	for (p = 0; p < ds->num_ports; p++)
349 		if (dsa_is_user_port(ds, p))
350 			mask |= BIT(p);
351 
352 	return mask;
353 }
354 
355 /* Return the local port used to reach an arbitrary switch device */
356 static inline unsigned int dsa_routing_port(struct dsa_switch *ds, int device)
357 {
358 	struct dsa_switch_tree *dst = ds->dst;
359 	struct dsa_link *dl;
360 
361 	list_for_each_entry(dl, &dst->rtable, list)
362 		if (dl->dp->ds == ds && dl->link_dp->ds->index == device)
363 			return dl->dp->index;
364 
365 	return ds->num_ports;
366 }
367 
368 /* Return the local port used to reach an arbitrary switch port */
369 static inline unsigned int dsa_towards_port(struct dsa_switch *ds, int device,
370 					    int port)
371 {
372 	if (device == ds->index)
373 		return port;
374 	else
375 		return dsa_routing_port(ds, device);
376 }
377 
378 /* Return the local port used to reach the dedicated CPU port */
379 static inline unsigned int dsa_upstream_port(struct dsa_switch *ds, int port)
380 {
381 	const struct dsa_port *dp = dsa_to_port(ds, port);
382 	const struct dsa_port *cpu_dp = dp->cpu_dp;
383 
384 	if (!cpu_dp)
385 		return port;
386 
387 	return dsa_towards_port(ds, cpu_dp->ds->index, cpu_dp->index);
388 }
389 
390 static inline bool dsa_port_is_vlan_filtering(const struct dsa_port *dp)
391 {
392 	const struct dsa_switch *ds = dp->ds;
393 
394 	if (ds->vlan_filtering_is_global)
395 		return ds->vlan_filtering;
396 	else
397 		return dp->vlan_filtering;
398 }
399 
400 typedef int dsa_fdb_dump_cb_t(const unsigned char *addr, u16 vid,
401 			      bool is_static, void *data);
402 struct dsa_switch_ops {
403 	enum dsa_tag_protocol (*get_tag_protocol)(struct dsa_switch *ds,
404 						  int port,
405 						  enum dsa_tag_protocol mprot);
406 
407 	int	(*setup)(struct dsa_switch *ds);
408 	void	(*teardown)(struct dsa_switch *ds);
409 	u32	(*get_phy_flags)(struct dsa_switch *ds, int port);
410 
411 	/*
412 	 * Access to the switch's PHY registers.
413 	 */
414 	int	(*phy_read)(struct dsa_switch *ds, int port, int regnum);
415 	int	(*phy_write)(struct dsa_switch *ds, int port,
416 			     int regnum, u16 val);
417 
418 	/*
419 	 * Link state adjustment (called from libphy)
420 	 */
421 	void	(*adjust_link)(struct dsa_switch *ds, int port,
422 				struct phy_device *phydev);
423 	void	(*fixed_link_update)(struct dsa_switch *ds, int port,
424 				struct fixed_phy_status *st);
425 
426 	/*
427 	 * PHYLINK integration
428 	 */
429 	void	(*phylink_validate)(struct dsa_switch *ds, int port,
430 				    unsigned long *supported,
431 				    struct phylink_link_state *state);
432 	int	(*phylink_mac_link_state)(struct dsa_switch *ds, int port,
433 					  struct phylink_link_state *state);
434 	void	(*phylink_mac_config)(struct dsa_switch *ds, int port,
435 				      unsigned int mode,
436 				      const struct phylink_link_state *state);
437 	void	(*phylink_mac_an_restart)(struct dsa_switch *ds, int port);
438 	void	(*phylink_mac_link_down)(struct dsa_switch *ds, int port,
439 					 unsigned int mode,
440 					 phy_interface_t interface);
441 	void	(*phylink_mac_link_up)(struct dsa_switch *ds, int port,
442 				       unsigned int mode,
443 				       phy_interface_t interface,
444 				       struct phy_device *phydev,
445 				       int speed, int duplex,
446 				       bool tx_pause, bool rx_pause);
447 	void	(*phylink_fixed_state)(struct dsa_switch *ds, int port,
448 				       struct phylink_link_state *state);
449 	/*
450 	 * ethtool hardware statistics.
451 	 */
452 	void	(*get_strings)(struct dsa_switch *ds, int port,
453 			       u32 stringset, uint8_t *data);
454 	void	(*get_ethtool_stats)(struct dsa_switch *ds,
455 				     int port, uint64_t *data);
456 	int	(*get_sset_count)(struct dsa_switch *ds, int port, int sset);
457 	void	(*get_ethtool_phy_stats)(struct dsa_switch *ds,
458 					 int port, uint64_t *data);
459 
460 	/*
461 	 * ethtool Wake-on-LAN
462 	 */
463 	void	(*get_wol)(struct dsa_switch *ds, int port,
464 			   struct ethtool_wolinfo *w);
465 	int	(*set_wol)(struct dsa_switch *ds, int port,
466 			   struct ethtool_wolinfo *w);
467 
468 	/*
469 	 * ethtool timestamp info
470 	 */
471 	int	(*get_ts_info)(struct dsa_switch *ds, int port,
472 			       struct ethtool_ts_info *ts);
473 
474 	/*
475 	 * Suspend and resume
476 	 */
477 	int	(*suspend)(struct dsa_switch *ds);
478 	int	(*resume)(struct dsa_switch *ds);
479 
480 	/*
481 	 * Port enable/disable
482 	 */
483 	int	(*port_enable)(struct dsa_switch *ds, int port,
484 			       struct phy_device *phy);
485 	void	(*port_disable)(struct dsa_switch *ds, int port);
486 
487 	/*
488 	 * Port's MAC EEE settings
489 	 */
490 	int	(*set_mac_eee)(struct dsa_switch *ds, int port,
491 			       struct ethtool_eee *e);
492 	int	(*get_mac_eee)(struct dsa_switch *ds, int port,
493 			       struct ethtool_eee *e);
494 
495 	/* EEPROM access */
496 	int	(*get_eeprom_len)(struct dsa_switch *ds);
497 	int	(*get_eeprom)(struct dsa_switch *ds,
498 			      struct ethtool_eeprom *eeprom, u8 *data);
499 	int	(*set_eeprom)(struct dsa_switch *ds,
500 			      struct ethtool_eeprom *eeprom, u8 *data);
501 
502 	/*
503 	 * Register access.
504 	 */
505 	int	(*get_regs_len)(struct dsa_switch *ds, int port);
506 	void	(*get_regs)(struct dsa_switch *ds, int port,
507 			    struct ethtool_regs *regs, void *p);
508 
509 	/*
510 	 * Bridge integration
511 	 */
512 	int	(*set_ageing_time)(struct dsa_switch *ds, unsigned int msecs);
513 	int	(*port_bridge_join)(struct dsa_switch *ds, int port,
514 				    struct net_device *bridge);
515 	void	(*port_bridge_leave)(struct dsa_switch *ds, int port,
516 				     struct net_device *bridge);
517 	void	(*port_stp_state_set)(struct dsa_switch *ds, int port,
518 				      u8 state);
519 	void	(*port_fast_age)(struct dsa_switch *ds, int port);
520 	int	(*port_egress_floods)(struct dsa_switch *ds, int port,
521 				      bool unicast, bool multicast);
522 
523 	/*
524 	 * VLAN support
525 	 */
526 	int	(*port_vlan_filtering)(struct dsa_switch *ds, int port,
527 				       bool vlan_filtering);
528 	int (*port_vlan_prepare)(struct dsa_switch *ds, int port,
529 				 const struct switchdev_obj_port_vlan *vlan);
530 	void (*port_vlan_add)(struct dsa_switch *ds, int port,
531 			      const struct switchdev_obj_port_vlan *vlan);
532 	int	(*port_vlan_del)(struct dsa_switch *ds, int port,
533 				 const struct switchdev_obj_port_vlan *vlan);
534 	/*
535 	 * Forwarding database
536 	 */
537 	int	(*port_fdb_add)(struct dsa_switch *ds, int port,
538 				const unsigned char *addr, u16 vid);
539 	int	(*port_fdb_del)(struct dsa_switch *ds, int port,
540 				const unsigned char *addr, u16 vid);
541 	int	(*port_fdb_dump)(struct dsa_switch *ds, int port,
542 				 dsa_fdb_dump_cb_t *cb, void *data);
543 
544 	/*
545 	 * Multicast database
546 	 */
547 	int (*port_mdb_prepare)(struct dsa_switch *ds, int port,
548 				const struct switchdev_obj_port_mdb *mdb);
549 	void (*port_mdb_add)(struct dsa_switch *ds, int port,
550 			     const struct switchdev_obj_port_mdb *mdb);
551 	int	(*port_mdb_del)(struct dsa_switch *ds, int port,
552 				const struct switchdev_obj_port_mdb *mdb);
553 	/*
554 	 * RXNFC
555 	 */
556 	int	(*get_rxnfc)(struct dsa_switch *ds, int port,
557 			     struct ethtool_rxnfc *nfc, u32 *rule_locs);
558 	int	(*set_rxnfc)(struct dsa_switch *ds, int port,
559 			     struct ethtool_rxnfc *nfc);
560 
561 	/*
562 	 * TC integration
563 	 */
564 	int	(*cls_flower_add)(struct dsa_switch *ds, int port,
565 				  struct flow_cls_offload *cls, bool ingress);
566 	int	(*cls_flower_del)(struct dsa_switch *ds, int port,
567 				  struct flow_cls_offload *cls, bool ingress);
568 	int	(*cls_flower_stats)(struct dsa_switch *ds, int port,
569 				    struct flow_cls_offload *cls, bool ingress);
570 	int	(*port_mirror_add)(struct dsa_switch *ds, int port,
571 				   struct dsa_mall_mirror_tc_entry *mirror,
572 				   bool ingress);
573 	void	(*port_mirror_del)(struct dsa_switch *ds, int port,
574 				   struct dsa_mall_mirror_tc_entry *mirror);
575 	int	(*port_policer_add)(struct dsa_switch *ds, int port,
576 				    struct dsa_mall_policer_tc_entry *policer);
577 	void	(*port_policer_del)(struct dsa_switch *ds, int port);
578 	int	(*port_setup_tc)(struct dsa_switch *ds, int port,
579 				 enum tc_setup_type type, void *type_data);
580 
581 	/*
582 	 * Cross-chip operations
583 	 */
584 	int	(*crosschip_bridge_join)(struct dsa_switch *ds, int tree_index,
585 					 int sw_index, int port,
586 					 struct net_device *br);
587 	void	(*crosschip_bridge_leave)(struct dsa_switch *ds, int tree_index,
588 					  int sw_index, int port,
589 					  struct net_device *br);
590 
591 	/*
592 	 * PTP functionality
593 	 */
594 	int	(*port_hwtstamp_get)(struct dsa_switch *ds, int port,
595 				     struct ifreq *ifr);
596 	int	(*port_hwtstamp_set)(struct dsa_switch *ds, int port,
597 				     struct ifreq *ifr);
598 	bool	(*port_txtstamp)(struct dsa_switch *ds, int port,
599 				 struct sk_buff *clone, unsigned int type);
600 	bool	(*port_rxtstamp)(struct dsa_switch *ds, int port,
601 				 struct sk_buff *skb, unsigned int type);
602 
603 	/* Devlink parameters */
604 	int	(*devlink_param_get)(struct dsa_switch *ds, u32 id,
605 				     struct devlink_param_gset_ctx *ctx);
606 	int	(*devlink_param_set)(struct dsa_switch *ds, u32 id,
607 				     struct devlink_param_gset_ctx *ctx);
608 
609 	/*
610 	 * MTU change functionality. Switches can also adjust their MRU through
611 	 * this method. By MTU, one understands the SDU (L2 payload) length.
612 	 * If the switch needs to account for the DSA tag on the CPU port, this
613 	 * method needs to to do so privately.
614 	 */
615 	int	(*port_change_mtu)(struct dsa_switch *ds, int port,
616 				   int new_mtu);
617 	int	(*port_max_mtu)(struct dsa_switch *ds, int port);
618 };
619 
620 #define DSA_DEVLINK_PARAM_DRIVER(_id, _name, _type, _cmodes)		\
621 	DEVLINK_PARAM_DRIVER(_id, _name, _type, _cmodes,		\
622 			     dsa_devlink_param_get, dsa_devlink_param_set, NULL)
623 
624 int dsa_devlink_param_get(struct devlink *dl, u32 id,
625 			  struct devlink_param_gset_ctx *ctx);
626 int dsa_devlink_param_set(struct devlink *dl, u32 id,
627 			  struct devlink_param_gset_ctx *ctx);
628 int dsa_devlink_params_register(struct dsa_switch *ds,
629 				const struct devlink_param *params,
630 				size_t params_count);
631 void dsa_devlink_params_unregister(struct dsa_switch *ds,
632 				   const struct devlink_param *params,
633 				   size_t params_count);
634 int dsa_devlink_resource_register(struct dsa_switch *ds,
635 				  const char *resource_name,
636 				  u64 resource_size,
637 				  u64 resource_id,
638 				  u64 parent_resource_id,
639 				  const struct devlink_resource_size_params *size_params);
640 
641 void dsa_devlink_resources_unregister(struct dsa_switch *ds);
642 
643 void dsa_devlink_resource_occ_get_register(struct dsa_switch *ds,
644 					   u64 resource_id,
645 					   devlink_resource_occ_get_t *occ_get,
646 					   void *occ_get_priv);
647 void dsa_devlink_resource_occ_get_unregister(struct dsa_switch *ds,
648 					     u64 resource_id);
649 struct dsa_port *dsa_port_from_netdev(struct net_device *netdev);
650 
651 struct dsa_devlink_priv {
652 	struct dsa_switch *ds;
653 };
654 
655 struct dsa_switch_driver {
656 	struct list_head	list;
657 	const struct dsa_switch_ops *ops;
658 };
659 
660 struct net_device *dsa_dev_to_net_device(struct device *dev);
661 
662 /* Keep inline for faster access in hot path */
663 static inline bool netdev_uses_dsa(const struct net_device *dev)
664 {
665 #if IS_ENABLED(CONFIG_NET_DSA)
666 	return dev->dsa_ptr && dev->dsa_ptr->rcv;
667 #endif
668 	return false;
669 }
670 
671 static inline bool dsa_can_decode(const struct sk_buff *skb,
672 				  struct net_device *dev)
673 {
674 #if IS_ENABLED(CONFIG_NET_DSA)
675 	return !dev->dsa_ptr->filter || dev->dsa_ptr->filter(skb, dev);
676 #endif
677 	return false;
678 }
679 
680 void dsa_unregister_switch(struct dsa_switch *ds);
681 int dsa_register_switch(struct dsa_switch *ds);
682 struct dsa_switch *dsa_switch_find(int tree_index, int sw_index);
683 #ifdef CONFIG_PM_SLEEP
684 int dsa_switch_suspend(struct dsa_switch *ds);
685 int dsa_switch_resume(struct dsa_switch *ds);
686 #else
687 static inline int dsa_switch_suspend(struct dsa_switch *ds)
688 {
689 	return 0;
690 }
691 static inline int dsa_switch_resume(struct dsa_switch *ds)
692 {
693 	return 0;
694 }
695 #endif /* CONFIG_PM_SLEEP */
696 
697 enum dsa_notifier_type {
698 	DSA_PORT_REGISTER,
699 	DSA_PORT_UNREGISTER,
700 };
701 
702 struct dsa_notifier_info {
703 	struct net_device *dev;
704 };
705 
706 struct dsa_notifier_register_info {
707 	struct dsa_notifier_info info;	/* must be first */
708 	struct net_device *master;
709 	unsigned int port_number;
710 	unsigned int switch_number;
711 };
712 
713 static inline struct net_device *
714 dsa_notifier_info_to_dev(const struct dsa_notifier_info *info)
715 {
716 	return info->dev;
717 }
718 
719 #if IS_ENABLED(CONFIG_NET_DSA)
720 int register_dsa_notifier(struct notifier_block *nb);
721 int unregister_dsa_notifier(struct notifier_block *nb);
722 int call_dsa_notifiers(unsigned long val, struct net_device *dev,
723 		       struct dsa_notifier_info *info);
724 #else
725 static inline int register_dsa_notifier(struct notifier_block *nb)
726 {
727 	return 0;
728 }
729 
730 static inline int unregister_dsa_notifier(struct notifier_block *nb)
731 {
732 	return 0;
733 }
734 
735 static inline int call_dsa_notifiers(unsigned long val, struct net_device *dev,
736 				     struct dsa_notifier_info *info)
737 {
738 	return NOTIFY_DONE;
739 }
740 #endif
741 
742 /* Broadcom tag specific helpers to insert and extract queue/port number */
743 #define BRCM_TAG_SET_PORT_QUEUE(p, q)	((p) << 8 | q)
744 #define BRCM_TAG_GET_PORT(v)		((v) >> 8)
745 #define BRCM_TAG_GET_QUEUE(v)		((v) & 0xff)
746 
747 
748 netdev_tx_t dsa_enqueue_skb(struct sk_buff *skb, struct net_device *dev);
749 int dsa_port_get_phy_strings(struct dsa_port *dp, uint8_t *data);
750 int dsa_port_get_ethtool_phy_stats(struct dsa_port *dp, uint64_t *data);
751 int dsa_port_get_phy_sset_count(struct dsa_port *dp);
752 void dsa_port_phylink_mac_change(struct dsa_switch *ds, int port, bool up);
753 
754 struct dsa_tag_driver {
755 	const struct dsa_device_ops *ops;
756 	struct list_head list;
757 	struct module *owner;
758 };
759 
760 void dsa_tag_drivers_register(struct dsa_tag_driver *dsa_tag_driver_array[],
761 			      unsigned int count,
762 			      struct module *owner);
763 void dsa_tag_drivers_unregister(struct dsa_tag_driver *dsa_tag_driver_array[],
764 				unsigned int count);
765 
766 #define dsa_tag_driver_module_drivers(__dsa_tag_drivers_array, __count)	\
767 static int __init dsa_tag_driver_module_init(void)			\
768 {									\
769 	dsa_tag_drivers_register(__dsa_tag_drivers_array, __count,	\
770 				 THIS_MODULE);				\
771 	return 0;							\
772 }									\
773 module_init(dsa_tag_driver_module_init);				\
774 									\
775 static void __exit dsa_tag_driver_module_exit(void)			\
776 {									\
777 	dsa_tag_drivers_unregister(__dsa_tag_drivers_array, __count);	\
778 }									\
779 module_exit(dsa_tag_driver_module_exit)
780 
781 /**
782  * module_dsa_tag_drivers() - Helper macro for registering DSA tag
783  * drivers
784  * @__ops_array: Array of tag driver strucutres
785  *
786  * Helper macro for DSA tag drivers which do not do anything special
787  * in module init/exit. Each module may only use this macro once, and
788  * calling it replaces module_init() and module_exit().
789  */
790 #define module_dsa_tag_drivers(__ops_array)				\
791 dsa_tag_driver_module_drivers(__ops_array, ARRAY_SIZE(__ops_array))
792 
793 #define DSA_TAG_DRIVER_NAME(__ops) dsa_tag_driver ## _ ## __ops
794 
795 /* Create a static structure we can build a linked list of dsa_tag
796  * drivers
797  */
798 #define DSA_TAG_DRIVER(__ops)						\
799 static struct dsa_tag_driver DSA_TAG_DRIVER_NAME(__ops) = {		\
800 	.ops = &__ops,							\
801 }
802 
803 /**
804  * module_dsa_tag_driver() - Helper macro for registering a single DSA tag
805  * driver
806  * @__ops: Single tag driver structures
807  *
808  * Helper macro for DSA tag drivers which do not do anything special
809  * in module init/exit. Each module may only use this macro once, and
810  * calling it replaces module_init() and module_exit().
811  */
812 #define module_dsa_tag_driver(__ops)					\
813 DSA_TAG_DRIVER(__ops);							\
814 									\
815 static struct dsa_tag_driver *dsa_tag_driver_array[] =	{		\
816 	&DSA_TAG_DRIVER_NAME(__ops)					\
817 };									\
818 module_dsa_tag_drivers(dsa_tag_driver_array)
819 #endif
820 
821