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