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