Lennert Buytenhek | 91da11f | 2008-10-07 13:44:02 +0000 | [diff] [blame] | 1 | /* |
| 2 | * include/net/dsa.h - Driver for Distributed Switch Architecture switch chips |
Lennert Buytenhek | e84665c | 2009-03-20 09:52:09 +0000 | [diff] [blame] | 3 | * Copyright (c) 2008-2009 Marvell Semiconductor |
Lennert Buytenhek | 91da11f | 2008-10-07 13:44:02 +0000 | [diff] [blame] | 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 | |
Axel Lin | ea1f51b | 2011-11-30 22:07:18 +0000 | [diff] [blame] | 14 | #include <linux/if_ether.h> |
Ben Hutchings | c8f0b86 | 2011-11-27 17:06:08 +0000 | [diff] [blame] | 15 | #include <linux/list.h> |
Ben Hutchings | cf50dcc | 2011-11-25 14:32:52 +0000 | [diff] [blame] | 16 | #include <linux/timer.h> |
| 17 | #include <linux/workqueue.h> |
Florian Fainelli | fa981d9 | 2014-08-27 17:04:49 -0700 | [diff] [blame] | 18 | #include <linux/of.h> |
Florian Fainelli | ec9436b | 2014-08-27 17:04:53 -0700 | [diff] [blame] | 19 | #include <linux/phy.h> |
Florian Fainelli | ce31b31 | 2014-08-27 17:04:54 -0700 | [diff] [blame] | 20 | #include <linux/phy_fixed.h> |
Florian Fainelli | a282054 | 2014-10-17 16:02:13 -0700 | [diff] [blame] | 21 | #include <linux/ethtool.h> |
Ben Hutchings | cf50dcc | 2011-11-25 14:32:52 +0000 | [diff] [blame] | 22 | |
Florian Fainelli | ac7a04c | 2014-09-11 21:18:09 -0700 | [diff] [blame] | 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 | }; |
Florian Fainelli | 5037d53 | 2014-08-27 17:04:55 -0700 | [diff] [blame] | 30 | |
Lennert Buytenhek | e84665c | 2009-03-20 09:52:09 +0000 | [diff] [blame] | 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 | */ |
Alexander Duyck | b4d2394 | 2014-09-15 13:00:27 -0400 | [diff] [blame] | 38 | struct device *host_dev; |
Lennert Buytenhek | e84665c | 2009-03-20 09:52:09 +0000 | [diff] [blame] | 39 | int sw_addr; |
| 40 | |
Guenter Roeck | 6793abb | 2014-10-29 10:45:01 -0700 | [diff] [blame] | 41 | /* set to size of eeprom if supported by the switch */ |
| 42 | int eeprom_len; |
| 43 | |
Florian Fainelli | fa981d9 | 2014-08-27 17:04:49 -0700 | [diff] [blame] | 44 | /* Device tree node pointer for this specific switch chip |
| 45 | * used during switch setup in case additional properties |
| 46 | * and resources needs to be used |
| 47 | */ |
| 48 | struct device_node *of_node; |
| 49 | |
Lennert Buytenhek | e84665c | 2009-03-20 09:52:09 +0000 | [diff] [blame] | 50 | /* |
| 51 | * The names of the switch's ports. Use "cpu" to |
| 52 | * designate the switch port that the cpu is connected to, |
| 53 | * "dsa" to indicate that this port is a DSA link to |
| 54 | * another switch, NULL to indicate the port is unused, |
| 55 | * or any other string to indicate this is a physical port. |
| 56 | */ |
| 57 | char *port_names[DSA_MAX_PORTS]; |
Florian Fainelli | bd47497 | 2014-08-27 17:04:50 -0700 | [diff] [blame] | 58 | struct device_node *port_dn[DSA_MAX_PORTS]; |
Lennert Buytenhek | e84665c | 2009-03-20 09:52:09 +0000 | [diff] [blame] | 59 | |
| 60 | /* |
| 61 | * An array (with nr_chips elements) of which element [a] |
| 62 | * indicates which port on this switch should be used to |
| 63 | * send packets to that are destined for switch a. Can be |
| 64 | * NULL if there is only one switch chip. |
| 65 | */ |
| 66 | s8 *rtable; |
| 67 | }; |
Lennert Buytenhek | 91da11f | 2008-10-07 13:44:02 +0000 | [diff] [blame] | 68 | |
| 69 | struct dsa_platform_data { |
| 70 | /* |
| 71 | * Reference to a Linux network interface that connects |
Lennert Buytenhek | e84665c | 2009-03-20 09:52:09 +0000 | [diff] [blame] | 72 | * to the root switch chip of the tree. |
Lennert Buytenhek | 91da11f | 2008-10-07 13:44:02 +0000 | [diff] [blame] | 73 | */ |
| 74 | struct device *netdev; |
Florian Fainelli | 769a020 | 2015-03-09 14:31:21 -0700 | [diff] [blame] | 75 | struct net_device *of_netdev; |
Lennert Buytenhek | 91da11f | 2008-10-07 13:44:02 +0000 | [diff] [blame] | 76 | |
| 77 | /* |
Lennert Buytenhek | e84665c | 2009-03-20 09:52:09 +0000 | [diff] [blame] | 78 | * Info structs describing each of the switch chips |
| 79 | * connected via this network interface. |
Lennert Buytenhek | 91da11f | 2008-10-07 13:44:02 +0000 | [diff] [blame] | 80 | */ |
Lennert Buytenhek | e84665c | 2009-03-20 09:52:09 +0000 | [diff] [blame] | 81 | int nr_chips; |
| 82 | struct dsa_chip_data *chip; |
Lennert Buytenhek | 91da11f | 2008-10-07 13:44:02 +0000 | [diff] [blame] | 83 | }; |
| 84 | |
Alexander Duyck | 5075314 | 2014-09-15 13:00:19 -0400 | [diff] [blame] | 85 | struct packet_type; |
Florian Fainelli | 3e8a72d | 2014-08-27 17:04:46 -0700 | [diff] [blame] | 86 | |
Ben Hutchings | cf50dcc | 2011-11-25 14:32:52 +0000 | [diff] [blame] | 87 | struct dsa_switch_tree { |
| 88 | /* |
| 89 | * Configuration data for the platform device that owns |
| 90 | * this dsa switch tree instance. |
| 91 | */ |
| 92 | struct dsa_platform_data *pd; |
Lennert Buytenhek | cf85d08 | 2008-10-07 13:45:02 +0000 | [diff] [blame] | 93 | |
Ben Hutchings | cf50dcc | 2011-11-25 14:32:52 +0000 | [diff] [blame] | 94 | /* |
| 95 | * Reference to network device to use, and which tagging |
| 96 | * protocol to use. |
| 97 | */ |
| 98 | struct net_device *master_netdev; |
Alexander Duyck | 5075314 | 2014-09-15 13:00:19 -0400 | [diff] [blame] | 99 | int (*rcv)(struct sk_buff *skb, |
| 100 | struct net_device *dev, |
| 101 | struct packet_type *pt, |
| 102 | struct net_device *orig_dev); |
Florian Fainelli | ac7a04c | 2014-09-11 21:18:09 -0700 | [diff] [blame] | 103 | enum dsa_tag_protocol tag_protocol; |
Ben Hutchings | cf50dcc | 2011-11-25 14:32:52 +0000 | [diff] [blame] | 104 | |
| 105 | /* |
| 106 | * The switch and port to which the CPU is attached. |
| 107 | */ |
| 108 | s8 cpu_switch; |
| 109 | s8 cpu_port; |
| 110 | |
| 111 | /* |
| 112 | * Link state polling. |
| 113 | */ |
| 114 | int link_poll_needed; |
| 115 | struct work_struct link_poll_work; |
| 116 | struct timer_list link_poll_timer; |
| 117 | |
| 118 | /* |
| 119 | * Data for the individual switch chips. |
| 120 | */ |
| 121 | struct dsa_switch *ds[DSA_MAX_SWITCHES]; |
| 122 | }; |
| 123 | |
Ben Hutchings | c8f0b86 | 2011-11-27 17:06:08 +0000 | [diff] [blame] | 124 | struct dsa_switch { |
| 125 | /* |
| 126 | * Parent switch tree, and switch index. |
| 127 | */ |
| 128 | struct dsa_switch_tree *dst; |
| 129 | int index; |
| 130 | |
| 131 | /* |
Florian Fainelli | 5929903 | 2015-03-05 12:35:07 -0800 | [diff] [blame] | 132 | * Tagging protocol understood by this switch |
| 133 | */ |
| 134 | enum dsa_tag_protocol tag_protocol; |
| 135 | |
| 136 | /* |
Ben Hutchings | c8f0b86 | 2011-11-27 17:06:08 +0000 | [diff] [blame] | 137 | * Configuration data for this switch. |
| 138 | */ |
| 139 | struct dsa_chip_data *pd; |
| 140 | |
| 141 | /* |
| 142 | * The used switch driver. |
| 143 | */ |
| 144 | struct dsa_switch_driver *drv; |
| 145 | |
| 146 | /* |
Alexander Duyck | b4d2394 | 2014-09-15 13:00:27 -0400 | [diff] [blame] | 147 | * Reference to host device to use. |
Ben Hutchings | c8f0b86 | 2011-11-27 17:06:08 +0000 | [diff] [blame] | 148 | */ |
Alexander Duyck | b4d2394 | 2014-09-15 13:00:27 -0400 | [diff] [blame] | 149 | struct device *master_dev; |
Ben Hutchings | c8f0b86 | 2011-11-27 17:06:08 +0000 | [diff] [blame] | 150 | |
Guenter Roeck | 51579c3 | 2014-10-29 10:44:58 -0700 | [diff] [blame] | 151 | #ifdef CONFIG_NET_DSA_HWMON |
| 152 | /* |
| 153 | * Hardware monitoring information |
| 154 | */ |
| 155 | char hwmon_name[IFNAMSIZ + 8]; |
| 156 | struct device *hwmon_dev; |
| 157 | #endif |
| 158 | |
Ben Hutchings | c8f0b86 | 2011-11-27 17:06:08 +0000 | [diff] [blame] | 159 | /* |
| 160 | * Slave mii_bus and devices for the individual ports. |
| 161 | */ |
| 162 | u32 dsa_port_mask; |
| 163 | u32 phys_port_mask; |
Florian Fainelli | 0d8bcdd | 2014-08-27 17:04:51 -0700 | [diff] [blame] | 164 | u32 phys_mii_mask; |
Ben Hutchings | c8f0b86 | 2011-11-27 17:06:08 +0000 | [diff] [blame] | 165 | struct mii_bus *slave_mii_bus; |
| 166 | struct net_device *ports[DSA_MAX_PORTS]; |
| 167 | }; |
| 168 | |
| 169 | static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p) |
| 170 | { |
| 171 | return !!(ds->index == ds->dst->cpu_switch && p == ds->dst->cpu_port); |
| 172 | } |
| 173 | |
Guenter Roeck | d79d210 | 2015-02-24 23:02:02 -0800 | [diff] [blame] | 174 | static inline bool dsa_is_port_initialized(struct dsa_switch *ds, int p) |
| 175 | { |
| 176 | return ds->phys_port_mask & (1 << p) && ds->ports[p]; |
| 177 | } |
| 178 | |
Ben Hutchings | c8f0b86 | 2011-11-27 17:06:08 +0000 | [diff] [blame] | 179 | static inline u8 dsa_upstream_port(struct dsa_switch *ds) |
| 180 | { |
| 181 | struct dsa_switch_tree *dst = ds->dst; |
| 182 | |
| 183 | /* |
| 184 | * If this is the root switch (i.e. the switch that connects |
| 185 | * to the CPU), return the cpu port number on this switch. |
| 186 | * Else return the (DSA) port number that connects to the |
| 187 | * switch that is one hop closer to the cpu. |
| 188 | */ |
| 189 | if (dst->cpu_switch == ds->index) |
| 190 | return dst->cpu_port; |
| 191 | else |
| 192 | return ds->pd->rtable[dst->cpu_switch]; |
| 193 | } |
| 194 | |
| 195 | struct dsa_switch_driver { |
| 196 | struct list_head list; |
| 197 | |
Florian Fainelli | ac7a04c | 2014-09-11 21:18:09 -0700 | [diff] [blame] | 198 | enum dsa_tag_protocol tag_protocol; |
Ben Hutchings | c8f0b86 | 2011-11-27 17:06:08 +0000 | [diff] [blame] | 199 | int priv_size; |
| 200 | |
| 201 | /* |
| 202 | * Probing and setup. |
| 203 | */ |
Alexander Duyck | b4d2394 | 2014-09-15 13:00:27 -0400 | [diff] [blame] | 204 | char *(*probe)(struct device *host_dev, int sw_addr); |
Ben Hutchings | c8f0b86 | 2011-11-27 17:06:08 +0000 | [diff] [blame] | 205 | int (*setup)(struct dsa_switch *ds); |
| 206 | int (*set_addr)(struct dsa_switch *ds, u8 *addr); |
Florian Fainelli | 6819563 | 2014-09-19 13:07:54 -0700 | [diff] [blame] | 207 | u32 (*get_phy_flags)(struct dsa_switch *ds, int port); |
Ben Hutchings | c8f0b86 | 2011-11-27 17:06:08 +0000 | [diff] [blame] | 208 | |
| 209 | /* |
| 210 | * Access to the switch's PHY registers. |
| 211 | */ |
| 212 | int (*phy_read)(struct dsa_switch *ds, int port, int regnum); |
| 213 | int (*phy_write)(struct dsa_switch *ds, int port, |
| 214 | int regnum, u16 val); |
| 215 | |
| 216 | /* |
| 217 | * Link state polling and IRQ handling. |
| 218 | */ |
| 219 | void (*poll_link)(struct dsa_switch *ds); |
| 220 | |
| 221 | /* |
Florian Fainelli | ec9436b | 2014-08-27 17:04:53 -0700 | [diff] [blame] | 222 | * Link state adjustment (called from libphy) |
| 223 | */ |
| 224 | void (*adjust_link)(struct dsa_switch *ds, int port, |
| 225 | struct phy_device *phydev); |
Florian Fainelli | ce31b31 | 2014-08-27 17:04:54 -0700 | [diff] [blame] | 226 | void (*fixed_link_update)(struct dsa_switch *ds, int port, |
| 227 | struct fixed_phy_status *st); |
Florian Fainelli | ec9436b | 2014-08-27 17:04:53 -0700 | [diff] [blame] | 228 | |
| 229 | /* |
Ben Hutchings | c8f0b86 | 2011-11-27 17:06:08 +0000 | [diff] [blame] | 230 | * ethtool hardware statistics. |
| 231 | */ |
| 232 | void (*get_strings)(struct dsa_switch *ds, int port, uint8_t *data); |
| 233 | void (*get_ethtool_stats)(struct dsa_switch *ds, |
| 234 | int port, uint64_t *data); |
| 235 | int (*get_sset_count)(struct dsa_switch *ds); |
Florian Fainelli | 2446254 | 2014-09-18 17:31:22 -0700 | [diff] [blame] | 236 | |
| 237 | /* |
Florian Fainelli | 19e57c4 | 2014-09-18 17:31:24 -0700 | [diff] [blame] | 238 | * ethtool Wake-on-LAN |
| 239 | */ |
| 240 | void (*get_wol)(struct dsa_switch *ds, int port, |
| 241 | struct ethtool_wolinfo *w); |
| 242 | int (*set_wol)(struct dsa_switch *ds, int port, |
| 243 | struct ethtool_wolinfo *w); |
| 244 | |
| 245 | /* |
Florian Fainelli | 2446254 | 2014-09-18 17:31:22 -0700 | [diff] [blame] | 246 | * Suspend and resume |
| 247 | */ |
| 248 | int (*suspend)(struct dsa_switch *ds); |
| 249 | int (*resume)(struct dsa_switch *ds); |
Florian Fainelli | b2f2af2 | 2014-09-24 17:05:18 -0700 | [diff] [blame] | 250 | |
| 251 | /* |
| 252 | * Port enable/disable |
| 253 | */ |
| 254 | int (*port_enable)(struct dsa_switch *ds, int port, |
| 255 | struct phy_device *phy); |
| 256 | void (*port_disable)(struct dsa_switch *ds, int port, |
| 257 | struct phy_device *phy); |
Florian Fainelli | 7905288 | 2014-09-24 17:05:21 -0700 | [diff] [blame] | 258 | |
| 259 | /* |
| 260 | * EEE setttings |
| 261 | */ |
| 262 | int (*set_eee)(struct dsa_switch *ds, int port, |
| 263 | struct phy_device *phydev, |
| 264 | struct ethtool_eee *e); |
| 265 | int (*get_eee)(struct dsa_switch *ds, int port, |
| 266 | struct ethtool_eee *e); |
Guenter Roeck | 51579c3 | 2014-10-29 10:44:58 -0700 | [diff] [blame] | 267 | |
| 268 | #ifdef CONFIG_NET_DSA_HWMON |
| 269 | /* Hardware monitoring */ |
| 270 | int (*get_temp)(struct dsa_switch *ds, int *temp); |
| 271 | int (*get_temp_limit)(struct dsa_switch *ds, int *temp); |
| 272 | int (*set_temp_limit)(struct dsa_switch *ds, int temp); |
| 273 | int (*get_temp_alarm)(struct dsa_switch *ds, bool *alarm); |
| 274 | #endif |
Guenter Roeck | 6793abb | 2014-10-29 10:45:01 -0700 | [diff] [blame] | 275 | |
| 276 | /* EEPROM access */ |
| 277 | int (*get_eeprom_len)(struct dsa_switch *ds); |
| 278 | int (*get_eeprom)(struct dsa_switch *ds, |
| 279 | struct ethtool_eeprom *eeprom, u8 *data); |
| 280 | int (*set_eeprom)(struct dsa_switch *ds, |
| 281 | struct ethtool_eeprom *eeprom, u8 *data); |
Guenter Roeck | 3d762a0 | 2014-10-29 10:45:04 -0700 | [diff] [blame] | 282 | |
| 283 | /* |
| 284 | * Register access. |
| 285 | */ |
| 286 | int (*get_regs_len)(struct dsa_switch *ds, int port); |
| 287 | void (*get_regs)(struct dsa_switch *ds, int port, |
| 288 | struct ethtool_regs *regs, void *p); |
Florian Fainelli | b73adef | 2015-02-24 13:15:33 -0800 | [diff] [blame] | 289 | |
| 290 | /* |
| 291 | * Bridge integration |
| 292 | */ |
| 293 | int (*port_join_bridge)(struct dsa_switch *ds, int port, |
| 294 | u32 br_port_mask); |
| 295 | int (*port_leave_bridge)(struct dsa_switch *ds, int port, |
| 296 | u32 br_port_mask); |
| 297 | int (*port_stp_update)(struct dsa_switch *ds, int port, |
| 298 | u8 state); |
Vivien Didelot | 2a778e1 | 2015-08-10 09:09:49 -0400 | [diff] [blame] | 299 | |
| 300 | /* |
Vivien Didelot | 1114953 | 2015-08-13 12:52:17 -0400 | [diff] [blame^] | 301 | * VLAN support |
| 302 | */ |
| 303 | int (*port_pvid_get)(struct dsa_switch *ds, int port, u16 *pvid); |
| 304 | int (*port_pvid_set)(struct dsa_switch *ds, int port, u16 pvid); |
| 305 | int (*port_vlan_add)(struct dsa_switch *ds, int port, u16 vid, |
| 306 | bool untagged); |
| 307 | int (*port_vlan_del)(struct dsa_switch *ds, int port, u16 vid); |
| 308 | int (*vlan_getnext)(struct dsa_switch *ds, u16 *vid, |
| 309 | unsigned long *ports, unsigned long *untagged); |
| 310 | |
| 311 | /* |
Vivien Didelot | 2a778e1 | 2015-08-10 09:09:49 -0400 | [diff] [blame] | 312 | * Forwarding database |
| 313 | */ |
| 314 | int (*port_fdb_add)(struct dsa_switch *ds, int port, |
| 315 | const unsigned char *addr, u16 vid); |
| 316 | int (*port_fdb_del)(struct dsa_switch *ds, int port, |
| 317 | const unsigned char *addr, u16 vid); |
| 318 | int (*port_fdb_getnext)(struct dsa_switch *ds, int port, |
| 319 | unsigned char *addr, u16 *vid, |
| 320 | bool *is_static); |
Ben Hutchings | c8f0b86 | 2011-11-27 17:06:08 +0000 | [diff] [blame] | 321 | }; |
| 322 | |
| 323 | void register_switch_driver(struct dsa_switch_driver *type); |
| 324 | void unregister_switch_driver(struct dsa_switch_driver *type); |
Alexander Duyck | b4d2394 | 2014-09-15 13:00:27 -0400 | [diff] [blame] | 325 | struct mii_bus *dsa_host_dev_to_mii_bus(struct device *dev); |
Ben Hutchings | c8f0b86 | 2011-11-27 17:06:08 +0000 | [diff] [blame] | 326 | |
Florian Fainelli | 7fa857e | 2014-04-28 11:14:27 -0700 | [diff] [blame] | 327 | static inline void *ds_to_priv(struct dsa_switch *ds) |
| 328 | { |
| 329 | return (void *)(ds + 1); |
| 330 | } |
| 331 | |
Florian Fainelli | 5aed85c | 2014-08-27 17:04:52 -0700 | [diff] [blame] | 332 | static inline bool dsa_uses_tagged_protocol(struct dsa_switch_tree *dst) |
| 333 | { |
Alexander Duyck | 5075314 | 2014-09-15 13:00:19 -0400 | [diff] [blame] | 334 | return dst->rcv != NULL; |
Florian Fainelli | 5aed85c | 2014-08-27 17:04:52 -0700 | [diff] [blame] | 335 | } |
Lennert Buytenhek | 91da11f | 2008-10-07 13:44:02 +0000 | [diff] [blame] | 336 | #endif |