drivers/net/octeontx2/otx2_flow.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(C) 2019 Marvell International Ltd.
   3  */
   4
   5 #ifndef __OTX2_FLOW_H__
   6 #define __OTX2_FLOW_H__
   7
   8 #include <stdint.h>
   9
  10 #include <rte_flow_driver.h>
  11 #include <rte_malloc.h>
  12 #include <rte_tailq.h>
  13
  14 #include "otx2_common.h"
  15 #include "otx2_ethdev.h"
  16 #include "otx2_mbox.h"
  17
  18 struct otx2_eth_dev;
  19
  20 int otx2_flow_init(struct otx2_eth_dev *hw);
  21 int otx2_flow_fini(struct otx2_eth_dev *hw);
  22 extern const struct rte_flow_ops otx2_flow_ops;
  23
  24 enum {
  25         OTX2_INTF_RX = 0,
  26         OTX2_INTF_TX = 1,
  27         OTX2_INTF_MAX = 2,
  28 };
  29
  30 #define NPC_IH_LENGTH                   8
  31 #define NPC_TPID_LENGTH                 2
  32 #define NPC_HIGIG2_LENGTH               16
  33 #define NPC_MAX_RAW_ITEM_LEN            16
  34 #define NPC_COUNTER_NONE                (-1)
  35 /* 32 bytes from LDATA_CFG & 32 bytes from FLAGS_CFG */
  36 #define NPC_MAX_EXTRACT_DATA_LEN        (64)
  37 #define NPC_LDATA_LFLAG_LEN             (16)
  38 #define NPC_MAX_KEY_NIBBLES             (31)
  39 /* Nibble offsets */
  40 #define NPC_LAYER_KEYX_SZ               (3)
  41 #define NPC_PARSE_KEX_S_LA_OFFSET       (7)
  42 #define NPC_PARSE_KEX_S_LID_OFFSET(lid)         \
  43         ((((lid) - NPC_LID_LA) * NPC_LAYER_KEYX_SZ)  \
  44         + NPC_PARSE_KEX_S_LA_OFFSET)
  45
  46
  47 /* supported flow actions flags */
  48 #define OTX2_FLOW_ACT_MARK    (1 << 0)
  49 #define OTX2_FLOW_ACT_FLAG    (1 << 1)
  50 #define OTX2_FLOW_ACT_DROP    (1 << 2)
  51 #define OTX2_FLOW_ACT_QUEUE   (1 << 3)
  52 #define OTX2_FLOW_ACT_RSS     (1 << 4)
  53 #define OTX2_FLOW_ACT_DUP     (1 << 5)
  54 #define OTX2_FLOW_ACT_SEC     (1 << 6)
  55 #define OTX2_FLOW_ACT_COUNT   (1 << 7)
  56 #define OTX2_FLOW_ACT_PF      (1 << 8)
  57 #define OTX2_FLOW_ACT_VF      (1 << 9)
  58 #define OTX2_FLOW_ACT_VLAN_STRIP (1 << 10)
  59 #define OTX2_FLOW_ACT_VLAN_INSERT (1 << 11)
  60 #define OTX2_FLOW_ACT_VLAN_ETHTYPE_INSERT (1 << 12)
  61 #define OTX2_FLOW_ACT_VLAN_PCP_INSERT (1 << 13)
  62
  63 /* terminating actions */
  64 #define OTX2_FLOW_ACT_TERM    (OTX2_FLOW_ACT_DROP  | \
  65                                OTX2_FLOW_ACT_QUEUE | \
  66                                OTX2_FLOW_ACT_RSS   | \
  67                                OTX2_FLOW_ACT_DUP   | \
  68                                OTX2_FLOW_ACT_SEC)
  69
  70 /* This mark value indicates flag action */
  71 #define OTX2_FLOW_FLAG_VAL    (0xffff)
  72
  73 #define NIX_RX_ACT_MATCH_OFFSET         (40)
  74 #define NIX_RX_ACT_MATCH_MASK           (0xFFFF)
  75
  76 #define NIX_RSS_ACT_GRP_OFFSET          (20)
  77 #define NIX_RSS_ACT_ALG_OFFSET          (56)
  78 #define NIX_RSS_ACT_GRP_MASK            (0xFFFFF)
  79 #define NIX_RSS_ACT_ALG_MASK            (0x1F)
  80
  81 /* PMD-specific definition of the opaque struct rte_flow */
  82 #define OTX2_MAX_MCAM_WIDTH_DWORDS      7
  83
  84 enum npc_mcam_intf {
  85         NPC_MCAM_RX,
  86         NPC_MCAM_TX
  87 };
  88
  89 struct npc_xtract_info {
  90         /* Length in bytes of pkt data extracted. len = 0
  91          * indicates that extraction is disabled.
  92          */
  93         uint8_t len;
  94         uint8_t hdr_off; /* Byte offset of proto hdr: extract_src */
  95         uint8_t key_off; /* Byte offset in MCAM key where data is placed */
  96         uint8_t enable; /* Extraction enabled or disabled */
  97         uint8_t flags_enable; /* Flags extraction enabled */
  98 };
  99
 100 /* Information for a given {LAYER, LTYPE} */
 101 struct npc_lid_lt_xtract_info {
 102         /* Info derived from parser configuration */
 103         uint16_t npc_proto;              /* Network protocol identified */
 104         uint8_t  valid_flags_mask;       /* Flags applicable */
 105         uint8_t  is_terminating:1;       /* No more parsing */
 106         struct npc_xtract_info xtract[NPC_MAX_LD];
 107 };
 108
 109 union npc_kex_ldata_flags_cfg {
 110         struct {
 111         #if defined(__BIG_ENDIAN_BITFIELD)
 112                 uint64_t rvsd_62_1      : 61;
 113                 uint64_t lid            : 3;
 114         #else
 115                 uint64_t lid            : 3;
 116                 uint64_t rvsd_62_1      : 61;
 117         #endif
 118         } s;
 119
 120         uint64_t i;
 121 };
 122
 123 typedef struct npc_lid_lt_xtract_info
 124         otx2_dxcfg_t[NPC_MAX_INTF][NPC_MAX_LID][NPC_MAX_LT];
 125 typedef struct npc_lid_lt_xtract_info
 126         otx2_fxcfg_t[NPC_MAX_INTF][NPC_MAX_LD][NPC_MAX_LFL];
 127 typedef union npc_kex_ldata_flags_cfg otx2_ld_flags_t[NPC_MAX_LD];
 128
 129
 130 /* MBOX_MSG_NPC_GET_DATAX_CFG Response */
 131 struct npc_get_datax_cfg {
 132         /* NPC_AF_KEX_LDATA(0..1)_FLAGS_CFG */
 133         union npc_kex_ldata_flags_cfg ld_flags[NPC_MAX_LD];
 134         /* Extract information indexed with [LID][LTYPE] */
 135         struct npc_lid_lt_xtract_info lid_lt_xtract[NPC_MAX_LID][NPC_MAX_LT];
 136         /* Flags based extract indexed with [LDATA][FLAGS_LOWER_NIBBLE]
 137          * Fields flags_ena_ld0, flags_ena_ld1 in
 138          * struct npc_lid_lt_xtract_info indicate if this is applicable
 139          * for a given {LAYER, LTYPE}
 140          */
 141         struct npc_xtract_info flag_xtract[NPC_MAX_LD][NPC_MAX_LT];
 142 };
 143
 144 struct otx2_mcam_ents_info {
 145         /* Current max & min values of mcam index */
 146         uint32_t max_id;
 147         uint32_t min_id;
 148         uint32_t free_ent;
 149         uint32_t live_ent;
 150 };
 151
 152 struct otx2_flow_dump_data {
 153         uint8_t lid;
 154         uint16_t ltype;
 155 };
 156
 157 struct rte_flow {
 158         uint8_t  nix_intf;
 159         uint32_t  mcam_id;
 160         int32_t ctr_id;
 161         uint32_t priority;
 162         /* Contiguous match string */
 163         uint64_t mcam_data[OTX2_MAX_MCAM_WIDTH_DWORDS];
 164         uint64_t mcam_mask[OTX2_MAX_MCAM_WIDTH_DWORDS];
 165         uint64_t npc_action;
 166         uint64_t vtag_action;
 167         struct otx2_flow_dump_data dump_data[32];
 168         uint16_t num_patterns;
 169         TAILQ_ENTRY(rte_flow) next;
 170 };
 171
 172 TAILQ_HEAD(otx2_flow_list, rte_flow);
 173
 174 /* Accessed from ethdev private - otx2_eth_dev */
 175 struct otx2_npc_flow_info {
 176         rte_atomic32_t mark_actions;
 177         uint32_t vtag_actions;
 178         uint32_t keyx_supp_nmask[NPC_MAX_INTF];/* nibble mask */
 179         uint32_t keyx_len[NPC_MAX_INTF];        /* per intf key len in bits */
 180         uint32_t datax_len[NPC_MAX_INTF];       /* per intf data len in bits */
 181         uint32_t keyw[NPC_MAX_INTF];            /* max key + data len bits */
 182         uint32_t mcam_entries;                  /* mcam entries supported */
 183         otx2_dxcfg_t prx_dxcfg;                 /* intf, lid, lt, extract */
 184         otx2_fxcfg_t prx_fxcfg;                 /* Flag extract */
 185         otx2_ld_flags_t prx_lfcfg;              /* KEX LD_Flags CFG */
 186         /* mcam entry info per priority level: both free & in-use */
 187         struct otx2_mcam_ents_info *flow_entry_info;
 188         /* Bitmap of free preallocated entries in ascending index &
 189          * descending priority
 190          */
 191         struct rte_bitmap **free_entries;
 192         /* Bitmap of free preallocated entries in descending index &
 193          * ascending priority
 194          */
 195         struct rte_bitmap **free_entries_rev;
 196         /* Bitmap of live entries in ascending index & descending priority */
 197         struct rte_bitmap **live_entries;
 198         /* Bitmap of live entries in descending index & ascending priority */
 199         struct rte_bitmap **live_entries_rev;
 200         /* Priority bucket wise tail queue of all rte_flow resources */
 201         struct otx2_flow_list *flow_list;
 202         uint32_t rss_grps;  /* rss groups supported */
 203         struct rte_bitmap *rss_grp_entries;
 204         uint16_t channel; /*rx channel */
 205         uint16_t flow_prealloc_size;
 206         uint16_t flow_max_priority;
 207         uint16_t switch_header_type;
 208 };
 209
 210 struct otx2_parse_state {
 211         struct otx2_npc_flow_info *npc;
 212         const struct rte_flow_item *pattern;
 213         const struct rte_flow_item *last_pattern; /* Temp usage */
 214         struct rte_flow_error *error;
 215         struct rte_flow *flow;
 216         uint8_t tunnel;
 217         uint8_t terminate;
 218         uint8_t layer_mask;
 219         uint8_t lt[NPC_MAX_LID];
 220         uint8_t flags[NPC_MAX_LID];
 221         uint8_t *mcam_data; /* point to flow->mcam_data + key_len */
 222         uint8_t *mcam_mask; /* point to flow->mcam_mask + key_len */
 223         bool is_vf;
 224 };
 225
 226 struct otx2_flow_item_info {
 227         const void *def_mask; /* rte_flow default mask */
 228         void *hw_mask;        /* hardware supported mask */
 229         int  len;             /* length of item */
 230         const void *spec;     /* spec to use, NULL implies match any */
 231         const void *mask;     /* mask to use */
 232         uint8_t hw_hdr_len;  /* Extra data len at each layer*/
 233 };
 234
 235 struct otx2_idev_kex_cfg {
 236         struct npc_get_kex_cfg_rsp kex_cfg;
 237         rte_atomic16_t kex_refcnt;
 238 };
 239
 240 enum npc_kpu_parser_flag {
 241         NPC_F_NA = 0,
 242         NPC_F_PKI,
 243         NPC_F_PKI_VLAN,
 244         NPC_F_PKI_ETAG,
 245         NPC_F_PKI_ITAG,
 246         NPC_F_PKI_MPLS,
 247         NPC_F_PKI_NSH,
 248         NPC_F_ETYPE_UNK,
 249         NPC_F_ETHER_VLAN,
 250         NPC_F_ETHER_ETAG,
 251         NPC_F_ETHER_ITAG,
 252         NPC_F_ETHER_MPLS,
 253         NPC_F_ETHER_NSH,
 254         NPC_F_STAG_CTAG,
 255         NPC_F_STAG_CTAG_UNK,
 256         NPC_F_STAG_STAG_CTAG,
 257         NPC_F_STAG_STAG_STAG,
 258         NPC_F_QINQ_CTAG,
 259         NPC_F_QINQ_CTAG_UNK,
 260         NPC_F_QINQ_QINQ_CTAG,
 261         NPC_F_QINQ_QINQ_QINQ,
 262         NPC_F_BTAG_ITAG,
 263         NPC_F_BTAG_ITAG_STAG,
 264         NPC_F_BTAG_ITAG_CTAG,
 265         NPC_F_BTAG_ITAG_UNK,
 266         NPC_F_ETAG_CTAG,
 267         NPC_F_ETAG_BTAG_ITAG,
 268         NPC_F_ETAG_STAG,
 269         NPC_F_ETAG_QINQ,
 270         NPC_F_ETAG_ITAG,
 271         NPC_F_ETAG_ITAG_STAG,
 272         NPC_F_ETAG_ITAG_CTAG,
 273         NPC_F_ETAG_ITAG_UNK,
 274         NPC_F_ITAG_STAG_CTAG,
 275         NPC_F_ITAG_STAG,
 276         NPC_F_ITAG_CTAG,
 277         NPC_F_MPLS_4_LABELS,
 278         NPC_F_MPLS_3_LABELS,
 279         NPC_F_MPLS_2_LABELS,
 280         NPC_F_IP_HAS_OPTIONS,
 281         NPC_F_IP_IP_IN_IP,
 282         NPC_F_IP_6TO4,
 283         NPC_F_IP_MPLS_IN_IP,
 284         NPC_F_IP_UNK_PROTO,
 285         NPC_F_IP_IP_IN_IP_HAS_OPTIONS,
 286         NPC_F_IP_6TO4_HAS_OPTIONS,
 287         NPC_F_IP_MPLS_IN_IP_HAS_OPTIONS,
 288         NPC_F_IP_UNK_PROTO_HAS_OPTIONS,
 289         NPC_F_IP6_HAS_EXT,
 290         NPC_F_IP6_TUN_IP6,
 291         NPC_F_IP6_MPLS_IN_IP,
 292         NPC_F_TCP_HAS_OPTIONS,
 293         NPC_F_TCP_HTTP,
 294         NPC_F_TCP_HTTPS,
 295         NPC_F_TCP_PPTP,
 296         NPC_F_TCP_UNK_PORT,
 297         NPC_F_TCP_HTTP_HAS_OPTIONS,
 298         NPC_F_TCP_HTTPS_HAS_OPTIONS,
 299         NPC_F_TCP_PPTP_HAS_OPTIONS,
 300         NPC_F_TCP_UNK_PORT_HAS_OPTIONS,
 301         NPC_F_UDP_VXLAN,
 302         NPC_F_UDP_VXLAN_NOVNI,
 303         NPC_F_UDP_VXLAN_NOVNI_NSH,
 304         NPC_F_UDP_VXLANGPE,
 305         NPC_F_UDP_VXLANGPE_NSH,
 306         NPC_F_UDP_VXLANGPE_MPLS,
 307         NPC_F_UDP_VXLANGPE_NOVNI,
 308         NPC_F_UDP_VXLANGPE_NOVNI_NSH,
 309         NPC_F_UDP_VXLANGPE_NOVNI_MPLS,
 310         NPC_F_UDP_VXLANGPE_UNK,
 311         NPC_F_UDP_VXLANGPE_NONP,
 312         NPC_F_UDP_GTP_GTPC,
 313         NPC_F_UDP_GTP_GTPU_G_PDU,
 314         NPC_F_UDP_GTP_GTPU_UNK,
 315         NPC_F_UDP_UNK_PORT,
 316         NPC_F_UDP_GENEVE,
 317         NPC_F_UDP_GENEVE_OAM,
 318         NPC_F_UDP_GENEVE_CRI_OPT,
 319         NPC_F_UDP_GENEVE_OAM_CRI_OPT,
 320         NPC_F_GRE_NVGRE,
 321         NPC_F_GRE_HAS_SRE,
 322         NPC_F_GRE_HAS_CSUM,
 323         NPC_F_GRE_HAS_KEY,
 324         NPC_F_GRE_HAS_SEQ,
 325         NPC_F_GRE_HAS_CSUM_KEY,
 326         NPC_F_GRE_HAS_CSUM_SEQ,
 327         NPC_F_GRE_HAS_KEY_SEQ,
 328         NPC_F_GRE_HAS_CSUM_KEY_SEQ,
 329         NPC_F_GRE_HAS_ROUTE,
 330         NPC_F_GRE_UNK_PROTO,
 331         NPC_F_GRE_VER1,
 332         NPC_F_GRE_VER1_HAS_SEQ,
 333         NPC_F_GRE_VER1_HAS_ACK,
 334         NPC_F_GRE_VER1_HAS_SEQ_ACK,
 335         NPC_F_GRE_VER1_UNK_PROTO,
 336         NPC_F_TU_ETHER_UNK,
 337         NPC_F_TU_ETHER_CTAG,
 338         NPC_F_TU_ETHER_CTAG_UNK,
 339         NPC_F_TU_ETHER_STAG_CTAG,
 340         NPC_F_TU_ETHER_STAG_CTAG_UNK,
 341         NPC_F_TU_ETHER_STAG,
 342         NPC_F_TU_ETHER_STAG_UNK,
 343         NPC_F_TU_ETHER_QINQ_CTAG,
 344         NPC_F_TU_ETHER_QINQ_CTAG_UNK,
 345         NPC_F_TU_ETHER_QINQ,
 346         NPC_F_TU_ETHER_QINQ_UNK,
 347         NPC_F_LAST /* has to be the last item */
 348 };
 349
 350
 351 int otx2_flow_mcam_free_counter(struct otx2_mbox *mbox, uint16_t ctr_id);
 352
 353 int otx2_flow_mcam_read_counter(struct otx2_mbox *mbox, uint32_t ctr_id,
 354                                 uint64_t *count);
 355
 356 int otx2_flow_mcam_clear_counter(struct otx2_mbox *mbox, uint32_t ctr_id);
 357
 358 int otx2_flow_mcam_free_entry(struct otx2_mbox *mbox, uint32_t entry);
 359
 360 int otx2_flow_mcam_free_all_entries(struct otx2_mbox *mbox);
 361
 362 int otx2_flow_update_parse_state(struct otx2_parse_state *pst,
 363                                  struct otx2_flow_item_info *info,
 364                                  int lid, int lt, uint8_t flags);
 365
 366 int otx2_flow_parse_item_basic(const struct rte_flow_item *item,
 367                                struct otx2_flow_item_info *info,
 368                                struct rte_flow_error *error);
 369
 370 void otx2_flow_keyx_compress(uint64_t *data, uint32_t nibble_mask);
 371
 372 int otx2_flow_mcam_alloc_and_write(struct rte_flow *flow,
 373                                    struct otx2_mbox *mbox,
 374                                    struct otx2_parse_state *pst,
 375                                    struct otx2_npc_flow_info *flow_info);
 376
 377 void otx2_flow_get_hw_supp_mask(struct otx2_parse_state *pst,
 378                                 struct otx2_flow_item_info *info,
 379                                 int lid, int lt);
 380
 381 const struct rte_flow_item *
 382 otx2_flow_skip_void_and_any_items(const struct rte_flow_item *pattern);
 383
 384 int otx2_flow_parse_lh(struct otx2_parse_state *pst);
 385
 386 int otx2_flow_parse_lg(struct otx2_parse_state *pst);
 387
 388 int otx2_flow_parse_lf(struct otx2_parse_state *pst);
 389
 390 int otx2_flow_parse_le(struct otx2_parse_state *pst);
 391
 392 int otx2_flow_parse_ld(struct otx2_parse_state *pst);
 393
 394 int otx2_flow_parse_lc(struct otx2_parse_state *pst);
 395
 396 int otx2_flow_parse_lb(struct otx2_parse_state *pst);
 397
 398 int otx2_flow_parse_la(struct otx2_parse_state *pst);
 399
 400 int otx2_flow_parse_higig2_hdr(struct otx2_parse_state *pst);
 401
 402 int otx2_flow_parse_actions(struct rte_eth_dev *dev,
 403                             const struct rte_flow_attr *attr,
 404                             const struct rte_flow_action actions[],
 405                             struct rte_flow_error *error,
 406                             struct rte_flow *flow);
 407
 408 int otx2_flow_free_all_resources(struct otx2_eth_dev *hw);
 409
 410 int otx2_flow_parse_mpls(struct otx2_parse_state *pst, int lid);
 411
 412 void otx2_flow_dump(FILE *file, struct otx2_eth_dev *hw,
 413                     struct rte_flow *flow);
 414 #endif /* __OTX2_FLOW_H__ */