drivers/net/bnxt/tf_ulp/ulp_template_struct.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2014-2019 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         struct bnxt_ulp_context         *ulp_ctx;
  76 };
  77
  78 /* Flow Parser Header Information Structure */
  79 struct bnxt_ulp_rte_hdr_info {
  80         enum bnxt_ulp_hdr_type                                  hdr_type;
  81         /* Flow Parser Protocol Header Function Prototype */
  82         int (*proto_hdr_func)(const struct rte_flow_item        *item_list,
  83                               struct ulp_rte_parser_params      *params);
  84 };
  85
  86 /* Flow Parser Header Information Structure Array defined in template source*/
  87 extern struct bnxt_ulp_rte_hdr_info     ulp_hdr_info[];
  88
  89 /* Flow Parser Action Information Structure */
  90 struct bnxt_ulp_rte_act_info {
  91         enum bnxt_ulp_act_type                                  act_type;
  92         /* Flow Parser Protocol Action Function Prototype */
  93         int32_t (*proto_act_func)
  94                 (const struct rte_flow_action   *action_item,
  95                  struct ulp_rte_parser_params   *params);
  96 };
  97
  98 /* Flow Parser Action Information Structure Array defined in template source*/
  99 extern struct bnxt_ulp_rte_act_info     ulp_act_info[];
 100
 101 /* Flow Matcher structures */
 102 struct bnxt_ulp_header_match_info {
 103         struct ulp_rte_hdr_bitmap               hdr_bitmap;
 104         uint32_t                                start_idx;
 105         uint32_t                                num_entries;
 106         uint32_t                                class_tmpl_id;
 107         uint32_t                                act_vnic;
 108 };
 109
 110 struct ulp_rte_bitmap {
 111         uint64_t        bits;
 112 };
 113
 114 struct bnxt_ulp_class_match_info {
 115         struct ulp_rte_bitmap   hdr_sig;
 116         struct ulp_rte_bitmap   field_sig;
 117         uint32_t                class_hid;
 118         uint32_t                class_tid;
 119         uint8_t                 act_vnic;
 120         uint8_t                 wc_pri;
 121 };
 122
 123 /* Flow Matcher templates Structure for class entries */
 124 extern uint16_t ulp_class_sig_tbl[];
 125 extern struct bnxt_ulp_class_match_info ulp_class_match_list[];
 126
 127 /* Flow Matcher Action structures */
 128 struct bnxt_ulp_action_match_info {
 129         struct ulp_rte_act_bitmap               act_bitmap;
 130         uint32_t                                act_tmpl_id;
 131 };
 132
 133 struct bnxt_ulp_act_match_info {
 134         struct ulp_rte_bitmap   act_sig;
 135         uint32_t                act_hid;
 136         uint32_t                act_tid;
 137 };
 138
 139 /* Flow Matcher templates Structure for action entries */
 140 extern  uint16_t ulp_act_sig_tbl[];
 141 extern struct bnxt_ulp_act_match_info ulp_act_match_list[];
 142
 143 /* Device specific parameters */
 144 struct bnxt_ulp_device_params {
 145         uint8_t                         description[16];
 146         enum bnxt_ulp_flow_mem_type     flow_mem_type;
 147         enum bnxt_ulp_byte_order        byte_order;
 148         uint8_t                         encap_byte_swap;
 149         uint8_t                         num_phy_ports;
 150         uint32_t                        mark_db_lfid_entries;
 151         uint64_t                        mark_db_gfid_entries;
 152         uint64_t                        flow_db_num_entries;
 153         uint32_t                        flow_count_db_entries;
 154         uint32_t                        num_resources_per_flow;
 155         uint32_t                        ext_cntr_table_type;
 156         uint64_t                        byte_count_mask;
 157         uint64_t                        packet_count_mask;
 158         uint32_t                        byte_count_shift;
 159         uint32_t                        packet_count_shift;
 160 };
 161
 162 /* Flow Mapper */
 163 struct bnxt_ulp_mapper_tbl_list_info {
 164         uint32_t                device_name;
 165         uint32_t                start_tbl_idx;
 166         uint32_t                num_tbls;
 167         enum bnxt_ulp_fdb_type  flow_db_table_type;
 168 };
 169
 170 struct bnxt_ulp_mapper_tbl_info {
 171         enum bnxt_ulp_resource_func     resource_func;
 172         uint32_t                        resource_type; /* TF_ enum type */
 173         enum bnxt_ulp_resource_sub_type resource_sub_type;
 174         enum bnxt_ulp_cond_opcode       cond_opcode;
 175         uint32_t                        cond_operand;
 176         uint8_t                         direction;
 177         uint32_t                        priority;
 178         enum bnxt_ulp_search_before_alloc       srch_b4_alloc;
 179         enum bnxt_ulp_critical_resource         critical_resource;
 180
 181         /* Information for accessing the ulp_key_field_list */
 182         uint32_t        key_start_idx;
 183         uint16_t        key_bit_size;
 184         uint16_t        key_num_fields;
 185         /* Size of the blob that holds the key */
 186         uint16_t        blob_key_bit_size;
 187
 188         /* Information for accessing the ulp_class_result_field_list */
 189         uint32_t        result_start_idx;
 190         uint16_t        result_bit_size;
 191         uint16_t        result_num_fields;
 192         uint16_t        encap_num_fields;
 193
 194         /* Information for accessing the ulp_ident_list */
 195         uint32_t        ident_start_idx;
 196         uint16_t        ident_nums;
 197
 198         enum bnxt_ulp_mark_db_opcode    mark_db_opcode;
 199         enum bnxt_ulp_index_opcode      index_opcode;
 200         uint32_t                        index_operand;
 201 };
 202
 203 struct bnxt_ulp_mapper_class_key_field_info {
 204         uint8_t                         description[64];
 205         enum bnxt_ulp_mapper_opc        mask_opcode;
 206         enum bnxt_ulp_mapper_opc        spec_opcode;
 207         uint16_t                        field_bit_size;
 208         uint8_t                         mask_operand[16];
 209         uint8_t                         spec_operand[16];
 210 };
 211
 212 struct bnxt_ulp_mapper_result_field_info {
 213         uint8_t                         description[64];
 214         enum bnxt_ulp_mapper_opc        result_opcode;
 215         uint16_t                        field_bit_size;
 216         uint8_t                         result_operand[16];
 217         uint8_t                         result_operand_true[16];
 218         uint8_t                         result_operand_false[16];
 219 };
 220
 221 struct bnxt_ulp_mapper_ident_info {
 222         uint8_t         description[64];
 223         uint32_t        resource_func;
 224
 225         uint16_t        ident_type;
 226         uint16_t        ident_bit_size;
 227         uint16_t        ident_bit_pos;
 228         enum bnxt_ulp_regfile_index     regfile_idx;
 229 };
 230
 231 struct bnxt_ulp_glb_resource_info {
 232         enum bnxt_ulp_resource_func     resource_func;
 233         uint32_t                        resource_type; /* TF_ enum type */
 234         enum bnxt_ulp_glb_regfile_index glb_regfile_index;
 235         enum tf_dir                     direction;
 236 };
 237
 238 struct bnxt_ulp_cache_tbl_params {
 239         uint16_t num_entries;
 240 };
 241
 242 /*
 243  * Flow Mapper Static Data Externs:
 244  * Access to the below static data should be done through access functions and
 245  * directly throughout the code.
 246  */
 247
 248 /*
 249  * The ulp_device_params is indexed by the dev_id.
 250  * This table maintains the device specific parameters.
 251  */
 252 extern struct bnxt_ulp_device_params ulp_device_params[];
 253
 254 /*
 255  * The ulp_class_tmpl_list and ulp_act_tmpl_list are indexed by the dev_id
 256  * and template id (either class or action) returned by the matcher.
 257  * The result provides the start index and number of entries in the connected
 258  * ulp_class_tbl_list/ulp_act_tbl_list.
 259  */
 260 extern struct bnxt_ulp_mapper_tbl_list_info     ulp_class_tmpl_list[];
 261 extern struct bnxt_ulp_mapper_tbl_list_info     ulp_act_tmpl_list[];
 262
 263 /*
 264  * The ulp_class_tbl_list and ulp_act_tbl_list are indexed based on the results
 265  * of the template lists.  Each entry describes the high level details of the
 266  * table entry to include the start index and number of instructions in the
 267  * field lists.
 268  */
 269 extern struct bnxt_ulp_mapper_tbl_info  ulp_class_tbl_list[];
 270 extern struct bnxt_ulp_mapper_tbl_info  ulp_act_tbl_list[];
 271
 272 /*
 273  * The ulp_class_result_field_list provides the instructions for creating result
 274  * records such as tcam/em results.
 275  */
 276 extern struct bnxt_ulp_mapper_result_field_info ulp_class_result_field_list[];
 277
 278 /*
 279  * The ulp_data_field_list provides the instructions for creating an action
 280  * record.  It uses the same structure as the result list, but is only used for
 281  * actions.
 282  */
 283 extern
 284 struct bnxt_ulp_mapper_result_field_info ulp_act_result_field_list[];
 285
 286 /*
 287  * The ulp_act_prop_map_table provides the mapping to index and size of action
 288  * tcam and em tables.
 289  */
 290 extern
 291 struct bnxt_ulp_mapper_class_key_field_info     ulp_class_key_field_list[];
 292
 293 /*
 294  * The ulp_ident_list provides the instructions for creating identifiers such
 295  * as profile ids.
 296  */
 297 extern struct bnxt_ulp_mapper_ident_info        ulp_ident_list[];
 298
 299 /*
 300  * The ulp_act_prop_map_table provides the mapping to index and size of action
 301  * properties.
 302  */
 303 extern uint32_t ulp_act_prop_map_table[];
 304
 305 /*
 306  * The ulp_glb_resource_tbl provides the list of global resources that need to
 307  * be initialized and where to store them.
 308  */
 309 extern struct bnxt_ulp_glb_resource_info ulp_glb_resource_tbl[];
 310
 311 /*
 312  * The ulp_cache_tbl_parms table provides the sizes of the cache tables the
 313  * mapper must dynamically allocate during initialization.
 314  */
 315 extern struct bnxt_ulp_cache_tbl_params ulp_cache_tbl_params[];
 316
 317 /*
 318  * The ulp_global template table is used to initialize default entries
 319  * that could be reused by other templates.
 320  */
 321 extern uint32_t ulp_glb_template_tbl[];
 322
 323 #endif /* _ULP_TEMPLATE_STRUCT_H_ */