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;
113 struct net_device *dev;
115 struct mutex fdb_lock;
116 struct list_head fdbs;
120 struct dsa_switch_tree {
121 struct list_head list;
123 /* List of switch ports */
124 struct list_head ports;
126 /* Notifier chain for switch-wide events */
127 struct raw_notifier_head nh;
129 /* Tree identifier */
132 /* Number of switches attached to this tree */
133 struct kref refcount;
135 /* Maps offloaded LAG netdevs to a zero-based linear ID for
136 * drivers that need it.
138 struct dsa_lag **lags;
140 /* Tagging protocol operations */
141 const struct dsa_device_ops *tag_ops;
143 /* Default tagging protocol preferred by the switches in this
146 enum dsa_tag_protocol default_proto;
148 /* Has this tree been applied to the hardware? */
152 * Configuration data for the platform device that owns
153 * this dsa switch tree instance.
155 struct dsa_platform_data *pd;
157 /* List of DSA links composing the routing table */
158 struct list_head rtable;
160 /* Length of "lags" array */
161 unsigned int lags_len;
163 /* Track the largest switch index within a tree */
164 unsigned int last_switch;
167 /* LAG IDs are one-based, the dst->lags array is zero-based */
168 #define dsa_lags_foreach_id(_id, _dst) \
169 for ((_id) = 1; (_id) <= (_dst)->lags_len; (_id)++) \
170 if ((_dst)->lags[(_id) - 1])
172 #define dsa_lag_foreach_port(_dp, _dst, _lag) \
173 list_for_each_entry((_dp), &(_dst)->ports, list) \
174 if (dsa_port_offloads_lag((_dp), (_lag)))
176 #define dsa_hsr_foreach_port(_dp, _ds, _hsr) \
177 list_for_each_entry((_dp), &(_ds)->dst->ports, list) \
178 if ((_dp)->ds == (_ds) && (_dp)->hsr_dev == (_hsr))
180 static inline struct dsa_lag *dsa_lag_by_id(struct dsa_switch_tree *dst,
183 /* DSA LAG IDs are one-based, dst->lags is zero-based */
184 return dst->lags[id - 1];
187 static inline int dsa_lag_id(struct dsa_switch_tree *dst,
188 struct net_device *lag_dev)
192 dsa_lags_foreach_id(id, dst) {
193 struct dsa_lag *lag = dsa_lag_by_id(dst, id);
195 if (lag->dev == lag_dev)
202 /* TC matchall action types */
203 enum dsa_port_mall_action_type {
204 DSA_PORT_MALL_MIRROR,
205 DSA_PORT_MALL_POLICER,
208 /* TC mirroring entry */
209 struct dsa_mall_mirror_tc_entry {
214 /* TC port policer entry */
215 struct dsa_mall_policer_tc_entry {
217 u64 rate_bytes_per_sec;
220 /* TC matchall entry */
221 struct dsa_mall_tc_entry {
222 struct list_head list;
223 unsigned long cookie;
224 enum dsa_port_mall_action_type type;
226 struct dsa_mall_mirror_tc_entry mirror;
227 struct dsa_mall_policer_tc_entry policer;
232 struct net_device *dev;
239 /* A CPU port is physically connected to a master device.
240 * A user port exposed to userspace has a slave device.
243 struct net_device *master;
244 struct net_device *slave;
247 /* Copy of the tagging protocol operations, for quicker access
248 * in the data path. Valid only for the CPU ports.
250 const struct dsa_device_ops *tag_ops;
252 /* Copies for faster access in master receive hot path */
253 struct dsa_switch_tree *dst;
254 struct sk_buff *(*rcv)(struct sk_buff *skb, struct net_device *dev);
256 struct dsa_switch *ds;
261 DSA_PORT_TYPE_UNUSED = 0,
268 struct dsa_port *cpu_dp;
273 /* Warning: the following bit fields are not atomic, and updating them
274 * can only be done from code paths where concurrency is not possible
275 * (probe time or under rtnl_lock).
279 /* Managed by DSA on user ports and by drivers on CPU and DSA ports */
284 /* Master state bits, valid only on CPU ports */
285 u8 master_admin_up:1;
288 /* Valid only on user ports */
289 u8 cpu_port_in_lag:1;
293 struct device_node *dn;
294 unsigned int ageing_time;
296 struct dsa_bridge *bridge;
297 struct devlink_port devlink_port;
299 struct phylink_config pl_config;
301 struct net_device *hsr_dev;
303 struct list_head list;
306 * Original copy of the master netdev ethtool_ops
308 const struct ethtool_ops *orig_ethtool_ops;
310 /* List of MAC addresses that must be forwarded on this port.
311 * These are only valid on CPU ports and DSA links.
313 struct mutex addr_lists_lock;
314 struct list_head fdbs;
315 struct list_head mdbs;
317 struct mutex vlans_lock;
319 /* List of VLANs that CPU and DSA ports are members of.
320 * Access to this is serialized by the sleepable @vlans_lock.
322 struct list_head vlans;
323 /* List of VLANs that user ports are members of.
324 * Access to this is serialized by netif_addr_lock_bh().
326 struct list_head user_vlans;
330 /* TODO: ideally DSA ports would have a single dp->link_dp member,
331 * and no dst->rtable nor this struct dsa_link would be needed,
332 * but this would require some more complex tree walking,
333 * so keep it stupid at the moment and list them all.
337 struct dsa_port *link_dp;
338 struct list_head list;
348 enum dsa_db_type type;
351 const struct dsa_port *dp;
353 struct dsa_bridge bridge;
357 struct dsa_mac_addr {
358 unsigned char addr[ETH_ALEN];
361 struct list_head list;
368 struct list_head list;
375 * Parent switch tree, and switch index.
377 struct dsa_switch_tree *dst;
380 /* Warning: the following bit fields are not atomic, and updating them
381 * can only be done from code paths where concurrency is not possible
382 * (probe time or under rtnl_lock).
386 /* Disallow bridge core from requesting different VLAN awareness
387 * settings on ports if not hardware-supported
389 u32 vlan_filtering_is_global:1;
391 /* Keep VLAN filtering enabled on ports not offloading any upper */
392 u32 needs_standalone_vlan_filtering:1;
394 /* Pass .port_vlan_add and .port_vlan_del to drivers even for bridges
395 * that have vlan_filtering=0. All drivers should ideally set this (and
396 * then the option would get removed), but it is unknown whether this
397 * would break things or not.
399 u32 configure_vlan_while_not_filtering:1;
401 /* If the switch driver always programs the CPU port as egress tagged
402 * despite the VLAN configuration indicating otherwise, then setting
403 * @untag_bridge_pvid will force the DSA receive path to pop the
404 * bridge's default_pvid VLAN tagged frames to offer a consistent
405 * behavior between a vlan_filtering=0 and vlan_filtering=1 bridge
408 u32 untag_bridge_pvid:1;
410 /* Let DSA manage the FDB entries towards the
411 * CPU, based on the software bridge database.
413 u32 assisted_learning_on_cpu_port:1;
415 /* In case vlan_filtering_is_global is set, the VLAN awareness state
416 * should be retrieved from here and not from the per-port settings.
418 u32 vlan_filtering:1;
420 /* For switches that only have the MRU configurable. To ensure the
421 * configured MTU is not exceeded, normalization of MRU on all bridged
422 * interfaces is needed.
424 u32 mtu_enforcement_ingress:1;
426 /* Drivers that isolate the FDBs of multiple bridges must set this
427 * to true to receive the bridge as an argument in .port_fdb_{add,del}
428 * and .port_mdb_{add,del}. Otherwise, the bridge.num will always be
433 /* Listener for switch fabric events */
434 struct notifier_block nb;
437 * Give the switch driver somewhere to hang its private data
445 * Configuration data for this switch.
447 struct dsa_chip_data *cd;
450 * The switch operations.
452 const struct dsa_switch_ops *ops;
455 * Slave mii_bus and devices for the individual ports.
458 struct mii_bus *slave_mii_bus;
460 /* Ageing Time limits in msecs */
461 unsigned int ageing_time_min;
462 unsigned int ageing_time_max;
464 /* Storage for drivers using tag_8021q */
465 struct dsa_8021q_context *tag_8021q_ctx;
467 /* devlink used to represent this switch device */
468 struct devlink *devlink;
470 /* Number of switch port queues */
471 unsigned int num_tx_queues;
473 /* Drivers that benefit from having an ID associated with each
474 * offloaded LAG should set this to the maximum number of
475 * supported IDs. DSA will then maintain a mapping of _at
476 * least_ these many IDs, accessible to drivers via
479 unsigned int num_lag_ids;
481 /* Drivers that support bridge forwarding offload or FDB isolation
482 * should set this to the maximum number of bridges spanning the same
483 * switch tree (or all trees, in the case of cross-tree bridging
484 * support) that can be offloaded.
486 unsigned int max_num_bridges;
488 unsigned int num_ports;
491 static inline struct dsa_port *dsa_to_port(struct dsa_switch *ds, int p)
493 struct dsa_switch_tree *dst = ds->dst;
496 list_for_each_entry(dp, &dst->ports, list)
497 if (dp->ds == ds && dp->index == p)
503 static inline bool dsa_port_is_dsa(struct dsa_port *port)
505 return port->type == DSA_PORT_TYPE_DSA;
508 static inline bool dsa_port_is_cpu(struct dsa_port *port)
510 return port->type == DSA_PORT_TYPE_CPU;
513 static inline bool dsa_port_is_user(struct dsa_port *dp)
515 return dp->type == DSA_PORT_TYPE_USER;
518 static inline bool dsa_port_is_unused(struct dsa_port *dp)
520 return dp->type == DSA_PORT_TYPE_UNUSED;
523 static inline bool dsa_port_master_is_operational(struct dsa_port *dp)
525 return dsa_port_is_cpu(dp) && dp->master_admin_up &&
529 static inline bool dsa_is_unused_port(struct dsa_switch *ds, int p)
531 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_UNUSED;
534 static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p)
536 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_CPU;
539 static inline bool dsa_is_dsa_port(struct dsa_switch *ds, int p)
541 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_DSA;
544 static inline bool dsa_is_user_port(struct dsa_switch *ds, int p)
546 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_USER;
549 #define dsa_tree_for_each_user_port(_dp, _dst) \
550 list_for_each_entry((_dp), &(_dst)->ports, list) \
551 if (dsa_port_is_user((_dp)))
553 #define dsa_tree_for_each_user_port_continue_reverse(_dp, _dst) \
554 list_for_each_entry_continue_reverse((_dp), &(_dst)->ports, list) \
555 if (dsa_port_is_user((_dp)))
557 #define dsa_tree_for_each_cpu_port(_dp, _dst) \
558 list_for_each_entry((_dp), &(_dst)->ports, list) \
559 if (dsa_port_is_cpu((_dp)))
561 #define dsa_switch_for_each_port(_dp, _ds) \
562 list_for_each_entry((_dp), &(_ds)->dst->ports, list) \
563 if ((_dp)->ds == (_ds))
565 #define dsa_switch_for_each_port_safe(_dp, _next, _ds) \
566 list_for_each_entry_safe((_dp), (_next), &(_ds)->dst->ports, list) \
567 if ((_dp)->ds == (_ds))
569 #define dsa_switch_for_each_port_continue_reverse(_dp, _ds) \
570 list_for_each_entry_continue_reverse((_dp), &(_ds)->dst->ports, list) \
571 if ((_dp)->ds == (_ds))
573 #define dsa_switch_for_each_available_port(_dp, _ds) \
574 dsa_switch_for_each_port((_dp), (_ds)) \
575 if (!dsa_port_is_unused((_dp)))
577 #define dsa_switch_for_each_user_port(_dp, _ds) \
578 dsa_switch_for_each_port((_dp), (_ds)) \
579 if (dsa_port_is_user((_dp)))
581 #define dsa_switch_for_each_cpu_port(_dp, _ds) \
582 dsa_switch_for_each_port((_dp), (_ds)) \
583 if (dsa_port_is_cpu((_dp)))
585 #define dsa_switch_for_each_cpu_port_continue_reverse(_dp, _ds) \
586 dsa_switch_for_each_port_continue_reverse((_dp), (_ds)) \
587 if (dsa_port_is_cpu((_dp)))
589 static inline u32 dsa_user_ports(struct dsa_switch *ds)
594 dsa_switch_for_each_user_port(dp, ds)
595 mask |= BIT(dp->index);
600 static inline u32 dsa_cpu_ports(struct dsa_switch *ds)
602 struct dsa_port *cpu_dp;
605 dsa_switch_for_each_cpu_port(cpu_dp, ds)
606 mask |= BIT(cpu_dp->index);
611 /* Return the local port used to reach an arbitrary switch device */
612 static inline unsigned int dsa_routing_port(struct dsa_switch *ds, int device)
614 struct dsa_switch_tree *dst = ds->dst;
617 list_for_each_entry(dl, &dst->rtable, list)
618 if (dl->dp->ds == ds && dl->link_dp->ds->index == device)
619 return dl->dp->index;
621 return ds->num_ports;
624 /* Return the local port used to reach an arbitrary switch port */
625 static inline unsigned int dsa_towards_port(struct dsa_switch *ds, int device,
628 if (device == ds->index)
631 return dsa_routing_port(ds, device);
634 /* Return the local port used to reach the dedicated CPU port */
635 static inline unsigned int dsa_upstream_port(struct dsa_switch *ds, int port)
637 const struct dsa_port *dp = dsa_to_port(ds, port);
638 const struct dsa_port *cpu_dp = dp->cpu_dp;
643 return dsa_towards_port(ds, cpu_dp->ds->index, cpu_dp->index);
646 /* Return true if this is the local port used to reach the CPU port */
647 static inline bool dsa_is_upstream_port(struct dsa_switch *ds, int port)
649 if (dsa_is_unused_port(ds, port))
652 return port == dsa_upstream_port(ds, port);
655 /* Return true if this is a DSA port leading away from the CPU */
656 static inline bool dsa_is_downstream_port(struct dsa_switch *ds, int port)
658 return dsa_is_dsa_port(ds, port) && !dsa_is_upstream_port(ds, port);
661 /* Return the local port used to reach the CPU port */
662 static inline unsigned int dsa_switch_upstream_port(struct dsa_switch *ds)
666 dsa_switch_for_each_available_port(dp, ds) {
667 return dsa_upstream_port(ds, dp->index);
670 return ds->num_ports;
673 /* Return true if @upstream_ds is an upstream switch of @downstream_ds, meaning
674 * that the routing port from @downstream_ds to @upstream_ds is also the port
675 * which @downstream_ds uses to reach its dedicated CPU.
677 static inline bool dsa_switch_is_upstream_of(struct dsa_switch *upstream_ds,
678 struct dsa_switch *downstream_ds)
682 if (upstream_ds == downstream_ds)
685 routing_port = dsa_routing_port(downstream_ds, upstream_ds->index);
687 return dsa_is_upstream_port(downstream_ds, routing_port);
690 static inline bool dsa_port_is_vlan_filtering(const struct dsa_port *dp)
692 const struct dsa_switch *ds = dp->ds;
694 if (ds->vlan_filtering_is_global)
695 return ds->vlan_filtering;
697 return dp->vlan_filtering;
700 static inline unsigned int dsa_port_lag_id_get(struct dsa_port *dp)
702 return dp->lag ? dp->lag->id : 0;
705 static inline struct net_device *dsa_port_lag_dev_get(struct dsa_port *dp)
707 return dp->lag ? dp->lag->dev : NULL;
710 static inline bool dsa_port_offloads_lag(struct dsa_port *dp,
711 const struct dsa_lag *lag)
713 return dsa_port_lag_dev_get(dp) == lag->dev;
716 static inline struct net_device *dsa_port_to_master(const struct dsa_port *dp)
718 if (dp->cpu_port_in_lag)
719 return dsa_port_lag_dev_get(dp->cpu_dp);
721 return dp->cpu_dp->master;
725 struct net_device *dsa_port_to_bridge_port(const struct dsa_port *dp)
732 else if (dp->hsr_dev)
738 static inline struct net_device *
739 dsa_port_bridge_dev_get(const struct dsa_port *dp)
741 return dp->bridge ? dp->bridge->dev : NULL;
744 static inline unsigned int dsa_port_bridge_num_get(struct dsa_port *dp)
746 return dp->bridge ? dp->bridge->num : 0;
749 static inline bool dsa_port_bridge_same(const struct dsa_port *a,
750 const struct dsa_port *b)
752 struct net_device *br_a = dsa_port_bridge_dev_get(a);
753 struct net_device *br_b = dsa_port_bridge_dev_get(b);
755 /* Standalone ports are not in the same bridge with one another */
756 return (!br_a || !br_b) ? false : (br_a == br_b);
759 static inline bool dsa_port_offloads_bridge_port(struct dsa_port *dp,
760 const struct net_device *dev)
762 return dsa_port_to_bridge_port(dp) == dev;
766 dsa_port_offloads_bridge_dev(struct dsa_port *dp,
767 const struct net_device *bridge_dev)
769 /* DSA ports connected to a bridge, and event was emitted
772 return dsa_port_bridge_dev_get(dp) == bridge_dev;
775 static inline bool dsa_port_offloads_bridge(struct dsa_port *dp,
776 const struct dsa_bridge *bridge)
778 return dsa_port_bridge_dev_get(dp) == bridge->dev;
781 /* Returns true if any port of this tree offloads the given net_device */
782 static inline bool dsa_tree_offloads_bridge_port(struct dsa_switch_tree *dst,
783 const struct net_device *dev)
787 list_for_each_entry(dp, &dst->ports, list)
788 if (dsa_port_offloads_bridge_port(dp, dev))
794 /* Returns true if any port of this tree offloads the given bridge */
796 dsa_tree_offloads_bridge_dev(struct dsa_switch_tree *dst,
797 const struct net_device *bridge_dev)
801 list_for_each_entry(dp, &dst->ports, list)
802 if (dsa_port_offloads_bridge_dev(dp, bridge_dev))
808 static inline bool dsa_port_tree_same(const struct dsa_port *a,
809 const struct dsa_port *b)
811 return a->ds->dst == b->ds->dst;
814 typedef int dsa_fdb_dump_cb_t(const unsigned char *addr, u16 vid,
815 bool is_static, void *data);
816 struct dsa_switch_ops {
818 * Tagging protocol helpers called for the CPU ports and DSA links.
819 * @get_tag_protocol retrieves the initial tagging protocol and is
820 * mandatory. Switches which can operate using multiple tagging
821 * protocols should implement @change_tag_protocol and report in
822 * @get_tag_protocol the tagger in current use.
824 enum dsa_tag_protocol (*get_tag_protocol)(struct dsa_switch *ds,
826 enum dsa_tag_protocol mprot);
827 int (*change_tag_protocol)(struct dsa_switch *ds,
828 enum dsa_tag_protocol proto);
830 * Method for switch drivers to connect to the tagging protocol driver
831 * in current use. The switch driver can provide handlers for certain
832 * types of packets for switch management.
834 int (*connect_tag_protocol)(struct dsa_switch *ds,
835 enum dsa_tag_protocol proto);
837 int (*port_change_master)(struct dsa_switch *ds, int port,
838 struct net_device *master,
839 struct netlink_ext_ack *extack);
841 /* Optional switch-wide initialization and destruction methods */
842 int (*setup)(struct dsa_switch *ds);
843 void (*teardown)(struct dsa_switch *ds);
845 /* Per-port initialization and destruction methods. Mandatory if the
846 * driver registers devlink port regions, optional otherwise.
848 int (*port_setup)(struct dsa_switch *ds, int port);
849 void (*port_teardown)(struct dsa_switch *ds, int port);
851 u32 (*get_phy_flags)(struct dsa_switch *ds, int port);
854 * Access to the switch's PHY registers.
856 int (*phy_read)(struct dsa_switch *ds, int port, int regnum);
857 int (*phy_write)(struct dsa_switch *ds, int port,
858 int regnum, u16 val);
861 * Link state adjustment (called from libphy)
863 void (*adjust_link)(struct dsa_switch *ds, int port,
864 struct phy_device *phydev);
865 void (*fixed_link_update)(struct dsa_switch *ds, int port,
866 struct fixed_phy_status *st);
869 * PHYLINK integration
871 void (*phylink_get_caps)(struct dsa_switch *ds, int port,
872 struct phylink_config *config);
873 struct phylink_pcs *(*phylink_mac_select_pcs)(struct dsa_switch *ds,
875 phy_interface_t iface);
876 int (*phylink_mac_prepare)(struct dsa_switch *ds, int port,
878 phy_interface_t interface);
879 void (*phylink_mac_config)(struct dsa_switch *ds, int port,
881 const struct phylink_link_state *state);
882 int (*phylink_mac_finish)(struct dsa_switch *ds, int port,
884 phy_interface_t interface);
885 void (*phylink_mac_link_down)(struct dsa_switch *ds, int port,
887 phy_interface_t interface);
888 void (*phylink_mac_link_up)(struct dsa_switch *ds, int port,
890 phy_interface_t interface,
891 struct phy_device *phydev,
892 int speed, int duplex,
893 bool tx_pause, bool rx_pause);
894 void (*phylink_fixed_state)(struct dsa_switch *ds, int port,
895 struct phylink_link_state *state);
897 * Port statistics counters.
899 void (*get_strings)(struct dsa_switch *ds, int port,
900 u32 stringset, uint8_t *data);
901 void (*get_ethtool_stats)(struct dsa_switch *ds,
902 int port, uint64_t *data);
903 int (*get_sset_count)(struct dsa_switch *ds, int port, int sset);
904 void (*get_ethtool_phy_stats)(struct dsa_switch *ds,
905 int port, uint64_t *data);
906 void (*get_eth_phy_stats)(struct dsa_switch *ds, int port,
907 struct ethtool_eth_phy_stats *phy_stats);
908 void (*get_eth_mac_stats)(struct dsa_switch *ds, int port,
909 struct ethtool_eth_mac_stats *mac_stats);
910 void (*get_eth_ctrl_stats)(struct dsa_switch *ds, int port,
911 struct ethtool_eth_ctrl_stats *ctrl_stats);
912 void (*get_rmon_stats)(struct dsa_switch *ds, int port,
913 struct ethtool_rmon_stats *rmon_stats,
914 const struct ethtool_rmon_hist_range **ranges);
915 void (*get_stats64)(struct dsa_switch *ds, int port,
916 struct rtnl_link_stats64 *s);
917 void (*get_pause_stats)(struct dsa_switch *ds, int port,
918 struct ethtool_pause_stats *pause_stats);
919 void (*self_test)(struct dsa_switch *ds, int port,
920 struct ethtool_test *etest, u64 *data);
923 * ethtool Wake-on-LAN
925 void (*get_wol)(struct dsa_switch *ds, int port,
926 struct ethtool_wolinfo *w);
927 int (*set_wol)(struct dsa_switch *ds, int port,
928 struct ethtool_wolinfo *w);
931 * ethtool timestamp info
933 int (*get_ts_info)(struct dsa_switch *ds, int port,
934 struct ethtool_ts_info *ts);
937 * ethtool MAC merge layer
939 int (*get_mm)(struct dsa_switch *ds, int port,
940 struct ethtool_mm_state *state);
941 int (*set_mm)(struct dsa_switch *ds, int port,
942 struct ethtool_mm_cfg *cfg,
943 struct netlink_ext_ack *extack);
944 void (*get_mm_stats)(struct dsa_switch *ds, int port,
945 struct ethtool_mm_stats *stats);
950 int (*port_get_default_prio)(struct dsa_switch *ds, int port);
951 int (*port_set_default_prio)(struct dsa_switch *ds, int port,
953 int (*port_get_dscp_prio)(struct dsa_switch *ds, int port, u8 dscp);
954 int (*port_add_dscp_prio)(struct dsa_switch *ds, int port, u8 dscp,
956 int (*port_del_dscp_prio)(struct dsa_switch *ds, int port, u8 dscp,
962 int (*suspend)(struct dsa_switch *ds);
963 int (*resume)(struct dsa_switch *ds);
966 * Port enable/disable
968 int (*port_enable)(struct dsa_switch *ds, int port,
969 struct phy_device *phy);
970 void (*port_disable)(struct dsa_switch *ds, int port);
973 * Compatibility between device trees defining multiple CPU ports and
974 * drivers which are not OK to use by default the numerically smallest
975 * CPU port of a switch for its local ports. This can return NULL,
976 * meaning "don't know/don't care".
978 struct dsa_port *(*preferred_default_local_cpu_port)(struct dsa_switch *ds);
981 * Port's MAC EEE settings
983 int (*set_mac_eee)(struct dsa_switch *ds, int port,
984 struct ethtool_eee *e);
985 int (*get_mac_eee)(struct dsa_switch *ds, int port,
986 struct ethtool_eee *e);
989 int (*get_eeprom_len)(struct dsa_switch *ds);
990 int (*get_eeprom)(struct dsa_switch *ds,
991 struct ethtool_eeprom *eeprom, u8 *data);
992 int (*set_eeprom)(struct dsa_switch *ds,
993 struct ethtool_eeprom *eeprom, u8 *data);
998 int (*get_regs_len)(struct dsa_switch *ds, int port);
999 void (*get_regs)(struct dsa_switch *ds, int port,
1000 struct ethtool_regs *regs, void *p);
1003 * Upper device tracking.
1005 int (*port_prechangeupper)(struct dsa_switch *ds, int port,
1006 struct netdev_notifier_changeupper_info *info);
1009 * Bridge integration
1011 int (*set_ageing_time)(struct dsa_switch *ds, unsigned int msecs);
1012 int (*port_bridge_join)(struct dsa_switch *ds, int port,
1013 struct dsa_bridge bridge,
1014 bool *tx_fwd_offload,
1015 struct netlink_ext_ack *extack);
1016 void (*port_bridge_leave)(struct dsa_switch *ds, int port,
1017 struct dsa_bridge bridge);
1018 void (*port_stp_state_set)(struct dsa_switch *ds, int port,
1020 int (*port_mst_state_set)(struct dsa_switch *ds, int port,
1021 const struct switchdev_mst_state *state);
1022 void (*port_fast_age)(struct dsa_switch *ds, int port);
1023 int (*port_vlan_fast_age)(struct dsa_switch *ds, int port, u16 vid);
1024 int (*port_pre_bridge_flags)(struct dsa_switch *ds, int port,
1025 struct switchdev_brport_flags flags,
1026 struct netlink_ext_ack *extack);
1027 int (*port_bridge_flags)(struct dsa_switch *ds, int port,
1028 struct switchdev_brport_flags flags,
1029 struct netlink_ext_ack *extack);
1030 void (*port_set_host_flood)(struct dsa_switch *ds, int port,
1036 int (*port_vlan_filtering)(struct dsa_switch *ds, int port,
1037 bool vlan_filtering,
1038 struct netlink_ext_ack *extack);
1039 int (*port_vlan_add)(struct dsa_switch *ds, int port,
1040 const struct switchdev_obj_port_vlan *vlan,
1041 struct netlink_ext_ack *extack);
1042 int (*port_vlan_del)(struct dsa_switch *ds, int port,
1043 const struct switchdev_obj_port_vlan *vlan);
1044 int (*vlan_msti_set)(struct dsa_switch *ds, struct dsa_bridge bridge,
1045 const struct switchdev_vlan_msti *msti);
1048 * Forwarding database
1050 int (*port_fdb_add)(struct dsa_switch *ds, int port,
1051 const unsigned char *addr, u16 vid,
1053 int (*port_fdb_del)(struct dsa_switch *ds, int port,
1054 const unsigned char *addr, u16 vid,
1056 int (*port_fdb_dump)(struct dsa_switch *ds, int port,
1057 dsa_fdb_dump_cb_t *cb, void *data);
1058 int (*lag_fdb_add)(struct dsa_switch *ds, struct dsa_lag lag,
1059 const unsigned char *addr, u16 vid,
1061 int (*lag_fdb_del)(struct dsa_switch *ds, struct dsa_lag lag,
1062 const unsigned char *addr, u16 vid,
1066 * Multicast database
1068 int (*port_mdb_add)(struct dsa_switch *ds, int port,
1069 const struct switchdev_obj_port_mdb *mdb,
1071 int (*port_mdb_del)(struct dsa_switch *ds, int port,
1072 const struct switchdev_obj_port_mdb *mdb,
1077 int (*get_rxnfc)(struct dsa_switch *ds, int port,
1078 struct ethtool_rxnfc *nfc, u32 *rule_locs);
1079 int (*set_rxnfc)(struct dsa_switch *ds, int port,
1080 struct ethtool_rxnfc *nfc);
1085 int (*cls_flower_add)(struct dsa_switch *ds, int port,
1086 struct flow_cls_offload *cls, bool ingress);
1087 int (*cls_flower_del)(struct dsa_switch *ds, int port,
1088 struct flow_cls_offload *cls, bool ingress);
1089 int (*cls_flower_stats)(struct dsa_switch *ds, int port,
1090 struct flow_cls_offload *cls, bool ingress);
1091 int (*port_mirror_add)(struct dsa_switch *ds, int port,
1092 struct dsa_mall_mirror_tc_entry *mirror,
1093 bool ingress, struct netlink_ext_ack *extack);
1094 void (*port_mirror_del)(struct dsa_switch *ds, int port,
1095 struct dsa_mall_mirror_tc_entry *mirror);
1096 int (*port_policer_add)(struct dsa_switch *ds, int port,
1097 struct dsa_mall_policer_tc_entry *policer);
1098 void (*port_policer_del)(struct dsa_switch *ds, int port);
1099 int (*port_setup_tc)(struct dsa_switch *ds, int port,
1100 enum tc_setup_type type, void *type_data);
1103 * Cross-chip operations
1105 int (*crosschip_bridge_join)(struct dsa_switch *ds, int tree_index,
1106 int sw_index, int port,
1107 struct dsa_bridge bridge,
1108 struct netlink_ext_ack *extack);
1109 void (*crosschip_bridge_leave)(struct dsa_switch *ds, int tree_index,
1110 int sw_index, int port,
1111 struct dsa_bridge bridge);
1112 int (*crosschip_lag_change)(struct dsa_switch *ds, int sw_index,
1114 int (*crosschip_lag_join)(struct dsa_switch *ds, int sw_index,
1115 int port, struct dsa_lag lag,
1116 struct netdev_lag_upper_info *info,
1117 struct netlink_ext_ack *extack);
1118 int (*crosschip_lag_leave)(struct dsa_switch *ds, int sw_index,
1119 int port, struct dsa_lag lag);
1124 int (*port_hwtstamp_get)(struct dsa_switch *ds, int port,
1126 int (*port_hwtstamp_set)(struct dsa_switch *ds, int port,
1128 void (*port_txtstamp)(struct dsa_switch *ds, int port,
1129 struct sk_buff *skb);
1130 bool (*port_rxtstamp)(struct dsa_switch *ds, int port,
1131 struct sk_buff *skb, unsigned int type);
1133 /* Devlink parameters, etc */
1134 int (*devlink_param_get)(struct dsa_switch *ds, u32 id,
1135 struct devlink_param_gset_ctx *ctx);
1136 int (*devlink_param_set)(struct dsa_switch *ds, u32 id,
1137 struct devlink_param_gset_ctx *ctx);
1138 int (*devlink_info_get)(struct dsa_switch *ds,
1139 struct devlink_info_req *req,
1140 struct netlink_ext_ack *extack);
1141 int (*devlink_sb_pool_get)(struct dsa_switch *ds,
1142 unsigned int sb_index, u16 pool_index,
1143 struct devlink_sb_pool_info *pool_info);
1144 int (*devlink_sb_pool_set)(struct dsa_switch *ds, unsigned int sb_index,
1145 u16 pool_index, u32 size,
1146 enum devlink_sb_threshold_type threshold_type,
1147 struct netlink_ext_ack *extack);
1148 int (*devlink_sb_port_pool_get)(struct dsa_switch *ds, int port,
1149 unsigned int sb_index, u16 pool_index,
1151 int (*devlink_sb_port_pool_set)(struct dsa_switch *ds, int port,
1152 unsigned int sb_index, u16 pool_index,
1154 struct netlink_ext_ack *extack);
1155 int (*devlink_sb_tc_pool_bind_get)(struct dsa_switch *ds, int port,
1156 unsigned int sb_index, u16 tc_index,
1157 enum devlink_sb_pool_type pool_type,
1158 u16 *p_pool_index, u32 *p_threshold);
1159 int (*devlink_sb_tc_pool_bind_set)(struct dsa_switch *ds, int port,
1160 unsigned int sb_index, u16 tc_index,
1161 enum devlink_sb_pool_type pool_type,
1162 u16 pool_index, u32 threshold,
1163 struct netlink_ext_ack *extack);
1164 int (*devlink_sb_occ_snapshot)(struct dsa_switch *ds,
1165 unsigned int sb_index);
1166 int (*devlink_sb_occ_max_clear)(struct dsa_switch *ds,
1167 unsigned int sb_index);
1168 int (*devlink_sb_occ_port_pool_get)(struct dsa_switch *ds, int port,
1169 unsigned int sb_index, u16 pool_index,
1170 u32 *p_cur, u32 *p_max);
1171 int (*devlink_sb_occ_tc_port_bind_get)(struct dsa_switch *ds, int port,
1172 unsigned int sb_index, u16 tc_index,
1173 enum devlink_sb_pool_type pool_type,
1174 u32 *p_cur, u32 *p_max);
1177 * MTU change functionality. Switches can also adjust their MRU through
1178 * this method. By MTU, one understands the SDU (L2 payload) length.
1179 * If the switch needs to account for the DSA tag on the CPU port, this
1180 * method needs to do so privately.
1182 int (*port_change_mtu)(struct dsa_switch *ds, int port,
1184 int (*port_max_mtu)(struct dsa_switch *ds, int port);
1189 int (*port_lag_change)(struct dsa_switch *ds, int port);
1190 int (*port_lag_join)(struct dsa_switch *ds, int port,
1192 struct netdev_lag_upper_info *info,
1193 struct netlink_ext_ack *extack);
1194 int (*port_lag_leave)(struct dsa_switch *ds, int port,
1195 struct dsa_lag lag);
1200 int (*port_hsr_join)(struct dsa_switch *ds, int port,
1201 struct net_device *hsr);
1202 int (*port_hsr_leave)(struct dsa_switch *ds, int port,
1203 struct net_device *hsr);
1208 int (*port_mrp_add)(struct dsa_switch *ds, int port,
1209 const struct switchdev_obj_mrp *mrp);
1210 int (*port_mrp_del)(struct dsa_switch *ds, int port,
1211 const struct switchdev_obj_mrp *mrp);
1212 int (*port_mrp_add_ring_role)(struct dsa_switch *ds, int port,
1213 const struct switchdev_obj_ring_role_mrp *mrp);
1214 int (*port_mrp_del_ring_role)(struct dsa_switch *ds, int port,
1215 const struct switchdev_obj_ring_role_mrp *mrp);
1218 * tag_8021q operations
1220 int (*tag_8021q_vlan_add)(struct dsa_switch *ds, int port, u16 vid,
1222 int (*tag_8021q_vlan_del)(struct dsa_switch *ds, int port, u16 vid);
1225 * DSA master tracking operations
1227 void (*master_state_change)(struct dsa_switch *ds,
1228 const struct net_device *master,
1232 #define DSA_DEVLINK_PARAM_DRIVER(_id, _name, _type, _cmodes) \
1233 DEVLINK_PARAM_DRIVER(_id, _name, _type, _cmodes, \
1234 dsa_devlink_param_get, dsa_devlink_param_set, NULL)
1236 int dsa_devlink_param_get(struct devlink *dl, u32 id,
1237 struct devlink_param_gset_ctx *ctx);
1238 int dsa_devlink_param_set(struct devlink *dl, u32 id,
1239 struct devlink_param_gset_ctx *ctx);
1240 int dsa_devlink_params_register(struct dsa_switch *ds,
1241 const struct devlink_param *params,
1242 size_t params_count);
1243 void dsa_devlink_params_unregister(struct dsa_switch *ds,
1244 const struct devlink_param *params,
1245 size_t params_count);
1246 int dsa_devlink_resource_register(struct dsa_switch *ds,
1247 const char *resource_name,
1250 u64 parent_resource_id,
1251 const struct devlink_resource_size_params *size_params);
1253 void dsa_devlink_resources_unregister(struct dsa_switch *ds);
1255 void dsa_devlink_resource_occ_get_register(struct dsa_switch *ds,
1257 devlink_resource_occ_get_t *occ_get,
1258 void *occ_get_priv);
1259 void dsa_devlink_resource_occ_get_unregister(struct dsa_switch *ds,
1261 struct devlink_region *
1262 dsa_devlink_region_create(struct dsa_switch *ds,
1263 const struct devlink_region_ops *ops,
1264 u32 region_max_snapshots, u64 region_size);
1265 struct devlink_region *
1266 dsa_devlink_port_region_create(struct dsa_switch *ds,
1268 const struct devlink_port_region_ops *ops,
1269 u32 region_max_snapshots, u64 region_size);
1270 void dsa_devlink_region_destroy(struct devlink_region *region);
1272 struct dsa_port *dsa_port_from_netdev(struct net_device *netdev);
1274 struct dsa_devlink_priv {
1275 struct dsa_switch *ds;
1278 static inline struct dsa_switch *dsa_devlink_to_ds(struct devlink *dl)
1280 struct dsa_devlink_priv *dl_priv = devlink_priv(dl);
1286 struct dsa_switch *dsa_devlink_port_to_ds(struct devlink_port *port)
1288 struct devlink *dl = port->devlink;
1289 struct dsa_devlink_priv *dl_priv = devlink_priv(dl);
1294 static inline int dsa_devlink_port_to_port(struct devlink_port *port)
1299 struct dsa_switch_driver {
1300 struct list_head list;
1301 const struct dsa_switch_ops *ops;
1304 bool dsa_fdb_present_in_other_db(struct dsa_switch *ds, int port,
1305 const unsigned char *addr, u16 vid,
1307 bool dsa_mdb_present_in_other_db(struct dsa_switch *ds, int port,
1308 const struct switchdev_obj_port_mdb *mdb,
1311 /* Keep inline for faster access in hot path */
1312 static inline bool netdev_uses_dsa(const struct net_device *dev)
1314 #if IS_ENABLED(CONFIG_NET_DSA)
1315 return dev->dsa_ptr && dev->dsa_ptr->rcv;
1320 /* All DSA tags that push the EtherType to the right (basically all except tail
1321 * tags, which don't break dissection) can be treated the same from the
1322 * perspective of the flow dissector.
1324 * We need to return:
1325 * - offset: the (B - A) difference between:
1326 * A. the position of the real EtherType and
1327 * B. the current skb->data (aka ETH_HLEN bytes into the frame, aka 2 bytes
1328 * after the normal EtherType was supposed to be)
1329 * The offset in bytes is exactly equal to the tagger overhead (and half of
1330 * that, in __be16 shorts).
1332 * - proto: the value of the real EtherType.
1334 static inline void dsa_tag_generic_flow_dissect(const struct sk_buff *skb,
1335 __be16 *proto, int *offset)
1337 #if IS_ENABLED(CONFIG_NET_DSA)
1338 const struct dsa_device_ops *ops = skb->dev->dsa_ptr->tag_ops;
1339 int tag_len = ops->needed_headroom;
1342 *proto = ((__be16 *)skb->data)[(tag_len / 2) - 1];
1346 void dsa_unregister_switch(struct dsa_switch *ds);
1347 int dsa_register_switch(struct dsa_switch *ds);
1348 void dsa_switch_shutdown(struct dsa_switch *ds);
1349 struct dsa_switch *dsa_switch_find(int tree_index, int sw_index);
1350 void dsa_flush_workqueue(void);
1351 #ifdef CONFIG_PM_SLEEP
1352 int dsa_switch_suspend(struct dsa_switch *ds);
1353 int dsa_switch_resume(struct dsa_switch *ds);
1355 static inline int dsa_switch_suspend(struct dsa_switch *ds)
1359 static inline int dsa_switch_resume(struct dsa_switch *ds)
1363 #endif /* CONFIG_PM_SLEEP */
1365 #if IS_ENABLED(CONFIG_NET_DSA)
1366 bool dsa_slave_dev_check(const struct net_device *dev);
1368 static inline bool dsa_slave_dev_check(const struct net_device *dev)
1374 netdev_tx_t dsa_enqueue_skb(struct sk_buff *skb, struct net_device *dev);
1375 void dsa_port_phylink_mac_change(struct dsa_switch *ds, int port, bool up);