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_steer {
  85         struct mlx5_devx_obj *rqt;
  86         void *domain;
  87         void *tbl;
  88         struct {
  89                 struct mlx5dv_flow_matcher *matcher;
  90                 struct mlx5_devx_obj *tir;
  91                 void *tir_action;
  92                 void *flow;
  93         } rss[7];
  94 };
  95
  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. */
 104         struct ibv_pd *pd;
 105         uint32_t gpa_mkey_index;
 106         struct ibv_mr *null_mr;
 107         struct rte_vhost_memory *vmem;
 108         uint32_t eqn;
 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;
 114         uint16_t nr_virtqs;
 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;
 120 };
 121
 122 /**
 123  * Release all the prepared memory regions and all their related resources.
 124  *
 125  * @param[in] priv
 126  *   The vdpa driver private structure.
 127  */
 128 void mlx5_vdpa_mem_dereg(struct mlx5_vdpa_priv *priv);
 129
 130 /**
 131  * Register all the memory regions of the virtio device to the HW and allocate
 132  * all their related resources.
 133  *
 134  * @param[in] priv
 135  *   The vdpa driver private structure.
 136  *
 137  * @return
 138  *   0 on success, a negative errno value otherwise and rte_errno is set.
 139  */
 140 int mlx5_vdpa_mem_register(struct mlx5_vdpa_priv *priv);
 141
 142
 143 /**
 144  * Create an event QP and all its related resources.
 145  *
 146  * @param[in] priv
 147  *   The vdpa driver private structure.
 148  * @param[in] desc_n
 149  *   Number of descriptors.
 150  * @param[in] callfd
 151  *   The guest notification file descriptor.
 152  * @param[in/out] eqp
 153  *   Pointer to the event QP structure.
 154  *
 155  * @return
 156  *   0 on success, -1 otherwise and rte_errno is set.
 157  */
 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);
 160
 161 /**
 162  * Destroy an event QP and all its related resources.
 163  *
 164  * @param[in/out] eqp
 165  *   Pointer to the event QP structure.
 166  */
 167 void mlx5_vdpa_event_qp_destroy(struct mlx5_vdpa_event_qp *eqp);
 168
 169 /**
 170  * Release all the event global resources.
 171  *
 172  * @param[in] priv
 173  *   The vdpa driver private structure.
 174  */
 175 void mlx5_vdpa_event_qp_global_release(struct mlx5_vdpa_priv *priv);
 176
 177 /**
 178  * Setup CQE event.
 179  *
 180  * @param[in] priv
 181  *   The vdpa driver private structure.
 182  *
 183  * @return
 184  *   0 on success, a negative errno value otherwise and rte_errno is set.
 185  */
 186 int mlx5_vdpa_cqe_event_setup(struct mlx5_vdpa_priv *priv);
 187
 188 /**
 189  * Unset CQE event .
 190  *
 191  * @param[in] priv
 192  *   The vdpa driver private structure.
 193  */
 194 void mlx5_vdpa_cqe_event_unset(struct mlx5_vdpa_priv *priv);
 195
 196 /**
 197  * Release a virtq and all its related resources.
 198  *
 199  * @param[in] priv
 200  *   The vdpa driver private structure.
 201  */
 202 void mlx5_vdpa_virtqs_release(struct mlx5_vdpa_priv *priv);
 203
 204 /**
 205  * Create all the HW virtqs resources and all their related resources.
 206  *
 207  * @param[in] priv
 208  *   The vdpa driver private structure.
 209  *
 210  * @return
 211  *   0 on success, a negative errno value otherwise and rte_errno is set.
 212  */
 213 int mlx5_vdpa_virtqs_prepare(struct mlx5_vdpa_priv *priv);
 214
 215 /**
 216  * Unset steering and release all its related resources- stop traffic.
 217  *
 218  * @param[in] priv
 219  *   The vdpa driver private structure.
 220  */
 221 int mlx5_vdpa_steer_unset(struct mlx5_vdpa_priv *priv);
 222
 223 /**
 224  * Setup steering and all its related resources to enable RSS traffic from the
 225  * device to all the Rx host queues.
 226  *
 227  * @param[in] priv
 228  *   The vdpa driver private structure.
 229  *
 230  * @return
 231  *   0 on success, a negative value otherwise.
 232  */
 233 int mlx5_vdpa_steer_setup(struct mlx5_vdpa_priv *priv);
 234
 235 #endif /* RTE_PMD_MLX5_VDPA_H_ */