lib/librte_cryptodev/rte_cryptodev.h

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