net/octeontx2: support Rx
[dpdk.git] / drivers / net / octeontx2 / otx2_rx.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(C) 2019 Marvell International Ltd.
3  */
4
5 #ifndef __OTX2_RX_H__
6 #define __OTX2_RX_H__
7
8 /* Default mark value used when none is provided. */
9 #define OTX2_FLOW_ACTION_FLAG_DEFAULT   0xffff
10
11 #define PTYPE_WIDTH 12
12 #define PTYPE_NON_TUNNEL_ARRAY_SZ       BIT(PTYPE_WIDTH)
13 #define PTYPE_TUNNEL_ARRAY_SZ           BIT(PTYPE_WIDTH)
14 #define PTYPE_ARRAY_SZ                  ((PTYPE_NON_TUNNEL_ARRAY_SZ +\
15                                          PTYPE_TUNNEL_ARRAY_SZ) *\
16                                          sizeof(uint16_t))
17
18 #define NIX_RX_OFFLOAD_NONE            (0)
19 #define NIX_RX_OFFLOAD_RSS_F           BIT(0)
20 #define NIX_RX_OFFLOAD_PTYPE_F         BIT(1)
21 #define NIX_RX_OFFLOAD_CHECKSUM_F      BIT(2)
22 #define NIX_RX_OFFLOAD_VLAN_STRIP_F    BIT(3)
23 #define NIX_RX_OFFLOAD_MARK_UPDATE_F   BIT(4)
24 #define NIX_RX_OFFLOAD_TSTAMP_F        BIT(5)
25
26 #define NIX_TIMESYNC_RX_OFFSET          8
27
28 struct otx2_timesync_info {
29         uint64_t        rx_tstamp;
30         rte_iova_t      tx_tstamp_iova;
31         uint64_t        *tx_tstamp;
32         uint8_t         tx_ready;
33         uint8_t         rx_ready;
34 } __rte_cache_aligned;
35
36 union mbuf_initializer {
37         struct {
38                 uint16_t data_off;
39                 uint16_t refcnt;
40                 uint16_t nb_segs;
41                 uint16_t port;
42         } fields;
43         uint64_t value;
44 };
45
46 static __rte_always_inline void
47 otx2_nix_mbuf_to_tstamp(struct rte_mbuf *mbuf,
48                         struct otx2_timesync_info *tstamp, const uint16_t flag)
49 {
50         if ((flag & NIX_RX_OFFLOAD_TSTAMP_F) &&
51             mbuf->packet_type == RTE_PTYPE_L2_ETHER_TIMESYNC &&
52             (mbuf->data_off == RTE_PKTMBUF_HEADROOM +
53              NIX_TIMESYNC_RX_OFFSET)) {
54                 uint64_t *tstamp_ptr;
55
56                 /* Deal with rx timestamp */
57                 tstamp_ptr = rte_pktmbuf_mtod_offset(mbuf, uint64_t *,
58                                                      -NIX_TIMESYNC_RX_OFFSET);
59                 mbuf->timestamp = rte_be_to_cpu_64(*tstamp_ptr);
60                 tstamp->rx_tstamp = mbuf->timestamp;
61                 tstamp->rx_ready = 1;
62                 mbuf->ol_flags |= PKT_RX_IEEE1588_PTP | PKT_RX_IEEE1588_TMST
63                         | PKT_RX_TIMESTAMP;
64         }
65 }
66
67 static __rte_always_inline uint64_t
68 nix_clear_data_off(uint64_t oldval)
69 {
70         union mbuf_initializer mbuf_init = { .value = oldval };
71
72         mbuf_init.fields.data_off = 0;
73         return mbuf_init.value;
74 }
75
76 static __rte_always_inline struct rte_mbuf *
77 nix_get_mbuf_from_cqe(void *cq, const uint64_t data_off)
78 {
79         rte_iova_t buff;
80
81         /* Skip CQE, NIX_RX_PARSE_S and SG HDR(9 DWORDs) and peek buff addr */
82         buff = *((rte_iova_t *)((uint64_t *)cq + 9));
83         return (struct rte_mbuf *)(buff - data_off);
84 }
85
86
87 static __rte_always_inline uint32_t
88 nix_ptype_get(const void * const lookup_mem, const uint64_t in)
89 {
90         const uint16_t * const ptype = lookup_mem;
91         const uint16_t lg_lf_le = (in & 0xFFF000000000000) >> 48;
92         const uint16_t tu_l2 = ptype[(in & 0x000FFF000000000) >> 36];
93         const uint16_t il4_tu = ptype[PTYPE_NON_TUNNEL_ARRAY_SZ + lg_lf_le];
94
95         return (il4_tu << PTYPE_WIDTH) | tu_l2;
96 }
97
98 static __rte_always_inline uint32_t
99 nix_rx_olflags_get(const void * const lookup_mem, const uint64_t in)
100 {
101         const uint32_t * const ol_flags = (const uint32_t *)
102                         ((const uint8_t *)lookup_mem + PTYPE_ARRAY_SZ);
103
104         return ol_flags[(in & 0xfff00000) >> 20];
105 }
106
107 static inline uint64_t
108 nix_update_match_id(const uint16_t match_id, uint64_t ol_flags,
109                     struct rte_mbuf *mbuf)
110 {
111         /* There is no separate bit to check match_id
112          * is valid or not? and no flag to identify it is an
113          * RTE_FLOW_ACTION_TYPE_FLAG vs RTE_FLOW_ACTION_TYPE_MARK
114          * action. The former case addressed through 0 being invalid
115          * value and inc/dec match_id pair when MARK is activated.
116          * The later case addressed through defining
117          * OTX2_FLOW_MARK_DEFAULT as value for
118          * RTE_FLOW_ACTION_TYPE_MARK.
119          * This would translate to not use
120          * OTX2_FLOW_ACTION_FLAG_DEFAULT - 1 and
121          * OTX2_FLOW_ACTION_FLAG_DEFAULT for match_id.
122          * i.e valid mark_id's are from
123          * 0 to OTX2_FLOW_ACTION_FLAG_DEFAULT - 2
124          */
125         if (likely(match_id)) {
126                 ol_flags |= PKT_RX_FDIR;
127                 if (match_id != OTX2_FLOW_ACTION_FLAG_DEFAULT) {
128                         ol_flags |= PKT_RX_FDIR_ID;
129                         mbuf->hash.fdir.hi = match_id - 1;
130                 }
131         }
132
133         return ol_flags;
134 }
135
136 static __rte_always_inline void
137 otx2_nix_cqe_to_mbuf(const struct nix_cqe_hdr_s *cq, const uint32_t tag,
138                      struct rte_mbuf *mbuf, const void *lookup_mem,
139                      const uint64_t val, const uint16_t flag)
140 {
141         const struct nix_rx_parse_s *rx =
142                  (const struct nix_rx_parse_s *)((const uint64_t *)cq + 1);
143         const uint64_t w1 = *(const uint64_t *)rx;
144         const uint16_t len = rx->pkt_lenm1 + 1;
145         uint64_t ol_flags = 0;
146
147         /* Mark mempool obj as "get" as it is alloc'ed by NIX */
148         __mempool_check_cookies(mbuf->pool, (void **)&mbuf, 1, 1);
149
150         if (flag & NIX_RX_OFFLOAD_PTYPE_F)
151                 mbuf->packet_type = nix_ptype_get(lookup_mem, w1);
152         else
153                 mbuf->packet_type = 0;
154
155         if (flag & NIX_RX_OFFLOAD_RSS_F) {
156                 mbuf->hash.rss = tag;
157                 ol_flags |= PKT_RX_RSS_HASH;
158         }
159
160         if (flag & NIX_RX_OFFLOAD_CHECKSUM_F)
161                 ol_flags |= nix_rx_olflags_get(lookup_mem, w1);
162
163         if (flag & NIX_RX_OFFLOAD_VLAN_STRIP_F) {
164                 if (rx->vtag0_gone) {
165                         ol_flags |= PKT_RX_VLAN | PKT_RX_VLAN_STRIPPED;
166                         mbuf->vlan_tci = rx->vtag0_tci;
167                 }
168                 if (rx->vtag1_gone) {
169                         ol_flags |= PKT_RX_QINQ | PKT_RX_QINQ_STRIPPED;
170                         mbuf->vlan_tci_outer = rx->vtag1_tci;
171                 }
172         }
173
174         if (flag & NIX_RX_OFFLOAD_MARK_UPDATE_F)
175                 ol_flags = nix_update_match_id(rx->match_id, ol_flags, mbuf);
176
177         mbuf->ol_flags = ol_flags;
178         *(uint64_t *)(&mbuf->rearm_data) = val;
179         mbuf->pkt_len = len;
180
181         mbuf->data_len = len;
182 }
183
184 #define CKSUM_F NIX_RX_OFFLOAD_CHECKSUM_F
185 #define PTYPE_F NIX_RX_OFFLOAD_PTYPE_F
186 #define RSS_F   NIX_RX_OFFLOAD_RSS_F
187 #define RX_VLAN_F  NIX_RX_OFFLOAD_VLAN_STRIP_F
188 #define MARK_F  NIX_RX_OFFLOAD_MARK_UPDATE_F
189 #define TS_F    NIX_RX_OFFLOAD_TSTAMP_F
190
191 /* [TSMP] [MARK] [VLAN] [CKSUM] [PTYPE] [RSS] */
192 #define NIX_RX_FASTPATH_MODES                                                  \
193 R(no_offload,                   0, 0, 0, 0, 0, 0, NIX_RX_OFFLOAD_NONE)  \
194 R(rss,                          0, 0, 0, 0, 0, 1, RSS_F)                \
195 R(ptype,                        0, 0, 0, 0, 1, 0, PTYPE_F)              \
196 R(ptype_rss,                    0, 0, 0, 0, 1, 1, PTYPE_F | RSS_F)      \
197 R(cksum,                        0, 0, 0, 1, 0, 0, CKSUM_F)              \
198 R(cksum_rss,                    0, 0, 0, 1, 0, 1, CKSUM_F | RSS_F)      \
199 R(cksum_ptype,                  0, 0, 0, 1, 1, 0, CKSUM_F | PTYPE_F)    \
200 R(cksum_ptype_rss,              0, 0, 0, 1, 1, 1, CKSUM_F | PTYPE_F | RSS_F)\
201 R(vlan,                         0, 0, 1, 0, 0, 0, RX_VLAN_F)            \
202 R(vlan_rss,                     0, 0, 1, 0, 0, 1, RX_VLAN_F | RSS_F)    \
203 R(vlan_ptype,                   0, 0, 1, 0, 1, 0, RX_VLAN_F | PTYPE_F)  \
204 R(vlan_ptype_rss,               0, 0, 1, 0, 1, 1, RX_VLAN_F | PTYPE_F | RSS_F)\
205 R(vlan_cksum,                   0, 0, 1, 1, 0, 0, RX_VLAN_F | CKSUM_F)  \
206 R(vlan_cksum_rss,               0, 0, 1, 1, 0, 1, RX_VLAN_F | CKSUM_F | RSS_F)\
207 R(vlan_cksum_ptype,             0, 0, 1, 1, 1, 0,                       \
208                         RX_VLAN_F | CKSUM_F | PTYPE_F)                  \
209 R(vlan_cksum_ptype_rss,         0, 0, 1, 1, 1, 1,                       \
210                         RX_VLAN_F | CKSUM_F | PTYPE_F | RSS_F)          \
211 R(mark,                         0, 1, 0, 0, 0, 0, MARK_F)               \
212 R(mark_rss,                     0, 1, 0, 0, 0, 1, MARK_F | RSS_F)       \
213 R(mark_ptype,                   0, 1, 0, 0, 1, 0, MARK_F | PTYPE_F)     \
214 R(mark_ptype_rss,               0, 1, 0, 0, 1, 1, MARK_F | PTYPE_F | RSS_F)\
215 R(mark_cksum,                   0, 1, 0, 1, 0, 0, MARK_F | CKSUM_F)     \
216 R(mark_cksum_rss,               0, 1, 0, 1, 0, 1, MARK_F | CKSUM_F | RSS_F)\
217 R(mark_cksum_ptype,             0, 1, 0, 1, 1, 0, MARK_F | CKSUM_F | PTYPE_F)\
218 R(mark_cksum_ptype_rss,         0, 1, 0, 1, 1, 1,                       \
219                         MARK_F | CKSUM_F | PTYPE_F | RSS_F)             \
220 R(mark_vlan,                    0, 1, 1, 0, 0, 0, MARK_F | RX_VLAN_F)   \
221 R(mark_vlan_rss,                0, 1, 1, 0, 0, 1, MARK_F | RX_VLAN_F | RSS_F)\
222 R(mark_vlan_ptype,              0, 1, 1, 0, 1, 0,                       \
223                         MARK_F | RX_VLAN_F | PTYPE_F)                   \
224 R(mark_vlan_ptype_rss,          0, 1, 1, 0, 1, 1,                       \
225                         MARK_F | RX_VLAN_F | PTYPE_F | RSS_F)           \
226 R(mark_vlan_cksum,              0, 1, 1, 1, 0, 0,                       \
227                         MARK_F | RX_VLAN_F | CKSUM_F)                   \
228 R(mark_vlan_cksum_rss,          0, 1, 1, 1, 0, 1,                       \
229                         MARK_F | RX_VLAN_F | CKSUM_F | RSS_F)           \
230 R(mark_vlan_cksum_ptype,        0, 1, 1, 1, 1, 0,                       \
231                         MARK_F | RX_VLAN_F | CKSUM_F | PTYPE_F)         \
232 R(mark_vlan_cksum_ptype_rss,    0, 1, 1, 1, 1, 1,                       \
233                         MARK_F | RX_VLAN_F | CKSUM_F | PTYPE_F | RSS_F) \
234 R(ts,                           1, 0, 0, 0, 0, 0, TS_F)                 \
235 R(ts_rss,                       1, 0, 0, 0, 0, 1, TS_F | RSS_F)         \
236 R(ts_ptype,                     1, 0, 0, 0, 1, 0, TS_F | PTYPE_F)       \
237 R(ts_ptype_rss,                 1, 0, 0, 0, 1, 1, TS_F | PTYPE_F | RSS_F)\
238 R(ts_cksum,                     1, 0, 0, 1, 0, 0, TS_F | CKSUM_F)       \
239 R(ts_cksum_rss,                 1, 0, 0, 1, 0, 1, TS_F | CKSUM_F | RSS_F)\
240 R(ts_cksum_ptype,               1, 0, 0, 1, 1, 0, TS_F | CKSUM_F | PTYPE_F)\
241 R(ts_cksum_ptype_rss,           1, 0, 0, 1, 1, 1,                       \
242                         TS_F | CKSUM_F | PTYPE_F | RSS_F)               \
243 R(ts_vlan,                      1, 0, 1, 0, 0, 0, TS_F | RX_VLAN_F)     \
244 R(ts_vlan_rss,                  1, 0, 1, 0, 0, 1, TS_F | RX_VLAN_F | RSS_F)\
245 R(ts_vlan_ptype,                1, 0, 1, 0, 1, 0, TS_F | RX_VLAN_F | PTYPE_F)\
246 R(ts_vlan_ptype_rss,            1, 0, 1, 0, 1, 1,                       \
247                         TS_F | RX_VLAN_F | PTYPE_F | RSS_F)             \
248 R(ts_vlan_cksum,                1, 0, 1, 1, 0, 0,                       \
249                         TS_F | RX_VLAN_F | CKSUM_F)                     \
250 R(ts_vlan_cksum_rss,            1, 0, 1, 1, 0, 1,                       \
251                         MARK_F | RX_VLAN_F | CKSUM_F | RSS_F)           \
252 R(ts_vlan_cksum_ptype,          1, 0, 1, 1, 1, 0,                       \
253                         TS_F | RX_VLAN_F | CKSUM_F | PTYPE_F)           \
254 R(ts_vlan_cksum_ptype_rss,      1, 0, 1, 1, 1, 1,                       \
255                         TS_F | RX_VLAN_F | CKSUM_F | PTYPE_F | RSS_F)   \
256 R(ts_mark,                      1, 1, 0, 0, 0, 0, TS_F | MARK_F)        \
257 R(ts_mark_rss,                  1, 1, 0, 0, 0, 1, TS_F | MARK_F | RSS_F)\
258 R(ts_mark_ptype,                1, 1, 0, 0, 1, 0, TS_F | MARK_F | PTYPE_F)\
259 R(ts_mark_ptype_rss,            1, 1, 0, 0, 1, 1,                       \
260                         TS_F | MARK_F | PTYPE_F | RSS_F)                \
261 R(ts_mark_cksum,                1, 1, 0, 1, 0, 0, TS_F | MARK_F | CKSUM_F)\
262 R(ts_mark_cksum_rss,            1, 1, 0, 1, 0, 1,                       \
263                         TS_F | MARK_F | CKSUM_F | RSS_F)\
264 R(ts_mark_cksum_ptype,          1, 1, 0, 1, 1, 0,                       \
265                         TS_F | MARK_F | CKSUM_F | PTYPE_F)              \
266 R(ts_mark_cksum_ptype_rss,      1, 1, 0, 1, 1, 1,                       \
267                         TS_F | MARK_F | CKSUM_F | PTYPE_F | RSS_F)      \
268 R(ts_mark_vlan,                 1, 1, 1, 0, 0, 0, TS_F | MARK_F | RX_VLAN_F)\
269 R(ts_mark_vlan_rss,             1, 1, 1, 0, 0, 1,                       \
270                         TS_F | MARK_F | RX_VLAN_F | RSS_F)\
271 R(ts_mark_vlan_ptype,           1, 1, 1, 0, 1, 0,                       \
272                         TS_F | MARK_F | RX_VLAN_F | PTYPE_F)            \
273 R(ts_mark_vlan_ptype_rss,       1, 1, 1, 0, 1, 1,                       \
274                         TS_F | MARK_F | RX_VLAN_F | PTYPE_F | RSS_F)    \
275 R(ts_mark_vlan_cksum_ptype,     1, 1, 1, 1, 1, 0,                       \
276                         TS_F | MARK_F | RX_VLAN_F | CKSUM_F | PTYPE_F)  \
277 R(ts_mark_vlan_cksum_ptype_rss, 1, 1, 1, 1, 1, 1,                       \
278                         TS_F | MARK_F | RX_VLAN_F | CKSUM_F | PTYPE_F | RSS_F)
279
280 #endif /* __OTX2_RX_H__ */