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 struct switchdev_trans
{
23 static inline bool switchdev_trans_ph_prepare(struct switchdev_trans
*trans
)
25 return trans
&& trans
->ph_prepare
;
28 static inline bool switchdev_trans_ph_commit(struct switchdev_trans
*trans
)
30 return trans
&& !trans
->ph_prepare
;
33 enum switchdev_attr_id
{
34 SWITCHDEV_ATTR_ID_UNDEFINED
,
35 SWITCHDEV_ATTR_ID_PORT_STP_STATE
,
36 SWITCHDEV_ATTR_ID_PORT_BRIDGE_FLAGS
,
37 SWITCHDEV_ATTR_ID_PORT_PRE_BRIDGE_FLAGS
,
38 SWITCHDEV_ATTR_ID_PORT_MROUTER
,
39 SWITCHDEV_ATTR_ID_BRIDGE_AGEING_TIME
,
40 SWITCHDEV_ATTR_ID_BRIDGE_VLAN_FILTERING
,
41 SWITCHDEV_ATTR_ID_BRIDGE_MC_DISABLED
,
42 SWITCHDEV_ATTR_ID_BRIDGE_MROUTER
,
43 #if IS_ENABLED(CONFIG_BRIDGE_MRP)
44 SWITCHDEV_ATTR_ID_MRP_PORT_STATE
,
45 SWITCHDEV_ATTR_ID_MRP_PORT_ROLE
,
49 struct switchdev_attr
{
50 struct net_device
*orig_dev
;
51 enum switchdev_attr_id id
;
54 void (*complete
)(struct net_device
*dev
, int err
, void *priv
);
56 u8 stp_state
; /* PORT_STP_STATE */
57 unsigned long brport_flags
; /* PORT_{PRE}_BRIDGE_FLAGS */
58 bool mrouter
; /* PORT_MROUTER */
59 clock_t ageing_time
; /* BRIDGE_AGEING_TIME */
60 bool vlan_filtering
; /* BRIDGE_VLAN_FILTERING */
61 bool mc_disabled
; /* MC_DISABLED */
62 #if IS_ENABLED(CONFIG_BRIDGE_MRP)
63 u8 mrp_port_state
; /* MRP_PORT_STATE */
64 u8 mrp_port_role
; /* MRP_PORT_ROLE */
69 enum switchdev_obj_id
{
70 SWITCHDEV_OBJ_ID_UNDEFINED
,
71 SWITCHDEV_OBJ_ID_PORT_VLAN
,
72 SWITCHDEV_OBJ_ID_PORT_MDB
,
73 SWITCHDEV_OBJ_ID_HOST_MDB
,
74 #if IS_ENABLED(CONFIG_BRIDGE_MRP)
76 SWITCHDEV_OBJ_ID_RING_TEST_MRP
,
77 SWITCHDEV_OBJ_ID_RING_ROLE_MRP
,
78 SWITCHDEV_OBJ_ID_RING_STATE_MRP
,
79 SWITCHDEV_OBJ_ID_IN_TEST_MRP
,
80 SWITCHDEV_OBJ_ID_IN_ROLE_MRP
,
81 SWITCHDEV_OBJ_ID_IN_STATE_MRP
,
86 struct switchdev_obj
{
87 struct net_device
*orig_dev
;
88 enum switchdev_obj_id id
;
91 void (*complete
)(struct net_device
*dev
, int err
, void *priv
);
94 /* SWITCHDEV_OBJ_ID_PORT_VLAN */
95 struct switchdev_obj_port_vlan
{
96 struct switchdev_obj obj
;
102 #define SWITCHDEV_OBJ_PORT_VLAN(OBJ) \
103 container_of((OBJ), struct switchdev_obj_port_vlan, obj)
105 /* SWITCHDEV_OBJ_ID_PORT_MDB */
106 struct switchdev_obj_port_mdb
{
107 struct switchdev_obj obj
;
108 unsigned char addr
[ETH_ALEN
];
112 #define SWITCHDEV_OBJ_PORT_MDB(OBJ) \
113 container_of((OBJ), struct switchdev_obj_port_mdb, obj)
116 #if IS_ENABLED(CONFIG_BRIDGE_MRP)
117 /* SWITCHDEV_OBJ_ID_MRP */
118 struct switchdev_obj_mrp
{
119 struct switchdev_obj obj
;
120 struct net_device
*p_port
;
121 struct net_device
*s_port
;
126 #define SWITCHDEV_OBJ_MRP(OBJ) \
127 container_of((OBJ), struct switchdev_obj_mrp, obj)
129 /* SWITCHDEV_OBJ_ID_RING_TEST_MRP */
130 struct switchdev_obj_ring_test_mrp
{
131 struct switchdev_obj obj
;
132 /* The value is in us and a value of 0 represents to stop */
140 #define SWITCHDEV_OBJ_RING_TEST_MRP(OBJ) \
141 container_of((OBJ), struct switchdev_obj_ring_test_mrp, obj)
143 /* SWICHDEV_OBJ_ID_RING_ROLE_MRP */
144 struct switchdev_obj_ring_role_mrp
{
145 struct switchdev_obj obj
;
150 #define SWITCHDEV_OBJ_RING_ROLE_MRP(OBJ) \
151 container_of((OBJ), struct switchdev_obj_ring_role_mrp, obj)
153 struct switchdev_obj_ring_state_mrp
{
154 struct switchdev_obj obj
;
159 #define SWITCHDEV_OBJ_RING_STATE_MRP(OBJ) \
160 container_of((OBJ), struct switchdev_obj_ring_state_mrp, obj)
162 /* SWITCHDEV_OBJ_ID_IN_TEST_MRP */
163 struct switchdev_obj_in_test_mrp
{
164 struct switchdev_obj obj
;
165 /* The value is in us and a value of 0 represents to stop */
172 #define SWITCHDEV_OBJ_IN_TEST_MRP(OBJ) \
173 container_of((OBJ), struct switchdev_obj_in_test_mrp, obj)
175 /* SWICHDEV_OBJ_ID_IN_ROLE_MRP */
176 struct switchdev_obj_in_role_mrp
{
177 struct switchdev_obj obj
;
178 struct net_device
*i_port
;
184 #define SWITCHDEV_OBJ_IN_ROLE_MRP(OBJ) \
185 container_of((OBJ), struct switchdev_obj_in_role_mrp, obj)
187 struct switchdev_obj_in_state_mrp
{
188 struct switchdev_obj obj
;
193 #define SWITCHDEV_OBJ_IN_STATE_MRP(OBJ) \
194 container_of((OBJ), struct switchdev_obj_in_state_mrp, obj)
198 typedef int switchdev_obj_dump_cb_t(struct switchdev_obj
*obj
);
200 enum switchdev_notifier_type
{
201 SWITCHDEV_FDB_ADD_TO_BRIDGE
= 1,
202 SWITCHDEV_FDB_DEL_TO_BRIDGE
,
203 SWITCHDEV_FDB_ADD_TO_DEVICE
,
204 SWITCHDEV_FDB_DEL_TO_DEVICE
,
205 SWITCHDEV_FDB_OFFLOADED
,
206 SWITCHDEV_FDB_FLUSH_TO_BRIDGE
,
208 SWITCHDEV_PORT_OBJ_ADD
, /* Blocking. */
209 SWITCHDEV_PORT_OBJ_DEL
, /* Blocking. */
210 SWITCHDEV_PORT_ATTR_SET
, /* May be blocking . */
212 SWITCHDEV_VXLAN_FDB_ADD_TO_BRIDGE
,
213 SWITCHDEV_VXLAN_FDB_DEL_TO_BRIDGE
,
214 SWITCHDEV_VXLAN_FDB_ADD_TO_DEVICE
,
215 SWITCHDEV_VXLAN_FDB_DEL_TO_DEVICE
,
216 SWITCHDEV_VXLAN_FDB_OFFLOADED
,
219 struct switchdev_notifier_info
{
220 struct net_device
*dev
;
221 struct netlink_ext_ack
*extack
;
224 struct switchdev_notifier_fdb_info
{
225 struct switchdev_notifier_info info
; /* must be first */
226 const unsigned char *addr
;
232 struct switchdev_notifier_port_obj_info
{
233 struct switchdev_notifier_info info
; /* must be first */
234 const struct switchdev_obj
*obj
;
235 struct switchdev_trans
*trans
;
239 struct switchdev_notifier_port_attr_info
{
240 struct switchdev_notifier_info info
; /* must be first */
241 const struct switchdev_attr
*attr
;
242 struct switchdev_trans
*trans
;
246 static inline struct net_device
*
247 switchdev_notifier_info_to_dev(const struct switchdev_notifier_info
*info
)
252 static inline struct netlink_ext_ack
*
253 switchdev_notifier_info_to_extack(const struct switchdev_notifier_info
*info
)
258 #ifdef CONFIG_NET_SWITCHDEV
260 void switchdev_deferred_process(void);
261 int switchdev_port_attr_set(struct net_device
*dev
,
262 const struct switchdev_attr
*attr
);
263 int switchdev_port_obj_add(struct net_device
*dev
,
264 const struct switchdev_obj
*obj
,
265 struct netlink_ext_ack
*extack
);
266 int switchdev_port_obj_del(struct net_device
*dev
,
267 const struct switchdev_obj
*obj
);
269 int register_switchdev_notifier(struct notifier_block
*nb
);
270 int unregister_switchdev_notifier(struct notifier_block
*nb
);
271 int call_switchdev_notifiers(unsigned long val
, struct net_device
*dev
,
272 struct switchdev_notifier_info
*info
,
273 struct netlink_ext_ack
*extack
);
275 int register_switchdev_blocking_notifier(struct notifier_block
*nb
);
276 int unregister_switchdev_blocking_notifier(struct notifier_block
*nb
);
277 int call_switchdev_blocking_notifiers(unsigned long val
, struct net_device
*dev
,
278 struct switchdev_notifier_info
*info
,
279 struct netlink_ext_ack
*extack
);
281 void switchdev_port_fwd_mark_set(struct net_device
*dev
,
282 struct net_device
*group_dev
,
285 int switchdev_handle_port_obj_add(struct net_device
*dev
,
286 struct switchdev_notifier_port_obj_info
*port_obj_info
,
287 bool (*check_cb
)(const struct net_device
*dev
),
288 int (*add_cb
)(struct net_device
*dev
,
289 const struct switchdev_obj
*obj
,
290 struct switchdev_trans
*trans
,
291 struct netlink_ext_ack
*extack
));
292 int switchdev_handle_port_obj_del(struct net_device
*dev
,
293 struct switchdev_notifier_port_obj_info
*port_obj_info
,
294 bool (*check_cb
)(const struct net_device
*dev
),
295 int (*del_cb
)(struct net_device
*dev
,
296 const struct switchdev_obj
*obj
));
298 int switchdev_handle_port_attr_set(struct net_device
*dev
,
299 struct switchdev_notifier_port_attr_info
*port_attr_info
,
300 bool (*check_cb
)(const struct net_device
*dev
),
301 int (*set_cb
)(struct net_device
*dev
,
302 const struct switchdev_attr
*attr
,
303 struct switchdev_trans
*trans
));
306 static inline void switchdev_deferred_process(void)
310 static inline int switchdev_port_attr_set(struct net_device
*dev
,
311 const struct switchdev_attr
*attr
)
316 static inline int switchdev_port_obj_add(struct net_device
*dev
,
317 const struct switchdev_obj
*obj
,
318 struct netlink_ext_ack
*extack
)
323 static inline int switchdev_port_obj_del(struct net_device
*dev
,
324 const struct switchdev_obj
*obj
)
329 static inline int register_switchdev_notifier(struct notifier_block
*nb
)
334 static inline int unregister_switchdev_notifier(struct notifier_block
*nb
)
339 static inline int call_switchdev_notifiers(unsigned long val
,
340 struct net_device
*dev
,
341 struct switchdev_notifier_info
*info
,
342 struct netlink_ext_ack
*extack
)
348 register_switchdev_blocking_notifier(struct notifier_block
*nb
)
354 unregister_switchdev_blocking_notifier(struct notifier_block
*nb
)
360 call_switchdev_blocking_notifiers(unsigned long val
,
361 struct net_device
*dev
,
362 struct switchdev_notifier_info
*info
,
363 struct netlink_ext_ack
*extack
)
369 switchdev_handle_port_obj_add(struct net_device
*dev
,
370 struct switchdev_notifier_port_obj_info
*port_obj_info
,
371 bool (*check_cb
)(const struct net_device
*dev
),
372 int (*add_cb
)(struct net_device
*dev
,
373 const struct switchdev_obj
*obj
,
374 struct switchdev_trans
*trans
,
375 struct netlink_ext_ack
*extack
))
381 switchdev_handle_port_obj_del(struct net_device
*dev
,
382 struct switchdev_notifier_port_obj_info
*port_obj_info
,
383 bool (*check_cb
)(const struct net_device
*dev
),
384 int (*del_cb
)(struct net_device
*dev
,
385 const struct switchdev_obj
*obj
))
391 switchdev_handle_port_attr_set(struct net_device
*dev
,
392 struct switchdev_notifier_port_attr_info
*port_attr_info
,
393 bool (*check_cb
)(const struct net_device
*dev
),
394 int (*set_cb
)(struct net_device
*dev
,
395 const struct switchdev_attr
*attr
,
396 struct switchdev_trans
*trans
))
402 #endif /* _LINUX_SWITCHDEV_H_ */