1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 * include/net/dsa.h - Driver for Distributed Switch Architecture switch chips
4 * Copyright (c) 2008-2009 Marvell Semiconductor
7 #ifndef __LINUX_NET_DSA_H
8 #define __LINUX_NET_DSA_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>
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 <net/devlink.h>
22 #include <net/switchdev.h>
26 struct fixed_phy_status
;
27 struct phylink_link_state
;
29 #define DSA_TAG_PROTO_NONE_VALUE 0
30 #define DSA_TAG_PROTO_BRCM_VALUE 1
31 #define DSA_TAG_PROTO_BRCM_PREPEND_VALUE 2
32 #define DSA_TAG_PROTO_DSA_VALUE 3
33 #define DSA_TAG_PROTO_EDSA_VALUE 4
34 #define DSA_TAG_PROTO_GSWIP_VALUE 5
35 #define DSA_TAG_PROTO_KSZ9477_VALUE 6
36 #define DSA_TAG_PROTO_KSZ9893_VALUE 7
37 #define DSA_TAG_PROTO_LAN9303_VALUE 8
38 #define DSA_TAG_PROTO_MTK_VALUE 9
39 #define DSA_TAG_PROTO_QCA_VALUE 10
40 #define DSA_TAG_PROTO_TRAILER_VALUE 11
41 #define DSA_TAG_PROTO_8021Q_VALUE 12
42 #define DSA_TAG_PROTO_SJA1105_VALUE 13
44 enum dsa_tag_protocol
{
45 DSA_TAG_PROTO_NONE
= DSA_TAG_PROTO_NONE_VALUE
,
46 DSA_TAG_PROTO_BRCM
= DSA_TAG_PROTO_BRCM_VALUE
,
47 DSA_TAG_PROTO_BRCM_PREPEND
= DSA_TAG_PROTO_BRCM_PREPEND_VALUE
,
48 DSA_TAG_PROTO_DSA
= DSA_TAG_PROTO_DSA_VALUE
,
49 DSA_TAG_PROTO_EDSA
= DSA_TAG_PROTO_EDSA_VALUE
,
50 DSA_TAG_PROTO_GSWIP
= DSA_TAG_PROTO_GSWIP_VALUE
,
51 DSA_TAG_PROTO_KSZ9477
= DSA_TAG_PROTO_KSZ9477_VALUE
,
52 DSA_TAG_PROTO_KSZ9893
= DSA_TAG_PROTO_KSZ9893_VALUE
,
53 DSA_TAG_PROTO_LAN9303
= DSA_TAG_PROTO_LAN9303_VALUE
,
54 DSA_TAG_PROTO_MTK
= DSA_TAG_PROTO_MTK_VALUE
,
55 DSA_TAG_PROTO_QCA
= DSA_TAG_PROTO_QCA_VALUE
,
56 DSA_TAG_PROTO_TRAILER
= DSA_TAG_PROTO_TRAILER_VALUE
,
57 DSA_TAG_PROTO_8021Q
= DSA_TAG_PROTO_8021Q_VALUE
,
58 DSA_TAG_PROTO_SJA1105
= DSA_TAG_PROTO_SJA1105_VALUE
,
64 struct dsa_device_ops
{
65 struct sk_buff
*(*xmit
)(struct sk_buff
*skb
, struct net_device
*dev
);
66 struct sk_buff
*(*rcv
)(struct sk_buff
*skb
, struct net_device
*dev
,
67 struct packet_type
*pt
);
68 int (*flow_dissect
)(const struct sk_buff
*skb
, __be16
*proto
,
70 /* Used to determine which traffic should match the DSA filter in
71 * eth_type_trans, and which, if any, should bypass it and be processed
72 * as regular on the master net device.
74 bool (*filter
)(const struct sk_buff
*skb
, struct net_device
*dev
);
75 unsigned int overhead
;
77 enum dsa_tag_protocol proto
;
80 #define DSA_TAG_DRIVER_ALIAS "dsa_tag-"
81 #define MODULE_ALIAS_DSA_TAG_DRIVER(__proto) \
82 MODULE_ALIAS(DSA_TAG_DRIVER_ALIAS __stringify(__proto##_VALUE))
85 struct sk_buff
*clone
;
91 u8 priv
[48 - sizeof(struct dsa_skb_cb
)];
94 #define __DSA_SKB_CB(skb) ((struct __dsa_skb_cb *)((skb)->cb))
96 #define DSA_SKB_CB(skb) ((struct dsa_skb_cb *)((skb)->cb))
98 #define DSA_SKB_CB_PRIV(skb) \
99 ((void *)(skb)->cb + offsetof(struct __dsa_skb_cb, priv))
101 struct dsa_switch_tree
{
102 struct list_head list
;
104 /* Notifier chain for switch-wide events */
105 struct raw_notifier_head nh
;
107 /* Tree identifier */
110 /* Number of switches attached to this tree */
111 struct kref refcount
;
113 /* Has this tree been applied to the hardware? */
117 * Configuration data for the platform device that owns
118 * this dsa switch tree instance.
120 struct dsa_platform_data
*pd
;
123 * The switch port to which the CPU is attached.
125 struct dsa_port
*cpu_dp
;
128 * Data for the individual switch chips.
130 struct dsa_switch
*ds
[DSA_MAX_SWITCHES
];
133 /* TC matchall action types, only mirroring for now */
134 enum dsa_port_mall_action_type
{
135 DSA_PORT_MALL_MIRROR
,
138 /* TC mirroring entry */
139 struct dsa_mall_mirror_tc_entry
{
144 /* TC matchall entry */
145 struct dsa_mall_tc_entry
{
146 struct list_head list
;
147 unsigned long cookie
;
148 enum dsa_port_mall_action_type type
;
150 struct dsa_mall_mirror_tc_entry mirror
;
156 /* A CPU port is physically connected to a master device.
157 * A user port exposed to userspace has a slave device.
160 struct net_device
*master
;
161 struct net_device
*slave
;
164 /* CPU port tagging operations used by master or slave devices */
165 const struct dsa_device_ops
*tag_ops
;
167 /* Copies for faster access in master receive hot path */
168 struct dsa_switch_tree
*dst
;
169 struct sk_buff
*(*rcv
)(struct sk_buff
*skb
, struct net_device
*dev
,
170 struct packet_type
*pt
);
171 bool (*filter
)(const struct sk_buff
*skb
, struct net_device
*dev
);
174 DSA_PORT_TYPE_UNUSED
= 0,
180 struct dsa_switch
*ds
;
183 const struct dsa_port
*cpu_dp
;
185 struct device_node
*dn
;
186 unsigned int ageing_time
;
189 struct net_device
*bridge_dev
;
190 struct devlink_port devlink_port
;
193 struct work_struct xmit_work
;
194 struct sk_buff_head xmit_queue
;
197 * Give the switch driver somewhere to hang its per-port private data
198 * structures (accessible from the tagger).
203 * Original copy of the master netdev ethtool_ops
205 const struct ethtool_ops
*orig_ethtool_ops
;
208 * Original copy of the master netdev net_device_ops
210 const struct net_device_ops
*orig_ndo_ops
;
217 * Parent switch tree, and switch index.
219 struct dsa_switch_tree
*dst
;
222 /* Listener for switch fabric events */
223 struct notifier_block nb
;
226 * Give the switch driver somewhere to hang its private data
232 * Configuration data for this switch.
234 struct dsa_chip_data
*cd
;
237 * The switch operations.
239 const struct dsa_switch_ops
*ops
;
242 * An array of which element [a] indicates which port on this
243 * switch should be used to send packets to that are destined
244 * for switch a. Can be NULL if there is only one switch chip.
246 s8 rtable
[DSA_MAX_SWITCHES
];
249 * Slave mii_bus and devices for the individual ports.
252 struct mii_bus
*slave_mii_bus
;
254 /* Ageing Time limits in msecs */
255 unsigned int ageing_time_min
;
256 unsigned int ageing_time_max
;
258 /* devlink used to represent this switch device */
259 struct devlink
*devlink
;
261 /* Number of switch port queues */
262 unsigned int num_tx_queues
;
264 /* Disallow bridge core from requesting different VLAN awareness
265 * settings on ports if not hardware-supported
267 bool vlan_filtering_is_global
;
269 /* In case vlan_filtering_is_global is set, the VLAN awareness state
270 * should be retrieved from here and not from the per-port settings.
274 unsigned long *bitmap
;
275 unsigned long _bitmap
;
277 /* Dynamically allocated ports, keep last */
279 struct dsa_port ports
[];
282 static inline const struct dsa_port
*dsa_to_port(struct dsa_switch
*ds
, int p
)
284 return &ds
->ports
[p
];
287 static inline bool dsa_is_unused_port(struct dsa_switch
*ds
, int p
)
289 return dsa_to_port(ds
, p
)->type
== DSA_PORT_TYPE_UNUSED
;
292 static inline bool dsa_is_cpu_port(struct dsa_switch
*ds
, int p
)
294 return dsa_to_port(ds
, p
)->type
== DSA_PORT_TYPE_CPU
;
297 static inline bool dsa_is_dsa_port(struct dsa_switch
*ds
, int p
)
299 return dsa_to_port(ds
, p
)->type
== DSA_PORT_TYPE_DSA
;
302 static inline bool dsa_is_user_port(struct dsa_switch
*ds
, int p
)
304 return dsa_to_port(ds
, p
)->type
== DSA_PORT_TYPE_USER
;
307 static inline u32
dsa_user_ports(struct dsa_switch
*ds
)
312 for (p
= 0; p
< ds
->num_ports
; p
++)
313 if (dsa_is_user_port(ds
, p
))
319 /* Return the local port used to reach an arbitrary switch port */
320 static inline unsigned int dsa_towards_port(struct dsa_switch
*ds
, int device
,
323 if (device
== ds
->index
)
326 return ds
->rtable
[device
];
329 /* Return the local port used to reach the dedicated CPU port */
330 static inline unsigned int dsa_upstream_port(struct dsa_switch
*ds
, int port
)
332 const struct dsa_port
*dp
= dsa_to_port(ds
, port
);
333 const struct dsa_port
*cpu_dp
= dp
->cpu_dp
;
338 return dsa_towards_port(ds
, cpu_dp
->ds
->index
, cpu_dp
->index
);
341 static inline bool dsa_port_is_vlan_filtering(const struct dsa_port
*dp
)
343 const struct dsa_switch
*ds
= dp
->ds
;
345 if (ds
->vlan_filtering_is_global
)
346 return ds
->vlan_filtering
;
348 return dp
->vlan_filtering
;
351 typedef int dsa_fdb_dump_cb_t(const unsigned char *addr
, u16 vid
,
352 bool is_static
, void *data
);
353 struct dsa_switch_ops
{
354 enum dsa_tag_protocol (*get_tag_protocol
)(struct dsa_switch
*ds
,
357 int (*setup
)(struct dsa_switch
*ds
);
358 u32 (*get_phy_flags
)(struct dsa_switch
*ds
, int port
);
361 * Access to the switch's PHY registers.
363 int (*phy_read
)(struct dsa_switch
*ds
, int port
, int regnum
);
364 int (*phy_write
)(struct dsa_switch
*ds
, int port
,
365 int regnum
, u16 val
);
368 * Link state adjustment (called from libphy)
370 void (*adjust_link
)(struct dsa_switch
*ds
, int port
,
371 struct phy_device
*phydev
);
372 void (*fixed_link_update
)(struct dsa_switch
*ds
, int port
,
373 struct fixed_phy_status
*st
);
376 * PHYLINK integration
378 void (*phylink_validate
)(struct dsa_switch
*ds
, int port
,
379 unsigned long *supported
,
380 struct phylink_link_state
*state
);
381 int (*phylink_mac_link_state
)(struct dsa_switch
*ds
, int port
,
382 struct phylink_link_state
*state
);
383 void (*phylink_mac_config
)(struct dsa_switch
*ds
, int port
,
385 const struct phylink_link_state
*state
);
386 void (*phylink_mac_an_restart
)(struct dsa_switch
*ds
, int port
);
387 void (*phylink_mac_link_down
)(struct dsa_switch
*ds
, int port
,
389 phy_interface_t interface
);
390 void (*phylink_mac_link_up
)(struct dsa_switch
*ds
, int port
,
392 phy_interface_t interface
,
393 struct phy_device
*phydev
);
394 void (*phylink_fixed_state
)(struct dsa_switch
*ds
, int port
,
395 struct phylink_link_state
*state
);
397 * ethtool hardware statistics.
399 void (*get_strings
)(struct dsa_switch
*ds
, int port
,
400 u32 stringset
, uint8_t *data
);
401 void (*get_ethtool_stats
)(struct dsa_switch
*ds
,
402 int port
, uint64_t *data
);
403 int (*get_sset_count
)(struct dsa_switch
*ds
, int port
, int sset
);
404 void (*get_ethtool_phy_stats
)(struct dsa_switch
*ds
,
405 int port
, uint64_t *data
);
408 * ethtool Wake-on-LAN
410 void (*get_wol
)(struct dsa_switch
*ds
, int port
,
411 struct ethtool_wolinfo
*w
);
412 int (*set_wol
)(struct dsa_switch
*ds
, int port
,
413 struct ethtool_wolinfo
*w
);
416 * ethtool timestamp info
418 int (*get_ts_info
)(struct dsa_switch
*ds
, int port
,
419 struct ethtool_ts_info
*ts
);
424 int (*suspend
)(struct dsa_switch
*ds
);
425 int (*resume
)(struct dsa_switch
*ds
);
428 * Port enable/disable
430 int (*port_enable
)(struct dsa_switch
*ds
, int port
,
431 struct phy_device
*phy
);
432 void (*port_disable
)(struct dsa_switch
*ds
, int port
);
435 * Port's MAC EEE settings
437 int (*set_mac_eee
)(struct dsa_switch
*ds
, int port
,
438 struct ethtool_eee
*e
);
439 int (*get_mac_eee
)(struct dsa_switch
*ds
, int port
,
440 struct ethtool_eee
*e
);
443 int (*get_eeprom_len
)(struct dsa_switch
*ds
);
444 int (*get_eeprom
)(struct dsa_switch
*ds
,
445 struct ethtool_eeprom
*eeprom
, u8
*data
);
446 int (*set_eeprom
)(struct dsa_switch
*ds
,
447 struct ethtool_eeprom
*eeprom
, u8
*data
);
452 int (*get_regs_len
)(struct dsa_switch
*ds
, int port
);
453 void (*get_regs
)(struct dsa_switch
*ds
, int port
,
454 struct ethtool_regs
*regs
, void *p
);
459 int (*set_ageing_time
)(struct dsa_switch
*ds
, unsigned int msecs
);
460 int (*port_bridge_join
)(struct dsa_switch
*ds
, int port
,
461 struct net_device
*bridge
);
462 void (*port_bridge_leave
)(struct dsa_switch
*ds
, int port
,
463 struct net_device
*bridge
);
464 void (*port_stp_state_set
)(struct dsa_switch
*ds
, int port
,
466 void (*port_fast_age
)(struct dsa_switch
*ds
, int port
);
467 int (*port_egress_floods
)(struct dsa_switch
*ds
, int port
,
468 bool unicast
, bool multicast
);
473 int (*port_vlan_filtering
)(struct dsa_switch
*ds
, int port
,
474 bool vlan_filtering
);
475 int (*port_vlan_prepare
)(struct dsa_switch
*ds
, int port
,
476 const struct switchdev_obj_port_vlan
*vlan
);
477 void (*port_vlan_add
)(struct dsa_switch
*ds
, int port
,
478 const struct switchdev_obj_port_vlan
*vlan
);
479 int (*port_vlan_del
)(struct dsa_switch
*ds
, int port
,
480 const struct switchdev_obj_port_vlan
*vlan
);
482 * Forwarding database
484 int (*port_fdb_add
)(struct dsa_switch
*ds
, int port
,
485 const unsigned char *addr
, u16 vid
);
486 int (*port_fdb_del
)(struct dsa_switch
*ds
, int port
,
487 const unsigned char *addr
, u16 vid
);
488 int (*port_fdb_dump
)(struct dsa_switch
*ds
, int port
,
489 dsa_fdb_dump_cb_t
*cb
, void *data
);
494 int (*port_mdb_prepare
)(struct dsa_switch
*ds
, int port
,
495 const struct switchdev_obj_port_mdb
*mdb
);
496 void (*port_mdb_add
)(struct dsa_switch
*ds
, int port
,
497 const struct switchdev_obj_port_mdb
*mdb
);
498 int (*port_mdb_del
)(struct dsa_switch
*ds
, int port
,
499 const struct switchdev_obj_port_mdb
*mdb
);
503 int (*get_rxnfc
)(struct dsa_switch
*ds
, int port
,
504 struct ethtool_rxnfc
*nfc
, u32
*rule_locs
);
505 int (*set_rxnfc
)(struct dsa_switch
*ds
, int port
,
506 struct ethtool_rxnfc
*nfc
);
511 int (*port_mirror_add
)(struct dsa_switch
*ds
, int port
,
512 struct dsa_mall_mirror_tc_entry
*mirror
,
514 void (*port_mirror_del
)(struct dsa_switch
*ds
, int port
,
515 struct dsa_mall_mirror_tc_entry
*mirror
);
518 * Cross-chip operations
520 int (*crosschip_bridge_join
)(struct dsa_switch
*ds
, int sw_index
,
521 int port
, struct net_device
*br
);
522 void (*crosschip_bridge_leave
)(struct dsa_switch
*ds
, int sw_index
,
523 int port
, struct net_device
*br
);
528 int (*port_hwtstamp_get
)(struct dsa_switch
*ds
, int port
,
530 int (*port_hwtstamp_set
)(struct dsa_switch
*ds
, int port
,
532 bool (*port_txtstamp
)(struct dsa_switch
*ds
, int port
,
533 struct sk_buff
*clone
, unsigned int type
);
534 bool (*port_rxtstamp
)(struct dsa_switch
*ds
, int port
,
535 struct sk_buff
*skb
, unsigned int type
);
540 netdev_tx_t (*port_deferred_xmit
)(struct dsa_switch
*ds
, int port
,
541 struct sk_buff
*skb
);
544 struct dsa_switch_driver
{
545 struct list_head list
;
546 const struct dsa_switch_ops
*ops
;
549 struct net_device
*dsa_dev_to_net_device(struct device
*dev
);
551 /* Keep inline for faster access in hot path */
552 static inline bool netdev_uses_dsa(struct net_device
*dev
)
554 #if IS_ENABLED(CONFIG_NET_DSA)
555 return dev
->dsa_ptr
&& dev
->dsa_ptr
->rcv
;
560 static inline bool dsa_can_decode(const struct sk_buff
*skb
,
561 struct net_device
*dev
)
563 #if IS_ENABLED(CONFIG_NET_DSA)
564 return !dev
->dsa_ptr
->filter
|| dev
->dsa_ptr
->filter(skb
, dev
);
569 struct dsa_switch
*dsa_switch_alloc(struct device
*dev
, size_t n
);
570 void dsa_unregister_switch(struct dsa_switch
*ds
);
571 int dsa_register_switch(struct dsa_switch
*ds
);
572 #ifdef CONFIG_PM_SLEEP
573 int dsa_switch_suspend(struct dsa_switch
*ds
);
574 int dsa_switch_resume(struct dsa_switch
*ds
);
576 static inline int dsa_switch_suspend(struct dsa_switch
*ds
)
580 static inline int dsa_switch_resume(struct dsa_switch
*ds
)
584 #endif /* CONFIG_PM_SLEEP */
586 enum dsa_notifier_type
{
591 struct dsa_notifier_info
{
592 struct net_device
*dev
;
595 struct dsa_notifier_register_info
{
596 struct dsa_notifier_info info
; /* must be first */
597 struct net_device
*master
;
598 unsigned int port_number
;
599 unsigned int switch_number
;
602 static inline struct net_device
*
603 dsa_notifier_info_to_dev(const struct dsa_notifier_info
*info
)
608 #if IS_ENABLED(CONFIG_NET_DSA)
609 int register_dsa_notifier(struct notifier_block
*nb
);
610 int unregister_dsa_notifier(struct notifier_block
*nb
);
611 int call_dsa_notifiers(unsigned long val
, struct net_device
*dev
,
612 struct dsa_notifier_info
*info
);
614 static inline int register_dsa_notifier(struct notifier_block
*nb
)
619 static inline int unregister_dsa_notifier(struct notifier_block
*nb
)
624 static inline int call_dsa_notifiers(unsigned long val
, struct net_device
*dev
,
625 struct dsa_notifier_info
*info
)
631 /* Broadcom tag specific helpers to insert and extract queue/port number */
632 #define BRCM_TAG_SET_PORT_QUEUE(p, q) ((p) << 8 | q)
633 #define BRCM_TAG_GET_PORT(v) ((v) >> 8)
634 #define BRCM_TAG_GET_QUEUE(v) ((v) & 0xff)
637 netdev_tx_t
dsa_enqueue_skb(struct sk_buff
*skb
, struct net_device
*dev
);
638 int dsa_port_get_phy_strings(struct dsa_port
*dp
, uint8_t *data
);
639 int dsa_port_get_ethtool_phy_stats(struct dsa_port
*dp
, uint64_t *data
);
640 int dsa_port_get_phy_sset_count(struct dsa_port
*dp
);
641 void dsa_port_phylink_mac_change(struct dsa_switch
*ds
, int port
, bool up
);
643 struct dsa_tag_driver
{
644 const struct dsa_device_ops
*ops
;
645 struct list_head list
;
646 struct module
*owner
;
649 void dsa_tag_drivers_register(struct dsa_tag_driver
*dsa_tag_driver_array
[],
651 struct module
*owner
);
652 void dsa_tag_drivers_unregister(struct dsa_tag_driver
*dsa_tag_driver_array
[],
655 #define dsa_tag_driver_module_drivers(__dsa_tag_drivers_array, __count) \
656 static int __init dsa_tag_driver_module_init(void) \
658 dsa_tag_drivers_register(__dsa_tag_drivers_array, __count, \
662 module_init(dsa_tag_driver_module_init); \
664 static void __exit dsa_tag_driver_module_exit(void) \
666 dsa_tag_drivers_unregister(__dsa_tag_drivers_array, __count); \
668 module_exit(dsa_tag_driver_module_exit)
671 * module_dsa_tag_drivers() - Helper macro for registering DSA tag
673 * @__ops_array: Array of tag driver strucutres
675 * Helper macro for DSA tag drivers which do not do anything special
676 * in module init/exit. Each module may only use this macro once, and
677 * calling it replaces module_init() and module_exit().
679 #define module_dsa_tag_drivers(__ops_array) \
680 dsa_tag_driver_module_drivers(__ops_array, ARRAY_SIZE(__ops_array))
682 #define DSA_TAG_DRIVER_NAME(__ops) dsa_tag_driver ## _ ## __ops
684 /* Create a static structure we can build a linked list of dsa_tag
687 #define DSA_TAG_DRIVER(__ops) \
688 static struct dsa_tag_driver DSA_TAG_DRIVER_NAME(__ops) = { \
693 * module_dsa_tag_driver() - Helper macro for registering a single DSA tag
695 * @__ops: Single tag driver structures
697 * Helper macro for DSA tag drivers which do not do anything special
698 * in module init/exit. Each module may only use this macro once, and
699 * calling it replaces module_init() and module_exit().
701 #define module_dsa_tag_driver(__ops) \
702 DSA_TAG_DRIVER(__ops); \
704 static struct dsa_tag_driver *dsa_tag_driver_array[] = { \
705 &DSA_TAG_DRIVER_NAME(__ops) \
707 module_dsa_tag_drivers(dsa_tag_driver_array)