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_FIELD_SVIF_IDX       1
  34
  35 /* Direction attributes */
  36 #define BNXT_ULP_FLOW_ATTR_TRANSFER     0x1
  37 #define BNXT_ULP_FLOW_ATTR_INGRESS      0x2
  38 #define BNXT_ULP_FLOW_ATTR_EGRESS       0x4
  39
  40 struct ulp_rte_hdr_bitmap {
  41         uint64_t        bits;
  42 };
  43
  44 struct ulp_rte_field_bitmap {
  45         uint64_t        bits;
  46 };
  47
  48 /* Structure to store the protocol fields */
  49 #define RTE_PARSER_FLOW_HDR_FIELD_SIZE          16
  50 struct ulp_rte_hdr_field {
  51         uint8_t         spec[RTE_PARSER_FLOW_HDR_FIELD_SIZE];
  52         uint8_t         mask[RTE_PARSER_FLOW_HDR_FIELD_SIZE];
  53         uint32_t        size;
  54 };
  55
  56 struct ulp_rte_act_bitmap {
  57         uint64_t        bits;
  58 };
  59
  60 /* Structure to hold the action property details. */
  61 struct ulp_rte_act_prop {
  62         uint8_t act_details[BNXT_ULP_ACT_PROP_IDX_LAST];
  63 };
  64
  65 /* Structure to be used for passing all the parser functions */
  66 struct ulp_rte_parser_params {
  67         STAILQ_ENTRY(ulp_rte_parser_params)  next;
  68         struct ulp_rte_hdr_bitmap       hdr_bitmap;
  69         struct ulp_rte_hdr_bitmap       hdr_fp_bit;
  70         struct ulp_rte_field_bitmap     fld_bitmap;
  71         struct ulp_rte_field_bitmap     fld_s_bitmap;
  72         struct ulp_rte_hdr_field        hdr_field[BNXT_ULP_PROTO_HDR_MAX];
  73         uint32_t                        comp_fld[BNXT_ULP_CF_IDX_LAST];
  74         uint32_t                        field_idx;
  75         struct ulp_rte_act_bitmap       act_bitmap;
  76         struct ulp_rte_act_prop         act_prop;
  77         uint32_t                        dir_attr;
  78         uint32_t                        priority;
  79         uint32_t                        fid;
  80         uint32_t                        parent_flow;
  81         uint32_t                        parent_fid;
  82         uint16_t                        func_id;
  83         uint16_t                        port_id;
  84         uint32_t                        class_id;
  85         uint32_t                        act_tmpl;
  86         struct bnxt_ulp_context         *ulp_ctx;
  87         uint32_t                        hdr_sig_id;
  88         uint32_t                        flow_sig_id;
  89         uint32_t                        flow_pattern_id;
  90         uint32_t                        act_pattern_id;
  91 };
  92
  93 /* Flow Parser Header Information Structure */
  94 struct bnxt_ulp_rte_hdr_info {
  95         enum bnxt_ulp_hdr_type                                  hdr_type;
  96         /* Flow Parser Protocol Header Function Prototype */
  97         int (*proto_hdr_func)(const struct rte_flow_item        *item_list,
  98                               struct ulp_rte_parser_params      *params);
  99 };
 100
 101 /* Flow Parser Header Information Structure Array defined in template source*/
 102 extern struct bnxt_ulp_rte_hdr_info     ulp_hdr_info[];
 103
 104 /* Flow Parser Action Information Structure */
 105 struct bnxt_ulp_rte_act_info {
 106         enum bnxt_ulp_act_type                                  act_type;
 107         /* Flow Parser Protocol Action Function Prototype */
 108         int32_t (*proto_act_func)
 109                 (const struct rte_flow_action   *action_item,
 110                  struct ulp_rte_parser_params   *params);
 111 };
 112
 113 /* Flow Parser Action Information Structure Array defined in template source*/
 114 extern struct bnxt_ulp_rte_act_info     ulp_act_info[];
 115
 116 /* Flow Matcher structures */
 117 struct bnxt_ulp_header_match_info {
 118         struct ulp_rte_hdr_bitmap               hdr_bitmap;
 119         uint32_t                                start_idx;
 120         uint32_t                                num_entries;
 121         uint32_t                                class_tmpl_id;
 122         uint32_t                                act_vnic;
 123 };
 124
 125 struct ulp_rte_bitmap {
 126         uint64_t        bits;
 127 };
 128
 129 struct bnxt_ulp_class_match_info {
 130         struct ulp_rte_bitmap   hdr_sig;
 131         struct ulp_rte_bitmap   field_sig;
 132         uint32_t                class_hid;
 133         uint32_t                class_tid;
 134         uint8_t                 act_vnic;
 135         uint8_t                 wc_pri;
 136         uint32_t                hdr_sig_id;
 137         uint32_t                flow_sig_id;
 138         uint32_t                flow_pattern_id;
 139 };
 140
 141 /* Flow Matcher templates Structure for class entries */
 142 extern uint16_t ulp_class_sig_tbl[];
 143 extern struct bnxt_ulp_class_match_info ulp_class_match_list[];
 144
 145 /* Flow Matcher Action structures */
 146 struct bnxt_ulp_action_match_info {
 147         struct ulp_rte_act_bitmap               act_bitmap;
 148         uint32_t                                act_tmpl_id;
 149 };
 150
 151 struct bnxt_ulp_act_match_info {
 152         struct ulp_rte_bitmap   act_sig;
 153         uint32_t                act_hid;
 154         uint32_t                act_tid;
 155         uint32_t                act_pattern_id;
 156 };
 157
 158 /* Flow Matcher templates Structure for action entries */
 159 extern  uint16_t ulp_act_sig_tbl[];
 160 extern struct bnxt_ulp_act_match_info ulp_act_match_list[];
 161
 162 /* Device Specific Tables for mapper */
 163 struct bnxt_ulp_mapper_cond_info {
 164         enum bnxt_ulp_cond_opc cond_opcode;
 165         uint32_t cond_operand;
 166 };
 167
 168 struct bnxt_ulp_mapper_cond_list_info {
 169         enum bnxt_ulp_cond_list_opc cond_list_opcode;
 170         uint32_t cond_start_idx;
 171         uint32_t cond_nums;
 172         int32_t cond_true_goto;
 173         int32_t cond_false_goto;
 174 };
 175
 176 struct bnxt_ulp_mapper_cc_upd_info {
 177         enum bnxt_ulp_cc_upd_opc        cc_opc;
 178         enum bnxt_ulp_cc_upd_src        cc_src1;
 179         enum bnxt_ulp_cc_upd_src        cc_src2;
 180         uint16_t                        cc_opr1;
 181         uint16_t                        cc_opr2;
 182         uint16_t                        cc_dst_opr;
 183 };
 184
 185 struct bnxt_ulp_template_device_tbls {
 186         struct bnxt_ulp_mapper_tmpl_info *tmpl_list;
 187         uint32_t tmpl_list_size;
 188         struct bnxt_ulp_mapper_tbl_info *tbl_list;
 189         uint32_t tbl_list_size;
 190         struct bnxt_ulp_mapper_key_info *key_info_list;
 191         uint32_t key_info_list_size;
 192         struct bnxt_ulp_mapper_field_info *result_field_list;
 193         uint32_t result_field_list_size;
 194         struct bnxt_ulp_mapper_ident_info *ident_list;
 195         uint32_t ident_list_size;
 196         struct bnxt_ulp_mapper_cond_info *cond_list;
 197         uint32_t cond_list_size;
 198 };
 199
 200 /* Device specific parameters */
 201 struct bnxt_ulp_device_params {
 202         uint8_t                         description[16];
 203         enum bnxt_ulp_byte_order        byte_order;
 204         uint8_t                         encap_byte_swap;
 205         uint8_t                         num_phy_ports;
 206         uint32_t                        mark_db_lfid_entries;
 207         uint64_t                        mark_db_gfid_entries;
 208         uint64_t                        int_flow_db_num_entries;
 209         uint64_t                        ext_flow_db_num_entries;
 210         uint32_t                        flow_count_db_entries;
 211         uint32_t                        fdb_parent_flow_entries;
 212         uint32_t                        num_resources_per_flow;
 213         uint32_t                        ext_cntr_table_type;
 214         uint64_t                        byte_count_mask;
 215         uint64_t                        packet_count_mask;
 216         uint32_t                        byte_count_shift;
 217         uint32_t                        packet_count_shift;
 218         uint32_t                        dynamic_pad_en;
 219         uint16_t                        em_blk_size_bits;
 220         uint16_t                        em_blk_align_bits;
 221         uint16_t                        em_key_align_bytes;
 222         uint16_t                        em_result_size_bits;
 223         uint16_t                        wc_slice_width;
 224         uint16_t                        wc_max_slices;
 225         uint32_t                        wc_mode_list[4];
 226         uint32_t                        wc_mod_list_max_size;
 227         uint32_t                        wc_ctl_size_bits;
 228         const struct bnxt_ulp_template_device_tbls *dev_tbls;
 229 };
 230
 231 /* Flow Mapper */
 232 struct bnxt_ulp_mapper_tmpl_info {
 233         uint32_t                device_name;
 234         uint32_t                start_tbl_idx;
 235         uint32_t                num_tbls;
 236         struct bnxt_ulp_mapper_cond_list_info reject_info;
 237 };
 238
 239 struct bnxt_ulp_mapper_tbl_info {
 240         enum bnxt_ulp_resource_func     resource_func;
 241         uint32_t                        resource_type; /* TF_ enum type */
 242         enum bnxt_ulp_resource_sub_type resource_sub_type;
 243         struct bnxt_ulp_mapper_cond_list_info execute_info;
 244         struct bnxt_ulp_mapper_cc_upd_info cc_upd_info;
 245         enum bnxt_ulp_cond_opc cond_opcode;
 246         uint32_t cond_operand;
 247         uint8_t                         direction;
 248         enum bnxt_ulp_pri_opc           pri_opcode;
 249         uint32_t                        pri_operand;
 250         enum bnxt_ulp_byte_order        byte_order;
 251
 252         /* conflict resolution opcode */
 253         enum bnxt_ulp_accept_opc        accept_opcode;
 254
 255         enum bnxt_ulp_critical_resource         critical_resource;
 256
 257         /* Information for accessing the ulp_key_field_list */
 258         uint32_t        key_start_idx;
 259         uint16_t        key_bit_size;
 260         uint16_t        key_num_fields;
 261         /* Size of the blob that holds the key */
 262         uint16_t        blob_key_bit_size;
 263
 264         /* Information for accessing the ulp_class_result_field_list */
 265         uint32_t        result_start_idx;
 266         uint16_t        result_bit_size;
 267         uint16_t        result_num_fields;
 268         uint16_t        encap_num_fields;
 269
 270         /* Information for accessing the ulp_ident_list */
 271         uint32_t        ident_start_idx;
 272         uint16_t        ident_nums;
 273
 274         enum bnxt_ulp_mark_db_opc       mark_db_opcode;
 275
 276         /* Table opcode for table operations */
 277         uint32_t                        tbl_opcode;
 278         uint32_t                        tbl_operand;
 279         enum bnxt_ulp_generic_tbl_lkup_type gen_tbl_lkup_type;
 280
 281         /* FDB table opcode */
 282         enum bnxt_ulp_fdb_opc           fdb_opcode;
 283         uint32_t                        fdb_operand;
 284 };
 285
 286 struct bnxt_ulp_mapper_field_info {
 287         uint8_t                         description[64];
 288         uint16_t                        field_bit_size;
 289         enum bnxt_ulp_field_opc         field_opc;
 290         enum bnxt_ulp_field_src         field_src1;
 291         uint8_t                         field_opr1[16];
 292         enum bnxt_ulp_field_src         field_src2;
 293         uint8_t                         field_opr2[16];
 294         enum bnxt_ulp_field_src         field_src3;
 295         uint8_t                         field_opr3[16];
 296 };
 297
 298 struct bnxt_ulp_mapper_key_info {
 299         struct bnxt_ulp_mapper_field_info       field_info_spec;
 300         struct bnxt_ulp_mapper_field_info       field_info_mask;
 301 };
 302
 303 struct bnxt_ulp_mapper_ident_info {
 304         uint8_t         description[64];
 305         uint32_t        resource_func;
 306
 307         uint16_t        ident_type;
 308         uint16_t        ident_bit_size;
 309         uint16_t        ident_bit_pos;
 310         enum bnxt_ulp_rf_idx    regfile_idx;
 311 };
 312
 313 struct bnxt_ulp_glb_resource_info {
 314         uint8_t                         app_id;
 315         enum bnxt_ulp_device_id         device_id;
 316         enum tf_dir                     direction;
 317         enum bnxt_ulp_resource_func     resource_func;
 318         uint32_t                        resource_type; /* TF_ enum type */
 319         enum bnxt_ulp_glb_rf_idx        glb_regfile_index;
 320 };
 321
 322 struct bnxt_ulp_resource_resv_info {
 323         uint8_t                         app_id;
 324         enum bnxt_ulp_device_id         device_id;
 325         enum tf_dir                     direction;
 326         enum bnxt_ulp_resource_func     resource_func;
 327         uint32_t                        resource_type; /* TF_ enum type */
 328         uint32_t                        count;
 329 };
 330
 331 struct bnxt_ulp_app_capabilities_info {
 332         uint8_t                         app_id;
 333         enum bnxt_ulp_device_id         device_id;
 334         uint32_t                        flags;
 335 };
 336
 337 struct bnxt_ulp_cache_tbl_params {
 338         uint16_t num_entries;
 339 };
 340
 341 struct bnxt_ulp_generic_tbl_params {
 342         const char                      *name;
 343         uint16_t                        result_num_entries;
 344         uint16_t                        result_num_bytes;
 345         enum bnxt_ulp_byte_order        result_byte_order;
 346         uint32_t                        hash_tbl_entries;
 347         uint16_t                        num_buckets;
 348         uint16_t                        key_num_bytes;
 349 };
 350
 351 struct bnxt_ulp_shared_act_info {
 352         uint64_t act_bitmask;
 353 };
 354
 355 /*
 356  * Flow Mapper Static Data Externs:
 357  * Access to the below static data should be done through access functions and
 358  * directly throughout the code.
 359  */
 360
 361 /*
 362  * The ulp_device_params is indexed by the dev_id.
 363  * This table maintains the device specific parameters.
 364  */
 365 extern struct bnxt_ulp_device_params ulp_device_params[];
 366
 367 /*
 368  * The ulp_act_prop_map_table provides the mapping to index and size of action
 369  * properties.
 370  */
 371 extern uint32_t ulp_act_prop_map_table[];
 372
 373 /*
 374  * The ulp_glb_resource_tbl provides the list of global resources that need to
 375  * be initialized and where to store them.
 376  */
 377 extern struct bnxt_ulp_glb_resource_info ulp_glb_resource_tbl[];
 378
 379 /*
 380  * The ulp_app_glb_resource_tbl provides the list of shared resources required
 381  * in the event that shared session is enabled.
 382  */
 383 extern struct bnxt_ulp_glb_resource_info ulp_app_glb_resource_tbl[];
 384
 385 /*
 386  * The ulp_resource_resv_list provides the list of tf resources required when
 387  * calling tf_open.
 388  */
 389 extern struct bnxt_ulp_resource_resv_info ulp_resource_resv_list[];
 390
 391 /*
 392  * The_app_cap_info_list provides the list of ULP capabilities per app/device.
 393  */
 394 extern struct bnxt_ulp_app_capabilities_info ulp_app_cap_info_list[];
 395
 396 /*
 397  * The ulp_cache_tbl_parms table provides the sizes of the cache tables the
 398  * mapper must dynamically allocate during initialization.
 399  */
 400 extern struct bnxt_ulp_cache_tbl_params ulp_cache_tbl_params[];
 401
 402 /*
 403  * The ulp_generic_tbl_parms table provides the sizes of the generic tables the
 404  * mapper must dynamically allocate during initialization.
 405  */
 406 extern struct bnxt_ulp_generic_tbl_params ulp_generic_tbl_params[];
 407 /*
 408  * The ulp_global template table is used to initialize default entries
 409  * that could be reused by other templates.
 410  */
 411 extern uint32_t ulp_glb_template_tbl[];
 412
 413 #endif /* _ULP_TEMPLATE_STRUCT_H_ */