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_device_ops {
 105         struct sk_buff *(*xmit)(struct sk_buff *skb, struct net_device *dev);
 106         struct sk_buff *(*rcv)(struct sk_buff *skb, struct net_device *dev,
 107                                struct packet_type *pt);
 108         int (*flow_dissect)(const struct sk_buff *skb, __be16 *proto,
 109                             int *offset);
 110 };
 111
 112 struct dsa_switch_tree {
 113         struct list_head        list;
 114
 115         /* Notifier chain for switch-wide events */
 116         struct raw_notifier_head        nh;
 117
 118         /* Tree identifier */
 119         u32 tree;
 120
 121         /* Number of switches attached to this tree */
 122         struct kref refcount;
 123
 124         /* Has this tree been applied to the hardware? */
 125         bool applied;
 126
 127         /*
 128          * Configuration data for the platform device that owns
 129          * this dsa switch tree instance.
 130          */
 131         struct dsa_platform_data        *pd;
 132
 133         /* Copy of tag_ops->rcv for faster access in hot path */
 134         struct sk_buff *        (*rcv)(struct sk_buff *skb,
 135                                        struct net_device *dev,
 136                                        struct packet_type *pt);
 137
 138         /*
 139          * The switch port to which the CPU is attached.
 140          */
 141         struct dsa_port         *cpu_dp;
 142
 143         /*
 144          * Data for the individual switch chips.
 145          */
 146         struct dsa_switch       *ds[DSA_MAX_SWITCHES];
 147
 148         /*
 149          * Tagging protocol operations for adding and removing an
 150          * encapsulation tag.
 151          */
 152         const struct dsa_device_ops *tag_ops;
 153 };
 154
 155 /* TC matchall action types, only mirroring for now */
 156 enum dsa_port_mall_action_type {
 157         DSA_PORT_MALL_MIRROR,
 158 };
 159
 160 /* TC mirroring entry */
 161 struct dsa_mall_mirror_tc_entry {
 162         u8 to_local_port;
 163         bool ingress;
 164 };
 165
 166 /* TC matchall entry */
 167 struct dsa_mall_tc_entry {
 168         struct list_head list;
 169         unsigned long cookie;
 170         enum dsa_port_mall_action_type type;
 171         union {
 172                 struct dsa_mall_mirror_tc_entry mirror;
 173         };
 174 };
 175
 176
 177 struct dsa_port {
 178         struct dsa_switch       *ds;
 179         unsigned int            index;
 180         const char              *name;
 181         struct dsa_port         *cpu_dp;
 182         struct net_device       *netdev;
 183         struct device_node      *dn;
 184         unsigned int            ageing_time;
 185         u8                      stp_state;
 186         struct net_device       *bridge_dev;
 187         struct devlink_port     devlink_port;
 188         /*
 189          * Original copy of the master netdev ethtool_ops
 190          */
 191         const struct ethtool_ops *orig_ethtool_ops;
 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          * Slave mii_bus and devices for the individual ports.
 231          */
 232         u32                     dsa_port_mask;
 233         u32                     cpu_port_mask;
 234         u32                     enabled_port_mask;
 235         u32                     phys_mii_mask;
 236         struct mii_bus          *slave_mii_bus;
 237
 238         /* Ageing Time limits in msecs */
 239         unsigned int ageing_time_min;
 240         unsigned int ageing_time_max;
 241
 242         /* devlink used to represent this switch device */
 243         struct devlink          *devlink;
 244
 245         /* Number of switch port queues */
 246         unsigned int            num_tx_queues;
 247
 248         /* Dynamically allocated ports, keep last */
 249         size_t num_ports;
 250         struct dsa_port ports[];
 251 };
 252
 253 static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p)
 254 {
 255         return !!(ds->cpu_port_mask & (1 << p));
 256 }
 257
 258 static inline bool dsa_is_dsa_port(struct dsa_switch *ds, int p)
 259 {
 260         return !!((ds->dsa_port_mask) & (1 << p));
 261 }
 262
 263 static inline bool dsa_is_normal_port(struct dsa_switch *ds, int p)
 264 {
 265         return !dsa_is_cpu_port(ds, p) && !dsa_is_dsa_port(ds, p);
 266 }
 267
 268 static inline u8 dsa_upstream_port(struct dsa_switch *ds)
 269 {
 270         struct dsa_switch_tree *dst = ds->dst;
 271
 272         /*
 273          * If this is the root switch (i.e. the switch that connects
 274          * to the CPU), return the cpu port number on this switch.
 275          * Else return the (DSA) port number that connects to the
 276          * switch that is one hop closer to the cpu.
 277          */
 278         if (dst->cpu_dp->ds == ds)
 279                 return dst->cpu_dp->index;
 280         else
 281                 return ds->rtable[dst->cpu_dp->ds->index];
 282 }
 283
 284 typedef int dsa_fdb_dump_cb_t(const unsigned char *addr, u16 vid,
 285                               bool is_static, void *data);
 286 struct dsa_switch_ops {
 287         /*
 288          * Legacy probing.
 289          */
 290         const char      *(*probe)(struct device *dsa_dev,
 291                                   struct device *host_dev, int sw_addr,
 292                                   void **priv);
 293
 294         enum dsa_tag_protocol (*get_tag_protocol)(struct dsa_switch *ds);
 295
 296         int     (*setup)(struct dsa_switch *ds);
 297         int     (*set_addr)(struct dsa_switch *ds, u8 *addr);
 298         u32     (*get_phy_flags)(struct dsa_switch *ds, int port);
 299
 300         /*
 301          * Access to the switch's PHY registers.
 302          */
 303         int     (*phy_read)(struct dsa_switch *ds, int port, int regnum);
 304         int     (*phy_write)(struct dsa_switch *ds, int port,
 305                              int regnum, u16 val);
 306
 307         /*
 308          * Link state adjustment (called from libphy)
 309          */
 310         void    (*adjust_link)(struct dsa_switch *ds, int port,
 311                                 struct phy_device *phydev);
 312         void    (*fixed_link_update)(struct dsa_switch *ds, int port,
 313                                 struct fixed_phy_status *st);
 314
 315         /*
 316          * ethtool hardware statistics.
 317          */
 318         void    (*get_strings)(struct dsa_switch *ds, int port, uint8_t *data);
 319         void    (*get_ethtool_stats)(struct dsa_switch *ds,
 320                                      int port, uint64_t *data);
 321         int     (*get_sset_count)(struct dsa_switch *ds);
 322
 323         /*
 324          * ethtool Wake-on-LAN
 325          */
 326         void    (*get_wol)(struct dsa_switch *ds, int port,
 327                            struct ethtool_wolinfo *w);
 328         int     (*set_wol)(struct dsa_switch *ds, int port,
 329                            struct ethtool_wolinfo *w);
 330
 331         /*
 332          * Suspend and resume
 333          */
 334         int     (*suspend)(struct dsa_switch *ds);
 335         int     (*resume)(struct dsa_switch *ds);
 336
 337         /*
 338          * Port enable/disable
 339          */
 340         int     (*port_enable)(struct dsa_switch *ds, int port,
 341                                struct phy_device *phy);
 342         void    (*port_disable)(struct dsa_switch *ds, int port,
 343                                 struct phy_device *phy);
 344
 345         /*
 346          * Port's MAC EEE settings
 347          */
 348         int     (*set_mac_eee)(struct dsa_switch *ds, int port,
 349                                struct ethtool_eee *e);
 350         int     (*get_mac_eee)(struct dsa_switch *ds, int port,
 351                                struct ethtool_eee *e);
 352
 353         /* EEPROM access */
 354         int     (*get_eeprom_len)(struct dsa_switch *ds);
 355         int     (*get_eeprom)(struct dsa_switch *ds,
 356                               struct ethtool_eeprom *eeprom, u8 *data);
 357         int     (*set_eeprom)(struct dsa_switch *ds,
 358                               struct ethtool_eeprom *eeprom, u8 *data);
 359
 360         /*
 361          * Register access.
 362          */
 363         int     (*get_regs_len)(struct dsa_switch *ds, int port);
 364         void    (*get_regs)(struct dsa_switch *ds, int port,
 365                             struct ethtool_regs *regs, void *p);
 366
 367         /*
 368          * Bridge integration
 369          */
 370         int     (*set_ageing_time)(struct dsa_switch *ds, unsigned int msecs);
 371         int     (*port_bridge_join)(struct dsa_switch *ds, int port,
 372                                     struct net_device *bridge);
 373         void    (*port_bridge_leave)(struct dsa_switch *ds, int port,
 374                                      struct net_device *bridge);
 375         void    (*port_stp_state_set)(struct dsa_switch *ds, int port,
 376                                       u8 state);
 377         void    (*port_fast_age)(struct dsa_switch *ds, int port);
 378
 379         /*
 380          * VLAN support
 381          */
 382         int     (*port_vlan_filtering)(struct dsa_switch *ds, int port,
 383                                        bool vlan_filtering);
 384         int     (*port_vlan_prepare)(struct dsa_switch *ds, int port,
 385                                      const struct switchdev_obj_port_vlan *vlan,
 386                                      struct switchdev_trans *trans);
 387         void    (*port_vlan_add)(struct dsa_switch *ds, int port,
 388                                  const struct switchdev_obj_port_vlan *vlan,
 389                                  struct switchdev_trans *trans);
 390         int     (*port_vlan_del)(struct dsa_switch *ds, int port,
 391                                  const struct switchdev_obj_port_vlan *vlan);
 392         /*
 393          * Forwarding database
 394          */
 395         int     (*port_fdb_add)(struct dsa_switch *ds, int port,
 396                                 const unsigned char *addr, u16 vid);
 397         int     (*port_fdb_del)(struct dsa_switch *ds, int port,
 398                                 const unsigned char *addr, u16 vid);
 399         int     (*port_fdb_dump)(struct dsa_switch *ds, int port,
 400                                  dsa_fdb_dump_cb_t *cb, void *data);
 401
 402         /*
 403          * Multicast database
 404          */
 405         int     (*port_mdb_prepare)(struct dsa_switch *ds, int port,
 406                                     const struct switchdev_obj_port_mdb *mdb,
 407                                     struct switchdev_trans *trans);
 408         void    (*port_mdb_add)(struct dsa_switch *ds, int port,
 409                                 const struct switchdev_obj_port_mdb *mdb,
 410                                 struct switchdev_trans *trans);
 411         int     (*port_mdb_del)(struct dsa_switch *ds, int port,
 412                                 const struct switchdev_obj_port_mdb *mdb);
 413         /*
 414          * RXNFC
 415          */
 416         int     (*get_rxnfc)(struct dsa_switch *ds, int port,
 417                              struct ethtool_rxnfc *nfc, u32 *rule_locs);
 418         int     (*set_rxnfc)(struct dsa_switch *ds, int port,
 419                              struct ethtool_rxnfc *nfc);
 420
 421         /*
 422          * TC integration
 423          */
 424         int     (*port_mirror_add)(struct dsa_switch *ds, int port,
 425                                    struct dsa_mall_mirror_tc_entry *mirror,
 426                                    bool ingress);
 427         void    (*port_mirror_del)(struct dsa_switch *ds, int port,
 428                                    struct dsa_mall_mirror_tc_entry *mirror);
 429
 430         /*
 431          * Cross-chip operations
 432          */
 433         int     (*crosschip_bridge_join)(struct dsa_switch *ds, int sw_index,
 434                                          int port, struct net_device *br);
 435         void    (*crosschip_bridge_leave)(struct dsa_switch *ds, int sw_index,
 436                                           int port, struct net_device *br);
 437 };
 438
 439 struct dsa_switch_driver {
 440         struct list_head        list;
 441         const struct dsa_switch_ops *ops;
 442 };
 443
 444 /* Legacy driver registration */
 445 void register_switch_driver(struct dsa_switch_driver *type);
 446 void unregister_switch_driver(struct dsa_switch_driver *type);
 447 struct mii_bus *dsa_host_dev_to_mii_bus(struct device *dev);
 448
 449 struct net_device *dsa_dev_to_net_device(struct device *dev);
 450
 451 /* Keep inline for faster access in hot path */
 452 static inline bool netdev_uses_dsa(struct net_device *dev)
 453 {
 454 #if IS_ENABLED(CONFIG_NET_DSA)
 455         return dev->dsa_ptr && dev->dsa_ptr->rcv;
 456 #endif
 457         return false;
 458 }
 459
 460 struct dsa_switch *dsa_switch_alloc(struct device *dev, size_t n);
 461 void dsa_unregister_switch(struct dsa_switch *ds);
 462 int dsa_register_switch(struct dsa_switch *ds);
 463 #ifdef CONFIG_PM_SLEEP
 464 int dsa_switch_suspend(struct dsa_switch *ds);
 465 int dsa_switch_resume(struct dsa_switch *ds);
 466 #else
 467 static inline int dsa_switch_suspend(struct dsa_switch *ds)
 468 {
 469         return 0;
 470 }
 471 static inline int dsa_switch_resume(struct dsa_switch *ds)
 472 {
 473         return 0;
 474 }
 475 #endif /* CONFIG_PM_SLEEP */
 476
 477 #endif