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