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