1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2014-2019 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 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
33 struct ulp_rte_hdr_bitmap {
37 struct ulp_rte_field_bitmap {
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];
49 struct ulp_rte_act_bitmap {
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];
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_CF_IDX_LAST];
66 struct ulp_rte_act_bitmap act_bitmap;
67 struct ulp_rte_act_prop act_prop;
69 struct bnxt_ulp_context *ulp_ctx;
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);
80 /* Flow Parser Header Information Structure Array defined in template source*/
81 extern struct bnxt_ulp_rte_hdr_info ulp_hdr_info[];
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);
92 /* Flow Parser Action Information Structure Array defined in template source*/
93 extern struct bnxt_ulp_rte_act_info ulp_act_info[];
95 /* Flow Matcher structures */
96 struct bnxt_ulp_header_match_info {
97 struct ulp_rte_hdr_bitmap hdr_bitmap;
100 uint32_t class_tmpl_id;
104 struct ulp_rte_bitmap {
108 struct bnxt_ulp_class_match_info {
109 struct ulp_rte_bitmap hdr_sig;
110 struct ulp_rte_bitmap field_sig;
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[];
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;
127 struct bnxt_ulp_act_match_info {
128 struct ulp_rte_bitmap act_sig;
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[];
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;
148 uint32_t num_resources_per_flow;
152 struct bnxt_ulp_mapper_tbl_list_info {
153 uint32_t device_name;
154 uint32_t start_tbl_idx;
158 struct bnxt_ulp_mapper_class_tbl_info {
159 enum bnxt_ulp_resource_func resource_func;
163 uint8_t srch_b4_alloc;
164 uint32_t critical_resource;
166 /* Information for accessing the ulp_key_field_list */
167 uint32_t key_start_idx;
168 uint16_t key_bit_size;
169 uint16_t key_num_fields;
170 /* Size of the blob that holds the key */
171 uint16_t blob_key_bit_size;
173 /* Information for accessing the ulp_class_result_field_list */
174 uint32_t result_start_idx;
175 uint16_t result_bit_size;
176 uint16_t result_num_fields;
178 /* Information for accessing the ulp_ident_list */
179 uint32_t ident_start_idx;
183 enum bnxt_ulp_regfile_index regfile_wr_idx;
185 enum bnxt_ulp_cache_tbl_id cache_tbl_id;
188 struct bnxt_ulp_mapper_act_tbl_info {
189 enum bnxt_ulp_resource_func resource_func;
190 enum tf_tbl_type table_type;
192 uint8_t srch_b4_alloc;
193 uint32_t result_start_idx;
194 uint16_t result_bit_size;
195 uint16_t encap_num_fields;
196 uint16_t result_num_fields;
198 enum bnxt_ulp_regfile_index regfile_wr_idx;
201 struct bnxt_ulp_mapper_class_key_field_info {
202 uint8_t description[64];
203 enum bnxt_ulp_mask_opc mask_opcode;
204 enum bnxt_ulp_spec_opc spec_opcode;
205 uint16_t field_bit_size;
206 uint8_t mask_operand[16];
207 uint8_t spec_operand[16];
210 struct bnxt_ulp_mapper_result_field_info {
211 uint8_t description[64];
212 enum bnxt_ulp_result_opc result_opcode;
213 uint16_t field_bit_size;
214 uint8_t result_operand[16];
217 struct bnxt_ulp_mapper_ident_info {
218 uint8_t description[64];
219 uint32_t resource_func;
222 uint16_t ident_bit_size;
223 uint16_t ident_bit_pos;
224 enum bnxt_ulp_regfile_index regfile_wr_idx;
227 struct bnxt_ulp_glb_resource_info {
228 enum bnxt_ulp_resource_func resource_func;
229 uint32_t resource_type; /* TF_ enum type */
230 enum bnxt_ulp_glb_regfile_index glb_regfile_index;
231 enum tf_dir direction;
234 struct bnxt_ulp_cache_tbl_params {
235 uint16_t num_entries;
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.
245 * The ulp_device_params is indexed by the dev_id.
246 * This table maintains the device specific parameters.
248 extern struct bnxt_ulp_device_params ulp_device_params[];
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.
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[];
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
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[];
269 * The ulp_class_result_field_list provides the instructions for creating result
270 * records such as tcam/em results.
272 extern struct bnxt_ulp_mapper_result_field_info ulp_class_result_field_list[];
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
280 struct bnxt_ulp_mapper_result_field_info ulp_act_result_field_list[];
283 * The ulp_act_prop_map_table provides the mapping to index and size of action
284 * tcam and em tables.
287 struct bnxt_ulp_mapper_class_key_field_info ulp_class_key_field_list[];
290 * The ulp_ident_list provides the instructions for creating identifiers such
293 extern struct bnxt_ulp_mapper_ident_info ulp_ident_list[];
296 * The ulp_act_prop_map_table provides the mapping to index and size of action
299 extern uint32_t ulp_act_prop_map_table[];
302 * The ulp_glb_resource_tbl provides the list of global resources that need to
303 * be initialized and where to store them.
305 extern struct bnxt_ulp_glb_resource_info ulp_glb_resource_tbl[];
308 * The ulp_cache_tbl_parms table provides the sizes of the cache tables the
309 * mapper must dynamically allocate during initialization.
311 extern struct bnxt_ulp_cache_tbl_params ulp_cache_tbl_params[];
313 #endif /* _ULP_TEMPLATE_STRUCT_H_ */