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 <net/devlink.h>
  23 #include <net/switchdev.h>
  24
  25 struct tc_action;
  26 struct phy_device;
  27 struct fixed_phy_status;
  28
  29 enum dsa_tag_protocol {
  30         DSA_TAG_PROTO_NONE = 0,
  31         DSA_TAG_PROTO_BRCM,
  32         DSA_TAG_PROTO_DSA,
  33         DSA_TAG_PROTO_EDSA,
  34         DSA_TAG_PROTO_KSZ,
  35         DSA_TAG_PROTO_LAN9303,
  36         DSA_TAG_PROTO_MTK,
  37         DSA_TAG_PROTO_QCA,
  38         DSA_TAG_PROTO_TRAILER,
  39         DSA_TAG_LAST,           /* MUST BE LAST */
  40 };
  41
  42 #define DSA_MAX_SWITCHES        4
  43 #define DSA_MAX_PORTS           12
  44
  45 #define DSA_RTABLE_NONE         -1
  46
  47 struct dsa_chip_data {
  48         /*
  49          * How to access the switch configuration registers.
  50          */
  51         struct device   *host_dev;
  52         int             sw_addr;
  53
  54         /*
  55          * Reference to network devices
  56          */
  57         struct device   *netdev[DSA_MAX_PORTS];
  58
  59         /* set to size of eeprom if supported by the switch */
  60         int             eeprom_len;
  61
  62         /* Device tree node pointer for this specific switch chip
  63          * used during switch setup in case additional properties
  64          * and resources needs to be used
  65          */
  66         struct device_node *of_node;
  67
  68         /*
  69          * The names of the switch's ports.  Use "cpu" to
  70          * designate the switch port that the cpu is connected to,
  71          * "dsa" to indicate that this port is a DSA link to
  72          * another switch, NULL to indicate the port is unused,
  73          * or any other string to indicate this is a physical port.
  74          */
  75         char            *port_names[DSA_MAX_PORTS];
  76         struct device_node *port_dn[DSA_MAX_PORTS];
  77
  78         /*
  79          * An array of which element [a] indicates which port on this
  80          * switch should be used to send packets to that are destined
  81          * for switch a. Can be NULL if there is only one switch chip.
  82          */
  83         s8              rtable[DSA_MAX_SWITCHES];
  84 };
  85
  86 struct dsa_platform_data {
  87         /*
  88          * Reference to a Linux network interface that connects
  89          * to the root switch chip of the tree.
  90          */
  91         struct device   *netdev;
  92         struct net_device *of_netdev;
  93
  94         /*
  95          * Info structs describing each of the switch chips
  96          * connected via this network interface.
  97          */
  98         int             nr_chips;
  99         struct dsa_chip_data    *chip;
 100 };
 101
 102 struct packet_type;
 103
 104 struct dsa_switch_tree {
 105         struct list_head        list;
 106
 107         /* Notifier chain for switch-wide events */
 108         struct raw_notifier_head        nh;
 109
 110         /* Tree identifier */
 111         u32 tree;
 112
 113         /* Number of switches attached to this tree */
 114         struct kref refcount;
 115
 116         /* Has this tree been applied to the hardware? */
 117         bool applied;
 118
 119         /*
 120          * Configuration data for the platform device that owns
 121          * this dsa switch tree instance.
 122          */
 123         struct dsa_platform_data        *pd;
 124
 125         /*
 126          * Reference to network device to use, and which tagging
 127          * protocol to use.
 128          */
 129         struct net_device       *master_netdev;
 130
 131         /* Copy of tag_ops->rcv for faster access in hot path */
 132         struct sk_buff *        (*rcv)(struct sk_buff *skb,
 133                                        struct net_device *dev,
 134                                        struct packet_type *pt,
 135                                        struct net_device *orig_dev);
 136
 137         /*
 138          * Original copy of the master netdev ethtool_ops
 139          */
 140         struct ethtool_ops      master_ethtool_ops;
 141         const struct ethtool_ops *master_orig_ethtool_ops;
 142
 143         /*
 144          * The switch port to which the CPU is attached.
 145          */
 146         struct dsa_port         *cpu_dp;
 147
 148         /*
 149          * Data for the individual switch chips.
 150          */
 151         struct dsa_switch       *ds[DSA_MAX_SWITCHES];
 152
 153         /*
 154          * Tagging protocol operations for adding and removing an
 155          * encapsulation tag.
 156          */
 157         const struct dsa_device_ops *tag_ops;
 158 };
 159
 160 /* TC matchall action types, only mirroring for now */
 161 enum dsa_port_mall_action_type {
 162         DSA_PORT_MALL_MIRROR,
 163 };
 164
 165 /* TC mirroring entry */
 166 struct dsa_mall_mirror_tc_entry {
 167         u8 to_local_port;
 168         bool ingress;
 169 };
 170
 171 /* TC matchall entry */
 172 struct dsa_mall_tc_entry {
 173         struct list_head list;
 174         unsigned long cookie;
 175         enum dsa_port_mall_action_type type;
 176         union {
 177                 struct dsa_mall_mirror_tc_entry mirror;
 178         };
 179 };
 180
 181
 182 struct dsa_port {
 183         struct dsa_switch       *ds;
 184         unsigned int            index;
 185         const char              *name;
 186         struct net_device       *netdev;
 187         struct device_node      *dn;
 188         unsigned int            ageing_time;
 189         u8                      stp_state;
 190         struct net_device       *bridge_dev;
 191         struct devlink_port     devlink_port;
 192 };
 193
 194 struct dsa_switch {
 195         struct device *dev;
 196
 197         /*
 198          * Parent switch tree, and switch index.
 199          */
 200         struct dsa_switch_tree  *dst;
 201         int                     index;
 202
 203         /* Listener for switch fabric events */
 204         struct notifier_block   nb;
 205
 206         /*
 207          * Give the switch driver somewhere to hang its private data
 208          * structure.
 209          */
 210         void *priv;
 211
 212         /*
 213          * Configuration data for this switch.
 214          */
 215         struct dsa_chip_data    *cd;
 216
 217         /*
 218          * The switch operations.
 219          */
 220         const struct dsa_switch_ops     *ops;
 221
 222         /*
 223          * An array of which element [a] indicates which port on this
 224          * switch should be used to send packets to that are destined
 225          * for switch a. Can be NULL if there is only one switch chip.
 226          */
 227         s8              rtable[DSA_MAX_SWITCHES];
 228
 229         /*
 230          * The lower device this switch uses to talk to the host
 231          */
 232         struct net_device *master_netdev;
 233
 234         /*
 235          * Slave mii_bus and devices for the individual ports.
 236          */
 237         u32                     dsa_port_mask;
 238         u32                     cpu_port_mask;
 239         u32                     enabled_port_mask;
 240         u32                     phys_mii_mask;
 241         struct mii_bus          *slave_mii_bus;
 242
 243         /* Ageing Time limits in msecs */
 244         unsigned int ageing_time_min;
 245         unsigned int ageing_time_max;
 246
 247         /* devlink used to represent this switch device */
 248         struct devlink          *devlink;
 249
 250         /* Dynamically allocated ports, keep last */
 251         size_t num_ports;
 252         struct dsa_port ports[];
 253 };
 254
 255 static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p)
 256 {
 257         return !!(ds->cpu_port_mask & (1 << p));
 258 }
 259
 260 static inline bool dsa_is_dsa_port(struct dsa_switch *ds, int p)
 261 {
 262         return !!((ds->dsa_port_mask) & (1 << p));
 263 }
 264
 265 static inline bool dsa_is_normal_port(struct dsa_switch *ds, int p)
 266 {
 267         return !dsa_is_cpu_port(ds, p) && !dsa_is_dsa_port(ds, p);
 268 }
 269
 270 static inline bool dsa_is_port_initialized(struct dsa_switch *ds, int p)
 271 {
 272         return ds->enabled_port_mask & (1 << p) && ds->ports[p].netdev;
 273 }
 274
 275 static inline u8 dsa_upstream_port(struct dsa_switch *ds)
 276 {
 277         struct dsa_switch_tree *dst = ds->dst;
 278
 279         /*
 280          * If this is the root switch (i.e. the switch that connects
 281          * to the CPU), return the cpu port number on this switch.
 282          * Else return the (DSA) port number that connects to the
 283          * switch that is one hop closer to the cpu.
 284          */
 285         if (dst->cpu_dp->ds == ds)
 286                 return dst->cpu_dp->index;
 287         else
 288                 return ds->rtable[dst->cpu_dp->ds->index];
 289 }
 290
 291 struct dsa_switch_ops {
 292         /*
 293          * Legacy probing.
 294          */
 295         const char      *(*probe)(struct device *dsa_dev,
 296                                   struct device *host_dev, int sw_addr,
 297                                   void **priv);
 298
 299         enum dsa_tag_protocol (*get_tag_protocol)(struct dsa_switch *ds);
 300
 301         int     (*setup)(struct dsa_switch *ds);
 302         int     (*set_addr)(struct dsa_switch *ds, u8 *addr);
 303         u32     (*get_phy_flags)(struct dsa_switch *ds, int port);
 304
 305         /*
 306          * Access to the switch's PHY registers.
 307          */
 308         int     (*phy_read)(struct dsa_switch *ds, int port, int regnum);
 309         int     (*phy_write)(struct dsa_switch *ds, int port,
 310                              int regnum, u16 val);
 311
 312         /*
 313          * Link state adjustment (called from libphy)
 314          */
 315         void    (*adjust_link)(struct dsa_switch *ds, int port,
 316                                 struct phy_device *phydev);
 317         void    (*fixed_link_update)(struct dsa_switch *ds, int port,
 318                                 struct fixed_phy_status *st);
 319
 320         /*
 321          * ethtool hardware statistics.
 322          */
 323         void    (*get_strings)(struct dsa_switch *ds, int port, uint8_t *data);
 324         void    (*get_ethtool_stats)(struct dsa_switch *ds,
 325                                      int port, uint64_t *data);
 326         int     (*get_sset_count)(struct dsa_switch *ds);
 327
 328         /*
 329          * ethtool Wake-on-LAN
 330          */
 331         void    (*get_wol)(struct dsa_switch *ds, int port,
 332                            struct ethtool_wolinfo *w);
 333         int     (*set_wol)(struct dsa_switch *ds, int port,
 334                            struct ethtool_wolinfo *w);
 335
 336         /*
 337          * Suspend and resume
 338          */
 339         int     (*suspend)(struct dsa_switch *ds);
 340         int     (*resume)(struct dsa_switch *ds);
 341
 342         /*
 343          * Port enable/disable
 344          */
 345         int     (*port_enable)(struct dsa_switch *ds, int port,
 346                                struct phy_device *phy);
 347         void    (*port_disable)(struct dsa_switch *ds, int port,
 348                                 struct phy_device *phy);
 349
 350         /*
 351          * EEE setttings
 352          */
 353         int     (*set_eee)(struct dsa_switch *ds, int port,
 354                            struct phy_device *phydev,
 355                            struct ethtool_eee *e);
 356         int     (*get_eee)(struct dsa_switch *ds, int port,
 357                            struct ethtool_eee *e);
 358
 359         /* EEPROM access */
 360         int     (*get_eeprom_len)(struct dsa_switch *ds);
 361         int     (*get_eeprom)(struct dsa_switch *ds,
 362                               struct ethtool_eeprom *eeprom, u8 *data);
 363         int     (*set_eeprom)(struct dsa_switch *ds,
 364                               struct ethtool_eeprom *eeprom, u8 *data);
 365
 366         /*
 367          * Register access.
 368          */
 369         int     (*get_regs_len)(struct dsa_switch *ds, int port);
 370         void    (*get_regs)(struct dsa_switch *ds, int port,
 371                             struct ethtool_regs *regs, void *p);
 372
 373         /*
 374          * Bridge integration
 375          */
 376         int     (*set_ageing_time)(struct dsa_switch *ds, unsigned int msecs);
 377         int     (*port_bridge_join)(struct dsa_switch *ds, int port,
 378                                     struct net_device *bridge);
 379         void    (*port_bridge_leave)(struct dsa_switch *ds, int port,
 380                                      struct net_device *bridge);
 381         void    (*port_stp_state_set)(struct dsa_switch *ds, int port,
 382                                       u8 state);
 383         void    (*port_fast_age)(struct dsa_switch *ds, int port);
 384
 385         /*
 386          * VLAN support
 387          */
 388         int     (*port_vlan_filtering)(struct dsa_switch *ds, int port,
 389                                        bool vlan_filtering);
 390         int     (*port_vlan_prepare)(struct dsa_switch *ds, int port,
 391                                      const struct switchdev_obj_port_vlan *vlan,
 392                                      struct switchdev_trans *trans);
 393         void    (*port_vlan_add)(struct dsa_switch *ds, int port,
 394                                  const struct switchdev_obj_port_vlan *vlan,
 395                                  struct switchdev_trans *trans);
 396         int     (*port_vlan_del)(struct dsa_switch *ds, int port,
 397                                  const struct switchdev_obj_port_vlan *vlan);
 398         int     (*port_vlan_dump)(struct dsa_switch *ds, int port,
 399                                   struct switchdev_obj_port_vlan *vlan,
 400                                   switchdev_obj_dump_cb_t *cb);
 401
 402         /*
 403          * Forwarding database
 404          */
 405         int     (*port_fdb_prepare)(struct dsa_switch *ds, int port,
 406                                     const struct switchdev_obj_port_fdb *fdb,
 407                                     struct switchdev_trans *trans);
 408         void    (*port_fdb_add)(struct dsa_switch *ds, int port,
 409                                 const struct switchdev_obj_port_fdb *fdb,
 410                                 struct switchdev_trans *trans);
 411         int     (*port_fdb_del)(struct dsa_switch *ds, int port,
 412                                 const struct switchdev_obj_port_fdb *fdb);
 413         int     (*port_fdb_dump)(struct dsa_switch *ds, int port,
 414                                  struct switchdev_obj_port_fdb *fdb,
 415                                   switchdev_obj_dump_cb_t *cb);
 416
 417         /*
 418          * Multicast database
 419          */
 420         int     (*port_mdb_prepare)(struct dsa_switch *ds, int port,
 421                                     const struct switchdev_obj_port_mdb *mdb,
 422                                     struct switchdev_trans *trans);
 423         void    (*port_mdb_add)(struct dsa_switch *ds, int port,
 424                                 const struct switchdev_obj_port_mdb *mdb,
 425                                 struct switchdev_trans *trans);
 426         int     (*port_mdb_del)(struct dsa_switch *ds, int port,
 427                                 const struct switchdev_obj_port_mdb *mdb);
 428         int     (*port_mdb_dump)(struct dsa_switch *ds, int port,
 429                                  struct switchdev_obj_port_mdb *mdb,
 430                                   switchdev_obj_dump_cb_t *cb);
 431
 432         /*
 433          * RXNFC
 434          */
 435         int     (*get_rxnfc)(struct dsa_switch *ds, int port,
 436                              struct ethtool_rxnfc *nfc, u32 *rule_locs);
 437         int     (*set_rxnfc)(struct dsa_switch *ds, int port,
 438                              struct ethtool_rxnfc *nfc);
 439
 440         /*
 441          * TC integration
 442          */
 443         int     (*port_mirror_add)(struct dsa_switch *ds, int port,
 444                                    struct dsa_mall_mirror_tc_entry *mirror,
 445                                    bool ingress);
 446         void    (*port_mirror_del)(struct dsa_switch *ds, int port,
 447                                    struct dsa_mall_mirror_tc_entry *mirror);
 448
 449         /*
 450          * Cross-chip operations
 451          */
 452         int     (*crosschip_bridge_join)(struct dsa_switch *ds, int sw_index,
 453                                          int port, struct net_device *br);
 454         void    (*crosschip_bridge_leave)(struct dsa_switch *ds, int sw_index,
 455                                           int port, struct net_device *br);
 456 };
 457
 458 struct dsa_switch_driver {
 459         struct list_head        list;
 460         const struct dsa_switch_ops *ops;
 461 };
 462
 463 /* Legacy driver registration */
 464 void register_switch_driver(struct dsa_switch_driver *type);
 465 void unregister_switch_driver(struct dsa_switch_driver *type);
 466 struct mii_bus *dsa_host_dev_to_mii_bus(struct device *dev);
 467
 468 struct net_device *dsa_dev_to_net_device(struct device *dev);
 469
 470 /* Keep inline for faster access in hot path */
 471 static inline bool netdev_uses_dsa(struct net_device *dev)
 472 {
 473 #if IS_ENABLED(CONFIG_NET_DSA)
 474         return dev->dsa_ptr && dev->dsa_ptr->rcv;
 475 #endif
 476         return false;
 477 }
 478
 479 struct dsa_switch *dsa_switch_alloc(struct device *dev, size_t n);
 480 void dsa_unregister_switch(struct dsa_switch *ds);
 481 int dsa_register_switch(struct dsa_switch *ds);
 482 #ifdef CONFIG_PM_SLEEP
 483 int dsa_switch_suspend(struct dsa_switch *ds);
 484 int dsa_switch_resume(struct dsa_switch *ds);
 485 #else
 486 static inline int dsa_switch_suspend(struct dsa_switch *ds)
 487 {
 488         return 0;
 489 }
 490 static inline int dsa_switch_resume(struct dsa_switch *ds)
 491 {
 492         return 0;
 493 }
 494 #endif /* CONFIG_PM_SLEEP */
 495
 496 #endif