[mirror_ubuntu-bionic-kernel.git] / include / net / switchdev.h

/*
 * include/net/switchdev.h - Switch device API
 * Copyright (c) 2014 Jiri Pirko <jiri@resnulli.us>
 * Copyright (c) 2014-2015 Scott Feldman <sfeldma@gmail.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 */
#ifndef _LINUX_SWITCHDEV_H_
#define _LINUX_SWITCHDEV_H_

#include <linux/netdevice.h>
#include <linux/notifier.h>

#define SWITCHDEV_F_NO_RECURSE		BIT(0)

enum switchdev_trans {
	SWITCHDEV_TRANS_NONE,
	SWITCHDEV_TRANS_PREPARE,
	SWITCHDEV_TRANS_ABORT,
	SWITCHDEV_TRANS_COMMIT,
};

enum switchdev_attr_id {
	SWITCHDEV_ATTR_UNDEFINED,
	SWITCHDEV_ATTR_PORT_PARENT_ID,
	SWITCHDEV_ATTR_PORT_STP_STATE,
	SWITCHDEV_ATTR_PORT_BRIDGE_FLAGS,
};

struct switchdev_attr {
	enum switchdev_attr_id id;
	enum switchdev_trans trans;
	u32 flags;
	union {
		struct netdev_phys_item_id ppid;	/* PORT_PARENT_ID */
		u8 stp_state;				/* PORT_STP_STATE */
		unsigned long brport_flags;		/* PORT_BRIDGE_FLAGS */
	} u;
};

struct fib_info;

enum switchdev_obj_id {
	SWITCHDEV_OBJ_UNDEFINED,
	SWITCHDEV_OBJ_PORT_VLAN,
	SWITCHDEV_OBJ_IPV4_FIB,
	SWITCHDEV_OBJ_PORT_FDB,
};

struct switchdev_obj {
	enum switchdev_obj_id id;
	enum switchdev_trans trans;
	int (*cb)(struct net_device *dev, struct switchdev_obj *obj);
	union {
		struct switchdev_obj_vlan {		/* PORT_VLAN */
			u16 flags;
			u16 vid_begin;
			u16 vid_end;
		} vlan;
		struct switchdev_obj_ipv4_fib {		/* IPV4_FIB */
			u32 dst;
			int dst_len;
			struct fib_info *fi;
			u8 tos;
			u8 type;
			u32 nlflags;
			u32 tb_id;
		} ipv4_fib;
		struct switchdev_obj_fdb {		/* PORT_FDB */
			const unsigned char *addr;
			u16 vid;
			u16 ndm_state;
		} fdb;
	} u;
};

/**
 * struct switchdev_ops - switchdev operations
 *
 * @switchdev_port_attr_get: Get a port attribute (see switchdev_attr).
 *
 * @switchdev_port_attr_set: Set a port attribute (see switchdev_attr).
 *
 * @switchdev_port_obj_add: Add an object to port (see switchdev_obj).
 *
 * @switchdev_port_obj_del: Delete an object from port (see switchdev_obj).
 *
 * @switchdev_port_obj_dump: Dump port objects (see switchdev_obj).
 */
struct switchdev_ops {
	int	(*switchdev_port_attr_get)(struct net_device *dev,
					   struct switchdev_attr *attr);
	int	(*switchdev_port_attr_set)(struct net_device *dev,
					   struct switchdev_attr *attr);
	int	(*switchdev_port_obj_add)(struct net_device *dev,
					  struct switchdev_obj *obj);
	int	(*switchdev_port_obj_del)(struct net_device *dev,
					  struct switchdev_obj *obj);
	int	(*switchdev_port_obj_dump)(struct net_device *dev,
					  struct switchdev_obj *obj);
};

enum switchdev_notifier_type {
	SWITCHDEV_FDB_ADD = 1,
	SWITCHDEV_FDB_DEL,
};

struct switchdev_notifier_info {
	struct net_device *dev;
};

struct switchdev_notifier_fdb_info {
	struct switchdev_notifier_info info; /* must be first */
	const unsigned char *addr;
	u16 vid;
};

static inline struct net_device *
switchdev_notifier_info_to_dev(const struct switchdev_notifier_info *info)
{
	return info->dev;
}

#ifdef CONFIG_NET_SWITCHDEV

int switchdev_port_attr_get(struct net_device *dev,
			    struct switchdev_attr *attr);
int switchdev_port_attr_set(struct net_device *dev,
			    struct switchdev_attr *attr);
int switchdev_port_obj_add(struct net_device *dev, struct switchdev_obj *obj);
int switchdev_port_obj_del(struct net_device *dev, struct switchdev_obj *obj);
int switchdev_port_obj_dump(struct net_device *dev, struct switchdev_obj *obj);
int register_switchdev_notifier(struct notifier_block *nb);
int unregister_switchdev_notifier(struct notifier_block *nb);
int call_switchdev_notifiers(unsigned long val, struct net_device *dev,
			     struct switchdev_notifier_info *info);
int switchdev_port_bridge_getlink(struct sk_buff *skb, u32 pid, u32 seq,
				  struct net_device *dev, u32 filter_mask,
				  int nlflags);
int switchdev_port_bridge_setlink(struct net_device *dev,
				  struct nlmsghdr *nlh, u16 flags);
int switchdev_port_bridge_dellink(struct net_device *dev,
				  struct nlmsghdr *nlh, u16 flags);
int switchdev_fib_ipv4_add(u32 dst, int dst_len, struct fib_info *fi,
			   u8 tos, u8 type, u32 nlflags, u32 tb_id);
int switchdev_fib_ipv4_del(u32 dst, int dst_len, struct fib_info *fi,
			   u8 tos, u8 type, u32 tb_id);
void switchdev_fib_ipv4_abort(struct fib_info *fi);
int switchdev_port_fdb_add(struct ndmsg *ndm, struct nlattr *tb[],
			   struct net_device *dev, const unsigned char *addr,
			   u16 vid, u16 nlm_flags);
int switchdev_port_fdb_del(struct ndmsg *ndm, struct nlattr *tb[],
			   struct net_device *dev, const unsigned char *addr,
			   u16 vid);
int switchdev_port_fdb_dump(struct sk_buff *skb, struct netlink_callback *cb,
			    struct net_device *dev,
			    struct net_device *filter_dev, int idx);
void switchdev_port_fwd_mark_set(struct net_device *dev,
				 struct net_device *group_dev,
				 bool joining);

#else

static inline int switchdev_port_attr_get(struct net_device *dev,
					  struct switchdev_attr *attr)
{
	return -EOPNOTSUPP;
}

static inline int switchdev_port_attr_set(struct net_device *dev,
					  struct switchdev_attr *attr)
{
	return -EOPNOTSUPP;
}

static inline int switchdev_port_obj_add(struct net_device *dev,
					 struct switchdev_obj *obj)
{
	return -EOPNOTSUPP;
}

static inline int switchdev_port_obj_del(struct net_device *dev,
					 struct switchdev_obj *obj)
{
	return -EOPNOTSUPP;
}

static inline int switchdev_port_obj_dump(struct net_device *dev,
					  struct switchdev_obj *obj)
{
	return -EOPNOTSUPP;
}

static inline int register_switchdev_notifier(struct notifier_block *nb)
{
	return 0;
}

static inline int unregister_switchdev_notifier(struct notifier_block *nb)
{
	return 0;
}

static inline int call_switchdev_notifiers(unsigned long val,
					   struct net_device *dev,
					   struct switchdev_notifier_info *info)
{
	return NOTIFY_DONE;
}

static inline int switchdev_port_bridge_getlink(struct sk_buff *skb, u32 pid,
					    u32 seq, struct net_device *dev,
					    u32 filter_mask, int nlflags)
{
	return -EOPNOTSUPP;
}

static inline int switchdev_port_bridge_setlink(struct net_device *dev,
						struct nlmsghdr *nlh,
						u16 flags)
{
	return -EOPNOTSUPP;
}

static inline int switchdev_port_bridge_dellink(struct net_device *dev,
						struct nlmsghdr *nlh,
						u16 flags)
{
	return -EOPNOTSUPP;
}

static inline int switchdev_fib_ipv4_add(u32 dst, int dst_len,
					 struct fib_info *fi,
					 u8 tos, u8 type,
					 u32 nlflags, u32 tb_id)
{
	return 0;
}

static inline int switchdev_fib_ipv4_del(u32 dst, int dst_len,
					 struct fib_info *fi,
					 u8 tos, u8 type, u32 tb_id)
{
	return 0;
}

static inline void switchdev_fib_ipv4_abort(struct fib_info *fi)
{
}

static inline int switchdev_port_fdb_add(struct ndmsg *ndm, struct nlattr *tb[],
					 struct net_device *dev,
					 const unsigned char *addr,
					 u16 vid, u16 nlm_flags)
{
	return -EOPNOTSUPP;
}

static inline int switchdev_port_fdb_del(struct ndmsg *ndm, struct nlattr *tb[],
					 struct net_device *dev,
					 const unsigned char *addr, u16 vid)
{
	return -EOPNOTSUPP;
}

static inline int switchdev_port_fdb_dump(struct sk_buff *skb,
					  struct netlink_callback *cb,
					  struct net_device *dev,
					  struct net_device *filter_dev,
					  int idx)
{
	return -EOPNOTSUPP;
}

static inline void switchdev_port_fwd_mark_set(struct net_device *dev,
					       struct net_device *group_dev,
					       bool joining)
{
}

#endif

#endif /* _LINUX_SWITCHDEV_H_ */
Commit	Line	Data
007f790c JP	1	/*
	2	* include/net/switchdev.h - Switch device API
	3	* Copyright (c) 2014 Jiri Pirko <jiri@resnulli.us>
f8f21471	4	* Copyright (c) 2014-2015 Scott Feldman <sfeldma@gmail.com>
007f790c JP	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>
03bf0c28 JP	15	#include <linux/notifier.h>
03bf0c28 JP	16
3094333d SF	17	#define SWITCHDEV_F_NO_RECURSE BIT(0)
	18
	19	enum switchdev_trans {
	20	SWITCHDEV_TRANS_NONE,
	21	SWITCHDEV_TRANS_PREPARE,
	22	SWITCHDEV_TRANS_ABORT,
	23	SWITCHDEV_TRANS_COMMIT,
	24	};
	25
	26	enum switchdev_attr_id {
	27	SWITCHDEV_ATTR_UNDEFINED,
f8e20a9f	28	SWITCHDEV_ATTR_PORT_PARENT_ID,
35636062	29	SWITCHDEV_ATTR_PORT_STP_STATE,
6004c867	30	SWITCHDEV_ATTR_PORT_BRIDGE_FLAGS,
3094333d SF	31	};
	32
	33	struct switchdev_attr {
	34	enum switchdev_attr_id id;
	35	enum switchdev_trans trans;
	36	u32 flags;
f8e20a9f SF	37	union {
f8e20a9f SF	38	struct netdev_phys_item_id ppid; /* PORT_PARENT_ID */
35636062	39	u8 stp_state; /* PORT_STP_STATE */
6004c867	40	unsigned long brport_flags; /* PORT_BRIDGE_FLAGS */
42275bd8	41	} u;
3094333d SF	42	};
3094333d SF	43
4170604f SF	44	struct fib_info;
4170604f SF	45
491d0f15 SF	46	enum switchdev_obj_id {
491d0f15 SF	47	SWITCHDEV_OBJ_UNDEFINED,
6fc3016d	48	SWITCHDEV_OBJ_PORT_VLAN,
58c2cb16	49	SWITCHDEV_OBJ_IPV4_FIB,
45d4122c	50	SWITCHDEV_OBJ_PORT_FDB,
491d0f15 SF	51	};
	52
	53	struct switchdev_obj {
	54	enum switchdev_obj_id id;
	55	enum switchdev_trans trans;
45d4122c	56	int (cb)(struct net_device dev, struct switchdev_obj *obj);
6fc3016d	57	union {
5eb764ed	58	struct switchdev_obj_vlan { /* PORT_VLAN */
6fc3016d	59	u16 flags;
3e3a78b4	60	u16 vid_begin;
6fc3016d SF	61	u16 vid_end;
6fc3016d SF	62	} vlan;
58c2cb16 SF	63	struct switchdev_obj_ipv4_fib { /* IPV4_FIB */
	64	u32 dst;
	65	int dst_len;
	66	struct fib_info *fi;
	67	u8 tos;
	68	u8 type;
	69	u32 nlflags;
	70	u32 tb_id;
	71	} ipv4_fib;
45d4122c	72	struct switchdev_obj_fdb { /* PORT_FDB */
cdf09697	73	const unsigned char *addr;
45d4122c	74	u16 vid;
ce80e7bc	75	u16 ndm_state;
45d4122c	76	} fdb;
42275bd8	77	} u;
491d0f15 SF	78	};
491d0f15 SF	79
4170604f SF	80	/**
	81	* struct switchdev_ops - switchdev operations
	82	*
3094333d SF	83	* @switchdev_port_attr_get: Get a port attribute (see switchdev_attr).
	84	*
	85	* @switchdev_port_attr_set: Set a port attribute (see switchdev_attr).
	86	*
491d0f15 SF	87	* @switchdev_port_obj_add: Add an object to port (see switchdev_obj).
	88	*
	89	* @switchdev_port_obj_del: Delete an object from port (see switchdev_obj).
45d4122c SS	90	*
45d4122c SS	91	* @switchdev_port_obj_dump: Dump port objects (see switchdev_obj).
4170604f	92	*/
9d47c0a2	93	struct switchdev_ops {
3094333d SF	94	int (switchdev_port_attr_get)(struct net_device dev,
	95	struct switchdev_attr *attr);
	96	int (switchdev_port_attr_set)(struct net_device dev,
	97	struct switchdev_attr *attr);
491d0f15 SF	98	int (switchdev_port_obj_add)(struct net_device dev,
	99	struct switchdev_obj *obj);
	100	int (switchdev_port_obj_del)(struct net_device dev,
	101	struct switchdev_obj *obj);
45d4122c SS	102	int (switchdev_port_obj_dump)(struct net_device dev,
45d4122c SS	103	struct switchdev_obj *obj);
4170604f SF	104	};
4170604f SF	105
ebb9a03a JP	106	enum switchdev_notifier_type {
	107	SWITCHDEV_FDB_ADD = 1,
	108	SWITCHDEV_FDB_DEL,
3aeb6617 JP	109	};
3aeb6617 JP	110
ebb9a03a	111	struct switchdev_notifier_info {
03bf0c28 JP	112	struct net_device *dev;
	113	};
	114
ebb9a03a JP	115	struct switchdev_notifier_fdb_info {
ebb9a03a JP	116	struct switchdev_notifier_info info; /* must be first */
3aeb6617 JP	117	const unsigned char *addr;
	118	u16 vid;
	119	};
	120
03bf0c28	121	static inline struct net_device *
ebb9a03a	122	switchdev_notifier_info_to_dev(const struct switchdev_notifier_info *info)
03bf0c28 JP	123	{
	124	return info->dev;
	125	}
007f790c JP	126
	127	#ifdef CONFIG_NET_SWITCHDEV
	128
3094333d SF	129	int switchdev_port_attr_get(struct net_device *dev,
	130	struct switchdev_attr *attr);
	131	int switchdev_port_attr_set(struct net_device *dev,
	132	struct switchdev_attr *attr);
491d0f15 SF	133	int switchdev_port_obj_add(struct net_device dev, struct switchdev_obj obj);
491d0f15 SF	134	int switchdev_port_obj_del(struct net_device dev, struct switchdev_obj obj);
45d4122c	135	int switchdev_port_obj_dump(struct net_device dev, struct switchdev_obj obj);
ebb9a03a JP	136	int register_switchdev_notifier(struct notifier_block *nb);
	137	int unregister_switchdev_notifier(struct notifier_block *nb);
	138	int call_switchdev_notifiers(unsigned long val, struct net_device *dev,
	139	struct switchdev_notifier_info *info);
8793d0a6 SF	140	int switchdev_port_bridge_getlink(struct sk_buff *skb, u32 pid, u32 seq,
	141	struct net_device *dev, u32 filter_mask,
	142	int nlflags);
ebb9a03a JP	143	int switchdev_port_bridge_setlink(struct net_device *dev,
	144	struct nlmsghdr *nlh, u16 flags);
	145	int switchdev_port_bridge_dellink(struct net_device *dev,
	146	struct nlmsghdr *nlh, u16 flags);
ebb9a03a JP	147	int switchdev_fib_ipv4_add(u32 dst, int dst_len, struct fib_info *fi,
	148	u8 tos, u8 type, u32 nlflags, u32 tb_id);
	149	int switchdev_fib_ipv4_del(u32 dst, int dst_len, struct fib_info *fi,
	150	u8 tos, u8 type, u32 tb_id);
	151	void switchdev_fib_ipv4_abort(struct fib_info *fi);
45d4122c SS	152	int switchdev_port_fdb_add(struct ndmsg ndm, struct nlattr tb[],
	153	struct net_device dev, const unsigned char addr,
	154	u16 vid, u16 nlm_flags);
	155	int switchdev_port_fdb_del(struct ndmsg ndm, struct nlattr tb[],
	156	struct net_device dev, const unsigned char addr,
	157	u16 vid);
	158	int switchdev_port_fdb_dump(struct sk_buff skb, struct netlink_callback cb,
	159	struct net_device *dev,
	160	struct net_device *filter_dev, int idx);
1a3b2ec9 SF	161	void switchdev_port_fwd_mark_set(struct net_device *dev,
	162	struct net_device *group_dev,
	163	bool joining);
5e8d9049	164
007f790c JP	165	#else
007f790c JP	166
3094333d SF	167	static inline int switchdev_port_attr_get(struct net_device *dev,
	168	struct switchdev_attr *attr)
	169	{
	170	return -EOPNOTSUPP;
	171	}
	172
	173	static inline int switchdev_port_attr_set(struct net_device *dev,
	174	struct switchdev_attr *attr)
	175	{
	176	return -EOPNOTSUPP;
	177	}
	178
491d0f15 SF	179	static inline int switchdev_port_obj_add(struct net_device *dev,
	180	struct switchdev_obj *obj)
	181	{
	182	return -EOPNOTSUPP;
	183	}
	184
	185	static inline int switchdev_port_obj_del(struct net_device *dev,
	186	struct switchdev_obj *obj)
	187	{
	188	return -EOPNOTSUPP;
	189	}
	190
45d4122c SS	191	static inline int switchdev_port_obj_dump(struct net_device *dev,
	192	struct switchdev_obj *obj)
	193	{
	194	return -EOPNOTSUPP;
	195	}
	196
ebb9a03a	197	static inline int register_switchdev_notifier(struct notifier_block *nb)
03bf0c28 JP	198	{
	199	return 0;
	200	}
	201
ebb9a03a	202	static inline int unregister_switchdev_notifier(struct notifier_block *nb)
03bf0c28 JP	203	{
	204	return 0;
	205	}
	206
ebb9a03a JP	207	static inline int call_switchdev_notifiers(unsigned long val,
	208	struct net_device *dev,
	209	struct switchdev_notifier_info *info)
03bf0c28 JP	210	{
	211	return NOTIFY_DONE;
	212	}
	213
8793d0a6 SF	214	static inline int switchdev_port_bridge_getlink(struct sk_buff *skb, u32 pid,
	215	u32 seq, struct net_device *dev,
	216	u32 filter_mask, int nlflags)
	217	{
	218	return -EOPNOTSUPP;
	219	}
	220
ebb9a03a JP	221	static inline int switchdev_port_bridge_setlink(struct net_device *dev,
	222	struct nlmsghdr *nlh,
	223	u16 flags)
8a44dbb2 RP	224	{
	225	return -EOPNOTSUPP;
	226	}
	227
ebb9a03a JP	228	static inline int switchdev_port_bridge_dellink(struct net_device *dev,
	229	struct nlmsghdr *nlh,
	230	u16 flags)
8a44dbb2 RP	231	{
	232	return -EOPNOTSUPP;
	233	}
	234
ebb9a03a JP	235	static inline int switchdev_fib_ipv4_add(u32 dst, int dst_len,
	236	struct fib_info *fi,
	237	u8 tos, u8 type,
	238	u32 nlflags, u32 tb_id)
5e8d9049 SF	239	{
	240	return 0;
	241	}
	242
ebb9a03a JP	243	static inline int switchdev_fib_ipv4_del(u32 dst, int dst_len,
	244	struct fib_info *fi,
	245	u8 tos, u8 type, u32 tb_id)
5e8d9049 SF	246	{
	247	return 0;
	248	}
	249
ebb9a03a	250	static inline void switchdev_fib_ipv4_abort(struct fib_info *fi)
8e05fd71 SF	251	{
	252	}
	253
45d4122c SS	254	static inline int switchdev_port_fdb_add(struct ndmsg ndm, struct nlattr tb[],
	255	struct net_device *dev,
	256	const unsigned char *addr,
	257	u16 vid, u16 nlm_flags)
	258	{
	259	return -EOPNOTSUPP;
	260	}
	261
	262	static inline int switchdev_port_fdb_del(struct ndmsg ndm, struct nlattr tb[],
	263	struct net_device *dev,
	264	const unsigned char *addr, u16 vid)
	265	{
	266	return -EOPNOTSUPP;
	267	}
	268
	269	static inline int switchdev_port_fdb_dump(struct sk_buff *skb,
	270	struct netlink_callback *cb,
	271	struct net_device *dev,
	272	struct net_device *filter_dev,
	273	int idx)
	274	{
	275	return -EOPNOTSUPP;
	276	}
	277
1a3b2ec9 SF	278	static inline void switchdev_port_fwd_mark_set(struct net_device *dev,
	279	struct net_device *group_dev,
	280	bool joining)
	281	{
	282	}
	283
007f790c JP	284	#endif
	285
	286	#endif /* _LINUX_SWITCHDEV_H_ */