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
  22 /* Not an official ethertype value, used only internally for DSA
  23  * demultiplexing
  24  */
  25 #define ETH_P_BRCMTAG           (ETH_P_XDSA + 1)
  26
  27 #define DSA_MAX_SWITCHES        4
  28 #define DSA_MAX_PORTS           12
  29
  30 struct dsa_chip_data {
  31         /*
  32          * How to access the switch configuration registers.
  33          */
  34         struct device   *mii_bus;
  35         int             sw_addr;
  36
  37         /* Device tree node pointer for this specific switch chip
  38          * used during switch setup in case additional properties
  39          * and resources needs to be used
  40          */
  41         struct device_node *of_node;
  42
  43         /*
  44          * The names of the switch's ports.  Use "cpu" to
  45          * designate the switch port that the cpu is connected to,
  46          * "dsa" to indicate that this port is a DSA link to
  47          * another switch, NULL to indicate the port is unused,
  48          * or any other string to indicate this is a physical port.
  49          */
  50         char            *port_names[DSA_MAX_PORTS];
  51         struct device_node *port_dn[DSA_MAX_PORTS];
  52
  53         /*
  54          * An array (with nr_chips elements) of which element [a]
  55          * indicates which port on this switch should be used to
  56          * send packets to that are destined for switch a.  Can be
  57          * NULL if there is only one switch chip.
  58          */
  59         s8              *rtable;
  60 };
  61
  62 struct dsa_platform_data {
  63         /*
  64          * Reference to a Linux network interface that connects
  65          * to the root switch chip of the tree.
  66          */
  67         struct device   *netdev;
  68
  69         /*
  70          * Info structs describing each of the switch chips
  71          * connected via this network interface.
  72          */
  73         int             nr_chips;
  74         struct dsa_chip_data    *chip;
  75 };
  76
  77 struct dsa_device_ops;
  78
  79 struct dsa_switch_tree {
  80         /*
  81          * Configuration data for the platform device that owns
  82          * this dsa switch tree instance.
  83          */
  84         struct dsa_platform_data        *pd;
  85
  86         /*
  87          * Reference to network device to use, and which tagging
  88          * protocol to use.
  89          */
  90         struct net_device       *master_netdev;
  91         const struct dsa_device_ops     *ops;
  92         __be16                  tag_protocol;
  93
  94         /*
  95          * The switch and port to which the CPU is attached.
  96          */
  97         s8                      cpu_switch;
  98         s8                      cpu_port;
  99
 100         /*
 101          * Link state polling.
 102          */
 103         int                     link_poll_needed;
 104         struct work_struct      link_poll_work;
 105         struct timer_list       link_poll_timer;
 106
 107         /*
 108          * Data for the individual switch chips.
 109          */
 110         struct dsa_switch       *ds[DSA_MAX_SWITCHES];
 111 };
 112
 113 struct dsa_switch {
 114         /*
 115          * Parent switch tree, and switch index.
 116          */
 117         struct dsa_switch_tree  *dst;
 118         int                     index;
 119
 120         /*
 121          * Configuration data for this switch.
 122          */
 123         struct dsa_chip_data    *pd;
 124
 125         /*
 126          * The used switch driver.
 127          */
 128         struct dsa_switch_driver        *drv;
 129
 130         /*
 131          * Reference to mii bus to use.
 132          */
 133         struct mii_bus          *master_mii_bus;
 134
 135         /*
 136          * Slave mii_bus and devices for the individual ports.
 137          */
 138         u32                     dsa_port_mask;
 139         u32                     phys_port_mask;
 140         u32                     phys_mii_mask;
 141         struct mii_bus          *slave_mii_bus;
 142         struct net_device       *ports[DSA_MAX_PORTS];
 143 };
 144
 145 static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p)
 146 {
 147         return !!(ds->index == ds->dst->cpu_switch && p == ds->dst->cpu_port);
 148 }
 149
 150 static inline u8 dsa_upstream_port(struct dsa_switch *ds)
 151 {
 152         struct dsa_switch_tree *dst = ds->dst;
 153
 154         /*
 155          * If this is the root switch (i.e. the switch that connects
 156          * to the CPU), return the cpu port number on this switch.
 157          * Else return the (DSA) port number that connects to the
 158          * switch that is one hop closer to the cpu.
 159          */
 160         if (dst->cpu_switch == ds->index)
 161                 return dst->cpu_port;
 162         else
 163                 return ds->pd->rtable[dst->cpu_switch];
 164 }
 165
 166 struct dsa_switch_driver {
 167         struct list_head        list;
 168
 169         __be16                  tag_protocol;
 170         int                     priv_size;
 171
 172         /*
 173          * Probing and setup.
 174          */
 175         char    *(*probe)(struct mii_bus *bus, int sw_addr);
 176         int     (*setup)(struct dsa_switch *ds);
 177         int     (*set_addr)(struct dsa_switch *ds, u8 *addr);
 178
 179         /*
 180          * Access to the switch's PHY registers.
 181          */
 182         int     (*phy_read)(struct dsa_switch *ds, int port, int regnum);
 183         int     (*phy_write)(struct dsa_switch *ds, int port,
 184                              int regnum, u16 val);
 185
 186         /*
 187          * Link state polling and IRQ handling.
 188          */
 189         void    (*poll_link)(struct dsa_switch *ds);
 190
 191         /*
 192          * Link state adjustment (called from libphy)
 193          */
 194         void    (*adjust_link)(struct dsa_switch *ds, int port,
 195                                 struct phy_device *phydev);
 196         void    (*fixed_link_update)(struct dsa_switch *ds, int port,
 197                                 struct fixed_phy_status *st);
 198
 199         /*
 200          * ethtool hardware statistics.
 201          */
 202         void    (*get_strings)(struct dsa_switch *ds, int port, uint8_t *data);
 203         void    (*get_ethtool_stats)(struct dsa_switch *ds,
 204                                      int port, uint64_t *data);
 205         int     (*get_sset_count)(struct dsa_switch *ds);
 206 };
 207
 208 void register_switch_driver(struct dsa_switch_driver *type);
 209 void unregister_switch_driver(struct dsa_switch_driver *type);
 210
 211 static inline void *ds_to_priv(struct dsa_switch *ds)
 212 {
 213         return (void *)(ds + 1);
 214 }
 215
 216 static inline bool dsa_uses_tagged_protocol(struct dsa_switch_tree *dst)
 217 {
 218         return dst->tag_protocol != 0;
 219 }
 220
 221 #endif