net/i40e: fix Rx packet statistics
[dpdk.git] / drivers / net / sfc / sfc_flow.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  *
3  * Copyright(c) 2019-2021 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 /* Used to guard action masks */
30 #define SFC_BUILD_SET_OVERFLOW(_action, _set) \
31         RTE_BUILD_BUG_ON((_action) >= sizeof(_set) * CHAR_BIT)
32
33 /* RSS configuration storage */
34 struct sfc_flow_rss {
35         unsigned int    rxq_hw_index_min;
36         unsigned int    rxq_hw_index_max;
37         unsigned int    rss_hash_types;
38         uint8_t         rss_key[EFX_RSS_KEY_SIZE];
39         unsigned int    rss_tbl[EFX_RSS_TBL_SIZE];
40 };
41
42 /* Flow engines supported by the implementation */
43 enum sfc_flow_spec_type {
44         SFC_FLOW_SPEC_FILTER = 0,
45         SFC_FLOW_SPEC_MAE,
46
47         SFC_FLOW_SPEC_NTYPES
48 };
49
50 /* VNIC-specific flow specification */
51 struct sfc_flow_spec_filter {
52         /* partial specification from flow rule */
53         efx_filter_spec_t template;
54         /* fully elaborated hardware filters specifications */
55         efx_filter_spec_t filters[SF_FLOW_SPEC_NB_FILTERS_MAX];
56         /* number of complete specifications */
57         unsigned int count;
58         /* RSS toggle */
59         boolean_t rss;
60         /* RSS hash toggle */
61         boolean_t rss_hash_required;
62         /* RSS configuration */
63         struct sfc_flow_rss rss_conf;
64 };
65
66 /* MAE-specific flow specification */
67 struct sfc_flow_spec_mae {
68         /* Desired priority level */
69         unsigned int                    priority;
70         /* Outer rule registry entry */
71         struct sfc_mae_outer_rule       *outer_rule;
72         /* EFX match specification */
73         efx_mae_match_spec_t            *match_spec;
74         /* Action set registry entry */
75         struct sfc_mae_action_set       *action_set;
76         /* Firmware-allocated rule ID */
77         efx_mae_rule_id_t               rule_id;
78 };
79
80 /* Flow specification */
81 struct sfc_flow_spec {
82         /* Flow specification type (engine-based) */
83         enum sfc_flow_spec_type type;
84
85         RTE_STD_C11
86         union {
87                 /* Filter-based (VNIC level flows) specification */
88                 struct sfc_flow_spec_filter filter;
89                 /* MAE-based (lower-level HW switch flows) specification */
90                 struct sfc_flow_spec_mae mae;
91         };
92 };
93
94 /* PMD-specific definition of the opaque type from rte_flow.h */
95 struct rte_flow {
96         struct sfc_flow_spec spec;      /* flow specification */
97         TAILQ_ENTRY(rte_flow) entries;  /* flow list entries */
98 };
99
100 TAILQ_HEAD(sfc_flow_list, rte_flow);
101
102 extern const struct rte_flow_ops sfc_flow_ops;
103
104 enum sfc_flow_item_layers {
105         SFC_FLOW_ITEM_ANY_LAYER,
106         SFC_FLOW_ITEM_START_LAYER,
107         SFC_FLOW_ITEM_L2,
108         SFC_FLOW_ITEM_L3,
109         SFC_FLOW_ITEM_L4,
110 };
111
112 /* Flow parse context types */
113 enum sfc_flow_parse_ctx_type {
114         SFC_FLOW_PARSE_CTX_FILTER = 0,
115         SFC_FLOW_PARSE_CTX_MAE,
116
117         SFC_FLOW_PARSE_CTX_NTYPES
118 };
119
120 /* Flow parse context */
121 struct sfc_flow_parse_ctx {
122         enum sfc_flow_parse_ctx_type type;
123
124         RTE_STD_C11
125         union {
126                 /* Context pointer valid for filter-based (VNIC) flows */
127                 efx_filter_spec_t *filter;
128                 /* Context pointer valid for MAE-based flows */
129                 struct sfc_mae_parse_ctx *mae;
130         };
131 };
132
133 typedef int (sfc_flow_item_parse)(const struct rte_flow_item *item,
134                                   struct sfc_flow_parse_ctx *parse_ctx,
135                                   struct rte_flow_error *error);
136
137 struct sfc_flow_item {
138         enum rte_flow_item_type type;           /* Type of item */
139         const char *name;                       /* Item name */
140         enum sfc_flow_item_layers layer;        /* Layer of item */
141         enum sfc_flow_item_layers prev_layer;   /* Previous layer of item */
142         enum sfc_flow_parse_ctx_type ctx_type;  /* Parse context type */
143         sfc_flow_item_parse *parse;             /* Parsing function */
144 };
145
146 struct sfc_adapter;
147
148 int sfc_flow_parse_pattern(struct sfc_adapter *sa,
149                            const struct sfc_flow_item *flow_items,
150                            unsigned int nb_flow_items,
151                            const struct rte_flow_item pattern[],
152                            struct sfc_flow_parse_ctx *parse_ctx,
153                            struct rte_flow_error *error);
154
155 int sfc_flow_parse_init(const struct rte_flow_item *item,
156                         const void **spec_ptr,
157                         const void **mask_ptr,
158                         const void *supp_mask,
159                         const void *def_mask,
160                         unsigned int size,
161                         struct rte_flow_error *error);
162
163 void sfc_flow_init(struct sfc_adapter *sa);
164 void sfc_flow_fini(struct sfc_adapter *sa);
165 int sfc_flow_start(struct sfc_adapter *sa);
166 void sfc_flow_stop(struct sfc_adapter *sa);
167
168 typedef int (sfc_flow_parse_cb_t)(struct rte_eth_dev *dev,
169                                   const struct rte_flow_item items[],
170                                   const struct rte_flow_action actions[],
171                                   struct rte_flow *flow,
172                                   struct rte_flow_error *error);
173
174 typedef int (sfc_flow_verify_cb_t)(struct sfc_adapter *sa,
175                                    struct rte_flow *flow);
176
177 typedef void (sfc_flow_cleanup_cb_t)(struct sfc_adapter *sa,
178                                      struct rte_flow *flow);
179
180 typedef int (sfc_flow_insert_cb_t)(struct sfc_adapter *sa,
181                                    struct rte_flow *flow);
182
183 typedef int (sfc_flow_remove_cb_t)(struct sfc_adapter *sa,
184                                    struct rte_flow *flow);
185
186 typedef int (sfc_flow_query_cb_t)(struct rte_eth_dev *dev,
187                                   struct rte_flow *flow,
188                                   const struct rte_flow_action *action,
189                                   void *data,
190                                   struct rte_flow_error *error);
191
192 #ifdef __cplusplus
193 }
194 #endif
195 #endif /* _SFC_FLOW_H */