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