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