1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2014-2021 Broadcom
6 #ifndef _ULP_TEMPLATE_STRUCT_H_
7 #define _ULP_TEMPLATE_STRUCT_H_
10 #include "rte_ether.h"
20 /* Number of fields for each protocol */
21 #define BNXT_ULP_PROTO_HDR_SVIF_NUM 2
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_GRE_NUM 6
31 #define BNXT_ULP_PROTO_HDR_ICMP_NUM 5
32 #define BNXT_ULP_PROTO_HDR_MAX 128
33 #define BNXT_ULP_PROTO_HDR_ENCAP_MAX 64
34 #define BNXT_ULP_PROTO_HDR_FIELD_SVIF_IDX 1
36 /* Direction attributes */
37 #define BNXT_ULP_FLOW_ATTR_TRANSFER 0x1
38 #define BNXT_ULP_FLOW_ATTR_INGRESS 0x2
39 #define BNXT_ULP_FLOW_ATTR_EGRESS 0x4
41 struct ulp_rte_hdr_bitmap {
45 struct ulp_rte_field_bitmap {
49 /* Structure to store the protocol fields */
50 #define RTE_PARSER_FLOW_HDR_FIELD_SIZE 16
51 struct ulp_rte_hdr_field {
52 uint8_t spec[RTE_PARSER_FLOW_HDR_FIELD_SIZE];
53 uint8_t mask[RTE_PARSER_FLOW_HDR_FIELD_SIZE];
57 struct ulp_rte_act_bitmap {
61 /* Structure to hold the action property details. */
62 struct ulp_rte_act_prop {
63 uint8_t act_details[BNXT_ULP_ACT_PROP_IDX_LAST];
66 /* Structure to be used for passing all the parser functions */
67 struct ulp_rte_parser_params {
68 struct ulp_rte_hdr_bitmap hdr_bitmap;
69 struct ulp_rte_hdr_bitmap enc_hdr_bitmap;
70 struct ulp_rte_hdr_bitmap hdr_fp_bit;
71 struct ulp_rte_field_bitmap fld_bitmap;
72 struct ulp_rte_field_bitmap fld_s_bitmap;
73 struct ulp_rte_hdr_field hdr_field[BNXT_ULP_PROTO_HDR_MAX];
74 struct ulp_rte_hdr_field enc_field[BNXT_ULP_PROTO_HDR_ENCAP_MAX];
75 uint64_t comp_fld[BNXT_ULP_CF_IDX_LAST];
77 struct ulp_rte_act_bitmap act_bitmap;
78 struct ulp_rte_act_prop act_prop;
88 struct bnxt_ulp_context *ulp_ctx;
91 uint32_t flow_pattern_id;
92 uint32_t act_pattern_id;
98 /* Flow Parser Header Information Structure */
99 struct bnxt_ulp_rte_hdr_info {
100 enum bnxt_ulp_hdr_type hdr_type;
101 /* Flow Parser Protocol Header Function Prototype */
102 int (*proto_hdr_func)(const struct rte_flow_item *item_list,
103 struct ulp_rte_parser_params *params);
106 /* Flow Parser Header Information Structure Array defined in template source*/
107 extern struct bnxt_ulp_rte_hdr_info ulp_hdr_info[];
108 extern struct bnxt_ulp_rte_hdr_info ulp_vendor_hdr_info[];
110 /* Flow Parser Action Information Structure */
111 struct bnxt_ulp_rte_act_info {
112 enum bnxt_ulp_act_type act_type;
113 /* Flow Parser Protocol Action Function Prototype */
114 int32_t (*proto_act_func)
115 (const struct rte_flow_action *action_item,
116 struct ulp_rte_parser_params *params);
119 /* Flow Parser Action Information Structure Array defined in template source*/
120 extern struct bnxt_ulp_rte_act_info ulp_act_info[];
121 extern struct bnxt_ulp_rte_act_info ulp_vendor_act_info[];
123 /* Flow Matcher structures */
124 struct bnxt_ulp_header_match_info {
125 struct ulp_rte_hdr_bitmap hdr_bitmap;
127 uint32_t num_entries;
128 uint32_t class_tmpl_id;
132 struct ulp_rte_bitmap {
136 struct bnxt_ulp_class_match_info {
137 struct ulp_rte_bitmap hdr_sig;
138 struct ulp_rte_bitmap field_sig;
145 uint64_t flow_sig_id;
146 uint32_t flow_pattern_id;
149 /* Flow Matcher templates Structure for class entries */
150 extern uint16_t ulp_class_sig_tbl[];
151 extern struct bnxt_ulp_class_match_info ulp_class_match_list[];
153 /* Flow Matcher Action structures */
154 struct bnxt_ulp_action_match_info {
155 struct ulp_rte_act_bitmap act_bitmap;
156 uint32_t act_tmpl_id;
159 struct bnxt_ulp_act_match_info {
160 struct ulp_rte_bitmap act_sig;
163 uint32_t act_pattern_id;
167 /* Flow Matcher templates Structure for action entries */
168 extern uint16_t ulp_act_sig_tbl[];
169 extern struct bnxt_ulp_act_match_info ulp_act_match_list[];
171 /* Device Specific Tables for mapper */
172 struct bnxt_ulp_mapper_cond_info {
173 enum bnxt_ulp_cond_opc cond_opcode;
174 uint32_t cond_operand;
177 struct bnxt_ulp_mapper_cond_list_info {
178 enum bnxt_ulp_cond_list_opc cond_list_opcode;
179 uint32_t cond_start_idx;
181 int32_t cond_true_goto;
182 int32_t cond_false_goto;
185 struct bnxt_ulp_mapper_func_info {
186 enum bnxt_ulp_func_opc func_opc;
187 enum bnxt_ulp_func_src func_src1;
188 enum bnxt_ulp_func_src func_src2;
191 uint16_t func_dst_opr;
194 struct bnxt_ulp_template_device_tbls {
195 struct bnxt_ulp_mapper_tmpl_info *tmpl_list;
196 uint32_t tmpl_list_size;
197 struct bnxt_ulp_mapper_tbl_info *tbl_list;
198 uint32_t tbl_list_size;
199 struct bnxt_ulp_mapper_key_info *key_info_list;
200 uint32_t key_info_list_size;
201 struct bnxt_ulp_mapper_field_info *result_field_list;
202 uint32_t result_field_list_size;
203 struct bnxt_ulp_mapper_ident_info *ident_list;
204 uint32_t ident_list_size;
205 struct bnxt_ulp_mapper_cond_info *cond_list;
206 uint32_t cond_list_size;
209 /* Device specific parameters */
210 struct bnxt_ulp_device_params {
211 uint8_t description[16];
212 enum bnxt_ulp_byte_order key_byte_order;
213 enum bnxt_ulp_byte_order result_byte_order;
214 enum bnxt_ulp_byte_order encap_byte_order;
215 enum bnxt_ulp_byte_order wc_key_byte_order;
216 enum bnxt_ulp_byte_order em_byte_order;
217 uint8_t encap_byte_swap;
218 uint8_t num_phy_ports;
219 uint32_t mark_db_lfid_entries;
220 uint64_t mark_db_gfid_entries;
221 uint64_t int_flow_db_num_entries;
222 uint64_t ext_flow_db_num_entries;
223 uint32_t flow_count_db_entries;
224 uint32_t fdb_parent_flow_entries;
225 uint32_t num_resources_per_flow;
226 uint32_t ext_cntr_table_type;
227 uint64_t byte_count_mask;
228 uint64_t packet_count_mask;
229 uint32_t byte_count_shift;
230 uint32_t packet_count_shift;
231 uint32_t dynamic_pad_en;
232 uint16_t em_blk_size_bits;
233 uint16_t em_blk_align_bits;
234 uint16_t em_key_align_bytes;
235 uint16_t em_result_size_bits;
236 uint16_t wc_slice_width;
237 uint16_t wc_max_slices;
238 uint32_t wc_mode_list[4];
239 uint32_t wc_mod_list_max_size;
240 uint32_t wc_ctl_size_bits;
241 const struct bnxt_ulp_template_device_tbls *dev_tbls;
245 struct bnxt_ulp_mapper_tmpl_info {
246 uint32_t device_name;
247 uint32_t start_tbl_idx;
249 struct bnxt_ulp_mapper_cond_list_info reject_info;
252 struct bnxt_ulp_mapper_tbl_info {
253 enum bnxt_ulp_resource_func resource_func;
254 uint32_t resource_type; /* TF_ enum type */
255 enum bnxt_ulp_resource_sub_type resource_sub_type;
256 struct bnxt_ulp_mapper_cond_list_info execute_info;
257 struct bnxt_ulp_mapper_func_info func_info;
258 enum bnxt_ulp_cond_opc cond_opcode;
259 uint32_t cond_operand;
261 enum bnxt_ulp_pri_opc pri_opcode;
262 uint32_t pri_operand;
264 /* conflict resolution opcode */
265 enum bnxt_ulp_accept_opc accept_opcode;
267 enum bnxt_ulp_critical_resource critical_resource;
269 /* Information for accessing the ulp_key_field_list */
270 uint32_t key_start_idx;
271 uint16_t key_bit_size;
272 uint16_t key_num_fields;
273 /* Size of the blob that holds the key */
274 uint16_t blob_key_bit_size;
275 uint16_t record_size;
277 /* Information for accessing the ulp_class_result_field_list */
278 uint32_t result_start_idx;
279 uint16_t result_bit_size;
280 uint16_t result_num_fields;
281 uint16_t encap_num_fields;
283 /* Information for accessing the ulp_ident_list */
284 uint32_t ident_start_idx;
287 enum bnxt_ulp_mark_db_opc mark_db_opcode;
289 /* Table opcode for table operations */
291 uint32_t tbl_operand;
292 enum bnxt_ulp_generic_tbl_lkup_type gen_tbl_lkup_type;
294 /* FDB table opcode */
295 enum bnxt_ulp_fdb_opc fdb_opcode;
296 uint32_t fdb_operand;
299 enum bnxt_ulp_shared_session shared_session;
302 struct bnxt_ulp_mapper_field_info {
303 uint8_t description[64];
304 uint16_t field_bit_size;
305 enum bnxt_ulp_field_opc field_opc;
306 enum bnxt_ulp_field_src field_src1;
307 uint8_t field_opr1[16];
308 enum bnxt_ulp_field_src field_src2;
309 uint8_t field_opr2[16];
310 enum bnxt_ulp_field_src field_src3;
311 uint8_t field_opr3[16];
314 struct bnxt_ulp_mapper_key_info {
315 struct bnxt_ulp_mapper_field_info field_info_spec;
316 struct bnxt_ulp_mapper_field_info field_info_mask;
319 struct bnxt_ulp_mapper_ident_info {
320 uint8_t description[64];
321 uint32_t resource_func;
324 uint16_t ident_bit_size;
325 uint16_t ident_bit_pos;
326 enum bnxt_ulp_rf_idx regfile_idx;
329 struct bnxt_ulp_glb_resource_info {
331 enum bnxt_ulp_device_id device_id;
332 enum tf_dir direction;
333 enum bnxt_ulp_resource_func resource_func;
334 uint32_t resource_type; /* TF_ enum type */
335 enum bnxt_ulp_glb_rf_idx glb_regfile_index;
338 struct bnxt_ulp_resource_resv_info {
340 enum bnxt_ulp_device_id device_id;
341 enum tf_dir direction;
342 enum bnxt_ulp_resource_func resource_func;
343 uint32_t resource_type; /* TF_ enum type */
347 struct bnxt_ulp_app_capabilities_info {
349 enum bnxt_ulp_device_id device_id;
353 struct bnxt_ulp_cache_tbl_params {
354 uint16_t num_entries;
357 struct bnxt_ulp_generic_tbl_params {
359 uint16_t result_num_entries;
360 uint16_t result_num_bytes;
361 enum bnxt_ulp_byte_order result_byte_order;
362 uint32_t hash_tbl_entries;
363 uint16_t num_buckets;
364 uint16_t key_num_bytes;
367 struct bnxt_ulp_shared_act_info {
368 uint64_t act_bitmask;
372 * Flow Mapper Static Data Externs:
373 * Access to the below static data should be done through access functions and
374 * directly throughout the code.
378 * The ulp_device_params is indexed by the dev_id.
379 * This table maintains the device specific parameters.
381 extern struct bnxt_ulp_device_params ulp_device_params[];
384 * The ulp_act_prop_map_table provides the mapping to index and size of action
387 extern uint32_t ulp_act_prop_map_table[];
390 * The ulp_glb_resource_tbl provides the list of global resources that need to
391 * be initialized and where to store them.
393 extern struct bnxt_ulp_glb_resource_info ulp_glb_resource_tbl[];
396 * The ulp_app_glb_resource_tbl provides the list of shared resources required
397 * in the event that shared session is enabled.
399 extern struct bnxt_ulp_glb_resource_info ulp_app_glb_resource_tbl[];
402 * The ulp_resource_resv_list provides the list of tf resources required when
405 extern struct bnxt_ulp_resource_resv_info ulp_resource_resv_list[];
408 * The ulp_app_resource_resv_list provides the list of tf resources required
409 * when calling tf_open.
411 extern struct bnxt_ulp_resource_resv_info ulp_app_resource_resv_list[];
414 * The_app_cap_info_list provides the list of ULP capabilities per app/device.
416 extern struct bnxt_ulp_app_capabilities_info ulp_app_cap_info_list[];
419 * The ulp_cache_tbl_parms table provides the sizes of the cache tables the
420 * mapper must dynamically allocate during initialization.
422 extern struct bnxt_ulp_cache_tbl_params ulp_cache_tbl_params[];
425 * The ulp_generic_tbl_parms table provides the sizes of the generic tables the
426 * mapper must dynamically allocate during initialization.
428 extern struct bnxt_ulp_generic_tbl_params ulp_generic_tbl_params[];
430 * The ulp_global template table is used to initialize default entries
431 * that could be reused by other templates.
433 extern uint32_t ulp_glb_template_tbl[];
435 #endif /* _ULP_TEMPLATE_STRUCT_H_ */