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
43 struct mlx5_devx_obj *cq;
44 struct mlx5dv_devx_umem *umem_obj;
46 volatile void *umem_buf;
47 volatile struct mlx5_cqe *cqes;
49 volatile uint32_t *db_rec;
53 struct mlx5_vdpa_event_qp {
54 struct mlx5_vdpa_cq cq;
55 struct mlx5_devx_obj *fw_qp;
56 struct mlx5_devx_obj *sw_qp;
57 struct mlx5dv_devx_umem *umem_obj;
59 volatile uint32_t *db_rec;
62 struct mlx5_vdpa_query_mr {
63 SLIST_ENTRY(mlx5_vdpa_query_mr) next;
66 struct mlx5dv_devx_umem *umem;
67 struct mlx5_devx_obj *mkey;
71 struct mlx5_vdpa_virtq {
72 SLIST_ENTRY(mlx5_vdpa_virtq) next;
76 struct mlx5_vdpa_priv *priv;
77 struct mlx5_devx_obj *virtq;
78 struct mlx5_vdpa_event_qp eqp;
80 struct mlx5dv_devx_umem *obj;
84 struct rte_intr_handle intr_handle;
87 struct mlx5_vdpa_steer {
88 struct mlx5_devx_obj *rqt;
92 struct mlx5dv_flow_matcher *matcher;
93 struct mlx5_devx_obj *tir;
99 struct mlx5_vdpa_priv {
100 TAILQ_ENTRY(mlx5_vdpa_priv) next;
101 int id; /* vDPA device id. */
102 int vid; /* vhost device id. */
103 struct ibv_context *ctx; /* Device context. */
104 struct rte_vdpa_dev_addr dev_addr;
105 struct mlx5_hca_vdpa_attr caps;
106 uint32_t pdn; /* Protection Domain number. */
108 uint32_t gpa_mkey_index;
109 struct ibv_mr *null_mr;
110 struct rte_vhost_memory *vmem;
112 struct mlx5dv_devx_event_channel *eventc;
113 struct mlx5dv_devx_uar *uar;
114 struct rte_intr_handle intr_handle;
115 struct mlx5_devx_obj *td;
116 struct mlx5_devx_obj *tis;
118 uint64_t features; /* Negotiated features. */
119 uint16_t log_max_rqt_size;
120 SLIST_HEAD(virtq_list, mlx5_vdpa_virtq) virtq_list;
121 struct mlx5_vdpa_steer steer;
122 struct mlx5dv_var *var;
124 SLIST_HEAD(mr_list, mlx5_vdpa_query_mr) mr_list;
128 * Release all the prepared memory regions and all their related resources.
131 * The vdpa driver private structure.
133 void mlx5_vdpa_mem_dereg(struct mlx5_vdpa_priv *priv);
136 * Register all the memory regions of the virtio device to the HW and allocate
137 * all their related resources.
140 * The vdpa driver private structure.
143 * 0 on success, a negative errno value otherwise and rte_errno is set.
145 int mlx5_vdpa_mem_register(struct mlx5_vdpa_priv *priv);
149 * Create an event QP and all its related resources.
152 * The vdpa driver private structure.
154 * Number of descriptors.
156 * The guest notification file descriptor.
158 * Pointer to the event QP structure.
161 * 0 on success, -1 otherwise and rte_errno is set.
163 int mlx5_vdpa_event_qp_create(struct mlx5_vdpa_priv *priv, uint16_t desc_n,
164 int callfd, struct mlx5_vdpa_event_qp *eqp);
167 * Destroy an event QP and all its related resources.
170 * Pointer to the event QP structure.
172 void mlx5_vdpa_event_qp_destroy(struct mlx5_vdpa_event_qp *eqp);
175 * Release all the event global resources.
178 * The vdpa driver private structure.
180 void mlx5_vdpa_event_qp_global_release(struct mlx5_vdpa_priv *priv);
186 * The vdpa driver private structure.
189 * 0 on success, a negative errno value otherwise and rte_errno is set.
191 int mlx5_vdpa_cqe_event_setup(struct mlx5_vdpa_priv *priv);
197 * The vdpa driver private structure.
199 void mlx5_vdpa_cqe_event_unset(struct mlx5_vdpa_priv *priv);
202 * Release a virtq and all its related resources.
205 * The vdpa driver private structure.
207 void mlx5_vdpa_virtqs_release(struct mlx5_vdpa_priv *priv);
210 * Create all the HW virtqs resources and all their related resources.
213 * The vdpa driver private structure.
216 * 0 on success, a negative errno value otherwise and rte_errno is set.
218 int mlx5_vdpa_virtqs_prepare(struct mlx5_vdpa_priv *priv);
221 * Enable\Disable virtq..
224 * The vdpa driver private virtq structure.
226 * Set to enable, otherwise disable.
229 * 0 on success, a negative value otherwise.
231 int mlx5_vdpa_virtq_enable(struct mlx5_vdpa_virtq *virtq, int enable);
234 * Unset steering and release all its related resources- stop traffic.
237 * The vdpa driver private structure.
239 int mlx5_vdpa_steer_unset(struct mlx5_vdpa_priv *priv);
242 * Setup steering and all its related resources to enable RSS traffic from the
243 * device to all the Rx host queues.
246 * The vdpa driver private structure.
249 * 0 on success, a negative value otherwise.
251 int mlx5_vdpa_steer_setup(struct mlx5_vdpa_priv *priv);
253 #endif /* RTE_PMD_MLX5_VDPA_H_ */