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         ROC_NPC_ACTION_TYPE_VLAN_STRIP = (1 << 12),
  66         ROC_NPC_ACTION_TYPE_VLAN_INSERT = (1 << 13),
  67         ROC_NPC_ACTION_TYPE_VLAN_ETHTYPE_INSERT = (1 << 14),
  68         ROC_NPC_ACTION_TYPE_VLAN_PCP_INSERT = (1 << 15),
  69 };
  70
  71 struct roc_npc_action {
  72         enum roc_npc_action_type type; /**< Action type. */
  73         const void *conf; /**< Pointer to action configuration object. */
  74 };
  75
  76 struct roc_npc_action_mark {
  77         uint32_t id; /**< Integer value to return with packets. */
  78 };
  79
  80 struct roc_npc_action_vf {
  81         uint32_t original : 1;  /**< Use original VF ID if possible. */
  82         uint32_t reserved : 31; /**< Reserved, must be zero. */
  83         uint32_t id;            /**< VF ID. */
  84 };
  85
  86 struct roc_npc_action_queue {
  87         uint16_t index; /**< Queue index to use. */
  88 };
  89
  90 struct roc_npc_action_of_push_vlan {
  91         uint16_t ethertype; /**< EtherType. */
  92 };
  93
  94 struct roc_npc_action_of_set_vlan_vid {
  95         uint16_t vlan_vid; /**< VLAN id. */
  96 };
  97
  98 struct roc_npc_action_of_set_vlan_pcp {
  99         uint8_t vlan_pcp; /**< VLAN priority. */
 100 };
 101
 102 struct roc_npc_attr {
 103         uint32_t priority;      /**< Rule priority level within group. */
 104         uint32_t ingress : 1;   /**< Rule applies to ingress traffic. */
 105         uint32_t egress : 1;    /**< Rule applies to egress traffic. */
 106         uint32_t reserved : 30; /**< Reserved, must be zero. */
 107 };
 108
 109 struct roc_npc_flow_dump_data {
 110         uint8_t lid;
 111         uint16_t ltype;
 112 };
 113
 114 struct roc_npc_flow {
 115         uint8_t nix_intf;
 116         uint8_t enable;
 117         uint32_t mcam_id;
 118         int32_t ctr_id;
 119         uint32_t priority;
 120 #define ROC_NPC_MAX_MCAM_WIDTH_DWORDS 7
 121         /* Contiguous match string */
 122         uint64_t mcam_data[ROC_NPC_MAX_MCAM_WIDTH_DWORDS];
 123         uint64_t mcam_mask[ROC_NPC_MAX_MCAM_WIDTH_DWORDS];
 124         uint64_t npc_action;
 125         uint64_t vtag_action;
 126         bool vtag_insert_enabled;
 127 #define ROC_NPC_MAX_FLOW_PATTERNS 32
 128         struct roc_npc_flow_dump_data dump_data[ROC_NPC_MAX_FLOW_PATTERNS];
 129         uint16_t num_patterns;
 130
 131         TAILQ_ENTRY(roc_npc_flow) next;
 132 };
 133
 134 enum roc_npc_rss_hash_function {
 135         ROC_NPC_RSS_HASH_FUNCTION_DEFAULT = 0,
 136         ROC_NPC_RSS_HASH_FUNCTION_TOEPLITZ,   /**< Toeplitz */
 137         ROC_NPC_RSS_HASH_FUNCTION_SIMPLE_XOR, /**< Simple XOR */
 138         ROC_NPC_RSS_HASH_FUNCTION_SYMMETRIC_TOEPLITZ,
 139         ROC_NPC_RSS_HASH_FUNCTION_MAX,
 140 };
 141
 142 struct roc_npc_action_rss {
 143         enum roc_npc_rss_hash_function func;
 144         uint32_t level;
 145         uint64_t types;        /**< Specific RSS hash types (see ETH_RSS_*). */
 146         uint32_t key_len;      /**< Hash key length in bytes. */
 147         uint32_t queue_num;    /**< Number of entries in @p queue. */
 148         const uint8_t *key;    /**< Hash key. */
 149         const uint16_t *queue; /**< Queue indices to use. */
 150 };
 151
 152 enum roc_npc_intf {
 153         ROC_NPC_INTF_RX = 0,
 154         ROC_NPC_INTF_TX = 1,
 155         ROC_NPC_INTF_MAX = 2,
 156 };
 157
 158 enum flow_vtag_cfg_dir { VTAG_TX, VTAG_RX };
 159 #define ROC_ETHER_TYPE_VLAN 0x8100 /**< IEEE 802.1Q VLAN tagging. */
 160 #define ROC_ETHER_TYPE_QINQ 0x88A8 /**< IEEE 802.1ad QinQ tagging. */
 161
 162 struct roc_npc {
 163         struct roc_nix *roc_nix;
 164         uint8_t switch_header_type;
 165         uint16_t flow_prealloc_size;
 166         uint16_t flow_max_priority;
 167         uint16_t channel;
 168         uint16_t pf_func;
 169         uint64_t kex_capability;
 170         uint64_t rx_parse_nibble;
 171         /* Parsed RSS Flowkey cfg for current flow being created */
 172         uint32_t flowkey_cfg_state;
 173
 174 #define ROC_NPC_MEM_SZ (5 * 1024)
 175         uint8_t reserved[ROC_NPC_MEM_SZ];
 176 } __plt_cache_aligned;
 177
 178 int __roc_api roc_npc_init(struct roc_npc *roc_npc);
 179 int __roc_api roc_npc_fini(struct roc_npc *roc_npc);
 180 const char *__roc_api roc_npc_profile_name_get(struct roc_npc *roc_npc);
 181
 182 struct roc_npc_flow *__roc_api
 183 roc_npc_flow_create(struct roc_npc *roc_npc, const struct roc_npc_attr *attr,
 184                     const struct roc_npc_item_info pattern[],
 185                     const struct roc_npc_action actions[], int *errcode);
 186 int __roc_api roc_npc_flow_destroy(struct roc_npc *roc_npc,
 187                                    struct roc_npc_flow *flow);
 188 int __roc_api roc_npc_mcam_free_entry(struct roc_npc *roc_npc, uint32_t entry);
 189 int __roc_api roc_npc_mcam_alloc_entry(struct roc_npc *roc_npc,
 190                                        struct roc_npc_flow *mcam,
 191                                        struct roc_npc_flow *ref_mcam, int prio,
 192                                        int *resp_count);
 193 int __roc_api roc_npc_mcam_alloc_entries(struct roc_npc *roc_npc, int ref_entry,
 194                                          int *alloc_entry, int req_count,
 195                                          int priority, int *resp_count);
 196 int __roc_api roc_npc_mcam_ena_dis_entry(struct roc_npc *roc_npc,
 197                                          struct roc_npc_flow *mcam,
 198                                          bool enable);
 199 int __roc_api roc_npc_mcam_write_entry(struct roc_npc *roc_npc,
 200                                        struct roc_npc_flow *mcam);
 201 int __roc_api roc_npc_flow_parse(struct roc_npc *roc_npc,
 202                                  const struct roc_npc_attr *attr,
 203                                  const struct roc_npc_item_info pattern[],
 204                                  const struct roc_npc_action actions[],
 205                                  struct roc_npc_flow *flow);
 206 int __roc_api roc_npc_get_low_priority_mcam(struct roc_npc *roc_npc);
 207
 208 int __roc_api roc_npc_mcam_free_counter(struct roc_npc *roc_npc,
 209                                         uint16_t ctr_id);
 210
 211 int __roc_api roc_npc_mcam_read_counter(struct roc_npc *roc_npc,
 212                                         uint32_t ctr_id, uint64_t *count);
 213 int __roc_api roc_npc_mcam_clear_counter(struct roc_npc *roc_npc,
 214                                          uint32_t ctr_id);
 215
 216 int __roc_api roc_npc_mcam_free_all_resources(struct roc_npc *roc_npc);
 217 void __roc_api roc_npc_flow_dump(FILE *file, struct roc_npc *roc_npc);
 218 void __roc_api roc_npc_flow_mcam_dump(FILE *file, struct roc_npc *roc_npc,
 219                                       struct roc_npc_flow *mcam);
 220 int __roc_api roc_npc_mark_actions_get(struct roc_npc *roc_npc);
 221 int __roc_api roc_npc_mark_actions_sub_return(struct roc_npc *roc_npc,
 222                                               uint32_t count);
 223 int __roc_api roc_npc_vtag_actions_get(struct roc_npc *roc_npc);
 224 int __roc_api roc_npc_vtag_actions_sub_return(struct roc_npc *roc_npc,
 225                                               uint32_t count);
 226 #endif /* _ROC_NPC_H_ */