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 DSA_TAG_LAST, /* MUST BE LAST */ 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 of which element [a] indicates which port on this 63 * switch should be used to send packets to that are destined 64 * for switch a. Can be NULL if there is only one switch chip. 65 */ 66 s8 rtable[DSA_MAX_SWITCHES]; 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 struct list_head list; 89 90 /* Tree identifier */ 91 u32 tree; 92 93 /* Number of switches attached to this tree */ 94 struct kref refcount; 95 96 /* Has this tree been applied to the hardware? */ 97 bool applied; 98 99 /* 100 * Configuration data for the platform device that owns 101 * this dsa switch tree instance. 102 */ 103 struct dsa_platform_data *pd; 104 105 /* 106 * Reference to network device to use, and which tagging 107 * protocol to use. 108 */ 109 struct net_device *master_netdev; 110 int (*rcv)(struct sk_buff *skb, 111 struct net_device *dev, 112 struct packet_type *pt, 113 struct net_device *orig_dev); 114 115 /* 116 * Original copy of the master netdev ethtool_ops 117 */ 118 struct ethtool_ops master_ethtool_ops; 119 const struct ethtool_ops *master_orig_ethtool_ops; 120 121 /* 122 * The switch and port to which the CPU is attached. 123 */ 124 s8 cpu_switch; 125 s8 cpu_port; 126 127 /* 128 * Data for the individual switch chips. 129 */ 130 struct dsa_switch *ds[DSA_MAX_SWITCHES]; 131 132 /* 133 * Tagging protocol operations for adding and removing an 134 * encapsulation tag. 135 */ 136 const struct dsa_device_ops *tag_ops; 137 }; 138 139 struct dsa_port { 140 struct net_device *netdev; 141 struct device_node *dn; 142 }; 143 144 struct dsa_switch { 145 struct device *dev; 146 147 /* 148 * Parent switch tree, and switch index. 149 */ 150 struct dsa_switch_tree *dst; 151 int index; 152 153 /* 154 * Give the switch driver somewhere to hang its private data 155 * structure. 156 */ 157 void *priv; 158 159 /* 160 * Configuration data for this switch. 161 */ 162 struct dsa_chip_data *cd; 163 164 /* 165 * The used switch driver. 166 */ 167 struct dsa_switch_driver *drv; 168 169 /* 170 * An array of which element [a] indicates which port on this 171 * switch should be used to send packets to that are destined 172 * for switch a. Can be NULL if there is only one switch chip. 173 */ 174 s8 rtable[DSA_MAX_SWITCHES]; 175 176 #ifdef CONFIG_NET_DSA_HWMON 177 /* 178 * Hardware monitoring information 179 */ 180 char hwmon_name[IFNAMSIZ + 8]; 181 struct device *hwmon_dev; 182 #endif 183 184 /* 185 * The lower device this switch uses to talk to the host 186 */ 187 struct net_device *master_netdev; 188 189 /* 190 * Slave mii_bus and devices for the individual ports. 191 */ 192 u32 dsa_port_mask; 193 u32 cpu_port_mask; 194 u32 enabled_port_mask; 195 u32 phys_mii_mask; 196 struct dsa_port ports[DSA_MAX_PORTS]; 197 struct mii_bus *slave_mii_bus; 198 }; 199 200 static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p) 201 { 202 return !!(ds->index == ds->dst->cpu_switch && p == ds->dst->cpu_port); 203 } 204 205 static inline bool dsa_is_dsa_port(struct dsa_switch *ds, int p) 206 { 207 return !!((ds->dsa_port_mask) & (1 << p)); 208 } 209 210 static inline bool dsa_is_port_initialized(struct dsa_switch *ds, int p) 211 { 212 return ds->enabled_port_mask & (1 << p) && ds->ports[p].netdev; 213 } 214 215 static inline u8 dsa_upstream_port(struct dsa_switch *ds) 216 { 217 struct dsa_switch_tree *dst = ds->dst; 218 219 /* 220 * If this is the root switch (i.e. the switch that connects 221 * to the CPU), return the cpu port number on this switch. 222 * Else return the (DSA) port number that connects to the 223 * switch that is one hop closer to the cpu. 224 */ 225 if (dst->cpu_switch == ds->index) 226 return dst->cpu_port; 227 else 228 return ds->rtable[dst->cpu_switch]; 229 } 230 231 struct switchdev_trans; 232 struct switchdev_obj; 233 struct switchdev_obj_port_fdb; 234 struct switchdev_obj_port_vlan; 235 236 struct dsa_switch_driver { 237 struct list_head list; 238 239 enum dsa_tag_protocol tag_protocol; 240 241 /* 242 * Probing and setup. 243 */ 244 const char *(*probe)(struct device *dsa_dev, 245 struct device *host_dev, int sw_addr, 246 void **priv); 247 int (*setup)(struct dsa_switch *ds); 248 int (*set_addr)(struct dsa_switch *ds, u8 *addr); 249 u32 (*get_phy_flags)(struct dsa_switch *ds, int port); 250 251 /* 252 * Access to the switch's PHY registers. 253 */ 254 int (*phy_read)(struct dsa_switch *ds, int port, int regnum); 255 int (*phy_write)(struct dsa_switch *ds, int port, 256 int regnum, u16 val); 257 258 /* 259 * Link state adjustment (called from libphy) 260 */ 261 void (*adjust_link)(struct dsa_switch *ds, int port, 262 struct phy_device *phydev); 263 void (*fixed_link_update)(struct dsa_switch *ds, int port, 264 struct fixed_phy_status *st); 265 266 /* 267 * ethtool hardware statistics. 268 */ 269 void (*get_strings)(struct dsa_switch *ds, int port, uint8_t *data); 270 void (*get_ethtool_stats)(struct dsa_switch *ds, 271 int port, uint64_t *data); 272 int (*get_sset_count)(struct dsa_switch *ds); 273 274 /* 275 * ethtool Wake-on-LAN 276 */ 277 void (*get_wol)(struct dsa_switch *ds, int port, 278 struct ethtool_wolinfo *w); 279 int (*set_wol)(struct dsa_switch *ds, int port, 280 struct ethtool_wolinfo *w); 281 282 /* 283 * Suspend and resume 284 */ 285 int (*suspend)(struct dsa_switch *ds); 286 int (*resume)(struct dsa_switch *ds); 287 288 /* 289 * Port enable/disable 290 */ 291 int (*port_enable)(struct dsa_switch *ds, int port, 292 struct phy_device *phy); 293 void (*port_disable)(struct dsa_switch *ds, int port, 294 struct phy_device *phy); 295 296 /* 297 * EEE setttings 298 */ 299 int (*set_eee)(struct dsa_switch *ds, int port, 300 struct phy_device *phydev, 301 struct ethtool_eee *e); 302 int (*get_eee)(struct dsa_switch *ds, int port, 303 struct ethtool_eee *e); 304 305 #ifdef CONFIG_NET_DSA_HWMON 306 /* Hardware monitoring */ 307 int (*get_temp)(struct dsa_switch *ds, int *temp); 308 int (*get_temp_limit)(struct dsa_switch *ds, int *temp); 309 int (*set_temp_limit)(struct dsa_switch *ds, int temp); 310 int (*get_temp_alarm)(struct dsa_switch *ds, bool *alarm); 311 #endif 312 313 /* EEPROM access */ 314 int (*get_eeprom_len)(struct dsa_switch *ds); 315 int (*get_eeprom)(struct dsa_switch *ds, 316 struct ethtool_eeprom *eeprom, u8 *data); 317 int (*set_eeprom)(struct dsa_switch *ds, 318 struct ethtool_eeprom *eeprom, u8 *data); 319 320 /* 321 * Register access. 322 */ 323 int (*get_regs_len)(struct dsa_switch *ds, int port); 324 void (*get_regs)(struct dsa_switch *ds, int port, 325 struct ethtool_regs *regs, void *p); 326 327 /* 328 * Bridge integration 329 */ 330 int (*port_bridge_join)(struct dsa_switch *ds, int port, 331 struct net_device *bridge); 332 void (*port_bridge_leave)(struct dsa_switch *ds, int port); 333 void (*port_stp_state_set)(struct dsa_switch *ds, int port, 334 u8 state); 335 336 /* 337 * VLAN support 338 */ 339 int (*port_vlan_filtering)(struct dsa_switch *ds, int port, 340 bool vlan_filtering); 341 int (*port_vlan_prepare)(struct dsa_switch *ds, int port, 342 const struct switchdev_obj_port_vlan *vlan, 343 struct switchdev_trans *trans); 344 void (*port_vlan_add)(struct dsa_switch *ds, int port, 345 const struct switchdev_obj_port_vlan *vlan, 346 struct switchdev_trans *trans); 347 int (*port_vlan_del)(struct dsa_switch *ds, int port, 348 const struct switchdev_obj_port_vlan *vlan); 349 int (*port_vlan_dump)(struct dsa_switch *ds, int port, 350 struct switchdev_obj_port_vlan *vlan, 351 int (*cb)(struct switchdev_obj *obj)); 352 353 /* 354 * Forwarding database 355 */ 356 int (*port_fdb_prepare)(struct dsa_switch *ds, int port, 357 const struct switchdev_obj_port_fdb *fdb, 358 struct switchdev_trans *trans); 359 void (*port_fdb_add)(struct dsa_switch *ds, int port, 360 const struct switchdev_obj_port_fdb *fdb, 361 struct switchdev_trans *trans); 362 int (*port_fdb_del)(struct dsa_switch *ds, int port, 363 const struct switchdev_obj_port_fdb *fdb); 364 int (*port_fdb_dump)(struct dsa_switch *ds, int port, 365 struct switchdev_obj_port_fdb *fdb, 366 int (*cb)(struct switchdev_obj *obj)); 367 }; 368 369 void register_switch_driver(struct dsa_switch_driver *type); 370 void unregister_switch_driver(struct dsa_switch_driver *type); 371 struct mii_bus *dsa_host_dev_to_mii_bus(struct device *dev); 372 373 static inline void *ds_to_priv(struct dsa_switch *ds) 374 { 375 return ds->priv; 376 } 377 378 static inline bool dsa_uses_tagged_protocol(struct dsa_switch_tree *dst) 379 { 380 return dst->rcv != NULL; 381 } 382 383 void dsa_unregister_switch(struct dsa_switch *ds); 384 int dsa_register_switch(struct dsa_switch *ds, struct device_node *np); 385 #endif 386