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