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 extern const char **rte_cyptodev_names;
  55
  56 /* Logging Macros */
  57
  58 #define CDEV_LOG_ERR(...) \
  59         RTE_LOG(ERR, CRYPTODEV, \
  60                 RTE_FMT("%s() line %u: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
  61                         __func__, __LINE__, RTE_FMT_TAIL(__VA_ARGS__,)))
  62
  63 #define CDEV_PMD_LOG_ERR(dev, ...) \
  64         RTE_LOG(ERR, CRYPTODEV, \
  65                 RTE_FMT("[%s] %s() line %u: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
  66                         dev, __func__, __LINE__, RTE_FMT_TAIL(__VA_ARGS__,)))
  67
  68 #ifdef RTE_LIBRTE_CRYPTODEV_DEBUG
  69 #define CDEV_LOG_DEBUG(...) \
  70         RTE_LOG(DEBUG, CRYPTODEV, \
  71                 RTE_FMT("%s() line %u: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
  72                         __func__, __LINE__, RTE_FMT_TAIL(__VA_ARGS__,)))
  73
  74 #define CDEV_PMD_TRACE(...) \
  75         RTE_LOG(DEBUG, CRYPTODEV, \
  76                 RTE_FMT("[%s] %s: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
  77                         dev, __func__, RTE_FMT_TAIL(__VA_ARGS__,)))
  78
  79 #else
  80 #define CDEV_LOG_DEBUG(...) (void)0
  81 #define CDEV_PMD_TRACE(...) (void)0
  82 #endif
  83
  84
  85
  86 /**
  87  * A macro that points to an offset from the start
  88  * of the crypto operation structure (rte_crypto_op)
  89  *
  90  * The returned pointer is cast to type t.
  91  *
  92  * @param c
  93  *   The crypto operation.
  94  * @param o
  95  *   The offset from the start of the crypto operation.
  96  * @param t
  97  *   The type to cast the result into.
  98  */
  99 #define rte_crypto_op_ctod_offset(c, t, o)      \
 100         ((t)((char *)(c) + (o)))
 101
 102 /**
 103  * A macro that returns the physical address that points
 104  * to an offset from the start of the crypto operation
 105  * (rte_crypto_op)
 106  *
 107  * @param c
 108  *   The crypto operation.
 109  * @param o
 110  *   The offset from the start of the crypto operation
 111  *   to calculate address from.
 112  */
 113 #define rte_crypto_op_ctophys_offset(c, o)      \
 114         (phys_addr_t)((c)->phys_addr + (o))
 115
 116 /**
 117  * Crypto parameters range description
 118  */
 119 struct rte_crypto_param_range {
 120         uint16_t min;   /**< minimum size */
 121         uint16_t max;   /**< maximum size */
 122         uint16_t increment;
 123         /**< if a range of sizes are supported,
 124          * this parameter is used to indicate
 125          * increments in byte size that are supported
 126          * between the minimum and maximum
 127          */
 128 };
 129
 130 /**
 131  * Symmetric Crypto Capability
 132  */
 133 struct rte_cryptodev_symmetric_capability {
 134         enum rte_crypto_sym_xform_type xform_type;
 135         /**< Transform type : Authentication / Cipher / AEAD */
 136         RTE_STD_C11
 137         union {
 138                 struct {
 139                         enum rte_crypto_auth_algorithm algo;
 140                         /**< authentication algorithm */
 141                         uint16_t block_size;
 142                         /**< algorithm block size */
 143                         struct rte_crypto_param_range key_size;
 144                         /**< auth key size range */
 145                         struct rte_crypto_param_range digest_size;
 146                         /**< digest size range */
 147                         struct rte_crypto_param_range aad_size;
 148                         /**< Additional authentication data size range */
 149                         struct rte_crypto_param_range iv_size;
 150                         /**< Initialisation vector data size range */
 151                 } auth;
 152                 /**< Symmetric Authentication transform capabilities */
 153                 struct {
 154                         enum rte_crypto_cipher_algorithm algo;
 155                         /**< cipher algorithm */
 156                         uint16_t block_size;
 157                         /**< algorithm block size */
 158                         struct rte_crypto_param_range key_size;
 159                         /**< cipher key size range */
 160                         struct rte_crypto_param_range iv_size;
 161                         /**< Initialisation vector data size range */
 162                 } cipher;
 163                 /**< Symmetric Cipher transform capabilities */
 164                 struct {
 165                         enum rte_crypto_aead_algorithm algo;
 166                         /**< AEAD algorithm */
 167                         uint16_t block_size;
 168                         /**< algorithm block size */
 169                         struct rte_crypto_param_range key_size;
 170                         /**< AEAD key size range */
 171                         struct rte_crypto_param_range digest_size;
 172                         /**< digest size range */
 173                         struct rte_crypto_param_range aad_size;
 174                         /**< Additional authentication data size range */
 175                         struct rte_crypto_param_range iv_size;
 176                         /**< Initialisation vector data size range */
 177                 } aead;
 178         };
 179 };
 180
 181 /** Structure used to capture a capability of a crypto device */
 182 struct rte_cryptodev_capabilities {
 183         enum rte_crypto_op_type op;
 184         /**< Operation type */
 185
 186         RTE_STD_C11
 187         union {
 188                 struct rte_cryptodev_symmetric_capability sym;
 189                 /**< Symmetric operation capability parameters */
 190         };
 191 };
 192
 193 /** Structure used to describe crypto algorithms */
 194 struct rte_cryptodev_sym_capability_idx {
 195         enum rte_crypto_sym_xform_type type;
 196         union {
 197                 enum rte_crypto_cipher_algorithm cipher;
 198                 enum rte_crypto_auth_algorithm auth;
 199                 enum rte_crypto_aead_algorithm aead;
 200         } algo;
 201 };
 202
 203 /**
 204  *  Provide capabilities available for defined device and algorithm
 205  *
 206  * @param       dev_id          The identifier of the device.
 207  * @param       idx             Description of crypto algorithms.
 208  *
 209  * @return
 210  *   - Return description of the symmetric crypto capability if exist.
 211  *   - Return NULL if the capability not exist.
 212  */
 213 const struct rte_cryptodev_symmetric_capability *
 214 rte_cryptodev_sym_capability_get(uint8_t dev_id,
 215                 const struct rte_cryptodev_sym_capability_idx *idx);
 216
 217 /**
 218  * Check if key size and initial vector are supported
 219  * in crypto cipher capability
 220  *
 221  * @param       capability      Description of the symmetric crypto capability.
 222  * @param       key_size        Cipher key size.
 223  * @param       iv_size         Cipher initial vector size.
 224  *
 225  * @return
 226  *   - Return 0 if the parameters are in range of the capability.
 227  *   - Return -1 if the parameters are out of range of the capability.
 228  */
 229 int
 230 rte_cryptodev_sym_capability_check_cipher(
 231                 const struct rte_cryptodev_symmetric_capability *capability,
 232                 uint16_t key_size, uint16_t iv_size);
 233
 234 /**
 235  * Check if key size and initial vector are supported
 236  * in crypto auth capability
 237  *
 238  * @param       capability      Description of the symmetric crypto capability.
 239  * @param       key_size        Auth key size.
 240  * @param       digest_size     Auth digest size.
 241  * @param       iv_size         Auth initial vector size.
 242  *
 243  * @return
 244  *   - Return 0 if the parameters are in range of the capability.
 245  *   - Return -1 if the parameters are out of range of the capability.
 246  */
 247 int
 248 rte_cryptodev_sym_capability_check_auth(
 249                 const struct rte_cryptodev_symmetric_capability *capability,
 250                 uint16_t key_size, uint16_t digest_size, uint16_t iv_size);
 251
 252 /**
 253  * Check if key, digest, AAD and initial vector sizes are supported
 254  * in crypto AEAD capability
 255  *
 256  * @param       capability      Description of the symmetric crypto capability.
 257  * @param       key_size        AEAD key size.
 258  * @param       digest_size     AEAD digest size.
 259  * @param       aad_size        AEAD AAD size.
 260  * @param       iv_size         AEAD IV size.
 261  *
 262  * @return
 263  *   - Return 0 if the parameters are in range of the capability.
 264  *   - Return -1 if the parameters are out of range of the capability.
 265  */
 266 int
 267 rte_cryptodev_sym_capability_check_aead(
 268                 const struct rte_cryptodev_symmetric_capability *capability,
 269                 uint16_t key_size, uint16_t digest_size, uint16_t aad_size,
 270                 uint16_t iv_size);
 271
 272 /**
 273  * Provide the cipher algorithm enum, given an algorithm string
 274  *
 275  * @param       algo_enum       A pointer to the cipher algorithm
 276  *                              enum to be filled
 277  * @param       algo_string     Authentication algo string
 278  *
 279  * @return
 280  * - Return -1 if string is not valid
 281  * - Return 0 is the string is valid
 282  */
 283 int
 284 rte_cryptodev_get_cipher_algo_enum(enum rte_crypto_cipher_algorithm *algo_enum,
 285                 const char *algo_string);
 286
 287 /**
 288  * Provide the authentication algorithm enum, given an algorithm string
 289  *
 290  * @param       algo_enum       A pointer to the authentication algorithm
 291  *                              enum to be filled
 292  * @param       algo_string     Authentication algo string
 293  *
 294  * @return
 295  * - Return -1 if string is not valid
 296  * - Return 0 is the string is valid
 297  */
 298 int
 299 rte_cryptodev_get_auth_algo_enum(enum rte_crypto_auth_algorithm *algo_enum,
 300                 const char *algo_string);
 301
 302 /**
 303  * Provide the AEAD algorithm enum, given an algorithm string
 304  *
 305  * @param       algo_enum       A pointer to the AEAD algorithm
 306  *                              enum to be filled
 307  * @param       algo_string     AEAD algorithm string
 308  *
 309  * @return
 310  * - Return -1 if string is not valid
 311  * - Return 0 is the string is valid
 312  */
 313 int
 314 rte_cryptodev_get_aead_algo_enum(enum rte_crypto_aead_algorithm *algo_enum,
 315                 const char *algo_string);
 316
 317 /** Macro used at end of crypto PMD list */
 318 #define RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST() \
 319         { RTE_CRYPTO_OP_TYPE_UNDEFINED }
 320
 321
 322 /**
 323  * Crypto device supported feature flags
 324  *
 325  * Note:
 326  * New features flags should be added to the end of the list
 327  *
 328  * Keep these flags synchronised with rte_cryptodev_get_feature_name()
 329  */
 330 #define RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO       (1ULL << 0)
 331 /**< Symmetric crypto operations are supported */
 332 #define RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO      (1ULL << 1)
 333 /**< Asymmetric crypto operations are supported */
 334 #define RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING (1ULL << 2)
 335 /**< Chaining symmetric crypto operations are supported */
 336 #define RTE_CRYPTODEV_FF_CPU_SSE                (1ULL << 3)
 337 /**< Utilises CPU SIMD SSE instructions */
 338 #define RTE_CRYPTODEV_FF_CPU_AVX                (1ULL << 4)
 339 /**< Utilises CPU SIMD AVX instructions */
 340 #define RTE_CRYPTODEV_FF_CPU_AVX2               (1ULL << 5)
 341 /**< Utilises CPU SIMD AVX2 instructions */
 342 #define RTE_CRYPTODEV_FF_CPU_AESNI              (1ULL << 6)
 343 /**< Utilises CPU AES-NI instructions */
 344 #define RTE_CRYPTODEV_FF_HW_ACCELERATED         (1ULL << 7)
 345 /**< Operations are off-loaded to an external hardware accelerator */
 346 #define RTE_CRYPTODEV_FF_CPU_AVX512             (1ULL << 8)
 347 /**< Utilises CPU SIMD AVX512 instructions */
 348 #define RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER    (1ULL << 9)
 349 /**< Scatter-gather mbufs are supported */
 350 #define RTE_CRYPTODEV_FF_CPU_NEON               (1ULL << 10)
 351 /**< Utilises CPU NEON instructions */
 352 #define RTE_CRYPTODEV_FF_CPU_ARM_CE             (1ULL << 11)
 353 /**< Utilises ARM CPU Cryptographic Extensions */
 354
 355
 356 /**
 357  * Get the name of a crypto device feature flag
 358  *
 359  * @param       flag    The mask describing the flag.
 360  *
 361  * @return
 362  *   The name of this flag, or NULL if it's not a valid feature flag.
 363  */
 364
 365 extern const char *
 366 rte_cryptodev_get_feature_name(uint64_t flag);
 367
 368 /**  Crypto device information */
 369 struct rte_cryptodev_info {
 370         const char *driver_name;                /**< Driver name. */
 371         uint8_t driver_id;                      /**< Driver identifier */
 372         struct rte_pci_device *pci_dev;         /**< PCI information. */
 373
 374         uint64_t feature_flags;                 /**< Feature flags */
 375
 376         const struct rte_cryptodev_capabilities *capabilities;
 377         /**< Array of devices supported capabilities */
 378
 379         unsigned max_nb_queue_pairs;
 380         /**< Maximum number of queues pairs supported by device. */
 381
 382         struct {
 383                 unsigned max_nb_sessions;
 384                 /**< Maximum number of sessions supported by device. */
 385                 unsigned int max_nb_sessions_per_qp;
 386                 /**< Maximum number of sessions per queue pair.
 387                  * Default 0 for infinite sessions
 388                  */
 389         } sym;
 390 };
 391
 392 #define RTE_CRYPTODEV_DETACHED  (0)
 393 #define RTE_CRYPTODEV_ATTACHED  (1)
 394
 395 /** Definitions of Crypto device event types */
 396 enum rte_cryptodev_event_type {
 397         RTE_CRYPTODEV_EVENT_UNKNOWN,    /**< unknown event type */
 398         RTE_CRYPTODEV_EVENT_ERROR,      /**< error interrupt event */
 399         RTE_CRYPTODEV_EVENT_MAX         /**< max value of this enum */
 400 };
 401
 402 /** Crypto device queue pair configuration structure. */
 403 struct rte_cryptodev_qp_conf {
 404         uint32_t nb_descriptors; /**< Number of descriptors per queue pair */
 405 };
 406
 407 /**
 408  * Typedef for application callback function to be registered by application
 409  * software for notification of device events
 410  *
 411  * @param       dev_id  Crypto device identifier
 412  * @param       event   Crypto device event to register for notification of.
 413  * @param       cb_arg  User specified parameter to be passed as to passed to
 414  *                      users callback function.
 415  */
 416 typedef void (*rte_cryptodev_cb_fn)(uint8_t dev_id,
 417                 enum rte_cryptodev_event_type event, void *cb_arg);
 418
 419
 420 /** Crypto Device statistics */
 421 struct rte_cryptodev_stats {
 422         uint64_t enqueued_count;
 423         /**< Count of all operations enqueued */
 424         uint64_t dequeued_count;
 425         /**< Count of all operations dequeued */
 426
 427         uint64_t enqueue_err_count;
 428         /**< Total error count on operations enqueued */
 429         uint64_t dequeue_err_count;
 430         /**< Total error count on operations dequeued */
 431 };
 432
 433 #define RTE_CRYPTODEV_NAME_MAX_LEN      (64)
 434 /**< Max length of name of crypto PMD */
 435
 436 /**
 437  * @deprecated
 438  *
 439  * Create a virtual crypto device
 440  *
 441  * @param       name    Cryptodev PMD name of device to be created.
 442  * @param       args    Options arguments for device.
 443  *
 444  * @return
 445  * - On successful creation of the cryptodev the device index is returned,
 446  *   which will be between 0 and rte_cryptodev_count().
 447  * - In the case of a failure, returns -1.
 448  */
 449 __rte_deprecated
 450 extern int
 451 rte_cryptodev_create_vdev(const char *name, const char *args);
 452
 453 /**
 454  * Get the device identifier for the named crypto device.
 455  *
 456  * @param       name    device name to select the device structure.
 457  *
 458  * @return
 459  *   - Returns crypto device identifier on success.
 460  *   - Return -1 on failure to find named crypto device.
 461  */
 462 extern int
 463 rte_cryptodev_get_dev_id(const char *name);
 464
 465 /**
 466  * Get the crypto device name given a device identifier.
 467  *
 468  * @param dev_id
 469  *   The identifier of the device
 470  *
 471  * @return
 472  *   - Returns crypto device name.
 473  *   - Returns NULL if crypto device is not present.
 474  */
 475 extern const char *
 476 rte_cryptodev_name_get(uint8_t dev_id);
 477
 478 /**
 479  * Get the total number of crypto devices that have been successfully
 480  * initialised.
 481  *
 482  * @return
 483  *   - The total number of usable crypto devices.
 484  */
 485 extern uint8_t
 486 rte_cryptodev_count(void);
 487
 488 /**
 489  * Get number of crypto device defined type.
 490  *
 491  * @param       driver_id       driver identifier.
 492  *
 493  * @return
 494  *   Returns number of crypto device.
 495  */
 496 extern uint8_t
 497 rte_cryptodev_device_count_by_driver(uint8_t driver_id);
 498
 499 /**
 500  * Get number and identifiers of attached crypto devices that
 501  * use the same crypto driver.
 502  *
 503  * @param       driver_name     driver name.
 504  * @param       devices         output devices identifiers.
 505  * @param       nb_devices      maximal number of devices.
 506  *
 507  * @return
 508  *   Returns number of attached crypto device.
 509  */
 510 uint8_t
 511 rte_cryptodev_devices_get(const char *driver_name, uint8_t *devices,
 512                 uint8_t nb_devices);
 513 /*
 514  * Return the NUMA socket to which a device is connected
 515  *
 516  * @param dev_id
 517  *   The identifier of the device
 518  * @return
 519  *   The NUMA socket id to which the device is connected or
 520  *   a default of zero if the socket could not be determined.
 521  *   -1 if returned is the dev_id value is out of range.
 522  */
 523 extern int
 524 rte_cryptodev_socket_id(uint8_t dev_id);
 525
 526 /** Crypto device configuration structure */
 527 struct rte_cryptodev_config {
 528         int socket_id;                  /**< Socket to allocate resources on */
 529         uint16_t nb_queue_pairs;
 530         /**< Number of queue pairs to configure on device */
 531 };
 532
 533 /**
 534  * Configure a device.
 535  *
 536  * This function must be invoked first before any other function in the
 537  * API. This function can also be re-invoked when a device is in the
 538  * stopped state.
 539  *
 540  * @param       dev_id          The identifier of the device to configure.
 541  * @param       config          The crypto device configuration structure.
 542  *
 543  * @return
 544  *   - 0: Success, device configured.
 545  *   - <0: Error code returned by the driver configuration function.
 546  */
 547 extern int
 548 rte_cryptodev_configure(uint8_t dev_id, struct rte_cryptodev_config *config);
 549
 550 /**
 551  * Start an device.
 552  *
 553  * The device start step is the last one and consists of setting the configured
 554  * offload features and in starting the transmit and the receive units of the
 555  * device.
 556  * On success, all basic functions exported by the API (link status,
 557  * receive/transmit, and so on) can be invoked.
 558  *
 559  * @param dev_id
 560  *   The identifier of the device.
 561  * @return
 562  *   - 0: Success, device started.
 563  *   - <0: Error code of the driver device start function.
 564  */
 565 extern int
 566 rte_cryptodev_start(uint8_t dev_id);
 567
 568 /**
 569  * Stop an device. The device can be restarted with a call to
 570  * rte_cryptodev_start()
 571  *
 572  * @param       dev_id          The identifier of the device.
 573  */
 574 extern void
 575 rte_cryptodev_stop(uint8_t dev_id);
 576
 577 /**
 578  * Close an device. The device cannot be restarted!
 579  *
 580  * @param       dev_id          The identifier of the device.
 581  *
 582  * @return
 583  *  - 0 on successfully closing device
 584  *  - <0 on failure to close device
 585  */
 586 extern int
 587 rte_cryptodev_close(uint8_t dev_id);
 588
 589 /**
 590  * Allocate and set up a receive queue pair for a device.
 591  *
 592  *
 593  * @param       dev_id          The identifier of the device.
 594  * @param       queue_pair_id   The index of the queue pairs to set up. The
 595  *                              value must be in the range [0, nb_queue_pair
 596  *                              - 1] previously supplied to
 597  *                              rte_cryptodev_configure().
 598  * @param       qp_conf         The pointer to the configuration data to be
 599  *                              used for the queue pair. NULL value is
 600  *                              allowed, in which case default configuration
 601  *                              will be used.
 602  * @param       socket_id       The *socket_id* argument is the socket
 603  *                              identifier in case of NUMA. The value can be
 604  *                              *SOCKET_ID_ANY* if there is no NUMA constraint
 605  *                              for the DMA memory allocated for the receive
 606  *                              queue pair.
 607  * @param       session_pool    Pointer to device session mempool, used
 608  *                              for session-less operations.
 609  *
 610  * @return
 611  *   - 0: Success, queue pair correctly set up.
 612  *   - <0: Queue pair configuration failed
 613  */
 614 extern int
 615 rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
 616                 const struct rte_cryptodev_qp_conf *qp_conf, int socket_id,
 617                 struct rte_mempool *session_pool);
 618
 619 /**
 620  * Start a specified queue pair of a device. It is used
 621  * when deferred_start flag of the specified queue is true.
 622  *
 623  * @param       dev_id          The identifier of the device
 624  * @param       queue_pair_id   The index of the queue pair to start. The value
 625  *                              must be in the range [0, nb_queue_pair - 1]
 626  *                              previously supplied to
 627  *                              rte_crypto_dev_configure().
 628  * @return
 629  *   - 0: Success, the transmit queue is correctly set up.
 630  *   - -EINVAL: The dev_id or the queue_id out of range.
 631  *   - -ENOTSUP: The function not supported in PMD driver.
 632  */
 633 extern int
 634 rte_cryptodev_queue_pair_start(uint8_t dev_id, uint16_t queue_pair_id);
 635
 636 /**
 637  * Stop specified queue pair of a device
 638  *
 639  * @param       dev_id          The identifier of the device
 640  * @param       queue_pair_id   The index of the queue pair to stop. The value
 641  *                              must be in the range [0, nb_queue_pair - 1]
 642  *                              previously supplied to
 643  *                              rte_cryptodev_configure().
 644  * @return
 645  *   - 0: Success, the transmit queue is correctly set up.
 646  *   - -EINVAL: The dev_id or the queue_id out of range.
 647  *   - -ENOTSUP: The function not supported in PMD driver.
 648  */
 649 extern int
 650 rte_cryptodev_queue_pair_stop(uint8_t dev_id, uint16_t queue_pair_id);
 651
 652 /**
 653  * Get the number of queue pairs on a specific crypto device
 654  *
 655  * @param       dev_id          Crypto device identifier.
 656  * @return
 657  *   - The number of configured queue pairs.
 658  */
 659 extern uint16_t
 660 rte_cryptodev_queue_pair_count(uint8_t dev_id);
 661
 662
 663 /**
 664  * Retrieve the general I/O statistics of a device.
 665  *
 666  * @param       dev_id          The identifier of the device.
 667  * @param       stats           A pointer to a structure of type
 668  *                              *rte_cryptodev_stats* to be filled with the
 669  *                              values of device counters.
 670  * @return
 671  *   - Zero if successful.
 672  *   - Non-zero otherwise.
 673  */
 674 extern int
 675 rte_cryptodev_stats_get(uint8_t dev_id, struct rte_cryptodev_stats *stats);
 676
 677 /**
 678  * Reset the general I/O statistics of a device.
 679  *
 680  * @param       dev_id          The identifier of the device.
 681  */
 682 extern void
 683 rte_cryptodev_stats_reset(uint8_t dev_id);
 684
 685 /**
 686  * Retrieve the contextual information of a device.
 687  *
 688  * @param       dev_id          The identifier of the device.
 689  * @param       dev_info        A pointer to a structure of type
 690  *                              *rte_cryptodev_info* to be filled with the
 691  *                              contextual information of the device.
 692  */
 693 extern void
 694 rte_cryptodev_info_get(uint8_t dev_id, struct rte_cryptodev_info *dev_info);
 695
 696
 697 /**
 698  * Register a callback function for specific device id.
 699  *
 700  * @param       dev_id          Device id.
 701  * @param       event           Event interested.
 702  * @param       cb_fn           User supplied callback function to be called.
 703  * @param       cb_arg          Pointer to the parameters for the registered
 704  *                              callback.
 705  *
 706  * @return
 707  *  - On success, zero.
 708  *  - On failure, a negative value.
 709  */
 710 extern int
 711 rte_cryptodev_callback_register(uint8_t dev_id,
 712                 enum rte_cryptodev_event_type event,
 713                 rte_cryptodev_cb_fn cb_fn, void *cb_arg);
 714
 715 /**
 716  * Unregister a callback function for specific device id.
 717  *
 718  * @param       dev_id          The device identifier.
 719  * @param       event           Event interested.
 720  * @param       cb_fn           User supplied callback function to be called.
 721  * @param       cb_arg          Pointer to the parameters for the registered
 722  *                              callback.
 723  *
 724  * @return
 725  *  - On success, zero.
 726  *  - On failure, a negative value.
 727  */
 728 extern int
 729 rte_cryptodev_callback_unregister(uint8_t dev_id,
 730                 enum rte_cryptodev_event_type event,
 731                 rte_cryptodev_cb_fn cb_fn, void *cb_arg);
 732
 733
 734 typedef uint16_t (*dequeue_pkt_burst_t)(void *qp,
 735                 struct rte_crypto_op **ops,     uint16_t nb_ops);
 736 /**< Dequeue processed packets from queue pair of a device. */
 737
 738 typedef uint16_t (*enqueue_pkt_burst_t)(void *qp,
 739                 struct rte_crypto_op **ops,     uint16_t nb_ops);
 740 /**< Enqueue packets for processing on queue pair of a device. */
 741
 742
 743
 744
 745 struct rte_cryptodev_callback;
 746
 747 /** Structure to keep track of registered callbacks */
 748 TAILQ_HEAD(rte_cryptodev_cb_list, rte_cryptodev_callback);
 749
 750 /** The data structure associated with each crypto device. */
 751 struct rte_cryptodev {
 752         dequeue_pkt_burst_t dequeue_burst;
 753         /**< Pointer to PMD receive function. */
 754         enqueue_pkt_burst_t enqueue_burst;
 755         /**< Pointer to PMD transmit function. */
 756
 757         struct rte_cryptodev_data *data;
 758         /**< Pointer to device data */
 759         struct rte_cryptodev_ops *dev_ops;
 760         /**< Functions exported by PMD */
 761         uint64_t feature_flags;
 762         /**< Supported features */
 763         struct rte_device *device;
 764         /**< Backing device */
 765
 766         uint8_t driver_id;
 767         /**< Crypto driver identifier*/
 768
 769         struct rte_cryptodev_cb_list link_intr_cbs;
 770         /**< User application callback for interrupts if present */
 771
 772         __extension__
 773         uint8_t attached : 1;
 774         /**< Flag indicating the device is attached */
 775 } __rte_cache_aligned;
 776
 777 /**
 778  *
 779  * The data part, with no function pointers, associated with each device.
 780  *
 781  * This structure is safe to place in shared memory to be common among
 782  * different processes in a multi-process configuration.
 783  */
 784 struct rte_cryptodev_data {
 785         uint8_t dev_id;
 786         /**< Device ID for this instance */
 787         uint8_t socket_id;
 788         /**< Socket ID where memory is allocated */
 789         char name[RTE_CRYPTODEV_NAME_MAX_LEN];
 790         /**< Unique identifier name */
 791
 792         __extension__
 793         uint8_t dev_started : 1;
 794         /**< Device state: STARTED(1)/STOPPED(0) */
 795
 796         struct rte_mempool *session_pool;
 797         /**< Session memory pool */
 798         void **queue_pairs;
 799         /**< Array of pointers to queue pairs. */
 800         uint16_t nb_queue_pairs;
 801         /**< Number of device queue pairs. */
 802
 803         void *dev_private;
 804         /**< PMD-specific private data */
 805 } __rte_cache_aligned;
 806
 807 extern struct rte_cryptodev *rte_cryptodevs;
 808 /**
 809  *
 810  * Dequeue a burst of processed crypto operations from a queue on the crypto
 811  * device. The dequeued operation are stored in *rte_crypto_op* structures
 812  * whose pointers are supplied in the *ops* array.
 813  *
 814  * The rte_cryptodev_dequeue_burst() function returns the number of ops
 815  * actually dequeued, which is the number of *rte_crypto_op* data structures
 816  * effectively supplied into the *ops* array.
 817  *
 818  * A return value equal to *nb_ops* indicates that the queue contained
 819  * at least *nb_ops* operations, and this is likely to signify that other
 820  * processed operations remain in the devices output queue. Applications
 821  * implementing a "retrieve as many processed operations as possible" policy
 822  * can check this specific case and keep invoking the
 823  * rte_cryptodev_dequeue_burst() function until a value less than
 824  * *nb_ops* is returned.
 825  *
 826  * The rte_cryptodev_dequeue_burst() function does not provide any error
 827  * notification to avoid the corresponding overhead.
 828  *
 829  * @param       dev_id          The symmetric crypto device identifier
 830  * @param       qp_id           The index of the queue pair from which to
 831  *                              retrieve processed packets. The value must be
 832  *                              in the range [0, nb_queue_pair - 1] previously
 833  *                              supplied to rte_cryptodev_configure().
 834  * @param       ops             The address of an array of pointers to
 835  *                              *rte_crypto_op* structures that must be
 836  *                              large enough to store *nb_ops* pointers in it.
 837  * @param       nb_ops          The maximum number of operations to dequeue.
 838  *
 839  * @return
 840  *   - The number of operations actually dequeued, which is the number
 841  *   of pointers to *rte_crypto_op* structures effectively supplied to the
 842  *   *ops* array.
 843  */
 844 static inline uint16_t
 845 rte_cryptodev_dequeue_burst(uint8_t dev_id, uint16_t qp_id,
 846                 struct rte_crypto_op **ops, uint16_t nb_ops)
 847 {
 848         struct rte_cryptodev *dev = &rte_cryptodevs[dev_id];
 849
 850         nb_ops = (*dev->dequeue_burst)
 851                         (dev->data->queue_pairs[qp_id], ops, nb_ops);
 852
 853         return nb_ops;
 854 }
 855
 856 /**
 857  * Enqueue a burst of operations for processing on a crypto device.
 858  *
 859  * The rte_cryptodev_enqueue_burst() function is invoked to place
 860  * crypto operations on the queue *qp_id* of the device designated by
 861  * its *dev_id*.
 862  *
 863  * The *nb_ops* parameter is the number of operations to process which are
 864  * supplied in the *ops* array of *rte_crypto_op* structures.
 865  *
 866  * The rte_cryptodev_enqueue_burst() function returns the number of
 867  * operations it actually enqueued for processing. A return value equal to
 868  * *nb_ops* means that all packets have been enqueued.
 869  *
 870  * @param       dev_id          The identifier of the device.
 871  * @param       qp_id           The index of the queue pair which packets are
 872  *                              to be enqueued for processing. The value
 873  *                              must be in the range [0, nb_queue_pairs - 1]
 874  *                              previously supplied to
 875  *                               *rte_cryptodev_configure*.
 876  * @param       ops             The address of an array of *nb_ops* pointers
 877  *                              to *rte_crypto_op* structures which contain
 878  *                              the crypto operations to be processed.
 879  * @param       nb_ops          The number of operations to process.
 880  *
 881  * @return
 882  * The number of operations actually enqueued on the crypto device. The return
 883  * value can be less than the value of the *nb_ops* parameter when the
 884  * crypto devices queue is full or if invalid parameters are specified in
 885  * a *rte_crypto_op*.
 886  */
 887 static inline uint16_t
 888 rte_cryptodev_enqueue_burst(uint8_t dev_id, uint16_t qp_id,
 889                 struct rte_crypto_op **ops, uint16_t nb_ops)
 890 {
 891         struct rte_cryptodev *dev = &rte_cryptodevs[dev_id];
 892
 893         return (*dev->enqueue_burst)(
 894                         dev->data->queue_pairs[qp_id], ops, nb_ops);
 895 }
 896
 897
 898 /** Cryptodev symmetric crypto session */
 899 struct rte_cryptodev_sym_session {
 900         __extension__ void *sess_private_data[0];
 901         /**< Private session material */
 902 };
 903
 904
 905 /**
 906  * Create symmetric crypto session header (generic with no private data)
 907  *
 908  * @param   mempool    Symmetric session mempool to allocate session
 909  *                     objects from
 910  * @return
 911  *  - On success return pointer to sym-session
 912  *  - On failure returns NULL
 913  */
 914 struct rte_cryptodev_sym_session *
 915 rte_cryptodev_sym_session_create(struct rte_mempool *mempool);
 916
 917 /**
 918  * Frees symmetric crypto session header, after checking that all
 919  * the device private data has been freed, returning it
 920  * to its original mempool.
 921  *
 922  * @param   sess     Session header to be freed.
 923  *
 924  * @return
 925  *  - 0 if successful.
 926  *  - -EINVAL if session is NULL.
 927  *  - -EBUSY if not all device private data has been freed.
 928  */
 929 int
 930 rte_cryptodev_sym_session_free(struct rte_cryptodev_sym_session *sess);
 931
 932 /**
 933  * Fill out private data for the device id, based on its device type.
 934  *
 935  * @param   dev_id   ID of device that we want the session to be used on
 936  * @param   sess     Session where the private data will be attached to
 937  * @param   xforms   Symmetric crypto transform operations to apply on flow
 938  *                   processed with this session
 939  * @param   mempool  Mempool where the private data is allocated.
 940  *
 941  * @return
 942  *  - On success, zero.
 943  *  - -EINVAL if input parameters are invalid.
 944  *  - -ENOTSUP if crypto device does not support the crypto transform.
 945  *  - -ENOMEM if the private session could not be allocated.
 946  */
 947 int
 948 rte_cryptodev_sym_session_init(uint8_t dev_id,
 949                         struct rte_cryptodev_sym_session *sess,
 950                         struct rte_crypto_sym_xform *xforms,
 951                         struct rte_mempool *mempool);
 952
 953 /**
 954  * Frees private data for the device id, based on its device type,
 955  * returning it to its mempool.
 956  *
 957  * @param   dev_id   ID of device that uses the session.
 958  * @param   sess     Session containing the reference to the private data
 959  *
 960  * @return
 961  *  - 0 if successful.
 962  *  - -EINVAL if device is invalid or session is NULL.
 963  */
 964 int
 965 rte_cryptodev_sym_session_clear(uint8_t dev_id,
 966                         struct rte_cryptodev_sym_session *sess);
 967
 968 /**
 969  * Get the size of the header session, for all registered drivers.
 970  *
 971  * @return
 972  *   Size of the header session.
 973  */
 974 unsigned int
 975 rte_cryptodev_get_header_session_size(void);
 976
 977 /**
 978  * Get the size of the private session data for a device.
 979  *
 980  * @param       dev_id          The device identifier.
 981  *
 982  * @return
 983  *   - Size of the private data, if successful
 984  *   - 0 if device is invalid or does not have private session
 985  */
 986 unsigned int
 987 rte_cryptodev_get_private_session_size(uint8_t dev_id);
 988
 989 /**
 990  * Attach queue pair with sym session.
 991  *
 992  * @param       dev_id          Device to which the session will be attached.
 993  * @param       qp_id           Queue pair to which the session will be attached.
 994  * @param       session         Session pointer previously allocated by
 995  *                              *rte_cryptodev_sym_session_create*.
 996  *
 997  * @return
 998  *  - On success, zero.
 999  *  - On failure, a negative value.
1000  */
1001 int
1002 rte_cryptodev_queue_pair_attach_sym_session(uint8_t dev_id, uint16_t qp_id,
1003                 struct rte_cryptodev_sym_session *session);
1004
1005 /**
1006  * Detach queue pair with sym session.
1007  *
1008  * @param       dev_id          Device to which the session is attached.
1009  * @param       qp_id           Queue pair to which the session is attached.
1010  * @param       session         Session pointer previously allocated by
1011  *                              *rte_cryptodev_sym_session_create*.
1012  *
1013  * @return
1014  *  - On success, zero.
1015  *  - On failure, a negative value.
1016  */
1017 int
1018 rte_cryptodev_queue_pair_detach_sym_session(uint8_t dev_id, uint16_t qp_id,
1019                 struct rte_cryptodev_sym_session *session);
1020
1021 /**
1022  * Provide driver identifier.
1023  *
1024  * @param name
1025  *   The pointer to a driver name.
1026  * @return
1027  *  The driver type identifier or -1 if no driver found
1028  */
1029 int rte_cryptodev_driver_id_get(const char *name);
1030
1031 /**
1032  * Provide driver name.
1033  *
1034  * @param driver_id
1035  *   The driver identifier.
1036  * @return
1037  *  The driver name or null if no driver found
1038  */
1039 const char *rte_cryptodev_driver_name_get(uint8_t driver_id);
1040
1041 #ifdef __cplusplus
1042 }
1043 #endif
1044
1045 #endif /* _RTE_CRYPTODEV_H_ */