lib/librte_cryptodev/rte_cryptodev.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2015-2020 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 /**
 147  * Asymmetric Xform Crypto Capability
 148  *
 149  */
 150 struct rte_cryptodev_asymmetric_xform_capability {
 151         enum rte_crypto_asym_xform_type xform_type;
 152         /**< Transform type: RSA/MODEXP/DH/DSA/MODINV */
 153
 154         uint32_t op_types;
 155         /**< bitmask for supported rte_crypto_asym_op_type */
 156
 157         __extension__
 158         union {
 159                 struct rte_crypto_param_range modlen;
 160                 /**< Range of modulus length supported by modulus based xform.
 161                  * Value 0 mean implementation default
 162                  */
 163         };
 164 };
 165
 166 /**
 167  * Asymmetric Crypto Capability
 168  *
 169  */
 170 struct rte_cryptodev_asymmetric_capability {
 171         struct rte_cryptodev_asymmetric_xform_capability xform_capa;
 172 };
 173
 174
 175 /** Structure used to capture a capability of a crypto device */
 176 struct rte_cryptodev_capabilities {
 177         enum rte_crypto_op_type op;
 178         /**< Operation type */
 179
 180         RTE_STD_C11
 181         union {
 182                 struct rte_cryptodev_symmetric_capability sym;
 183                 /**< Symmetric operation capability parameters */
 184                 struct rte_cryptodev_asymmetric_capability asym;
 185                 /**< Asymmetric operation capability parameters */
 186         };
 187 };
 188
 189 /** Structure used to describe crypto algorithms */
 190 struct rte_cryptodev_sym_capability_idx {
 191         enum rte_crypto_sym_xform_type type;
 192         union {
 193                 enum rte_crypto_cipher_algorithm cipher;
 194                 enum rte_crypto_auth_algorithm auth;
 195                 enum rte_crypto_aead_algorithm aead;
 196         } algo;
 197 };
 198
 199 /**
 200  * Structure used to describe asymmetric crypto xforms
 201  * Each xform maps to one asym algorithm.
 202  *
 203  */
 204 struct rte_cryptodev_asym_capability_idx {
 205         enum rte_crypto_asym_xform_type type;
 206         /**< Asymmetric xform (algo) type */
 207 };
 208
 209 /**
 210  * Provide capabilities available for defined device and algorithm
 211  *
 212  * @param       dev_id          The identifier of the device.
 213  * @param       idx             Description of crypto algorithms.
 214  *
 215  * @return
 216  *   - Return description of the symmetric crypto capability if exist.
 217  *   - Return NULL if the capability not exist.
 218  */
 219 const struct rte_cryptodev_symmetric_capability *
 220 rte_cryptodev_sym_capability_get(uint8_t dev_id,
 221                 const struct rte_cryptodev_sym_capability_idx *idx);
 222
 223 /**
 224  *  Provide capabilities available for defined device and xform
 225  *
 226  * @param       dev_id          The identifier of the device.
 227  * @param       idx             Description of asym crypto xform.
 228  *
 229  * @return
 230  *   - Return description of the asymmetric crypto capability if exist.
 231  *   - Return NULL if the capability not exist.
 232  */
 233 __rte_experimental
 234 const struct rte_cryptodev_asymmetric_xform_capability *
 235 rte_cryptodev_asym_capability_get(uint8_t dev_id,
 236                 const struct rte_cryptodev_asym_capability_idx *idx);
 237
 238 /**
 239  * Check if key size and initial vector are supported
 240  * in crypto cipher capability
 241  *
 242  * @param       capability      Description of the symmetric crypto capability.
 243  * @param       key_size        Cipher key size.
 244  * @param       iv_size         Cipher initial vector size.
 245  *
 246  * @return
 247  *   - Return 0 if the parameters are in range of the capability.
 248  *   - Return -1 if the parameters are out of range of the capability.
 249  */
 250 int
 251 rte_cryptodev_sym_capability_check_cipher(
 252                 const struct rte_cryptodev_symmetric_capability *capability,
 253                 uint16_t key_size, uint16_t iv_size);
 254
 255 /**
 256  * Check if key size and initial vector are supported
 257  * in crypto auth capability
 258  *
 259  * @param       capability      Description of the symmetric crypto capability.
 260  * @param       key_size        Auth key size.
 261  * @param       digest_size     Auth digest size.
 262  * @param       iv_size         Auth initial vector size.
 263  *
 264  * @return
 265  *   - Return 0 if the parameters are in range of the capability.
 266  *   - Return -1 if the parameters are out of range of the capability.
 267  */
 268 int
 269 rte_cryptodev_sym_capability_check_auth(
 270                 const struct rte_cryptodev_symmetric_capability *capability,
 271                 uint16_t key_size, uint16_t digest_size, uint16_t iv_size);
 272
 273 /**
 274  * Check if key, digest, AAD and initial vector sizes are supported
 275  * in crypto AEAD capability
 276  *
 277  * @param       capability      Description of the symmetric crypto capability.
 278  * @param       key_size        AEAD key size.
 279  * @param       digest_size     AEAD digest size.
 280  * @param       aad_size        AEAD AAD size.
 281  * @param       iv_size         AEAD IV size.
 282  *
 283  * @return
 284  *   - Return 0 if the parameters are in range of the capability.
 285  *   - Return -1 if the parameters are out of range of the capability.
 286  */
 287 int
 288 rte_cryptodev_sym_capability_check_aead(
 289                 const struct rte_cryptodev_symmetric_capability *capability,
 290                 uint16_t key_size, uint16_t digest_size, uint16_t aad_size,
 291                 uint16_t iv_size);
 292
 293 /**
 294  * Check if op type is supported
 295  *
 296  * @param       capability      Description of the asymmetric crypto capability.
 297  * @param       op_type         op type
 298  *
 299  * @return
 300  *   - Return 1 if the op type is supported
 301  *   - Return 0 if unsupported
 302  */
 303 __rte_experimental
 304 int
 305 rte_cryptodev_asym_xform_capability_check_optype(
 306         const struct rte_cryptodev_asymmetric_xform_capability *capability,
 307                 enum rte_crypto_asym_op_type op_type);
 308
 309 /**
 310  * Check if modulus length is in supported range
 311  *
 312  * @param       capability      Description of the asymmetric crypto capability.
 313  * @param       modlen          modulus length.
 314  *
 315  * @return
 316  *   - Return 0 if the parameters are in range of the capability.
 317  *   - Return -1 if the parameters are out of range of the capability.
 318  */
 319 __rte_experimental
 320 int
 321 rte_cryptodev_asym_xform_capability_check_modlen(
 322         const struct rte_cryptodev_asymmetric_xform_capability *capability,
 323                 uint16_t modlen);
 324
 325 /**
 326  * Provide the cipher algorithm enum, given an algorithm string
 327  *
 328  * @param       algo_enum       A pointer to the cipher algorithm
 329  *                              enum to be filled
 330  * @param       algo_string     Authentication algo string
 331  *
 332  * @return
 333  * - Return -1 if string is not valid
 334  * - Return 0 is the string is valid
 335  */
 336 int
 337 rte_cryptodev_get_cipher_algo_enum(enum rte_crypto_cipher_algorithm *algo_enum,
 338                 const char *algo_string);
 339
 340 /**
 341  * Provide the authentication algorithm enum, given an algorithm string
 342  *
 343  * @param       algo_enum       A pointer to the authentication algorithm
 344  *                              enum to be filled
 345  * @param       algo_string     Authentication algo string
 346  *
 347  * @return
 348  * - Return -1 if string is not valid
 349  * - Return 0 is the string is valid
 350  */
 351 int
 352 rte_cryptodev_get_auth_algo_enum(enum rte_crypto_auth_algorithm *algo_enum,
 353                 const char *algo_string);
 354
 355 /**
 356  * Provide the AEAD algorithm enum, given an algorithm string
 357  *
 358  * @param       algo_enum       A pointer to the AEAD algorithm
 359  *                              enum to be filled
 360  * @param       algo_string     AEAD algorithm string
 361  *
 362  * @return
 363  * - Return -1 if string is not valid
 364  * - Return 0 is the string is valid
 365  */
 366 int
 367 rte_cryptodev_get_aead_algo_enum(enum rte_crypto_aead_algorithm *algo_enum,
 368                 const char *algo_string);
 369
 370 /**
 371  * Provide the Asymmetric xform enum, given an xform string
 372  *
 373  * @param       xform_enum      A pointer to the xform type
 374  *                              enum to be filled
 375  * @param       xform_string    xform string
 376  *
 377  * @return
 378  * - Return -1 if string is not valid
 379  * - Return 0 if the string is valid
 380  */
 381 __rte_experimental
 382 int
 383 rte_cryptodev_asym_get_xform_enum(enum rte_crypto_asym_xform_type *xform_enum,
 384                 const char *xform_string);
 385
 386
 387 /** Macro used at end of crypto PMD list */
 388 #define RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST() \
 389         { RTE_CRYPTO_OP_TYPE_UNDEFINED }
 390
 391
 392 /**
 393  * Crypto device supported feature flags
 394  *
 395  * Note:
 396  * New features flags should be added to the end of the list
 397  *
 398  * Keep these flags synchronised with rte_cryptodev_get_feature_name()
 399  */
 400 #define RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO               (1ULL << 0)
 401 /**< Symmetric crypto operations are supported */
 402 #define RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO              (1ULL << 1)
 403 /**< Asymmetric crypto operations are supported */
 404 #define RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING         (1ULL << 2)
 405 /**< Chaining symmetric crypto operations are supported */
 406 #define RTE_CRYPTODEV_FF_CPU_SSE                        (1ULL << 3)
 407 /**< Utilises CPU SIMD SSE instructions */
 408 #define RTE_CRYPTODEV_FF_CPU_AVX                        (1ULL << 4)
 409 /**< Utilises CPU SIMD AVX instructions */
 410 #define RTE_CRYPTODEV_FF_CPU_AVX2                       (1ULL << 5)
 411 /**< Utilises CPU SIMD AVX2 instructions */
 412 #define RTE_CRYPTODEV_FF_CPU_AESNI                      (1ULL << 6)
 413 /**< Utilises CPU AES-NI instructions */
 414 #define RTE_CRYPTODEV_FF_HW_ACCELERATED                 (1ULL << 7)
 415 /**< Operations are off-loaded to an
 416  * external hardware accelerator
 417  */
 418 #define RTE_CRYPTODEV_FF_CPU_AVX512                     (1ULL << 8)
 419 /**< Utilises CPU SIMD AVX512 instructions */
 420 #define RTE_CRYPTODEV_FF_IN_PLACE_SGL                   (1ULL << 9)
 421 /**< In-place Scatter-gather (SGL) buffers, with multiple segments,
 422  * are supported
 423  */
 424 #define RTE_CRYPTODEV_FF_OOP_SGL_IN_SGL_OUT             (1ULL << 10)
 425 /**< Out-of-place Scatter-gather (SGL) buffers are
 426  * supported in input and output
 427  */
 428 #define RTE_CRYPTODEV_FF_OOP_SGL_IN_LB_OUT              (1ULL << 11)
 429 /**< Out-of-place Scatter-gather (SGL) buffers are supported
 430  * in input, combined with linear buffers (LB), with a
 431  * single segment in output
 432  */
 433 #define RTE_CRYPTODEV_FF_OOP_LB_IN_SGL_OUT              (1ULL << 12)
 434 /**< Out-of-place Scatter-gather (SGL) buffers are supported
 435  * in output, combined with linear buffers (LB) in input
 436  */
 437 #define RTE_CRYPTODEV_FF_OOP_LB_IN_LB_OUT               (1ULL << 13)
 438 /**< Out-of-place linear buffers (LB) are supported in input and output */
 439 #define RTE_CRYPTODEV_FF_CPU_NEON                       (1ULL << 14)
 440 /**< Utilises CPU NEON instructions */
 441 #define RTE_CRYPTODEV_FF_CPU_ARM_CE                     (1ULL << 15)
 442 /**< Utilises ARM CPU Cryptographic Extensions */
 443 #define RTE_CRYPTODEV_FF_SECURITY                       (1ULL << 16)
 444 /**< Support Security Protocol Processing */
 445 #define RTE_CRYPTODEV_FF_RSA_PRIV_OP_KEY_EXP            (1ULL << 17)
 446 /**< Support RSA Private Key OP with exponent */
 447 #define RTE_CRYPTODEV_FF_RSA_PRIV_OP_KEY_QT             (1ULL << 18)
 448 /**< Support RSA Private Key OP with CRT (quintuple) Keys */
 449 #define RTE_CRYPTODEV_FF_DIGEST_ENCRYPTED               (1ULL << 19)
 450 /**< Support encrypted-digest operations where digest is appended to data */
 451 #define RTE_CRYPTODEV_FF_ASYM_SESSIONLESS               (1ULL << 20)
 452 /**< Support asymmetric session-less operations */
 453 #define RTE_CRYPTODEV_FF_SYM_CPU_CRYPTO                 (1ULL << 21)
 454 /**< Support symmetric cpu-crypto processing */
 455 #define RTE_CRYPTODEV_FF_SYM_SESSIONLESS                (1ULL << 22)
 456 /**< Support symmetric session-less operations */
 457
 458
 459 /**
 460  * Get the name of a crypto device feature flag
 461  *
 462  * @param       flag    The mask describing the flag.
 463  *
 464  * @return
 465  *   The name of this flag, or NULL if it's not a valid feature flag.
 466  */
 467
 468 extern const char *
 469 rte_cryptodev_get_feature_name(uint64_t flag);
 470
 471 /**  Crypto device information */
 472 struct rte_cryptodev_info {
 473         const char *driver_name;        /**< Driver name. */
 474         uint8_t driver_id;              /**< Driver identifier */
 475         struct rte_device *device;      /**< Generic device information. */
 476
 477         uint64_t feature_flags;
 478         /**< Feature flags exposes HW/SW features for the given device */
 479
 480         const struct rte_cryptodev_capabilities *capabilities;
 481         /**< Array of devices supported capabilities */
 482
 483         unsigned max_nb_queue_pairs;
 484         /**< Maximum number of queues pairs supported by device. */
 485
 486         uint16_t min_mbuf_headroom_req;
 487         /**< Minimum mbuf headroom required by device */
 488
 489         uint16_t min_mbuf_tailroom_req;
 490         /**< Minimum mbuf tailroom required by device */
 491
 492         struct {
 493                 unsigned max_nb_sessions;
 494                 /**< Maximum number of sessions supported by device.
 495                  * If 0, the device does not have any limitation in
 496                  * number of sessions that can be used.
 497                  */
 498         } sym;
 499 };
 500
 501 #define RTE_CRYPTODEV_DETACHED  (0)
 502 #define RTE_CRYPTODEV_ATTACHED  (1)
 503
 504 /** Definitions of Crypto device event types */
 505 enum rte_cryptodev_event_type {
 506         RTE_CRYPTODEV_EVENT_UNKNOWN,    /**< unknown event type */
 507         RTE_CRYPTODEV_EVENT_ERROR,      /**< error interrupt event */
 508         RTE_CRYPTODEV_EVENT_MAX         /**< max value of this enum */
 509 };
 510
 511 /** Crypto device queue pair configuration structure. */
 512 struct rte_cryptodev_qp_conf {
 513         uint32_t nb_descriptors; /**< Number of descriptors per queue pair */
 514         struct rte_mempool *mp_session;
 515         /**< The mempool for creating session in sessionless mode */
 516         struct rte_mempool *mp_session_private;
 517         /**< The mempool for creating sess private data in sessionless mode */
 518 };
 519
 520 /**
 521  * Typedef for application callback function to be registered by application
 522  * software for notification of device events
 523  *
 524  * @param       dev_id  Crypto device identifier
 525  * @param       event   Crypto device event to register for notification of.
 526  * @param       cb_arg  User specified parameter to be passed as to passed to
 527  *                      users callback function.
 528  */
 529 typedef void (*rte_cryptodev_cb_fn)(uint8_t dev_id,
 530                 enum rte_cryptodev_event_type event, void *cb_arg);
 531
 532
 533 /** Crypto Device statistics */
 534 struct rte_cryptodev_stats {
 535         uint64_t enqueued_count;
 536         /**< Count of all operations enqueued */
 537         uint64_t dequeued_count;
 538         /**< Count of all operations dequeued */
 539
 540         uint64_t enqueue_err_count;
 541         /**< Total error count on operations enqueued */
 542         uint64_t dequeue_err_count;
 543         /**< Total error count on operations dequeued */
 544 };
 545
 546 #define RTE_CRYPTODEV_NAME_MAX_LEN      (64)
 547 /**< Max length of name of crypto PMD */
 548
 549 /**
 550  * Get the device identifier for the named crypto device.
 551  *
 552  * @param       name    device name to select the device structure.
 553  *
 554  * @return
 555  *   - Returns crypto device identifier on success.
 556  *   - Return -1 on failure to find named crypto device.
 557  */
 558 extern int
 559 rte_cryptodev_get_dev_id(const char *name);
 560
 561 /**
 562  * Get the crypto device name given a device identifier.
 563  *
 564  * @param dev_id
 565  *   The identifier of the device
 566  *
 567  * @return
 568  *   - Returns crypto device name.
 569  *   - Returns NULL if crypto device is not present.
 570  */
 571 extern const char *
 572 rte_cryptodev_name_get(uint8_t dev_id);
 573
 574 /**
 575  * Get the total number of crypto devices that have been successfully
 576  * initialised.
 577  *
 578  * @return
 579  *   - The total number of usable crypto devices.
 580  */
 581 extern uint8_t
 582 rte_cryptodev_count(void);
 583
 584 /**
 585  * Get number of crypto device defined type.
 586  *
 587  * @param       driver_id       driver identifier.
 588  *
 589  * @return
 590  *   Returns number of crypto device.
 591  */
 592 extern uint8_t
 593 rte_cryptodev_device_count_by_driver(uint8_t driver_id);
 594
 595 /**
 596  * Get number and identifiers of attached crypto devices that
 597  * use the same crypto driver.
 598  *
 599  * @param       driver_name     driver name.
 600  * @param       devices         output devices identifiers.
 601  * @param       nb_devices      maximal number of devices.
 602  *
 603  * @return
 604  *   Returns number of attached crypto device.
 605  */
 606 uint8_t
 607 rte_cryptodev_devices_get(const char *driver_name, uint8_t *devices,
 608                 uint8_t nb_devices);
 609 /*
 610  * Return the NUMA socket to which a device is connected
 611  *
 612  * @param dev_id
 613  *   The identifier of the device
 614  * @return
 615  *   The NUMA socket id to which the device is connected or
 616  *   a default of zero if the socket could not be determined.
 617  *   -1 if returned is the dev_id value is out of range.
 618  */
 619 extern int
 620 rte_cryptodev_socket_id(uint8_t dev_id);
 621
 622 /** Crypto device configuration structure */
 623 struct rte_cryptodev_config {
 624         int socket_id;                  /**< Socket to allocate resources on */
 625         uint16_t nb_queue_pairs;
 626         /**< Number of queue pairs to configure on device */
 627         uint64_t ff_disable;
 628         /**< Feature flags to be disabled. Only the following features are
 629          * allowed to be disabled,
 630          *  - RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO
 631          *  - RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO
 632          *  - RTE_CRYTPODEV_FF_SECURITY
 633          */
 634 };
 635
 636 /**
 637  * Configure a device.
 638  *
 639  * This function must be invoked first before any other function in the
 640  * API. This function can also be re-invoked when a device is in the
 641  * stopped state.
 642  *
 643  * @param       dev_id          The identifier of the device to configure.
 644  * @param       config          The crypto device configuration structure.
 645  *
 646  * @return
 647  *   - 0: Success, device configured.
 648  *   - <0: Error code returned by the driver configuration function.
 649  */
 650 extern int
 651 rte_cryptodev_configure(uint8_t dev_id, struct rte_cryptodev_config *config);
 652
 653 /**
 654  * Start an device.
 655  *
 656  * The device start step is the last one and consists of setting the configured
 657  * offload features and in starting the transmit and the receive units of the
 658  * device.
 659  * On success, all basic functions exported by the API (link status,
 660  * receive/transmit, and so on) can be invoked.
 661  *
 662  * @param dev_id
 663  *   The identifier of the device.
 664  * @return
 665  *   - 0: Success, device started.
 666  *   - <0: Error code of the driver device start function.
 667  */
 668 extern int
 669 rte_cryptodev_start(uint8_t dev_id);
 670
 671 /**
 672  * Stop an device. The device can be restarted with a call to
 673  * rte_cryptodev_start()
 674  *
 675  * @param       dev_id          The identifier of the device.
 676  */
 677 extern void
 678 rte_cryptodev_stop(uint8_t dev_id);
 679
 680 /**
 681  * Close an device. The device cannot be restarted!
 682  *
 683  * @param       dev_id          The identifier of the device.
 684  *
 685  * @return
 686  *  - 0 on successfully closing device
 687  *  - <0 on failure to close device
 688  */
 689 extern int
 690 rte_cryptodev_close(uint8_t dev_id);
 691
 692 /**
 693  * Allocate and set up a receive queue pair for a device.
 694  *
 695  *
 696  * @param       dev_id          The identifier of the device.
 697  * @param       queue_pair_id   The index of the queue pairs to set up. The
 698  *                              value must be in the range [0, nb_queue_pair
 699  *                              - 1] previously supplied to
 700  *                              rte_cryptodev_configure().
 701  * @param       qp_conf         The pointer to the configuration data to be
 702  *                              used for the queue pair.
 703  * @param       socket_id       The *socket_id* argument is the socket
 704  *                              identifier in case of NUMA. The value can be
 705  *                              *SOCKET_ID_ANY* if there is no NUMA constraint
 706  *                              for the DMA memory allocated for the receive
 707  *                              queue pair.
 708  *
 709  * @return
 710  *   - 0: Success, queue pair correctly set up.
 711  *   - <0: Queue pair configuration failed
 712  */
 713 extern int
 714 rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
 715                 const struct rte_cryptodev_qp_conf *qp_conf, int socket_id);
 716
 717 /**
 718  * Get the number of queue pairs on a specific crypto device
 719  *
 720  * @param       dev_id          Crypto device identifier.
 721  * @return
 722  *   - The number of configured queue pairs.
 723  */
 724 extern uint16_t
 725 rte_cryptodev_queue_pair_count(uint8_t dev_id);
 726
 727
 728 /**
 729  * Retrieve the general I/O statistics of a device.
 730  *
 731  * @param       dev_id          The identifier of the device.
 732  * @param       stats           A pointer to a structure of type
 733  *                              *rte_cryptodev_stats* to be filled with the
 734  *                              values of device counters.
 735  * @return
 736  *   - Zero if successful.
 737  *   - Non-zero otherwise.
 738  */
 739 extern int
 740 rte_cryptodev_stats_get(uint8_t dev_id, struct rte_cryptodev_stats *stats);
 741
 742 /**
 743  * Reset the general I/O statistics of a device.
 744  *
 745  * @param       dev_id          The identifier of the device.
 746  */
 747 extern void
 748 rte_cryptodev_stats_reset(uint8_t dev_id);
 749
 750 /**
 751  * Retrieve the contextual information of a device.
 752  *
 753  * @param       dev_id          The identifier of the device.
 754  * @param       dev_info        A pointer to a structure of type
 755  *                              *rte_cryptodev_info* to be filled with the
 756  *                              contextual information of the device.
 757  *
 758  * @note The capabilities field of dev_info is set to point to the first
 759  * element of an array of struct rte_cryptodev_capabilities. The element after
 760  * the last valid element has it's op field set to
 761  * RTE_CRYPTO_OP_TYPE_UNDEFINED.
 762  */
 763 extern void
 764 rte_cryptodev_info_get(uint8_t dev_id, struct rte_cryptodev_info *dev_info);
 765
 766
 767 /**
 768  * Register a callback function for specific device id.
 769  *
 770  * @param       dev_id          Device id.
 771  * @param       event           Event interested.
 772  * @param       cb_fn           User supplied callback function to be called.
 773  * @param       cb_arg          Pointer to the parameters for the registered
 774  *                              callback.
 775  *
 776  * @return
 777  *  - On success, zero.
 778  *  - On failure, a negative value.
 779  */
 780 extern int
 781 rte_cryptodev_callback_register(uint8_t dev_id,
 782                 enum rte_cryptodev_event_type event,
 783                 rte_cryptodev_cb_fn cb_fn, void *cb_arg);
 784
 785 /**
 786  * Unregister a callback function for specific device id.
 787  *
 788  * @param       dev_id          The device identifier.
 789  * @param       event           Event interested.
 790  * @param       cb_fn           User supplied callback function to be called.
 791  * @param       cb_arg          Pointer to the parameters for the registered
 792  *                              callback.
 793  *
 794  * @return
 795  *  - On success, zero.
 796  *  - On failure, a negative value.
 797  */
 798 extern int
 799 rte_cryptodev_callback_unregister(uint8_t dev_id,
 800                 enum rte_cryptodev_event_type event,
 801                 rte_cryptodev_cb_fn cb_fn, void *cb_arg);
 802
 803
 804 typedef uint16_t (*dequeue_pkt_burst_t)(void *qp,
 805                 struct rte_crypto_op **ops,     uint16_t nb_ops);
 806 /**< Dequeue processed packets from queue pair of a device. */
 807
 808 typedef uint16_t (*enqueue_pkt_burst_t)(void *qp,
 809                 struct rte_crypto_op **ops,     uint16_t nb_ops);
 810 /**< Enqueue packets for processing on queue pair of a device. */
 811
 812
 813
 814
 815 struct rte_cryptodev_callback;
 816
 817 /** Structure to keep track of registered callbacks */
 818 TAILQ_HEAD(rte_cryptodev_cb_list, rte_cryptodev_callback);
 819
 820 /** The data structure associated with each crypto device. */
 821 struct rte_cryptodev {
 822         dequeue_pkt_burst_t dequeue_burst;
 823         /**< Pointer to PMD receive function. */
 824         enqueue_pkt_burst_t enqueue_burst;
 825         /**< Pointer to PMD transmit function. */
 826
 827         struct rte_cryptodev_data *data;
 828         /**< Pointer to device data */
 829         struct rte_cryptodev_ops *dev_ops;
 830         /**< Functions exported by PMD */
 831         uint64_t feature_flags;
 832         /**< Feature flags exposes HW/SW features for the given device */
 833         struct rte_device *device;
 834         /**< Backing device */
 835
 836         uint8_t driver_id;
 837         /**< Crypto driver identifier*/
 838
 839         struct rte_cryptodev_cb_list link_intr_cbs;
 840         /**< User application callback for interrupts if present */
 841
 842         void *security_ctx;
 843         /**< Context for security ops */
 844
 845         __extension__
 846         uint8_t attached : 1;
 847         /**< Flag indicating the device is attached */
 848 } __rte_cache_aligned;
 849
 850 void *
 851 rte_cryptodev_get_sec_ctx(uint8_t dev_id);
 852
 853 /**
 854  *
 855  * The data part, with no function pointers, associated with each device.
 856  *
 857  * This structure is safe to place in shared memory to be common among
 858  * different processes in a multi-process configuration.
 859  */
 860 struct rte_cryptodev_data {
 861         uint8_t dev_id;
 862         /**< Device ID for this instance */
 863         uint8_t socket_id;
 864         /**< Socket ID where memory is allocated */
 865         char name[RTE_CRYPTODEV_NAME_MAX_LEN];
 866         /**< Unique identifier name */
 867
 868         __extension__
 869         uint8_t dev_started : 1;
 870         /**< Device state: STARTED(1)/STOPPED(0) */
 871
 872         struct rte_mempool *session_pool;
 873         /**< Session memory pool */
 874         void **queue_pairs;
 875         /**< Array of pointers to queue pairs. */
 876         uint16_t nb_queue_pairs;
 877         /**< Number of device queue pairs. */
 878
 879         void *dev_private;
 880         /**< PMD-specific private data */
 881 } __rte_cache_aligned;
 882
 883 extern struct rte_cryptodev *rte_cryptodevs;
 884 /**
 885  *
 886  * Dequeue a burst of processed crypto operations from a queue on the crypto
 887  * device. The dequeued operation are stored in *rte_crypto_op* structures
 888  * whose pointers are supplied in the *ops* array.
 889  *
 890  * The rte_cryptodev_dequeue_burst() function returns the number of ops
 891  * actually dequeued, which is the number of *rte_crypto_op* data structures
 892  * effectively supplied into the *ops* array.
 893  *
 894  * A return value equal to *nb_ops* indicates that the queue contained
 895  * at least *nb_ops* operations, and this is likely to signify that other
 896  * processed operations remain in the devices output queue. Applications
 897  * implementing a "retrieve as many processed operations as possible" policy
 898  * can check this specific case and keep invoking the
 899  * rte_cryptodev_dequeue_burst() function until a value less than
 900  * *nb_ops* is returned.
 901  *
 902  * The rte_cryptodev_dequeue_burst() function does not provide any error
 903  * notification to avoid the corresponding overhead.
 904  *
 905  * @param       dev_id          The symmetric crypto device identifier
 906  * @param       qp_id           The index of the queue pair from which to
 907  *                              retrieve processed packets. The value must be
 908  *                              in the range [0, nb_queue_pair - 1] previously
 909  *                              supplied to rte_cryptodev_configure().
 910  * @param       ops             The address of an array of pointers to
 911  *                              *rte_crypto_op* structures that must be
 912  *                              large enough to store *nb_ops* pointers in it.
 913  * @param       nb_ops          The maximum number of operations to dequeue.
 914  *
 915  * @return
 916  *   - The number of operations actually dequeued, which is the number
 917  *   of pointers to *rte_crypto_op* structures effectively supplied to the
 918  *   *ops* array.
 919  */
 920 static inline uint16_t
 921 rte_cryptodev_dequeue_burst(uint8_t dev_id, uint16_t qp_id,
 922                 struct rte_crypto_op **ops, uint16_t nb_ops)
 923 {
 924         struct rte_cryptodev *dev = &rte_cryptodevs[dev_id];
 925
 926         nb_ops = (*dev->dequeue_burst)
 927                         (dev->data->queue_pairs[qp_id], ops, nb_ops);
 928
 929         return nb_ops;
 930 }
 931
 932 /**
 933  * Enqueue a burst of operations for processing on a crypto device.
 934  *
 935  * The rte_cryptodev_enqueue_burst() function is invoked to place
 936  * crypto operations on the queue *qp_id* of the device designated by
 937  * its *dev_id*.
 938  *
 939  * The *nb_ops* parameter is the number of operations to process which are
 940  * supplied in the *ops* array of *rte_crypto_op* structures.
 941  *
 942  * The rte_cryptodev_enqueue_burst() function returns the number of
 943  * operations it actually enqueued for processing. A return value equal to
 944  * *nb_ops* means that all packets have been enqueued.
 945  *
 946  * @param       dev_id          The identifier of the device.
 947  * @param       qp_id           The index of the queue pair which packets are
 948  *                              to be enqueued for processing. The value
 949  *                              must be in the range [0, nb_queue_pairs - 1]
 950  *                              previously supplied to
 951  *                               *rte_cryptodev_configure*.
 952  * @param       ops             The address of an array of *nb_ops* pointers
 953  *                              to *rte_crypto_op* structures which contain
 954  *                              the crypto operations to be processed.
 955  * @param       nb_ops          The number of operations to process.
 956  *
 957  * @return
 958  * The number of operations actually enqueued on the crypto device. The return
 959  * value can be less than the value of the *nb_ops* parameter when the
 960  * crypto devices queue is full or if invalid parameters are specified in
 961  * a *rte_crypto_op*.
 962  */
 963 static inline uint16_t
 964 rte_cryptodev_enqueue_burst(uint8_t dev_id, uint16_t qp_id,
 965                 struct rte_crypto_op **ops, uint16_t nb_ops)
 966 {
 967         struct rte_cryptodev *dev = &rte_cryptodevs[dev_id];
 968
 969         return (*dev->enqueue_burst)(
 970                         dev->data->queue_pairs[qp_id], ops, nb_ops);
 971 }
 972
 973
 974 /** Cryptodev symmetric crypto session
 975  * Each session is derived from a fixed xform chain. Therefore each session
 976  * has a fixed algo, key, op-type, digest_len etc.
 977  */
 978 struct rte_cryptodev_sym_session {
 979         uint64_t opaque_data;
 980         /**< Can be used for external metadata */
 981         uint16_t nb_drivers;
 982         /**< number of elements in sess_data array */
 983         uint16_t user_data_sz;
 984         /**< session user data will be placed after sess_data */
 985         __extension__ struct {
 986                 void *data;
 987                 uint16_t refcnt;
 988         } sess_data[0];
 989         /**< Driver specific session material, variable size */
 990 };
 991
 992 /** Cryptodev asymmetric crypto session */
 993 struct rte_cryptodev_asym_session {
 994         __extension__ void *sess_private_data[0];
 995         /**< Private asymmetric session material */
 996 };
 997
 998 /**
 999  * Create a symmetric session mempool.
1000  *
1001  * @param name
1002  *   The unique mempool name.
1003  * @param nb_elts
1004  *   The number of elements in the mempool.
1005  * @param elt_size
1006  *   The size of the element. This value will be ignored if it is smaller than
1007  *   the minimum session header size required for the system. For the user who
1008  *   want to use the same mempool for sym session and session private data it
1009  *   can be the maximum value of all existing devices' private data and session
1010  *   header sizes.
1011  * @param cache_size
1012  *   The number of per-lcore cache elements
1013  * @param priv_size
1014  *   The private data size of each session.
1015  * @param socket_id
1016  *   The *socket_id* argument is the socket identifier in the case of
1017  *   NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
1018  *   constraint for the reserved zone.
1019  *
1020  * @return
1021  *  - On success return size of the session
1022  *  - On failure returns 0
1023  */
1024 __rte_experimental
1025 struct rte_mempool *
1026 rte_cryptodev_sym_session_pool_create(const char *name, uint32_t nb_elts,
1027         uint32_t elt_size, uint32_t cache_size, uint16_t priv_size,
1028         int socket_id);
1029
1030 /**
1031  * Create symmetric crypto session header (generic with no private data)
1032  *
1033  * @param   mempool    Symmetric session mempool to allocate session
1034  *                     objects from
1035  * @return
1036  *  - On success return pointer to sym-session
1037  *  - On failure returns NULL
1038  */
1039 struct rte_cryptodev_sym_session *
1040 rte_cryptodev_sym_session_create(struct rte_mempool *mempool);
1041
1042 /**
1043  * Create asymmetric crypto session header (generic with no private data)
1044  *
1045  * @param   mempool    mempool to allocate asymmetric session
1046  *                     objects from
1047  * @return
1048  *  - On success return pointer to asym-session
1049  *  - On failure returns NULL
1050  */
1051 __rte_experimental
1052 struct rte_cryptodev_asym_session *
1053 rte_cryptodev_asym_session_create(struct rte_mempool *mempool);
1054
1055 /**
1056  * Frees symmetric crypto session header, after checking that all
1057  * the device private data has been freed, returning it
1058  * to its original mempool.
1059  *
1060  * @param   sess     Session header to be freed.
1061  *
1062  * @return
1063  *  - 0 if successful.
1064  *  - -EINVAL if session is NULL.
1065  *  - -EBUSY if not all device private data has been freed.
1066  */
1067 int
1068 rte_cryptodev_sym_session_free(struct rte_cryptodev_sym_session *sess);
1069
1070 /**
1071  * Frees asymmetric crypto session header, after checking that all
1072  * the device private data has been freed, returning it
1073  * to its original mempool.
1074  *
1075  * @param   sess     Session header to be freed.
1076  *
1077  * @return
1078  *  - 0 if successful.
1079  *  - -EINVAL if session is NULL.
1080  *  - -EBUSY if not all device private data has been freed.
1081  */
1082 __rte_experimental
1083 int
1084 rte_cryptodev_asym_session_free(struct rte_cryptodev_asym_session *sess);
1085
1086 /**
1087  * Fill out private data for the device id, based on its device type.
1088  *
1089  * @param   dev_id   ID of device that we want the session to be used on
1090  * @param   sess     Session where the private data will be attached to
1091  * @param   xforms   Symmetric crypto transform operations to apply on flow
1092  *                   processed with this session
1093  * @param   mempool  Mempool where the private data is allocated.
1094  *
1095  * @return
1096  *  - On success, zero.
1097  *  - -EINVAL if input parameters are invalid.
1098  *  - -ENOTSUP if crypto device does not support the crypto transform or
1099  *    does not support symmetric operations.
1100  *  - -ENOMEM if the private session could not be allocated.
1101  */
1102 int
1103 rte_cryptodev_sym_session_init(uint8_t dev_id,
1104                         struct rte_cryptodev_sym_session *sess,
1105                         struct rte_crypto_sym_xform *xforms,
1106                         struct rte_mempool *mempool);
1107
1108 /**
1109  * Initialize asymmetric session on a device with specific asymmetric xform
1110  *
1111  * @param   dev_id   ID of device that we want the session to be used on
1112  * @param   sess     Session to be set up on a device
1113  * @param   xforms   Asymmetric crypto transform operations to apply on flow
1114  *                   processed with this session
1115  * @param   mempool  Mempool to be used for internal allocation.
1116  *
1117  * @return
1118  *  - On success, zero.
1119  *  - -EINVAL if input parameters are invalid.
1120  *  - -ENOTSUP if crypto device does not support the crypto transform.
1121  *  - -ENOMEM if the private session could not be allocated.
1122  */
1123 __rte_experimental
1124 int
1125 rte_cryptodev_asym_session_init(uint8_t dev_id,
1126                         struct rte_cryptodev_asym_session *sess,
1127                         struct rte_crypto_asym_xform *xforms,
1128                         struct rte_mempool *mempool);
1129
1130 /**
1131  * Frees private data for the device id, based on its device type,
1132  * returning it to its mempool. It is the application's responsibility
1133  * to ensure that private session data is not cleared while there are
1134  * still in-flight operations using it.
1135  *
1136  * @param   dev_id   ID of device that uses the session.
1137  * @param   sess     Session containing the reference to the private data
1138  *
1139  * @return
1140  *  - 0 if successful.
1141  *  - -EINVAL if device is invalid or session is NULL.
1142  *  - -ENOTSUP if crypto device does not support symmetric operations.
1143  */
1144 int
1145 rte_cryptodev_sym_session_clear(uint8_t dev_id,
1146                         struct rte_cryptodev_sym_session *sess);
1147
1148 /**
1149  * Frees resources held by asymmetric session during rte_cryptodev_session_init
1150  *
1151  * @param   dev_id   ID of device that uses the asymmetric session.
1152  * @param   sess     Asymmetric session setup on device using
1153  *                                       rte_cryptodev_session_init
1154  * @return
1155  *  - 0 if successful.
1156  *  - -EINVAL if device is invalid or session is NULL.
1157  */
1158 __rte_experimental
1159 int
1160 rte_cryptodev_asym_session_clear(uint8_t dev_id,
1161                         struct rte_cryptodev_asym_session *sess);
1162
1163 /**
1164  * Get the size of the header session, for all registered drivers excluding
1165  * the user data size.
1166  *
1167  * @return
1168  *   Size of the symmetric header session.
1169  */
1170 unsigned int
1171 rte_cryptodev_sym_get_header_session_size(void);
1172
1173 /**
1174  * Get the size of the header session from created session.
1175  *
1176  * @param sess
1177  *   The sym cryptodev session pointer
1178  *
1179  * @return
1180  *   - If sess is not NULL, return the size of the header session including
1181  *   the private data size defined within sess.
1182  *   - If sess is NULL, return 0.
1183  */
1184 __rte_experimental
1185 unsigned int
1186 rte_cryptodev_sym_get_existing_header_session_size(
1187                 struct rte_cryptodev_sym_session *sess);
1188
1189 /**
1190  * Get the size of the asymmetric session header, for all registered drivers.
1191  *
1192  * @return
1193  *   Size of the asymmetric header session.
1194  */
1195 __rte_experimental
1196 unsigned int
1197 rte_cryptodev_asym_get_header_session_size(void);
1198
1199 /**
1200  * Get the size of the private symmetric session data
1201  * for a device.
1202  *
1203  * @param       dev_id          The device identifier.
1204  *
1205  * @return
1206  *   - Size of the private data, if successful
1207  *   - 0 if device is invalid or does not have private
1208  *   symmetric session
1209  */
1210 unsigned int
1211 rte_cryptodev_sym_get_private_session_size(uint8_t dev_id);
1212
1213 /**
1214  * Get the size of the private data for asymmetric session
1215  * on device
1216  *
1217  * @param       dev_id          The device identifier.
1218  *
1219  * @return
1220  *   - Size of the asymmetric private data, if successful
1221  *   - 0 if device is invalid or does not have private session
1222  */
1223 __rte_experimental
1224 unsigned int
1225 rte_cryptodev_asym_get_private_session_size(uint8_t dev_id);
1226
1227 /**
1228  * Provide driver identifier.
1229  *
1230  * @param name
1231  *   The pointer to a driver name.
1232  * @return
1233  *  The driver type identifier or -1 if no driver found
1234  */
1235 int rte_cryptodev_driver_id_get(const char *name);
1236
1237 /**
1238  * Provide driver name.
1239  *
1240  * @param driver_id
1241  *   The driver identifier.
1242  * @return
1243  *  The driver name or null if no driver found
1244  */
1245 const char *rte_cryptodev_driver_name_get(uint8_t driver_id);
1246
1247 /**
1248  * Store user data in a session.
1249  *
1250  * @param       sess            Session pointer allocated by
1251  *                              *rte_cryptodev_sym_session_create*.
1252  * @param       data            Pointer to the user data.
1253  * @param       size            Size of the user data.
1254  *
1255  * @return
1256  *  - On success, zero.
1257  *  - On failure, a negative value.
1258  */
1259 __rte_experimental
1260 int
1261 rte_cryptodev_sym_session_set_user_data(
1262                                         struct rte_cryptodev_sym_session *sess,
1263                                         void *data,
1264                                         uint16_t size);
1265
1266 /**
1267  * Get user data stored in a session.
1268  *
1269  * @param       sess            Session pointer allocated by
1270  *                              *rte_cryptodev_sym_session_create*.
1271  *
1272  * @return
1273  *  - On success return pointer to user data.
1274  *  - On failure returns NULL.
1275  */
1276 __rte_experimental
1277 void *
1278 rte_cryptodev_sym_session_get_user_data(
1279                                         struct rte_cryptodev_sym_session *sess);
1280
1281 /**
1282  * Perform actual crypto processing (encrypt/digest or auth/decrypt)
1283  * on user provided data.
1284  *
1285  * @param       dev_id  The device identifier.
1286  * @param       sess    Cryptodev session structure
1287  * @param       ofs     Start and stop offsets for auth and cipher operations
1288  * @param       vec     Vectorized operation descriptor
1289  *
1290  * @return
1291  *  - Returns number of successfully processed packets.
1292  */
1293 __rte_experimental
1294 uint32_t
1295 rte_cryptodev_sym_cpu_crypto_process(uint8_t dev_id,
1296         struct rte_cryptodev_sym_session *sess, union rte_crypto_sym_ofs ofs,
1297         struct rte_crypto_sym_vec *vec);
1298
1299 #ifdef __cplusplus
1300 }
1301 #endif
1302
1303 #endif /* _RTE_CRYPTODEV_H_ */