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