xref: /dpdk/drivers/net/bnxt/tf_ulp/ulp_template_struct.h (revision cb440babbd45a80c059f8bc80e87c48d09086fd7)
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	8
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 /* Direction attributes */
34 #define BNXT_ULP_FLOW_ATTR_TRANSFER	0x1
35 #define BNXT_ULP_FLOW_ATTR_INGRESS	0x2
36 #define BNXT_ULP_FLOW_ATTR_EGRESS	0x4
37 
38 struct ulp_rte_hdr_bitmap {
39 	uint64_t	bits;
40 };
41 
42 struct ulp_rte_field_bitmap {
43 	uint64_t	bits;
44 };
45 
46 /* Structure to store the protocol fields */
47 #define RTE_PARSER_FLOW_HDR_FIELD_SIZE		16
48 struct ulp_rte_hdr_field {
49 	uint8_t		spec[RTE_PARSER_FLOW_HDR_FIELD_SIZE];
50 	uint8_t		mask[RTE_PARSER_FLOW_HDR_FIELD_SIZE];
51 	uint32_t	size;
52 };
53 
54 struct ulp_rte_act_bitmap {
55 	uint64_t	bits;
56 };
57 
58 /* Structure to hold the action property details. */
59 struct ulp_rte_act_prop {
60 	uint8_t	act_details[BNXT_ULP_ACT_PROP_IDX_LAST];
61 };
62 
63 /* Structure to be used for passing all the parser functions */
64 struct ulp_rte_parser_params {
65 	struct ulp_rte_hdr_bitmap	hdr_bitmap;
66 	struct ulp_rte_field_bitmap	fld_bitmap;
67 	struct ulp_rte_hdr_field	hdr_field[BNXT_ULP_PROTO_HDR_MAX];
68 	uint32_t			comp_fld[BNXT_ULP_CF_IDX_LAST];
69 	uint32_t			field_idx;
70 	uint32_t			vlan_idx;
71 	struct ulp_rte_act_bitmap	act_bitmap;
72 	struct ulp_rte_act_prop		act_prop;
73 	uint32_t			dir_attr;
74 	struct bnxt_ulp_context		*ulp_ctx;
75 };
76 
77 /* Flow Parser Header Information Structure */
78 struct bnxt_ulp_rte_hdr_info {
79 	enum bnxt_ulp_hdr_type					hdr_type;
80 	/* Flow Parser Protocol Header Function Prototype */
81 	int (*proto_hdr_func)(const struct rte_flow_item	*item_list,
82 			      struct ulp_rte_parser_params	*params);
83 };
84 
85 /* Flow Parser Header Information Structure Array defined in template source*/
86 extern struct bnxt_ulp_rte_hdr_info	ulp_hdr_info[];
87 
88 /* Flow Parser Action Information Structure */
89 struct bnxt_ulp_rte_act_info {
90 	enum bnxt_ulp_act_type					act_type;
91 	/* Flow Parser Protocol Action Function Prototype */
92 	int32_t (*proto_act_func)
93 		(const struct rte_flow_action	*action_item,
94 		 struct ulp_rte_parser_params	*params);
95 };
96 
97 /* Flow Parser Action Information Structure Array defined in template source*/
98 extern struct bnxt_ulp_rte_act_info	ulp_act_info[];
99 
100 /* Flow Matcher structures */
101 struct bnxt_ulp_header_match_info {
102 	struct ulp_rte_hdr_bitmap		hdr_bitmap;
103 	uint32_t				start_idx;
104 	uint32_t				num_entries;
105 	uint32_t				class_tmpl_id;
106 	uint32_t				act_vnic;
107 };
108 
109 struct ulp_rte_bitmap {
110 	uint64_t	bits;
111 };
112 
113 struct bnxt_ulp_class_match_info {
114 	struct ulp_rte_bitmap	hdr_sig;
115 	struct ulp_rte_bitmap	field_sig;
116 	uint32_t		class_hid;
117 	uint32_t		class_tid;
118 	uint8_t			act_vnic;
119 	uint8_t			wc_pri;
120 };
121 
122 /* Flow Matcher templates Structure for class entries */
123 extern uint16_t ulp_class_sig_tbl[];
124 extern struct bnxt_ulp_class_match_info ulp_class_match_list[];
125 
126 /* Flow Matcher Action structures */
127 struct bnxt_ulp_action_match_info {
128 	struct ulp_rte_act_bitmap		act_bitmap;
129 	uint32_t				act_tmpl_id;
130 };
131 
132 struct bnxt_ulp_act_match_info {
133 	struct ulp_rte_bitmap	act_sig;
134 	uint32_t		act_hid;
135 	uint32_t		act_tid;
136 };
137 
138 /* Flow Matcher templates Structure for action entries */
139 extern	uint16_t ulp_act_sig_tbl[];
140 extern struct bnxt_ulp_act_match_info ulp_act_match_list[];
141 
142 /* Device specific parameters */
143 struct bnxt_ulp_device_params {
144 	uint8_t				description[16];
145 	enum bnxt_ulp_flow_mem_type	flow_mem_type;
146 	enum bnxt_ulp_byte_order	byte_order;
147 	uint8_t				encap_byte_swap;
148 	uint8_t				num_phy_ports;
149 	uint32_t			mark_db_lfid_entries;
150 	uint64_t			mark_db_gfid_entries;
151 	uint64_t			flow_db_num_entries;
152 	uint32_t			flow_count_db_entries;
153 	uint32_t			num_resources_per_flow;
154 	uint32_t			ext_cntr_table_type;
155 	uint64_t			byte_count_mask;
156 	uint64_t			packet_count_mask;
157 	uint32_t			byte_count_shift;
158 	uint32_t			packet_count_shift;
159 };
160 
161 /* Flow Mapper */
162 struct bnxt_ulp_mapper_tbl_list_info {
163 	uint32_t		device_name;
164 	uint32_t		start_tbl_idx;
165 	uint32_t		num_tbls;
166 	enum bnxt_ulp_fdb_type	flow_db_table_type;
167 };
168 
169 struct bnxt_ulp_mapper_tbl_info {
170 	enum bnxt_ulp_resource_func	resource_func;
171 	uint32_t			resource_type; /* TF_ enum type */
172 	enum bnxt_ulp_resource_sub_type	resource_sub_type;
173 	enum bnxt_ulp_cond_opcode	cond_opcode;
174 	uint32_t			cond_operand;
175 	uint8_t		direction;
176 	uint32_t	priority;
177 	uint8_t		srch_b4_alloc;
178 	enum bnxt_ulp_critical_resource	critical_resource;
179 
180 	/* Information for accessing the ulp_key_field_list */
181 	uint32_t	key_start_idx;
182 	uint16_t	key_bit_size;
183 	uint16_t	key_num_fields;
184 	/* Size of the blob that holds the key */
185 	uint16_t	blob_key_bit_size;
186 
187 	/* Information for accessing the ulp_class_result_field_list */
188 	uint32_t	result_start_idx;
189 	uint16_t	result_bit_size;
190 	uint16_t	result_num_fields;
191 	uint16_t	encap_num_fields;
192 
193 	/* Information for accessing the ulp_ident_list */
194 	uint32_t	ident_start_idx;
195 	uint16_t	ident_nums;
196 
197 	enum bnxt_ulp_mark_db_opcode	mark_db_opcode;
198 	enum bnxt_ulp_index_opcode	index_opcode;
199 	uint32_t			index_operand;
200 };
201 
202 struct bnxt_ulp_mapper_class_key_field_info {
203 	uint8_t				description[64];
204 	enum bnxt_ulp_mapper_opc	mask_opcode;
205 	enum bnxt_ulp_mapper_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_mapper_opc	result_opcode;
214 	uint16_t			field_bit_size;
215 	uint8_t				result_operand[16];
216 	uint8_t				result_operand_true[16];
217 	uint8_t				result_operand_false[16];
218 };
219 
220 struct bnxt_ulp_mapper_ident_info {
221 	uint8_t		description[64];
222 	uint32_t	resource_func;
223 
224 	uint16_t	ident_type;
225 	uint16_t	ident_bit_size;
226 	uint16_t	ident_bit_pos;
227 	enum bnxt_ulp_regfile_index	regfile_idx;
228 };
229 
230 struct bnxt_ulp_glb_resource_info {
231 	enum bnxt_ulp_resource_func	resource_func;
232 	uint32_t			resource_type; /* TF_ enum type */
233 	enum bnxt_ulp_glb_regfile_index	glb_regfile_index;
234 	enum tf_dir			direction;
235 };
236 
237 struct bnxt_ulp_cache_tbl_params {
238 	uint16_t num_entries;
239 };
240 
241 /*
242  * Flow Mapper Static Data Externs:
243  * Access to the below static data should be done through access functions and
244  * directly throughout the code.
245  */
246 
247 /*
248  * The ulp_device_params is indexed by the dev_id.
249  * This table maintains the device specific parameters.
250  */
251 extern struct bnxt_ulp_device_params ulp_device_params[];
252 
253 /*
254  * The ulp_class_tmpl_list and ulp_act_tmpl_list are indexed by the dev_id
255  * and template id (either class or action) returned by the matcher.
256  * The result provides the start index and number of entries in the connected
257  * ulp_class_tbl_list/ulp_act_tbl_list.
258  */
259 extern struct bnxt_ulp_mapper_tbl_list_info	ulp_class_tmpl_list[];
260 extern struct bnxt_ulp_mapper_tbl_list_info	ulp_act_tmpl_list[];
261 
262 /*
263  * The ulp_class_tbl_list and ulp_act_tbl_list are indexed based on the results
264  * of the template lists.  Each entry describes the high level details of the
265  * table entry to include the start index and number of instructions in the
266  * field lists.
267  */
268 extern struct bnxt_ulp_mapper_tbl_info	ulp_class_tbl_list[];
269 extern struct bnxt_ulp_mapper_tbl_info	ulp_act_tbl_list[];
270 
271 /*
272  * The ulp_class_result_field_list provides the instructions for creating result
273  * records such as tcam/em results.
274  */
275 extern struct bnxt_ulp_mapper_result_field_info	ulp_class_result_field_list[];
276 
277 /*
278  * The ulp_data_field_list provides the instructions for creating an action
279  * record.  It uses the same structure as the result list, but is only used for
280  * actions.
281  */
282 extern
283 struct bnxt_ulp_mapper_result_field_info ulp_act_result_field_list[];
284 
285 /*
286  * The ulp_act_prop_map_table provides the mapping to index and size of action
287  * tcam and em tables.
288  */
289 extern
290 struct bnxt_ulp_mapper_class_key_field_info	ulp_class_key_field_list[];
291 
292 /*
293  * The ulp_ident_list provides the instructions for creating identifiers such
294  * as profile ids.
295  */
296 extern struct bnxt_ulp_mapper_ident_info	ulp_ident_list[];
297 
298 /*
299  * The ulp_act_prop_map_table provides the mapping to index and size of action
300  * properties.
301  */
302 extern uint32_t ulp_act_prop_map_table[];
303 
304 /*
305  * The ulp_glb_resource_tbl provides the list of global resources that need to
306  * be initialized and where to store them.
307  */
308 extern struct bnxt_ulp_glb_resource_info ulp_glb_resource_tbl[];
309 
310 /*
311  * The ulp_cache_tbl_parms table provides the sizes of the cache tables the
312  * mapper must dynamically allocate during initialization.
313  */
314 extern struct bnxt_ulp_cache_tbl_params ulp_cache_tbl_params[];
315 
316 /*
317  * The ulp_global template table is used to initialize default entries
318  * that could be reused by other templates.
319  */
320 extern uint32_t ulp_glb_template_tbl[];
321 
322 #endif /* _ULP_TEMPLATE_STRUCT_H_ */
323