[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 */
	};
};

struct fib_info;

enum switchdev_obj_id {
	SWITCHDEV_OBJ_UNDEFINED,
	SWITCHDEV_OBJ_PORT_VLAN,
	SWITCHDEV_OBJ_IPV4_FIB,
};

struct switchdev_obj {
	enum switchdev_obj_id id;
	enum switchdev_trans trans;
	union {
		struct switchdev_obj_vlan {			/* PORT_VLAN */
			u16 flags;
			u16 vid_start;
			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_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).
 */
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);
};

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 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);

#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 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)
{
}

#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 */
f8e20a9f	41	};
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,
491d0f15 SF	50	};
	51
	52	struct switchdev_obj {
	53	enum switchdev_obj_id id;
	54	enum switchdev_trans trans;
6fc3016d SF	55	union {
	56	struct switchdev_obj_vlan { /* PORT_VLAN */
	57	u16 flags;
	58	u16 vid_start;
	59	u16 vid_end;
	60	} vlan;
58c2cb16 SF	61	struct switchdev_obj_ipv4_fib { /* IPV4_FIB */
	62	u32 dst;
	63	int dst_len;
	64	struct fib_info *fi;
	65	u8 tos;
	66	u8 type;
	67	u32 nlflags;
	68	u32 tb_id;
	69	} ipv4_fib;
6fc3016d	70	};
491d0f15 SF	71	};
491d0f15 SF	72
4170604f SF	73	/**
	74	* struct switchdev_ops - switchdev operations
	75	*
3094333d SF	76	* @switchdev_port_attr_get: Get a port attribute (see switchdev_attr).
	77	*
	78	* @switchdev_port_attr_set: Set a port attribute (see switchdev_attr).
	79	*
491d0f15 SF	80	* @switchdev_port_obj_add: Add an object to port (see switchdev_obj).
	81	*
	82	* @switchdev_port_obj_del: Delete an object from port (see switchdev_obj).
4170604f	83	*/
9d47c0a2	84	struct switchdev_ops {
3094333d SF	85	int (switchdev_port_attr_get)(struct net_device dev,
	86	struct switchdev_attr *attr);
	87	int (switchdev_port_attr_set)(struct net_device dev,
	88	struct switchdev_attr *attr);
491d0f15 SF	89	int (switchdev_port_obj_add)(struct net_device dev,
	90	struct switchdev_obj *obj);
	91	int (switchdev_port_obj_del)(struct net_device dev,
	92	struct switchdev_obj *obj);
4170604f SF	93	};
4170604f SF	94
ebb9a03a JP	95	enum switchdev_notifier_type {
	96	SWITCHDEV_FDB_ADD = 1,
	97	SWITCHDEV_FDB_DEL,
3aeb6617 JP	98	};
3aeb6617 JP	99
ebb9a03a	100	struct switchdev_notifier_info {
03bf0c28 JP	101	struct net_device *dev;
	102	};
	103
ebb9a03a JP	104	struct switchdev_notifier_fdb_info {
ebb9a03a JP	105	struct switchdev_notifier_info info; /* must be first */
3aeb6617 JP	106	const unsigned char *addr;
	107	u16 vid;
	108	};
	109
03bf0c28	110	static inline struct net_device *
ebb9a03a	111	switchdev_notifier_info_to_dev(const struct switchdev_notifier_info *info)
03bf0c28 JP	112	{
	113	return info->dev;
	114	}
007f790c JP	115
	116	#ifdef CONFIG_NET_SWITCHDEV
	117
3094333d SF	118	int switchdev_port_attr_get(struct net_device *dev,
	119	struct switchdev_attr *attr);
	120	int switchdev_port_attr_set(struct net_device *dev,
	121	struct switchdev_attr *attr);
491d0f15 SF	122	int switchdev_port_obj_add(struct net_device dev, struct switchdev_obj obj);
491d0f15 SF	123	int switchdev_port_obj_del(struct net_device dev, struct switchdev_obj obj);
ebb9a03a JP	124	int register_switchdev_notifier(struct notifier_block *nb);
	125	int unregister_switchdev_notifier(struct notifier_block *nb);
	126	int call_switchdev_notifiers(unsigned long val, struct net_device *dev,
	127	struct switchdev_notifier_info *info);
8793d0a6 SF	128	int switchdev_port_bridge_getlink(struct sk_buff *skb, u32 pid, u32 seq,
	129	struct net_device *dev, u32 filter_mask,
	130	int nlflags);
ebb9a03a JP	131	int switchdev_port_bridge_setlink(struct net_device *dev,
	132	struct nlmsghdr *nlh, u16 flags);
	133	int switchdev_port_bridge_dellink(struct net_device *dev,
	134	struct nlmsghdr *nlh, u16 flags);
ebb9a03a JP	135	int switchdev_fib_ipv4_add(u32 dst, int dst_len, struct fib_info *fi,
	136	u8 tos, u8 type, u32 nlflags, u32 tb_id);
	137	int switchdev_fib_ipv4_del(u32 dst, int dst_len, struct fib_info *fi,
	138	u8 tos, u8 type, u32 tb_id);
	139	void switchdev_fib_ipv4_abort(struct fib_info *fi);
5e8d9049	140
007f790c JP	141	#else
007f790c JP	142
3094333d SF	143	static inline int switchdev_port_attr_get(struct net_device *dev,
	144	struct switchdev_attr *attr)
	145	{
	146	return -EOPNOTSUPP;
	147	}
	148
	149	static inline int switchdev_port_attr_set(struct net_device *dev,
	150	struct switchdev_attr *attr)
	151	{
	152	return -EOPNOTSUPP;
	153	}
	154
491d0f15 SF	155	static inline int switchdev_port_obj_add(struct net_device *dev,
	156	struct switchdev_obj *obj)
	157	{
	158	return -EOPNOTSUPP;
	159	}
	160
	161	static inline int switchdev_port_obj_del(struct net_device *dev,
	162	struct switchdev_obj *obj)
	163	{
	164	return -EOPNOTSUPP;
	165	}
	166
ebb9a03a	167	static inline int register_switchdev_notifier(struct notifier_block *nb)
03bf0c28 JP	168	{
	169	return 0;
	170	}
	171
ebb9a03a	172	static inline int unregister_switchdev_notifier(struct notifier_block *nb)
03bf0c28 JP	173	{
	174	return 0;
	175	}
	176
ebb9a03a JP	177	static inline int call_switchdev_notifiers(unsigned long val,
	178	struct net_device *dev,
	179	struct switchdev_notifier_info *info)
03bf0c28 JP	180	{
	181	return NOTIFY_DONE;
	182	}
	183
8793d0a6 SF	184	static inline int switchdev_port_bridge_getlink(struct sk_buff *skb, u32 pid,
	185	u32 seq, struct net_device *dev,
	186	u32 filter_mask, int nlflags)
	187	{
	188	return -EOPNOTSUPP;
	189	}
	190
ebb9a03a JP	191	static inline int switchdev_port_bridge_setlink(struct net_device *dev,
	192	struct nlmsghdr *nlh,
	193	u16 flags)
8a44dbb2 RP	194	{
	195	return -EOPNOTSUPP;
	196	}
	197
ebb9a03a JP	198	static inline int switchdev_port_bridge_dellink(struct net_device *dev,
	199	struct nlmsghdr *nlh,
	200	u16 flags)
8a44dbb2 RP	201	{
	202	return -EOPNOTSUPP;
	203	}
	204
ebb9a03a JP	205	static inline int switchdev_fib_ipv4_add(u32 dst, int dst_len,
	206	struct fib_info *fi,
	207	u8 tos, u8 type,
	208	u32 nlflags, u32 tb_id)
5e8d9049 SF	209	{
	210	return 0;
	211	}
	212
ebb9a03a JP	213	static inline int switchdev_fib_ipv4_del(u32 dst, int dst_len,
	214	struct fib_info *fi,
	215	u8 tos, u8 type, u32 tb_id)
5e8d9049 SF	216	{
	217	return 0;
	218	}
	219
ebb9a03a	220	static inline void switchdev_fib_ipv4_abort(struct fib_info *fi)
8e05fd71 SF	221	{
	222	}
	223
007f790c JP	224	#endif
	225
	226	#endif /* _LINUX_SWITCHDEV_H_ */