1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright 2019 Mellanox Technologies, Ltd
5 #ifndef RTE_PMD_MLX5_VDPA_H_
6 #define RTE_PMD_MLX5_VDPA_H_
8 #include <linux/virtio_net.h>
12 #pragma GCC diagnostic ignored "-Wpedantic"
15 #include <rte_vhost.h>
17 #pragma GCC diagnostic error "-Wpedantic"
19 #include <rte_spinlock.h>
20 #include <rte_interrupts.h>
22 #include <mlx5_glue.h>
23 #include <mlx5_devx_cmds.h>
27 #define MLX5_VDPA_INTR_RETRIES 256
28 #define MLX5_VDPA_INTR_RETRIES_USEC 1000
30 #ifndef VIRTIO_F_ORDER_PLATFORM
31 #define VIRTIO_F_ORDER_PLATFORM 36
34 #ifndef VIRTIO_F_RING_PACKED
35 #define VIRTIO_F_RING_PACKED 34
44 struct mlx5_devx_obj *cq;
45 struct mlx5dv_devx_umem *umem_obj;
47 volatile void *umem_buf;
48 volatile struct mlx5_cqe *cqes;
50 volatile uint32_t *db_rec;
54 struct mlx5_vdpa_event_qp {
55 struct mlx5_vdpa_cq cq;
56 struct mlx5_devx_obj *fw_qp;
57 struct mlx5_devx_obj *sw_qp;
58 struct mlx5dv_devx_umem *umem_obj;
60 volatile uint32_t *db_rec;
63 struct mlx5_vdpa_query_mr {
64 SLIST_ENTRY(mlx5_vdpa_query_mr) next;
67 struct mlx5dv_devx_umem *umem;
68 struct mlx5_devx_obj *mkey;
72 struct mlx5_vdpa_virtq {
73 SLIST_ENTRY(mlx5_vdpa_virtq) next;
77 struct mlx5_vdpa_priv *priv;
78 struct mlx5_devx_obj *virtq;
79 struct mlx5_vdpa_event_qp eqp;
81 struct mlx5dv_devx_umem *obj;
85 struct rte_intr_handle intr_handle;
88 struct mlx5_vdpa_steer {
89 struct mlx5_devx_obj *rqt;
93 struct mlx5dv_flow_matcher *matcher;
94 struct mlx5_devx_obj *tir;
100 struct mlx5_vdpa_priv {
101 TAILQ_ENTRY(mlx5_vdpa_priv) next;
103 uint8_t direct_notifier; /* Whether direct notifier is on or off. */
104 int id; /* vDPA device id. */
105 int vid; /* vhost device id. */
106 struct ibv_context *ctx; /* Device context. */
107 struct rte_vdpa_dev_addr dev_addr;
108 struct mlx5_hca_vdpa_attr caps;
109 uint32_t pdn; /* Protection Domain number. */
111 uint32_t gpa_mkey_index;
112 struct ibv_mr *null_mr;
113 struct rte_vhost_memory *vmem;
115 struct mlx5dv_devx_event_channel *eventc;
116 struct mlx5dv_devx_uar *uar;
117 struct rte_intr_handle intr_handle;
118 struct mlx5_devx_obj *td;
119 struct mlx5_devx_obj *tis;
121 uint64_t features; /* Negotiated features. */
122 uint16_t log_max_rqt_size;
123 struct mlx5_vdpa_steer steer;
124 struct mlx5dv_var *var;
126 SLIST_HEAD(mr_list, mlx5_vdpa_query_mr) mr_list;
127 struct mlx5_vdpa_virtq virtqs[];
131 * Check whether virtq is for traffic receive.
132 * According to VIRTIO_NET Spec the virtqueues index identity its type by:
137 * 2(N-1)+1 transmitqN
140 static inline uint8_t
141 is_virtq_recvq(int virtq_index, int nr_vring)
143 if (virtq_index % 2 == 0 && virtq_index != nr_vring - 1)
149 * Release all the prepared memory regions and all their related resources.
152 * The vdpa driver private structure.
154 void mlx5_vdpa_mem_dereg(struct mlx5_vdpa_priv *priv);
157 * Register all the memory regions of the virtio device to the HW and allocate
158 * all their related resources.
161 * The vdpa driver private structure.
164 * 0 on success, a negative errno value otherwise and rte_errno is set.
166 int mlx5_vdpa_mem_register(struct mlx5_vdpa_priv *priv);
170 * Create an event QP and all its related resources.
173 * The vdpa driver private structure.
175 * Number of descriptors.
177 * The guest notification file descriptor.
179 * Pointer to the event QP structure.
182 * 0 on success, -1 otherwise and rte_errno is set.
184 int mlx5_vdpa_event_qp_create(struct mlx5_vdpa_priv *priv, uint16_t desc_n,
185 int callfd, struct mlx5_vdpa_event_qp *eqp);
188 * Destroy an event QP and all its related resources.
191 * Pointer to the event QP structure.
193 void mlx5_vdpa_event_qp_destroy(struct mlx5_vdpa_event_qp *eqp);
196 * Release all the event global resources.
199 * The vdpa driver private structure.
201 void mlx5_vdpa_event_qp_global_release(struct mlx5_vdpa_priv *priv);
207 * The vdpa driver private structure.
210 * 0 on success, a negative errno value otherwise and rte_errno is set.
212 int mlx5_vdpa_cqe_event_setup(struct mlx5_vdpa_priv *priv);
218 * The vdpa driver private structure.
220 void mlx5_vdpa_cqe_event_unset(struct mlx5_vdpa_priv *priv);
223 * Release a virtq and all its related resources.
226 * The vdpa driver private structure.
228 void mlx5_vdpa_virtqs_release(struct mlx5_vdpa_priv *priv);
231 * Create all the HW virtqs resources and all their related resources.
234 * The vdpa driver private structure.
237 * 0 on success, a negative errno value otherwise and rte_errno is set.
239 int mlx5_vdpa_virtqs_prepare(struct mlx5_vdpa_priv *priv);
242 * Enable\Disable virtq..
245 * The vdpa driver private structure.
249 * Set to enable, otherwise disable.
252 * 0 on success, a negative value otherwise.
254 int mlx5_vdpa_virtq_enable(struct mlx5_vdpa_priv *priv, int index, int enable);
257 * Unset steering and release all its related resources- stop traffic.
260 * The vdpa driver private structure.
262 void mlx5_vdpa_steer_unset(struct mlx5_vdpa_priv *priv);
265 * Update steering according to the received queues status.
268 * The vdpa driver private structure.
271 * 0 on success, a negative value otherwise.
273 int mlx5_vdpa_steer_update(struct mlx5_vdpa_priv *priv);
276 * Setup steering and all its related resources to enable RSS traffic from the
277 * device to all the Rx host queues.
280 * The vdpa driver private structure.
283 * 0 on success, a negative value otherwise.
285 int mlx5_vdpa_steer_setup(struct mlx5_vdpa_priv *priv);
288 * Enable\Disable live migration logging.
291 * The vdpa driver private structure.
293 * Set for enable, unset for disable.
296 * 0 on success, a negative value otherwise.
298 int mlx5_vdpa_logging_enable(struct mlx5_vdpa_priv *priv, int enable);
301 * Set dirty bitmap logging to allow live migration.
304 * The vdpa driver private structure.
305 * @param[in] log_base
307 * @param[in] log_size
311 * 0 on success, a negative value otherwise.
313 int mlx5_vdpa_dirty_bitmap_set(struct mlx5_vdpa_priv *priv, uint64_t log_base,
317 * Log all virtqs information for live migration.
320 * The vdpa driver private structure.
322 * Set for enable, unset for disable.
325 * 0 on success, a negative value otherwise.
327 int mlx5_vdpa_lm_log(struct mlx5_vdpa_priv *priv);
330 * Modify virtq state to be ready or suspend.
333 * The vdpa driver private virtq structure.
335 * Set for ready, otherwise suspend.
338 * 0 on success, a negative value otherwise.
340 int mlx5_vdpa_virtq_modify(struct mlx5_vdpa_virtq *virtq, int state);
343 * Stop virtq before destroying it.
346 * The vdpa driver private structure.
351 * 0 on success, a negative value otherwise.
353 int mlx5_vdpa_virtq_stop(struct mlx5_vdpa_priv *priv, int index);
355 #endif /* RTE_PMD_MLX5_VDPA_H_ */