1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 * net/dsa/dsa_priv.h - Hardware switch handling
4 * Copyright (c) 2008-2009 Marvell Semiconductor
10 #include <linux/if_bridge.h>
11 #include <linux/phy.h>
12 #include <linux/netdevice.h>
13 #include <linux/netpoll.h>
15 #include <net/gro_cells.h>
17 #define DSA_MAX_NUM_OFFLOADING_BRIDGES BITS_PER_LONG
20 DSA_NOTIFIER_AGEING_TIME,
21 DSA_NOTIFIER_BRIDGE_JOIN,
22 DSA_NOTIFIER_BRIDGE_LEAVE,
25 DSA_NOTIFIER_HOST_FDB_ADD,
26 DSA_NOTIFIER_HOST_FDB_DEL,
27 DSA_NOTIFIER_HSR_JOIN,
28 DSA_NOTIFIER_HSR_LEAVE,
29 DSA_NOTIFIER_LAG_CHANGE,
30 DSA_NOTIFIER_LAG_JOIN,
31 DSA_NOTIFIER_LAG_LEAVE,
34 DSA_NOTIFIER_HOST_MDB_ADD,
35 DSA_NOTIFIER_HOST_MDB_DEL,
36 DSA_NOTIFIER_VLAN_ADD,
37 DSA_NOTIFIER_VLAN_DEL,
39 DSA_NOTIFIER_TAG_PROTO,
42 DSA_NOTIFIER_MRP_ADD_RING_ROLE,
43 DSA_NOTIFIER_MRP_DEL_RING_ROLE,
44 DSA_NOTIFIER_TAG_8021Q_VLAN_ADD,
45 DSA_NOTIFIER_TAG_8021Q_VLAN_DEL,
48 /* DSA_NOTIFIER_AGEING_TIME */
49 struct dsa_notifier_ageing_time_info {
50 unsigned int ageing_time;
53 /* DSA_NOTIFIER_BRIDGE_* */
54 struct dsa_notifier_bridge_info {
55 struct net_device *br;
61 /* DSA_NOTIFIER_FDB_* */
62 struct dsa_notifier_fdb_info {
65 const unsigned char *addr;
69 /* DSA_NOTIFIER_MDB_* */
70 struct dsa_notifier_mdb_info {
71 const struct switchdev_obj_port_mdb *mdb;
76 /* DSA_NOTIFIER_LAG_* */
77 struct dsa_notifier_lag_info {
78 struct net_device *lag;
82 struct netdev_lag_upper_info *info;
85 /* DSA_NOTIFIER_VLAN_* */
86 struct dsa_notifier_vlan_info {
87 const struct switchdev_obj_port_vlan *vlan;
90 struct netlink_ext_ack *extack;
93 /* DSA_NOTIFIER_MTU */
94 struct dsa_notifier_mtu_info {
101 /* DSA_NOTIFIER_TAG_PROTO_* */
102 struct dsa_notifier_tag_proto_info {
103 const struct dsa_device_ops *tag_ops;
106 /* DSA_NOTIFIER_MRP_* */
107 struct dsa_notifier_mrp_info {
108 const struct switchdev_obj_mrp *mrp;
113 /* DSA_NOTIFIER_MRP_* */
114 struct dsa_notifier_mrp_ring_role_info {
115 const struct switchdev_obj_ring_role_mrp *mrp;
120 /* DSA_NOTIFIER_TAG_8021Q_VLAN_* */
121 struct dsa_notifier_tag_8021q_vlan_info {
128 struct dsa_switchdev_event_work {
129 struct dsa_switch *ds;
131 struct net_device *dev;
132 struct work_struct work;
134 /* Specific for SWITCHDEV_FDB_ADD_TO_DEVICE and
135 * SWITCHDEV_FDB_DEL_TO_DEVICE
137 unsigned char addr[ETH_ALEN];
142 /* DSA_NOTIFIER_HSR_* */
143 struct dsa_notifier_hsr_info {
144 struct net_device *hsr;
149 struct dsa_slave_priv {
150 /* Copy of CPU port xmit for faster access in slave transmit hot path */
151 struct sk_buff * (*xmit)(struct sk_buff *skb,
152 struct net_device *dev);
154 struct gro_cells gcells;
156 /* DSA port data, such as switch, port index, etc. */
159 #ifdef CONFIG_NET_POLL_CONTROLLER
160 struct netpoll *netpoll;
164 struct list_head mall_tc_list;
168 const struct dsa_device_ops *dsa_tag_driver_get(int tag_protocol);
169 void dsa_tag_driver_put(const struct dsa_device_ops *ops);
170 const struct dsa_device_ops *dsa_find_tagger_by_name(const char *buf);
172 bool dsa_schedule_work(struct work_struct *work);
173 const char *dsa_tag_protocol_to_str(const struct dsa_device_ops *ops);
175 static inline int dsa_tag_protocol_overhead(const struct dsa_device_ops *ops)
177 return ops->needed_headroom + ops->needed_tailroom;
181 int dsa_master_setup(struct net_device *dev, struct dsa_port *cpu_dp);
182 void dsa_master_teardown(struct net_device *dev);
184 static inline struct net_device *dsa_master_find_slave(struct net_device *dev,
185 int device, int port)
187 struct dsa_port *cpu_dp = dev->dsa_ptr;
188 struct dsa_switch_tree *dst = cpu_dp->dst;
191 list_for_each_entry(dp, &dst->ports, list)
192 if (dp->ds->index == device && dp->index == port &&
193 dp->type == DSA_PORT_TYPE_USER)
200 void dsa_port_set_tag_protocol(struct dsa_port *cpu_dp,
201 const struct dsa_device_ops *tag_ops);
202 int dsa_port_set_state(struct dsa_port *dp, u8 state, bool do_fast_age);
203 int dsa_port_enable_rt(struct dsa_port *dp, struct phy_device *phy);
204 int dsa_port_enable(struct dsa_port *dp, struct phy_device *phy);
205 void dsa_port_disable_rt(struct dsa_port *dp);
206 void dsa_port_disable(struct dsa_port *dp);
207 int dsa_port_bridge_join(struct dsa_port *dp, struct net_device *br,
208 struct netlink_ext_ack *extack);
209 void dsa_port_pre_bridge_leave(struct dsa_port *dp, struct net_device *br);
210 void dsa_port_bridge_leave(struct dsa_port *dp, struct net_device *br);
211 int dsa_port_lag_change(struct dsa_port *dp,
212 struct netdev_lag_lower_state_info *linfo);
213 int dsa_port_lag_join(struct dsa_port *dp, struct net_device *lag_dev,
214 struct netdev_lag_upper_info *uinfo,
215 struct netlink_ext_ack *extack);
216 void dsa_port_pre_lag_leave(struct dsa_port *dp, struct net_device *lag_dev);
217 void dsa_port_lag_leave(struct dsa_port *dp, struct net_device *lag_dev);
218 int dsa_port_vlan_filtering(struct dsa_port *dp, bool vlan_filtering,
219 struct netlink_ext_ack *extack);
220 bool dsa_port_skip_vlan_configuration(struct dsa_port *dp);
221 int dsa_port_ageing_time(struct dsa_port *dp, clock_t ageing_clock);
222 int dsa_port_mtu_change(struct dsa_port *dp, int new_mtu,
223 bool targeted_match);
224 int dsa_port_fdb_add(struct dsa_port *dp, const unsigned char *addr,
226 int dsa_port_fdb_del(struct dsa_port *dp, const unsigned char *addr,
228 int dsa_port_host_fdb_add(struct dsa_port *dp, const unsigned char *addr,
230 int dsa_port_host_fdb_del(struct dsa_port *dp, const unsigned char *addr,
232 int dsa_port_fdb_dump(struct dsa_port *dp, dsa_fdb_dump_cb_t *cb, void *data);
233 int dsa_port_mdb_add(const struct dsa_port *dp,
234 const struct switchdev_obj_port_mdb *mdb);
235 int dsa_port_mdb_del(const struct dsa_port *dp,
236 const struct switchdev_obj_port_mdb *mdb);
237 int dsa_port_host_mdb_add(const struct dsa_port *dp,
238 const struct switchdev_obj_port_mdb *mdb);
239 int dsa_port_host_mdb_del(const struct dsa_port *dp,
240 const struct switchdev_obj_port_mdb *mdb);
241 int dsa_port_pre_bridge_flags(const struct dsa_port *dp,
242 struct switchdev_brport_flags flags,
243 struct netlink_ext_ack *extack);
244 int dsa_port_bridge_flags(struct dsa_port *dp,
245 struct switchdev_brport_flags flags,
246 struct netlink_ext_ack *extack);
247 int dsa_port_vlan_add(struct dsa_port *dp,
248 const struct switchdev_obj_port_vlan *vlan,
249 struct netlink_ext_ack *extack);
250 int dsa_port_vlan_del(struct dsa_port *dp,
251 const struct switchdev_obj_port_vlan *vlan);
252 int dsa_port_mrp_add(const struct dsa_port *dp,
253 const struct switchdev_obj_mrp *mrp);
254 int dsa_port_mrp_del(const struct dsa_port *dp,
255 const struct switchdev_obj_mrp *mrp);
256 int dsa_port_mrp_add_ring_role(const struct dsa_port *dp,
257 const struct switchdev_obj_ring_role_mrp *mrp);
258 int dsa_port_mrp_del_ring_role(const struct dsa_port *dp,
259 const struct switchdev_obj_ring_role_mrp *mrp);
260 int dsa_port_link_register_of(struct dsa_port *dp);
261 void dsa_port_link_unregister_of(struct dsa_port *dp);
262 int dsa_port_hsr_join(struct dsa_port *dp, struct net_device *hsr);
263 void dsa_port_hsr_leave(struct dsa_port *dp, struct net_device *hsr);
264 int dsa_port_tag_8021q_vlan_add(struct dsa_port *dp, u16 vid, bool broadcast);
265 void dsa_port_tag_8021q_vlan_del(struct dsa_port *dp, u16 vid, bool broadcast);
266 extern const struct phylink_mac_ops dsa_port_phylink_mac_ops;
268 static inline bool dsa_port_offloads_bridge_port(struct dsa_port *dp,
269 const struct net_device *dev)
271 return dsa_port_to_bridge_port(dp) == dev;
274 static inline bool dsa_port_offloads_bridge(struct dsa_port *dp,
275 const struct net_device *bridge_dev)
277 /* DSA ports connected to a bridge, and event was emitted
280 return dp->bridge_dev == bridge_dev;
283 /* Returns true if any port of this tree offloads the given net_device */
284 static inline bool dsa_tree_offloads_bridge_port(struct dsa_switch_tree *dst,
285 const struct net_device *dev)
289 list_for_each_entry(dp, &dst->ports, list)
290 if (dsa_port_offloads_bridge_port(dp, dev))
296 /* Returns true if any port of this tree offloads the given bridge */
297 static inline bool dsa_tree_offloads_bridge(struct dsa_switch_tree *dst,
298 const struct net_device *bridge_dev)
302 list_for_each_entry(dp, &dst->ports, list)
303 if (dsa_port_offloads_bridge(dp, bridge_dev))
310 extern const struct dsa_device_ops notag_netdev_ops;
311 extern struct notifier_block dsa_slave_switchdev_notifier;
312 extern struct notifier_block dsa_slave_switchdev_blocking_notifier;
314 void dsa_slave_mii_bus_init(struct dsa_switch *ds);
315 int dsa_slave_create(struct dsa_port *dp);
316 void dsa_slave_destroy(struct net_device *slave_dev);
317 int dsa_slave_suspend(struct net_device *slave_dev);
318 int dsa_slave_resume(struct net_device *slave_dev);
319 int dsa_slave_register_notifier(void);
320 void dsa_slave_unregister_notifier(void);
321 void dsa_slave_setup_tagger(struct net_device *slave);
322 int dsa_slave_change_mtu(struct net_device *dev, int new_mtu);
323 int dsa_slave_manage_vlan_filtering(struct net_device *dev,
324 bool vlan_filtering);
326 static inline struct dsa_port *dsa_slave_to_port(const struct net_device *dev)
328 struct dsa_slave_priv *p = netdev_priv(dev);
333 static inline struct net_device *
334 dsa_slave_to_master(const struct net_device *dev)
336 struct dsa_port *dp = dsa_slave_to_port(dev);
338 return dp->cpu_dp->master;
341 /* If under a bridge with vlan_filtering=0, make sure to send pvid-tagged
342 * frames as untagged, since the bridge will not untag them.
344 static inline struct sk_buff *dsa_untag_bridge_pvid(struct sk_buff *skb)
346 struct dsa_port *dp = dsa_slave_to_port(skb->dev);
347 struct net_device *br = dp->bridge_dev;
348 struct net_device *dev = skb->dev;
349 struct net_device *upper_dev;
350 u16 vid, pvid, proto;
353 if (!br || br_vlan_enabled(br))
356 err = br_vlan_get_proto(br, &proto);
360 /* Move VLAN tag from data to hwaccel */
361 if (!skb_vlan_tag_present(skb) && skb->protocol == htons(proto)) {
362 skb = skb_vlan_untag(skb);
367 if (!skb_vlan_tag_present(skb))
370 vid = skb_vlan_tag_get_id(skb);
372 /* We already run under an RCU read-side critical section since
373 * we are called from netif_receive_skb_list_internal().
375 err = br_vlan_get_pvid_rcu(dev, &pvid);
382 /* The sad part about attempting to untag from DSA is that we
383 * don't know, unless we check, if the skb will end up in
384 * the bridge's data path - br_allowed_ingress() - or not.
385 * For example, there might be an 8021q upper for the
386 * default_pvid of the bridge, which will steal VLAN-tagged traffic
387 * from the bridge's data path. This is a configuration that DSA
388 * supports because vlan_filtering is 0. In that case, we should
389 * definitely keep the tag, to make sure it keeps working.
391 upper_dev = __vlan_find_dev_deep_rcu(br, htons(proto), vid);
395 __vlan_hwaccel_clear_tag(skb);
400 /* For switches without hardware support for DSA tagging to be able
401 * to support termination through the bridge.
403 static inline struct net_device *
404 dsa_find_designated_bridge_port_by_vid(struct net_device *master, u16 vid)
406 struct dsa_port *cpu_dp = master->dsa_ptr;
407 struct dsa_switch_tree *dst = cpu_dp->dst;
408 struct bridge_vlan_info vinfo;
409 struct net_device *slave;
413 list_for_each_entry(dp, &dst->ports, list) {
414 if (dp->type != DSA_PORT_TYPE_USER)
420 if (dp->stp_state != BR_STATE_LEARNING &&
421 dp->stp_state != BR_STATE_FORWARDING)
424 /* Since the bridge might learn this packet, keep the CPU port
425 * affinity with the port that will be used for the reply on
428 if (dp->cpu_dp != cpu_dp)
433 err = br_vlan_get_info_rcu(slave, vid, &vinfo);
443 /* If the ingress port offloads the bridge, we mark the frame as autonomously
444 * forwarded by hardware, so the software bridge doesn't forward in twice, back
445 * to us, because we already did. However, if we're in fallback mode and we do
446 * software bridging, we are not offloading it, therefore the dp->bridge_dev
447 * pointer is not populated, and flooding needs to be done by software (we are
448 * effectively operating in standalone ports mode).
450 static inline void dsa_default_offload_fwd_mark(struct sk_buff *skb)
452 struct dsa_port *dp = dsa_slave_to_port(skb->dev);
454 skb->offload_fwd_mark = !!(dp->bridge_dev);
457 /* Helper for removing DSA header tags from packets in the RX path.
458 * Must not be called before skb_pull(len).
462 * | | | | | | | | | | | | | | | | | | |
463 * +-----------------------+-----------------------+---------------+-------+
464 * | Destination MAC | Source MAC | DSA header | EType |
465 * +-----------------------+-----------------------+---------------+-------+
467 * <----- len -----> <----- len ----->
470 * >>>>>>> | | | | | | | | | | | | | | |
471 * >>>>>>> +-----------------------+-----------------------+-------+
472 * >>>>>>> | Destination MAC | Source MAC | EType |
473 * +-----------------------+-----------------------+-------+
478 static inline void dsa_strip_etype_header(struct sk_buff *skb, int len)
480 memmove(skb->data - ETH_HLEN, skb->data - ETH_HLEN - len, 2 * ETH_ALEN);
483 /* Helper for creating space for DSA header tags in TX path packets.
484 * Must not be called before skb_push(len).
488 * <<<<<<< | | | | | | | | | | | | | | |
489 * ^ <<<<<<< +-----------------------+-----------------------+-------+
490 * | <<<<<<< | Destination MAC | Source MAC | EType |
491 * | +-----------------------+-----------------------+-------+
499 * | | | | | | | | | | | | | | | | | | |
500 * +-----------------------+-----------------------+---------------+-------+
501 * | Destination MAC | Source MAC | DSA header | EType |
502 * +-----------------------+-----------------------+---------------+-------+
504 * | <----- len ----->
507 static inline void dsa_alloc_etype_header(struct sk_buff *skb, int len)
509 memmove(skb->data, skb->data + len, 2 * ETH_ALEN);
512 /* On RX, eth_type_trans() on the DSA master pulls ETH_HLEN bytes starting from
513 * skb_mac_header(skb), which leaves skb->data pointing at the first byte after
514 * what the DSA master perceives as the EtherType (the beginning of the L3
515 * protocol). Since DSA EtherType header taggers treat the EtherType as part of
516 * the DSA tag itself, and the EtherType is 2 bytes in length, the DSA header
517 * is located 2 bytes behind skb->data. Note that EtherType in this context
518 * means the first 2 bytes of the DSA header, not the encapsulated EtherType
519 * that will become visible after the DSA header is stripped.
521 static inline void *dsa_etype_header_pos_rx(struct sk_buff *skb)
523 return skb->data - 2;
526 /* On TX, skb->data points to skb_mac_header(skb), which means that EtherType
527 * header taggers start exactly where the EtherType is (the EtherType is
528 * treated as part of the DSA header).
530 static inline void *dsa_etype_header_pos_tx(struct sk_buff *skb)
532 return skb->data + 2 * ETH_ALEN;
536 int dsa_switch_register_notifier(struct dsa_switch *ds);
537 void dsa_switch_unregister_notifier(struct dsa_switch *ds);
540 void dsa_lag_map(struct dsa_switch_tree *dst, struct net_device *lag);
541 void dsa_lag_unmap(struct dsa_switch_tree *dst, struct net_device *lag);
542 int dsa_tree_notify(struct dsa_switch_tree *dst, unsigned long e, void *v);
543 int dsa_broadcast(unsigned long e, void *v);
544 int dsa_tree_change_tag_proto(struct dsa_switch_tree *dst,
545 struct net_device *master,
546 const struct dsa_device_ops *tag_ops,
547 const struct dsa_device_ops *old_tag_ops);
548 int dsa_bridge_num_get(const struct net_device *bridge_dev, int max);
549 void dsa_bridge_num_put(const struct net_device *bridge_dev, int bridge_num);
552 int dsa_tag_8021q_bridge_join(struct dsa_switch *ds,
553 struct dsa_notifier_bridge_info *info);
554 int dsa_tag_8021q_bridge_leave(struct dsa_switch *ds,
555 struct dsa_notifier_bridge_info *info);
556 int dsa_switch_tag_8021q_vlan_add(struct dsa_switch *ds,
557 struct dsa_notifier_tag_8021q_vlan_info *info);
558 int dsa_switch_tag_8021q_vlan_del(struct dsa_switch *ds,
559 struct dsa_notifier_tag_8021q_vlan_info *info);
561 extern struct list_head dsa_tree_list;