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 /* Device specific parameters */
 210 struct bnxt_ulp_device_params {
 211         uint8_t                         description[16];
 212         enum bnxt_ulp_byte_order        key_byte_order;
 213         enum bnxt_ulp_byte_order        result_byte_order;
 214         enum bnxt_ulp_byte_order        encap_byte_order;
 215         enum bnxt_ulp_byte_order        wc_key_byte_order;
 216         uint8_t                         encap_byte_swap;
 217         uint8_t                         num_phy_ports;
 218         uint32_t                        mark_db_lfid_entries;
 219         uint64_t                        mark_db_gfid_entries;
 220         uint64_t                        int_flow_db_num_entries;
 221         uint64_t                        ext_flow_db_num_entries;
 222         uint32_t                        flow_count_db_entries;
 223         uint32_t                        fdb_parent_flow_entries;
 224         uint32_t                        num_resources_per_flow;
 225         uint32_t                        ext_cntr_table_type;
 226         uint64_t                        byte_count_mask;
 227         uint64_t                        packet_count_mask;
 228         uint32_t                        byte_count_shift;
 229         uint32_t                        packet_count_shift;
 230         uint32_t                        dynamic_pad_en;
 231         uint16_t                        em_blk_size_bits;
 232         uint16_t                        em_blk_align_bits;
 233         uint16_t                        em_key_align_bytes;
 234         uint16_t                        em_result_size_bits;
 235         uint16_t                        wc_slice_width;
 236         uint16_t                        wc_max_slices;
 237         uint32_t                        wc_mode_list[4];
 238         uint32_t                        wc_mod_list_max_size;
 239         uint32_t                        wc_ctl_size_bits;
 240         const struct bnxt_ulp_template_device_tbls *dev_tbls;
 241 };
 242
 243 /* Flow Mapper */
 244 struct bnxt_ulp_mapper_tmpl_info {
 245         uint32_t                device_name;
 246         uint32_t                start_tbl_idx;
 247         uint32_t                num_tbls;
 248         struct bnxt_ulp_mapper_cond_list_info reject_info;
 249 };
 250
 251 struct bnxt_ulp_mapper_tbl_info {
 252         enum bnxt_ulp_resource_func     resource_func;
 253         uint32_t                        resource_type; /* TF_ enum type */
 254         enum bnxt_ulp_resource_sub_type resource_sub_type;
 255         struct bnxt_ulp_mapper_cond_list_info execute_info;
 256         struct bnxt_ulp_mapper_func_info func_info;
 257         enum bnxt_ulp_cond_opc cond_opcode;
 258         uint32_t cond_operand;
 259         uint8_t                         direction;
 260         enum bnxt_ulp_pri_opc           pri_opcode;
 261         uint32_t                        pri_operand;
 262
 263         /* conflict resolution opcode */
 264         enum bnxt_ulp_accept_opc        accept_opcode;
 265
 266         enum bnxt_ulp_critical_resource         critical_resource;
 267
 268         /* Information for accessing the ulp_key_field_list */
 269         uint32_t        key_start_idx;
 270         uint16_t        key_bit_size;
 271         uint16_t        key_num_fields;
 272         /* Size of the blob that holds the key */
 273         uint16_t        blob_key_bit_size;
 274         uint16_t        record_size;
 275
 276         /* Information for accessing the ulp_class_result_field_list */
 277         uint32_t        result_start_idx;
 278         uint16_t        result_bit_size;
 279         uint16_t        result_num_fields;
 280         uint16_t        encap_num_fields;
 281
 282         /* Information for accessing the ulp_ident_list */
 283         uint32_t        ident_start_idx;
 284         uint16_t        ident_nums;
 285
 286         enum bnxt_ulp_mark_db_opc       mark_db_opcode;
 287
 288         /* Table opcode for table operations */
 289         uint32_t                        tbl_opcode;
 290         uint32_t                        tbl_operand;
 291         enum bnxt_ulp_generic_tbl_lkup_type gen_tbl_lkup_type;
 292
 293         /* FDB table opcode */
 294         enum bnxt_ulp_fdb_opc           fdb_opcode;
 295         uint32_t                        fdb_operand;
 296
 297         /* Shared session */
 298         enum bnxt_ulp_shared_session    shared_session;
 299 };
 300
 301 struct bnxt_ulp_mapper_field_info {
 302         uint8_t                         description[64];
 303         uint16_t                        field_bit_size;
 304         enum bnxt_ulp_field_opc         field_opc;
 305         enum bnxt_ulp_field_src         field_src1;
 306         uint8_t                         field_opr1[16];
 307         enum bnxt_ulp_field_src         field_src2;
 308         uint8_t                         field_opr2[16];
 309         enum bnxt_ulp_field_src         field_src3;
 310         uint8_t                         field_opr3[16];
 311 };
 312
 313 struct bnxt_ulp_mapper_key_info {
 314         struct bnxt_ulp_mapper_field_info       field_info_spec;
 315         struct bnxt_ulp_mapper_field_info       field_info_mask;
 316 };
 317
 318 struct bnxt_ulp_mapper_ident_info {
 319         uint8_t         description[64];
 320         uint32_t        resource_func;
 321
 322         uint16_t        ident_type;
 323         uint16_t        ident_bit_size;
 324         uint16_t        ident_bit_pos;
 325         enum bnxt_ulp_rf_idx    regfile_idx;
 326 };
 327
 328 struct bnxt_ulp_glb_resource_info {
 329         uint8_t                         app_id;
 330         enum bnxt_ulp_device_id         device_id;
 331         enum tf_dir                     direction;
 332         enum bnxt_ulp_resource_func     resource_func;
 333         uint32_t                        resource_type; /* TF_ enum type */
 334         enum bnxt_ulp_glb_rf_idx        glb_regfile_index;
 335 };
 336
 337 struct bnxt_ulp_resource_resv_info {
 338         uint8_t                         app_id;
 339         enum bnxt_ulp_device_id         device_id;
 340         enum tf_dir                     direction;
 341         enum bnxt_ulp_resource_func     resource_func;
 342         uint32_t                        resource_type; /* TF_ enum type */
 343         uint32_t                        count;
 344 };
 345
 346 struct bnxt_ulp_app_capabilities_info {
 347         uint8_t                         app_id;
 348         enum bnxt_ulp_device_id         device_id;
 349         uint32_t                        flags;
 350 };
 351
 352 struct bnxt_ulp_cache_tbl_params {
 353         uint16_t num_entries;
 354 };
 355
 356 struct bnxt_ulp_generic_tbl_params {
 357         const char                      *name;
 358         uint16_t                        result_num_entries;
 359         uint16_t                        result_num_bytes;
 360         enum bnxt_ulp_byte_order        result_byte_order;
 361         uint32_t                        hash_tbl_entries;
 362         uint16_t                        num_buckets;
 363         uint16_t                        key_num_bytes;
 364 };
 365
 366 struct bnxt_ulp_shared_act_info {
 367         uint64_t act_bitmask;
 368 };
 369
 370 /*
 371  * Flow Mapper Static Data Externs:
 372  * Access to the below static data should be done through access functions and
 373  * directly throughout the code.
 374  */
 375
 376 /*
 377  * The ulp_device_params is indexed by the dev_id.
 378  * This table maintains the device specific parameters.
 379  */
 380 extern struct bnxt_ulp_device_params ulp_device_params[];
 381
 382 /*
 383  * The ulp_act_prop_map_table provides the mapping to index and size of action
 384  * properties.
 385  */
 386 extern uint32_t ulp_act_prop_map_table[];
 387
 388 /*
 389  * The ulp_glb_resource_tbl provides the list of global resources that need to
 390  * be initialized and where to store them.
 391  */
 392 extern struct bnxt_ulp_glb_resource_info ulp_glb_resource_tbl[];
 393
 394 /*
 395  * The ulp_app_glb_resource_tbl provides the list of shared resources required
 396  * in the event that shared session is enabled.
 397  */
 398 extern struct bnxt_ulp_glb_resource_info ulp_app_glb_resource_tbl[];
 399
 400 /*
 401  * The ulp_resource_resv_list provides the list of tf resources required when
 402  * calling tf_open.
 403  */
 404 extern struct bnxt_ulp_resource_resv_info ulp_resource_resv_list[];
 405
 406 /*
 407  * The ulp_app_resource_resv_list provides the list of tf resources required
 408  * when calling tf_open.
 409  */
 410 extern struct bnxt_ulp_resource_resv_info ulp_app_resource_resv_list[];
 411
 412 /*
 413  * The_app_cap_info_list provides the list of ULP capabilities per app/device.
 414  */
 415 extern struct bnxt_ulp_app_capabilities_info ulp_app_cap_info_list[];
 416
 417 /*
 418  * The ulp_cache_tbl_parms table provides the sizes of the cache tables the
 419  * mapper must dynamically allocate during initialization.
 420  */
 421 extern struct bnxt_ulp_cache_tbl_params ulp_cache_tbl_params[];
 422
 423 /*
 424  * The ulp_generic_tbl_parms table provides the sizes of the generic tables the
 425  * mapper must dynamically allocate during initialization.
 426  */
 427 extern struct bnxt_ulp_generic_tbl_params ulp_generic_tbl_params[];
 428 /*
 429  * The ulp_global template table is used to initialize default entries
 430  * that could be reused by other templates.
 431  */
 432 extern uint32_t ulp_glb_template_tbl[];
 433
 434 #endif /* _ULP_TEMPLATE_STRUCT_H_ */