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         /* Device tree node pointer for this specific switch chip
  42          * used during switch setup in case additional properties
  43          * and resources needs to be used
  44          */
  45         struct device_node *of_node;
  46
  47         /*
  48          * The names of the switch's ports.  Use "cpu" to
  49          * designate the switch port that the cpu is connected to,
  50          * "dsa" to indicate that this port is a DSA link to
  51          * another switch, NULL to indicate the port is unused,
  52          * or any other string to indicate this is a physical port.
  53          */
  54         char            *port_names[DSA_MAX_PORTS];
  55         struct device_node *port_dn[DSA_MAX_PORTS];
  56
  57         /*
  58          * An array (with nr_chips elements) of which element [a]
  59          * indicates which port on this switch should be used to
  60          * send packets to that are destined for switch a.  Can be
  61          * NULL if there is only one switch chip.
  62          */
  63         s8              *rtable;
  64 };
  65
  66 struct dsa_platform_data {
  67         /*
  68          * Reference to a Linux network interface that connects
  69          * to the root switch chip of the tree.
  70          */
  71         struct device   *netdev;
  72
  73         /*
  74          * Info structs describing each of the switch chips
  75          * connected via this network interface.
  76          */
  77         int             nr_chips;
  78         struct dsa_chip_data    *chip;
  79 };
  80
  81 struct packet_type;
  82
  83 struct dsa_switch_tree {
  84         /*
  85          * Configuration data for the platform device that owns
  86          * this dsa switch tree instance.
  87          */
  88         struct dsa_platform_data        *pd;
  89
  90         /*
  91          * Reference to network device to use, and which tagging
  92          * protocol to use.
  93          */
  94         struct net_device       *master_netdev;
  95         int                     (*rcv)(struct sk_buff *skb,
  96                                        struct net_device *dev,
  97                                        struct packet_type *pt,
  98                                        struct net_device *orig_dev);
  99         enum dsa_tag_protocol   tag_protocol;
 100
 101         /*
 102          * The switch and port to which the CPU is attached.
 103          */
 104         s8                      cpu_switch;
 105         s8                      cpu_port;
 106
 107         /*
 108          * Link state polling.
 109          */
 110         int                     link_poll_needed;
 111         struct work_struct      link_poll_work;
 112         struct timer_list       link_poll_timer;
 113
 114         /*
 115          * Data for the individual switch chips.
 116          */
 117         struct dsa_switch       *ds[DSA_MAX_SWITCHES];
 118 };
 119
 120 struct dsa_switch {
 121         /*
 122          * Parent switch tree, and switch index.
 123          */
 124         struct dsa_switch_tree  *dst;
 125         int                     index;
 126
 127         /*
 128          * Configuration data for this switch.
 129          */
 130         struct dsa_chip_data    *pd;
 131
 132         /*
 133          * The used switch driver.
 134          */
 135         struct dsa_switch_driver        *drv;
 136
 137         /*
 138          * Reference to host device to use.
 139          */
 140         struct device           *master_dev;
 141
 142         /*
 143          * Slave mii_bus and devices for the individual ports.
 144          */
 145         u32                     dsa_port_mask;
 146         u32                     phys_port_mask;
 147         u32                     phys_mii_mask;
 148         struct mii_bus          *slave_mii_bus;
 149         struct net_device       *ports[DSA_MAX_PORTS];
 150 };
 151
 152 static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p)
 153 {
 154         return !!(ds->index == ds->dst->cpu_switch && p == ds->dst->cpu_port);
 155 }
 156
 157 static inline u8 dsa_upstream_port(struct dsa_switch *ds)
 158 {
 159         struct dsa_switch_tree *dst = ds->dst;
 160
 161         /*
 162          * If this is the root switch (i.e. the switch that connects
 163          * to the CPU), return the cpu port number on this switch.
 164          * Else return the (DSA) port number that connects to the
 165          * switch that is one hop closer to the cpu.
 166          */
 167         if (dst->cpu_switch == ds->index)
 168                 return dst->cpu_port;
 169         else
 170                 return ds->pd->rtable[dst->cpu_switch];
 171 }
 172
 173 struct dsa_switch_driver {
 174         struct list_head        list;
 175
 176         enum dsa_tag_protocol   tag_protocol;
 177         int                     priv_size;
 178
 179         /*
 180          * Probing and setup.
 181          */
 182         char    *(*probe)(struct device *host_dev, int sw_addr);
 183         int     (*setup)(struct dsa_switch *ds);
 184         int     (*set_addr)(struct dsa_switch *ds, u8 *addr);
 185         u32     (*get_phy_flags)(struct dsa_switch *ds, int port);
 186
 187         /*
 188          * Access to the switch's PHY registers.
 189          */
 190         int     (*phy_read)(struct dsa_switch *ds, int port, int regnum);
 191         int     (*phy_write)(struct dsa_switch *ds, int port,
 192                              int regnum, u16 val);
 193
 194         /*
 195          * Link state polling and IRQ handling.
 196          */
 197         void    (*poll_link)(struct dsa_switch *ds);
 198
 199         /*
 200          * Link state adjustment (called from libphy)
 201          */
 202         void    (*adjust_link)(struct dsa_switch *ds, int port,
 203                                 struct phy_device *phydev);
 204         void    (*fixed_link_update)(struct dsa_switch *ds, int port,
 205                                 struct fixed_phy_status *st);
 206
 207         /*
 208          * ethtool hardware statistics.
 209          */
 210         void    (*get_strings)(struct dsa_switch *ds, int port, uint8_t *data);
 211         void    (*get_ethtool_stats)(struct dsa_switch *ds,
 212                                      int port, uint64_t *data);
 213         int     (*get_sset_count)(struct dsa_switch *ds);
 214
 215         /*
 216          * ethtool Wake-on-LAN
 217          */
 218         void    (*get_wol)(struct dsa_switch *ds, int port,
 219                            struct ethtool_wolinfo *w);
 220         int     (*set_wol)(struct dsa_switch *ds, int port,
 221                            struct ethtool_wolinfo *w);
 222
 223         /*
 224          * Suspend and resume
 225          */
 226         int     (*suspend)(struct dsa_switch *ds);
 227         int     (*resume)(struct dsa_switch *ds);
 228
 229         /*
 230          * Port enable/disable
 231          */
 232         int     (*port_enable)(struct dsa_switch *ds, int port,
 233                                struct phy_device *phy);
 234         void    (*port_disable)(struct dsa_switch *ds, int port,
 235                                 struct phy_device *phy);
 236
 237         /*
 238          * EEE setttings
 239          */
 240         int     (*set_eee)(struct dsa_switch *ds, int port,
 241                            struct phy_device *phydev,
 242                            struct ethtool_eee *e);
 243         int     (*get_eee)(struct dsa_switch *ds, int port,
 244                            struct ethtool_eee *e);
 245 };
 246
 247 void register_switch_driver(struct dsa_switch_driver *type);
 248 void unregister_switch_driver(struct dsa_switch_driver *type);
 249 struct mii_bus *dsa_host_dev_to_mii_bus(struct device *dev);
 250
 251 static inline void *ds_to_priv(struct dsa_switch *ds)
 252 {
 253         return (void *)(ds + 1);
 254 }
 255
 256 static inline bool dsa_uses_tagged_protocol(struct dsa_switch_tree *dst)
 257 {
 258         return dst->rcv != NULL;
 259 }
 260 #endif