include/net/dsa.h

   1 /*
   2  * include/net/dsa.h - Driver for Distributed Switch Architecture switch chips
   3  * Copyright (c) 2008-2009 Marvell Semiconductor
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  */
  10
  11 #ifndef __LINUX_NET_DSA_H
  12 #define __LINUX_NET_DSA_H
  13
  14 #include <linux/if.h>
  15 #include <linux/if_ether.h>
  16 #include <linux/list.h>
  17 #include <linux/notifier.h>
  18 #include <linux/timer.h>
  19 #include <linux/workqueue.h>
  20 #include <linux/of.h>
  21 #include <linux/ethtool.h>
  22 #include <linux/net_tstamp.h>
  23 #include <linux/phy.h>
  24 #include <linux/platform_data/dsa.h>
  25 #include <net/devlink.h>
  26 #include <net/switchdev.h>
  27
  28 struct tc_action;
  29 struct phy_device;
  30 struct fixed_phy_status;
  31 struct phylink_link_state;
  32
  33 enum dsa_tag_protocol {
  34         DSA_TAG_PROTO_NONE = 0,
  35         DSA_TAG_PROTO_BRCM,
  36         DSA_TAG_PROTO_BRCM_PREPEND,
  37         DSA_TAG_PROTO_DSA,
  38         DSA_TAG_PROTO_EDSA,
  39         DSA_TAG_PROTO_GSWIP,
  40         DSA_TAG_PROTO_KSZ9477,
  41         DSA_TAG_PROTO_LAN9303,
  42         DSA_TAG_PROTO_MTK,
  43         DSA_TAG_PROTO_QCA,
  44         DSA_TAG_PROTO_TRAILER,
  45         DSA_TAG_LAST,           /* MUST BE LAST */
  46 };
  47
  48 struct packet_type;
  49 struct dsa_switch;
  50
  51 struct dsa_device_ops {
  52         struct sk_buff *(*xmit)(struct sk_buff *skb, struct net_device *dev);
  53         struct sk_buff *(*rcv)(struct sk_buff *skb, struct net_device *dev,
  54                                struct packet_type *pt);
  55         int (*flow_dissect)(const struct sk_buff *skb, __be16 *proto,
  56                             int *offset);
  57         unsigned int overhead;
  58 };
  59
  60 struct dsa_switch_tree {
  61         struct list_head        list;
  62
  63         /* Notifier chain for switch-wide events */
  64         struct raw_notifier_head        nh;
  65
  66         /* Tree identifier */
  67         unsigned int index;
  68
  69         /* Number of switches attached to this tree */
  70         struct kref refcount;
  71
  72         /* Has this tree been applied to the hardware? */
  73         bool setup;
  74
  75         /*
  76          * Configuration data for the platform device that owns
  77          * this dsa switch tree instance.
  78          */
  79         struct dsa_platform_data        *pd;
  80
  81         /*
  82          * The switch port to which the CPU is attached.
  83          */
  84         struct dsa_port         *cpu_dp;
  85
  86         /*
  87          * Data for the individual switch chips.
  88          */
  89         struct dsa_switch       *ds[DSA_MAX_SWITCHES];
  90 };
  91
  92 /* TC matchall action types, only mirroring for now */
  93 enum dsa_port_mall_action_type {
  94         DSA_PORT_MALL_MIRROR,
  95 };
  96
  97 /* TC mirroring entry */
  98 struct dsa_mall_mirror_tc_entry {
  99         u8 to_local_port;
 100         bool ingress;
 101 };
 102
 103 /* TC matchall entry */
 104 struct dsa_mall_tc_entry {
 105         struct list_head list;
 106         unsigned long cookie;
 107         enum dsa_port_mall_action_type type;
 108         union {
 109                 struct dsa_mall_mirror_tc_entry mirror;
 110         };
 111 };
 112
 113
 114 struct dsa_port {
 115         /* A CPU port is physically connected to a master device.
 116          * A user port exposed to userspace has a slave device.
 117          */
 118         union {
 119                 struct net_device *master;
 120                 struct net_device *slave;
 121         };
 122
 123         /* CPU port tagging operations used by master or slave devices */
 124         const struct dsa_device_ops *tag_ops;
 125
 126         /* Copies for faster access in master receive hot path */
 127         struct dsa_switch_tree *dst;
 128         struct sk_buff *(*rcv)(struct sk_buff *skb, struct net_device *dev,
 129                                struct packet_type *pt);
 130
 131         enum {
 132                 DSA_PORT_TYPE_UNUSED = 0,
 133                 DSA_PORT_TYPE_CPU,
 134                 DSA_PORT_TYPE_DSA,
 135                 DSA_PORT_TYPE_USER,
 136         } type;
 137
 138         struct dsa_switch       *ds;
 139         unsigned int            index;
 140         const char              *name;
 141         const struct dsa_port   *cpu_dp;
 142         struct device_node      *dn;
 143         unsigned int            ageing_time;
 144         u8                      stp_state;
 145         struct net_device       *bridge_dev;
 146         struct devlink_port     devlink_port;
 147         struct phylink          *pl;
 148         /*
 149          * Original copy of the master netdev ethtool_ops
 150          */
 151         const struct ethtool_ops *orig_ethtool_ops;
 152
 153         /*
 154          * Original copy of the master netdev net_device_ops
 155          */
 156         const struct net_device_ops *orig_ndo_ops;
 157 };
 158
 159 struct dsa_switch {
 160         struct device *dev;
 161
 162         /*
 163          * Parent switch tree, and switch index.
 164          */
 165         struct dsa_switch_tree  *dst;
 166         unsigned int            index;
 167
 168         /* Listener for switch fabric events */
 169         struct notifier_block   nb;
 170
 171         /*
 172          * Give the switch driver somewhere to hang its private data
 173          * structure.
 174          */
 175         void *priv;
 176
 177         /*
 178          * Configuration data for this switch.
 179          */
 180         struct dsa_chip_data    *cd;
 181
 182         /*
 183          * The switch operations.
 184          */
 185         const struct dsa_switch_ops     *ops;
 186
 187         /*
 188          * An array of which element [a] indicates which port on this
 189          * switch should be used to send packets to that are destined
 190          * for switch a. Can be NULL if there is only one switch chip.
 191          */
 192         s8              rtable[DSA_MAX_SWITCHES];
 193
 194         /*
 195          * Slave mii_bus and devices for the individual ports.
 196          */
 197         u32                     phys_mii_mask;
 198         struct mii_bus          *slave_mii_bus;
 199
 200         /* Ageing Time limits in msecs */
 201         unsigned int ageing_time_min;
 202         unsigned int ageing_time_max;
 203
 204         /* devlink used to represent this switch device */
 205         struct devlink          *devlink;
 206
 207         /* Number of switch port queues */
 208         unsigned int            num_tx_queues;
 209
 210         unsigned long           *bitmap;
 211         unsigned long           _bitmap;
 212
 213         /* Dynamically allocated ports, keep last */
 214         size_t num_ports;
 215         struct dsa_port ports[];
 216 };
 217
 218 static inline const struct dsa_port *dsa_to_port(struct dsa_switch *ds, int p)
 219 {
 220         return &ds->ports[p];
 221 }
 222
 223 static inline bool dsa_is_unused_port(struct dsa_switch *ds, int p)
 224 {
 225         return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_UNUSED;
 226 }
 227
 228 static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p)
 229 {
 230         return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_CPU;
 231 }
 232
 233 static inline bool dsa_is_dsa_port(struct dsa_switch *ds, int p)
 234 {
 235         return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_DSA;
 236 }
 237
 238 static inline bool dsa_is_user_port(struct dsa_switch *ds, int p)
 239 {
 240         return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_USER;
 241 }
 242
 243 static inline u32 dsa_user_ports(struct dsa_switch *ds)
 244 {
 245         u32 mask = 0;
 246         int p;
 247
 248         for (p = 0; p < ds->num_ports; p++)
 249                 if (dsa_is_user_port(ds, p))
 250                         mask |= BIT(p);
 251
 252         return mask;
 253 }
 254
 255 /* Return the local port used to reach an arbitrary switch port */
 256 static inline unsigned int dsa_towards_port(struct dsa_switch *ds, int device,
 257                                             int port)
 258 {
 259         if (device == ds->index)
 260                 return port;
 261         else
 262                 return ds->rtable[device];
 263 }
 264
 265 /* Return the local port used to reach the dedicated CPU port */
 266 static inline unsigned int dsa_upstream_port(struct dsa_switch *ds, int port)
 267 {
 268         const struct dsa_port *dp = dsa_to_port(ds, port);
 269         const struct dsa_port *cpu_dp = dp->cpu_dp;
 270
 271         if (!cpu_dp)
 272                 return port;
 273
 274         return dsa_towards_port(ds, cpu_dp->ds->index, cpu_dp->index);
 275 }
 276
 277 typedef int dsa_fdb_dump_cb_t(const unsigned char *addr, u16 vid,
 278                               bool is_static, void *data);
 279 struct dsa_switch_ops {
 280 #if IS_ENABLED(CONFIG_NET_DSA_LEGACY)
 281         /*
 282          * Legacy probing.
 283          */
 284         const char      *(*probe)(struct device *dsa_dev,
 285                                   struct device *host_dev, int sw_addr,
 286                                   void **priv);
 287 #endif
 288
 289         enum dsa_tag_protocol (*get_tag_protocol)(struct dsa_switch *ds,
 290                                                   int port);
 291
 292         int     (*setup)(struct dsa_switch *ds);
 293         u32     (*get_phy_flags)(struct dsa_switch *ds, int port);
 294
 295         /*
 296          * Access to the switch's PHY registers.
 297          */
 298         int     (*phy_read)(struct dsa_switch *ds, int port, int regnum);
 299         int     (*phy_write)(struct dsa_switch *ds, int port,
 300                              int regnum, u16 val);
 301
 302         /*
 303          * Link state adjustment (called from libphy)
 304          */
 305         void    (*adjust_link)(struct dsa_switch *ds, int port,
 306                                 struct phy_device *phydev);
 307         void    (*fixed_link_update)(struct dsa_switch *ds, int port,
 308                                 struct fixed_phy_status *st);
 309
 310         /*
 311          * PHYLINK integration
 312          */
 313         void    (*phylink_validate)(struct dsa_switch *ds, int port,
 314                                     unsigned long *supported,
 315                                     struct phylink_link_state *state);
 316         int     (*phylink_mac_link_state)(struct dsa_switch *ds, int port,
 317                                           struct phylink_link_state *state);
 318         void    (*phylink_mac_config)(struct dsa_switch *ds, int port,
 319                                       unsigned int mode,
 320                                       const struct phylink_link_state *state);
 321         void    (*phylink_mac_an_restart)(struct dsa_switch *ds, int port);
 322         void    (*phylink_mac_link_down)(struct dsa_switch *ds, int port,
 323                                          unsigned int mode,
 324                                          phy_interface_t interface);
 325         void    (*phylink_mac_link_up)(struct dsa_switch *ds, int port,
 326                                        unsigned int mode,
 327                                        phy_interface_t interface,
 328                                        struct phy_device *phydev);
 329         void    (*phylink_fixed_state)(struct dsa_switch *ds, int port,
 330                                        struct phylink_link_state *state);
 331         /*
 332          * ethtool hardware statistics.
 333          */
 334         void    (*get_strings)(struct dsa_switch *ds, int port,
 335                                u32 stringset, uint8_t *data);
 336         void    (*get_ethtool_stats)(struct dsa_switch *ds,
 337                                      int port, uint64_t *data);
 338         int     (*get_sset_count)(struct dsa_switch *ds, int port, int sset);
 339         void    (*get_ethtool_phy_stats)(struct dsa_switch *ds,
 340                                          int port, uint64_t *data);
 341
 342         /*
 343          * ethtool Wake-on-LAN
 344          */
 345         void    (*get_wol)(struct dsa_switch *ds, int port,
 346                            struct ethtool_wolinfo *w);
 347         int     (*set_wol)(struct dsa_switch *ds, int port,
 348                            struct ethtool_wolinfo *w);
 349
 350         /*
 351          * ethtool timestamp info
 352          */
 353         int     (*get_ts_info)(struct dsa_switch *ds, int port,
 354                                struct ethtool_ts_info *ts);
 355
 356         /*
 357          * Suspend and resume
 358          */
 359         int     (*suspend)(struct dsa_switch *ds);
 360         int     (*resume)(struct dsa_switch *ds);
 361
 362         /*
 363          * Port enable/disable
 364          */
 365         int     (*port_enable)(struct dsa_switch *ds, int port,
 366                                struct phy_device *phy);
 367         void    (*port_disable)(struct dsa_switch *ds, int port);
 368
 369         /*
 370          * Port's MAC EEE settings
 371          */
 372         int     (*set_mac_eee)(struct dsa_switch *ds, int port,
 373                                struct ethtool_eee *e);
 374         int     (*get_mac_eee)(struct dsa_switch *ds, int port,
 375                                struct ethtool_eee *e);
 376
 377         /* EEPROM access */
 378         int     (*get_eeprom_len)(struct dsa_switch *ds);
 379         int     (*get_eeprom)(struct dsa_switch *ds,
 380                               struct ethtool_eeprom *eeprom, u8 *data);
 381         int     (*set_eeprom)(struct dsa_switch *ds,
 382                               struct ethtool_eeprom *eeprom, u8 *data);
 383
 384         /*
 385          * Register access.
 386          */
 387         int     (*get_regs_len)(struct dsa_switch *ds, int port);
 388         void    (*get_regs)(struct dsa_switch *ds, int port,
 389                             struct ethtool_regs *regs, void *p);
 390
 391         /*
 392          * Bridge integration
 393          */
 394         int     (*set_ageing_time)(struct dsa_switch *ds, unsigned int msecs);
 395         int     (*port_bridge_join)(struct dsa_switch *ds, int port,
 396                                     struct net_device *bridge);
 397         void    (*port_bridge_leave)(struct dsa_switch *ds, int port,
 398                                      struct net_device *bridge);
 399         void    (*port_stp_state_set)(struct dsa_switch *ds, int port,
 400                                       u8 state);
 401         void    (*port_fast_age)(struct dsa_switch *ds, int port);
 402         int     (*port_egress_floods)(struct dsa_switch *ds, int port,
 403                                       bool unicast, bool multicast);
 404
 405         /*
 406          * VLAN support
 407          */
 408         int     (*port_vlan_filtering)(struct dsa_switch *ds, int port,
 409                                        bool vlan_filtering);
 410         int (*port_vlan_prepare)(struct dsa_switch *ds, int port,
 411                                  const struct switchdev_obj_port_vlan *vlan);
 412         void (*port_vlan_add)(struct dsa_switch *ds, int port,
 413                               const struct switchdev_obj_port_vlan *vlan);
 414         int     (*port_vlan_del)(struct dsa_switch *ds, int port,
 415                                  const struct switchdev_obj_port_vlan *vlan);
 416         /*
 417          * Forwarding database
 418          */
 419         int     (*port_fdb_add)(struct dsa_switch *ds, int port,
 420                                 const unsigned char *addr, u16 vid);
 421         int     (*port_fdb_del)(struct dsa_switch *ds, int port,
 422                                 const unsigned char *addr, u16 vid);
 423         int     (*port_fdb_dump)(struct dsa_switch *ds, int port,
 424                                  dsa_fdb_dump_cb_t *cb, void *data);
 425
 426         /*
 427          * Multicast database
 428          */
 429         int (*port_mdb_prepare)(struct dsa_switch *ds, int port,
 430                                 const struct switchdev_obj_port_mdb *mdb);
 431         void (*port_mdb_add)(struct dsa_switch *ds, int port,
 432                              const struct switchdev_obj_port_mdb *mdb);
 433         int     (*port_mdb_del)(struct dsa_switch *ds, int port,
 434                                 const struct switchdev_obj_port_mdb *mdb);
 435         /*
 436          * RXNFC
 437          */
 438         int     (*get_rxnfc)(struct dsa_switch *ds, int port,
 439                              struct ethtool_rxnfc *nfc, u32 *rule_locs);
 440         int     (*set_rxnfc)(struct dsa_switch *ds, int port,
 441                              struct ethtool_rxnfc *nfc);
 442
 443         /*
 444          * TC integration
 445          */
 446         int     (*port_mirror_add)(struct dsa_switch *ds, int port,
 447                                    struct dsa_mall_mirror_tc_entry *mirror,
 448                                    bool ingress);
 449         void    (*port_mirror_del)(struct dsa_switch *ds, int port,
 450                                    struct dsa_mall_mirror_tc_entry *mirror);
 451
 452         /*
 453          * Cross-chip operations
 454          */
 455         int     (*crosschip_bridge_join)(struct dsa_switch *ds, int sw_index,
 456                                          int port, struct net_device *br);
 457         void    (*crosschip_bridge_leave)(struct dsa_switch *ds, int sw_index,
 458                                           int port, struct net_device *br);
 459
 460         /*
 461          * PTP functionality
 462          */
 463         int     (*port_hwtstamp_get)(struct dsa_switch *ds, int port,
 464                                      struct ifreq *ifr);
 465         int     (*port_hwtstamp_set)(struct dsa_switch *ds, int port,
 466                                      struct ifreq *ifr);
 467         bool    (*port_txtstamp)(struct dsa_switch *ds, int port,
 468                                  struct sk_buff *clone, unsigned int type);
 469         bool    (*port_rxtstamp)(struct dsa_switch *ds, int port,
 470                                  struct sk_buff *skb, unsigned int type);
 471 };
 472
 473 struct dsa_switch_driver {
 474         struct list_head        list;
 475         const struct dsa_switch_ops *ops;
 476 };
 477
 478 #if IS_ENABLED(CONFIG_NET_DSA_LEGACY)
 479 /* Legacy driver registration */
 480 void register_switch_driver(struct dsa_switch_driver *type);
 481 void unregister_switch_driver(struct dsa_switch_driver *type);
 482 struct mii_bus *dsa_host_dev_to_mii_bus(struct device *dev);
 483
 484 #else
 485 static inline void register_switch_driver(struct dsa_switch_driver *type) { }
 486 static inline void unregister_switch_driver(struct dsa_switch_driver *type) { }
 487 static inline struct mii_bus *dsa_host_dev_to_mii_bus(struct device *dev)
 488 {
 489         return NULL;
 490 }
 491 #endif
 492 struct net_device *dsa_dev_to_net_device(struct device *dev);
 493
 494 /* Keep inline for faster access in hot path */
 495 static inline bool netdev_uses_dsa(struct net_device *dev)
 496 {
 497 #if IS_ENABLED(CONFIG_NET_DSA)
 498         return dev->dsa_ptr && dev->dsa_ptr->rcv;
 499 #endif
 500         return false;
 501 }
 502
 503 struct dsa_switch *dsa_switch_alloc(struct device *dev, size_t n);
 504 void dsa_unregister_switch(struct dsa_switch *ds);
 505 int dsa_register_switch(struct dsa_switch *ds);
 506 #ifdef CONFIG_PM_SLEEP
 507 int dsa_switch_suspend(struct dsa_switch *ds);
 508 int dsa_switch_resume(struct dsa_switch *ds);
 509 #else
 510 static inline int dsa_switch_suspend(struct dsa_switch *ds)
 511 {
 512         return 0;
 513 }
 514 static inline int dsa_switch_resume(struct dsa_switch *ds)
 515 {
 516         return 0;
 517 }
 518 #endif /* CONFIG_PM_SLEEP */
 519
 520 enum dsa_notifier_type {
 521         DSA_PORT_REGISTER,
 522         DSA_PORT_UNREGISTER,
 523 };
 524
 525 struct dsa_notifier_info {
 526         struct net_device *dev;
 527 };
 528
 529 struct dsa_notifier_register_info {
 530         struct dsa_notifier_info info;  /* must be first */
 531         struct net_device *master;
 532         unsigned int port_number;
 533         unsigned int switch_number;
 534 };
 535
 536 static inline struct net_device *
 537 dsa_notifier_info_to_dev(const struct dsa_notifier_info *info)
 538 {
 539         return info->dev;
 540 }
 541
 542 #if IS_ENABLED(CONFIG_NET_DSA)
 543 int register_dsa_notifier(struct notifier_block *nb);
 544 int unregister_dsa_notifier(struct notifier_block *nb);
 545 int call_dsa_notifiers(unsigned long val, struct net_device *dev,
 546                        struct dsa_notifier_info *info);
 547 #else
 548 static inline int register_dsa_notifier(struct notifier_block *nb)
 549 {
 550         return 0;
 551 }
 552
 553 static inline int unregister_dsa_notifier(struct notifier_block *nb)
 554 {
 555         return 0;
 556 }
 557
 558 static inline int call_dsa_notifiers(unsigned long val, struct net_device *dev,
 559                                      struct dsa_notifier_info *info)
 560 {
 561         return NOTIFY_DONE;
 562 }
 563 #endif
 564
 565 /* Broadcom tag specific helpers to insert and extract queue/port number */
 566 #define BRCM_TAG_SET_PORT_QUEUE(p, q)   ((p) << 8 | q)
 567 #define BRCM_TAG_GET_PORT(v)            ((v) >> 8)
 568 #define BRCM_TAG_GET_QUEUE(v)           ((v) & 0xff)
 569
 570
 571 int dsa_port_get_phy_strings(struct dsa_port *dp, uint8_t *data);
 572 int dsa_port_get_ethtool_phy_stats(struct dsa_port *dp, uint64_t *data);
 573 int dsa_port_get_phy_sset_count(struct dsa_port *dp);
 574 void dsa_port_phylink_mac_change(struct dsa_switch *ds, int port, bool up);
 575
 576 #endif