ef2cacc0274747bf55c78a2263283c22dd49e49d
[dpdk.git] / drivers / net / mlx5 / mlx5_rxtx.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright 2015 6WIND S.A.
3  * Copyright 2015 Mellanox Technologies, Ltd
4  */
5
6 #ifndef RTE_PMD_MLX5_RXTX_H_
7 #define RTE_PMD_MLX5_RXTX_H_
8
9 #include <stddef.h>
10 #include <stdint.h>
11 #include <sys/queue.h>
12
13 #include <rte_mbuf.h>
14 #include <rte_mempool.h>
15 #include <rte_common.h>
16 #include <rte_hexdump.h>
17 #include <rte_atomic.h>
18 #include <rte_spinlock.h>
19 #include <rte_io.h>
20 #include <rte_bus_pci.h>
21 #include <rte_malloc.h>
22 #include <rte_cycles.h>
23
24 #include <mlx5_glue.h>
25 #include <mlx5_prm.h>
26 #include <mlx5_common.h>
27 #include <mlx5_common_mr.h>
28
29 #include "mlx5_defs.h"
30 #include "mlx5_utils.h"
31 #include "mlx5.h"
32 #include "mlx5_autoconf.h"
33 #include "mlx5_mr.h"
34
35 /* Support tunnel matching. */
36 #define MLX5_FLOW_TUNNEL 10
37
38 /* Mbuf dynamic flag offset for inline. */
39 extern uint64_t rte_net_mlx5_dynf_inline_mask;
40
41 struct mlx5_rxq_stats {
42 #ifdef MLX5_PMD_SOFT_COUNTERS
43         uint64_t ipackets; /**< Total of successfully received packets. */
44         uint64_t ibytes; /**< Total of successfully received bytes. */
45 #endif
46         uint64_t idropped; /**< Total of packets dropped when RX ring full. */
47         uint64_t rx_nombuf; /**< Total of RX mbuf allocation failures. */
48 };
49
50 struct mlx5_txq_stats {
51 #ifdef MLX5_PMD_SOFT_COUNTERS
52         uint64_t opackets; /**< Total of successfully sent packets. */
53         uint64_t obytes; /**< Total of successfully sent bytes. */
54 #endif
55         uint64_t oerrors; /**< Total number of failed transmitted packets. */
56 };
57
58 struct mlx5_priv;
59
60 /* Compressed CQE context. */
61 struct rxq_zip {
62         uint16_t ai; /* Array index. */
63         uint16_t ca; /* Current array index. */
64         uint16_t na; /* Next array index. */
65         uint16_t cq_ci; /* The next CQE. */
66         uint32_t cqe_cnt; /* Number of CQEs. */
67 };
68
69 /* Multi-Packet RQ buffer header. */
70 struct mlx5_mprq_buf {
71         struct rte_mempool *mp;
72         uint16_t refcnt; /* Atomically accessed refcnt. */
73         uint8_t pad[RTE_PKTMBUF_HEADROOM]; /* Headroom for the first packet. */
74         struct rte_mbuf_ext_shared_info shinfos[];
75         /*
76          * Shared information per stride.
77          * More memory will be allocated for the first stride head-room and for
78          * the strides data.
79          */
80 } __rte_cache_aligned;
81
82 /* Get pointer to the first stride. */
83 #define mlx5_mprq_buf_addr(ptr, strd_n) (RTE_PTR_ADD((ptr), \
84                                 sizeof(struct mlx5_mprq_buf) + \
85                                 (strd_n) * \
86                                 sizeof(struct rte_mbuf_ext_shared_info) + \
87                                 RTE_PKTMBUF_HEADROOM))
88
89 #define MLX5_MIN_SINGLE_STRIDE_LOG_NUM_BYTES 6
90 #define MLX5_MIN_SINGLE_WQE_LOG_NUM_STRIDES 9
91
92 enum mlx5_rxq_err_state {
93         MLX5_RXQ_ERR_STATE_NO_ERROR = 0,
94         MLX5_RXQ_ERR_STATE_NEED_RESET,
95         MLX5_RXQ_ERR_STATE_NEED_READY,
96 };
97
98 enum mlx5_rqx_code {
99         MLX5_RXQ_CODE_EXIT = 0,
100         MLX5_RXQ_CODE_NOMBUF,
101         MLX5_RXQ_CODE_DROPPED,
102 };
103
104 struct mlx5_eth_rxseg {
105         struct rte_mempool *mp; /**< Memory pool to allocate segment from. */
106         uint16_t length; /**< Segment data length, configures split point. */
107         uint16_t offset; /**< Data offset from beginning of mbuf data buffer. */
108         uint32_t reserved; /**< Reserved field. */
109 };
110
111 /* RX queue descriptor. */
112 struct mlx5_rxq_data {
113         unsigned int csum:1; /* Enable checksum offloading. */
114         unsigned int hw_timestamp:1; /* Enable HW timestamp. */
115         unsigned int rt_timestamp:1; /* Realtime timestamp format. */
116         unsigned int vlan_strip:1; /* Enable VLAN stripping. */
117         unsigned int crc_present:1; /* CRC must be subtracted. */
118         unsigned int sges_n:3; /* Log 2 of SGEs (max buffers per packet). */
119         unsigned int cqe_n:4; /* Log 2 of CQ elements. */
120         unsigned int elts_n:4; /* Log 2 of Mbufs. */
121         unsigned int rss_hash:1; /* RSS hash result is enabled. */
122         unsigned int mark:1; /* Marked flow available on the queue. */
123         unsigned int strd_num_n:5; /* Log 2 of the number of stride. */
124         unsigned int strd_sz_n:4; /* Log 2 of stride size. */
125         unsigned int strd_shift_en:1; /* Enable 2bytes shift on a stride. */
126         unsigned int err_state:2; /* enum mlx5_rxq_err_state. */
127         unsigned int strd_scatter_en:1; /* Scattered packets from a stride. */
128         unsigned int lro:1; /* Enable LRO. */
129         unsigned int dynf_meta:1; /* Dynamic metadata is configured. */
130         volatile uint32_t *rq_db;
131         volatile uint32_t *cq_db;
132         uint16_t port_id;
133         uint32_t elts_ci;
134         uint32_t rq_ci;
135         uint16_t consumed_strd; /* Number of consumed strides in WQE. */
136         uint32_t rq_pi;
137         uint32_t cq_ci;
138         uint16_t rq_repl_thresh; /* Threshold for buffer replenishment. */
139         union {
140                 struct rxq_zip zip; /* Compressed context. */
141                 uint16_t decompressed;
142                 /* Number of ready mbufs decompressed from the CQ. */
143         };
144         struct mlx5_mr_ctrl mr_ctrl; /* MR control descriptor. */
145         uint16_t mprq_max_memcpy_len; /* Maximum size of packet to memcpy. */
146         volatile void *wqes;
147         volatile struct mlx5_cqe(*cqes)[];
148         struct rte_mbuf *(*elts)[];
149         struct mlx5_mprq_buf *(*mprq_bufs)[];
150         struct rte_mempool *mp;
151         struct rte_mempool *mprq_mp; /* Mempool for Multi-Packet RQ. */
152         struct mlx5_mprq_buf *mprq_repl; /* Stashed mbuf for replenish. */
153         struct mlx5_dev_ctx_shared *sh; /* Shared context. */
154         uint16_t idx; /* Queue index. */
155         struct mlx5_rxq_stats stats;
156         rte_xmm_t mbuf_initializer; /* Default rearm/flags for vectorized Rx. */
157         struct rte_mbuf fake_mbuf; /* elts padding for vectorized Rx. */
158         void *cq_uar; /* Verbs CQ user access region. */
159         uint32_t cqn; /* CQ number. */
160         uint8_t cq_arm_sn; /* CQ arm seq number. */
161 #ifndef RTE_ARCH_64
162         rte_spinlock_t *uar_lock_cq;
163         /* CQ (UAR) access lock required for 32bit implementations */
164 #endif
165         uint32_t tunnel; /* Tunnel information. */
166         int timestamp_offset; /* Dynamic mbuf field for timestamp. */
167         uint64_t timestamp_rx_flag; /* Dynamic mbuf flag for timestamp. */
168         uint64_t flow_meta_mask;
169         int32_t flow_meta_offset;
170         uint32_t rxseg_n; /* Number of split segment descriptions. */
171         struct mlx5_eth_rxseg rxseg[MLX5_MAX_RXQ_NSEG];
172         /* Buffer split segment descriptions - sizes, offsets, pools. */
173 } __rte_cache_aligned;
174
175 enum mlx5_rxq_type {
176         MLX5_RXQ_TYPE_STANDARD, /* Standard Rx queue. */
177         MLX5_RXQ_TYPE_HAIRPIN, /* Hairpin Rx queue. */
178         MLX5_RXQ_TYPE_UNDEFINED,
179 };
180
181 /* RX queue control descriptor. */
182 struct mlx5_rxq_ctrl {
183         struct mlx5_rxq_data rxq; /* Data path structure. */
184         LIST_ENTRY(mlx5_rxq_ctrl) next; /* Pointer to the next element. */
185         uint32_t refcnt; /* Reference counter. */
186         struct mlx5_rxq_obj *obj; /* Verbs/DevX elements. */
187         struct mlx5_priv *priv; /* Back pointer to private data. */
188         enum mlx5_rxq_type type; /* Rxq type. */
189         unsigned int socket; /* CPU socket ID for allocations. */
190         unsigned int irq:1; /* Whether IRQ is enabled. */
191         uint32_t flow_mark_n; /* Number of Mark/Flag flows using this Queue. */
192         uint32_t flow_tunnels_n[MLX5_FLOW_TUNNEL]; /* Tunnels counters. */
193         uint32_t wqn; /* WQ number. */
194         uint16_t dump_file_n; /* Number of dump files. */
195         struct mlx5_devx_dbr_page *rq_dbrec_page;
196         uint64_t rq_dbr_offset;
197         /* Storing RQ door-bell information, needed when freeing door-bell. */
198         struct mlx5_devx_dbr_page *cq_dbrec_page;
199         uint64_t cq_dbr_offset;
200         /* Storing CQ door-bell information, needed when freeing door-bell. */
201         void *wq_umem; /* WQ buffer registration info. */
202         void *cq_umem; /* CQ buffer registration info. */
203         struct rte_eth_hairpin_conf hairpin_conf; /* Hairpin configuration. */
204         uint32_t hairpin_status; /* Hairpin binding status. */
205 };
206
207 /* TX queue send local data. */
208 __extension__
209 struct mlx5_txq_local {
210         struct mlx5_wqe *wqe_last; /* last sent WQE pointer. */
211         struct rte_mbuf *mbuf; /* first mbuf to process. */
212         uint16_t pkts_copy; /* packets copied to elts. */
213         uint16_t pkts_sent; /* packets sent. */
214         uint16_t pkts_loop; /* packets sent on loop entry. */
215         uint16_t elts_free; /* available elts remain. */
216         uint16_t wqe_free; /* available wqe remain. */
217         uint16_t mbuf_off; /* data offset in current mbuf. */
218         uint16_t mbuf_nseg; /* number of remaining mbuf. */
219 };
220
221 /* TX queue descriptor. */
222 __extension__
223 struct mlx5_txq_data {
224         uint16_t elts_head; /* Current counter in (*elts)[]. */
225         uint16_t elts_tail; /* Counter of first element awaiting completion. */
226         uint16_t elts_comp; /* elts index since last completion request. */
227         uint16_t elts_s; /* Number of mbuf elements. */
228         uint16_t elts_m; /* Mask for mbuf elements indices. */
229         /* Fields related to elts mbuf storage. */
230         uint16_t wqe_ci; /* Consumer index for work queue. */
231         uint16_t wqe_pi; /* Producer index for work queue. */
232         uint16_t wqe_s; /* Number of WQ elements. */
233         uint16_t wqe_m; /* Mask Number for WQ elements. */
234         uint16_t wqe_comp; /* WQE index since last completion request. */
235         uint16_t wqe_thres; /* WQE threshold to request completion in CQ. */
236         /* WQ related fields. */
237         uint16_t cq_ci; /* Consumer index for completion queue. */
238         uint16_t cq_pi; /* Production index for completion queue. */
239         uint16_t cqe_s; /* Number of CQ elements. */
240         uint16_t cqe_m; /* Mask for CQ indices. */
241         /* CQ related fields. */
242         uint16_t elts_n:4; /* elts[] length (in log2). */
243         uint16_t cqe_n:4; /* Number of CQ elements (in log2). */
244         uint16_t wqe_n:4; /* Number of WQ elements (in log2). */
245         uint16_t tso_en:1; /* When set hardware TSO is enabled. */
246         uint16_t tunnel_en:1;
247         /* When set TX offload for tunneled packets are supported. */
248         uint16_t swp_en:1; /* Whether SW parser is enabled. */
249         uint16_t vlan_en:1; /* VLAN insertion in WQE is supported. */
250         uint16_t db_nc:1; /* Doorbell mapped to non-cached region. */
251         uint16_t db_heu:1; /* Doorbell heuristic write barrier. */
252         uint16_t inlen_send; /* Ordinary send data inline size. */
253         uint16_t inlen_empw; /* eMPW max packet size to inline. */
254         uint16_t inlen_mode; /* Minimal data length to inline. */
255         uint32_t qp_num_8s; /* QP number shifted by 8. */
256         uint64_t offloads; /* Offloads for Tx Queue. */
257         struct mlx5_mr_ctrl mr_ctrl; /* MR control descriptor. */
258         struct mlx5_wqe *wqes; /* Work queue. */
259         struct mlx5_wqe *wqes_end; /* Work queue array limit. */
260 #ifdef RTE_LIBRTE_MLX5_DEBUG
261         uint32_t *fcqs; /* Free completion queue (debug extended). */
262 #else
263         uint16_t *fcqs; /* Free completion queue. */
264 #endif
265         volatile struct mlx5_cqe *cqes; /* Completion queue. */
266         volatile uint32_t *qp_db; /* Work queue doorbell. */
267         volatile uint32_t *cq_db; /* Completion queue doorbell. */
268         uint16_t port_id; /* Port ID of device. */
269         uint16_t idx; /* Queue index. */
270         uint64_t ts_mask; /* Timestamp flag dynamic mask. */
271         int32_t ts_offset; /* Timestamp field dynamic offset. */
272         struct mlx5_dev_ctx_shared *sh; /* Shared context. */
273         struct mlx5_txq_stats stats; /* TX queue counters. */
274 #ifndef RTE_ARCH_64
275         rte_spinlock_t *uar_lock;
276         /* UAR access lock required for 32bit implementations */
277 #endif
278         struct rte_mbuf *elts[0];
279         /* Storage for queued packets, must be the last field. */
280 } __rte_cache_aligned;
281
282 enum mlx5_txq_type {
283         MLX5_TXQ_TYPE_STANDARD, /* Standard Tx queue. */
284         MLX5_TXQ_TYPE_HAIRPIN, /* Hairpin Rx queue. */
285 };
286
287 /* TX queue control descriptor. */
288 struct mlx5_txq_ctrl {
289         LIST_ENTRY(mlx5_txq_ctrl) next; /* Pointer to the next element. */
290         uint32_t refcnt; /* Reference counter. */
291         unsigned int socket; /* CPU socket ID for allocations. */
292         enum mlx5_txq_type type; /* The txq ctrl type. */
293         unsigned int max_inline_data; /* Max inline data. */
294         unsigned int max_tso_header; /* Max TSO header size. */
295         struct mlx5_txq_obj *obj; /* Verbs/DevX queue object. */
296         struct mlx5_priv *priv; /* Back pointer to private data. */
297         off_t uar_mmap_offset; /* UAR mmap offset for non-primary process. */
298         void *bf_reg; /* BlueFlame register from Verbs. */
299         uint16_t dump_file_n; /* Number of dump files. */
300         struct rte_eth_hairpin_conf hairpin_conf; /* Hairpin configuration. */
301         uint32_t hairpin_status; /* Hairpin binding status. */
302         struct mlx5_txq_data txq; /* Data path structure. */
303         /* Must be the last field in the structure, contains elts[]. */
304 };
305
306 #define MLX5_TX_BFREG(txq) \
307                 (MLX5_PROC_PRIV((txq)->port_id)->uar_table[(txq)->idx])
308
309 /* mlx5_rxq.c */
310
311 extern uint8_t rss_hash_default_key[];
312
313 int mlx5_check_mprq_support(struct rte_eth_dev *dev);
314 int mlx5_rxq_mprq_enabled(struct mlx5_rxq_data *rxq);
315 int mlx5_mprq_enabled(struct rte_eth_dev *dev);
316 unsigned int mlx5_rxq_cqe_num(struct mlx5_rxq_data *rxq_data);
317 int mlx5_mprq_free_mp(struct rte_eth_dev *dev);
318 int mlx5_mprq_alloc_mp(struct rte_eth_dev *dev);
319 int mlx5_rx_queue_start(struct rte_eth_dev *dev, uint16_t queue_id);
320 int mlx5_rx_queue_stop(struct rte_eth_dev *dev, uint16_t queue_id);
321 int mlx5_rx_queue_start_primary(struct rte_eth_dev *dev, uint16_t queue_id);
322 int mlx5_rx_queue_stop_primary(struct rte_eth_dev *dev, uint16_t queue_id);
323 int mlx5_rx_queue_setup(struct rte_eth_dev *dev, uint16_t idx, uint16_t desc,
324                         unsigned int socket, const struct rte_eth_rxconf *conf,
325                         struct rte_mempool *mp);
326 int mlx5_rx_hairpin_queue_setup
327         (struct rte_eth_dev *dev, uint16_t idx, uint16_t desc,
328          const struct rte_eth_hairpin_conf *hairpin_conf);
329 void mlx5_rx_queue_release(void *dpdk_rxq);
330 int mlx5_rx_intr_vec_enable(struct rte_eth_dev *dev);
331 void mlx5_rx_intr_vec_disable(struct rte_eth_dev *dev);
332 int mlx5_rx_intr_enable(struct rte_eth_dev *dev, uint16_t rx_queue_id);
333 int mlx5_rx_intr_disable(struct rte_eth_dev *dev, uint16_t rx_queue_id);
334 int mlx5_rxq_obj_verify(struct rte_eth_dev *dev);
335 struct mlx5_rxq_ctrl *mlx5_rxq_new(struct rte_eth_dev *dev, uint16_t idx,
336                                    uint16_t desc, unsigned int socket,
337                                    const struct rte_eth_rxconf *conf,
338                                    const struct rte_eth_rxseg_split *rx_seg,
339                                    uint16_t n_seg);
340 struct mlx5_rxq_ctrl *mlx5_rxq_hairpin_new
341         (struct rte_eth_dev *dev, uint16_t idx, uint16_t desc,
342          const struct rte_eth_hairpin_conf *hairpin_conf);
343 struct mlx5_rxq_ctrl *mlx5_rxq_get(struct rte_eth_dev *dev, uint16_t idx);
344 int mlx5_rxq_release(struct rte_eth_dev *dev, uint16_t idx);
345 int mlx5_rxq_verify(struct rte_eth_dev *dev);
346 int rxq_alloc_elts(struct mlx5_rxq_ctrl *rxq_ctrl);
347 int mlx5_ind_table_obj_verify(struct rte_eth_dev *dev);
348 struct mlx5_ind_table_obj *mlx5_ind_table_obj_get(struct rte_eth_dev *dev,
349                                                   const uint16_t *queues,
350                                                   uint32_t queues_n);
351 int mlx5_ind_table_obj_release(struct rte_eth_dev *dev,
352                                struct mlx5_ind_table_obj *ind_tbl);
353 uint32_t mlx5_hrxq_new(struct rte_eth_dev *dev,
354                        const uint8_t *rss_key, uint32_t rss_key_len,
355                        uint64_t hash_fields,
356                        const uint16_t *queues, uint32_t queues_n,
357                        int tunnel, bool shared);
358 uint32_t mlx5_hrxq_get(struct rte_eth_dev *dev,
359                        const uint8_t *rss_key, uint32_t rss_key_len,
360                        uint64_t hash_fields,
361                        const uint16_t *queues, uint32_t queues_n);
362 int mlx5_hrxq_release(struct rte_eth_dev *dev, uint32_t hxrq_idx);
363 int mlx5_hrxq_verify(struct rte_eth_dev *dev);
364 enum mlx5_rxq_type mlx5_rxq_get_type(struct rte_eth_dev *dev, uint16_t idx);
365 const struct rte_eth_hairpin_conf *mlx5_rxq_get_hairpin_conf
366         (struct rte_eth_dev *dev, uint16_t idx);
367 struct mlx5_hrxq *mlx5_drop_action_create(struct rte_eth_dev *dev);
368 void mlx5_drop_action_destroy(struct rte_eth_dev *dev);
369 uint64_t mlx5_get_rx_port_offloads(void);
370 uint64_t mlx5_get_rx_queue_offloads(struct rte_eth_dev *dev);
371 void mlx5_rxq_timestamp_set(struct rte_eth_dev *dev);
372 int mlx5_hrxq_modify(struct rte_eth_dev *dev, uint32_t hxrq_idx,
373                      const uint8_t *rss_key, uint32_t rss_key_len,
374                      uint64_t hash_fields,
375                      const uint16_t *queues, uint32_t queues_n);
376
377 /* mlx5_txq.c */
378
379 int mlx5_tx_queue_start(struct rte_eth_dev *dev, uint16_t queue_id);
380 int mlx5_tx_queue_stop(struct rte_eth_dev *dev, uint16_t queue_id);
381 int mlx5_tx_queue_start_primary(struct rte_eth_dev *dev, uint16_t queue_id);
382 int mlx5_tx_queue_stop_primary(struct rte_eth_dev *dev, uint16_t queue_id);
383 int mlx5_tx_queue_setup(struct rte_eth_dev *dev, uint16_t idx, uint16_t desc,
384                         unsigned int socket, const struct rte_eth_txconf *conf);
385 int mlx5_tx_hairpin_queue_setup
386         (struct rte_eth_dev *dev, uint16_t idx, uint16_t desc,
387          const struct rte_eth_hairpin_conf *hairpin_conf);
388 void mlx5_tx_queue_release(void *dpdk_txq);
389 void txq_uar_init(struct mlx5_txq_ctrl *txq_ctrl);
390 int mlx5_tx_uar_init_secondary(struct rte_eth_dev *dev, int fd);
391 void mlx5_tx_uar_uninit_secondary(struct rte_eth_dev *dev);
392 int mlx5_txq_obj_verify(struct rte_eth_dev *dev);
393 struct mlx5_txq_ctrl *mlx5_txq_new(struct rte_eth_dev *dev, uint16_t idx,
394                                    uint16_t desc, unsigned int socket,
395                                    const struct rte_eth_txconf *conf);
396 struct mlx5_txq_ctrl *mlx5_txq_hairpin_new
397         (struct rte_eth_dev *dev, uint16_t idx, uint16_t desc,
398          const struct rte_eth_hairpin_conf *hairpin_conf);
399 struct mlx5_txq_ctrl *mlx5_txq_get(struct rte_eth_dev *dev, uint16_t idx);
400 int mlx5_txq_release(struct rte_eth_dev *dev, uint16_t idx);
401 int mlx5_txq_releasable(struct rte_eth_dev *dev, uint16_t idx);
402 int mlx5_txq_verify(struct rte_eth_dev *dev);
403 void txq_alloc_elts(struct mlx5_txq_ctrl *txq_ctrl);
404 void txq_free_elts(struct mlx5_txq_ctrl *txq_ctrl);
405 uint64_t mlx5_get_tx_port_offloads(struct rte_eth_dev *dev);
406 void mlx5_txq_dynf_timestamp_set(struct rte_eth_dev *dev);
407
408 /* mlx5_rxtx.c */
409
410 extern uint32_t mlx5_ptype_table[];
411 extern uint8_t mlx5_cksum_table[];
412 extern uint8_t mlx5_swp_types_table[];
413
414 void mlx5_set_ptype_table(void);
415 void mlx5_set_cksum_table(void);
416 void mlx5_set_swp_types_table(void);
417 uint16_t mlx5_rx_burst(void *dpdk_rxq, struct rte_mbuf **pkts, uint16_t pkts_n);
418 void mlx5_rxq_initialize(struct mlx5_rxq_data *rxq);
419 __rte_noinline int mlx5_rx_err_handle(struct mlx5_rxq_data *rxq, uint8_t vec);
420 void mlx5_mprq_buf_free_cb(void *addr, void *opaque);
421 void mlx5_mprq_buf_free(struct mlx5_mprq_buf *buf);
422 uint16_t mlx5_rx_burst_mprq(void *dpdk_rxq, struct rte_mbuf **pkts,
423                             uint16_t pkts_n);
424 uint16_t removed_tx_burst(void *dpdk_txq, struct rte_mbuf **pkts,
425                           uint16_t pkts_n);
426 uint16_t removed_rx_burst(void *dpdk_rxq, struct rte_mbuf **pkts,
427                           uint16_t pkts_n);
428 int mlx5_rx_descriptor_status(void *rx_queue, uint16_t offset);
429 int mlx5_tx_descriptor_status(void *tx_queue, uint16_t offset);
430 uint32_t mlx5_rx_queue_count(struct rte_eth_dev *dev, uint16_t rx_queue_id);
431 void mlx5_dump_debug_information(const char *path, const char *title,
432                                  const void *buf, unsigned int len);
433 int mlx5_queue_state_modify_primary(struct rte_eth_dev *dev,
434                         const struct mlx5_mp_arg_queue_state_modify *sm);
435 void mlx5_rxq_info_get(struct rte_eth_dev *dev, uint16_t queue_id,
436                        struct rte_eth_rxq_info *qinfo);
437 void mlx5_txq_info_get(struct rte_eth_dev *dev, uint16_t queue_id,
438                        struct rte_eth_txq_info *qinfo);
439 int mlx5_rx_burst_mode_get(struct rte_eth_dev *dev, uint16_t rx_queue_id,
440                            struct rte_eth_burst_mode *mode);
441 int mlx5_tx_burst_mode_get(struct rte_eth_dev *dev, uint16_t tx_queue_id,
442                            struct rte_eth_burst_mode *mode);
443
444 /* Vectorized version of mlx5_rxtx.c */
445 int mlx5_rxq_check_vec_support(struct mlx5_rxq_data *rxq_data);
446 int mlx5_check_vec_rx_support(struct rte_eth_dev *dev);
447 uint16_t mlx5_rx_burst_vec(void *dpdk_txq, struct rte_mbuf **pkts,
448                            uint16_t pkts_n);
449 uint16_t mlx5_rx_burst_mprq_vec(void *dpdk_txq, struct rte_mbuf **pkts,
450                                 uint16_t pkts_n);
451
452 /* mlx5_mr.c */
453
454 void mlx5_mr_flush_local_cache(struct mlx5_mr_ctrl *mr_ctrl);
455 uint32_t mlx5_rx_addr2mr_bh(struct mlx5_rxq_data *rxq, uintptr_t addr);
456 uint32_t mlx5_tx_mb2mr_bh(struct mlx5_txq_data *txq, struct rte_mbuf *mb);
457 uint32_t mlx5_tx_update_ext_mp(struct mlx5_txq_data *txq, uintptr_t addr,
458                                struct rte_mempool *mp);
459 int mlx5_dma_map(struct rte_pci_device *pdev, void *addr, uint64_t iova,
460                  size_t len);
461 int mlx5_dma_unmap(struct rte_pci_device *pdev, void *addr, uint64_t iova,
462                    size_t len);
463
464 /**
465  * Provide safe 64bit store operation to mlx5 UAR region for both 32bit and
466  * 64bit architectures.
467  *
468  * @param val
469  *   value to write in CPU endian format.
470  * @param addr
471  *   Address to write to.
472  * @param lock
473  *   Address of the lock to use for that UAR access.
474  */
475 static __rte_always_inline void
476 __mlx5_uar_write64_relaxed(uint64_t val, void *addr,
477                            rte_spinlock_t *lock __rte_unused)
478 {
479 #ifdef RTE_ARCH_64
480         *(uint64_t *)addr = val;
481 #else /* !RTE_ARCH_64 */
482         rte_spinlock_lock(lock);
483         *(uint32_t *)addr = val;
484         rte_io_wmb();
485         *((uint32_t *)addr + 1) = val >> 32;
486         rte_spinlock_unlock(lock);
487 #endif
488 }
489
490 /**
491  * Provide safe 64bit store operation to mlx5 UAR region for both 32bit and
492  * 64bit architectures while guaranteeing the order of execution with the
493  * code being executed.
494  *
495  * @param val
496  *   value to write in CPU endian format.
497  * @param addr
498  *   Address to write to.
499  * @param lock
500  *   Address of the lock to use for that UAR access.
501  */
502 static __rte_always_inline void
503 __mlx5_uar_write64(uint64_t val, void *addr, rte_spinlock_t *lock)
504 {
505         rte_io_wmb();
506         __mlx5_uar_write64_relaxed(val, addr, lock);
507 }
508
509 /* Assist macros, used instead of directly calling the functions they wrap. */
510 #ifdef RTE_ARCH_64
511 #define mlx5_uar_write64_relaxed(val, dst, lock) \
512                 __mlx5_uar_write64_relaxed(val, dst, NULL)
513 #define mlx5_uar_write64(val, dst, lock) __mlx5_uar_write64(val, dst, NULL)
514 #else
515 #define mlx5_uar_write64_relaxed(val, dst, lock) \
516                 __mlx5_uar_write64_relaxed(val, dst, lock)
517 #define mlx5_uar_write64(val, dst, lock) __mlx5_uar_write64(val, dst, lock)
518 #endif
519
520 /**
521  * Get Memory Pool (MP) from mbuf. If mbuf is indirect, the pool from which the
522  * cloned mbuf is allocated is returned instead.
523  *
524  * @param buf
525  *   Pointer to mbuf.
526  *
527  * @return
528  *   Memory pool where data is located for given mbuf.
529  */
530 static inline struct rte_mempool *
531 mlx5_mb2mp(struct rte_mbuf *buf)
532 {
533         if (unlikely(RTE_MBUF_CLONED(buf)))
534                 return rte_mbuf_from_indirect(buf)->pool;
535         return buf->pool;
536 }
537
538 /**
539  * Query LKey from a packet buffer for Rx. No need to flush local caches for Rx
540  * as mempool is pre-configured and static.
541  *
542  * @param rxq
543  *   Pointer to Rx queue structure.
544  * @param addr
545  *   Address to search.
546  *
547  * @return
548  *   Searched LKey on success, UINT32_MAX on no match.
549  */
550 static __rte_always_inline uint32_t
551 mlx5_rx_addr2mr(struct mlx5_rxq_data *rxq, uintptr_t addr)
552 {
553         struct mlx5_mr_ctrl *mr_ctrl = &rxq->mr_ctrl;
554         uint32_t lkey;
555
556         /* Linear search on MR cache array. */
557         lkey = mlx5_mr_lookup_lkey(mr_ctrl->cache, &mr_ctrl->mru,
558                                    MLX5_MR_CACHE_N, addr);
559         if (likely(lkey != UINT32_MAX))
560                 return lkey;
561         /* Take slower bottom-half (Binary Search) on miss. */
562         return mlx5_rx_addr2mr_bh(rxq, addr);
563 }
564
565 #define mlx5_rx_mb2mr(rxq, mb) mlx5_rx_addr2mr(rxq, (uintptr_t)((mb)->buf_addr))
566
567 /**
568  * Query LKey from a packet buffer for Tx. If not found, add the mempool.
569  *
570  * @param txq
571  *   Pointer to Tx queue structure.
572  * @param addr
573  *   Address to search.
574  *
575  * @return
576  *   Searched LKey on success, UINT32_MAX on no match.
577  */
578 static __rte_always_inline uint32_t
579 mlx5_tx_mb2mr(struct mlx5_txq_data *txq, struct rte_mbuf *mb)
580 {
581         struct mlx5_mr_ctrl *mr_ctrl = &txq->mr_ctrl;
582         uintptr_t addr = (uintptr_t)mb->buf_addr;
583         uint32_t lkey;
584
585         /* Check generation bit to see if there's any change on existing MRs. */
586         if (unlikely(*mr_ctrl->dev_gen_ptr != mr_ctrl->cur_gen))
587                 mlx5_mr_flush_local_cache(mr_ctrl);
588         /* Linear search on MR cache array. */
589         lkey = mlx5_mr_lookup_lkey(mr_ctrl->cache, &mr_ctrl->mru,
590                                    MLX5_MR_CACHE_N, addr);
591         if (likely(lkey != UINT32_MAX))
592                 return lkey;
593         /* Take slower bottom-half on miss. */
594         return mlx5_tx_mb2mr_bh(txq, mb);
595 }
596
597 /**
598  * Ring TX queue doorbell and flush the update if requested.
599  *
600  * @param txq
601  *   Pointer to TX queue structure.
602  * @param wqe
603  *   Pointer to the last WQE posted in the NIC.
604  * @param cond
605  *   Request for write memory barrier after BlueFlame update.
606  */
607 static __rte_always_inline void
608 mlx5_tx_dbrec_cond_wmb(struct mlx5_txq_data *txq, volatile struct mlx5_wqe *wqe,
609                        int cond)
610 {
611         uint64_t *dst = MLX5_TX_BFREG(txq);
612         volatile uint64_t *src = ((volatile uint64_t *)wqe);
613
614         rte_io_wmb();
615         *txq->qp_db = rte_cpu_to_be_32(txq->wqe_ci);
616         /* Ensure ordering between DB record and BF copy. */
617         rte_wmb();
618         mlx5_uar_write64_relaxed(*src, dst, txq->uar_lock);
619         if (cond)
620                 rte_wmb();
621 }
622
623 /**
624  * Ring TX queue doorbell and flush the update by write memory barrier.
625  *
626  * @param txq
627  *   Pointer to TX queue structure.
628  * @param wqe
629  *   Pointer to the last WQE posted in the NIC.
630  */
631 static __rte_always_inline void
632 mlx5_tx_dbrec(struct mlx5_txq_data *txq, volatile struct mlx5_wqe *wqe)
633 {
634         mlx5_tx_dbrec_cond_wmb(txq, wqe, 1);
635 }
636
637 /**
638  * Convert timestamp from HW format to linear counter
639  * from Packet Pacing Clock Queue CQE timestamp format.
640  *
641  * @param sh
642  *   Pointer to the device shared context. Might be needed
643  *   to convert according current device configuration.
644  * @param ts
645  *   Timestamp from CQE to convert.
646  * @return
647  *   UTC in nanoseconds
648  */
649 static __rte_always_inline uint64_t
650 mlx5_txpp_convert_rx_ts(struct mlx5_dev_ctx_shared *sh, uint64_t ts)
651 {
652         RTE_SET_USED(sh);
653         return (ts & UINT32_MAX) + (ts >> 32) * NS_PER_S;
654 }
655
656 /**
657  * Convert timestamp from mbuf format to linear counter
658  * of Clock Queue completions (24 bits)
659  *
660  * @param sh
661  *   Pointer to the device shared context to fetch Tx
662  *   packet pacing timestamp and parameters.
663  * @param ts
664  *   Timestamp from mbuf to convert.
665  * @return
666  *   positive or zero value - completion ID to wait
667  *   negative value - conversion error
668  */
669 static __rte_always_inline int32_t
670 mlx5_txpp_convert_tx_ts(struct mlx5_dev_ctx_shared *sh, uint64_t mts)
671 {
672         uint64_t ts, ci;
673         uint32_t tick;
674
675         do {
676                 /*
677                  * Read atomically two uint64_t fields and compare lsb bits.
678                  * It there is no match - the timestamp was updated in
679                  * the service thread, data should be re-read.
680                  */
681                 rte_compiler_barrier();
682                 ci = rte_atomic64_read(&sh->txpp.ts.ci_ts);
683                 ts = rte_atomic64_read(&sh->txpp.ts.ts);
684                 rte_compiler_barrier();
685                 if (!((ts ^ ci) << (64 - MLX5_CQ_INDEX_WIDTH)))
686                         break;
687         } while (true);
688         /* Perform the skew correction, positive value to send earlier. */
689         mts -= sh->txpp.skew;
690         mts -= ts;
691         if (unlikely(mts >= UINT64_MAX / 2)) {
692                 /* We have negative integer, mts is in the past. */
693                 rte_atomic32_inc(&sh->txpp.err_ts_past);
694                 return -1;
695         }
696         tick = sh->txpp.tick;
697         MLX5_ASSERT(tick);
698         /* Convert delta to completions, round up. */
699         mts = (mts + tick - 1) / tick;
700         if (unlikely(mts >= (1 << MLX5_CQ_INDEX_WIDTH) / 2 - 1)) {
701                 /* We have mts is too distant future. */
702                 rte_atomic32_inc(&sh->txpp.err_ts_future);
703                 return -1;
704         }
705         mts <<= 64 - MLX5_CQ_INDEX_WIDTH;
706         ci += mts;
707         ci >>= 64 - MLX5_CQ_INDEX_WIDTH;
708         return ci;
709 }
710
711 /**
712  * Set timestamp in mbuf dynamic field.
713  *
714  * @param mbuf
715  *   Structure to write into.
716  * @param offset
717  *   Dynamic field offset in mbuf structure.
718  * @param timestamp
719  *   Value to write.
720  */
721 static __rte_always_inline void
722 mlx5_timestamp_set(struct rte_mbuf *mbuf, int offset,
723                 rte_mbuf_timestamp_t timestamp)
724 {
725         *RTE_MBUF_DYNFIELD(mbuf, offset, rte_mbuf_timestamp_t *) = timestamp;
726 }
727
728 /**
729  * Replace MPRQ buffer.
730  *
731  * @param rxq
732  *   Pointer to Rx queue structure.
733  * @param rq_idx
734  *   RQ index to replace.
735  */
736 static __rte_always_inline void
737 mprq_buf_replace(struct mlx5_rxq_data *rxq, uint16_t rq_idx)
738 {
739         const uint32_t strd_n = 1 << rxq->strd_num_n;
740         struct mlx5_mprq_buf *rep = rxq->mprq_repl;
741         volatile struct mlx5_wqe_data_seg *wqe =
742                 &((volatile struct mlx5_wqe_mprq *)rxq->wqes)[rq_idx].dseg;
743         struct mlx5_mprq_buf *buf = (*rxq->mprq_bufs)[rq_idx];
744         void *addr;
745
746         if (__atomic_load_n(&buf->refcnt, __ATOMIC_RELAXED) > 1) {
747                 MLX5_ASSERT(rep != NULL);
748                 /* Replace MPRQ buf. */
749                 (*rxq->mprq_bufs)[rq_idx] = rep;
750                 /* Replace WQE. */
751                 addr = mlx5_mprq_buf_addr(rep, strd_n);
752                 wqe->addr = rte_cpu_to_be_64((uintptr_t)addr);
753                 /* If there's only one MR, no need to replace LKey in WQE. */
754                 if (unlikely(mlx5_mr_btree_len(&rxq->mr_ctrl.cache_bh) > 1))
755                         wqe->lkey = mlx5_rx_addr2mr(rxq, (uintptr_t)addr);
756                 /* Stash a mbuf for next replacement. */
757                 if (likely(!rte_mempool_get(rxq->mprq_mp, (void **)&rep)))
758                         rxq->mprq_repl = rep;
759                 else
760                         rxq->mprq_repl = NULL;
761                 /* Release the old buffer. */
762                 mlx5_mprq_buf_free(buf);
763         } else if (unlikely(rxq->mprq_repl == NULL)) {
764                 struct mlx5_mprq_buf *rep;
765
766                 /*
767                  * Currently, the MPRQ mempool is out of buffer
768                  * and doing memcpy regardless of the size of Rx
769                  * packet. Retry allocation to get back to
770                  * normal.
771                  */
772                 if (!rte_mempool_get(rxq->mprq_mp, (void **)&rep))
773                         rxq->mprq_repl = rep;
774         }
775 }
776
777 /**
778  * Attach or copy MPRQ buffer content to a packet.
779  *
780  * @param rxq
781  *   Pointer to Rx queue structure.
782  * @param pkt
783  *   Pointer to a packet to fill.
784  * @param len
785  *   Packet length.
786  * @param buf
787  *   Pointer to a MPRQ buffer to take the data from.
788  * @param strd_idx
789  *   Stride index to start from.
790  * @param strd_cnt
791  *   Number of strides to consume.
792  */
793 static __rte_always_inline enum mlx5_rqx_code
794 mprq_buf_to_pkt(struct mlx5_rxq_data *rxq, struct rte_mbuf *pkt, uint32_t len,
795                 struct mlx5_mprq_buf *buf, uint16_t strd_idx, uint16_t strd_cnt)
796 {
797         const uint32_t strd_n = 1 << rxq->strd_num_n;
798         const uint16_t strd_sz = 1 << rxq->strd_sz_n;
799         const uint16_t strd_shift =
800                 MLX5_MPRQ_STRIDE_SHIFT_BYTE * rxq->strd_shift_en;
801         const int32_t hdrm_overlap =
802                 len + RTE_PKTMBUF_HEADROOM - strd_cnt * strd_sz;
803         const uint32_t offset = strd_idx * strd_sz + strd_shift;
804         void *addr = RTE_PTR_ADD(mlx5_mprq_buf_addr(buf, strd_n), offset);
805
806         /*
807          * Memcpy packets to the target mbuf if:
808          * - The size of packet is smaller than mprq_max_memcpy_len.
809          * - Out of buffer in the Mempool for Multi-Packet RQ.
810          * - The packet's stride overlaps a headroom and scatter is off.
811          */
812         if (len <= rxq->mprq_max_memcpy_len ||
813             rxq->mprq_repl == NULL ||
814             (hdrm_overlap > 0 && !rxq->strd_scatter_en)) {
815                 if (likely(len <=
816                            (uint32_t)(pkt->buf_len - RTE_PKTMBUF_HEADROOM))) {
817                         rte_memcpy(rte_pktmbuf_mtod(pkt, void *),
818                                    addr, len);
819                         DATA_LEN(pkt) = len;
820                 } else if (rxq->strd_scatter_en) {
821                         struct rte_mbuf *prev = pkt;
822                         uint32_t seg_len = RTE_MIN(len, (uint32_t)
823                                 (pkt->buf_len - RTE_PKTMBUF_HEADROOM));
824                         uint32_t rem_len = len - seg_len;
825
826                         rte_memcpy(rte_pktmbuf_mtod(pkt, void *),
827                                    addr, seg_len);
828                         DATA_LEN(pkt) = seg_len;
829                         while (rem_len) {
830                                 struct rte_mbuf *next =
831                                         rte_pktmbuf_alloc(rxq->mp);
832
833                                 if (unlikely(next == NULL))
834                                         return MLX5_RXQ_CODE_NOMBUF;
835                                 NEXT(prev) = next;
836                                 SET_DATA_OFF(next, 0);
837                                 addr = RTE_PTR_ADD(addr, seg_len);
838                                 seg_len = RTE_MIN(rem_len, (uint32_t)
839                                         (next->buf_len - RTE_PKTMBUF_HEADROOM));
840                                 rte_memcpy
841                                         (rte_pktmbuf_mtod(next, void *),
842                                          addr, seg_len);
843                                 DATA_LEN(next) = seg_len;
844                                 rem_len -= seg_len;
845                                 prev = next;
846                                 ++NB_SEGS(pkt);
847                         }
848                 } else {
849                         return MLX5_RXQ_CODE_DROPPED;
850                 }
851         } else {
852                 rte_iova_t buf_iova;
853                 struct rte_mbuf_ext_shared_info *shinfo;
854                 uint16_t buf_len = strd_cnt * strd_sz;
855                 void *buf_addr;
856
857                 /* Increment the refcnt of the whole chunk. */
858                 __atomic_add_fetch(&buf->refcnt, 1, __ATOMIC_RELAXED);
859                 MLX5_ASSERT(__atomic_load_n(&buf->refcnt,
860                             __ATOMIC_RELAXED) <= strd_n + 1);
861                 buf_addr = RTE_PTR_SUB(addr, RTE_PKTMBUF_HEADROOM);
862                 /*
863                  * MLX5 device doesn't use iova but it is necessary in a
864                  * case where the Rx packet is transmitted via a
865                  * different PMD.
866                  */
867                 buf_iova = rte_mempool_virt2iova(buf) +
868                            RTE_PTR_DIFF(buf_addr, buf);
869                 shinfo = &buf->shinfos[strd_idx];
870                 rte_mbuf_ext_refcnt_set(shinfo, 1);
871                 /*
872                  * EXT_ATTACHED_MBUF will be set to pkt->ol_flags when
873                  * attaching the stride to mbuf and more offload flags
874                  * will be added below by calling rxq_cq_to_mbuf().
875                  * Other fields will be overwritten.
876                  */
877                 rte_pktmbuf_attach_extbuf(pkt, buf_addr, buf_iova,
878                                           buf_len, shinfo);
879                 /* Set mbuf head-room. */
880                 SET_DATA_OFF(pkt, RTE_PKTMBUF_HEADROOM);
881                 MLX5_ASSERT(pkt->ol_flags == EXT_ATTACHED_MBUF);
882                 MLX5_ASSERT(rte_pktmbuf_tailroom(pkt) >=
883                         len - (hdrm_overlap > 0 ? hdrm_overlap : 0));
884                 DATA_LEN(pkt) = len;
885                 /*
886                  * Copy the last fragment of a packet (up to headroom
887                  * size bytes) in case there is a stride overlap with
888                  * a next packet's headroom. Allocate a separate mbuf
889                  * to store this fragment and link it. Scatter is on.
890                  */
891                 if (hdrm_overlap > 0) {
892                         MLX5_ASSERT(rxq->strd_scatter_en);
893                         struct rte_mbuf *seg =
894                                 rte_pktmbuf_alloc(rxq->mp);
895
896                         if (unlikely(seg == NULL))
897                                 return MLX5_RXQ_CODE_NOMBUF;
898                         SET_DATA_OFF(seg, 0);
899                         rte_memcpy(rte_pktmbuf_mtod(seg, void *),
900                                 RTE_PTR_ADD(addr, len - hdrm_overlap),
901                                 hdrm_overlap);
902                         DATA_LEN(seg) = hdrm_overlap;
903                         DATA_LEN(pkt) = len - hdrm_overlap;
904                         NEXT(pkt) = seg;
905                         NB_SEGS(pkt) = 2;
906                 }
907         }
908         return MLX5_RXQ_CODE_EXIT;
909 }
910
911 #endif /* RTE_PMD_MLX5_RXTX_H_ */