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_
11 #pragma GCC diagnostic ignored "-Wpedantic"
14 #include <rte_vhost.h>
16 #pragma GCC diagnostic error "-Wpedantic"
18 #include <rte_spinlock.h>
19 #include <rte_interrupts.h>
21 #include <mlx5_glue.h>
22 #include <mlx5_devx_cmds.h>
26 #define MLX5_VDPA_INTR_RETRIES 256
27 #define MLX5_VDPA_INTR_RETRIES_USEC 1000
34 struct mlx5_devx_obj *cq;
35 struct mlx5dv_devx_umem *umem_obj;
37 volatile void *umem_buf;
38 volatile struct mlx5_cqe *cqes;
40 volatile uint32_t *db_rec;
44 struct mlx5_vdpa_event_qp {
45 struct mlx5_vdpa_cq cq;
46 struct mlx5_devx_obj *fw_qp;
47 struct mlx5_devx_obj *sw_qp;
48 struct mlx5dv_devx_umem *umem_obj;
50 volatile uint32_t *db_rec;
53 struct mlx5_vdpa_query_mr {
54 SLIST_ENTRY(mlx5_vdpa_query_mr) next;
57 struct mlx5dv_devx_umem *umem;
58 struct mlx5_devx_obj *mkey;
62 struct mlx5_vdpa_virtq {
63 SLIST_ENTRY(mlx5_vdpa_virtq) next;
66 struct mlx5_devx_obj *virtq;
67 struct mlx5_vdpa_event_qp eqp;
69 struct mlx5dv_devx_umem *obj;
75 struct mlx5_vdpa_priv {
76 TAILQ_ENTRY(mlx5_vdpa_priv) next;
77 int id; /* vDPA device id. */
78 int vid; /* vhost device id. */
79 struct ibv_context *ctx; /* Device context. */
80 struct rte_vdpa_dev_addr dev_addr;
81 struct mlx5_hca_vdpa_attr caps;
82 uint32_t pdn; /* Protection Domain number. */
84 uint32_t gpa_mkey_index;
85 struct ibv_mr *null_mr;
86 struct rte_vhost_memory *vmem;
88 struct mlx5dv_devx_event_channel *eventc;
89 struct mlx5dv_devx_uar *uar;
90 struct rte_intr_handle intr_handle;
91 struct mlx5_devx_obj *td;
92 struct mlx5_devx_obj *tis;
94 SLIST_HEAD(virtq_list, mlx5_vdpa_virtq) virtq_list;
95 SLIST_HEAD(mr_list, mlx5_vdpa_query_mr) mr_list;
99 * Release all the prepared memory regions and all their related resources.
102 * The vdpa driver private structure.
104 void mlx5_vdpa_mem_dereg(struct mlx5_vdpa_priv *priv);
107 * Register all the memory regions of the virtio device to the HW and allocate
108 * all their related resources.
111 * The vdpa driver private structure.
114 * 0 on success, a negative errno value otherwise and rte_errno is set.
116 int mlx5_vdpa_mem_register(struct mlx5_vdpa_priv *priv);
120 * Create an event QP and all its related resources.
123 * The vdpa driver private structure.
125 * Number of descriptors.
127 * The guest notification file descriptor.
129 * Pointer to the event QP structure.
132 * 0 on success, -1 otherwise and rte_errno is set.
134 int mlx5_vdpa_event_qp_create(struct mlx5_vdpa_priv *priv, uint16_t desc_n,
135 int callfd, struct mlx5_vdpa_event_qp *eqp);
138 * Destroy an event QP and all its related resources.
141 * Pointer to the event QP structure.
143 void mlx5_vdpa_event_qp_destroy(struct mlx5_vdpa_event_qp *eqp);
146 * Release all the event global resources.
149 * The vdpa driver private structure.
151 void mlx5_vdpa_event_qp_global_release(struct mlx5_vdpa_priv *priv);
157 * The vdpa driver private structure.
160 * 0 on success, a negative errno value otherwise and rte_errno is set.
162 int mlx5_vdpa_cqe_event_setup(struct mlx5_vdpa_priv *priv);
168 * The vdpa driver private structure.
170 void mlx5_vdpa_cqe_event_unset(struct mlx5_vdpa_priv *priv);
173 * Release a virtq and all its related resources.
176 * The vdpa driver private structure.
178 void mlx5_vdpa_virtqs_release(struct mlx5_vdpa_priv *priv);
181 * Create all the HW virtqs resources and all their related resources.
184 * The vdpa driver private structure.
187 * 0 on success, a negative errno value otherwise and rte_errno is set.
189 int mlx5_vdpa_virtqs_prepare(struct mlx5_vdpa_priv *priv);
191 #endif /* RTE_PMD_MLX5_VDPA_H_ */