1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2015-2017 Intel Corporation.
5 #ifndef _RTE_CRYPTODEV_H_
6 #define _RTE_CRYPTODEV_H_
9 * @file rte_cryptodev.h
11 * RTE Cryptographic Device APIs
13 * Defines RTE Crypto Device APIs for the provisioning of cipher and
14 * authentication operations.
21 #include "rte_kvargs.h"
22 #include "rte_crypto.h"
24 #include <rte_common.h>
25 #include <rte_config.h>
27 extern const char **rte_cyptodev_names;
31 #define CDEV_LOG_ERR(...) \
32 RTE_LOG(ERR, CRYPTODEV, \
33 RTE_FMT("%s() line %u: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
34 __func__, __LINE__, RTE_FMT_TAIL(__VA_ARGS__,)))
36 #define CDEV_LOG_INFO(...) \
37 RTE_LOG(INFO, CRYPTODEV, \
38 RTE_FMT(RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
39 RTE_FMT_TAIL(__VA_ARGS__,)))
41 #define CDEV_LOG_DEBUG(...) \
42 RTE_LOG(DEBUG, CRYPTODEV, \
43 RTE_FMT("%s() line %u: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
44 __func__, __LINE__, RTE_FMT_TAIL(__VA_ARGS__,)))
46 #define CDEV_PMD_TRACE(...) \
47 RTE_LOG(DEBUG, CRYPTODEV, \
48 RTE_FMT("[%s] %s: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
49 dev, __func__, RTE_FMT_TAIL(__VA_ARGS__,)))
52 * A macro that points to an offset from the start
53 * of the crypto operation structure (rte_crypto_op)
55 * The returned pointer is cast to type t.
58 * The crypto operation.
60 * The offset from the start of the crypto operation.
62 * The type to cast the result into.
64 #define rte_crypto_op_ctod_offset(c, t, o) \
65 ((t)((char *)(c) + (o)))
68 * A macro that returns the physical address that points
69 * to an offset from the start of the crypto operation
73 * The crypto operation.
75 * The offset from the start of the crypto operation
76 * to calculate address from.
78 #define rte_crypto_op_ctophys_offset(c, o) \
79 (rte_iova_t)((c)->phys_addr + (o))
82 * Crypto parameters range description
84 struct rte_crypto_param_range {
85 uint16_t min; /**< minimum size */
86 uint16_t max; /**< maximum size */
88 /**< if a range of sizes are supported,
89 * this parameter is used to indicate
90 * increments in byte size that are supported
91 * between the minimum and maximum
96 * Symmetric Crypto Capability
98 struct rte_cryptodev_symmetric_capability {
99 enum rte_crypto_sym_xform_type xform_type;
100 /**< Transform type : Authentication / Cipher / AEAD */
104 enum rte_crypto_auth_algorithm algo;
105 /**< authentication algorithm */
107 /**< algorithm block size */
108 struct rte_crypto_param_range key_size;
109 /**< auth key size range */
110 struct rte_crypto_param_range digest_size;
111 /**< digest size range */
112 struct rte_crypto_param_range aad_size;
113 /**< Additional authentication data size range */
114 struct rte_crypto_param_range iv_size;
115 /**< Initialisation vector data size range */
117 /**< Symmetric Authentication transform capabilities */
119 enum rte_crypto_cipher_algorithm algo;
120 /**< cipher algorithm */
122 /**< algorithm block size */
123 struct rte_crypto_param_range key_size;
124 /**< cipher key size range */
125 struct rte_crypto_param_range iv_size;
126 /**< Initialisation vector data size range */
128 /**< Symmetric Cipher transform capabilities */
130 enum rte_crypto_aead_algorithm algo;
131 /**< AEAD algorithm */
133 /**< algorithm block size */
134 struct rte_crypto_param_range key_size;
135 /**< AEAD key size range */
136 struct rte_crypto_param_range digest_size;
137 /**< digest size range */
138 struct rte_crypto_param_range aad_size;
139 /**< Additional authentication data size range */
140 struct rte_crypto_param_range iv_size;
141 /**< Initialisation vector data size range */
146 /** Structure used to capture a capability of a crypto device */
147 struct rte_cryptodev_capabilities {
148 enum rte_crypto_op_type op;
149 /**< Operation type */
153 struct rte_cryptodev_symmetric_capability sym;
154 /**< Symmetric operation capability parameters */
158 /** Structure used to describe crypto algorithms */
159 struct rte_cryptodev_sym_capability_idx {
160 enum rte_crypto_sym_xform_type type;
162 enum rte_crypto_cipher_algorithm cipher;
163 enum rte_crypto_auth_algorithm auth;
164 enum rte_crypto_aead_algorithm aead;
169 * Provide capabilities available for defined device and algorithm
171 * @param dev_id The identifier of the device.
172 * @param idx Description of crypto algorithms.
175 * - Return description of the symmetric crypto capability if exist.
176 * - Return NULL if the capability not exist.
178 const struct rte_cryptodev_symmetric_capability *
179 rte_cryptodev_sym_capability_get(uint8_t dev_id,
180 const struct rte_cryptodev_sym_capability_idx *idx);
183 * Check if key size and initial vector are supported
184 * in crypto cipher capability
186 * @param capability Description of the symmetric crypto capability.
187 * @param key_size Cipher key size.
188 * @param iv_size Cipher initial vector size.
191 * - Return 0 if the parameters are in range of the capability.
192 * - Return -1 if the parameters are out of range of the capability.
195 rte_cryptodev_sym_capability_check_cipher(
196 const struct rte_cryptodev_symmetric_capability *capability,
197 uint16_t key_size, uint16_t iv_size);
200 * Check if key size and initial vector are supported
201 * in crypto auth capability
203 * @param capability Description of the symmetric crypto capability.
204 * @param key_size Auth key size.
205 * @param digest_size Auth digest size.
206 * @param iv_size Auth initial vector size.
209 * - Return 0 if the parameters are in range of the capability.
210 * - Return -1 if the parameters are out of range of the capability.
213 rte_cryptodev_sym_capability_check_auth(
214 const struct rte_cryptodev_symmetric_capability *capability,
215 uint16_t key_size, uint16_t digest_size, uint16_t iv_size);
218 * Check if key, digest, AAD and initial vector sizes are supported
219 * in crypto AEAD capability
221 * @param capability Description of the symmetric crypto capability.
222 * @param key_size AEAD key size.
223 * @param digest_size AEAD digest size.
224 * @param aad_size AEAD AAD size.
225 * @param iv_size AEAD IV size.
228 * - Return 0 if the parameters are in range of the capability.
229 * - Return -1 if the parameters are out of range of the capability.
232 rte_cryptodev_sym_capability_check_aead(
233 const struct rte_cryptodev_symmetric_capability *capability,
234 uint16_t key_size, uint16_t digest_size, uint16_t aad_size,
238 * Provide the cipher algorithm enum, given an algorithm string
240 * @param algo_enum A pointer to the cipher algorithm
242 * @param algo_string Authentication algo string
245 * - Return -1 if string is not valid
246 * - Return 0 is the string is valid
249 rte_cryptodev_get_cipher_algo_enum(enum rte_crypto_cipher_algorithm *algo_enum,
250 const char *algo_string);
253 * Provide the authentication algorithm enum, given an algorithm string
255 * @param algo_enum A pointer to the authentication algorithm
257 * @param algo_string Authentication algo string
260 * - Return -1 if string is not valid
261 * - Return 0 is the string is valid
264 rte_cryptodev_get_auth_algo_enum(enum rte_crypto_auth_algorithm *algo_enum,
265 const char *algo_string);
268 * Provide the AEAD algorithm enum, given an algorithm string
270 * @param algo_enum A pointer to the AEAD algorithm
272 * @param algo_string AEAD algorithm string
275 * - Return -1 if string is not valid
276 * - Return 0 is the string is valid
279 rte_cryptodev_get_aead_algo_enum(enum rte_crypto_aead_algorithm *algo_enum,
280 const char *algo_string);
282 /** Macro used at end of crypto PMD list */
283 #define RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST() \
284 { RTE_CRYPTO_OP_TYPE_UNDEFINED }
288 * Crypto device supported feature flags
291 * New features flags should be added to the end of the list
293 * Keep these flags synchronised with rte_cryptodev_get_feature_name()
295 #define RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO (1ULL << 0)
296 /**< Symmetric crypto operations are supported */
297 #define RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO (1ULL << 1)
298 /**< Asymmetric crypto operations are supported */
299 #define RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING (1ULL << 2)
300 /**< Chaining symmetric crypto operations are supported */
301 #define RTE_CRYPTODEV_FF_CPU_SSE (1ULL << 3)
302 /**< Utilises CPU SIMD SSE instructions */
303 #define RTE_CRYPTODEV_FF_CPU_AVX (1ULL << 4)
304 /**< Utilises CPU SIMD AVX instructions */
305 #define RTE_CRYPTODEV_FF_CPU_AVX2 (1ULL << 5)
306 /**< Utilises CPU SIMD AVX2 instructions */
307 #define RTE_CRYPTODEV_FF_CPU_AESNI (1ULL << 6)
308 /**< Utilises CPU AES-NI instructions */
309 #define RTE_CRYPTODEV_FF_HW_ACCELERATED (1ULL << 7)
310 /**< Operations are off-loaded to an external hardware accelerator */
311 #define RTE_CRYPTODEV_FF_CPU_AVX512 (1ULL << 8)
312 /**< Utilises CPU SIMD AVX512 instructions */
313 #define RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER (1ULL << 9)
314 /**< Scatter-gather mbufs are supported */
315 #define RTE_CRYPTODEV_FF_CPU_NEON (1ULL << 10)
316 /**< Utilises CPU NEON instructions */
317 #define RTE_CRYPTODEV_FF_CPU_ARM_CE (1ULL << 11)
318 /**< Utilises ARM CPU Cryptographic Extensions */
319 #define RTE_CRYPTODEV_FF_SECURITY (1ULL << 12)
320 /**< Support Security Protocol Processing */
324 * Get the name of a crypto device feature flag
326 * @param flag The mask describing the flag.
329 * The name of this flag, or NULL if it's not a valid feature flag.
333 rte_cryptodev_get_feature_name(uint64_t flag);
335 /** Crypto device information */
336 struct rte_cryptodev_info {
337 const char *driver_name; /**< Driver name. */
338 uint8_t driver_id; /**< Driver identifier */
339 struct rte_device *device; /**< Generic device information. */
341 uint64_t feature_flags;
342 /**< Feature flags exposes HW/SW features for the given device */
344 const struct rte_cryptodev_capabilities *capabilities;
345 /**< Array of devices supported capabilities */
347 unsigned max_nb_queue_pairs;
348 /**< Maximum number of queues pairs supported by device. */
351 unsigned max_nb_sessions;
352 /**< Maximum number of sessions supported by device. */
356 #define RTE_CRYPTODEV_DETACHED (0)
357 #define RTE_CRYPTODEV_ATTACHED (1)
359 /** Definitions of Crypto device event types */
360 enum rte_cryptodev_event_type {
361 RTE_CRYPTODEV_EVENT_UNKNOWN, /**< unknown event type */
362 RTE_CRYPTODEV_EVENT_ERROR, /**< error interrupt event */
363 RTE_CRYPTODEV_EVENT_MAX /**< max value of this enum */
366 /** Crypto device queue pair configuration structure. */
367 struct rte_cryptodev_qp_conf {
368 uint32_t nb_descriptors; /**< Number of descriptors per queue pair */
372 * Typedef for application callback function to be registered by application
373 * software for notification of device events
375 * @param dev_id Crypto device identifier
376 * @param event Crypto device event to register for notification of.
377 * @param cb_arg User specified parameter to be passed as to passed to
378 * users callback function.
380 typedef void (*rte_cryptodev_cb_fn)(uint8_t dev_id,
381 enum rte_cryptodev_event_type event, void *cb_arg);
384 /** Crypto Device statistics */
385 struct rte_cryptodev_stats {
386 uint64_t enqueued_count;
387 /**< Count of all operations enqueued */
388 uint64_t dequeued_count;
389 /**< Count of all operations dequeued */
391 uint64_t enqueue_err_count;
392 /**< Total error count on operations enqueued */
393 uint64_t dequeue_err_count;
394 /**< Total error count on operations dequeued */
397 #define RTE_CRYPTODEV_NAME_MAX_LEN (64)
398 /**< Max length of name of crypto PMD */
401 * Get the device identifier for the named crypto device.
403 * @param name device name to select the device structure.
406 * - Returns crypto device identifier on success.
407 * - Return -1 on failure to find named crypto device.
410 rte_cryptodev_get_dev_id(const char *name);
413 * Get the crypto device name given a device identifier.
416 * The identifier of the device
419 * - Returns crypto device name.
420 * - Returns NULL if crypto device is not present.
423 rte_cryptodev_name_get(uint8_t dev_id);
426 * Get the total number of crypto devices that have been successfully
430 * - The total number of usable crypto devices.
433 rte_cryptodev_count(void);
436 * Get number of crypto device defined type.
438 * @param driver_id driver identifier.
441 * Returns number of crypto device.
444 rte_cryptodev_device_count_by_driver(uint8_t driver_id);
447 * Get number and identifiers of attached crypto devices that
448 * use the same crypto driver.
450 * @param driver_name driver name.
451 * @param devices output devices identifiers.
452 * @param nb_devices maximal number of devices.
455 * Returns number of attached crypto device.
458 rte_cryptodev_devices_get(const char *driver_name, uint8_t *devices,
461 * Return the NUMA socket to which a device is connected
464 * The identifier of the device
466 * The NUMA socket id to which the device is connected or
467 * a default of zero if the socket could not be determined.
468 * -1 if returned is the dev_id value is out of range.
471 rte_cryptodev_socket_id(uint8_t dev_id);
473 /** Crypto device configuration structure */
474 struct rte_cryptodev_config {
475 int socket_id; /**< Socket to allocate resources on */
476 uint16_t nb_queue_pairs;
477 /**< Number of queue pairs to configure on device */
481 * Configure a device.
483 * This function must be invoked first before any other function in the
484 * API. This function can also be re-invoked when a device is in the
487 * @param dev_id The identifier of the device to configure.
488 * @param config The crypto device configuration structure.
491 * - 0: Success, device configured.
492 * - <0: Error code returned by the driver configuration function.
495 rte_cryptodev_configure(uint8_t dev_id, struct rte_cryptodev_config *config);
500 * The device start step is the last one and consists of setting the configured
501 * offload features and in starting the transmit and the receive units of the
503 * On success, all basic functions exported by the API (link status,
504 * receive/transmit, and so on) can be invoked.
507 * The identifier of the device.
509 * - 0: Success, device started.
510 * - <0: Error code of the driver device start function.
513 rte_cryptodev_start(uint8_t dev_id);
516 * Stop an device. The device can be restarted with a call to
517 * rte_cryptodev_start()
519 * @param dev_id The identifier of the device.
522 rte_cryptodev_stop(uint8_t dev_id);
525 * Close an device. The device cannot be restarted!
527 * @param dev_id The identifier of the device.
530 * - 0 on successfully closing device
531 * - <0 on failure to close device
534 rte_cryptodev_close(uint8_t dev_id);
537 * Allocate and set up a receive queue pair for a device.
540 * @param dev_id The identifier of the device.
541 * @param queue_pair_id The index of the queue pairs to set up. The
542 * value must be in the range [0, nb_queue_pair
543 * - 1] previously supplied to
544 * rte_cryptodev_configure().
545 * @param qp_conf The pointer to the configuration data to be
546 * used for the queue pair. NULL value is
547 * allowed, in which case default configuration
549 * @param socket_id The *socket_id* argument is the socket
550 * identifier in case of NUMA. The value can be
551 * *SOCKET_ID_ANY* if there is no NUMA constraint
552 * for the DMA memory allocated for the receive
554 * @param session_pool Pointer to device session mempool, used
555 * for session-less operations.
558 * - 0: Success, queue pair correctly set up.
559 * - <0: Queue pair configuration failed
562 rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
563 const struct rte_cryptodev_qp_conf *qp_conf, int socket_id,
564 struct rte_mempool *session_pool);
568 * Start a specified queue pair of a device. It is used
569 * when deferred_start flag of the specified queue is true.
571 * @param dev_id The identifier of the device
572 * @param queue_pair_id The index of the queue pair to start. The value
573 * must be in the range [0, nb_queue_pair - 1]
574 * previously supplied to
575 * rte_crypto_dev_configure().
577 * - 0: Success, the transmit queue is correctly set up.
578 * - -EINVAL: The dev_id or the queue_id out of range.
579 * - -ENOTSUP: The function not supported in PMD driver.
583 rte_cryptodev_queue_pair_start(uint8_t dev_id, uint16_t queue_pair_id);
587 * Stop specified queue pair of a device
589 * @param dev_id The identifier of the device
590 * @param queue_pair_id The index of the queue pair to stop. The value
591 * must be in the range [0, nb_queue_pair - 1]
592 * previously supplied to
593 * rte_cryptodev_configure().
595 * - 0: Success, the transmit queue is correctly set up.
596 * - -EINVAL: The dev_id or the queue_id out of range.
597 * - -ENOTSUP: The function not supported in PMD driver.
601 rte_cryptodev_queue_pair_stop(uint8_t dev_id, uint16_t queue_pair_id);
604 * Get the number of queue pairs on a specific crypto device
606 * @param dev_id Crypto device identifier.
608 * - The number of configured queue pairs.
611 rte_cryptodev_queue_pair_count(uint8_t dev_id);
615 * Retrieve the general I/O statistics of a device.
617 * @param dev_id The identifier of the device.
618 * @param stats A pointer to a structure of type
619 * *rte_cryptodev_stats* to be filled with the
620 * values of device counters.
622 * - Zero if successful.
623 * - Non-zero otherwise.
626 rte_cryptodev_stats_get(uint8_t dev_id, struct rte_cryptodev_stats *stats);
629 * Reset the general I/O statistics of a device.
631 * @param dev_id The identifier of the device.
634 rte_cryptodev_stats_reset(uint8_t dev_id);
637 * Retrieve the contextual information of a device.
639 * @param dev_id The identifier of the device.
640 * @param dev_info A pointer to a structure of type
641 * *rte_cryptodev_info* to be filled with the
642 * contextual information of the device.
644 * @note The capabilities field of dev_info is set to point to the first
645 * element of an array of struct rte_cryptodev_capabilities. The element after
646 * the last valid element has it's op field set to
647 * RTE_CRYPTO_OP_TYPE_UNDEFINED.
650 rte_cryptodev_info_get(uint8_t dev_id, struct rte_cryptodev_info *dev_info);
654 * Register a callback function for specific device id.
656 * @param dev_id Device id.
657 * @param event Event interested.
658 * @param cb_fn User supplied callback function to be called.
659 * @param cb_arg Pointer to the parameters for the registered
663 * - On success, zero.
664 * - On failure, a negative value.
667 rte_cryptodev_callback_register(uint8_t dev_id,
668 enum rte_cryptodev_event_type event,
669 rte_cryptodev_cb_fn cb_fn, void *cb_arg);
672 * Unregister a callback function for specific device id.
674 * @param dev_id The device identifier.
675 * @param event Event interested.
676 * @param cb_fn User supplied callback function to be called.
677 * @param cb_arg Pointer to the parameters for the registered
681 * - On success, zero.
682 * - On failure, a negative value.
685 rte_cryptodev_callback_unregister(uint8_t dev_id,
686 enum rte_cryptodev_event_type event,
687 rte_cryptodev_cb_fn cb_fn, void *cb_arg);
690 typedef uint16_t (*dequeue_pkt_burst_t)(void *qp,
691 struct rte_crypto_op **ops, uint16_t nb_ops);
692 /**< Dequeue processed packets from queue pair of a device. */
694 typedef uint16_t (*enqueue_pkt_burst_t)(void *qp,
695 struct rte_crypto_op **ops, uint16_t nb_ops);
696 /**< Enqueue packets for processing on queue pair of a device. */
701 struct rte_cryptodev_callback;
703 /** Structure to keep track of registered callbacks */
704 TAILQ_HEAD(rte_cryptodev_cb_list, rte_cryptodev_callback);
706 /** The data structure associated with each crypto device. */
707 struct rte_cryptodev {
708 dequeue_pkt_burst_t dequeue_burst;
709 /**< Pointer to PMD receive function. */
710 enqueue_pkt_burst_t enqueue_burst;
711 /**< Pointer to PMD transmit function. */
713 struct rte_cryptodev_data *data;
714 /**< Pointer to device data */
715 struct rte_cryptodev_ops *dev_ops;
716 /**< Functions exported by PMD */
717 uint64_t feature_flags;
718 /**< Feature flags exposes HW/SW features for the given device */
719 struct rte_device *device;
720 /**< Backing device */
723 /**< Crypto driver identifier*/
725 struct rte_cryptodev_cb_list link_intr_cbs;
726 /**< User application callback for interrupts if present */
729 /**< Context for security ops */
732 uint8_t attached : 1;
733 /**< Flag indicating the device is attached */
734 } __rte_cache_aligned;
737 rte_cryptodev_get_sec_ctx(uint8_t dev_id);
741 * The data part, with no function pointers, associated with each device.
743 * This structure is safe to place in shared memory to be common among
744 * different processes in a multi-process configuration.
746 struct rte_cryptodev_data {
748 /**< Device ID for this instance */
750 /**< Socket ID where memory is allocated */
751 char name[RTE_CRYPTODEV_NAME_MAX_LEN];
752 /**< Unique identifier name */
755 uint8_t dev_started : 1;
756 /**< Device state: STARTED(1)/STOPPED(0) */
758 struct rte_mempool *session_pool;
759 /**< Session memory pool */
761 /**< Array of pointers to queue pairs. */
762 uint16_t nb_queue_pairs;
763 /**< Number of device queue pairs. */
766 /**< PMD-specific private data */
767 } __rte_cache_aligned;
769 extern struct rte_cryptodev *rte_cryptodevs;
772 * Dequeue a burst of processed crypto operations from a queue on the crypto
773 * device. The dequeued operation are stored in *rte_crypto_op* structures
774 * whose pointers are supplied in the *ops* array.
776 * The rte_cryptodev_dequeue_burst() function returns the number of ops
777 * actually dequeued, which is the number of *rte_crypto_op* data structures
778 * effectively supplied into the *ops* array.
780 * A return value equal to *nb_ops* indicates that the queue contained
781 * at least *nb_ops* operations, and this is likely to signify that other
782 * processed operations remain in the devices output queue. Applications
783 * implementing a "retrieve as many processed operations as possible" policy
784 * can check this specific case and keep invoking the
785 * rte_cryptodev_dequeue_burst() function until a value less than
786 * *nb_ops* is returned.
788 * The rte_cryptodev_dequeue_burst() function does not provide any error
789 * notification to avoid the corresponding overhead.
791 * @param dev_id The symmetric crypto device identifier
792 * @param qp_id The index of the queue pair from which to
793 * retrieve processed packets. The value must be
794 * in the range [0, nb_queue_pair - 1] previously
795 * supplied to rte_cryptodev_configure().
796 * @param ops The address of an array of pointers to
797 * *rte_crypto_op* structures that must be
798 * large enough to store *nb_ops* pointers in it.
799 * @param nb_ops The maximum number of operations to dequeue.
802 * - The number of operations actually dequeued, which is the number
803 * of pointers to *rte_crypto_op* structures effectively supplied to the
806 static inline uint16_t
807 rte_cryptodev_dequeue_burst(uint8_t dev_id, uint16_t qp_id,
808 struct rte_crypto_op **ops, uint16_t nb_ops)
810 struct rte_cryptodev *dev = &rte_cryptodevs[dev_id];
812 nb_ops = (*dev->dequeue_burst)
813 (dev->data->queue_pairs[qp_id], ops, nb_ops);
819 * Enqueue a burst of operations for processing on a crypto device.
821 * The rte_cryptodev_enqueue_burst() function is invoked to place
822 * crypto operations on the queue *qp_id* of the device designated by
825 * The *nb_ops* parameter is the number of operations to process which are
826 * supplied in the *ops* array of *rte_crypto_op* structures.
828 * The rte_cryptodev_enqueue_burst() function returns the number of
829 * operations it actually enqueued for processing. A return value equal to
830 * *nb_ops* means that all packets have been enqueued.
832 * @param dev_id The identifier of the device.
833 * @param qp_id The index of the queue pair which packets are
834 * to be enqueued for processing. The value
835 * must be in the range [0, nb_queue_pairs - 1]
836 * previously supplied to
837 * *rte_cryptodev_configure*.
838 * @param ops The address of an array of *nb_ops* pointers
839 * to *rte_crypto_op* structures which contain
840 * the crypto operations to be processed.
841 * @param nb_ops The number of operations to process.
844 * The number of operations actually enqueued on the crypto device. The return
845 * value can be less than the value of the *nb_ops* parameter when the
846 * crypto devices queue is full or if invalid parameters are specified in
849 static inline uint16_t
850 rte_cryptodev_enqueue_burst(uint8_t dev_id, uint16_t qp_id,
851 struct rte_crypto_op **ops, uint16_t nb_ops)
853 struct rte_cryptodev *dev = &rte_cryptodevs[dev_id];
855 return (*dev->enqueue_burst)(
856 dev->data->queue_pairs[qp_id], ops, nb_ops);
860 /** Cryptodev symmetric crypto session
861 * Each session is derived from a fixed xform chain. Therefore each session
862 * has a fixed algo, key, op-type, digest_len etc.
864 struct rte_cryptodev_sym_session {
865 __extension__ void *sess_private_data[0];
866 /**< Private session material */
871 * Create symmetric crypto session header (generic with no private data)
873 * @param mempool Symmetric session mempool to allocate session
876 * - On success return pointer to sym-session
877 * - On failure returns NULL
879 struct rte_cryptodev_sym_session *
880 rte_cryptodev_sym_session_create(struct rte_mempool *mempool);
883 * Frees symmetric crypto session header, after checking that all
884 * the device private data has been freed, returning it
885 * to its original mempool.
887 * @param sess Session header to be freed.
891 * - -EINVAL if session is NULL.
892 * - -EBUSY if not all device private data has been freed.
895 rte_cryptodev_sym_session_free(struct rte_cryptodev_sym_session *sess);
898 * Fill out private data for the device id, based on its device type.
900 * @param dev_id ID of device that we want the session to be used on
901 * @param sess Session where the private data will be attached to
902 * @param xforms Symmetric crypto transform operations to apply on flow
903 * processed with this session
904 * @param mempool Mempool where the private data is allocated.
907 * - On success, zero.
908 * - -EINVAL if input parameters are invalid.
909 * - -ENOTSUP if crypto device does not support the crypto transform.
910 * - -ENOMEM if the private session could not be allocated.
913 rte_cryptodev_sym_session_init(uint8_t dev_id,
914 struct rte_cryptodev_sym_session *sess,
915 struct rte_crypto_sym_xform *xforms,
916 struct rte_mempool *mempool);
919 * Frees private data for the device id, based on its device type,
920 * returning it to its mempool. It is the application's responsibility
921 * to ensure that private session data is not cleared while there are
922 * still in-flight operations using it.
924 * @param dev_id ID of device that uses the session.
925 * @param sess Session containing the reference to the private data
929 * - -EINVAL if device is invalid or session is NULL.
932 rte_cryptodev_sym_session_clear(uint8_t dev_id,
933 struct rte_cryptodev_sym_session *sess);
937 * Get the size of the header session, for all registered drivers.
940 * Size of the header session.
944 rte_cryptodev_get_header_session_size(void);
948 * Get the size of the private session data for a device.
950 * @param dev_id The device identifier.
953 * - Size of the private data, if successful
954 * - 0 if device is invalid or does not have private session
958 rte_cryptodev_get_private_session_size(uint8_t dev_id);
961 * Get the size of the header session, for all registered drivers.
964 * Size of the symmetric eader session.
967 rte_cryptodev_sym_get_header_session_size(void);
970 * Get the size of the private symmetric session data
973 * @param dev_id The device identifier.
976 * - Size of the private data, if successful
977 * - 0 if device is invalid or does not have private
981 rte_cryptodev_sym_get_private_session_size(uint8_t dev_id);
985 * Attach queue pair with sym session.
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*.
993 * - On success, zero.
994 * - On failure, a negative value.
998 rte_cryptodev_queue_pair_attach_sym_session(uint8_t dev_id, uint16_t qp_id,
999 struct rte_cryptodev_sym_session *session);
1003 * Detach queue pair with sym session.
1005 * @param dev_id Device to which the session is attached.
1006 * @param qp_id Queue pair to which the session is attached.
1007 * @param session Session pointer previously allocated by
1008 * *rte_cryptodev_sym_session_create*.
1011 * - On success, zero.
1012 * - On failure, a negative value.
1016 rte_cryptodev_queue_pair_detach_sym_session(uint8_t dev_id, uint16_t qp_id,
1017 struct rte_cryptodev_sym_session *session);
1020 * Provide driver identifier.
1023 * The pointer to a driver name.
1025 * The driver type identifier or -1 if no driver found
1027 int rte_cryptodev_driver_id_get(const char *name);
1030 * Provide driver name.
1033 * The driver identifier.
1035 * The driver name or null if no driver found
1037 const char *rte_cryptodev_driver_name_get(uint8_t driver_id);
1040 * Set private data for a session.
1042 * @param sess Session pointer allocated by
1043 * *rte_cryptodev_sym_session_create*.
1044 * @param data Pointer to the private data.
1045 * @param size Size of the private data.
1048 * - On success, zero.
1049 * - On failure, a negative value.
1051 int __rte_experimental
1052 rte_cryptodev_sym_session_set_private_data(
1053 struct rte_cryptodev_sym_session *sess,
1058 * Get private data of a session.
1060 * @param sess Session pointer allocated by
1061 * *rte_cryptodev_sym_session_create*.
1064 * - On success return pointer to private data.
1065 * - On failure returns NULL.
1067 void * __rte_experimental
1068 rte_cryptodev_sym_session_get_private_data(
1069 struct rte_cryptodev_sym_session *sess);
1075 #endif /* _RTE_CRYPTODEV_H_ */