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         uint16_t index;
  74         uint16_t vq_size;
  75         struct mlx5_devx_obj *virtq;
  76         struct mlx5_vdpa_event_qp eqp;
  77         struct {
  78                 struct mlx5dv_devx_umem *obj;
  79                 void *buf;
  80                 uint32_t size;
  81         } umems[3];
  82 };
  83
  84 struct mlx5_vdpa_priv {
  85         TAILQ_ENTRY(mlx5_vdpa_priv) next;
  86         int id; /* vDPA device id. */
  87         int vid; /* vhost device id. */
  88         struct ibv_context *ctx; /* Device context. */
  89         struct rte_vdpa_dev_addr dev_addr;
  90         struct mlx5_hca_vdpa_attr caps;
  91         uint32_t pdn; /* Protection Domain number. */
  92         struct ibv_pd *pd;
  93         uint32_t gpa_mkey_index;
  94         struct ibv_mr *null_mr;
  95         struct rte_vhost_memory *vmem;
  96         uint32_t eqn;
  97         struct mlx5dv_devx_event_channel *eventc;
  98         struct mlx5dv_devx_uar *uar;
  99         struct rte_intr_handle intr_handle;
 100         struct mlx5_devx_obj *td;
 101         struct mlx5_devx_obj *tis;
 102         uint16_t nr_virtqs;
 103         uint64_t features; /* Negotiated features. */
 104         SLIST_HEAD(virtq_list, mlx5_vdpa_virtq) virtq_list;
 105         SLIST_HEAD(mr_list, mlx5_vdpa_query_mr) mr_list;
 106 };
 107
 108 /**
 109  * Release all the prepared memory regions and all their related resources.
 110  *
 111  * @param[in] priv
 112  *   The vdpa driver private structure.
 113  */
 114 void mlx5_vdpa_mem_dereg(struct mlx5_vdpa_priv *priv);
 115
 116 /**
 117  * Register all the memory regions of the virtio device to the HW and allocate
 118  * all their related resources.
 119  *
 120  * @param[in] priv
 121  *   The vdpa driver private structure.
 122  *
 123  * @return
 124  *   0 on success, a negative errno value otherwise and rte_errno is set.
 125  */
 126 int mlx5_vdpa_mem_register(struct mlx5_vdpa_priv *priv);
 127
 128
 129 /**
 130  * Create an event QP and all its related resources.
 131  *
 132  * @param[in] priv
 133  *   The vdpa driver private structure.
 134  * @param[in] desc_n
 135  *   Number of descriptors.
 136  * @param[in] callfd
 137  *   The guest notification file descriptor.
 138  * @param[in/out] eqp
 139  *   Pointer to the event QP structure.
 140  *
 141  * @return
 142  *   0 on success, -1 otherwise and rte_errno is set.
 143  */
 144 int mlx5_vdpa_event_qp_create(struct mlx5_vdpa_priv *priv, uint16_t desc_n,
 145                               int callfd, struct mlx5_vdpa_event_qp *eqp);
 146
 147 /**
 148  * Destroy an event QP and all its related resources.
 149  *
 150  * @param[in/out] eqp
 151  *   Pointer to the event QP structure.
 152  */
 153 void mlx5_vdpa_event_qp_destroy(struct mlx5_vdpa_event_qp *eqp);
 154
 155 /**
 156  * Release all the event global resources.
 157  *
 158  * @param[in] priv
 159  *   The vdpa driver private structure.
 160  */
 161 void mlx5_vdpa_event_qp_global_release(struct mlx5_vdpa_priv *priv);
 162
 163 /**
 164  * Setup CQE event.
 165  *
 166  * @param[in] priv
 167  *   The vdpa driver private structure.
 168  *
 169  * @return
 170  *   0 on success, a negative errno value otherwise and rte_errno is set.
 171  */
 172 int mlx5_vdpa_cqe_event_setup(struct mlx5_vdpa_priv *priv);
 173
 174 /**
 175  * Unset CQE event .
 176  *
 177  * @param[in] priv
 178  *   The vdpa driver private structure.
 179  */
 180 void mlx5_vdpa_cqe_event_unset(struct mlx5_vdpa_priv *priv);
 181
 182 /**
 183  * Release a virtq and all its related resources.
 184  *
 185  * @param[in] priv
 186  *   The vdpa driver private structure.
 187  */
 188 void mlx5_vdpa_virtqs_release(struct mlx5_vdpa_priv *priv);
 189
 190 /**
 191  * Create all the HW virtqs resources and all their related resources.
 192  *
 193  * @param[in] priv
 194  *   The vdpa driver private structure.
 195  *
 196  * @return
 197  *   0 on success, a negative errno value otherwise and rte_errno is set.
 198  */
 199 int mlx5_vdpa_virtqs_prepare(struct mlx5_vdpa_priv *priv);
 200
 201 #endif /* RTE_PMD_MLX5_VDPA_H_ */