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 /* List of VLANs that CPU and DSA ports are members of. */
318 struct mutex vlans_lock;
319 struct list_head vlans;
322 /* TODO: ideally DSA ports would have a single dp->link_dp member,
323 * and no dst->rtable nor this struct dsa_link would be needed,
324 * but this would require some more complex tree walking,
325 * so keep it stupid at the moment and list them all.
329 struct dsa_port *link_dp;
330 struct list_head list;
340 enum dsa_db_type type;
343 const struct dsa_port *dp;
345 struct dsa_bridge bridge;
349 struct dsa_mac_addr {
350 unsigned char addr[ETH_ALEN];
353 struct list_head list;
360 struct list_head list;
367 * Parent switch tree, and switch index.
369 struct dsa_switch_tree *dst;
372 /* Warning: the following bit fields are not atomic, and updating them
373 * can only be done from code paths where concurrency is not possible
374 * (probe time or under rtnl_lock).
378 /* Disallow bridge core from requesting different VLAN awareness
379 * settings on ports if not hardware-supported
381 u32 vlan_filtering_is_global:1;
383 /* Keep VLAN filtering enabled on ports not offloading any upper */
384 u32 needs_standalone_vlan_filtering:1;
386 /* Pass .port_vlan_add and .port_vlan_del to drivers even for bridges
387 * that have vlan_filtering=0. All drivers should ideally set this (and
388 * then the option would get removed), but it is unknown whether this
389 * would break things or not.
391 u32 configure_vlan_while_not_filtering:1;
393 /* If the switch driver always programs the CPU port as egress tagged
394 * despite the VLAN configuration indicating otherwise, then setting
395 * @untag_bridge_pvid will force the DSA receive path to pop the
396 * bridge's default_pvid VLAN tagged frames to offer a consistent
397 * behavior between a vlan_filtering=0 and vlan_filtering=1 bridge
400 u32 untag_bridge_pvid:1;
402 /* Let DSA manage the FDB entries towards the
403 * CPU, based on the software bridge database.
405 u32 assisted_learning_on_cpu_port:1;
407 /* In case vlan_filtering_is_global is set, the VLAN awareness state
408 * should be retrieved from here and not from the per-port settings.
410 u32 vlan_filtering:1;
412 /* For switches that only have the MRU configurable. To ensure the
413 * configured MTU is not exceeded, normalization of MRU on all bridged
414 * interfaces is needed.
416 u32 mtu_enforcement_ingress:1;
418 /* Drivers that isolate the FDBs of multiple bridges must set this
419 * to true to receive the bridge as an argument in .port_fdb_{add,del}
420 * and .port_mdb_{add,del}. Otherwise, the bridge.num will always be
425 /* Listener for switch fabric events */
426 struct notifier_block nb;
429 * Give the switch driver somewhere to hang its private data
437 * Configuration data for this switch.
439 struct dsa_chip_data *cd;
442 * The switch operations.
444 const struct dsa_switch_ops *ops;
447 * Slave mii_bus and devices for the individual ports.
450 struct mii_bus *slave_mii_bus;
452 /* Ageing Time limits in msecs */
453 unsigned int ageing_time_min;
454 unsigned int ageing_time_max;
456 /* Storage for drivers using tag_8021q */
457 struct dsa_8021q_context *tag_8021q_ctx;
459 /* devlink used to represent this switch device */
460 struct devlink *devlink;
462 /* Number of switch port queues */
463 unsigned int num_tx_queues;
465 /* Drivers that benefit from having an ID associated with each
466 * offloaded LAG should set this to the maximum number of
467 * supported IDs. DSA will then maintain a mapping of _at
468 * least_ these many IDs, accessible to drivers via
471 unsigned int num_lag_ids;
473 /* Drivers that support bridge forwarding offload or FDB isolation
474 * should set this to the maximum number of bridges spanning the same
475 * switch tree (or all trees, in the case of cross-tree bridging
476 * support) that can be offloaded.
478 unsigned int max_num_bridges;
480 unsigned int num_ports;
483 static inline struct dsa_port *dsa_to_port(struct dsa_switch *ds, int p)
485 struct dsa_switch_tree *dst = ds->dst;
488 list_for_each_entry(dp, &dst->ports, list)
489 if (dp->ds == ds && dp->index == p)
495 static inline bool dsa_port_is_dsa(struct dsa_port *port)
497 return port->type == DSA_PORT_TYPE_DSA;
500 static inline bool dsa_port_is_cpu(struct dsa_port *port)
502 return port->type == DSA_PORT_TYPE_CPU;
505 static inline bool dsa_port_is_user(struct dsa_port *dp)
507 return dp->type == DSA_PORT_TYPE_USER;
510 static inline bool dsa_port_is_unused(struct dsa_port *dp)
512 return dp->type == DSA_PORT_TYPE_UNUSED;
515 static inline bool dsa_port_master_is_operational(struct dsa_port *dp)
517 return dsa_port_is_cpu(dp) && dp->master_admin_up &&
521 static inline bool dsa_is_unused_port(struct dsa_switch *ds, int p)
523 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_UNUSED;
526 static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p)
528 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_CPU;
531 static inline bool dsa_is_dsa_port(struct dsa_switch *ds, int p)
533 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_DSA;
536 static inline bool dsa_is_user_port(struct dsa_switch *ds, int p)
538 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_USER;
541 #define dsa_tree_for_each_user_port(_dp, _dst) \
542 list_for_each_entry((_dp), &(_dst)->ports, list) \
543 if (dsa_port_is_user((_dp)))
545 #define dsa_tree_for_each_user_port_continue_reverse(_dp, _dst) \
546 list_for_each_entry_continue_reverse((_dp), &(_dst)->ports, list) \
547 if (dsa_port_is_user((_dp)))
549 #define dsa_tree_for_each_cpu_port(_dp, _dst) \
550 list_for_each_entry((_dp), &(_dst)->ports, list) \
551 if (dsa_port_is_cpu((_dp)))
553 #define dsa_switch_for_each_port(_dp, _ds) \
554 list_for_each_entry((_dp), &(_ds)->dst->ports, list) \
555 if ((_dp)->ds == (_ds))
557 #define dsa_switch_for_each_port_safe(_dp, _next, _ds) \
558 list_for_each_entry_safe((_dp), (_next), &(_ds)->dst->ports, list) \
559 if ((_dp)->ds == (_ds))
561 #define dsa_switch_for_each_port_continue_reverse(_dp, _ds) \
562 list_for_each_entry_continue_reverse((_dp), &(_ds)->dst->ports, list) \
563 if ((_dp)->ds == (_ds))
565 #define dsa_switch_for_each_available_port(_dp, _ds) \
566 dsa_switch_for_each_port((_dp), (_ds)) \
567 if (!dsa_port_is_unused((_dp)))
569 #define dsa_switch_for_each_user_port(_dp, _ds) \
570 dsa_switch_for_each_port((_dp), (_ds)) \
571 if (dsa_port_is_user((_dp)))
573 #define dsa_switch_for_each_cpu_port(_dp, _ds) \
574 dsa_switch_for_each_port((_dp), (_ds)) \
575 if (dsa_port_is_cpu((_dp)))
577 #define dsa_switch_for_each_cpu_port_continue_reverse(_dp, _ds) \
578 dsa_switch_for_each_port_continue_reverse((_dp), (_ds)) \
579 if (dsa_port_is_cpu((_dp)))
581 static inline u32 dsa_user_ports(struct dsa_switch *ds)
586 dsa_switch_for_each_user_port(dp, ds)
587 mask |= BIT(dp->index);
592 static inline u32 dsa_cpu_ports(struct dsa_switch *ds)
594 struct dsa_port *cpu_dp;
597 dsa_switch_for_each_cpu_port(cpu_dp, ds)
598 mask |= BIT(cpu_dp->index);
603 /* Return the local port used to reach an arbitrary switch device */
604 static inline unsigned int dsa_routing_port(struct dsa_switch *ds, int device)
606 struct dsa_switch_tree *dst = ds->dst;
609 list_for_each_entry(dl, &dst->rtable, list)
610 if (dl->dp->ds == ds && dl->link_dp->ds->index == device)
611 return dl->dp->index;
613 return ds->num_ports;
616 /* Return the local port used to reach an arbitrary switch port */
617 static inline unsigned int dsa_towards_port(struct dsa_switch *ds, int device,
620 if (device == ds->index)
623 return dsa_routing_port(ds, device);
626 /* Return the local port used to reach the dedicated CPU port */
627 static inline unsigned int dsa_upstream_port(struct dsa_switch *ds, int port)
629 const struct dsa_port *dp = dsa_to_port(ds, port);
630 const struct dsa_port *cpu_dp = dp->cpu_dp;
635 return dsa_towards_port(ds, cpu_dp->ds->index, cpu_dp->index);
638 /* Return true if this is the local port used to reach the CPU port */
639 static inline bool dsa_is_upstream_port(struct dsa_switch *ds, int port)
641 if (dsa_is_unused_port(ds, port))
644 return port == dsa_upstream_port(ds, port);
647 /* Return true if this is a DSA port leading away from the CPU */
648 static inline bool dsa_is_downstream_port(struct dsa_switch *ds, int port)
650 return dsa_is_dsa_port(ds, port) && !dsa_is_upstream_port(ds, port);
653 /* Return the local port used to reach the CPU port */
654 static inline unsigned int dsa_switch_upstream_port(struct dsa_switch *ds)
658 dsa_switch_for_each_available_port(dp, ds) {
659 return dsa_upstream_port(ds, dp->index);
662 return ds->num_ports;
665 /* Return true if @upstream_ds is an upstream switch of @downstream_ds, meaning
666 * that the routing port from @downstream_ds to @upstream_ds is also the port
667 * which @downstream_ds uses to reach its dedicated CPU.
669 static inline bool dsa_switch_is_upstream_of(struct dsa_switch *upstream_ds,
670 struct dsa_switch *downstream_ds)
674 if (upstream_ds == downstream_ds)
677 routing_port = dsa_routing_port(downstream_ds, upstream_ds->index);
679 return dsa_is_upstream_port(downstream_ds, routing_port);
682 static inline bool dsa_port_is_vlan_filtering(const struct dsa_port *dp)
684 const struct dsa_switch *ds = dp->ds;
686 if (ds->vlan_filtering_is_global)
687 return ds->vlan_filtering;
689 return dp->vlan_filtering;
692 static inline unsigned int dsa_port_lag_id_get(struct dsa_port *dp)
694 return dp->lag ? dp->lag->id : 0;
697 static inline struct net_device *dsa_port_lag_dev_get(struct dsa_port *dp)
699 return dp->lag ? dp->lag->dev : NULL;
702 static inline bool dsa_port_offloads_lag(struct dsa_port *dp,
703 const struct dsa_lag *lag)
705 return dsa_port_lag_dev_get(dp) == lag->dev;
708 static inline struct net_device *dsa_port_to_master(const struct dsa_port *dp)
710 if (dp->cpu_port_in_lag)
711 return dsa_port_lag_dev_get(dp->cpu_dp);
713 return dp->cpu_dp->master;
717 struct net_device *dsa_port_to_bridge_port(const struct dsa_port *dp)
724 else if (dp->hsr_dev)
730 static inline struct net_device *
731 dsa_port_bridge_dev_get(const struct dsa_port *dp)
733 return dp->bridge ? dp->bridge->dev : NULL;
736 static inline unsigned int dsa_port_bridge_num_get(struct dsa_port *dp)
738 return dp->bridge ? dp->bridge->num : 0;
741 static inline bool dsa_port_bridge_same(const struct dsa_port *a,
742 const struct dsa_port *b)
744 struct net_device *br_a = dsa_port_bridge_dev_get(a);
745 struct net_device *br_b = dsa_port_bridge_dev_get(b);
747 /* Standalone ports are not in the same bridge with one another */
748 return (!br_a || !br_b) ? false : (br_a == br_b);
751 static inline bool dsa_port_offloads_bridge_port(struct dsa_port *dp,
752 const struct net_device *dev)
754 return dsa_port_to_bridge_port(dp) == dev;
758 dsa_port_offloads_bridge_dev(struct dsa_port *dp,
759 const struct net_device *bridge_dev)
761 /* DSA ports connected to a bridge, and event was emitted
764 return dsa_port_bridge_dev_get(dp) == bridge_dev;
767 static inline bool dsa_port_offloads_bridge(struct dsa_port *dp,
768 const struct dsa_bridge *bridge)
770 return dsa_port_bridge_dev_get(dp) == bridge->dev;
773 /* Returns true if any port of this tree offloads the given net_device */
774 static inline bool dsa_tree_offloads_bridge_port(struct dsa_switch_tree *dst,
775 const struct net_device *dev)
779 list_for_each_entry(dp, &dst->ports, list)
780 if (dsa_port_offloads_bridge_port(dp, dev))
786 /* Returns true if any port of this tree offloads the given bridge */
788 dsa_tree_offloads_bridge_dev(struct dsa_switch_tree *dst,
789 const struct net_device *bridge_dev)
793 list_for_each_entry(dp, &dst->ports, list)
794 if (dsa_port_offloads_bridge_dev(dp, bridge_dev))
800 static inline bool dsa_port_tree_same(const struct dsa_port *a,
801 const struct dsa_port *b)
803 return a->ds->dst == b->ds->dst;
806 typedef int dsa_fdb_dump_cb_t(const unsigned char *addr, u16 vid,
807 bool is_static, void *data);
808 struct dsa_switch_ops {
810 * Tagging protocol helpers called for the CPU ports and DSA links.
811 * @get_tag_protocol retrieves the initial tagging protocol and is
812 * mandatory. Switches which can operate using multiple tagging
813 * protocols should implement @change_tag_protocol and report in
814 * @get_tag_protocol the tagger in current use.
816 enum dsa_tag_protocol (*get_tag_protocol)(struct dsa_switch *ds,
818 enum dsa_tag_protocol mprot);
819 int (*change_tag_protocol)(struct dsa_switch *ds,
820 enum dsa_tag_protocol proto);
822 * Method for switch drivers to connect to the tagging protocol driver
823 * in current use. The switch driver can provide handlers for certain
824 * types of packets for switch management.
826 int (*connect_tag_protocol)(struct dsa_switch *ds,
827 enum dsa_tag_protocol proto);
829 int (*port_change_master)(struct dsa_switch *ds, int port,
830 struct net_device *master,
831 struct netlink_ext_ack *extack);
833 /* Optional switch-wide initialization and destruction methods */
834 int (*setup)(struct dsa_switch *ds);
835 void (*teardown)(struct dsa_switch *ds);
837 /* Per-port initialization and destruction methods. Mandatory if the
838 * driver registers devlink port regions, optional otherwise.
840 int (*port_setup)(struct dsa_switch *ds, int port);
841 void (*port_teardown)(struct dsa_switch *ds, int port);
843 u32 (*get_phy_flags)(struct dsa_switch *ds, int port);
846 * Access to the switch's PHY registers.
848 int (*phy_read)(struct dsa_switch *ds, int port, int regnum);
849 int (*phy_write)(struct dsa_switch *ds, int port,
850 int regnum, u16 val);
853 * Link state adjustment (called from libphy)
855 void (*adjust_link)(struct dsa_switch *ds, int port,
856 struct phy_device *phydev);
857 void (*fixed_link_update)(struct dsa_switch *ds, int port,
858 struct fixed_phy_status *st);
861 * PHYLINK integration
863 void (*phylink_get_caps)(struct dsa_switch *ds, int port,
864 struct phylink_config *config);
865 struct phylink_pcs *(*phylink_mac_select_pcs)(struct dsa_switch *ds,
867 phy_interface_t iface);
868 int (*phylink_mac_link_state)(struct dsa_switch *ds, int port,
869 struct phylink_link_state *state);
870 void (*phylink_mac_config)(struct dsa_switch *ds, int port,
872 const struct phylink_link_state *state);
873 void (*phylink_mac_an_restart)(struct dsa_switch *ds, int port);
874 void (*phylink_mac_link_down)(struct dsa_switch *ds, int port,
876 phy_interface_t interface);
877 void (*phylink_mac_link_up)(struct dsa_switch *ds, int port,
879 phy_interface_t interface,
880 struct phy_device *phydev,
881 int speed, int duplex,
882 bool tx_pause, bool rx_pause);
883 void (*phylink_fixed_state)(struct dsa_switch *ds, int port,
884 struct phylink_link_state *state);
886 * Port statistics counters.
888 void (*get_strings)(struct dsa_switch *ds, int port,
889 u32 stringset, uint8_t *data);
890 void (*get_ethtool_stats)(struct dsa_switch *ds,
891 int port, uint64_t *data);
892 int (*get_sset_count)(struct dsa_switch *ds, int port, int sset);
893 void (*get_ethtool_phy_stats)(struct dsa_switch *ds,
894 int port, uint64_t *data);
895 void (*get_eth_phy_stats)(struct dsa_switch *ds, int port,
896 struct ethtool_eth_phy_stats *phy_stats);
897 void (*get_eth_mac_stats)(struct dsa_switch *ds, int port,
898 struct ethtool_eth_mac_stats *mac_stats);
899 void (*get_eth_ctrl_stats)(struct dsa_switch *ds, int port,
900 struct ethtool_eth_ctrl_stats *ctrl_stats);
901 void (*get_rmon_stats)(struct dsa_switch *ds, int port,
902 struct ethtool_rmon_stats *rmon_stats,
903 const struct ethtool_rmon_hist_range **ranges);
904 void (*get_stats64)(struct dsa_switch *ds, int port,
905 struct rtnl_link_stats64 *s);
906 void (*get_pause_stats)(struct dsa_switch *ds, int port,
907 struct ethtool_pause_stats *pause_stats);
908 void (*self_test)(struct dsa_switch *ds, int port,
909 struct ethtool_test *etest, u64 *data);
912 * ethtool Wake-on-LAN
914 void (*get_wol)(struct dsa_switch *ds, int port,
915 struct ethtool_wolinfo *w);
916 int (*set_wol)(struct dsa_switch *ds, int port,
917 struct ethtool_wolinfo *w);
920 * ethtool timestamp info
922 int (*get_ts_info)(struct dsa_switch *ds, int port,
923 struct ethtool_ts_info *ts);
926 * ethtool MAC merge layer
928 int (*get_mm)(struct dsa_switch *ds, int port,
929 struct ethtool_mm_state *state);
930 int (*set_mm)(struct dsa_switch *ds, int port,
931 struct ethtool_mm_cfg *cfg,
932 struct netlink_ext_ack *extack);
933 void (*get_mm_stats)(struct dsa_switch *ds, int port,
934 struct ethtool_mm_stats *stats);
939 int (*port_get_default_prio)(struct dsa_switch *ds, int port);
940 int (*port_set_default_prio)(struct dsa_switch *ds, int port,
942 int (*port_get_dscp_prio)(struct dsa_switch *ds, int port, u8 dscp);
943 int (*port_add_dscp_prio)(struct dsa_switch *ds, int port, u8 dscp,
945 int (*port_del_dscp_prio)(struct dsa_switch *ds, int port, u8 dscp,
951 int (*suspend)(struct dsa_switch *ds);
952 int (*resume)(struct dsa_switch *ds);
955 * Port enable/disable
957 int (*port_enable)(struct dsa_switch *ds, int port,
958 struct phy_device *phy);
959 void (*port_disable)(struct dsa_switch *ds, int port);
962 * Port's MAC EEE settings
964 int (*set_mac_eee)(struct dsa_switch *ds, int port,
965 struct ethtool_eee *e);
966 int (*get_mac_eee)(struct dsa_switch *ds, int port,
967 struct ethtool_eee *e);
970 int (*get_eeprom_len)(struct dsa_switch *ds);
971 int (*get_eeprom)(struct dsa_switch *ds,
972 struct ethtool_eeprom *eeprom, u8 *data);
973 int (*set_eeprom)(struct dsa_switch *ds,
974 struct ethtool_eeprom *eeprom, u8 *data);
979 int (*get_regs_len)(struct dsa_switch *ds, int port);
980 void (*get_regs)(struct dsa_switch *ds, int port,
981 struct ethtool_regs *regs, void *p);
984 * Upper device tracking.
986 int (*port_prechangeupper)(struct dsa_switch *ds, int port,
987 struct netdev_notifier_changeupper_info *info);
992 int (*set_ageing_time)(struct dsa_switch *ds, unsigned int msecs);
993 int (*port_bridge_join)(struct dsa_switch *ds, int port,
994 struct dsa_bridge bridge,
995 bool *tx_fwd_offload,
996 struct netlink_ext_ack *extack);
997 void (*port_bridge_leave)(struct dsa_switch *ds, int port,
998 struct dsa_bridge bridge);
999 void (*port_stp_state_set)(struct dsa_switch *ds, int port,
1001 int (*port_mst_state_set)(struct dsa_switch *ds, int port,
1002 const struct switchdev_mst_state *state);
1003 void (*port_fast_age)(struct dsa_switch *ds, int port);
1004 int (*port_vlan_fast_age)(struct dsa_switch *ds, int port, u16 vid);
1005 int (*port_pre_bridge_flags)(struct dsa_switch *ds, int port,
1006 struct switchdev_brport_flags flags,
1007 struct netlink_ext_ack *extack);
1008 int (*port_bridge_flags)(struct dsa_switch *ds, int port,
1009 struct switchdev_brport_flags flags,
1010 struct netlink_ext_ack *extack);
1011 void (*port_set_host_flood)(struct dsa_switch *ds, int port,
1017 int (*port_vlan_filtering)(struct dsa_switch *ds, int port,
1018 bool vlan_filtering,
1019 struct netlink_ext_ack *extack);
1020 int (*port_vlan_add)(struct dsa_switch *ds, int port,
1021 const struct switchdev_obj_port_vlan *vlan,
1022 struct netlink_ext_ack *extack);
1023 int (*port_vlan_del)(struct dsa_switch *ds, int port,
1024 const struct switchdev_obj_port_vlan *vlan);
1025 int (*vlan_msti_set)(struct dsa_switch *ds, struct dsa_bridge bridge,
1026 const struct switchdev_vlan_msti *msti);
1029 * Forwarding database
1031 int (*port_fdb_add)(struct dsa_switch *ds, int port,
1032 const unsigned char *addr, u16 vid,
1034 int (*port_fdb_del)(struct dsa_switch *ds, int port,
1035 const unsigned char *addr, u16 vid,
1037 int (*port_fdb_dump)(struct dsa_switch *ds, int port,
1038 dsa_fdb_dump_cb_t *cb, void *data);
1039 int (*lag_fdb_add)(struct dsa_switch *ds, struct dsa_lag lag,
1040 const unsigned char *addr, u16 vid,
1042 int (*lag_fdb_del)(struct dsa_switch *ds, struct dsa_lag lag,
1043 const unsigned char *addr, u16 vid,
1047 * Multicast database
1049 int (*port_mdb_add)(struct dsa_switch *ds, int port,
1050 const struct switchdev_obj_port_mdb *mdb,
1052 int (*port_mdb_del)(struct dsa_switch *ds, int port,
1053 const struct switchdev_obj_port_mdb *mdb,
1058 int (*get_rxnfc)(struct dsa_switch *ds, int port,
1059 struct ethtool_rxnfc *nfc, u32 *rule_locs);
1060 int (*set_rxnfc)(struct dsa_switch *ds, int port,
1061 struct ethtool_rxnfc *nfc);
1066 int (*cls_flower_add)(struct dsa_switch *ds, int port,
1067 struct flow_cls_offload *cls, bool ingress);
1068 int (*cls_flower_del)(struct dsa_switch *ds, int port,
1069 struct flow_cls_offload *cls, bool ingress);
1070 int (*cls_flower_stats)(struct dsa_switch *ds, int port,
1071 struct flow_cls_offload *cls, bool ingress);
1072 int (*port_mirror_add)(struct dsa_switch *ds, int port,
1073 struct dsa_mall_mirror_tc_entry *mirror,
1074 bool ingress, struct netlink_ext_ack *extack);
1075 void (*port_mirror_del)(struct dsa_switch *ds, int port,
1076 struct dsa_mall_mirror_tc_entry *mirror);
1077 int (*port_policer_add)(struct dsa_switch *ds, int port,
1078 struct dsa_mall_policer_tc_entry *policer);
1079 void (*port_policer_del)(struct dsa_switch *ds, int port);
1080 int (*port_setup_tc)(struct dsa_switch *ds, int port,
1081 enum tc_setup_type type, void *type_data);
1084 * Cross-chip operations
1086 int (*crosschip_bridge_join)(struct dsa_switch *ds, int tree_index,
1087 int sw_index, int port,
1088 struct dsa_bridge bridge,
1089 struct netlink_ext_ack *extack);
1090 void (*crosschip_bridge_leave)(struct dsa_switch *ds, int tree_index,
1091 int sw_index, int port,
1092 struct dsa_bridge bridge);
1093 int (*crosschip_lag_change)(struct dsa_switch *ds, int sw_index,
1095 int (*crosschip_lag_join)(struct dsa_switch *ds, int sw_index,
1096 int port, struct dsa_lag lag,
1097 struct netdev_lag_upper_info *info,
1098 struct netlink_ext_ack *extack);
1099 int (*crosschip_lag_leave)(struct dsa_switch *ds, int sw_index,
1100 int port, struct dsa_lag lag);
1105 int (*port_hwtstamp_get)(struct dsa_switch *ds, int port,
1107 int (*port_hwtstamp_set)(struct dsa_switch *ds, int port,
1109 void (*port_txtstamp)(struct dsa_switch *ds, int port,
1110 struct sk_buff *skb);
1111 bool (*port_rxtstamp)(struct dsa_switch *ds, int port,
1112 struct sk_buff *skb, unsigned int type);
1114 /* Devlink parameters, etc */
1115 int (*devlink_param_get)(struct dsa_switch *ds, u32 id,
1116 struct devlink_param_gset_ctx *ctx);
1117 int (*devlink_param_set)(struct dsa_switch *ds, u32 id,
1118 struct devlink_param_gset_ctx *ctx);
1119 int (*devlink_info_get)(struct dsa_switch *ds,
1120 struct devlink_info_req *req,
1121 struct netlink_ext_ack *extack);
1122 int (*devlink_sb_pool_get)(struct dsa_switch *ds,
1123 unsigned int sb_index, u16 pool_index,
1124 struct devlink_sb_pool_info *pool_info);
1125 int (*devlink_sb_pool_set)(struct dsa_switch *ds, unsigned int sb_index,
1126 u16 pool_index, u32 size,
1127 enum devlink_sb_threshold_type threshold_type,
1128 struct netlink_ext_ack *extack);
1129 int (*devlink_sb_port_pool_get)(struct dsa_switch *ds, int port,
1130 unsigned int sb_index, u16 pool_index,
1132 int (*devlink_sb_port_pool_set)(struct dsa_switch *ds, int port,
1133 unsigned int sb_index, u16 pool_index,
1135 struct netlink_ext_ack *extack);
1136 int (*devlink_sb_tc_pool_bind_get)(struct dsa_switch *ds, int port,
1137 unsigned int sb_index, u16 tc_index,
1138 enum devlink_sb_pool_type pool_type,
1139 u16 *p_pool_index, u32 *p_threshold);
1140 int (*devlink_sb_tc_pool_bind_set)(struct dsa_switch *ds, int port,
1141 unsigned int sb_index, u16 tc_index,
1142 enum devlink_sb_pool_type pool_type,
1143 u16 pool_index, u32 threshold,
1144 struct netlink_ext_ack *extack);
1145 int (*devlink_sb_occ_snapshot)(struct dsa_switch *ds,
1146 unsigned int sb_index);
1147 int (*devlink_sb_occ_max_clear)(struct dsa_switch *ds,
1148 unsigned int sb_index);
1149 int (*devlink_sb_occ_port_pool_get)(struct dsa_switch *ds, int port,
1150 unsigned int sb_index, u16 pool_index,
1151 u32 *p_cur, u32 *p_max);
1152 int (*devlink_sb_occ_tc_port_bind_get)(struct dsa_switch *ds, int port,
1153 unsigned int sb_index, u16 tc_index,
1154 enum devlink_sb_pool_type pool_type,
1155 u32 *p_cur, u32 *p_max);
1158 * MTU change functionality. Switches can also adjust their MRU through
1159 * this method. By MTU, one understands the SDU (L2 payload) length.
1160 * If the switch needs to account for the DSA tag on the CPU port, this
1161 * method needs to do so privately.
1163 int (*port_change_mtu)(struct dsa_switch *ds, int port,
1165 int (*port_max_mtu)(struct dsa_switch *ds, int port);
1170 int (*port_lag_change)(struct dsa_switch *ds, int port);
1171 int (*port_lag_join)(struct dsa_switch *ds, int port,
1173 struct netdev_lag_upper_info *info,
1174 struct netlink_ext_ack *extack);
1175 int (*port_lag_leave)(struct dsa_switch *ds, int port,
1176 struct dsa_lag lag);
1181 int (*port_hsr_join)(struct dsa_switch *ds, int port,
1182 struct net_device *hsr);
1183 int (*port_hsr_leave)(struct dsa_switch *ds, int port,
1184 struct net_device *hsr);
1189 int (*port_mrp_add)(struct dsa_switch *ds, int port,
1190 const struct switchdev_obj_mrp *mrp);
1191 int (*port_mrp_del)(struct dsa_switch *ds, int port,
1192 const struct switchdev_obj_mrp *mrp);
1193 int (*port_mrp_add_ring_role)(struct dsa_switch *ds, int port,
1194 const struct switchdev_obj_ring_role_mrp *mrp);
1195 int (*port_mrp_del_ring_role)(struct dsa_switch *ds, int port,
1196 const struct switchdev_obj_ring_role_mrp *mrp);
1199 * tag_8021q operations
1201 int (*tag_8021q_vlan_add)(struct dsa_switch *ds, int port, u16 vid,
1203 int (*tag_8021q_vlan_del)(struct dsa_switch *ds, int port, u16 vid);
1206 * DSA master tracking operations
1208 void (*master_state_change)(struct dsa_switch *ds,
1209 const struct net_device *master,
1213 #define DSA_DEVLINK_PARAM_DRIVER(_id, _name, _type, _cmodes) \
1214 DEVLINK_PARAM_DRIVER(_id, _name, _type, _cmodes, \
1215 dsa_devlink_param_get, dsa_devlink_param_set, NULL)
1217 int dsa_devlink_param_get(struct devlink *dl, u32 id,
1218 struct devlink_param_gset_ctx *ctx);
1219 int dsa_devlink_param_set(struct devlink *dl, u32 id,
1220 struct devlink_param_gset_ctx *ctx);
1221 int dsa_devlink_params_register(struct dsa_switch *ds,
1222 const struct devlink_param *params,
1223 size_t params_count);
1224 void dsa_devlink_params_unregister(struct dsa_switch *ds,
1225 const struct devlink_param *params,
1226 size_t params_count);
1227 int dsa_devlink_resource_register(struct dsa_switch *ds,
1228 const char *resource_name,
1231 u64 parent_resource_id,
1232 const struct devlink_resource_size_params *size_params);
1234 void dsa_devlink_resources_unregister(struct dsa_switch *ds);
1236 void dsa_devlink_resource_occ_get_register(struct dsa_switch *ds,
1238 devlink_resource_occ_get_t *occ_get,
1239 void *occ_get_priv);
1240 void dsa_devlink_resource_occ_get_unregister(struct dsa_switch *ds,
1242 struct devlink_region *
1243 dsa_devlink_region_create(struct dsa_switch *ds,
1244 const struct devlink_region_ops *ops,
1245 u32 region_max_snapshots, u64 region_size);
1246 struct devlink_region *
1247 dsa_devlink_port_region_create(struct dsa_switch *ds,
1249 const struct devlink_port_region_ops *ops,
1250 u32 region_max_snapshots, u64 region_size);
1251 void dsa_devlink_region_destroy(struct devlink_region *region);
1253 struct dsa_port *dsa_port_from_netdev(struct net_device *netdev);
1255 struct dsa_devlink_priv {
1256 struct dsa_switch *ds;
1259 static inline struct dsa_switch *dsa_devlink_to_ds(struct devlink *dl)
1261 struct dsa_devlink_priv *dl_priv = devlink_priv(dl);
1267 struct dsa_switch *dsa_devlink_port_to_ds(struct devlink_port *port)
1269 struct devlink *dl = port->devlink;
1270 struct dsa_devlink_priv *dl_priv = devlink_priv(dl);
1275 static inline int dsa_devlink_port_to_port(struct devlink_port *port)
1280 struct dsa_switch_driver {
1281 struct list_head list;
1282 const struct dsa_switch_ops *ops;
1285 bool dsa_fdb_present_in_other_db(struct dsa_switch *ds, int port,
1286 const unsigned char *addr, u16 vid,
1288 bool dsa_mdb_present_in_other_db(struct dsa_switch *ds, int port,
1289 const struct switchdev_obj_port_mdb *mdb,
1292 /* Keep inline for faster access in hot path */
1293 static inline bool netdev_uses_dsa(const struct net_device *dev)
1295 #if IS_ENABLED(CONFIG_NET_DSA)
1296 return dev->dsa_ptr && dev->dsa_ptr->rcv;
1301 /* All DSA tags that push the EtherType to the right (basically all except tail
1302 * tags, which don't break dissection) can be treated the same from the
1303 * perspective of the flow dissector.
1305 * We need to return:
1306 * - offset: the (B - A) difference between:
1307 * A. the position of the real EtherType and
1308 * B. the current skb->data (aka ETH_HLEN bytes into the frame, aka 2 bytes
1309 * after the normal EtherType was supposed to be)
1310 * The offset in bytes is exactly equal to the tagger overhead (and half of
1311 * that, in __be16 shorts).
1313 * - proto: the value of the real EtherType.
1315 static inline void dsa_tag_generic_flow_dissect(const struct sk_buff *skb,
1316 __be16 *proto, int *offset)
1318 #if IS_ENABLED(CONFIG_NET_DSA)
1319 const struct dsa_device_ops *ops = skb->dev->dsa_ptr->tag_ops;
1320 int tag_len = ops->needed_headroom;
1323 *proto = ((__be16 *)skb->data)[(tag_len / 2) - 1];
1327 void dsa_unregister_switch(struct dsa_switch *ds);
1328 int dsa_register_switch(struct dsa_switch *ds);
1329 void dsa_switch_shutdown(struct dsa_switch *ds);
1330 struct dsa_switch *dsa_switch_find(int tree_index, int sw_index);
1331 void dsa_flush_workqueue(void);
1332 #ifdef CONFIG_PM_SLEEP
1333 int dsa_switch_suspend(struct dsa_switch *ds);
1334 int dsa_switch_resume(struct dsa_switch *ds);
1336 static inline int dsa_switch_suspend(struct dsa_switch *ds)
1340 static inline int dsa_switch_resume(struct dsa_switch *ds)
1344 #endif /* CONFIG_PM_SLEEP */
1346 #if IS_ENABLED(CONFIG_NET_DSA)
1347 bool dsa_slave_dev_check(const struct net_device *dev);
1349 static inline bool dsa_slave_dev_check(const struct net_device *dev)
1355 netdev_tx_t dsa_enqueue_skb(struct sk_buff *skb, struct net_device *dev);
1356 void dsa_port_phylink_mac_change(struct dsa_switch *ds, int port, bool up);