adb2266d09352684cd085624b3d30a15383c7eca
[dpdk.git] / drivers / net / bnxt / tf_ulp / ulp_template_struct.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2014-2021 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     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_MAX          128
31 #define BNXT_ULP_PROTO_HDR_FIELD_SVIF_IDX       1
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         struct ulp_rte_act_bitmap       act_bitmap;
72         struct ulp_rte_act_prop         act_prop;
73         uint32_t                        dir_attr;
74         uint32_t                        priority;
75         uint32_t                        fid;
76         uint32_t                        parent_flow;
77         uint32_t                        parent_fid;
78         uint16_t                        func_id;
79         uint32_t                        class_id;
80         uint32_t                        act_tmpl;
81         struct bnxt_ulp_context         *ulp_ctx;
82         uint32_t                        hdr_sig_id;
83         uint32_t                        flow_sig_id;
84 };
85
86 /* Flow Parser Header Information Structure */
87 struct bnxt_ulp_rte_hdr_info {
88         enum bnxt_ulp_hdr_type                                  hdr_type;
89         /* Flow Parser Protocol Header Function Prototype */
90         int (*proto_hdr_func)(const struct rte_flow_item        *item_list,
91                               struct ulp_rte_parser_params      *params);
92 };
93
94 /* Flow Parser Header Information Structure Array defined in template source*/
95 extern struct bnxt_ulp_rte_hdr_info     ulp_hdr_info[];
96
97 /* Flow Parser Action Information Structure */
98 struct bnxt_ulp_rte_act_info {
99         enum bnxt_ulp_act_type                                  act_type;
100         /* Flow Parser Protocol Action Function Prototype */
101         int32_t (*proto_act_func)
102                 (const struct rte_flow_action   *action_item,
103                  struct ulp_rte_parser_params   *params);
104 };
105
106 /* Flow Parser Action Information Structure Array defined in template source*/
107 extern struct bnxt_ulp_rte_act_info     ulp_act_info[];
108
109 /* Flow Matcher structures */
110 struct bnxt_ulp_header_match_info {
111         struct ulp_rte_hdr_bitmap               hdr_bitmap;
112         uint32_t                                start_idx;
113         uint32_t                                num_entries;
114         uint32_t                                class_tmpl_id;
115         uint32_t                                act_vnic;
116 };
117
118 struct ulp_rte_bitmap {
119         uint64_t        bits;
120 };
121
122 struct bnxt_ulp_class_match_info {
123         struct ulp_rte_bitmap   hdr_sig;
124         struct ulp_rte_bitmap   field_sig;
125         uint32_t                class_hid;
126         uint32_t                class_tid;
127         uint8_t                 act_vnic;
128         uint8_t                 wc_pri;
129         uint32_t                hdr_sig_id;
130         uint32_t                flow_sig_id;
131 };
132
133 /* Flow Matcher templates Structure for class entries */
134 extern uint16_t ulp_class_sig_tbl[];
135 extern struct bnxt_ulp_class_match_info ulp_class_match_list[];
136
137 /* Flow Matcher Action structures */
138 struct bnxt_ulp_action_match_info {
139         struct ulp_rte_act_bitmap               act_bitmap;
140         uint32_t                                act_tmpl_id;
141 };
142
143 struct bnxt_ulp_act_match_info {
144         struct ulp_rte_bitmap   act_sig;
145         uint32_t                act_hid;
146         uint32_t                act_tid;
147 };
148
149 /* Flow Matcher templates Structure for action entries */
150 extern  uint16_t ulp_act_sig_tbl[];
151 extern struct bnxt_ulp_act_match_info ulp_act_match_list[];
152
153 /* Device Specific Tables for mapper */
154 struct bnxt_ulp_mapper_cond_info {
155         enum bnxt_ulp_cond_opc cond_opcode;
156         uint32_t cond_operand;
157 };
158
159 struct bnxt_ulp_mapper_cond_list_info {
160         enum bnxt_ulp_cond_list_opc cond_list_opcode;
161         uint32_t cond_start_idx;
162         uint32_t cond_nums;
163 };
164
165 struct bnxt_ulp_template_device_tbls {
166         struct bnxt_ulp_mapper_tmpl_info *tmpl_list;
167         uint32_t tmpl_list_size;
168         struct bnxt_ulp_mapper_tbl_info *tbl_list;
169         uint32_t tbl_list_size;
170         struct bnxt_ulp_mapper_key_info *key_info_list;
171         uint32_t key_info_list_size;
172         struct bnxt_ulp_mapper_field_info *result_field_list;
173         uint32_t result_field_list_size;
174         struct bnxt_ulp_mapper_ident_info *ident_list;
175         uint32_t ident_list_size;
176         struct bnxt_ulp_mapper_cond_info *cond_list;
177         uint32_t cond_list_size;
178 };
179
180 /* Device specific parameters */
181 struct bnxt_ulp_device_params {
182         uint8_t                         description[16];
183         enum bnxt_ulp_byte_order        byte_order;
184         uint8_t                         encap_byte_swap;
185         uint8_t                         num_phy_ports;
186         uint32_t                        mark_db_lfid_entries;
187         uint64_t                        mark_db_gfid_entries;
188         uint64_t                        int_flow_db_num_entries;
189         uint64_t                        ext_flow_db_num_entries;
190         uint32_t                        flow_count_db_entries;
191         uint32_t                        fdb_parent_flow_entries;
192         uint32_t                        num_resources_per_flow;
193         uint32_t                        ext_cntr_table_type;
194         uint64_t                        byte_count_mask;
195         uint64_t                        packet_count_mask;
196         uint32_t                        byte_count_shift;
197         uint32_t                        packet_count_shift;
198         const struct bnxt_ulp_template_device_tbls *dev_tbls;
199 };
200
201 /* Flow Mapper */
202 struct bnxt_ulp_mapper_tmpl_info {
203         uint32_t                device_name;
204         uint32_t                start_tbl_idx;
205         uint32_t                num_tbls;
206         struct bnxt_ulp_mapper_cond_list_info reject_info;
207 };
208
209 struct bnxt_ulp_mapper_tbl_info {
210         enum bnxt_ulp_resource_func     resource_func;
211         uint32_t                        resource_type; /* TF_ enum type */
212         enum bnxt_ulp_resource_sub_type resource_sub_type;
213         struct bnxt_ulp_mapper_cond_list_info execute_info;
214         enum bnxt_ulp_cond_opc cond_opcode;
215         uint32_t cond_operand;
216         enum bnxt_ulp_mem_type_opc      mem_type_opcode;
217         uint8_t                         direction;
218         enum bnxt_ulp_pri_opc           pri_opcode;
219         uint32_t                        pri_operand;
220
221         /* conflict resolution opcode */
222         enum bnxt_ulp_accept_opc        accept_opcode;
223
224         enum bnxt_ulp_critical_resource         critical_resource;
225
226         /* Information for accessing the ulp_key_field_list */
227         uint32_t        key_start_idx;
228         uint16_t        key_bit_size;
229         uint16_t        key_num_fields;
230         /* Size of the blob that holds the key */
231         uint16_t        blob_key_bit_size;
232
233         /* Information for accessing the ulp_class_result_field_list */
234         uint32_t        result_start_idx;
235         uint16_t        result_bit_size;
236         uint16_t        result_num_fields;
237         uint16_t        encap_num_fields;
238
239         /* Information for accessing the ulp_ident_list */
240         uint32_t        ident_start_idx;
241         uint16_t        ident_nums;
242
243         enum bnxt_ulp_mark_db_opc       mark_db_opcode;
244
245         /* Table opcode for table operations */
246         uint32_t                        tbl_opcode;
247         uint32_t                        tbl_operand;
248
249         /* FDB table opcode */
250         enum bnxt_ulp_fdb_opc           fdb_opcode;
251         uint32_t                        fdb_operand;
252 };
253
254 struct bnxt_ulp_mapper_field_info {
255         uint8_t                 description[64];
256         enum bnxt_ulp_field_opc field_opcode;
257         uint16_t                field_bit_size;
258         uint8_t                 field_operand[16];
259         uint8_t                 field_operand_true[16];
260         uint8_t                 field_operand_false[16];
261 };
262
263 struct bnxt_ulp_mapper_key_info {
264         struct bnxt_ulp_mapper_field_info       field_info_spec;
265         struct bnxt_ulp_mapper_field_info       field_info_mask;
266 };
267
268 struct bnxt_ulp_mapper_ident_info {
269         uint8_t         description[64];
270         uint32_t        resource_func;
271
272         uint16_t        ident_type;
273         uint16_t        ident_bit_size;
274         uint16_t        ident_bit_pos;
275         enum bnxt_ulp_rf_idx    regfile_idx;
276 };
277
278 struct bnxt_ulp_glb_resource_info {
279         enum bnxt_ulp_resource_func     resource_func;
280         uint32_t                        resource_type; /* TF_ enum type */
281         enum bnxt_ulp_glb_rf_idx        glb_regfile_index;
282         enum tf_dir                     direction;
283 };
284
285 struct bnxt_ulp_cache_tbl_params {
286         uint16_t num_entries;
287 };
288
289 struct bnxt_ulp_generic_tbl_params {
290         uint16_t                        result_num_entries;
291         uint16_t                        result_num_bytes;
292         enum bnxt_ulp_byte_order        result_byte_order;
293 };
294
295 struct bnxt_ulp_shared_act_info {
296         uint64_t act_bitmask;
297 };
298
299 /*
300  * Flow Mapper Static Data Externs:
301  * Access to the below static data should be done through access functions and
302  * directly throughout the code.
303  */
304
305 /*
306  * The ulp_device_params is indexed by the dev_id.
307  * This table maintains the device specific parameters.
308  */
309 extern struct bnxt_ulp_device_params ulp_device_params[];
310
311 /*
312  * The ulp_act_prop_map_table provides the mapping to index and size of action
313  * properties.
314  */
315 extern uint32_t ulp_act_prop_map_table[];
316
317 /*
318  * The ulp_glb_resource_tbl provides the list of global resources that need to
319  * be initialized and where to store them.
320  */
321 extern struct bnxt_ulp_glb_resource_info ulp_glb_resource_tbl[];
322
323 /*
324  * The ulp_cache_tbl_parms table provides the sizes of the cache tables the
325  * mapper must dynamically allocate during initialization.
326  */
327 extern struct bnxt_ulp_cache_tbl_params ulp_cache_tbl_params[];
328
329 /*
330  * The ulp_generic_tbl_parms table provides the sizes of the generic tables the
331  * mapper must dynamically allocate during initialization.
332  */
333 extern struct bnxt_ulp_generic_tbl_params ulp_generic_tbl_params[];
334 /*
335  * The ulp_global template table is used to initialize default entries
336  * that could be reused by other templates.
337  */
338 extern uint32_t ulp_glb_template_tbl[];
339
340 #endif /* _ULP_TEMPLATE_STRUCT_H_ */