drivers/common/cnxk/roc_npc.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(C) 2021 Marvell.
   3  */
   4
   5 #ifndef _ROC_NPC_H_
   6 #define _ROC_NPC_H_
   7
   8 #include <sys/queue.h>
   9
  10 enum roc_npc_item_type {
  11         ROC_NPC_ITEM_TYPE_VOID,
  12         ROC_NPC_ITEM_TYPE_ANY,
  13         ROC_NPC_ITEM_TYPE_ETH,
  14         ROC_NPC_ITEM_TYPE_VLAN,
  15         ROC_NPC_ITEM_TYPE_E_TAG,
  16         ROC_NPC_ITEM_TYPE_IPV4,
  17         ROC_NPC_ITEM_TYPE_IPV6,
  18         ROC_NPC_ITEM_TYPE_ARP_ETH_IPV4,
  19         ROC_NPC_ITEM_TYPE_MPLS,
  20         ROC_NPC_ITEM_TYPE_ICMP,
  21         ROC_NPC_ITEM_TYPE_IGMP,
  22         ROC_NPC_ITEM_TYPE_UDP,
  23         ROC_NPC_ITEM_TYPE_TCP,
  24         ROC_NPC_ITEM_TYPE_SCTP,
  25         ROC_NPC_ITEM_TYPE_ESP,
  26         ROC_NPC_ITEM_TYPE_GRE,
  27         ROC_NPC_ITEM_TYPE_NVGRE,
  28         ROC_NPC_ITEM_TYPE_VXLAN,
  29         ROC_NPC_ITEM_TYPE_GTPC,
  30         ROC_NPC_ITEM_TYPE_GTPU,
  31         ROC_NPC_ITEM_TYPE_GENEVE,
  32         ROC_NPC_ITEM_TYPE_VXLAN_GPE,
  33         ROC_NPC_ITEM_TYPE_IPV6_EXT,
  34         ROC_NPC_ITEM_TYPE_GRE_KEY,
  35         ROC_NPC_ITEM_TYPE_HIGIG2,
  36         ROC_NPC_ITEM_TYPE_CPT_HDR,
  37         ROC_NPC_ITEM_TYPE_L3_CUSTOM,
  38         ROC_NPC_ITEM_TYPE_QINQ,
  39         ROC_NPC_ITEM_TYPE_RAW,
  40         ROC_NPC_ITEM_TYPE_MARK,
  41         ROC_NPC_ITEM_TYPE_END,
  42 };
  43
  44 struct roc_npc_item_info {
  45         enum roc_npc_item_type type; /* Item type */
  46         uint32_t size;               /* item size */
  47         const void *spec; /**< Pointer to item specification structure. */
  48         const void *mask; /**< Bit-mask applied to spec and last. */
  49         const void *last; /* For range */
  50 };
  51
  52 struct roc_npc_flow_item_raw {
  53         uint32_t relative : 1; /**< Look for pattern after the previous item. */
  54         uint32_t search : 1;   /**< Search pattern from offset. */
  55         uint32_t reserved : 30; /**< Reserved, must be set to zero. */
  56         int32_t offset;         /**< Absolute or relative offset for pattern. */
  57         uint16_t limit;         /**< Search area limit for start of pattern. */
  58         uint16_t length;        /**< Pattern length. */
  59         const uint8_t *pattern; /**< Byte string to look for. */
  60 };
  61
  62 struct roc_ether_addr {
  63         uint8_t addr_bytes[PLT_ETHER_ADDR_LEN]; /**< Addr bytes in tx order */
  64 } __plt_aligned(2);
  65
  66 struct roc_ether_hdr {
  67         struct roc_ether_addr d_addr; /**< Destination address. */
  68         PLT_STD_C11
  69         union {
  70                 struct roc_ether_addr s_addr; /**< Source address. */
  71                 struct {
  72                         struct roc_ether_addr S_addr;
  73                 } S_un; /**< Do not use directly; use s_addr instead.*/
  74         };
  75         uint16_t ether_type; /**< Frame type. */
  76 } __plt_aligned(2);
  77
  78 PLT_STD_C11
  79 struct roc_npc_flow_item_eth {
  80         union {
  81                 struct {
  82                         /*
  83                          * These fields are retained
  84                          * for compatibility.
  85                          * Please switch to the new header field below.
  86                          */
  87                         struct roc_ether_addr dst; /**< Destination MAC. */
  88                         struct roc_ether_addr src; /**< Source MAC. */
  89                         uint16_t type;             /**< EtherType or TPID. */
  90                 };
  91                 struct roc_ether_hdr hdr;
  92         };
  93         uint32_t has_vlan : 1; /**< Packet header contains at least one VLAN. */
  94         uint32_t reserved : 31; /**< Reserved, must be zero. */
  95 };
  96
  97 struct roc_vlan_hdr {
  98         uint16_t vlan_tci; /**< Priority (3) + CFI (1) + Identifier Code (12) */
  99         uint16_t eth_proto; /**< Ethernet type of encapsulated frame. */
 100 } __plt_packed;
 101
 102 PLT_STD_C11
 103 struct roc_npc_flow_item_vlan {
 104         union {
 105                 struct {
 106                         uint16_t tci;        /**< Tag control information. */
 107                         uint16_t inner_type; /**< Inner EtherType or TPID. */
 108                 };
 109                 struct roc_vlan_hdr hdr;
 110         };
 111         uint32_t has_more_vlan : 1;
 112         /**< Packet header contains at least one more VLAN, after this VLAN. */
 113         uint32_t reserved : 31; /**< Reserved, must be zero. */
 114 };
 115
 116 struct roc_ipv6_hdr {
 117         uint32_t vtc_flow;    /**< IP version, traffic class & flow label. */
 118         uint16_t payload_len; /**< IP payload size, including ext. headers */
 119         uint8_t proto;        /**< Protocol, next header. */
 120         uint8_t hop_limits;   /**< Hop limits. */
 121         uint8_t src_addr[16]; /**< IP address of source host. */
 122         uint8_t dst_addr[16]; /**< IP address of destination host(s). */
 123 } __plt_packed;
 124
 125 struct roc_npc_flow_item_ipv6 {
 126         struct roc_ipv6_hdr hdr; /**< IPv6 header definition. */
 127         uint32_t has_hop_ext : 1;
 128         /**< Header contains Hop-by-Hop Options extension header. */
 129         uint32_t has_route_ext : 1;
 130         /**< Header contains Routing extension header. */
 131         uint32_t has_frag_ext : 1;
 132         /**< Header contains Fragment extension header. */
 133         uint32_t has_auth_ext : 1;
 134         /**< Header contains Authentication extension header. */
 135         uint32_t has_esp_ext : 1;
 136         /**< Header contains Encapsulation Security Payload extension header. */
 137         uint32_t has_dest_ext : 1;
 138         /**< Header contains Destination Options extension header. */
 139         uint32_t has_mobil_ext : 1;
 140         /**< Header contains Mobility extension header. */
 141         uint32_t has_hip_ext : 1;
 142         /**< Header contains Host Identity Protocol extension header. */
 143         uint32_t has_shim6_ext : 1;
 144         /**< Header contains Shim6 Protocol extension header. */
 145         uint32_t reserved : 23;
 146         /**< Reserved for future extension headers, must be zero. */
 147 };
 148
 149 #define ROC_NPC_MAX_ACTION_COUNT 19
 150
 151 enum roc_npc_action_type {
 152         ROC_NPC_ACTION_TYPE_END = (1 << 0),
 153         ROC_NPC_ACTION_TYPE_VOID = (1 << 1),
 154         ROC_NPC_ACTION_TYPE_MARK = (1 << 2),
 155         ROC_NPC_ACTION_TYPE_FLAG = (1 << 3),
 156         ROC_NPC_ACTION_TYPE_DROP = (1 << 4),
 157         ROC_NPC_ACTION_TYPE_QUEUE = (1 << 5),
 158         ROC_NPC_ACTION_TYPE_RSS = (1 << 6),
 159         ROC_NPC_ACTION_TYPE_DUP = (1 << 7),
 160         ROC_NPC_ACTION_TYPE_SEC = (1 << 8),
 161         ROC_NPC_ACTION_TYPE_COUNT = (1 << 9),
 162         ROC_NPC_ACTION_TYPE_PF = (1 << 10),
 163         ROC_NPC_ACTION_TYPE_VF = (1 << 11),
 164         ROC_NPC_ACTION_TYPE_VLAN_STRIP = (1 << 12),
 165         ROC_NPC_ACTION_TYPE_VLAN_INSERT = (1 << 13),
 166         ROC_NPC_ACTION_TYPE_VLAN_ETHTYPE_INSERT = (1 << 14),
 167         ROC_NPC_ACTION_TYPE_VLAN_PCP_INSERT = (1 << 15),
 168         ROC_NPC_ACTION_TYPE_PORT_ID = (1 << 16),
 169         ROC_NPC_ACTION_TYPE_METER = (1 << 17),
 170 };
 171
 172 struct roc_npc_action {
 173         enum roc_npc_action_type type; /**< Action type. */
 174         const void *conf; /**< Pointer to action configuration object. */
 175 };
 176
 177 struct roc_npc_action_mark {
 178         uint32_t id; /**< Integer value to return with packets. */
 179 };
 180
 181 struct roc_npc_action_vf {
 182         uint32_t original : 1;  /**< Use original VF ID if possible. */
 183         uint32_t reserved : 31; /**< Reserved, must be zero. */
 184         uint32_t id;            /**< VF ID. */
 185 };
 186
 187 struct roc_npc_action_port_id {
 188         uint32_t original : 1;  /**< Use original port ID if possible. */
 189         uint32_t reserved : 31; /**< Reserved, must be zero. */
 190         uint32_t id;            /**< port ID. */
 191 };
 192
 193 struct roc_npc_action_queue {
 194         uint16_t index; /**< Queue index to use. */
 195 };
 196
 197 struct roc_npc_action_of_push_vlan {
 198         uint16_t ethertype; /**< EtherType. */
 199 };
 200
 201 struct roc_npc_action_of_set_vlan_vid {
 202         uint16_t vlan_vid; /**< VLAN id. */
 203 };
 204
 205 struct roc_npc_action_of_set_vlan_pcp {
 206         uint8_t vlan_pcp; /**< VLAN priority. */
 207 };
 208
 209 struct roc_npc_action_meter {
 210         uint32_t mtr_id; /**< Meter id to be applied. > */
 211 };
 212
 213 enum roc_npc_sec_action_alg {
 214         ROC_NPC_SEC_ACTION_ALG0,
 215         ROC_NPC_SEC_ACTION_ALG1,
 216         ROC_NPC_SEC_ACTION_ALG2,
 217         ROC_NPC_SEC_ACTION_ALG3,
 218 };
 219
 220 struct roc_npc_sec_action {
 221         /* Used as lookup result for ALG3 */
 222         uint32_t sa_index;
 223         /* When true XOR initial SA_INDEX with SA_HI/SA_LO to get SA_MCAM */
 224         bool sa_xor;
 225         uint16_t sa_hi, sa_lo;
 226         /* Determines alg to be applied post SA_MCAM computation with/without
 227          * XOR
 228          */
 229         enum roc_npc_sec_action_alg alg;
 230 };
 231
 232 struct roc_npc_attr {
 233         uint32_t priority;      /**< Rule priority level within group. */
 234         uint32_t ingress : 1;   /**< Rule applies to ingress traffic. */
 235         uint32_t egress : 1;    /**< Rule applies to egress traffic. */
 236         uint32_t reserved : 30; /**< Reserved, must be zero. */
 237 };
 238
 239 struct roc_npc_flow_dump_data {
 240         uint8_t lid;
 241         uint16_t ltype;
 242 };
 243
 244 struct roc_npc_flow {
 245         uint8_t nix_intf;
 246         uint8_t enable;
 247         uint32_t mcam_id;
 248         int32_t ctr_id;
 249         uint32_t priority;
 250         uint32_t mtr_id;
 251 #define ROC_NPC_MAX_MCAM_WIDTH_DWORDS 7
 252         /* Contiguous match string */
 253         uint64_t mcam_data[ROC_NPC_MAX_MCAM_WIDTH_DWORDS];
 254         uint64_t mcam_mask[ROC_NPC_MAX_MCAM_WIDTH_DWORDS];
 255         uint64_t npc_action;
 256         uint64_t vtag_action;
 257         bool vtag_insert_enabled;
 258         uint8_t vtag_insert_count;
 259 #define ROC_NPC_MAX_FLOW_PATTERNS 32
 260         struct roc_npc_flow_dump_data dump_data[ROC_NPC_MAX_FLOW_PATTERNS];
 261         uint16_t num_patterns;
 262
 263         TAILQ_ENTRY(roc_npc_flow) next;
 264 };
 265
 266 enum roc_npc_rss_hash_function {
 267         ROC_NPC_RSS_HASH_FUNCTION_DEFAULT = 0,
 268         ROC_NPC_RSS_HASH_FUNCTION_TOEPLITZ,   /**< Toeplitz */
 269         ROC_NPC_RSS_HASH_FUNCTION_SIMPLE_XOR, /**< Simple XOR */
 270         ROC_NPC_RSS_HASH_FUNCTION_SYMMETRIC_TOEPLITZ,
 271         ROC_NPC_RSS_HASH_FUNCTION_MAX,
 272 };
 273
 274 struct roc_npc_action_rss {
 275         enum roc_npc_rss_hash_function func;
 276         uint32_t level;
 277         uint64_t types;        /**< Specific RSS hash types (see ETH_RSS_*). */
 278         uint32_t key_len;      /**< Hash key length in bytes. */
 279         uint32_t queue_num;    /**< Number of entries in @p queue. */
 280         const uint8_t *key;    /**< Hash key. */
 281         const uint16_t *queue; /**< Queue indices to use. */
 282 };
 283
 284 enum roc_npc_intf {
 285         ROC_NPC_INTF_RX = 0,
 286         ROC_NPC_INTF_TX = 1,
 287         ROC_NPC_INTF_MAX = 2,
 288 };
 289
 290 enum flow_vtag_cfg_dir { VTAG_TX, VTAG_RX };
 291 #define ROC_ETHER_TYPE_VLAN 0x8100 /**< IEEE 802.1Q VLAN tagging. */
 292 #define ROC_ETHER_TYPE_QINQ 0x88A8 /**< IEEE 802.1ad QinQ tagging. */
 293
 294 struct roc_npc {
 295         struct roc_nix *roc_nix;
 296         uint8_t switch_header_type;
 297         uint8_t pre_l2_size_offset;      /**< Offset with in header that holds
 298                                            * size of custom header
 299                                            */
 300         uint8_t pre_l2_size_offset_mask; /**< Offset mask with in header
 301                                            * that holds size of custom header
 302                                            */
 303         uint8_t pre_l2_size_shift_dir;   /**< Shift direction to calculate size
 304                                            */
 305         uint16_t flow_prealloc_size;
 306         uint16_t flow_max_priority;
 307         uint16_t channel;
 308         uint16_t pf_func;
 309         uint64_t kex_capability;
 310         uint64_t rx_parse_nibble;
 311         /* Parsed RSS Flowkey cfg for current flow being created */
 312         uint32_t flowkey_cfg_state;
 313         bool is_sdp_mask_set;
 314         uint16_t sdp_channel;
 315         uint16_t sdp_channel_mask;
 316
 317 #define ROC_NPC_MEM_SZ (5 * 1024)
 318         uint8_t reserved[ROC_NPC_MEM_SZ];
 319 } __plt_cache_aligned;
 320
 321 int __roc_api roc_npc_init(struct roc_npc *roc_npc);
 322 int __roc_api roc_npc_fini(struct roc_npc *roc_npc);
 323 const char *__roc_api roc_npc_profile_name_get(struct roc_npc *roc_npc);
 324
 325 struct roc_npc_flow *__roc_api
 326 roc_npc_flow_create(struct roc_npc *roc_npc, const struct roc_npc_attr *attr,
 327                     const struct roc_npc_item_info pattern[],
 328                     const struct roc_npc_action actions[], int *errcode);
 329 int __roc_api roc_npc_flow_destroy(struct roc_npc *roc_npc,
 330                                    struct roc_npc_flow *flow);
 331 int __roc_api roc_npc_mcam_free_entry(struct roc_npc *roc_npc, uint32_t entry);
 332 int __roc_api roc_npc_mcam_enable_all_entries(struct roc_npc *roc_npc,
 333                                               bool enable);
 334 int __roc_api roc_npc_mcam_alloc_entry(struct roc_npc *roc_npc,
 335                                        struct roc_npc_flow *mcam,
 336                                        struct roc_npc_flow *ref_mcam, int prio,
 337                                        int *resp_count);
 338 int __roc_api roc_npc_mcam_alloc_entries(struct roc_npc *roc_npc, int ref_entry,
 339                                          int *alloc_entry, int req_count,
 340                                          int priority, int *resp_count);
 341 int __roc_api roc_npc_mcam_ena_dis_entry(struct roc_npc *roc_npc,
 342                                          struct roc_npc_flow *mcam,
 343                                          bool enable);
 344 int __roc_api roc_npc_mcam_write_entry(struct roc_npc *roc_npc,
 345                                        struct roc_npc_flow *mcam);
 346 int __roc_api roc_npc_flow_parse(struct roc_npc *roc_npc,
 347                                  const struct roc_npc_attr *attr,
 348                                  const struct roc_npc_item_info pattern[],
 349                                  const struct roc_npc_action actions[],
 350                                  struct roc_npc_flow *flow);
 351 int __roc_api roc_npc_get_low_priority_mcam(struct roc_npc *roc_npc);
 352 int __roc_api roc_npc_mcam_free_counter(struct roc_npc *roc_npc,
 353                                         uint16_t ctr_id);
 354 int __roc_api roc_npc_mcam_read_counter(struct roc_npc *roc_npc,
 355                                         uint32_t ctr_id, uint64_t *count);
 356 int __roc_api roc_npc_mcam_clear_counter(struct roc_npc *roc_npc,
 357                                          uint32_t ctr_id);
 358 int __roc_api roc_npc_mcam_free_all_resources(struct roc_npc *roc_npc);
 359 void __roc_api roc_npc_flow_dump(FILE *file, struct roc_npc *roc_npc);
 360 void __roc_api roc_npc_flow_mcam_dump(FILE *file, struct roc_npc *roc_npc,
 361                                       struct roc_npc_flow *mcam);
 362 int __roc_api roc_npc_vtag_actions_get(struct roc_npc *roc_npc);
 363 int __roc_api roc_npc_vtag_actions_sub_return(struct roc_npc *roc_npc,
 364                                               uint32_t count);
 365 int __roc_api roc_npc_mcam_merge_base_steering_rule(struct roc_npc *roc_npc,
 366                                                     struct roc_npc_flow *flow);
 367 int __roc_api roc_npc_validate_portid_action(struct roc_npc *roc_npc_src,
 368                                              struct roc_npc *roc_npc_dst);
 369 #endif /* _ROC_NPC_H_ */