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_END,
  40 };
  41
  42 struct roc_npc_item_info {
  43         enum roc_npc_item_type type; /* Item type */
  44         uint32_t size;               /* item size */
  45         const void *spec; /**< Pointer to item specification structure. */
  46         const void *mask; /**< Bit-mask applied to spec and last. */
  47         const void *last; /* For range */
  48 };
  49
  50 #define ROC_NPC_MAX_ACTION_COUNT 12
  51
  52 enum roc_npc_action_type {
  53         ROC_NPC_ACTION_TYPE_END = (1 << 0),
  54         ROC_NPC_ACTION_TYPE_VOID = (1 << 1),
  55         ROC_NPC_ACTION_TYPE_MARK = (1 << 2),
  56         ROC_NPC_ACTION_TYPE_FLAG = (1 << 3),
  57         ROC_NPC_ACTION_TYPE_DROP = (1 << 4),
  58         ROC_NPC_ACTION_TYPE_QUEUE = (1 << 5),
  59         ROC_NPC_ACTION_TYPE_RSS = (1 << 6),
  60         ROC_NPC_ACTION_TYPE_DUP = (1 << 7),
  61         ROC_NPC_ACTION_TYPE_SEC = (1 << 8),
  62         ROC_NPC_ACTION_TYPE_COUNT = (1 << 9),
  63         ROC_NPC_ACTION_TYPE_PF = (1 << 10),
  64         ROC_NPC_ACTION_TYPE_VF = (1 << 11),
  65 };
  66
  67 struct roc_npc_action {
  68         enum roc_npc_action_type type; /**< Action type. */
  69         const void *conf; /**< Pointer to action configuration object. */
  70 };
  71
  72 struct roc_npc_action_mark {
  73         uint32_t id; /**< Integer value to return with packets. */
  74 };
  75
  76 struct roc_npc_action_vf {
  77         uint32_t original : 1;  /**< Use original VF ID if possible. */
  78         uint32_t reserved : 31; /**< Reserved, must be zero. */
  79         uint32_t id;            /**< VF ID. */
  80 };
  81
  82 struct roc_npc_action_queue {
  83         uint16_t index; /**< Queue index to use. */
  84 };
  85
  86 struct roc_npc_attr {
  87         uint32_t priority;      /**< Rule priority level within group. */
  88         uint32_t ingress : 1;   /**< Rule applies to ingress traffic. */
  89         uint32_t egress : 1;    /**< Rule applies to egress traffic. */
  90         uint32_t reserved : 30; /**< Reserved, must be zero. */
  91 };
  92
  93 struct roc_npc_flow_dump_data {
  94         uint8_t lid;
  95         uint16_t ltype;
  96 };
  97
  98 struct roc_npc_flow {
  99         uint8_t nix_intf;
 100         uint8_t enable;
 101         uint32_t mcam_id;
 102         int32_t ctr_id;
 103         uint32_t priority;
 104 #define ROC_NPC_MAX_MCAM_WIDTH_DWORDS 7
 105         /* Contiguous match string */
 106         uint64_t mcam_data[ROC_NPC_MAX_MCAM_WIDTH_DWORDS];
 107         uint64_t mcam_mask[ROC_NPC_MAX_MCAM_WIDTH_DWORDS];
 108         uint64_t npc_action;
 109         uint64_t vtag_action;
 110 #define ROC_NPC_MAX_FLOW_PATTERNS 32
 111         struct roc_npc_flow_dump_data dump_data[ROC_NPC_MAX_FLOW_PATTERNS];
 112         uint16_t num_patterns;
 113
 114         TAILQ_ENTRY(roc_npc_flow) next;
 115 };
 116
 117 enum roc_npc_rss_hash_function {
 118         ROC_NPC_RSS_HASH_FUNCTION_DEFAULT = 0,
 119         ROC_NPC_RSS_HASH_FUNCTION_TOEPLITZ,   /**< Toeplitz */
 120         ROC_NPC_RSS_HASH_FUNCTION_SIMPLE_XOR, /**< Simple XOR */
 121         ROC_NPC_RSS_HASH_FUNCTION_SYMMETRIC_TOEPLITZ,
 122         ROC_NPC_RSS_HASH_FUNCTION_MAX,
 123 };
 124
 125 struct roc_npc_action_rss {
 126         enum roc_npc_rss_hash_function func;
 127         uint32_t level;
 128         uint64_t types;        /**< Specific RSS hash types (see ETH_RSS_*). */
 129         uint32_t key_len;      /**< Hash key length in bytes. */
 130         uint32_t queue_num;    /**< Number of entries in @p queue. */
 131         const uint8_t *key;    /**< Hash key. */
 132         const uint16_t *queue; /**< Queue indices to use. */
 133 };
 134
 135 enum roc_npc_intf {
 136         ROC_NPC_INTF_RX = 0,
 137         ROC_NPC_INTF_TX = 1,
 138         ROC_NPC_INTF_MAX = 2,
 139 };
 140
 141 struct roc_npc {
 142         struct roc_nix *roc_nix;
 143         uint8_t switch_header_type;
 144         uint16_t flow_prealloc_size;
 145         uint16_t flow_max_priority;
 146         uint16_t channel;
 147         uint16_t pf_func;
 148         uint64_t kex_capability;
 149         uint64_t rx_parse_nibble;
 150         /* Parsed RSS Flowkey cfg for current flow being created */
 151         uint32_t flowkey_cfg_state;
 152
 153 #define ROC_NPC_MEM_SZ (5 * 1024)
 154         uint8_t reserved[ROC_NPC_MEM_SZ];
 155 } __plt_cache_aligned;
 156
 157 int __roc_api roc_npc_init(struct roc_npc *roc_npc);
 158 int __roc_api roc_npc_fini(struct roc_npc *roc_npc);
 159 const char *__roc_api roc_npc_profile_name_get(struct roc_npc *roc_npc);
 160
 161 struct roc_npc_flow *__roc_api
 162 roc_npc_flow_create(struct roc_npc *roc_npc, const struct roc_npc_attr *attr,
 163                     const struct roc_npc_item_info pattern[],
 164                     const struct roc_npc_action actions[], int *errcode);
 165 int __roc_api roc_npc_flow_destroy(struct roc_npc *roc_npc,
 166                                    struct roc_npc_flow *flow);
 167 int __roc_api roc_npc_mcam_free_entry(struct roc_npc *roc_npc, uint32_t entry);
 168 int __roc_api roc_npc_mcam_alloc_entry(struct roc_npc *roc_npc,
 169                                        struct roc_npc_flow *mcam,
 170                                        struct roc_npc_flow *ref_mcam, int prio,
 171                                        int *resp_count);
 172 int __roc_api roc_npc_mcam_alloc_entries(struct roc_npc *roc_npc, int ref_entry,
 173                                          int *alloc_entry, int req_count,
 174                                          int priority, int *resp_count);
 175 int __roc_api roc_npc_mcam_ena_dis_entry(struct roc_npc *roc_npc,
 176                                          struct roc_npc_flow *mcam,
 177                                          bool enable);
 178 int __roc_api roc_npc_mcam_write_entry(struct roc_npc *roc_npc,
 179                                        struct roc_npc_flow *mcam);
 180 int __roc_api roc_npc_flow_parse(struct roc_npc *roc_npc,
 181                                  const struct roc_npc_attr *attr,
 182                                  const struct roc_npc_item_info pattern[],
 183                                  const struct roc_npc_action actions[],
 184                                  struct roc_npc_flow *flow);
 185 int __roc_api roc_npc_get_low_priority_mcam(struct roc_npc *roc_npc);
 186
 187 int __roc_api roc_npc_mcam_free_counter(struct roc_npc *roc_npc,
 188                                         uint16_t ctr_id);
 189
 190 int __roc_api roc_npc_mcam_read_counter(struct roc_npc *roc_npc,
 191                                         uint32_t ctr_id, uint64_t *count);
 192 int __roc_api roc_npc_mcam_clear_counter(struct roc_npc *roc_npc,
 193                                          uint32_t ctr_id);
 194
 195 int __roc_api roc_npc_mcam_free_all_resources(struct roc_npc *roc_npc);
 196 void __roc_api roc_npc_flow_dump(FILE *file, struct roc_npc *roc_npc);
 197 void __roc_api roc_npc_flow_mcam_dump(FILE *file, struct roc_npc *roc_npc,
 198                                       struct roc_npc_flow *mcam);
 199 int __roc_api roc_npc_mark_actions_get(struct roc_npc *roc_npc);
 200 int __roc_api roc_npc_mark_actions_sub_return(struct roc_npc *roc_npc,
 201                                               uint32_t count);
 202 #endif /* _ROC_NPC_H_ */