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 int id; /* vDPA device id. */
104 int vid; /* vhost device id. */
105 struct ibv_context *ctx; /* Device context. */
106 struct rte_vdpa_dev_addr dev_addr;
107 struct mlx5_hca_vdpa_attr caps;
108 uint32_t pdn; /* Protection Domain number. */
110 uint32_t gpa_mkey_index;
111 struct ibv_mr *null_mr;
112 struct rte_vhost_memory *vmem;
114 struct mlx5dv_devx_event_channel *eventc;
115 struct mlx5dv_devx_uar *uar;
116 struct rte_intr_handle intr_handle;
117 struct mlx5_devx_obj *td;
118 struct mlx5_devx_obj *tis;
120 uint64_t features; /* Negotiated features. */
121 uint16_t log_max_rqt_size;
122 SLIST_HEAD(virtq_list, mlx5_vdpa_virtq) virtq_list;
123 struct mlx5_vdpa_steer steer;
124 struct mlx5dv_var *var;
126 SLIST_HEAD(mr_list, mlx5_vdpa_query_mr) mr_list;
130 * Release all the prepared memory regions and all their related resources.
133 * The vdpa driver private structure.
135 void mlx5_vdpa_mem_dereg(struct mlx5_vdpa_priv *priv);
138 * Register all the memory regions of the virtio device to the HW and allocate
139 * all their related resources.
142 * The vdpa driver private structure.
145 * 0 on success, a negative errno value otherwise and rte_errno is set.
147 int mlx5_vdpa_mem_register(struct mlx5_vdpa_priv *priv);
151 * Create an event QP and all its related resources.
154 * The vdpa driver private structure.
156 * Number of descriptors.
158 * The guest notification file descriptor.
160 * Pointer to the event QP structure.
163 * 0 on success, -1 otherwise and rte_errno is set.
165 int mlx5_vdpa_event_qp_create(struct mlx5_vdpa_priv *priv, uint16_t desc_n,
166 int callfd, struct mlx5_vdpa_event_qp *eqp);
169 * Destroy an event QP and all its related resources.
172 * Pointer to the event QP structure.
174 void mlx5_vdpa_event_qp_destroy(struct mlx5_vdpa_event_qp *eqp);
177 * Release all the event global resources.
180 * The vdpa driver private structure.
182 void mlx5_vdpa_event_qp_global_release(struct mlx5_vdpa_priv *priv);
188 * The vdpa driver private structure.
191 * 0 on success, a negative errno value otherwise and rte_errno is set.
193 int mlx5_vdpa_cqe_event_setup(struct mlx5_vdpa_priv *priv);
199 * The vdpa driver private structure.
201 void mlx5_vdpa_cqe_event_unset(struct mlx5_vdpa_priv *priv);
204 * Release a virtq and all its related resources.
207 * The vdpa driver private structure.
209 void mlx5_vdpa_virtqs_release(struct mlx5_vdpa_priv *priv);
212 * Create all the HW virtqs resources and all their related resources.
215 * The vdpa driver private structure.
218 * 0 on success, a negative errno value otherwise and rte_errno is set.
220 int mlx5_vdpa_virtqs_prepare(struct mlx5_vdpa_priv *priv);
223 * Enable\Disable virtq..
226 * The vdpa driver private virtq structure.
228 * Set to enable, otherwise disable.
231 * 0 on success, a negative value otherwise.
233 int mlx5_vdpa_virtq_enable(struct mlx5_vdpa_virtq *virtq, int enable);
236 * Unset steering and release all its related resources- stop traffic.
239 * The vdpa driver private structure.
241 int mlx5_vdpa_steer_unset(struct mlx5_vdpa_priv *priv);
244 * Setup steering and all its related resources to enable RSS traffic from the
245 * device to all the Rx host queues.
248 * The vdpa driver private structure.
251 * 0 on success, a negative value otherwise.
253 int mlx5_vdpa_steer_setup(struct mlx5_vdpa_priv *priv);
256 * Enable\Disable live migration logging.
259 * The vdpa driver private structure.
261 * Set for enable, unset for disable.
264 * 0 on success, a negative value otherwise.
266 int mlx5_vdpa_logging_enable(struct mlx5_vdpa_priv *priv, int enable);
269 * Set dirty bitmap logging to allow live migration.
272 * The vdpa driver private structure.
273 * @param[in] log_base
275 * @param[in] log_size
279 * 0 on success, a negative value otherwise.
281 int mlx5_vdpa_dirty_bitmap_set(struct mlx5_vdpa_priv *priv, uint64_t log_base,
285 * Log all virtqs information for live migration.
288 * The vdpa driver private structure.
290 * Set for enable, unset for disable.
293 * 0 on success, a negative value otherwise.
295 int mlx5_vdpa_lm_log(struct mlx5_vdpa_priv *priv);
298 * Modify virtq state to be ready or suspend.
301 * The vdpa driver private virtq structure.
303 * Set for ready, otherwise suspend.
306 * 0 on success, a negative value otherwise.
308 int mlx5_vdpa_virtq_modify(struct mlx5_vdpa_virtq *virtq, int state);
310 #endif /* RTE_PMD_MLX5_VDPA_H_ */