lib/librte_cryptodev/rte_cryptodev.h

   1 /*-
   2  *
   3  *   Copyright(c) 2015-2016 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 #define CRYPTODEV_NAME_NULL_PMD         crypto_null
  54 /**< Null crypto PMD device name */
  55 #define CRYPTODEV_NAME_AESNI_MB_PMD     crypto_aesni_mb
  56 /**< AES-NI Multi buffer PMD device name */
  57 #define CRYPTODEV_NAME_AESNI_GCM_PMD    crypto_aesni_gcm
  58 /**< AES-NI GCM PMD device name */
  59 #define CRYPTODEV_NAME_OPENSSL_PMD      crypto_openssl
  60 /**< Open SSL Crypto PMD device name */
  61 #define CRYPTODEV_NAME_QAT_SYM_PMD      crypto_qat
  62 /**< Intel QAT Symmetric Crypto PMD device name */
  63 #define CRYPTODEV_NAME_SNOW3G_PMD       crypto_snow3g
  64 /**< SNOW 3G PMD device name */
  65 #define CRYPTODEV_NAME_KASUMI_PMD       crypto_kasumi
  66 /**< KASUMI PMD device name */
  67 #define CRYPTODEV_NAME_ZUC_PMD          crypto_zuc
  68 /**< KASUMI PMD device name */
  69
  70 /** Crypto device type */
  71 enum rte_cryptodev_type {
  72         RTE_CRYPTODEV_NULL_PMD = 1,     /**< Null crypto PMD */
  73         RTE_CRYPTODEV_AESNI_GCM_PMD,    /**< AES-NI GCM PMD */
  74         RTE_CRYPTODEV_AESNI_MB_PMD,     /**< AES-NI multi buffer PMD */
  75         RTE_CRYPTODEV_QAT_SYM_PMD,      /**< QAT PMD Symmetric Crypto */
  76         RTE_CRYPTODEV_SNOW3G_PMD,       /**< SNOW 3G PMD */
  77         RTE_CRYPTODEV_KASUMI_PMD,       /**< KASUMI PMD */
  78         RTE_CRYPTODEV_ZUC_PMD,          /**< ZUC PMD */
  79         RTE_CRYPTODEV_OPENSSL_PMD,    /**<  OpenSSL PMD */
  80 };
  81
  82 extern const char **rte_cyptodev_names;
  83
  84 /* Logging Macros */
  85
  86 #define CDEV_LOG_ERR(...) \
  87         RTE_LOG(ERR, CRYPTODEV, \
  88                 RTE_FMT("%s() line %u: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
  89                         __func__, __LINE__, RTE_FMT_TAIL(__VA_ARGS__,)))
  90
  91 #define CDEV_PMD_LOG_ERR(dev, ...) \
  92         RTE_LOG(ERR, CRYPTODEV, \
  93                 RTE_FMT("[%s] %s() line %u: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
  94                         dev, __func__, __LINE__, RTE_FMT_TAIL(__VA_ARGS__,)))
  95
  96 #ifdef RTE_LIBRTE_CRYPTODEV_DEBUG
  97 #define CDEV_LOG_DEBUG(...) \
  98         RTE_LOG(DEBUG, CRYPTODEV, \
  99                 RTE_FMT("%s() line %u: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
 100                         __func__, __LINE__, RTE_FMT_TAIL(__VA_ARGS__,)))
 101
 102 #define CDEV_PMD_TRACE(...) \
 103         RTE_LOG(DEBUG, CRYPTODEV, \
 104                 RTE_FMT("[%s] %s: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
 105                         dev, __func__, RTE_FMT_TAIL(__VA_ARGS__,)))
 106
 107 #else
 108 #define CDEV_LOG_DEBUG(...) (void)0
 109 #define CDEV_PMD_TRACE(...) (void)0
 110 #endif
 111
 112 /**
 113  * Symmetric Crypto Capability
 114  */
 115 struct rte_cryptodev_symmetric_capability {
 116         enum rte_crypto_sym_xform_type xform_type;
 117         /**< Transform type : Authentication / Cipher */
 118         RTE_STD_C11
 119         union {
 120                 struct {
 121                         enum rte_crypto_auth_algorithm algo;
 122                         /**< authentication algorithm */
 123                         uint16_t block_size;
 124                         /**< algorithm block size */
 125                         struct {
 126                                 uint16_t min;   /**< minimum key size */
 127                                 uint16_t max;   /**< maximum key size */
 128                                 uint16_t increment;
 129                                 /**< if a range of sizes are supported,
 130                                  * this parameter is used to indicate
 131                                  * increments in byte size that are supported
 132                                  * between the minimum and maximum */
 133                         } key_size;
 134                         /**< auth key size range */
 135                         struct {
 136                                 uint16_t min;   /**< minimum digest size */
 137                                 uint16_t max;   /**< maximum digest size */
 138                                 uint16_t increment;
 139                                 /**< if a range of sizes are supported,
 140                                  * this parameter is used to indicate
 141                                  * increments in byte size that are supported
 142                                  * between the minimum and maximum */
 143                         } digest_size;
 144                         /**< digest size range */
 145                         struct {
 146                                 uint16_t min;   /**< minimum aad size */
 147                                 uint16_t max;   /**< maximum aad size */
 148                                 uint16_t increment;
 149                                 /**< if a range of sizes are supported,
 150                                  * this parameter is used to indicate
 151                                  * increments in byte size that are supported
 152                                  * between the minimum and maximum */
 153                         } aad_size;
 154                         /**< Additional authentication data size range */
 155                 } auth;
 156                 /**< Symmetric Authentication transform capabilities */
 157                 struct {
 158                         enum rte_crypto_cipher_algorithm algo;
 159                         /**< cipher algorithm */
 160                         uint16_t block_size;
 161                         /**< algorithm block size */
 162                         struct {
 163                                 uint16_t min;   /**< minimum key size */
 164                                 uint16_t max;   /**< maximum key size */
 165                                 uint16_t increment;
 166                                 /**< if a range of sizes are supported,
 167                                  * this parameter is used to indicate
 168                                  * increments in byte size that are supported
 169                                  * between the minimum and maximum */
 170                         } key_size;
 171                         /**< cipher key size range */
 172                         struct {
 173                                 uint16_t min;   /**< minimum iv size */
 174                                 uint16_t max;   /**< maximum iv size */
 175                                 uint16_t increment;
 176                                 /**< if a range of sizes are supported,
 177                                  * this parameter is used to indicate
 178                                  * increments in byte size that are supported
 179                                  * between the minimum and maximum */
 180                         } iv_size;
 181                         /**< Initialisation vector data size range */
 182                 } cipher;
 183                 /**< Symmetric Cipher transform capabilities */
 184         };
 185 };
 186
 187 /** Structure used to capture a capability of a crypto device */
 188 struct rte_cryptodev_capabilities {
 189         enum rte_crypto_op_type op;
 190         /**< Operation type */
 191
 192         RTE_STD_C11
 193         union {
 194                 struct rte_cryptodev_symmetric_capability sym;
 195                 /**< Symmetric operation capability parameters */
 196         };
 197 };
 198
 199 /** Macro used at end of crypto PMD list */
 200 #define RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST() \
 201         { RTE_CRYPTO_OP_TYPE_UNDEFINED }
 202
 203
 204 /**
 205  * Crypto device supported feature flags
 206  *
 207  * Note:
 208  * New features flags should be added to the end of the list
 209  *
 210  * Keep these flags synchronised with rte_cryptodev_get_feature_name()
 211  */
 212 #define RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO       (1ULL << 0)
 213 /**< Symmetric crypto operations are supported */
 214 #define RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO      (1ULL << 1)
 215 /**< Asymmetric crypto operations are supported */
 216 #define RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING (1ULL << 2)
 217 /**< Chaining symmetric crypto operations are supported */
 218 #define RTE_CRYPTODEV_FF_CPU_SSE                (1ULL << 3)
 219 /**< Utilises CPU SIMD SSE instructions */
 220 #define RTE_CRYPTODEV_FF_CPU_AVX                (1ULL << 4)
 221 /**< Utilises CPU SIMD AVX instructions */
 222 #define RTE_CRYPTODEV_FF_CPU_AVX2               (1ULL << 5)
 223 /**< Utilises CPU SIMD AVX2 instructions */
 224 #define RTE_CRYPTODEV_FF_CPU_AESNI              (1ULL << 6)
 225 /**< Utilises CPU AES-NI instructions */
 226 #define RTE_CRYPTODEV_FF_HW_ACCELERATED         (1ULL << 7)
 227 /**< Operations are off-loaded to an external hardware accelerator */
 228 #define RTE_CRYPTODEV_FF_CPU_AVX512             (1ULL << 8)
 229 /**< Utilises CPU SIMD AVX512 instructions */
 230 #define RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER    (1ULL << 9)
 231 /**< Scatter-gather mbufs are supported */
 232
 233
 234 /**
 235  * Get the name of a crypto device feature flag
 236  *
 237  * @param       flag    The mask describing the flag.
 238  *
 239  * @return
 240  *   The name of this flag, or NULL if it's not a valid feature flag.
 241  */
 242
 243 extern const char *
 244 rte_cryptodev_get_feature_name(uint64_t flag);
 245
 246 /**  Crypto device information */
 247 struct rte_cryptodev_info {
 248         const char *driver_name;                /**< Driver name. */
 249         enum rte_cryptodev_type dev_type;       /**< Device type */
 250         struct rte_pci_device *pci_dev;         /**< PCI information. */
 251
 252         uint64_t feature_flags;                 /**< Feature flags */
 253
 254         const struct rte_cryptodev_capabilities *capabilities;
 255         /**< Array of devices supported capabilities */
 256
 257         unsigned max_nb_queue_pairs;
 258         /**< Maximum number of queues pairs supported by device. */
 259
 260         struct {
 261                 unsigned max_nb_sessions;
 262                 /**< Maximum number of sessions supported by device. */
 263         } sym;
 264 };
 265
 266 #define RTE_CRYPTODEV_DETACHED  (0)
 267 #define RTE_CRYPTODEV_ATTACHED  (1)
 268
 269 /** Definitions of Crypto device event types */
 270 enum rte_cryptodev_event_type {
 271         RTE_CRYPTODEV_EVENT_UNKNOWN,    /**< unknown event type */
 272         RTE_CRYPTODEV_EVENT_ERROR,      /**< error interrupt event */
 273         RTE_CRYPTODEV_EVENT_MAX         /**< max value of this enum */
 274 };
 275
 276 /** Crypto device queue pair configuration structure. */
 277 struct rte_cryptodev_qp_conf {
 278         uint32_t nb_descriptors; /**< Number of descriptors per queue pair */
 279 };
 280
 281 /**
 282  * Typedef for application callback function to be registered by application
 283  * software for notification of device events
 284  *
 285  * @param       dev_id  Crypto device identifier
 286  * @param       event   Crypto device event to register for notification of.
 287  * @param       cb_arg  User specified parameter to be passed as to passed to
 288  *                      users callback function.
 289  */
 290 typedef void (*rte_cryptodev_cb_fn)(uint8_t dev_id,
 291                 enum rte_cryptodev_event_type event, void *cb_arg);
 292
 293
 294 /** Crypto Device statistics */
 295 struct rte_cryptodev_stats {
 296         uint64_t enqueued_count;
 297         /**< Count of all operations enqueued */
 298         uint64_t dequeued_count;
 299         /**< Count of all operations dequeued */
 300
 301         uint64_t enqueue_err_count;
 302         /**< Total error count on operations enqueued */
 303         uint64_t dequeue_err_count;
 304         /**< Total error count on operations dequeued */
 305 };
 306
 307 #define RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_QUEUE_PAIRS   8
 308 #define RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_SESSIONS      2048
 309
 310 /**
 311  * @internal
 312  * Initialisation parameters for virtual crypto devices
 313  */
 314 struct rte_crypto_vdev_init_params {
 315         unsigned max_nb_queue_pairs;
 316         unsigned max_nb_sessions;
 317         uint8_t socket_id;
 318 };
 319
 320 /**
 321  * Parse virtual device initialisation parameters input arguments
 322  * @internal
 323  *
 324  * @params      params          Initialisation parameters with defaults set.
 325  * @params      input_args      Command line arguments
 326  *
 327  * @return
 328  * 0 on successful parse
 329  * <0 on failure to parse
 330  */
 331 int
 332 rte_cryptodev_parse_vdev_init_params(
 333                 struct rte_crypto_vdev_init_params *params,
 334                 const char *input_args);
 335
 336 /**
 337  * Create a virtual crypto device
 338  *
 339  * @param       name    Cryptodev PMD name of device to be created.
 340  * @param       args    Options arguments for device.
 341  *
 342  * @return
 343  * - On successful creation of the cryptodev the device index is returned,
 344  *   which will be between 0 and rte_cryptodev_count().
 345  * - In the case of a failure, returns -1.
 346  */
 347 extern int
 348 rte_cryptodev_create_vdev(const char *name, const char *args);
 349
 350 /**
 351  * Get the device identifier for the named crypto device.
 352  *
 353  * @param       name    device name to select the device structure.
 354  *
 355  * @return
 356  *   - Returns crypto device identifier on success.
 357  *   - Return -1 on failure to find named crypto device.
 358  */
 359 extern int
 360 rte_cryptodev_get_dev_id(const char *name);
 361
 362 /**
 363  * Get the total number of crypto devices that have been successfully
 364  * initialised.
 365  *
 366  * @return
 367  *   - The total number of usable crypto devices.
 368  */
 369 extern uint8_t
 370 rte_cryptodev_count(void);
 371
 372 extern uint8_t
 373 rte_cryptodev_count_devtype(enum rte_cryptodev_type type);
 374 /*
 375  * Return the NUMA socket to which a device is connected
 376  *
 377  * @param dev_id
 378  *   The identifier of the device
 379  * @return
 380  *   The NUMA socket id to which the device is connected or
 381  *   a default of zero if the socket could not be determined.
 382  *   -1 if returned is the dev_id value is out of range.
 383  */
 384 extern int
 385 rte_cryptodev_socket_id(uint8_t dev_id);
 386
 387 /** Crypto device configuration structure */
 388 struct rte_cryptodev_config {
 389         int socket_id;                  /**< Socket to allocate resources on */
 390         uint16_t nb_queue_pairs;
 391         /**< Number of queue pairs to configure on device */
 392
 393         struct {
 394                 uint32_t nb_objs;       /**< Number of objects in mempool */
 395                 uint32_t cache_size;    /**< l-core object cache size */
 396         } session_mp;           /**< Session mempool configuration */
 397 };
 398
 399 /**
 400  * Configure a device.
 401  *
 402  * This function must be invoked first before any other function in the
 403  * API. This function can also be re-invoked when a device is in the
 404  * stopped state.
 405  *
 406  * @param       dev_id          The identifier of the device to configure.
 407  * @param       config          The crypto device configuration structure.
 408  *
 409  * @return
 410  *   - 0: Success, device configured.
 411  *   - <0: Error code returned by the driver configuration function.
 412  */
 413 extern int
 414 rte_cryptodev_configure(uint8_t dev_id, struct rte_cryptodev_config *config);
 415
 416 /**
 417  * Start an device.
 418  *
 419  * The device start step is the last one and consists of setting the configured
 420  * offload features and in starting the transmit and the receive units of the
 421  * device.
 422  * On success, all basic functions exported by the API (link status,
 423  * receive/transmit, and so on) can be invoked.
 424  *
 425  * @param dev_id
 426  *   The identifier of the device.
 427  * @return
 428  *   - 0: Success, device started.
 429  *   - <0: Error code of the driver device start function.
 430  */
 431 extern int
 432 rte_cryptodev_start(uint8_t dev_id);
 433
 434 /**
 435  * Stop an device. The device can be restarted with a call to
 436  * rte_cryptodev_start()
 437  *
 438  * @param       dev_id          The identifier of the device.
 439  */
 440 extern void
 441 rte_cryptodev_stop(uint8_t dev_id);
 442
 443 /**
 444  * Close an device. The device cannot be restarted!
 445  *
 446  * @param       dev_id          The identifier of the device.
 447  *
 448  * @return
 449  *  - 0 on successfully closing device
 450  *  - <0 on failure to close device
 451  */
 452 extern int
 453 rte_cryptodev_close(uint8_t dev_id);
 454
 455 /**
 456  * Allocate and set up a receive queue pair for a device.
 457  *
 458  *
 459  * @param       dev_id          The identifier of the device.
 460  * @param       queue_pair_id   The index of the queue pairs to set up. The
 461  *                              value must be in the range [0, nb_queue_pair
 462  *                              - 1] previously supplied to
 463  *                              rte_cryptodev_configure().
 464  * @param       qp_conf         The pointer to the configuration data to be
 465  *                              used for the queue pair. NULL value is
 466  *                              allowed, in which case default configuration
 467  *                              will be used.
 468  * @param       socket_id       The *socket_id* argument is the socket
 469  *                              identifier in case of NUMA. The value can be
 470  *                              *SOCKET_ID_ANY* if there is no NUMA constraint
 471  *                              for the DMA memory allocated for the receive
 472  *                              queue pair.
 473  *
 474  * @return
 475  *   - 0: Success, queue pair correctly set up.
 476  *   - <0: Queue pair configuration failed
 477  */
 478 extern int
 479 rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
 480                 const struct rte_cryptodev_qp_conf *qp_conf, int socket_id);
 481
 482 /**
 483  * Start a specified queue pair of a device. It is used
 484  * when deferred_start flag of the specified queue is true.
 485  *
 486  * @param       dev_id          The identifier of the device
 487  * @param       queue_pair_id   The index of the queue pair to start. The value
 488  *                              must be in the range [0, nb_queue_pair - 1]
 489  *                              previously supplied to
 490  *                              rte_crypto_dev_configure().
 491  * @return
 492  *   - 0: Success, the transmit queue is correctly set up.
 493  *   - -EINVAL: The dev_id or the queue_id out of range.
 494  *   - -ENOTSUP: The function not supported in PMD driver.
 495  */
 496 extern int
 497 rte_cryptodev_queue_pair_start(uint8_t dev_id, uint16_t queue_pair_id);
 498
 499 /**
 500  * Stop specified queue pair of a device
 501  *
 502  * @param       dev_id          The identifier of the device
 503  * @param       queue_pair_id   The index of the queue pair to stop. The value
 504  *                              must be in the range [0, nb_queue_pair - 1]
 505  *                              previously supplied to
 506  *                              rte_cryptodev_configure().
 507  * @return
 508  *   - 0: Success, the transmit queue is correctly set up.
 509  *   - -EINVAL: The dev_id or the queue_id out of range.
 510  *   - -ENOTSUP: The function not supported in PMD driver.
 511  */
 512 extern int
 513 rte_cryptodev_queue_pair_stop(uint8_t dev_id, uint16_t queue_pair_id);
 514
 515 /**
 516  * Get the number of queue pairs on a specific crypto device
 517  *
 518  * @param       dev_id          Crypto device identifier.
 519  * @return
 520  *   - The number of configured queue pairs.
 521  */
 522 extern uint16_t
 523 rte_cryptodev_queue_pair_count(uint8_t dev_id);
 524
 525
 526 /**
 527  * Retrieve the general I/O statistics of a device.
 528  *
 529  * @param       dev_id          The identifier of the device.
 530  * @param       stats           A pointer to a structure of type
 531  *                              *rte_cryptodev_stats* to be filled with the
 532  *                              values of device counters.
 533  * @return
 534  *   - Zero if successful.
 535  *   - Non-zero otherwise.
 536  */
 537 extern int
 538 rte_cryptodev_stats_get(uint8_t dev_id, struct rte_cryptodev_stats *stats);
 539
 540 /**
 541  * Reset the general I/O statistics of a device.
 542  *
 543  * @param       dev_id          The identifier of the device.
 544  */
 545 extern void
 546 rte_cryptodev_stats_reset(uint8_t dev_id);
 547
 548 /**
 549  * Retrieve the contextual information of a device.
 550  *
 551  * @param       dev_id          The identifier of the device.
 552  * @param       dev_info        A pointer to a structure of type
 553  *                              *rte_cryptodev_info* to be filled with the
 554  *                              contextual information of the device.
 555  */
 556 extern void
 557 rte_cryptodev_info_get(uint8_t dev_id, struct rte_cryptodev_info *dev_info);
 558
 559
 560 /**
 561  * Register a callback function for specific device id.
 562  *
 563  * @param       dev_id          Device id.
 564  * @param       event           Event interested.
 565  * @param       cb_fn           User supplied callback function to be called.
 566  * @param       cb_arg          Pointer to the parameters for the registered
 567  *                              callback.
 568  *
 569  * @return
 570  *  - On success, zero.
 571  *  - On failure, a negative value.
 572  */
 573 extern int
 574 rte_cryptodev_callback_register(uint8_t dev_id,
 575                 enum rte_cryptodev_event_type event,
 576                 rte_cryptodev_cb_fn cb_fn, void *cb_arg);
 577
 578 /**
 579  * Unregister a callback function for specific device id.
 580  *
 581  * @param       dev_id          The device identifier.
 582  * @param       event           Event interested.
 583  * @param       cb_fn           User supplied callback function to be called.
 584  * @param       cb_arg          Pointer to the parameters for the registered
 585  *                              callback.
 586  *
 587  * @return
 588  *  - On success, zero.
 589  *  - On failure, a negative value.
 590  */
 591 extern int
 592 rte_cryptodev_callback_unregister(uint8_t dev_id,
 593                 enum rte_cryptodev_event_type event,
 594                 rte_cryptodev_cb_fn cb_fn, void *cb_arg);
 595
 596
 597 typedef uint16_t (*dequeue_pkt_burst_t)(void *qp,
 598                 struct rte_crypto_op **ops,     uint16_t nb_ops);
 599 /**< Dequeue processed packets from queue pair of a device. */
 600
 601 typedef uint16_t (*enqueue_pkt_burst_t)(void *qp,
 602                 struct rte_crypto_op **ops,     uint16_t nb_ops);
 603 /**< Enqueue packets for processing on queue pair of a device. */
 604
 605
 606
 607
 608 struct rte_cryptodev_callback;
 609
 610 /** Structure to keep track of registered callbacks */
 611 TAILQ_HEAD(rte_cryptodev_cb_list, rte_cryptodev_callback);
 612
 613 /** The data structure associated with each crypto device. */
 614 struct rte_cryptodev {
 615         dequeue_pkt_burst_t dequeue_burst;
 616         /**< Pointer to PMD receive function. */
 617         enqueue_pkt_burst_t enqueue_burst;
 618         /**< Pointer to PMD transmit function. */
 619
 620         const struct rte_cryptodev_driver *driver;
 621         /**< Driver for this device */
 622         struct rte_cryptodev_data *data;
 623         /**< Pointer to device data */
 624         struct rte_cryptodev_ops *dev_ops;
 625         /**< Functions exported by PMD */
 626         uint64_t feature_flags;
 627         /**< Supported features */
 628         struct rte_pci_device *pci_dev;
 629         /**< PCI info. supplied by probing */
 630
 631         enum rte_cryptodev_type dev_type;
 632         /**< Crypto device type */
 633
 634         struct rte_cryptodev_cb_list link_intr_cbs;
 635         /**< User application callback for interrupts if present */
 636
 637         __extension__
 638         uint8_t attached : 1;
 639         /**< Flag indicating the device is attached */
 640 } __rte_cache_aligned;
 641
 642
 643 #define RTE_CRYPTODEV_NAME_MAX_LEN      (64)
 644 /**< Max length of name of crypto PMD */
 645
 646 /**
 647  *
 648  * The data part, with no function pointers, associated with each device.
 649  *
 650  * This structure is safe to place in shared memory to be common among
 651  * different processes in a multi-process configuration.
 652  */
 653 struct rte_cryptodev_data {
 654         uint8_t dev_id;
 655         /**< Device ID for this instance */
 656         uint8_t socket_id;
 657         /**< Socket ID where memory is allocated */
 658         char name[RTE_CRYPTODEV_NAME_MAX_LEN];
 659         /**< Unique identifier name */
 660
 661         __extension__
 662         uint8_t dev_started : 1;
 663         /**< Device state: STARTED(1)/STOPPED(0) */
 664
 665         struct rte_mempool *session_pool;
 666         /**< Session memory pool */
 667         void **queue_pairs;
 668         /**< Array of pointers to queue pairs. */
 669         uint16_t nb_queue_pairs;
 670         /**< Number of device queue pairs. */
 671
 672         void *dev_private;
 673         /**< PMD-specific private data */
 674 } __rte_cache_aligned;
 675
 676 extern struct rte_cryptodev *rte_cryptodevs;
 677 /**
 678  *
 679  * Dequeue a burst of processed crypto operations from a queue on the crypto
 680  * device. The dequeued operation are stored in *rte_crypto_op* structures
 681  * whose pointers are supplied in the *ops* array.
 682  *
 683  * The rte_cryptodev_dequeue_burst() function returns the number of ops
 684  * actually dequeued, which is the number of *rte_crypto_op* data structures
 685  * effectively supplied into the *ops* array.
 686  *
 687  * A return value equal to *nb_ops* indicates that the queue contained
 688  * at least *nb_ops* operations, and this is likely to signify that other
 689  * processed operations remain in the devices output queue. Applications
 690  * implementing a "retrieve as many processed operations as possible" policy
 691  * can check this specific case and keep invoking the
 692  * rte_cryptodev_dequeue_burst() function until a value less than
 693  * *nb_ops* is returned.
 694  *
 695  * The rte_cryptodev_dequeue_burst() function does not provide any error
 696  * notification to avoid the corresponding overhead.
 697  *
 698  * @param       dev_id          The symmetric crypto device identifier
 699  * @param       qp_id           The index of the queue pair from which to
 700  *                              retrieve processed packets. The value must be
 701  *                              in the range [0, nb_queue_pair - 1] previously
 702  *                              supplied to rte_cryptodev_configure().
 703  * @param       ops             The address of an array of pointers to
 704  *                              *rte_crypto_op* structures that must be
 705  *                              large enough to store *nb_ops* pointers in it.
 706  * @param       nb_ops          The maximum number of operations to dequeue.
 707  *
 708  * @return
 709  *   - The number of operations actually dequeued, which is the number
 710  *   of pointers to *rte_crypto_op* structures effectively supplied to the
 711  *   *ops* array.
 712  */
 713 static inline uint16_t
 714 rte_cryptodev_dequeue_burst(uint8_t dev_id, uint16_t qp_id,
 715                 struct rte_crypto_op **ops, uint16_t nb_ops)
 716 {
 717         struct rte_cryptodev *dev = &rte_cryptodevs[dev_id];
 718
 719         nb_ops = (*dev->dequeue_burst)
 720                         (dev->data->queue_pairs[qp_id], ops, nb_ops);
 721
 722         return nb_ops;
 723 }
 724
 725 /**
 726  * Enqueue a burst of operations for processing on a crypto device.
 727  *
 728  * The rte_cryptodev_enqueue_burst() function is invoked to place
 729  * crypto operations on the queue *qp_id* of the device designated by
 730  * its *dev_id*.
 731  *
 732  * The *nb_ops* parameter is the number of operations to process which are
 733  * supplied in the *ops* array of *rte_crypto_op* structures.
 734  *
 735  * The rte_cryptodev_enqueue_burst() function returns the number of
 736  * operations it actually enqueued for processing. A return value equal to
 737  * *nb_ops* means that all packets have been enqueued.
 738  *
 739  * @param       dev_id          The identifier of the device.
 740  * @param       qp_id           The index of the queue pair which packets are
 741  *                              to be enqueued for processing. The value
 742  *                              must be in the range [0, nb_queue_pairs - 1]
 743  *                              previously supplied to
 744  *                               *rte_cryptodev_configure*.
 745  * @param       ops             The address of an array of *nb_ops* pointers
 746  *                              to *rte_crypto_op* structures which contain
 747  *                              the crypto operations to be processed.
 748  * @param       nb_ops          The number of operations to process.
 749  *
 750  * @return
 751  * The number of operations actually enqueued on the crypto device. The return
 752  * value can be less than the value of the *nb_ops* parameter when the
 753  * crypto devices queue is full or if invalid parameters are specified in
 754  * a *rte_crypto_op*.
 755  */
 756 static inline uint16_t
 757 rte_cryptodev_enqueue_burst(uint8_t dev_id, uint16_t qp_id,
 758                 struct rte_crypto_op **ops, uint16_t nb_ops)
 759 {
 760         struct rte_cryptodev *dev = &rte_cryptodevs[dev_id];
 761
 762         return (*dev->enqueue_burst)(
 763                         dev->data->queue_pairs[qp_id], ops, nb_ops);
 764 }
 765
 766
 767 /** Cryptodev symmetric crypto session */
 768 struct rte_cryptodev_sym_session {
 769         RTE_STD_C11
 770         struct {
 771                 uint8_t dev_id;
 772                 /**< Device Id */
 773                 enum rte_cryptodev_type dev_type;
 774                 /** Crypto Device type session created on */
 775                 struct rte_mempool *mp;
 776                 /**< Mempool session allocated from */
 777         } __rte_aligned(8);
 778         /**< Public symmetric session details */
 779
 780         __extension__ char _private[0];
 781         /**< Private session material */
 782 };
 783
 784
 785 /**
 786  * Initialise a session for symmetric cryptographic operations.
 787  *
 788  * This function is used by the client to initialize immutable
 789  * parameters of symmetric cryptographic operation.
 790  * To perform the operation the rte_cryptodev_enqueue_burst function is
 791  * used.  Each mbuf should contain a reference to the session
 792  * pointer returned from this function contained within it's crypto_op if a
 793  * session-based operation is being provisioned. Memory to contain the session
 794  * information is allocated from within mempool managed by the cryptodev.
 795  *
 796  * The rte_cryptodev_session_free must be called to free allocated
 797  * memory when the session is no longer required.
 798  *
 799  * @param       dev_id          The device identifier.
 800  * @param       xform           Crypto transform chain.
 801
 802  *
 803  * @return
 804  *  Pointer to the created session or NULL
 805  */
 806 extern struct rte_cryptodev_sym_session *
 807 rte_cryptodev_sym_session_create(uint8_t dev_id,
 808                 struct rte_crypto_sym_xform *xform);
 809
 810 /**
 811  * Free the memory associated with a previously allocated session.
 812  *
 813  * @param       dev_id          The device identifier.
 814  * @param       session         Session pointer previously allocated by
 815  *                              *rte_cryptodev_sym_session_create*.
 816  *
 817  * @return
 818  *   NULL on successful freeing of session.
 819  *   Session pointer on failure to free session.
 820  */
 821 extern struct rte_cryptodev_sym_session *
 822 rte_cryptodev_sym_session_free(uint8_t dev_id,
 823                 struct rte_cryptodev_sym_session *session);
 824
 825
 826 #ifdef __cplusplus
 827 }
 828 #endif
 829
 830 #endif /* _RTE_CRYPTODEV_H_ */