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 SLIST_HEAD(virtq_list, mlx5_vdpa_virtq) virtq_list;
124 struct mlx5_vdpa_steer steer;
125 struct mlx5dv_var *var;
127 SLIST_HEAD(mr_list, mlx5_vdpa_query_mr) mr_list;
131 * Release all the prepared memory regions and all their related resources.
134 * The vdpa driver private structure.
136 void mlx5_vdpa_mem_dereg(struct mlx5_vdpa_priv *priv);
139 * Register all the memory regions of the virtio device to the HW and allocate
140 * all their related resources.
143 * The vdpa driver private structure.
146 * 0 on success, a negative errno value otherwise and rte_errno is set.
148 int mlx5_vdpa_mem_register(struct mlx5_vdpa_priv *priv);
152 * Create an event QP and all its related resources.
155 * The vdpa driver private structure.
157 * Number of descriptors.
159 * The guest notification file descriptor.
161 * Pointer to the event QP structure.
164 * 0 on success, -1 otherwise and rte_errno is set.
166 int mlx5_vdpa_event_qp_create(struct mlx5_vdpa_priv *priv, uint16_t desc_n,
167 int callfd, struct mlx5_vdpa_event_qp *eqp);
170 * Destroy an event QP and all its related resources.
173 * Pointer to the event QP structure.
175 void mlx5_vdpa_event_qp_destroy(struct mlx5_vdpa_event_qp *eqp);
178 * Release all the event global resources.
181 * The vdpa driver private structure.
183 void mlx5_vdpa_event_qp_global_release(struct mlx5_vdpa_priv *priv);
189 * The vdpa driver private structure.
192 * 0 on success, a negative errno value otherwise and rte_errno is set.
194 int mlx5_vdpa_cqe_event_setup(struct mlx5_vdpa_priv *priv);
200 * The vdpa driver private structure.
202 void mlx5_vdpa_cqe_event_unset(struct mlx5_vdpa_priv *priv);
205 * Release a virtq and all its related resources.
208 * The vdpa driver private structure.
210 void mlx5_vdpa_virtqs_release(struct mlx5_vdpa_priv *priv);
213 * Create all the HW virtqs resources and all their related resources.
216 * The vdpa driver private structure.
219 * 0 on success, a negative errno value otherwise and rte_errno is set.
221 int mlx5_vdpa_virtqs_prepare(struct mlx5_vdpa_priv *priv);
224 * Enable\Disable virtq..
227 * The vdpa driver private virtq structure.
229 * Set to enable, otherwise disable.
232 * 0 on success, a negative value otherwise.
234 int mlx5_vdpa_virtq_enable(struct mlx5_vdpa_virtq *virtq, int enable);
237 * Unset steering and release all its related resources- stop traffic.
240 * The vdpa driver private structure.
242 int mlx5_vdpa_steer_unset(struct mlx5_vdpa_priv *priv);
245 * Setup steering and all its related resources to enable RSS traffic from the
246 * device to all the Rx host queues.
249 * The vdpa driver private structure.
252 * 0 on success, a negative value otherwise.
254 int mlx5_vdpa_steer_setup(struct mlx5_vdpa_priv *priv);
257 * Enable\Disable live migration logging.
260 * The vdpa driver private structure.
262 * Set for enable, unset for disable.
265 * 0 on success, a negative value otherwise.
267 int mlx5_vdpa_logging_enable(struct mlx5_vdpa_priv *priv, int enable);
270 * Set dirty bitmap logging to allow live migration.
273 * The vdpa driver private structure.
274 * @param[in] log_base
276 * @param[in] log_size
280 * 0 on success, a negative value otherwise.
282 int mlx5_vdpa_dirty_bitmap_set(struct mlx5_vdpa_priv *priv, uint64_t log_base,
286 * Log all virtqs information for live migration.
289 * The vdpa driver private structure.
291 * Set for enable, unset for disable.
294 * 0 on success, a negative value otherwise.
296 int mlx5_vdpa_lm_log(struct mlx5_vdpa_priv *priv);
299 * Modify virtq state to be ready or suspend.
302 * The vdpa driver private virtq structure.
304 * Set for ready, otherwise suspend.
307 * 0 on success, a negative value otherwise.
309 int mlx5_vdpa_virtq_modify(struct mlx5_vdpa_virtq *virtq, int state);
311 #endif /* RTE_PMD_MLX5_VDPA_H_ */