xref: /linux-6.15/include/linux/mlx5/fs.h (revision 66dfdff0)
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 enum {
46 	MLX5_FLOW_TABLE_TUNNEL_EN = BIT(0),
47 };
48 
49 #define LEFTOVERS_RULE_NUM	 2
50 static inline void build_leftovers_ft_param(int *priority,
51 					    int *n_ent,
52 					    int *n_grp)
53 {
54 	*priority = 0; /* Priority of leftovers_prio-0 */
55 	*n_ent = LEFTOVERS_RULE_NUM;
56 	*n_grp = LEFTOVERS_RULE_NUM;
57 }
58 
59 enum mlx5_flow_namespace_type {
60 	MLX5_FLOW_NAMESPACE_BYPASS,
61 	MLX5_FLOW_NAMESPACE_LAG,
62 	MLX5_FLOW_NAMESPACE_OFFLOADS,
63 	MLX5_FLOW_NAMESPACE_ETHTOOL,
64 	MLX5_FLOW_NAMESPACE_KERNEL,
65 	MLX5_FLOW_NAMESPACE_LEFTOVERS,
66 	MLX5_FLOW_NAMESPACE_ANCHOR,
67 	MLX5_FLOW_NAMESPACE_FDB,
68 	MLX5_FLOW_NAMESPACE_ESW_EGRESS,
69 	MLX5_FLOW_NAMESPACE_ESW_INGRESS,
70 	MLX5_FLOW_NAMESPACE_SNIFFER_RX,
71 	MLX5_FLOW_NAMESPACE_SNIFFER_TX,
72 };
73 
74 struct mlx5_flow_table;
75 struct mlx5_flow_group;
76 struct mlx5_flow_namespace;
77 struct mlx5_flow_handle;
78 
79 struct mlx5_flow_spec {
80 	u8   match_criteria_enable;
81 	u32  match_criteria[MLX5_ST_SZ_DW(fte_match_param)];
82 	u32  match_value[MLX5_ST_SZ_DW(fte_match_param)];
83 };
84 
85 struct mlx5_flow_destination {
86 	enum mlx5_flow_destination_type	type;
87 	union {
88 		u32			tir_num;
89 		struct mlx5_flow_table	*ft;
90 		u32			vport_num;
91 		struct mlx5_fc		*counter;
92 	};
93 };
94 
95 struct mlx5_flow_namespace *
96 mlx5_get_flow_namespace(struct mlx5_core_dev *dev,
97 			enum mlx5_flow_namespace_type type);
98 struct mlx5_flow_namespace *
99 mlx5_get_flow_vport_acl_namespace(struct mlx5_core_dev *dev,
100 				  enum mlx5_flow_namespace_type type,
101 				  int vport);
102 
103 struct mlx5_flow_table *
104 mlx5_create_auto_grouped_flow_table(struct mlx5_flow_namespace *ns,
105 				    int prio,
106 				    int num_flow_table_entries,
107 				    int max_num_groups,
108 				    u32 level,
109 				    u32 flags);
110 
111 struct mlx5_flow_table_attr {
112 	int prio;
113 	int max_fte;
114 	u32 level;
115 	u32 flags;
116 };
117 
118 struct mlx5_flow_table *
119 mlx5_create_flow_table(struct mlx5_flow_namespace *ns,
120 		       struct mlx5_flow_table_attr *ft_attr);
121 
122 struct mlx5_flow_table *
123 mlx5_create_vport_flow_table(struct mlx5_flow_namespace *ns,
124 			     int prio,
125 			     int num_flow_table_entries,
126 			     u32 level, u16 vport);
127 struct mlx5_flow_table *mlx5_create_lag_demux_flow_table(
128 					       struct mlx5_flow_namespace *ns,
129 					       int prio, u32 level);
130 int mlx5_destroy_flow_table(struct mlx5_flow_table *ft);
131 
132 /* inbox should be set with the following values:
133  * start_flow_index
134  * end_flow_index
135  * match_criteria_enable
136  * match_criteria
137  */
138 struct mlx5_flow_group *
139 mlx5_create_flow_group(struct mlx5_flow_table *ft, u32 *in);
140 void mlx5_destroy_flow_group(struct mlx5_flow_group *fg);
141 
142 struct mlx5_flow_act {
143 	u32 action;
144 	u32 flow_tag;
145 	u32 encap_id;
146 	u32 modify_id;
147 };
148 
149 #define MLX5_DECLARE_FLOW_ACT(name) \
150 	struct mlx5_flow_act name = {MLX5_FLOW_CONTEXT_ACTION_FWD_DEST,\
151 				     MLX5_FS_DEFAULT_FLOW_TAG, 0, 0}
152 
153 /* Single destination per rule.
154  * Group ID is implied by the match criteria.
155  */
156 struct mlx5_flow_handle *
157 mlx5_add_flow_rules(struct mlx5_flow_table *ft,
158 		    struct mlx5_flow_spec *spec,
159 		    struct mlx5_flow_act *flow_act,
160 		    struct mlx5_flow_destination *dest,
161 		    int dest_num);
162 void mlx5_del_flow_rules(struct mlx5_flow_handle *fr);
163 
164 int mlx5_modify_rule_destination(struct mlx5_flow_handle *handler,
165 				 struct mlx5_flow_destination *new_dest,
166 				 struct mlx5_flow_destination *old_dest);
167 
168 struct mlx5_fc *mlx5_flow_rule_counter(struct mlx5_flow_handle *handler);
169 struct mlx5_fc *mlx5_fc_create(struct mlx5_core_dev *dev, bool aging);
170 void mlx5_fc_destroy(struct mlx5_core_dev *dev, struct mlx5_fc *counter);
171 void mlx5_fc_query_cached(struct mlx5_fc *counter,
172 			  u64 *bytes, u64 *packets, u64 *lastuse);
173 int mlx5_fs_add_rx_underlay_qpn(struct mlx5_core_dev *dev, u32 underlay_qpn);
174 int mlx5_fs_remove_rx_underlay_qpn(struct mlx5_core_dev *dev, u32 underlay_qpn);
175 
176 #endif
177