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 #ifdef RTE_LIBRTE_SECURITY
  12 #include <rte_security_driver.h>
  13 #endif
  14
  15 #include "qat_logs.h"
  16 #include "qat_sym.h"
  17 #include "qat_sym_session.h"
  18 #include "qat_sym_pmd.h"
  19
  20 #define MIXED_CRYPTO_MIN_FW_VER 0x04090000
  21
  22 uint8_t qat_sym_driver_id;
  23
  24 static const struct rte_cryptodev_capabilities qat_gen1_sym_capabilities[] = {
  25         QAT_BASE_GEN1_SYM_CAPABILITIES,
  26         RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST()
  27 };
  28
  29 static const struct rte_cryptodev_capabilities qat_gen2_sym_capabilities[] = {
  30         QAT_BASE_GEN1_SYM_CAPABILITIES,
  31         QAT_EXTRA_GEN2_SYM_CAPABILITIES,
  32         RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST()
  33 };
  34
  35 static const struct rte_cryptodev_capabilities qat_gen3_sym_capabilities[] = {
  36         QAT_BASE_GEN1_SYM_CAPABILITIES,
  37         QAT_EXTRA_GEN2_SYM_CAPABILITIES,
  38         RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST()
  39 };
  40
  41 #ifdef RTE_LIBRTE_SECURITY
  42 static const struct rte_cryptodev_capabilities
  43                                         qat_security_sym_capabilities[] = {
  44         QAT_SECURITY_SYM_CAPABILITIES,
  45         RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST()
  46 };
  47
  48 static const struct rte_security_capability qat_security_capabilities[] = {
  49         QAT_SECURITY_CAPABILITIES(qat_security_sym_capabilities),
  50         {
  51                 .action = RTE_SECURITY_ACTION_TYPE_NONE
  52         }
  53 };
  54 #endif
  55
  56 static int qat_sym_qp_release(struct rte_cryptodev *dev,
  57         uint16_t queue_pair_id);
  58
  59 static int qat_sym_dev_config(__rte_unused struct rte_cryptodev *dev,
  60                 __rte_unused struct rte_cryptodev_config *config)
  61 {
  62         return 0;
  63 }
  64
  65 static int qat_sym_dev_start(__rte_unused struct rte_cryptodev *dev)
  66 {
  67         return 0;
  68 }
  69
  70 static void qat_sym_dev_stop(__rte_unused struct rte_cryptodev *dev)
  71 {
  72         return;
  73 }
  74
  75 static int qat_sym_dev_close(struct rte_cryptodev *dev)
  76 {
  77         int i, ret;
  78
  79         for (i = 0; i < dev->data->nb_queue_pairs; i++) {
  80                 ret = qat_sym_qp_release(dev, i);
  81                 if (ret < 0)
  82                         return ret;
  83         }
  84
  85         return 0;
  86 }
  87
  88 static void qat_sym_dev_info_get(struct rte_cryptodev *dev,
  89                         struct rte_cryptodev_info *info)
  90 {
  91         struct qat_sym_dev_private *internals = dev->data->dev_private;
  92         const struct qat_qp_hw_data *sym_hw_qps =
  93                 qat_gen_config[internals->qat_dev->qat_dev_gen]
  94                               .qp_hw_data[QAT_SERVICE_SYMMETRIC];
  95
  96         if (info != NULL) {
  97                 info->max_nb_queue_pairs =
  98                         qat_qps_per_service(sym_hw_qps, QAT_SERVICE_SYMMETRIC);
  99                 info->feature_flags = dev->feature_flags;
 100                 info->capabilities = internals->qat_dev_capabilities;
 101                 info->driver_id = qat_sym_driver_id;
 102                 /* No limit of number of sessions */
 103                 info->sym.max_nb_sessions = 0;
 104         }
 105 }
 106
 107 static void qat_sym_stats_get(struct rte_cryptodev *dev,
 108                 struct rte_cryptodev_stats *stats)
 109 {
 110         struct qat_common_stats qat_stats = {0};
 111         struct qat_sym_dev_private *qat_priv;
 112
 113         if (stats == NULL || dev == NULL) {
 114                 QAT_LOG(ERR, "invalid ptr: stats %p, dev %p", stats, dev);
 115                 return;
 116         }
 117         qat_priv = dev->data->dev_private;
 118
 119         qat_stats_get(qat_priv->qat_dev, &qat_stats, QAT_SERVICE_SYMMETRIC);
 120         stats->enqueued_count = qat_stats.enqueued_count;
 121         stats->dequeued_count = qat_stats.dequeued_count;
 122         stats->enqueue_err_count = qat_stats.enqueue_err_count;
 123         stats->dequeue_err_count = qat_stats.dequeue_err_count;
 124 }
 125
 126 static void qat_sym_stats_reset(struct rte_cryptodev *dev)
 127 {
 128         struct qat_sym_dev_private *qat_priv;
 129
 130         if (dev == NULL) {
 131                 QAT_LOG(ERR, "invalid cryptodev ptr %p", dev);
 132                 return;
 133         }
 134         qat_priv = dev->data->dev_private;
 135
 136         qat_stats_reset(qat_priv->qat_dev, QAT_SERVICE_SYMMETRIC);
 137
 138 }
 139
 140 static int qat_sym_qp_release(struct rte_cryptodev *dev, uint16_t queue_pair_id)
 141 {
 142         struct qat_sym_dev_private *qat_private = dev->data->dev_private;
 143
 144         QAT_LOG(DEBUG, "Release sym qp %u on device %d",
 145                                 queue_pair_id, dev->data->dev_id);
 146
 147         qat_private->qat_dev->qps_in_use[QAT_SERVICE_SYMMETRIC][queue_pair_id]
 148                                                 = NULL;
 149
 150         return qat_qp_release((struct qat_qp **)
 151                         &(dev->data->queue_pairs[queue_pair_id]));
 152 }
 153
 154 static int qat_sym_qp_setup(struct rte_cryptodev *dev, uint16_t qp_id,
 155         const struct rte_cryptodev_qp_conf *qp_conf,
 156         int socket_id)
 157 {
 158         struct qat_qp *qp;
 159         int ret = 0;
 160         uint32_t i;
 161         struct qat_qp_config qat_qp_conf;
 162
 163         struct qat_qp **qp_addr =
 164                         (struct qat_qp **)&(dev->data->queue_pairs[qp_id]);
 165         struct qat_sym_dev_private *qat_private = dev->data->dev_private;
 166         const struct qat_qp_hw_data *sym_hw_qps =
 167                         qat_gen_config[qat_private->qat_dev->qat_dev_gen]
 168                                       .qp_hw_data[QAT_SERVICE_SYMMETRIC];
 169         const struct qat_qp_hw_data *qp_hw_data = sym_hw_qps + qp_id;
 170
 171         /* If qp is already in use free ring memory and qp metadata. */
 172         if (*qp_addr != NULL) {
 173                 ret = qat_sym_qp_release(dev, qp_id);
 174                 if (ret < 0)
 175                         return ret;
 176         }
 177         if (qp_id >= qat_qps_per_service(sym_hw_qps, QAT_SERVICE_SYMMETRIC)) {
 178                 QAT_LOG(ERR, "qp_id %u invalid for this device", qp_id);
 179                 return -EINVAL;
 180         }
 181
 182         qat_qp_conf.hw = qp_hw_data;
 183         qat_qp_conf.build_request = qat_sym_build_request;
 184         qat_qp_conf.cookie_size = sizeof(struct qat_sym_op_cookie);
 185         qat_qp_conf.nb_descriptors = qp_conf->nb_descriptors;
 186         qat_qp_conf.socket_id = socket_id;
 187         qat_qp_conf.service_str = "sym";
 188
 189         ret = qat_qp_setup(qat_private->qat_dev, qp_addr, qp_id, &qat_qp_conf);
 190         if (ret != 0)
 191                 return ret;
 192
 193         /* store a link to the qp in the qat_pci_device */
 194         qat_private->qat_dev->qps_in_use[QAT_SERVICE_SYMMETRIC][qp_id]
 195                                                         = *qp_addr;
 196
 197         qp = (struct qat_qp *)*qp_addr;
 198         qp->min_enq_burst_threshold = qat_private->min_enq_burst_threshold;
 199
 200         for (i = 0; i < qp->nb_descriptors; i++) {
 201
 202                 struct qat_sym_op_cookie *cookie =
 203                                 qp->op_cookies[i];
 204
 205                 cookie->qat_sgl_src_phys_addr =
 206                                 rte_mempool_virt2iova(cookie) +
 207                                 offsetof(struct qat_sym_op_cookie,
 208                                 qat_sgl_src);
 209
 210                 cookie->qat_sgl_dst_phys_addr =
 211                                 rte_mempool_virt2iova(cookie) +
 212                                 offsetof(struct qat_sym_op_cookie,
 213                                 qat_sgl_dst);
 214         }
 215
 216         /* Get fw version from QAT (GEN2), skip if we've got it already */
 217         if (qp->qat_dev_gen == QAT_GEN2 && !(qat_private->internal_capabilities
 218                         & QAT_SYM_CAP_VALID)) {
 219                 ret = qat_cq_get_fw_version(qp);
 220
 221                 if (ret < 0) {
 222                         qat_sym_qp_release(dev, qp_id);
 223                         return ret;
 224                 }
 225
 226                 if (ret != 0)
 227                         QAT_LOG(DEBUG, "QAT firmware version: %d.%d.%d",
 228                                         (ret >> 24) & 0xff,
 229                                         (ret >> 16) & 0xff,
 230                                         (ret >> 8) & 0xff);
 231                 else
 232                         QAT_LOG(DEBUG, "unknown QAT firmware version");
 233
 234                 /* set capabilities based on the fw version */
 235                 qat_private->internal_capabilities = QAT_SYM_CAP_VALID |
 236                                 ((ret >= MIXED_CRYPTO_MIN_FW_VER) ?
 237                                                 QAT_SYM_CAP_MIXED_CRYPTO : 0);
 238                 ret = 0;
 239         }
 240
 241         return ret;
 242 }
 243
 244 static struct rte_cryptodev_ops crypto_qat_ops = {
 245
 246                 /* Device related operations */
 247                 .dev_configure          = qat_sym_dev_config,
 248                 .dev_start              = qat_sym_dev_start,
 249                 .dev_stop               = qat_sym_dev_stop,
 250                 .dev_close              = qat_sym_dev_close,
 251                 .dev_infos_get          = qat_sym_dev_info_get,
 252
 253                 .stats_get              = qat_sym_stats_get,
 254                 .stats_reset            = qat_sym_stats_reset,
 255                 .queue_pair_setup       = qat_sym_qp_setup,
 256                 .queue_pair_release     = qat_sym_qp_release,
 257
 258                 /* Crypto related operations */
 259                 .sym_session_get_size   = qat_sym_session_get_private_size,
 260                 .sym_session_configure  = qat_sym_session_configure,
 261                 .sym_session_clear      = qat_sym_session_clear
 262 };
 263
 264 #ifdef RTE_LIBRTE_SECURITY
 265 static const struct rte_security_capability *
 266 qat_security_cap_get(void *device __rte_unused)
 267 {
 268         return qat_security_capabilities;
 269 }
 270
 271 static struct rte_security_ops security_qat_ops = {
 272
 273                 .session_create = qat_security_session_create,
 274                 .session_update = NULL,
 275                 .session_stats_get = NULL,
 276                 .session_destroy = qat_security_session_destroy,
 277                 .set_pkt_metadata = NULL,
 278                 .capabilities_get = qat_security_cap_get
 279 };
 280 #endif
 281
 282 static uint16_t
 283 qat_sym_pmd_enqueue_op_burst(void *qp, struct rte_crypto_op **ops,
 284                 uint16_t nb_ops)
 285 {
 286         return qat_enqueue_op_burst(qp, (void **)ops, nb_ops);
 287 }
 288
 289 static uint16_t
 290 qat_sym_pmd_dequeue_op_burst(void *qp, struct rte_crypto_op **ops,
 291                 uint16_t nb_ops)
 292 {
 293         return qat_dequeue_op_burst(qp, (void **)ops, nb_ops);
 294 }
 295
 296 /* An rte_driver is needed in the registration of both the device and the driver
 297  * with cryptodev.
 298  * The actual qat pci's rte_driver can't be used as its name represents
 299  * the whole pci device with all services. Think of this as a holder for a name
 300  * for the crypto part of the pci device.
 301  */
 302 static const char qat_sym_drv_name[] = RTE_STR(CRYPTODEV_NAME_QAT_SYM_PMD);
 303 static const struct rte_driver cryptodev_qat_sym_driver = {
 304         .name = qat_sym_drv_name,
 305         .alias = qat_sym_drv_name
 306 };
 307
 308 int
 309 qat_sym_dev_create(struct qat_pci_device *qat_pci_dev,
 310                 struct qat_dev_cmd_param *qat_dev_cmd_param __rte_unused)
 311 {
 312         int i = 0;
 313         struct qat_device_info *qat_dev_instance =
 314                         &qat_pci_devs[qat_pci_dev->qat_dev_id];
 315
 316         struct rte_cryptodev_pmd_init_params init_params = {
 317                         .name = "",
 318                         .socket_id =
 319                                 qat_dev_instance->pci_dev->device.numa_node,
 320                         .private_data_size = sizeof(struct qat_sym_dev_private)
 321         };
 322         char name[RTE_CRYPTODEV_NAME_MAX_LEN];
 323         char capa_memz_name[RTE_CRYPTODEV_NAME_MAX_LEN];
 324         struct rte_cryptodev *cryptodev;
 325         struct qat_sym_dev_private *internals;
 326         const struct rte_cryptodev_capabilities *capabilities;
 327         uint64_t capa_size;
 328
 329         /*
 330          * All processes must use same driver id so they can share sessions.
 331          * Store driver_id so we can validate that all processes have the same
 332          * value, typically they have, but could differ if binaries built
 333          * separately.
 334          */
 335         if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
 336                 qat_pci_dev->qat_sym_driver_id =
 337                                 qat_sym_driver_id;
 338         } else if (rte_eal_process_type() == RTE_PROC_SECONDARY) {
 339                 if (qat_pci_dev->qat_sym_driver_id !=
 340                                 qat_sym_driver_id) {
 341                         QAT_LOG(ERR,
 342                                 "Device %s have different driver id than corresponding device in primary process",
 343                                 name);
 344                         return -(EFAULT);
 345                 }
 346         }
 347
 348 #ifdef RTE_LIBRTE_SECURITY
 349         struct rte_security_ctx *security_instance;
 350 #endif
 351
 352         snprintf(name, RTE_CRYPTODEV_NAME_MAX_LEN, "%s_%s",
 353                         qat_pci_dev->name, "sym");
 354         QAT_LOG(DEBUG, "Creating QAT SYM device %s", name);
 355
 356         /* Populate subset device to use in cryptodev device creation */
 357         qat_dev_instance->sym_rte_dev.driver = &cryptodev_qat_sym_driver;
 358         qat_dev_instance->sym_rte_dev.numa_node =
 359                         qat_dev_instance->pci_dev->device.numa_node;
 360         qat_dev_instance->sym_rte_dev.devargs = NULL;
 361
 362         cryptodev = rte_cryptodev_pmd_create(name,
 363                         &(qat_dev_instance->sym_rte_dev), &init_params);
 364
 365         if (cryptodev == NULL)
 366                 return -ENODEV;
 367
 368         qat_dev_instance->sym_rte_dev.name = cryptodev->data->name;
 369         cryptodev->driver_id = qat_sym_driver_id;
 370         cryptodev->dev_ops = &crypto_qat_ops;
 371
 372         cryptodev->enqueue_burst = qat_sym_pmd_enqueue_op_burst;
 373         cryptodev->dequeue_burst = qat_sym_pmd_dequeue_op_burst;
 374
 375         cryptodev->feature_flags = RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO |
 376                         RTE_CRYPTODEV_FF_HW_ACCELERATED |
 377                         RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING |
 378                         RTE_CRYPTODEV_FF_IN_PLACE_SGL |
 379                         RTE_CRYPTODEV_FF_OOP_SGL_IN_SGL_OUT |
 380                         RTE_CRYPTODEV_FF_OOP_SGL_IN_LB_OUT |
 381                         RTE_CRYPTODEV_FF_OOP_LB_IN_SGL_OUT |
 382                         RTE_CRYPTODEV_FF_OOP_LB_IN_LB_OUT |
 383                         RTE_CRYPTODEV_FF_DIGEST_ENCRYPTED |
 384                         RTE_CRYPTODEV_FF_SECURITY;
 385
 386         if (rte_eal_process_type() != RTE_PROC_PRIMARY)
 387                 return 0;
 388
 389         snprintf(capa_memz_name, RTE_CRYPTODEV_NAME_MAX_LEN,
 390                         "QAT_SYM_CAPA_GEN_%d",
 391                         qat_pci_dev->qat_dev_gen);
 392
 393 #ifdef RTE_LIBRTE_SECURITY
 394         security_instance = rte_malloc("qat_sec",
 395                                 sizeof(struct rte_security_ctx),
 396                                 RTE_CACHE_LINE_SIZE);
 397         if (security_instance == NULL) {
 398                 QAT_LOG(ERR, "rte_security_ctx memory alloc failed");
 399                 rte_cryptodev_pmd_destroy(cryptodev);
 400                 return -ENOMEM;
 401         }
 402
 403         security_instance->device = (void *)cryptodev;
 404         security_instance->ops = &security_qat_ops;
 405         security_instance->sess_cnt = 0;
 406         cryptodev->security_ctx = security_instance;
 407 #endif
 408
 409         internals = cryptodev->data->dev_private;
 410         internals->qat_dev = qat_pci_dev;
 411
 412         internals->sym_dev_id = cryptodev->data->dev_id;
 413         switch (qat_pci_dev->qat_dev_gen) {
 414         case QAT_GEN1:
 415                 capabilities = qat_gen1_sym_capabilities;
 416                 capa_size = sizeof(qat_gen1_sym_capabilities);
 417                 break;
 418         case QAT_GEN2:
 419                 capabilities = qat_gen2_sym_capabilities;
 420                 capa_size = sizeof(qat_gen2_sym_capabilities);
 421                 break;
 422         case QAT_GEN3:
 423                 capabilities = qat_gen3_sym_capabilities;
 424                 capa_size = sizeof(qat_gen3_sym_capabilities);
 425                 break;
 426         default:
 427                 QAT_LOG(DEBUG,
 428                         "QAT gen %d capabilities unknown",
 429                         qat_pci_dev->qat_dev_gen);
 430                 rte_cryptodev_pmd_destroy(cryptodev);
 431                 memset(&qat_dev_instance->sym_rte_dev, 0,
 432                         sizeof(qat_dev_instance->sym_rte_dev));
 433                 return -(EINVAL);
 434         }
 435
 436         internals->capa_mz = rte_memzone_lookup(capa_memz_name);
 437         if (internals->capa_mz == NULL) {
 438                 internals->capa_mz = rte_memzone_reserve(capa_memz_name,
 439                 capa_size,
 440                 rte_socket_id(), 0);
 441         }
 442         if (internals->capa_mz == NULL) {
 443                 QAT_LOG(DEBUG,
 444                         "Error allocating memzone for capabilities, destroying PMD for %s",
 445                         name);
 446                 rte_cryptodev_pmd_destroy(cryptodev);
 447                 memset(&qat_dev_instance->sym_rte_dev, 0,
 448                         sizeof(qat_dev_instance->sym_rte_dev));
 449                 return -EFAULT;
 450         }
 451
 452         memcpy(internals->capa_mz->addr, capabilities, capa_size);
 453         internals->qat_dev_capabilities = internals->capa_mz->addr;
 454
 455         while (1) {
 456                 if (qat_dev_cmd_param[i].name == NULL)
 457                         break;
 458                 if (!strcmp(qat_dev_cmd_param[i].name, SYM_ENQ_THRESHOLD_NAME))
 459                         internals->min_enq_burst_threshold =
 460                                         qat_dev_cmd_param[i].val;
 461                 i++;
 462         }
 463
 464         qat_pci_dev->sym_dev = internals;
 465         QAT_LOG(DEBUG, "Created QAT SYM device %s as cryptodev instance %d",
 466                         cryptodev->data->name, internals->sym_dev_id);
 467
 468         return 0;
 469 }
 470
 471 int
 472 qat_sym_dev_destroy(struct qat_pci_device *qat_pci_dev)
 473 {
 474         struct rte_cryptodev *cryptodev;
 475
 476         if (qat_pci_dev == NULL)
 477                 return -ENODEV;
 478         if (qat_pci_dev->sym_dev == NULL)
 479                 return 0;
 480         if (rte_eal_process_type() == RTE_PROC_PRIMARY)
 481                 rte_memzone_free(qat_pci_dev->sym_dev->capa_mz);
 482
 483         /* free crypto device */
 484         cryptodev = rte_cryptodev_pmd_get_dev(qat_pci_dev->sym_dev->sym_dev_id);
 485 #ifdef RTE_LIBRTE_SECURITY
 486         rte_free(cryptodev->security_ctx);
 487 #endif
 488         rte_cryptodev_pmd_destroy(cryptodev);
 489         qat_pci_devs[qat_pci_dev->qat_dev_id].sym_rte_dev.name = NULL;
 490         qat_pci_dev->sym_dev = NULL;
 491
 492         return 0;
 493 }
 494
 495 static struct cryptodev_driver qat_crypto_drv;
 496 RTE_PMD_REGISTER_CRYPTO_DRIVER(qat_crypto_drv,
 497                 cryptodev_qat_sym_driver,
 498                 qat_sym_driver_id);