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