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