vdpa/mlx5: support close and config operations
[dpdk.git] / drivers / vdpa / mlx5 / mlx5_vdpa.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright 2019 Mellanox Technologies, Ltd
3  */
4
5 #ifndef RTE_PMD_MLX5_VDPA_H_
6 #define RTE_PMD_MLX5_VDPA_H_
7
8 #include <linux/virtio_net.h>
9 #include <sys/queue.h>
10
11 #ifdef PEDANTIC
12 #pragma GCC diagnostic ignored "-Wpedantic"
13 #endif
14 #include <rte_vdpa.h>
15 #include <rte_vhost.h>
16 #ifdef PEDANTIC
17 #pragma GCC diagnostic error "-Wpedantic"
18 #endif
19 #include <rte_spinlock.h>
20 #include <rte_interrupts.h>
21
22 #include <mlx5_glue.h>
23 #include <mlx5_devx_cmds.h>
24 #include <mlx5_prm.h>
25
26
27 #define MLX5_VDPA_INTR_RETRIES 256
28 #define MLX5_VDPA_INTR_RETRIES_USEC 1000
29
30 #ifndef VIRTIO_F_ORDER_PLATFORM
31 #define VIRTIO_F_ORDER_PLATFORM 36
32 #endif
33
34 #ifndef VIRTIO_F_RING_PACKED
35 #define VIRTIO_F_RING_PACKED 34
36 #endif
37
38 struct mlx5_vdpa_cq {
39         uint16_t log_desc_n;
40         uint32_t cq_ci:24;
41         uint32_t arm_sn:2;
42         rte_spinlock_t sl;
43         struct mlx5_devx_obj *cq;
44         struct mlx5dv_devx_umem *umem_obj;
45         union {
46                 volatile void *umem_buf;
47                 volatile struct mlx5_cqe *cqes;
48         };
49         volatile uint32_t *db_rec;
50         uint64_t errors;
51 };
52
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;
58         void *umem_buf;
59         volatile uint32_t *db_rec;
60 };
61
62 struct mlx5_vdpa_query_mr {
63         SLIST_ENTRY(mlx5_vdpa_query_mr) next;
64         void *addr;
65         uint64_t length;
66         struct mlx5dv_devx_umem *umem;
67         struct mlx5_devx_obj *mkey;
68         int is_indirect;
69 };
70
71 struct mlx5_vdpa_virtq {
72         SLIST_ENTRY(mlx5_vdpa_virtq) next;
73         uint8_t enable;
74         uint16_t index;
75         uint16_t vq_size;
76         struct mlx5_vdpa_priv *priv;
77         struct mlx5_devx_obj *virtq;
78         struct mlx5_vdpa_event_qp eqp;
79         struct {
80                 struct mlx5dv_devx_umem *obj;
81                 void *buf;
82                 uint32_t size;
83         } umems[3];
84         struct rte_intr_handle intr_handle;
85 };
86
87 struct mlx5_vdpa_steer {
88         struct mlx5_devx_obj *rqt;
89         void *domain;
90         void *tbl;
91         struct {
92                 struct mlx5dv_flow_matcher *matcher;
93                 struct mlx5_devx_obj *tir;
94                 void *tir_action;
95                 void *flow;
96         } rss[7];
97 };
98
99 struct mlx5_vdpa_priv {
100         TAILQ_ENTRY(mlx5_vdpa_priv) next;
101         uint8_t configured;
102         int id; /* vDPA device id. */
103         int vid; /* vhost device id. */
104         struct ibv_context *ctx; /* Device context. */
105         struct rte_vdpa_dev_addr dev_addr;
106         struct mlx5_hca_vdpa_attr caps;
107         uint32_t pdn; /* Protection Domain number. */
108         struct ibv_pd *pd;
109         uint32_t gpa_mkey_index;
110         struct ibv_mr *null_mr;
111         struct rte_vhost_memory *vmem;
112         uint32_t eqn;
113         struct mlx5dv_devx_event_channel *eventc;
114         struct mlx5dv_devx_uar *uar;
115         struct rte_intr_handle intr_handle;
116         struct mlx5_devx_obj *td;
117         struct mlx5_devx_obj *tis;
118         uint16_t nr_virtqs;
119         uint64_t features; /* Negotiated features. */
120         uint16_t log_max_rqt_size;
121         SLIST_HEAD(virtq_list, mlx5_vdpa_virtq) virtq_list;
122         struct mlx5_vdpa_steer steer;
123         struct mlx5dv_var *var;
124         void *virtq_db_addr;
125         SLIST_HEAD(mr_list, mlx5_vdpa_query_mr) mr_list;
126 };
127
128 /**
129  * Release all the prepared memory regions and all their related resources.
130  *
131  * @param[in] priv
132  *   The vdpa driver private structure.
133  */
134 void mlx5_vdpa_mem_dereg(struct mlx5_vdpa_priv *priv);
135
136 /**
137  * Register all the memory regions of the virtio device to the HW and allocate
138  * all their related resources.
139  *
140  * @param[in] priv
141  *   The vdpa driver private structure.
142  *
143  * @return
144  *   0 on success, a negative errno value otherwise and rte_errno is set.
145  */
146 int mlx5_vdpa_mem_register(struct mlx5_vdpa_priv *priv);
147
148
149 /**
150  * Create an event QP and all its related resources.
151  *
152  * @param[in] priv
153  *   The vdpa driver private structure.
154  * @param[in] desc_n
155  *   Number of descriptors.
156  * @param[in] callfd
157  *   The guest notification file descriptor.
158  * @param[in/out] eqp
159  *   Pointer to the event QP structure.
160  *
161  * @return
162  *   0 on success, -1 otherwise and rte_errno is set.
163  */
164 int mlx5_vdpa_event_qp_create(struct mlx5_vdpa_priv *priv, uint16_t desc_n,
165                               int callfd, struct mlx5_vdpa_event_qp *eqp);
166
167 /**
168  * Destroy an event QP and all its related resources.
169  *
170  * @param[in/out] eqp
171  *   Pointer to the event QP structure.
172  */
173 void mlx5_vdpa_event_qp_destroy(struct mlx5_vdpa_event_qp *eqp);
174
175 /**
176  * Release all the event global resources.
177  *
178  * @param[in] priv
179  *   The vdpa driver private structure.
180  */
181 void mlx5_vdpa_event_qp_global_release(struct mlx5_vdpa_priv *priv);
182
183 /**
184  * Setup CQE event.
185  *
186  * @param[in] priv
187  *   The vdpa driver private structure.
188  *
189  * @return
190  *   0 on success, a negative errno value otherwise and rte_errno is set.
191  */
192 int mlx5_vdpa_cqe_event_setup(struct mlx5_vdpa_priv *priv);
193
194 /**
195  * Unset CQE event .
196  *
197  * @param[in] priv
198  *   The vdpa driver private structure.
199  */
200 void mlx5_vdpa_cqe_event_unset(struct mlx5_vdpa_priv *priv);
201
202 /**
203  * Release a virtq and all its related resources.
204  *
205  * @param[in] priv
206  *   The vdpa driver private structure.
207  */
208 void mlx5_vdpa_virtqs_release(struct mlx5_vdpa_priv *priv);
209
210 /**
211  * Create all the HW virtqs resources and all their related resources.
212  *
213  * @param[in] priv
214  *   The vdpa driver private structure.
215  *
216  * @return
217  *   0 on success, a negative errno value otherwise and rte_errno is set.
218  */
219 int mlx5_vdpa_virtqs_prepare(struct mlx5_vdpa_priv *priv);
220
221 /**
222  * Enable\Disable virtq..
223  *
224  * @param[in] virtq
225  *   The vdpa driver private virtq structure.
226  * @param[in] enable
227  *   Set to enable, otherwise disable.
228  *
229  * @return
230  *   0 on success, a negative value otherwise.
231  */
232 int mlx5_vdpa_virtq_enable(struct mlx5_vdpa_virtq *virtq, int enable);
233
234 /**
235  * Unset steering and release all its related resources- stop traffic.
236  *
237  * @param[in] priv
238  *   The vdpa driver private structure.
239  */
240 int mlx5_vdpa_steer_unset(struct mlx5_vdpa_priv *priv);
241
242 /**
243  * Setup steering and all its related resources to enable RSS traffic from the
244  * device to all the Rx host queues.
245  *
246  * @param[in] priv
247  *   The vdpa driver private structure.
248  *
249  * @return
250  *   0 on success, a negative value otherwise.
251  */
252 int mlx5_vdpa_steer_setup(struct mlx5_vdpa_priv *priv);
253
254 /**
255  * Enable\Disable live migration logging.
256  *
257  * @param[in] priv
258  *   The vdpa driver private structure.
259  * @param[in] enable
260  *   Set for enable, unset for disable.
261  *
262  * @return
263  *   0 on success, a negative value otherwise.
264  */
265 int mlx5_vdpa_logging_enable(struct mlx5_vdpa_priv *priv, int enable);
266
267 /**
268  * Set dirty bitmap logging to allow live migration.
269  *
270  * @param[in] priv
271  *   The vdpa driver private structure.
272  * @param[in] log_base
273  *   Vhost log base.
274  * @param[in] log_size
275  *   Vhost log size.
276  *
277  * @return
278  *   0 on success, a negative value otherwise.
279  */
280 int mlx5_vdpa_dirty_bitmap_set(struct mlx5_vdpa_priv *priv, uint64_t log_base,
281                                uint64_t log_size);
282
283 /**
284  * Log all virtqs information for live migration.
285  *
286  * @param[in] priv
287  *   The vdpa driver private structure.
288  * @param[in] enable
289  *   Set for enable, unset for disable.
290  *
291  * @return
292  *   0 on success, a negative value otherwise.
293  */
294 int mlx5_vdpa_lm_log(struct mlx5_vdpa_priv *priv);
295
296 /**
297  * Modify virtq state to be ready or suspend.
298  *
299  * @param[in] virtq
300  *   The vdpa driver private virtq structure.
301  * @param[in] state
302  *   Set for ready, otherwise suspend.
303  *
304  * @return
305  *   0 on success, a negative value otherwise.
306  */
307 int mlx5_vdpa_virtq_modify(struct mlx5_vdpa_virtq *virtq, int state);
308
309 #endif /* RTE_PMD_MLX5_VDPA_H_ */