xref: /dpdk/drivers/net/bnxt/tf_ulp/ulp_template_struct.h (revision e11bdd37745229bf26b557305c07d118c3dbaad7)
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2014-2019 Broadcom
3  * All rights reserved.
4  */
5 
6 #ifndef _ULP_TEMPLATE_STRUCT_H_
7 #define _ULP_TEMPLATE_STRUCT_H_
8 
9 #include <stdint.h>
10 #include "rte_ether.h"
11 #include "rte_icmp.h"
12 #include "rte_ip.h"
13 #include "rte_tcp.h"
14 #include "rte_udp.h"
15 #include "rte_esp.h"
16 #include "rte_sctp.h"
17 #include "rte_flow.h"
18 #include "tf_core.h"
19 
20 /* Number of fields for each protocol */
21 #define BNXT_ULP_PROTO_HDR_SVIF_NUM	1
22 #define BNXT_ULP_PROTO_HDR_ETH_NUM	3
23 #define BNXT_ULP_PROTO_HDR_S_VLAN_NUM	3
24 #define BNXT_ULP_PROTO_HDR_VLAN_NUM	6
25 #define BNXT_ULP_PROTO_HDR_IPV4_NUM	10
26 #define BNXT_ULP_PROTO_HDR_IPV6_NUM	6
27 #define BNXT_ULP_PROTO_HDR_UDP_NUM	4
28 #define BNXT_ULP_PROTO_HDR_TCP_NUM	9
29 #define BNXT_ULP_PROTO_HDR_VXLAN_NUM	4
30 #define BNXT_ULP_PROTO_HDR_MAX		128
31 #define BNXT_ULP_PROTO_HDR_FIELD_SVIF_IDX	0
32 
33 struct ulp_rte_hdr_bitmap {
34 	uint64_t	bits;
35 };
36 
37 struct ulp_rte_field_bitmap {
38 	uint64_t	bits;
39 };
40 
41 /* Structure to store the protocol fields */
42 #define RTE_PARSER_FLOW_HDR_FIELD_SIZE		16
43 struct ulp_rte_hdr_field {
44 	uint8_t		spec[RTE_PARSER_FLOW_HDR_FIELD_SIZE];
45 	uint8_t		mask[RTE_PARSER_FLOW_HDR_FIELD_SIZE];
46 	uint32_t	size;
47 };
48 
49 struct ulp_rte_act_bitmap {
50 	uint64_t	bits;
51 };
52 
53 /* Structure to hold the action property details. */
54 struct ulp_rte_act_prop {
55 	uint8_t	act_details[BNXT_ULP_ACT_PROP_IDX_LAST];
56 };
57 
58 /* Structure to be used for passing all the parser functions */
59 struct ulp_rte_parser_params {
60 	struct ulp_rte_hdr_bitmap	hdr_bitmap;
61 	struct ulp_rte_field_bitmap	fld_bitmap;
62 	struct ulp_rte_hdr_field	hdr_field[BNXT_ULP_PROTO_HDR_MAX];
63 	uint32_t			comp_fld[BNXT_ULP_CHF_IDX_LAST];
64 	uint32_t			field_idx;
65 	uint32_t			vlan_idx;
66 	struct ulp_rte_act_bitmap	act_bitmap;
67 	struct ulp_rte_act_prop		act_prop;
68 	uint32_t			dir;
69 	struct bnxt_ulp_context		*ulp_ctx;
70 };
71 
72 /* Flow Parser Header Information Structure */
73 struct bnxt_ulp_rte_hdr_info {
74 	enum bnxt_ulp_hdr_type					hdr_type;
75 	/* Flow Parser Protocol Header Function Prototype */
76 	int (*proto_hdr_func)(const struct rte_flow_item	*item_list,
77 			      struct ulp_rte_parser_params	*params);
78 };
79 
80 /* Flow Parser Header Information Structure Array defined in template source*/
81 extern struct bnxt_ulp_rte_hdr_info	ulp_hdr_info[];
82 
83 /* Flow Parser Action Information Structure */
84 struct bnxt_ulp_rte_act_info {
85 	enum bnxt_ulp_act_type					act_type;
86 	/* Flow Parser Protocol Action Function Prototype */
87 	int32_t (*proto_act_func)
88 		(const struct rte_flow_action	*action_item,
89 		 struct ulp_rte_parser_params	*params);
90 };
91 
92 /* Flow Parser Action Information Structure Array defined in template source*/
93 extern struct bnxt_ulp_rte_act_info	ulp_act_info[];
94 
95 /* Flow Matcher structures */
96 struct bnxt_ulp_header_match_info {
97 	struct ulp_rte_hdr_bitmap		hdr_bitmap;
98 	uint32_t				start_idx;
99 	uint32_t				num_entries;
100 	uint32_t				class_tmpl_id;
101 	uint32_t				act_vnic;
102 };
103 
104 struct ulp_rte_bitmap {
105 	uint64_t	bits;
106 };
107 
108 struct bnxt_ulp_class_match_info {
109 	struct ulp_rte_bitmap	hdr_sig;
110 	struct ulp_rte_bitmap	field_sig;
111 	uint32_t		class_hid;
112 	uint32_t		class_tid;
113 	uint8_t			act_vnic;
114 	uint8_t			wc_pri;
115 };
116 
117 /* Flow Matcher templates Structure for class entries */
118 extern uint16_t ulp_class_sig_tbl[];
119 extern struct bnxt_ulp_class_match_info ulp_class_match_list[];
120 
121 /* Flow Matcher Action structures */
122 struct bnxt_ulp_action_match_info {
123 	struct ulp_rte_act_bitmap		act_bitmap;
124 	uint32_t				act_tmpl_id;
125 };
126 
127 struct bnxt_ulp_act_match_info {
128 	struct ulp_rte_bitmap	act_sig;
129 	uint32_t		act_hid;
130 	uint32_t		act_tid;
131 };
132 
133 /* Flow Matcher templates Structure for action entries */
134 extern	uint16_t ulp_act_sig_tbl[];
135 extern struct bnxt_ulp_act_match_info ulp_act_match_list[];
136 
137 /* Device specific parameters */
138 struct bnxt_ulp_device_params {
139 	uint8_t				description[16];
140 	uint32_t			global_fid_enable;
141 	enum bnxt_ulp_byte_order	byte_order;
142 	uint8_t				encap_byte_swap;
143 	uint32_t			lfid_entries;
144 	uint32_t			lfid_entry_size;
145 	uint64_t			gfid_entries;
146 	uint32_t			gfid_entry_size;
147 	uint64_t			num_flows;
148 	uint32_t			num_resources_per_flow;
149 };
150 
151 /* Flow Mapper */
152 struct bnxt_ulp_mapper_tbl_list_info {
153 	uint32_t	device_name;
154 	uint32_t	start_tbl_idx;
155 	uint32_t	num_tbls;
156 };
157 
158 struct bnxt_ulp_mapper_class_tbl_info {
159 	enum bnxt_ulp_resource_func	resource_func;
160 	uint32_t	table_type;
161 	uint8_t		direction;
162 	uint8_t		mem;
163 	uint32_t	priority;
164 	uint8_t		srch_b4_alloc;
165 	uint32_t	critical_resource;
166 
167 	/* Information for accessing the ulp_key_field_list */
168 	uint32_t	key_start_idx;
169 	uint16_t	key_bit_size;
170 	uint16_t	key_num_fields;
171 	/* Size of the blob that holds the key */
172 	uint16_t	blob_key_bit_size;
173 
174 	/* Information for accessing the ulp_class_result_field_list */
175 	uint32_t	result_start_idx;
176 	uint16_t	result_bit_size;
177 	uint16_t	result_num_fields;
178 
179 	/* Information for accessing the ulp_ident_list */
180 	uint32_t	ident_start_idx;
181 	uint16_t	ident_nums;
182 
183 	uint8_t		mark_enable;
184 	enum bnxt_ulp_regfile_index	regfile_wr_idx;
185 
186 	enum bnxt_ulp_cache_tbl_id cache_tbl_id;
187 };
188 
189 struct bnxt_ulp_mapper_act_tbl_info {
190 	enum bnxt_ulp_resource_func	resource_func;
191 	enum tf_tbl_type table_type;
192 	uint8_t		direction;
193 	uint8_t		srch_b4_alloc;
194 	uint32_t	result_start_idx;
195 	uint16_t	result_bit_size;
196 	uint16_t	encap_num_fields;
197 	uint16_t	result_num_fields;
198 
199 	enum bnxt_ulp_regfile_index	regfile_wr_idx;
200 };
201 
202 struct bnxt_ulp_mapper_class_key_field_info {
203 	uint8_t			description[64];
204 	enum bnxt_ulp_mask_opc	mask_opcode;
205 	enum bnxt_ulp_spec_opc	spec_opcode;
206 	uint16_t		field_bit_size;
207 	uint8_t			mask_operand[16];
208 	uint8_t			spec_operand[16];
209 };
210 
211 struct bnxt_ulp_mapper_result_field_info {
212 	uint8_t				description[64];
213 	enum bnxt_ulp_result_opc	result_opcode;
214 	uint16_t			field_bit_size;
215 	uint8_t				result_operand[16];
216 };
217 
218 struct bnxt_ulp_mapper_ident_info {
219 	uint8_t		description[64];
220 	uint32_t	resource_func;
221 
222 	uint16_t	ident_type;
223 	uint16_t	ident_bit_size;
224 	uint16_t	ident_bit_pos;
225 	enum bnxt_ulp_regfile_index	regfile_wr_idx;
226 };
227 
228 struct bnxt_ulp_def_ident_info {
229 	enum tf_dir direction;
230 	enum tf_identifier_type ident_type;
231 	enum bnxt_ulp_def_regfile_index def_regfile_index;
232 };
233 
234 struct bnxt_ulp_cache_tbl_params {
235 	uint16_t num_entries;
236 };
237 
238 /*
239  * Flow Mapper Static Data Externs:
240  * Access to the below static data should be done through access functions and
241  * directly throughout the code.
242  */
243 
244 /*
245  * The ulp_device_params is indexed by the dev_id.
246  * This table maintains the device specific parameters.
247  */
248 extern struct bnxt_ulp_device_params ulp_device_params[];
249 
250 /*
251  * The ulp_class_tmpl_list and ulp_act_tmpl_list are indexed by the dev_id
252  * and template id (either class or action) returned by the matcher.
253  * The result provides the start index and number of entries in the connected
254  * ulp_class_tbl_list/ulp_act_tbl_list.
255  */
256 extern struct bnxt_ulp_mapper_tbl_list_info	ulp_class_tmpl_list[];
257 extern struct bnxt_ulp_mapper_tbl_list_info	ulp_act_tmpl_list[];
258 
259 /*
260  * The ulp_class_tbl_list and ulp_act_tbl_list are indexed based on the results
261  * of the template lists.  Each entry describes the high level details of the
262  * table entry to include the start index and number of instructions in the
263  * field lists.
264  */
265 extern struct bnxt_ulp_mapper_class_tbl_info	ulp_class_tbl_list[];
266 extern struct bnxt_ulp_mapper_act_tbl_info	ulp_act_tbl_list[];
267 
268 /*
269  * The ulp_class_result_field_list provides the instructions for creating result
270  * records such as tcam/em results.
271  */
272 extern struct bnxt_ulp_mapper_result_field_info	ulp_class_result_field_list[];
273 
274 /*
275  * The ulp_data_field_list provides the instructions for creating an action
276  * record.  It uses the same structure as the result list, but is only used for
277  * actions.
278  */
279 extern
280 struct bnxt_ulp_mapper_result_field_info ulp_act_result_field_list[];
281 
282 /*
283  * The ulp_act_prop_map_table provides the mapping to index and size of action
284  * tcam and em tables.
285  */
286 extern
287 struct bnxt_ulp_mapper_class_key_field_info	ulp_class_key_field_list[];
288 
289 /*
290  * The ulp_ident_list provides the instructions for creating identifiers such
291  * as profile ids.
292  */
293 extern struct bnxt_ulp_mapper_ident_info	ulp_ident_list[];
294 
295 /*
296  * The ulp_act_prop_map_table provides the mapping to index and size of action
297  * properties.
298  */
299 extern uint32_t ulp_act_prop_map_table[];
300 
301 /*
302  * The ulp_def_ident_tbl provides the list of default identifiers that need to
303  * be initialized and where to store them.
304  */
305 extern struct bnxt_ulp_def_ident_info ulp_def_ident_tbl[];
306 
307 /*
308  * The ulp_cache_tbl_parms table provides the sizes of the cache tables the
309  * mapper must dynamically allocate during initialization.
310  */
311 extern struct bnxt_ulp_cache_tbl_params ulp_cache_tbl_params[];
312 
313 #endif /* _ULP_TEMPLATE_STRUCT_H_ */
314