drivers/net/sfc/sfc_flow.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  *
   3  * Copyright(c) 2019-2020 Xilinx, Inc.
   4  * Copyright(c) 2017-2019 Solarflare Communications Inc.
   5  *
   6  * This software was jointly developed between OKTET Labs (under contract
   7  * for Solarflare) and Solarflare Communications, Inc.
   8  */
   9
  10 #ifndef _SFC_FLOW_H
  11 #define _SFC_FLOW_H
  12
  13 #include <rte_tailq.h>
  14 #include <rte_flow_driver.h>
  15
  16 #include "efx.h"
  17
  18 #ifdef __cplusplus
  19 extern "C" {
  20 #endif
  21
  22 /*
  23  * The maximum number of fully elaborated hardware filter specifications
  24  * which can be produced from a template by means of multiplication, if
  25  * missing match flags are needed to be taken into account
  26  */
  27 #define SF_FLOW_SPEC_NB_FILTERS_MAX 8
  28
  29 /* RSS configuration storage */
  30 struct sfc_flow_rss {
  31         unsigned int    rxq_hw_index_min;
  32         unsigned int    rxq_hw_index_max;
  33         unsigned int    rss_hash_types;
  34         uint8_t         rss_key[EFX_RSS_KEY_SIZE];
  35         unsigned int    rss_tbl[EFX_RSS_TBL_SIZE];
  36 };
  37
  38 /* Flow engines supported by the implementation */
  39 enum sfc_flow_spec_type {
  40         SFC_FLOW_SPEC_FILTER = 0,
  41         SFC_FLOW_SPEC_MAE,
  42
  43         SFC_FLOW_SPEC_NTYPES
  44 };
  45
  46 /* VNIC-specific flow specification */
  47 struct sfc_flow_spec_filter {
  48         /* partial specification from flow rule */
  49         efx_filter_spec_t template;
  50         /* fully elaborated hardware filters specifications */
  51         efx_filter_spec_t filters[SF_FLOW_SPEC_NB_FILTERS_MAX];
  52         /* number of complete specifications */
  53         unsigned int count;
  54         /* RSS toggle */
  55         boolean_t rss;
  56         /* RSS hash toggle */
  57         boolean_t rss_hash_required;
  58         /* RSS configuration */
  59         struct sfc_flow_rss rss_conf;
  60 };
  61
  62 /* MAE-specific flow specification */
  63 struct sfc_flow_spec_mae {
  64         /* Desired priority level */
  65         unsigned int                    priority;
  66         /* EFX match specification */
  67         efx_mae_match_spec_t            *match_spec;
  68 };
  69
  70 /* Flow specification */
  71 struct sfc_flow_spec {
  72         /* Flow specification type (engine-based) */
  73         enum sfc_flow_spec_type type;
  74
  75         RTE_STD_C11
  76         union {
  77                 /* Filter-based (VNIC level flows) specification */
  78                 struct sfc_flow_spec_filter filter;
  79                 /* MAE-based (lower-level HW switch flows) specification */
  80                 struct sfc_flow_spec_mae mae;
  81         };
  82 };
  83
  84 /* PMD-specific definition of the opaque type from rte_flow.h */
  85 struct rte_flow {
  86         struct sfc_flow_spec spec;      /* flow specification */
  87         TAILQ_ENTRY(rte_flow) entries;  /* flow list entries */
  88 };
  89
  90 TAILQ_HEAD(sfc_flow_list, rte_flow);
  91
  92 extern const struct rte_flow_ops sfc_flow_ops;
  93
  94 enum sfc_flow_item_layers {
  95         SFC_FLOW_ITEM_ANY_LAYER,
  96         SFC_FLOW_ITEM_START_LAYER,
  97         SFC_FLOW_ITEM_L2,
  98         SFC_FLOW_ITEM_L3,
  99         SFC_FLOW_ITEM_L4,
 100 };
 101
 102 /* Flow parse context types */
 103 enum sfc_flow_parse_ctx_type {
 104         SFC_FLOW_PARSE_CTX_FILTER = 0,
 105         SFC_FLOW_PARSE_CTX_MAE,
 106
 107         SFC_FLOW_PARSE_CTX_NTYPES
 108 };
 109
 110 /* Flow parse context */
 111 struct sfc_flow_parse_ctx {
 112         enum sfc_flow_parse_ctx_type type;
 113
 114         RTE_STD_C11
 115         union {
 116                 /* Context pointer valid for filter-based (VNIC) flows */
 117                 efx_filter_spec_t *filter;
 118                 /* Context pointer valid for MAE-based flows */
 119                 struct sfc_mae_parse_ctx *mae;
 120         };
 121 };
 122
 123 typedef int (sfc_flow_item_parse)(const struct rte_flow_item *item,
 124                                   struct sfc_flow_parse_ctx *parse_ctx,
 125                                   struct rte_flow_error *error);
 126
 127 struct sfc_flow_item {
 128         enum rte_flow_item_type type;           /* Type of item */
 129         enum sfc_flow_item_layers layer;        /* Layer of item */
 130         enum sfc_flow_item_layers prev_layer;   /* Previous layer of item */
 131         enum sfc_flow_parse_ctx_type ctx_type;  /* Parse context type */
 132         sfc_flow_item_parse *parse;             /* Parsing function */
 133 };
 134
 135 int sfc_flow_parse_pattern(const struct sfc_flow_item *flow_items,
 136                            unsigned int nb_flow_items,
 137                            const struct rte_flow_item pattern[],
 138                            struct sfc_flow_parse_ctx *parse_ctx,
 139                            struct rte_flow_error *error);
 140
 141 int sfc_flow_parse_init(const struct rte_flow_item *item,
 142                         const void **spec_ptr,
 143                         const void **mask_ptr,
 144                         const void *supp_mask,
 145                         const void *def_mask,
 146                         unsigned int size,
 147                         struct rte_flow_error *error);
 148
 149 struct sfc_adapter;
 150
 151 void sfc_flow_init(struct sfc_adapter *sa);
 152 void sfc_flow_fini(struct sfc_adapter *sa);
 153 int sfc_flow_start(struct sfc_adapter *sa);
 154 void sfc_flow_stop(struct sfc_adapter *sa);
 155
 156 typedef int (sfc_flow_parse_cb_t)(struct rte_eth_dev *dev,
 157                                   const struct rte_flow_item items[],
 158                                   const struct rte_flow_action actions[],
 159                                   struct rte_flow *flow,
 160                                   struct rte_flow_error *error);
 161
 162 typedef int (sfc_flow_verify_cb_t)(struct sfc_adapter *sa,
 163                                    struct rte_flow *flow);
 164
 165 typedef void (sfc_flow_cleanup_cb_t)(struct sfc_adapter *sa,
 166                                      struct rte_flow *flow);
 167
 168 typedef int (sfc_flow_insert_cb_t)(struct sfc_adapter *sa,
 169                                    struct rte_flow *flow);
 170
 171 typedef int (sfc_flow_remove_cb_t)(struct sfc_adapter *sa,
 172                                    struct rte_flow *flow);
 173
 174 #ifdef __cplusplus
 175 }
 176 #endif
 177 #endif /* _SFC_FLOW_H */