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;
75 struct mlx5_devx_obj *virtq;
76 struct mlx5_vdpa_event_qp eqp;
78 struct mlx5dv_devx_umem *obj;
84 struct mlx5_vdpa_steer {
85 struct mlx5_devx_obj *rqt;
89 struct mlx5dv_flow_matcher *matcher;
90 struct mlx5_devx_obj *tir;
96 struct mlx5_vdpa_priv {
97 TAILQ_ENTRY(mlx5_vdpa_priv) next;
98 int id; /* vDPA device id. */
99 int vid; /* vhost device id. */
100 struct ibv_context *ctx; /* Device context. */
101 struct rte_vdpa_dev_addr dev_addr;
102 struct mlx5_hca_vdpa_attr caps;
103 uint32_t pdn; /* Protection Domain number. */
105 uint32_t gpa_mkey_index;
106 struct ibv_mr *null_mr;
107 struct rte_vhost_memory *vmem;
109 struct mlx5dv_devx_event_channel *eventc;
110 struct mlx5dv_devx_uar *uar;
111 struct rte_intr_handle intr_handle;
112 struct mlx5_devx_obj *td;
113 struct mlx5_devx_obj *tis;
115 uint64_t features; /* Negotiated features. */
116 uint16_t log_max_rqt_size;
117 SLIST_HEAD(virtq_list, mlx5_vdpa_virtq) virtq_list;
118 struct mlx5_vdpa_steer steer;
119 SLIST_HEAD(mr_list, mlx5_vdpa_query_mr) mr_list;
123 * Release all the prepared memory regions and all their related resources.
126 * The vdpa driver private structure.
128 void mlx5_vdpa_mem_dereg(struct mlx5_vdpa_priv *priv);
131 * Register all the memory regions of the virtio device to the HW and allocate
132 * all their related resources.
135 * The vdpa driver private structure.
138 * 0 on success, a negative errno value otherwise and rte_errno is set.
140 int mlx5_vdpa_mem_register(struct mlx5_vdpa_priv *priv);
144 * Create an event QP and all its related resources.
147 * The vdpa driver private structure.
149 * Number of descriptors.
151 * The guest notification file descriptor.
153 * Pointer to the event QP structure.
156 * 0 on success, -1 otherwise and rte_errno is set.
158 int mlx5_vdpa_event_qp_create(struct mlx5_vdpa_priv *priv, uint16_t desc_n,
159 int callfd, struct mlx5_vdpa_event_qp *eqp);
162 * Destroy an event QP and all its related resources.
165 * Pointer to the event QP structure.
167 void mlx5_vdpa_event_qp_destroy(struct mlx5_vdpa_event_qp *eqp);
170 * Release all the event global resources.
173 * The vdpa driver private structure.
175 void mlx5_vdpa_event_qp_global_release(struct mlx5_vdpa_priv *priv);
181 * The vdpa driver private structure.
184 * 0 on success, a negative errno value otherwise and rte_errno is set.
186 int mlx5_vdpa_cqe_event_setup(struct mlx5_vdpa_priv *priv);
192 * The vdpa driver private structure.
194 void mlx5_vdpa_cqe_event_unset(struct mlx5_vdpa_priv *priv);
197 * Release a virtq and all its related resources.
200 * The vdpa driver private structure.
202 void mlx5_vdpa_virtqs_release(struct mlx5_vdpa_priv *priv);
205 * Create all the HW virtqs resources and all their related resources.
208 * The vdpa driver private structure.
211 * 0 on success, a negative errno value otherwise and rte_errno is set.
213 int mlx5_vdpa_virtqs_prepare(struct mlx5_vdpa_priv *priv);
216 * Unset steering and release all its related resources- stop traffic.
219 * The vdpa driver private structure.
221 int mlx5_vdpa_steer_unset(struct mlx5_vdpa_priv *priv);
224 * Setup steering and all its related resources to enable RSS traffic from the
225 * device to all the Rx host queues.
228 * The vdpa driver private structure.
231 * 0 on success, a negative value otherwise.
233 int mlx5_vdpa_steer_setup(struct mlx5_vdpa_priv *priv);
235 #endif /* RTE_PMD_MLX5_VDPA_H_ */