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