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