lib/librte_cryptodev/rte_cryptodev.h

   1 /*-
   2  *
   3  *   Copyright(c) 2015-2017 Intel Corporation. All rights reserved.
   4  *
   5  *   Redistribution and use in source and binary forms, with or without
   6  *   modification, are permitted provided that the following conditions
   7  *   are met:
   8  *
   9  *     * Redistributions of source code must retain the above copyright
  10  *       notice, this list of conditions and the following disclaimer.
  11  *     * Redistributions in binary form must reproduce the above copyright
  12  *       notice, this list of conditions and the following disclaimer in
  13  *       the documentation and/or other materials provided with the
  14  *       distribution.
  15  *     * Neither the name of Intel Corporation nor the names of its
  16  *       contributors may be used to endorse or promote products derived
  17  *       from this software without specific prior written permission.
  18  *
  19  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 #ifndef _RTE_CRYPTODEV_H_
  33 #define _RTE_CRYPTODEV_H_
  34
  35 /**
  36  * @file rte_cryptodev.h
  37  *
  38  * RTE Cryptographic Device APIs
  39  *
  40  * Defines RTE Crypto Device APIs for the provisioning of cipher and
  41  * authentication operations.
  42  */
  43
  44 #ifdef __cplusplus
  45 extern "C" {
  46 #endif
  47
  48 #include "rte_kvargs.h"
  49 #include "rte_crypto.h"
  50 #include "rte_dev.h"
  51 #include <rte_common.h>
  52 #include <rte_vdev.h>
  53
  54 #define CRYPTODEV_NAME_NULL_PMD         crypto_null
  55 /**< Null crypto PMD device name */
  56 #define CRYPTODEV_NAME_AESNI_MB_PMD     crypto_aesni_mb
  57 /**< AES-NI Multi buffer PMD device name */
  58 #define CRYPTODEV_NAME_AESNI_GCM_PMD    crypto_aesni_gcm
  59 /**< AES-NI GCM PMD device name */
  60 #define CRYPTODEV_NAME_OPENSSL_PMD      crypto_openssl
  61 /**< Open SSL Crypto PMD device name */
  62 #define CRYPTODEV_NAME_QAT_SYM_PMD      crypto_qat
  63 /**< Intel QAT Symmetric Crypto PMD device name */
  64 #define CRYPTODEV_NAME_SNOW3G_PMD       crypto_snow3g
  65 /**< SNOW 3G PMD device name */
  66 #define CRYPTODEV_NAME_KASUMI_PMD       crypto_kasumi
  67 /**< KASUMI PMD device name */
  68 #define CRYPTODEV_NAME_ZUC_PMD          crypto_zuc
  69 /**< KASUMI PMD device name */
  70 #define CRYPTODEV_NAME_ARMV8_PMD        crypto_armv8
  71 /**< ARMv8 Crypto PMD device name */
  72 #define CRYPTODEV_NAME_SCHEDULER_PMD    crypto_scheduler
  73 /**< Scheduler Crypto PMD device name */
  74 #define CRYPTODEV_NAME_DPAA2_SEC_PMD    cryptodev_dpaa2_sec_pmd
  75 /**< NXP DPAA2 - SEC PMD device name */
  76
  77 /** Crypto device type */
  78 enum rte_cryptodev_type {
  79         RTE_CRYPTODEV_NULL_PMD = 1,     /**< Null crypto PMD */
  80         RTE_CRYPTODEV_AESNI_GCM_PMD,    /**< AES-NI GCM PMD */
  81         RTE_CRYPTODEV_AESNI_MB_PMD,     /**< AES-NI multi buffer PMD */
  82         RTE_CRYPTODEV_QAT_SYM_PMD,      /**< QAT PMD Symmetric Crypto */
  83         RTE_CRYPTODEV_SNOW3G_PMD,       /**< SNOW 3G PMD */
  84         RTE_CRYPTODEV_KASUMI_PMD,       /**< KASUMI PMD */
  85         RTE_CRYPTODEV_ZUC_PMD,          /**< ZUC PMD */
  86         RTE_CRYPTODEV_OPENSSL_PMD,    /**<  OpenSSL PMD */
  87         RTE_CRYPTODEV_ARMV8_PMD,        /**< ARMv8 crypto PMD */
  88         RTE_CRYPTODEV_SCHEDULER_PMD,    /**< Crypto Scheduler PMD */
  89         RTE_CRYPTODEV_DPAA2_SEC_PMD,    /**< NXP DPAA2 - SEC PMD */
  90 };
  91
  92 extern const char **rte_cyptodev_names;
  93
  94 /* Logging Macros */
  95
  96 #define CDEV_LOG_ERR(...) \
  97         RTE_LOG(ERR, CRYPTODEV, \
  98                 RTE_FMT("%s() line %u: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
  99                         __func__, __LINE__, RTE_FMT_TAIL(__VA_ARGS__,)))
 100
 101 #define CDEV_PMD_LOG_ERR(dev, ...) \
 102         RTE_LOG(ERR, CRYPTODEV, \
 103                 RTE_FMT("[%s] %s() line %u: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
 104                         dev, __func__, __LINE__, RTE_FMT_TAIL(__VA_ARGS__,)))
 105
 106 #ifdef RTE_LIBRTE_CRYPTODEV_DEBUG
 107 #define CDEV_LOG_DEBUG(...) \
 108         RTE_LOG(DEBUG, CRYPTODEV, \
 109                 RTE_FMT("%s() line %u: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
 110                         __func__, __LINE__, RTE_FMT_TAIL(__VA_ARGS__,)))
 111
 112 #define CDEV_PMD_TRACE(...) \
 113         RTE_LOG(DEBUG, CRYPTODEV, \
 114                 RTE_FMT("[%s] %s: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
 115                         dev, __func__, RTE_FMT_TAIL(__VA_ARGS__,)))
 116
 117 #else
 118 #define CDEV_LOG_DEBUG(...) (void)0
 119 #define CDEV_PMD_TRACE(...) (void)0
 120 #endif
 121
 122 /**
 123  * Crypto parameters range description
 124  */
 125 struct rte_crypto_param_range {
 126         uint16_t min;   /**< minimum size */
 127         uint16_t max;   /**< maximum size */
 128         uint16_t increment;
 129         /**< if a range of sizes are supported,
 130          * this parameter is used to indicate
 131          * increments in byte size that are supported
 132          * between the minimum and maximum
 133          */
 134 };
 135
 136 /**
 137  * Symmetric Crypto Capability
 138  */
 139 struct rte_cryptodev_symmetric_capability {
 140         enum rte_crypto_sym_xform_type xform_type;
 141         /**< Transform type : Authentication / Cipher */
 142         RTE_STD_C11
 143         union {
 144                 struct {
 145                         enum rte_crypto_auth_algorithm algo;
 146                         /**< authentication algorithm */
 147                         uint16_t block_size;
 148                         /**< algorithm block size */
 149                         struct rte_crypto_param_range key_size;
 150                         /**< auth key size range */
 151                         struct rte_crypto_param_range digest_size;
 152                         /**< digest size range */
 153                         struct rte_crypto_param_range aad_size;
 154                         /**< Additional authentication data size range */
 155                 } auth;
 156                 /**< Symmetric Authentication transform capabilities */
 157                 struct {
 158                         enum rte_crypto_cipher_algorithm algo;
 159                         /**< cipher algorithm */
 160                         uint16_t block_size;
 161                         /**< algorithm block size */
 162                         struct rte_crypto_param_range key_size;
 163                         /**< cipher key size range */
 164                         struct rte_crypto_param_range iv_size;
 165                         /**< Initialisation vector data size range */
 166                 } cipher;
 167                 /**< Symmetric Cipher transform capabilities */
 168         };
 169 };
 170
 171 /** Structure used to capture a capability of a crypto device */
 172 struct rte_cryptodev_capabilities {
 173         enum rte_crypto_op_type op;
 174         /**< Operation type */
 175
 176         RTE_STD_C11
 177         union {
 178                 struct rte_cryptodev_symmetric_capability sym;
 179                 /**< Symmetric operation capability parameters */
 180         };
 181 };
 182
 183 /** Structure used to describe crypto algorithms */
 184 struct rte_cryptodev_sym_capability_idx {
 185         enum rte_crypto_sym_xform_type type;
 186         union {
 187                 enum rte_crypto_cipher_algorithm cipher;
 188                 enum rte_crypto_auth_algorithm auth;
 189         } algo;
 190 };
 191
 192 /**
 193  *  Provide capabilities available for defined device and algorithm
 194  *
 195  * @param       dev_id          The identifier of the device.
 196  * @param       idx             Description of crypto algorithms.
 197  *
 198  * @return
 199  *   - Return description of the symmetric crypto capability if exist.
 200  *   - Return NULL if the capability not exist.
 201  */
 202 const struct rte_cryptodev_symmetric_capability *
 203 rte_cryptodev_sym_capability_get(uint8_t dev_id,
 204                 const struct rte_cryptodev_sym_capability_idx *idx);
 205
 206 /**
 207  * Check if key size and initial vector are supported
 208  * in crypto cipher capability
 209  *
 210  * @param       capability      Description of the symmetric crypto capability.
 211  * @param       key_size        Cipher key size.
 212  * @param       iv_size         Cipher initial vector size.
 213  *
 214  * @return
 215  *   - Return 0 if the parameters are in range of the capability.
 216  *   - Return -1 if the parameters are out of range of the capability.
 217  */
 218 int
 219 rte_cryptodev_sym_capability_check_cipher(
 220                 const struct rte_cryptodev_symmetric_capability *capability,
 221                 uint16_t key_size, uint16_t iv_size);
 222
 223 /**
 224  * Check if key size and initial vector are supported
 225  * in crypto auth capability
 226  *
 227  * @param       capability      Description of the symmetric crypto capability.
 228  * @param       key_size        Auth key size.
 229  * @param       digest_size     Auth digest size.
 230  * @param       aad_size        Auth aad size.
 231  *
 232  * @return
 233  *   - Return 0 if the parameters are in range of the capability.
 234  *   - Return -1 if the parameters are out of range of the capability.
 235  */
 236 int
 237 rte_cryptodev_sym_capability_check_auth(
 238                 const struct rte_cryptodev_symmetric_capability *capability,
 239                 uint16_t key_size, uint16_t digest_size, uint16_t aad_size);
 240
 241 /**
 242  * Provide the cipher algorithm enum, given an algorithm string
 243  *
 244  * @param       algo_enum       A pointer to the cipher algorithm
 245  *                              enum to be filled
 246  * @param       algo_string     Authentication algo string
 247  *
 248  * @return
 249  * - Return -1 if string is not valid
 250  * - Return 0 is the string is valid
 251  */
 252 int
 253 rte_cryptodev_get_cipher_algo_enum(enum rte_crypto_cipher_algorithm *algo_enum,
 254                 const char *algo_string);
 255
 256 /**
 257  * Provide the authentication algorithm enum, given an algorithm string
 258  *
 259  * @param       algo_enum       A pointer to the authentication algorithm
 260  *                              enum to be filled
 261  * @param       algo_string     Authentication algo string
 262  *
 263  * @return
 264  * - Return -1 if string is not valid
 265  * - Return 0 is the string is valid
 266  */
 267 int
 268 rte_cryptodev_get_auth_algo_enum(enum rte_crypto_auth_algorithm *algo_enum,
 269                 const char *algo_string);
 270
 271 /** Macro used at end of crypto PMD list */
 272 #define RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST() \
 273         { RTE_CRYPTO_OP_TYPE_UNDEFINED }
 274
 275
 276 /**
 277  * Crypto device supported feature flags
 278  *
 279  * Note:
 280  * New features flags should be added to the end of the list
 281  *
 282  * Keep these flags synchronised with rte_cryptodev_get_feature_name()
 283  */
 284 #define RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO       (1ULL << 0)
 285 /**< Symmetric crypto operations are supported */
 286 #define RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO      (1ULL << 1)
 287 /**< Asymmetric crypto operations are supported */
 288 #define RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING (1ULL << 2)
 289 /**< Chaining symmetric crypto operations are supported */
 290 #define RTE_CRYPTODEV_FF_CPU_SSE                (1ULL << 3)
 291 /**< Utilises CPU SIMD SSE instructions */
 292 #define RTE_CRYPTODEV_FF_CPU_AVX                (1ULL << 4)
 293 /**< Utilises CPU SIMD AVX instructions */
 294 #define RTE_CRYPTODEV_FF_CPU_AVX2               (1ULL << 5)
 295 /**< Utilises CPU SIMD AVX2 instructions */
 296 #define RTE_CRYPTODEV_FF_CPU_AESNI              (1ULL << 6)
 297 /**< Utilises CPU AES-NI instructions */
 298 #define RTE_CRYPTODEV_FF_HW_ACCELERATED         (1ULL << 7)
 299 /**< Operations are off-loaded to an external hardware accelerator */
 300 #define RTE_CRYPTODEV_FF_CPU_AVX512             (1ULL << 8)
 301 /**< Utilises CPU SIMD AVX512 instructions */
 302 #define RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER    (1ULL << 9)
 303 /**< Scatter-gather mbufs are supported */
 304 #define RTE_CRYPTODEV_FF_CPU_NEON               (1ULL << 10)
 305 /**< Utilises CPU NEON instructions */
 306 #define RTE_CRYPTODEV_FF_CPU_ARM_CE             (1ULL << 11)
 307 /**< Utilises ARM CPU Cryptographic Extensions */
 308
 309
 310 /**
 311  * Get the name of a crypto device feature flag
 312  *
 313  * @param       flag    The mask describing the flag.
 314  *
 315  * @return
 316  *   The name of this flag, or NULL if it's not a valid feature flag.
 317  */
 318
 319 extern const char *
 320 rte_cryptodev_get_feature_name(uint64_t flag);
 321
 322 /**  Crypto device information */
 323 struct rte_cryptodev_info {
 324         const char *driver_name;                /**< Driver name. */
 325         enum rte_cryptodev_type dev_type;       /**< Device type */
 326         struct rte_pci_device *pci_dev;         /**< PCI information. */
 327
 328         uint64_t feature_flags;                 /**< Feature flags */
 329
 330         const struct rte_cryptodev_capabilities *capabilities;
 331         /**< Array of devices supported capabilities */
 332
 333         unsigned max_nb_queue_pairs;
 334         /**< Maximum number of queues pairs supported by device. */
 335
 336         struct {
 337                 unsigned max_nb_sessions;
 338                 /**< Maximum number of sessions supported by device. */
 339                 unsigned int max_nb_sessions_per_qp;
 340                 /**< Maximum number of sessions per queue pair.
 341                  * Default 0 for infinite sessions
 342                  */
 343         } sym;
 344 };
 345
 346 #define RTE_CRYPTODEV_DETACHED  (0)
 347 #define RTE_CRYPTODEV_ATTACHED  (1)
 348
 349 /** Definitions of Crypto device event types */
 350 enum rte_cryptodev_event_type {
 351         RTE_CRYPTODEV_EVENT_UNKNOWN,    /**< unknown event type */
 352         RTE_CRYPTODEV_EVENT_ERROR,      /**< error interrupt event */
 353         RTE_CRYPTODEV_EVENT_MAX         /**< max value of this enum */
 354 };
 355
 356 /** Crypto device queue pair configuration structure. */
 357 struct rte_cryptodev_qp_conf {
 358         uint32_t nb_descriptors; /**< Number of descriptors per queue pair */
 359 };
 360
 361 /**
 362  * Typedef for application callback function to be registered by application
 363  * software for notification of device events
 364  *
 365  * @param       dev_id  Crypto device identifier
 366  * @param       event   Crypto device event to register for notification of.
 367  * @param       cb_arg  User specified parameter to be passed as to passed to
 368  *                      users callback function.
 369  */
 370 typedef void (*rte_cryptodev_cb_fn)(uint8_t dev_id,
 371                 enum rte_cryptodev_event_type event, void *cb_arg);
 372
 373
 374 /** Crypto Device statistics */
 375 struct rte_cryptodev_stats {
 376         uint64_t enqueued_count;
 377         /**< Count of all operations enqueued */
 378         uint64_t dequeued_count;
 379         /**< Count of all operations dequeued */
 380
 381         uint64_t enqueue_err_count;
 382         /**< Total error count on operations enqueued */
 383         uint64_t dequeue_err_count;
 384         /**< Total error count on operations dequeued */
 385 };
 386
 387 #define RTE_CRYPTODEV_NAME_MAX_LEN      (64)
 388 /**< Max length of name of crypto PMD */
 389 #define RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_QUEUE_PAIRS   8
 390 #define RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_SESSIONS      2048
 391
 392 /**
 393  * @internal
 394  * Initialisation parameters for virtual crypto devices
 395  */
 396 struct rte_crypto_vdev_init_params {
 397         unsigned max_nb_queue_pairs;
 398         unsigned max_nb_sessions;
 399         uint8_t socket_id;
 400         char name[RTE_CRYPTODEV_NAME_MAX_LEN];
 401 };
 402
 403 /**
 404  * Parse virtual device initialisation parameters input arguments
 405  * @internal
 406  *
 407  * @params      params          Initialisation parameters with defaults set.
 408  * @params      input_args      Command line arguments
 409  *
 410  * @return
 411  * 0 on successful parse
 412  * <0 on failure to parse
 413  */
 414 int
 415 rte_cryptodev_parse_vdev_init_params(
 416                 struct rte_crypto_vdev_init_params *params,
 417                 const char *input_args);
 418
 419 /**
 420  * Create a virtual crypto device
 421  *
 422  * @param       name    Cryptodev PMD name of device to be created.
 423  * @param       args    Options arguments for device.
 424  *
 425  * @return
 426  * - On successful creation of the cryptodev the device index is returned,
 427  *   which will be between 0 and rte_cryptodev_count().
 428  * - In the case of a failure, returns -1.
 429  */
 430 extern int
 431 rte_cryptodev_create_vdev(const char *name, const char *args);
 432
 433 /**
 434  * Get the device identifier for the named crypto device.
 435  *
 436  * @param       name    device name to select the device structure.
 437  *
 438  * @return
 439  *   - Returns crypto device identifier on success.
 440  *   - Return -1 on failure to find named crypto device.
 441  */
 442 extern int
 443 rte_cryptodev_get_dev_id(const char *name);
 444
 445 /**
 446  * Get the total number of crypto devices that have been successfully
 447  * initialised.
 448  *
 449  * @return
 450  *   - The total number of usable crypto devices.
 451  */
 452 extern uint8_t
 453 rte_cryptodev_count(void);
 454
 455 /**
 456  * Get number of crypto device defined type.
 457  *
 458  * @param       type    type of device.
 459  *
 460  * @return
 461  *   Returns number of crypto device.
 462  */
 463 extern uint8_t
 464 rte_cryptodev_count_devtype(enum rte_cryptodev_type type);
 465
 466 /**
 467  * Get number and identifiers of attached crypto device.
 468  *
 469  * @param       dev_name        device name.
 470  * @param       devices         output devices identifiers.
 471  * @param       nb_devices      maximal number of devices.
 472  *
 473  * @return
 474  *   Returns number of attached crypto device.
 475  */
 476 uint8_t
 477 rte_cryptodev_devices_get(const char *dev_name, uint8_t *devices,
 478                 uint8_t nb_devices);
 479 /*
 480  * Return the NUMA socket to which a device is connected
 481  *
 482  * @param dev_id
 483  *   The identifier of the device
 484  * @return
 485  *   The NUMA socket id to which the device is connected or
 486  *   a default of zero if the socket could not be determined.
 487  *   -1 if returned is the dev_id value is out of range.
 488  */
 489 extern int
 490 rte_cryptodev_socket_id(uint8_t dev_id);
 491
 492 /** Crypto device configuration structure */
 493 struct rte_cryptodev_config {
 494         int socket_id;                  /**< Socket to allocate resources on */
 495         uint16_t nb_queue_pairs;
 496         /**< Number of queue pairs to configure on device */
 497
 498         struct {
 499                 uint32_t nb_objs;       /**< Number of objects in mempool */
 500                 uint32_t cache_size;    /**< l-core object cache size */
 501         } session_mp;           /**< Session mempool configuration */
 502 };
 503
 504 /**
 505  * Configure a device.
 506  *
 507  * This function must be invoked first before any other function in the
 508  * API. This function can also be re-invoked when a device is in the
 509  * stopped state.
 510  *
 511  * @param       dev_id          The identifier of the device to configure.
 512  * @param       config          The crypto device configuration structure.
 513  *
 514  * @return
 515  *   - 0: Success, device configured.
 516  *   - <0: Error code returned by the driver configuration function.
 517  */
 518 extern int
 519 rte_cryptodev_configure(uint8_t dev_id, struct rte_cryptodev_config *config);
 520
 521 /**
 522  * Start an device.
 523  *
 524  * The device start step is the last one and consists of setting the configured
 525  * offload features and in starting the transmit and the receive units of the
 526  * device.
 527  * On success, all basic functions exported by the API (link status,
 528  * receive/transmit, and so on) can be invoked.
 529  *
 530  * @param dev_id
 531  *   The identifier of the device.
 532  * @return
 533  *   - 0: Success, device started.
 534  *   - <0: Error code of the driver device start function.
 535  */
 536 extern int
 537 rte_cryptodev_start(uint8_t dev_id);
 538
 539 /**
 540  * Stop an device. The device can be restarted with a call to
 541  * rte_cryptodev_start()
 542  *
 543  * @param       dev_id          The identifier of the device.
 544  */
 545 extern void
 546 rte_cryptodev_stop(uint8_t dev_id);
 547
 548 /**
 549  * Close an device. The device cannot be restarted!
 550  *
 551  * @param       dev_id          The identifier of the device.
 552  *
 553  * @return
 554  *  - 0 on successfully closing device
 555  *  - <0 on failure to close device
 556  */
 557 extern int
 558 rte_cryptodev_close(uint8_t dev_id);
 559
 560 /**
 561  * Allocate and set up a receive queue pair for a device.
 562  *
 563  *
 564  * @param       dev_id          The identifier of the device.
 565  * @param       queue_pair_id   The index of the queue pairs to set up. The
 566  *                              value must be in the range [0, nb_queue_pair
 567  *                              - 1] previously supplied to
 568  *                              rte_cryptodev_configure().
 569  * @param       qp_conf         The pointer to the configuration data to be
 570  *                              used for the queue pair. NULL value is
 571  *                              allowed, in which case default configuration
 572  *                              will be used.
 573  * @param       socket_id       The *socket_id* argument is the socket
 574  *                              identifier in case of NUMA. The value can be
 575  *                              *SOCKET_ID_ANY* if there is no NUMA constraint
 576  *                              for the DMA memory allocated for the receive
 577  *                              queue pair.
 578  *
 579  * @return
 580  *   - 0: Success, queue pair correctly set up.
 581  *   - <0: Queue pair configuration failed
 582  */
 583 extern int
 584 rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
 585                 const struct rte_cryptodev_qp_conf *qp_conf, int socket_id);
 586
 587 /**
 588  * Start a specified queue pair of a device. It is used
 589  * when deferred_start flag of the specified queue is true.
 590  *
 591  * @param       dev_id          The identifier of the device
 592  * @param       queue_pair_id   The index of the queue pair to start. The value
 593  *                              must be in the range [0, nb_queue_pair - 1]
 594  *                              previously supplied to
 595  *                              rte_crypto_dev_configure().
 596  * @return
 597  *   - 0: Success, the transmit queue is correctly set up.
 598  *   - -EINVAL: The dev_id or the queue_id out of range.
 599  *   - -ENOTSUP: The function not supported in PMD driver.
 600  */
 601 extern int
 602 rte_cryptodev_queue_pair_start(uint8_t dev_id, uint16_t queue_pair_id);
 603
 604 /**
 605  * Stop specified queue pair of a device
 606  *
 607  * @param       dev_id          The identifier of the device
 608  * @param       queue_pair_id   The index of the queue pair to stop. The value
 609  *                              must be in the range [0, nb_queue_pair - 1]
 610  *                              previously supplied to
 611  *                              rte_cryptodev_configure().
 612  * @return
 613  *   - 0: Success, the transmit queue is correctly set up.
 614  *   - -EINVAL: The dev_id or the queue_id out of range.
 615  *   - -ENOTSUP: The function not supported in PMD driver.
 616  */
 617 extern int
 618 rte_cryptodev_queue_pair_stop(uint8_t dev_id, uint16_t queue_pair_id);
 619
 620 /**
 621  * Get the number of queue pairs on a specific crypto device
 622  *
 623  * @param       dev_id          Crypto device identifier.
 624  * @return
 625  *   - The number of configured queue pairs.
 626  */
 627 extern uint16_t
 628 rte_cryptodev_queue_pair_count(uint8_t dev_id);
 629
 630
 631 /**
 632  * Retrieve the general I/O statistics of a device.
 633  *
 634  * @param       dev_id          The identifier of the device.
 635  * @param       stats           A pointer to a structure of type
 636  *                              *rte_cryptodev_stats* to be filled with the
 637  *                              values of device counters.
 638  * @return
 639  *   - Zero if successful.
 640  *   - Non-zero otherwise.
 641  */
 642 extern int
 643 rte_cryptodev_stats_get(uint8_t dev_id, struct rte_cryptodev_stats *stats);
 644
 645 /**
 646  * Reset the general I/O statistics of a device.
 647  *
 648  * @param       dev_id          The identifier of the device.
 649  */
 650 extern void
 651 rte_cryptodev_stats_reset(uint8_t dev_id);
 652
 653 /**
 654  * Retrieve the contextual information of a device.
 655  *
 656  * @param       dev_id          The identifier of the device.
 657  * @param       dev_info        A pointer to a structure of type
 658  *                              *rte_cryptodev_info* to be filled with the
 659  *                              contextual information of the device.
 660  */
 661 extern void
 662 rte_cryptodev_info_get(uint8_t dev_id, struct rte_cryptodev_info *dev_info);
 663
 664
 665 /**
 666  * Register a callback function for specific device id.
 667  *
 668  * @param       dev_id          Device id.
 669  * @param       event           Event interested.
 670  * @param       cb_fn           User supplied callback function to be called.
 671  * @param       cb_arg          Pointer to the parameters for the registered
 672  *                              callback.
 673  *
 674  * @return
 675  *  - On success, zero.
 676  *  - On failure, a negative value.
 677  */
 678 extern int
 679 rte_cryptodev_callback_register(uint8_t dev_id,
 680                 enum rte_cryptodev_event_type event,
 681                 rte_cryptodev_cb_fn cb_fn, void *cb_arg);
 682
 683 /**
 684  * Unregister a callback function for specific device id.
 685  *
 686  * @param       dev_id          The device identifier.
 687  * @param       event           Event interested.
 688  * @param       cb_fn           User supplied callback function to be called.
 689  * @param       cb_arg          Pointer to the parameters for the registered
 690  *                              callback.
 691  *
 692  * @return
 693  *  - On success, zero.
 694  *  - On failure, a negative value.
 695  */
 696 extern int
 697 rte_cryptodev_callback_unregister(uint8_t dev_id,
 698                 enum rte_cryptodev_event_type event,
 699                 rte_cryptodev_cb_fn cb_fn, void *cb_arg);
 700
 701
 702 typedef uint16_t (*dequeue_pkt_burst_t)(void *qp,
 703                 struct rte_crypto_op **ops,     uint16_t nb_ops);
 704 /**< Dequeue processed packets from queue pair of a device. */
 705
 706 typedef uint16_t (*enqueue_pkt_burst_t)(void *qp,
 707                 struct rte_crypto_op **ops,     uint16_t nb_ops);
 708 /**< Enqueue packets for processing on queue pair of a device. */
 709
 710
 711
 712
 713 struct rte_cryptodev_callback;
 714
 715 /** Structure to keep track of registered callbacks */
 716 TAILQ_HEAD(rte_cryptodev_cb_list, rte_cryptodev_callback);
 717
 718 /** The data structure associated with each crypto device. */
 719 struct rte_cryptodev {
 720         dequeue_pkt_burst_t dequeue_burst;
 721         /**< Pointer to PMD receive function. */
 722         enqueue_pkt_burst_t enqueue_burst;
 723         /**< Pointer to PMD transmit function. */
 724
 725         const struct rte_cryptodev_driver *driver;
 726         /**< Driver for this device */
 727         struct rte_cryptodev_data *data;
 728         /**< Pointer to device data */
 729         struct rte_cryptodev_ops *dev_ops;
 730         /**< Functions exported by PMD */
 731         uint64_t feature_flags;
 732         /**< Supported features */
 733         struct rte_device *device;
 734         /**< Backing device */
 735
 736         enum rte_cryptodev_type dev_type;
 737         /**< Crypto device type */
 738
 739         struct rte_cryptodev_cb_list link_intr_cbs;
 740         /**< User application callback for interrupts if present */
 741
 742         __extension__
 743         uint8_t attached : 1;
 744         /**< Flag indicating the device is attached */
 745 } __rte_cache_aligned;
 746
 747 /**
 748  *
 749  * The data part, with no function pointers, associated with each device.
 750  *
 751  * This structure is safe to place in shared memory to be common among
 752  * different processes in a multi-process configuration.
 753  */
 754 struct rte_cryptodev_data {
 755         uint8_t dev_id;
 756         /**< Device ID for this instance */
 757         uint8_t socket_id;
 758         /**< Socket ID where memory is allocated */
 759         char name[RTE_CRYPTODEV_NAME_MAX_LEN];
 760         /**< Unique identifier name */
 761
 762         __extension__
 763         uint8_t dev_started : 1;
 764         /**< Device state: STARTED(1)/STOPPED(0) */
 765
 766         struct rte_mempool *session_pool;
 767         /**< Session memory pool */
 768         void **queue_pairs;
 769         /**< Array of pointers to queue pairs. */
 770         uint16_t nb_queue_pairs;
 771         /**< Number of device queue pairs. */
 772
 773         void *dev_private;
 774         /**< PMD-specific private data */
 775 } __rte_cache_aligned;
 776
 777 extern struct rte_cryptodev *rte_cryptodevs;
 778 /**
 779  *
 780  * Dequeue a burst of processed crypto operations from a queue on the crypto
 781  * device. The dequeued operation are stored in *rte_crypto_op* structures
 782  * whose pointers are supplied in the *ops* array.
 783  *
 784  * The rte_cryptodev_dequeue_burst() function returns the number of ops
 785  * actually dequeued, which is the number of *rte_crypto_op* data structures
 786  * effectively supplied into the *ops* array.
 787  *
 788  * A return value equal to *nb_ops* indicates that the queue contained
 789  * at least *nb_ops* operations, and this is likely to signify that other
 790  * processed operations remain in the devices output queue. Applications
 791  * implementing a "retrieve as many processed operations as possible" policy
 792  * can check this specific case and keep invoking the
 793  * rte_cryptodev_dequeue_burst() function until a value less than
 794  * *nb_ops* is returned.
 795  *
 796  * The rte_cryptodev_dequeue_burst() function does not provide any error
 797  * notification to avoid the corresponding overhead.
 798  *
 799  * @param       dev_id          The symmetric crypto device identifier
 800  * @param       qp_id           The index of the queue pair from which to
 801  *                              retrieve processed packets. The value must be
 802  *                              in the range [0, nb_queue_pair - 1] previously
 803  *                              supplied to rte_cryptodev_configure().
 804  * @param       ops             The address of an array of pointers to
 805  *                              *rte_crypto_op* structures that must be
 806  *                              large enough to store *nb_ops* pointers in it.
 807  * @param       nb_ops          The maximum number of operations to dequeue.
 808  *
 809  * @return
 810  *   - The number of operations actually dequeued, which is the number
 811  *   of pointers to *rte_crypto_op* structures effectively supplied to the
 812  *   *ops* array.
 813  */
 814 static inline uint16_t
 815 rte_cryptodev_dequeue_burst(uint8_t dev_id, uint16_t qp_id,
 816                 struct rte_crypto_op **ops, uint16_t nb_ops)
 817 {
 818         struct rte_cryptodev *dev = &rte_cryptodevs[dev_id];
 819
 820         nb_ops = (*dev->dequeue_burst)
 821                         (dev->data->queue_pairs[qp_id], ops, nb_ops);
 822
 823         return nb_ops;
 824 }
 825
 826 /**
 827  * Enqueue a burst of operations for processing on a crypto device.
 828  *
 829  * The rte_cryptodev_enqueue_burst() function is invoked to place
 830  * crypto operations on the queue *qp_id* of the device designated by
 831  * its *dev_id*.
 832  *
 833  * The *nb_ops* parameter is the number of operations to process which are
 834  * supplied in the *ops* array of *rte_crypto_op* structures.
 835  *
 836  * The rte_cryptodev_enqueue_burst() function returns the number of
 837  * operations it actually enqueued for processing. A return value equal to
 838  * *nb_ops* means that all packets have been enqueued.
 839  *
 840  * @param       dev_id          The identifier of the device.
 841  * @param       qp_id           The index of the queue pair which packets are
 842  *                              to be enqueued for processing. The value
 843  *                              must be in the range [0, nb_queue_pairs - 1]
 844  *                              previously supplied to
 845  *                               *rte_cryptodev_configure*.
 846  * @param       ops             The address of an array of *nb_ops* pointers
 847  *                              to *rte_crypto_op* structures which contain
 848  *                              the crypto operations to be processed.
 849  * @param       nb_ops          The number of operations to process.
 850  *
 851  * @return
 852  * The number of operations actually enqueued on the crypto device. The return
 853  * value can be less than the value of the *nb_ops* parameter when the
 854  * crypto devices queue is full or if invalid parameters are specified in
 855  * a *rte_crypto_op*.
 856  */
 857 static inline uint16_t
 858 rte_cryptodev_enqueue_burst(uint8_t dev_id, uint16_t qp_id,
 859                 struct rte_crypto_op **ops, uint16_t nb_ops)
 860 {
 861         struct rte_cryptodev *dev = &rte_cryptodevs[dev_id];
 862
 863         return (*dev->enqueue_burst)(
 864                         dev->data->queue_pairs[qp_id], ops, nb_ops);
 865 }
 866
 867
 868 /** Cryptodev symmetric crypto session */
 869 struct rte_cryptodev_sym_session {
 870         RTE_STD_C11
 871         struct {
 872                 uint8_t dev_id;
 873                 /**< Device Id */
 874                 enum rte_cryptodev_type dev_type;
 875                 /** Crypto Device type session created on */
 876                 struct rte_mempool *mp;
 877                 /**< Mempool session allocated from */
 878         } __rte_aligned(8);
 879         /**< Public symmetric session details */
 880
 881         __extension__ char _private[0];
 882         /**< Private session material */
 883 };
 884
 885
 886 /**
 887  * Initialise a session for symmetric cryptographic operations.
 888  *
 889  * This function is used by the client to initialize immutable
 890  * parameters of symmetric cryptographic operation.
 891  * To perform the operation the rte_cryptodev_enqueue_burst function is
 892  * used.  Each mbuf should contain a reference to the session
 893  * pointer returned from this function contained within it's crypto_op if a
 894  * session-based operation is being provisioned. Memory to contain the session
 895  * information is allocated from within mempool managed by the cryptodev.
 896  *
 897  * The rte_cryptodev_session_free must be called to free allocated
 898  * memory when the session is no longer required.
 899  *
 900  * @param       dev_id          The device identifier.
 901  * @param       xform           Crypto transform chain.
 902
 903  *
 904  * @return
 905  *  Pointer to the created session or NULL
 906  */
 907 extern struct rte_cryptodev_sym_session *
 908 rte_cryptodev_sym_session_create(uint8_t dev_id,
 909                 struct rte_crypto_sym_xform *xform);
 910
 911 /**
 912  * Free the memory associated with a previously allocated session.
 913  *
 914  * @param       dev_id          The device identifier.
 915  * @param       session         Session pointer previously allocated by
 916  *                              *rte_cryptodev_sym_session_create*.
 917  *
 918  * @return
 919  *   NULL on successful freeing of session.
 920  *   Session pointer on failure to free session.
 921  */
 922 extern struct rte_cryptodev_sym_session *
 923 rte_cryptodev_sym_session_free(uint8_t dev_id,
 924                 struct rte_cryptodev_sym_session *session);
 925
 926 /**
 927  * Attach queue pair with sym session.
 928  *
 929  * @param       qp_id           Queue pair to which session will be attached.
 930  * @param       session         Session pointer previously allocated by
 931  *                              *rte_cryptodev_sym_session_create*.
 932  *
 933  * @return
 934  *  - On success, zero.
 935  *  - On failure, a negative value.
 936  */
 937 int
 938 rte_cryptodev_queue_pair_attach_sym_session(uint16_t qp_id,
 939                 struct rte_cryptodev_sym_session *session);
 940
 941 /**
 942  * Detach queue pair with sym session.
 943  *
 944  * @param       qp_id           Queue pair to which session is attached.
 945  * @param       session         Session pointer previously allocated by
 946  *                              *rte_cryptodev_sym_session_create*.
 947  *
 948  * @return
 949  *  - On success, zero.
 950  *  - On failure, a negative value.
 951  */
 952 int
 953 rte_cryptodev_queue_pair_detach_sym_session(uint16_t qp_id,
 954                 struct rte_cryptodev_sym_session *session);
 955
 956
 957 #ifdef __cplusplus
 958 }
 959 #endif
 960
 961 #endif /* _RTE_CRYPTODEV_H_ */