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 <net/devlink.h>
23 #include <net/switchdev.h>
27 struct fixed_phy_status
;
29 enum dsa_tag_protocol
{
30 DSA_TAG_PROTO_NONE
= 0,
35 DSA_TAG_PROTO_LAN9303
,
38 DSA_TAG_PROTO_TRAILER
,
39 DSA_TAG_LAST
, /* MUST BE LAST */
42 #define DSA_MAX_SWITCHES 4
43 #define DSA_MAX_PORTS 12
45 #define DSA_RTABLE_NONE -1
47 struct dsa_chip_data
{
49 * How to access the switch configuration registers.
51 struct device
*host_dev
;
55 * Reference to network devices
57 struct device
*netdev
[DSA_MAX_PORTS
];
59 /* set to size of eeprom if supported by the switch */
62 /* Device tree node pointer for this specific switch chip
63 * used during switch setup in case additional properties
64 * and resources needs to be used
66 struct device_node
*of_node
;
69 * The names of the switch's ports. Use "cpu" to
70 * designate the switch port that the cpu is connected to,
71 * "dsa" to indicate that this port is a DSA link to
72 * another switch, NULL to indicate the port is unused,
73 * or any other string to indicate this is a physical port.
75 char *port_names
[DSA_MAX_PORTS
];
76 struct device_node
*port_dn
[DSA_MAX_PORTS
];
79 * An array of which element [a] indicates which port on this
80 * switch should be used to send packets to that are destined
81 * for switch a. Can be NULL if there is only one switch chip.
83 s8 rtable
[DSA_MAX_SWITCHES
];
86 struct dsa_platform_data
{
88 * Reference to a Linux network interface that connects
89 * to the root switch chip of the tree.
91 struct device
*netdev
;
92 struct net_device
*of_netdev
;
95 * Info structs describing each of the switch chips
96 * connected via this network interface.
99 struct dsa_chip_data
*chip
;
104 struct dsa_device_ops
{
105 struct sk_buff
*(*xmit
)(struct sk_buff
*skb
, struct net_device
*dev
);
106 struct sk_buff
*(*rcv
)(struct sk_buff
*skb
, struct net_device
*dev
,
107 struct packet_type
*pt
);
108 int (*flow_dissect
)(const struct sk_buff
*skb
, __be16
*proto
,
112 struct dsa_switch_tree
{
113 struct list_head list
;
115 /* Notifier chain for switch-wide events */
116 struct raw_notifier_head nh
;
118 /* Tree identifier */
121 /* Number of switches attached to this tree */
122 struct kref refcount
;
124 /* Has this tree been applied to the hardware? */
128 * Configuration data for the platform device that owns
129 * this dsa switch tree instance.
131 struct dsa_platform_data
*pd
;
134 * The switch port to which the CPU is attached.
136 struct dsa_port
*cpu_dp
;
139 * Data for the individual switch chips.
141 struct dsa_switch
*ds
[DSA_MAX_SWITCHES
];
144 /* TC matchall action types, only mirroring for now */
145 enum dsa_port_mall_action_type
{
146 DSA_PORT_MALL_MIRROR
,
149 /* TC mirroring entry */
150 struct dsa_mall_mirror_tc_entry
{
155 /* TC matchall entry */
156 struct dsa_mall_tc_entry
{
157 struct list_head list
;
158 unsigned long cookie
;
159 enum dsa_port_mall_action_type type
;
161 struct dsa_mall_mirror_tc_entry mirror
;
167 /* A CPU port is physically connected to a master device.
168 * A user port exposed to userspace has a slave device.
171 struct net_device
*master
;
172 struct net_device
*slave
;
175 /* CPU port tagging operations used by master or slave devices */
176 const struct dsa_device_ops
*tag_ops
;
178 /* Copies for faster access in master receive hot path */
179 struct dsa_switch_tree
*dst
;
180 struct sk_buff
*(*rcv
)(struct sk_buff
*skb
, struct net_device
*dev
,
181 struct packet_type
*pt
);
184 DSA_PORT_TYPE_UNUSED
= 0,
190 struct dsa_switch
*ds
;
193 struct dsa_port
*cpu_dp
;
194 struct device_node
*dn
;
195 unsigned int ageing_time
;
197 struct net_device
*bridge_dev
;
198 struct devlink_port devlink_port
;
200 * Original copy of the master netdev ethtool_ops
202 const struct ethtool_ops
*orig_ethtool_ops
;
209 * Parent switch tree, and switch index.
211 struct dsa_switch_tree
*dst
;
214 /* Listener for switch fabric events */
215 struct notifier_block nb
;
218 * Give the switch driver somewhere to hang its private data
224 * Configuration data for this switch.
226 struct dsa_chip_data
*cd
;
229 * The switch operations.
231 const struct dsa_switch_ops
*ops
;
234 * An array of which element [a] indicates which port on this
235 * switch should be used to send packets to that are destined
236 * for switch a. Can be NULL if there is only one switch chip.
238 s8 rtable
[DSA_MAX_SWITCHES
];
241 * Slave mii_bus and devices for the individual ports.
244 struct mii_bus
*slave_mii_bus
;
246 /* Ageing Time limits in msecs */
247 unsigned int ageing_time_min
;
248 unsigned int ageing_time_max
;
250 /* devlink used to represent this switch device */
251 struct devlink
*devlink
;
253 /* Number of switch port queues */
254 unsigned int num_tx_queues
;
256 /* Dynamically allocated ports, keep last */
258 struct dsa_port ports
[];
261 static inline const struct dsa_port
*dsa_to_port(struct dsa_switch
*ds
, int p
)
263 return &ds
->ports
[p
];
266 static inline bool dsa_is_unused_port(struct dsa_switch
*ds
, int p
)
268 return dsa_to_port(ds
, p
)->type
== DSA_PORT_TYPE_UNUSED
;
271 static inline bool dsa_is_cpu_port(struct dsa_switch
*ds
, int p
)
273 return dsa_to_port(ds
, p
)->type
== DSA_PORT_TYPE_CPU
;
276 static inline bool dsa_is_dsa_port(struct dsa_switch
*ds
, int p
)
278 return dsa_to_port(ds
, p
)->type
== DSA_PORT_TYPE_DSA
;
281 static inline bool dsa_is_user_port(struct dsa_switch
*ds
, int p
)
283 return dsa_to_port(ds
, p
)->type
== DSA_PORT_TYPE_USER
;
286 static inline u32
dsa_user_ports(struct dsa_switch
*ds
)
291 for (p
= 0; p
< ds
->num_ports
; p
++)
292 if (dsa_is_user_port(ds
, p
))
298 static inline u8
dsa_upstream_port(struct dsa_switch
*ds
)
300 struct dsa_switch_tree
*dst
= ds
->dst
;
303 * If this is the root switch (i.e. the switch that connects
304 * to the CPU), return the cpu port number on this switch.
305 * Else return the (DSA) port number that connects to the
306 * switch that is one hop closer to the cpu.
308 if (dst
->cpu_dp
->ds
== ds
)
309 return dst
->cpu_dp
->index
;
311 return ds
->rtable
[dst
->cpu_dp
->ds
->index
];
314 typedef int dsa_fdb_dump_cb_t(const unsigned char *addr
, u16 vid
,
315 bool is_static
, void *data
);
316 struct dsa_switch_ops
{
320 const char *(*probe
)(struct device
*dsa_dev
,
321 struct device
*host_dev
, int sw_addr
,
324 enum dsa_tag_protocol (*get_tag_protocol
)(struct dsa_switch
*ds
);
326 int (*setup
)(struct dsa_switch
*ds
);
327 u32 (*get_phy_flags
)(struct dsa_switch
*ds
, int port
);
330 * Access to the switch's PHY registers.
332 int (*phy_read
)(struct dsa_switch
*ds
, int port
, int regnum
);
333 int (*phy_write
)(struct dsa_switch
*ds
, int port
,
334 int regnum
, u16 val
);
337 * Link state adjustment (called from libphy)
339 void (*adjust_link
)(struct dsa_switch
*ds
, int port
,
340 struct phy_device
*phydev
);
341 void (*fixed_link_update
)(struct dsa_switch
*ds
, int port
,
342 struct fixed_phy_status
*st
);
345 * ethtool hardware statistics.
347 void (*get_strings
)(struct dsa_switch
*ds
, int port
, uint8_t *data
);
348 void (*get_ethtool_stats
)(struct dsa_switch
*ds
,
349 int port
, uint64_t *data
);
350 int (*get_sset_count
)(struct dsa_switch
*ds
);
353 * ethtool Wake-on-LAN
355 void (*get_wol
)(struct dsa_switch
*ds
, int port
,
356 struct ethtool_wolinfo
*w
);
357 int (*set_wol
)(struct dsa_switch
*ds
, int port
,
358 struct ethtool_wolinfo
*w
);
363 int (*suspend
)(struct dsa_switch
*ds
);
364 int (*resume
)(struct dsa_switch
*ds
);
367 * Port enable/disable
369 int (*port_enable
)(struct dsa_switch
*ds
, int port
,
370 struct phy_device
*phy
);
371 void (*port_disable
)(struct dsa_switch
*ds
, int port
,
372 struct phy_device
*phy
);
375 * Port's MAC EEE settings
377 int (*set_mac_eee
)(struct dsa_switch
*ds
, int port
,
378 struct ethtool_eee
*e
);
379 int (*get_mac_eee
)(struct dsa_switch
*ds
, int port
,
380 struct ethtool_eee
*e
);
383 int (*get_eeprom_len
)(struct dsa_switch
*ds
);
384 int (*get_eeprom
)(struct dsa_switch
*ds
,
385 struct ethtool_eeprom
*eeprom
, u8
*data
);
386 int (*set_eeprom
)(struct dsa_switch
*ds
,
387 struct ethtool_eeprom
*eeprom
, u8
*data
);
392 int (*get_regs_len
)(struct dsa_switch
*ds
, int port
);
393 void (*get_regs
)(struct dsa_switch
*ds
, int port
,
394 struct ethtool_regs
*regs
, void *p
);
399 int (*set_ageing_time
)(struct dsa_switch
*ds
, unsigned int msecs
);
400 int (*port_bridge_join
)(struct dsa_switch
*ds
, int port
,
401 struct net_device
*bridge
);
402 void (*port_bridge_leave
)(struct dsa_switch
*ds
, int port
,
403 struct net_device
*bridge
);
404 void (*port_stp_state_set
)(struct dsa_switch
*ds
, int port
,
406 void (*port_fast_age
)(struct dsa_switch
*ds
, int port
);
411 int (*port_vlan_filtering
)(struct dsa_switch
*ds
, int port
,
412 bool vlan_filtering
);
413 int (*port_vlan_prepare
)(struct dsa_switch
*ds
, int port
,
414 const struct switchdev_obj_port_vlan
*vlan
,
415 struct switchdev_trans
*trans
);
416 void (*port_vlan_add
)(struct dsa_switch
*ds
, int port
,
417 const struct switchdev_obj_port_vlan
*vlan
,
418 struct switchdev_trans
*trans
);
419 int (*port_vlan_del
)(struct dsa_switch
*ds
, int port
,
420 const struct switchdev_obj_port_vlan
*vlan
);
422 * Forwarding database
424 int (*port_fdb_add
)(struct dsa_switch
*ds
, int port
,
425 const unsigned char *addr
, u16 vid
);
426 int (*port_fdb_del
)(struct dsa_switch
*ds
, int port
,
427 const unsigned char *addr
, u16 vid
);
428 int (*port_fdb_dump
)(struct dsa_switch
*ds
, int port
,
429 dsa_fdb_dump_cb_t
*cb
, void *data
);
434 int (*port_mdb_prepare
)(struct dsa_switch
*ds
, int port
,
435 const struct switchdev_obj_port_mdb
*mdb
,
436 struct switchdev_trans
*trans
);
437 void (*port_mdb_add
)(struct dsa_switch
*ds
, int port
,
438 const struct switchdev_obj_port_mdb
*mdb
,
439 struct switchdev_trans
*trans
);
440 int (*port_mdb_del
)(struct dsa_switch
*ds
, int port
,
441 const struct switchdev_obj_port_mdb
*mdb
);
445 int (*get_rxnfc
)(struct dsa_switch
*ds
, int port
,
446 struct ethtool_rxnfc
*nfc
, u32
*rule_locs
);
447 int (*set_rxnfc
)(struct dsa_switch
*ds
, int port
,
448 struct ethtool_rxnfc
*nfc
);
453 int (*port_mirror_add
)(struct dsa_switch
*ds
, int port
,
454 struct dsa_mall_mirror_tc_entry
*mirror
,
456 void (*port_mirror_del
)(struct dsa_switch
*ds
, int port
,
457 struct dsa_mall_mirror_tc_entry
*mirror
);
460 * Cross-chip operations
462 int (*crosschip_bridge_join
)(struct dsa_switch
*ds
, int sw_index
,
463 int port
, struct net_device
*br
);
464 void (*crosschip_bridge_leave
)(struct dsa_switch
*ds
, int sw_index
,
465 int port
, struct net_device
*br
);
468 struct dsa_switch_driver
{
469 struct list_head list
;
470 const struct dsa_switch_ops
*ops
;
473 /* Legacy driver registration */
474 void register_switch_driver(struct dsa_switch_driver
*type
);
475 void unregister_switch_driver(struct dsa_switch_driver
*type
);
476 struct mii_bus
*dsa_host_dev_to_mii_bus(struct device
*dev
);
478 struct net_device
*dsa_dev_to_net_device(struct device
*dev
);
480 /* Keep inline for faster access in hot path */
481 static inline bool netdev_uses_dsa(struct net_device
*dev
)
483 #if IS_ENABLED(CONFIG_NET_DSA)
484 return dev
->dsa_ptr
&& dev
->dsa_ptr
->rcv
;
489 struct dsa_switch
*dsa_switch_alloc(struct device
*dev
, size_t n
);
490 void dsa_unregister_switch(struct dsa_switch
*ds
);
491 int dsa_register_switch(struct dsa_switch
*ds
);
492 #ifdef CONFIG_PM_SLEEP
493 int dsa_switch_suspend(struct dsa_switch
*ds
);
494 int dsa_switch_resume(struct dsa_switch
*ds
);
496 static inline int dsa_switch_suspend(struct dsa_switch
*ds
)
500 static inline int dsa_switch_resume(struct dsa_switch
*ds
)
504 #endif /* CONFIG_PM_SLEEP */
506 enum dsa_notifier_type
{
511 struct dsa_notifier_info
{
512 struct net_device
*dev
;
515 struct dsa_notifier_register_info
{
516 struct dsa_notifier_info info
; /* must be first */
517 struct net_device
*master
;
518 unsigned int port_number
;
519 unsigned int switch_number
;
522 static inline struct net_device
*
523 dsa_notifier_info_to_dev(const struct dsa_notifier_info
*info
)
528 #if IS_ENABLED(CONFIG_NET_DSA)
529 int register_dsa_notifier(struct notifier_block
*nb
);
530 int unregister_dsa_notifier(struct notifier_block
*nb
);
531 int call_dsa_notifiers(unsigned long val
, struct net_device
*dev
,
532 struct dsa_notifier_info
*info
);
534 static inline int register_dsa_notifier(struct notifier_block
*nb
)
539 static inline int unregister_dsa_notifier(struct notifier_block
*nb
)
544 static inline int call_dsa_notifiers(unsigned long val
, struct net_device
*dev
,
545 struct dsa_notifier_info
*info
)
551 /* Broadcom tag specific helpers to insert and extract queue/port number */
552 #define BRCM_TAG_SET_PORT_QUEUE(p, q) ((p) << 8 | q)
553 #define BRCM_TAG_GET_PORT(v) ((v) >> 8)
554 #define BRCM_TAG_GET_QUEUE(v) ((v) & 0xff)