Loading...
1/* SPDX-License-Identifier: GPL-2.0-or-later */
2/*
3 * include/net/dsa.h - Driver for Distributed Switch Architecture switch chips
4 * Copyright (c) 2008-2009 Marvell Semiconductor
5 */
6
7#ifndef __LINUX_NET_DSA_H
8#define __LINUX_NET_DSA_H
9
10#include <linux/if.h>
11#include <linux/if_ether.h>
12#include <linux/list.h>
13#include <linux/notifier.h>
14#include <linux/timer.h>
15#include <linux/workqueue.h>
16#include <linux/of.h>
17#include <linux/ethtool.h>
18#include <linux/net_tstamp.h>
19#include <linux/phy.h>
20#include <linux/platform_data/dsa.h>
21#include <linux/phylink.h>
22#include <net/devlink.h>
23#include <net/switchdev.h>
24
25struct dsa_8021q_context;
26struct tc_action;
27
28#define DSA_TAG_PROTO_NONE_VALUE 0
29#define DSA_TAG_PROTO_BRCM_VALUE 1
30#define DSA_TAG_PROTO_BRCM_PREPEND_VALUE 2
31#define DSA_TAG_PROTO_DSA_VALUE 3
32#define DSA_TAG_PROTO_EDSA_VALUE 4
33#define DSA_TAG_PROTO_GSWIP_VALUE 5
34#define DSA_TAG_PROTO_KSZ9477_VALUE 6
35#define DSA_TAG_PROTO_KSZ9893_VALUE 7
36#define DSA_TAG_PROTO_LAN9303_VALUE 8
37#define DSA_TAG_PROTO_MTK_VALUE 9
38#define DSA_TAG_PROTO_QCA_VALUE 10
39#define DSA_TAG_PROTO_TRAILER_VALUE 11
40#define DSA_TAG_PROTO_8021Q_VALUE 12
41#define DSA_TAG_PROTO_SJA1105_VALUE 13
42#define DSA_TAG_PROTO_KSZ8795_VALUE 14
43#define DSA_TAG_PROTO_OCELOT_VALUE 15
44#define DSA_TAG_PROTO_AR9331_VALUE 16
45#define DSA_TAG_PROTO_RTL4_A_VALUE 17
46#define DSA_TAG_PROTO_HELLCREEK_VALUE 18
47#define DSA_TAG_PROTO_XRS700X_VALUE 19
48#define DSA_TAG_PROTO_OCELOT_8021Q_VALUE 20
49#define DSA_TAG_PROTO_SEVILLE_VALUE 21
50#define DSA_TAG_PROTO_BRCM_LEGACY_VALUE 22
51#define DSA_TAG_PROTO_SJA1110_VALUE 23
52#define DSA_TAG_PROTO_RTL8_4_VALUE 24
53#define DSA_TAG_PROTO_RTL8_4T_VALUE 25
54#define DSA_TAG_PROTO_RZN1_A5PSW_VALUE 26
55#define DSA_TAG_PROTO_LAN937X_VALUE 27
56#define DSA_TAG_PROTO_VSC73XX_8021Q_VALUE 28
57
58enum dsa_tag_protocol {
59 DSA_TAG_PROTO_NONE = DSA_TAG_PROTO_NONE_VALUE,
60 DSA_TAG_PROTO_BRCM = DSA_TAG_PROTO_BRCM_VALUE,
61 DSA_TAG_PROTO_BRCM_LEGACY = DSA_TAG_PROTO_BRCM_LEGACY_VALUE,
62 DSA_TAG_PROTO_BRCM_PREPEND = DSA_TAG_PROTO_BRCM_PREPEND_VALUE,
63 DSA_TAG_PROTO_DSA = DSA_TAG_PROTO_DSA_VALUE,
64 DSA_TAG_PROTO_EDSA = DSA_TAG_PROTO_EDSA_VALUE,
65 DSA_TAG_PROTO_GSWIP = DSA_TAG_PROTO_GSWIP_VALUE,
66 DSA_TAG_PROTO_KSZ9477 = DSA_TAG_PROTO_KSZ9477_VALUE,
67 DSA_TAG_PROTO_KSZ9893 = DSA_TAG_PROTO_KSZ9893_VALUE,
68 DSA_TAG_PROTO_LAN9303 = DSA_TAG_PROTO_LAN9303_VALUE,
69 DSA_TAG_PROTO_MTK = DSA_TAG_PROTO_MTK_VALUE,
70 DSA_TAG_PROTO_QCA = DSA_TAG_PROTO_QCA_VALUE,
71 DSA_TAG_PROTO_TRAILER = DSA_TAG_PROTO_TRAILER_VALUE,
72 DSA_TAG_PROTO_8021Q = DSA_TAG_PROTO_8021Q_VALUE,
73 DSA_TAG_PROTO_SJA1105 = DSA_TAG_PROTO_SJA1105_VALUE,
74 DSA_TAG_PROTO_KSZ8795 = DSA_TAG_PROTO_KSZ8795_VALUE,
75 DSA_TAG_PROTO_OCELOT = DSA_TAG_PROTO_OCELOT_VALUE,
76 DSA_TAG_PROTO_AR9331 = DSA_TAG_PROTO_AR9331_VALUE,
77 DSA_TAG_PROTO_RTL4_A = DSA_TAG_PROTO_RTL4_A_VALUE,
78 DSA_TAG_PROTO_HELLCREEK = DSA_TAG_PROTO_HELLCREEK_VALUE,
79 DSA_TAG_PROTO_XRS700X = DSA_TAG_PROTO_XRS700X_VALUE,
80 DSA_TAG_PROTO_OCELOT_8021Q = DSA_TAG_PROTO_OCELOT_8021Q_VALUE,
81 DSA_TAG_PROTO_SEVILLE = DSA_TAG_PROTO_SEVILLE_VALUE,
82 DSA_TAG_PROTO_SJA1110 = DSA_TAG_PROTO_SJA1110_VALUE,
83 DSA_TAG_PROTO_RTL8_4 = DSA_TAG_PROTO_RTL8_4_VALUE,
84 DSA_TAG_PROTO_RTL8_4T = DSA_TAG_PROTO_RTL8_4T_VALUE,
85 DSA_TAG_PROTO_RZN1_A5PSW = DSA_TAG_PROTO_RZN1_A5PSW_VALUE,
86 DSA_TAG_PROTO_LAN937X = DSA_TAG_PROTO_LAN937X_VALUE,
87 DSA_TAG_PROTO_VSC73XX_8021Q = DSA_TAG_PROTO_VSC73XX_8021Q_VALUE,
88};
89
90struct dsa_switch;
91
92struct dsa_device_ops {
93 struct sk_buff *(*xmit)(struct sk_buff *skb, struct net_device *dev);
94 struct sk_buff *(*rcv)(struct sk_buff *skb, struct net_device *dev);
95 void (*flow_dissect)(const struct sk_buff *skb, __be16 *proto,
96 int *offset);
97 int (*connect)(struct dsa_switch *ds);
98 void (*disconnect)(struct dsa_switch *ds);
99 unsigned int needed_headroom;
100 unsigned int needed_tailroom;
101 const char *name;
102 enum dsa_tag_protocol proto;
103 /* Some tagging protocols either mangle or shift the destination MAC
104 * address, in which case the DSA conduit would drop packets on ingress
105 * if what it understands out of the destination MAC address is not in
106 * its RX filter.
107 */
108 bool promisc_on_conduit;
109};
110
111struct dsa_lag {
112 struct net_device *dev;
113 unsigned int id;
114 struct mutex fdb_lock;
115 struct list_head fdbs;
116 refcount_t refcount;
117};
118
119struct dsa_switch_tree {
120 struct list_head list;
121
122 /* List of switch ports */
123 struct list_head ports;
124
125 /* Notifier chain for switch-wide events */
126 struct raw_notifier_head nh;
127
128 /* Tree identifier */
129 unsigned int index;
130
131 /* Number of switches attached to this tree */
132 struct kref refcount;
133
134 /* Maps offloaded LAG netdevs to a zero-based linear ID for
135 * drivers that need it.
136 */
137 struct dsa_lag **lags;
138
139 /* Tagging protocol operations */
140 const struct dsa_device_ops *tag_ops;
141
142 /* Default tagging protocol preferred by the switches in this
143 * tree.
144 */
145 enum dsa_tag_protocol default_proto;
146
147 /* Has this tree been applied to the hardware? */
148 bool setup;
149
150 /*
151 * Configuration data for the platform device that owns
152 * this dsa switch tree instance.
153 */
154 struct dsa_platform_data *pd;
155
156 /* List of DSA links composing the routing table */
157 struct list_head rtable;
158
159 /* Length of "lags" array */
160 unsigned int lags_len;
161
162 /* Track the largest switch index within a tree */
163 unsigned int last_switch;
164};
165
166/* LAG IDs are one-based, the dst->lags array is zero-based */
167#define dsa_lags_foreach_id(_id, _dst) \
168 for ((_id) = 1; (_id) <= (_dst)->lags_len; (_id)++) \
169 if ((_dst)->lags[(_id) - 1])
170
171#define dsa_lag_foreach_port(_dp, _dst, _lag) \
172 list_for_each_entry((_dp), &(_dst)->ports, list) \
173 if (dsa_port_offloads_lag((_dp), (_lag)))
174
175#define dsa_hsr_foreach_port(_dp, _ds, _hsr) \
176 list_for_each_entry((_dp), &(_ds)->dst->ports, list) \
177 if ((_dp)->ds == (_ds) && (_dp)->hsr_dev == (_hsr))
178
179static inline struct dsa_lag *dsa_lag_by_id(struct dsa_switch_tree *dst,
180 unsigned int id)
181{
182 /* DSA LAG IDs are one-based, dst->lags is zero-based */
183 return dst->lags[id - 1];
184}
185
186static inline int dsa_lag_id(struct dsa_switch_tree *dst,
187 struct net_device *lag_dev)
188{
189 unsigned int id;
190
191 dsa_lags_foreach_id(id, dst) {
192 struct dsa_lag *lag = dsa_lag_by_id(dst, id);
193
194 if (lag->dev == lag_dev)
195 return lag->id;
196 }
197
198 return -ENODEV;
199}
200
201/* TC matchall action types */
202enum dsa_port_mall_action_type {
203 DSA_PORT_MALL_MIRROR,
204 DSA_PORT_MALL_POLICER,
205};
206
207/* TC mirroring entry */
208struct dsa_mall_mirror_tc_entry {
209 u8 to_local_port;
210 bool ingress;
211};
212
213/* TC port policer entry */
214struct dsa_mall_policer_tc_entry {
215 u32 burst;
216 u64 rate_bytes_per_sec;
217};
218
219/* TC matchall entry */
220struct dsa_mall_tc_entry {
221 struct list_head list;
222 unsigned long cookie;
223 enum dsa_port_mall_action_type type;
224 union {
225 struct dsa_mall_mirror_tc_entry mirror;
226 struct dsa_mall_policer_tc_entry policer;
227 };
228};
229
230struct dsa_bridge {
231 struct net_device *dev;
232 unsigned int num;
233 bool tx_fwd_offload;
234 refcount_t refcount;
235};
236
237struct dsa_port {
238 /* A CPU port is physically connected to a conduit device. A user port
239 * exposes a network device to user-space, called 'user' here.
240 */
241 union {
242 struct net_device *conduit;
243 struct net_device *user;
244 };
245
246 /* Copy of the tagging protocol operations, for quicker access
247 * in the data path. Valid only for the CPU ports.
248 */
249 const struct dsa_device_ops *tag_ops;
250
251 /* Copies for faster access in conduit receive hot path */
252 struct dsa_switch_tree *dst;
253 struct sk_buff *(*rcv)(struct sk_buff *skb, struct net_device *dev);
254
255 struct dsa_switch *ds;
256
257 unsigned int index;
258
259 enum {
260 DSA_PORT_TYPE_UNUSED = 0,
261 DSA_PORT_TYPE_CPU,
262 DSA_PORT_TYPE_DSA,
263 DSA_PORT_TYPE_USER,
264 } type;
265
266 const char *name;
267 struct dsa_port *cpu_dp;
268 u8 mac[ETH_ALEN];
269
270 u8 stp_state;
271
272 /* Warning: the following bit fields are not atomic, and updating them
273 * can only be done from code paths where concurrency is not possible
274 * (probe time or under rtnl_lock).
275 */
276 u8 vlan_filtering:1;
277
278 /* Managed by DSA on user ports and by drivers on CPU and DSA ports */
279 u8 learning:1;
280
281 u8 lag_tx_enabled:1;
282
283 /* conduit state bits, valid only on CPU ports */
284 u8 conduit_admin_up:1;
285 u8 conduit_oper_up:1;
286
287 /* Valid only on user ports */
288 u8 cpu_port_in_lag:1;
289
290 u8 setup:1;
291
292 struct device_node *dn;
293 unsigned int ageing_time;
294
295 struct dsa_bridge *bridge;
296 struct devlink_port devlink_port;
297 struct phylink *pl;
298 struct phylink_config pl_config;
299 struct dsa_lag *lag;
300 struct net_device *hsr_dev;
301
302 struct list_head list;
303
304 /*
305 * Original copy of the conduit netdev ethtool_ops
306 */
307 const struct ethtool_ops *orig_ethtool_ops;
308
309 /* List of MAC addresses that must be forwarded on this port.
310 * These are only valid on CPU ports and DSA links.
311 */
312 struct mutex addr_lists_lock;
313 struct list_head fdbs;
314 struct list_head mdbs;
315
316 struct mutex vlans_lock;
317 union {
318 /* List of VLANs that CPU and DSA ports are members of.
319 * Access to this is serialized by the sleepable @vlans_lock.
320 */
321 struct list_head vlans;
322 /* List of VLANs that user ports are members of.
323 * Access to this is serialized by netif_addr_lock_bh().
324 */
325 struct list_head user_vlans;
326 };
327};
328
329static inline struct dsa_port *
330dsa_phylink_to_port(struct phylink_config *config)
331{
332 return container_of(config, struct dsa_port, pl_config);
333}
334
335/* TODO: ideally DSA ports would have a single dp->link_dp member,
336 * and no dst->rtable nor this struct dsa_link would be needed,
337 * but this would require some more complex tree walking,
338 * so keep it stupid at the moment and list them all.
339 */
340struct dsa_link {
341 struct dsa_port *dp;
342 struct dsa_port *link_dp;
343 struct list_head list;
344};
345
346enum dsa_db_type {
347 DSA_DB_PORT,
348 DSA_DB_LAG,
349 DSA_DB_BRIDGE,
350};
351
352struct dsa_db {
353 enum dsa_db_type type;
354
355 union {
356 const struct dsa_port *dp;
357 struct dsa_lag lag;
358 struct dsa_bridge bridge;
359 };
360};
361
362struct dsa_mac_addr {
363 unsigned char addr[ETH_ALEN];
364 u16 vid;
365 refcount_t refcount;
366 struct list_head list;
367 struct dsa_db db;
368};
369
370struct dsa_vlan {
371 u16 vid;
372 refcount_t refcount;
373 struct list_head list;
374};
375
376struct dsa_switch {
377 struct device *dev;
378
379 /*
380 * Parent switch tree, and switch index.
381 */
382 struct dsa_switch_tree *dst;
383 unsigned int index;
384
385 /* Warning: the following bit fields are not atomic, and updating them
386 * can only be done from code paths where concurrency is not possible
387 * (probe time or under rtnl_lock).
388 */
389 u32 setup:1;
390
391 /* Disallow bridge core from requesting different VLAN awareness
392 * settings on ports if not hardware-supported
393 */
394 u32 vlan_filtering_is_global:1;
395
396 /* Keep VLAN filtering enabled on ports not offloading any upper */
397 u32 needs_standalone_vlan_filtering:1;
398
399 /* Pass .port_vlan_add and .port_vlan_del to drivers even for bridges
400 * that have vlan_filtering=0. All drivers should ideally set this (and
401 * then the option would get removed), but it is unknown whether this
402 * would break things or not.
403 */
404 u32 configure_vlan_while_not_filtering:1;
405
406 /* Pop the default_pvid of VLAN-unaware bridge ports from tagged frames.
407 * DEPRECATED: Do NOT set this field in new drivers. Instead look at
408 * the dsa_software_vlan_untag() comments.
409 */
410 u32 untag_bridge_pvid:1;
411 /* Pop the default_pvid of VLAN-aware bridge ports from tagged frames.
412 * Useful if the switch cannot preserve the VLAN tag as seen on the
413 * wire for user port ingress, and chooses to send all frames as
414 * VLAN-tagged to the CPU, including those which were originally
415 * untagged.
416 */
417 u32 untag_vlan_aware_bridge_pvid:1;
418
419 /* Let DSA manage the FDB entries towards the
420 * CPU, based on the software bridge database.
421 */
422 u32 assisted_learning_on_cpu_port:1;
423
424 /* In case vlan_filtering_is_global is set, the VLAN awareness state
425 * should be retrieved from here and not from the per-port settings.
426 */
427 u32 vlan_filtering:1;
428
429 /* For switches that only have the MRU configurable. To ensure the
430 * configured MTU is not exceeded, normalization of MRU on all bridged
431 * interfaces is needed.
432 */
433 u32 mtu_enforcement_ingress:1;
434
435 /* Drivers that isolate the FDBs of multiple bridges must set this
436 * to true to receive the bridge as an argument in .port_fdb_{add,del}
437 * and .port_mdb_{add,del}. Otherwise, the bridge.num will always be
438 * passed as zero.
439 */
440 u32 fdb_isolation:1;
441
442 /* Drivers that have global DSCP mapping settings must set this to
443 * true to automatically apply the settings to all ports.
444 */
445 u32 dscp_prio_mapping_is_global:1;
446
447 /* Listener for switch fabric events */
448 struct notifier_block nb;
449
450 /*
451 * Give the switch driver somewhere to hang its private data
452 * structure.
453 */
454 void *priv;
455
456 void *tagger_data;
457
458 /*
459 * Configuration data for this switch.
460 */
461 struct dsa_chip_data *cd;
462
463 /*
464 * The switch operations.
465 */
466 const struct dsa_switch_ops *ops;
467
468 /*
469 * Allow a DSA switch driver to override the phylink MAC ops
470 */
471 const struct phylink_mac_ops *phylink_mac_ops;
472
473 /*
474 * User mii_bus and devices for the individual ports.
475 */
476 u32 phys_mii_mask;
477 struct mii_bus *user_mii_bus;
478
479 /* Ageing Time limits in msecs */
480 unsigned int ageing_time_min;
481 unsigned int ageing_time_max;
482
483 /* Storage for drivers using tag_8021q */
484 struct dsa_8021q_context *tag_8021q_ctx;
485
486 /* devlink used to represent this switch device */
487 struct devlink *devlink;
488
489 /* Number of switch port queues */
490 unsigned int num_tx_queues;
491
492 /* Drivers that benefit from having an ID associated with each
493 * offloaded LAG should set this to the maximum number of
494 * supported IDs. DSA will then maintain a mapping of _at
495 * least_ these many IDs, accessible to drivers via
496 * dsa_lag_id().
497 */
498 unsigned int num_lag_ids;
499
500 /* Drivers that support bridge forwarding offload or FDB isolation
501 * should set this to the maximum number of bridges spanning the same
502 * switch tree (or all trees, in the case of cross-tree bridging
503 * support) that can be offloaded.
504 */
505 unsigned int max_num_bridges;
506
507 unsigned int num_ports;
508};
509
510static inline struct dsa_port *dsa_to_port(struct dsa_switch *ds, int p)
511{
512 struct dsa_switch_tree *dst = ds->dst;
513 struct dsa_port *dp;
514
515 list_for_each_entry(dp, &dst->ports, list)
516 if (dp->ds == ds && dp->index == p)
517 return dp;
518
519 return NULL;
520}
521
522static inline bool dsa_port_is_dsa(struct dsa_port *port)
523{
524 return port->type == DSA_PORT_TYPE_DSA;
525}
526
527static inline bool dsa_port_is_cpu(struct dsa_port *port)
528{
529 return port->type == DSA_PORT_TYPE_CPU;
530}
531
532static inline bool dsa_port_is_user(struct dsa_port *dp)
533{
534 return dp->type == DSA_PORT_TYPE_USER;
535}
536
537static inline bool dsa_port_is_unused(struct dsa_port *dp)
538{
539 return dp->type == DSA_PORT_TYPE_UNUSED;
540}
541
542static inline bool dsa_port_conduit_is_operational(struct dsa_port *dp)
543{
544 return dsa_port_is_cpu(dp) && dp->conduit_admin_up &&
545 dp->conduit_oper_up;
546}
547
548static inline bool dsa_is_unused_port(struct dsa_switch *ds, int p)
549{
550 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_UNUSED;
551}
552
553static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p)
554{
555 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_CPU;
556}
557
558static inline bool dsa_is_dsa_port(struct dsa_switch *ds, int p)
559{
560 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_DSA;
561}
562
563static inline bool dsa_is_user_port(struct dsa_switch *ds, int p)
564{
565 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_USER;
566}
567
568#define dsa_tree_for_each_user_port(_dp, _dst) \
569 list_for_each_entry((_dp), &(_dst)->ports, list) \
570 if (dsa_port_is_user((_dp)))
571
572#define dsa_tree_for_each_user_port_continue_reverse(_dp, _dst) \
573 list_for_each_entry_continue_reverse((_dp), &(_dst)->ports, list) \
574 if (dsa_port_is_user((_dp)))
575
576#define dsa_tree_for_each_cpu_port(_dp, _dst) \
577 list_for_each_entry((_dp), &(_dst)->ports, list) \
578 if (dsa_port_is_cpu((_dp)))
579
580#define dsa_switch_for_each_port(_dp, _ds) \
581 list_for_each_entry((_dp), &(_ds)->dst->ports, list) \
582 if ((_dp)->ds == (_ds))
583
584#define dsa_switch_for_each_port_safe(_dp, _next, _ds) \
585 list_for_each_entry_safe((_dp), (_next), &(_ds)->dst->ports, list) \
586 if ((_dp)->ds == (_ds))
587
588#define dsa_switch_for_each_port_continue_reverse(_dp, _ds) \
589 list_for_each_entry_continue_reverse((_dp), &(_ds)->dst->ports, list) \
590 if ((_dp)->ds == (_ds))
591
592#define dsa_switch_for_each_available_port(_dp, _ds) \
593 dsa_switch_for_each_port((_dp), (_ds)) \
594 if (!dsa_port_is_unused((_dp)))
595
596#define dsa_switch_for_each_user_port(_dp, _ds) \
597 dsa_switch_for_each_port((_dp), (_ds)) \
598 if (dsa_port_is_user((_dp)))
599
600#define dsa_switch_for_each_user_port_continue_reverse(_dp, _ds) \
601 dsa_switch_for_each_port_continue_reverse((_dp), (_ds)) \
602 if (dsa_port_is_user((_dp)))
603
604#define dsa_switch_for_each_cpu_port(_dp, _ds) \
605 dsa_switch_for_each_port((_dp), (_ds)) \
606 if (dsa_port_is_cpu((_dp)))
607
608#define dsa_switch_for_each_cpu_port_continue_reverse(_dp, _ds) \
609 dsa_switch_for_each_port_continue_reverse((_dp), (_ds)) \
610 if (dsa_port_is_cpu((_dp)))
611
612static inline u32 dsa_user_ports(struct dsa_switch *ds)
613{
614 struct dsa_port *dp;
615 u32 mask = 0;
616
617 dsa_switch_for_each_user_port(dp, ds)
618 mask |= BIT(dp->index);
619
620 return mask;
621}
622
623static inline u32 dsa_cpu_ports(struct dsa_switch *ds)
624{
625 struct dsa_port *cpu_dp;
626 u32 mask = 0;
627
628 dsa_switch_for_each_cpu_port(cpu_dp, ds)
629 mask |= BIT(cpu_dp->index);
630
631 return mask;
632}
633
634/* Return the local port used to reach an arbitrary switch device */
635static inline unsigned int dsa_routing_port(struct dsa_switch *ds, int device)
636{
637 struct dsa_switch_tree *dst = ds->dst;
638 struct dsa_link *dl;
639
640 list_for_each_entry(dl, &dst->rtable, list)
641 if (dl->dp->ds == ds && dl->link_dp->ds->index == device)
642 return dl->dp->index;
643
644 return ds->num_ports;
645}
646
647/* Return the local port used to reach an arbitrary switch port */
648static inline unsigned int dsa_towards_port(struct dsa_switch *ds, int device,
649 int port)
650{
651 if (device == ds->index)
652 return port;
653 else
654 return dsa_routing_port(ds, device);
655}
656
657/* Return the local port used to reach the dedicated CPU port */
658static inline unsigned int dsa_upstream_port(struct dsa_switch *ds, int port)
659{
660 const struct dsa_port *dp = dsa_to_port(ds, port);
661 const struct dsa_port *cpu_dp = dp->cpu_dp;
662
663 if (!cpu_dp)
664 return port;
665
666 return dsa_towards_port(ds, cpu_dp->ds->index, cpu_dp->index);
667}
668
669/* Return true if this is the local port used to reach the CPU port */
670static inline bool dsa_is_upstream_port(struct dsa_switch *ds, int port)
671{
672 if (dsa_is_unused_port(ds, port))
673 return false;
674
675 return port == dsa_upstream_port(ds, port);
676}
677
678/* Return true if this is a DSA port leading away from the CPU */
679static inline bool dsa_is_downstream_port(struct dsa_switch *ds, int port)
680{
681 return dsa_is_dsa_port(ds, port) && !dsa_is_upstream_port(ds, port);
682}
683
684/* Return the local port used to reach the CPU port */
685static inline unsigned int dsa_switch_upstream_port(struct dsa_switch *ds)
686{
687 struct dsa_port *dp;
688
689 dsa_switch_for_each_available_port(dp, ds) {
690 return dsa_upstream_port(ds, dp->index);
691 }
692
693 return ds->num_ports;
694}
695
696/* Return true if @upstream_ds is an upstream switch of @downstream_ds, meaning
697 * that the routing port from @downstream_ds to @upstream_ds is also the port
698 * which @downstream_ds uses to reach its dedicated CPU.
699 */
700static inline bool dsa_switch_is_upstream_of(struct dsa_switch *upstream_ds,
701 struct dsa_switch *downstream_ds)
702{
703 int routing_port;
704
705 if (upstream_ds == downstream_ds)
706 return true;
707
708 routing_port = dsa_routing_port(downstream_ds, upstream_ds->index);
709
710 return dsa_is_upstream_port(downstream_ds, routing_port);
711}
712
713static inline bool dsa_port_is_vlan_filtering(const struct dsa_port *dp)
714{
715 const struct dsa_switch *ds = dp->ds;
716
717 if (ds->vlan_filtering_is_global)
718 return ds->vlan_filtering;
719 else
720 return dp->vlan_filtering;
721}
722
723static inline unsigned int dsa_port_lag_id_get(struct dsa_port *dp)
724{
725 return dp->lag ? dp->lag->id : 0;
726}
727
728static inline struct net_device *dsa_port_lag_dev_get(struct dsa_port *dp)
729{
730 return dp->lag ? dp->lag->dev : NULL;
731}
732
733static inline bool dsa_port_offloads_lag(struct dsa_port *dp,
734 const struct dsa_lag *lag)
735{
736 return dsa_port_lag_dev_get(dp) == lag->dev;
737}
738
739static inline struct net_device *dsa_port_to_conduit(const struct dsa_port *dp)
740{
741 if (dp->cpu_port_in_lag)
742 return dsa_port_lag_dev_get(dp->cpu_dp);
743
744 return dp->cpu_dp->conduit;
745}
746
747static inline
748struct net_device *dsa_port_to_bridge_port(const struct dsa_port *dp)
749{
750 if (!dp->bridge)
751 return NULL;
752
753 if (dp->lag)
754 return dp->lag->dev;
755 else if (dp->hsr_dev)
756 return dp->hsr_dev;
757
758 return dp->user;
759}
760
761static inline struct net_device *
762dsa_port_bridge_dev_get(const struct dsa_port *dp)
763{
764 return dp->bridge ? dp->bridge->dev : NULL;
765}
766
767static inline unsigned int dsa_port_bridge_num_get(struct dsa_port *dp)
768{
769 return dp->bridge ? dp->bridge->num : 0;
770}
771
772static inline bool dsa_port_bridge_same(const struct dsa_port *a,
773 const struct dsa_port *b)
774{
775 struct net_device *br_a = dsa_port_bridge_dev_get(a);
776 struct net_device *br_b = dsa_port_bridge_dev_get(b);
777
778 /* Standalone ports are not in the same bridge with one another */
779 return (!br_a || !br_b) ? false : (br_a == br_b);
780}
781
782static inline bool dsa_port_offloads_bridge_port(struct dsa_port *dp,
783 const struct net_device *dev)
784{
785 return dsa_port_to_bridge_port(dp) == dev;
786}
787
788static inline bool
789dsa_port_offloads_bridge_dev(struct dsa_port *dp,
790 const struct net_device *bridge_dev)
791{
792 /* DSA ports connected to a bridge, and event was emitted
793 * for the bridge.
794 */
795 return dsa_port_bridge_dev_get(dp) == bridge_dev;
796}
797
798static inline bool dsa_port_offloads_bridge(struct dsa_port *dp,
799 const struct dsa_bridge *bridge)
800{
801 return dsa_port_bridge_dev_get(dp) == bridge->dev;
802}
803
804/* Returns true if any port of this tree offloads the given net_device */
805static inline bool dsa_tree_offloads_bridge_port(struct dsa_switch_tree *dst,
806 const struct net_device *dev)
807{
808 struct dsa_port *dp;
809
810 list_for_each_entry(dp, &dst->ports, list)
811 if (dsa_port_offloads_bridge_port(dp, dev))
812 return true;
813
814 return false;
815}
816
817/* Returns true if any port of this tree offloads the given bridge */
818static inline bool
819dsa_tree_offloads_bridge_dev(struct dsa_switch_tree *dst,
820 const struct net_device *bridge_dev)
821{
822 struct dsa_port *dp;
823
824 list_for_each_entry(dp, &dst->ports, list)
825 if (dsa_port_offloads_bridge_dev(dp, bridge_dev))
826 return true;
827
828 return false;
829}
830
831static inline bool dsa_port_tree_same(const struct dsa_port *a,
832 const struct dsa_port *b)
833{
834 return a->ds->dst == b->ds->dst;
835}
836
837typedef int dsa_fdb_dump_cb_t(const unsigned char *addr, u16 vid,
838 bool is_static, void *data);
839struct dsa_switch_ops {
840 /*
841 * Tagging protocol helpers called for the CPU ports and DSA links.
842 * @get_tag_protocol retrieves the initial tagging protocol and is
843 * mandatory. Switches which can operate using multiple tagging
844 * protocols should implement @change_tag_protocol and report in
845 * @get_tag_protocol the tagger in current use.
846 */
847 enum dsa_tag_protocol (*get_tag_protocol)(struct dsa_switch *ds,
848 int port,
849 enum dsa_tag_protocol mprot);
850 int (*change_tag_protocol)(struct dsa_switch *ds,
851 enum dsa_tag_protocol proto);
852 /*
853 * Method for switch drivers to connect to the tagging protocol driver
854 * in current use. The switch driver can provide handlers for certain
855 * types of packets for switch management.
856 */
857 int (*connect_tag_protocol)(struct dsa_switch *ds,
858 enum dsa_tag_protocol proto);
859
860 int (*port_change_conduit)(struct dsa_switch *ds, int port,
861 struct net_device *conduit,
862 struct netlink_ext_ack *extack);
863
864 /* Optional switch-wide initialization and destruction methods */
865 int (*setup)(struct dsa_switch *ds);
866 void (*teardown)(struct dsa_switch *ds);
867
868 /* Per-port initialization and destruction methods. Mandatory if the
869 * driver registers devlink port regions, optional otherwise.
870 */
871 int (*port_setup)(struct dsa_switch *ds, int port);
872 void (*port_teardown)(struct dsa_switch *ds, int port);
873
874 u32 (*get_phy_flags)(struct dsa_switch *ds, int port);
875
876 /*
877 * Access to the switch's PHY registers.
878 */
879 int (*phy_read)(struct dsa_switch *ds, int port, int regnum);
880 int (*phy_write)(struct dsa_switch *ds, int port,
881 int regnum, u16 val);
882
883 /*
884 * PHYLINK integration
885 */
886 void (*phylink_get_caps)(struct dsa_switch *ds, int port,
887 struct phylink_config *config);
888 void (*phylink_fixed_state)(struct dsa_switch *ds, int port,
889 struct phylink_link_state *state);
890 /*
891 * Port statistics counters.
892 */
893 void (*get_strings)(struct dsa_switch *ds, int port,
894 u32 stringset, uint8_t *data);
895 void (*get_ethtool_stats)(struct dsa_switch *ds,
896 int port, uint64_t *data);
897 int (*get_sset_count)(struct dsa_switch *ds, int port, int sset);
898 void (*get_ethtool_phy_stats)(struct dsa_switch *ds,
899 int port, uint64_t *data);
900 void (*get_eth_phy_stats)(struct dsa_switch *ds, int port,
901 struct ethtool_eth_phy_stats *phy_stats);
902 void (*get_eth_mac_stats)(struct dsa_switch *ds, int port,
903 struct ethtool_eth_mac_stats *mac_stats);
904 void (*get_eth_ctrl_stats)(struct dsa_switch *ds, int port,
905 struct ethtool_eth_ctrl_stats *ctrl_stats);
906 void (*get_rmon_stats)(struct dsa_switch *ds, int port,
907 struct ethtool_rmon_stats *rmon_stats,
908 const struct ethtool_rmon_hist_range **ranges);
909 void (*get_stats64)(struct dsa_switch *ds, int port,
910 struct rtnl_link_stats64 *s);
911 void (*get_pause_stats)(struct dsa_switch *ds, int port,
912 struct ethtool_pause_stats *pause_stats);
913 void (*self_test)(struct dsa_switch *ds, int port,
914 struct ethtool_test *etest, u64 *data);
915
916 /*
917 * ethtool Wake-on-LAN
918 */
919 void (*get_wol)(struct dsa_switch *ds, int port,
920 struct ethtool_wolinfo *w);
921 int (*set_wol)(struct dsa_switch *ds, int port,
922 struct ethtool_wolinfo *w);
923
924 /*
925 * ethtool timestamp info
926 */
927 int (*get_ts_info)(struct dsa_switch *ds, int port,
928 struct kernel_ethtool_ts_info *ts);
929
930 /*
931 * ethtool MAC merge layer
932 */
933 int (*get_mm)(struct dsa_switch *ds, int port,
934 struct ethtool_mm_state *state);
935 int (*set_mm)(struct dsa_switch *ds, int port,
936 struct ethtool_mm_cfg *cfg,
937 struct netlink_ext_ack *extack);
938 void (*get_mm_stats)(struct dsa_switch *ds, int port,
939 struct ethtool_mm_stats *stats);
940
941 /*
942 * DCB ops
943 */
944 int (*port_get_default_prio)(struct dsa_switch *ds, int port);
945 int (*port_set_default_prio)(struct dsa_switch *ds, int port,
946 u8 prio);
947 int (*port_get_dscp_prio)(struct dsa_switch *ds, int port, u8 dscp);
948 int (*port_add_dscp_prio)(struct dsa_switch *ds, int port, u8 dscp,
949 u8 prio);
950 int (*port_del_dscp_prio)(struct dsa_switch *ds, int port, u8 dscp,
951 u8 prio);
952 int (*port_set_apptrust)(struct dsa_switch *ds, int port,
953 const u8 *sel, int nsel);
954 int (*port_get_apptrust)(struct dsa_switch *ds, int port, u8 *sel,
955 int *nsel);
956
957 /*
958 * Suspend and resume
959 */
960 int (*suspend)(struct dsa_switch *ds);
961 int (*resume)(struct dsa_switch *ds);
962
963 /*
964 * Port enable/disable
965 */
966 int (*port_enable)(struct dsa_switch *ds, int port,
967 struct phy_device *phy);
968 void (*port_disable)(struct dsa_switch *ds, int port);
969
970
971 /*
972 * Notification for MAC address changes on user ports. Drivers can
973 * currently only veto operations. They should not use the method to
974 * program the hardware, since the operation is not rolled back in case
975 * of other errors.
976 */
977 int (*port_set_mac_address)(struct dsa_switch *ds, int port,
978 const unsigned char *addr);
979
980 /*
981 * Compatibility between device trees defining multiple CPU ports and
982 * drivers which are not OK to use by default the numerically smallest
983 * CPU port of a switch for its local ports. This can return NULL,
984 * meaning "don't know/don't care".
985 */
986 struct dsa_port *(*preferred_default_local_cpu_port)(struct dsa_switch *ds);
987
988 /*
989 * Port's MAC EEE settings
990 */
991 int (*set_mac_eee)(struct dsa_switch *ds, int port,
992 struct ethtool_keee *e);
993 int (*get_mac_eee)(struct dsa_switch *ds, int port,
994 struct ethtool_keee *e);
995
996 /* EEPROM access */
997 int (*get_eeprom_len)(struct dsa_switch *ds);
998 int (*get_eeprom)(struct dsa_switch *ds,
999 struct ethtool_eeprom *eeprom, u8 *data);
1000 int (*set_eeprom)(struct dsa_switch *ds,
1001 struct ethtool_eeprom *eeprom, u8 *data);
1002
1003 /*
1004 * Register access.
1005 */
1006 int (*get_regs_len)(struct dsa_switch *ds, int port);
1007 void (*get_regs)(struct dsa_switch *ds, int port,
1008 struct ethtool_regs *regs, void *p);
1009
1010 /*
1011 * Upper device tracking.
1012 */
1013 int (*port_prechangeupper)(struct dsa_switch *ds, int port,
1014 struct netdev_notifier_changeupper_info *info);
1015
1016 /*
1017 * Bridge integration
1018 */
1019 int (*set_ageing_time)(struct dsa_switch *ds, unsigned int msecs);
1020 int (*port_bridge_join)(struct dsa_switch *ds, int port,
1021 struct dsa_bridge bridge,
1022 bool *tx_fwd_offload,
1023 struct netlink_ext_ack *extack);
1024 void (*port_bridge_leave)(struct dsa_switch *ds, int port,
1025 struct dsa_bridge bridge);
1026 void (*port_stp_state_set)(struct dsa_switch *ds, int port,
1027 u8 state);
1028 int (*port_mst_state_set)(struct dsa_switch *ds, int port,
1029 const struct switchdev_mst_state *state);
1030 void (*port_fast_age)(struct dsa_switch *ds, int port);
1031 int (*port_vlan_fast_age)(struct dsa_switch *ds, int port, u16 vid);
1032 int (*port_pre_bridge_flags)(struct dsa_switch *ds, int port,
1033 struct switchdev_brport_flags flags,
1034 struct netlink_ext_ack *extack);
1035 int (*port_bridge_flags)(struct dsa_switch *ds, int port,
1036 struct switchdev_brport_flags flags,
1037 struct netlink_ext_ack *extack);
1038 void (*port_set_host_flood)(struct dsa_switch *ds, int port,
1039 bool uc, bool mc);
1040
1041 /*
1042 * VLAN support
1043 */
1044 int (*port_vlan_filtering)(struct dsa_switch *ds, int port,
1045 bool vlan_filtering,
1046 struct netlink_ext_ack *extack);
1047 int (*port_vlan_add)(struct dsa_switch *ds, int port,
1048 const struct switchdev_obj_port_vlan *vlan,
1049 struct netlink_ext_ack *extack);
1050 int (*port_vlan_del)(struct dsa_switch *ds, int port,
1051 const struct switchdev_obj_port_vlan *vlan);
1052 int (*vlan_msti_set)(struct dsa_switch *ds, struct dsa_bridge bridge,
1053 const struct switchdev_vlan_msti *msti);
1054
1055 /*
1056 * Forwarding database
1057 */
1058 int (*port_fdb_add)(struct dsa_switch *ds, int port,
1059 const unsigned char *addr, u16 vid,
1060 struct dsa_db db);
1061 int (*port_fdb_del)(struct dsa_switch *ds, int port,
1062 const unsigned char *addr, u16 vid,
1063 struct dsa_db db);
1064 int (*port_fdb_dump)(struct dsa_switch *ds, int port,
1065 dsa_fdb_dump_cb_t *cb, void *data);
1066 int (*lag_fdb_add)(struct dsa_switch *ds, struct dsa_lag lag,
1067 const unsigned char *addr, u16 vid,
1068 struct dsa_db db);
1069 int (*lag_fdb_del)(struct dsa_switch *ds, struct dsa_lag lag,
1070 const unsigned char *addr, u16 vid,
1071 struct dsa_db db);
1072
1073 /*
1074 * Multicast database
1075 */
1076 int (*port_mdb_add)(struct dsa_switch *ds, int port,
1077 const struct switchdev_obj_port_mdb *mdb,
1078 struct dsa_db db);
1079 int (*port_mdb_del)(struct dsa_switch *ds, int port,
1080 const struct switchdev_obj_port_mdb *mdb,
1081 struct dsa_db db);
1082 /*
1083 * RXNFC
1084 */
1085 int (*get_rxnfc)(struct dsa_switch *ds, int port,
1086 struct ethtool_rxnfc *nfc, u32 *rule_locs);
1087 int (*set_rxnfc)(struct dsa_switch *ds, int port,
1088 struct ethtool_rxnfc *nfc);
1089
1090 /*
1091 * TC integration
1092 */
1093 int (*cls_flower_add)(struct dsa_switch *ds, int port,
1094 struct flow_cls_offload *cls, bool ingress);
1095 int (*cls_flower_del)(struct dsa_switch *ds, int port,
1096 struct flow_cls_offload *cls, bool ingress);
1097 int (*cls_flower_stats)(struct dsa_switch *ds, int port,
1098 struct flow_cls_offload *cls, bool ingress);
1099 int (*port_mirror_add)(struct dsa_switch *ds, int port,
1100 struct dsa_mall_mirror_tc_entry *mirror,
1101 bool ingress, struct netlink_ext_ack *extack);
1102 void (*port_mirror_del)(struct dsa_switch *ds, int port,
1103 struct dsa_mall_mirror_tc_entry *mirror);
1104 int (*port_policer_add)(struct dsa_switch *ds, int port,
1105 struct dsa_mall_policer_tc_entry *policer);
1106 void (*port_policer_del)(struct dsa_switch *ds, int port);
1107 int (*port_setup_tc)(struct dsa_switch *ds, int port,
1108 enum tc_setup_type type, void *type_data);
1109
1110 /*
1111 * Cross-chip operations
1112 */
1113 int (*crosschip_bridge_join)(struct dsa_switch *ds, int tree_index,
1114 int sw_index, int port,
1115 struct dsa_bridge bridge,
1116 struct netlink_ext_ack *extack);
1117 void (*crosschip_bridge_leave)(struct dsa_switch *ds, int tree_index,
1118 int sw_index, int port,
1119 struct dsa_bridge bridge);
1120 int (*crosschip_lag_change)(struct dsa_switch *ds, int sw_index,
1121 int port);
1122 int (*crosschip_lag_join)(struct dsa_switch *ds, int sw_index,
1123 int port, struct dsa_lag lag,
1124 struct netdev_lag_upper_info *info,
1125 struct netlink_ext_ack *extack);
1126 int (*crosschip_lag_leave)(struct dsa_switch *ds, int sw_index,
1127 int port, struct dsa_lag lag);
1128
1129 /*
1130 * PTP functionality
1131 */
1132 int (*port_hwtstamp_get)(struct dsa_switch *ds, int port,
1133 struct ifreq *ifr);
1134 int (*port_hwtstamp_set)(struct dsa_switch *ds, int port,
1135 struct ifreq *ifr);
1136 void (*port_txtstamp)(struct dsa_switch *ds, int port,
1137 struct sk_buff *skb);
1138 bool (*port_rxtstamp)(struct dsa_switch *ds, int port,
1139 struct sk_buff *skb, unsigned int type);
1140
1141 /* Devlink parameters, etc */
1142 int (*devlink_param_get)(struct dsa_switch *ds, u32 id,
1143 struct devlink_param_gset_ctx *ctx);
1144 int (*devlink_param_set)(struct dsa_switch *ds, u32 id,
1145 struct devlink_param_gset_ctx *ctx);
1146 int (*devlink_info_get)(struct dsa_switch *ds,
1147 struct devlink_info_req *req,
1148 struct netlink_ext_ack *extack);
1149 int (*devlink_sb_pool_get)(struct dsa_switch *ds,
1150 unsigned int sb_index, u16 pool_index,
1151 struct devlink_sb_pool_info *pool_info);
1152 int (*devlink_sb_pool_set)(struct dsa_switch *ds, unsigned int sb_index,
1153 u16 pool_index, u32 size,
1154 enum devlink_sb_threshold_type threshold_type,
1155 struct netlink_ext_ack *extack);
1156 int (*devlink_sb_port_pool_get)(struct dsa_switch *ds, int port,
1157 unsigned int sb_index, u16 pool_index,
1158 u32 *p_threshold);
1159 int (*devlink_sb_port_pool_set)(struct dsa_switch *ds, int port,
1160 unsigned int sb_index, u16 pool_index,
1161 u32 threshold,
1162 struct netlink_ext_ack *extack);
1163 int (*devlink_sb_tc_pool_bind_get)(struct dsa_switch *ds, int port,
1164 unsigned int sb_index, u16 tc_index,
1165 enum devlink_sb_pool_type pool_type,
1166 u16 *p_pool_index, u32 *p_threshold);
1167 int (*devlink_sb_tc_pool_bind_set)(struct dsa_switch *ds, int port,
1168 unsigned int sb_index, u16 tc_index,
1169 enum devlink_sb_pool_type pool_type,
1170 u16 pool_index, u32 threshold,
1171 struct netlink_ext_ack *extack);
1172 int (*devlink_sb_occ_snapshot)(struct dsa_switch *ds,
1173 unsigned int sb_index);
1174 int (*devlink_sb_occ_max_clear)(struct dsa_switch *ds,
1175 unsigned int sb_index);
1176 int (*devlink_sb_occ_port_pool_get)(struct dsa_switch *ds, int port,
1177 unsigned int sb_index, u16 pool_index,
1178 u32 *p_cur, u32 *p_max);
1179 int (*devlink_sb_occ_tc_port_bind_get)(struct dsa_switch *ds, int port,
1180 unsigned int sb_index, u16 tc_index,
1181 enum devlink_sb_pool_type pool_type,
1182 u32 *p_cur, u32 *p_max);
1183
1184 /*
1185 * MTU change functionality. Switches can also adjust their MRU through
1186 * this method. By MTU, one understands the SDU (L2 payload) length.
1187 * If the switch needs to account for the DSA tag on the CPU port, this
1188 * method needs to do so privately.
1189 */
1190 int (*port_change_mtu)(struct dsa_switch *ds, int port,
1191 int new_mtu);
1192 int (*port_max_mtu)(struct dsa_switch *ds, int port);
1193
1194 /*
1195 * LAG integration
1196 */
1197 int (*port_lag_change)(struct dsa_switch *ds, int port);
1198 int (*port_lag_join)(struct dsa_switch *ds, int port,
1199 struct dsa_lag lag,
1200 struct netdev_lag_upper_info *info,
1201 struct netlink_ext_ack *extack);
1202 int (*port_lag_leave)(struct dsa_switch *ds, int port,
1203 struct dsa_lag lag);
1204
1205 /*
1206 * HSR integration
1207 */
1208 int (*port_hsr_join)(struct dsa_switch *ds, int port,
1209 struct net_device *hsr,
1210 struct netlink_ext_ack *extack);
1211 int (*port_hsr_leave)(struct dsa_switch *ds, int port,
1212 struct net_device *hsr);
1213
1214 /*
1215 * MRP integration
1216 */
1217 int (*port_mrp_add)(struct dsa_switch *ds, int port,
1218 const struct switchdev_obj_mrp *mrp);
1219 int (*port_mrp_del)(struct dsa_switch *ds, int port,
1220 const struct switchdev_obj_mrp *mrp);
1221 int (*port_mrp_add_ring_role)(struct dsa_switch *ds, int port,
1222 const struct switchdev_obj_ring_role_mrp *mrp);
1223 int (*port_mrp_del_ring_role)(struct dsa_switch *ds, int port,
1224 const struct switchdev_obj_ring_role_mrp *mrp);
1225
1226 /*
1227 * tag_8021q operations
1228 */
1229 int (*tag_8021q_vlan_add)(struct dsa_switch *ds, int port, u16 vid,
1230 u16 flags);
1231 int (*tag_8021q_vlan_del)(struct dsa_switch *ds, int port, u16 vid);
1232
1233 /*
1234 * DSA conduit tracking operations
1235 */
1236 void (*conduit_state_change)(struct dsa_switch *ds,
1237 const struct net_device *conduit,
1238 bool operational);
1239};
1240
1241#define DSA_DEVLINK_PARAM_DRIVER(_id, _name, _type, _cmodes) \
1242 DEVLINK_PARAM_DRIVER(_id, _name, _type, _cmodes, \
1243 dsa_devlink_param_get, dsa_devlink_param_set, NULL)
1244
1245int dsa_devlink_param_get(struct devlink *dl, u32 id,
1246 struct devlink_param_gset_ctx *ctx);
1247int dsa_devlink_param_set(struct devlink *dl, u32 id,
1248 struct devlink_param_gset_ctx *ctx,
1249 struct netlink_ext_ack *extack);
1250int dsa_devlink_params_register(struct dsa_switch *ds,
1251 const struct devlink_param *params,
1252 size_t params_count);
1253void dsa_devlink_params_unregister(struct dsa_switch *ds,
1254 const struct devlink_param *params,
1255 size_t params_count);
1256int dsa_devlink_resource_register(struct dsa_switch *ds,
1257 const char *resource_name,
1258 u64 resource_size,
1259 u64 resource_id,
1260 u64 parent_resource_id,
1261 const struct devlink_resource_size_params *size_params);
1262
1263void dsa_devlink_resources_unregister(struct dsa_switch *ds);
1264
1265void dsa_devlink_resource_occ_get_register(struct dsa_switch *ds,
1266 u64 resource_id,
1267 devlink_resource_occ_get_t *occ_get,
1268 void *occ_get_priv);
1269void dsa_devlink_resource_occ_get_unregister(struct dsa_switch *ds,
1270 u64 resource_id);
1271struct devlink_region *
1272dsa_devlink_region_create(struct dsa_switch *ds,
1273 const struct devlink_region_ops *ops,
1274 u32 region_max_snapshots, u64 region_size);
1275struct devlink_region *
1276dsa_devlink_port_region_create(struct dsa_switch *ds,
1277 int port,
1278 const struct devlink_port_region_ops *ops,
1279 u32 region_max_snapshots, u64 region_size);
1280void dsa_devlink_region_destroy(struct devlink_region *region);
1281
1282struct dsa_port *dsa_port_from_netdev(struct net_device *netdev);
1283
1284struct dsa_devlink_priv {
1285 struct dsa_switch *ds;
1286};
1287
1288static inline struct dsa_switch *dsa_devlink_to_ds(struct devlink *dl)
1289{
1290 struct dsa_devlink_priv *dl_priv = devlink_priv(dl);
1291
1292 return dl_priv->ds;
1293}
1294
1295static inline
1296struct dsa_switch *dsa_devlink_port_to_ds(struct devlink_port *port)
1297{
1298 struct devlink *dl = port->devlink;
1299 struct dsa_devlink_priv *dl_priv = devlink_priv(dl);
1300
1301 return dl_priv->ds;
1302}
1303
1304static inline int dsa_devlink_port_to_port(struct devlink_port *port)
1305{
1306 return port->index;
1307}
1308
1309struct dsa_switch_driver {
1310 struct list_head list;
1311 const struct dsa_switch_ops *ops;
1312};
1313
1314bool dsa_fdb_present_in_other_db(struct dsa_switch *ds, int port,
1315 const unsigned char *addr, u16 vid,
1316 struct dsa_db db);
1317bool dsa_mdb_present_in_other_db(struct dsa_switch *ds, int port,
1318 const struct switchdev_obj_port_mdb *mdb,
1319 struct dsa_db db);
1320
1321/* Keep inline for faster access in hot path */
1322static inline bool netdev_uses_dsa(const struct net_device *dev)
1323{
1324#if IS_ENABLED(CONFIG_NET_DSA)
1325 return dev->dsa_ptr && dev->dsa_ptr->rcv;
1326#endif
1327 return false;
1328}
1329
1330/* All DSA tags that push the EtherType to the right (basically all except tail
1331 * tags, which don't break dissection) can be treated the same from the
1332 * perspective of the flow dissector.
1333 *
1334 * We need to return:
1335 * - offset: the (B - A) difference between:
1336 * A. the position of the real EtherType and
1337 * B. the current skb->data (aka ETH_HLEN bytes into the frame, aka 2 bytes
1338 * after the normal EtherType was supposed to be)
1339 * The offset in bytes is exactly equal to the tagger overhead (and half of
1340 * that, in __be16 shorts).
1341 *
1342 * - proto: the value of the real EtherType.
1343 */
1344static inline void dsa_tag_generic_flow_dissect(const struct sk_buff *skb,
1345 __be16 *proto, int *offset)
1346{
1347#if IS_ENABLED(CONFIG_NET_DSA)
1348 const struct dsa_device_ops *ops = skb->dev->dsa_ptr->tag_ops;
1349 int tag_len = ops->needed_headroom;
1350
1351 *offset = tag_len;
1352 *proto = ((__be16 *)skb->data)[(tag_len / 2) - 1];
1353#endif
1354}
1355
1356void dsa_unregister_switch(struct dsa_switch *ds);
1357int dsa_register_switch(struct dsa_switch *ds);
1358void dsa_switch_shutdown(struct dsa_switch *ds);
1359struct dsa_switch *dsa_switch_find(int tree_index, int sw_index);
1360void dsa_flush_workqueue(void);
1361#ifdef CONFIG_PM_SLEEP
1362int dsa_switch_suspend(struct dsa_switch *ds);
1363int dsa_switch_resume(struct dsa_switch *ds);
1364#else
1365static inline int dsa_switch_suspend(struct dsa_switch *ds)
1366{
1367 return 0;
1368}
1369static inline int dsa_switch_resume(struct dsa_switch *ds)
1370{
1371 return 0;
1372}
1373#endif /* CONFIG_PM_SLEEP */
1374
1375#if IS_ENABLED(CONFIG_NET_DSA)
1376bool dsa_user_dev_check(const struct net_device *dev);
1377#else
1378static inline bool dsa_user_dev_check(const struct net_device *dev)
1379{
1380 return false;
1381}
1382#endif
1383
1384netdev_tx_t dsa_enqueue_skb(struct sk_buff *skb, struct net_device *dev);
1385void dsa_port_phylink_mac_change(struct dsa_switch *ds, int port, bool up);
1386
1387#endif
1/* SPDX-License-Identifier: GPL-2.0-or-later */
2/*
3 * include/net/dsa.h - Driver for Distributed Switch Architecture switch chips
4 * Copyright (c) 2008-2009 Marvell Semiconductor
5 */
6
7#ifndef __LINUX_NET_DSA_H
8#define __LINUX_NET_DSA_H
9
10#include <linux/if.h>
11#include <linux/if_ether.h>
12#include <linux/list.h>
13#include <linux/notifier.h>
14#include <linux/timer.h>
15#include <linux/workqueue.h>
16#include <linux/of.h>
17#include <linux/ethtool.h>
18#include <linux/net_tstamp.h>
19#include <linux/phy.h>
20#include <linux/platform_data/dsa.h>
21#include <linux/phylink.h>
22#include <net/devlink.h>
23#include <net/switchdev.h>
24
25struct tc_action;
26struct phy_device;
27struct fixed_phy_status;
28struct phylink_link_state;
29
30#define DSA_TAG_PROTO_NONE_VALUE 0
31#define DSA_TAG_PROTO_BRCM_VALUE 1
32#define DSA_TAG_PROTO_BRCM_PREPEND_VALUE 2
33#define DSA_TAG_PROTO_DSA_VALUE 3
34#define DSA_TAG_PROTO_EDSA_VALUE 4
35#define DSA_TAG_PROTO_GSWIP_VALUE 5
36#define DSA_TAG_PROTO_KSZ9477_VALUE 6
37#define DSA_TAG_PROTO_KSZ9893_VALUE 7
38#define DSA_TAG_PROTO_LAN9303_VALUE 8
39#define DSA_TAG_PROTO_MTK_VALUE 9
40#define DSA_TAG_PROTO_QCA_VALUE 10
41#define DSA_TAG_PROTO_TRAILER_VALUE 11
42#define DSA_TAG_PROTO_8021Q_VALUE 12
43#define DSA_TAG_PROTO_SJA1105_VALUE 13
44#define DSA_TAG_PROTO_KSZ8795_VALUE 14
45#define DSA_TAG_PROTO_OCELOT_VALUE 15
46#define DSA_TAG_PROTO_AR9331_VALUE 16
47#define DSA_TAG_PROTO_RTL4_A_VALUE 17
48
49enum dsa_tag_protocol {
50 DSA_TAG_PROTO_NONE = DSA_TAG_PROTO_NONE_VALUE,
51 DSA_TAG_PROTO_BRCM = DSA_TAG_PROTO_BRCM_VALUE,
52 DSA_TAG_PROTO_BRCM_PREPEND = DSA_TAG_PROTO_BRCM_PREPEND_VALUE,
53 DSA_TAG_PROTO_DSA = DSA_TAG_PROTO_DSA_VALUE,
54 DSA_TAG_PROTO_EDSA = DSA_TAG_PROTO_EDSA_VALUE,
55 DSA_TAG_PROTO_GSWIP = DSA_TAG_PROTO_GSWIP_VALUE,
56 DSA_TAG_PROTO_KSZ9477 = DSA_TAG_PROTO_KSZ9477_VALUE,
57 DSA_TAG_PROTO_KSZ9893 = DSA_TAG_PROTO_KSZ9893_VALUE,
58 DSA_TAG_PROTO_LAN9303 = DSA_TAG_PROTO_LAN9303_VALUE,
59 DSA_TAG_PROTO_MTK = DSA_TAG_PROTO_MTK_VALUE,
60 DSA_TAG_PROTO_QCA = DSA_TAG_PROTO_QCA_VALUE,
61 DSA_TAG_PROTO_TRAILER = DSA_TAG_PROTO_TRAILER_VALUE,
62 DSA_TAG_PROTO_8021Q = DSA_TAG_PROTO_8021Q_VALUE,
63 DSA_TAG_PROTO_SJA1105 = DSA_TAG_PROTO_SJA1105_VALUE,
64 DSA_TAG_PROTO_KSZ8795 = DSA_TAG_PROTO_KSZ8795_VALUE,
65 DSA_TAG_PROTO_OCELOT = DSA_TAG_PROTO_OCELOT_VALUE,
66 DSA_TAG_PROTO_AR9331 = DSA_TAG_PROTO_AR9331_VALUE,
67 DSA_TAG_PROTO_RTL4_A = DSA_TAG_PROTO_RTL4_A_VALUE,
68};
69
70struct packet_type;
71struct dsa_switch;
72
73struct dsa_device_ops {
74 struct sk_buff *(*xmit)(struct sk_buff *skb, struct net_device *dev);
75 struct sk_buff *(*rcv)(struct sk_buff *skb, struct net_device *dev,
76 struct packet_type *pt);
77 int (*flow_dissect)(const struct sk_buff *skb, __be16 *proto,
78 int *offset);
79 /* Used to determine which traffic should match the DSA filter in
80 * eth_type_trans, and which, if any, should bypass it and be processed
81 * as regular on the master net device.
82 */
83 bool (*filter)(const struct sk_buff *skb, struct net_device *dev);
84 unsigned int overhead;
85 const char *name;
86 enum dsa_tag_protocol proto;
87};
88
89/* This structure defines the control interfaces that are overlayed by the
90 * DSA layer on top of the DSA CPU/management net_device instance. This is
91 * used by the core net_device layer while calling various net_device_ops
92 * function pointers.
93 */
94struct dsa_netdevice_ops {
95 int (*ndo_do_ioctl)(struct net_device *dev, struct ifreq *ifr,
96 int cmd);
97};
98
99#define DSA_TAG_DRIVER_ALIAS "dsa_tag-"
100#define MODULE_ALIAS_DSA_TAG_DRIVER(__proto) \
101 MODULE_ALIAS(DSA_TAG_DRIVER_ALIAS __stringify(__proto##_VALUE))
102
103struct dsa_skb_cb {
104 struct sk_buff *clone;
105};
106
107struct __dsa_skb_cb {
108 struct dsa_skb_cb cb;
109 u8 priv[48 - sizeof(struct dsa_skb_cb)];
110};
111
112#define DSA_SKB_CB(skb) ((struct dsa_skb_cb *)((skb)->cb))
113
114#define DSA_SKB_CB_PRIV(skb) \
115 ((void *)(skb)->cb + offsetof(struct __dsa_skb_cb, priv))
116
117struct dsa_switch_tree {
118 struct list_head list;
119
120 /* Notifier chain for switch-wide events */
121 struct raw_notifier_head nh;
122
123 /* Tree identifier */
124 unsigned int index;
125
126 /* Number of switches attached to this tree */
127 struct kref refcount;
128
129 /* Has this tree been applied to the hardware? */
130 bool setup;
131
132 /*
133 * Configuration data for the platform device that owns
134 * this dsa switch tree instance.
135 */
136 struct dsa_platform_data *pd;
137
138 /* List of switch ports */
139 struct list_head ports;
140
141 /* List of DSA links composing the routing table */
142 struct list_head rtable;
143};
144
145/* TC matchall action types */
146enum dsa_port_mall_action_type {
147 DSA_PORT_MALL_MIRROR,
148 DSA_PORT_MALL_POLICER,
149};
150
151/* TC mirroring entry */
152struct dsa_mall_mirror_tc_entry {
153 u8 to_local_port;
154 bool ingress;
155};
156
157/* TC port policer entry */
158struct dsa_mall_policer_tc_entry {
159 u32 burst;
160 u64 rate_bytes_per_sec;
161};
162
163/* TC matchall entry */
164struct dsa_mall_tc_entry {
165 struct list_head list;
166 unsigned long cookie;
167 enum dsa_port_mall_action_type type;
168 union {
169 struct dsa_mall_mirror_tc_entry mirror;
170 struct dsa_mall_policer_tc_entry policer;
171 };
172};
173
174
175struct dsa_port {
176 /* A CPU port is physically connected to a master device.
177 * A user port exposed to userspace has a slave device.
178 */
179 union {
180 struct net_device *master;
181 struct net_device *slave;
182 };
183
184 /* CPU port tagging operations used by master or slave devices */
185 const struct dsa_device_ops *tag_ops;
186
187 /* Copies for faster access in master receive hot path */
188 struct dsa_switch_tree *dst;
189 struct sk_buff *(*rcv)(struct sk_buff *skb, struct net_device *dev,
190 struct packet_type *pt);
191 bool (*filter)(const struct sk_buff *skb, struct net_device *dev);
192
193 enum {
194 DSA_PORT_TYPE_UNUSED = 0,
195 DSA_PORT_TYPE_CPU,
196 DSA_PORT_TYPE_DSA,
197 DSA_PORT_TYPE_USER,
198 } type;
199
200 struct dsa_switch *ds;
201 unsigned int index;
202 const char *name;
203 struct dsa_port *cpu_dp;
204 const char *mac;
205 struct device_node *dn;
206 unsigned int ageing_time;
207 bool vlan_filtering;
208 u8 stp_state;
209 struct net_device *bridge_dev;
210 struct devlink_port devlink_port;
211 struct phylink *pl;
212 struct phylink_config pl_config;
213
214 struct list_head list;
215
216 /*
217 * Give the switch driver somewhere to hang its per-port private data
218 * structures (accessible from the tagger).
219 */
220 void *priv;
221
222 /*
223 * Original copy of the master netdev ethtool_ops
224 */
225 const struct ethtool_ops *orig_ethtool_ops;
226
227 /*
228 * Original copy of the master netdev net_device_ops
229 */
230 const struct dsa_netdevice_ops *netdev_ops;
231
232 bool setup;
233};
234
235/* TODO: ideally DSA ports would have a single dp->link_dp member,
236 * and no dst->rtable nor this struct dsa_link would be needed,
237 * but this would require some more complex tree walking,
238 * so keep it stupid at the moment and list them all.
239 */
240struct dsa_link {
241 struct dsa_port *dp;
242 struct dsa_port *link_dp;
243 struct list_head list;
244};
245
246struct dsa_switch {
247 bool setup;
248
249 struct device *dev;
250
251 /*
252 * Parent switch tree, and switch index.
253 */
254 struct dsa_switch_tree *dst;
255 unsigned int index;
256
257 /* Listener for switch fabric events */
258 struct notifier_block nb;
259
260 /*
261 * Give the switch driver somewhere to hang its private data
262 * structure.
263 */
264 void *priv;
265
266 /*
267 * Configuration data for this switch.
268 */
269 struct dsa_chip_data *cd;
270
271 /*
272 * The switch operations.
273 */
274 const struct dsa_switch_ops *ops;
275
276 /*
277 * Slave mii_bus and devices for the individual ports.
278 */
279 u32 phys_mii_mask;
280 struct mii_bus *slave_mii_bus;
281
282 /* Ageing Time limits in msecs */
283 unsigned int ageing_time_min;
284 unsigned int ageing_time_max;
285
286 /* devlink used to represent this switch device */
287 struct devlink *devlink;
288
289 /* Number of switch port queues */
290 unsigned int num_tx_queues;
291
292 /* Disallow bridge core from requesting different VLAN awareness
293 * settings on ports if not hardware-supported
294 */
295 bool vlan_filtering_is_global;
296
297 /* Pass .port_vlan_add and .port_vlan_del to drivers even for bridges
298 * that have vlan_filtering=0. All drivers should ideally set this (and
299 * then the option would get removed), but it is unknown whether this
300 * would break things or not.
301 */
302 bool configure_vlan_while_not_filtering;
303
304 /* In case vlan_filtering_is_global is set, the VLAN awareness state
305 * should be retrieved from here and not from the per-port settings.
306 */
307 bool vlan_filtering;
308
309 /* MAC PCS does not provide link state change interrupt, and requires
310 * polling. Flag passed on to PHYLINK.
311 */
312 bool pcs_poll;
313
314 /* For switches that only have the MRU configurable. To ensure the
315 * configured MTU is not exceeded, normalization of MRU on all bridged
316 * interfaces is needed.
317 */
318 bool mtu_enforcement_ingress;
319
320 size_t num_ports;
321};
322
323static inline struct dsa_port *dsa_to_port(struct dsa_switch *ds, int p)
324{
325 struct dsa_switch_tree *dst = ds->dst;
326 struct dsa_port *dp;
327
328 list_for_each_entry(dp, &dst->ports, list)
329 if (dp->ds == ds && dp->index == p)
330 return dp;
331
332 return NULL;
333}
334
335static inline bool dsa_is_unused_port(struct dsa_switch *ds, int p)
336{
337 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_UNUSED;
338}
339
340static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p)
341{
342 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_CPU;
343}
344
345static inline bool dsa_is_dsa_port(struct dsa_switch *ds, int p)
346{
347 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_DSA;
348}
349
350static inline bool dsa_is_user_port(struct dsa_switch *ds, int p)
351{
352 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_USER;
353}
354
355static inline u32 dsa_user_ports(struct dsa_switch *ds)
356{
357 u32 mask = 0;
358 int p;
359
360 for (p = 0; p < ds->num_ports; p++)
361 if (dsa_is_user_port(ds, p))
362 mask |= BIT(p);
363
364 return mask;
365}
366
367/* Return the local port used to reach an arbitrary switch device */
368static inline unsigned int dsa_routing_port(struct dsa_switch *ds, int device)
369{
370 struct dsa_switch_tree *dst = ds->dst;
371 struct dsa_link *dl;
372
373 list_for_each_entry(dl, &dst->rtable, list)
374 if (dl->dp->ds == ds && dl->link_dp->ds->index == device)
375 return dl->dp->index;
376
377 return ds->num_ports;
378}
379
380/* Return the local port used to reach an arbitrary switch port */
381static inline unsigned int dsa_towards_port(struct dsa_switch *ds, int device,
382 int port)
383{
384 if (device == ds->index)
385 return port;
386 else
387 return dsa_routing_port(ds, device);
388}
389
390/* Return the local port used to reach the dedicated CPU port */
391static inline unsigned int dsa_upstream_port(struct dsa_switch *ds, int port)
392{
393 const struct dsa_port *dp = dsa_to_port(ds, port);
394 const struct dsa_port *cpu_dp = dp->cpu_dp;
395
396 if (!cpu_dp)
397 return port;
398
399 return dsa_towards_port(ds, cpu_dp->ds->index, cpu_dp->index);
400}
401
402static inline bool dsa_port_is_vlan_filtering(const struct dsa_port *dp)
403{
404 const struct dsa_switch *ds = dp->ds;
405
406 if (ds->vlan_filtering_is_global)
407 return ds->vlan_filtering;
408 else
409 return dp->vlan_filtering;
410}
411
412typedef int dsa_fdb_dump_cb_t(const unsigned char *addr, u16 vid,
413 bool is_static, void *data);
414struct dsa_switch_ops {
415 enum dsa_tag_protocol (*get_tag_protocol)(struct dsa_switch *ds,
416 int port,
417 enum dsa_tag_protocol mprot);
418
419 int (*setup)(struct dsa_switch *ds);
420 void (*teardown)(struct dsa_switch *ds);
421 u32 (*get_phy_flags)(struct dsa_switch *ds, int port);
422
423 /*
424 * Access to the switch's PHY registers.
425 */
426 int (*phy_read)(struct dsa_switch *ds, int port, int regnum);
427 int (*phy_write)(struct dsa_switch *ds, int port,
428 int regnum, u16 val);
429
430 /*
431 * Link state adjustment (called from libphy)
432 */
433 void (*adjust_link)(struct dsa_switch *ds, int port,
434 struct phy_device *phydev);
435 void (*fixed_link_update)(struct dsa_switch *ds, int port,
436 struct fixed_phy_status *st);
437
438 /*
439 * PHYLINK integration
440 */
441 void (*phylink_validate)(struct dsa_switch *ds, int port,
442 unsigned long *supported,
443 struct phylink_link_state *state);
444 int (*phylink_mac_link_state)(struct dsa_switch *ds, int port,
445 struct phylink_link_state *state);
446 void (*phylink_mac_config)(struct dsa_switch *ds, int port,
447 unsigned int mode,
448 const struct phylink_link_state *state);
449 void (*phylink_mac_an_restart)(struct dsa_switch *ds, int port);
450 void (*phylink_mac_link_down)(struct dsa_switch *ds, int port,
451 unsigned int mode,
452 phy_interface_t interface);
453 void (*phylink_mac_link_up)(struct dsa_switch *ds, int port,
454 unsigned int mode,
455 phy_interface_t interface,
456 struct phy_device *phydev,
457 int speed, int duplex,
458 bool tx_pause, bool rx_pause);
459 void (*phylink_fixed_state)(struct dsa_switch *ds, int port,
460 struct phylink_link_state *state);
461 /*
462 * ethtool hardware statistics.
463 */
464 void (*get_strings)(struct dsa_switch *ds, int port,
465 u32 stringset, uint8_t *data);
466 void (*get_ethtool_stats)(struct dsa_switch *ds,
467 int port, uint64_t *data);
468 int (*get_sset_count)(struct dsa_switch *ds, int port, int sset);
469 void (*get_ethtool_phy_stats)(struct dsa_switch *ds,
470 int port, uint64_t *data);
471
472 /*
473 * ethtool Wake-on-LAN
474 */
475 void (*get_wol)(struct dsa_switch *ds, int port,
476 struct ethtool_wolinfo *w);
477 int (*set_wol)(struct dsa_switch *ds, int port,
478 struct ethtool_wolinfo *w);
479
480 /*
481 * ethtool timestamp info
482 */
483 int (*get_ts_info)(struct dsa_switch *ds, int port,
484 struct ethtool_ts_info *ts);
485
486 /*
487 * Suspend and resume
488 */
489 int (*suspend)(struct dsa_switch *ds);
490 int (*resume)(struct dsa_switch *ds);
491
492 /*
493 * Port enable/disable
494 */
495 int (*port_enable)(struct dsa_switch *ds, int port,
496 struct phy_device *phy);
497 void (*port_disable)(struct dsa_switch *ds, int port);
498
499 /*
500 * Port's MAC EEE settings
501 */
502 int (*set_mac_eee)(struct dsa_switch *ds, int port,
503 struct ethtool_eee *e);
504 int (*get_mac_eee)(struct dsa_switch *ds, int port,
505 struct ethtool_eee *e);
506
507 /* EEPROM access */
508 int (*get_eeprom_len)(struct dsa_switch *ds);
509 int (*get_eeprom)(struct dsa_switch *ds,
510 struct ethtool_eeprom *eeprom, u8 *data);
511 int (*set_eeprom)(struct dsa_switch *ds,
512 struct ethtool_eeprom *eeprom, u8 *data);
513
514 /*
515 * Register access.
516 */
517 int (*get_regs_len)(struct dsa_switch *ds, int port);
518 void (*get_regs)(struct dsa_switch *ds, int port,
519 struct ethtool_regs *regs, void *p);
520
521 /*
522 * Bridge integration
523 */
524 int (*set_ageing_time)(struct dsa_switch *ds, unsigned int msecs);
525 int (*port_bridge_join)(struct dsa_switch *ds, int port,
526 struct net_device *bridge);
527 void (*port_bridge_leave)(struct dsa_switch *ds, int port,
528 struct net_device *bridge);
529 void (*port_stp_state_set)(struct dsa_switch *ds, int port,
530 u8 state);
531 void (*port_fast_age)(struct dsa_switch *ds, int port);
532 int (*port_egress_floods)(struct dsa_switch *ds, int port,
533 bool unicast, bool multicast);
534
535 /*
536 * VLAN support
537 */
538 int (*port_vlan_filtering)(struct dsa_switch *ds, int port,
539 bool vlan_filtering);
540 int (*port_vlan_prepare)(struct dsa_switch *ds, int port,
541 const struct switchdev_obj_port_vlan *vlan);
542 void (*port_vlan_add)(struct dsa_switch *ds, int port,
543 const struct switchdev_obj_port_vlan *vlan);
544 int (*port_vlan_del)(struct dsa_switch *ds, int port,
545 const struct switchdev_obj_port_vlan *vlan);
546 /*
547 * Forwarding database
548 */
549 int (*port_fdb_add)(struct dsa_switch *ds, int port,
550 const unsigned char *addr, u16 vid);
551 int (*port_fdb_del)(struct dsa_switch *ds, int port,
552 const unsigned char *addr, u16 vid);
553 int (*port_fdb_dump)(struct dsa_switch *ds, int port,
554 dsa_fdb_dump_cb_t *cb, void *data);
555
556 /*
557 * Multicast database
558 */
559 int (*port_mdb_prepare)(struct dsa_switch *ds, int port,
560 const struct switchdev_obj_port_mdb *mdb);
561 void (*port_mdb_add)(struct dsa_switch *ds, int port,
562 const struct switchdev_obj_port_mdb *mdb);
563 int (*port_mdb_del)(struct dsa_switch *ds, int port,
564 const struct switchdev_obj_port_mdb *mdb);
565 /*
566 * RXNFC
567 */
568 int (*get_rxnfc)(struct dsa_switch *ds, int port,
569 struct ethtool_rxnfc *nfc, u32 *rule_locs);
570 int (*set_rxnfc)(struct dsa_switch *ds, int port,
571 struct ethtool_rxnfc *nfc);
572
573 /*
574 * TC integration
575 */
576 int (*cls_flower_add)(struct dsa_switch *ds, int port,
577 struct flow_cls_offload *cls, bool ingress);
578 int (*cls_flower_del)(struct dsa_switch *ds, int port,
579 struct flow_cls_offload *cls, bool ingress);
580 int (*cls_flower_stats)(struct dsa_switch *ds, int port,
581 struct flow_cls_offload *cls, bool ingress);
582 int (*port_mirror_add)(struct dsa_switch *ds, int port,
583 struct dsa_mall_mirror_tc_entry *mirror,
584 bool ingress);
585 void (*port_mirror_del)(struct dsa_switch *ds, int port,
586 struct dsa_mall_mirror_tc_entry *mirror);
587 int (*port_policer_add)(struct dsa_switch *ds, int port,
588 struct dsa_mall_policer_tc_entry *policer);
589 void (*port_policer_del)(struct dsa_switch *ds, int port);
590 int (*port_setup_tc)(struct dsa_switch *ds, int port,
591 enum tc_setup_type type, void *type_data);
592
593 /*
594 * Cross-chip operations
595 */
596 int (*crosschip_bridge_join)(struct dsa_switch *ds, int tree_index,
597 int sw_index, int port,
598 struct net_device *br);
599 void (*crosschip_bridge_leave)(struct dsa_switch *ds, int tree_index,
600 int sw_index, int port,
601 struct net_device *br);
602
603 /*
604 * PTP functionality
605 */
606 int (*port_hwtstamp_get)(struct dsa_switch *ds, int port,
607 struct ifreq *ifr);
608 int (*port_hwtstamp_set)(struct dsa_switch *ds, int port,
609 struct ifreq *ifr);
610 bool (*port_txtstamp)(struct dsa_switch *ds, int port,
611 struct sk_buff *clone, unsigned int type);
612 bool (*port_rxtstamp)(struct dsa_switch *ds, int port,
613 struct sk_buff *skb, unsigned int type);
614
615 /* Devlink parameters */
616 int (*devlink_param_get)(struct dsa_switch *ds, u32 id,
617 struct devlink_param_gset_ctx *ctx);
618 int (*devlink_param_set)(struct dsa_switch *ds, u32 id,
619 struct devlink_param_gset_ctx *ctx);
620
621 /*
622 * MTU change functionality. Switches can also adjust their MRU through
623 * this method. By MTU, one understands the SDU (L2 payload) length.
624 * If the switch needs to account for the DSA tag on the CPU port, this
625 * method needs to do so privately.
626 */
627 int (*port_change_mtu)(struct dsa_switch *ds, int port,
628 int new_mtu);
629 int (*port_max_mtu)(struct dsa_switch *ds, int port);
630};
631
632#define DSA_DEVLINK_PARAM_DRIVER(_id, _name, _type, _cmodes) \
633 DEVLINK_PARAM_DRIVER(_id, _name, _type, _cmodes, \
634 dsa_devlink_param_get, dsa_devlink_param_set, NULL)
635
636int dsa_devlink_param_get(struct devlink *dl, u32 id,
637 struct devlink_param_gset_ctx *ctx);
638int dsa_devlink_param_set(struct devlink *dl, u32 id,
639 struct devlink_param_gset_ctx *ctx);
640int dsa_devlink_params_register(struct dsa_switch *ds,
641 const struct devlink_param *params,
642 size_t params_count);
643void dsa_devlink_params_unregister(struct dsa_switch *ds,
644 const struct devlink_param *params,
645 size_t params_count);
646int dsa_devlink_resource_register(struct dsa_switch *ds,
647 const char *resource_name,
648 u64 resource_size,
649 u64 resource_id,
650 u64 parent_resource_id,
651 const struct devlink_resource_size_params *size_params);
652
653void dsa_devlink_resources_unregister(struct dsa_switch *ds);
654
655void dsa_devlink_resource_occ_get_register(struct dsa_switch *ds,
656 u64 resource_id,
657 devlink_resource_occ_get_t *occ_get,
658 void *occ_get_priv);
659void dsa_devlink_resource_occ_get_unregister(struct dsa_switch *ds,
660 u64 resource_id);
661struct dsa_port *dsa_port_from_netdev(struct net_device *netdev);
662
663struct dsa_devlink_priv {
664 struct dsa_switch *ds;
665};
666
667struct dsa_switch_driver {
668 struct list_head list;
669 const struct dsa_switch_ops *ops;
670};
671
672struct net_device *dsa_dev_to_net_device(struct device *dev);
673
674/* Keep inline for faster access in hot path */
675static inline bool netdev_uses_dsa(const struct net_device *dev)
676{
677#if IS_ENABLED(CONFIG_NET_DSA)
678 return dev->dsa_ptr && dev->dsa_ptr->rcv;
679#endif
680 return false;
681}
682
683static inline bool dsa_can_decode(const struct sk_buff *skb,
684 struct net_device *dev)
685{
686#if IS_ENABLED(CONFIG_NET_DSA)
687 return !dev->dsa_ptr->filter || dev->dsa_ptr->filter(skb, dev);
688#endif
689 return false;
690}
691
692#if IS_ENABLED(CONFIG_NET_DSA)
693static inline int __dsa_netdevice_ops_check(struct net_device *dev)
694{
695 int err = -EOPNOTSUPP;
696
697 if (!dev->dsa_ptr)
698 return err;
699
700 if (!dev->dsa_ptr->netdev_ops)
701 return err;
702
703 return 0;
704}
705
706static inline int dsa_ndo_do_ioctl(struct net_device *dev, struct ifreq *ifr,
707 int cmd)
708{
709 const struct dsa_netdevice_ops *ops;
710 int err;
711
712 err = __dsa_netdevice_ops_check(dev);
713 if (err)
714 return err;
715
716 ops = dev->dsa_ptr->netdev_ops;
717
718 return ops->ndo_do_ioctl(dev, ifr, cmd);
719}
720#else
721static inline int dsa_ndo_do_ioctl(struct net_device *dev, struct ifreq *ifr,
722 int cmd)
723{
724 return -EOPNOTSUPP;
725}
726#endif
727
728void dsa_unregister_switch(struct dsa_switch *ds);
729int dsa_register_switch(struct dsa_switch *ds);
730struct dsa_switch *dsa_switch_find(int tree_index, int sw_index);
731#ifdef CONFIG_PM_SLEEP
732int dsa_switch_suspend(struct dsa_switch *ds);
733int dsa_switch_resume(struct dsa_switch *ds);
734#else
735static inline int dsa_switch_suspend(struct dsa_switch *ds)
736{
737 return 0;
738}
739static inline int dsa_switch_resume(struct dsa_switch *ds)
740{
741 return 0;
742}
743#endif /* CONFIG_PM_SLEEP */
744
745enum dsa_notifier_type {
746 DSA_PORT_REGISTER,
747 DSA_PORT_UNREGISTER,
748};
749
750struct dsa_notifier_info {
751 struct net_device *dev;
752};
753
754struct dsa_notifier_register_info {
755 struct dsa_notifier_info info; /* must be first */
756 struct net_device *master;
757 unsigned int port_number;
758 unsigned int switch_number;
759};
760
761static inline struct net_device *
762dsa_notifier_info_to_dev(const struct dsa_notifier_info *info)
763{
764 return info->dev;
765}
766
767#if IS_ENABLED(CONFIG_NET_DSA)
768int register_dsa_notifier(struct notifier_block *nb);
769int unregister_dsa_notifier(struct notifier_block *nb);
770int call_dsa_notifiers(unsigned long val, struct net_device *dev,
771 struct dsa_notifier_info *info);
772#else
773static inline int register_dsa_notifier(struct notifier_block *nb)
774{
775 return 0;
776}
777
778static inline int unregister_dsa_notifier(struct notifier_block *nb)
779{
780 return 0;
781}
782
783static inline int call_dsa_notifiers(unsigned long val, struct net_device *dev,
784 struct dsa_notifier_info *info)
785{
786 return NOTIFY_DONE;
787}
788#endif
789
790/* Broadcom tag specific helpers to insert and extract queue/port number */
791#define BRCM_TAG_SET_PORT_QUEUE(p, q) ((p) << 8 | q)
792#define BRCM_TAG_GET_PORT(v) ((v) >> 8)
793#define BRCM_TAG_GET_QUEUE(v) ((v) & 0xff)
794
795
796netdev_tx_t dsa_enqueue_skb(struct sk_buff *skb, struct net_device *dev);
797int dsa_port_get_phy_strings(struct dsa_port *dp, uint8_t *data);
798int dsa_port_get_ethtool_phy_stats(struct dsa_port *dp, uint64_t *data);
799int dsa_port_get_phy_sset_count(struct dsa_port *dp);
800void dsa_port_phylink_mac_change(struct dsa_switch *ds, int port, bool up);
801
802struct dsa_tag_driver {
803 const struct dsa_device_ops *ops;
804 struct list_head list;
805 struct module *owner;
806};
807
808void dsa_tag_drivers_register(struct dsa_tag_driver *dsa_tag_driver_array[],
809 unsigned int count,
810 struct module *owner);
811void dsa_tag_drivers_unregister(struct dsa_tag_driver *dsa_tag_driver_array[],
812 unsigned int count);
813
814#define dsa_tag_driver_module_drivers(__dsa_tag_drivers_array, __count) \
815static int __init dsa_tag_driver_module_init(void) \
816{ \
817 dsa_tag_drivers_register(__dsa_tag_drivers_array, __count, \
818 THIS_MODULE); \
819 return 0; \
820} \
821module_init(dsa_tag_driver_module_init); \
822 \
823static void __exit dsa_tag_driver_module_exit(void) \
824{ \
825 dsa_tag_drivers_unregister(__dsa_tag_drivers_array, __count); \
826} \
827module_exit(dsa_tag_driver_module_exit)
828
829/**
830 * module_dsa_tag_drivers() - Helper macro for registering DSA tag
831 * drivers
832 * @__ops_array: Array of tag driver strucutres
833 *
834 * Helper macro for DSA tag drivers which do not do anything special
835 * in module init/exit. Each module may only use this macro once, and
836 * calling it replaces module_init() and module_exit().
837 */
838#define module_dsa_tag_drivers(__ops_array) \
839dsa_tag_driver_module_drivers(__ops_array, ARRAY_SIZE(__ops_array))
840
841#define DSA_TAG_DRIVER_NAME(__ops) dsa_tag_driver ## _ ## __ops
842
843/* Create a static structure we can build a linked list of dsa_tag
844 * drivers
845 */
846#define DSA_TAG_DRIVER(__ops) \
847static struct dsa_tag_driver DSA_TAG_DRIVER_NAME(__ops) = { \
848 .ops = &__ops, \
849}
850
851/**
852 * module_dsa_tag_driver() - Helper macro for registering a single DSA tag
853 * driver
854 * @__ops: Single tag driver structures
855 *
856 * Helper macro for DSA tag drivers which do not do anything special
857 * in module init/exit. Each module may only use this macro once, and
858 * calling it replaces module_init() and module_exit().
859 */
860#define module_dsa_tag_driver(__ops) \
861DSA_TAG_DRIVER(__ops); \
862 \
863static struct dsa_tag_driver *dsa_tag_driver_array[] = { \
864 &DSA_TAG_DRIVER_NAME(__ops) \
865}; \
866module_dsa_tag_drivers(dsa_tag_driver_array)
867#endif
868