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 */
147 * Asymmetric Xform Crypto Capability
150 struct rte_cryptodev_asymmetric_xform_capability {
151 enum rte_crypto_asym_xform_type xform_type;
152 /**< Transform type: RSA/MODEXP/DH/DSA/MODINV */
155 /**< bitmask for supported rte_crypto_asym_op_type */
159 struct rte_crypto_param_range modlen;
160 /**< Range of modulus length supported by modulus based xform.
161 * Value 0 mean implementation default
167 * Asymmetric Crypto Capability
170 struct rte_cryptodev_asymmetric_capability {
171 struct rte_cryptodev_asymmetric_xform_capability xform_capa;
175 /** Structure used to capture a capability of a crypto device */
176 struct rte_cryptodev_capabilities {
177 enum rte_crypto_op_type op;
178 /**< Operation type */
182 struct rte_cryptodev_symmetric_capability sym;
183 /**< Symmetric operation capability parameters */
184 struct rte_cryptodev_asymmetric_capability asym;
185 /**< Asymmetric operation capability parameters */
189 /** Structure used to describe crypto algorithms */
190 struct rte_cryptodev_sym_capability_idx {
191 enum rte_crypto_sym_xform_type type;
193 enum rte_crypto_cipher_algorithm cipher;
194 enum rte_crypto_auth_algorithm auth;
195 enum rte_crypto_aead_algorithm aead;
200 * Structure used to describe asymmetric crypto xforms
201 * Each xform maps to one asym algorithm.
204 struct rte_cryptodev_asym_capability_idx {
205 enum rte_crypto_asym_xform_type type;
206 /**< Asymmetric xform (algo) type */
210 * Provide capabilities available for defined device and algorithm
212 * @param dev_id The identifier of the device.
213 * @param idx Description of crypto algorithms.
216 * - Return description of the symmetric crypto capability if exist.
217 * - Return NULL if the capability not exist.
219 const struct rte_cryptodev_symmetric_capability *
220 rte_cryptodev_sym_capability_get(uint8_t dev_id,
221 const struct rte_cryptodev_sym_capability_idx *idx);
224 * Provide capabilities available for defined device and xform
226 * @param dev_id The identifier of the device.
227 * @param idx Description of asym crypto xform.
230 * - Return description of the asymmetric crypto capability if exist.
231 * - Return NULL if the capability not exist.
233 const struct rte_cryptodev_asymmetric_xform_capability * __rte_experimental
234 rte_cryptodev_asym_capability_get(uint8_t dev_id,
235 const struct rte_cryptodev_asym_capability_idx *idx);
238 * Check if key size and initial vector are supported
239 * in crypto cipher capability
241 * @param capability Description of the symmetric crypto capability.
242 * @param key_size Cipher key size.
243 * @param iv_size Cipher initial vector size.
246 * - Return 0 if the parameters are in range of the capability.
247 * - Return -1 if the parameters are out of range of the capability.
250 rte_cryptodev_sym_capability_check_cipher(
251 const struct rte_cryptodev_symmetric_capability *capability,
252 uint16_t key_size, uint16_t iv_size);
255 * Check if key size and initial vector are supported
256 * in crypto auth capability
258 * @param capability Description of the symmetric crypto capability.
259 * @param key_size Auth key size.
260 * @param digest_size Auth digest size.
261 * @param iv_size Auth initial vector size.
264 * - Return 0 if the parameters are in range of the capability.
265 * - Return -1 if the parameters are out of range of the capability.
268 rte_cryptodev_sym_capability_check_auth(
269 const struct rte_cryptodev_symmetric_capability *capability,
270 uint16_t key_size, uint16_t digest_size, uint16_t iv_size);
273 * Check if key, digest, AAD and initial vector sizes are supported
274 * in crypto AEAD capability
276 * @param capability Description of the symmetric crypto capability.
277 * @param key_size AEAD key size.
278 * @param digest_size AEAD digest size.
279 * @param aad_size AEAD AAD size.
280 * @param iv_size AEAD IV size.
283 * - Return 0 if the parameters are in range of the capability.
284 * - Return -1 if the parameters are out of range of the capability.
287 rte_cryptodev_sym_capability_check_aead(
288 const struct rte_cryptodev_symmetric_capability *capability,
289 uint16_t key_size, uint16_t digest_size, uint16_t aad_size,
293 * Check if op type is supported
295 * @param capability Description of the asymmetric crypto capability.
296 * @param op_type op type
299 * - Return 1 if the op type is supported
300 * - Return 0 if unsupported
302 int __rte_experimental
303 rte_cryptodev_asym_xform_capability_check_optype(
304 const struct rte_cryptodev_asymmetric_xform_capability *capability,
305 enum rte_crypto_asym_op_type op_type);
308 * Check if modulus length is in supported range
310 * @param capability Description of the asymmetric crypto capability.
311 * @param modlen modulus length.
314 * - Return 0 if the parameters are in range of the capability.
315 * - Return -1 if the parameters are out of range of the capability.
317 int __rte_experimental
318 rte_cryptodev_asym_xform_capability_check_modlen(
319 const struct rte_cryptodev_asymmetric_xform_capability *capability,
323 * Provide the cipher algorithm enum, given an algorithm string
325 * @param algo_enum A pointer to the cipher algorithm
327 * @param algo_string Authentication algo string
330 * - Return -1 if string is not valid
331 * - Return 0 is the string is valid
334 rte_cryptodev_get_cipher_algo_enum(enum rte_crypto_cipher_algorithm *algo_enum,
335 const char *algo_string);
338 * Provide the authentication algorithm enum, given an algorithm string
340 * @param algo_enum A pointer to the authentication algorithm
342 * @param algo_string Authentication algo string
345 * - Return -1 if string is not valid
346 * - Return 0 is the string is valid
349 rte_cryptodev_get_auth_algo_enum(enum rte_crypto_auth_algorithm *algo_enum,
350 const char *algo_string);
353 * Provide the AEAD algorithm enum, given an algorithm string
355 * @param algo_enum A pointer to the AEAD algorithm
357 * @param algo_string AEAD algorithm string
360 * - Return -1 if string is not valid
361 * - Return 0 is the string is valid
364 rte_cryptodev_get_aead_algo_enum(enum rte_crypto_aead_algorithm *algo_enum,
365 const char *algo_string);
368 * Provide the Asymmetric xform enum, given an xform string
370 * @param xform_enum A pointer to the xform type
372 * @param xform_string xform string
375 * - Return -1 if string is not valid
376 * - Return 0 if the string is valid
378 int __rte_experimental
379 rte_cryptodev_asym_get_xform_enum(enum rte_crypto_asym_xform_type *xform_enum,
380 const char *xform_string);
383 /** Macro used at end of crypto PMD list */
384 #define RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST() \
385 { RTE_CRYPTO_OP_TYPE_UNDEFINED }
389 * Crypto device supported feature flags
392 * New features flags should be added to the end of the list
394 * Keep these flags synchronised with rte_cryptodev_get_feature_name()
396 #define RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO (1ULL << 0)
397 /**< Symmetric crypto operations are supported */
398 #define RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO (1ULL << 1)
399 /**< Asymmetric crypto operations are supported */
400 #define RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING (1ULL << 2)
401 /**< Chaining symmetric crypto operations are supported */
402 #define RTE_CRYPTODEV_FF_CPU_SSE (1ULL << 3)
403 /**< Utilises CPU SIMD SSE instructions */
404 #define RTE_CRYPTODEV_FF_CPU_AVX (1ULL << 4)
405 /**< Utilises CPU SIMD AVX instructions */
406 #define RTE_CRYPTODEV_FF_CPU_AVX2 (1ULL << 5)
407 /**< Utilises CPU SIMD AVX2 instructions */
408 #define RTE_CRYPTODEV_FF_CPU_AESNI (1ULL << 6)
409 /**< Utilises CPU AES-NI instructions */
410 #define RTE_CRYPTODEV_FF_HW_ACCELERATED (1ULL << 7)
411 /**< Operations are off-loaded to an
412 * external hardware accelerator
414 #define RTE_CRYPTODEV_FF_CPU_AVX512 (1ULL << 8)
415 /**< Utilises CPU SIMD AVX512 instructions */
416 #define RTE_CRYPTODEV_FF_IN_PLACE_SGL (1ULL << 9)
417 /**< In-place Scatter-gather (SGL) buffers, with multiple segments,
420 #define RTE_CRYPTODEV_FF_OOP_SGL_IN_SGL_OUT (1ULL << 10)
421 /**< Out-of-place Scatter-gather (SGL) buffers are
422 * supported in input and output
424 #define RTE_CRYPTODEV_FF_OOP_SGL_IN_LB_OUT (1ULL << 11)
425 /**< Out-of-place Scatter-gather (SGL) buffers are supported
426 * in input, combined with linear buffers (LB), with a
427 * single segment in output
429 #define RTE_CRYPTODEV_FF_OOP_LB_IN_SGL_OUT (1ULL << 12)
430 /**< Out-of-place Scatter-gather (SGL) buffers are supported
431 * in output, combined with linear buffers (LB) in input
433 #define RTE_CRYPTODEV_FF_OOP_LB_IN_LB_OUT (1ULL << 13)
434 /**< Out-of-place linear buffers (LB) are supported in input and output */
435 #define RTE_CRYPTODEV_FF_CPU_NEON (1ULL << 14)
436 /**< Utilises CPU NEON instructions */
437 #define RTE_CRYPTODEV_FF_CPU_ARM_CE (1ULL << 15)
438 /**< Utilises ARM CPU Cryptographic Extensions */
439 #define RTE_CRYPTODEV_FF_SECURITY (1ULL << 16)
440 /**< Support Security Protocol Processing */
444 * Get the name of a crypto device feature flag
446 * @param flag The mask describing the flag.
449 * The name of this flag, or NULL if it's not a valid feature flag.
453 rte_cryptodev_get_feature_name(uint64_t flag);
455 /** Crypto device information */
456 struct rte_cryptodev_info {
457 const char *driver_name; /**< Driver name. */
458 uint8_t driver_id; /**< Driver identifier */
459 struct rte_device *device; /**< Generic device information. */
461 uint64_t feature_flags;
462 /**< Feature flags exposes HW/SW features for the given device */
464 const struct rte_cryptodev_capabilities *capabilities;
465 /**< Array of devices supported capabilities */
467 unsigned max_nb_queue_pairs;
468 /**< Maximum number of queues pairs supported by device. */
470 uint16_t min_mbuf_headroom_req;
471 /**< Minimum mbuf headroom required by device */
473 uint16_t min_mbuf_tailroom_req;
474 /**< Minimum mbuf tailroom required by device */
477 unsigned max_nb_sessions;
478 /**< Maximum number of sessions supported by device.
479 * If 0, the device does not have any limitation in
480 * number of sessions that can be used.
485 #define RTE_CRYPTODEV_DETACHED (0)
486 #define RTE_CRYPTODEV_ATTACHED (1)
488 /** Definitions of Crypto device event types */
489 enum rte_cryptodev_event_type {
490 RTE_CRYPTODEV_EVENT_UNKNOWN, /**< unknown event type */
491 RTE_CRYPTODEV_EVENT_ERROR, /**< error interrupt event */
492 RTE_CRYPTODEV_EVENT_MAX /**< max value of this enum */
495 /** Crypto device queue pair configuration structure. */
496 struct rte_cryptodev_qp_conf {
497 uint32_t nb_descriptors; /**< Number of descriptors per queue pair */
501 * Typedef for application callback function to be registered by application
502 * software for notification of device events
504 * @param dev_id Crypto device identifier
505 * @param event Crypto device event to register for notification of.
506 * @param cb_arg User specified parameter to be passed as to passed to
507 * users callback function.
509 typedef void (*rte_cryptodev_cb_fn)(uint8_t dev_id,
510 enum rte_cryptodev_event_type event, void *cb_arg);
513 /** Crypto Device statistics */
514 struct rte_cryptodev_stats {
515 uint64_t enqueued_count;
516 /**< Count of all operations enqueued */
517 uint64_t dequeued_count;
518 /**< Count of all operations dequeued */
520 uint64_t enqueue_err_count;
521 /**< Total error count on operations enqueued */
522 uint64_t dequeue_err_count;
523 /**< Total error count on operations dequeued */
526 #define RTE_CRYPTODEV_NAME_MAX_LEN (64)
527 /**< Max length of name of crypto PMD */
530 * Get the device identifier for the named crypto device.
532 * @param name device name to select the device structure.
535 * - Returns crypto device identifier on success.
536 * - Return -1 on failure to find named crypto device.
539 rte_cryptodev_get_dev_id(const char *name);
542 * Get the crypto device name given a device identifier.
545 * The identifier of the device
548 * - Returns crypto device name.
549 * - Returns NULL if crypto device is not present.
552 rte_cryptodev_name_get(uint8_t dev_id);
555 * Get the total number of crypto devices that have been successfully
559 * - The total number of usable crypto devices.
562 rte_cryptodev_count(void);
565 * Get number of crypto device defined type.
567 * @param driver_id driver identifier.
570 * Returns number of crypto device.
573 rte_cryptodev_device_count_by_driver(uint8_t driver_id);
576 * Get number and identifiers of attached crypto devices that
577 * use the same crypto driver.
579 * @param driver_name driver name.
580 * @param devices output devices identifiers.
581 * @param nb_devices maximal number of devices.
584 * Returns number of attached crypto device.
587 rte_cryptodev_devices_get(const char *driver_name, uint8_t *devices,
590 * Return the NUMA socket to which a device is connected
593 * The identifier of the device
595 * The NUMA socket id to which the device is connected or
596 * a default of zero if the socket could not be determined.
597 * -1 if returned is the dev_id value is out of range.
600 rte_cryptodev_socket_id(uint8_t dev_id);
602 /** Crypto device configuration structure */
603 struct rte_cryptodev_config {
604 int socket_id; /**< Socket to allocate resources on */
605 uint16_t nb_queue_pairs;
606 /**< Number of queue pairs to configure on device */
610 * Configure a device.
612 * This function must be invoked first before any other function in the
613 * API. This function can also be re-invoked when a device is in the
616 * @param dev_id The identifier of the device to configure.
617 * @param config The crypto device configuration structure.
620 * - 0: Success, device configured.
621 * - <0: Error code returned by the driver configuration function.
624 rte_cryptodev_configure(uint8_t dev_id, struct rte_cryptodev_config *config);
629 * The device start step is the last one and consists of setting the configured
630 * offload features and in starting the transmit and the receive units of the
632 * On success, all basic functions exported by the API (link status,
633 * receive/transmit, and so on) can be invoked.
636 * The identifier of the device.
638 * - 0: Success, device started.
639 * - <0: Error code of the driver device start function.
642 rte_cryptodev_start(uint8_t dev_id);
645 * Stop an device. The device can be restarted with a call to
646 * rte_cryptodev_start()
648 * @param dev_id The identifier of the device.
651 rte_cryptodev_stop(uint8_t dev_id);
654 * Close an device. The device cannot be restarted!
656 * @param dev_id The identifier of the device.
659 * - 0 on successfully closing device
660 * - <0 on failure to close device
663 rte_cryptodev_close(uint8_t dev_id);
666 * Allocate and set up a receive queue pair for a device.
669 * @param dev_id The identifier of the device.
670 * @param queue_pair_id The index of the queue pairs to set up. The
671 * value must be in the range [0, nb_queue_pair
672 * - 1] previously supplied to
673 * rte_cryptodev_configure().
674 * @param qp_conf The pointer to the configuration data to be
675 * used for the queue pair. NULL value is
676 * allowed, in which case default configuration
678 * @param socket_id The *socket_id* argument is the socket
679 * identifier in case of NUMA. The value can be
680 * *SOCKET_ID_ANY* if there is no NUMA constraint
681 * for the DMA memory allocated for the receive
683 * @param session_pool Pointer to device session mempool, used
684 * for session-less operations.
687 * - 0: Success, queue pair correctly set up.
688 * - <0: Queue pair configuration failed
691 rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
692 const struct rte_cryptodev_qp_conf *qp_conf, int socket_id,
693 struct rte_mempool *session_pool);
696 * Get the number of queue pairs on a specific crypto device
698 * @param dev_id Crypto device identifier.
700 * - The number of configured queue pairs.
703 rte_cryptodev_queue_pair_count(uint8_t dev_id);
707 * Retrieve the general I/O statistics of a device.
709 * @param dev_id The identifier of the device.
710 * @param stats A pointer to a structure of type
711 * *rte_cryptodev_stats* to be filled with the
712 * values of device counters.
714 * - Zero if successful.
715 * - Non-zero otherwise.
718 rte_cryptodev_stats_get(uint8_t dev_id, struct rte_cryptodev_stats *stats);
721 * Reset the general I/O statistics of a device.
723 * @param dev_id The identifier of the device.
726 rte_cryptodev_stats_reset(uint8_t dev_id);
729 * Retrieve the contextual information of a device.
731 * @param dev_id The identifier of the device.
732 * @param dev_info A pointer to a structure of type
733 * *rte_cryptodev_info* to be filled with the
734 * contextual information of the device.
736 * @note The capabilities field of dev_info is set to point to the first
737 * element of an array of struct rte_cryptodev_capabilities. The element after
738 * the last valid element has it's op field set to
739 * RTE_CRYPTO_OP_TYPE_UNDEFINED.
742 rte_cryptodev_info_get(uint8_t dev_id, struct rte_cryptodev_info *dev_info);
746 * Register a callback function for specific device id.
748 * @param dev_id Device id.
749 * @param event Event interested.
750 * @param cb_fn User supplied callback function to be called.
751 * @param cb_arg Pointer to the parameters for the registered
755 * - On success, zero.
756 * - On failure, a negative value.
759 rte_cryptodev_callback_register(uint8_t dev_id,
760 enum rte_cryptodev_event_type event,
761 rte_cryptodev_cb_fn cb_fn, void *cb_arg);
764 * Unregister a callback function for specific device id.
766 * @param dev_id The device identifier.
767 * @param event Event interested.
768 * @param cb_fn User supplied callback function to be called.
769 * @param cb_arg Pointer to the parameters for the registered
773 * - On success, zero.
774 * - On failure, a negative value.
777 rte_cryptodev_callback_unregister(uint8_t dev_id,
778 enum rte_cryptodev_event_type event,
779 rte_cryptodev_cb_fn cb_fn, void *cb_arg);
782 typedef uint16_t (*dequeue_pkt_burst_t)(void *qp,
783 struct rte_crypto_op **ops, uint16_t nb_ops);
784 /**< Dequeue processed packets from queue pair of a device. */
786 typedef uint16_t (*enqueue_pkt_burst_t)(void *qp,
787 struct rte_crypto_op **ops, uint16_t nb_ops);
788 /**< Enqueue packets for processing on queue pair of a device. */
793 struct rte_cryptodev_callback;
795 /** Structure to keep track of registered callbacks */
796 TAILQ_HEAD(rte_cryptodev_cb_list, rte_cryptodev_callback);
798 /** The data structure associated with each crypto device. */
799 struct rte_cryptodev {
800 dequeue_pkt_burst_t dequeue_burst;
801 /**< Pointer to PMD receive function. */
802 enqueue_pkt_burst_t enqueue_burst;
803 /**< Pointer to PMD transmit function. */
805 struct rte_cryptodev_data *data;
806 /**< Pointer to device data */
807 struct rte_cryptodev_ops *dev_ops;
808 /**< Functions exported by PMD */
809 uint64_t feature_flags;
810 /**< Feature flags exposes HW/SW features for the given device */
811 struct rte_device *device;
812 /**< Backing device */
815 /**< Crypto driver identifier*/
817 struct rte_cryptodev_cb_list link_intr_cbs;
818 /**< User application callback for interrupts if present */
821 /**< Context for security ops */
824 uint8_t attached : 1;
825 /**< Flag indicating the device is attached */
826 } __rte_cache_aligned;
829 rte_cryptodev_get_sec_ctx(uint8_t dev_id);
833 * The data part, with no function pointers, associated with each device.
835 * This structure is safe to place in shared memory to be common among
836 * different processes in a multi-process configuration.
838 struct rte_cryptodev_data {
840 /**< Device ID for this instance */
842 /**< Socket ID where memory is allocated */
843 char name[RTE_CRYPTODEV_NAME_MAX_LEN];
844 /**< Unique identifier name */
847 uint8_t dev_started : 1;
848 /**< Device state: STARTED(1)/STOPPED(0) */
850 struct rte_mempool *session_pool;
851 /**< Session memory pool */
853 /**< Array of pointers to queue pairs. */
854 uint16_t nb_queue_pairs;
855 /**< Number of device queue pairs. */
858 /**< PMD-specific private data */
859 } __rte_cache_aligned;
861 extern struct rte_cryptodev *rte_cryptodevs;
864 * Dequeue a burst of processed crypto operations from a queue on the crypto
865 * device. The dequeued operation are stored in *rte_crypto_op* structures
866 * whose pointers are supplied in the *ops* array.
868 * The rte_cryptodev_dequeue_burst() function returns the number of ops
869 * actually dequeued, which is the number of *rte_crypto_op* data structures
870 * effectively supplied into the *ops* array.
872 * A return value equal to *nb_ops* indicates that the queue contained
873 * at least *nb_ops* operations, and this is likely to signify that other
874 * processed operations remain in the devices output queue. Applications
875 * implementing a "retrieve as many processed operations as possible" policy
876 * can check this specific case and keep invoking the
877 * rte_cryptodev_dequeue_burst() function until a value less than
878 * *nb_ops* is returned.
880 * The rte_cryptodev_dequeue_burst() function does not provide any error
881 * notification to avoid the corresponding overhead.
883 * @param dev_id The symmetric crypto device identifier
884 * @param qp_id The index of the queue pair from which to
885 * retrieve processed packets. The value must be
886 * in the range [0, nb_queue_pair - 1] previously
887 * supplied to rte_cryptodev_configure().
888 * @param ops The address of an array of pointers to
889 * *rte_crypto_op* structures that must be
890 * large enough to store *nb_ops* pointers in it.
891 * @param nb_ops The maximum number of operations to dequeue.
894 * - The number of operations actually dequeued, which is the number
895 * of pointers to *rte_crypto_op* structures effectively supplied to the
898 static inline uint16_t
899 rte_cryptodev_dequeue_burst(uint8_t dev_id, uint16_t qp_id,
900 struct rte_crypto_op **ops, uint16_t nb_ops)
902 struct rte_cryptodev *dev = &rte_cryptodevs[dev_id];
904 nb_ops = (*dev->dequeue_burst)
905 (dev->data->queue_pairs[qp_id], ops, nb_ops);
911 * Enqueue a burst of operations for processing on a crypto device.
913 * The rte_cryptodev_enqueue_burst() function is invoked to place
914 * crypto operations on the queue *qp_id* of the device designated by
917 * The *nb_ops* parameter is the number of operations to process which are
918 * supplied in the *ops* array of *rte_crypto_op* structures.
920 * The rte_cryptodev_enqueue_burst() function returns the number of
921 * operations it actually enqueued for processing. A return value equal to
922 * *nb_ops* means that all packets have been enqueued.
924 * @param dev_id The identifier of the device.
925 * @param qp_id The index of the queue pair which packets are
926 * to be enqueued for processing. The value
927 * must be in the range [0, nb_queue_pairs - 1]
928 * previously supplied to
929 * *rte_cryptodev_configure*.
930 * @param ops The address of an array of *nb_ops* pointers
931 * to *rte_crypto_op* structures which contain
932 * the crypto operations to be processed.
933 * @param nb_ops The number of operations to process.
936 * The number of operations actually enqueued on the crypto device. The return
937 * value can be less than the value of the *nb_ops* parameter when the
938 * crypto devices queue is full or if invalid parameters are specified in
941 static inline uint16_t
942 rte_cryptodev_enqueue_burst(uint8_t dev_id, uint16_t qp_id,
943 struct rte_crypto_op **ops, uint16_t nb_ops)
945 struct rte_cryptodev *dev = &rte_cryptodevs[dev_id];
947 return (*dev->enqueue_burst)(
948 dev->data->queue_pairs[qp_id], ops, nb_ops);
952 /** Cryptodev symmetric crypto session
953 * Each session is derived from a fixed xform chain. Therefore each session
954 * has a fixed algo, key, op-type, digest_len etc.
956 struct rte_cryptodev_sym_session {
957 __extension__ void *sess_private_data[0];
958 /**< Private symmetric session material */
961 /** Cryptodev asymmetric crypto session */
962 struct rte_cryptodev_asym_session {
963 __extension__ void *sess_private_data[0];
964 /**< Private asymmetric session material */
968 * Create symmetric crypto session header (generic with no private data)
970 * @param mempool Symmetric session mempool to allocate session
973 * - On success return pointer to sym-session
974 * - On failure returns NULL
976 struct rte_cryptodev_sym_session *
977 rte_cryptodev_sym_session_create(struct rte_mempool *mempool);
980 * Create asymmetric crypto session header (generic with no private data)
982 * @param mempool mempool to allocate asymmetric session
985 * - On success return pointer to asym-session
986 * - On failure returns NULL
988 struct rte_cryptodev_asym_session * __rte_experimental
989 rte_cryptodev_asym_session_create(struct rte_mempool *mempool);
992 * Frees symmetric crypto session header, after checking that all
993 * the device private data has been freed, returning it
994 * to its original mempool.
996 * @param sess Session header to be freed.
1000 * - -EINVAL if session is NULL.
1001 * - -EBUSY if not all device private data has been freed.
1004 rte_cryptodev_sym_session_free(struct rte_cryptodev_sym_session *sess);
1007 * Frees asymmetric crypto session header, after checking that all
1008 * the device private data has been freed, returning it
1009 * to its original mempool.
1011 * @param sess Session header to be freed.
1014 * - 0 if successful.
1015 * - -EINVAL if session is NULL.
1016 * - -EBUSY if not all device private data has been freed.
1018 int __rte_experimental
1019 rte_cryptodev_asym_session_free(struct rte_cryptodev_asym_session *sess);
1022 * Fill out private data for the device id, based on its device type.
1024 * @param dev_id ID of device that we want the session to be used on
1025 * @param sess Session where the private data will be attached to
1026 * @param xforms Symmetric crypto transform operations to apply on flow
1027 * processed with this session
1028 * @param mempool Mempool where the private data is allocated.
1031 * - On success, zero.
1032 * - -EINVAL if input parameters are invalid.
1033 * - -ENOTSUP if crypto device does not support the crypto transform or
1034 * does not support symmetric operations.
1035 * - -ENOMEM if the private session could not be allocated.
1038 rte_cryptodev_sym_session_init(uint8_t dev_id,
1039 struct rte_cryptodev_sym_session *sess,
1040 struct rte_crypto_sym_xform *xforms,
1041 struct rte_mempool *mempool);
1044 * Initialize asymmetric session on a device with specific asymmetric xform
1046 * @param dev_id ID of device that we want the session to be used on
1047 * @param sess Session to be set up on a device
1048 * @param xforms Asymmetric crypto transform operations to apply on flow
1049 * processed with this session
1050 * @param mempool Mempool to be used for internal allocation.
1053 * - On success, zero.
1054 * - -EINVAL if input parameters are invalid.
1055 * - -ENOTSUP if crypto device does not support the crypto transform.
1056 * - -ENOMEM if the private session could not be allocated.
1058 int __rte_experimental
1059 rte_cryptodev_asym_session_init(uint8_t dev_id,
1060 struct rte_cryptodev_asym_session *sess,
1061 struct rte_crypto_asym_xform *xforms,
1062 struct rte_mempool *mempool);
1065 * Frees private data for the device id, based on its device type,
1066 * returning it to its mempool. It is the application's responsibility
1067 * to ensure that private session data is not cleared while there are
1068 * still in-flight operations using it.
1070 * @param dev_id ID of device that uses the session.
1071 * @param sess Session containing the reference to the private data
1074 * - 0 if successful.
1075 * - -EINVAL if device is invalid or session is NULL.
1076 * - -ENOTSUP if crypto device does not support symmetric operations.
1079 rte_cryptodev_sym_session_clear(uint8_t dev_id,
1080 struct rte_cryptodev_sym_session *sess);
1083 * Frees resources held by asymmetric session during rte_cryptodev_session_init
1085 * @param dev_id ID of device that uses the asymmetric session.
1086 * @param sess Asymmetric session setup on device using
1087 * rte_cryptodev_session_init
1089 * - 0 if successful.
1090 * - -EINVAL if device is invalid or session is NULL.
1092 int __rte_experimental
1093 rte_cryptodev_asym_session_clear(uint8_t dev_id,
1094 struct rte_cryptodev_asym_session *sess);
1097 * Get the size of the header session, for all registered drivers.
1100 * Size of the symmetric eader session.
1103 rte_cryptodev_sym_get_header_session_size(void);
1106 * Get the size of the asymmetric session header, for all registered drivers.
1109 * Size of the asymmetric header session.
1111 unsigned int __rte_experimental
1112 rte_cryptodev_asym_get_header_session_size(void);
1115 * Get the size of the private symmetric session data
1118 * @param dev_id The device identifier.
1121 * - Size of the private data, if successful
1122 * - 0 if device is invalid or does not have private
1126 rte_cryptodev_sym_get_private_session_size(uint8_t dev_id);
1129 * Get the size of the private data for asymmetric session
1132 * @param dev_id The device identifier.
1135 * - Size of the asymmetric private data, if successful
1136 * - 0 if device is invalid or does not have private session
1138 unsigned int __rte_experimental
1139 rte_cryptodev_asym_get_private_session_size(uint8_t dev_id);
1142 * Provide driver identifier.
1145 * The pointer to a driver name.
1147 * The driver type identifier or -1 if no driver found
1149 int rte_cryptodev_driver_id_get(const char *name);
1152 * Provide driver name.
1155 * The driver identifier.
1157 * The driver name or null if no driver found
1159 const char *rte_cryptodev_driver_name_get(uint8_t driver_id);
1162 * Store user data in a session.
1164 * @param sess Session pointer allocated by
1165 * *rte_cryptodev_sym_session_create*.
1166 * @param data Pointer to the user data.
1167 * @param size Size of the user data.
1170 * - On success, zero.
1171 * - On failure, a negative value.
1173 int __rte_experimental
1174 rte_cryptodev_sym_session_set_user_data(
1175 struct rte_cryptodev_sym_session *sess,
1180 * Get user data stored in a session.
1182 * @param sess Session pointer allocated by
1183 * *rte_cryptodev_sym_session_create*.
1186 * - On success return pointer to user data.
1187 * - On failure returns NULL.
1189 void * __rte_experimental
1190 rte_cryptodev_sym_session_get_user_data(
1191 struct rte_cryptodev_sym_session *sess);
1197 #endif /* _RTE_CRYPTODEV_H_ */