02dfb04558323849de7b22163db7e468cbe14fab
[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         uint32_t cond_goto;
164 };
165
166 struct bnxt_ulp_template_device_tbls {
167         struct bnxt_ulp_mapper_tmpl_info *tmpl_list;
168         uint32_t tmpl_list_size;
169         struct bnxt_ulp_mapper_tbl_info *tbl_list;
170         uint32_t tbl_list_size;
171         struct bnxt_ulp_mapper_key_info *key_info_list;
172         uint32_t key_info_list_size;
173         struct bnxt_ulp_mapper_field_info *result_field_list;
174         uint32_t result_field_list_size;
175         struct bnxt_ulp_mapper_ident_info *ident_list;
176         uint32_t ident_list_size;
177         struct bnxt_ulp_mapper_cond_info *cond_list;
178         uint32_t cond_list_size;
179 };
180
181 /* Device specific parameters */
182 struct bnxt_ulp_device_params {
183         uint8_t                         description[16];
184         enum bnxt_ulp_byte_order        byte_order;
185         uint8_t                         encap_byte_swap;
186         uint8_t                         num_phy_ports;
187         uint32_t                        mark_db_lfid_entries;
188         uint64_t                        mark_db_gfid_entries;
189         uint64_t                        int_flow_db_num_entries;
190         uint64_t                        ext_flow_db_num_entries;
191         uint32_t                        flow_count_db_entries;
192         uint32_t                        fdb_parent_flow_entries;
193         uint32_t                        num_resources_per_flow;
194         uint32_t                        ext_cntr_table_type;
195         uint64_t                        byte_count_mask;
196         uint64_t                        packet_count_mask;
197         uint32_t                        byte_count_shift;
198         uint32_t                        packet_count_shift;
199         const struct bnxt_ulp_template_device_tbls *dev_tbls;
200 };
201
202 /* Flow Mapper */
203 struct bnxt_ulp_mapper_tmpl_info {
204         uint32_t                device_name;
205         uint32_t                start_tbl_idx;
206         uint32_t                num_tbls;
207         struct bnxt_ulp_mapper_cond_list_info reject_info;
208 };
209
210 struct bnxt_ulp_mapper_tbl_info {
211         enum bnxt_ulp_resource_func     resource_func;
212         uint32_t                        resource_type; /* TF_ enum type */
213         enum bnxt_ulp_resource_sub_type resource_sub_type;
214         struct bnxt_ulp_mapper_cond_list_info execute_info;
215         enum bnxt_ulp_cond_opc cond_opcode;
216         uint32_t cond_operand;
217         enum bnxt_ulp_mem_type_opc      mem_type_opcode;
218         uint8_t                         direction;
219         enum bnxt_ulp_pri_opc           pri_opcode;
220         uint32_t                        pri_operand;
221
222         /* conflict resolution opcode */
223         enum bnxt_ulp_accept_opc        accept_opcode;
224
225         enum bnxt_ulp_critical_resource         critical_resource;
226
227         /* Information for accessing the ulp_key_field_list */
228         uint32_t        key_start_idx;
229         uint16_t        key_bit_size;
230         uint16_t        key_num_fields;
231         /* Size of the blob that holds the key */
232         uint16_t        blob_key_bit_size;
233
234         /* Information for accessing the ulp_class_result_field_list */
235         uint32_t        result_start_idx;
236         uint16_t        result_bit_size;
237         uint16_t        result_num_fields;
238         uint16_t        encap_num_fields;
239
240         /* Information for accessing the ulp_ident_list */
241         uint32_t        ident_start_idx;
242         uint16_t        ident_nums;
243
244         enum bnxt_ulp_mark_db_opc       mark_db_opcode;
245
246         /* Table opcode for table operations */
247         uint32_t                        tbl_opcode;
248         uint32_t                        tbl_operand;
249
250         /* FDB table opcode */
251         enum bnxt_ulp_fdb_opc           fdb_opcode;
252         uint32_t                        fdb_operand;
253 };
254
255 struct bnxt_ulp_mapper_field_info {
256         uint8_t                         description[64];
257         uint16_t                        field_bit_size;
258         enum bnxt_ulp_field_cond_src    field_cond_src;
259         uint8_t                         field_cond_opr[16];
260         enum bnxt_ulp_field_src         field_src1;
261         uint8_t                         field_opr1[16];
262         enum bnxt_ulp_field_src         field_src2;
263         uint8_t                         field_opr2[16];
264
265 };
266
267 struct bnxt_ulp_mapper_key_info {
268         struct bnxt_ulp_mapper_field_info       field_info_spec;
269         struct bnxt_ulp_mapper_field_info       field_info_mask;
270 };
271
272 struct bnxt_ulp_mapper_ident_info {
273         uint8_t         description[64];
274         uint32_t        resource_func;
275
276         uint16_t        ident_type;
277         uint16_t        ident_bit_size;
278         uint16_t        ident_bit_pos;
279         enum bnxt_ulp_rf_idx    regfile_idx;
280 };
281
282 struct bnxt_ulp_glb_resource_info {
283         enum bnxt_ulp_resource_func     resource_func;
284         uint32_t                        resource_type; /* TF_ enum type */
285         enum bnxt_ulp_glb_rf_idx        glb_regfile_index;
286         enum tf_dir                     direction;
287 };
288
289 struct bnxt_ulp_cache_tbl_params {
290         uint16_t num_entries;
291 };
292
293 struct bnxt_ulp_generic_tbl_params {
294         uint16_t                        result_num_entries;
295         uint16_t                        result_num_bytes;
296         enum bnxt_ulp_byte_order        result_byte_order;
297 };
298
299 struct bnxt_ulp_shared_act_info {
300         uint64_t act_bitmask;
301 };
302
303 /*
304  * Flow Mapper Static Data Externs:
305  * Access to the below static data should be done through access functions and
306  * directly throughout the code.
307  */
308
309 /*
310  * The ulp_device_params is indexed by the dev_id.
311  * This table maintains the device specific parameters.
312  */
313 extern struct bnxt_ulp_device_params ulp_device_params[];
314
315 /*
316  * The ulp_act_prop_map_table provides the mapping to index and size of action
317  * properties.
318  */
319 extern uint32_t ulp_act_prop_map_table[];
320
321 /*
322  * The ulp_glb_resource_tbl provides the list of global resources that need to
323  * be initialized and where to store them.
324  */
325 extern struct bnxt_ulp_glb_resource_info ulp_glb_resource_tbl[];
326
327 /*
328  * The ulp_cache_tbl_parms table provides the sizes of the cache tables the
329  * mapper must dynamically allocate during initialization.
330  */
331 extern struct bnxt_ulp_cache_tbl_params ulp_cache_tbl_params[];
332
333 /*
334  * The ulp_generic_tbl_parms table provides the sizes of the generic tables the
335  * mapper must dynamically allocate during initialization.
336  */
337 extern struct bnxt_ulp_generic_tbl_params ulp_generic_tbl_params[];
338 /*
339  * The ulp_global template table is used to initialize default entries
340  * that could be reused by other templates.
341  */
342 extern uint32_t ulp_glb_template_tbl[];
343
344 #endif /* _ULP_TEMPLATE_STRUCT_H_ */