Commit | Line | Data |
---|---|---|
91da11f8 LB |
1 | /* |
2 | * include/net/dsa.h - Driver for Distributed Switch Architecture switch chips | |
e84665c9 | 3 | * Copyright (c) 2008-2009 Marvell Semiconductor |
91da11f8 LB |
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 | ||
4d56a29f | 14 | #include <linux/if.h> |
ea1f51be | 15 | #include <linux/if_ether.h> |
c8f0b869 | 16 | #include <linux/list.h> |
f515f192 | 17 | #include <linux/notifier.h> |
cf50dcc2 BH |
18 | #include <linux/timer.h> |
19 | #include <linux/workqueue.h> | |
fa981d9a | 20 | #include <linux/of.h> |
a2820543 | 21 | #include <linux/ethtool.h> |
96567d5d | 22 | #include <net/devlink.h> |
f0c24ccf | 23 | #include <net/switchdev.h> |
cf50dcc2 | 24 | |
f50f2127 | 25 | struct tc_action; |
4d56a29f RK |
26 | struct phy_device; |
27 | struct fixed_phy_status; | |
f50f2127 | 28 | |
ac7a04c3 FF |
29 | enum dsa_tag_protocol { |
30 | DSA_TAG_PROTO_NONE = 0, | |
eb7b7211 | 31 | DSA_TAG_PROTO_BRCM, |
ac7a04c3 | 32 | DSA_TAG_PROTO_DSA, |
ac7a04c3 | 33 | DSA_TAG_PROTO_EDSA, |
8b8010fb | 34 | DSA_TAG_PROTO_KSZ, |
e8fe177a | 35 | DSA_TAG_PROTO_LAN9303, |
eb7b7211 AL |
36 | DSA_TAG_PROTO_MTK, |
37 | DSA_TAG_PROTO_QCA, | |
38 | DSA_TAG_PROTO_TRAILER, | |
39a7f2a4 | 39 | DSA_TAG_LAST, /* MUST BE LAST */ |
ac7a04c3 | 40 | }; |
5037d532 | 41 | |
e84665c9 LB |
42 | #define DSA_MAX_SWITCHES 4 |
43 | #define DSA_MAX_PORTS 12 | |
44 | ||
d390238c VD |
45 | #define DSA_RTABLE_NONE -1 |
46 | ||
e84665c9 LB |
47 | struct dsa_chip_data { |
48 | /* | |
49 | * How to access the switch configuration registers. | |
50 | */ | |
b4d2394d | 51 | struct device *host_dev; |
e84665c9 LB |
52 | int sw_addr; |
53 | ||
71e0bbde FF |
54 | /* |
55 | * Reference to network devices | |
56 | */ | |
57 | struct device *netdev[DSA_MAX_PORTS]; | |
58 | ||
6793abb4 GR |
59 | /* set to size of eeprom if supported by the switch */ |
60 | int eeprom_len; | |
61 | ||
fa981d9a FF |
62 | /* Device tree node pointer for this specific switch chip |
63 | * used during switch setup in case additional properties | |
64 | * and resources needs to be used | |
65 | */ | |
66 | struct device_node *of_node; | |
67 | ||
e84665c9 LB |
68 | /* |
69 | * The names of the switch's ports. Use "cpu" to | |
70 | * designate the switch port that the cpu is connected to, | |
71 | * "dsa" to indicate that this port is a DSA link to | |
72 | * another switch, NULL to indicate the port is unused, | |
73 | * or any other string to indicate this is a physical port. | |
74 | */ | |
75 | char *port_names[DSA_MAX_PORTS]; | |
bd47497a | 76 | struct device_node *port_dn[DSA_MAX_PORTS]; |
e84665c9 LB |
77 | |
78 | /* | |
4a7704ff AL |
79 | * An array of which element [a] indicates which port on this |
80 | * switch should be used to send packets to that are destined | |
81 | * for switch a. Can be NULL if there is only one switch chip. | |
e84665c9 | 82 | */ |
4a7704ff | 83 | s8 rtable[DSA_MAX_SWITCHES]; |
e84665c9 | 84 | }; |
91da11f8 LB |
85 | |
86 | struct dsa_platform_data { | |
87 | /* | |
88 | * Reference to a Linux network interface that connects | |
e84665c9 | 89 | * to the root switch chip of the tree. |
91da11f8 LB |
90 | */ |
91 | struct device *netdev; | |
769a0202 | 92 | struct net_device *of_netdev; |
91da11f8 LB |
93 | |
94 | /* | |
e84665c9 LB |
95 | * Info structs describing each of the switch chips |
96 | * connected via this network interface. | |
91da11f8 | 97 | */ |
e84665c9 LB |
98 | int nr_chips; |
99 | struct dsa_chip_data *chip; | |
91da11f8 LB |
100 | }; |
101 | ||
5075314e | 102 | struct packet_type; |
3e8a72d1 | 103 | |
cf50dcc2 | 104 | struct dsa_switch_tree { |
83c0afae AL |
105 | struct list_head list; |
106 | ||
f515f192 VD |
107 | /* Notifier chain for switch-wide events */ |
108 | struct raw_notifier_head nh; | |
109 | ||
83c0afae AL |
110 | /* Tree identifier */ |
111 | u32 tree; | |
112 | ||
113 | /* Number of switches attached to this tree */ | |
114 | struct kref refcount; | |
115 | ||
116 | /* Has this tree been applied to the hardware? */ | |
117 | bool applied; | |
118 | ||
cf50dcc2 BH |
119 | /* |
120 | * Configuration data for the platform device that owns | |
121 | * this dsa switch tree instance. | |
122 | */ | |
123 | struct dsa_platform_data *pd; | |
124 | ||
73a7ece8 | 125 | /* Copy of tag_ops->rcv for faster access in hot path */ |
a86d8bec | 126 | struct sk_buff * (*rcv)(struct sk_buff *skb, |
5075314e AD |
127 | struct net_device *dev, |
128 | struct packet_type *pt, | |
129 | struct net_device *orig_dev); | |
cf50dcc2 BH |
130 | |
131 | /* | |
8b0d3ea5 | 132 | * The switch port to which the CPU is attached. |
cf50dcc2 | 133 | */ |
8b0d3ea5 | 134 | struct dsa_port *cpu_dp; |
cf50dcc2 | 135 | |
cf50dcc2 BH |
136 | /* |
137 | * Data for the individual switch chips. | |
138 | */ | |
139 | struct dsa_switch *ds[DSA_MAX_SWITCHES]; | |
39a7f2a4 AL |
140 | |
141 | /* | |
142 | * Tagging protocol operations for adding and removing an | |
143 | * encapsulation tag. | |
144 | */ | |
145 | const struct dsa_device_ops *tag_ops; | |
cf50dcc2 BH |
146 | }; |
147 | ||
f50f2127 FF |
148 | /* TC matchall action types, only mirroring for now */ |
149 | enum dsa_port_mall_action_type { | |
150 | DSA_PORT_MALL_MIRROR, | |
151 | }; | |
152 | ||
153 | /* TC mirroring entry */ | |
154 | struct dsa_mall_mirror_tc_entry { | |
155 | u8 to_local_port; | |
156 | bool ingress; | |
157 | }; | |
158 | ||
159 | /* TC matchall entry */ | |
160 | struct dsa_mall_tc_entry { | |
161 | struct list_head list; | |
162 | unsigned long cookie; | |
163 | enum dsa_port_mall_action_type type; | |
164 | union { | |
165 | struct dsa_mall_mirror_tc_entry mirror; | |
166 | }; | |
167 | }; | |
168 | ||
169 | ||
c8b09808 | 170 | struct dsa_port { |
818be848 VD |
171 | struct dsa_switch *ds; |
172 | unsigned int index; | |
71e0bbde | 173 | const char *name; |
a29342e7 | 174 | struct dsa_port *cpu_dp; |
c8b09808 | 175 | struct net_device *netdev; |
189b0d93 | 176 | struct device_node *dn; |
34a79f63 | 177 | unsigned int ageing_time; |
732f794c | 178 | u8 stp_state; |
a5e9a02e | 179 | struct net_device *bridge_dev; |
96567d5d | 180 | struct devlink_port devlink_port; |
67dbb9d4 FF |
181 | /* |
182 | * Original copy of the master netdev ethtool_ops | |
183 | */ | |
184 | struct ethtool_ops ethtool_ops; | |
185 | const struct ethtool_ops *orig_ethtool_ops; | |
c8b09808 AL |
186 | }; |
187 | ||
c8f0b869 | 188 | struct dsa_switch { |
c33063d6 AL |
189 | struct device *dev; |
190 | ||
c8f0b869 BH |
191 | /* |
192 | * Parent switch tree, and switch index. | |
193 | */ | |
194 | struct dsa_switch_tree *dst; | |
195 | int index; | |
196 | ||
f515f192 VD |
197 | /* Listener for switch fabric events */ |
198 | struct notifier_block nb; | |
199 | ||
7543a6d5 AL |
200 | /* |
201 | * Give the switch driver somewhere to hang its private data | |
202 | * structure. | |
203 | */ | |
204 | void *priv; | |
205 | ||
c8f0b869 BH |
206 | /* |
207 | * Configuration data for this switch. | |
208 | */ | |
ff04955c | 209 | struct dsa_chip_data *cd; |
c8f0b869 BH |
210 | |
211 | /* | |
9d490b4e | 212 | * The switch operations. |
c8f0b869 | 213 | */ |
a82f67af | 214 | const struct dsa_switch_ops *ops; |
c8f0b869 | 215 | |
66472fc0 AL |
216 | /* |
217 | * An array of which element [a] indicates which port on this | |
218 | * switch should be used to send packets to that are destined | |
219 | * for switch a. Can be NULL if there is only one switch chip. | |
220 | */ | |
221 | s8 rtable[DSA_MAX_SWITCHES]; | |
222 | ||
c8f0b869 BH |
223 | /* |
224 | * Slave mii_bus and devices for the individual ports. | |
225 | */ | |
226 | u32 dsa_port_mask; | |
83c0afae | 227 | u32 cpu_port_mask; |
74c3e2a5 | 228 | u32 enabled_port_mask; |
0d8bcdd3 | 229 | u32 phys_mii_mask; |
c8f0b869 | 230 | struct mii_bus *slave_mii_bus; |
a0c02161 | 231 | |
0f3da6af VD |
232 | /* Ageing Time limits in msecs */ |
233 | unsigned int ageing_time_min; | |
234 | unsigned int ageing_time_max; | |
235 | ||
96567d5d AL |
236 | /* devlink used to represent this switch device */ |
237 | struct devlink *devlink; | |
238 | ||
a0c02161 VD |
239 | /* Dynamically allocated ports, keep last */ |
240 | size_t num_ports; | |
241 | struct dsa_port ports[]; | |
c8f0b869 BH |
242 | }; |
243 | ||
244 | static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p) | |
245 | { | |
14be36c2 | 246 | return !!(ds->cpu_port_mask & (1 << p)); |
c8f0b869 BH |
247 | } |
248 | ||
60045cbf AL |
249 | static inline bool dsa_is_dsa_port(struct dsa_switch *ds, int p) |
250 | { | |
251 | return !!((ds->dsa_port_mask) & (1 << p)); | |
252 | } | |
253 | ||
6cd456f3 VD |
254 | static inline bool dsa_is_normal_port(struct dsa_switch *ds, int p) |
255 | { | |
256 | return !dsa_is_cpu_port(ds, p) && !dsa_is_dsa_port(ds, p); | |
257 | } | |
258 | ||
c8f0b869 BH |
259 | static inline u8 dsa_upstream_port(struct dsa_switch *ds) |
260 | { | |
261 | struct dsa_switch_tree *dst = ds->dst; | |
262 | ||
263 | /* | |
264 | * If this is the root switch (i.e. the switch that connects | |
265 | * to the CPU), return the cpu port number on this switch. | |
266 | * Else return the (DSA) port number that connects to the | |
267 | * switch that is one hop closer to the cpu. | |
268 | */ | |
8b0d3ea5 VD |
269 | if (dst->cpu_dp->ds == ds) |
270 | return dst->cpu_dp->index; | |
c8f0b869 | 271 | else |
8b0d3ea5 | 272 | return ds->rtable[dst->cpu_dp->ds->index]; |
c8f0b869 BH |
273 | } |
274 | ||
9d490b4e | 275 | struct dsa_switch_ops { |
c8f0b869 | 276 | /* |
a6a71f19 | 277 | * Legacy probing. |
c8f0b869 | 278 | */ |
0209d144 VD |
279 | const char *(*probe)(struct device *dsa_dev, |
280 | struct device *host_dev, int sw_addr, | |
281 | void **priv); | |
7b314362 AL |
282 | |
283 | enum dsa_tag_protocol (*get_tag_protocol)(struct dsa_switch *ds); | |
284 | ||
c8f0b869 BH |
285 | int (*setup)(struct dsa_switch *ds); |
286 | int (*set_addr)(struct dsa_switch *ds, u8 *addr); | |
6819563e | 287 | u32 (*get_phy_flags)(struct dsa_switch *ds, int port); |
c8f0b869 BH |
288 | |
289 | /* | |
290 | * Access to the switch's PHY registers. | |
291 | */ | |
292 | int (*phy_read)(struct dsa_switch *ds, int port, int regnum); | |
293 | int (*phy_write)(struct dsa_switch *ds, int port, | |
294 | int regnum, u16 val); | |
295 | ||
ec9436ba FF |
296 | /* |
297 | * Link state adjustment (called from libphy) | |
298 | */ | |
299 | void (*adjust_link)(struct dsa_switch *ds, int port, | |
300 | struct phy_device *phydev); | |
ce31b31c FF |
301 | void (*fixed_link_update)(struct dsa_switch *ds, int port, |
302 | struct fixed_phy_status *st); | |
ec9436ba | 303 | |
c8f0b869 BH |
304 | /* |
305 | * ethtool hardware statistics. | |
306 | */ | |
307 | void (*get_strings)(struct dsa_switch *ds, int port, uint8_t *data); | |
308 | void (*get_ethtool_stats)(struct dsa_switch *ds, | |
309 | int port, uint64_t *data); | |
310 | int (*get_sset_count)(struct dsa_switch *ds); | |
24462549 | 311 | |
19e57c4e FF |
312 | /* |
313 | * ethtool Wake-on-LAN | |
314 | */ | |
315 | void (*get_wol)(struct dsa_switch *ds, int port, | |
316 | struct ethtool_wolinfo *w); | |
317 | int (*set_wol)(struct dsa_switch *ds, int port, | |
318 | struct ethtool_wolinfo *w); | |
319 | ||
24462549 FF |
320 | /* |
321 | * Suspend and resume | |
322 | */ | |
323 | int (*suspend)(struct dsa_switch *ds); | |
324 | int (*resume)(struct dsa_switch *ds); | |
b2f2af21 FF |
325 | |
326 | /* | |
327 | * Port enable/disable | |
328 | */ | |
329 | int (*port_enable)(struct dsa_switch *ds, int port, | |
330 | struct phy_device *phy); | |
331 | void (*port_disable)(struct dsa_switch *ds, int port, | |
332 | struct phy_device *phy); | |
7905288f FF |
333 | |
334 | /* | |
08f50061 | 335 | * Port's MAC EEE settings |
7905288f | 336 | */ |
08f50061 VD |
337 | int (*set_mac_eee)(struct dsa_switch *ds, int port, |
338 | struct ethtool_eee *e); | |
339 | int (*get_mac_eee)(struct dsa_switch *ds, int port, | |
340 | struct ethtool_eee *e); | |
51579c3f | 341 | |
6793abb4 GR |
342 | /* EEPROM access */ |
343 | int (*get_eeprom_len)(struct dsa_switch *ds); | |
344 | int (*get_eeprom)(struct dsa_switch *ds, | |
345 | struct ethtool_eeprom *eeprom, u8 *data); | |
346 | int (*set_eeprom)(struct dsa_switch *ds, | |
347 | struct ethtool_eeprom *eeprom, u8 *data); | |
3d762a0f GR |
348 | |
349 | /* | |
350 | * Register access. | |
351 | */ | |
352 | int (*get_regs_len)(struct dsa_switch *ds, int port); | |
353 | void (*get_regs)(struct dsa_switch *ds, int port, | |
354 | struct ethtool_regs *regs, void *p); | |
b73adef6 FF |
355 | |
356 | /* | |
357 | * Bridge integration | |
358 | */ | |
34a79f63 | 359 | int (*set_ageing_time)(struct dsa_switch *ds, unsigned int msecs); |
71327a4e | 360 | int (*port_bridge_join)(struct dsa_switch *ds, int port, |
a6692754 | 361 | struct net_device *bridge); |
f123f2fb VD |
362 | void (*port_bridge_leave)(struct dsa_switch *ds, int port, |
363 | struct net_device *bridge); | |
43c44a9f VD |
364 | void (*port_stp_state_set)(struct dsa_switch *ds, int port, |
365 | u8 state); | |
732f794c | 366 | void (*port_fast_age)(struct dsa_switch *ds, int port); |
2a778e1b | 367 | |
11149536 VD |
368 | /* |
369 | * VLAN support | |
370 | */ | |
fb2dabad VD |
371 | int (*port_vlan_filtering)(struct dsa_switch *ds, int port, |
372 | bool vlan_filtering); | |
76e398a6 VD |
373 | int (*port_vlan_prepare)(struct dsa_switch *ds, int port, |
374 | const struct switchdev_obj_port_vlan *vlan, | |
375 | struct switchdev_trans *trans); | |
4d5770b3 | 376 | void (*port_vlan_add)(struct dsa_switch *ds, int port, |
76e398a6 VD |
377 | const struct switchdev_obj_port_vlan *vlan, |
378 | struct switchdev_trans *trans); | |
379 | int (*port_vlan_del)(struct dsa_switch *ds, int port, | |
380 | const struct switchdev_obj_port_vlan *vlan); | |
2a778e1b VD |
381 | /* |
382 | * Forwarding database | |
383 | */ | |
1b6dd556 | 384 | int (*port_fdb_add)(struct dsa_switch *ds, int port, |
6c2c1dcb | 385 | const unsigned char *addr, u16 vid); |
2a778e1b | 386 | int (*port_fdb_del)(struct dsa_switch *ds, int port, |
6c2c1dcb | 387 | const unsigned char *addr, u16 vid); |
ea70ba98 VD |
388 | int (*port_fdb_dump)(struct dsa_switch *ds, int port, |
389 | struct switchdev_obj_port_fdb *fdb, | |
438ff537 | 390 | switchdev_obj_dump_cb_t *cb); |
8df30255 VD |
391 | |
392 | /* | |
393 | * Multicast database | |
394 | */ | |
395 | int (*port_mdb_prepare)(struct dsa_switch *ds, int port, | |
396 | const struct switchdev_obj_port_mdb *mdb, | |
397 | struct switchdev_trans *trans); | |
398 | void (*port_mdb_add)(struct dsa_switch *ds, int port, | |
399 | const struct switchdev_obj_port_mdb *mdb, | |
400 | struct switchdev_trans *trans); | |
401 | int (*port_mdb_del)(struct dsa_switch *ds, int port, | |
402 | const struct switchdev_obj_port_mdb *mdb); | |
bf9f2648 FF |
403 | /* |
404 | * RXNFC | |
405 | */ | |
406 | int (*get_rxnfc)(struct dsa_switch *ds, int port, | |
407 | struct ethtool_rxnfc *nfc, u32 *rule_locs); | |
408 | int (*set_rxnfc)(struct dsa_switch *ds, int port, | |
409 | struct ethtool_rxnfc *nfc); | |
f50f2127 FF |
410 | |
411 | /* | |
412 | * TC integration | |
413 | */ | |
414 | int (*port_mirror_add)(struct dsa_switch *ds, int port, | |
415 | struct dsa_mall_mirror_tc_entry *mirror, | |
416 | bool ingress); | |
417 | void (*port_mirror_del)(struct dsa_switch *ds, int port, | |
418 | struct dsa_mall_mirror_tc_entry *mirror); | |
40ef2c93 VD |
419 | |
420 | /* | |
421 | * Cross-chip operations | |
422 | */ | |
423 | int (*crosschip_bridge_join)(struct dsa_switch *ds, int sw_index, | |
424 | int port, struct net_device *br); | |
425 | void (*crosschip_bridge_leave)(struct dsa_switch *ds, int sw_index, | |
426 | int port, struct net_device *br); | |
c8f0b869 BH |
427 | }; |
428 | ||
ab3d408d FF |
429 | struct dsa_switch_driver { |
430 | struct list_head list; | |
a82f67af | 431 | const struct dsa_switch_ops *ops; |
ab3d408d FF |
432 | }; |
433 | ||
a6a71f19 | 434 | /* Legacy driver registration */ |
ab3d408d FF |
435 | void register_switch_driver(struct dsa_switch_driver *type); |
436 | void unregister_switch_driver(struct dsa_switch_driver *type); | |
b4d2394d | 437 | struct mii_bus *dsa_host_dev_to_mii_bus(struct device *dev); |
a6a71f19 | 438 | |
14b89f36 | 439 | struct net_device *dsa_dev_to_net_device(struct device *dev); |
c8f0b869 | 440 | |
73a7ece8 | 441 | /* Keep inline for faster access in hot path */ |
c6e970a0 AL |
442 | static inline bool netdev_uses_dsa(struct net_device *dev) |
443 | { | |
444 | #if IS_ENABLED(CONFIG_NET_DSA) | |
717ffbfb | 445 | return dev->dsa_ptr && dev->dsa_ptr->rcv; |
c6e970a0 AL |
446 | #endif |
447 | return false; | |
448 | } | |
449 | ||
a0c02161 | 450 | struct dsa_switch *dsa_switch_alloc(struct device *dev, size_t n); |
83c0afae | 451 | void dsa_unregister_switch(struct dsa_switch *ds); |
23c9ee49 | 452 | int dsa_register_switch(struct dsa_switch *ds); |
ea825e70 FF |
453 | #ifdef CONFIG_PM_SLEEP |
454 | int dsa_switch_suspend(struct dsa_switch *ds); | |
455 | int dsa_switch_resume(struct dsa_switch *ds); | |
456 | #else | |
457 | static inline int dsa_switch_suspend(struct dsa_switch *ds) | |
458 | { | |
459 | return 0; | |
460 | } | |
461 | static inline int dsa_switch_resume(struct dsa_switch *ds) | |
462 | { | |
463 | return 0; | |
464 | } | |
465 | #endif /* CONFIG_PM_SLEEP */ | |
466 | ||
91da11f8 | 467 | #endif |