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 /**
 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
 450
 451 /**
 452  * Get the name of a crypto device feature flag
 453  *
 454  * @param       flag    The mask describing the flag.
 455  *
 456  * @return
 457  *   The name of this flag, or NULL if it's not a valid feature flag.
 458  */
 459
 460 extern const char *
 461 rte_cryptodev_get_feature_name(uint64_t flag);
 462
 463 /**  Crypto device information */
 464 struct rte_cryptodev_info {
 465         const char *driver_name;        /**< Driver name. */
 466         uint8_t driver_id;              /**< Driver identifier */
 467         struct rte_device *device;      /**< Generic device information. */
 468
 469         uint64_t feature_flags;
 470         /**< Feature flags exposes HW/SW features for the given device */
 471
 472         const struct rte_cryptodev_capabilities *capabilities;
 473         /**< Array of devices supported capabilities */
 474
 475         unsigned max_nb_queue_pairs;
 476         /**< Maximum number of queues pairs supported by device. */
 477
 478         uint16_t min_mbuf_headroom_req;
 479         /**< Minimum mbuf headroom required by device */
 480
 481         uint16_t min_mbuf_tailroom_req;
 482         /**< Minimum mbuf tailroom required by device */
 483
 484         struct {
 485                 unsigned max_nb_sessions;
 486                 /**< Maximum number of sessions supported by device.
 487                  * If 0, the device does not have any limitation in
 488                  * number of sessions that can be used.
 489                  */
 490         } sym;
 491 };
 492
 493 #define RTE_CRYPTODEV_DETACHED  (0)
 494 #define RTE_CRYPTODEV_ATTACHED  (1)
 495
 496 /** Definitions of Crypto device event types */
 497 enum rte_cryptodev_event_type {
 498         RTE_CRYPTODEV_EVENT_UNKNOWN,    /**< unknown event type */
 499         RTE_CRYPTODEV_EVENT_ERROR,      /**< error interrupt event */
 500         RTE_CRYPTODEV_EVENT_MAX         /**< max value of this enum */
 501 };
 502
 503 /** Crypto device queue pair configuration structure. */
 504 struct rte_cryptodev_qp_conf {
 505         uint32_t nb_descriptors; /**< Number of descriptors per queue pair */
 506         struct rte_mempool *mp_session;
 507         /**< The mempool for creating session in sessionless mode */
 508         struct rte_mempool *mp_session_private;
 509         /**< The mempool for creating sess private data in sessionless mode */
 510 };
 511
 512 /**
 513  * Typedef for application callback function to be registered by application
 514  * software for notification of device events
 515  *
 516  * @param       dev_id  Crypto device identifier
 517  * @param       event   Crypto device event to register for notification of.
 518  * @param       cb_arg  User specified parameter to be passed as to passed to
 519  *                      users callback function.
 520  */
 521 typedef void (*rte_cryptodev_cb_fn)(uint8_t dev_id,
 522                 enum rte_cryptodev_event_type event, void *cb_arg);
 523
 524
 525 /** Crypto Device statistics */
 526 struct rte_cryptodev_stats {
 527         uint64_t enqueued_count;
 528         /**< Count of all operations enqueued */
 529         uint64_t dequeued_count;
 530         /**< Count of all operations dequeued */
 531
 532         uint64_t enqueue_err_count;
 533         /**< Total error count on operations enqueued */
 534         uint64_t dequeue_err_count;
 535         /**< Total error count on operations dequeued */
 536 };
 537
 538 #define RTE_CRYPTODEV_NAME_MAX_LEN      (64)
 539 /**< Max length of name of crypto PMD */
 540
 541 /**
 542  * Get the device identifier for the named crypto device.
 543  *
 544  * @param       name    device name to select the device structure.
 545  *
 546  * @return
 547  *   - Returns crypto device identifier on success.
 548  *   - Return -1 on failure to find named crypto device.
 549  */
 550 extern int
 551 rte_cryptodev_get_dev_id(const char *name);
 552
 553 /**
 554  * Get the crypto device name given a device identifier.
 555  *
 556  * @param dev_id
 557  *   The identifier of the device
 558  *
 559  * @return
 560  *   - Returns crypto device name.
 561  *   - Returns NULL if crypto device is not present.
 562  */
 563 extern const char *
 564 rte_cryptodev_name_get(uint8_t dev_id);
 565
 566 /**
 567  * Get the total number of crypto devices that have been successfully
 568  * initialised.
 569  *
 570  * @return
 571  *   - The total number of usable crypto devices.
 572  */
 573 extern uint8_t
 574 rte_cryptodev_count(void);
 575
 576 /**
 577  * Get number of crypto device defined type.
 578  *
 579  * @param       driver_id       driver identifier.
 580  *
 581  * @return
 582  *   Returns number of crypto device.
 583  */
 584 extern uint8_t
 585 rte_cryptodev_device_count_by_driver(uint8_t driver_id);
 586
 587 /**
 588  * Get number and identifiers of attached crypto devices that
 589  * use the same crypto driver.
 590  *
 591  * @param       driver_name     driver name.
 592  * @param       devices         output devices identifiers.
 593  * @param       nb_devices      maximal number of devices.
 594  *
 595  * @return
 596  *   Returns number of attached crypto device.
 597  */
 598 uint8_t
 599 rte_cryptodev_devices_get(const char *driver_name, uint8_t *devices,
 600                 uint8_t nb_devices);
 601 /*
 602  * Return the NUMA socket to which a device is connected
 603  *
 604  * @param dev_id
 605  *   The identifier of the device
 606  * @return
 607  *   The NUMA socket id to which the device is connected or
 608  *   a default of zero if the socket could not be determined.
 609  *   -1 if returned is the dev_id value is out of range.
 610  */
 611 extern int
 612 rte_cryptodev_socket_id(uint8_t dev_id);
 613
 614 /** Crypto device configuration structure */
 615 struct rte_cryptodev_config {
 616         int socket_id;                  /**< Socket to allocate resources on */
 617         uint16_t nb_queue_pairs;
 618         /**< Number of queue pairs to configure on device */
 619 };
 620
 621 /**
 622  * Configure a device.
 623  *
 624  * This function must be invoked first before any other function in the
 625  * API. This function can also be re-invoked when a device is in the
 626  * stopped state.
 627  *
 628  * @param       dev_id          The identifier of the device to configure.
 629  * @param       config          The crypto device configuration structure.
 630  *
 631  * @return
 632  *   - 0: Success, device configured.
 633  *   - <0: Error code returned by the driver configuration function.
 634  */
 635 extern int
 636 rte_cryptodev_configure(uint8_t dev_id, struct rte_cryptodev_config *config);
 637
 638 /**
 639  * Start an device.
 640  *
 641  * The device start step is the last one and consists of setting the configured
 642  * offload features and in starting the transmit and the receive units of the
 643  * device.
 644  * On success, all basic functions exported by the API (link status,
 645  * receive/transmit, and so on) can be invoked.
 646  *
 647  * @param dev_id
 648  *   The identifier of the device.
 649  * @return
 650  *   - 0: Success, device started.
 651  *   - <0: Error code of the driver device start function.
 652  */
 653 extern int
 654 rte_cryptodev_start(uint8_t dev_id);
 655
 656 /**
 657  * Stop an device. The device can be restarted with a call to
 658  * rte_cryptodev_start()
 659  *
 660  * @param       dev_id          The identifier of the device.
 661  */
 662 extern void
 663 rte_cryptodev_stop(uint8_t dev_id);
 664
 665 /**
 666  * Close an device. The device cannot be restarted!
 667  *
 668  * @param       dev_id          The identifier of the device.
 669  *
 670  * @return
 671  *  - 0 on successfully closing device
 672  *  - <0 on failure to close device
 673  */
 674 extern int
 675 rte_cryptodev_close(uint8_t dev_id);
 676
 677 /**
 678  * Allocate and set up a receive queue pair for a device.
 679  *
 680  *
 681  * @param       dev_id          The identifier of the device.
 682  * @param       queue_pair_id   The index of the queue pairs to set up. The
 683  *                              value must be in the range [0, nb_queue_pair
 684  *                              - 1] previously supplied to
 685  *                              rte_cryptodev_configure().
 686  * @param       qp_conf         The pointer to the configuration data to be
 687  *                              used for the queue pair.
 688  * @param       socket_id       The *socket_id* argument is the socket
 689  *                              identifier in case of NUMA. The value can be
 690  *                              *SOCKET_ID_ANY* if there is no NUMA constraint
 691  *                              for the DMA memory allocated for the receive
 692  *                              queue pair.
 693  *
 694  * @return
 695  *   - 0: Success, queue pair correctly set up.
 696  *   - <0: Queue pair configuration failed
 697  */
 698 extern int
 699 rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
 700                 const struct rte_cryptodev_qp_conf *qp_conf, int socket_id);
 701
 702 /**
 703  * Get the number of queue pairs on a specific crypto device
 704  *
 705  * @param       dev_id          Crypto device identifier.
 706  * @return
 707  *   - The number of configured queue pairs.
 708  */
 709 extern uint16_t
 710 rte_cryptodev_queue_pair_count(uint8_t dev_id);
 711
 712
 713 /**
 714  * Retrieve the general I/O statistics of a device.
 715  *
 716  * @param       dev_id          The identifier of the device.
 717  * @param       stats           A pointer to a structure of type
 718  *                              *rte_cryptodev_stats* to be filled with the
 719  *                              values of device counters.
 720  * @return
 721  *   - Zero if successful.
 722  *   - Non-zero otherwise.
 723  */
 724 extern int
 725 rte_cryptodev_stats_get(uint8_t dev_id, struct rte_cryptodev_stats *stats);
 726
 727 /**
 728  * Reset the general I/O statistics of a device.
 729  *
 730  * @param       dev_id          The identifier of the device.
 731  */
 732 extern void
 733 rte_cryptodev_stats_reset(uint8_t dev_id);
 734
 735 /**
 736  * Retrieve the contextual information of a device.
 737  *
 738  * @param       dev_id          The identifier of the device.
 739  * @param       dev_info        A pointer to a structure of type
 740  *                              *rte_cryptodev_info* to be filled with the
 741  *                              contextual information of the device.
 742  *
 743  * @note The capabilities field of dev_info is set to point to the first
 744  * element of an array of struct rte_cryptodev_capabilities. The element after
 745  * the last valid element has it's op field set to
 746  * RTE_CRYPTO_OP_TYPE_UNDEFINED.
 747  */
 748 extern void
 749 rte_cryptodev_info_get(uint8_t dev_id, struct rte_cryptodev_info *dev_info);
 750
 751
 752 /**
 753  * Register a callback function for specific device id.
 754  *
 755  * @param       dev_id          Device id.
 756  * @param       event           Event interested.
 757  * @param       cb_fn           User supplied callback function to be called.
 758  * @param       cb_arg          Pointer to the parameters for the registered
 759  *                              callback.
 760  *
 761  * @return
 762  *  - On success, zero.
 763  *  - On failure, a negative value.
 764  */
 765 extern int
 766 rte_cryptodev_callback_register(uint8_t dev_id,
 767                 enum rte_cryptodev_event_type event,
 768                 rte_cryptodev_cb_fn cb_fn, void *cb_arg);
 769
 770 /**
 771  * Unregister a callback function for specific device id.
 772  *
 773  * @param       dev_id          The device identifier.
 774  * @param       event           Event interested.
 775  * @param       cb_fn           User supplied callback function to be called.
 776  * @param       cb_arg          Pointer to the parameters for the registered
 777  *                              callback.
 778  *
 779  * @return
 780  *  - On success, zero.
 781  *  - On failure, a negative value.
 782  */
 783 extern int
 784 rte_cryptodev_callback_unregister(uint8_t dev_id,
 785                 enum rte_cryptodev_event_type event,
 786                 rte_cryptodev_cb_fn cb_fn, void *cb_arg);
 787
 788
 789 typedef uint16_t (*dequeue_pkt_burst_t)(void *qp,
 790                 struct rte_crypto_op **ops,     uint16_t nb_ops);
 791 /**< Dequeue processed packets from queue pair of a device. */
 792
 793 typedef uint16_t (*enqueue_pkt_burst_t)(void *qp,
 794                 struct rte_crypto_op **ops,     uint16_t nb_ops);
 795 /**< Enqueue packets for processing on queue pair of a device. */
 796
 797
 798
 799
 800 struct rte_cryptodev_callback;
 801
 802 /** Structure to keep track of registered callbacks */
 803 TAILQ_HEAD(rte_cryptodev_cb_list, rte_cryptodev_callback);
 804
 805 /** The data structure associated with each crypto device. */
 806 struct rte_cryptodev {
 807         dequeue_pkt_burst_t dequeue_burst;
 808         /**< Pointer to PMD receive function. */
 809         enqueue_pkt_burst_t enqueue_burst;
 810         /**< Pointer to PMD transmit function. */
 811
 812         struct rte_cryptodev_data *data;
 813         /**< Pointer to device data */
 814         struct rte_cryptodev_ops *dev_ops;
 815         /**< Functions exported by PMD */
 816         uint64_t feature_flags;
 817         /**< Feature flags exposes HW/SW features for the given device */
 818         struct rte_device *device;
 819         /**< Backing device */
 820
 821         uint8_t driver_id;
 822         /**< Crypto driver identifier*/
 823
 824         struct rte_cryptodev_cb_list link_intr_cbs;
 825         /**< User application callback for interrupts if present */
 826
 827         void *security_ctx;
 828         /**< Context for security ops */
 829
 830         __extension__
 831         uint8_t attached : 1;
 832         /**< Flag indicating the device is attached */
 833 } __rte_cache_aligned;
 834
 835 void *
 836 rte_cryptodev_get_sec_ctx(uint8_t dev_id);
 837
 838 /**
 839  *
 840  * The data part, with no function pointers, associated with each device.
 841  *
 842  * This structure is safe to place in shared memory to be common among
 843  * different processes in a multi-process configuration.
 844  */
 845 struct rte_cryptodev_data {
 846         uint8_t dev_id;
 847         /**< Device ID for this instance */
 848         uint8_t socket_id;
 849         /**< Socket ID where memory is allocated */
 850         char name[RTE_CRYPTODEV_NAME_MAX_LEN];
 851         /**< Unique identifier name */
 852
 853         __extension__
 854         uint8_t dev_started : 1;
 855         /**< Device state: STARTED(1)/STOPPED(0) */
 856
 857         struct rte_mempool *session_pool;
 858         /**< Session memory pool */
 859         void **queue_pairs;
 860         /**< Array of pointers to queue pairs. */
 861         uint16_t nb_queue_pairs;
 862         /**< Number of device queue pairs. */
 863
 864         void *dev_private;
 865         /**< PMD-specific private data */
 866 } __rte_cache_aligned;
 867
 868 extern struct rte_cryptodev *rte_cryptodevs;
 869 /**
 870  *
 871  * Dequeue a burst of processed crypto operations from a queue on the crypto
 872  * device. The dequeued operation are stored in *rte_crypto_op* structures
 873  * whose pointers are supplied in the *ops* array.
 874  *
 875  * The rte_cryptodev_dequeue_burst() function returns the number of ops
 876  * actually dequeued, which is the number of *rte_crypto_op* data structures
 877  * effectively supplied into the *ops* array.
 878  *
 879  * A return value equal to *nb_ops* indicates that the queue contained
 880  * at least *nb_ops* operations, and this is likely to signify that other
 881  * processed operations remain in the devices output queue. Applications
 882  * implementing a "retrieve as many processed operations as possible" policy
 883  * can check this specific case and keep invoking the
 884  * rte_cryptodev_dequeue_burst() function until a value less than
 885  * *nb_ops* is returned.
 886  *
 887  * The rte_cryptodev_dequeue_burst() function does not provide any error
 888  * notification to avoid the corresponding overhead.
 889  *
 890  * @param       dev_id          The symmetric crypto device identifier
 891  * @param       qp_id           The index of the queue pair from which to
 892  *                              retrieve processed packets. The value must be
 893  *                              in the range [0, nb_queue_pair - 1] previously
 894  *                              supplied to rte_cryptodev_configure().
 895  * @param       ops             The address of an array of pointers to
 896  *                              *rte_crypto_op* structures that must be
 897  *                              large enough to store *nb_ops* pointers in it.
 898  * @param       nb_ops          The maximum number of operations to dequeue.
 899  *
 900  * @return
 901  *   - The number of operations actually dequeued, which is the number
 902  *   of pointers to *rte_crypto_op* structures effectively supplied to the
 903  *   *ops* array.
 904  */
 905 static inline uint16_t
 906 rte_cryptodev_dequeue_burst(uint8_t dev_id, uint16_t qp_id,
 907                 struct rte_crypto_op **ops, uint16_t nb_ops)
 908 {
 909         struct rte_cryptodev *dev = &rte_cryptodevs[dev_id];
 910
 911         nb_ops = (*dev->dequeue_burst)
 912                         (dev->data->queue_pairs[qp_id], ops, nb_ops);
 913
 914         return nb_ops;
 915 }
 916
 917 /**
 918  * Enqueue a burst of operations for processing on a crypto device.
 919  *
 920  * The rte_cryptodev_enqueue_burst() function is invoked to place
 921  * crypto operations on the queue *qp_id* of the device designated by
 922  * its *dev_id*.
 923  *
 924  * The *nb_ops* parameter is the number of operations to process which are
 925  * supplied in the *ops* array of *rte_crypto_op* structures.
 926  *
 927  * The rte_cryptodev_enqueue_burst() function returns the number of
 928  * operations it actually enqueued for processing. A return value equal to
 929  * *nb_ops* means that all packets have been enqueued.
 930  *
 931  * @param       dev_id          The identifier of the device.
 932  * @param       qp_id           The index of the queue pair which packets are
 933  *                              to be enqueued for processing. The value
 934  *                              must be in the range [0, nb_queue_pairs - 1]
 935  *                              previously supplied to
 936  *                               *rte_cryptodev_configure*.
 937  * @param       ops             The address of an array of *nb_ops* pointers
 938  *                              to *rte_crypto_op* structures which contain
 939  *                              the crypto operations to be processed.
 940  * @param       nb_ops          The number of operations to process.
 941  *
 942  * @return
 943  * The number of operations actually enqueued on the crypto device. The return
 944  * value can be less than the value of the *nb_ops* parameter when the
 945  * crypto devices queue is full or if invalid parameters are specified in
 946  * a *rte_crypto_op*.
 947  */
 948 static inline uint16_t
 949 rte_cryptodev_enqueue_burst(uint8_t dev_id, uint16_t qp_id,
 950                 struct rte_crypto_op **ops, uint16_t nb_ops)
 951 {
 952         struct rte_cryptodev *dev = &rte_cryptodevs[dev_id];
 953
 954         return (*dev->enqueue_burst)(
 955                         dev->data->queue_pairs[qp_id], ops, nb_ops);
 956 }
 957
 958
 959 /** Cryptodev symmetric crypto session
 960  * Each session is derived from a fixed xform chain. Therefore each session
 961  * has a fixed algo, key, op-type, digest_len etc.
 962  */
 963 struct rte_cryptodev_sym_session {
 964         uint64_t opaque_data;
 965         /**< Can be used for external metadata */
 966         uint16_t nb_drivers;
 967         /**< number of elements in sess_data array */
 968         uint16_t user_data_sz;
 969         /**< session user data will be placed after sess_data */
 970         __extension__ struct {
 971                 void *data;
 972                 uint16_t refcnt;
 973         } sess_data[0];
 974         /**< Driver specific session material, variable size */
 975 };
 976
 977 /** Cryptodev asymmetric crypto session */
 978 struct rte_cryptodev_asym_session {
 979         __extension__ void *sess_private_data[0];
 980         /**< Private asymmetric session material */
 981 };
 982
 983 /**
 984  * Create a symmetric session mempool.
 985  *
 986  * @param name
 987  *   The unique mempool name.
 988  * @param nb_elts
 989  *   The number of elements in the mempool.
 990  * @param elt_size
 991  *   The size of the element. This value will be ignored if it is smaller than
 992  *   the minimum session header size required for the system. For the user who
 993  *   want to use the same mempool for sym session and session private data it
 994  *   can be the maximum value of all existing devices' private data and session
 995  *   header sizes.
 996  * @param cache_size
 997  *   The number of per-lcore cache elements
 998  * @param priv_size
 999  *   The private data size of each session.
1000  * @param socket_id
1001  *   The *socket_id* argument is the socket identifier in the case of
1002  *   NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
1003  *   constraint for the reserved zone.
1004  *
1005  * @return
1006  *  - On success return size of the session
1007  *  - On failure returns 0
1008  */
1009 __rte_experimental
1010 struct rte_mempool *
1011 rte_cryptodev_sym_session_pool_create(const char *name, uint32_t nb_elts,
1012         uint32_t elt_size, uint32_t cache_size, uint16_t priv_size,
1013         int socket_id);
1014
1015 /**
1016  * Create symmetric crypto session header (generic with no private data)
1017  *
1018  * @param   mempool    Symmetric session mempool to allocate session
1019  *                     objects from
1020  * @return
1021  *  - On success return pointer to sym-session
1022  *  - On failure returns NULL
1023  */
1024 struct rte_cryptodev_sym_session *
1025 rte_cryptodev_sym_session_create(struct rte_mempool *mempool);
1026
1027 /**
1028  * Create asymmetric crypto session header (generic with no private data)
1029  *
1030  * @param   mempool    mempool to allocate asymmetric session
1031  *                     objects from
1032  * @return
1033  *  - On success return pointer to asym-session
1034  *  - On failure returns NULL
1035  */
1036 __rte_experimental
1037 struct rte_cryptodev_asym_session *
1038 rte_cryptodev_asym_session_create(struct rte_mempool *mempool);
1039
1040 /**
1041  * Frees symmetric crypto session header, after checking that all
1042  * the device private data has been freed, returning it
1043  * to its original mempool.
1044  *
1045  * @param   sess     Session header to be freed.
1046  *
1047  * @return
1048  *  - 0 if successful.
1049  *  - -EINVAL if session is NULL.
1050  *  - -EBUSY if not all device private data has been freed.
1051  */
1052 int
1053 rte_cryptodev_sym_session_free(struct rte_cryptodev_sym_session *sess);
1054
1055 /**
1056  * Frees asymmetric 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 __rte_experimental
1068 int
1069 rte_cryptodev_asym_session_free(struct rte_cryptodev_asym_session *sess);
1070
1071 /**
1072  * Fill out private data for the device id, based on its device type.
1073  *
1074  * @param   dev_id   ID of device that we want the session to be used on
1075  * @param   sess     Session where the private data will be attached to
1076  * @param   xforms   Symmetric crypto transform operations to apply on flow
1077  *                   processed with this session
1078  * @param   mempool  Mempool where the private data is allocated.
1079  *
1080  * @return
1081  *  - On success, zero.
1082  *  - -EINVAL if input parameters are invalid.
1083  *  - -ENOTSUP if crypto device does not support the crypto transform or
1084  *    does not support symmetric operations.
1085  *  - -ENOMEM if the private session could not be allocated.
1086  */
1087 int
1088 rte_cryptodev_sym_session_init(uint8_t dev_id,
1089                         struct rte_cryptodev_sym_session *sess,
1090                         struct rte_crypto_sym_xform *xforms,
1091                         struct rte_mempool *mempool);
1092
1093 /**
1094  * Initialize asymmetric session on a device with specific asymmetric xform
1095  *
1096  * @param   dev_id   ID of device that we want the session to be used on
1097  * @param   sess     Session to be set up on a device
1098  * @param   xforms   Asymmetric crypto transform operations to apply on flow
1099  *                   processed with this session
1100  * @param   mempool  Mempool to be used for internal allocation.
1101  *
1102  * @return
1103  *  - On success, zero.
1104  *  - -EINVAL if input parameters are invalid.
1105  *  - -ENOTSUP if crypto device does not support the crypto transform.
1106  *  - -ENOMEM if the private session could not be allocated.
1107  */
1108 __rte_experimental
1109 int
1110 rte_cryptodev_asym_session_init(uint8_t dev_id,
1111                         struct rte_cryptodev_asym_session *sess,
1112                         struct rte_crypto_asym_xform *xforms,
1113                         struct rte_mempool *mempool);
1114
1115 /**
1116  * Frees private data for the device id, based on its device type,
1117  * returning it to its mempool. It is the application's responsibility
1118  * to ensure that private session data is not cleared while there are
1119  * still in-flight operations using it.
1120  *
1121  * @param   dev_id   ID of device that uses the session.
1122  * @param   sess     Session containing the reference to the private data
1123  *
1124  * @return
1125  *  - 0 if successful.
1126  *  - -EINVAL if device is invalid or session is NULL.
1127  *  - -ENOTSUP if crypto device does not support symmetric operations.
1128  */
1129 int
1130 rte_cryptodev_sym_session_clear(uint8_t dev_id,
1131                         struct rte_cryptodev_sym_session *sess);
1132
1133 /**
1134  * Frees resources held by asymmetric session during rte_cryptodev_session_init
1135  *
1136  * @param   dev_id   ID of device that uses the asymmetric session.
1137  * @param   sess     Asymmetric session setup on device using
1138  *                                       rte_cryptodev_session_init
1139  * @return
1140  *  - 0 if successful.
1141  *  - -EINVAL if device is invalid or session is NULL.
1142  */
1143 __rte_experimental
1144 int
1145 rte_cryptodev_asym_session_clear(uint8_t dev_id,
1146                         struct rte_cryptodev_asym_session *sess);
1147
1148 /**
1149  * Get the size of the header session, for all registered drivers excluding
1150  * the user data size.
1151  *
1152  * @return
1153  *   Size of the symmetric header session.
1154  */
1155 unsigned int
1156 rte_cryptodev_sym_get_header_session_size(void);
1157
1158 /**
1159  * Get the size of the header session from created session.
1160  *
1161  * @param sess
1162  *   The sym cryptodev session pointer
1163  *
1164  * @return
1165  *   - If sess is not NULL, return the size of the header session including
1166  *   the private data size defined within sess.
1167  *   - If sess is NULL, return 0.
1168  */
1169 __rte_experimental
1170 unsigned int
1171 rte_cryptodev_sym_get_existing_header_session_size(
1172                 struct rte_cryptodev_sym_session *sess);
1173
1174 /**
1175  * Get the size of the asymmetric session header, for all registered drivers.
1176  *
1177  * @return
1178  *   Size of the asymmetric header session.
1179  */
1180 __rte_experimental
1181 unsigned int
1182 rte_cryptodev_asym_get_header_session_size(void);
1183
1184 /**
1185  * Get the size of the private symmetric session data
1186  * for a device.
1187  *
1188  * @param       dev_id          The device identifier.
1189  *
1190  * @return
1191  *   - Size of the private data, if successful
1192  *   - 0 if device is invalid or does not have private
1193  *   symmetric session
1194  */
1195 unsigned int
1196 rte_cryptodev_sym_get_private_session_size(uint8_t dev_id);
1197
1198 /**
1199  * Get the size of the private data for asymmetric session
1200  * on device
1201  *
1202  * @param       dev_id          The device identifier.
1203  *
1204  * @return
1205  *   - Size of the asymmetric private data, if successful
1206  *   - 0 if device is invalid or does not have private session
1207  */
1208 __rte_experimental
1209 unsigned int
1210 rte_cryptodev_asym_get_private_session_size(uint8_t dev_id);
1211
1212 /**
1213  * Provide driver identifier.
1214  *
1215  * @param name
1216  *   The pointer to a driver name.
1217  * @return
1218  *  The driver type identifier or -1 if no driver found
1219  */
1220 int rte_cryptodev_driver_id_get(const char *name);
1221
1222 /**
1223  * Provide driver name.
1224  *
1225  * @param driver_id
1226  *   The driver identifier.
1227  * @return
1228  *  The driver name or null if no driver found
1229  */
1230 const char *rte_cryptodev_driver_name_get(uint8_t driver_id);
1231
1232 /**
1233  * Store user data in a session.
1234  *
1235  * @param       sess            Session pointer allocated by
1236  *                              *rte_cryptodev_sym_session_create*.
1237  * @param       data            Pointer to the user data.
1238  * @param       size            Size of the user data.
1239  *
1240  * @return
1241  *  - On success, zero.
1242  *  - On failure, a negative value.
1243  */
1244 __rte_experimental
1245 int
1246 rte_cryptodev_sym_session_set_user_data(
1247                                         struct rte_cryptodev_sym_session *sess,
1248                                         void *data,
1249                                         uint16_t size);
1250
1251 /**
1252  * Get user data stored in a session.
1253  *
1254  * @param       sess            Session pointer allocated by
1255  *                              *rte_cryptodev_sym_session_create*.
1256  *
1257  * @return
1258  *  - On success return pointer to user data.
1259  *  - On failure returns NULL.
1260  */
1261 __rte_experimental
1262 void *
1263 rte_cryptodev_sym_session_get_user_data(
1264                                         struct rte_cryptodev_sym_session *sess);
1265
1266 #ifdef __cplusplus
1267 }
1268 #endif
1269
1270 #endif /* _RTE_CRYPTODEV_H_ */