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          * The switch and port to which the CPU is attached.
 107          */
 108         s8                      cpu_switch;
 109         s8                      cpu_port;
 110
 111         /*
 112          * Link state polling.
 113          */
 114         int                     link_poll_needed;
 115         struct work_struct      link_poll_work;
 116         struct timer_list       link_poll_timer;
 117
 118         /*
 119          * Data for the individual switch chips.
 120          */
 121         struct dsa_switch       *ds[DSA_MAX_SWITCHES];
 122 };
 123
 124 struct dsa_switch {
 125         /*
 126          * Parent switch tree, and switch index.
 127          */
 128         struct dsa_switch_tree  *dst;
 129         int                     index;
 130
 131         /*
 132          * Tagging protocol understood by this switch
 133          */
 134         enum dsa_tag_protocol   tag_protocol;
 135
 136         /*
 137          * Configuration data for this switch.
 138          */
 139         struct dsa_chip_data    *pd;
 140
 141         /*
 142          * The used switch driver.
 143          */
 144         struct dsa_switch_driver        *drv;
 145
 146         /*
 147          * Reference to host device to use.
 148          */
 149         struct device           *master_dev;
 150
 151 #ifdef CONFIG_NET_DSA_HWMON
 152         /*
 153          * Hardware monitoring information
 154          */
 155         char                    hwmon_name[IFNAMSIZ + 8];
 156         struct device           *hwmon_dev;
 157 #endif
 158
 159         /*
 160          * Slave mii_bus and devices for the individual ports.
 161          */
 162         u32                     dsa_port_mask;
 163         u32                     phys_port_mask;
 164         u32                     phys_mii_mask;
 165         struct mii_bus          *slave_mii_bus;
 166         struct net_device       *ports[DSA_MAX_PORTS];
 167 };
 168
 169 static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p)
 170 {
 171         return !!(ds->index == ds->dst->cpu_switch && p == ds->dst->cpu_port);
 172 }
 173
 174 static inline bool dsa_is_dsa_port(struct dsa_switch *ds, int p)
 175 {
 176         return !!((ds->dsa_port_mask) & (1 << p));
 177 }
 178
 179 static inline bool dsa_is_port_initialized(struct dsa_switch *ds, int p)
 180 {
 181         return ds->phys_port_mask & (1 << p) && ds->ports[p];
 182 }
 183
 184 static inline u8 dsa_upstream_port(struct dsa_switch *ds)
 185 {
 186         struct dsa_switch_tree *dst = ds->dst;
 187
 188         /*
 189          * If this is the root switch (i.e. the switch that connects
 190          * to the CPU), return the cpu port number on this switch.
 191          * Else return the (DSA) port number that connects to the
 192          * switch that is one hop closer to the cpu.
 193          */
 194         if (dst->cpu_switch == ds->index)
 195                 return dst->cpu_port;
 196         else
 197                 return ds->pd->rtable[dst->cpu_switch];
 198 }
 199
 200 struct switchdev_trans;
 201 struct switchdev_obj;
 202 struct switchdev_obj_port_fdb;
 203 struct switchdev_obj_port_vlan;
 204
 205 struct dsa_switch_driver {
 206         struct list_head        list;
 207
 208         enum dsa_tag_protocol   tag_protocol;
 209         int                     priv_size;
 210
 211         /*
 212          * Probing and setup.
 213          */
 214         char    *(*probe)(struct device *host_dev, int sw_addr);
 215         int     (*setup)(struct dsa_switch *ds);
 216         int     (*set_addr)(struct dsa_switch *ds, u8 *addr);
 217         u32     (*get_phy_flags)(struct dsa_switch *ds, int port);
 218
 219         /*
 220          * Access to the switch's PHY registers.
 221          */
 222         int     (*phy_read)(struct dsa_switch *ds, int port, int regnum);
 223         int     (*phy_write)(struct dsa_switch *ds, int port,
 224                              int regnum, u16 val);
 225
 226         /*
 227          * Link state polling and IRQ handling.
 228          */
 229         void    (*poll_link)(struct dsa_switch *ds);
 230
 231         /*
 232          * Link state adjustment (called from libphy)
 233          */
 234         void    (*adjust_link)(struct dsa_switch *ds, int port,
 235                                 struct phy_device *phydev);
 236         void    (*fixed_link_update)(struct dsa_switch *ds, int port,
 237                                 struct fixed_phy_status *st);
 238
 239         /*
 240          * ethtool hardware statistics.
 241          */
 242         void    (*get_strings)(struct dsa_switch *ds, int port, uint8_t *data);
 243         void    (*get_ethtool_stats)(struct dsa_switch *ds,
 244                                      int port, uint64_t *data);
 245         int     (*get_sset_count)(struct dsa_switch *ds);
 246
 247         /*
 248          * ethtool Wake-on-LAN
 249          */
 250         void    (*get_wol)(struct dsa_switch *ds, int port,
 251                            struct ethtool_wolinfo *w);
 252         int     (*set_wol)(struct dsa_switch *ds, int port,
 253                            struct ethtool_wolinfo *w);
 254
 255         /*
 256          * Suspend and resume
 257          */
 258         int     (*suspend)(struct dsa_switch *ds);
 259         int     (*resume)(struct dsa_switch *ds);
 260
 261         /*
 262          * Port enable/disable
 263          */
 264         int     (*port_enable)(struct dsa_switch *ds, int port,
 265                                struct phy_device *phy);
 266         void    (*port_disable)(struct dsa_switch *ds, int port,
 267                                 struct phy_device *phy);
 268
 269         /*
 270          * EEE setttings
 271          */
 272         int     (*set_eee)(struct dsa_switch *ds, int port,
 273                            struct phy_device *phydev,
 274                            struct ethtool_eee *e);
 275         int     (*get_eee)(struct dsa_switch *ds, int port,
 276                            struct ethtool_eee *e);
 277
 278 #ifdef CONFIG_NET_DSA_HWMON
 279         /* Hardware monitoring */
 280         int     (*get_temp)(struct dsa_switch *ds, int *temp);
 281         int     (*get_temp_limit)(struct dsa_switch *ds, int *temp);
 282         int     (*set_temp_limit)(struct dsa_switch *ds, int temp);
 283         int     (*get_temp_alarm)(struct dsa_switch *ds, bool *alarm);
 284 #endif
 285
 286         /* EEPROM access */
 287         int     (*get_eeprom_len)(struct dsa_switch *ds);
 288         int     (*get_eeprom)(struct dsa_switch *ds,
 289                               struct ethtool_eeprom *eeprom, u8 *data);
 290         int     (*set_eeprom)(struct dsa_switch *ds,
 291                               struct ethtool_eeprom *eeprom, u8 *data);
 292
 293         /*
 294          * Register access.
 295          */
 296         int     (*get_regs_len)(struct dsa_switch *ds, int port);
 297         void    (*get_regs)(struct dsa_switch *ds, int port,
 298                             struct ethtool_regs *regs, void *p);
 299
 300         /*
 301          * Bridge integration
 302          */
 303         int     (*port_join_bridge)(struct dsa_switch *ds, int port,
 304                                     u32 br_port_mask);
 305         int     (*port_leave_bridge)(struct dsa_switch *ds, int port,
 306                                      u32 br_port_mask);
 307         int     (*port_stp_update)(struct dsa_switch *ds, int port,
 308                                    u8 state);
 309
 310         /*
 311          * VLAN support
 312          */
 313         int     (*port_vlan_prepare)(struct dsa_switch *ds, int port,
 314                                      const struct switchdev_obj_port_vlan *vlan,
 315                                      struct switchdev_trans *trans);
 316         int     (*port_vlan_add)(struct dsa_switch *ds, int port,
 317                                  const struct switchdev_obj_port_vlan *vlan,
 318                                  struct switchdev_trans *trans);
 319         int     (*port_vlan_del)(struct dsa_switch *ds, int port,
 320                                  const struct switchdev_obj_port_vlan *vlan);
 321         int     (*port_pvid_get)(struct dsa_switch *ds, int port, u16 *pvid);
 322         int     (*vlan_getnext)(struct dsa_switch *ds, u16 *vid,
 323                                 unsigned long *ports, unsigned long *untagged);
 324
 325         /*
 326          * Forwarding database
 327          */
 328         int     (*port_fdb_prepare)(struct dsa_switch *ds, int port,
 329                                     const struct switchdev_obj_port_fdb *fdb,
 330                                     struct switchdev_trans *trans);
 331         int     (*port_fdb_add)(struct dsa_switch *ds, int port,
 332                                 const struct switchdev_obj_port_fdb *fdb,
 333                                 struct switchdev_trans *trans);
 334         int     (*port_fdb_del)(struct dsa_switch *ds, int port,
 335                                 const struct switchdev_obj_port_fdb *fdb);
 336         int     (*port_fdb_dump)(struct dsa_switch *ds, int port,
 337                                  struct switchdev_obj_port_fdb *fdb,
 338                                  int (*cb)(struct switchdev_obj *obj));
 339 };
 340
 341 void register_switch_driver(struct dsa_switch_driver *type);
 342 void unregister_switch_driver(struct dsa_switch_driver *type);
 343 struct mii_bus *dsa_host_dev_to_mii_bus(struct device *dev);
 344
 345 static inline void *ds_to_priv(struct dsa_switch *ds)
 346 {
 347         return (void *)(ds + 1);
 348 }
 349
 350 static inline bool dsa_uses_tagged_protocol(struct dsa_switch_tree *dst)
 351 {
 352         return dst->rcv != NULL;
 353 }
 354 #endif