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