db4c1f70f0afd5a326aa6038cb75c7bbab0b1b9a
[dpdk.git] / drivers / net / octeontx2 / otx2_tx.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(C) 2019 Marvell International Ltd.
3  */
4
5 #ifndef __OTX2_TX_H__
6 #define __OTX2_TX_H__
7
8 #define NIX_TX_OFFLOAD_NONE             (0)
9 #define NIX_TX_OFFLOAD_L3_L4_CSUM_F     BIT(0)
10 #define NIX_TX_OFFLOAD_OL3_OL4_CSUM_F   BIT(1)
11 #define NIX_TX_OFFLOAD_VLAN_QINQ_F      BIT(2)
12 #define NIX_TX_OFFLOAD_MBUF_NOFF_F      BIT(3)
13 #define NIX_TX_OFFLOAD_TSTAMP_F         BIT(4)
14
15 /* Flags to control xmit_prepare function.
16  * Defining it from backwards to denote its been
17  * not used as offload flags to pick function
18  */
19 #define NIX_TX_MULTI_SEG_F              BIT(15)
20
21 #define NIX_TX_NEED_SEND_HDR_W1 \
22         (NIX_TX_OFFLOAD_L3_L4_CSUM_F | NIX_TX_OFFLOAD_OL3_OL4_CSUM_F |  \
23          NIX_TX_OFFLOAD_VLAN_QINQ_F)
24
25 #define NIX_TX_NEED_EXT_HDR \
26         (NIX_TX_OFFLOAD_VLAN_QINQ_F | NIX_TX_OFFLOAD_TSTAMP_F)
27
28 /* Function to determine no of tx subdesc required in case ext
29  * sub desc is enabled.
30  */
31 static __rte_always_inline int
32 otx2_nix_tx_ext_subs(const uint16_t flags)
33 {
34         return (flags & NIX_TX_OFFLOAD_TSTAMP_F) ? 2 :
35                 ((flags & NIX_TX_OFFLOAD_VLAN_QINQ_F) ? 1 : 0);
36 }
37
38 static __rte_always_inline void
39 otx2_nix_xmit_prepare_tstamp(uint64_t *cmd,  const uint64_t *send_mem_desc,
40                              const uint64_t ol_flags, const uint16_t no_segdw,
41                              const uint16_t flags)
42 {
43         if (flags & NIX_TX_OFFLOAD_TSTAMP_F) {
44                 struct nix_send_mem_s *send_mem;
45                 uint16_t off = (no_segdw - 1) << 1;
46
47                 send_mem = (struct nix_send_mem_s *)(cmd + off);
48                 if (flags & NIX_TX_MULTI_SEG_F)
49                         /* Retrieving the default desc values */
50                         cmd[off] = send_mem_desc[6];
51
52                 /* Packets for which PKT_TX_IEEE1588_TMST is not set, tx tstamp
53                  * should not be updated at tx tstamp registered address, rather
54                  * a dummy address which is eight bytes ahead would be updated
55                  */
56                 send_mem->addr = (rte_iova_t)((uint64_t *)send_mem_desc[7] +
57                                 !(ol_flags & PKT_TX_IEEE1588_TMST));
58         }
59 }
60
61 static inline void
62 otx2_nix_xmit_prepare(struct rte_mbuf *m, uint64_t *cmd, const uint16_t flags)
63 {
64         struct nix_send_ext_s *send_hdr_ext;
65         struct nix_send_hdr_s *send_hdr;
66         uint64_t ol_flags = 0, mask;
67         union nix_send_hdr_w1_u w1;
68         union nix_send_sg_s *sg;
69
70         send_hdr = (struct nix_send_hdr_s *)cmd;
71         if (flags & NIX_TX_NEED_EXT_HDR) {
72                 send_hdr_ext = (struct nix_send_ext_s *)(cmd + 2);
73                 sg = (union nix_send_sg_s *)(cmd + 4);
74                 /* Clear previous markings */
75                 send_hdr_ext->w0.lso = 0;
76                 send_hdr_ext->w1.u = 0;
77         } else {
78                 sg = (union nix_send_sg_s *)(cmd + 2);
79         }
80
81         if (flags & NIX_TX_NEED_SEND_HDR_W1) {
82                 ol_flags = m->ol_flags;
83                 w1.u = 0;
84         }
85
86         if (!(flags & NIX_TX_MULTI_SEG_F)) {
87                 send_hdr->w0.total = m->data_len;
88                 send_hdr->w0.aura =
89                         npa_lf_aura_handle_to_aura(m->pool->pool_id);
90         }
91
92         /*
93          * L3type:  2 => IPV4
94          *          3 => IPV4 with csum
95          *          4 => IPV6
96          * L3type and L3ptr needs to be set for either
97          * L3 csum or L4 csum or LSO
98          *
99          */
100
101         if ((flags & NIX_TX_OFFLOAD_OL3_OL4_CSUM_F) &&
102             (flags & NIX_TX_OFFLOAD_L3_L4_CSUM_F)) {
103                 const uint8_t csum = !!(ol_flags & PKT_TX_OUTER_UDP_CKSUM);
104                 const uint8_t ol3type =
105                         ((!!(ol_flags & PKT_TX_OUTER_IPV4)) << 1) +
106                         ((!!(ol_flags & PKT_TX_OUTER_IPV6)) << 2) +
107                         !!(ol_flags & PKT_TX_OUTER_IP_CKSUM);
108
109                 /* Outer L3 */
110                 w1.ol3type = ol3type;
111                 mask = 0xffffull << ((!!ol3type) << 4);
112                 w1.ol3ptr = ~mask & m->outer_l2_len;
113                 w1.ol4ptr = ~mask & (w1.ol3ptr + m->outer_l3_len);
114
115                 /* Outer L4 */
116                 w1.ol4type = csum + (csum << 1);
117
118                 /* Inner L3 */
119                 w1.il3type = ((!!(ol_flags & PKT_TX_IPV4)) << 1) +
120                         ((!!(ol_flags & PKT_TX_IPV6)) << 2);
121                 w1.il3ptr = w1.ol4ptr + m->l2_len;
122                 w1.il4ptr = w1.il3ptr + m->l3_len;
123                 /* Increment it by 1 if it is IPV4 as 3 is with csum */
124                 w1.il3type = w1.il3type + !!(ol_flags & PKT_TX_IP_CKSUM);
125
126                 /* Inner L4 */
127                 w1.il4type =  (ol_flags & PKT_TX_L4_MASK) >> 52;
128
129                 /* In case of no tunnel header use only
130                  * shift IL3/IL4 fields a bit to use
131                  * OL3/OL4 for header checksum
132                  */
133                 mask = !ol3type;
134                 w1.u = ((w1.u & 0xFFFFFFFF00000000) >> (mask << 3)) |
135                         ((w1.u & 0X00000000FFFFFFFF) >> (mask << 4));
136
137         } else if (flags & NIX_TX_OFFLOAD_OL3_OL4_CSUM_F) {
138                 const uint8_t csum = !!(ol_flags & PKT_TX_OUTER_UDP_CKSUM);
139                 const uint8_t outer_l2_len = m->outer_l2_len;
140
141                 /* Outer L3 */
142                 w1.ol3ptr = outer_l2_len;
143                 w1.ol4ptr = outer_l2_len + m->outer_l3_len;
144                 /* Increment it by 1 if it is IPV4 as 3 is with csum */
145                 w1.ol3type = ((!!(ol_flags & PKT_TX_OUTER_IPV4)) << 1) +
146                         ((!!(ol_flags & PKT_TX_OUTER_IPV6)) << 2) +
147                         !!(ol_flags & PKT_TX_OUTER_IP_CKSUM);
148
149                 /* Outer L4 */
150                 w1.ol4type = csum + (csum << 1);
151
152         } else if (flags & NIX_TX_OFFLOAD_L3_L4_CSUM_F) {
153                 const uint8_t l2_len = m->l2_len;
154
155                 /* Always use OLXPTR and OLXTYPE when only
156                  * when one header is present
157                  */
158
159                 /* Inner L3 */
160                 w1.ol3ptr = l2_len;
161                 w1.ol4ptr = l2_len + m->l3_len;
162                 /* Increment it by 1 if it is IPV4 as 3 is with csum */
163                 w1.ol3type = ((!!(ol_flags & PKT_TX_IPV4)) << 1) +
164                         ((!!(ol_flags & PKT_TX_IPV6)) << 2) +
165                         !!(ol_flags & PKT_TX_IP_CKSUM);
166
167                 /* Inner L4 */
168                 w1.ol4type =  (ol_flags & PKT_TX_L4_MASK) >> 52;
169         }
170
171         if (flags & NIX_TX_NEED_EXT_HDR &&
172             flags & NIX_TX_OFFLOAD_VLAN_QINQ_F) {
173                 send_hdr_ext->w1.vlan1_ins_ena = !!(ol_flags & PKT_TX_VLAN);
174                 /* HW will update ptr after vlan0 update */
175                 send_hdr_ext->w1.vlan1_ins_ptr = 12;
176                 send_hdr_ext->w1.vlan1_ins_tci = m->vlan_tci;
177
178                 send_hdr_ext->w1.vlan0_ins_ena = !!(ol_flags & PKT_TX_QINQ);
179                 /* 2B before end of l2 header */
180                 send_hdr_ext->w1.vlan0_ins_ptr = 12;
181                 send_hdr_ext->w1.vlan0_ins_tci = m->vlan_tci_outer;
182         }
183
184         if (flags & NIX_TX_NEED_SEND_HDR_W1)
185                 send_hdr->w1.u = w1.u;
186
187         if (!(flags & NIX_TX_MULTI_SEG_F)) {
188                 sg->seg1_size = m->data_len;
189                 *(rte_iova_t *)(++sg) = rte_mbuf_data_iova(m);
190
191                 if (flags & NIX_TX_OFFLOAD_MBUF_NOFF_F) {
192                         /* Set don't free bit if reference count > 1 */
193                         if (rte_pktmbuf_prefree_seg(m) == NULL)
194                                 send_hdr->w0.df = 1; /* SET DF */
195                 }
196                 /* Mark mempool object as "put" since it is freed by NIX */
197                 if (!send_hdr->w0.df)
198                         __mempool_check_cookies(m->pool, (void **)&m, 1, 0);
199         }
200 }
201
202
203 static __rte_always_inline void
204 otx2_nix_xmit_one(uint64_t *cmd, void *lmt_addr,
205                   const rte_iova_t io_addr, const uint32_t flags)
206 {
207         uint64_t lmt_status;
208
209         do {
210                 otx2_lmt_mov(lmt_addr, cmd, otx2_nix_tx_ext_subs(flags));
211                 lmt_status = otx2_lmt_submit(io_addr);
212         } while (lmt_status == 0);
213 }
214
215
216 #define L3L4CSUM_F   NIX_TX_OFFLOAD_L3_L4_CSUM_F
217 #define OL3OL4CSUM_F NIX_TX_OFFLOAD_OL3_OL4_CSUM_F
218 #define VLAN_F       NIX_TX_OFFLOAD_VLAN_QINQ_F
219 #define NOFF_F       NIX_TX_OFFLOAD_MBUF_NOFF_F
220 #define TSP_F        NIX_TX_OFFLOAD_TSTAMP_F
221
222 /* [TSTMP] [NOFF] [VLAN] [OL3OL4CSUM] [L3L4CSUM] */
223 #define NIX_TX_FASTPATH_MODES                                   \
224 T(no_offload,                           0, 0, 0, 0, 0,  4,      \
225                 NIX_TX_OFFLOAD_NONE)                            \
226 T(l3l4csum,                             0, 0, 0, 0, 1,  4,      \
227                 L3L4CSUM_F)                                     \
228 T(ol3ol4csum,                           0, 0, 0, 1, 0,  4,      \
229                 OL3OL4CSUM_F)                                   \
230 T(ol3ol4csum_l3l4csum,                  0, 0, 0, 1, 1,  4,      \
231                 OL3OL4CSUM_F | L3L4CSUM_F)                      \
232 T(vlan,                                 0, 0, 1, 0, 0,  6,      \
233                 VLAN_F)                                         \
234 T(vlan_l3l4csum,                        0, 0, 1, 0, 1,  6,      \
235                 VLAN_F | L3L4CSUM_F)                            \
236 T(vlan_ol3ol4csum,                      0, 0, 1, 1, 0,  6,      \
237                 VLAN_F | OL3OL4CSUM_F)                          \
238 T(vlan_ol3ol4csum_l3l4csum,             0, 0, 1, 1, 1,  6,      \
239                 VLAN_F | OL3OL4CSUM_F | L3L4CSUM_F)             \
240 T(noff,                                 0, 1, 0, 0, 0,  4,      \
241                 NOFF_F)                                         \
242 T(noff_l3l4csum,                        0, 1, 0, 0, 1,  4,      \
243                 NOFF_F | L3L4CSUM_F)                            \
244 T(noff_ol3ol4csum,                      0, 1, 0, 1, 0,  4,      \
245                 NOFF_F | OL3OL4CSUM_F)                          \
246 T(noff_ol3ol4csum_l3l4csum,             0, 1, 0, 1, 1,  4,      \
247                 NOFF_F | OL3OL4CSUM_F | L3L4CSUM_F)             \
248 T(noff_vlan,                            0, 1, 1, 0, 0,  6,      \
249                 NOFF_F | VLAN_F)                                \
250 T(noff_vlan_l3l4csum,                   0, 1, 1, 0, 1,  6,      \
251                 NOFF_F | VLAN_F | L3L4CSUM_F)                   \
252 T(noff_vlan_ol3ol4csum,                 0, 1, 1, 1, 0,  6,      \
253                 NOFF_F | VLAN_F | OL3OL4CSUM_F)                 \
254 T(noff_vlan_ol3ol4csum_l3l4csum,        0, 1, 1, 1, 1,  6,      \
255                 NOFF_F | VLAN_F | OL3OL4CSUM_F | L3L4CSUM_F)    \
256 T(ts,                                   1, 0, 0, 0, 0,  8,      \
257                 TSP_F)                                          \
258 T(ts_l3l4csum,                  1, 0, 0, 0, 1,  8,              \
259                 TSP_F | L3L4CSUM_F)                             \
260 T(ts_ol3ol4csum,                        1, 0, 0, 1, 0,  8,      \
261                 TSP_F | OL3OL4CSUM_F)                           \
262 T(ts_ol3ol4csum_l3l4csum,               1, 0, 0, 1, 1,  8,      \
263                 TSP_F | OL3OL4CSUM_F | L3L4CSUM_F)              \
264 T(ts_vlan,                              1, 0, 1, 0, 0,  8,      \
265                 TSP_F | VLAN_F)                                 \
266 T(ts_vlan_l3l4csum,                     1, 0, 1, 0, 1,  8,      \
267                 TSP_F | VLAN_F | L3L4CSUM_F)                    \
268 T(ts_vlan_ol3ol4csum,           1, 0, 1, 1, 0,  8,              \
269                 TSP_F | VLAN_F | OL3OL4CSUM_F)                  \
270 T(ts_vlan_ol3ol4csum_l3l4csum,  1, 0, 1, 1, 1,  8,              \
271                 TSP_F | VLAN_F | OL3OL4CSUM_F | L3L4CSUM_F)     \
272 T(ts_noff,                              1, 1, 0, 0, 0,  8,      \
273                 TSP_F | NOFF_F)                                 \
274 T(ts_noff_l3l4csum,                     1, 1, 0, 0, 1,  8,      \
275                 TSP_F | NOFF_F | L3L4CSUM_F)                    \
276 T(ts_noff_ol3ol4csum,           1, 1, 0, 1, 0,  8,              \
277                 TSP_F | NOFF_F | OL3OL4CSUM_F)                  \
278 T(ts_noff_ol3ol4csum_l3l4csum,  1, 1, 0, 1, 1,  8,              \
279                 TSP_F | NOFF_F | OL3OL4CSUM_F | L3L4CSUM_F)     \
280 T(ts_noff_vlan,                 1, 1, 1, 0, 0,  8,              \
281                 TSP_F | NOFF_F | VLAN_F)                        \
282 T(ts_noff_vlan_l3l4csum,                1, 1, 1, 0, 1,  8,      \
283                 TSP_F | NOFF_F | VLAN_F | L3L4CSUM_F)           \
284 T(ts_noff_vlan_ol3ol4csum,              1, 1, 1, 1, 0,  8,      \
285                 TSP_F | NOFF_F | VLAN_F | OL3OL4CSUM_F)         \
286 T(ts_noff_vlan_ol3ol4csum_l3l4csum,     1, 1, 1, 1, 1,  8,      \
287                 TSP_F | NOFF_F | VLAN_F | OL3OL4CSUM_F | L3L4CSUM_F)
288
289 #endif /* __OTX2_TX_H__ */