include/net/dsa.h

   1 /* SPDX-License-Identifier: GPL-2.0-or-later */
   2 /*
   3  * include/net/dsa.h - Driver for Distributed Switch Architecture switch chips
   4  * Copyright (c) 2008-2009 Marvell Semiconductor
   5  */
   6
   7 #ifndef __LINUX_NET_DSA_H
   8 #define __LINUX_NET_DSA_H
   9
  10 #include <linux/if.h>
  11 #include <linux/if_ether.h>
  12 #include <linux/list.h>
  13 #include <linux/notifier.h>
  14 #include <linux/timer.h>
  15 #include <linux/workqueue.h>
  16 #include <linux/of.h>
  17 #include <linux/ethtool.h>
  18 #include <linux/net_tstamp.h>
  19 #include <linux/phy.h>
  20 #include <linux/platform_data/dsa.h>
  21 #include <linux/phylink.h>
  22 #include <net/devlink.h>
  23 #include <net/switchdev.h>
  24
  25 struct dsa_8021q_context;
  26 struct tc_action;
  27
  28 #define DSA_TAG_PROTO_NONE_VALUE                0
  29 #define DSA_TAG_PROTO_BRCM_VALUE                1
  30 #define DSA_TAG_PROTO_BRCM_PREPEND_VALUE        2
  31 #define DSA_TAG_PROTO_DSA_VALUE                 3
  32 #define DSA_TAG_PROTO_EDSA_VALUE                4
  33 #define DSA_TAG_PROTO_GSWIP_VALUE               5
  34 #define DSA_TAG_PROTO_KSZ9477_VALUE             6
  35 #define DSA_TAG_PROTO_KSZ9893_VALUE             7
  36 #define DSA_TAG_PROTO_LAN9303_VALUE             8
  37 #define DSA_TAG_PROTO_MTK_VALUE                 9
  38 #define DSA_TAG_PROTO_QCA_VALUE                 10
  39 #define DSA_TAG_PROTO_TRAILER_VALUE             11
  40 #define DSA_TAG_PROTO_8021Q_VALUE               12
  41 #define DSA_TAG_PROTO_SJA1105_VALUE             13
  42 #define DSA_TAG_PROTO_KSZ8795_VALUE             14
  43 #define DSA_TAG_PROTO_OCELOT_VALUE              15
  44 #define DSA_TAG_PROTO_AR9331_VALUE              16
  45 #define DSA_TAG_PROTO_RTL4_A_VALUE              17
  46 #define DSA_TAG_PROTO_HELLCREEK_VALUE           18
  47 #define DSA_TAG_PROTO_XRS700X_VALUE             19
  48 #define DSA_TAG_PROTO_OCELOT_8021Q_VALUE        20
  49 #define DSA_TAG_PROTO_SEVILLE_VALUE             21
  50 #define DSA_TAG_PROTO_BRCM_LEGACY_VALUE         22
  51 #define DSA_TAG_PROTO_SJA1110_VALUE             23
  52 #define DSA_TAG_PROTO_RTL8_4_VALUE              24
  53 #define DSA_TAG_PROTO_RTL8_4T_VALUE             25
  54 #define DSA_TAG_PROTO_RZN1_A5PSW_VALUE          26
  55 #define DSA_TAG_PROTO_LAN937X_VALUE             27
  56
  57 enum dsa_tag_protocol {
  58         DSA_TAG_PROTO_NONE              = DSA_TAG_PROTO_NONE_VALUE,
  59         DSA_TAG_PROTO_BRCM              = DSA_TAG_PROTO_BRCM_VALUE,
  60         DSA_TAG_PROTO_BRCM_LEGACY       = DSA_TAG_PROTO_BRCM_LEGACY_VALUE,
  61         DSA_TAG_PROTO_BRCM_PREPEND      = DSA_TAG_PROTO_BRCM_PREPEND_VALUE,
  62         DSA_TAG_PROTO_DSA               = DSA_TAG_PROTO_DSA_VALUE,
  63         DSA_TAG_PROTO_EDSA              = DSA_TAG_PROTO_EDSA_VALUE,
  64         DSA_TAG_PROTO_GSWIP             = DSA_TAG_PROTO_GSWIP_VALUE,
  65         DSA_TAG_PROTO_KSZ9477           = DSA_TAG_PROTO_KSZ9477_VALUE,
  66         DSA_TAG_PROTO_KSZ9893           = DSA_TAG_PROTO_KSZ9893_VALUE,
  67         DSA_TAG_PROTO_LAN9303           = DSA_TAG_PROTO_LAN9303_VALUE,
  68         DSA_TAG_PROTO_MTK               = DSA_TAG_PROTO_MTK_VALUE,
  69         DSA_TAG_PROTO_QCA               = DSA_TAG_PROTO_QCA_VALUE,
  70         DSA_TAG_PROTO_TRAILER           = DSA_TAG_PROTO_TRAILER_VALUE,
  71         DSA_TAG_PROTO_8021Q             = DSA_TAG_PROTO_8021Q_VALUE,
  72         DSA_TAG_PROTO_SJA1105           = DSA_TAG_PROTO_SJA1105_VALUE,
  73         DSA_TAG_PROTO_KSZ8795           = DSA_TAG_PROTO_KSZ8795_VALUE,
  74         DSA_TAG_PROTO_OCELOT            = DSA_TAG_PROTO_OCELOT_VALUE,
  75         DSA_TAG_PROTO_AR9331            = DSA_TAG_PROTO_AR9331_VALUE,
  76         DSA_TAG_PROTO_RTL4_A            = DSA_TAG_PROTO_RTL4_A_VALUE,
  77         DSA_TAG_PROTO_HELLCREEK         = DSA_TAG_PROTO_HELLCREEK_VALUE,
  78         DSA_TAG_PROTO_XRS700X           = DSA_TAG_PROTO_XRS700X_VALUE,
  79         DSA_TAG_PROTO_OCELOT_8021Q      = DSA_TAG_PROTO_OCELOT_8021Q_VALUE,
  80         DSA_TAG_PROTO_SEVILLE           = DSA_TAG_PROTO_SEVILLE_VALUE,
  81         DSA_TAG_PROTO_SJA1110           = DSA_TAG_PROTO_SJA1110_VALUE,
  82         DSA_TAG_PROTO_RTL8_4            = DSA_TAG_PROTO_RTL8_4_VALUE,
  83         DSA_TAG_PROTO_RTL8_4T           = DSA_TAG_PROTO_RTL8_4T_VALUE,
  84         DSA_TAG_PROTO_RZN1_A5PSW        = DSA_TAG_PROTO_RZN1_A5PSW_VALUE,
  85         DSA_TAG_PROTO_LAN937X           = DSA_TAG_PROTO_LAN937X_VALUE,
  86 };
  87
  88 struct dsa_switch;
  89
  90 struct dsa_device_ops {
  91         struct sk_buff *(*xmit)(struct sk_buff *skb, struct net_device *dev);
  92         struct sk_buff *(*rcv)(struct sk_buff *skb, struct net_device *dev);
  93         void (*flow_dissect)(const struct sk_buff *skb, __be16 *proto,
  94                              int *offset);
  95         int (*connect)(struct dsa_switch *ds);
  96         void (*disconnect)(struct dsa_switch *ds);
  97         unsigned int needed_headroom;
  98         unsigned int needed_tailroom;
  99         const char *name;
 100         enum dsa_tag_protocol proto;
 101         /* Some tagging protocols either mangle or shift the destination MAC
 102          * address, in which case the DSA conduit would drop packets on ingress
 103          * if what it understands out of the destination MAC address is not in
 104          * its RX filter.
 105          */
 106         bool promisc_on_conduit;
 107 };
 108
 109 struct dsa_lag {
 110         struct net_device *dev;
 111         unsigned int id;
 112         struct mutex fdb_lock;
 113         struct list_head fdbs;
 114         refcount_t refcount;
 115 };
 116
 117 struct dsa_switch_tree {
 118         struct list_head        list;
 119
 120         /* List of switch ports */
 121         struct list_head ports;
 122
 123         /* Notifier chain for switch-wide events */
 124         struct raw_notifier_head        nh;
 125
 126         /* Tree identifier */
 127         unsigned int index;
 128
 129         /* Number of switches attached to this tree */
 130         struct kref refcount;
 131
 132         /* Maps offloaded LAG netdevs to a zero-based linear ID for
 133          * drivers that need it.
 134          */
 135         struct dsa_lag **lags;
 136
 137         /* Tagging protocol operations */
 138         const struct dsa_device_ops *tag_ops;
 139
 140         /* Default tagging protocol preferred by the switches in this
 141          * tree.
 142          */
 143         enum dsa_tag_protocol default_proto;
 144
 145         /* Has this tree been applied to the hardware? */
 146         bool setup;
 147
 148         /*
 149          * Configuration data for the platform device that owns
 150          * this dsa switch tree instance.
 151          */
 152         struct dsa_platform_data        *pd;
 153
 154         /* List of DSA links composing the routing table */
 155         struct list_head rtable;
 156
 157         /* Length of "lags" array */
 158         unsigned int lags_len;
 159
 160         /* Track the largest switch index within a tree */
 161         unsigned int last_switch;
 162 };
 163
 164 /* LAG IDs are one-based, the dst->lags array is zero-based */
 165 #define dsa_lags_foreach_id(_id, _dst)                          \
 166         for ((_id) = 1; (_id) <= (_dst)->lags_len; (_id)++)     \
 167                 if ((_dst)->lags[(_id) - 1])
 168
 169 #define dsa_lag_foreach_port(_dp, _dst, _lag)                   \
 170         list_for_each_entry((_dp), &(_dst)->ports, list)        \
 171                 if (dsa_port_offloads_lag((_dp), (_lag)))
 172
 173 #define dsa_hsr_foreach_port(_dp, _ds, _hsr)                    \
 174         list_for_each_entry((_dp), &(_ds)->dst->ports, list)    \
 175                 if ((_dp)->ds == (_ds) && (_dp)->hsr_dev == (_hsr))
 176
 177 static inline struct dsa_lag *dsa_lag_by_id(struct dsa_switch_tree *dst,
 178                                             unsigned int id)
 179 {
 180         /* DSA LAG IDs are one-based, dst->lags is zero-based */
 181         return dst->lags[id - 1];
 182 }
 183
 184 static inline int dsa_lag_id(struct dsa_switch_tree *dst,
 185                              struct net_device *lag_dev)
 186 {
 187         unsigned int id;
 188
 189         dsa_lags_foreach_id(id, dst) {
 190                 struct dsa_lag *lag = dsa_lag_by_id(dst, id);
 191
 192                 if (lag->dev == lag_dev)
 193                         return lag->id;
 194         }
 195
 196         return -ENODEV;
 197 }
 198
 199 /* TC matchall action types */
 200 enum dsa_port_mall_action_type {
 201         DSA_PORT_MALL_MIRROR,
 202         DSA_PORT_MALL_POLICER,
 203 };
 204
 205 /* TC mirroring entry */
 206 struct dsa_mall_mirror_tc_entry {
 207         u8 to_local_port;
 208         bool ingress;
 209 };
 210
 211 /* TC port policer entry */
 212 struct dsa_mall_policer_tc_entry {
 213         u32 burst;
 214         u64 rate_bytes_per_sec;
 215 };
 216
 217 /* TC matchall entry */
 218 struct dsa_mall_tc_entry {
 219         struct list_head list;
 220         unsigned long cookie;
 221         enum dsa_port_mall_action_type type;
 222         union {
 223                 struct dsa_mall_mirror_tc_entry mirror;
 224                 struct dsa_mall_policer_tc_entry policer;
 225         };
 226 };
 227
 228 struct dsa_bridge {
 229         struct net_device *dev;
 230         unsigned int num;
 231         bool tx_fwd_offload;
 232         refcount_t refcount;
 233 };
 234
 235 struct dsa_port {
 236         /* A CPU port is physically connected to a conduit device. A user port
 237          * exposes a network device to user-space, called 'user' here.
 238          */
 239         union {
 240                 struct net_device *conduit;
 241                 struct net_device *user;
 242         };
 243
 244         /* Copy of the tagging protocol operations, for quicker access
 245          * in the data path. Valid only for the CPU ports.
 246          */
 247         const struct dsa_device_ops *tag_ops;
 248
 249         /* Copies for faster access in conduit receive hot path */
 250         struct dsa_switch_tree *dst;
 251         struct sk_buff *(*rcv)(struct sk_buff *skb, struct net_device *dev);
 252
 253         struct dsa_switch       *ds;
 254
 255         unsigned int            index;
 256
 257         enum {
 258                 DSA_PORT_TYPE_UNUSED = 0,
 259                 DSA_PORT_TYPE_CPU,
 260                 DSA_PORT_TYPE_DSA,
 261                 DSA_PORT_TYPE_USER,
 262         } type;
 263
 264         const char              *name;
 265         struct dsa_port         *cpu_dp;
 266         u8                      mac[ETH_ALEN];
 267
 268         u8                      stp_state;
 269
 270         /* Warning: the following bit fields are not atomic, and updating them
 271          * can only be done from code paths where concurrency is not possible
 272          * (probe time or under rtnl_lock).
 273          */
 274         u8                      vlan_filtering:1;
 275
 276         /* Managed by DSA on user ports and by drivers on CPU and DSA ports */
 277         u8                      learning:1;
 278
 279         u8                      lag_tx_enabled:1;
 280
 281         /* conduit state bits, valid only on CPU ports */
 282         u8                      conduit_admin_up:1;
 283         u8                      conduit_oper_up:1;
 284
 285         /* Valid only on user ports */
 286         u8                      cpu_port_in_lag:1;
 287
 288         u8                      setup:1;
 289
 290         struct device_node      *dn;
 291         unsigned int            ageing_time;
 292
 293         struct dsa_bridge       *bridge;
 294         struct devlink_port     devlink_port;
 295         struct phylink          *pl;
 296         struct phylink_config   pl_config;
 297         struct dsa_lag          *lag;
 298         struct net_device       *hsr_dev;
 299
 300         struct list_head list;
 301
 302         /*
 303          * Original copy of the conduit netdev ethtool_ops
 304          */
 305         const struct ethtool_ops *orig_ethtool_ops;
 306
 307         /* List of MAC addresses that must be forwarded on this port.
 308          * These are only valid on CPU ports and DSA links.
 309          */
 310         struct mutex            addr_lists_lock;
 311         struct list_head        fdbs;
 312         struct list_head        mdbs;
 313
 314         struct mutex            vlans_lock;
 315         union {
 316                 /* List of VLANs that CPU and DSA ports are members of.
 317                  * Access to this is serialized by the sleepable @vlans_lock.
 318                  */
 319                 struct list_head        vlans;
 320                 /* List of VLANs that user ports are members of.
 321                  * Access to this is serialized by netif_addr_lock_bh().
 322                  */
 323                 struct list_head        user_vlans;
 324         };
 325 };
 326
 327 static inline struct dsa_port *
 328 dsa_phylink_to_port(struct phylink_config *config)
 329 {
 330         return container_of(config, struct dsa_port, pl_config);
 331 }
 332
 333 /* TODO: ideally DSA ports would have a single dp->link_dp member,
 334  * and no dst->rtable nor this struct dsa_link would be needed,
 335  * but this would require some more complex tree walking,
 336  * so keep it stupid at the moment and list them all.
 337  */
 338 struct dsa_link {
 339         struct dsa_port *dp;
 340         struct dsa_port *link_dp;
 341         struct list_head list;
 342 };
 343
 344 enum dsa_db_type {
 345         DSA_DB_PORT,
 346         DSA_DB_LAG,
 347         DSA_DB_BRIDGE,
 348 };
 349
 350 struct dsa_db {
 351         enum dsa_db_type type;
 352
 353         union {
 354                 const struct dsa_port *dp;
 355                 struct dsa_lag lag;
 356                 struct dsa_bridge bridge;
 357         };
 358 };
 359
 360 struct dsa_mac_addr {
 361         unsigned char addr[ETH_ALEN];
 362         u16 vid;
 363         refcount_t refcount;
 364         struct list_head list;
 365         struct dsa_db db;
 366 };
 367
 368 struct dsa_vlan {
 369         u16 vid;
 370         refcount_t refcount;
 371         struct list_head list;
 372 };
 373
 374 struct dsa_switch {
 375         struct device *dev;
 376
 377         /*
 378          * Parent switch tree, and switch index.
 379          */
 380         struct dsa_switch_tree  *dst;
 381         unsigned int            index;
 382
 383         /* Warning: the following bit fields are not atomic, and updating them
 384          * can only be done from code paths where concurrency is not possible
 385          * (probe time or under rtnl_lock).
 386          */
 387         u32                     setup:1;
 388
 389         /* Disallow bridge core from requesting different VLAN awareness
 390          * settings on ports if not hardware-supported
 391          */
 392         u32                     vlan_filtering_is_global:1;
 393
 394         /* Keep VLAN filtering enabled on ports not offloading any upper */
 395         u32                     needs_standalone_vlan_filtering:1;
 396
 397         /* Pass .port_vlan_add and .port_vlan_del to drivers even for bridges
 398          * that have vlan_filtering=0. All drivers should ideally set this (and
 399          * then the option would get removed), but it is unknown whether this
 400          * would break things or not.
 401          */
 402         u32                     configure_vlan_while_not_filtering:1;
 403
 404         /* If the switch driver always programs the CPU port as egress tagged
 405          * despite the VLAN configuration indicating otherwise, then setting
 406          * @untag_bridge_pvid will force the DSA receive path to pop the
 407          * bridge's default_pvid VLAN tagged frames to offer a consistent
 408          * behavior between a vlan_filtering=0 and vlan_filtering=1 bridge
 409          * device.
 410          */
 411         u32                     untag_bridge_pvid:1;
 412
 413         /* Let DSA manage the FDB entries towards the
 414          * CPU, based on the software bridge database.
 415          */
 416         u32                     assisted_learning_on_cpu_port:1;
 417
 418         /* In case vlan_filtering_is_global is set, the VLAN awareness state
 419          * should be retrieved from here and not from the per-port settings.
 420          */
 421         u32                     vlan_filtering:1;
 422
 423         /* For switches that only have the MRU configurable. To ensure the
 424          * configured MTU is not exceeded, normalization of MRU on all bridged
 425          * interfaces is needed.
 426          */
 427         u32                     mtu_enforcement_ingress:1;
 428
 429         /* Drivers that isolate the FDBs of multiple bridges must set this
 430          * to true to receive the bridge as an argument in .port_fdb_{add,del}
 431          * and .port_mdb_{add,del}. Otherwise, the bridge.num will always be
 432          * passed as zero.
 433          */
 434         u32                     fdb_isolation:1;
 435
 436         /* Drivers that have global DSCP mapping settings must set this to
 437          * true to automatically apply the settings to all ports.
 438          */
 439         u32                     dscp_prio_mapping_is_global:1;
 440
 441         /* Listener for switch fabric events */
 442         struct notifier_block   nb;
 443
 444         /*
 445          * Give the switch driver somewhere to hang its private data
 446          * structure.
 447          */
 448         void *priv;
 449
 450         void *tagger_data;
 451
 452         /*
 453          * Configuration data for this switch.
 454          */
 455         struct dsa_chip_data    *cd;
 456
 457         /*
 458          * The switch operations.
 459          */
 460         const struct dsa_switch_ops     *ops;
 461
 462         /*
 463          * Allow a DSA switch driver to override the phylink MAC ops
 464          */
 465         const struct phylink_mac_ops    *phylink_mac_ops;
 466
 467         /*
 468          * User mii_bus and devices for the individual ports.
 469          */
 470         u32                     phys_mii_mask;
 471         struct mii_bus          *user_mii_bus;
 472
 473         /* Ageing Time limits in msecs */
 474         unsigned int ageing_time_min;
 475         unsigned int ageing_time_max;
 476
 477         /* Storage for drivers using tag_8021q */
 478         struct dsa_8021q_context *tag_8021q_ctx;
 479
 480         /* devlink used to represent this switch device */
 481         struct devlink          *devlink;
 482
 483         /* Number of switch port queues */
 484         unsigned int            num_tx_queues;
 485
 486         /* Drivers that benefit from having an ID associated with each
 487          * offloaded LAG should set this to the maximum number of
 488          * supported IDs. DSA will then maintain a mapping of _at
 489          * least_ these many IDs, accessible to drivers via
 490          * dsa_lag_id().
 491          */
 492         unsigned int            num_lag_ids;
 493
 494         /* Drivers that support bridge forwarding offload or FDB isolation
 495          * should set this to the maximum number of bridges spanning the same
 496          * switch tree (or all trees, in the case of cross-tree bridging
 497          * support) that can be offloaded.
 498          */
 499         unsigned int            max_num_bridges;
 500
 501         unsigned int            num_ports;
 502 };
 503
 504 static inline struct dsa_port *dsa_to_port(struct dsa_switch *ds, int p)
 505 {
 506         struct dsa_switch_tree *dst = ds->dst;
 507         struct dsa_port *dp;
 508
 509         list_for_each_entry(dp, &dst->ports, list)
 510                 if (dp->ds == ds && dp->index == p)
 511                         return dp;
 512
 513         return NULL;
 514 }
 515
 516 static inline bool dsa_port_is_dsa(struct dsa_port *port)
 517 {
 518         return port->type == DSA_PORT_TYPE_DSA;
 519 }
 520
 521 static inline bool dsa_port_is_cpu(struct dsa_port *port)
 522 {
 523         return port->type == DSA_PORT_TYPE_CPU;
 524 }
 525
 526 static inline bool dsa_port_is_user(struct dsa_port *dp)
 527 {
 528         return dp->type == DSA_PORT_TYPE_USER;
 529 }
 530
 531 static inline bool dsa_port_is_unused(struct dsa_port *dp)
 532 {
 533         return dp->type == DSA_PORT_TYPE_UNUSED;
 534 }
 535
 536 static inline bool dsa_port_conduit_is_operational(struct dsa_port *dp)
 537 {
 538         return dsa_port_is_cpu(dp) && dp->conduit_admin_up &&
 539                dp->conduit_oper_up;
 540 }
 541
 542 static inline bool dsa_is_unused_port(struct dsa_switch *ds, int p)
 543 {
 544         return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_UNUSED;
 545 }
 546
 547 static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p)
 548 {
 549         return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_CPU;
 550 }
 551
 552 static inline bool dsa_is_dsa_port(struct dsa_switch *ds, int p)
 553 {
 554         return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_DSA;
 555 }
 556
 557 static inline bool dsa_is_user_port(struct dsa_switch *ds, int p)
 558 {
 559         return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_USER;
 560 }
 561
 562 #define dsa_tree_for_each_user_port(_dp, _dst) \
 563         list_for_each_entry((_dp), &(_dst)->ports, list) \
 564                 if (dsa_port_is_user((_dp)))
 565
 566 #define dsa_tree_for_each_user_port_continue_reverse(_dp, _dst) \
 567         list_for_each_entry_continue_reverse((_dp), &(_dst)->ports, list) \
 568                 if (dsa_port_is_user((_dp)))
 569
 570 #define dsa_tree_for_each_cpu_port(_dp, _dst) \
 571         list_for_each_entry((_dp), &(_dst)->ports, list) \
 572                 if (dsa_port_is_cpu((_dp)))
 573
 574 #define dsa_switch_for_each_port(_dp, _ds) \
 575         list_for_each_entry((_dp), &(_ds)->dst->ports, list) \
 576                 if ((_dp)->ds == (_ds))
 577
 578 #define dsa_switch_for_each_port_safe(_dp, _next, _ds) \
 579         list_for_each_entry_safe((_dp), (_next), &(_ds)->dst->ports, list) \
 580                 if ((_dp)->ds == (_ds))
 581
 582 #define dsa_switch_for_each_port_continue_reverse(_dp, _ds) \
 583         list_for_each_entry_continue_reverse((_dp), &(_ds)->dst->ports, list) \
 584                 if ((_dp)->ds == (_ds))
 585
 586 #define dsa_switch_for_each_available_port(_dp, _ds) \
 587         dsa_switch_for_each_port((_dp), (_ds)) \
 588                 if (!dsa_port_is_unused((_dp)))
 589
 590 #define dsa_switch_for_each_user_port(_dp, _ds) \
 591         dsa_switch_for_each_port((_dp), (_ds)) \
 592                 if (dsa_port_is_user((_dp)))
 593
 594 #define dsa_switch_for_each_user_port_continue_reverse(_dp, _ds) \
 595         dsa_switch_for_each_port_continue_reverse((_dp), (_ds)) \
 596                 if (dsa_port_is_user((_dp)))
 597
 598 #define dsa_switch_for_each_cpu_port(_dp, _ds) \
 599         dsa_switch_for_each_port((_dp), (_ds)) \
 600                 if (dsa_port_is_cpu((_dp)))
 601
 602 #define dsa_switch_for_each_cpu_port_continue_reverse(_dp, _ds) \
 603         dsa_switch_for_each_port_continue_reverse((_dp), (_ds)) \
 604                 if (dsa_port_is_cpu((_dp)))
 605
 606 static inline u32 dsa_user_ports(struct dsa_switch *ds)
 607 {
 608         struct dsa_port *dp;
 609         u32 mask = 0;
 610
 611         dsa_switch_for_each_user_port(dp, ds)
 612                 mask |= BIT(dp->index);
 613
 614         return mask;
 615 }
 616
 617 static inline u32 dsa_cpu_ports(struct dsa_switch *ds)
 618 {
 619         struct dsa_port *cpu_dp;
 620         u32 mask = 0;
 621
 622         dsa_switch_for_each_cpu_port(cpu_dp, ds)
 623                 mask |= BIT(cpu_dp->index);
 624
 625         return mask;
 626 }
 627
 628 /* Return the local port used to reach an arbitrary switch device */
 629 static inline unsigned int dsa_routing_port(struct dsa_switch *ds, int device)
 630 {
 631         struct dsa_switch_tree *dst = ds->dst;
 632         struct dsa_link *dl;
 633
 634         list_for_each_entry(dl, &dst->rtable, list)
 635                 if (dl->dp->ds == ds && dl->link_dp->ds->index == device)
 636                         return dl->dp->index;
 637
 638         return ds->num_ports;
 639 }
 640
 641 /* Return the local port used to reach an arbitrary switch port */
 642 static inline unsigned int dsa_towards_port(struct dsa_switch *ds, int device,
 643                                             int port)
 644 {
 645         if (device == ds->index)
 646                 return port;
 647         else
 648                 return dsa_routing_port(ds, device);
 649 }
 650
 651 /* Return the local port used to reach the dedicated CPU port */
 652 static inline unsigned int dsa_upstream_port(struct dsa_switch *ds, int port)
 653 {
 654         const struct dsa_port *dp = dsa_to_port(ds, port);
 655         const struct dsa_port *cpu_dp = dp->cpu_dp;
 656
 657         if (!cpu_dp)
 658                 return port;
 659
 660         return dsa_towards_port(ds, cpu_dp->ds->index, cpu_dp->index);
 661 }
 662
 663 /* Return true if this is the local port used to reach the CPU port */
 664 static inline bool dsa_is_upstream_port(struct dsa_switch *ds, int port)
 665 {
 666         if (dsa_is_unused_port(ds, port))
 667                 return false;
 668
 669         return port == dsa_upstream_port(ds, port);
 670 }
 671
 672 /* Return true if this is a DSA port leading away from the CPU */
 673 static inline bool dsa_is_downstream_port(struct dsa_switch *ds, int port)
 674 {
 675         return dsa_is_dsa_port(ds, port) && !dsa_is_upstream_port(ds, port);
 676 }
 677
 678 /* Return the local port used to reach the CPU port */
 679 static inline unsigned int dsa_switch_upstream_port(struct dsa_switch *ds)
 680 {
 681         struct dsa_port *dp;
 682
 683         dsa_switch_for_each_available_port(dp, ds) {
 684                 return dsa_upstream_port(ds, dp->index);
 685         }
 686
 687         return ds->num_ports;
 688 }
 689
 690 /* Return true if @upstream_ds is an upstream switch of @downstream_ds, meaning
 691  * that the routing port from @downstream_ds to @upstream_ds is also the port
 692  * which @downstream_ds uses to reach its dedicated CPU.
 693  */
 694 static inline bool dsa_switch_is_upstream_of(struct dsa_switch *upstream_ds,
 695                                              struct dsa_switch *downstream_ds)
 696 {
 697         int routing_port;
 698
 699         if (upstream_ds == downstream_ds)
 700                 return true;
 701
 702         routing_port = dsa_routing_port(downstream_ds, upstream_ds->index);
 703
 704         return dsa_is_upstream_port(downstream_ds, routing_port);
 705 }
 706
 707 static inline bool dsa_port_is_vlan_filtering(const struct dsa_port *dp)
 708 {
 709         const struct dsa_switch *ds = dp->ds;
 710
 711         if (ds->vlan_filtering_is_global)
 712                 return ds->vlan_filtering;
 713         else
 714                 return dp->vlan_filtering;
 715 }
 716
 717 static inline unsigned int dsa_port_lag_id_get(struct dsa_port *dp)
 718 {
 719         return dp->lag ? dp->lag->id : 0;
 720 }
 721
 722 static inline struct net_device *dsa_port_lag_dev_get(struct dsa_port *dp)
 723 {
 724         return dp->lag ? dp->lag->dev : NULL;
 725 }
 726
 727 static inline bool dsa_port_offloads_lag(struct dsa_port *dp,
 728                                          const struct dsa_lag *lag)
 729 {
 730         return dsa_port_lag_dev_get(dp) == lag->dev;
 731 }
 732
 733 static inline struct net_device *dsa_port_to_conduit(const struct dsa_port *dp)
 734 {
 735         if (dp->cpu_port_in_lag)
 736                 return dsa_port_lag_dev_get(dp->cpu_dp);
 737
 738         return dp->cpu_dp->conduit;
 739 }
 740
 741 static inline
 742 struct net_device *dsa_port_to_bridge_port(const struct dsa_port *dp)
 743 {
 744         if (!dp->bridge)
 745                 return NULL;
 746
 747         if (dp->lag)
 748                 return dp->lag->dev;
 749         else if (dp->hsr_dev)
 750                 return dp->hsr_dev;
 751
 752         return dp->user;
 753 }
 754
 755 static inline struct net_device *
 756 dsa_port_bridge_dev_get(const struct dsa_port *dp)
 757 {
 758         return dp->bridge ? dp->bridge->dev : NULL;
 759 }
 760
 761 static inline unsigned int dsa_port_bridge_num_get(struct dsa_port *dp)
 762 {
 763         return dp->bridge ? dp->bridge->num : 0;
 764 }
 765
 766 static inline bool dsa_port_bridge_same(const struct dsa_port *a,
 767                                         const struct dsa_port *b)
 768 {
 769         struct net_device *br_a = dsa_port_bridge_dev_get(a);
 770         struct net_device *br_b = dsa_port_bridge_dev_get(b);
 771
 772         /* Standalone ports are not in the same bridge with one another */
 773         return (!br_a || !br_b) ? false : (br_a == br_b);
 774 }
 775
 776 static inline bool dsa_port_offloads_bridge_port(struct dsa_port *dp,
 777                                                  const struct net_device *dev)
 778 {
 779         return dsa_port_to_bridge_port(dp) == dev;
 780 }
 781
 782 static inline bool
 783 dsa_port_offloads_bridge_dev(struct dsa_port *dp,
 784                              const struct net_device *bridge_dev)
 785 {
 786         /* DSA ports connected to a bridge, and event was emitted
 787          * for the bridge.
 788          */
 789         return dsa_port_bridge_dev_get(dp) == bridge_dev;
 790 }
 791
 792 static inline bool dsa_port_offloads_bridge(struct dsa_port *dp,
 793                                             const struct dsa_bridge *bridge)
 794 {
 795         return dsa_port_bridge_dev_get(dp) == bridge->dev;
 796 }
 797
 798 /* Returns true if any port of this tree offloads the given net_device */
 799 static inline bool dsa_tree_offloads_bridge_port(struct dsa_switch_tree *dst,
 800                                                  const struct net_device *dev)
 801 {
 802         struct dsa_port *dp;
 803
 804         list_for_each_entry(dp, &dst->ports, list)
 805                 if (dsa_port_offloads_bridge_port(dp, dev))
 806                         return true;
 807
 808         return false;
 809 }
 810
 811 /* Returns true if any port of this tree offloads the given bridge */
 812 static inline bool
 813 dsa_tree_offloads_bridge_dev(struct dsa_switch_tree *dst,
 814                              const struct net_device *bridge_dev)
 815 {
 816         struct dsa_port *dp;
 817
 818         list_for_each_entry(dp, &dst->ports, list)
 819                 if (dsa_port_offloads_bridge_dev(dp, bridge_dev))
 820                         return true;
 821
 822         return false;
 823 }
 824
 825 static inline bool dsa_port_tree_same(const struct dsa_port *a,
 826                                       const struct dsa_port *b)
 827 {
 828         return a->ds->dst == b->ds->dst;
 829 }
 830
 831 typedef int dsa_fdb_dump_cb_t(const unsigned char *addr, u16 vid,
 832                               bool is_static, void *data);
 833 struct dsa_switch_ops {
 834         /*
 835          * Tagging protocol helpers called for the CPU ports and DSA links.
 836          * @get_tag_protocol retrieves the initial tagging protocol and is
 837          * mandatory. Switches which can operate using multiple tagging
 838          * protocols should implement @change_tag_protocol and report in
 839          * @get_tag_protocol the tagger in current use.
 840          */
 841         enum dsa_tag_protocol (*get_tag_protocol)(struct dsa_switch *ds,
 842                                                   int port,
 843                                                   enum dsa_tag_protocol mprot);
 844         int     (*change_tag_protocol)(struct dsa_switch *ds,
 845                                        enum dsa_tag_protocol proto);
 846         /*
 847          * Method for switch drivers to connect to the tagging protocol driver
 848          * in current use. The switch driver can provide handlers for certain
 849          * types of packets for switch management.
 850          */
 851         int     (*connect_tag_protocol)(struct dsa_switch *ds,
 852                                         enum dsa_tag_protocol proto);
 853
 854         int     (*port_change_conduit)(struct dsa_switch *ds, int port,
 855                                        struct net_device *conduit,
 856                                        struct netlink_ext_ack *extack);
 857
 858         /* Optional switch-wide initialization and destruction methods */
 859         int     (*setup)(struct dsa_switch *ds);
 860         void    (*teardown)(struct dsa_switch *ds);
 861
 862         /* Per-port initialization and destruction methods. Mandatory if the
 863          * driver registers devlink port regions, optional otherwise.
 864          */
 865         int     (*port_setup)(struct dsa_switch *ds, int port);
 866         void    (*port_teardown)(struct dsa_switch *ds, int port);
 867
 868         u32     (*get_phy_flags)(struct dsa_switch *ds, int port);
 869
 870         /*
 871          * Access to the switch's PHY registers.
 872          */
 873         int     (*phy_read)(struct dsa_switch *ds, int port, int regnum);
 874         int     (*phy_write)(struct dsa_switch *ds, int port,
 875                              int regnum, u16 val);
 876
 877         /*
 878          * PHYLINK integration
 879          */
 880         void    (*phylink_get_caps)(struct dsa_switch *ds, int port,
 881                                     struct phylink_config *config);
 882         struct phylink_pcs *(*phylink_mac_select_pcs)(struct dsa_switch *ds,
 883                                                       int port,
 884                                                       phy_interface_t iface);
 885         int     (*phylink_mac_prepare)(struct dsa_switch *ds, int port,
 886                                        unsigned int mode,
 887                                        phy_interface_t interface);
 888         void    (*phylink_mac_config)(struct dsa_switch *ds, int port,
 889                                       unsigned int mode,
 890                                       const struct phylink_link_state *state);
 891         int     (*phylink_mac_finish)(struct dsa_switch *ds, int port,
 892                                       unsigned int mode,
 893                                       phy_interface_t interface);
 894         void    (*phylink_mac_link_down)(struct dsa_switch *ds, int port,
 895                                          unsigned int mode,
 896                                          phy_interface_t interface);
 897         void    (*phylink_mac_link_up)(struct dsa_switch *ds, int port,
 898                                        unsigned int mode,
 899                                        phy_interface_t interface,
 900                                        struct phy_device *phydev,
 901                                        int speed, int duplex,
 902                                        bool tx_pause, bool rx_pause);
 903         void    (*phylink_fixed_state)(struct dsa_switch *ds, int port,
 904                                        struct phylink_link_state *state);
 905         /*
 906          * Port statistics counters.
 907          */
 908         void    (*get_strings)(struct dsa_switch *ds, int port,
 909                                u32 stringset, uint8_t *data);
 910         void    (*get_ethtool_stats)(struct dsa_switch *ds,
 911                                      int port, uint64_t *data);
 912         int     (*get_sset_count)(struct dsa_switch *ds, int port, int sset);
 913         void    (*get_ethtool_phy_stats)(struct dsa_switch *ds,
 914                                          int port, uint64_t *data);
 915         void    (*get_eth_phy_stats)(struct dsa_switch *ds, int port,
 916                                      struct ethtool_eth_phy_stats *phy_stats);
 917         void    (*get_eth_mac_stats)(struct dsa_switch *ds, int port,
 918                                      struct ethtool_eth_mac_stats *mac_stats);
 919         void    (*get_eth_ctrl_stats)(struct dsa_switch *ds, int port,
 920                                       struct ethtool_eth_ctrl_stats *ctrl_stats);
 921         void    (*get_rmon_stats)(struct dsa_switch *ds, int port,
 922                                   struct ethtool_rmon_stats *rmon_stats,
 923                                   const struct ethtool_rmon_hist_range **ranges);
 924         void    (*get_stats64)(struct dsa_switch *ds, int port,
 925                                    struct rtnl_link_stats64 *s);
 926         void    (*get_pause_stats)(struct dsa_switch *ds, int port,
 927                                    struct ethtool_pause_stats *pause_stats);
 928         void    (*self_test)(struct dsa_switch *ds, int port,
 929                              struct ethtool_test *etest, u64 *data);
 930
 931         /*
 932          * ethtool Wake-on-LAN
 933          */
 934         void    (*get_wol)(struct dsa_switch *ds, int port,
 935                            struct ethtool_wolinfo *w);
 936         int     (*set_wol)(struct dsa_switch *ds, int port,
 937                            struct ethtool_wolinfo *w);
 938
 939         /*
 940          * ethtool timestamp info
 941          */
 942         int     (*get_ts_info)(struct dsa_switch *ds, int port,
 943                                struct ethtool_ts_info *ts);
 944
 945         /*
 946          * ethtool MAC merge layer
 947          */
 948         int     (*get_mm)(struct dsa_switch *ds, int port,
 949                           struct ethtool_mm_state *state);
 950         int     (*set_mm)(struct dsa_switch *ds, int port,
 951                           struct ethtool_mm_cfg *cfg,
 952                           struct netlink_ext_ack *extack);
 953         void    (*get_mm_stats)(struct dsa_switch *ds, int port,
 954                                 struct ethtool_mm_stats *stats);
 955
 956         /*
 957          * DCB ops
 958          */
 959         int     (*port_get_default_prio)(struct dsa_switch *ds, int port);
 960         int     (*port_set_default_prio)(struct dsa_switch *ds, int port,
 961                                          u8 prio);
 962         int     (*port_get_dscp_prio)(struct dsa_switch *ds, int port, u8 dscp);
 963         int     (*port_add_dscp_prio)(struct dsa_switch *ds, int port, u8 dscp,
 964                                       u8 prio);
 965         int     (*port_del_dscp_prio)(struct dsa_switch *ds, int port, u8 dscp,
 966                                       u8 prio);
 967         int     (*port_set_apptrust)(struct dsa_switch *ds, int port,
 968                                      const u8 *sel, int nsel);
 969         int     (*port_get_apptrust)(struct dsa_switch *ds, int port, u8 *sel,
 970                                      int *nsel);
 971
 972         /*
 973          * Suspend and resume
 974          */
 975         int     (*suspend)(struct dsa_switch *ds);
 976         int     (*resume)(struct dsa_switch *ds);
 977
 978         /*
 979          * Port enable/disable
 980          */
 981         int     (*port_enable)(struct dsa_switch *ds, int port,
 982                                struct phy_device *phy);
 983         void    (*port_disable)(struct dsa_switch *ds, int port);
 984
 985
 986         /*
 987          * Notification for MAC address changes on user ports. Drivers can
 988          * currently only veto operations. They should not use the method to
 989          * program the hardware, since the operation is not rolled back in case
 990          * of other errors.
 991          */
 992         int     (*port_set_mac_address)(struct dsa_switch *ds, int port,
 993                                         const unsigned char *addr);
 994
 995         /*
 996          * Compatibility between device trees defining multiple CPU ports and
 997          * drivers which are not OK to use by default the numerically smallest
 998          * CPU port of a switch for its local ports. This can return NULL,
 999          * meaning "don't know/don't care".
1000          */
1001         struct dsa_port *(*preferred_default_local_cpu_port)(struct dsa_switch *ds);
1002
1003         /*
1004          * Port's MAC EEE settings
1005          */
1006         int     (*set_mac_eee)(struct dsa_switch *ds, int port,
1007                                struct ethtool_keee *e);
1008         int     (*get_mac_eee)(struct dsa_switch *ds, int port,
1009                                struct ethtool_keee *e);
1010
1011         /* EEPROM access */
1012         int     (*get_eeprom_len)(struct dsa_switch *ds);
1013         int     (*get_eeprom)(struct dsa_switch *ds,
1014                               struct ethtool_eeprom *eeprom, u8 *data);
1015         int     (*set_eeprom)(struct dsa_switch *ds,
1016                               struct ethtool_eeprom *eeprom, u8 *data);
1017
1018         /*
1019          * Register access.
1020          */
1021         int     (*get_regs_len)(struct dsa_switch *ds, int port);
1022         void    (*get_regs)(struct dsa_switch *ds, int port,
1023                             struct ethtool_regs *regs, void *p);
1024
1025         /*
1026          * Upper device tracking.
1027          */
1028         int     (*port_prechangeupper)(struct dsa_switch *ds, int port,
1029                                        struct netdev_notifier_changeupper_info *info);
1030
1031         /*
1032          * Bridge integration
1033          */
1034         int     (*set_ageing_time)(struct dsa_switch *ds, unsigned int msecs);
1035         int     (*port_bridge_join)(struct dsa_switch *ds, int port,
1036                                     struct dsa_bridge bridge,
1037                                     bool *tx_fwd_offload,
1038                                     struct netlink_ext_ack *extack);
1039         void    (*port_bridge_leave)(struct dsa_switch *ds, int port,
1040                                      struct dsa_bridge bridge);
1041         void    (*port_stp_state_set)(struct dsa_switch *ds, int port,
1042                                       u8 state);
1043         int     (*port_mst_state_set)(struct dsa_switch *ds, int port,
1044                                       const struct switchdev_mst_state *state);
1045         void    (*port_fast_age)(struct dsa_switch *ds, int port);
1046         int     (*port_vlan_fast_age)(struct dsa_switch *ds, int port, u16 vid);
1047         int     (*port_pre_bridge_flags)(struct dsa_switch *ds, int port,
1048                                          struct switchdev_brport_flags flags,
1049                                          struct netlink_ext_ack *extack);
1050         int     (*port_bridge_flags)(struct dsa_switch *ds, int port,
1051                                      struct switchdev_brport_flags flags,
1052                                      struct netlink_ext_ack *extack);
1053         void    (*port_set_host_flood)(struct dsa_switch *ds, int port,
1054                                        bool uc, bool mc);
1055
1056         /*
1057          * VLAN support
1058          */
1059         int     (*port_vlan_filtering)(struct dsa_switch *ds, int port,
1060                                        bool vlan_filtering,
1061                                        struct netlink_ext_ack *extack);
1062         int     (*port_vlan_add)(struct dsa_switch *ds, int port,
1063                                  const struct switchdev_obj_port_vlan *vlan,
1064                                  struct netlink_ext_ack *extack);
1065         int     (*port_vlan_del)(struct dsa_switch *ds, int port,
1066                                  const struct switchdev_obj_port_vlan *vlan);
1067         int     (*vlan_msti_set)(struct dsa_switch *ds, struct dsa_bridge bridge,
1068                                  const struct switchdev_vlan_msti *msti);
1069
1070         /*
1071          * Forwarding database
1072          */
1073         int     (*port_fdb_add)(struct dsa_switch *ds, int port,
1074                                 const unsigned char *addr, u16 vid,
1075                                 struct dsa_db db);
1076         int     (*port_fdb_del)(struct dsa_switch *ds, int port,
1077                                 const unsigned char *addr, u16 vid,
1078                                 struct dsa_db db);
1079         int     (*port_fdb_dump)(struct dsa_switch *ds, int port,
1080                                  dsa_fdb_dump_cb_t *cb, void *data);
1081         int     (*lag_fdb_add)(struct dsa_switch *ds, struct dsa_lag lag,
1082                                const unsigned char *addr, u16 vid,
1083                                struct dsa_db db);
1084         int     (*lag_fdb_del)(struct dsa_switch *ds, struct dsa_lag lag,
1085                                const unsigned char *addr, u16 vid,
1086                                struct dsa_db db);
1087
1088         /*
1089          * Multicast database
1090          */
1091         int     (*port_mdb_add)(struct dsa_switch *ds, int port,
1092                                 const struct switchdev_obj_port_mdb *mdb,
1093                                 struct dsa_db db);
1094         int     (*port_mdb_del)(struct dsa_switch *ds, int port,
1095                                 const struct switchdev_obj_port_mdb *mdb,
1096                                 struct dsa_db db);
1097         /*
1098          * RXNFC
1099          */
1100         int     (*get_rxnfc)(struct dsa_switch *ds, int port,
1101                              struct ethtool_rxnfc *nfc, u32 *rule_locs);
1102         int     (*set_rxnfc)(struct dsa_switch *ds, int port,
1103                              struct ethtool_rxnfc *nfc);
1104
1105         /*
1106          * TC integration
1107          */
1108         int     (*cls_flower_add)(struct dsa_switch *ds, int port,
1109                                   struct flow_cls_offload *cls, bool ingress);
1110         int     (*cls_flower_del)(struct dsa_switch *ds, int port,
1111                                   struct flow_cls_offload *cls, bool ingress);
1112         int     (*cls_flower_stats)(struct dsa_switch *ds, int port,
1113                                     struct flow_cls_offload *cls, bool ingress);
1114         int     (*port_mirror_add)(struct dsa_switch *ds, int port,
1115                                    struct dsa_mall_mirror_tc_entry *mirror,
1116                                    bool ingress, struct netlink_ext_ack *extack);
1117         void    (*port_mirror_del)(struct dsa_switch *ds, int port,
1118                                    struct dsa_mall_mirror_tc_entry *mirror);
1119         int     (*port_policer_add)(struct dsa_switch *ds, int port,
1120                                     struct dsa_mall_policer_tc_entry *policer);
1121         void    (*port_policer_del)(struct dsa_switch *ds, int port);
1122         int     (*port_setup_tc)(struct dsa_switch *ds, int port,
1123                                  enum tc_setup_type type, void *type_data);
1124
1125         /*
1126          * Cross-chip operations
1127          */
1128         int     (*crosschip_bridge_join)(struct dsa_switch *ds, int tree_index,
1129                                          int sw_index, int port,
1130                                          struct dsa_bridge bridge,
1131                                          struct netlink_ext_ack *extack);
1132         void    (*crosschip_bridge_leave)(struct dsa_switch *ds, int tree_index,
1133                                           int sw_index, int port,
1134                                           struct dsa_bridge bridge);
1135         int     (*crosschip_lag_change)(struct dsa_switch *ds, int sw_index,
1136                                         int port);
1137         int     (*crosschip_lag_join)(struct dsa_switch *ds, int sw_index,
1138                                       int port, struct dsa_lag lag,
1139                                       struct netdev_lag_upper_info *info,
1140                                       struct netlink_ext_ack *extack);
1141         int     (*crosschip_lag_leave)(struct dsa_switch *ds, int sw_index,
1142                                        int port, struct dsa_lag lag);
1143
1144         /*
1145          * PTP functionality
1146          */
1147         int     (*port_hwtstamp_get)(struct dsa_switch *ds, int port,
1148                                      struct ifreq *ifr);
1149         int     (*port_hwtstamp_set)(struct dsa_switch *ds, int port,
1150                                      struct ifreq *ifr);
1151         void    (*port_txtstamp)(struct dsa_switch *ds, int port,
1152                                  struct sk_buff *skb);
1153         bool    (*port_rxtstamp)(struct dsa_switch *ds, int port,
1154                                  struct sk_buff *skb, unsigned int type);
1155
1156         /* Devlink parameters, etc */
1157         int     (*devlink_param_get)(struct dsa_switch *ds, u32 id,
1158                                      struct devlink_param_gset_ctx *ctx);
1159         int     (*devlink_param_set)(struct dsa_switch *ds, u32 id,
1160                                      struct devlink_param_gset_ctx *ctx);
1161         int     (*devlink_info_get)(struct dsa_switch *ds,
1162                                     struct devlink_info_req *req,
1163                                     struct netlink_ext_ack *extack);
1164         int     (*devlink_sb_pool_get)(struct dsa_switch *ds,
1165                                        unsigned int sb_index, u16 pool_index,
1166                                        struct devlink_sb_pool_info *pool_info);
1167         int     (*devlink_sb_pool_set)(struct dsa_switch *ds, unsigned int sb_index,
1168                                        u16 pool_index, u32 size,
1169                                        enum devlink_sb_threshold_type threshold_type,
1170                                        struct netlink_ext_ack *extack);
1171         int     (*devlink_sb_port_pool_get)(struct dsa_switch *ds, int port,
1172                                             unsigned int sb_index, u16 pool_index,
1173                                             u32 *p_threshold);
1174         int     (*devlink_sb_port_pool_set)(struct dsa_switch *ds, int port,
1175                                             unsigned int sb_index, u16 pool_index,
1176                                             u32 threshold,
1177                                             struct netlink_ext_ack *extack);
1178         int     (*devlink_sb_tc_pool_bind_get)(struct dsa_switch *ds, int port,
1179                                                unsigned int sb_index, u16 tc_index,
1180                                                enum devlink_sb_pool_type pool_type,
1181                                                u16 *p_pool_index, u32 *p_threshold);
1182         int     (*devlink_sb_tc_pool_bind_set)(struct dsa_switch *ds, int port,
1183                                                unsigned int sb_index, u16 tc_index,
1184                                                enum devlink_sb_pool_type pool_type,
1185                                                u16 pool_index, u32 threshold,
1186                                                struct netlink_ext_ack *extack);
1187         int     (*devlink_sb_occ_snapshot)(struct dsa_switch *ds,
1188                                            unsigned int sb_index);
1189         int     (*devlink_sb_occ_max_clear)(struct dsa_switch *ds,
1190                                             unsigned int sb_index);
1191         int     (*devlink_sb_occ_port_pool_get)(struct dsa_switch *ds, int port,
1192                                                 unsigned int sb_index, u16 pool_index,
1193                                                 u32 *p_cur, u32 *p_max);
1194         int     (*devlink_sb_occ_tc_port_bind_get)(struct dsa_switch *ds, int port,
1195                                                    unsigned int sb_index, u16 tc_index,
1196                                                    enum devlink_sb_pool_type pool_type,
1197                                                    u32 *p_cur, u32 *p_max);
1198
1199         /*
1200          * MTU change functionality. Switches can also adjust their MRU through
1201          * this method. By MTU, one understands the SDU (L2 payload) length.
1202          * If the switch needs to account for the DSA tag on the CPU port, this
1203          * method needs to do so privately.
1204          */
1205         int     (*port_change_mtu)(struct dsa_switch *ds, int port,
1206                                    int new_mtu);
1207         int     (*port_max_mtu)(struct dsa_switch *ds, int port);
1208
1209         /*
1210          * LAG integration
1211          */
1212         int     (*port_lag_change)(struct dsa_switch *ds, int port);
1213         int     (*port_lag_join)(struct dsa_switch *ds, int port,
1214                                  struct dsa_lag lag,
1215                                  struct netdev_lag_upper_info *info,
1216                                  struct netlink_ext_ack *extack);
1217         int     (*port_lag_leave)(struct dsa_switch *ds, int port,
1218                                   struct dsa_lag lag);
1219
1220         /*
1221          * HSR integration
1222          */
1223         int     (*port_hsr_join)(struct dsa_switch *ds, int port,
1224                                  struct net_device *hsr,
1225                                  struct netlink_ext_ack *extack);
1226         int     (*port_hsr_leave)(struct dsa_switch *ds, int port,
1227                                   struct net_device *hsr);
1228
1229         /*
1230          * MRP integration
1231          */
1232         int     (*port_mrp_add)(struct dsa_switch *ds, int port,
1233                                 const struct switchdev_obj_mrp *mrp);
1234         int     (*port_mrp_del)(struct dsa_switch *ds, int port,
1235                                 const struct switchdev_obj_mrp *mrp);
1236         int     (*port_mrp_add_ring_role)(struct dsa_switch *ds, int port,
1237                                           const struct switchdev_obj_ring_role_mrp *mrp);
1238         int     (*port_mrp_del_ring_role)(struct dsa_switch *ds, int port,
1239                                           const struct switchdev_obj_ring_role_mrp *mrp);
1240
1241         /*
1242          * tag_8021q operations
1243          */
1244         int     (*tag_8021q_vlan_add)(struct dsa_switch *ds, int port, u16 vid,
1245                                       u16 flags);
1246         int     (*tag_8021q_vlan_del)(struct dsa_switch *ds, int port, u16 vid);
1247
1248         /*
1249          * DSA conduit tracking operations
1250          */
1251         void    (*conduit_state_change)(struct dsa_switch *ds,
1252                                         const struct net_device *conduit,
1253                                         bool operational);
1254 };
1255
1256 #define DSA_DEVLINK_PARAM_DRIVER(_id, _name, _type, _cmodes)            \
1257         DEVLINK_PARAM_DRIVER(_id, _name, _type, _cmodes,                \
1258                              dsa_devlink_param_get, dsa_devlink_param_set, NULL)
1259
1260 int dsa_devlink_param_get(struct devlink *dl, u32 id,
1261                           struct devlink_param_gset_ctx *ctx);
1262 int dsa_devlink_param_set(struct devlink *dl, u32 id,
1263                           struct devlink_param_gset_ctx *ctx,
1264                           struct netlink_ext_ack *extack);
1265 int dsa_devlink_params_register(struct dsa_switch *ds,
1266                                 const struct devlink_param *params,
1267                                 size_t params_count);
1268 void dsa_devlink_params_unregister(struct dsa_switch *ds,
1269                                    const struct devlink_param *params,
1270                                    size_t params_count);
1271 int dsa_devlink_resource_register(struct dsa_switch *ds,
1272                                   const char *resource_name,
1273                                   u64 resource_size,
1274                                   u64 resource_id,
1275                                   u64 parent_resource_id,
1276                                   const struct devlink_resource_size_params *size_params);
1277
1278 void dsa_devlink_resources_unregister(struct dsa_switch *ds);
1279
1280 void dsa_devlink_resource_occ_get_register(struct dsa_switch *ds,
1281                                            u64 resource_id,
1282                                            devlink_resource_occ_get_t *occ_get,
1283                                            void *occ_get_priv);
1284 void dsa_devlink_resource_occ_get_unregister(struct dsa_switch *ds,
1285                                              u64 resource_id);
1286 struct devlink_region *
1287 dsa_devlink_region_create(struct dsa_switch *ds,
1288                           const struct devlink_region_ops *ops,
1289                           u32 region_max_snapshots, u64 region_size);
1290 struct devlink_region *
1291 dsa_devlink_port_region_create(struct dsa_switch *ds,
1292                                int port,
1293                                const struct devlink_port_region_ops *ops,
1294                                u32 region_max_snapshots, u64 region_size);
1295 void dsa_devlink_region_destroy(struct devlink_region *region);
1296
1297 struct dsa_port *dsa_port_from_netdev(struct net_device *netdev);
1298
1299 struct dsa_devlink_priv {
1300         struct dsa_switch *ds;
1301 };
1302
1303 static inline struct dsa_switch *dsa_devlink_to_ds(struct devlink *dl)
1304 {
1305         struct dsa_devlink_priv *dl_priv = devlink_priv(dl);
1306
1307         return dl_priv->ds;
1308 }
1309
1310 static inline
1311 struct dsa_switch *dsa_devlink_port_to_ds(struct devlink_port *port)
1312 {
1313         struct devlink *dl = port->devlink;
1314         struct dsa_devlink_priv *dl_priv = devlink_priv(dl);
1315
1316         return dl_priv->ds;
1317 }
1318
1319 static inline int dsa_devlink_port_to_port(struct devlink_port *port)
1320 {
1321         return port->index;
1322 }
1323
1324 struct dsa_switch_driver {
1325         struct list_head        list;
1326         const struct dsa_switch_ops *ops;
1327 };
1328
1329 bool dsa_fdb_present_in_other_db(struct dsa_switch *ds, int port,
1330                                  const unsigned char *addr, u16 vid,
1331                                  struct dsa_db db);
1332 bool dsa_mdb_present_in_other_db(struct dsa_switch *ds, int port,
1333                                  const struct switchdev_obj_port_mdb *mdb,
1334                                  struct dsa_db db);
1335
1336 /* Keep inline for faster access in hot path */
1337 static inline bool netdev_uses_dsa(const struct net_device *dev)
1338 {
1339 #if IS_ENABLED(CONFIG_NET_DSA)
1340         return dev->dsa_ptr && dev->dsa_ptr->rcv;
1341 #endif
1342         return false;
1343 }
1344
1345 /* All DSA tags that push the EtherType to the right (basically all except tail
1346  * tags, which don't break dissection) can be treated the same from the
1347  * perspective of the flow dissector.
1348  *
1349  * We need to return:
1350  *  - offset: the (B - A) difference between:
1351  *    A. the position of the real EtherType and
1352  *    B. the current skb->data (aka ETH_HLEN bytes into the frame, aka 2 bytes
1353  *       after the normal EtherType was supposed to be)
1354  *    The offset in bytes is exactly equal to the tagger overhead (and half of
1355  *    that, in __be16 shorts).
1356  *
1357  *  - proto: the value of the real EtherType.
1358  */
1359 static inline void dsa_tag_generic_flow_dissect(const struct sk_buff *skb,
1360                                                 __be16 *proto, int *offset)
1361 {
1362 #if IS_ENABLED(CONFIG_NET_DSA)
1363         const struct dsa_device_ops *ops = skb->dev->dsa_ptr->tag_ops;
1364         int tag_len = ops->needed_headroom;
1365
1366         *offset = tag_len;
1367         *proto = ((__be16 *)skb->data)[(tag_len / 2) - 1];
1368 #endif
1369 }
1370
1371 void dsa_unregister_switch(struct dsa_switch *ds);
1372 int dsa_register_switch(struct dsa_switch *ds);
1373 void dsa_switch_shutdown(struct dsa_switch *ds);
1374 struct dsa_switch *dsa_switch_find(int tree_index, int sw_index);
1375 void dsa_flush_workqueue(void);
1376 #ifdef CONFIG_PM_SLEEP
1377 int dsa_switch_suspend(struct dsa_switch *ds);
1378 int dsa_switch_resume(struct dsa_switch *ds);
1379 #else
1380 static inline int dsa_switch_suspend(struct dsa_switch *ds)
1381 {
1382         return 0;
1383 }
1384 static inline int dsa_switch_resume(struct dsa_switch *ds)
1385 {
1386         return 0;
1387 }
1388 #endif /* CONFIG_PM_SLEEP */
1389
1390 #if IS_ENABLED(CONFIG_NET_DSA)
1391 bool dsa_user_dev_check(const struct net_device *dev);
1392 #else
1393 static inline bool dsa_user_dev_check(const struct net_device *dev)
1394 {
1395         return false;
1396 }
1397 #endif
1398
1399 netdev_tx_t dsa_enqueue_skb(struct sk_buff *skb, struct net_device *dev);
1400 void dsa_port_phylink_mac_change(struct dsa_switch *ds, int port, bool up);
1401
1402 #endif