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         struct ethtool_ops      ethtool_ops;
 192         const struct ethtool_ops *orig_ethtool_ops;
 193 };
 194
 195 struct dsa_switch {
 196         struct device *dev;
 197
 198         /*
 199          * Parent switch tree, and switch index.
 200          */
 201         struct dsa_switch_tree  *dst;
 202         int                     index;
 203
 204         /* Listener for switch fabric events */
 205         struct notifier_block   nb;
 206
 207         /*
 208          * Give the switch driver somewhere to hang its private data
 209          * structure.
 210          */
 211         void *priv;
 212
 213         /*
 214          * Configuration data for this switch.
 215          */
 216         struct dsa_chip_data    *cd;
 217
 218         /*
 219          * The switch operations.
 220          */
 221         const struct dsa_switch_ops     *ops;
 222
 223         /*
 224          * An array of which element [a] indicates which port on this
 225          * switch should be used to send packets to that are destined
 226          * for switch a. Can be NULL if there is only one switch chip.
 227          */
 228         s8              rtable[DSA_MAX_SWITCHES];
 229
 230         /*
 231          * Slave mii_bus and devices for the individual ports.
 232          */
 233         u32                     dsa_port_mask;
 234         u32                     cpu_port_mask;
 235         u32                     enabled_port_mask;
 236         u32                     phys_mii_mask;
 237         struct mii_bus          *slave_mii_bus;
 238
 239         /* Ageing Time limits in msecs */
 240         unsigned int ageing_time_min;
 241         unsigned int ageing_time_max;
 242
 243         /* devlink used to represent this switch device */
 244         struct devlink          *devlink;
 245
 246         /* Dynamically allocated ports, keep last */
 247         size_t num_ports;
 248         struct dsa_port ports[];
 249 };
 250
 251 static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p)
 252 {
 253         return !!(ds->cpu_port_mask & (1 << p));
 254 }
 255
 256 static inline bool dsa_is_dsa_port(struct dsa_switch *ds, int p)
 257 {
 258         return !!((ds->dsa_port_mask) & (1 << p));
 259 }
 260
 261 static inline bool dsa_is_normal_port(struct dsa_switch *ds, int p)
 262 {
 263         return !dsa_is_cpu_port(ds, p) && !dsa_is_dsa_port(ds, p);
 264 }
 265
 266 static inline u8 dsa_upstream_port(struct dsa_switch *ds)
 267 {
 268         struct dsa_switch_tree *dst = ds->dst;
 269
 270         /*
 271          * If this is the root switch (i.e. the switch that connects
 272          * to the CPU), return the cpu port number on this switch.
 273          * Else return the (DSA) port number that connects to the
 274          * switch that is one hop closer to the cpu.
 275          */
 276         if (dst->cpu_dp->ds == ds)
 277                 return dst->cpu_dp->index;
 278         else
 279                 return ds->rtable[dst->cpu_dp->ds->index];
 280 }
 281
 282 typedef int dsa_fdb_dump_cb_t(const unsigned char *addr, u16 vid,
 283                               bool is_static, void *data);
 284 struct dsa_switch_ops {
 285         /*
 286          * Legacy probing.
 287          */
 288         const char      *(*probe)(struct device *dsa_dev,
 289                                   struct device *host_dev, int sw_addr,
 290                                   void **priv);
 291
 292         enum dsa_tag_protocol (*get_tag_protocol)(struct dsa_switch *ds);
 293
 294         int     (*setup)(struct dsa_switch *ds);
 295         int     (*set_addr)(struct dsa_switch *ds, u8 *addr);
 296         u32     (*get_phy_flags)(struct dsa_switch *ds, int port);
 297
 298         /*
 299          * Access to the switch's PHY registers.
 300          */
 301         int     (*phy_read)(struct dsa_switch *ds, int port, int regnum);
 302         int     (*phy_write)(struct dsa_switch *ds, int port,
 303                              int regnum, u16 val);
 304
 305         /*
 306          * Link state adjustment (called from libphy)
 307          */
 308         void    (*adjust_link)(struct dsa_switch *ds, int port,
 309                                 struct phy_device *phydev);
 310         void    (*fixed_link_update)(struct dsa_switch *ds, int port,
 311                                 struct fixed_phy_status *st);
 312
 313         /*
 314          * ethtool hardware statistics.
 315          */
 316         void    (*get_strings)(struct dsa_switch *ds, int port, uint8_t *data);
 317         void    (*get_ethtool_stats)(struct dsa_switch *ds,
 318                                      int port, uint64_t *data);
 319         int     (*get_sset_count)(struct dsa_switch *ds);
 320
 321         /*
 322          * ethtool Wake-on-LAN
 323          */
 324         void    (*get_wol)(struct dsa_switch *ds, int port,
 325                            struct ethtool_wolinfo *w);
 326         int     (*set_wol)(struct dsa_switch *ds, int port,
 327                            struct ethtool_wolinfo *w);
 328
 329         /*
 330          * Suspend and resume
 331          */
 332         int     (*suspend)(struct dsa_switch *ds);
 333         int     (*resume)(struct dsa_switch *ds);
 334
 335         /*
 336          * Port enable/disable
 337          */
 338         int     (*port_enable)(struct dsa_switch *ds, int port,
 339                                struct phy_device *phy);
 340         void    (*port_disable)(struct dsa_switch *ds, int port,
 341                                 struct phy_device *phy);
 342
 343         /*
 344          * Port's MAC EEE settings
 345          */
 346         int     (*set_mac_eee)(struct dsa_switch *ds, int port,
 347                                struct ethtool_eee *e);
 348         int     (*get_mac_eee)(struct dsa_switch *ds, int port,
 349                                struct ethtool_eee *e);
 350
 351         /* EEPROM access */
 352         int     (*get_eeprom_len)(struct dsa_switch *ds);
 353         int     (*get_eeprom)(struct dsa_switch *ds,
 354                               struct ethtool_eeprom *eeprom, u8 *data);
 355         int     (*set_eeprom)(struct dsa_switch *ds,
 356                               struct ethtool_eeprom *eeprom, u8 *data);
 357
 358         /*
 359          * Register access.
 360          */
 361         int     (*get_regs_len)(struct dsa_switch *ds, int port);
 362         void    (*get_regs)(struct dsa_switch *ds, int port,
 363                             struct ethtool_regs *regs, void *p);
 364
 365         /*
 366          * Bridge integration
 367          */
 368         int     (*set_ageing_time)(struct dsa_switch *ds, unsigned int msecs);
 369         int     (*port_bridge_join)(struct dsa_switch *ds, int port,
 370                                     struct net_device *bridge);
 371         void    (*port_bridge_leave)(struct dsa_switch *ds, int port,
 372                                      struct net_device *bridge);
 373         void    (*port_stp_state_set)(struct dsa_switch *ds, int port,
 374                                       u8 state);
 375         void    (*port_fast_age)(struct dsa_switch *ds, int port);
 376
 377         /*
 378          * VLAN support
 379          */
 380         int     (*port_vlan_filtering)(struct dsa_switch *ds, int port,
 381                                        bool vlan_filtering);
 382         int     (*port_vlan_prepare)(struct dsa_switch *ds, int port,
 383                                      const struct switchdev_obj_port_vlan *vlan,
 384                                      struct switchdev_trans *trans);
 385         void    (*port_vlan_add)(struct dsa_switch *ds, int port,
 386                                  const struct switchdev_obj_port_vlan *vlan,
 387                                  struct switchdev_trans *trans);
 388         int     (*port_vlan_del)(struct dsa_switch *ds, int port,
 389                                  const struct switchdev_obj_port_vlan *vlan);
 390         /*
 391          * Forwarding database
 392          */
 393         int     (*port_fdb_add)(struct dsa_switch *ds, int port,
 394                                 const unsigned char *addr, u16 vid);
 395         int     (*port_fdb_del)(struct dsa_switch *ds, int port,
 396                                 const unsigned char *addr, u16 vid);
 397         int     (*port_fdb_dump)(struct dsa_switch *ds, int port,
 398                                  dsa_fdb_dump_cb_t *cb, void *data);
 399
 400         /*
 401          * Multicast database
 402          */
 403         int     (*port_mdb_prepare)(struct dsa_switch *ds, int port,
 404                                     const struct switchdev_obj_port_mdb *mdb,
 405                                     struct switchdev_trans *trans);
 406         void    (*port_mdb_add)(struct dsa_switch *ds, int port,
 407                                 const struct switchdev_obj_port_mdb *mdb,
 408                                 struct switchdev_trans *trans);
 409         int     (*port_mdb_del)(struct dsa_switch *ds, int port,
 410                                 const struct switchdev_obj_port_mdb *mdb);
 411         /*
 412          * RXNFC
 413          */
 414         int     (*get_rxnfc)(struct dsa_switch *ds, int port,
 415                              struct ethtool_rxnfc *nfc, u32 *rule_locs);
 416         int     (*set_rxnfc)(struct dsa_switch *ds, int port,
 417                              struct ethtool_rxnfc *nfc);
 418
 419         /*
 420          * TC integration
 421          */
 422         int     (*port_mirror_add)(struct dsa_switch *ds, int port,
 423                                    struct dsa_mall_mirror_tc_entry *mirror,
 424                                    bool ingress);
 425         void    (*port_mirror_del)(struct dsa_switch *ds, int port,
 426                                    struct dsa_mall_mirror_tc_entry *mirror);
 427
 428         /*
 429          * Cross-chip operations
 430          */
 431         int     (*crosschip_bridge_join)(struct dsa_switch *ds, int sw_index,
 432                                          int port, struct net_device *br);
 433         void    (*crosschip_bridge_leave)(struct dsa_switch *ds, int sw_index,
 434                                           int port, struct net_device *br);
 435 };
 436
 437 struct dsa_switch_driver {
 438         struct list_head        list;
 439         const struct dsa_switch_ops *ops;
 440 };
 441
 442 /* Legacy driver registration */
 443 void register_switch_driver(struct dsa_switch_driver *type);
 444 void unregister_switch_driver(struct dsa_switch_driver *type);
 445 struct mii_bus *dsa_host_dev_to_mii_bus(struct device *dev);
 446
 447 struct net_device *dsa_dev_to_net_device(struct device *dev);
 448
 449 /* Keep inline for faster access in hot path */
 450 static inline bool netdev_uses_dsa(struct net_device *dev)
 451 {
 452 #if IS_ENABLED(CONFIG_NET_DSA)
 453         return dev->dsa_ptr && dev->dsa_ptr->rcv;
 454 #endif
 455         return false;
 456 }
 457
 458 struct dsa_switch *dsa_switch_alloc(struct device *dev, size_t n);
 459 void dsa_unregister_switch(struct dsa_switch *ds);
 460 int dsa_register_switch(struct dsa_switch *ds);
 461 #ifdef CONFIG_PM_SLEEP
 462 int dsa_switch_suspend(struct dsa_switch *ds);
 463 int dsa_switch_resume(struct dsa_switch *ds);
 464 #else
 465 static inline int dsa_switch_suspend(struct dsa_switch *ds)
 466 {
 467         return 0;
 468 }
 469 static inline int dsa_switch_resume(struct dsa_switch *ds)
 470 {
 471         return 0;
 472 }
 473 #endif /* CONFIG_PM_SLEEP */
 474
 475 #endif