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