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     6
  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_CHF_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 };
  70
  71 /* Flow Parser Header Information Structure */
  72 struct bnxt_ulp_rte_hdr_info {
  73         enum bnxt_ulp_hdr_type                                  hdr_type;
  74         /* Flow Parser Protocol Header Function Prototype */
  75         int (*proto_hdr_func)(const struct rte_flow_item        *item_list,
  76                               struct ulp_rte_parser_params      *params);
  77 };
  78
  79 /* Flow Parser Header Information Structure Array defined in template source*/
  80 extern struct bnxt_ulp_rte_hdr_info     ulp_hdr_info[];
  81
  82 /* Flow Parser Action Information Structure */
  83 struct bnxt_ulp_rte_act_info {
  84         enum bnxt_ulp_act_type                                  act_type;
  85         /* Flow Parser Protocol Action Function Prototype */
  86         int32_t (*proto_act_func)
  87                 (const struct rte_flow_action   *action_item,
  88                  struct ulp_rte_parser_params   *params);
  89 };
  90
  91 /* Flow Parser Action Information Structure Array defined in template source*/
  92 extern struct bnxt_ulp_rte_act_info     ulp_act_info[];
  93
  94 /* Flow Matcher structures */
  95 struct bnxt_ulp_header_match_info {
  96         struct ulp_rte_hdr_bitmap               hdr_bitmap;
  97         uint32_t                                start_idx;
  98         uint32_t                                num_entries;
  99         uint32_t                                class_tmpl_id;
 100         uint32_t                                act_vnic;
 101 };
 102
 103 struct ulp_rte_bitmap {
 104         uint64_t        bits;
 105 };
 106
 107 struct bnxt_ulp_class_match_info {
 108         struct ulp_rte_bitmap   hdr_sig;
 109         struct ulp_rte_bitmap   field_sig;
 110         uint32_t                class_hid;
 111         uint32_t                class_tid;
 112         uint8_t                 act_vnic;
 113         uint8_t                 wc_pri;
 114 };
 115
 116 /* Flow Matcher templates Structure for class entries */
 117 extern uint16_t ulp_class_sig_tbl[];
 118 extern struct bnxt_ulp_class_match_info ulp_class_match_list[];
 119
 120 /* Flow Matcher Action structures */
 121 struct bnxt_ulp_action_match_info {
 122         struct ulp_rte_act_bitmap               act_bitmap;
 123         uint32_t                                act_tmpl_id;
 124 };
 125
 126 struct bnxt_ulp_act_match_info {
 127         struct ulp_rte_bitmap   act_sig;
 128         uint32_t                act_hid;
 129         uint32_t                act_tid;
 130 };
 131
 132 /* Flow Matcher templates Structure for action entries */
 133 extern  uint16_t ulp_act_sig_tbl[];
 134 extern struct bnxt_ulp_act_match_info ulp_act_match_list[];
 135
 136 /* Device specific parameters */
 137 struct bnxt_ulp_device_params {
 138         uint8_t                         description[16];
 139         uint32_t                        global_fid_enable;
 140         enum bnxt_ulp_byte_order        byte_order;
 141         uint8_t                         encap_byte_swap;
 142         uint32_t                        lfid_entries;
 143         uint32_t                        lfid_entry_size;
 144         uint64_t                        gfid_entries;
 145         uint32_t                        gfid_entry_size;
 146         uint64_t                        num_flows;
 147         uint32_t                        num_resources_per_flow;
 148 };
 149
 150 /* Flow Mapper */
 151 struct bnxt_ulp_mapper_tbl_list_info {
 152         uint32_t        device_name;
 153         uint32_t        start_tbl_idx;
 154         uint32_t        num_tbls;
 155 };
 156
 157 struct bnxt_ulp_mapper_class_tbl_info {
 158         enum bnxt_ulp_resource_func     resource_func;
 159         uint32_t        table_type;
 160         uint8_t         direction;
 161         uint8_t         mem;
 162         uint32_t        priority;
 163         uint8_t         srch_b4_alloc;
 164         uint32_t        critical_resource;
 165
 166         /* Information for accessing the ulp_key_field_list */
 167         uint32_t        key_start_idx;
 168         uint16_t        key_bit_size;
 169         uint16_t        key_num_fields;
 170         /* Size of the blob that holds the key */
 171         uint16_t        blob_key_bit_size;
 172
 173         /* Information for accessing the ulp_class_result_field_list */
 174         uint32_t        result_start_idx;
 175         uint16_t        result_bit_size;
 176         uint16_t        result_num_fields;
 177
 178         /* Information for accessing the ulp_ident_list */
 179         uint32_t        ident_start_idx;
 180         uint16_t        ident_nums;
 181
 182         uint8_t         mark_enable;
 183         enum bnxt_ulp_regfile_index     regfile_wr_idx;
 184 };
 185
 186 struct bnxt_ulp_mapper_act_tbl_info {
 187         enum bnxt_ulp_resource_func     resource_func;
 188         enum tf_tbl_type table_type;
 189         uint8_t         direction;
 190         uint8_t         srch_b4_alloc;
 191         uint32_t        result_start_idx;
 192         uint16_t        result_bit_size;
 193         uint16_t        encap_num_fields;
 194         uint16_t        result_num_fields;
 195
 196         enum bnxt_ulp_regfile_index     regfile_wr_idx;
 197 };
 198
 199 struct bnxt_ulp_mapper_class_key_field_info {
 200         uint8_t                 description[64];
 201         enum bnxt_ulp_mask_opc  mask_opcode;
 202         enum bnxt_ulp_spec_opc  spec_opcode;
 203         uint16_t                field_bit_size;
 204         uint8_t                 mask_operand[16];
 205         uint8_t                 spec_operand[16];
 206 };
 207
 208 struct bnxt_ulp_mapper_result_field_info {
 209         uint8_t                         description[64];
 210         enum bnxt_ulp_result_opc        result_opcode;
 211         uint16_t                        field_bit_size;
 212         uint8_t                         result_operand[16];
 213 };
 214
 215 struct bnxt_ulp_mapper_ident_info {
 216         uint8_t         description[64];
 217         uint32_t        resource_func;
 218
 219         uint16_t        ident_type;
 220         uint16_t        ident_bit_size;
 221         uint16_t        ident_bit_pos;
 222         enum bnxt_ulp_regfile_index     regfile_wr_idx;
 223 };
 224
 225 struct bnxt_ulp_def_ident_info {
 226         enum tf_dir direction;
 227         enum tf_identifier_type ident_type;
 228         enum bnxt_ulp_def_regfile_index def_regfile_index;
 229 };
 230
 231 /*
 232  * Flow Mapper Static Data Externs:
 233  * Access to the below static data should be done through access functions and
 234  * directly throughout the code.
 235  */
 236
 237 /*
 238  * The ulp_device_params is indexed by the dev_id.
 239  * This table maintains the device specific parameters.
 240  */
 241 extern struct bnxt_ulp_device_params ulp_device_params[];
 242
 243 /*
 244  * The ulp_class_tmpl_list and ulp_act_tmpl_list are indexed by the dev_id
 245  * and template id (either class or action) returned by the matcher.
 246  * The result provides the start index and number of entries in the connected
 247  * ulp_class_tbl_list/ulp_act_tbl_list.
 248  */
 249 extern struct bnxt_ulp_mapper_tbl_list_info     ulp_class_tmpl_list[];
 250 extern struct bnxt_ulp_mapper_tbl_list_info     ulp_act_tmpl_list[];
 251
 252 /*
 253  * The ulp_class_tbl_list and ulp_act_tbl_list are indexed based on the results
 254  * of the template lists.  Each entry describes the high level details of the
 255  * table entry to include the start index and number of instructions in the
 256  * field lists.
 257  */
 258 extern struct bnxt_ulp_mapper_class_tbl_info    ulp_class_tbl_list[];
 259 extern struct bnxt_ulp_mapper_act_tbl_info      ulp_act_tbl_list[];
 260
 261 /*
 262  * The ulp_class_result_field_list provides the instructions for creating result
 263  * records such as tcam/em results.
 264  */
 265 extern struct bnxt_ulp_mapper_result_field_info ulp_class_result_field_list[];
 266
 267 /*
 268  * The ulp_data_field_list provides the instructions for creating an action
 269  * record.  It uses the same structure as the result list, but is only used for
 270  * actions.
 271  */
 272 extern
 273 struct bnxt_ulp_mapper_result_field_info ulp_act_result_field_list[];
 274
 275 /*
 276  * The ulp_act_prop_map_table provides the mapping to index and size of action
 277  * tcam and em tables.
 278  */
 279 extern
 280 struct bnxt_ulp_mapper_class_key_field_info     ulp_class_key_field_list[];
 281
 282 /*
 283  * The ulp_ident_list provides the instructions for creating identifiers such
 284  * as profile ids.
 285  */
 286 extern struct bnxt_ulp_mapper_ident_info        ulp_ident_list[];
 287
 288 /*
 289  * The ulp_act_prop_map_table provides the mapping to index and size of action
 290  * properties.
 291  */
 292 extern uint32_t ulp_act_prop_map_table[];
 293
 294 /*
 295  * The ulp_def_ident_tbl provides the list of default identifiers that need to
 296  * be initialized and where to store them.
 297  */
 298 extern struct bnxt_ulp_def_ident_info ulp_def_ident_tbl[];
 299 #endif /* _ULP_TEMPLATE_STRUCT_H_ */