xref: /linux-6.15/include/linux/mlx5/fs.h (revision 3c8d7ef8)
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 	MLX5_FLOW_CONTEXT_ACTION_ENCRYPT	= 1 << 17,
44 	MLX5_FLOW_CONTEXT_ACTION_DECRYPT	= 1 << 18,
45 };
46 
47 enum {
48 	MLX5_FLOW_TABLE_TUNNEL_EN_REFORMAT = BIT(0),
49 	MLX5_FLOW_TABLE_TUNNEL_EN_DECAP = BIT(1),
50 };
51 
52 #define LEFTOVERS_RULE_NUM	 2
53 static inline void build_leftovers_ft_param(int *priority,
54 					    int *n_ent,
55 					    int *n_grp)
56 {
57 	*priority = 0; /* Priority of leftovers_prio-0 */
58 	*n_ent = LEFTOVERS_RULE_NUM;
59 	*n_grp = LEFTOVERS_RULE_NUM;
60 }
61 
62 enum mlx5_flow_namespace_type {
63 	MLX5_FLOW_NAMESPACE_BYPASS,
64 	MLX5_FLOW_NAMESPACE_LAG,
65 	MLX5_FLOW_NAMESPACE_OFFLOADS,
66 	MLX5_FLOW_NAMESPACE_ETHTOOL,
67 	MLX5_FLOW_NAMESPACE_KERNEL,
68 	MLX5_FLOW_NAMESPACE_LEFTOVERS,
69 	MLX5_FLOW_NAMESPACE_ANCHOR,
70 	MLX5_FLOW_NAMESPACE_FDB,
71 	MLX5_FLOW_NAMESPACE_ESW_EGRESS,
72 	MLX5_FLOW_NAMESPACE_ESW_INGRESS,
73 	MLX5_FLOW_NAMESPACE_SNIFFER_RX,
74 	MLX5_FLOW_NAMESPACE_SNIFFER_TX,
75 	MLX5_FLOW_NAMESPACE_EGRESS,
76 };
77 
78 struct mlx5_flow_table;
79 struct mlx5_flow_group;
80 struct mlx5_flow_namespace;
81 struct mlx5_flow_handle;
82 
83 struct mlx5_flow_spec {
84 	u8   match_criteria_enable;
85 	u32  match_criteria[MLX5_ST_SZ_DW(fte_match_param)];
86 	u32  match_value[MLX5_ST_SZ_DW(fte_match_param)];
87 };
88 
89 enum {
90 	MLX5_FLOW_DEST_VPORT_VHCA_ID      = BIT(0),
91 	MLX5_FLOW_DEST_VPORT_REFORMAT_ID  = BIT(1),
92 };
93 
94 struct mlx5_flow_destination {
95 	enum mlx5_flow_destination_type	type;
96 	union {
97 		u32			tir_num;
98 		u32			ft_num;
99 		struct mlx5_flow_table	*ft;
100 		u32			counter_id;
101 		struct {
102 			u16		num;
103 			u16		vhca_id;
104 			u32		reformat_id;
105 			u8		flags;
106 		} vport;
107 	};
108 };
109 
110 struct mlx5_flow_namespace *
111 mlx5_get_fdb_sub_ns(struct mlx5_core_dev *dev, int n);
112 struct mlx5_flow_namespace *
113 mlx5_get_flow_namespace(struct mlx5_core_dev *dev,
114 			enum mlx5_flow_namespace_type type);
115 struct mlx5_flow_namespace *
116 mlx5_get_flow_vport_acl_namespace(struct mlx5_core_dev *dev,
117 				  enum mlx5_flow_namespace_type type,
118 				  int vport);
119 
120 struct mlx5_flow_table *
121 mlx5_create_auto_grouped_flow_table(struct mlx5_flow_namespace *ns,
122 				    int prio,
123 				    int num_flow_table_entries,
124 				    int max_num_groups,
125 				    u32 level,
126 				    u32 flags);
127 
128 struct mlx5_flow_table_attr {
129 	int prio;
130 	int max_fte;
131 	u32 level;
132 	u32 flags;
133 };
134 
135 struct mlx5_flow_table *
136 mlx5_create_flow_table(struct mlx5_flow_namespace *ns,
137 		       struct mlx5_flow_table_attr *ft_attr);
138 
139 struct mlx5_flow_table *
140 mlx5_create_vport_flow_table(struct mlx5_flow_namespace *ns,
141 			     int prio,
142 			     int num_flow_table_entries,
143 			     u32 level, u16 vport);
144 struct mlx5_flow_table *mlx5_create_lag_demux_flow_table(
145 					       struct mlx5_flow_namespace *ns,
146 					       int prio, u32 level);
147 int mlx5_destroy_flow_table(struct mlx5_flow_table *ft);
148 
149 /* inbox should be set with the following values:
150  * start_flow_index
151  * end_flow_index
152  * match_criteria_enable
153  * match_criteria
154  */
155 struct mlx5_flow_group *
156 mlx5_create_flow_group(struct mlx5_flow_table *ft, u32 *in);
157 void mlx5_destroy_flow_group(struct mlx5_flow_group *fg);
158 
159 struct mlx5_fs_vlan {
160         u16 ethtype;
161         u16 vid;
162         u8  prio;
163 };
164 
165 #define MLX5_FS_VLAN_DEPTH	2
166 
167 enum {
168 	FLOW_ACT_HAS_TAG   = BIT(0),
169 	FLOW_ACT_NO_APPEND = BIT(1),
170 };
171 
172 struct mlx5_flow_act {
173 	u32 action;
174 	u32 flow_tag;
175 	u32 reformat_id;
176 	u32 modify_id;
177 	uintptr_t esp_id;
178 	u32 flags;
179 	struct mlx5_fs_vlan vlan[MLX5_FS_VLAN_DEPTH];
180 	struct ib_counters *counters;
181 };
182 
183 #define MLX5_DECLARE_FLOW_ACT(name) \
184 	struct mlx5_flow_act name = { .action = MLX5_FLOW_CONTEXT_ACTION_FWD_DEST,\
185 				      .flow_tag = MLX5_FS_DEFAULT_FLOW_TAG, \
186 				      .reformat_id = 0, \
187 				      .modify_id = 0, \
188 				      .flags =  0, }
189 
190 /* Single destination per rule.
191  * Group ID is implied by the match criteria.
192  */
193 struct mlx5_flow_handle *
194 mlx5_add_flow_rules(struct mlx5_flow_table *ft,
195 		    struct mlx5_flow_spec *spec,
196 		    struct mlx5_flow_act *flow_act,
197 		    struct mlx5_flow_destination *dest,
198 		    int num_dest);
199 void mlx5_del_flow_rules(struct mlx5_flow_handle *fr);
200 
201 int mlx5_modify_rule_destination(struct mlx5_flow_handle *handler,
202 				 struct mlx5_flow_destination *new_dest,
203 				 struct mlx5_flow_destination *old_dest);
204 
205 struct mlx5_fc *mlx5_fc_create(struct mlx5_core_dev *dev, bool aging);
206 void mlx5_fc_destroy(struct mlx5_core_dev *dev, struct mlx5_fc *counter);
207 void mlx5_fc_query_cached(struct mlx5_fc *counter,
208 			  u64 *bytes, u64 *packets, u64 *lastuse);
209 int mlx5_fc_query(struct mlx5_core_dev *dev, struct mlx5_fc *counter,
210 		  u64 *packets, u64 *bytes);
211 u32 mlx5_fc_id(struct mlx5_fc *counter);
212 
213 int mlx5_fs_add_rx_underlay_qpn(struct mlx5_core_dev *dev, u32 underlay_qpn);
214 int mlx5_fs_remove_rx_underlay_qpn(struct mlx5_core_dev *dev, u32 underlay_qpn);
215 
216 int mlx5_modify_header_alloc(struct mlx5_core_dev *dev,
217 			     u8 namespace, u8 num_actions,
218 			     void *modify_actions, u32 *modify_header_id);
219 void mlx5_modify_header_dealloc(struct mlx5_core_dev *dev,
220 				u32 modify_header_id);
221 
222 int mlx5_packet_reformat_alloc(struct mlx5_core_dev *dev,
223 			       int reformat_type,
224 			       size_t size,
225 			       void *reformat_data,
226 			       enum mlx5_flow_namespace_type namespace,
227 			       u32 *packet_reformat_id);
228 void mlx5_packet_reformat_dealloc(struct mlx5_core_dev *dev,
229 				  u32 packet_reformat_id);
230 
231 #endif
232