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
  24 struct tc_action;
  25 struct phy_device;
  26 struct fixed_phy_status;
  27
  28 enum dsa_tag_protocol {
  29         DSA_TAG_PROTO_NONE = 0,
  30         DSA_TAG_PROTO_DSA,
  31         DSA_TAG_PROTO_TRAILER,
  32         DSA_TAG_PROTO_EDSA,
  33         DSA_TAG_PROTO_BRCM,
  34         DSA_TAG_PROTO_QCA,
  35         DSA_TAG_PROTO_MTK,
  36         DSA_TAG_PROTO_LAN9303,
  37         DSA_TAG_LAST,           /* MUST BE LAST */
  38 };
  39
  40 #define DSA_MAX_SWITCHES        4
  41 #define DSA_MAX_PORTS           12
  42
  43 #define DSA_RTABLE_NONE         -1
  44
  45 struct dsa_chip_data {
  46         /*
  47          * How to access the switch configuration registers.
  48          */
  49         struct device   *host_dev;
  50         int             sw_addr;
  51
  52         /*
  53          * Reference to network devices
  54          */
  55         struct device   *netdev[DSA_MAX_PORTS];
  56
  57         /* set to size of eeprom if supported by the switch */
  58         int             eeprom_len;
  59
  60         /* Device tree node pointer for this specific switch chip
  61          * used during switch setup in case additional properties
  62          * and resources needs to be used
  63          */
  64         struct device_node *of_node;
  65
  66         /*
  67          * The names of the switch's ports.  Use "cpu" to
  68          * designate the switch port that the cpu is connected to,
  69          * "dsa" to indicate that this port is a DSA link to
  70          * another switch, NULL to indicate the port is unused,
  71          * or any other string to indicate this is a physical port.
  72          */
  73         char            *port_names[DSA_MAX_PORTS];
  74         struct device_node *port_dn[DSA_MAX_PORTS];
  75
  76         /*
  77          * An array of which element [a] indicates which port on this
  78          * switch should be used to send packets to that are destined
  79          * for switch a. Can be NULL if there is only one switch chip.
  80          */
  81         s8              rtable[DSA_MAX_SWITCHES];
  82 };
  83
  84 struct dsa_platform_data {
  85         /*
  86          * Reference to a Linux network interface that connects
  87          * to the root switch chip of the tree.
  88          */
  89         struct device   *netdev;
  90         struct net_device *of_netdev;
  91
  92         /*
  93          * Info structs describing each of the switch chips
  94          * connected via this network interface.
  95          */
  96         int             nr_chips;
  97         struct dsa_chip_data    *chip;
  98 };
  99
 100 struct packet_type;
 101
 102 struct dsa_switch_tree {
 103         struct list_head        list;
 104
 105         /* Notifier chain for switch-wide events */
 106         struct raw_notifier_head        nh;
 107
 108         /* Tree identifier */
 109         u32 tree;
 110
 111         /* Number of switches attached to this tree */
 112         struct kref refcount;
 113
 114         /* Has this tree been applied to the hardware? */
 115         bool applied;
 116
 117         /*
 118          * Configuration data for the platform device that owns
 119          * this dsa switch tree instance.
 120          */
 121         struct dsa_platform_data        *pd;
 122
 123         /*
 124          * Reference to network device to use, and which tagging
 125          * protocol to use.
 126          */
 127         struct net_device       *master_netdev;
 128         struct sk_buff *        (*rcv)(struct sk_buff *skb,
 129                                        struct net_device *dev,
 130                                        struct packet_type *pt,
 131                                        struct net_device *orig_dev);
 132
 133         /*
 134          * Original copy of the master netdev ethtool_ops
 135          */
 136         struct ethtool_ops      master_ethtool_ops;
 137         const struct ethtool_ops *master_orig_ethtool_ops;
 138
 139         /*
 140          * The switch and port to which the CPU is attached.
 141          */
 142         struct dsa_switch       *cpu_switch;
 143         s8                      cpu_port;
 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 == ds->dst->cpu_switch && p == ds->dst->cpu_port);
 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_switch == ds)
 283                 return dst->cpu_port;
 284         else
 285                 return ds->rtable[dst->cpu_switch->index];
 286 }
 287
 288 struct switchdev_trans;
 289 struct switchdev_obj;
 290 struct switchdev_obj_port_fdb;
 291 struct switchdev_obj_port_mdb;
 292 struct switchdev_obj_port_vlan;
 293
 294 #define DSA_NOTIFIER_BRIDGE_JOIN                1
 295 #define DSA_NOTIFIER_BRIDGE_LEAVE               2
 296
 297 /* DSA_NOTIFIER_BRIDGE_* */
 298 struct dsa_notifier_bridge_info {
 299         struct net_device *br;
 300         int sw_index;
 301         int port;
 302 };
 303
 304 struct dsa_switch_ops {
 305         /*
 306          * Legacy probing.
 307          */
 308         const char      *(*probe)(struct device *dsa_dev,
 309                                   struct device *host_dev, int sw_addr,
 310                                   void **priv);
 311
 312         enum dsa_tag_protocol (*get_tag_protocol)(struct dsa_switch *ds);
 313
 314         int     (*setup)(struct dsa_switch *ds);
 315         int     (*set_addr)(struct dsa_switch *ds, u8 *addr);
 316         u32     (*get_phy_flags)(struct dsa_switch *ds, int port);
 317
 318         /*
 319          * Access to the switch's PHY registers.
 320          */
 321         int     (*phy_read)(struct dsa_switch *ds, int port, int regnum);
 322         int     (*phy_write)(struct dsa_switch *ds, int port,
 323                              int regnum, u16 val);
 324
 325         /*
 326          * Link state adjustment (called from libphy)
 327          */
 328         void    (*adjust_link)(struct dsa_switch *ds, int port,
 329                                 struct phy_device *phydev);
 330         void    (*fixed_link_update)(struct dsa_switch *ds, int port,
 331                                 struct fixed_phy_status *st);
 332
 333         /*
 334          * ethtool hardware statistics.
 335          */
 336         void    (*get_strings)(struct dsa_switch *ds, int port, uint8_t *data);
 337         void    (*get_ethtool_stats)(struct dsa_switch *ds,
 338                                      int port, uint64_t *data);
 339         int     (*get_sset_count)(struct dsa_switch *ds);
 340
 341         /*
 342          * ethtool Wake-on-LAN
 343          */
 344         void    (*get_wol)(struct dsa_switch *ds, int port,
 345                            struct ethtool_wolinfo *w);
 346         int     (*set_wol)(struct dsa_switch *ds, int port,
 347                            struct ethtool_wolinfo *w);
 348
 349         /*
 350          * Suspend and resume
 351          */
 352         int     (*suspend)(struct dsa_switch *ds);
 353         int     (*resume)(struct dsa_switch *ds);
 354
 355         /*
 356          * Port enable/disable
 357          */
 358         int     (*port_enable)(struct dsa_switch *ds, int port,
 359                                struct phy_device *phy);
 360         void    (*port_disable)(struct dsa_switch *ds, int port,
 361                                 struct phy_device *phy);
 362
 363         /*
 364          * EEE setttings
 365          */
 366         int     (*set_eee)(struct dsa_switch *ds, int port,
 367                            struct phy_device *phydev,
 368                            struct ethtool_eee *e);
 369         int     (*get_eee)(struct dsa_switch *ds, int port,
 370                            struct ethtool_eee *e);
 371
 372         /* EEPROM access */
 373         int     (*get_eeprom_len)(struct dsa_switch *ds);
 374         int     (*get_eeprom)(struct dsa_switch *ds,
 375                               struct ethtool_eeprom *eeprom, u8 *data);
 376         int     (*set_eeprom)(struct dsa_switch *ds,
 377                               struct ethtool_eeprom *eeprom, u8 *data);
 378
 379         /*
 380          * Register access.
 381          */
 382         int     (*get_regs_len)(struct dsa_switch *ds, int port);
 383         void    (*get_regs)(struct dsa_switch *ds, int port,
 384                             struct ethtool_regs *regs, void *p);
 385
 386         /*
 387          * Bridge integration
 388          */
 389         int     (*set_ageing_time)(struct dsa_switch *ds, unsigned int msecs);
 390         int     (*port_bridge_join)(struct dsa_switch *ds, int port,
 391                                     struct net_device *bridge);
 392         void    (*port_bridge_leave)(struct dsa_switch *ds, int port,
 393                                      struct net_device *bridge);
 394         void    (*port_stp_state_set)(struct dsa_switch *ds, int port,
 395                                       u8 state);
 396         void    (*port_fast_age)(struct dsa_switch *ds, int port);
 397
 398         /*
 399          * VLAN support
 400          */
 401         int     (*port_vlan_filtering)(struct dsa_switch *ds, int port,
 402                                        bool vlan_filtering);
 403         int     (*port_vlan_prepare)(struct dsa_switch *ds, int port,
 404                                      const struct switchdev_obj_port_vlan *vlan,
 405                                      struct switchdev_trans *trans);
 406         void    (*port_vlan_add)(struct dsa_switch *ds, int port,
 407                                  const struct switchdev_obj_port_vlan *vlan,
 408                                  struct switchdev_trans *trans);
 409         int     (*port_vlan_del)(struct dsa_switch *ds, int port,
 410                                  const struct switchdev_obj_port_vlan *vlan);
 411         int     (*port_vlan_dump)(struct dsa_switch *ds, int port,
 412                                   struct switchdev_obj_port_vlan *vlan,
 413                                   int (*cb)(struct switchdev_obj *obj));
 414
 415         /*
 416          * Forwarding database
 417          */
 418         int     (*port_fdb_prepare)(struct dsa_switch *ds, int port,
 419                                     const struct switchdev_obj_port_fdb *fdb,
 420                                     struct switchdev_trans *trans);
 421         void    (*port_fdb_add)(struct dsa_switch *ds, int port,
 422                                 const struct switchdev_obj_port_fdb *fdb,
 423                                 struct switchdev_trans *trans);
 424         int     (*port_fdb_del)(struct dsa_switch *ds, int port,
 425                                 const struct switchdev_obj_port_fdb *fdb);
 426         int     (*port_fdb_dump)(struct dsa_switch *ds, int port,
 427                                  struct switchdev_obj_port_fdb *fdb,
 428                                  int (*cb)(struct switchdev_obj *obj));
 429
 430         /*
 431          * Multicast database
 432          */
 433         int     (*port_mdb_prepare)(struct dsa_switch *ds, int port,
 434                                     const struct switchdev_obj_port_mdb *mdb,
 435                                     struct switchdev_trans *trans);
 436         void    (*port_mdb_add)(struct dsa_switch *ds, int port,
 437                                 const struct switchdev_obj_port_mdb *mdb,
 438                                 struct switchdev_trans *trans);
 439         int     (*port_mdb_del)(struct dsa_switch *ds, int port,
 440                                 const struct switchdev_obj_port_mdb *mdb);
 441         int     (*port_mdb_dump)(struct dsa_switch *ds, int port,
 442                                  struct switchdev_obj_port_mdb *mdb,
 443                                  int (*cb)(struct switchdev_obj *obj));
 444
 445         /*
 446          * RXNFC
 447          */
 448         int     (*get_rxnfc)(struct dsa_switch *ds, int port,
 449                              struct ethtool_rxnfc *nfc, u32 *rule_locs);
 450         int     (*set_rxnfc)(struct dsa_switch *ds, int port,
 451                              struct ethtool_rxnfc *nfc);
 452
 453         /*
 454          * TC integration
 455          */
 456         int     (*port_mirror_add)(struct dsa_switch *ds, int port,
 457                                    struct dsa_mall_mirror_tc_entry *mirror,
 458                                    bool ingress);
 459         void    (*port_mirror_del)(struct dsa_switch *ds, int port,
 460                                    struct dsa_mall_mirror_tc_entry *mirror);
 461
 462         /*
 463          * Cross-chip operations
 464          */
 465         int     (*crosschip_bridge_join)(struct dsa_switch *ds, int sw_index,
 466                                          int port, struct net_device *br);
 467         void    (*crosschip_bridge_leave)(struct dsa_switch *ds, int sw_index,
 468                                           int port, struct net_device *br);
 469 };
 470
 471 struct dsa_switch_driver {
 472         struct list_head        list;
 473         const struct dsa_switch_ops *ops;
 474 };
 475
 476 /* Legacy driver registration */
 477 void register_switch_driver(struct dsa_switch_driver *type);
 478 void unregister_switch_driver(struct dsa_switch_driver *type);
 479 struct mii_bus *dsa_host_dev_to_mii_bus(struct device *dev);
 480
 481 struct net_device *dsa_dev_to_net_device(struct device *dev);
 482
 483 static inline bool dsa_uses_tagged_protocol(struct dsa_switch_tree *dst)
 484 {
 485         return dst->rcv != NULL;
 486 }
 487
 488 static inline bool netdev_uses_dsa(struct net_device *dev)
 489 {
 490 #if IS_ENABLED(CONFIG_NET_DSA)
 491         if (dev->dsa_ptr != NULL)
 492                 return dsa_uses_tagged_protocol(dev->dsa_ptr);
 493 #endif
 494         return false;
 495 }
 496
 497 struct dsa_switch *dsa_switch_alloc(struct device *dev, size_t n);
 498 void dsa_unregister_switch(struct dsa_switch *ds);
 499 int dsa_register_switch(struct dsa_switch *ds, struct device *dev);
 500 #ifdef CONFIG_PM_SLEEP
 501 int dsa_switch_suspend(struct dsa_switch *ds);
 502 int dsa_switch_resume(struct dsa_switch *ds);
 503 #else
 504 static inline int dsa_switch_suspend(struct dsa_switch *ds)
 505 {
 506         return 0;
 507 }
 508 static inline int dsa_switch_resume(struct dsa_switch *ds)
 509 {
 510         return 0;
 511 }
 512 #endif /* CONFIG_PM_SLEEP */
 513
 514 #endif