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_BRIDGE_FLAGS
,
23 SWITCHDEV_ATTR_ID_PORT_PRE_BRIDGE_FLAGS
,
24 SWITCHDEV_ATTR_ID_PORT_MROUTER
,
25 SWITCHDEV_ATTR_ID_BRIDGE_AGEING_TIME
,
26 SWITCHDEV_ATTR_ID_BRIDGE_VLAN_FILTERING
,
27 SWITCHDEV_ATTR_ID_BRIDGE_VLAN_PROTOCOL
,
28 SWITCHDEV_ATTR_ID_BRIDGE_MC_DISABLED
,
29 SWITCHDEV_ATTR_ID_BRIDGE_MROUTER
,
30 SWITCHDEV_ATTR_ID_MRP_PORT_ROLE
,
33 struct switchdev_brport_flags
{
38 struct switchdev_attr
{
39 struct net_device
*orig_dev
;
40 enum switchdev_attr_id id
;
43 void (*complete
)(struct net_device
*dev
, int err
, void *priv
);
45 u8 stp_state
; /* PORT_STP_STATE */
46 struct switchdev_brport_flags brport_flags
; /* PORT_BRIDGE_FLAGS */
47 bool mrouter
; /* PORT_MROUTER */
48 clock_t ageing_time
; /* BRIDGE_AGEING_TIME */
49 bool vlan_filtering
; /* BRIDGE_VLAN_FILTERING */
50 u16 vlan_protocol
; /* BRIDGE_VLAN_PROTOCOL */
51 bool mc_disabled
; /* MC_DISABLED */
52 u8 mrp_port_role
; /* MRP_PORT_ROLE */
56 enum switchdev_obj_id
{
57 SWITCHDEV_OBJ_ID_UNDEFINED
,
58 SWITCHDEV_OBJ_ID_PORT_VLAN
,
59 SWITCHDEV_OBJ_ID_PORT_MDB
,
60 SWITCHDEV_OBJ_ID_HOST_MDB
,
62 SWITCHDEV_OBJ_ID_RING_TEST_MRP
,
63 SWITCHDEV_OBJ_ID_RING_ROLE_MRP
,
64 SWITCHDEV_OBJ_ID_RING_STATE_MRP
,
65 SWITCHDEV_OBJ_ID_IN_TEST_MRP
,
66 SWITCHDEV_OBJ_ID_IN_ROLE_MRP
,
67 SWITCHDEV_OBJ_ID_IN_STATE_MRP
,
70 struct switchdev_obj
{
71 struct list_head list
;
72 struct net_device
*orig_dev
;
73 enum switchdev_obj_id id
;
76 void (*complete
)(struct net_device
*dev
, int err
, void *priv
);
79 /* SWITCHDEV_OBJ_ID_PORT_VLAN */
80 struct switchdev_obj_port_vlan
{
81 struct switchdev_obj obj
;
86 #define SWITCHDEV_OBJ_PORT_VLAN(OBJ) \
87 container_of((OBJ), struct switchdev_obj_port_vlan, obj)
89 /* SWITCHDEV_OBJ_ID_PORT_MDB */
90 struct switchdev_obj_port_mdb
{
91 struct switchdev_obj obj
;
92 unsigned char addr
[ETH_ALEN
];
96 #define SWITCHDEV_OBJ_PORT_MDB(OBJ) \
97 container_of((OBJ), struct switchdev_obj_port_mdb, obj)
100 /* SWITCHDEV_OBJ_ID_MRP */
101 struct switchdev_obj_mrp
{
102 struct switchdev_obj obj
;
103 struct net_device
*p_port
;
104 struct net_device
*s_port
;
109 #define SWITCHDEV_OBJ_MRP(OBJ) \
110 container_of((OBJ), struct switchdev_obj_mrp, obj)
112 /* SWITCHDEV_OBJ_ID_RING_TEST_MRP */
113 struct switchdev_obj_ring_test_mrp
{
114 struct switchdev_obj obj
;
115 /* The value is in us and a value of 0 represents to stop */
123 #define SWITCHDEV_OBJ_RING_TEST_MRP(OBJ) \
124 container_of((OBJ), struct switchdev_obj_ring_test_mrp, obj)
126 /* SWICHDEV_OBJ_ID_RING_ROLE_MRP */
127 struct switchdev_obj_ring_role_mrp
{
128 struct switchdev_obj obj
;
134 #define SWITCHDEV_OBJ_RING_ROLE_MRP(OBJ) \
135 container_of((OBJ), struct switchdev_obj_ring_role_mrp, obj)
137 struct switchdev_obj_ring_state_mrp
{
138 struct switchdev_obj obj
;
143 #define SWITCHDEV_OBJ_RING_STATE_MRP(OBJ) \
144 container_of((OBJ), struct switchdev_obj_ring_state_mrp, obj)
146 /* SWITCHDEV_OBJ_ID_IN_TEST_MRP */
147 struct switchdev_obj_in_test_mrp
{
148 struct switchdev_obj obj
;
149 /* The value is in us and a value of 0 represents to stop */
156 #define SWITCHDEV_OBJ_IN_TEST_MRP(OBJ) \
157 container_of((OBJ), struct switchdev_obj_in_test_mrp, obj)
159 /* SWICHDEV_OBJ_ID_IN_ROLE_MRP */
160 struct switchdev_obj_in_role_mrp
{
161 struct switchdev_obj obj
;
162 struct net_device
*i_port
;
169 #define SWITCHDEV_OBJ_IN_ROLE_MRP(OBJ) \
170 container_of((OBJ), struct switchdev_obj_in_role_mrp, obj)
172 struct switchdev_obj_in_state_mrp
{
173 struct switchdev_obj obj
;
178 #define SWITCHDEV_OBJ_IN_STATE_MRP(OBJ) \
179 container_of((OBJ), struct switchdev_obj_in_state_mrp, obj)
181 typedef int switchdev_obj_dump_cb_t(struct switchdev_obj
*obj
);
183 struct switchdev_brport
{
184 struct net_device
*dev
;
186 struct notifier_block
*atomic_nb
;
187 struct notifier_block
*blocking_nb
;
191 enum switchdev_notifier_type
{
192 SWITCHDEV_FDB_ADD_TO_BRIDGE
= 1,
193 SWITCHDEV_FDB_DEL_TO_BRIDGE
,
194 SWITCHDEV_FDB_ADD_TO_DEVICE
,
195 SWITCHDEV_FDB_DEL_TO_DEVICE
,
196 SWITCHDEV_FDB_OFFLOADED
,
197 SWITCHDEV_FDB_FLUSH_TO_BRIDGE
,
199 SWITCHDEV_PORT_OBJ_ADD
, /* Blocking. */
200 SWITCHDEV_PORT_OBJ_DEL
, /* Blocking. */
201 SWITCHDEV_PORT_ATTR_SET
, /* May be blocking . */
203 SWITCHDEV_VXLAN_FDB_ADD_TO_BRIDGE
,
204 SWITCHDEV_VXLAN_FDB_DEL_TO_BRIDGE
,
205 SWITCHDEV_VXLAN_FDB_ADD_TO_DEVICE
,
206 SWITCHDEV_VXLAN_FDB_DEL_TO_DEVICE
,
207 SWITCHDEV_VXLAN_FDB_OFFLOADED
,
209 SWITCHDEV_BRPORT_OFFLOADED
,
210 SWITCHDEV_BRPORT_UNOFFLOADED
,
213 struct switchdev_notifier_info
{
214 struct net_device
*dev
;
215 struct netlink_ext_ack
*extack
;
219 struct switchdev_notifier_fdb_info
{
220 struct switchdev_notifier_info info
; /* must be first */
221 const unsigned char *addr
;
228 struct switchdev_notifier_port_obj_info
{
229 struct switchdev_notifier_info info
; /* must be first */
230 const struct switchdev_obj
*obj
;
234 struct switchdev_notifier_port_attr_info
{
235 struct switchdev_notifier_info info
; /* must be first */
236 const struct switchdev_attr
*attr
;
240 struct switchdev_notifier_brport_info
{
241 struct switchdev_notifier_info info
; /* must be first */
242 const struct switchdev_brport brport
;
245 static inline struct net_device
*
246 switchdev_notifier_info_to_dev(const struct switchdev_notifier_info
*info
)
251 static inline struct netlink_ext_ack
*
252 switchdev_notifier_info_to_extack(const struct switchdev_notifier_info
*info
)
258 switchdev_fdb_is_dynamically_learned(const struct switchdev_notifier_fdb_info
*fdb_info
)
260 return !fdb_info
->added_by_user
&& !fdb_info
->is_local
;
263 #ifdef CONFIG_NET_SWITCHDEV
265 int switchdev_bridge_port_offload(struct net_device
*brport_dev
,
266 struct net_device
*dev
, const void *ctx
,
267 struct notifier_block
*atomic_nb
,
268 struct notifier_block
*blocking_nb
,
270 struct netlink_ext_ack
*extack
);
271 void switchdev_bridge_port_unoffload(struct net_device
*brport_dev
,
273 struct notifier_block
*atomic_nb
,
274 struct notifier_block
*blocking_nb
);
276 void switchdev_deferred_process(void);
277 int switchdev_port_attr_set(struct net_device
*dev
,
278 const struct switchdev_attr
*attr
,
279 struct netlink_ext_ack
*extack
);
280 int switchdev_port_obj_add(struct net_device
*dev
,
281 const struct switchdev_obj
*obj
,
282 struct netlink_ext_ack
*extack
);
283 int switchdev_port_obj_del(struct net_device
*dev
,
284 const struct switchdev_obj
*obj
);
286 int register_switchdev_notifier(struct notifier_block
*nb
);
287 int unregister_switchdev_notifier(struct notifier_block
*nb
);
288 int call_switchdev_notifiers(unsigned long val
, struct net_device
*dev
,
289 struct switchdev_notifier_info
*info
,
290 struct netlink_ext_ack
*extack
);
292 int register_switchdev_blocking_notifier(struct notifier_block
*nb
);
293 int unregister_switchdev_blocking_notifier(struct notifier_block
*nb
);
294 int call_switchdev_blocking_notifiers(unsigned long val
, struct net_device
*dev
,
295 struct switchdev_notifier_info
*info
,
296 struct netlink_ext_ack
*extack
);
298 void switchdev_port_fwd_mark_set(struct net_device
*dev
,
299 struct net_device
*group_dev
,
302 int switchdev_handle_fdb_add_to_device(struct net_device
*dev
,
303 const struct switchdev_notifier_fdb_info
*fdb_info
,
304 bool (*check_cb
)(const struct net_device
*dev
),
305 bool (*foreign_dev_check_cb
)(const struct net_device
*dev
,
306 const struct net_device
*foreign_dev
),
307 int (*add_cb
)(struct net_device
*dev
,
308 const struct net_device
*orig_dev
, const void *ctx
,
309 const struct switchdev_notifier_fdb_info
*fdb_info
),
310 int (*lag_add_cb
)(struct net_device
*dev
,
311 const struct net_device
*orig_dev
, const void *ctx
,
312 const struct switchdev_notifier_fdb_info
*fdb_info
));
314 int switchdev_handle_fdb_del_to_device(struct net_device
*dev
,
315 const struct switchdev_notifier_fdb_info
*fdb_info
,
316 bool (*check_cb
)(const struct net_device
*dev
),
317 bool (*foreign_dev_check_cb
)(const struct net_device
*dev
,
318 const struct net_device
*foreign_dev
),
319 int (*del_cb
)(struct net_device
*dev
,
320 const struct net_device
*orig_dev
, const void *ctx
,
321 const struct switchdev_notifier_fdb_info
*fdb_info
),
322 int (*lag_del_cb
)(struct net_device
*dev
,
323 const struct net_device
*orig_dev
, const void *ctx
,
324 const struct switchdev_notifier_fdb_info
*fdb_info
));
326 int switchdev_handle_port_obj_add(struct net_device
*dev
,
327 struct switchdev_notifier_port_obj_info
*port_obj_info
,
328 bool (*check_cb
)(const struct net_device
*dev
),
329 int (*add_cb
)(struct net_device
*dev
, const void *ctx
,
330 const struct switchdev_obj
*obj
,
331 struct netlink_ext_ack
*extack
));
332 int switchdev_handle_port_obj_del(struct net_device
*dev
,
333 struct switchdev_notifier_port_obj_info
*port_obj_info
,
334 bool (*check_cb
)(const struct net_device
*dev
),
335 int (*del_cb
)(struct net_device
*dev
, const void *ctx
,
336 const struct switchdev_obj
*obj
));
338 int switchdev_handle_port_attr_set(struct net_device
*dev
,
339 struct switchdev_notifier_port_attr_info
*port_attr_info
,
340 bool (*check_cb
)(const struct net_device
*dev
),
341 int (*set_cb
)(struct net_device
*dev
, const void *ctx
,
342 const struct switchdev_attr
*attr
,
343 struct netlink_ext_ack
*extack
));
347 switchdev_bridge_port_offload(struct net_device
*brport_dev
,
348 struct net_device
*dev
, const void *ctx
,
349 struct notifier_block
*atomic_nb
,
350 struct notifier_block
*blocking_nb
,
352 struct netlink_ext_ack
*extack
)
358 switchdev_bridge_port_unoffload(struct net_device
*brport_dev
,
360 struct notifier_block
*atomic_nb
,
361 struct notifier_block
*blocking_nb
)
365 static inline void switchdev_deferred_process(void)
369 static inline int switchdev_port_attr_set(struct net_device
*dev
,
370 const struct switchdev_attr
*attr
,
371 struct netlink_ext_ack
*extack
)
376 static inline int switchdev_port_obj_add(struct net_device
*dev
,
377 const struct switchdev_obj
*obj
,
378 struct netlink_ext_ack
*extack
)
383 static inline int switchdev_port_obj_del(struct net_device
*dev
,
384 const struct switchdev_obj
*obj
)
389 static inline int register_switchdev_notifier(struct notifier_block
*nb
)
394 static inline int unregister_switchdev_notifier(struct notifier_block
*nb
)
399 static inline int call_switchdev_notifiers(unsigned long val
,
400 struct net_device
*dev
,
401 struct switchdev_notifier_info
*info
,
402 struct netlink_ext_ack
*extack
)
408 register_switchdev_blocking_notifier(struct notifier_block
*nb
)
414 unregister_switchdev_blocking_notifier(struct notifier_block
*nb
)
420 call_switchdev_blocking_notifiers(unsigned long val
,
421 struct net_device
*dev
,
422 struct switchdev_notifier_info
*info
,
423 struct netlink_ext_ack
*extack
)
429 switchdev_handle_fdb_add_to_device(struct net_device
*dev
,
430 const struct switchdev_notifier_fdb_info
*fdb_info
,
431 bool (*check_cb
)(const struct net_device
*dev
),
432 bool (*foreign_dev_check_cb
)(const struct net_device
*dev
,
433 const struct net_device
*foreign_dev
),
434 int (*add_cb
)(struct net_device
*dev
,
435 const struct net_device
*orig_dev
, const void *ctx
,
436 const struct switchdev_notifier_fdb_info
*fdb_info
),
437 int (*lag_add_cb
)(struct net_device
*dev
,
438 const struct net_device
*orig_dev
, const void *ctx
,
439 const struct switchdev_notifier_fdb_info
*fdb_info
))
445 switchdev_handle_fdb_del_to_device(struct net_device
*dev
,
446 const struct switchdev_notifier_fdb_info
*fdb_info
,
447 bool (*check_cb
)(const struct net_device
*dev
),
448 bool (*foreign_dev_check_cb
)(const struct net_device
*dev
,
449 const struct net_device
*foreign_dev
),
450 int (*del_cb
)(struct net_device
*dev
,
451 const struct net_device
*orig_dev
, const void *ctx
,
452 const struct switchdev_notifier_fdb_info
*fdb_info
),
453 int (*lag_del_cb
)(struct net_device
*dev
,
454 const struct net_device
*orig_dev
, const void *ctx
,
455 const struct switchdev_notifier_fdb_info
*fdb_info
))
461 switchdev_handle_port_obj_add(struct net_device
*dev
,
462 struct switchdev_notifier_port_obj_info
*port_obj_info
,
463 bool (*check_cb
)(const struct net_device
*dev
),
464 int (*add_cb
)(struct net_device
*dev
, const void *ctx
,
465 const struct switchdev_obj
*obj
,
466 struct netlink_ext_ack
*extack
))
472 switchdev_handle_port_obj_del(struct net_device
*dev
,
473 struct switchdev_notifier_port_obj_info
*port_obj_info
,
474 bool (*check_cb
)(const struct net_device
*dev
),
475 int (*del_cb
)(struct net_device
*dev
, const void *ctx
,
476 const struct switchdev_obj
*obj
))
482 switchdev_handle_port_attr_set(struct net_device
*dev
,
483 struct switchdev_notifier_port_attr_info
*port_attr_info
,
484 bool (*check_cb
)(const struct net_device
*dev
),
485 int (*set_cb
)(struct net_device
*dev
, const void *ctx
,
486 const struct switchdev_attr
*attr
,
487 struct netlink_ext_ack
*extack
))
493 #endif /* _LINUX_SWITCHDEV_H_ */