xref: /linux-6.15/include/linux/mlx5/fs.h (revision 78f73bf0)
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 	MLX5_FLOW_NAMESPACE_ESW_EGRESS,
62 	MLX5_FLOW_NAMESPACE_ESW_INGRESS,
63 };
64 
65 struct mlx5_flow_table;
66 struct mlx5_flow_group;
67 struct mlx5_flow_rule;
68 struct mlx5_flow_namespace;
69 
70 struct mlx5_flow_destination {
71 	enum mlx5_flow_destination_type	type;
72 	union {
73 		u32			tir_num;
74 		struct mlx5_flow_table	*ft;
75 		u32			vport_num;
76 		struct mlx5_fc		*counter;
77 	};
78 };
79 
80 struct mlx5_flow_namespace *
81 mlx5_get_flow_namespace(struct mlx5_core_dev *dev,
82 			enum mlx5_flow_namespace_type type);
83 
84 struct mlx5_flow_table *
85 mlx5_create_auto_grouped_flow_table(struct mlx5_flow_namespace *ns,
86 				    int prio,
87 				    int num_flow_table_entries,
88 				    int max_num_groups,
89 				    u32 level);
90 
91 struct mlx5_flow_table *
92 mlx5_create_flow_table(struct mlx5_flow_namespace *ns,
93 		       int prio,
94 		       int num_flow_table_entries,
95 		       u32 level);
96 struct mlx5_flow_table *
97 mlx5_create_vport_flow_table(struct mlx5_flow_namespace *ns,
98 			     int prio,
99 			     int num_flow_table_entries,
100 			     u32 level, u16 vport);
101 int mlx5_destroy_flow_table(struct mlx5_flow_table *ft);
102 
103 /* inbox should be set with the following values:
104  * start_flow_index
105  * end_flow_index
106  * match_criteria_enable
107  * match_criteria
108  */
109 struct mlx5_flow_group *
110 mlx5_create_flow_group(struct mlx5_flow_table *ft, u32 *in);
111 void mlx5_destroy_flow_group(struct mlx5_flow_group *fg);
112 
113 /* Single destination per rule.
114  * Group ID is implied by the match criteria.
115  */
116 struct mlx5_flow_rule *
117 mlx5_add_flow_rule(struct mlx5_flow_table *ft,
118 		   u8 match_criteria_enable,
119 		   u32 *match_criteria,
120 		   u32 *match_value,
121 		   u32 action,
122 		   u32 flow_tag,
123 		   struct mlx5_flow_destination *dest);
124 void mlx5_del_flow_rule(struct mlx5_flow_rule *fr);
125 
126 int mlx5_modify_rule_destination(struct mlx5_flow_rule *rule,
127 				 struct mlx5_flow_destination *dest);
128 
129 struct mlx5_fc *mlx5_flow_rule_counter(struct mlx5_flow_rule *rule);
130 struct mlx5_fc *mlx5_fc_create(struct mlx5_core_dev *dev, bool aging);
131 void mlx5_fc_destroy(struct mlx5_core_dev *dev, struct mlx5_fc *counter);
132 void mlx5_fc_query_cached(struct mlx5_fc *counter,
133 			  u64 *bytes, u64 *packets, u64 *lastuse);
134 
135 #endif
136