drivers/crypto/qat/qat_sym_pmd.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2015-2018 Intel Corporation
   3  */
   4
   5 #include <rte_bus_pci.h>
   6 #include <rte_common.h>
   7 #include <rte_dev.h>
   8 #include <rte_malloc.h>
   9 #include <rte_pci.h>
  10 #include <rte_cryptodev_pmd.h>
  11
  12 #include "qat_logs.h"
  13 #include "qat_sym.h"
  14 #include "qat_sym_session.h"
  15 #include "qat_sym_pmd.h"
  16
  17 uint8_t cryptodev_qat_driver_id;
  18
  19 static const struct rte_cryptodev_capabilities qat_gen1_sym_capabilities[] = {
  20         QAT_BASE_GEN1_SYM_CAPABILITIES,
  21         RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST()
  22 };
  23
  24 static const struct rte_cryptodev_capabilities qat_gen2_sym_capabilities[] = {
  25         QAT_BASE_GEN1_SYM_CAPABILITIES,
  26         QAT_EXTRA_GEN2_SYM_CAPABILITIES,
  27         RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST()
  28 };
  29
  30 static const struct rte_cryptodev_capabilities qat_gen3_sym_capabilities[] = {
  31         QAT_BASE_GEN1_SYM_CAPABILITIES,
  32         QAT_EXTRA_GEN2_SYM_CAPABILITIES,
  33         QAT_EXTRA_GEN3_SYM_CAPABILITIES,
  34         RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST()
  35 };
  36
  37 static int qat_sym_qp_release(struct rte_cryptodev *dev,
  38         uint16_t queue_pair_id);
  39
  40 static int qat_sym_dev_config(__rte_unused struct rte_cryptodev *dev,
  41                 __rte_unused struct rte_cryptodev_config *config)
  42 {
  43         return 0;
  44 }
  45
  46 static int qat_sym_dev_start(__rte_unused struct rte_cryptodev *dev)
  47 {
  48         return 0;
  49 }
  50
  51 static void qat_sym_dev_stop(__rte_unused struct rte_cryptodev *dev)
  52 {
  53         return;
  54 }
  55
  56 static int qat_sym_dev_close(struct rte_cryptodev *dev)
  57 {
  58         int i, ret;
  59
  60         for (i = 0; i < dev->data->nb_queue_pairs; i++) {
  61                 ret = qat_sym_qp_release(dev, i);
  62                 if (ret < 0)
  63                         return ret;
  64         }
  65
  66         return 0;
  67 }
  68
  69 static void qat_sym_dev_info_get(struct rte_cryptodev *dev,
  70                         struct rte_cryptodev_info *info)
  71 {
  72         struct qat_sym_dev_private *internals = dev->data->dev_private;
  73         const struct qat_qp_hw_data *sym_hw_qps =
  74                 qat_gen_config[internals->qat_dev->qat_dev_gen]
  75                               .qp_hw_data[QAT_SERVICE_SYMMETRIC];
  76
  77         if (info != NULL) {
  78                 info->max_nb_queue_pairs =
  79                         qat_qps_per_service(sym_hw_qps, QAT_SERVICE_SYMMETRIC);
  80                 info->feature_flags = dev->feature_flags;
  81                 info->capabilities = internals->qat_dev_capabilities;
  82                 info->driver_id = cryptodev_qat_driver_id;
  83                 /* No limit of number of sessions */
  84                 info->sym.max_nb_sessions = 0;
  85         }
  86 }
  87
  88 static void qat_sym_stats_get(struct rte_cryptodev *dev,
  89                 struct rte_cryptodev_stats *stats)
  90 {
  91         struct qat_common_stats qat_stats = {0};
  92         struct qat_sym_dev_private *qat_priv;
  93
  94         if (stats == NULL || dev == NULL) {
  95                 QAT_LOG(ERR, "invalid ptr: stats %p, dev %p", stats, dev);
  96                 return;
  97         }
  98         qat_priv = dev->data->dev_private;
  99
 100         qat_stats_get(qat_priv->qat_dev, &qat_stats, QAT_SERVICE_SYMMETRIC);
 101         stats->enqueued_count = qat_stats.enqueued_count;
 102         stats->dequeued_count = qat_stats.dequeued_count;
 103         stats->enqueue_err_count = qat_stats.enqueue_err_count;
 104         stats->dequeue_err_count = qat_stats.dequeue_err_count;
 105 }
 106
 107 static void qat_sym_stats_reset(struct rte_cryptodev *dev)
 108 {
 109         struct qat_sym_dev_private *qat_priv;
 110
 111         if (dev == NULL) {
 112                 QAT_LOG(ERR, "invalid cryptodev ptr %p", dev);
 113                 return;
 114         }
 115         qat_priv = dev->data->dev_private;
 116
 117         qat_stats_reset(qat_priv->qat_dev, QAT_SERVICE_SYMMETRIC);
 118
 119 }
 120
 121 static int qat_sym_qp_release(struct rte_cryptodev *dev, uint16_t queue_pair_id)
 122 {
 123         struct qat_sym_dev_private *qat_private = dev->data->dev_private;
 124
 125         QAT_LOG(DEBUG, "Release sym qp %u on device %d",
 126                                 queue_pair_id, dev->data->dev_id);
 127
 128         qat_private->qat_dev->qps_in_use[QAT_SERVICE_SYMMETRIC][queue_pair_id]
 129                                                 = NULL;
 130
 131         return qat_qp_release((struct qat_qp **)
 132                         &(dev->data->queue_pairs[queue_pair_id]));
 133 }
 134
 135 static int qat_sym_qp_setup(struct rte_cryptodev *dev, uint16_t qp_id,
 136         const struct rte_cryptodev_qp_conf *qp_conf,
 137         int socket_id)
 138 {
 139         struct qat_qp *qp;
 140         int ret = 0;
 141         uint32_t i;
 142         struct qat_qp_config qat_qp_conf;
 143
 144         struct qat_qp **qp_addr =
 145                         (struct qat_qp **)&(dev->data->queue_pairs[qp_id]);
 146         struct qat_sym_dev_private *qat_private = dev->data->dev_private;
 147         const struct qat_qp_hw_data *sym_hw_qps =
 148                         qat_gen_config[qat_private->qat_dev->qat_dev_gen]
 149                                       .qp_hw_data[QAT_SERVICE_SYMMETRIC];
 150         const struct qat_qp_hw_data *qp_hw_data = sym_hw_qps + qp_id;
 151
 152         /* If qp is already in use free ring memory and qp metadata. */
 153         if (*qp_addr != NULL) {
 154                 ret = qat_sym_qp_release(dev, qp_id);
 155                 if (ret < 0)
 156                         return ret;
 157         }
 158         if (qp_id >= qat_qps_per_service(sym_hw_qps, QAT_SERVICE_SYMMETRIC)) {
 159                 QAT_LOG(ERR, "qp_id %u invalid for this device", qp_id);
 160                 return -EINVAL;
 161         }
 162
 163         qat_qp_conf.hw = qp_hw_data;
 164         qat_qp_conf.build_request = qat_sym_build_request;
 165         qat_qp_conf.cookie_size = sizeof(struct qat_sym_op_cookie);
 166         qat_qp_conf.nb_descriptors = qp_conf->nb_descriptors;
 167         qat_qp_conf.socket_id = socket_id;
 168         qat_qp_conf.service_str = "sym";
 169
 170         ret = qat_qp_setup(qat_private->qat_dev, qp_addr, qp_id, &qat_qp_conf);
 171         if (ret != 0)
 172                 return ret;
 173
 174         /* store a link to the qp in the qat_pci_device */
 175         qat_private->qat_dev->qps_in_use[QAT_SERVICE_SYMMETRIC][qp_id]
 176                                                         = *qp_addr;
 177
 178         qp = (struct qat_qp *)*qp_addr;
 179         qp->min_enq_burst_threshold = qat_private->min_enq_burst_threshold;
 180
 181         for (i = 0; i < qp->nb_descriptors; i++) {
 182
 183                 struct qat_sym_op_cookie *cookie =
 184                                 qp->op_cookies[i];
 185
 186                 cookie->qat_sgl_src_phys_addr =
 187                                 rte_mempool_virt2iova(cookie) +
 188                                 offsetof(struct qat_sym_op_cookie,
 189                                 qat_sgl_src);
 190
 191                 cookie->qat_sgl_dst_phys_addr =
 192                                 rte_mempool_virt2iova(cookie) +
 193                                 offsetof(struct qat_sym_op_cookie,
 194                                 qat_sgl_dst);
 195         }
 196
 197         return ret;
 198 }
 199
 200 static struct rte_cryptodev_ops crypto_qat_ops = {
 201
 202                 /* Device related operations */
 203                 .dev_configure          = qat_sym_dev_config,
 204                 .dev_start              = qat_sym_dev_start,
 205                 .dev_stop               = qat_sym_dev_stop,
 206                 .dev_close              = qat_sym_dev_close,
 207                 .dev_infos_get          = qat_sym_dev_info_get,
 208
 209                 .stats_get              = qat_sym_stats_get,
 210                 .stats_reset            = qat_sym_stats_reset,
 211                 .queue_pair_setup       = qat_sym_qp_setup,
 212                 .queue_pair_release     = qat_sym_qp_release,
 213                 .queue_pair_count       = NULL,
 214
 215                 /* Crypto related operations */
 216                 .sym_session_get_size   = qat_sym_session_get_private_size,
 217                 .sym_session_configure  = qat_sym_session_configure,
 218                 .sym_session_clear      = qat_sym_session_clear
 219 };
 220
 221 static uint16_t
 222 qat_sym_pmd_enqueue_op_burst(void *qp, struct rte_crypto_op **ops,
 223                 uint16_t nb_ops)
 224 {
 225         return qat_enqueue_op_burst(qp, (void **)ops, nb_ops);
 226 }
 227
 228 static uint16_t
 229 qat_sym_pmd_dequeue_op_burst(void *qp, struct rte_crypto_op **ops,
 230                 uint16_t nb_ops)
 231 {
 232         return qat_dequeue_op_burst(qp, (void **)ops, nb_ops);
 233 }
 234
 235 /* An rte_driver is needed in the registration of both the device and the driver
 236  * with cryptodev.
 237  * The actual qat pci's rte_driver can't be used as its name represents
 238  * the whole pci device with all services. Think of this as a holder for a name
 239  * for the crypto part of the pci device.
 240  */
 241 static const char qat_sym_drv_name[] = RTE_STR(CRYPTODEV_NAME_QAT_SYM_PMD);
 242 static const struct rte_driver cryptodev_qat_sym_driver = {
 243         .name = qat_sym_drv_name,
 244         .alias = qat_sym_drv_name
 245 };
 246
 247 int
 248 qat_sym_dev_create(struct qat_pci_device *qat_pci_dev,
 249                 struct qat_dev_cmd_param *qat_dev_cmd_param __rte_unused)
 250 {
 251         int i = 0;
 252         struct rte_cryptodev_pmd_init_params init_params = {
 253                         .name = "",
 254                         .socket_id = qat_pci_dev->pci_dev->device.numa_node,
 255                         .private_data_size = sizeof(struct qat_sym_dev_private)
 256         };
 257         char name[RTE_CRYPTODEV_NAME_MAX_LEN];
 258         struct rte_cryptodev *cryptodev;
 259         struct qat_sym_dev_private *internals;
 260
 261         snprintf(name, RTE_CRYPTODEV_NAME_MAX_LEN, "%s_%s",
 262                         qat_pci_dev->name, "sym");
 263         QAT_LOG(DEBUG, "Creating QAT SYM device %s", name);
 264
 265         /* Populate subset device to use in cryptodev device creation */
 266         qat_pci_dev->sym_rte_dev.driver = &cryptodev_qat_sym_driver;
 267         qat_pci_dev->sym_rte_dev.numa_node =
 268                                 qat_pci_dev->pci_dev->device.numa_node;
 269         qat_pci_dev->sym_rte_dev.devargs = NULL;
 270
 271         cryptodev = rte_cryptodev_pmd_create(name,
 272                         &(qat_pci_dev->sym_rte_dev), &init_params);
 273
 274         if (cryptodev == NULL)
 275                 return -ENODEV;
 276
 277         qat_pci_dev->sym_rte_dev.name = cryptodev->data->name;
 278         cryptodev->driver_id = cryptodev_qat_driver_id;
 279         cryptodev->dev_ops = &crypto_qat_ops;
 280
 281         cryptodev->enqueue_burst = qat_sym_pmd_enqueue_op_burst;
 282         cryptodev->dequeue_burst = qat_sym_pmd_dequeue_op_burst;
 283
 284         cryptodev->feature_flags = RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO |
 285                         RTE_CRYPTODEV_FF_HW_ACCELERATED |
 286                         RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING |
 287                         RTE_CRYPTODEV_FF_IN_PLACE_SGL |
 288                         RTE_CRYPTODEV_FF_OOP_SGL_IN_SGL_OUT |
 289                         RTE_CRYPTODEV_FF_OOP_SGL_IN_LB_OUT |
 290                         RTE_CRYPTODEV_FF_OOP_LB_IN_SGL_OUT |
 291                         RTE_CRYPTODEV_FF_OOP_LB_IN_LB_OUT |
 292                         RTE_CRYPTODEV_FF_DIGEST_ENCRYPTED;
 293
 294         internals = cryptodev->data->dev_private;
 295         internals->qat_dev = qat_pci_dev;
 296         qat_pci_dev->sym_dev = internals;
 297
 298         internals->sym_dev_id = cryptodev->data->dev_id;
 299         switch (qat_pci_dev->qat_dev_gen) {
 300         case QAT_GEN1:
 301                 internals->qat_dev_capabilities = qat_gen1_sym_capabilities;
 302                 break;
 303         case QAT_GEN2:
 304                 internals->qat_dev_capabilities = qat_gen2_sym_capabilities;
 305                 break;
 306         case QAT_GEN3:
 307                 internals->qat_dev_capabilities = qat_gen3_sym_capabilities;
 308                 break;
 309         default:
 310                 internals->qat_dev_capabilities = qat_gen2_sym_capabilities;
 311                 QAT_LOG(DEBUG,
 312                         "QAT gen %d capabilities unknown, default to GEN2",
 313                                         qat_pci_dev->qat_dev_gen);
 314                 break;
 315         }
 316
 317         while (1) {
 318                 if (qat_dev_cmd_param[i].name == NULL)
 319                         break;
 320                 if (!strcmp(qat_dev_cmd_param[i].name, SYM_ENQ_THRESHOLD_NAME))
 321                         internals->min_enq_burst_threshold =
 322                                         qat_dev_cmd_param[i].val;
 323                 i++;
 324         }
 325
 326         QAT_LOG(DEBUG, "Created QAT SYM device %s as cryptodev instance %d",
 327                         cryptodev->data->name, internals->sym_dev_id);
 328         return 0;
 329 }
 330
 331 int
 332 qat_sym_dev_destroy(struct qat_pci_device *qat_pci_dev)
 333 {
 334         struct rte_cryptodev *cryptodev;
 335
 336         if (qat_pci_dev == NULL)
 337                 return -ENODEV;
 338         if (qat_pci_dev->sym_dev == NULL)
 339                 return 0;
 340
 341         /* free crypto device */
 342         cryptodev = rte_cryptodev_pmd_get_dev(qat_pci_dev->sym_dev->sym_dev_id);
 343         rte_cryptodev_pmd_destroy(cryptodev);
 344         qat_pci_dev->sym_rte_dev.name = NULL;
 345         qat_pci_dev->sym_dev = NULL;
 346
 347         return 0;
 348 }
 349
 350 static struct cryptodev_driver qat_crypto_drv;
 351 RTE_PMD_REGISTER_CRYPTO_DRIVER(qat_crypto_drv,
 352                 cryptodev_qat_sym_driver,
 353                 cryptodev_qat_driver_id);