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