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