xref: /linux-6.15/include/linux/mlx5/fs.h (revision d4ea45e8)
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 struct mlx5_flow_destination {
90 	enum mlx5_flow_destination_type	type;
91 	union {
92 		u32			tir_num;
93 		u32			ft_num;
94 		struct mlx5_flow_table	*ft;
95 		u32			counter_id;
96 		struct {
97 			u16		num;
98 			u16		vhca_id;
99 			bool		vhca_id_valid;
100 		} vport;
101 	};
102 };
103 
104 struct mlx5_flow_namespace *
105 mlx5_get_fdb_sub_ns(struct mlx5_core_dev *dev, int n);
106 struct mlx5_flow_namespace *
107 mlx5_get_flow_namespace(struct mlx5_core_dev *dev,
108 			enum mlx5_flow_namespace_type type);
109 struct mlx5_flow_namespace *
110 mlx5_get_flow_vport_acl_namespace(struct mlx5_core_dev *dev,
111 				  enum mlx5_flow_namespace_type type,
112 				  int vport);
113 
114 struct mlx5_flow_table *
115 mlx5_create_auto_grouped_flow_table(struct mlx5_flow_namespace *ns,
116 				    int prio,
117 				    int num_flow_table_entries,
118 				    int max_num_groups,
119 				    u32 level,
120 				    u32 flags);
121 
122 struct mlx5_flow_table_attr {
123 	int prio;
124 	int max_fte;
125 	u32 level;
126 	u32 flags;
127 };
128 
129 struct mlx5_flow_table *
130 mlx5_create_flow_table(struct mlx5_flow_namespace *ns,
131 		       struct mlx5_flow_table_attr *ft_attr);
132 
133 struct mlx5_flow_table *
134 mlx5_create_vport_flow_table(struct mlx5_flow_namespace *ns,
135 			     int prio,
136 			     int num_flow_table_entries,
137 			     u32 level, u16 vport);
138 struct mlx5_flow_table *mlx5_create_lag_demux_flow_table(
139 					       struct mlx5_flow_namespace *ns,
140 					       int prio, u32 level);
141 int mlx5_destroy_flow_table(struct mlx5_flow_table *ft);
142 
143 /* inbox should be set with the following values:
144  * start_flow_index
145  * end_flow_index
146  * match_criteria_enable
147  * match_criteria
148  */
149 struct mlx5_flow_group *
150 mlx5_create_flow_group(struct mlx5_flow_table *ft, u32 *in);
151 void mlx5_destroy_flow_group(struct mlx5_flow_group *fg);
152 
153 struct mlx5_fs_vlan {
154         u16 ethtype;
155         u16 vid;
156         u8  prio;
157 };
158 
159 #define MLX5_FS_VLAN_DEPTH	2
160 
161 enum {
162 	FLOW_ACT_HAS_TAG   = BIT(0),
163 	FLOW_ACT_NO_APPEND = BIT(1),
164 };
165 
166 struct mlx5_flow_act {
167 	u32 action;
168 	u32 flow_tag;
169 	u32 reformat_id;
170 	u32 modify_id;
171 	uintptr_t esp_id;
172 	u32 flags;
173 	struct mlx5_fs_vlan vlan[MLX5_FS_VLAN_DEPTH];
174 	struct ib_counters *counters;
175 };
176 
177 #define MLX5_DECLARE_FLOW_ACT(name) \
178 	struct mlx5_flow_act name = { .action = MLX5_FLOW_CONTEXT_ACTION_FWD_DEST,\
179 				      .flow_tag = MLX5_FS_DEFAULT_FLOW_TAG, \
180 				      .reformat_id = 0, \
181 				      .modify_id = 0, \
182 				      .flags =  0, }
183 
184 /* Single destination per rule.
185  * Group ID is implied by the match criteria.
186  */
187 struct mlx5_flow_handle *
188 mlx5_add_flow_rules(struct mlx5_flow_table *ft,
189 		    struct mlx5_flow_spec *spec,
190 		    struct mlx5_flow_act *flow_act,
191 		    struct mlx5_flow_destination *dest,
192 		    int num_dest);
193 void mlx5_del_flow_rules(struct mlx5_flow_handle *fr);
194 
195 int mlx5_modify_rule_destination(struct mlx5_flow_handle *handler,
196 				 struct mlx5_flow_destination *new_dest,
197 				 struct mlx5_flow_destination *old_dest);
198 
199 struct mlx5_fc *mlx5_fc_create(struct mlx5_core_dev *dev, bool aging);
200 void mlx5_fc_destroy(struct mlx5_core_dev *dev, struct mlx5_fc *counter);
201 void mlx5_fc_query_cached(struct mlx5_fc *counter,
202 			  u64 *bytes, u64 *packets, u64 *lastuse);
203 int mlx5_fc_query(struct mlx5_core_dev *dev, struct mlx5_fc *counter,
204 		  u64 *packets, u64 *bytes);
205 u32 mlx5_fc_id(struct mlx5_fc *counter);
206 
207 int mlx5_fs_add_rx_underlay_qpn(struct mlx5_core_dev *dev, u32 underlay_qpn);
208 int mlx5_fs_remove_rx_underlay_qpn(struct mlx5_core_dev *dev, u32 underlay_qpn);
209 
210 int mlx5_modify_header_alloc(struct mlx5_core_dev *dev,
211 			     u8 namespace, u8 num_actions,
212 			     void *modify_actions, u32 *modify_header_id);
213 void mlx5_modify_header_dealloc(struct mlx5_core_dev *dev,
214 				u32 modify_header_id);
215 
216 int mlx5_packet_reformat_alloc(struct mlx5_core_dev *dev,
217 			       int reformat_type,
218 			       size_t size,
219 			       void *reformat_data,
220 			       enum mlx5_flow_namespace_type namespace,
221 			       u32 *packet_reformat_id);
222 void mlx5_packet_reformat_dealloc(struct mlx5_core_dev *dev,
223 				  u32 packet_reformat_id);
224 
225 #endif
226