[deliverable/linux.git] / drivers / net / ethernet / mellanox / mlx5 / core / fs_core.h

/*
 * Copyright (c) 2015, Mellanox Technologies. All rights reserved.
 *
 * This software is available to you under a choice of one of two
 * licenses.  You may choose to be licensed under the terms of the GNU
 * General Public License (GPL) Version 2, available from the file
 * COPYING in the main directory of this source tree, or the
 * OpenIB.org BSD license below:
 *
 *     Redistribution and use in source and binary forms, with or
 *     without modification, are permitted provided that the following
 *     conditions are met:
 *
 *      - Redistributions of source code must retain the above
 *        copyright notice, this list of conditions and the following
 *        disclaimer.
 *
 *      - Redistributions in binary form must reproduce the above
 *        copyright notice, this list of conditions and the following
 *        disclaimer in the documentation and/or other materials
 *        provided with the distribution.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#ifndef _MLX5_FS_CORE_
#define _MLX5_FS_CORE_

#include <linux/mlx5/fs.h>

enum fs_node_type {
	FS_TYPE_NAMESPACE,
	FS_TYPE_PRIO,
	FS_TYPE_FLOW_TABLE,
	FS_TYPE_FLOW_GROUP,
	FS_TYPE_FLOW_ENTRY,
	FS_TYPE_FLOW_DEST
};

enum fs_flow_table_type {
	FS_FT_NIC_RX	 = 0x0,
};

enum fs_fte_status {
	FS_FTE_STATUS_EXISTING = 1UL << 0,
};

struct fs_node {
	struct list_head	list;
	struct list_head	children;
	enum fs_node_type	type;
	struct fs_node		*parent;
	struct fs_node		*root;
	/* lock the node for writing and traversing */
	struct mutex		lock;
	atomic_t		refcount;
	void			(*remove_func)(struct fs_node *);
};

struct mlx5_flow_rule {
	struct fs_node				node;
	struct mlx5_flow_destination		dest_attr;
};

/* Type of children is mlx5_flow_group */
struct mlx5_flow_table {
	struct fs_node			node;
	u32				id;
	unsigned int			max_fte;
	unsigned int			level;
	enum fs_flow_table_type		type;
};

/* Type of children is mlx5_flow_rule */
struct fs_fte {
	struct fs_node			node;
	u32				val[MLX5_ST_SZ_DW(fte_match_param)];
	u32				dests_size;
	u32				flow_tag;
	u32				index;
	u32				action;
	enum fs_fte_status		status;
};

/* Type of children is mlx5_flow_table/namespace */
struct fs_prio {
	struct fs_node			node;
	unsigned int			max_ft;
	unsigned int			start_level;
	unsigned int			prio;
	unsigned int			num_ft;
};

/* Type of children is fs_prio */
struct mlx5_flow_namespace {
	/* parent == NULL => root ns */
	struct	fs_node			node;
};

struct mlx5_flow_group_mask {
	u8	match_criteria_enable;
	u32	match_criteria[MLX5_ST_SZ_DW(fte_match_param)];
};

/* Type of children is fs_fte */
struct mlx5_flow_group {
	struct fs_node			node;
	struct mlx5_flow_group_mask	mask;
	u32				start_index;
	u32				max_ftes;
	u32				num_ftes;
	u32				id;
};

struct mlx5_flow_root_namespace {
	struct mlx5_flow_namespace	ns;
	enum   fs_flow_table_type	table_type;
	struct mlx5_core_dev		*dev;
};

#define fs_get_obj(v, _node)  {v = container_of((_node), typeof(*v), node); }

#define fs_list_for_each_entry(pos, root)		\
	list_for_each_entry(pos, root, node.list)

#define fs_for_each_ns_or_ft_reverse(pos, prio)				\
	list_for_each_entry_reverse(pos, &(prio)->node.children, list)

#define fs_for_each_ns_or_ft(pos, prio)					\
	list_for_each_entry(pos, (&(prio)->node.children), list)

#define fs_for_each_prio(pos, ns)			\
	fs_list_for_each_entry(pos, &(ns)->node.children)

#define fs_for_each_fg(pos, ft)			\
	fs_list_for_each_entry(pos, &(ft)->node.children)

#define fs_for_each_fte(pos, fg)			\
	fs_list_for_each_entry(pos, &(fg)->node.children)

#define fs_for_each_dst(pos, fte)			\
	fs_list_for_each_entry(pos, &(fte)->node.children)

#endif
Commit	Line	Data
26a81453 MG	1	/*
	2	* Copyright (c) 2015, Mellanox Technologies. All rights reserved.
	3	*
	4	* This software is available to you under a choice of one of two
	5	* licenses. You may choose to be licensed under the terms of the GNU
	6	* General Public License (GPL) Version 2, available from the file
	7	* COPYING in the main directory of this source tree, or the
	8	* OpenIB.org BSD license below:
	9	*
	10	* Redistribution and use in source and binary forms, with or
	11	* without modification, are permitted provided that the following
	12	* conditions are met:
	13	*
	14	* - Redistributions of source code must retain the above
	15	* copyright notice, this list of conditions and the following
	16	* disclaimer.
	17	*
	18	* - Redistributions in binary form must reproduce the above
	19	* copyright notice, this list of conditions and the following
	20	* disclaimer in the documentation and/or other materials
	21	* provided with the distribution.
	22	*
	23	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
	24	* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
	25	* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
	26	* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
	27	* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
	28	* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
	29	* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	30	* SOFTWARE.
	31	*/
	32
	33	#ifndef _MLX5_FS_CORE_
	34	#define _MLX5_FS_CORE_
	35
	36	#include <linux/mlx5/fs.h>
	37
	38	enum fs_node_type {
	39	FS_TYPE_NAMESPACE,
	40	FS_TYPE_PRIO,
	41	FS_TYPE_FLOW_TABLE,
	42	FS_TYPE_FLOW_GROUP,
	43	FS_TYPE_FLOW_ENTRY,
	44	FS_TYPE_FLOW_DEST
	45	};
	46
	47	enum fs_flow_table_type {
	48	FS_FT_NIC_RX = 0x0,
	49	};
	50
	51	enum fs_fte_status {
	52	FS_FTE_STATUS_EXISTING = 1UL << 0,
	53	};
	54
	55	struct fs_node {
	56	struct list_head list;
	57	struct list_head children;
	58	enum fs_node_type type;
de8575e0 MG	59	struct fs_node *parent;
	60	struct fs_node *root;
	61	/* lock the node for writing and traversing */
	62	struct mutex lock;
	63	atomic_t refcount;
	64	void (remove_func)(struct fs_node );
26a81453 MG	65	};
	66
	67	struct mlx5_flow_rule {
	68	struct fs_node node;
	69	struct mlx5_flow_destination dest_attr;
	70	};
	71
0c56b975	72	/* Type of children is mlx5_flow_group */
26a81453 MG	73	struct mlx5_flow_table {
	74	struct fs_node node;
	75	u32 id;
0c56b975	76	unsigned int max_fte;
5e1626c0	77	unsigned int level;
26a81453 MG	78	enum fs_flow_table_type type;
	79	};
	80
0c56b975	81	/* Type of children is mlx5_flow_rule */
26a81453 MG	82	struct fs_fte {
	83	struct fs_node node;
	84	u32 val[MLX5_ST_SZ_DW(fte_match_param)];
	85	u32 dests_size;
	86	u32 flow_tag;
	87	u32 index;
	88	u32 action;
0c56b975	89	enum fs_fte_status status;
26a81453 MG	90	};
26a81453 MG	91
0c56b975	92	/* Type of children is mlx5_flow_table/namespace */
5e1626c0 MG	93	struct fs_prio {
	94	struct fs_node node;
	95	unsigned int max_ft;
	96	unsigned int start_level;
	97	unsigned int prio;
0c56b975	98	unsigned int num_ft;
5e1626c0 MG	99	};
5e1626c0 MG	100
0c56b975	101	/* Type of children is fs_prio */
5e1626c0 MG	102	struct mlx5_flow_namespace {
	103	/* parent == NULL => root ns */
	104	struct fs_node node;
	105	};
	106
	107	struct mlx5_flow_group_mask {
	108	u8 match_criteria_enable;
	109	u32 match_criteria[MLX5_ST_SZ_DW(fte_match_param)];
	110	};
	111
0c56b975 MG	112	/* Type of children is fs_fte */
	113	struct mlx5_flow_group {
	114	struct fs_node node;
	115	struct mlx5_flow_group_mask mask;
	116	u32 start_index;
	117	u32 max_ftes;
	118	u32 num_ftes;
	119	u32 id;
	120	};
	121
	122	struct mlx5_flow_root_namespace {
	123	struct mlx5_flow_namespace ns;
	124	enum fs_flow_table_type table_type;
	125	struct mlx5_core_dev *dev;
	126	};
	127
5e1626c0 MG	128	#define fs_get_obj(v, _node) {v = container_of((_node), typeof(*v), node); }
	129
	130	#define fs_list_for_each_entry(pos, root) \
	131	list_for_each_entry(pos, root, node.list)
	132
	133	#define fs_for_each_ns_or_ft_reverse(pos, prio) \
	134	list_for_each_entry_reverse(pos, &(prio)->node.children, list)
	135
	136	#define fs_for_each_ns_or_ft(pos, prio) \
	137	list_for_each_entry(pos, (&(prio)->node.children), list)
	138
	139	#define fs_for_each_prio(pos, ns) \
	140	fs_list_for_each_entry(pos, &(ns)->node.children)
	141
	142	#define fs_for_each_fg(pos, ft) \
	143	fs_list_for_each_entry(pos, &(ft)->node.children)
	144
	145	#define fs_for_each_fte(pos, fg) \
	146	fs_list_for_each_entry(pos, &(fg)->node.children)
	147
	148	#define fs_for_each_dst(pos, fte) \
	149	fs_list_for_each_entry(pos, &(fte)->node.children)
	150
26a81453	151	#endif