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