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