Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/* SPDX-License-Identifier: GPL-2.0-or-later */
2/*
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>
6 */
7#ifndef _LINUX_SWITCHDEV_H_
8#define _LINUX_SWITCHDEV_H_
9
10#include <linux/netdevice.h>
11#include <linux/notifier.h>
12#include <linux/list.h>
13#include <net/ip_fib.h>
14
15#define SWITCHDEV_F_NO_RECURSE BIT(0)
16#define SWITCHDEV_F_SKIP_EOPNOTSUPP BIT(1)
17#define SWITCHDEV_F_DEFER BIT(2)
18
19enum 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,
31};
32
33struct switchdev_brport_flags {
34 unsigned long val;
35 unsigned long mask;
36};
37
38struct switchdev_attr {
39 struct net_device *orig_dev;
40 enum switchdev_attr_id id;
41 u32 flags;
42 void *complete_priv;
43 void (*complete)(struct net_device *dev, int err, void *priv);
44 union {
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 */
53 } u;
54};
55
56enum 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,
61 SWITCHDEV_OBJ_ID_MRP,
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,
68};
69
70struct switchdev_obj {
71 struct list_head list;
72 struct net_device *orig_dev;
73 enum switchdev_obj_id id;
74 u32 flags;
75 void *complete_priv;
76 void (*complete)(struct net_device *dev, int err, void *priv);
77};
78
79/* SWITCHDEV_OBJ_ID_PORT_VLAN */
80struct switchdev_obj_port_vlan {
81 struct switchdev_obj obj;
82 u16 flags;
83 u16 vid;
84};
85
86#define SWITCHDEV_OBJ_PORT_VLAN(OBJ) \
87 container_of((OBJ), struct switchdev_obj_port_vlan, obj)
88
89/* SWITCHDEV_OBJ_ID_PORT_MDB */
90struct switchdev_obj_port_mdb {
91 struct switchdev_obj obj;
92 unsigned char addr[ETH_ALEN];
93 u16 vid;
94};
95
96#define SWITCHDEV_OBJ_PORT_MDB(OBJ) \
97 container_of((OBJ), struct switchdev_obj_port_mdb, obj)
98
99
100/* SWITCHDEV_OBJ_ID_MRP */
101struct switchdev_obj_mrp {
102 struct switchdev_obj obj;
103 struct net_device *p_port;
104 struct net_device *s_port;
105 u32 ring_id;
106 u16 prio;
107};
108
109#define SWITCHDEV_OBJ_MRP(OBJ) \
110 container_of((OBJ), struct switchdev_obj_mrp, obj)
111
112/* SWITCHDEV_OBJ_ID_RING_TEST_MRP */
113struct switchdev_obj_ring_test_mrp {
114 struct switchdev_obj obj;
115 /* The value is in us and a value of 0 represents to stop */
116 u32 interval;
117 u8 max_miss;
118 u32 ring_id;
119 u32 period;
120 bool monitor;
121};
122
123#define SWITCHDEV_OBJ_RING_TEST_MRP(OBJ) \
124 container_of((OBJ), struct switchdev_obj_ring_test_mrp, obj)
125
126/* SWICHDEV_OBJ_ID_RING_ROLE_MRP */
127struct switchdev_obj_ring_role_mrp {
128 struct switchdev_obj obj;
129 u8 ring_role;
130 u32 ring_id;
131 u8 sw_backup;
132};
133
134#define SWITCHDEV_OBJ_RING_ROLE_MRP(OBJ) \
135 container_of((OBJ), struct switchdev_obj_ring_role_mrp, obj)
136
137struct switchdev_obj_ring_state_mrp {
138 struct switchdev_obj obj;
139 u8 ring_state;
140 u32 ring_id;
141};
142
143#define SWITCHDEV_OBJ_RING_STATE_MRP(OBJ) \
144 container_of((OBJ), struct switchdev_obj_ring_state_mrp, obj)
145
146/* SWITCHDEV_OBJ_ID_IN_TEST_MRP */
147struct switchdev_obj_in_test_mrp {
148 struct switchdev_obj obj;
149 /* The value is in us and a value of 0 represents to stop */
150 u32 interval;
151 u32 in_id;
152 u32 period;
153 u8 max_miss;
154};
155
156#define SWITCHDEV_OBJ_IN_TEST_MRP(OBJ) \
157 container_of((OBJ), struct switchdev_obj_in_test_mrp, obj)
158
159/* SWICHDEV_OBJ_ID_IN_ROLE_MRP */
160struct switchdev_obj_in_role_mrp {
161 struct switchdev_obj obj;
162 struct net_device *i_port;
163 u32 ring_id;
164 u16 in_id;
165 u8 in_role;
166 u8 sw_backup;
167};
168
169#define SWITCHDEV_OBJ_IN_ROLE_MRP(OBJ) \
170 container_of((OBJ), struct switchdev_obj_in_role_mrp, obj)
171
172struct switchdev_obj_in_state_mrp {
173 struct switchdev_obj obj;
174 u32 in_id;
175 u8 in_state;
176};
177
178#define SWITCHDEV_OBJ_IN_STATE_MRP(OBJ) \
179 container_of((OBJ), struct switchdev_obj_in_state_mrp, obj)
180
181typedef int switchdev_obj_dump_cb_t(struct switchdev_obj *obj);
182
183enum switchdev_notifier_type {
184 SWITCHDEV_FDB_ADD_TO_BRIDGE = 1,
185 SWITCHDEV_FDB_DEL_TO_BRIDGE,
186 SWITCHDEV_FDB_ADD_TO_DEVICE,
187 SWITCHDEV_FDB_DEL_TO_DEVICE,
188 SWITCHDEV_FDB_OFFLOADED,
189 SWITCHDEV_FDB_FLUSH_TO_BRIDGE,
190
191 SWITCHDEV_PORT_OBJ_ADD, /* Blocking. */
192 SWITCHDEV_PORT_OBJ_DEL, /* Blocking. */
193 SWITCHDEV_PORT_ATTR_SET, /* May be blocking . */
194
195 SWITCHDEV_VXLAN_FDB_ADD_TO_BRIDGE,
196 SWITCHDEV_VXLAN_FDB_DEL_TO_BRIDGE,
197 SWITCHDEV_VXLAN_FDB_ADD_TO_DEVICE,
198 SWITCHDEV_VXLAN_FDB_DEL_TO_DEVICE,
199 SWITCHDEV_VXLAN_FDB_OFFLOADED,
200};
201
202struct switchdev_notifier_info {
203 struct net_device *dev;
204 struct netlink_ext_ack *extack;
205};
206
207struct switchdev_notifier_fdb_info {
208 struct switchdev_notifier_info info; /* must be first */
209 const unsigned char *addr;
210 u16 vid;
211 u8 added_by_user:1,
212 is_local:1,
213 offloaded:1;
214};
215
216struct switchdev_notifier_port_obj_info {
217 struct switchdev_notifier_info info; /* must be first */
218 const struct switchdev_obj *obj;
219 bool handled;
220};
221
222struct switchdev_notifier_port_attr_info {
223 struct switchdev_notifier_info info; /* must be first */
224 const struct switchdev_attr *attr;
225 bool handled;
226};
227
228static inline struct net_device *
229switchdev_notifier_info_to_dev(const struct switchdev_notifier_info *info)
230{
231 return info->dev;
232}
233
234static inline struct netlink_ext_ack *
235switchdev_notifier_info_to_extack(const struct switchdev_notifier_info *info)
236{
237 return info->extack;
238}
239
240#ifdef CONFIG_NET_SWITCHDEV
241
242void switchdev_deferred_process(void);
243int switchdev_port_attr_set(struct net_device *dev,
244 const struct switchdev_attr *attr,
245 struct netlink_ext_ack *extack);
246int switchdev_port_obj_add(struct net_device *dev,
247 const struct switchdev_obj *obj,
248 struct netlink_ext_ack *extack);
249int switchdev_port_obj_del(struct net_device *dev,
250 const struct switchdev_obj *obj);
251
252int register_switchdev_notifier(struct notifier_block *nb);
253int unregister_switchdev_notifier(struct notifier_block *nb);
254int call_switchdev_notifiers(unsigned long val, struct net_device *dev,
255 struct switchdev_notifier_info *info,
256 struct netlink_ext_ack *extack);
257
258int register_switchdev_blocking_notifier(struct notifier_block *nb);
259int unregister_switchdev_blocking_notifier(struct notifier_block *nb);
260int call_switchdev_blocking_notifiers(unsigned long val, struct net_device *dev,
261 struct switchdev_notifier_info *info,
262 struct netlink_ext_ack *extack);
263
264void switchdev_port_fwd_mark_set(struct net_device *dev,
265 struct net_device *group_dev,
266 bool joining);
267
268int switchdev_handle_port_obj_add(struct net_device *dev,
269 struct switchdev_notifier_port_obj_info *port_obj_info,
270 bool (*check_cb)(const struct net_device *dev),
271 int (*add_cb)(struct net_device *dev,
272 const struct switchdev_obj *obj,
273 struct netlink_ext_ack *extack));
274int switchdev_handle_port_obj_del(struct net_device *dev,
275 struct switchdev_notifier_port_obj_info *port_obj_info,
276 bool (*check_cb)(const struct net_device *dev),
277 int (*del_cb)(struct net_device *dev,
278 const struct switchdev_obj *obj));
279
280int switchdev_handle_port_attr_set(struct net_device *dev,
281 struct switchdev_notifier_port_attr_info *port_attr_info,
282 bool (*check_cb)(const struct net_device *dev),
283 int (*set_cb)(struct net_device *dev,
284 const struct switchdev_attr *attr,
285 struct netlink_ext_ack *extack));
286#else
287
288static inline void switchdev_deferred_process(void)
289{
290}
291
292static inline int switchdev_port_attr_set(struct net_device *dev,
293 const struct switchdev_attr *attr,
294 struct netlink_ext_ack *extack)
295{
296 return -EOPNOTSUPP;
297}
298
299static inline int switchdev_port_obj_add(struct net_device *dev,
300 const struct switchdev_obj *obj,
301 struct netlink_ext_ack *extack)
302{
303 return -EOPNOTSUPP;
304}
305
306static inline int switchdev_port_obj_del(struct net_device *dev,
307 const struct switchdev_obj *obj)
308{
309 return -EOPNOTSUPP;
310}
311
312static inline int register_switchdev_notifier(struct notifier_block *nb)
313{
314 return 0;
315}
316
317static inline int unregister_switchdev_notifier(struct notifier_block *nb)
318{
319 return 0;
320}
321
322static inline int call_switchdev_notifiers(unsigned long val,
323 struct net_device *dev,
324 struct switchdev_notifier_info *info,
325 struct netlink_ext_ack *extack)
326{
327 return NOTIFY_DONE;
328}
329
330static inline int
331register_switchdev_blocking_notifier(struct notifier_block *nb)
332{
333 return 0;
334}
335
336static inline int
337unregister_switchdev_blocking_notifier(struct notifier_block *nb)
338{
339 return 0;
340}
341
342static inline int
343call_switchdev_blocking_notifiers(unsigned long val,
344 struct net_device *dev,
345 struct switchdev_notifier_info *info,
346 struct netlink_ext_ack *extack)
347{
348 return NOTIFY_DONE;
349}
350
351static inline int
352switchdev_handle_port_obj_add(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 (*add_cb)(struct net_device *dev,
356 const struct switchdev_obj *obj,
357 struct netlink_ext_ack *extack))
358{
359 return 0;
360}
361
362static inline int
363switchdev_handle_port_obj_del(struct net_device *dev,
364 struct switchdev_notifier_port_obj_info *port_obj_info,
365 bool (*check_cb)(const struct net_device *dev),
366 int (*del_cb)(struct net_device *dev,
367 const struct switchdev_obj *obj))
368{
369 return 0;
370}
371
372static inline int
373switchdev_handle_port_attr_set(struct net_device *dev,
374 struct switchdev_notifier_port_attr_info *port_attr_info,
375 bool (*check_cb)(const struct net_device *dev),
376 int (*set_cb)(struct net_device *dev,
377 const struct switchdev_attr *attr,
378 struct netlink_ext_ack *extack))
379{
380 return 0;
381}
382#endif
383
384#endif /* _LINUX_SWITCHDEV_H_ */