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>
18 DSA_NOTIFIER_AGEING_TIME,
19 DSA_NOTIFIER_BRIDGE_JOIN,
20 DSA_NOTIFIER_BRIDGE_LEAVE,
23 DSA_NOTIFIER_HOST_FDB_ADD,
24 DSA_NOTIFIER_HOST_FDB_DEL,
25 DSA_NOTIFIER_HSR_JOIN,
26 DSA_NOTIFIER_HSR_LEAVE,
27 DSA_NOTIFIER_LAG_CHANGE,
28 DSA_NOTIFIER_LAG_JOIN,
29 DSA_NOTIFIER_LAG_LEAVE,
32 DSA_NOTIFIER_HOST_MDB_ADD,
33 DSA_NOTIFIER_HOST_MDB_DEL,
34 DSA_NOTIFIER_VLAN_ADD,
35 DSA_NOTIFIER_VLAN_DEL,
37 DSA_NOTIFIER_TAG_PROTO,
40 DSA_NOTIFIER_MRP_ADD_RING_ROLE,
41 DSA_NOTIFIER_MRP_DEL_RING_ROLE,
44 /* DSA_NOTIFIER_AGEING_TIME */
45 struct dsa_notifier_ageing_time_info {
46 unsigned int ageing_time;
49 /* DSA_NOTIFIER_BRIDGE_* */
50 struct dsa_notifier_bridge_info {
51 struct net_device *br;
57 /* DSA_NOTIFIER_FDB_* */
58 struct dsa_notifier_fdb_info {
61 const unsigned char *addr;
65 /* DSA_NOTIFIER_MDB_* */
66 struct dsa_notifier_mdb_info {
67 const struct switchdev_obj_port_mdb *mdb;
72 /* DSA_NOTIFIER_LAG_* */
73 struct dsa_notifier_lag_info {
74 struct net_device *lag;
78 struct netdev_lag_upper_info *info;
81 /* DSA_NOTIFIER_VLAN_* */
82 struct dsa_notifier_vlan_info {
83 const struct switchdev_obj_port_vlan *vlan;
86 struct netlink_ext_ack *extack;
89 /* DSA_NOTIFIER_MTU */
90 struct dsa_notifier_mtu_info {
97 /* DSA_NOTIFIER_TAG_PROTO_* */
98 struct dsa_notifier_tag_proto_info {
99 const struct dsa_device_ops *tag_ops;
102 /* DSA_NOTIFIER_MRP_* */
103 struct dsa_notifier_mrp_info {
104 const struct switchdev_obj_mrp *mrp;
109 /* DSA_NOTIFIER_MRP_* */
110 struct dsa_notifier_mrp_ring_role_info {
111 const struct switchdev_obj_ring_role_mrp *mrp;
116 struct dsa_switchdev_event_work {
117 struct dsa_switch *ds;
119 struct net_device *dev;
120 struct work_struct work;
122 /* Specific for SWITCHDEV_FDB_ADD_TO_DEVICE and
123 * SWITCHDEV_FDB_DEL_TO_DEVICE
125 unsigned char addr[ETH_ALEN];
130 /* DSA_NOTIFIER_HSR_* */
131 struct dsa_notifier_hsr_info {
132 struct net_device *hsr;
137 struct dsa_slave_priv {
138 /* Copy of CPU port xmit for faster access in slave transmit hot path */
139 struct sk_buff * (*xmit)(struct sk_buff *skb,
140 struct net_device *dev);
142 struct gro_cells gcells;
144 /* DSA port data, such as switch, port index, etc. */
147 #ifdef CONFIG_NET_POLL_CONTROLLER
148 struct netpoll *netpoll;
152 struct list_head mall_tc_list;
156 const struct dsa_device_ops *dsa_tag_driver_get(int tag_protocol);
157 void dsa_tag_driver_put(const struct dsa_device_ops *ops);
158 const struct dsa_device_ops *dsa_find_tagger_by_name(const char *buf);
160 bool dsa_schedule_work(struct work_struct *work);
161 const char *dsa_tag_protocol_to_str(const struct dsa_device_ops *ops);
163 static inline int dsa_tag_protocol_overhead(const struct dsa_device_ops *ops)
165 return ops->needed_headroom + ops->needed_tailroom;
169 int dsa_master_setup(struct net_device *dev, struct dsa_port *cpu_dp);
170 void dsa_master_teardown(struct net_device *dev);
172 static inline struct net_device *dsa_master_find_slave(struct net_device *dev,
173 int device, int port)
175 struct dsa_port *cpu_dp = dev->dsa_ptr;
176 struct dsa_switch_tree *dst = cpu_dp->dst;
179 list_for_each_entry(dp, &dst->ports, list)
180 if (dp->ds->index == device && dp->index == port &&
181 dp->type == DSA_PORT_TYPE_USER)
188 void dsa_port_set_tag_protocol(struct dsa_port *cpu_dp,
189 const struct dsa_device_ops *tag_ops);
190 int dsa_port_set_state(struct dsa_port *dp, u8 state);
191 int dsa_port_enable_rt(struct dsa_port *dp, struct phy_device *phy);
192 int dsa_port_enable(struct dsa_port *dp, struct phy_device *phy);
193 void dsa_port_disable_rt(struct dsa_port *dp);
194 void dsa_port_disable(struct dsa_port *dp);
195 int dsa_port_bridge_join(struct dsa_port *dp, struct net_device *br,
196 struct netlink_ext_ack *extack);
197 int dsa_port_pre_bridge_leave(struct dsa_port *dp, struct net_device *br,
198 struct netlink_ext_ack *extack);
199 void dsa_port_bridge_leave(struct dsa_port *dp, struct net_device *br);
200 int dsa_port_lag_change(struct dsa_port *dp,
201 struct netdev_lag_lower_state_info *linfo);
202 int dsa_port_lag_join(struct dsa_port *dp, struct net_device *lag_dev,
203 struct netdev_lag_upper_info *uinfo,
204 struct netlink_ext_ack *extack);
205 int dsa_port_pre_lag_leave(struct dsa_port *dp, struct net_device *lag_dev,
206 struct netlink_ext_ack *extack);
207 void dsa_port_lag_leave(struct dsa_port *dp, struct net_device *lag_dev);
208 int dsa_port_vlan_filtering(struct dsa_port *dp, bool vlan_filtering,
209 struct netlink_ext_ack *extack);
210 bool dsa_port_skip_vlan_configuration(struct dsa_port *dp);
211 int dsa_port_ageing_time(struct dsa_port *dp, clock_t ageing_clock);
212 int dsa_port_mtu_change(struct dsa_port *dp, int new_mtu,
213 bool targeted_match);
214 int dsa_port_fdb_add(struct dsa_port *dp, const unsigned char *addr,
216 int dsa_port_fdb_del(struct dsa_port *dp, const unsigned char *addr,
218 int dsa_port_host_fdb_add(struct dsa_port *dp, const unsigned char *addr,
220 int dsa_port_host_fdb_del(struct dsa_port *dp, const unsigned char *addr,
222 int dsa_port_fdb_dump(struct dsa_port *dp, dsa_fdb_dump_cb_t *cb, void *data);
223 int dsa_port_mdb_add(const struct dsa_port *dp,
224 const struct switchdev_obj_port_mdb *mdb);
225 int dsa_port_mdb_del(const struct dsa_port *dp,
226 const struct switchdev_obj_port_mdb *mdb);
227 int dsa_port_host_mdb_add(const struct dsa_port *dp,
228 const struct switchdev_obj_port_mdb *mdb);
229 int dsa_port_host_mdb_del(const struct dsa_port *dp,
230 const struct switchdev_obj_port_mdb *mdb);
231 int dsa_port_pre_bridge_flags(const struct dsa_port *dp,
232 struct switchdev_brport_flags flags,
233 struct netlink_ext_ack *extack);
234 int dsa_port_bridge_flags(const struct dsa_port *dp,
235 struct switchdev_brport_flags flags,
236 struct netlink_ext_ack *extack);
237 int dsa_port_mrouter(struct dsa_port *dp, bool mrouter,
238 struct netlink_ext_ack *extack);
239 int dsa_port_vlan_add(struct dsa_port *dp,
240 const struct switchdev_obj_port_vlan *vlan,
241 struct netlink_ext_ack *extack);
242 int dsa_port_vlan_del(struct dsa_port *dp,
243 const struct switchdev_obj_port_vlan *vlan);
244 int dsa_port_mrp_add(const struct dsa_port *dp,
245 const struct switchdev_obj_mrp *mrp);
246 int dsa_port_mrp_del(const struct dsa_port *dp,
247 const struct switchdev_obj_mrp *mrp);
248 int dsa_port_mrp_add_ring_role(const struct dsa_port *dp,
249 const struct switchdev_obj_ring_role_mrp *mrp);
250 int dsa_port_mrp_del_ring_role(const struct dsa_port *dp,
251 const struct switchdev_obj_ring_role_mrp *mrp);
252 int dsa_port_link_register_of(struct dsa_port *dp);
253 void dsa_port_link_unregister_of(struct dsa_port *dp);
254 int dsa_port_hsr_join(struct dsa_port *dp, struct net_device *hsr);
255 void dsa_port_hsr_leave(struct dsa_port *dp, struct net_device *hsr);
256 extern const struct phylink_mac_ops dsa_port_phylink_mac_ops;
258 static inline bool dsa_port_offloads_bridge_port(struct dsa_port *dp,
259 struct net_device *dev)
261 return dsa_port_to_bridge_port(dp) == dev;
264 static inline bool dsa_port_offloads_bridge(struct dsa_port *dp,
265 struct net_device *bridge_dev)
267 /* DSA ports connected to a bridge, and event was emitted
270 return dp->bridge_dev == bridge_dev;
273 /* Returns true if any port of this tree offloads the given net_device */
274 static inline bool dsa_tree_offloads_bridge_port(struct dsa_switch_tree *dst,
275 struct net_device *dev)
279 list_for_each_entry(dp, &dst->ports, list)
280 if (dsa_port_offloads_bridge_port(dp, dev))
287 extern const struct dsa_device_ops notag_netdev_ops;
288 extern struct notifier_block dsa_slave_switchdev_notifier;
289 extern struct notifier_block dsa_slave_switchdev_blocking_notifier;
291 void dsa_slave_mii_bus_init(struct dsa_switch *ds);
292 int dsa_slave_create(struct dsa_port *dp);
293 void dsa_slave_destroy(struct net_device *slave_dev);
294 int dsa_slave_suspend(struct net_device *slave_dev);
295 int dsa_slave_resume(struct net_device *slave_dev);
296 int dsa_slave_register_notifier(void);
297 void dsa_slave_unregister_notifier(void);
298 void dsa_slave_setup_tagger(struct net_device *slave);
299 int dsa_slave_change_mtu(struct net_device *dev, int new_mtu);
301 static inline struct dsa_port *dsa_slave_to_port(const struct net_device *dev)
303 struct dsa_slave_priv *p = netdev_priv(dev);
308 static inline struct net_device *
309 dsa_slave_to_master(const struct net_device *dev)
311 struct dsa_port *dp = dsa_slave_to_port(dev);
313 return dp->cpu_dp->master;
316 /* If under a bridge with vlan_filtering=0, make sure to send pvid-tagged
317 * frames as untagged, since the bridge will not untag them.
319 static inline struct sk_buff *dsa_untag_bridge_pvid(struct sk_buff *skb)
321 struct dsa_port *dp = dsa_slave_to_port(skb->dev);
322 struct net_device *br = dp->bridge_dev;
323 struct net_device *dev = skb->dev;
324 struct net_device *upper_dev;
325 u16 vid, pvid, proto;
328 if (!br || br_vlan_enabled(br))
331 err = br_vlan_get_proto(br, &proto);
335 /* Move VLAN tag from data to hwaccel */
336 if (!skb_vlan_tag_present(skb) && skb->protocol == htons(proto)) {
337 skb = skb_vlan_untag(skb);
342 if (!skb_vlan_tag_present(skb))
345 vid = skb_vlan_tag_get_id(skb);
347 /* We already run under an RCU read-side critical section since
348 * we are called from netif_receive_skb_list_internal().
350 err = br_vlan_get_pvid_rcu(dev, &pvid);
357 /* The sad part about attempting to untag from DSA is that we
358 * don't know, unless we check, if the skb will end up in
359 * the bridge's data path - br_allowed_ingress() - or not.
360 * For example, there might be an 8021q upper for the
361 * default_pvid of the bridge, which will steal VLAN-tagged traffic
362 * from the bridge's data path. This is a configuration that DSA
363 * supports because vlan_filtering is 0. In that case, we should
364 * definitely keep the tag, to make sure it keeps working.
366 upper_dev = __vlan_find_dev_deep_rcu(br, htons(proto), vid);
370 __vlan_hwaccel_clear_tag(skb);
376 int dsa_switch_register_notifier(struct dsa_switch *ds);
377 void dsa_switch_unregister_notifier(struct dsa_switch *ds);
380 void dsa_lag_map(struct dsa_switch_tree *dst, struct net_device *lag);
381 void dsa_lag_unmap(struct dsa_switch_tree *dst, struct net_device *lag);
382 int dsa_tree_notify(struct dsa_switch_tree *dst, unsigned long e, void *v);
383 int dsa_broadcast(unsigned long e, void *v);
384 int dsa_tree_change_tag_proto(struct dsa_switch_tree *dst,
385 struct net_device *master,
386 const struct dsa_device_ops *tag_ops,
387 const struct dsa_device_ops *old_tag_ops);
389 extern struct list_head dsa_tree_list;