xref: /linux-6.15/include/linux/mlx5/fs.h (revision 56d06fa2)
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_
34 #define _MLX5_FS_
35 
36 #include <linux/mlx5/driver.h>
37 #include <linux/mlx5/mlx5_ifc.h>
38 
39 #define MLX5_FS_DEFAULT_FLOW_TAG 0x0
40 
41 enum {
42 	MLX5_FLOW_CONTEXT_ACTION_FWD_NEXT_PRIO	= 1 << 16,
43 };
44 
45 #define LEFTOVERS_RULE_NUM	 2
46 static inline void build_leftovers_ft_param(int *priority,
47 					    int *n_ent,
48 					    int *n_grp)
49 {
50 	*priority = 0; /* Priority of leftovers_prio-0 */
51 	*n_ent = LEFTOVERS_RULE_NUM;
52 	*n_grp = LEFTOVERS_RULE_NUM;
53 }
54 
55 enum mlx5_flow_namespace_type {
56 	MLX5_FLOW_NAMESPACE_BYPASS,
57 	MLX5_FLOW_NAMESPACE_KERNEL,
58 	MLX5_FLOW_NAMESPACE_LEFTOVERS,
59 	MLX5_FLOW_NAMESPACE_ANCHOR,
60 	MLX5_FLOW_NAMESPACE_FDB,
61 };
62 
63 struct mlx5_flow_table;
64 struct mlx5_flow_group;
65 struct mlx5_flow_rule;
66 struct mlx5_flow_namespace;
67 
68 struct mlx5_flow_destination {
69 	enum mlx5_flow_destination_type	type;
70 	union {
71 		u32			tir_num;
72 		struct mlx5_flow_table	*ft;
73 		u32			vport_num;
74 	};
75 };
76 
77 struct mlx5_flow_namespace *
78 mlx5_get_flow_namespace(struct mlx5_core_dev *dev,
79 			enum mlx5_flow_namespace_type type);
80 
81 struct mlx5_flow_table *
82 mlx5_create_auto_grouped_flow_table(struct mlx5_flow_namespace *ns,
83 				    int prio,
84 				    int num_flow_table_entries,
85 				    int max_num_groups);
86 
87 struct mlx5_flow_table *
88 mlx5_create_flow_table(struct mlx5_flow_namespace *ns,
89 		       int prio,
90 		       int num_flow_table_entries);
91 int mlx5_destroy_flow_table(struct mlx5_flow_table *ft);
92 
93 /* inbox should be set with the following values:
94  * start_flow_index
95  * end_flow_index
96  * match_criteria_enable
97  * match_criteria
98  */
99 struct mlx5_flow_group *
100 mlx5_create_flow_group(struct mlx5_flow_table *ft, u32 *in);
101 void mlx5_destroy_flow_group(struct mlx5_flow_group *fg);
102 
103 /* Single destination per rule.
104  * Group ID is implied by the match criteria.
105  */
106 struct mlx5_flow_rule *
107 mlx5_add_flow_rule(struct mlx5_flow_table *ft,
108 		   u8 match_criteria_enable,
109 		   u32 *match_criteria,
110 		   u32 *match_value,
111 		   u32 action,
112 		   u32 flow_tag,
113 		   struct mlx5_flow_destination *dest);
114 void mlx5_del_flow_rule(struct mlx5_flow_rule *fr);
115 
116 #endif
117