Linux Audio

Check our new training course

Linux kernel drivers training

Mar 31-Apr 9, 2025, special US time zones
Register
Loading...
Note: File does not exist in v3.1.
  1/*
  2 * include/net/switchdev.h - Switch device API
  3 * Copyright (c) 2014-2015 Jiri Pirko <jiri@resnulli.us>
  4 * Copyright (c) 2014-2015 Scott Feldman <sfeldma@gmail.com>
  5 *
  6 * This program is free software; you can redistribute it and/or modify
  7 * it under the terms of the GNU General Public License as published by
  8 * the Free Software Foundation; either version 2 of the License, or
  9 * (at your option) any later version.
 10 */
 11#ifndef _LINUX_SWITCHDEV_H_
 12#define _LINUX_SWITCHDEV_H_
 13
 14#include <linux/netdevice.h>
 15#include <linux/notifier.h>
 16#include <linux/list.h>
 17#include <net/ip_fib.h>
 18
 19#define SWITCHDEV_F_NO_RECURSE		BIT(0)
 20#define SWITCHDEV_F_SKIP_EOPNOTSUPP	BIT(1)
 21#define SWITCHDEV_F_DEFER		BIT(2)
 22
 23struct switchdev_trans_item {
 24	struct list_head list;
 25	void *data;
 26	void (*destructor)(const void *data);
 27};
 28
 29struct switchdev_trans {
 30	struct list_head item_list;
 31	bool ph_prepare;
 32};
 33
 34static inline bool switchdev_trans_ph_prepare(struct switchdev_trans *trans)
 35{
 36	return trans && trans->ph_prepare;
 37}
 38
 39static inline bool switchdev_trans_ph_commit(struct switchdev_trans *trans)
 40{
 41	return trans && !trans->ph_prepare;
 42}
 43
 44enum switchdev_attr_id {
 45	SWITCHDEV_ATTR_ID_UNDEFINED,
 46	SWITCHDEV_ATTR_ID_PORT_PARENT_ID,
 47	SWITCHDEV_ATTR_ID_PORT_STP_STATE,
 48	SWITCHDEV_ATTR_ID_PORT_BRIDGE_FLAGS,
 49	SWITCHDEV_ATTR_ID_BRIDGE_AGEING_TIME,
 50	SWITCHDEV_ATTR_ID_BRIDGE_VLAN_FILTERING,
 51};
 52
 53struct switchdev_attr {
 54	struct net_device *orig_dev;
 55	enum switchdev_attr_id id;
 56	u32 flags;
 57	void *complete_priv;
 58	void (*complete)(struct net_device *dev, int err, void *priv);
 59	union {
 60		struct netdev_phys_item_id ppid;	/* PORT_PARENT_ID */
 61		u8 stp_state;				/* PORT_STP_STATE */
 62		unsigned long brport_flags;		/* PORT_BRIDGE_FLAGS */
 63		u32 ageing_time;			/* BRIDGE_AGEING_TIME */
 64		bool vlan_filtering;			/* BRIDGE_VLAN_FILTERING */
 65	} u;
 66};
 67
 68enum switchdev_obj_id {
 69	SWITCHDEV_OBJ_ID_UNDEFINED,
 70	SWITCHDEV_OBJ_ID_PORT_VLAN,
 71	SWITCHDEV_OBJ_ID_IPV4_FIB,
 72	SWITCHDEV_OBJ_ID_PORT_FDB,
 73	SWITCHDEV_OBJ_ID_PORT_MDB,
 74};
 75
 76struct switchdev_obj {
 77	struct net_device *orig_dev;
 78	enum switchdev_obj_id id;
 79	u32 flags;
 80	void *complete_priv;
 81	void (*complete)(struct net_device *dev, int err, void *priv);
 82};
 83
 84/* SWITCHDEV_OBJ_ID_PORT_VLAN */
 85struct switchdev_obj_port_vlan {
 86	struct switchdev_obj obj;
 87	u16 flags;
 88	u16 vid_begin;
 89	u16 vid_end;
 90};
 91
 92#define SWITCHDEV_OBJ_PORT_VLAN(obj) \
 93	container_of(obj, struct switchdev_obj_port_vlan, obj)
 94
 95/* SWITCHDEV_OBJ_ID_IPV4_FIB */
 96struct switchdev_obj_ipv4_fib {
 97	struct switchdev_obj obj;
 98	u32 dst;
 99	int dst_len;
100	struct fib_info fi;
101	u8 tos;
102	u8 type;
103	u32 nlflags;
104	u32 tb_id;
105};
106
107#define SWITCHDEV_OBJ_IPV4_FIB(obj) \
108	container_of(obj, struct switchdev_obj_ipv4_fib, obj)
109
110/* SWITCHDEV_OBJ_ID_PORT_FDB */
111struct switchdev_obj_port_fdb {
112	struct switchdev_obj obj;
113	unsigned char addr[ETH_ALEN];
114	u16 vid;
115	u16 ndm_state;
116};
117
118#define SWITCHDEV_OBJ_PORT_FDB(obj) \
119	container_of(obj, struct switchdev_obj_port_fdb, obj)
120
121/* SWITCHDEV_OBJ_ID_PORT_MDB */
122struct switchdev_obj_port_mdb {
123	struct switchdev_obj obj;
124	unsigned char addr[ETH_ALEN];
125	u16 vid;
126};
127
128#define SWITCHDEV_OBJ_PORT_MDB(obj) \
129	container_of(obj, struct switchdev_obj_port_mdb, obj)
130
131void switchdev_trans_item_enqueue(struct switchdev_trans *trans,
132				  void *data, void (*destructor)(void const *),
133				  struct switchdev_trans_item *tritem);
134void *switchdev_trans_item_dequeue(struct switchdev_trans *trans);
135
136typedef int switchdev_obj_dump_cb_t(struct switchdev_obj *obj);
137
138/**
139 * struct switchdev_ops - switchdev operations
140 *
141 * @switchdev_port_attr_get: Get a port attribute (see switchdev_attr).
142 *
143 * @switchdev_port_attr_set: Set a port attribute (see switchdev_attr).
144 *
145 * @switchdev_port_obj_add: Add an object to port (see switchdev_obj_*).
146 *
147 * @switchdev_port_obj_del: Delete an object from port (see switchdev_obj_*).
148 *
149 * @switchdev_port_obj_dump: Dump port objects (see switchdev_obj_*).
150 */
151struct switchdev_ops {
152	int	(*switchdev_port_attr_get)(struct net_device *dev,
153					   struct switchdev_attr *attr);
154	int	(*switchdev_port_attr_set)(struct net_device *dev,
155					   const struct switchdev_attr *attr,
156					   struct switchdev_trans *trans);
157	int	(*switchdev_port_obj_add)(struct net_device *dev,
158					  const struct switchdev_obj *obj,
159					  struct switchdev_trans *trans);
160	int	(*switchdev_port_obj_del)(struct net_device *dev,
161					  const struct switchdev_obj *obj);
162	int	(*switchdev_port_obj_dump)(struct net_device *dev,
163					   struct switchdev_obj *obj,
164					   switchdev_obj_dump_cb_t *cb);
165};
166
167enum switchdev_notifier_type {
168	SWITCHDEV_FDB_ADD = 1,
169	SWITCHDEV_FDB_DEL,
170};
171
172struct switchdev_notifier_info {
173	struct net_device *dev;
174};
175
176struct switchdev_notifier_fdb_info {
177	struct switchdev_notifier_info info; /* must be first */
178	const unsigned char *addr;
179	u16 vid;
180};
181
182static inline struct net_device *
183switchdev_notifier_info_to_dev(const struct switchdev_notifier_info *info)
184{
185	return info->dev;
186}
187
188#ifdef CONFIG_NET_SWITCHDEV
189
190void switchdev_deferred_process(void);
191int switchdev_port_attr_get(struct net_device *dev,
192			    struct switchdev_attr *attr);
193int switchdev_port_attr_set(struct net_device *dev,
194			    const struct switchdev_attr *attr);
195int switchdev_port_obj_add(struct net_device *dev,
196			   const struct switchdev_obj *obj);
197int switchdev_port_obj_del(struct net_device *dev,
198			   const struct switchdev_obj *obj);
199int switchdev_port_obj_dump(struct net_device *dev, struct switchdev_obj *obj,
200			    switchdev_obj_dump_cb_t *cb);
201int register_switchdev_notifier(struct notifier_block *nb);
202int unregister_switchdev_notifier(struct notifier_block *nb);
203int call_switchdev_notifiers(unsigned long val, struct net_device *dev,
204			     struct switchdev_notifier_info *info);
205int switchdev_port_bridge_getlink(struct sk_buff *skb, u32 pid, u32 seq,
206				  struct net_device *dev, u32 filter_mask,
207				  int nlflags);
208int switchdev_port_bridge_setlink(struct net_device *dev,
209				  struct nlmsghdr *nlh, u16 flags);
210int switchdev_port_bridge_dellink(struct net_device *dev,
211				  struct nlmsghdr *nlh, u16 flags);
212int switchdev_fib_ipv4_add(u32 dst, int dst_len, struct fib_info *fi,
213			   u8 tos, u8 type, u32 nlflags, u32 tb_id);
214int switchdev_fib_ipv4_del(u32 dst, int dst_len, struct fib_info *fi,
215			   u8 tos, u8 type, u32 tb_id);
216void switchdev_fib_ipv4_abort(struct fib_info *fi);
217int switchdev_port_fdb_add(struct ndmsg *ndm, struct nlattr *tb[],
218			   struct net_device *dev, const unsigned char *addr,
219			   u16 vid, u16 nlm_flags);
220int switchdev_port_fdb_del(struct ndmsg *ndm, struct nlattr *tb[],
221			   struct net_device *dev, const unsigned char *addr,
222			   u16 vid);
223int switchdev_port_fdb_dump(struct sk_buff *skb, struct netlink_callback *cb,
224			    struct net_device *dev,
225			    struct net_device *filter_dev, int idx);
226void switchdev_port_fwd_mark_set(struct net_device *dev,
227				 struct net_device *group_dev,
228				 bool joining);
229
230#else
231
232static inline void switchdev_deferred_process(void)
233{
234}
235
236static inline int switchdev_port_attr_get(struct net_device *dev,
237					  struct switchdev_attr *attr)
238{
239	return -EOPNOTSUPP;
240}
241
242static inline int switchdev_port_attr_set(struct net_device *dev,
243					  const struct switchdev_attr *attr)
244{
245	return -EOPNOTSUPP;
246}
247
248static inline int switchdev_port_obj_add(struct net_device *dev,
249					 const struct switchdev_obj *obj)
250{
251	return -EOPNOTSUPP;
252}
253
254static inline int switchdev_port_obj_del(struct net_device *dev,
255					 const struct switchdev_obj *obj)
256{
257	return -EOPNOTSUPP;
258}
259
260static inline int switchdev_port_obj_dump(struct net_device *dev,
261					  const struct switchdev_obj *obj,
262					  switchdev_obj_dump_cb_t *cb)
263{
264	return -EOPNOTSUPP;
265}
266
267static inline int register_switchdev_notifier(struct notifier_block *nb)
268{
269	return 0;
270}
271
272static inline int unregister_switchdev_notifier(struct notifier_block *nb)
273{
274	return 0;
275}
276
277static inline int call_switchdev_notifiers(unsigned long val,
278					   struct net_device *dev,
279					   struct switchdev_notifier_info *info)
280{
281	return NOTIFY_DONE;
282}
283
284static inline int switchdev_port_bridge_getlink(struct sk_buff *skb, u32 pid,
285					    u32 seq, struct net_device *dev,
286					    u32 filter_mask, int nlflags)
287{
288	return -EOPNOTSUPP;
289}
290
291static inline int switchdev_port_bridge_setlink(struct net_device *dev,
292						struct nlmsghdr *nlh,
293						u16 flags)
294{
295	return -EOPNOTSUPP;
296}
297
298static inline int switchdev_port_bridge_dellink(struct net_device *dev,
299						struct nlmsghdr *nlh,
300						u16 flags)
301{
302	return -EOPNOTSUPP;
303}
304
305static inline int switchdev_fib_ipv4_add(u32 dst, int dst_len,
306					 struct fib_info *fi,
307					 u8 tos, u8 type,
308					 u32 nlflags, u32 tb_id)
309{
310	return 0;
311}
312
313static inline int switchdev_fib_ipv4_del(u32 dst, int dst_len,
314					 struct fib_info *fi,
315					 u8 tos, u8 type, u32 tb_id)
316{
317	return 0;
318}
319
320static inline void switchdev_fib_ipv4_abort(struct fib_info *fi)
321{
322}
323
324static inline int switchdev_port_fdb_add(struct ndmsg *ndm, struct nlattr *tb[],
325					 struct net_device *dev,
326					 const unsigned char *addr,
327					 u16 vid, u16 nlm_flags)
328{
329	return -EOPNOTSUPP;
330}
331
332static inline int switchdev_port_fdb_del(struct ndmsg *ndm, struct nlattr *tb[],
333					 struct net_device *dev,
334					 const unsigned char *addr, u16 vid)
335{
336	return -EOPNOTSUPP;
337}
338
339static inline int switchdev_port_fdb_dump(struct sk_buff *skb,
340					  struct netlink_callback *cb,
341					  struct net_device *dev,
342					  struct net_device *filter_dev,
343					  int idx)
344{
345       return idx;
346}
347
348static inline void switchdev_port_fwd_mark_set(struct net_device *dev,
349					       struct net_device *group_dev,
350					       bool joining)
351{
352}
353
354#endif
355
356#endif /* _LINUX_SWITCHDEV_H_ */