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 };
  85
  86 struct mlx5_vdpa_steer {
  87         struct mlx5_devx_obj *rqt;
  88         void *domain;
  89         void *tbl;
  90         struct {
  91                 struct mlx5dv_flow_matcher *matcher;
  92                 struct mlx5_devx_obj *tir;
  93                 void *tir_action;
  94                 void *flow;
  95         } rss[7];
  96 };
  97
  98 struct mlx5_vdpa_priv {
  99         TAILQ_ENTRY(mlx5_vdpa_priv) next;
 100         int id; /* vDPA device id. */
 101         int vid; /* vhost device id. */
 102         struct ibv_context *ctx; /* Device context. */
 103         struct rte_vdpa_dev_addr dev_addr;
 104         struct mlx5_hca_vdpa_attr caps;
 105         uint32_t pdn; /* Protection Domain number. */
 106         struct ibv_pd *pd;
 107         uint32_t gpa_mkey_index;
 108         struct ibv_mr *null_mr;
 109         struct rte_vhost_memory *vmem;
 110         uint32_t eqn;
 111         struct mlx5dv_devx_event_channel *eventc;
 112         struct mlx5dv_devx_uar *uar;
 113         struct rte_intr_handle intr_handle;
 114         struct mlx5_devx_obj *td;
 115         struct mlx5_devx_obj *tis;
 116         uint16_t nr_virtqs;
 117         uint64_t features; /* Negotiated features. */
 118         uint16_t log_max_rqt_size;
 119         SLIST_HEAD(virtq_list, mlx5_vdpa_virtq) virtq_list;
 120         struct mlx5_vdpa_steer steer;
 121         SLIST_HEAD(mr_list, mlx5_vdpa_query_mr) mr_list;
 122 };
 123
 124 /**
 125  * Release all the prepared memory regions and all their related resources.
 126  *
 127  * @param[in] priv
 128  *   The vdpa driver private structure.
 129  */
 130 void mlx5_vdpa_mem_dereg(struct mlx5_vdpa_priv *priv);
 131
 132 /**
 133  * Register all the memory regions of the virtio device to the HW and allocate
 134  * all their related resources.
 135  *
 136  * @param[in] priv
 137  *   The vdpa driver private structure.
 138  *
 139  * @return
 140  *   0 on success, a negative errno value otherwise and rte_errno is set.
 141  */
 142 int mlx5_vdpa_mem_register(struct mlx5_vdpa_priv *priv);
 143
 144
 145 /**
 146  * Create an event QP and all its related resources.
 147  *
 148  * @param[in] priv
 149  *   The vdpa driver private structure.
 150  * @param[in] desc_n
 151  *   Number of descriptors.
 152  * @param[in] callfd
 153  *   The guest notification file descriptor.
 154  * @param[in/out] eqp
 155  *   Pointer to the event QP structure.
 156  *
 157  * @return
 158  *   0 on success, -1 otherwise and rte_errno is set.
 159  */
 160 int mlx5_vdpa_event_qp_create(struct mlx5_vdpa_priv *priv, uint16_t desc_n,
 161                               int callfd, struct mlx5_vdpa_event_qp *eqp);
 162
 163 /**
 164  * Destroy an event QP and all its related resources.
 165  *
 166  * @param[in/out] eqp
 167  *   Pointer to the event QP structure.
 168  */
 169 void mlx5_vdpa_event_qp_destroy(struct mlx5_vdpa_event_qp *eqp);
 170
 171 /**
 172  * Release all the event global resources.
 173  *
 174  * @param[in] priv
 175  *   The vdpa driver private structure.
 176  */
 177 void mlx5_vdpa_event_qp_global_release(struct mlx5_vdpa_priv *priv);
 178
 179 /**
 180  * Setup CQE event.
 181  *
 182  * @param[in] priv
 183  *   The vdpa driver private structure.
 184  *
 185  * @return
 186  *   0 on success, a negative errno value otherwise and rte_errno is set.
 187  */
 188 int mlx5_vdpa_cqe_event_setup(struct mlx5_vdpa_priv *priv);
 189
 190 /**
 191  * Unset CQE event .
 192  *
 193  * @param[in] priv
 194  *   The vdpa driver private structure.
 195  */
 196 void mlx5_vdpa_cqe_event_unset(struct mlx5_vdpa_priv *priv);
 197
 198 /**
 199  * Release a virtq and all its related resources.
 200  *
 201  * @param[in] priv
 202  *   The vdpa driver private structure.
 203  */
 204 void mlx5_vdpa_virtqs_release(struct mlx5_vdpa_priv *priv);
 205
 206 /**
 207  * Create all the HW virtqs resources and all their related resources.
 208  *
 209  * @param[in] priv
 210  *   The vdpa driver private structure.
 211  *
 212  * @return
 213  *   0 on success, a negative errno value otherwise and rte_errno is set.
 214  */
 215 int mlx5_vdpa_virtqs_prepare(struct mlx5_vdpa_priv *priv);
 216
 217 /**
 218  * Enable\Disable virtq..
 219  *
 220  * @param[in] virtq
 221  *   The vdpa driver private virtq structure.
 222  * @param[in] enable
 223  *   Set to enable, otherwise disable.
 224  *
 225  * @return
 226  *   0 on success, a negative value otherwise.
 227  */
 228 int mlx5_vdpa_virtq_enable(struct mlx5_vdpa_virtq *virtq, int enable);
 229
 230 /**
 231  * Unset steering and release all its related resources- stop traffic.
 232  *
 233  * @param[in] priv
 234  *   The vdpa driver private structure.
 235  */
 236 int mlx5_vdpa_steer_unset(struct mlx5_vdpa_priv *priv);
 237
 238 /**
 239  * Setup steering and all its related resources to enable RSS traffic from the
 240  * device to all the Rx host queues.
 241  *
 242  * @param[in] priv
 243  *   The vdpa driver private structure.
 244  *
 245  * @return
 246  *   0 on success, a negative value otherwise.
 247  */
 248 int mlx5_vdpa_steer_setup(struct mlx5_vdpa_priv *priv);
 249
 250 #endif /* RTE_PMD_MLX5_VDPA_H_ */