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