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/of_gpio.h>
  20 #include <linux/phy.h>
  21 #include <linux/phy_fixed.h>
  22 #include <linux/ethtool.h>
  23
  24 enum dsa_tag_protocol {
  25         DSA_TAG_PROTO_NONE = 0,
  26         DSA_TAG_PROTO_DSA,
  27         DSA_TAG_PROTO_TRAILER,
  28         DSA_TAG_PROTO_EDSA,
  29         DSA_TAG_PROTO_BRCM,
  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 (with nr_chips elements) of which element [a]
  63          * indicates which port on this switch should be used to
  64          * send packets to that are destined for switch a.  Can be
  65          * NULL if there is only one switch chip.
  66          */
  67         s8              *rtable;
  68
  69         /*
  70          * A switch may have a GPIO line tied to its reset pin. Parse
  71          * this from the device tree, and use it before performing
  72          * switch soft reset.
  73          */
  74         struct gpio_desc *reset;
  75 };
  76
  77 struct dsa_platform_data {
  78         /*
  79          * Reference to a Linux network interface that connects
  80          * to the root switch chip of the tree.
  81          */
  82         struct device   *netdev;
  83         struct net_device *of_netdev;
  84
  85         /*
  86          * Info structs describing each of the switch chips
  87          * connected via this network interface.
  88          */
  89         int             nr_chips;
  90         struct dsa_chip_data    *chip;
  91 };
  92
  93 struct packet_type;
  94
  95 struct dsa_switch_tree {
  96         /*
  97          * Configuration data for the platform device that owns
  98          * this dsa switch tree instance.
  99          */
 100         struct dsa_platform_data        *pd;
 101
 102         /*
 103          * Reference to network device to use, and which tagging
 104          * protocol to use.
 105          */
 106         struct net_device       *master_netdev;
 107         int                     (*rcv)(struct sk_buff *skb,
 108                                        struct net_device *dev,
 109                                        struct packet_type *pt,
 110                                        struct net_device *orig_dev);
 111         enum dsa_tag_protocol   tag_protocol;
 112
 113         /*
 114          * The switch and port to which the CPU is attached.
 115          */
 116         s8                      cpu_switch;
 117         s8                      cpu_port;
 118
 119         /*
 120          * Link state polling.
 121          */
 122         int                     link_poll_needed;
 123         struct work_struct      link_poll_work;
 124         struct timer_list       link_poll_timer;
 125
 126         /*
 127          * Data for the individual switch chips.
 128          */
 129         struct dsa_switch       *ds[DSA_MAX_SWITCHES];
 130 };
 131
 132 struct dsa_switch {
 133         /*
 134          * Parent switch tree, and switch index.
 135          */
 136         struct dsa_switch_tree  *dst;
 137         int                     index;
 138
 139         /*
 140          * Tagging protocol understood by this switch
 141          */
 142         enum dsa_tag_protocol   tag_protocol;
 143
 144         /*
 145          * Configuration data for this switch.
 146          */
 147         struct dsa_chip_data    *pd;
 148
 149         /*
 150          * The used switch driver.
 151          */
 152         struct dsa_switch_driver        *drv;
 153
 154         /*
 155          * Reference to host device to use.
 156          */
 157         struct device           *master_dev;
 158
 159 #ifdef CONFIG_NET_DSA_HWMON
 160         /*
 161          * Hardware monitoring information
 162          */
 163         char                    hwmon_name[IFNAMSIZ + 8];
 164         struct device           *hwmon_dev;
 165 #endif
 166
 167         /*
 168          * Slave mii_bus and devices for the individual ports.
 169          */
 170         u32                     dsa_port_mask;
 171         u32                     phys_port_mask;
 172         u32                     phys_mii_mask;
 173         struct mii_bus          *slave_mii_bus;
 174         struct net_device       *ports[DSA_MAX_PORTS];
 175 };
 176
 177 static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p)
 178 {
 179         return !!(ds->index == ds->dst->cpu_switch && p == ds->dst->cpu_port);
 180 }
 181
 182 static inline bool dsa_is_dsa_port(struct dsa_switch *ds, int p)
 183 {
 184         return !!((ds->dsa_port_mask) & (1 << p));
 185 }
 186
 187 static inline bool dsa_is_port_initialized(struct dsa_switch *ds, int p)
 188 {
 189         return ds->phys_port_mask & (1 << p) && ds->ports[p];
 190 }
 191
 192 static inline u8 dsa_upstream_port(struct dsa_switch *ds)
 193 {
 194         struct dsa_switch_tree *dst = ds->dst;
 195
 196         /*
 197          * If this is the root switch (i.e. the switch that connects
 198          * to the CPU), return the cpu port number on this switch.
 199          * Else return the (DSA) port number that connects to the
 200          * switch that is one hop closer to the cpu.
 201          */
 202         if (dst->cpu_switch == ds->index)
 203                 return dst->cpu_port;
 204         else
 205                 return ds->pd->rtable[dst->cpu_switch];
 206 }
 207
 208 struct switchdev_trans;
 209 struct switchdev_obj;
 210 struct switchdev_obj_port_fdb;
 211 struct switchdev_obj_port_vlan;
 212
 213 struct dsa_switch_driver {
 214         struct list_head        list;
 215
 216         enum dsa_tag_protocol   tag_protocol;
 217         int                     priv_size;
 218
 219         /*
 220          * Probing and setup.
 221          */
 222         char    *(*probe)(struct device *host_dev, int sw_addr);
 223         int     (*setup)(struct dsa_switch *ds);
 224         int     (*set_addr)(struct dsa_switch *ds, u8 *addr);
 225         u32     (*get_phy_flags)(struct dsa_switch *ds, int port);
 226
 227         /*
 228          * Access to the switch's PHY registers.
 229          */
 230         int     (*phy_read)(struct dsa_switch *ds, int port, int regnum);
 231         int     (*phy_write)(struct dsa_switch *ds, int port,
 232                              int regnum, u16 val);
 233
 234         /*
 235          * Link state polling and IRQ handling.
 236          */
 237         void    (*poll_link)(struct dsa_switch *ds);
 238
 239         /*
 240          * Link state adjustment (called from libphy)
 241          */
 242         void    (*adjust_link)(struct dsa_switch *ds, int port,
 243                                 struct phy_device *phydev);
 244         void    (*fixed_link_update)(struct dsa_switch *ds, int port,
 245                                 struct fixed_phy_status *st);
 246
 247         /*
 248          * ethtool hardware statistics.
 249          */
 250         void    (*get_strings)(struct dsa_switch *ds, int port, uint8_t *data);
 251         void    (*get_ethtool_stats)(struct dsa_switch *ds,
 252                                      int port, uint64_t *data);
 253         int     (*get_sset_count)(struct dsa_switch *ds);
 254
 255         /*
 256          * ethtool Wake-on-LAN
 257          */
 258         void    (*get_wol)(struct dsa_switch *ds, int port,
 259                            struct ethtool_wolinfo *w);
 260         int     (*set_wol)(struct dsa_switch *ds, int port,
 261                            struct ethtool_wolinfo *w);
 262
 263         /*
 264          * Suspend and resume
 265          */
 266         int     (*suspend)(struct dsa_switch *ds);
 267         int     (*resume)(struct dsa_switch *ds);
 268
 269         /*
 270          * Port enable/disable
 271          */
 272         int     (*port_enable)(struct dsa_switch *ds, int port,
 273                                struct phy_device *phy);
 274         void    (*port_disable)(struct dsa_switch *ds, int port,
 275                                 struct phy_device *phy);
 276
 277         /*
 278          * EEE setttings
 279          */
 280         int     (*set_eee)(struct dsa_switch *ds, int port,
 281                            struct phy_device *phydev,
 282                            struct ethtool_eee *e);
 283         int     (*get_eee)(struct dsa_switch *ds, int port,
 284                            struct ethtool_eee *e);
 285
 286 #ifdef CONFIG_NET_DSA_HWMON
 287         /* Hardware monitoring */
 288         int     (*get_temp)(struct dsa_switch *ds, int *temp);
 289         int     (*get_temp_limit)(struct dsa_switch *ds, int *temp);
 290         int     (*set_temp_limit)(struct dsa_switch *ds, int temp);
 291         int     (*get_temp_alarm)(struct dsa_switch *ds, bool *alarm);
 292 #endif
 293
 294         /* EEPROM access */
 295         int     (*get_eeprom_len)(struct dsa_switch *ds);
 296         int     (*get_eeprom)(struct dsa_switch *ds,
 297                               struct ethtool_eeprom *eeprom, u8 *data);
 298         int     (*set_eeprom)(struct dsa_switch *ds,
 299                               struct ethtool_eeprom *eeprom, u8 *data);
 300
 301         /*
 302          * Register access.
 303          */
 304         int     (*get_regs_len)(struct dsa_switch *ds, int port);
 305         void    (*get_regs)(struct dsa_switch *ds, int port,
 306                             struct ethtool_regs *regs, void *p);
 307
 308         /*
 309          * Bridge integration
 310          */
 311         int     (*port_join_bridge)(struct dsa_switch *ds, int port,
 312                                     u32 br_port_mask);
 313         int     (*port_leave_bridge)(struct dsa_switch *ds, int port,
 314                                      u32 br_port_mask);
 315         int     (*port_stp_update)(struct dsa_switch *ds, int port,
 316                                    u8 state);
 317
 318         /*
 319          * VLAN support
 320          */
 321         int     (*port_vlan_prepare)(struct dsa_switch *ds, int port,
 322                                      const struct switchdev_obj_port_vlan *vlan,
 323                                      struct switchdev_trans *trans);
 324         int     (*port_vlan_add)(struct dsa_switch *ds, int port,
 325                                  const struct switchdev_obj_port_vlan *vlan,
 326                                  struct switchdev_trans *trans);
 327         int     (*port_vlan_del)(struct dsa_switch *ds, int port,
 328                                  const struct switchdev_obj_port_vlan *vlan);
 329         int     (*port_pvid_get)(struct dsa_switch *ds, int port, u16 *pvid);
 330         int     (*vlan_getnext)(struct dsa_switch *ds, u16 *vid,
 331                                 unsigned long *ports, unsigned long *untagged);
 332
 333         /*
 334          * Forwarding database
 335          */
 336         int     (*port_fdb_prepare)(struct dsa_switch *ds, int port,
 337                                     const struct switchdev_obj_port_fdb *fdb,
 338                                     struct switchdev_trans *trans);
 339         int     (*port_fdb_add)(struct dsa_switch *ds, int port,
 340                                 const struct switchdev_obj_port_fdb *fdb,
 341                                 struct switchdev_trans *trans);
 342         int     (*port_fdb_del)(struct dsa_switch *ds, int port,
 343                                 const struct switchdev_obj_port_fdb *fdb);
 344         int     (*port_fdb_dump)(struct dsa_switch *ds, int port,
 345                                  struct switchdev_obj_port_fdb *fdb,
 346                                  int (*cb)(struct switchdev_obj *obj));
 347 };
 348
 349 void register_switch_driver(struct dsa_switch_driver *type);
 350 void unregister_switch_driver(struct dsa_switch_driver *type);
 351 struct mii_bus *dsa_host_dev_to_mii_bus(struct device *dev);
 352
 353 static inline void *ds_to_priv(struct dsa_switch *ds)
 354 {
 355         return (void *)(ds + 1);
 356 }
 357
 358 static inline bool dsa_uses_tagged_protocol(struct dsa_switch_tree *dst)
 359 {
 360         return dst->rcv != NULL;
 361 }
 362 #endif