xref: /dpdk/drivers/net/bnxt/tf_ulp/ulp_template_struct.h (revision 9f3b3a96dec2f4c01cc92a132d763b8887d29e6a)
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_hdr_bitmap	hdr_fp_bit;
67 	struct ulp_rte_field_bitmap	fld_bitmap;
68 	struct ulp_rte_hdr_field	hdr_field[BNXT_ULP_PROTO_HDR_MAX];
69 	uint32_t			comp_fld[BNXT_ULP_CF_IDX_LAST];
70 	uint32_t			field_idx;
71 	uint32_t			vlan_idx;
72 	struct ulp_rte_act_bitmap	act_bitmap;
73 	struct ulp_rte_act_prop		act_prop;
74 	uint32_t			dir_attr;
75 	uint32_t			priority;
76 	uint32_t			fid;
77 	uint32_t			parent_flow;
78 	uint32_t			parent_fid;
79 	uint16_t			func_id;
80 	uint32_t			class_id;
81 	uint32_t			act_tmpl;
82 	struct bnxt_ulp_context		*ulp_ctx;
83 };
84 
85 /* Flow Parser Header Information Structure */
86 struct bnxt_ulp_rte_hdr_info {
87 	enum bnxt_ulp_hdr_type					hdr_type;
88 	/* Flow Parser Protocol Header Function Prototype */
89 	int (*proto_hdr_func)(const struct rte_flow_item	*item_list,
90 			      struct ulp_rte_parser_params	*params);
91 };
92 
93 /* Flow Parser Header Information Structure Array defined in template source*/
94 extern struct bnxt_ulp_rte_hdr_info	ulp_hdr_info[];
95 
96 /* Flow Parser Action Information Structure */
97 struct bnxt_ulp_rte_act_info {
98 	enum bnxt_ulp_act_type					act_type;
99 	/* Flow Parser Protocol Action Function Prototype */
100 	int32_t (*proto_act_func)
101 		(const struct rte_flow_action	*action_item,
102 		 struct ulp_rte_parser_params	*params);
103 };
104 
105 /* Flow Parser Action Information Structure Array defined in template source*/
106 extern struct bnxt_ulp_rte_act_info	ulp_act_info[];
107 
108 /* Flow Matcher structures */
109 struct bnxt_ulp_header_match_info {
110 	struct ulp_rte_hdr_bitmap		hdr_bitmap;
111 	uint32_t				start_idx;
112 	uint32_t				num_entries;
113 	uint32_t				class_tmpl_id;
114 	uint32_t				act_vnic;
115 };
116 
117 struct ulp_rte_bitmap {
118 	uint64_t	bits;
119 };
120 
121 struct bnxt_ulp_class_match_info {
122 	struct ulp_rte_bitmap	hdr_sig;
123 	struct ulp_rte_bitmap	field_sig;
124 	uint32_t		class_hid;
125 	uint32_t		class_tid;
126 	uint8_t			act_vnic;
127 	uint8_t			wc_pri;
128 };
129 
130 /* Flow Matcher templates Structure for class entries */
131 extern uint16_t ulp_class_sig_tbl[];
132 extern struct bnxt_ulp_class_match_info ulp_class_match_list[];
133 
134 /* Flow Matcher Action structures */
135 struct bnxt_ulp_action_match_info {
136 	struct ulp_rte_act_bitmap		act_bitmap;
137 	uint32_t				act_tmpl_id;
138 };
139 
140 struct bnxt_ulp_act_match_info {
141 	struct ulp_rte_bitmap	act_sig;
142 	uint32_t		act_hid;
143 	uint32_t		act_tid;
144 };
145 
146 /* Flow Matcher templates Structure for action entries */
147 extern	uint16_t ulp_act_sig_tbl[];
148 extern struct bnxt_ulp_act_match_info ulp_act_match_list[];
149 
150 /* Device Specific Tables for mapper */
151 struct ulp_template_device_tbls {
152 	struct bnxt_ulp_mapper_tbl_list_info *tmpl_list;
153 	struct bnxt_ulp_mapper_tbl_info *tbl_list;
154 	struct bnxt_ulp_mapper_key_field_info *key_field_list;
155 	struct bnxt_ulp_mapper_result_field_info *result_field_list;
156 	struct bnxt_ulp_mapper_ident_info *ident_list;
157 };
158 
159 /* Device specific parameters */
160 struct bnxt_ulp_device_params {
161 	uint8_t				description[16];
162 	enum bnxt_ulp_byte_order	byte_order;
163 	uint8_t				encap_byte_swap;
164 	uint8_t				num_phy_ports;
165 	uint32_t			mark_db_lfid_entries;
166 	uint64_t			mark_db_gfid_entries;
167 	uint64_t			int_flow_db_num_entries;
168 	uint64_t			ext_flow_db_num_entries;
169 	uint32_t			flow_count_db_entries;
170 	uint32_t			fdb_parent_flow_entries;
171 	uint32_t			num_resources_per_flow;
172 	uint32_t			ext_cntr_table_type;
173 	uint64_t			byte_count_mask;
174 	uint64_t			packet_count_mask;
175 	uint32_t			byte_count_shift;
176 	uint32_t			packet_count_shift;
177 	const struct ulp_template_device_tbls *dev_tbls;
178 };
179 
180 /* Flow Mapper */
181 struct bnxt_ulp_mapper_tbl_list_info {
182 	uint32_t		device_name;
183 	uint32_t		start_tbl_idx;
184 	uint32_t		num_tbls;
185 };
186 
187 struct bnxt_ulp_mapper_tbl_info {
188 	enum bnxt_ulp_resource_func	resource_func;
189 	uint32_t			resource_type; /* TF_ enum type */
190 	enum bnxt_ulp_resource_sub_type	resource_sub_type;
191 	enum bnxt_ulp_cond_opcode	cond_opcode;
192 	uint32_t			cond_operand;
193 	enum bnxt_ulp_mem_type_opcode	mem_type_opcode;
194 	uint8_t				direction;
195 	uint32_t			priority;
196 	enum bnxt_ulp_search_before_alloc	srch_b4_alloc;
197 	enum bnxt_ulp_critical_resource		critical_resource;
198 
199 	/* Information for accessing the ulp_key_field_list */
200 	uint32_t	key_start_idx;
201 	uint16_t	key_bit_size;
202 	uint16_t	key_num_fields;
203 	/* Size of the blob that holds the key */
204 	uint16_t	blob_key_bit_size;
205 
206 	/* Information for accessing the ulp_class_result_field_list */
207 	uint32_t	result_start_idx;
208 	uint16_t	result_bit_size;
209 	uint16_t	result_num_fields;
210 	uint16_t	encap_num_fields;
211 
212 	/* Information for accessing the ulp_ident_list */
213 	uint32_t	ident_start_idx;
214 	uint16_t	ident_nums;
215 
216 	enum bnxt_ulp_mark_db_opcode	mark_db_opcode;
217 	enum bnxt_ulp_index_opcode	index_opcode;
218 	uint32_t			index_operand;
219 };
220 
221 struct bnxt_ulp_mapper_key_field_info {
222 	uint8_t				description[64];
223 	enum bnxt_ulp_mapper_opc	mask_opcode;
224 	enum bnxt_ulp_mapper_opc	spec_opcode;
225 	uint16_t			field_bit_size;
226 	uint8_t				mask_operand[16];
227 	uint8_t				spec_operand[16];
228 };
229 
230 struct bnxt_ulp_mapper_result_field_info {
231 	uint8_t				description[64];
232 	enum bnxt_ulp_mapper_opc	result_opcode;
233 	uint16_t			field_bit_size;
234 	uint8_t				result_operand[16];
235 	uint8_t				result_operand_true[16];
236 	uint8_t				result_operand_false[16];
237 };
238 
239 struct bnxt_ulp_mapper_ident_info {
240 	uint8_t		description[64];
241 	uint32_t	resource_func;
242 
243 	uint16_t	ident_type;
244 	uint16_t	ident_bit_size;
245 	uint16_t	ident_bit_pos;
246 	enum bnxt_ulp_regfile_index	regfile_idx;
247 };
248 
249 struct bnxt_ulp_glb_resource_info {
250 	enum bnxt_ulp_resource_func	resource_func;
251 	uint32_t			resource_type; /* TF_ enum type */
252 	enum bnxt_ulp_glb_regfile_index	glb_regfile_index;
253 	enum tf_dir			direction;
254 };
255 
256 struct bnxt_ulp_cache_tbl_params {
257 	uint16_t num_entries;
258 };
259 
260 /*
261  * Flow Mapper Static Data Externs:
262  * Access to the below static data should be done through access functions and
263  * directly throughout the code.
264  */
265 
266 /*
267  * The ulp_device_params is indexed by the dev_id.
268  * This table maintains the device specific parameters.
269  */
270 extern struct bnxt_ulp_device_params ulp_device_params[];
271 
272 /*
273  * The ulp_act_prop_map_table provides the mapping to index and size of action
274  * properties.
275  */
276 extern uint32_t ulp_act_prop_map_table[];
277 
278 /*
279  * The ulp_glb_resource_tbl provides the list of global resources that need to
280  * be initialized and where to store them.
281  */
282 extern struct bnxt_ulp_glb_resource_info ulp_glb_resource_tbl[];
283 
284 /*
285  * The ulp_cache_tbl_parms table provides the sizes of the cache tables the
286  * mapper must dynamically allocate during initialization.
287  */
288 extern struct bnxt_ulp_cache_tbl_params ulp_cache_tbl_params[];
289 
290 /*
291  * The ulp_global template table is used to initialize default entries
292  * that could be reused by other templates.
293  */
294 extern uint32_t ulp_glb_template_tbl[];
295 
296 #endif /* _ULP_TEMPLATE_STRUCT_H_ */
297