1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 * include/net/switchdev.h - Switch device API
4 * Copyright (c) 2014-2015 Jiri Pirko <jiri@resnulli.us>
5 * Copyright (c) 2014-2015 Scott Feldman <sfeldma@gmail.com>
7 #ifndef _LINUX_SWITCHDEV_H_
8 #define _LINUX_SWITCHDEV_H_
10 #include <linux/netdevice.h>
11 #include <linux/notifier.h>
12 #include <linux/list.h>
13 #include <net/ip_fib.h>
15 #define SWITCHDEV_F_NO_RECURSE BIT(0)
16 #define SWITCHDEV_F_SKIP_EOPNOTSUPP BIT(1)
17 #define SWITCHDEV_F_DEFER BIT(2)
19 enum switchdev_attr_id {
20 SWITCHDEV_ATTR_ID_UNDEFINED,
21 SWITCHDEV_ATTR_ID_PORT_STP_STATE,
22 SWITCHDEV_ATTR_ID_PORT_MST_STATE,
23 SWITCHDEV_ATTR_ID_PORT_BRIDGE_FLAGS,
24 SWITCHDEV_ATTR_ID_PORT_PRE_BRIDGE_FLAGS,
25 SWITCHDEV_ATTR_ID_PORT_MROUTER,
26 SWITCHDEV_ATTR_ID_BRIDGE_AGEING_TIME,
27 SWITCHDEV_ATTR_ID_BRIDGE_VLAN_FILTERING,
28 SWITCHDEV_ATTR_ID_BRIDGE_VLAN_PROTOCOL,
29 SWITCHDEV_ATTR_ID_BRIDGE_MC_DISABLED,
30 SWITCHDEV_ATTR_ID_BRIDGE_MROUTER,
31 SWITCHDEV_ATTR_ID_BRIDGE_MST,
32 SWITCHDEV_ATTR_ID_MRP_PORT_ROLE,
33 SWITCHDEV_ATTR_ID_VLAN_MSTI,
36 struct switchdev_mst_state {
41 struct switchdev_brport_flags {
46 struct switchdev_vlan_msti {
51 struct switchdev_attr {
52 struct net_device *orig_dev;
53 enum switchdev_attr_id id;
56 void (*complete)(struct net_device *dev, int err, void *priv);
58 u8 stp_state; /* PORT_STP_STATE */
59 struct switchdev_mst_state mst_state; /* PORT_MST_STATE */
60 struct switchdev_brport_flags brport_flags; /* PORT_BRIDGE_FLAGS */
61 bool mrouter; /* PORT_MROUTER */
62 clock_t ageing_time; /* BRIDGE_AGEING_TIME */
63 bool vlan_filtering; /* BRIDGE_VLAN_FILTERING */
64 u16 vlan_protocol; /* BRIDGE_VLAN_PROTOCOL */
65 bool mst; /* BRIDGE_MST */
66 bool mc_disabled; /* MC_DISABLED */
67 u8 mrp_port_role; /* MRP_PORT_ROLE */
68 struct switchdev_vlan_msti vlan_msti; /* VLAN_MSTI */
72 enum switchdev_obj_id {
73 SWITCHDEV_OBJ_ID_UNDEFINED,
74 SWITCHDEV_OBJ_ID_PORT_VLAN,
75 SWITCHDEV_OBJ_ID_PORT_MDB,
76 SWITCHDEV_OBJ_ID_HOST_MDB,
78 SWITCHDEV_OBJ_ID_RING_TEST_MRP,
79 SWITCHDEV_OBJ_ID_RING_ROLE_MRP,
80 SWITCHDEV_OBJ_ID_RING_STATE_MRP,
81 SWITCHDEV_OBJ_ID_IN_TEST_MRP,
82 SWITCHDEV_OBJ_ID_IN_ROLE_MRP,
83 SWITCHDEV_OBJ_ID_IN_STATE_MRP,
86 struct switchdev_obj {
87 struct list_head list;
88 struct net_device *orig_dev;
89 enum switchdev_obj_id id;
92 void (*complete)(struct net_device *dev, int err, void *priv);
95 /* SWITCHDEV_OBJ_ID_PORT_VLAN */
96 struct switchdev_obj_port_vlan {
97 struct switchdev_obj obj;
100 /* If set, the notifier signifies a change of one of the following
101 * flags for a VLAN that already exists:
102 * - BRIDGE_VLAN_INFO_PVID
103 * - BRIDGE_VLAN_INFO_UNTAGGED
104 * Entries with BRIDGE_VLAN_INFO_BRENTRY unset are not notified at all.
109 #define SWITCHDEV_OBJ_PORT_VLAN(OBJ) \
110 container_of((OBJ), struct switchdev_obj_port_vlan, obj)
112 /* SWITCHDEV_OBJ_ID_PORT_MDB */
113 struct switchdev_obj_port_mdb {
114 struct switchdev_obj obj;
115 unsigned char addr[ETH_ALEN];
119 #define SWITCHDEV_OBJ_PORT_MDB(OBJ) \
120 container_of((OBJ), struct switchdev_obj_port_mdb, obj)
123 /* SWITCHDEV_OBJ_ID_MRP */
124 struct switchdev_obj_mrp {
125 struct switchdev_obj obj;
126 struct net_device *p_port;
127 struct net_device *s_port;
132 #define SWITCHDEV_OBJ_MRP(OBJ) \
133 container_of((OBJ), struct switchdev_obj_mrp, obj)
135 /* SWITCHDEV_OBJ_ID_RING_TEST_MRP */
136 struct switchdev_obj_ring_test_mrp {
137 struct switchdev_obj obj;
138 /* The value is in us and a value of 0 represents to stop */
146 #define SWITCHDEV_OBJ_RING_TEST_MRP(OBJ) \
147 container_of((OBJ), struct switchdev_obj_ring_test_mrp, obj)
149 /* SWICHDEV_OBJ_ID_RING_ROLE_MRP */
150 struct switchdev_obj_ring_role_mrp {
151 struct switchdev_obj obj;
157 #define SWITCHDEV_OBJ_RING_ROLE_MRP(OBJ) \
158 container_of((OBJ), struct switchdev_obj_ring_role_mrp, obj)
160 struct switchdev_obj_ring_state_mrp {
161 struct switchdev_obj obj;
166 #define SWITCHDEV_OBJ_RING_STATE_MRP(OBJ) \
167 container_of((OBJ), struct switchdev_obj_ring_state_mrp, obj)
169 /* SWITCHDEV_OBJ_ID_IN_TEST_MRP */
170 struct switchdev_obj_in_test_mrp {
171 struct switchdev_obj obj;
172 /* The value is in us and a value of 0 represents to stop */
179 #define SWITCHDEV_OBJ_IN_TEST_MRP(OBJ) \
180 container_of((OBJ), struct switchdev_obj_in_test_mrp, obj)
182 /* SWICHDEV_OBJ_ID_IN_ROLE_MRP */
183 struct switchdev_obj_in_role_mrp {
184 struct switchdev_obj obj;
185 struct net_device *i_port;
192 #define SWITCHDEV_OBJ_IN_ROLE_MRP(OBJ) \
193 container_of((OBJ), struct switchdev_obj_in_role_mrp, obj)
195 struct switchdev_obj_in_state_mrp {
196 struct switchdev_obj obj;
201 #define SWITCHDEV_OBJ_IN_STATE_MRP(OBJ) \
202 container_of((OBJ), struct switchdev_obj_in_state_mrp, obj)
204 typedef int switchdev_obj_dump_cb_t(struct switchdev_obj *obj);
206 struct switchdev_brport {
207 struct net_device *dev;
209 struct notifier_block *atomic_nb;
210 struct notifier_block *blocking_nb;
214 enum switchdev_notifier_type {
215 SWITCHDEV_FDB_ADD_TO_BRIDGE = 1,
216 SWITCHDEV_FDB_DEL_TO_BRIDGE,
217 SWITCHDEV_FDB_ADD_TO_DEVICE,
218 SWITCHDEV_FDB_DEL_TO_DEVICE,
219 SWITCHDEV_FDB_OFFLOADED,
220 SWITCHDEV_FDB_FLUSH_TO_BRIDGE,
222 SWITCHDEV_PORT_OBJ_ADD, /* Blocking. */
223 SWITCHDEV_PORT_OBJ_DEL, /* Blocking. */
224 SWITCHDEV_PORT_ATTR_SET, /* May be blocking . */
226 SWITCHDEV_VXLAN_FDB_ADD_TO_BRIDGE,
227 SWITCHDEV_VXLAN_FDB_DEL_TO_BRIDGE,
228 SWITCHDEV_VXLAN_FDB_ADD_TO_DEVICE,
229 SWITCHDEV_VXLAN_FDB_DEL_TO_DEVICE,
230 SWITCHDEV_VXLAN_FDB_OFFLOADED,
232 SWITCHDEV_BRPORT_OFFLOADED,
233 SWITCHDEV_BRPORT_UNOFFLOADED,
236 struct switchdev_notifier_info {
237 struct net_device *dev;
238 struct netlink_ext_ack *extack;
242 /* Remember to update br_switchdev_fdb_populate() when adding
243 * new members to this structure
245 struct switchdev_notifier_fdb_info {
246 struct switchdev_notifier_info info; /* must be first */
247 const unsigned char *addr;
255 struct switchdev_notifier_port_obj_info {
256 struct switchdev_notifier_info info; /* must be first */
257 const struct switchdev_obj *obj;
261 struct switchdev_notifier_port_attr_info {
262 struct switchdev_notifier_info info; /* must be first */
263 const struct switchdev_attr *attr;
267 struct switchdev_notifier_brport_info {
268 struct switchdev_notifier_info info; /* must be first */
269 const struct switchdev_brport brport;
272 static inline struct net_device *
273 switchdev_notifier_info_to_dev(const struct switchdev_notifier_info *info)
278 static inline struct netlink_ext_ack *
279 switchdev_notifier_info_to_extack(const struct switchdev_notifier_info *info)
285 switchdev_fdb_is_dynamically_learned(const struct switchdev_notifier_fdb_info *fdb_info)
287 return !fdb_info->added_by_user && !fdb_info->is_local;
290 #ifdef CONFIG_NET_SWITCHDEV
292 int switchdev_bridge_port_offload(struct net_device *brport_dev,
293 struct net_device *dev, const void *ctx,
294 struct notifier_block *atomic_nb,
295 struct notifier_block *blocking_nb,
297 struct netlink_ext_ack *extack);
298 void switchdev_bridge_port_unoffload(struct net_device *brport_dev,
300 struct notifier_block *atomic_nb,
301 struct notifier_block *blocking_nb);
303 void switchdev_deferred_process(void);
304 int switchdev_port_attr_set(struct net_device *dev,
305 const struct switchdev_attr *attr,
306 struct netlink_ext_ack *extack);
307 int switchdev_port_obj_add(struct net_device *dev,
308 const struct switchdev_obj *obj,
309 struct netlink_ext_ack *extack);
310 int switchdev_port_obj_del(struct net_device *dev,
311 const struct switchdev_obj *obj);
313 int register_switchdev_notifier(struct notifier_block *nb);
314 int unregister_switchdev_notifier(struct notifier_block *nb);
315 int call_switchdev_notifiers(unsigned long val, struct net_device *dev,
316 struct switchdev_notifier_info *info,
317 struct netlink_ext_ack *extack);
319 int register_switchdev_blocking_notifier(struct notifier_block *nb);
320 int unregister_switchdev_blocking_notifier(struct notifier_block *nb);
321 int call_switchdev_blocking_notifiers(unsigned long val, struct net_device *dev,
322 struct switchdev_notifier_info *info,
323 struct netlink_ext_ack *extack);
325 void switchdev_port_fwd_mark_set(struct net_device *dev,
326 struct net_device *group_dev,
329 int switchdev_handle_fdb_event_to_device(struct net_device *dev, unsigned long event,
330 const struct switchdev_notifier_fdb_info *fdb_info,
331 bool (*check_cb)(const struct net_device *dev),
332 bool (*foreign_dev_check_cb)(const struct net_device *dev,
333 const struct net_device *foreign_dev),
334 int (*mod_cb)(struct net_device *dev, struct net_device *orig_dev,
335 unsigned long event, const void *ctx,
336 const struct switchdev_notifier_fdb_info *fdb_info));
338 int switchdev_handle_port_obj_add(struct net_device *dev,
339 struct switchdev_notifier_port_obj_info *port_obj_info,
340 bool (*check_cb)(const struct net_device *dev),
341 int (*add_cb)(struct net_device *dev, const void *ctx,
342 const struct switchdev_obj *obj,
343 struct netlink_ext_ack *extack));
344 int switchdev_handle_port_obj_add_foreign(struct net_device *dev,
345 struct switchdev_notifier_port_obj_info *port_obj_info,
346 bool (*check_cb)(const struct net_device *dev),
347 bool (*foreign_dev_check_cb)(const struct net_device *dev,
348 const struct net_device *foreign_dev),
349 int (*add_cb)(struct net_device *dev, const void *ctx,
350 const struct switchdev_obj *obj,
351 struct netlink_ext_ack *extack));
352 int switchdev_handle_port_obj_del(struct net_device *dev,
353 struct switchdev_notifier_port_obj_info *port_obj_info,
354 bool (*check_cb)(const struct net_device *dev),
355 int (*del_cb)(struct net_device *dev, const void *ctx,
356 const struct switchdev_obj *obj));
357 int switchdev_handle_port_obj_del_foreign(struct net_device *dev,
358 struct switchdev_notifier_port_obj_info *port_obj_info,
359 bool (*check_cb)(const struct net_device *dev),
360 bool (*foreign_dev_check_cb)(const struct net_device *dev,
361 const struct net_device *foreign_dev),
362 int (*del_cb)(struct net_device *dev, const void *ctx,
363 const struct switchdev_obj *obj));
365 int switchdev_handle_port_attr_set(struct net_device *dev,
366 struct switchdev_notifier_port_attr_info *port_attr_info,
367 bool (*check_cb)(const struct net_device *dev),
368 int (*set_cb)(struct net_device *dev, const void *ctx,
369 const struct switchdev_attr *attr,
370 struct netlink_ext_ack *extack));
374 switchdev_bridge_port_offload(struct net_device *brport_dev,
375 struct net_device *dev, const void *ctx,
376 struct notifier_block *atomic_nb,
377 struct notifier_block *blocking_nb,
379 struct netlink_ext_ack *extack)
385 switchdev_bridge_port_unoffload(struct net_device *brport_dev,
387 struct notifier_block *atomic_nb,
388 struct notifier_block *blocking_nb)
392 static inline void switchdev_deferred_process(void)
396 static inline int switchdev_port_attr_set(struct net_device *dev,
397 const struct switchdev_attr *attr,
398 struct netlink_ext_ack *extack)
403 static inline int switchdev_port_obj_add(struct net_device *dev,
404 const struct switchdev_obj *obj,
405 struct netlink_ext_ack *extack)
410 static inline int switchdev_port_obj_del(struct net_device *dev,
411 const struct switchdev_obj *obj)
416 static inline int register_switchdev_notifier(struct notifier_block *nb)
421 static inline int unregister_switchdev_notifier(struct notifier_block *nb)
426 static inline int call_switchdev_notifiers(unsigned long val,
427 struct net_device *dev,
428 struct switchdev_notifier_info *info,
429 struct netlink_ext_ack *extack)
435 register_switchdev_blocking_notifier(struct notifier_block *nb)
441 unregister_switchdev_blocking_notifier(struct notifier_block *nb)
447 call_switchdev_blocking_notifiers(unsigned long val,
448 struct net_device *dev,
449 struct switchdev_notifier_info *info,
450 struct netlink_ext_ack *extack)
456 switchdev_handle_fdb_event_to_device(struct net_device *dev, unsigned long event,
457 const struct switchdev_notifier_fdb_info *fdb_info,
458 bool (*check_cb)(const struct net_device *dev),
459 bool (*foreign_dev_check_cb)(const struct net_device *dev,
460 const struct net_device *foreign_dev),
461 int (*mod_cb)(struct net_device *dev, struct net_device *orig_dev,
462 unsigned long event, const void *ctx,
463 const struct switchdev_notifier_fdb_info *fdb_info))
469 switchdev_handle_port_obj_add(struct net_device *dev,
470 struct switchdev_notifier_port_obj_info *port_obj_info,
471 bool (*check_cb)(const struct net_device *dev),
472 int (*add_cb)(struct net_device *dev, const void *ctx,
473 const struct switchdev_obj *obj,
474 struct netlink_ext_ack *extack))
479 static inline int switchdev_handle_port_obj_add_foreign(struct net_device *dev,
480 struct switchdev_notifier_port_obj_info *port_obj_info,
481 bool (*check_cb)(const struct net_device *dev),
482 bool (*foreign_dev_check_cb)(const struct net_device *dev,
483 const struct net_device *foreign_dev),
484 int (*add_cb)(struct net_device *dev, const void *ctx,
485 const struct switchdev_obj *obj,
486 struct netlink_ext_ack *extack))
492 switchdev_handle_port_obj_del(struct net_device *dev,
493 struct switchdev_notifier_port_obj_info *port_obj_info,
494 bool (*check_cb)(const struct net_device *dev),
495 int (*del_cb)(struct net_device *dev, const void *ctx,
496 const struct switchdev_obj *obj))
502 switchdev_handle_port_obj_del_foreign(struct net_device *dev,
503 struct switchdev_notifier_port_obj_info *port_obj_info,
504 bool (*check_cb)(const struct net_device *dev),
505 bool (*foreign_dev_check_cb)(const struct net_device *dev,
506 const struct net_device *foreign_dev),
507 int (*del_cb)(struct net_device *dev, const void *ctx,
508 const struct switchdev_obj *obj))
514 switchdev_handle_port_attr_set(struct net_device *dev,
515 struct switchdev_notifier_port_attr_info *port_attr_info,
516 bool (*check_cb)(const struct net_device *dev),
517 int (*set_cb)(struct net_device *dev, const void *ctx,
518 const struct switchdev_attr *attr,
519 struct netlink_ext_ack *extack))
525 #endif /* _LINUX_SWITCHDEV_H_ */