2 * include/net/dsa.h - Driver for Distributed Switch Architecture switch chips
3 * Copyright (c) 2008-2009 Marvell Semiconductor
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
11 #ifndef __LINUX_NET_DSA_H
12 #define __LINUX_NET_DSA_H
15 #include <linux/if_ether.h>
16 #include <linux/list.h>
17 #include <linux/notifier.h>
18 #include <linux/timer.h>
19 #include <linux/workqueue.h>
21 #include <linux/ethtool.h>
22 #include <linux/net_tstamp.h>
23 #include <linux/phy.h>
24 #include <linux/platform_data/dsa.h>
25 #include <net/devlink.h>
26 #include <net/switchdev.h>
30 struct fixed_phy_status
;
31 struct phylink_link_state
;
33 #define DSA_TAG_PROTO_NONE_VALUE 0
34 #define DSA_TAG_PROTO_BRCM_VALUE 1
35 #define DSA_TAG_PROTO_BRCM_PREPEND_VALUE 2
36 #define DSA_TAG_PROTO_DSA_VALUE 3
37 #define DSA_TAG_PROTO_EDSA_VALUE 4
38 #define DSA_TAG_PROTO_GSWIP_VALUE 5
39 #define DSA_TAG_PROTO_KSZ9477_VALUE 6
40 #define DSA_TAG_PROTO_KSZ9893_VALUE 7
41 #define DSA_TAG_PROTO_LAN9303_VALUE 8
42 #define DSA_TAG_PROTO_MTK_VALUE 9
43 #define DSA_TAG_PROTO_QCA_VALUE 10
44 #define DSA_TAG_PROTO_TRAILER_VALUE 11
45 #define DSA_TAG_PROTO_8021Q_VALUE 12
46 #define DSA_TAG_PROTO_SJA1105_VALUE 13
48 enum dsa_tag_protocol
{
49 DSA_TAG_PROTO_NONE
= DSA_TAG_PROTO_NONE_VALUE
,
50 DSA_TAG_PROTO_BRCM
= DSA_TAG_PROTO_BRCM_VALUE
,
51 DSA_TAG_PROTO_BRCM_PREPEND
= DSA_TAG_PROTO_BRCM_PREPEND_VALUE
,
52 DSA_TAG_PROTO_DSA
= DSA_TAG_PROTO_DSA_VALUE
,
53 DSA_TAG_PROTO_EDSA
= DSA_TAG_PROTO_EDSA_VALUE
,
54 DSA_TAG_PROTO_GSWIP
= DSA_TAG_PROTO_GSWIP_VALUE
,
55 DSA_TAG_PROTO_KSZ9477
= DSA_TAG_PROTO_KSZ9477_VALUE
,
56 DSA_TAG_PROTO_KSZ9893
= DSA_TAG_PROTO_KSZ9893_VALUE
,
57 DSA_TAG_PROTO_LAN9303
= DSA_TAG_PROTO_LAN9303_VALUE
,
58 DSA_TAG_PROTO_MTK
= DSA_TAG_PROTO_MTK_VALUE
,
59 DSA_TAG_PROTO_QCA
= DSA_TAG_PROTO_QCA_VALUE
,
60 DSA_TAG_PROTO_TRAILER
= DSA_TAG_PROTO_TRAILER_VALUE
,
61 DSA_TAG_PROTO_8021Q
= DSA_TAG_PROTO_8021Q_VALUE
,
62 DSA_TAG_PROTO_SJA1105
= DSA_TAG_PROTO_SJA1105_VALUE
,
68 struct dsa_device_ops
{
69 struct sk_buff
*(*xmit
)(struct sk_buff
*skb
, struct net_device
*dev
);
70 struct sk_buff
*(*rcv
)(struct sk_buff
*skb
, struct net_device
*dev
,
71 struct packet_type
*pt
);
72 int (*flow_dissect
)(const struct sk_buff
*skb
, __be16
*proto
,
74 /* Used to determine which traffic should match the DSA filter in
75 * eth_type_trans, and which, if any, should bypass it and be processed
76 * as regular on the master net device.
78 bool (*filter
)(const struct sk_buff
*skb
, struct net_device
*dev
);
79 unsigned int overhead
;
81 enum dsa_tag_protocol proto
;
84 #define DSA_TAG_DRIVER_ALIAS "dsa_tag-"
85 #define MODULE_ALIAS_DSA_TAG_DRIVER(__proto) \
86 MODULE_ALIAS(DSA_TAG_DRIVER_ALIAS __stringify(__proto##_VALUE))
89 struct sk_buff
*clone
;
95 u8 priv
[48 - sizeof(struct dsa_skb_cb
)];
98 #define __DSA_SKB_CB(skb) ((struct __dsa_skb_cb *)((skb)->cb))
100 #define DSA_SKB_CB(skb) ((struct dsa_skb_cb *)((skb)->cb))
102 #define DSA_SKB_CB_PRIV(skb) \
103 ((void *)(skb)->cb + offsetof(struct __dsa_skb_cb, priv))
105 struct dsa_switch_tree
{
106 struct list_head list
;
108 /* Notifier chain for switch-wide events */
109 struct raw_notifier_head nh
;
111 /* Tree identifier */
114 /* Number of switches attached to this tree */
115 struct kref refcount
;
117 /* Has this tree been applied to the hardware? */
121 * Configuration data for the platform device that owns
122 * this dsa switch tree instance.
124 struct dsa_platform_data
*pd
;
127 * The switch port to which the CPU is attached.
129 struct dsa_port
*cpu_dp
;
132 * Data for the individual switch chips.
134 struct dsa_switch
*ds
[DSA_MAX_SWITCHES
];
137 /* TC matchall action types, only mirroring for now */
138 enum dsa_port_mall_action_type
{
139 DSA_PORT_MALL_MIRROR
,
142 /* TC mirroring entry */
143 struct dsa_mall_mirror_tc_entry
{
148 /* TC matchall entry */
149 struct dsa_mall_tc_entry
{
150 struct list_head list
;
151 unsigned long cookie
;
152 enum dsa_port_mall_action_type type
;
154 struct dsa_mall_mirror_tc_entry mirror
;
160 /* A CPU port is physically connected to a master device.
161 * A user port exposed to userspace has a slave device.
164 struct net_device
*master
;
165 struct net_device
*slave
;
168 /* CPU port tagging operations used by master or slave devices */
169 const struct dsa_device_ops
*tag_ops
;
171 /* Copies for faster access in master receive hot path */
172 struct dsa_switch_tree
*dst
;
173 struct sk_buff
*(*rcv
)(struct sk_buff
*skb
, struct net_device
*dev
,
174 struct packet_type
*pt
);
175 bool (*filter
)(const struct sk_buff
*skb
, struct net_device
*dev
);
178 DSA_PORT_TYPE_UNUSED
= 0,
184 struct dsa_switch
*ds
;
187 const struct dsa_port
*cpu_dp
;
189 struct device_node
*dn
;
190 unsigned int ageing_time
;
193 struct net_device
*bridge_dev
;
194 struct devlink_port devlink_port
;
197 struct work_struct xmit_work
;
198 struct sk_buff_head xmit_queue
;
201 * Give the switch driver somewhere to hang its per-port private data
202 * structures (accessible from the tagger).
207 * Original copy of the master netdev ethtool_ops
209 const struct ethtool_ops
*orig_ethtool_ops
;
212 * Original copy of the master netdev net_device_ops
214 const struct net_device_ops
*orig_ndo_ops
;
221 * Parent switch tree, and switch index.
223 struct dsa_switch_tree
*dst
;
226 /* Listener for switch fabric events */
227 struct notifier_block nb
;
230 * Give the switch driver somewhere to hang its private data
236 * Configuration data for this switch.
238 struct dsa_chip_data
*cd
;
241 * The switch operations.
243 const struct dsa_switch_ops
*ops
;
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.
250 s8 rtable
[DSA_MAX_SWITCHES
];
253 * Slave mii_bus and devices for the individual ports.
256 struct mii_bus
*slave_mii_bus
;
258 /* Ageing Time limits in msecs */
259 unsigned int ageing_time_min
;
260 unsigned int ageing_time_max
;
262 /* devlink used to represent this switch device */
263 struct devlink
*devlink
;
265 /* Number of switch port queues */
266 unsigned int num_tx_queues
;
268 /* Disallow bridge core from requesting different VLAN awareness
269 * settings on ports if not hardware-supported
271 bool vlan_filtering_is_global
;
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.
278 unsigned long *bitmap
;
279 unsigned long _bitmap
;
281 /* Dynamically allocated ports, keep last */
283 struct dsa_port ports
[];
286 static inline const struct dsa_port
*dsa_to_port(struct dsa_switch
*ds
, int p
)
288 return &ds
->ports
[p
];
291 static inline bool dsa_is_unused_port(struct dsa_switch
*ds
, int p
)
293 return dsa_to_port(ds
, p
)->type
== DSA_PORT_TYPE_UNUSED
;
296 static inline bool dsa_is_cpu_port(struct dsa_switch
*ds
, int p
)
298 return dsa_to_port(ds
, p
)->type
== DSA_PORT_TYPE_CPU
;
301 static inline bool dsa_is_dsa_port(struct dsa_switch
*ds
, int p
)
303 return dsa_to_port(ds
, p
)->type
== DSA_PORT_TYPE_DSA
;
306 static inline bool dsa_is_user_port(struct dsa_switch
*ds
, int p
)
308 return dsa_to_port(ds
, p
)->type
== DSA_PORT_TYPE_USER
;
311 static inline u32
dsa_user_ports(struct dsa_switch
*ds
)
316 for (p
= 0; p
< ds
->num_ports
; p
++)
317 if (dsa_is_user_port(ds
, p
))
323 /* Return the local port used to reach an arbitrary switch port */
324 static inline unsigned int dsa_towards_port(struct dsa_switch
*ds
, int device
,
327 if (device
== ds
->index
)
330 return ds
->rtable
[device
];
333 /* Return the local port used to reach the dedicated CPU port */
334 static inline unsigned int dsa_upstream_port(struct dsa_switch
*ds
, int port
)
336 const struct dsa_port
*dp
= dsa_to_port(ds
, port
);
337 const struct dsa_port
*cpu_dp
= dp
->cpu_dp
;
342 return dsa_towards_port(ds
, cpu_dp
->ds
->index
, cpu_dp
->index
);
345 static inline bool dsa_port_is_vlan_filtering(const struct dsa_port
*dp
)
347 const struct dsa_switch
*ds
= dp
->ds
;
349 if (ds
->vlan_filtering_is_global
)
350 return ds
->vlan_filtering
;
352 return dp
->vlan_filtering
;
355 typedef int dsa_fdb_dump_cb_t(const unsigned char *addr
, u16 vid
,
356 bool is_static
, void *data
);
357 struct dsa_switch_ops
{
358 enum dsa_tag_protocol (*get_tag_protocol
)(struct dsa_switch
*ds
,
361 int (*setup
)(struct dsa_switch
*ds
);
362 u32 (*get_phy_flags
)(struct dsa_switch
*ds
, int port
);
365 * Access to the switch's PHY registers.
367 int (*phy_read
)(struct dsa_switch
*ds
, int port
, int regnum
);
368 int (*phy_write
)(struct dsa_switch
*ds
, int port
,
369 int regnum
, u16 val
);
372 * Link state adjustment (called from libphy)
374 void (*adjust_link
)(struct dsa_switch
*ds
, int port
,
375 struct phy_device
*phydev
);
376 void (*fixed_link_update
)(struct dsa_switch
*ds
, int port
,
377 struct fixed_phy_status
*st
);
380 * PHYLINK integration
382 void (*phylink_validate
)(struct dsa_switch
*ds
, int port
,
383 unsigned long *supported
,
384 struct phylink_link_state
*state
);
385 int (*phylink_mac_link_state
)(struct dsa_switch
*ds
, int port
,
386 struct phylink_link_state
*state
);
387 void (*phylink_mac_config
)(struct dsa_switch
*ds
, int port
,
389 const struct phylink_link_state
*state
);
390 void (*phylink_mac_an_restart
)(struct dsa_switch
*ds
, int port
);
391 void (*phylink_mac_link_down
)(struct dsa_switch
*ds
, int port
,
393 phy_interface_t interface
);
394 void (*phylink_mac_link_up
)(struct dsa_switch
*ds
, int port
,
396 phy_interface_t interface
,
397 struct phy_device
*phydev
);
398 void (*phylink_fixed_state
)(struct dsa_switch
*ds
, int port
,
399 struct phylink_link_state
*state
);
401 * ethtool hardware statistics.
403 void (*get_strings
)(struct dsa_switch
*ds
, int port
,
404 u32 stringset
, uint8_t *data
);
405 void (*get_ethtool_stats
)(struct dsa_switch
*ds
,
406 int port
, uint64_t *data
);
407 int (*get_sset_count
)(struct dsa_switch
*ds
, int port
, int sset
);
408 void (*get_ethtool_phy_stats
)(struct dsa_switch
*ds
,
409 int port
, uint64_t *data
);
412 * ethtool Wake-on-LAN
414 void (*get_wol
)(struct dsa_switch
*ds
, int port
,
415 struct ethtool_wolinfo
*w
);
416 int (*set_wol
)(struct dsa_switch
*ds
, int port
,
417 struct ethtool_wolinfo
*w
);
420 * ethtool timestamp info
422 int (*get_ts_info
)(struct dsa_switch
*ds
, int port
,
423 struct ethtool_ts_info
*ts
);
428 int (*suspend
)(struct dsa_switch
*ds
);
429 int (*resume
)(struct dsa_switch
*ds
);
432 * Port enable/disable
434 int (*port_enable
)(struct dsa_switch
*ds
, int port
,
435 struct phy_device
*phy
);
436 void (*port_disable
)(struct dsa_switch
*ds
, int port
);
439 * Port's MAC EEE settings
441 int (*set_mac_eee
)(struct dsa_switch
*ds
, int port
,
442 struct ethtool_eee
*e
);
443 int (*get_mac_eee
)(struct dsa_switch
*ds
, int port
,
444 struct ethtool_eee
*e
);
447 int (*get_eeprom_len
)(struct dsa_switch
*ds
);
448 int (*get_eeprom
)(struct dsa_switch
*ds
,
449 struct ethtool_eeprom
*eeprom
, u8
*data
);
450 int (*set_eeprom
)(struct dsa_switch
*ds
,
451 struct ethtool_eeprom
*eeprom
, u8
*data
);
456 int (*get_regs_len
)(struct dsa_switch
*ds
, int port
);
457 void (*get_regs
)(struct dsa_switch
*ds
, int port
,
458 struct ethtool_regs
*regs
, void *p
);
463 int (*set_ageing_time
)(struct dsa_switch
*ds
, unsigned int msecs
);
464 int (*port_bridge_join
)(struct dsa_switch
*ds
, int port
,
465 struct net_device
*bridge
);
466 void (*port_bridge_leave
)(struct dsa_switch
*ds
, int port
,
467 struct net_device
*bridge
);
468 void (*port_stp_state_set
)(struct dsa_switch
*ds
, int port
,
470 void (*port_fast_age
)(struct dsa_switch
*ds
, int port
);
471 int (*port_egress_floods
)(struct dsa_switch
*ds
, int port
,
472 bool unicast
, bool multicast
);
477 int (*port_vlan_filtering
)(struct dsa_switch
*ds
, int port
,
478 bool vlan_filtering
);
479 int (*port_vlan_prepare
)(struct dsa_switch
*ds
, int port
,
480 const struct switchdev_obj_port_vlan
*vlan
);
481 void (*port_vlan_add
)(struct dsa_switch
*ds
, int port
,
482 const struct switchdev_obj_port_vlan
*vlan
);
483 int (*port_vlan_del
)(struct dsa_switch
*ds
, int port
,
484 const struct switchdev_obj_port_vlan
*vlan
);
486 * Forwarding database
488 int (*port_fdb_add
)(struct dsa_switch
*ds
, int port
,
489 const unsigned char *addr
, u16 vid
);
490 int (*port_fdb_del
)(struct dsa_switch
*ds
, int port
,
491 const unsigned char *addr
, u16 vid
);
492 int (*port_fdb_dump
)(struct dsa_switch
*ds
, int port
,
493 dsa_fdb_dump_cb_t
*cb
, void *data
);
498 int (*port_mdb_prepare
)(struct dsa_switch
*ds
, int port
,
499 const struct switchdev_obj_port_mdb
*mdb
);
500 void (*port_mdb_add
)(struct dsa_switch
*ds
, int port
,
501 const struct switchdev_obj_port_mdb
*mdb
);
502 int (*port_mdb_del
)(struct dsa_switch
*ds
, int port
,
503 const struct switchdev_obj_port_mdb
*mdb
);
507 int (*get_rxnfc
)(struct dsa_switch
*ds
, int port
,
508 struct ethtool_rxnfc
*nfc
, u32
*rule_locs
);
509 int (*set_rxnfc
)(struct dsa_switch
*ds
, int port
,
510 struct ethtool_rxnfc
*nfc
);
515 int (*port_mirror_add
)(struct dsa_switch
*ds
, int port
,
516 struct dsa_mall_mirror_tc_entry
*mirror
,
518 void (*port_mirror_del
)(struct dsa_switch
*ds
, int port
,
519 struct dsa_mall_mirror_tc_entry
*mirror
);
522 * Cross-chip operations
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
);
532 int (*port_hwtstamp_get
)(struct dsa_switch
*ds
, int port
,
534 int (*port_hwtstamp_set
)(struct dsa_switch
*ds
, int port
,
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
);
544 netdev_tx_t (*port_deferred_xmit
)(struct dsa_switch
*ds
, int port
,
545 struct sk_buff
*skb
);
548 struct dsa_switch_driver
{
549 struct list_head list
;
550 const struct dsa_switch_ops
*ops
;
553 struct net_device
*dsa_dev_to_net_device(struct device
*dev
);
555 /* Keep inline for faster access in hot path */
556 static inline bool netdev_uses_dsa(struct net_device
*dev
)
558 #if IS_ENABLED(CONFIG_NET_DSA)
559 return dev
->dsa_ptr
&& dev
->dsa_ptr
->rcv
;
564 static inline bool dsa_can_decode(const struct sk_buff
*skb
,
565 struct net_device
*dev
)
567 #if IS_ENABLED(CONFIG_NET_DSA)
568 return !dev
->dsa_ptr
->filter
|| dev
->dsa_ptr
->filter(skb
, dev
);
573 struct dsa_switch
*dsa_switch_alloc(struct device
*dev
, size_t n
);
574 void dsa_unregister_switch(struct dsa_switch
*ds
);
575 int dsa_register_switch(struct dsa_switch
*ds
);
576 #ifdef CONFIG_PM_SLEEP
577 int dsa_switch_suspend(struct dsa_switch
*ds
);
578 int dsa_switch_resume(struct dsa_switch
*ds
);
580 static inline int dsa_switch_suspend(struct dsa_switch
*ds
)
584 static inline int dsa_switch_resume(struct dsa_switch
*ds
)
588 #endif /* CONFIG_PM_SLEEP */
590 enum dsa_notifier_type
{
595 struct dsa_notifier_info
{
596 struct net_device
*dev
;
599 struct 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
;
606 static inline struct net_device
*
607 dsa_notifier_info_to_dev(const struct dsa_notifier_info
*info
)
612 #if IS_ENABLED(CONFIG_NET_DSA)
613 int register_dsa_notifier(struct notifier_block
*nb
);
614 int unregister_dsa_notifier(struct notifier_block
*nb
);
615 int call_dsa_notifiers(unsigned long val
, struct net_device
*dev
,
616 struct dsa_notifier_info
*info
);
618 static inline int register_dsa_notifier(struct notifier_block
*nb
)
623 static inline int unregister_dsa_notifier(struct notifier_block
*nb
)
628 static inline int call_dsa_notifiers(unsigned long val
, struct net_device
*dev
,
629 struct dsa_notifier_info
*info
)
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)
641 netdev_tx_t
dsa_enqueue_skb(struct sk_buff
*skb
, struct net_device
*dev
);
642 int dsa_port_get_phy_strings(struct dsa_port
*dp
, uint8_t *data
);
643 int dsa_port_get_ethtool_phy_stats(struct dsa_port
*dp
, uint64_t *data
);
644 int dsa_port_get_phy_sset_count(struct dsa_port
*dp
);
645 void dsa_port_phylink_mac_change(struct dsa_switch
*ds
, int port
, bool up
);
647 struct dsa_tag_driver
{
648 const struct dsa_device_ops
*ops
;
649 struct list_head list
;
650 struct module
*owner
;
653 void dsa_tag_drivers_register(struct dsa_tag_driver
*dsa_tag_driver_array
[],
655 struct module
*owner
);
656 void dsa_tag_drivers_unregister(struct dsa_tag_driver
*dsa_tag_driver_array
[],
659 #define dsa_tag_driver_module_drivers(__dsa_tag_drivers_array, __count) \
660 static int __init dsa_tag_driver_module_init(void) \
662 dsa_tag_drivers_register(__dsa_tag_drivers_array, __count, \
666 module_init(dsa_tag_driver_module_init); \
668 static void __exit dsa_tag_driver_module_exit(void) \
670 dsa_tag_drivers_unregister(__dsa_tag_drivers_array, __count); \
672 module_exit(dsa_tag_driver_module_exit)
675 * module_dsa_tag_drivers() - Helper macro for registering DSA tag
677 * @__ops_array: Array of tag driver strucutres
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().
683 #define module_dsa_tag_drivers(__ops_array) \
684 dsa_tag_driver_module_drivers(__ops_array, ARRAY_SIZE(__ops_array))
686 #define DSA_TAG_DRIVER_NAME(__ops) dsa_tag_driver ## _ ## __ops
688 /* Create a static structure we can build a linked list of dsa_tag
691 #define DSA_TAG_DRIVER(__ops) \
692 static struct dsa_tag_driver DSA_TAG_DRIVER_NAME(__ops) = { \
697 * module_dsa_tag_driver() - Helper macro for registering a single DSA tag
699 * @__ops: Single tag driver structures
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().
705 #define module_dsa_tag_driver(__ops) \
706 DSA_TAG_DRIVER(__ops); \
708 static struct dsa_tag_driver *dsa_tag_driver_array[] = { \
709 &DSA_TAG_DRIVER_NAME(__ops) \
711 module_dsa_tag_drivers(dsa_tag_driver_array)