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 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
46enum dsa_tag_protocol {
47 DSA_TAG_PROTO_NONE = DSA_TAG_PROTO_NONE_VALUE,
48 DSA_TAG_PROTO_BRCM = DSA_TAG_PROTO_BRCM_VALUE,
49 DSA_TAG_PROTO_BRCM_PREPEND = DSA_TAG_PROTO_BRCM_PREPEND_VALUE,
50 DSA_TAG_PROTO_DSA = DSA_TAG_PROTO_DSA_VALUE,
51 DSA_TAG_PROTO_EDSA = DSA_TAG_PROTO_EDSA_VALUE,
52 DSA_TAG_PROTO_GSWIP = DSA_TAG_PROTO_GSWIP_VALUE,
53 DSA_TAG_PROTO_KSZ9477 = DSA_TAG_PROTO_KSZ9477_VALUE,
54 DSA_TAG_PROTO_KSZ9893 = DSA_TAG_PROTO_KSZ9893_VALUE,
55 DSA_TAG_PROTO_LAN9303 = DSA_TAG_PROTO_LAN9303_VALUE,
56 DSA_TAG_PROTO_MTK = DSA_TAG_PROTO_MTK_VALUE,
57 DSA_TAG_PROTO_QCA = DSA_TAG_PROTO_QCA_VALUE,
58 DSA_TAG_PROTO_TRAILER = DSA_TAG_PROTO_TRAILER_VALUE,
59 DSA_TAG_PROTO_8021Q = DSA_TAG_PROTO_8021Q_VALUE,
60 DSA_TAG_PROTO_SJA1105 = DSA_TAG_PROTO_SJA1105_VALUE,
61 DSA_TAG_PROTO_KSZ8795 = DSA_TAG_PROTO_KSZ8795_VALUE,
62};
63
64struct packet_type;
65struct dsa_switch;
66
67struct dsa_device_ops {
68 struct sk_buff *(*xmit)(struct sk_buff *skb, struct net_device *dev);
69 struct sk_buff *(*rcv)(struct sk_buff *skb, struct net_device *dev,
70 struct packet_type *pt);
71 int (*flow_dissect)(const struct sk_buff *skb, __be16 *proto,
72 int *offset);
73 /* Used to determine which traffic should match the DSA filter in
74 * eth_type_trans, and which, if any, should bypass it and be processed
75 * as regular on the master net device.
76 */
77 bool (*filter)(const struct sk_buff *skb, struct net_device *dev);
78 unsigned int overhead;
79 const char *name;
80 enum dsa_tag_protocol proto;
81};
82
83#define DSA_TAG_DRIVER_ALIAS "dsa_tag-"
84#define MODULE_ALIAS_DSA_TAG_DRIVER(__proto) \
85 MODULE_ALIAS(DSA_TAG_DRIVER_ALIAS __stringify(__proto##_VALUE))
86
87struct dsa_skb_cb {
88 struct sk_buff *clone;
89 bool deferred_xmit;
90};
91
92struct __dsa_skb_cb {
93 struct dsa_skb_cb cb;
94 u8 priv[48 - sizeof(struct dsa_skb_cb)];
95};
96
97#define __DSA_SKB_CB(skb) ((struct __dsa_skb_cb *)((skb)->cb))
98
99#define DSA_SKB_CB(skb) ((struct dsa_skb_cb *)((skb)->cb))
100
101#define DSA_SKB_CB_PRIV(skb) \
102 ((void *)(skb)->cb + offsetof(struct __dsa_skb_cb, priv))
103
104struct dsa_switch_tree {
105 struct list_head list;
106
107 /* Notifier chain for switch-wide events */
108 struct raw_notifier_head nh;
109
110 /* Tree identifier */
111 unsigned int index;
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 setup;
118
119 /*
120 * Configuration data for the platform device that owns
121 * this dsa switch tree instance.
122 */
123 struct dsa_platform_data *pd;
124
125 /*
126 * The switch port to which the CPU is attached.
127 */
128 struct dsa_port *cpu_dp;
129
130 /*
131 * Data for the individual switch chips.
132 */
133 struct dsa_switch *ds[DSA_MAX_SWITCHES];
134};
135
136/* TC matchall action types, only mirroring for now */
137enum dsa_port_mall_action_type {
138 DSA_PORT_MALL_MIRROR,
139};
140
141/* TC mirroring entry */
142struct dsa_mall_mirror_tc_entry {
143 u8 to_local_port;
144 bool ingress;
145};
146
147/* TC matchall entry */
148struct dsa_mall_tc_entry {
149 struct list_head list;
150 unsigned long cookie;
151 enum dsa_port_mall_action_type type;
152 union {
153 struct dsa_mall_mirror_tc_entry mirror;
154 };
155};
156
157
158struct dsa_port {
159 /* A CPU port is physically connected to a master device.
160 * A user port exposed to userspace has a slave device.
161 */
162 union {
163 struct net_device *master;
164 struct net_device *slave;
165 };
166
167 /* CPU port tagging operations used by master or slave devices */
168 const struct dsa_device_ops *tag_ops;
169
170 /* Copies for faster access in master receive hot path */
171 struct dsa_switch_tree *dst;
172 struct sk_buff *(*rcv)(struct sk_buff *skb, struct net_device *dev,
173 struct packet_type *pt);
174 bool (*filter)(const struct sk_buff *skb, struct net_device *dev);
175
176 enum {
177 DSA_PORT_TYPE_UNUSED = 0,
178 DSA_PORT_TYPE_CPU,
179 DSA_PORT_TYPE_DSA,
180 DSA_PORT_TYPE_USER,
181 } type;
182
183 struct dsa_switch *ds;
184 unsigned int index;
185 const char *name;
186 struct dsa_port *cpu_dp;
187 const char *mac;
188 struct device_node *dn;
189 unsigned int ageing_time;
190 bool vlan_filtering;
191 u8 stp_state;
192 struct net_device *bridge_dev;
193 struct devlink_port devlink_port;
194 struct phylink *pl;
195 struct phylink_config pl_config;
196
197 struct work_struct xmit_work;
198 struct sk_buff_head xmit_queue;
199
200 /*
201 * Give the switch driver somewhere to hang its per-port private data
202 * structures (accessible from the tagger).
203 */
204 void *priv;
205
206 /*
207 * Original copy of the master netdev ethtool_ops
208 */
209 const struct ethtool_ops *orig_ethtool_ops;
210
211 /*
212 * Original copy of the master netdev net_device_ops
213 */
214 const struct net_device_ops *orig_ndo_ops;
215};
216
217struct dsa_switch {
218 struct device *dev;
219
220 /*
221 * Parent switch tree, and switch index.
222 */
223 struct dsa_switch_tree *dst;
224 unsigned int index;
225
226 /* Listener for switch fabric events */
227 struct notifier_block nb;
228
229 /*
230 * Give the switch driver somewhere to hang its private data
231 * structure.
232 */
233 void *priv;
234
235 /*
236 * Configuration data for this switch.
237 */
238 struct dsa_chip_data *cd;
239
240 /*
241 * The switch operations.
242 */
243 const struct dsa_switch_ops *ops;
244
245 /*
246 * An array of which element [a] indicates which port on this
247 * switch should be used to send packets to that are destined
248 * for switch a. Can be NULL if there is only one switch chip.
249 */
250 s8 rtable[DSA_MAX_SWITCHES];
251
252 /*
253 * Slave mii_bus and devices for the individual ports.
254 */
255 u32 phys_mii_mask;
256 struct mii_bus *slave_mii_bus;
257
258 /* Ageing Time limits in msecs */
259 unsigned int ageing_time_min;
260 unsigned int ageing_time_max;
261
262 /* devlink used to represent this switch device */
263 struct devlink *devlink;
264
265 /* Number of switch port queues */
266 unsigned int num_tx_queues;
267
268 /* Disallow bridge core from requesting different VLAN awareness
269 * settings on ports if not hardware-supported
270 */
271 bool vlan_filtering_is_global;
272
273 /* In case vlan_filtering_is_global is set, the VLAN awareness state
274 * should be retrieved from here and not from the per-port settings.
275 */
276 bool vlan_filtering;
277
278 /* Dynamically allocated ports, keep last */
279 size_t num_ports;
280 struct dsa_port ports[];
281};
282
283static inline const struct dsa_port *dsa_to_port(struct dsa_switch *ds, int p)
284{
285 return &ds->ports[p];
286}
287
288static inline bool dsa_is_unused_port(struct dsa_switch *ds, int p)
289{
290 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_UNUSED;
291}
292
293static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p)
294{
295 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_CPU;
296}
297
298static inline bool dsa_is_dsa_port(struct dsa_switch *ds, int p)
299{
300 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_DSA;
301}
302
303static inline bool dsa_is_user_port(struct dsa_switch *ds, int p)
304{
305 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_USER;
306}
307
308static inline u32 dsa_user_ports(struct dsa_switch *ds)
309{
310 u32 mask = 0;
311 int p;
312
313 for (p = 0; p < ds->num_ports; p++)
314 if (dsa_is_user_port(ds, p))
315 mask |= BIT(p);
316
317 return mask;
318}
319
320/* Return the local port used to reach an arbitrary switch port */
321static inline unsigned int dsa_towards_port(struct dsa_switch *ds, int device,
322 int port)
323{
324 if (device == ds->index)
325 return port;
326 else
327 return ds->rtable[device];
328}
329
330/* Return the local port used to reach the dedicated CPU port */
331static inline unsigned int dsa_upstream_port(struct dsa_switch *ds, int port)
332{
333 const struct dsa_port *dp = dsa_to_port(ds, port);
334 const struct dsa_port *cpu_dp = dp->cpu_dp;
335
336 if (!cpu_dp)
337 return port;
338
339 return dsa_towards_port(ds, cpu_dp->ds->index, cpu_dp->index);
340}
341
342static inline bool dsa_port_is_vlan_filtering(const struct dsa_port *dp)
343{
344 const struct dsa_switch *ds = dp->ds;
345
346 if (ds->vlan_filtering_is_global)
347 return ds->vlan_filtering;
348 else
349 return dp->vlan_filtering;
350}
351
352typedef int dsa_fdb_dump_cb_t(const unsigned char *addr, u16 vid,
353 bool is_static, void *data);
354struct dsa_switch_ops {
355 enum dsa_tag_protocol (*get_tag_protocol)(struct dsa_switch *ds,
356 int port);
357
358 int (*setup)(struct dsa_switch *ds);
359 void (*teardown)(struct dsa_switch *ds);
360 u32 (*get_phy_flags)(struct dsa_switch *ds, int port);
361
362 /*
363 * Access to the switch's PHY registers.
364 */
365 int (*phy_read)(struct dsa_switch *ds, int port, int regnum);
366 int (*phy_write)(struct dsa_switch *ds, int port,
367 int regnum, u16 val);
368
369 /*
370 * Link state adjustment (called from libphy)
371 */
372 void (*adjust_link)(struct dsa_switch *ds, int port,
373 struct phy_device *phydev);
374 void (*fixed_link_update)(struct dsa_switch *ds, int port,
375 struct fixed_phy_status *st);
376
377 /*
378 * PHYLINK integration
379 */
380 void (*phylink_validate)(struct dsa_switch *ds, int port,
381 unsigned long *supported,
382 struct phylink_link_state *state);
383 int (*phylink_mac_link_state)(struct dsa_switch *ds, int port,
384 struct phylink_link_state *state);
385 void (*phylink_mac_config)(struct dsa_switch *ds, int port,
386 unsigned int mode,
387 const struct phylink_link_state *state);
388 void (*phylink_mac_an_restart)(struct dsa_switch *ds, int port);
389 void (*phylink_mac_link_down)(struct dsa_switch *ds, int port,
390 unsigned int mode,
391 phy_interface_t interface);
392 void (*phylink_mac_link_up)(struct dsa_switch *ds, int port,
393 unsigned int mode,
394 phy_interface_t interface,
395 struct phy_device *phydev);
396 void (*phylink_fixed_state)(struct dsa_switch *ds, int port,
397 struct phylink_link_state *state);
398 /*
399 * ethtool hardware statistics.
400 */
401 void (*get_strings)(struct dsa_switch *ds, int port,
402 u32 stringset, uint8_t *data);
403 void (*get_ethtool_stats)(struct dsa_switch *ds,
404 int port, uint64_t *data);
405 int (*get_sset_count)(struct dsa_switch *ds, int port, int sset);
406 void (*get_ethtool_phy_stats)(struct dsa_switch *ds,
407 int port, uint64_t *data);
408
409 /*
410 * ethtool Wake-on-LAN
411 */
412 void (*get_wol)(struct dsa_switch *ds, int port,
413 struct ethtool_wolinfo *w);
414 int (*set_wol)(struct dsa_switch *ds, int port,
415 struct ethtool_wolinfo *w);
416
417 /*
418 * ethtool timestamp info
419 */
420 int (*get_ts_info)(struct dsa_switch *ds, int port,
421 struct ethtool_ts_info *ts);
422
423 /*
424 * Suspend and resume
425 */
426 int (*suspend)(struct dsa_switch *ds);
427 int (*resume)(struct dsa_switch *ds);
428
429 /*
430 * Port enable/disable
431 */
432 int (*port_enable)(struct dsa_switch *ds, int port,
433 struct phy_device *phy);
434 void (*port_disable)(struct dsa_switch *ds, int port);
435
436 /*
437 * Port's MAC EEE settings
438 */
439 int (*set_mac_eee)(struct dsa_switch *ds, int port,
440 struct ethtool_eee *e);
441 int (*get_mac_eee)(struct dsa_switch *ds, int port,
442 struct ethtool_eee *e);
443
444 /* EEPROM access */
445 int (*get_eeprom_len)(struct dsa_switch *ds);
446 int (*get_eeprom)(struct dsa_switch *ds,
447 struct ethtool_eeprom *eeprom, u8 *data);
448 int (*set_eeprom)(struct dsa_switch *ds,
449 struct ethtool_eeprom *eeprom, u8 *data);
450
451 /*
452 * Register access.
453 */
454 int (*get_regs_len)(struct dsa_switch *ds, int port);
455 void (*get_regs)(struct dsa_switch *ds, int port,
456 struct ethtool_regs *regs, void *p);
457
458 /*
459 * Bridge integration
460 */
461 int (*set_ageing_time)(struct dsa_switch *ds, unsigned int msecs);
462 int (*port_bridge_join)(struct dsa_switch *ds, int port,
463 struct net_device *bridge);
464 void (*port_bridge_leave)(struct dsa_switch *ds, int port,
465 struct net_device *bridge);
466 void (*port_stp_state_set)(struct dsa_switch *ds, int port,
467 u8 state);
468 void (*port_fast_age)(struct dsa_switch *ds, int port);
469 int (*port_egress_floods)(struct dsa_switch *ds, int port,
470 bool unicast, bool multicast);
471
472 /*
473 * VLAN support
474 */
475 int (*port_vlan_filtering)(struct dsa_switch *ds, int port,
476 bool vlan_filtering);
477 int (*port_vlan_prepare)(struct dsa_switch *ds, int port,
478 const struct switchdev_obj_port_vlan *vlan);
479 void (*port_vlan_add)(struct dsa_switch *ds, int port,
480 const struct switchdev_obj_port_vlan *vlan);
481 int (*port_vlan_del)(struct dsa_switch *ds, int port,
482 const struct switchdev_obj_port_vlan *vlan);
483 /*
484 * Forwarding database
485 */
486 int (*port_fdb_add)(struct dsa_switch *ds, int port,
487 const unsigned char *addr, u16 vid);
488 int (*port_fdb_del)(struct dsa_switch *ds, int port,
489 const unsigned char *addr, u16 vid);
490 int (*port_fdb_dump)(struct dsa_switch *ds, int port,
491 dsa_fdb_dump_cb_t *cb, void *data);
492
493 /*
494 * Multicast database
495 */
496 int (*port_mdb_prepare)(struct dsa_switch *ds, int port,
497 const struct switchdev_obj_port_mdb *mdb);
498 void (*port_mdb_add)(struct dsa_switch *ds, int port,
499 const struct switchdev_obj_port_mdb *mdb);
500 int (*port_mdb_del)(struct dsa_switch *ds, int port,
501 const struct switchdev_obj_port_mdb *mdb);
502 /*
503 * RXNFC
504 */
505 int (*get_rxnfc)(struct dsa_switch *ds, int port,
506 struct ethtool_rxnfc *nfc, u32 *rule_locs);
507 int (*set_rxnfc)(struct dsa_switch *ds, int port,
508 struct ethtool_rxnfc *nfc);
509
510 /*
511 * TC integration
512 */
513 int (*port_mirror_add)(struct dsa_switch *ds, int port,
514 struct dsa_mall_mirror_tc_entry *mirror,
515 bool ingress);
516 void (*port_mirror_del)(struct dsa_switch *ds, int port,
517 struct dsa_mall_mirror_tc_entry *mirror);
518 int (*port_setup_tc)(struct dsa_switch *ds, int port,
519 enum tc_setup_type type, void *type_data);
520
521 /*
522 * Cross-chip operations
523 */
524 int (*crosschip_bridge_join)(struct dsa_switch *ds, int sw_index,
525 int port, struct net_device *br);
526 void (*crosschip_bridge_leave)(struct dsa_switch *ds, int sw_index,
527 int port, struct net_device *br);
528
529 /*
530 * PTP functionality
531 */
532 int (*port_hwtstamp_get)(struct dsa_switch *ds, int port,
533 struct ifreq *ifr);
534 int (*port_hwtstamp_set)(struct dsa_switch *ds, int port,
535 struct ifreq *ifr);
536 bool (*port_txtstamp)(struct dsa_switch *ds, int port,
537 struct sk_buff *clone, unsigned int type);
538 bool (*port_rxtstamp)(struct dsa_switch *ds, int port,
539 struct sk_buff *skb, unsigned int type);
540
541 /*
542 * Deferred frame Tx
543 */
544 netdev_tx_t (*port_deferred_xmit)(struct dsa_switch *ds, int port,
545 struct sk_buff *skb);
546};
547
548struct dsa_switch_driver {
549 struct list_head list;
550 const struct dsa_switch_ops *ops;
551};
552
553struct net_device *dsa_dev_to_net_device(struct device *dev);
554
555/* Keep inline for faster access in hot path */
556static inline bool netdev_uses_dsa(struct net_device *dev)
557{
558#if IS_ENABLED(CONFIG_NET_DSA)
559 return dev->dsa_ptr && dev->dsa_ptr->rcv;
560#endif
561 return false;
562}
563
564static inline bool dsa_can_decode(const struct sk_buff *skb,
565 struct net_device *dev)
566{
567#if IS_ENABLED(CONFIG_NET_DSA)
568 return !dev->dsa_ptr->filter || dev->dsa_ptr->filter(skb, dev);
569#endif
570 return false;
571}
572
573struct dsa_switch *dsa_switch_alloc(struct device *dev, size_t n);
574void dsa_unregister_switch(struct dsa_switch *ds);
575int dsa_register_switch(struct dsa_switch *ds);
576#ifdef CONFIG_PM_SLEEP
577int dsa_switch_suspend(struct dsa_switch *ds);
578int dsa_switch_resume(struct dsa_switch *ds);
579#else
580static inline int dsa_switch_suspend(struct dsa_switch *ds)
581{
582 return 0;
583}
584static inline int dsa_switch_resume(struct dsa_switch *ds)
585{
586 return 0;
587}
588#endif /* CONFIG_PM_SLEEP */
589
590enum dsa_notifier_type {
591 DSA_PORT_REGISTER,
592 DSA_PORT_UNREGISTER,
593};
594
595struct dsa_notifier_info {
596 struct net_device *dev;
597};
598
599struct dsa_notifier_register_info {
600 struct dsa_notifier_info info; /* must be first */
601 struct net_device *master;
602 unsigned int port_number;
603 unsigned int switch_number;
604};
605
606static inline struct net_device *
607dsa_notifier_info_to_dev(const struct dsa_notifier_info *info)
608{
609 return info->dev;
610}
611
612#if IS_ENABLED(CONFIG_NET_DSA)
613int register_dsa_notifier(struct notifier_block *nb);
614int unregister_dsa_notifier(struct notifier_block *nb);
615int call_dsa_notifiers(unsigned long val, struct net_device *dev,
616 struct dsa_notifier_info *info);
617#else
618static inline int register_dsa_notifier(struct notifier_block *nb)
619{
620 return 0;
621}
622
623static inline int unregister_dsa_notifier(struct notifier_block *nb)
624{
625 return 0;
626}
627
628static inline int call_dsa_notifiers(unsigned long val, struct net_device *dev,
629 struct dsa_notifier_info *info)
630{
631 return NOTIFY_DONE;
632}
633#endif
634
635/* Broadcom tag specific helpers to insert and extract queue/port number */
636#define BRCM_TAG_SET_PORT_QUEUE(p, q) ((p) << 8 | q)
637#define BRCM_TAG_GET_PORT(v) ((v) >> 8)
638#define BRCM_TAG_GET_QUEUE(v) ((v) & 0xff)
639
640
641netdev_tx_t dsa_enqueue_skb(struct sk_buff *skb, struct net_device *dev);
642int dsa_port_get_phy_strings(struct dsa_port *dp, uint8_t *data);
643int dsa_port_get_ethtool_phy_stats(struct dsa_port *dp, uint64_t *data);
644int dsa_port_get_phy_sset_count(struct dsa_port *dp);
645void dsa_port_phylink_mac_change(struct dsa_switch *ds, int port, bool up);
646
647struct dsa_tag_driver {
648 const struct dsa_device_ops *ops;
649 struct list_head list;
650 struct module *owner;
651};
652
653void dsa_tag_drivers_register(struct dsa_tag_driver *dsa_tag_driver_array[],
654 unsigned int count,
655 struct module *owner);
656void dsa_tag_drivers_unregister(struct dsa_tag_driver *dsa_tag_driver_array[],
657 unsigned int count);
658
659#define dsa_tag_driver_module_drivers(__dsa_tag_drivers_array, __count) \
660static int __init dsa_tag_driver_module_init(void) \
661{ \
662 dsa_tag_drivers_register(__dsa_tag_drivers_array, __count, \
663 THIS_MODULE); \
664 return 0; \
665} \
666module_init(dsa_tag_driver_module_init); \
667 \
668static void __exit dsa_tag_driver_module_exit(void) \
669{ \
670 dsa_tag_drivers_unregister(__dsa_tag_drivers_array, __count); \
671} \
672module_exit(dsa_tag_driver_module_exit)
673
674/**
675 * module_dsa_tag_drivers() - Helper macro for registering DSA tag
676 * drivers
677 * @__ops_array: Array of tag driver strucutres
678 *
679 * Helper macro for DSA tag drivers which do not do anything special
680 * in module init/exit. Each module may only use this macro once, and
681 * calling it replaces module_init() and module_exit().
682 */
683#define module_dsa_tag_drivers(__ops_array) \
684dsa_tag_driver_module_drivers(__ops_array, ARRAY_SIZE(__ops_array))
685
686#define DSA_TAG_DRIVER_NAME(__ops) dsa_tag_driver ## _ ## __ops
687
688/* Create a static structure we can build a linked list of dsa_tag
689 * drivers
690 */
691#define DSA_TAG_DRIVER(__ops) \
692static struct dsa_tag_driver DSA_TAG_DRIVER_NAME(__ops) = { \
693 .ops = &__ops, \
694}
695
696/**
697 * module_dsa_tag_driver() - Helper macro for registering a single DSA tag
698 * driver
699 * @__ops: Single tag driver structures
700 *
701 * Helper macro for DSA tag drivers which do not do anything special
702 * in module init/exit. Each module may only use this macro once, and
703 * calling it replaces module_init() and module_exit().
704 */
705#define module_dsa_tag_driver(__ops) \
706DSA_TAG_DRIVER(__ops); \
707 \
708static struct dsa_tag_driver *dsa_tag_driver_array[] = { \
709 &DSA_TAG_DRIVER_NAME(__ops) \
710}; \
711module_dsa_tag_drivers(dsa_tag_driver_array)
712#endif
713
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#define DSA_TAG_PROTO_HELLCREEK_VALUE 18
49#define DSA_TAG_PROTO_XRS700X_VALUE 19
50#define DSA_TAG_PROTO_OCELOT_8021Q_VALUE 20
51#define DSA_TAG_PROTO_SEVILLE_VALUE 21
52#define DSA_TAG_PROTO_BRCM_LEGACY_VALUE 22
53#define DSA_TAG_PROTO_SJA1110_VALUE 23
54
55enum dsa_tag_protocol {
56 DSA_TAG_PROTO_NONE = DSA_TAG_PROTO_NONE_VALUE,
57 DSA_TAG_PROTO_BRCM = DSA_TAG_PROTO_BRCM_VALUE,
58 DSA_TAG_PROTO_BRCM_LEGACY = DSA_TAG_PROTO_BRCM_LEGACY_VALUE,
59 DSA_TAG_PROTO_BRCM_PREPEND = DSA_TAG_PROTO_BRCM_PREPEND_VALUE,
60 DSA_TAG_PROTO_DSA = DSA_TAG_PROTO_DSA_VALUE,
61 DSA_TAG_PROTO_EDSA = DSA_TAG_PROTO_EDSA_VALUE,
62 DSA_TAG_PROTO_GSWIP = DSA_TAG_PROTO_GSWIP_VALUE,
63 DSA_TAG_PROTO_KSZ9477 = DSA_TAG_PROTO_KSZ9477_VALUE,
64 DSA_TAG_PROTO_KSZ9893 = DSA_TAG_PROTO_KSZ9893_VALUE,
65 DSA_TAG_PROTO_LAN9303 = DSA_TAG_PROTO_LAN9303_VALUE,
66 DSA_TAG_PROTO_MTK = DSA_TAG_PROTO_MTK_VALUE,
67 DSA_TAG_PROTO_QCA = DSA_TAG_PROTO_QCA_VALUE,
68 DSA_TAG_PROTO_TRAILER = DSA_TAG_PROTO_TRAILER_VALUE,
69 DSA_TAG_PROTO_8021Q = DSA_TAG_PROTO_8021Q_VALUE,
70 DSA_TAG_PROTO_SJA1105 = DSA_TAG_PROTO_SJA1105_VALUE,
71 DSA_TAG_PROTO_KSZ8795 = DSA_TAG_PROTO_KSZ8795_VALUE,
72 DSA_TAG_PROTO_OCELOT = DSA_TAG_PROTO_OCELOT_VALUE,
73 DSA_TAG_PROTO_AR9331 = DSA_TAG_PROTO_AR9331_VALUE,
74 DSA_TAG_PROTO_RTL4_A = DSA_TAG_PROTO_RTL4_A_VALUE,
75 DSA_TAG_PROTO_HELLCREEK = DSA_TAG_PROTO_HELLCREEK_VALUE,
76 DSA_TAG_PROTO_XRS700X = DSA_TAG_PROTO_XRS700X_VALUE,
77 DSA_TAG_PROTO_OCELOT_8021Q = DSA_TAG_PROTO_OCELOT_8021Q_VALUE,
78 DSA_TAG_PROTO_SEVILLE = DSA_TAG_PROTO_SEVILLE_VALUE,
79 DSA_TAG_PROTO_SJA1110 = DSA_TAG_PROTO_SJA1110_VALUE,
80};
81
82struct packet_type;
83struct dsa_switch;
84
85struct dsa_device_ops {
86 struct sk_buff *(*xmit)(struct sk_buff *skb, struct net_device *dev);
87 struct sk_buff *(*rcv)(struct sk_buff *skb, struct net_device *dev,
88 struct packet_type *pt);
89 void (*flow_dissect)(const struct sk_buff *skb, __be16 *proto,
90 int *offset);
91 /* Used to determine which traffic should match the DSA filter in
92 * eth_type_trans, and which, if any, should bypass it and be processed
93 * as regular on the master net device.
94 */
95 bool (*filter)(const struct sk_buff *skb, struct net_device *dev);
96 unsigned int needed_headroom;
97 unsigned int needed_tailroom;
98 const char *name;
99 enum dsa_tag_protocol proto;
100 /* Some tagging protocols either mangle or shift the destination MAC
101 * address, in which case the DSA master would drop packets on ingress
102 * if what it understands out of the destination MAC address is not in
103 * its RX filter.
104 */
105 bool promisc_on_master;
106};
107
108/* This structure defines the control interfaces that are overlayed by the
109 * DSA layer on top of the DSA CPU/management net_device instance. This is
110 * used by the core net_device layer while calling various net_device_ops
111 * function pointers.
112 */
113struct dsa_netdevice_ops {
114 int (*ndo_do_ioctl)(struct net_device *dev, struct ifreq *ifr,
115 int cmd);
116};
117
118#define DSA_TAG_DRIVER_ALIAS "dsa_tag-"
119#define MODULE_ALIAS_DSA_TAG_DRIVER(__proto) \
120 MODULE_ALIAS(DSA_TAG_DRIVER_ALIAS __stringify(__proto##_VALUE))
121
122struct dsa_switch_tree {
123 struct list_head list;
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 /* Has this tree been applied to the hardware? */
135 bool setup;
136
137 /* Tagging protocol operations */
138 const struct dsa_device_ops *tag_ops;
139
140 /* Default tagging protocol preferred by the switches in this
141 * tree.
142 */
143 enum dsa_tag_protocol default_proto;
144
145 /*
146 * Configuration data for the platform device that owns
147 * this dsa switch tree instance.
148 */
149 struct dsa_platform_data *pd;
150
151 /* List of switch ports */
152 struct list_head ports;
153
154 /* List of DSA links composing the routing table */
155 struct list_head rtable;
156
157 /* Maps offloaded LAG netdevs to a zero-based linear ID for
158 * drivers that need it.
159 */
160 struct net_device **lags;
161 unsigned int lags_len;
162};
163
164#define dsa_lags_foreach_id(_id, _dst) \
165 for ((_id) = 0; (_id) < (_dst)->lags_len; (_id)++) \
166 if ((_dst)->lags[(_id)])
167
168#define dsa_lag_foreach_port(_dp, _dst, _lag) \
169 list_for_each_entry((_dp), &(_dst)->ports, list) \
170 if ((_dp)->lag_dev == (_lag))
171
172#define dsa_hsr_foreach_port(_dp, _ds, _hsr) \
173 list_for_each_entry((_dp), &(_ds)->dst->ports, list) \
174 if ((_dp)->ds == (_ds) && (_dp)->hsr_dev == (_hsr))
175
176static inline struct net_device *dsa_lag_dev(struct dsa_switch_tree *dst,
177 unsigned int id)
178{
179 return dst->lags[id];
180}
181
182static inline int dsa_lag_id(struct dsa_switch_tree *dst,
183 struct net_device *lag)
184{
185 unsigned int id;
186
187 dsa_lags_foreach_id(id, dst) {
188 if (dsa_lag_dev(dst, id) == lag)
189 return id;
190 }
191
192 return -ENODEV;
193}
194
195/* TC matchall action types */
196enum dsa_port_mall_action_type {
197 DSA_PORT_MALL_MIRROR,
198 DSA_PORT_MALL_POLICER,
199};
200
201/* TC mirroring entry */
202struct dsa_mall_mirror_tc_entry {
203 u8 to_local_port;
204 bool ingress;
205};
206
207/* TC port policer entry */
208struct dsa_mall_policer_tc_entry {
209 u32 burst;
210 u64 rate_bytes_per_sec;
211};
212
213/* TC matchall entry */
214struct dsa_mall_tc_entry {
215 struct list_head list;
216 unsigned long cookie;
217 enum dsa_port_mall_action_type type;
218 union {
219 struct dsa_mall_mirror_tc_entry mirror;
220 struct dsa_mall_policer_tc_entry policer;
221 };
222};
223
224
225struct dsa_port {
226 /* A CPU port is physically connected to a master device.
227 * A user port exposed to userspace has a slave device.
228 */
229 union {
230 struct net_device *master;
231 struct net_device *slave;
232 };
233
234 /* Copy of the tagging protocol operations, for quicker access
235 * in the data path. Valid only for the CPU ports.
236 */
237 const struct dsa_device_ops *tag_ops;
238
239 /* Copies for faster access in master receive hot path */
240 struct dsa_switch_tree *dst;
241 struct sk_buff *(*rcv)(struct sk_buff *skb, struct net_device *dev,
242 struct packet_type *pt);
243 bool (*filter)(const struct sk_buff *skb, struct net_device *dev);
244
245 enum {
246 DSA_PORT_TYPE_UNUSED = 0,
247 DSA_PORT_TYPE_CPU,
248 DSA_PORT_TYPE_DSA,
249 DSA_PORT_TYPE_USER,
250 } type;
251
252 struct dsa_switch *ds;
253 unsigned int index;
254 const char *name;
255 struct dsa_port *cpu_dp;
256 u8 mac[ETH_ALEN];
257 struct device_node *dn;
258 unsigned int ageing_time;
259 bool vlan_filtering;
260 u8 stp_state;
261 struct net_device *bridge_dev;
262 struct devlink_port devlink_port;
263 bool devlink_port_setup;
264 struct phylink *pl;
265 struct phylink_config pl_config;
266 struct net_device *lag_dev;
267 bool lag_tx_enabled;
268 struct net_device *hsr_dev;
269
270 struct list_head list;
271
272 /*
273 * Give the switch driver somewhere to hang its per-port private data
274 * structures (accessible from the tagger).
275 */
276 void *priv;
277
278 /*
279 * Original copy of the master netdev ethtool_ops
280 */
281 const struct ethtool_ops *orig_ethtool_ops;
282
283 /*
284 * Original copy of the master netdev net_device_ops
285 */
286 const struct dsa_netdevice_ops *netdev_ops;
287
288 /* List of MAC addresses that must be forwarded on this port.
289 * These are only valid on CPU ports and DSA links.
290 */
291 struct list_head fdbs;
292 struct list_head mdbs;
293
294 bool setup;
295};
296
297/* TODO: ideally DSA ports would have a single dp->link_dp member,
298 * and no dst->rtable nor this struct dsa_link would be needed,
299 * but this would require some more complex tree walking,
300 * so keep it stupid at the moment and list them all.
301 */
302struct dsa_link {
303 struct dsa_port *dp;
304 struct dsa_port *link_dp;
305 struct list_head list;
306};
307
308struct dsa_mac_addr {
309 unsigned char addr[ETH_ALEN];
310 u16 vid;
311 refcount_t refcount;
312 struct list_head list;
313};
314
315struct dsa_switch {
316 bool setup;
317
318 struct device *dev;
319
320 /*
321 * Parent switch tree, and switch index.
322 */
323 struct dsa_switch_tree *dst;
324 unsigned int index;
325
326 /* Listener for switch fabric events */
327 struct notifier_block nb;
328
329 /*
330 * Give the switch driver somewhere to hang its private data
331 * structure.
332 */
333 void *priv;
334
335 /*
336 * Configuration data for this switch.
337 */
338 struct dsa_chip_data *cd;
339
340 /*
341 * The switch operations.
342 */
343 const struct dsa_switch_ops *ops;
344
345 /*
346 * Slave mii_bus and devices for the individual ports.
347 */
348 u32 phys_mii_mask;
349 struct mii_bus *slave_mii_bus;
350
351 /* Ageing Time limits in msecs */
352 unsigned int ageing_time_min;
353 unsigned int ageing_time_max;
354
355 /* devlink used to represent this switch device */
356 struct devlink *devlink;
357
358 /* Number of switch port queues */
359 unsigned int num_tx_queues;
360
361 /* Disallow bridge core from requesting different VLAN awareness
362 * settings on ports if not hardware-supported
363 */
364 bool vlan_filtering_is_global;
365
366 /* Pass .port_vlan_add and .port_vlan_del to drivers even for bridges
367 * that have vlan_filtering=0. All drivers should ideally set this (and
368 * then the option would get removed), but it is unknown whether this
369 * would break things or not.
370 */
371 bool configure_vlan_while_not_filtering;
372
373 /* If the switch driver always programs the CPU port as egress tagged
374 * despite the VLAN configuration indicating otherwise, then setting
375 * @untag_bridge_pvid will force the DSA receive path to pop the bridge's
376 * default_pvid VLAN tagged frames to offer a consistent behavior
377 * between a vlan_filtering=0 and vlan_filtering=1 bridge device.
378 */
379 bool untag_bridge_pvid;
380
381 /* Let DSA manage the FDB entries towards the CPU, based on the
382 * software bridge database.
383 */
384 bool assisted_learning_on_cpu_port;
385
386 /* In case vlan_filtering_is_global is set, the VLAN awareness state
387 * should be retrieved from here and not from the per-port settings.
388 */
389 bool vlan_filtering;
390
391 /* MAC PCS does not provide link state change interrupt, and requires
392 * polling. Flag passed on to PHYLINK.
393 */
394 bool pcs_poll;
395
396 /* For switches that only have the MRU configurable. To ensure the
397 * configured MTU is not exceeded, normalization of MRU on all bridged
398 * interfaces is needed.
399 */
400 bool mtu_enforcement_ingress;
401
402 /* Drivers that benefit from having an ID associated with each
403 * offloaded LAG should set this to the maximum number of
404 * supported IDs. DSA will then maintain a mapping of _at
405 * least_ these many IDs, accessible to drivers via
406 * dsa_lag_id().
407 */
408 unsigned int num_lag_ids;
409
410 size_t num_ports;
411};
412
413static inline struct dsa_port *dsa_to_port(struct dsa_switch *ds, int p)
414{
415 struct dsa_switch_tree *dst = ds->dst;
416 struct dsa_port *dp;
417
418 list_for_each_entry(dp, &dst->ports, list)
419 if (dp->ds == ds && dp->index == p)
420 return dp;
421
422 return NULL;
423}
424
425static inline bool dsa_port_is_dsa(struct dsa_port *port)
426{
427 return port->type == DSA_PORT_TYPE_DSA;
428}
429
430static inline bool dsa_port_is_cpu(struct dsa_port *port)
431{
432 return port->type == DSA_PORT_TYPE_CPU;
433}
434
435static inline bool dsa_port_is_user(struct dsa_port *dp)
436{
437 return dp->type == DSA_PORT_TYPE_USER;
438}
439
440static inline bool dsa_port_is_unused(struct dsa_port *dp)
441{
442 return dp->type == DSA_PORT_TYPE_UNUSED;
443}
444
445static inline bool dsa_is_unused_port(struct dsa_switch *ds, int p)
446{
447 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_UNUSED;
448}
449
450static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p)
451{
452 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_CPU;
453}
454
455static inline bool dsa_is_dsa_port(struct dsa_switch *ds, int p)
456{
457 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_DSA;
458}
459
460static inline bool dsa_is_user_port(struct dsa_switch *ds, int p)
461{
462 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_USER;
463}
464
465static inline u32 dsa_user_ports(struct dsa_switch *ds)
466{
467 u32 mask = 0;
468 int p;
469
470 for (p = 0; p < ds->num_ports; p++)
471 if (dsa_is_user_port(ds, p))
472 mask |= BIT(p);
473
474 return mask;
475}
476
477/* Return the local port used to reach an arbitrary switch device */
478static inline unsigned int dsa_routing_port(struct dsa_switch *ds, int device)
479{
480 struct dsa_switch_tree *dst = ds->dst;
481 struct dsa_link *dl;
482
483 list_for_each_entry(dl, &dst->rtable, list)
484 if (dl->dp->ds == ds && dl->link_dp->ds->index == device)
485 return dl->dp->index;
486
487 return ds->num_ports;
488}
489
490/* Return the local port used to reach an arbitrary switch port */
491static inline unsigned int dsa_towards_port(struct dsa_switch *ds, int device,
492 int port)
493{
494 if (device == ds->index)
495 return port;
496 else
497 return dsa_routing_port(ds, device);
498}
499
500/* Return the local port used to reach the dedicated CPU port */
501static inline unsigned int dsa_upstream_port(struct dsa_switch *ds, int port)
502{
503 const struct dsa_port *dp = dsa_to_port(ds, port);
504 const struct dsa_port *cpu_dp = dp->cpu_dp;
505
506 if (!cpu_dp)
507 return port;
508
509 return dsa_towards_port(ds, cpu_dp->ds->index, cpu_dp->index);
510}
511
512/* Return true if this is the local port used to reach the CPU port */
513static inline bool dsa_is_upstream_port(struct dsa_switch *ds, int port)
514{
515 if (dsa_is_unused_port(ds, port))
516 return false;
517
518 return port == dsa_upstream_port(ds, port);
519}
520
521/* Return true if @upstream_ds is an upstream switch of @downstream_ds, meaning
522 * that the routing port from @downstream_ds to @upstream_ds is also the port
523 * which @downstream_ds uses to reach its dedicated CPU.
524 */
525static inline bool dsa_switch_is_upstream_of(struct dsa_switch *upstream_ds,
526 struct dsa_switch *downstream_ds)
527{
528 int routing_port;
529
530 if (upstream_ds == downstream_ds)
531 return true;
532
533 routing_port = dsa_routing_port(downstream_ds, upstream_ds->index);
534
535 return dsa_is_upstream_port(downstream_ds, routing_port);
536}
537
538static inline bool dsa_port_is_vlan_filtering(const struct dsa_port *dp)
539{
540 const struct dsa_switch *ds = dp->ds;
541
542 if (ds->vlan_filtering_is_global)
543 return ds->vlan_filtering;
544 else
545 return dp->vlan_filtering;
546}
547
548static inline
549struct net_device *dsa_port_to_bridge_port(const struct dsa_port *dp)
550{
551 if (!dp->bridge_dev)
552 return NULL;
553
554 if (dp->lag_dev)
555 return dp->lag_dev;
556 else if (dp->hsr_dev)
557 return dp->hsr_dev;
558
559 return dp->slave;
560}
561
562typedef int dsa_fdb_dump_cb_t(const unsigned char *addr, u16 vid,
563 bool is_static, void *data);
564struct dsa_switch_ops {
565 /*
566 * Tagging protocol helpers called for the CPU ports and DSA links.
567 * @get_tag_protocol retrieves the initial tagging protocol and is
568 * mandatory. Switches which can operate using multiple tagging
569 * protocols should implement @change_tag_protocol and report in
570 * @get_tag_protocol the tagger in current use.
571 */
572 enum dsa_tag_protocol (*get_tag_protocol)(struct dsa_switch *ds,
573 int port,
574 enum dsa_tag_protocol mprot);
575 int (*change_tag_protocol)(struct dsa_switch *ds, int port,
576 enum dsa_tag_protocol proto);
577
578 /* Optional switch-wide initialization and destruction methods */
579 int (*setup)(struct dsa_switch *ds);
580 void (*teardown)(struct dsa_switch *ds);
581
582 /* Per-port initialization and destruction methods. Mandatory if the
583 * driver registers devlink port regions, optional otherwise.
584 */
585 int (*port_setup)(struct dsa_switch *ds, int port);
586 void (*port_teardown)(struct dsa_switch *ds, int port);
587
588 u32 (*get_phy_flags)(struct dsa_switch *ds, int port);
589
590 /*
591 * Access to the switch's PHY registers.
592 */
593 int (*phy_read)(struct dsa_switch *ds, int port, int regnum);
594 int (*phy_write)(struct dsa_switch *ds, int port,
595 int regnum, u16 val);
596
597 /*
598 * Link state adjustment (called from libphy)
599 */
600 void (*adjust_link)(struct dsa_switch *ds, int port,
601 struct phy_device *phydev);
602 void (*fixed_link_update)(struct dsa_switch *ds, int port,
603 struct fixed_phy_status *st);
604
605 /*
606 * PHYLINK integration
607 */
608 void (*phylink_validate)(struct dsa_switch *ds, int port,
609 unsigned long *supported,
610 struct phylink_link_state *state);
611 int (*phylink_mac_link_state)(struct dsa_switch *ds, int port,
612 struct phylink_link_state *state);
613 void (*phylink_mac_config)(struct dsa_switch *ds, int port,
614 unsigned int mode,
615 const struct phylink_link_state *state);
616 void (*phylink_mac_an_restart)(struct dsa_switch *ds, int port);
617 void (*phylink_mac_link_down)(struct dsa_switch *ds, int port,
618 unsigned int mode,
619 phy_interface_t interface);
620 void (*phylink_mac_link_up)(struct dsa_switch *ds, int port,
621 unsigned int mode,
622 phy_interface_t interface,
623 struct phy_device *phydev,
624 int speed, int duplex,
625 bool tx_pause, bool rx_pause);
626 void (*phylink_fixed_state)(struct dsa_switch *ds, int port,
627 struct phylink_link_state *state);
628 /*
629 * Port statistics counters.
630 */
631 void (*get_strings)(struct dsa_switch *ds, int port,
632 u32 stringset, uint8_t *data);
633 void (*get_ethtool_stats)(struct dsa_switch *ds,
634 int port, uint64_t *data);
635 int (*get_sset_count)(struct dsa_switch *ds, int port, int sset);
636 void (*get_ethtool_phy_stats)(struct dsa_switch *ds,
637 int port, uint64_t *data);
638 void (*get_stats64)(struct dsa_switch *ds, int port,
639 struct rtnl_link_stats64 *s);
640 void (*self_test)(struct dsa_switch *ds, int port,
641 struct ethtool_test *etest, u64 *data);
642
643 /*
644 * ethtool Wake-on-LAN
645 */
646 void (*get_wol)(struct dsa_switch *ds, int port,
647 struct ethtool_wolinfo *w);
648 int (*set_wol)(struct dsa_switch *ds, int port,
649 struct ethtool_wolinfo *w);
650
651 /*
652 * ethtool timestamp info
653 */
654 int (*get_ts_info)(struct dsa_switch *ds, int port,
655 struct ethtool_ts_info *ts);
656
657 /*
658 * Suspend and resume
659 */
660 int (*suspend)(struct dsa_switch *ds);
661 int (*resume)(struct dsa_switch *ds);
662
663 /*
664 * Port enable/disable
665 */
666 int (*port_enable)(struct dsa_switch *ds, int port,
667 struct phy_device *phy);
668 void (*port_disable)(struct dsa_switch *ds, int port);
669
670 /*
671 * Port's MAC EEE settings
672 */
673 int (*set_mac_eee)(struct dsa_switch *ds, int port,
674 struct ethtool_eee *e);
675 int (*get_mac_eee)(struct dsa_switch *ds, int port,
676 struct ethtool_eee *e);
677
678 /* EEPROM access */
679 int (*get_eeprom_len)(struct dsa_switch *ds);
680 int (*get_eeprom)(struct dsa_switch *ds,
681 struct ethtool_eeprom *eeprom, u8 *data);
682 int (*set_eeprom)(struct dsa_switch *ds,
683 struct ethtool_eeprom *eeprom, u8 *data);
684
685 /*
686 * Register access.
687 */
688 int (*get_regs_len)(struct dsa_switch *ds, int port);
689 void (*get_regs)(struct dsa_switch *ds, int port,
690 struct ethtool_regs *regs, void *p);
691
692 /*
693 * Upper device tracking.
694 */
695 int (*port_prechangeupper)(struct dsa_switch *ds, int port,
696 struct netdev_notifier_changeupper_info *info);
697
698 /*
699 * Bridge integration
700 */
701 int (*set_ageing_time)(struct dsa_switch *ds, unsigned int msecs);
702 int (*port_bridge_join)(struct dsa_switch *ds, int port,
703 struct net_device *bridge);
704 void (*port_bridge_leave)(struct dsa_switch *ds, int port,
705 struct net_device *bridge);
706 void (*port_stp_state_set)(struct dsa_switch *ds, int port,
707 u8 state);
708 void (*port_fast_age)(struct dsa_switch *ds, int port);
709 int (*port_pre_bridge_flags)(struct dsa_switch *ds, int port,
710 struct switchdev_brport_flags flags,
711 struct netlink_ext_ack *extack);
712 int (*port_bridge_flags)(struct dsa_switch *ds, int port,
713 struct switchdev_brport_flags flags,
714 struct netlink_ext_ack *extack);
715
716 /*
717 * VLAN support
718 */
719 int (*port_vlan_filtering)(struct dsa_switch *ds, int port,
720 bool vlan_filtering,
721 struct netlink_ext_ack *extack);
722 int (*port_vlan_add)(struct dsa_switch *ds, int port,
723 const struct switchdev_obj_port_vlan *vlan,
724 struct netlink_ext_ack *extack);
725 int (*port_vlan_del)(struct dsa_switch *ds, int port,
726 const struct switchdev_obj_port_vlan *vlan);
727 /*
728 * Forwarding database
729 */
730 int (*port_fdb_add)(struct dsa_switch *ds, int port,
731 const unsigned char *addr, u16 vid);
732 int (*port_fdb_del)(struct dsa_switch *ds, int port,
733 const unsigned char *addr, u16 vid);
734 int (*port_fdb_dump)(struct dsa_switch *ds, int port,
735 dsa_fdb_dump_cb_t *cb, void *data);
736
737 /*
738 * Multicast database
739 */
740 int (*port_mdb_add)(struct dsa_switch *ds, int port,
741 const struct switchdev_obj_port_mdb *mdb);
742 int (*port_mdb_del)(struct dsa_switch *ds, int port,
743 const struct switchdev_obj_port_mdb *mdb);
744 /*
745 * RXNFC
746 */
747 int (*get_rxnfc)(struct dsa_switch *ds, int port,
748 struct ethtool_rxnfc *nfc, u32 *rule_locs);
749 int (*set_rxnfc)(struct dsa_switch *ds, int port,
750 struct ethtool_rxnfc *nfc);
751
752 /*
753 * TC integration
754 */
755 int (*cls_flower_add)(struct dsa_switch *ds, int port,
756 struct flow_cls_offload *cls, bool ingress);
757 int (*cls_flower_del)(struct dsa_switch *ds, int port,
758 struct flow_cls_offload *cls, bool ingress);
759 int (*cls_flower_stats)(struct dsa_switch *ds, int port,
760 struct flow_cls_offload *cls, bool ingress);
761 int (*port_mirror_add)(struct dsa_switch *ds, int port,
762 struct dsa_mall_mirror_tc_entry *mirror,
763 bool ingress);
764 void (*port_mirror_del)(struct dsa_switch *ds, int port,
765 struct dsa_mall_mirror_tc_entry *mirror);
766 int (*port_policer_add)(struct dsa_switch *ds, int port,
767 struct dsa_mall_policer_tc_entry *policer);
768 void (*port_policer_del)(struct dsa_switch *ds, int port);
769 int (*port_setup_tc)(struct dsa_switch *ds, int port,
770 enum tc_setup_type type, void *type_data);
771
772 /*
773 * Cross-chip operations
774 */
775 int (*crosschip_bridge_join)(struct dsa_switch *ds, int tree_index,
776 int sw_index, int port,
777 struct net_device *br);
778 void (*crosschip_bridge_leave)(struct dsa_switch *ds, int tree_index,
779 int sw_index, int port,
780 struct net_device *br);
781 int (*crosschip_lag_change)(struct dsa_switch *ds, int sw_index,
782 int port);
783 int (*crosschip_lag_join)(struct dsa_switch *ds, int sw_index,
784 int port, struct net_device *lag,
785 struct netdev_lag_upper_info *info);
786 int (*crosschip_lag_leave)(struct dsa_switch *ds, int sw_index,
787 int port, struct net_device *lag);
788
789 /*
790 * PTP functionality
791 */
792 int (*port_hwtstamp_get)(struct dsa_switch *ds, int port,
793 struct ifreq *ifr);
794 int (*port_hwtstamp_set)(struct dsa_switch *ds, int port,
795 struct ifreq *ifr);
796 void (*port_txtstamp)(struct dsa_switch *ds, int port,
797 struct sk_buff *skb);
798 bool (*port_rxtstamp)(struct dsa_switch *ds, int port,
799 struct sk_buff *skb, unsigned int type);
800
801 /* Devlink parameters, etc */
802 int (*devlink_param_get)(struct dsa_switch *ds, u32 id,
803 struct devlink_param_gset_ctx *ctx);
804 int (*devlink_param_set)(struct dsa_switch *ds, u32 id,
805 struct devlink_param_gset_ctx *ctx);
806 int (*devlink_info_get)(struct dsa_switch *ds,
807 struct devlink_info_req *req,
808 struct netlink_ext_ack *extack);
809 int (*devlink_sb_pool_get)(struct dsa_switch *ds,
810 unsigned int sb_index, u16 pool_index,
811 struct devlink_sb_pool_info *pool_info);
812 int (*devlink_sb_pool_set)(struct dsa_switch *ds, unsigned int sb_index,
813 u16 pool_index, u32 size,
814 enum devlink_sb_threshold_type threshold_type,
815 struct netlink_ext_ack *extack);
816 int (*devlink_sb_port_pool_get)(struct dsa_switch *ds, int port,
817 unsigned int sb_index, u16 pool_index,
818 u32 *p_threshold);
819 int (*devlink_sb_port_pool_set)(struct dsa_switch *ds, int port,
820 unsigned int sb_index, u16 pool_index,
821 u32 threshold,
822 struct netlink_ext_ack *extack);
823 int (*devlink_sb_tc_pool_bind_get)(struct dsa_switch *ds, int port,
824 unsigned int sb_index, u16 tc_index,
825 enum devlink_sb_pool_type pool_type,
826 u16 *p_pool_index, u32 *p_threshold);
827 int (*devlink_sb_tc_pool_bind_set)(struct dsa_switch *ds, int port,
828 unsigned int sb_index, u16 tc_index,
829 enum devlink_sb_pool_type pool_type,
830 u16 pool_index, u32 threshold,
831 struct netlink_ext_ack *extack);
832 int (*devlink_sb_occ_snapshot)(struct dsa_switch *ds,
833 unsigned int sb_index);
834 int (*devlink_sb_occ_max_clear)(struct dsa_switch *ds,
835 unsigned int sb_index);
836 int (*devlink_sb_occ_port_pool_get)(struct dsa_switch *ds, int port,
837 unsigned int sb_index, u16 pool_index,
838 u32 *p_cur, u32 *p_max);
839 int (*devlink_sb_occ_tc_port_bind_get)(struct dsa_switch *ds, int port,
840 unsigned int sb_index, u16 tc_index,
841 enum devlink_sb_pool_type pool_type,
842 u32 *p_cur, u32 *p_max);
843
844 /*
845 * MTU change functionality. Switches can also adjust their MRU through
846 * this method. By MTU, one understands the SDU (L2 payload) length.
847 * If the switch needs to account for the DSA tag on the CPU port, this
848 * method needs to do so privately.
849 */
850 int (*port_change_mtu)(struct dsa_switch *ds, int port,
851 int new_mtu);
852 int (*port_max_mtu)(struct dsa_switch *ds, int port);
853
854 /*
855 * LAG integration
856 */
857 int (*port_lag_change)(struct dsa_switch *ds, int port);
858 int (*port_lag_join)(struct dsa_switch *ds, int port,
859 struct net_device *lag,
860 struct netdev_lag_upper_info *info);
861 int (*port_lag_leave)(struct dsa_switch *ds, int port,
862 struct net_device *lag);
863
864 /*
865 * HSR integration
866 */
867 int (*port_hsr_join)(struct dsa_switch *ds, int port,
868 struct net_device *hsr);
869 int (*port_hsr_leave)(struct dsa_switch *ds, int port,
870 struct net_device *hsr);
871
872 /*
873 * MRP integration
874 */
875 int (*port_mrp_add)(struct dsa_switch *ds, int port,
876 const struct switchdev_obj_mrp *mrp);
877 int (*port_mrp_del)(struct dsa_switch *ds, int port,
878 const struct switchdev_obj_mrp *mrp);
879 int (*port_mrp_add_ring_role)(struct dsa_switch *ds, int port,
880 const struct switchdev_obj_ring_role_mrp *mrp);
881 int (*port_mrp_del_ring_role)(struct dsa_switch *ds, int port,
882 const struct switchdev_obj_ring_role_mrp *mrp);
883};
884
885#define DSA_DEVLINK_PARAM_DRIVER(_id, _name, _type, _cmodes) \
886 DEVLINK_PARAM_DRIVER(_id, _name, _type, _cmodes, \
887 dsa_devlink_param_get, dsa_devlink_param_set, NULL)
888
889int dsa_devlink_param_get(struct devlink *dl, u32 id,
890 struct devlink_param_gset_ctx *ctx);
891int dsa_devlink_param_set(struct devlink *dl, u32 id,
892 struct devlink_param_gset_ctx *ctx);
893int dsa_devlink_params_register(struct dsa_switch *ds,
894 const struct devlink_param *params,
895 size_t params_count);
896void dsa_devlink_params_unregister(struct dsa_switch *ds,
897 const struct devlink_param *params,
898 size_t params_count);
899int dsa_devlink_resource_register(struct dsa_switch *ds,
900 const char *resource_name,
901 u64 resource_size,
902 u64 resource_id,
903 u64 parent_resource_id,
904 const struct devlink_resource_size_params *size_params);
905
906void dsa_devlink_resources_unregister(struct dsa_switch *ds);
907
908void dsa_devlink_resource_occ_get_register(struct dsa_switch *ds,
909 u64 resource_id,
910 devlink_resource_occ_get_t *occ_get,
911 void *occ_get_priv);
912void dsa_devlink_resource_occ_get_unregister(struct dsa_switch *ds,
913 u64 resource_id);
914struct devlink_region *
915dsa_devlink_region_create(struct dsa_switch *ds,
916 const struct devlink_region_ops *ops,
917 u32 region_max_snapshots, u64 region_size);
918struct devlink_region *
919dsa_devlink_port_region_create(struct dsa_switch *ds,
920 int port,
921 const struct devlink_port_region_ops *ops,
922 u32 region_max_snapshots, u64 region_size);
923void dsa_devlink_region_destroy(struct devlink_region *region);
924
925struct dsa_port *dsa_port_from_netdev(struct net_device *netdev);
926
927struct dsa_devlink_priv {
928 struct dsa_switch *ds;
929};
930
931static inline struct dsa_switch *dsa_devlink_to_ds(struct devlink *dl)
932{
933 struct dsa_devlink_priv *dl_priv = devlink_priv(dl);
934
935 return dl_priv->ds;
936}
937
938static inline
939struct dsa_switch *dsa_devlink_port_to_ds(struct devlink_port *port)
940{
941 struct devlink *dl = port->devlink;
942 struct dsa_devlink_priv *dl_priv = devlink_priv(dl);
943
944 return dl_priv->ds;
945}
946
947static inline int dsa_devlink_port_to_port(struct devlink_port *port)
948{
949 return port->index;
950}
951
952struct dsa_switch_driver {
953 struct list_head list;
954 const struct dsa_switch_ops *ops;
955};
956
957struct net_device *dsa_dev_to_net_device(struct device *dev);
958
959/* Keep inline for faster access in hot path */
960static inline bool netdev_uses_dsa(const struct net_device *dev)
961{
962#if IS_ENABLED(CONFIG_NET_DSA)
963 return dev->dsa_ptr && dev->dsa_ptr->rcv;
964#endif
965 return false;
966}
967
968static inline bool dsa_can_decode(const struct sk_buff *skb,
969 struct net_device *dev)
970{
971#if IS_ENABLED(CONFIG_NET_DSA)
972 return !dev->dsa_ptr->filter || dev->dsa_ptr->filter(skb, dev);
973#endif
974 return false;
975}
976
977/* All DSA tags that push the EtherType to the right (basically all except tail
978 * tags, which don't break dissection) can be treated the same from the
979 * perspective of the flow dissector.
980 *
981 * We need to return:
982 * - offset: the (B - A) difference between:
983 * A. the position of the real EtherType and
984 * B. the current skb->data (aka ETH_HLEN bytes into the frame, aka 2 bytes
985 * after the normal EtherType was supposed to be)
986 * The offset in bytes is exactly equal to the tagger overhead (and half of
987 * that, in __be16 shorts).
988 *
989 * - proto: the value of the real EtherType.
990 */
991static inline void dsa_tag_generic_flow_dissect(const struct sk_buff *skb,
992 __be16 *proto, int *offset)
993{
994#if IS_ENABLED(CONFIG_NET_DSA)
995 const struct dsa_device_ops *ops = skb->dev->dsa_ptr->tag_ops;
996 int tag_len = ops->needed_headroom;
997
998 *offset = tag_len;
999 *proto = ((__be16 *)skb->data)[(tag_len / 2) - 1];
1000#endif
1001}
1002
1003#if IS_ENABLED(CONFIG_NET_DSA)
1004static inline int __dsa_netdevice_ops_check(struct net_device *dev)
1005{
1006 int err = -EOPNOTSUPP;
1007
1008 if (!dev->dsa_ptr)
1009 return err;
1010
1011 if (!dev->dsa_ptr->netdev_ops)
1012 return err;
1013
1014 return 0;
1015}
1016
1017static inline int dsa_ndo_do_ioctl(struct net_device *dev, struct ifreq *ifr,
1018 int cmd)
1019{
1020 const struct dsa_netdevice_ops *ops;
1021 int err;
1022
1023 err = __dsa_netdevice_ops_check(dev);
1024 if (err)
1025 return err;
1026
1027 ops = dev->dsa_ptr->netdev_ops;
1028
1029 return ops->ndo_do_ioctl(dev, ifr, cmd);
1030}
1031#else
1032static inline int dsa_ndo_do_ioctl(struct net_device *dev, struct ifreq *ifr,
1033 int cmd)
1034{
1035 return -EOPNOTSUPP;
1036}
1037#endif
1038
1039void dsa_unregister_switch(struct dsa_switch *ds);
1040int dsa_register_switch(struct dsa_switch *ds);
1041struct dsa_switch *dsa_switch_find(int tree_index, int sw_index);
1042#ifdef CONFIG_PM_SLEEP
1043int dsa_switch_suspend(struct dsa_switch *ds);
1044int dsa_switch_resume(struct dsa_switch *ds);
1045#else
1046static inline int dsa_switch_suspend(struct dsa_switch *ds)
1047{
1048 return 0;
1049}
1050static inline int dsa_switch_resume(struct dsa_switch *ds)
1051{
1052 return 0;
1053}
1054#endif /* CONFIG_PM_SLEEP */
1055
1056#if IS_ENABLED(CONFIG_NET_DSA)
1057bool dsa_slave_dev_check(const struct net_device *dev);
1058#else
1059static inline bool dsa_slave_dev_check(const struct net_device *dev)
1060{
1061 return false;
1062}
1063#endif
1064
1065netdev_tx_t dsa_enqueue_skb(struct sk_buff *skb, struct net_device *dev);
1066int dsa_port_get_phy_strings(struct dsa_port *dp, uint8_t *data);
1067int dsa_port_get_ethtool_phy_stats(struct dsa_port *dp, uint64_t *data);
1068int dsa_port_get_phy_sset_count(struct dsa_port *dp);
1069void dsa_port_phylink_mac_change(struct dsa_switch *ds, int port, bool up);
1070
1071struct dsa_tag_driver {
1072 const struct dsa_device_ops *ops;
1073 struct list_head list;
1074 struct module *owner;
1075};
1076
1077void dsa_tag_drivers_register(struct dsa_tag_driver *dsa_tag_driver_array[],
1078 unsigned int count,
1079 struct module *owner);
1080void dsa_tag_drivers_unregister(struct dsa_tag_driver *dsa_tag_driver_array[],
1081 unsigned int count);
1082
1083#define dsa_tag_driver_module_drivers(__dsa_tag_drivers_array, __count) \
1084static int __init dsa_tag_driver_module_init(void) \
1085{ \
1086 dsa_tag_drivers_register(__dsa_tag_drivers_array, __count, \
1087 THIS_MODULE); \
1088 return 0; \
1089} \
1090module_init(dsa_tag_driver_module_init); \
1091 \
1092static void __exit dsa_tag_driver_module_exit(void) \
1093{ \
1094 dsa_tag_drivers_unregister(__dsa_tag_drivers_array, __count); \
1095} \
1096module_exit(dsa_tag_driver_module_exit)
1097
1098/**
1099 * module_dsa_tag_drivers() - Helper macro for registering DSA tag
1100 * drivers
1101 * @__ops_array: Array of tag driver strucutres
1102 *
1103 * Helper macro for DSA tag drivers which do not do anything special
1104 * in module init/exit. Each module may only use this macro once, and
1105 * calling it replaces module_init() and module_exit().
1106 */
1107#define module_dsa_tag_drivers(__ops_array) \
1108dsa_tag_driver_module_drivers(__ops_array, ARRAY_SIZE(__ops_array))
1109
1110#define DSA_TAG_DRIVER_NAME(__ops) dsa_tag_driver ## _ ## __ops
1111
1112/* Create a static structure we can build a linked list of dsa_tag
1113 * drivers
1114 */
1115#define DSA_TAG_DRIVER(__ops) \
1116static struct dsa_tag_driver DSA_TAG_DRIVER_NAME(__ops) = { \
1117 .ops = &__ops, \
1118}
1119
1120/**
1121 * module_dsa_tag_driver() - Helper macro for registering a single DSA tag
1122 * driver
1123 * @__ops: Single tag driver structures
1124 *
1125 * Helper macro for DSA tag drivers which do not do anything special
1126 * in module init/exit. Each module may only use this macro once, and
1127 * calling it replaces module_init() and module_exit().
1128 */
1129#define module_dsa_tag_driver(__ops) \
1130DSA_TAG_DRIVER(__ops); \
1131 \
1132static struct dsa_tag_driver *dsa_tag_driver_array[] = { \
1133 &DSA_TAG_DRIVER_NAME(__ops) \
1134}; \
1135module_dsa_tag_drivers(dsa_tag_driver_array)
1136#endif
1137