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