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     1
  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_MAX          128
  31 #define BNXT_ULP_PROTO_HDR_FIELD_SVIF_IDX       0
  32
  33 /* Direction attributes */
  34 #define BNXT_ULP_FLOW_ATTR_TRANSFER     0x1
  35 #define BNXT_ULP_FLOW_ATTR_INGRESS      0x2
  36 #define BNXT_ULP_FLOW_ATTR_EGRESS       0x4
  37
  38 struct ulp_rte_hdr_bitmap {
  39         uint64_t        bits;
  40 };
  41
  42 struct ulp_rte_field_bitmap {
  43         uint64_t        bits;
  44 };
  45
  46 /* Structure to store the protocol fields */
  47 #define RTE_PARSER_FLOW_HDR_FIELD_SIZE          16
  48 struct ulp_rte_hdr_field {
  49         uint8_t         spec[RTE_PARSER_FLOW_HDR_FIELD_SIZE];
  50         uint8_t         mask[RTE_PARSER_FLOW_HDR_FIELD_SIZE];
  51         uint32_t        size;
  52 };
  53
  54 struct ulp_rte_act_bitmap {
  55         uint64_t        bits;
  56 };
  57
  58 /* Structure to hold the action property details. */
  59 struct ulp_rte_act_prop {
  60         uint8_t act_details[BNXT_ULP_ACT_PROP_IDX_LAST];
  61 };
  62
  63 /* Structure to be used for passing all the parser functions */
  64 struct ulp_rte_parser_params {
  65         struct ulp_rte_hdr_bitmap       hdr_bitmap;
  66         struct ulp_rte_hdr_bitmap       hdr_fp_bit;
  67         struct ulp_rte_field_bitmap     fld_bitmap;
  68         struct ulp_rte_hdr_field        hdr_field[BNXT_ULP_PROTO_HDR_MAX];
  69         uint32_t                        comp_fld[BNXT_ULP_CF_IDX_LAST];
  70         uint32_t                        field_idx;
  71         uint32_t                        vlan_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 };
  85
  86 /* Flow Parser Header Information Structure */
  87 struct bnxt_ulp_rte_hdr_info {
  88         enum bnxt_ulp_hdr_type                                  hdr_type;
  89         /* Flow Parser Protocol Header Function Prototype */
  90         int (*proto_hdr_func)(const struct rte_flow_item        *item_list,
  91                               struct ulp_rte_parser_params      *params);
  92 };
  93
  94 /* Flow Parser Header Information Structure Array defined in template source*/
  95 extern struct bnxt_ulp_rte_hdr_info     ulp_hdr_info[];
  96
  97 /* Flow Parser Action Information Structure */
  98 struct bnxt_ulp_rte_act_info {
  99         enum bnxt_ulp_act_type                                  act_type;
 100         /* Flow Parser Protocol Action Function Prototype */
 101         int32_t (*proto_act_func)
 102                 (const struct rte_flow_action   *action_item,
 103                  struct ulp_rte_parser_params   *params);
 104 };
 105
 106 /* Flow Parser Action Information Structure Array defined in template source*/
 107 extern struct bnxt_ulp_rte_act_info     ulp_act_info[];
 108
 109 /* Flow Matcher structures */
 110 struct bnxt_ulp_header_match_info {
 111         struct ulp_rte_hdr_bitmap               hdr_bitmap;
 112         uint32_t                                start_idx;
 113         uint32_t                                num_entries;
 114         uint32_t                                class_tmpl_id;
 115         uint32_t                                act_vnic;
 116 };
 117
 118 struct ulp_rte_bitmap {
 119         uint64_t        bits;
 120 };
 121
 122 struct bnxt_ulp_class_match_info {
 123         struct ulp_rte_bitmap   hdr_sig;
 124         struct ulp_rte_bitmap   field_sig;
 125         uint32_t                class_hid;
 126         uint32_t                class_tid;
 127         uint8_t                 act_vnic;
 128         uint8_t                 wc_pri;
 129 };
 130
 131 /* Flow Matcher templates Structure for class entries */
 132 extern uint16_t ulp_class_sig_tbl[];
 133 extern struct bnxt_ulp_class_match_info ulp_class_match_list[];
 134
 135 /* Flow Matcher Action structures */
 136 struct bnxt_ulp_action_match_info {
 137         struct ulp_rte_act_bitmap               act_bitmap;
 138         uint32_t                                act_tmpl_id;
 139 };
 140
 141 struct bnxt_ulp_act_match_info {
 142         struct ulp_rte_bitmap   act_sig;
 143         uint32_t                act_hid;
 144         uint32_t                act_tid;
 145 };
 146
 147 /* Flow Matcher templates Structure for action entries */
 148 extern  uint16_t ulp_act_sig_tbl[];
 149 extern struct bnxt_ulp_act_match_info ulp_act_match_list[];
 150
 151 /* Device Specific Tables for mapper */
 152 struct ulp_template_device_tbls {
 153         struct bnxt_ulp_mapper_tbl_list_info *tmpl_list;
 154         struct bnxt_ulp_mapper_tbl_info *tbl_list;
 155         struct bnxt_ulp_mapper_key_field_info *key_field_list;
 156         struct bnxt_ulp_mapper_result_field_info *result_field_list;
 157         struct bnxt_ulp_mapper_ident_info *ident_list;
 158 };
 159
 160 /* Device specific parameters */
 161 struct bnxt_ulp_device_params {
 162         uint8_t                         description[16];
 163         enum bnxt_ulp_byte_order        byte_order;
 164         uint8_t                         encap_byte_swap;
 165         uint8_t                         num_phy_ports;
 166         uint32_t                        mark_db_lfid_entries;
 167         uint64_t                        mark_db_gfid_entries;
 168         uint64_t                        int_flow_db_num_entries;
 169         uint64_t                        ext_flow_db_num_entries;
 170         uint32_t                        flow_count_db_entries;
 171         uint32_t                        fdb_parent_flow_entries;
 172         uint32_t                        num_resources_per_flow;
 173         uint32_t                        ext_cntr_table_type;
 174         uint64_t                        byte_count_mask;
 175         uint64_t                        packet_count_mask;
 176         uint32_t                        byte_count_shift;
 177         uint32_t                        packet_count_shift;
 178         const struct ulp_template_device_tbls *dev_tbls;
 179 };
 180
 181 /* Flow Mapper */
 182 struct bnxt_ulp_mapper_tbl_list_info {
 183         uint32_t                device_name;
 184         uint32_t                start_tbl_idx;
 185         uint32_t                num_tbls;
 186 };
 187
 188 struct bnxt_ulp_mapper_tbl_info {
 189         enum bnxt_ulp_resource_func     resource_func;
 190         uint32_t                        resource_type; /* TF_ enum type */
 191         enum bnxt_ulp_resource_sub_type resource_sub_type;
 192         enum bnxt_ulp_cond_opcode       cond_opcode;
 193         uint32_t                        cond_operand;
 194         enum bnxt_ulp_mem_type_opcode   mem_type_opcode;
 195         uint8_t                         direction;
 196         uint32_t                        priority;
 197         enum bnxt_ulp_search_before_alloc       srch_b4_alloc;
 198         enum bnxt_ulp_critical_resource         critical_resource;
 199
 200         /* Information for accessing the ulp_key_field_list */
 201         uint32_t        key_start_idx;
 202         uint16_t        key_bit_size;
 203         uint16_t        key_num_fields;
 204         /* Size of the blob that holds the key */
 205         uint16_t        blob_key_bit_size;
 206
 207         /* Information for accessing the ulp_class_result_field_list */
 208         uint32_t        result_start_idx;
 209         uint16_t        result_bit_size;
 210         uint16_t        result_num_fields;
 211         uint16_t        encap_num_fields;
 212
 213         /* Information for accessing the ulp_ident_list */
 214         uint32_t        ident_start_idx;
 215         uint16_t        ident_nums;
 216
 217         enum bnxt_ulp_mark_db_opcode    mark_db_opcode;
 218         enum bnxt_ulp_index_opcode      index_opcode;
 219         uint32_t                        index_operand;
 220
 221         /* Table opcode for table operations */
 222         uint32_t                        tbl_opcode;
 223
 224         /* FDB table opcode */
 225         enum bnxt_ulp_fdb_opc           fdb_opcode;
 226         uint32_t                        flow_db_operand;
 227 };
 228
 229 struct bnxt_ulp_mapper_key_field_info {
 230         uint8_t                         description[64];
 231         enum bnxt_ulp_mapper_opc        mask_opcode;
 232         enum bnxt_ulp_mapper_opc        spec_opcode;
 233         uint16_t                        field_bit_size;
 234         uint8_t                         mask_operand[16];
 235         uint8_t                         spec_operand[16];
 236 };
 237
 238 struct bnxt_ulp_mapper_result_field_info {
 239         uint8_t                         description[64];
 240         enum bnxt_ulp_mapper_opc        result_opcode;
 241         uint16_t                        field_bit_size;
 242         uint8_t                         result_operand[16];
 243         uint8_t                         result_operand_true[16];
 244         uint8_t                         result_operand_false[16];
 245 };
 246
 247 struct bnxt_ulp_mapper_ident_info {
 248         uint8_t         description[64];
 249         uint32_t        resource_func;
 250
 251         uint16_t        ident_type;
 252         uint16_t        ident_bit_size;
 253         uint16_t        ident_bit_pos;
 254         enum bnxt_ulp_regfile_index     regfile_idx;
 255 };
 256
 257 struct bnxt_ulp_glb_resource_info {
 258         enum bnxt_ulp_resource_func     resource_func;
 259         uint32_t                        resource_type; /* TF_ enum type */
 260         enum bnxt_ulp_glb_regfile_index glb_regfile_index;
 261         enum tf_dir                     direction;
 262 };
 263
 264 struct bnxt_ulp_cache_tbl_params {
 265         uint16_t num_entries;
 266 };
 267
 268 struct bnxt_ulp_generic_tbl_params {
 269         uint16_t                        result_num_entries;
 270         uint16_t                        result_byte_size;
 271         enum bnxt_ulp_byte_order        result_byte_order;
 272 };
 273
 274 /*
 275  * Flow Mapper Static Data Externs:
 276  * Access to the below static data should be done through access functions and
 277  * directly throughout the code.
 278  */
 279
 280 /*
 281  * The ulp_device_params is indexed by the dev_id.
 282  * This table maintains the device specific parameters.
 283  */
 284 extern struct bnxt_ulp_device_params ulp_device_params[];
 285
 286 /*
 287  * The ulp_act_prop_map_table provides the mapping to index and size of action
 288  * properties.
 289  */
 290 extern uint32_t ulp_act_prop_map_table[];
 291
 292 /*
 293  * The ulp_glb_resource_tbl provides the list of global resources that need to
 294  * be initialized and where to store them.
 295  */
 296 extern struct bnxt_ulp_glb_resource_info ulp_glb_resource_tbl[];
 297
 298 /*
 299  * The ulp_cache_tbl_parms table provides the sizes of the cache tables the
 300  * mapper must dynamically allocate during initialization.
 301  */
 302 extern struct bnxt_ulp_cache_tbl_params ulp_cache_tbl_params[];
 303
 304 /*
 305  * The ulp_generic_tbl_parms table provides the sizes of the generic tables the
 306  * mapper must dynamically allocate during initialization.
 307  */
 308 extern struct bnxt_ulp_generic_tbl_params ulp_generic_tbl_params[];
 309 /*
 310  * The ulp_global template table is used to initialize default entries
 311  * that could be reused by other templates.
 312  */
 313 extern uint32_t ulp_glb_template_tbl[];
 314
 315 #endif /* _ULP_TEMPLATE_STRUCT_H_ */