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_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
  35
  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
  40
  41 struct ulp_rte_hdr_bitmap {
  42         uint64_t        bits;
  43 };
  44
  45 struct ulp_rte_field_bitmap {
  46         uint64_t        bits;
  47 };
  48
  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];
  54         uint32_t        size;
  55 };
  56
  57 struct ulp_rte_act_bitmap {
  58         uint64_t        bits;
  59 };
  60
  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];
  64 };
  65
  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];
  76         uint32_t                        field_idx;
  77         struct ulp_rte_act_bitmap       act_bitmap;
  78         struct ulp_rte_act_prop         act_prop;
  79         uint32_t                        dir_attr;
  80         uint32_t                        priority;
  81         uint32_t                        fid;
  82         uint32_t                        parent_flow;
  83         uint32_t                        child_flow;
  84         uint16_t                        func_id;
  85         uint16_t                        port_id;
  86         uint32_t                        class_id;
  87         uint32_t                        act_tmpl;
  88         struct bnxt_ulp_context         *ulp_ctx;
  89         uint32_t                        hdr_sig_id;
  90         uint64_t                        flow_sig_id;
  91         uint32_t                        flow_pattern_id;
  92         uint32_t                        act_pattern_id;
  93         uint8_t                         app_id;
  94         uint8_t                         tun_idx;
  95
  96 };
  97
  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);
 104 };
 105
 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[];
 109
 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);
 117 };
 118
 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[];
 122
 123 /* Flow Matcher structures */
 124 struct bnxt_ulp_header_match_info {
 125         struct ulp_rte_hdr_bitmap               hdr_bitmap;
 126         uint32_t                                start_idx;
 127         uint32_t                                num_entries;
 128         uint32_t                                class_tmpl_id;
 129         uint32_t                                act_vnic;
 130 };
 131
 132 struct ulp_rte_bitmap {
 133         uint64_t        bits;
 134 };
 135
 136 struct bnxt_ulp_class_match_info {
 137         struct ulp_rte_bitmap   hdr_sig;
 138         struct ulp_rte_bitmap   field_sig;
 139         uint32_t                class_hid;
 140         uint32_t                class_tid;
 141         uint8_t                 act_vnic;
 142         uint8_t                 wc_pri;
 143         uint8_t                 app_sig;
 144         uint32_t                hdr_sig_id;
 145         uint64_t                flow_sig_id;
 146         uint32_t                flow_pattern_id;
 147 };
 148
 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[];
 152
 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;
 157 };
 158
 159 struct bnxt_ulp_act_match_info {
 160         struct ulp_rte_bitmap   act_sig;
 161         uint32_t                act_hid;
 162         uint32_t                act_tid;
 163         uint32_t                act_pattern_id;
 164         uint8_t                 app_sig;
 165 };
 166
 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[];
 170
 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;
 175 };
 176
 177 struct bnxt_ulp_mapper_cond_list_info {
 178         enum bnxt_ulp_cond_list_opc cond_list_opcode;
 179         uint32_t cond_start_idx;
 180         uint32_t cond_nums;
 181         int32_t cond_true_goto;
 182         int32_t cond_false_goto;
 183 };
 184
 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;
 189         uint16_t                        func_opr1;
 190         uint16_t                        func_opr2;
 191         uint16_t                        func_dst_opr;
 192 };
 193
 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;
 207 };
 208
 209 struct bnxt_ulp_dyn_size_map {
 210         uint32_t                slab_size;
 211         enum tf_tbl_type        tbl_type;
 212 };
 213
 214 /* Device specific parameters */
 215 struct bnxt_ulp_device_params {
 216         uint8_t                         description[16];
 217         enum bnxt_ulp_byte_order        key_byte_order;
 218         enum bnxt_ulp_byte_order        result_byte_order;
 219         enum bnxt_ulp_byte_order        encap_byte_order;
 220         enum bnxt_ulp_byte_order        wc_key_byte_order;
 221         enum bnxt_ulp_byte_order        em_byte_order;
 222         uint8_t                         encap_byte_swap;
 223         uint8_t                         num_phy_ports;
 224         uint32_t                        mark_db_lfid_entries;
 225         uint64_t                        mark_db_gfid_entries;
 226         uint64_t                        int_flow_db_num_entries;
 227         uint64_t                        ext_flow_db_num_entries;
 228         uint32_t                        flow_count_db_entries;
 229         uint32_t                        fdb_parent_flow_entries;
 230         uint32_t                        num_resources_per_flow;
 231         uint32_t                        ext_cntr_table_type;
 232         uint64_t                        byte_count_mask;
 233         uint64_t                        packet_count_mask;
 234         uint32_t                        byte_count_shift;
 235         uint32_t                        packet_count_shift;
 236         uint32_t                        dynamic_pad_en;
 237         uint32_t                        dynamic_sram_en;
 238         uint32_t                        dyn_encap_list_size;
 239         struct bnxt_ulp_dyn_size_map    dyn_encap_sizes[4];
 240         uint32_t                        dyn_modify_list_size;
 241         struct bnxt_ulp_dyn_size_map    dyn_modify_sizes[4];
 242         uint16_t                        em_blk_size_bits;
 243         uint16_t                        em_blk_align_bits;
 244         uint16_t                        em_key_align_bytes;
 245         uint16_t                        em_result_size_bits;
 246         uint16_t                        wc_slice_width;
 247         uint16_t                        wc_max_slices;
 248         uint32_t                        wc_mode_list[4];
 249         uint32_t                        wc_mod_list_max_size;
 250         uint32_t                        wc_ctl_size_bits;
 251         const struct bnxt_ulp_template_device_tbls *dev_tbls;
 252 };
 253
 254 /* Flow Mapper */
 255 struct bnxt_ulp_mapper_tmpl_info {
 256         uint32_t                device_name;
 257         uint32_t                start_tbl_idx;
 258         uint32_t                num_tbls;
 259         struct bnxt_ulp_mapper_cond_list_info reject_info;
 260 };
 261
 262 struct bnxt_ulp_mapper_tbl_info {
 263         enum bnxt_ulp_resource_func     resource_func;
 264         uint32_t                        resource_type; /* TF_ enum type */
 265         enum bnxt_ulp_resource_sub_type resource_sub_type;
 266         struct bnxt_ulp_mapper_cond_list_info execute_info;
 267         struct bnxt_ulp_mapper_func_info func_info;
 268         enum bnxt_ulp_cond_opc cond_opcode;
 269         uint32_t cond_operand;
 270         uint8_t                         direction;
 271         enum bnxt_ulp_pri_opc           pri_opcode;
 272         uint32_t                        pri_operand;
 273
 274         /* conflict resolution opcode */
 275         enum bnxt_ulp_accept_opc        accept_opcode;
 276
 277         enum bnxt_ulp_critical_resource         critical_resource;
 278
 279         /* Information for accessing the ulp_key_field_list */
 280         uint32_t        key_start_idx;
 281         uint16_t        key_bit_size;
 282         uint16_t        key_num_fields;
 283         /* Size of the blob that holds the key */
 284         uint16_t        blob_key_bit_size;
 285         uint16_t        record_size;
 286
 287         /* Information for accessing the ulp_class_result_field_list */
 288         uint32_t        result_start_idx;
 289         uint16_t        result_bit_size;
 290         uint16_t        result_num_fields;
 291         uint16_t        encap_num_fields;
 292
 293         /* Information for accessing the ulp_ident_list */
 294         uint32_t        ident_start_idx;
 295         uint16_t        ident_nums;
 296
 297         enum bnxt_ulp_mark_db_opc       mark_db_opcode;
 298
 299         /* Table opcode for table operations */
 300         uint32_t                        tbl_opcode;
 301         uint32_t                        tbl_operand;
 302         enum bnxt_ulp_generic_tbl_lkup_type gen_tbl_lkup_type;
 303
 304         /* FDB table opcode */
 305         enum bnxt_ulp_fdb_opc           fdb_opcode;
 306         uint32_t                        fdb_operand;
 307
 308         /* Shared session */
 309         enum bnxt_ulp_shared_session    shared_session;
 310 };
 311
 312 struct bnxt_ulp_mapper_field_info {
 313         uint8_t                         description[64];
 314         uint16_t                        field_bit_size;
 315         enum bnxt_ulp_field_opc         field_opc;
 316         enum bnxt_ulp_field_src         field_src1;
 317         uint8_t                         field_opr1[16];
 318         enum bnxt_ulp_field_src         field_src2;
 319         uint8_t                         field_opr2[16];
 320         enum bnxt_ulp_field_src         field_src3;
 321         uint8_t                         field_opr3[16];
 322 };
 323
 324 struct bnxt_ulp_mapper_key_info {
 325         struct bnxt_ulp_mapper_field_info       field_info_spec;
 326         struct bnxt_ulp_mapper_field_info       field_info_mask;
 327 };
 328
 329 struct bnxt_ulp_mapper_ident_info {
 330         uint8_t         description[64];
 331         uint32_t        resource_func;
 332
 333         uint16_t        ident_type;
 334         uint16_t        ident_bit_size;
 335         uint16_t        ident_bit_pos;
 336         enum bnxt_ulp_rf_idx    regfile_idx;
 337 };
 338
 339 struct bnxt_ulp_glb_resource_info {
 340         uint8_t                         app_id;
 341         enum bnxt_ulp_device_id         device_id;
 342         enum tf_dir                     direction;
 343         enum bnxt_ulp_resource_func     resource_func;
 344         uint32_t                        resource_type; /* TF_ enum type */
 345         enum bnxt_ulp_glb_rf_idx        glb_regfile_index;
 346 };
 347
 348 struct bnxt_ulp_resource_resv_info {
 349         uint8_t                         app_id;
 350         enum bnxt_ulp_device_id         device_id;
 351         enum tf_dir                     direction;
 352         enum bnxt_ulp_resource_func     resource_func;
 353         uint32_t                        resource_type; /* TF_ enum type */
 354         uint32_t                        count;
 355 };
 356
 357 struct bnxt_ulp_app_capabilities_info {
 358         uint8_t                         app_id;
 359         enum bnxt_ulp_device_id         device_id;
 360         uint32_t                        flags;
 361 };
 362
 363 struct bnxt_ulp_cache_tbl_params {
 364         uint16_t num_entries;
 365 };
 366
 367 struct bnxt_ulp_generic_tbl_params {
 368         const char                      *name;
 369         uint16_t                        result_num_entries;
 370         uint16_t                        result_num_bytes;
 371         enum bnxt_ulp_byte_order        result_byte_order;
 372         uint32_t                        hash_tbl_entries;
 373         uint16_t                        num_buckets;
 374         uint16_t                        key_num_bytes;
 375 };
 376
 377 struct bnxt_ulp_shared_act_info {
 378         uint64_t act_bitmask;
 379 };
 380
 381 /*
 382  * Flow Mapper Static Data Externs:
 383  * Access to the below static data should be done through access functions and
 384  * directly throughout the code.
 385  */
 386
 387 /*
 388  * The ulp_device_params is indexed by the dev_id.
 389  * This table maintains the device specific parameters.
 390  */
 391 extern struct bnxt_ulp_device_params ulp_device_params[];
 392
 393 /*
 394  * The ulp_act_prop_map_table provides the mapping to index and size of action
 395  * properties.
 396  */
 397 extern uint32_t ulp_act_prop_map_table[];
 398
 399 /*
 400  * The ulp_glb_resource_tbl provides the list of global resources that need to
 401  * be initialized and where to store them.
 402  */
 403 extern struct bnxt_ulp_glb_resource_info ulp_glb_resource_tbl[];
 404
 405 /*
 406  * The ulp_app_glb_resource_tbl provides the list of shared resources required
 407  * in the event that shared session is enabled.
 408  */
 409 extern struct bnxt_ulp_glb_resource_info ulp_app_glb_resource_tbl[];
 410
 411 /*
 412  * The ulp_resource_resv_list provides the list of tf resources required when
 413  * calling tf_open.
 414  */
 415 extern struct bnxt_ulp_resource_resv_info ulp_resource_resv_list[];
 416
 417 /*
 418  * The ulp_app_resource_resv_list provides the list of tf resources required
 419  * when calling tf_open.
 420  */
 421 extern struct bnxt_ulp_resource_resv_info ulp_app_resource_resv_list[];
 422
 423 /*
 424  * The_app_cap_info_list provides the list of ULP capabilities per app/device.
 425  */
 426 extern struct bnxt_ulp_app_capabilities_info ulp_app_cap_info_list[];
 427
 428 /*
 429  * The ulp_cache_tbl_parms table provides the sizes of the cache tables the
 430  * mapper must dynamically allocate during initialization.
 431  */
 432 extern struct bnxt_ulp_cache_tbl_params ulp_cache_tbl_params[];
 433
 434 /*
 435  * The ulp_generic_tbl_parms table provides the sizes of the generic tables the
 436  * mapper must dynamically allocate during initialization.
 437  */
 438 extern struct bnxt_ulp_generic_tbl_params ulp_generic_tbl_params[];
 439 /*
 440  * The ulp_global template table is used to initialize default entries
 441  * that could be reused by other templates.
 442  */
 443 extern uint32_t ulp_glb_template_tbl[];
 444
 445 #endif /* _ULP_TEMPLATE_STRUCT_H_ */