3 * Copyright(c) 2015-2017 Intel Corporation. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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
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.
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.
32 #ifndef _RTE_CRYPTODEV_H_
33 #define _RTE_CRYPTODEV_H_
36 * @file rte_cryptodev.h
38 * RTE Cryptographic Device APIs
40 * Defines RTE Crypto Device APIs for the provisioning of cipher and
41 * authentication operations.
48 #include "rte_kvargs.h"
49 #include "rte_crypto.h"
51 #include <rte_common.h>
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 #define CRYPTODEV_NAME_ARMV8_PMD crypto_armv8
70 /**< ARMv8 Crypto PMD device name */
71 #define CRYPTODEV_NAME_SCHEDULER_PMD crypto_scheduler
72 /**< Scheduler Crypto PMD device name */
73 #define CRYPTODEV_NAME_DPAA2_SEC_PMD cryptodev_dpaa2_sec_pmd
74 /**< NXP DPAA2 - SEC PMD device name */
76 /** Crypto device type */
77 enum rte_cryptodev_type {
78 RTE_CRYPTODEV_NULL_PMD = 1, /**< Null crypto PMD */
79 RTE_CRYPTODEV_AESNI_GCM_PMD, /**< AES-NI GCM PMD */
80 RTE_CRYPTODEV_AESNI_MB_PMD, /**< AES-NI multi buffer PMD */
81 RTE_CRYPTODEV_QAT_SYM_PMD, /**< QAT PMD Symmetric Crypto */
82 RTE_CRYPTODEV_SNOW3G_PMD, /**< SNOW 3G PMD */
83 RTE_CRYPTODEV_KASUMI_PMD, /**< KASUMI PMD */
84 RTE_CRYPTODEV_ZUC_PMD, /**< ZUC PMD */
85 RTE_CRYPTODEV_OPENSSL_PMD, /**< OpenSSL PMD */
86 RTE_CRYPTODEV_ARMV8_PMD, /**< ARMv8 crypto PMD */
87 RTE_CRYPTODEV_SCHEDULER_PMD, /**< Crypto Scheduler PMD */
88 RTE_CRYPTODEV_DPAA2_SEC_PMD, /**< NXP DPAA2 - SEC PMD */
91 extern const char **rte_cyptodev_names;
95 #define CDEV_LOG_ERR(...) \
96 RTE_LOG(ERR, CRYPTODEV, \
97 RTE_FMT("%s() line %u: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
98 __func__, __LINE__, RTE_FMT_TAIL(__VA_ARGS__,)))
100 #define CDEV_PMD_LOG_ERR(dev, ...) \
101 RTE_LOG(ERR, CRYPTODEV, \
102 RTE_FMT("[%s] %s() line %u: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
103 dev, __func__, __LINE__, RTE_FMT_TAIL(__VA_ARGS__,)))
105 #ifdef RTE_LIBRTE_CRYPTODEV_DEBUG
106 #define CDEV_LOG_DEBUG(...) \
107 RTE_LOG(DEBUG, CRYPTODEV, \
108 RTE_FMT("%s() line %u: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
109 __func__, __LINE__, RTE_FMT_TAIL(__VA_ARGS__,)))
111 #define CDEV_PMD_TRACE(...) \
112 RTE_LOG(DEBUG, CRYPTODEV, \
113 RTE_FMT("[%s] %s: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
114 dev, __func__, RTE_FMT_TAIL(__VA_ARGS__,)))
117 #define CDEV_LOG_DEBUG(...) (void)0
118 #define CDEV_PMD_TRACE(...) (void)0
122 * Crypto parameters range description
124 struct rte_crypto_param_range {
125 uint16_t min; /**< minimum size */
126 uint16_t max; /**< maximum size */
128 /**< if a range of sizes are supported,
129 * this parameter is used to indicate
130 * increments in byte size that are supported
131 * between the minimum and maximum
136 * Symmetric Crypto Capability
138 struct rte_cryptodev_symmetric_capability {
139 enum rte_crypto_sym_xform_type xform_type;
140 /**< Transform type : Authentication / Cipher */
144 enum rte_crypto_auth_algorithm algo;
145 /**< authentication algorithm */
147 /**< algorithm block size */
148 struct rte_crypto_param_range key_size;
149 /**< auth key size range */
150 struct rte_crypto_param_range digest_size;
151 /**< digest size range */
152 struct rte_crypto_param_range aad_size;
153 /**< Additional authentication data size range */
155 /**< Symmetric Authentication transform capabilities */
157 enum rte_crypto_cipher_algorithm algo;
158 /**< cipher algorithm */
160 /**< algorithm block size */
161 struct rte_crypto_param_range key_size;
162 /**< cipher key size range */
163 struct rte_crypto_param_range iv_size;
164 /**< Initialisation vector data size range */
166 /**< Symmetric Cipher transform capabilities */
170 /** Structure used to capture a capability of a crypto device */
171 struct rte_cryptodev_capabilities {
172 enum rte_crypto_op_type op;
173 /**< Operation type */
177 struct rte_cryptodev_symmetric_capability sym;
178 /**< Symmetric operation capability parameters */
182 /** Structure used to describe crypto algorithms */
183 struct rte_cryptodev_sym_capability_idx {
184 enum rte_crypto_sym_xform_type type;
186 enum rte_crypto_cipher_algorithm cipher;
187 enum rte_crypto_auth_algorithm auth;
192 * Provide capabilities available for defined device and algorithm
194 * @param dev_id The identifier of the device.
195 * @param idx Description of crypto algorithms.
198 * - Return description of the symmetric crypto capability if exist.
199 * - Return NULL if the capability not exist.
201 const struct rte_cryptodev_symmetric_capability *
202 rte_cryptodev_sym_capability_get(uint8_t dev_id,
203 const struct rte_cryptodev_sym_capability_idx *idx);
206 * Check if key size and initial vector are supported
207 * in crypto cipher capability
209 * @param capability Description of the symmetric crypto capability.
210 * @param key_size Cipher key size.
211 * @param iv_size Cipher initial vector size.
214 * - Return 0 if the parameters are in range of the capability.
215 * - Return -1 if the parameters are out of range of the capability.
218 rte_cryptodev_sym_capability_check_cipher(
219 const struct rte_cryptodev_symmetric_capability *capability,
220 uint16_t key_size, uint16_t iv_size);
223 * Check if key size and initial vector are supported
224 * in crypto auth capability
226 * @param capability Description of the symmetric crypto capability.
227 * @param key_size Auth key size.
228 * @param digest_size Auth digest size.
229 * @param aad_size Auth aad size.
232 * - Return 0 if the parameters are in range of the capability.
233 * - Return -1 if the parameters are out of range of the capability.
236 rte_cryptodev_sym_capability_check_auth(
237 const struct rte_cryptodev_symmetric_capability *capability,
238 uint16_t key_size, uint16_t digest_size, uint16_t aad_size);
241 * Provide the cipher algorithm enum, given an algorithm string
243 * @param algo_enum A pointer to the cipher algorithm
245 * @param algo_string Authentication algo string
248 * - Return -1 if string is not valid
249 * - Return 0 is the string is valid
252 rte_cryptodev_get_cipher_algo_enum(enum rte_crypto_cipher_algorithm *algo_enum,
253 const char *algo_string);
256 * Provide the authentication algorithm enum, given an algorithm string
258 * @param algo_enum A pointer to the authentication algorithm
260 * @param algo_string Authentication algo string
263 * - Return -1 if string is not valid
264 * - Return 0 is the string is valid
267 rte_cryptodev_get_auth_algo_enum(enum rte_crypto_auth_algorithm *algo_enum,
268 const char *algo_string);
270 /** Macro used at end of crypto PMD list */
271 #define RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST() \
272 { RTE_CRYPTO_OP_TYPE_UNDEFINED }
276 * Crypto device supported feature flags
279 * New features flags should be added to the end of the list
281 * Keep these flags synchronised with rte_cryptodev_get_feature_name()
283 #define RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO (1ULL << 0)
284 /**< Symmetric crypto operations are supported */
285 #define RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO (1ULL << 1)
286 /**< Asymmetric crypto operations are supported */
287 #define RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING (1ULL << 2)
288 /**< Chaining symmetric crypto operations are supported */
289 #define RTE_CRYPTODEV_FF_CPU_SSE (1ULL << 3)
290 /**< Utilises CPU SIMD SSE instructions */
291 #define RTE_CRYPTODEV_FF_CPU_AVX (1ULL << 4)
292 /**< Utilises CPU SIMD AVX instructions */
293 #define RTE_CRYPTODEV_FF_CPU_AVX2 (1ULL << 5)
294 /**< Utilises CPU SIMD AVX2 instructions */
295 #define RTE_CRYPTODEV_FF_CPU_AESNI (1ULL << 6)
296 /**< Utilises CPU AES-NI instructions */
297 #define RTE_CRYPTODEV_FF_HW_ACCELERATED (1ULL << 7)
298 /**< Operations are off-loaded to an external hardware accelerator */
299 #define RTE_CRYPTODEV_FF_CPU_AVX512 (1ULL << 8)
300 /**< Utilises CPU SIMD AVX512 instructions */
301 #define RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER (1ULL << 9)
302 /**< Scatter-gather mbufs are supported */
303 #define RTE_CRYPTODEV_FF_CPU_NEON (1ULL << 10)
304 /**< Utilises CPU NEON instructions */
305 #define RTE_CRYPTODEV_FF_CPU_ARM_CE (1ULL << 11)
306 /**< Utilises ARM CPU Cryptographic Extensions */
310 * Get the name of a crypto device feature flag
312 * @param flag The mask describing the flag.
315 * The name of this flag, or NULL if it's not a valid feature flag.
319 rte_cryptodev_get_feature_name(uint64_t flag);
321 /** Crypto device information */
322 struct rte_cryptodev_info {
323 const char *driver_name; /**< Driver name. */
324 enum rte_cryptodev_type dev_type; /**< Device type */
325 struct rte_pci_device *pci_dev; /**< PCI information. */
327 uint64_t feature_flags; /**< Feature flags */
329 const struct rte_cryptodev_capabilities *capabilities;
330 /**< Array of devices supported capabilities */
332 unsigned max_nb_queue_pairs;
333 /**< Maximum number of queues pairs supported by device. */
336 unsigned max_nb_sessions;
337 /**< Maximum number of sessions supported by device. */
338 unsigned int max_nb_sessions_per_qp;
339 /**< Maximum number of sessions per queue pair.
340 * Default 0 for infinite sessions
345 #define RTE_CRYPTODEV_DETACHED (0)
346 #define RTE_CRYPTODEV_ATTACHED (1)
348 /** Definitions of Crypto device event types */
349 enum rte_cryptodev_event_type {
350 RTE_CRYPTODEV_EVENT_UNKNOWN, /**< unknown event type */
351 RTE_CRYPTODEV_EVENT_ERROR, /**< error interrupt event */
352 RTE_CRYPTODEV_EVENT_MAX /**< max value of this enum */
355 /** Crypto device queue pair configuration structure. */
356 struct rte_cryptodev_qp_conf {
357 uint32_t nb_descriptors; /**< Number of descriptors per queue pair */
361 * Typedef for application callback function to be registered by application
362 * software for notification of device events
364 * @param dev_id Crypto device identifier
365 * @param event Crypto device event to register for notification of.
366 * @param cb_arg User specified parameter to be passed as to passed to
367 * users callback function.
369 typedef void (*rte_cryptodev_cb_fn)(uint8_t dev_id,
370 enum rte_cryptodev_event_type event, void *cb_arg);
373 /** Crypto Device statistics */
374 struct rte_cryptodev_stats {
375 uint64_t enqueued_count;
376 /**< Count of all operations enqueued */
377 uint64_t dequeued_count;
378 /**< Count of all operations dequeued */
380 uint64_t enqueue_err_count;
381 /**< Total error count on operations enqueued */
382 uint64_t dequeue_err_count;
383 /**< Total error count on operations dequeued */
386 #define RTE_CRYPTODEV_NAME_MAX_LEN (64)
387 /**< Max length of name of crypto PMD */
388 #define RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_QUEUE_PAIRS 8
389 #define RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_SESSIONS 2048
393 * Initialisation parameters for virtual crypto devices
395 struct rte_crypto_vdev_init_params {
396 unsigned max_nb_queue_pairs;
397 unsigned max_nb_sessions;
399 char name[RTE_CRYPTODEV_NAME_MAX_LEN];
403 * Parse virtual device initialisation parameters input arguments
406 * @params params Initialisation parameters with defaults set.
407 * @params input_args Command line arguments
410 * 0 on successful parse
411 * <0 on failure to parse
414 rte_cryptodev_parse_vdev_init_params(
415 struct rte_crypto_vdev_init_params *params,
416 const char *input_args);
419 * Create a virtual crypto device
421 * @param name Cryptodev PMD name of device to be created.
422 * @param args Options arguments for device.
425 * - On successful creation of the cryptodev the device index is returned,
426 * which will be between 0 and rte_cryptodev_count().
427 * - In the case of a failure, returns -1.
430 rte_cryptodev_create_vdev(const char *name, const char *args);
433 * Get the device identifier for the named crypto device.
435 * @param name device name to select the device structure.
438 * - Returns crypto device identifier on success.
439 * - Return -1 on failure to find named crypto device.
442 rte_cryptodev_get_dev_id(const char *name);
445 * Get the total number of crypto devices that have been successfully
449 * - The total number of usable crypto devices.
452 rte_cryptodev_count(void);
455 * Get number of crypto device defined type.
457 * @param type type of device.
460 * Returns number of crypto device.
463 rte_cryptodev_count_devtype(enum rte_cryptodev_type type);
466 * Get number and identifiers of attached crypto devices that
467 * use the same crypto driver.
469 * @param driver_name driver name.
470 * @param devices output devices identifiers.
471 * @param nb_devices maximal number of devices.
474 * Returns number of attached crypto device.
477 rte_cryptodev_devices_get(const char *driver_name, uint8_t *devices,
480 * Return the NUMA socket to which a device is connected
483 * The identifier of the device
485 * The NUMA socket id to which the device is connected or
486 * a default of zero if the socket could not be determined.
487 * -1 if returned is the dev_id value is out of range.
490 rte_cryptodev_socket_id(uint8_t dev_id);
492 /** Crypto device configuration structure */
493 struct rte_cryptodev_config {
494 int socket_id; /**< Socket to allocate resources on */
495 uint16_t nb_queue_pairs;
496 /**< Number of queue pairs to configure on device */
499 uint32_t nb_objs; /**< Number of objects in mempool */
500 uint32_t cache_size; /**< l-core object cache size */
501 } session_mp; /**< Session mempool configuration */
505 * Configure a device.
507 * This function must be invoked first before any other function in the
508 * API. This function can also be re-invoked when a device is in the
511 * @param dev_id The identifier of the device to configure.
512 * @param config The crypto device configuration structure.
515 * - 0: Success, device configured.
516 * - <0: Error code returned by the driver configuration function.
519 rte_cryptodev_configure(uint8_t dev_id, struct rte_cryptodev_config *config);
524 * The device start step is the last one and consists of setting the configured
525 * offload features and in starting the transmit and the receive units of the
527 * On success, all basic functions exported by the API (link status,
528 * receive/transmit, and so on) can be invoked.
531 * The identifier of the device.
533 * - 0: Success, device started.
534 * - <0: Error code of the driver device start function.
537 rte_cryptodev_start(uint8_t dev_id);
540 * Stop an device. The device can be restarted with a call to
541 * rte_cryptodev_start()
543 * @param dev_id The identifier of the device.
546 rte_cryptodev_stop(uint8_t dev_id);
549 * Close an device. The device cannot be restarted!
551 * @param dev_id The identifier of the device.
554 * - 0 on successfully closing device
555 * - <0 on failure to close device
558 rte_cryptodev_close(uint8_t dev_id);
561 * Allocate and set up a receive queue pair for a device.
564 * @param dev_id The identifier of the device.
565 * @param queue_pair_id The index of the queue pairs to set up. The
566 * value must be in the range [0, nb_queue_pair
567 * - 1] previously supplied to
568 * rte_cryptodev_configure().
569 * @param qp_conf The pointer to the configuration data to be
570 * used for the queue pair. NULL value is
571 * allowed, in which case default configuration
573 * @param socket_id The *socket_id* argument is the socket
574 * identifier in case of NUMA. The value can be
575 * *SOCKET_ID_ANY* if there is no NUMA constraint
576 * for the DMA memory allocated for the receive
580 * - 0: Success, queue pair correctly set up.
581 * - <0: Queue pair configuration failed
584 rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
585 const struct rte_cryptodev_qp_conf *qp_conf, int socket_id);
588 * Start a specified queue pair of a device. It is used
589 * when deferred_start flag of the specified queue is true.
591 * @param dev_id The identifier of the device
592 * @param queue_pair_id The index of the queue pair to start. The value
593 * must be in the range [0, nb_queue_pair - 1]
594 * previously supplied to
595 * rte_crypto_dev_configure().
597 * - 0: Success, the transmit queue is correctly set up.
598 * - -EINVAL: The dev_id or the queue_id out of range.
599 * - -ENOTSUP: The function not supported in PMD driver.
602 rte_cryptodev_queue_pair_start(uint8_t dev_id, uint16_t queue_pair_id);
605 * Stop specified queue pair of a device
607 * @param dev_id The identifier of the device
608 * @param queue_pair_id The index of the queue pair to stop. The value
609 * must be in the range [0, nb_queue_pair - 1]
610 * previously supplied to
611 * rte_cryptodev_configure().
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.
618 rte_cryptodev_queue_pair_stop(uint8_t dev_id, uint16_t queue_pair_id);
621 * Get the number of queue pairs on a specific crypto device
623 * @param dev_id Crypto device identifier.
625 * - The number of configured queue pairs.
628 rte_cryptodev_queue_pair_count(uint8_t dev_id);
632 * Retrieve the general I/O statistics of a device.
634 * @param dev_id The identifier of the device.
635 * @param stats A pointer to a structure of type
636 * *rte_cryptodev_stats* to be filled with the
637 * values of device counters.
639 * - Zero if successful.
640 * - Non-zero otherwise.
643 rte_cryptodev_stats_get(uint8_t dev_id, struct rte_cryptodev_stats *stats);
646 * Reset the general I/O statistics of a device.
648 * @param dev_id The identifier of the device.
651 rte_cryptodev_stats_reset(uint8_t dev_id);
654 * Retrieve the contextual information of a device.
656 * @param dev_id The identifier of the device.
657 * @param dev_info A pointer to a structure of type
658 * *rte_cryptodev_info* to be filled with the
659 * contextual information of the device.
662 rte_cryptodev_info_get(uint8_t dev_id, struct rte_cryptodev_info *dev_info);
666 * Register a callback function for specific device id.
668 * @param dev_id Device id.
669 * @param event Event interested.
670 * @param cb_fn User supplied callback function to be called.
671 * @param cb_arg Pointer to the parameters for the registered
675 * - On success, zero.
676 * - On failure, a negative value.
679 rte_cryptodev_callback_register(uint8_t dev_id,
680 enum rte_cryptodev_event_type event,
681 rte_cryptodev_cb_fn cb_fn, void *cb_arg);
684 * Unregister a callback function for specific device id.
686 * @param dev_id The device identifier.
687 * @param event Event interested.
688 * @param cb_fn User supplied callback function to be called.
689 * @param cb_arg Pointer to the parameters for the registered
693 * - On success, zero.
694 * - On failure, a negative value.
697 rte_cryptodev_callback_unregister(uint8_t dev_id,
698 enum rte_cryptodev_event_type event,
699 rte_cryptodev_cb_fn cb_fn, void *cb_arg);
702 typedef uint16_t (*dequeue_pkt_burst_t)(void *qp,
703 struct rte_crypto_op **ops, uint16_t nb_ops);
704 /**< Dequeue processed packets from queue pair of a device. */
706 typedef uint16_t (*enqueue_pkt_burst_t)(void *qp,
707 struct rte_crypto_op **ops, uint16_t nb_ops);
708 /**< Enqueue packets for processing on queue pair of a device. */
713 struct rte_cryptodev_callback;
715 /** Structure to keep track of registered callbacks */
716 TAILQ_HEAD(rte_cryptodev_cb_list, rte_cryptodev_callback);
718 /** The data structure associated with each crypto device. */
719 struct rte_cryptodev {
720 dequeue_pkt_burst_t dequeue_burst;
721 /**< Pointer to PMD receive function. */
722 enqueue_pkt_burst_t enqueue_burst;
723 /**< Pointer to PMD transmit function. */
725 const struct rte_cryptodev_driver *driver;
726 /**< Driver for this device */
727 struct rte_cryptodev_data *data;
728 /**< Pointer to device data */
729 struct rte_cryptodev_ops *dev_ops;
730 /**< Functions exported by PMD */
731 uint64_t feature_flags;
732 /**< Supported features */
733 struct rte_device *device;
734 /**< Backing device */
736 enum rte_cryptodev_type dev_type;
737 /**< Crypto device type */
739 struct rte_cryptodev_cb_list link_intr_cbs;
740 /**< User application callback for interrupts if present */
743 uint8_t attached : 1;
744 /**< Flag indicating the device is attached */
745 } __rte_cache_aligned;
749 * The data part, with no function pointers, associated with each device.
751 * This structure is safe to place in shared memory to be common among
752 * different processes in a multi-process configuration.
754 struct rte_cryptodev_data {
756 /**< Device ID for this instance */
758 /**< Socket ID where memory is allocated */
759 char name[RTE_CRYPTODEV_NAME_MAX_LEN];
760 /**< Unique identifier name */
763 uint8_t dev_started : 1;
764 /**< Device state: STARTED(1)/STOPPED(0) */
766 struct rte_mempool *session_pool;
767 /**< Session memory pool */
769 /**< Array of pointers to queue pairs. */
770 uint16_t nb_queue_pairs;
771 /**< Number of device queue pairs. */
774 /**< PMD-specific private data */
775 } __rte_cache_aligned;
777 extern struct rte_cryptodev *rte_cryptodevs;
780 * Dequeue a burst of processed crypto operations from a queue on the crypto
781 * device. The dequeued operation are stored in *rte_crypto_op* structures
782 * whose pointers are supplied in the *ops* array.
784 * The rte_cryptodev_dequeue_burst() function returns the number of ops
785 * actually dequeued, which is the number of *rte_crypto_op* data structures
786 * effectively supplied into the *ops* array.
788 * A return value equal to *nb_ops* indicates that the queue contained
789 * at least *nb_ops* operations, and this is likely to signify that other
790 * processed operations remain in the devices output queue. Applications
791 * implementing a "retrieve as many processed operations as possible" policy
792 * can check this specific case and keep invoking the
793 * rte_cryptodev_dequeue_burst() function until a value less than
794 * *nb_ops* is returned.
796 * The rte_cryptodev_dequeue_burst() function does not provide any error
797 * notification to avoid the corresponding overhead.
799 * @param dev_id The symmetric crypto device identifier
800 * @param qp_id The index of the queue pair from which to
801 * retrieve processed packets. The value must be
802 * in the range [0, nb_queue_pair - 1] previously
803 * supplied to rte_cryptodev_configure().
804 * @param ops The address of an array of pointers to
805 * *rte_crypto_op* structures that must be
806 * large enough to store *nb_ops* pointers in it.
807 * @param nb_ops The maximum number of operations to dequeue.
810 * - The number of operations actually dequeued, which is the number
811 * of pointers to *rte_crypto_op* structures effectively supplied to the
814 static inline uint16_t
815 rte_cryptodev_dequeue_burst(uint8_t dev_id, uint16_t qp_id,
816 struct rte_crypto_op **ops, uint16_t nb_ops)
818 struct rte_cryptodev *dev = &rte_cryptodevs[dev_id];
820 nb_ops = (*dev->dequeue_burst)
821 (dev->data->queue_pairs[qp_id], ops, nb_ops);
827 * Enqueue a burst of operations for processing on a crypto device.
829 * The rte_cryptodev_enqueue_burst() function is invoked to place
830 * crypto operations on the queue *qp_id* of the device designated by
833 * The *nb_ops* parameter is the number of operations to process which are
834 * supplied in the *ops* array of *rte_crypto_op* structures.
836 * The rte_cryptodev_enqueue_burst() function returns the number of
837 * operations it actually enqueued for processing. A return value equal to
838 * *nb_ops* means that all packets have been enqueued.
840 * @param dev_id The identifier of the device.
841 * @param qp_id The index of the queue pair which packets are
842 * to be enqueued for processing. The value
843 * must be in the range [0, nb_queue_pairs - 1]
844 * previously supplied to
845 * *rte_cryptodev_configure*.
846 * @param ops The address of an array of *nb_ops* pointers
847 * to *rte_crypto_op* structures which contain
848 * the crypto operations to be processed.
849 * @param nb_ops The number of operations to process.
852 * The number of operations actually enqueued on the crypto device. The return
853 * value can be less than the value of the *nb_ops* parameter when the
854 * crypto devices queue is full or if invalid parameters are specified in
857 static inline uint16_t
858 rte_cryptodev_enqueue_burst(uint8_t dev_id, uint16_t qp_id,
859 struct rte_crypto_op **ops, uint16_t nb_ops)
861 struct rte_cryptodev *dev = &rte_cryptodevs[dev_id];
863 return (*dev->enqueue_burst)(
864 dev->data->queue_pairs[qp_id], ops, nb_ops);
868 /** Cryptodev symmetric crypto session */
869 struct rte_cryptodev_sym_session {
874 enum rte_cryptodev_type dev_type;
875 /** Crypto Device type session created on */
876 struct rte_mempool *mp;
877 /**< Mempool session allocated from */
879 /**< Public symmetric session details */
881 __extension__ char _private[0];
882 /**< Private session material */
887 * Initialise a session for symmetric cryptographic operations.
889 * This function is used by the client to initialize immutable
890 * parameters of symmetric cryptographic operation.
891 * To perform the operation the rte_cryptodev_enqueue_burst function is
892 * used. Each mbuf should contain a reference to the session
893 * pointer returned from this function contained within it's crypto_op if a
894 * session-based operation is being provisioned. Memory to contain the session
895 * information is allocated from within mempool managed by the cryptodev.
897 * The rte_cryptodev_session_free must be called to free allocated
898 * memory when the session is no longer required.
900 * @param dev_id The device identifier.
901 * @param xform Crypto transform chain.
905 * Pointer to the created session or NULL
907 extern struct rte_cryptodev_sym_session *
908 rte_cryptodev_sym_session_create(uint8_t dev_id,
909 struct rte_crypto_sym_xform *xform);
912 * Free the memory associated with a previously allocated session.
914 * @param dev_id The device identifier.
915 * @param session Session pointer previously allocated by
916 * *rte_cryptodev_sym_session_create*.
919 * NULL on successful freeing of session.
920 * Session pointer on failure to free session.
922 extern struct rte_cryptodev_sym_session *
923 rte_cryptodev_sym_session_free(uint8_t dev_id,
924 struct rte_cryptodev_sym_session *session);
927 * Attach queue pair with sym session.
929 * @param qp_id Queue pair to which session will be attached.
930 * @param session Session pointer previously allocated by
931 * *rte_cryptodev_sym_session_create*.
934 * - On success, zero.
935 * - On failure, a negative value.
938 rte_cryptodev_queue_pair_attach_sym_session(uint16_t qp_id,
939 struct rte_cryptodev_sym_session *session);
942 * Detach queue pair with sym session.
944 * @param qp_id Queue pair to which session is attached.
945 * @param session Session pointer previously allocated by
946 * *rte_cryptodev_sym_session_create*.
949 * - On success, zero.
950 * - On failure, a negative value.
953 rte_cryptodev_queue_pair_detach_sym_session(uint16_t qp_id,
954 struct rte_cryptodev_sym_session *session);
961 #endif /* _RTE_CRYPTODEV_H_ */