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,
34 DSA_TAG_PROTO_LAN9303
,
37 DSA_TAG_PROTO_TRAILER
,
38 DSA_TAG_LAST
, /* MUST BE LAST */
41 #define DSA_MAX_SWITCHES 4
42 #define DSA_MAX_PORTS 12
44 #define DSA_RTABLE_NONE -1
46 struct dsa_chip_data
{
48 * How to access the switch configuration registers.
50 struct device
*host_dev
;
54 * Reference to network devices
56 struct device
*netdev
[DSA_MAX_PORTS
];
58 /* set to size of eeprom if supported by the switch */
61 /* Device tree node pointer for this specific switch chip
62 * used during switch setup in case additional properties
63 * and resources needs to be used
65 struct device_node
*of_node
;
68 * The names of the switch's ports. Use "cpu" to
69 * designate the switch port that the cpu is connected to,
70 * "dsa" to indicate that this port is a DSA link to
71 * another switch, NULL to indicate the port is unused,
72 * or any other string to indicate this is a physical port.
74 char *port_names
[DSA_MAX_PORTS
];
75 struct device_node
*port_dn
[DSA_MAX_PORTS
];
78 * An array of which element [a] indicates which port on this
79 * switch should be used to send packets to that are destined
80 * for switch a. Can be NULL if there is only one switch chip.
82 s8 rtable
[DSA_MAX_SWITCHES
];
85 struct dsa_platform_data
{
87 * Reference to a Linux network interface that connects
88 * to the root switch chip of the tree.
90 struct device
*netdev
;
91 struct net_device
*of_netdev
;
94 * Info structs describing each of the switch chips
95 * connected via this network interface.
98 struct dsa_chip_data
*chip
;
103 struct dsa_switch_tree
{
104 struct list_head list
;
106 /* Notifier chain for switch-wide events */
107 struct raw_notifier_head nh
;
109 /* Tree identifier */
112 /* Number of switches attached to this tree */
113 struct kref refcount
;
115 /* Has this tree been applied to the hardware? */
119 * Configuration data for the platform device that owns
120 * this dsa switch tree instance.
122 struct dsa_platform_data
*pd
;
125 * Reference to network device to use, and which tagging
128 struct net_device
*master_netdev
;
129 struct sk_buff
* (*rcv
)(struct sk_buff
*skb
,
130 struct net_device
*dev
,
131 struct packet_type
*pt
,
132 struct net_device
*orig_dev
);
135 * Original copy of the master netdev ethtool_ops
137 struct ethtool_ops master_ethtool_ops
;
138 const struct ethtool_ops
*master_orig_ethtool_ops
;
141 * The switch port to which the CPU is attached.
143 struct dsa_port
*cpu_dp
;
146 * Data for the individual switch chips.
148 struct dsa_switch
*ds
[DSA_MAX_SWITCHES
];
151 * Tagging protocol operations for adding and removing an
154 const struct dsa_device_ops
*tag_ops
;
157 /* TC matchall action types, only mirroring for now */
158 enum dsa_port_mall_action_type
{
159 DSA_PORT_MALL_MIRROR
,
162 /* TC mirroring entry */
163 struct dsa_mall_mirror_tc_entry
{
168 /* TC matchall entry */
169 struct dsa_mall_tc_entry
{
170 struct list_head list
;
171 unsigned long cookie
;
172 enum dsa_port_mall_action_type type
;
174 struct dsa_mall_mirror_tc_entry mirror
;
180 struct dsa_switch
*ds
;
183 struct net_device
*netdev
;
184 struct device_node
*dn
;
185 unsigned int ageing_time
;
187 struct net_device
*bridge_dev
;
188 struct devlink_port devlink_port
;
195 * Parent switch tree, and switch index.
197 struct dsa_switch_tree
*dst
;
200 /* Listener for switch fabric events */
201 struct notifier_block nb
;
204 * Give the switch driver somewhere to hang its private data
210 * Configuration data for this switch.
212 struct dsa_chip_data
*cd
;
215 * The switch operations.
217 const struct dsa_switch_ops
*ops
;
220 * An array of which element [a] indicates which port on this
221 * switch should be used to send packets to that are destined
222 * for switch a. Can be NULL if there is only one switch chip.
224 s8 rtable
[DSA_MAX_SWITCHES
];
227 * The lower device this switch uses to talk to the host
229 struct net_device
*master_netdev
;
232 * Slave mii_bus and devices for the individual ports.
236 u32 enabled_port_mask
;
238 struct mii_bus
*slave_mii_bus
;
240 /* Ageing Time limits in msecs */
241 unsigned int ageing_time_min
;
242 unsigned int ageing_time_max
;
244 /* devlink used to represent this switch device */
245 struct devlink
*devlink
;
247 /* Dynamically allocated ports, keep last */
249 struct dsa_port ports
[];
252 static inline bool dsa_is_cpu_port(struct dsa_switch
*ds
, int p
)
254 return ds
->dst
->cpu_dp
== &ds
->ports
[p
];
257 static inline bool dsa_is_dsa_port(struct dsa_switch
*ds
, int p
)
259 return !!((ds
->dsa_port_mask
) & (1 << p
));
262 static inline bool dsa_is_normal_port(struct dsa_switch
*ds
, int p
)
264 return !dsa_is_cpu_port(ds
, p
) && !dsa_is_dsa_port(ds
, p
);
267 static inline bool dsa_is_port_initialized(struct dsa_switch
*ds
, int p
)
269 return ds
->enabled_port_mask
& (1 << p
) && ds
->ports
[p
].netdev
;
272 static inline u8
dsa_upstream_port(struct dsa_switch
*ds
)
274 struct dsa_switch_tree
*dst
= ds
->dst
;
277 * If this is the root switch (i.e. the switch that connects
278 * to the CPU), return the cpu port number on this switch.
279 * Else return the (DSA) port number that connects to the
280 * switch that is one hop closer to the cpu.
282 if (dst
->cpu_dp
->ds
== ds
)
283 return dst
->cpu_dp
->index
;
285 return ds
->rtable
[dst
->cpu_dp
->ds
->index
];
288 #define DSA_NOTIFIER_BRIDGE_JOIN 1
289 #define DSA_NOTIFIER_BRIDGE_LEAVE 2
291 /* DSA_NOTIFIER_BRIDGE_* */
292 struct dsa_notifier_bridge_info
{
293 struct net_device
*br
;
298 struct dsa_switch_ops
{
302 const char *(*probe
)(struct device
*dsa_dev
,
303 struct device
*host_dev
, int sw_addr
,
306 enum dsa_tag_protocol (*get_tag_protocol
)(struct dsa_switch
*ds
);
308 int (*setup
)(struct dsa_switch
*ds
);
309 int (*set_addr
)(struct dsa_switch
*ds
, u8
*addr
);
310 u32 (*get_phy_flags
)(struct dsa_switch
*ds
, int port
);
313 * Access to the switch's PHY registers.
315 int (*phy_read
)(struct dsa_switch
*ds
, int port
, int regnum
);
316 int (*phy_write
)(struct dsa_switch
*ds
, int port
,
317 int regnum
, u16 val
);
320 * Link state adjustment (called from libphy)
322 void (*adjust_link
)(struct dsa_switch
*ds
, int port
,
323 struct phy_device
*phydev
);
324 void (*fixed_link_update
)(struct dsa_switch
*ds
, int port
,
325 struct fixed_phy_status
*st
);
328 * ethtool hardware statistics.
330 void (*get_strings
)(struct dsa_switch
*ds
, int port
, uint8_t *data
);
331 void (*get_ethtool_stats
)(struct dsa_switch
*ds
,
332 int port
, uint64_t *data
);
333 int (*get_sset_count
)(struct dsa_switch
*ds
);
336 * ethtool Wake-on-LAN
338 void (*get_wol
)(struct dsa_switch
*ds
, int port
,
339 struct ethtool_wolinfo
*w
);
340 int (*set_wol
)(struct dsa_switch
*ds
, int port
,
341 struct ethtool_wolinfo
*w
);
346 int (*suspend
)(struct dsa_switch
*ds
);
347 int (*resume
)(struct dsa_switch
*ds
);
350 * Port enable/disable
352 int (*port_enable
)(struct dsa_switch
*ds
, int port
,
353 struct phy_device
*phy
);
354 void (*port_disable
)(struct dsa_switch
*ds
, int port
,
355 struct phy_device
*phy
);
360 int (*set_eee
)(struct dsa_switch
*ds
, int port
,
361 struct phy_device
*phydev
,
362 struct ethtool_eee
*e
);
363 int (*get_eee
)(struct dsa_switch
*ds
, int port
,
364 struct ethtool_eee
*e
);
367 int (*get_eeprom_len
)(struct dsa_switch
*ds
);
368 int (*get_eeprom
)(struct dsa_switch
*ds
,
369 struct ethtool_eeprom
*eeprom
, u8
*data
);
370 int (*set_eeprom
)(struct dsa_switch
*ds
,
371 struct ethtool_eeprom
*eeprom
, u8
*data
);
376 int (*get_regs_len
)(struct dsa_switch
*ds
, int port
);
377 void (*get_regs
)(struct dsa_switch
*ds
, int port
,
378 struct ethtool_regs
*regs
, void *p
);
383 int (*set_ageing_time
)(struct dsa_switch
*ds
, unsigned int msecs
);
384 int (*port_bridge_join
)(struct dsa_switch
*ds
, int port
,
385 struct net_device
*bridge
);
386 void (*port_bridge_leave
)(struct dsa_switch
*ds
, int port
,
387 struct net_device
*bridge
);
388 void (*port_stp_state_set
)(struct dsa_switch
*ds
, int port
,
390 void (*port_fast_age
)(struct dsa_switch
*ds
, int port
);
395 int (*port_vlan_filtering
)(struct dsa_switch
*ds
, int port
,
396 bool vlan_filtering
);
397 int (*port_vlan_prepare
)(struct dsa_switch
*ds
, int port
,
398 const struct switchdev_obj_port_vlan
*vlan
,
399 struct switchdev_trans
*trans
);
400 void (*port_vlan_add
)(struct dsa_switch
*ds
, int port
,
401 const struct switchdev_obj_port_vlan
*vlan
,
402 struct switchdev_trans
*trans
);
403 int (*port_vlan_del
)(struct dsa_switch
*ds
, int port
,
404 const struct switchdev_obj_port_vlan
*vlan
);
405 int (*port_vlan_dump
)(struct dsa_switch
*ds
, int port
,
406 struct switchdev_obj_port_vlan
*vlan
,
407 int (*cb
)(struct switchdev_obj
*obj
));
410 * Forwarding database
412 int (*port_fdb_prepare
)(struct dsa_switch
*ds
, int port
,
413 const struct switchdev_obj_port_fdb
*fdb
,
414 struct switchdev_trans
*trans
);
415 void (*port_fdb_add
)(struct dsa_switch
*ds
, int port
,
416 const struct switchdev_obj_port_fdb
*fdb
,
417 struct switchdev_trans
*trans
);
418 int (*port_fdb_del
)(struct dsa_switch
*ds
, int port
,
419 const struct switchdev_obj_port_fdb
*fdb
);
420 int (*port_fdb_dump
)(struct dsa_switch
*ds
, int port
,
421 struct switchdev_obj_port_fdb
*fdb
,
422 int (*cb
)(struct switchdev_obj
*obj
));
427 int (*port_mdb_prepare
)(struct dsa_switch
*ds
, int port
,
428 const struct switchdev_obj_port_mdb
*mdb
,
429 struct switchdev_trans
*trans
);
430 void (*port_mdb_add
)(struct dsa_switch
*ds
, int port
,
431 const struct switchdev_obj_port_mdb
*mdb
,
432 struct switchdev_trans
*trans
);
433 int (*port_mdb_del
)(struct dsa_switch
*ds
, int port
,
434 const struct switchdev_obj_port_mdb
*mdb
);
435 int (*port_mdb_dump
)(struct dsa_switch
*ds
, int port
,
436 struct switchdev_obj_port_mdb
*mdb
,
437 int (*cb
)(struct switchdev_obj
*obj
));
442 int (*get_rxnfc
)(struct dsa_switch
*ds
, int port
,
443 struct ethtool_rxnfc
*nfc
, u32
*rule_locs
);
444 int (*set_rxnfc
)(struct dsa_switch
*ds
, int port
,
445 struct ethtool_rxnfc
*nfc
);
450 int (*port_mirror_add
)(struct dsa_switch
*ds
, int port
,
451 struct dsa_mall_mirror_tc_entry
*mirror
,
453 void (*port_mirror_del
)(struct dsa_switch
*ds
, int port
,
454 struct dsa_mall_mirror_tc_entry
*mirror
);
457 * Cross-chip operations
459 int (*crosschip_bridge_join
)(struct dsa_switch
*ds
, int sw_index
,
460 int port
, struct net_device
*br
);
461 void (*crosschip_bridge_leave
)(struct dsa_switch
*ds
, int sw_index
,
462 int port
, struct net_device
*br
);
465 struct dsa_switch_driver
{
466 struct list_head list
;
467 const struct dsa_switch_ops
*ops
;
470 /* Legacy driver registration */
471 void register_switch_driver(struct dsa_switch_driver
*type
);
472 void unregister_switch_driver(struct dsa_switch_driver
*type
);
473 struct mii_bus
*dsa_host_dev_to_mii_bus(struct device
*dev
);
475 struct net_device
*dsa_dev_to_net_device(struct device
*dev
);
477 static inline bool dsa_uses_tagged_protocol(struct dsa_switch_tree
*dst
)
479 return dst
->rcv
!= NULL
;
482 static inline bool netdev_uses_dsa(struct net_device
*dev
)
484 #if IS_ENABLED(CONFIG_NET_DSA)
485 if (dev
->dsa_ptr
!= NULL
)
486 return dsa_uses_tagged_protocol(dev
->dsa_ptr
);
491 struct dsa_switch
*dsa_switch_alloc(struct device
*dev
, size_t n
);
492 void dsa_unregister_switch(struct dsa_switch
*ds
);
493 int dsa_register_switch(struct dsa_switch
*ds
, struct device
*dev
);
494 #ifdef CONFIG_PM_SLEEP
495 int dsa_switch_suspend(struct dsa_switch
*ds
);
496 int dsa_switch_resume(struct dsa_switch
*ds
);
498 static inline int dsa_switch_suspend(struct dsa_switch
*ds
)
502 static inline int dsa_switch_resume(struct dsa_switch
*ds
)
506 #endif /* CONFIG_PM_SLEEP */