1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 * include/net/dsa.h - Driver for Distributed Switch Architecture switch chips
4 * Copyright (c) 2008-2009 Marvell Semiconductor
7 #ifndef __LINUX_NET_DSA_H
8 #define __LINUX_NET_DSA_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>
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>
25 struct dsa_8021q_context;
28 struct fixed_phy_status;
29 struct phylink_link_state;
31 #define DSA_TAG_PROTO_NONE_VALUE 0
32 #define DSA_TAG_PROTO_BRCM_VALUE 1
33 #define DSA_TAG_PROTO_BRCM_PREPEND_VALUE 2
34 #define DSA_TAG_PROTO_DSA_VALUE 3
35 #define DSA_TAG_PROTO_EDSA_VALUE 4
36 #define DSA_TAG_PROTO_GSWIP_VALUE 5
37 #define DSA_TAG_PROTO_KSZ9477_VALUE 6
38 #define DSA_TAG_PROTO_KSZ9893_VALUE 7
39 #define DSA_TAG_PROTO_LAN9303_VALUE 8
40 #define DSA_TAG_PROTO_MTK_VALUE 9
41 #define DSA_TAG_PROTO_QCA_VALUE 10
42 #define DSA_TAG_PROTO_TRAILER_VALUE 11
43 #define DSA_TAG_PROTO_8021Q_VALUE 12
44 #define DSA_TAG_PROTO_SJA1105_VALUE 13
45 #define DSA_TAG_PROTO_KSZ8795_VALUE 14
46 #define DSA_TAG_PROTO_OCELOT_VALUE 15
47 #define DSA_TAG_PROTO_AR9331_VALUE 16
48 #define DSA_TAG_PROTO_RTL4_A_VALUE 17
49 #define DSA_TAG_PROTO_HELLCREEK_VALUE 18
50 #define DSA_TAG_PROTO_XRS700X_VALUE 19
51 #define DSA_TAG_PROTO_OCELOT_8021Q_VALUE 20
52 #define DSA_TAG_PROTO_SEVILLE_VALUE 21
53 #define DSA_TAG_PROTO_BRCM_LEGACY_VALUE 22
54 #define DSA_TAG_PROTO_SJA1110_VALUE 23
55 #define DSA_TAG_PROTO_RTL8_4_VALUE 24
56 #define DSA_TAG_PROTO_RTL8_4T_VALUE 25
57 #define DSA_TAG_PROTO_RZN1_A5PSW_VALUE 26
58 #define DSA_TAG_PROTO_LAN937X_VALUE 27
60 enum dsa_tag_protocol {
61 DSA_TAG_PROTO_NONE = DSA_TAG_PROTO_NONE_VALUE,
62 DSA_TAG_PROTO_BRCM = DSA_TAG_PROTO_BRCM_VALUE,
63 DSA_TAG_PROTO_BRCM_LEGACY = DSA_TAG_PROTO_BRCM_LEGACY_VALUE,
64 DSA_TAG_PROTO_BRCM_PREPEND = DSA_TAG_PROTO_BRCM_PREPEND_VALUE,
65 DSA_TAG_PROTO_DSA = DSA_TAG_PROTO_DSA_VALUE,
66 DSA_TAG_PROTO_EDSA = DSA_TAG_PROTO_EDSA_VALUE,
67 DSA_TAG_PROTO_GSWIP = DSA_TAG_PROTO_GSWIP_VALUE,
68 DSA_TAG_PROTO_KSZ9477 = DSA_TAG_PROTO_KSZ9477_VALUE,
69 DSA_TAG_PROTO_KSZ9893 = DSA_TAG_PROTO_KSZ9893_VALUE,
70 DSA_TAG_PROTO_LAN9303 = DSA_TAG_PROTO_LAN9303_VALUE,
71 DSA_TAG_PROTO_MTK = DSA_TAG_PROTO_MTK_VALUE,
72 DSA_TAG_PROTO_QCA = DSA_TAG_PROTO_QCA_VALUE,
73 DSA_TAG_PROTO_TRAILER = DSA_TAG_PROTO_TRAILER_VALUE,
74 DSA_TAG_PROTO_8021Q = DSA_TAG_PROTO_8021Q_VALUE,
75 DSA_TAG_PROTO_SJA1105 = DSA_TAG_PROTO_SJA1105_VALUE,
76 DSA_TAG_PROTO_KSZ8795 = DSA_TAG_PROTO_KSZ8795_VALUE,
77 DSA_TAG_PROTO_OCELOT = DSA_TAG_PROTO_OCELOT_VALUE,
78 DSA_TAG_PROTO_AR9331 = DSA_TAG_PROTO_AR9331_VALUE,
79 DSA_TAG_PROTO_RTL4_A = DSA_TAG_PROTO_RTL4_A_VALUE,
80 DSA_TAG_PROTO_HELLCREEK = DSA_TAG_PROTO_HELLCREEK_VALUE,
81 DSA_TAG_PROTO_XRS700X = DSA_TAG_PROTO_XRS700X_VALUE,
82 DSA_TAG_PROTO_OCELOT_8021Q = DSA_TAG_PROTO_OCELOT_8021Q_VALUE,
83 DSA_TAG_PROTO_SEVILLE = DSA_TAG_PROTO_SEVILLE_VALUE,
84 DSA_TAG_PROTO_SJA1110 = DSA_TAG_PROTO_SJA1110_VALUE,
85 DSA_TAG_PROTO_RTL8_4 = DSA_TAG_PROTO_RTL8_4_VALUE,
86 DSA_TAG_PROTO_RTL8_4T = DSA_TAG_PROTO_RTL8_4T_VALUE,
87 DSA_TAG_PROTO_RZN1_A5PSW = DSA_TAG_PROTO_RZN1_A5PSW_VALUE,
88 DSA_TAG_PROTO_LAN937X = DSA_TAG_PROTO_LAN937X_VALUE,
93 struct dsa_device_ops {
94 struct sk_buff *(*xmit)(struct sk_buff *skb, struct net_device *dev);
95 struct sk_buff *(*rcv)(struct sk_buff *skb, struct net_device *dev);
96 void (*flow_dissect)(const struct sk_buff *skb, __be16 *proto,
98 int (*connect)(struct dsa_switch *ds);
99 void (*disconnect)(struct dsa_switch *ds);
100 unsigned int needed_headroom;
101 unsigned int needed_tailroom;
103 enum dsa_tag_protocol proto;
104 /* Some tagging protocols either mangle or shift the destination MAC
105 * address, in which case the DSA master would drop packets on ingress
106 * if what it understands out of the destination MAC address is not in
109 bool promisc_on_master;
112 /* This structure defines the control interfaces that are overlayed by the
113 * DSA layer on top of the DSA CPU/management net_device instance. This is
114 * used by the core net_device layer while calling various net_device_ops
117 struct dsa_netdevice_ops {
118 int (*ndo_eth_ioctl)(struct net_device *dev, struct ifreq *ifr,
123 struct net_device *dev;
125 struct mutex fdb_lock;
126 struct list_head fdbs;
130 struct dsa_switch_tree {
131 struct list_head list;
133 /* List of switch ports */
134 struct list_head ports;
136 /* Notifier chain for switch-wide events */
137 struct raw_notifier_head nh;
139 /* Tree identifier */
142 /* Number of switches attached to this tree */
143 struct kref refcount;
145 /* Maps offloaded LAG netdevs to a zero-based linear ID for
146 * drivers that need it.
148 struct dsa_lag **lags;
150 /* Tagging protocol operations */
151 const struct dsa_device_ops *tag_ops;
153 /* Default tagging protocol preferred by the switches in this
156 enum dsa_tag_protocol default_proto;
158 /* Has this tree been applied to the hardware? */
162 * Configuration data for the platform device that owns
163 * this dsa switch tree instance.
165 struct dsa_platform_data *pd;
167 /* List of DSA links composing the routing table */
168 struct list_head rtable;
170 /* Length of "lags" array */
171 unsigned int lags_len;
173 /* Track the largest switch index within a tree */
174 unsigned int last_switch;
177 /* LAG IDs are one-based, the dst->lags array is zero-based */
178 #define dsa_lags_foreach_id(_id, _dst) \
179 for ((_id) = 1; (_id) <= (_dst)->lags_len; (_id)++) \
180 if ((_dst)->lags[(_id) - 1])
182 #define dsa_lag_foreach_port(_dp, _dst, _lag) \
183 list_for_each_entry((_dp), &(_dst)->ports, list) \
184 if (dsa_port_offloads_lag((_dp), (_lag)))
186 #define dsa_hsr_foreach_port(_dp, _ds, _hsr) \
187 list_for_each_entry((_dp), &(_ds)->dst->ports, list) \
188 if ((_dp)->ds == (_ds) && (_dp)->hsr_dev == (_hsr))
190 static inline struct dsa_lag *dsa_lag_by_id(struct dsa_switch_tree *dst,
193 /* DSA LAG IDs are one-based, dst->lags is zero-based */
194 return dst->lags[id - 1];
197 static inline int dsa_lag_id(struct dsa_switch_tree *dst,
198 struct net_device *lag_dev)
202 dsa_lags_foreach_id(id, dst) {
203 struct dsa_lag *lag = dsa_lag_by_id(dst, id);
205 if (lag->dev == lag_dev)
212 /* TC matchall action types */
213 enum dsa_port_mall_action_type {
214 DSA_PORT_MALL_MIRROR,
215 DSA_PORT_MALL_POLICER,
218 /* TC mirroring entry */
219 struct dsa_mall_mirror_tc_entry {
224 /* TC port policer entry */
225 struct dsa_mall_policer_tc_entry {
227 u64 rate_bytes_per_sec;
230 /* TC matchall entry */
231 struct dsa_mall_tc_entry {
232 struct list_head list;
233 unsigned long cookie;
234 enum dsa_port_mall_action_type type;
236 struct dsa_mall_mirror_tc_entry mirror;
237 struct dsa_mall_policer_tc_entry policer;
242 struct net_device *dev;
249 /* A CPU port is physically connected to a master device.
250 * A user port exposed to userspace has a slave device.
253 struct net_device *master;
254 struct net_device *slave;
257 /* Copy of the tagging protocol operations, for quicker access
258 * in the data path. Valid only for the CPU ports.
260 const struct dsa_device_ops *tag_ops;
262 /* Copies for faster access in master receive hot path */
263 struct dsa_switch_tree *dst;
264 struct sk_buff *(*rcv)(struct sk_buff *skb, struct net_device *dev);
266 struct dsa_switch *ds;
271 DSA_PORT_TYPE_UNUSED = 0,
278 struct dsa_port *cpu_dp;
283 /* Warning: the following bit fields are not atomic, and updating them
284 * can only be done from code paths where concurrency is not possible
285 * (probe time or under rtnl_lock).
289 /* Managed by DSA on user ports and by drivers on CPU and DSA ports */
294 /* Master state bits, valid only on CPU ports */
295 u8 master_admin_up:1;
298 /* Valid only on user ports */
299 u8 cpu_port_in_lag:1;
303 struct device_node *dn;
304 unsigned int ageing_time;
306 struct dsa_bridge *bridge;
307 struct devlink_port devlink_port;
309 struct phylink_config pl_config;
311 struct net_device *hsr_dev;
313 struct list_head list;
316 * Original copy of the master netdev ethtool_ops
318 const struct ethtool_ops *orig_ethtool_ops;
321 * Original copy of the master netdev net_device_ops
323 const struct dsa_netdevice_ops *netdev_ops;
325 /* List of MAC addresses that must be forwarded on this port.
326 * These are only valid on CPU ports and DSA links.
328 struct mutex addr_lists_lock;
329 struct list_head fdbs;
330 struct list_head mdbs;
332 /* List of VLANs that CPU and DSA ports are members of. */
333 struct mutex vlans_lock;
334 struct list_head vlans;
337 /* TODO: ideally DSA ports would have a single dp->link_dp member,
338 * and no dst->rtable nor this struct dsa_link would be needed,
339 * but this would require some more complex tree walking,
340 * so keep it stupid at the moment and list them all.
344 struct dsa_port *link_dp;
345 struct list_head list;
355 enum dsa_db_type type;
358 const struct dsa_port *dp;
360 struct dsa_bridge bridge;
364 struct dsa_mac_addr {
365 unsigned char addr[ETH_ALEN];
368 struct list_head list;
375 struct list_head list;
382 * Parent switch tree, and switch index.
384 struct dsa_switch_tree *dst;
387 /* Warning: the following bit fields are not atomic, and updating them
388 * can only be done from code paths where concurrency is not possible
389 * (probe time or under rtnl_lock).
393 /* Disallow bridge core from requesting different VLAN awareness
394 * settings on ports if not hardware-supported
396 u32 vlan_filtering_is_global:1;
398 /* Keep VLAN filtering enabled on ports not offloading any upper */
399 u32 needs_standalone_vlan_filtering:1;
401 /* Pass .port_vlan_add and .port_vlan_del to drivers even for bridges
402 * that have vlan_filtering=0. All drivers should ideally set this (and
403 * then the option would get removed), but it is unknown whether this
404 * would break things or not.
406 u32 configure_vlan_while_not_filtering:1;
408 /* If the switch driver always programs the CPU port as egress tagged
409 * despite the VLAN configuration indicating otherwise, then setting
410 * @untag_bridge_pvid will force the DSA receive path to pop the
411 * bridge's default_pvid VLAN tagged frames to offer a consistent
412 * behavior between a vlan_filtering=0 and vlan_filtering=1 bridge
415 u32 untag_bridge_pvid:1;
417 /* Let DSA manage the FDB entries towards the
418 * CPU, based on the software bridge database.
420 u32 assisted_learning_on_cpu_port:1;
422 /* In case vlan_filtering_is_global is set, the VLAN awareness state
423 * should be retrieved from here and not from the per-port settings.
425 u32 vlan_filtering:1;
427 /* For switches that only have the MRU configurable. To ensure the
428 * configured MTU is not exceeded, normalization of MRU on all bridged
429 * interfaces is needed.
431 u32 mtu_enforcement_ingress:1;
433 /* Drivers that isolate the FDBs of multiple bridges must set this
434 * to true to receive the bridge as an argument in .port_fdb_{add,del}
435 * and .port_mdb_{add,del}. Otherwise, the bridge.num will always be
440 /* Listener for switch fabric events */
441 struct notifier_block nb;
444 * Give the switch driver somewhere to hang its private data
452 * Configuration data for this switch.
454 struct dsa_chip_data *cd;
457 * The switch operations.
459 const struct dsa_switch_ops *ops;
462 * Slave mii_bus and devices for the individual ports.
465 struct mii_bus *slave_mii_bus;
467 /* Ageing Time limits in msecs */
468 unsigned int ageing_time_min;
469 unsigned int ageing_time_max;
471 /* Storage for drivers using tag_8021q */
472 struct dsa_8021q_context *tag_8021q_ctx;
474 /* devlink used to represent this switch device */
475 struct devlink *devlink;
477 /* Number of switch port queues */
478 unsigned int num_tx_queues;
480 /* Drivers that benefit from having an ID associated with each
481 * offloaded LAG should set this to the maximum number of
482 * supported IDs. DSA will then maintain a mapping of _at
483 * least_ these many IDs, accessible to drivers via
486 unsigned int num_lag_ids;
488 /* Drivers that support bridge forwarding offload or FDB isolation
489 * should set this to the maximum number of bridges spanning the same
490 * switch tree (or all trees, in the case of cross-tree bridging
491 * support) that can be offloaded.
493 unsigned int max_num_bridges;
495 unsigned int num_ports;
498 static inline struct dsa_port *dsa_to_port(struct dsa_switch *ds, int p)
500 struct dsa_switch_tree *dst = ds->dst;
503 list_for_each_entry(dp, &dst->ports, list)
504 if (dp->ds == ds && dp->index == p)
510 static inline bool dsa_port_is_dsa(struct dsa_port *port)
512 return port->type == DSA_PORT_TYPE_DSA;
515 static inline bool dsa_port_is_cpu(struct dsa_port *port)
517 return port->type == DSA_PORT_TYPE_CPU;
520 static inline bool dsa_port_is_user(struct dsa_port *dp)
522 return dp->type == DSA_PORT_TYPE_USER;
525 static inline bool dsa_port_is_unused(struct dsa_port *dp)
527 return dp->type == DSA_PORT_TYPE_UNUSED;
530 static inline bool dsa_port_master_is_operational(struct dsa_port *dp)
532 return dsa_port_is_cpu(dp) && dp->master_admin_up &&
536 static inline bool dsa_is_unused_port(struct dsa_switch *ds, int p)
538 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_UNUSED;
541 static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p)
543 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_CPU;
546 static inline bool dsa_is_dsa_port(struct dsa_switch *ds, int p)
548 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_DSA;
551 static inline bool dsa_is_user_port(struct dsa_switch *ds, int p)
553 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_USER;
556 #define dsa_tree_for_each_user_port(_dp, _dst) \
557 list_for_each_entry((_dp), &(_dst)->ports, list) \
558 if (dsa_port_is_user((_dp)))
560 #define dsa_tree_for_each_user_port_continue_reverse(_dp, _dst) \
561 list_for_each_entry_continue_reverse((_dp), &(_dst)->ports, list) \
562 if (dsa_port_is_user((_dp)))
564 #define dsa_tree_for_each_cpu_port(_dp, _dst) \
565 list_for_each_entry((_dp), &(_dst)->ports, list) \
566 if (dsa_port_is_cpu((_dp)))
568 #define dsa_switch_for_each_port(_dp, _ds) \
569 list_for_each_entry((_dp), &(_ds)->dst->ports, list) \
570 if ((_dp)->ds == (_ds))
572 #define dsa_switch_for_each_port_safe(_dp, _next, _ds) \
573 list_for_each_entry_safe((_dp), (_next), &(_ds)->dst->ports, list) \
574 if ((_dp)->ds == (_ds))
576 #define dsa_switch_for_each_port_continue_reverse(_dp, _ds) \
577 list_for_each_entry_continue_reverse((_dp), &(_ds)->dst->ports, list) \
578 if ((_dp)->ds == (_ds))
580 #define dsa_switch_for_each_available_port(_dp, _ds) \
581 dsa_switch_for_each_port((_dp), (_ds)) \
582 if (!dsa_port_is_unused((_dp)))
584 #define dsa_switch_for_each_user_port(_dp, _ds) \
585 dsa_switch_for_each_port((_dp), (_ds)) \
586 if (dsa_port_is_user((_dp)))
588 #define dsa_switch_for_each_cpu_port(_dp, _ds) \
589 dsa_switch_for_each_port((_dp), (_ds)) \
590 if (dsa_port_is_cpu((_dp)))
592 #define dsa_switch_for_each_cpu_port_continue_reverse(_dp, _ds) \
593 dsa_switch_for_each_port_continue_reverse((_dp), (_ds)) \
594 if (dsa_port_is_cpu((_dp)))
596 static inline u32 dsa_user_ports(struct dsa_switch *ds)
601 dsa_switch_for_each_user_port(dp, ds)
602 mask |= BIT(dp->index);
607 static inline u32 dsa_cpu_ports(struct dsa_switch *ds)
609 struct dsa_port *cpu_dp;
612 dsa_switch_for_each_cpu_port(cpu_dp, ds)
613 mask |= BIT(cpu_dp->index);
618 /* Return the local port used to reach an arbitrary switch device */
619 static inline unsigned int dsa_routing_port(struct dsa_switch *ds, int device)
621 struct dsa_switch_tree *dst = ds->dst;
624 list_for_each_entry(dl, &dst->rtable, list)
625 if (dl->dp->ds == ds && dl->link_dp->ds->index == device)
626 return dl->dp->index;
628 return ds->num_ports;
631 /* Return the local port used to reach an arbitrary switch port */
632 static inline unsigned int dsa_towards_port(struct dsa_switch *ds, int device,
635 if (device == ds->index)
638 return dsa_routing_port(ds, device);
641 /* Return the local port used to reach the dedicated CPU port */
642 static inline unsigned int dsa_upstream_port(struct dsa_switch *ds, int port)
644 const struct dsa_port *dp = dsa_to_port(ds, port);
645 const struct dsa_port *cpu_dp = dp->cpu_dp;
650 return dsa_towards_port(ds, cpu_dp->ds->index, cpu_dp->index);
653 /* Return true if this is the local port used to reach the CPU port */
654 static inline bool dsa_is_upstream_port(struct dsa_switch *ds, int port)
656 if (dsa_is_unused_port(ds, port))
659 return port == dsa_upstream_port(ds, port);
662 /* Return true if this is a DSA port leading away from the CPU */
663 static inline bool dsa_is_downstream_port(struct dsa_switch *ds, int port)
665 return dsa_is_dsa_port(ds, port) && !dsa_is_upstream_port(ds, port);
668 /* Return the local port used to reach the CPU port */
669 static inline unsigned int dsa_switch_upstream_port(struct dsa_switch *ds)
673 dsa_switch_for_each_available_port(dp, ds) {
674 return dsa_upstream_port(ds, dp->index);
677 return ds->num_ports;
680 /* Return true if @upstream_ds is an upstream switch of @downstream_ds, meaning
681 * that the routing port from @downstream_ds to @upstream_ds is also the port
682 * which @downstream_ds uses to reach its dedicated CPU.
684 static inline bool dsa_switch_is_upstream_of(struct dsa_switch *upstream_ds,
685 struct dsa_switch *downstream_ds)
689 if (upstream_ds == downstream_ds)
692 routing_port = dsa_routing_port(downstream_ds, upstream_ds->index);
694 return dsa_is_upstream_port(downstream_ds, routing_port);
697 static inline bool dsa_port_is_vlan_filtering(const struct dsa_port *dp)
699 const struct dsa_switch *ds = dp->ds;
701 if (ds->vlan_filtering_is_global)
702 return ds->vlan_filtering;
704 return dp->vlan_filtering;
707 static inline unsigned int dsa_port_lag_id_get(struct dsa_port *dp)
709 return dp->lag ? dp->lag->id : 0;
712 static inline struct net_device *dsa_port_lag_dev_get(struct dsa_port *dp)
714 return dp->lag ? dp->lag->dev : NULL;
717 static inline bool dsa_port_offloads_lag(struct dsa_port *dp,
718 const struct dsa_lag *lag)
720 return dsa_port_lag_dev_get(dp) == lag->dev;
723 static inline struct net_device *dsa_port_to_master(const struct dsa_port *dp)
725 if (dp->cpu_port_in_lag)
726 return dsa_port_lag_dev_get(dp->cpu_dp);
728 return dp->cpu_dp->master;
732 struct net_device *dsa_port_to_bridge_port(const struct dsa_port *dp)
739 else if (dp->hsr_dev)
745 static inline struct net_device *
746 dsa_port_bridge_dev_get(const struct dsa_port *dp)
748 return dp->bridge ? dp->bridge->dev : NULL;
751 static inline unsigned int dsa_port_bridge_num_get(struct dsa_port *dp)
753 return dp->bridge ? dp->bridge->num : 0;
756 static inline bool dsa_port_bridge_same(const struct dsa_port *a,
757 const struct dsa_port *b)
759 struct net_device *br_a = dsa_port_bridge_dev_get(a);
760 struct net_device *br_b = dsa_port_bridge_dev_get(b);
762 /* Standalone ports are not in the same bridge with one another */
763 return (!br_a || !br_b) ? false : (br_a == br_b);
766 static inline bool dsa_port_offloads_bridge_port(struct dsa_port *dp,
767 const struct net_device *dev)
769 return dsa_port_to_bridge_port(dp) == dev;
773 dsa_port_offloads_bridge_dev(struct dsa_port *dp,
774 const struct net_device *bridge_dev)
776 /* DSA ports connected to a bridge, and event was emitted
779 return dsa_port_bridge_dev_get(dp) == bridge_dev;
782 static inline bool dsa_port_offloads_bridge(struct dsa_port *dp,
783 const struct dsa_bridge *bridge)
785 return dsa_port_bridge_dev_get(dp) == bridge->dev;
788 /* Returns true if any port of this tree offloads the given net_device */
789 static inline bool dsa_tree_offloads_bridge_port(struct dsa_switch_tree *dst,
790 const struct net_device *dev)
794 list_for_each_entry(dp, &dst->ports, list)
795 if (dsa_port_offloads_bridge_port(dp, dev))
801 /* Returns true if any port of this tree offloads the given bridge */
803 dsa_tree_offloads_bridge_dev(struct dsa_switch_tree *dst,
804 const struct net_device *bridge_dev)
808 list_for_each_entry(dp, &dst->ports, list)
809 if (dsa_port_offloads_bridge_dev(dp, bridge_dev))
815 static inline bool dsa_port_tree_same(const struct dsa_port *a,
816 const struct dsa_port *b)
818 return a->ds->dst == b->ds->dst;
821 typedef int dsa_fdb_dump_cb_t(const unsigned char *addr, u16 vid,
822 bool is_static, void *data);
823 struct dsa_switch_ops {
825 * Tagging protocol helpers called for the CPU ports and DSA links.
826 * @get_tag_protocol retrieves the initial tagging protocol and is
827 * mandatory. Switches which can operate using multiple tagging
828 * protocols should implement @change_tag_protocol and report in
829 * @get_tag_protocol the tagger in current use.
831 enum dsa_tag_protocol (*get_tag_protocol)(struct dsa_switch *ds,
833 enum dsa_tag_protocol mprot);
834 int (*change_tag_protocol)(struct dsa_switch *ds,
835 enum dsa_tag_protocol proto);
837 * Method for switch drivers to connect to the tagging protocol driver
838 * in current use. The switch driver can provide handlers for certain
839 * types of packets for switch management.
841 int (*connect_tag_protocol)(struct dsa_switch *ds,
842 enum dsa_tag_protocol proto);
844 int (*port_change_master)(struct dsa_switch *ds, int port,
845 struct net_device *master,
846 struct netlink_ext_ack *extack);
848 /* Optional switch-wide initialization and destruction methods */
849 int (*setup)(struct dsa_switch *ds);
850 void (*teardown)(struct dsa_switch *ds);
852 /* Per-port initialization and destruction methods. Mandatory if the
853 * driver registers devlink port regions, optional otherwise.
855 int (*port_setup)(struct dsa_switch *ds, int port);
856 void (*port_teardown)(struct dsa_switch *ds, int port);
858 u32 (*get_phy_flags)(struct dsa_switch *ds, int port);
861 * Access to the switch's PHY registers.
863 int (*phy_read)(struct dsa_switch *ds, int port, int regnum);
864 int (*phy_write)(struct dsa_switch *ds, int port,
865 int regnum, u16 val);
868 * Link state adjustment (called from libphy)
870 void (*adjust_link)(struct dsa_switch *ds, int port,
871 struct phy_device *phydev);
872 void (*fixed_link_update)(struct dsa_switch *ds, int port,
873 struct fixed_phy_status *st);
876 * PHYLINK integration
878 void (*phylink_get_caps)(struct dsa_switch *ds, int port,
879 struct phylink_config *config);
880 struct phylink_pcs *(*phylink_mac_select_pcs)(struct dsa_switch *ds,
882 phy_interface_t iface);
883 int (*phylink_mac_link_state)(struct dsa_switch *ds, int port,
884 struct phylink_link_state *state);
885 void (*phylink_mac_config)(struct dsa_switch *ds, int port,
887 const struct phylink_link_state *state);
888 void (*phylink_mac_an_restart)(struct dsa_switch *ds, int port);
889 void (*phylink_mac_link_down)(struct dsa_switch *ds, int port,
891 phy_interface_t interface);
892 void (*phylink_mac_link_up)(struct dsa_switch *ds, int port,
894 phy_interface_t interface,
895 struct phy_device *phydev,
896 int speed, int duplex,
897 bool tx_pause, bool rx_pause);
898 void (*phylink_fixed_state)(struct dsa_switch *ds, int port,
899 struct phylink_link_state *state);
901 * Port statistics counters.
903 void (*get_strings)(struct dsa_switch *ds, int port,
904 u32 stringset, uint8_t *data);
905 void (*get_ethtool_stats)(struct dsa_switch *ds,
906 int port, uint64_t *data);
907 int (*get_sset_count)(struct dsa_switch *ds, int port, int sset);
908 void (*get_ethtool_phy_stats)(struct dsa_switch *ds,
909 int port, uint64_t *data);
910 void (*get_eth_phy_stats)(struct dsa_switch *ds, int port,
911 struct ethtool_eth_phy_stats *phy_stats);
912 void (*get_eth_mac_stats)(struct dsa_switch *ds, int port,
913 struct ethtool_eth_mac_stats *mac_stats);
914 void (*get_eth_ctrl_stats)(struct dsa_switch *ds, int port,
915 struct ethtool_eth_ctrl_stats *ctrl_stats);
916 void (*get_rmon_stats)(struct dsa_switch *ds, int port,
917 struct ethtool_rmon_stats *rmon_stats,
918 const struct ethtool_rmon_hist_range **ranges);
919 void (*get_stats64)(struct dsa_switch *ds, int port,
920 struct rtnl_link_stats64 *s);
921 void (*get_pause_stats)(struct dsa_switch *ds, int port,
922 struct ethtool_pause_stats *pause_stats);
923 void (*self_test)(struct dsa_switch *ds, int port,
924 struct ethtool_test *etest, u64 *data);
927 * ethtool Wake-on-LAN
929 void (*get_wol)(struct dsa_switch *ds, int port,
930 struct ethtool_wolinfo *w);
931 int (*set_wol)(struct dsa_switch *ds, int port,
932 struct ethtool_wolinfo *w);
935 * ethtool timestamp info
937 int (*get_ts_info)(struct dsa_switch *ds, int port,
938 struct ethtool_ts_info *ts);
943 int (*port_get_default_prio)(struct dsa_switch *ds, int port);
944 int (*port_set_default_prio)(struct dsa_switch *ds, int port,
946 int (*port_get_dscp_prio)(struct dsa_switch *ds, int port, u8 dscp);
947 int (*port_add_dscp_prio)(struct dsa_switch *ds, int port, u8 dscp,
949 int (*port_del_dscp_prio)(struct dsa_switch *ds, int port, u8 dscp,
955 int (*suspend)(struct dsa_switch *ds);
956 int (*resume)(struct dsa_switch *ds);
959 * Port enable/disable
961 int (*port_enable)(struct dsa_switch *ds, int port,
962 struct phy_device *phy);
963 void (*port_disable)(struct dsa_switch *ds, int port);
966 * Port's MAC EEE settings
968 int (*set_mac_eee)(struct dsa_switch *ds, int port,
969 struct ethtool_eee *e);
970 int (*get_mac_eee)(struct dsa_switch *ds, int port,
971 struct ethtool_eee *e);
974 int (*get_eeprom_len)(struct dsa_switch *ds);
975 int (*get_eeprom)(struct dsa_switch *ds,
976 struct ethtool_eeprom *eeprom, u8 *data);
977 int (*set_eeprom)(struct dsa_switch *ds,
978 struct ethtool_eeprom *eeprom, u8 *data);
983 int (*get_regs_len)(struct dsa_switch *ds, int port);
984 void (*get_regs)(struct dsa_switch *ds, int port,
985 struct ethtool_regs *regs, void *p);
988 * Upper device tracking.
990 int (*port_prechangeupper)(struct dsa_switch *ds, int port,
991 struct netdev_notifier_changeupper_info *info);
996 int (*set_ageing_time)(struct dsa_switch *ds, unsigned int msecs);
997 int (*port_bridge_join)(struct dsa_switch *ds, int port,
998 struct dsa_bridge bridge,
999 bool *tx_fwd_offload,
1000 struct netlink_ext_ack *extack);
1001 void (*port_bridge_leave)(struct dsa_switch *ds, int port,
1002 struct dsa_bridge bridge);
1003 void (*port_stp_state_set)(struct dsa_switch *ds, int port,
1005 int (*port_mst_state_set)(struct dsa_switch *ds, int port,
1006 const struct switchdev_mst_state *state);
1007 void (*port_fast_age)(struct dsa_switch *ds, int port);
1008 int (*port_vlan_fast_age)(struct dsa_switch *ds, int port, u16 vid);
1009 int (*port_pre_bridge_flags)(struct dsa_switch *ds, int port,
1010 struct switchdev_brport_flags flags,
1011 struct netlink_ext_ack *extack);
1012 int (*port_bridge_flags)(struct dsa_switch *ds, int port,
1013 struct switchdev_brport_flags flags,
1014 struct netlink_ext_ack *extack);
1015 void (*port_set_host_flood)(struct dsa_switch *ds, int port,
1021 int (*port_vlan_filtering)(struct dsa_switch *ds, int port,
1022 bool vlan_filtering,
1023 struct netlink_ext_ack *extack);
1024 int (*port_vlan_add)(struct dsa_switch *ds, int port,
1025 const struct switchdev_obj_port_vlan *vlan,
1026 struct netlink_ext_ack *extack);
1027 int (*port_vlan_del)(struct dsa_switch *ds, int port,
1028 const struct switchdev_obj_port_vlan *vlan);
1029 int (*vlan_msti_set)(struct dsa_switch *ds, struct dsa_bridge bridge,
1030 const struct switchdev_vlan_msti *msti);
1033 * Forwarding database
1035 int (*port_fdb_add)(struct dsa_switch *ds, int port,
1036 const unsigned char *addr, u16 vid,
1038 int (*port_fdb_del)(struct dsa_switch *ds, int port,
1039 const unsigned char *addr, u16 vid,
1041 int (*port_fdb_dump)(struct dsa_switch *ds, int port,
1042 dsa_fdb_dump_cb_t *cb, void *data);
1043 int (*lag_fdb_add)(struct dsa_switch *ds, struct dsa_lag lag,
1044 const unsigned char *addr, u16 vid,
1046 int (*lag_fdb_del)(struct dsa_switch *ds, struct dsa_lag lag,
1047 const unsigned char *addr, u16 vid,
1051 * Multicast database
1053 int (*port_mdb_add)(struct dsa_switch *ds, int port,
1054 const struct switchdev_obj_port_mdb *mdb,
1056 int (*port_mdb_del)(struct dsa_switch *ds, int port,
1057 const struct switchdev_obj_port_mdb *mdb,
1062 int (*get_rxnfc)(struct dsa_switch *ds, int port,
1063 struct ethtool_rxnfc *nfc, u32 *rule_locs);
1064 int (*set_rxnfc)(struct dsa_switch *ds, int port,
1065 struct ethtool_rxnfc *nfc);
1070 int (*cls_flower_add)(struct dsa_switch *ds, int port,
1071 struct flow_cls_offload *cls, bool ingress);
1072 int (*cls_flower_del)(struct dsa_switch *ds, int port,
1073 struct flow_cls_offload *cls, bool ingress);
1074 int (*cls_flower_stats)(struct dsa_switch *ds, int port,
1075 struct flow_cls_offload *cls, bool ingress);
1076 int (*port_mirror_add)(struct dsa_switch *ds, int port,
1077 struct dsa_mall_mirror_tc_entry *mirror,
1078 bool ingress, struct netlink_ext_ack *extack);
1079 void (*port_mirror_del)(struct dsa_switch *ds, int port,
1080 struct dsa_mall_mirror_tc_entry *mirror);
1081 int (*port_policer_add)(struct dsa_switch *ds, int port,
1082 struct dsa_mall_policer_tc_entry *policer);
1083 void (*port_policer_del)(struct dsa_switch *ds, int port);
1084 int (*port_setup_tc)(struct dsa_switch *ds, int port,
1085 enum tc_setup_type type, void *type_data);
1088 * Cross-chip operations
1090 int (*crosschip_bridge_join)(struct dsa_switch *ds, int tree_index,
1091 int sw_index, int port,
1092 struct dsa_bridge bridge,
1093 struct netlink_ext_ack *extack);
1094 void (*crosschip_bridge_leave)(struct dsa_switch *ds, int tree_index,
1095 int sw_index, int port,
1096 struct dsa_bridge bridge);
1097 int (*crosschip_lag_change)(struct dsa_switch *ds, int sw_index,
1099 int (*crosschip_lag_join)(struct dsa_switch *ds, int sw_index,
1100 int port, struct dsa_lag lag,
1101 struct netdev_lag_upper_info *info,
1102 struct netlink_ext_ack *extack);
1103 int (*crosschip_lag_leave)(struct dsa_switch *ds, int sw_index,
1104 int port, struct dsa_lag lag);
1109 int (*port_hwtstamp_get)(struct dsa_switch *ds, int port,
1111 int (*port_hwtstamp_set)(struct dsa_switch *ds, int port,
1113 void (*port_txtstamp)(struct dsa_switch *ds, int port,
1114 struct sk_buff *skb);
1115 bool (*port_rxtstamp)(struct dsa_switch *ds, int port,
1116 struct sk_buff *skb, unsigned int type);
1118 /* Devlink parameters, etc */
1119 int (*devlink_param_get)(struct dsa_switch *ds, u32 id,
1120 struct devlink_param_gset_ctx *ctx);
1121 int (*devlink_param_set)(struct dsa_switch *ds, u32 id,
1122 struct devlink_param_gset_ctx *ctx);
1123 int (*devlink_info_get)(struct dsa_switch *ds,
1124 struct devlink_info_req *req,
1125 struct netlink_ext_ack *extack);
1126 int (*devlink_sb_pool_get)(struct dsa_switch *ds,
1127 unsigned int sb_index, u16 pool_index,
1128 struct devlink_sb_pool_info *pool_info);
1129 int (*devlink_sb_pool_set)(struct dsa_switch *ds, unsigned int sb_index,
1130 u16 pool_index, u32 size,
1131 enum devlink_sb_threshold_type threshold_type,
1132 struct netlink_ext_ack *extack);
1133 int (*devlink_sb_port_pool_get)(struct dsa_switch *ds, int port,
1134 unsigned int sb_index, u16 pool_index,
1136 int (*devlink_sb_port_pool_set)(struct dsa_switch *ds, int port,
1137 unsigned int sb_index, u16 pool_index,
1139 struct netlink_ext_ack *extack);
1140 int (*devlink_sb_tc_pool_bind_get)(struct dsa_switch *ds, int port,
1141 unsigned int sb_index, u16 tc_index,
1142 enum devlink_sb_pool_type pool_type,
1143 u16 *p_pool_index, u32 *p_threshold);
1144 int (*devlink_sb_tc_pool_bind_set)(struct dsa_switch *ds, int port,
1145 unsigned int sb_index, u16 tc_index,
1146 enum devlink_sb_pool_type pool_type,
1147 u16 pool_index, u32 threshold,
1148 struct netlink_ext_ack *extack);
1149 int (*devlink_sb_occ_snapshot)(struct dsa_switch *ds,
1150 unsigned int sb_index);
1151 int (*devlink_sb_occ_max_clear)(struct dsa_switch *ds,
1152 unsigned int sb_index);
1153 int (*devlink_sb_occ_port_pool_get)(struct dsa_switch *ds, int port,
1154 unsigned int sb_index, u16 pool_index,
1155 u32 *p_cur, u32 *p_max);
1156 int (*devlink_sb_occ_tc_port_bind_get)(struct dsa_switch *ds, int port,
1157 unsigned int sb_index, u16 tc_index,
1158 enum devlink_sb_pool_type pool_type,
1159 u32 *p_cur, u32 *p_max);
1162 * MTU change functionality. Switches can also adjust their MRU through
1163 * this method. By MTU, one understands the SDU (L2 payload) length.
1164 * If the switch needs to account for the DSA tag on the CPU port, this
1165 * method needs to do so privately.
1167 int (*port_change_mtu)(struct dsa_switch *ds, int port,
1169 int (*port_max_mtu)(struct dsa_switch *ds, int port);
1174 int (*port_lag_change)(struct dsa_switch *ds, int port);
1175 int (*port_lag_join)(struct dsa_switch *ds, int port,
1177 struct netdev_lag_upper_info *info,
1178 struct netlink_ext_ack *extack);
1179 int (*port_lag_leave)(struct dsa_switch *ds, int port,
1180 struct dsa_lag lag);
1185 int (*port_hsr_join)(struct dsa_switch *ds, int port,
1186 struct net_device *hsr);
1187 int (*port_hsr_leave)(struct dsa_switch *ds, int port,
1188 struct net_device *hsr);
1193 int (*port_mrp_add)(struct dsa_switch *ds, int port,
1194 const struct switchdev_obj_mrp *mrp);
1195 int (*port_mrp_del)(struct dsa_switch *ds, int port,
1196 const struct switchdev_obj_mrp *mrp);
1197 int (*port_mrp_add_ring_role)(struct dsa_switch *ds, int port,
1198 const struct switchdev_obj_ring_role_mrp *mrp);
1199 int (*port_mrp_del_ring_role)(struct dsa_switch *ds, int port,
1200 const struct switchdev_obj_ring_role_mrp *mrp);
1203 * tag_8021q operations
1205 int (*tag_8021q_vlan_add)(struct dsa_switch *ds, int port, u16 vid,
1207 int (*tag_8021q_vlan_del)(struct dsa_switch *ds, int port, u16 vid);
1210 * DSA master tracking operations
1212 void (*master_state_change)(struct dsa_switch *ds,
1213 const struct net_device *master,
1217 #define DSA_DEVLINK_PARAM_DRIVER(_id, _name, _type, _cmodes) \
1218 DEVLINK_PARAM_DRIVER(_id, _name, _type, _cmodes, \
1219 dsa_devlink_param_get, dsa_devlink_param_set, NULL)
1221 int dsa_devlink_param_get(struct devlink *dl, u32 id,
1222 struct devlink_param_gset_ctx *ctx);
1223 int dsa_devlink_param_set(struct devlink *dl, u32 id,
1224 struct devlink_param_gset_ctx *ctx);
1225 int dsa_devlink_params_register(struct dsa_switch *ds,
1226 const struct devlink_param *params,
1227 size_t params_count);
1228 void dsa_devlink_params_unregister(struct dsa_switch *ds,
1229 const struct devlink_param *params,
1230 size_t params_count);
1231 int dsa_devlink_resource_register(struct dsa_switch *ds,
1232 const char *resource_name,
1235 u64 parent_resource_id,
1236 const struct devlink_resource_size_params *size_params);
1238 void dsa_devlink_resources_unregister(struct dsa_switch *ds);
1240 void dsa_devlink_resource_occ_get_register(struct dsa_switch *ds,
1242 devlink_resource_occ_get_t *occ_get,
1243 void *occ_get_priv);
1244 void dsa_devlink_resource_occ_get_unregister(struct dsa_switch *ds,
1246 struct devlink_region *
1247 dsa_devlink_region_create(struct dsa_switch *ds,
1248 const struct devlink_region_ops *ops,
1249 u32 region_max_snapshots, u64 region_size);
1250 struct devlink_region *
1251 dsa_devlink_port_region_create(struct dsa_switch *ds,
1253 const struct devlink_port_region_ops *ops,
1254 u32 region_max_snapshots, u64 region_size);
1255 void dsa_devlink_region_destroy(struct devlink_region *region);
1257 struct dsa_port *dsa_port_from_netdev(struct net_device *netdev);
1259 struct dsa_devlink_priv {
1260 struct dsa_switch *ds;
1263 static inline struct dsa_switch *dsa_devlink_to_ds(struct devlink *dl)
1265 struct dsa_devlink_priv *dl_priv = devlink_priv(dl);
1271 struct dsa_switch *dsa_devlink_port_to_ds(struct devlink_port *port)
1273 struct devlink *dl = port->devlink;
1274 struct dsa_devlink_priv *dl_priv = devlink_priv(dl);
1279 static inline int dsa_devlink_port_to_port(struct devlink_port *port)
1284 struct dsa_switch_driver {
1285 struct list_head list;
1286 const struct dsa_switch_ops *ops;
1289 bool dsa_fdb_present_in_other_db(struct dsa_switch *ds, int port,
1290 const unsigned char *addr, u16 vid,
1292 bool dsa_mdb_present_in_other_db(struct dsa_switch *ds, int port,
1293 const struct switchdev_obj_port_mdb *mdb,
1296 /* Keep inline for faster access in hot path */
1297 static inline bool netdev_uses_dsa(const struct net_device *dev)
1299 #if IS_ENABLED(CONFIG_NET_DSA)
1300 return dev->dsa_ptr && dev->dsa_ptr->rcv;
1305 /* All DSA tags that push the EtherType to the right (basically all except tail
1306 * tags, which don't break dissection) can be treated the same from the
1307 * perspective of the flow dissector.
1309 * We need to return:
1310 * - offset: the (B - A) difference between:
1311 * A. the position of the real EtherType and
1312 * B. the current skb->data (aka ETH_HLEN bytes into the frame, aka 2 bytes
1313 * after the normal EtherType was supposed to be)
1314 * The offset in bytes is exactly equal to the tagger overhead (and half of
1315 * that, in __be16 shorts).
1317 * - proto: the value of the real EtherType.
1319 static inline void dsa_tag_generic_flow_dissect(const struct sk_buff *skb,
1320 __be16 *proto, int *offset)
1322 #if IS_ENABLED(CONFIG_NET_DSA)
1323 const struct dsa_device_ops *ops = skb->dev->dsa_ptr->tag_ops;
1324 int tag_len = ops->needed_headroom;
1327 *proto = ((__be16 *)skb->data)[(tag_len / 2) - 1];
1331 #if IS_ENABLED(CONFIG_NET_DSA)
1332 static inline int __dsa_netdevice_ops_check(struct net_device *dev)
1334 int err = -EOPNOTSUPP;
1339 if (!dev->dsa_ptr->netdev_ops)
1345 static inline int dsa_ndo_eth_ioctl(struct net_device *dev, struct ifreq *ifr,
1348 const struct dsa_netdevice_ops *ops;
1351 err = __dsa_netdevice_ops_check(dev);
1355 ops = dev->dsa_ptr->netdev_ops;
1357 return ops->ndo_eth_ioctl(dev, ifr, cmd);
1360 static inline int dsa_ndo_eth_ioctl(struct net_device *dev, struct ifreq *ifr,
1367 void dsa_unregister_switch(struct dsa_switch *ds);
1368 int dsa_register_switch(struct dsa_switch *ds);
1369 void dsa_switch_shutdown(struct dsa_switch *ds);
1370 struct dsa_switch *dsa_switch_find(int tree_index, int sw_index);
1371 void dsa_flush_workqueue(void);
1372 #ifdef CONFIG_PM_SLEEP
1373 int dsa_switch_suspend(struct dsa_switch *ds);
1374 int dsa_switch_resume(struct dsa_switch *ds);
1376 static inline int dsa_switch_suspend(struct dsa_switch *ds)
1380 static inline int dsa_switch_resume(struct dsa_switch *ds)
1384 #endif /* CONFIG_PM_SLEEP */
1386 #if IS_ENABLED(CONFIG_NET_DSA)
1387 bool dsa_slave_dev_check(const struct net_device *dev);
1389 static inline bool dsa_slave_dev_check(const struct net_device *dev)
1395 netdev_tx_t dsa_enqueue_skb(struct sk_buff *skb, struct net_device *dev);
1396 void dsa_port_phylink_mac_change(struct dsa_switch *ds, int port, bool up);