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