lib/librte_cryptodev/rte_cryptodev.h

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