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 */
498 struct rte_mempool *mp_session;
499 /**< The mempool for creating session in sessionless mode */
500 struct rte_mempool *mp_session_private;
501 /**< The mempool for creating sess private data in sessionless mode */
505 * Typedef for application callback function to be registered by application
506 * software for notification of device events
508 * @param dev_id Crypto device identifier
509 * @param event Crypto device event to register for notification of.
510 * @param cb_arg User specified parameter to be passed as to passed to
511 * users callback function.
513 typedef void (*rte_cryptodev_cb_fn)(uint8_t dev_id,
514 enum rte_cryptodev_event_type event, void *cb_arg);
517 /** Crypto Device statistics */
518 struct rte_cryptodev_stats {
519 uint64_t enqueued_count;
520 /**< Count of all operations enqueued */
521 uint64_t dequeued_count;
522 /**< Count of all operations dequeued */
524 uint64_t enqueue_err_count;
525 /**< Total error count on operations enqueued */
526 uint64_t dequeue_err_count;
527 /**< Total error count on operations dequeued */
530 #define RTE_CRYPTODEV_NAME_MAX_LEN (64)
531 /**< Max length of name of crypto PMD */
534 * Get the device identifier for the named crypto device.
536 * @param name device name to select the device structure.
539 * - Returns crypto device identifier on success.
540 * - Return -1 on failure to find named crypto device.
543 rte_cryptodev_get_dev_id(const char *name);
546 * Get the crypto device name given a device identifier.
549 * The identifier of the device
552 * - Returns crypto device name.
553 * - Returns NULL if crypto device is not present.
556 rte_cryptodev_name_get(uint8_t dev_id);
559 * Get the total number of crypto devices that have been successfully
563 * - The total number of usable crypto devices.
566 rte_cryptodev_count(void);
569 * Get number of crypto device defined type.
571 * @param driver_id driver identifier.
574 * Returns number of crypto device.
577 rte_cryptodev_device_count_by_driver(uint8_t driver_id);
580 * Get number and identifiers of attached crypto devices that
581 * use the same crypto driver.
583 * @param driver_name driver name.
584 * @param devices output devices identifiers.
585 * @param nb_devices maximal number of devices.
588 * Returns number of attached crypto device.
591 rte_cryptodev_devices_get(const char *driver_name, uint8_t *devices,
594 * Return the NUMA socket to which a device is connected
597 * The identifier of the device
599 * The NUMA socket id to which the device is connected or
600 * a default of zero if the socket could not be determined.
601 * -1 if returned is the dev_id value is out of range.
604 rte_cryptodev_socket_id(uint8_t dev_id);
606 /** Crypto device configuration structure */
607 struct rte_cryptodev_config {
608 int socket_id; /**< Socket to allocate resources on */
609 uint16_t nb_queue_pairs;
610 /**< Number of queue pairs to configure on device */
614 * Configure a device.
616 * This function must be invoked first before any other function in the
617 * API. This function can also be re-invoked when a device is in the
620 * @param dev_id The identifier of the device to configure.
621 * @param config The crypto device configuration structure.
624 * - 0: Success, device configured.
625 * - <0: Error code returned by the driver configuration function.
628 rte_cryptodev_configure(uint8_t dev_id, struct rte_cryptodev_config *config);
633 * The device start step is the last one and consists of setting the configured
634 * offload features and in starting the transmit and the receive units of the
636 * On success, all basic functions exported by the API (link status,
637 * receive/transmit, and so on) can be invoked.
640 * The identifier of the device.
642 * - 0: Success, device started.
643 * - <0: Error code of the driver device start function.
646 rte_cryptodev_start(uint8_t dev_id);
649 * Stop an device. The device can be restarted with a call to
650 * rte_cryptodev_start()
652 * @param dev_id The identifier of the device.
655 rte_cryptodev_stop(uint8_t dev_id);
658 * Close an device. The device cannot be restarted!
660 * @param dev_id The identifier of the device.
663 * - 0 on successfully closing device
664 * - <0 on failure to close device
667 rte_cryptodev_close(uint8_t dev_id);
670 * Allocate and set up a receive queue pair for a device.
673 * @param dev_id The identifier of the device.
674 * @param queue_pair_id The index of the queue pairs to set up. The
675 * value must be in the range [0, nb_queue_pair
676 * - 1] previously supplied to
677 * rte_cryptodev_configure().
678 * @param qp_conf The pointer to the configuration data to be
679 * used for the queue pair.
680 * @param socket_id The *socket_id* argument is the socket
681 * identifier in case of NUMA. The value can be
682 * *SOCKET_ID_ANY* if there is no NUMA constraint
683 * for the DMA memory allocated for the receive
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);
695 * Get the number of queue pairs on a specific crypto device
697 * @param dev_id Crypto device identifier.
699 * - The number of configured queue pairs.
702 rte_cryptodev_queue_pair_count(uint8_t dev_id);
706 * Retrieve the general I/O statistics of a device.
708 * @param dev_id The identifier of the device.
709 * @param stats A pointer to a structure of type
710 * *rte_cryptodev_stats* to be filled with the
711 * values of device counters.
713 * - Zero if successful.
714 * - Non-zero otherwise.
717 rte_cryptodev_stats_get(uint8_t dev_id, struct rte_cryptodev_stats *stats);
720 * Reset the general I/O statistics of a device.
722 * @param dev_id The identifier of the device.
725 rte_cryptodev_stats_reset(uint8_t dev_id);
728 * Retrieve the contextual information of a device.
730 * @param dev_id The identifier of the device.
731 * @param dev_info A pointer to a structure of type
732 * *rte_cryptodev_info* to be filled with the
733 * contextual information of the device.
735 * @note The capabilities field of dev_info is set to point to the first
736 * element of an array of struct rte_cryptodev_capabilities. The element after
737 * the last valid element has it's op field set to
738 * RTE_CRYPTO_OP_TYPE_UNDEFINED.
741 rte_cryptodev_info_get(uint8_t dev_id, struct rte_cryptodev_info *dev_info);
745 * Register a callback function for specific device id.
747 * @param dev_id Device id.
748 * @param event Event interested.
749 * @param cb_fn User supplied callback function to be called.
750 * @param cb_arg Pointer to the parameters for the registered
754 * - On success, zero.
755 * - On failure, a negative value.
758 rte_cryptodev_callback_register(uint8_t dev_id,
759 enum rte_cryptodev_event_type event,
760 rte_cryptodev_cb_fn cb_fn, void *cb_arg);
763 * Unregister a callback function for specific device id.
765 * @param dev_id The device identifier.
766 * @param event Event interested.
767 * @param cb_fn User supplied callback function to be called.
768 * @param cb_arg Pointer to the parameters for the registered
772 * - On success, zero.
773 * - On failure, a negative value.
776 rte_cryptodev_callback_unregister(uint8_t dev_id,
777 enum rte_cryptodev_event_type event,
778 rte_cryptodev_cb_fn cb_fn, void *cb_arg);
781 typedef uint16_t (*dequeue_pkt_burst_t)(void *qp,
782 struct rte_crypto_op **ops, uint16_t nb_ops);
783 /**< Dequeue processed packets from queue pair of a device. */
785 typedef uint16_t (*enqueue_pkt_burst_t)(void *qp,
786 struct rte_crypto_op **ops, uint16_t nb_ops);
787 /**< Enqueue packets for processing on queue pair of a device. */
792 struct rte_cryptodev_callback;
794 /** Structure to keep track of registered callbacks */
795 TAILQ_HEAD(rte_cryptodev_cb_list, rte_cryptodev_callback);
797 /** The data structure associated with each crypto device. */
798 struct rte_cryptodev {
799 dequeue_pkt_burst_t dequeue_burst;
800 /**< Pointer to PMD receive function. */
801 enqueue_pkt_burst_t enqueue_burst;
802 /**< Pointer to PMD transmit function. */
804 struct rte_cryptodev_data *data;
805 /**< Pointer to device data */
806 struct rte_cryptodev_ops *dev_ops;
807 /**< Functions exported by PMD */
808 uint64_t feature_flags;
809 /**< Feature flags exposes HW/SW features for the given device */
810 struct rte_device *device;
811 /**< Backing device */
814 /**< Crypto driver identifier*/
816 struct rte_cryptodev_cb_list link_intr_cbs;
817 /**< User application callback for interrupts if present */
820 /**< Context for security ops */
823 uint8_t attached : 1;
824 /**< Flag indicating the device is attached */
825 } __rte_cache_aligned;
828 rte_cryptodev_get_sec_ctx(uint8_t dev_id);
832 * The data part, with no function pointers, associated with each device.
834 * This structure is safe to place in shared memory to be common among
835 * different processes in a multi-process configuration.
837 struct rte_cryptodev_data {
839 /**< Device ID for this instance */
841 /**< Socket ID where memory is allocated */
842 char name[RTE_CRYPTODEV_NAME_MAX_LEN];
843 /**< Unique identifier name */
846 uint8_t dev_started : 1;
847 /**< Device state: STARTED(1)/STOPPED(0) */
849 struct rte_mempool *session_pool;
850 /**< Session memory pool */
852 /**< Array of pointers to queue pairs. */
853 uint16_t nb_queue_pairs;
854 /**< Number of device queue pairs. */
857 /**< PMD-specific private data */
858 } __rte_cache_aligned;
860 extern struct rte_cryptodev *rte_cryptodevs;
863 * Dequeue a burst of processed crypto operations from a queue on the crypto
864 * device. The dequeued operation are stored in *rte_crypto_op* structures
865 * whose pointers are supplied in the *ops* array.
867 * The rte_cryptodev_dequeue_burst() function returns the number of ops
868 * actually dequeued, which is the number of *rte_crypto_op* data structures
869 * effectively supplied into the *ops* array.
871 * A return value equal to *nb_ops* indicates that the queue contained
872 * at least *nb_ops* operations, and this is likely to signify that other
873 * processed operations remain in the devices output queue. Applications
874 * implementing a "retrieve as many processed operations as possible" policy
875 * can check this specific case and keep invoking the
876 * rte_cryptodev_dequeue_burst() function until a value less than
877 * *nb_ops* is returned.
879 * The rte_cryptodev_dequeue_burst() function does not provide any error
880 * notification to avoid the corresponding overhead.
882 * @param dev_id The symmetric crypto device identifier
883 * @param qp_id The index of the queue pair from which to
884 * retrieve processed packets. The value must be
885 * in the range [0, nb_queue_pair - 1] previously
886 * supplied to rte_cryptodev_configure().
887 * @param ops The address of an array of pointers to
888 * *rte_crypto_op* structures that must be
889 * large enough to store *nb_ops* pointers in it.
890 * @param nb_ops The maximum number of operations to dequeue.
893 * - The number of operations actually dequeued, which is the number
894 * of pointers to *rte_crypto_op* structures effectively supplied to the
897 static inline uint16_t
898 rte_cryptodev_dequeue_burst(uint8_t dev_id, uint16_t qp_id,
899 struct rte_crypto_op **ops, uint16_t nb_ops)
901 struct rte_cryptodev *dev = &rte_cryptodevs[dev_id];
903 nb_ops = (*dev->dequeue_burst)
904 (dev->data->queue_pairs[qp_id], ops, nb_ops);
910 * Enqueue a burst of operations for processing on a crypto device.
912 * The rte_cryptodev_enqueue_burst() function is invoked to place
913 * crypto operations on the queue *qp_id* of the device designated by
916 * The *nb_ops* parameter is the number of operations to process which are
917 * supplied in the *ops* array of *rte_crypto_op* structures.
919 * The rte_cryptodev_enqueue_burst() function returns the number of
920 * operations it actually enqueued for processing. A return value equal to
921 * *nb_ops* means that all packets have been enqueued.
923 * @param dev_id The identifier of the device.
924 * @param qp_id The index of the queue pair which packets are
925 * to be enqueued for processing. The value
926 * must be in the range [0, nb_queue_pairs - 1]
927 * previously supplied to
928 * *rte_cryptodev_configure*.
929 * @param ops The address of an array of *nb_ops* pointers
930 * to *rte_crypto_op* structures which contain
931 * the crypto operations to be processed.
932 * @param nb_ops The number of operations to process.
935 * The number of operations actually enqueued on the crypto device. The return
936 * value can be less than the value of the *nb_ops* parameter when the
937 * crypto devices queue is full or if invalid parameters are specified in
940 static inline uint16_t
941 rte_cryptodev_enqueue_burst(uint8_t dev_id, uint16_t qp_id,
942 struct rte_crypto_op **ops, uint16_t nb_ops)
944 struct rte_cryptodev *dev = &rte_cryptodevs[dev_id];
946 return (*dev->enqueue_burst)(
947 dev->data->queue_pairs[qp_id], ops, nb_ops);
951 /** Cryptodev symmetric crypto session
952 * Each session is derived from a fixed xform chain. Therefore each session
953 * has a fixed algo, key, op-type, digest_len etc.
955 struct rte_cryptodev_sym_session {
957 /**< number of elements in sess_data array */
958 __extension__ struct {
961 /**< Driver specific session material, variable size */
964 /** Cryptodev asymmetric crypto session */
965 struct rte_cryptodev_asym_session {
966 __extension__ void *sess_private_data[0];
967 /**< Private asymmetric session material */
971 * Create a symmetric session mempool.
974 * The unique mempool name.
976 * The number of elements in the mempool.
978 * The size of the element. This value will be ignored if it is smaller than
979 * the minimum session header size required for the system. For the user who
980 * want to use the same mempool for sym session and session private data it
981 * can be the maximum value of all existing devices' private data and session
984 * The number of per-lcore cache elements
986 * The private data size of each session.
988 * The *socket_id* argument is the socket identifier in the case of
989 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
990 * constraint for the reserved zone.
993 * - On success return size of the session
994 * - On failure returns 0
996 struct rte_mempool * __rte_experimental
997 rte_cryptodev_sym_session_pool_create(const char *name, uint32_t nb_elts,
998 uint32_t elt_size, uint32_t cache_size, uint16_t priv_size,
1002 * Create symmetric crypto session header (generic with no private data)
1004 * @param mempool Symmetric session mempool to allocate session
1007 * - On success return pointer to sym-session
1008 * - On failure returns NULL
1010 struct rte_cryptodev_sym_session *
1011 rte_cryptodev_sym_session_create(struct rte_mempool *mempool);
1014 * Create asymmetric crypto session header (generic with no private data)
1016 * @param mempool mempool to allocate asymmetric session
1019 * - On success return pointer to asym-session
1020 * - On failure returns NULL
1022 struct rte_cryptodev_asym_session * __rte_experimental
1023 rte_cryptodev_asym_session_create(struct rte_mempool *mempool);
1026 * Frees symmetric crypto session header, after checking that all
1027 * the device private data has been freed, returning it
1028 * to its original mempool.
1030 * @param sess Session header to be freed.
1033 * - 0 if successful.
1034 * - -EINVAL if session is NULL.
1035 * - -EBUSY if not all device private data has been freed.
1038 rte_cryptodev_sym_session_free(struct rte_cryptodev_sym_session *sess);
1041 * Frees asymmetric crypto session header, after checking that all
1042 * the device private data has been freed, returning it
1043 * to its original mempool.
1045 * @param sess Session header to be freed.
1048 * - 0 if successful.
1049 * - -EINVAL if session is NULL.
1050 * - -EBUSY if not all device private data has been freed.
1052 int __rte_experimental
1053 rte_cryptodev_asym_session_free(struct rte_cryptodev_asym_session *sess);
1056 * Fill out private data for the device id, based on its device type.
1058 * @param dev_id ID of device that we want the session to be used on
1059 * @param sess Session where the private data will be attached to
1060 * @param xforms Symmetric crypto transform operations to apply on flow
1061 * processed with this session
1062 * @param mempool Mempool where the private data is allocated.
1065 * - On success, zero.
1066 * - -EINVAL if input parameters are invalid.
1067 * - -ENOTSUP if crypto device does not support the crypto transform or
1068 * does not support symmetric operations.
1069 * - -ENOMEM if the private session could not be allocated.
1072 rte_cryptodev_sym_session_init(uint8_t dev_id,
1073 struct rte_cryptodev_sym_session *sess,
1074 struct rte_crypto_sym_xform *xforms,
1075 struct rte_mempool *mempool);
1078 * Initialize asymmetric session on a device with specific asymmetric xform
1080 * @param dev_id ID of device that we want the session to be used on
1081 * @param sess Session to be set up on a device
1082 * @param xforms Asymmetric crypto transform operations to apply on flow
1083 * processed with this session
1084 * @param mempool Mempool to be used for internal allocation.
1087 * - On success, zero.
1088 * - -EINVAL if input parameters are invalid.
1089 * - -ENOTSUP if crypto device does not support the crypto transform.
1090 * - -ENOMEM if the private session could not be allocated.
1092 int __rte_experimental
1093 rte_cryptodev_asym_session_init(uint8_t dev_id,
1094 struct rte_cryptodev_asym_session *sess,
1095 struct rte_crypto_asym_xform *xforms,
1096 struct rte_mempool *mempool);
1099 * Frees private data for the device id, based on its device type,
1100 * returning it to its mempool. It is the application's responsibility
1101 * to ensure that private session data is not cleared while there are
1102 * still in-flight operations using it.
1104 * @param dev_id ID of device that uses the session.
1105 * @param sess Session containing the reference to the private data
1108 * - 0 if successful.
1109 * - -EINVAL if device is invalid or session is NULL.
1110 * - -ENOTSUP if crypto device does not support symmetric operations.
1113 rte_cryptodev_sym_session_clear(uint8_t dev_id,
1114 struct rte_cryptodev_sym_session *sess);
1117 * Frees resources held by asymmetric session during rte_cryptodev_session_init
1119 * @param dev_id ID of device that uses the asymmetric session.
1120 * @param sess Asymmetric session setup on device using
1121 * rte_cryptodev_session_init
1123 * - 0 if successful.
1124 * - -EINVAL if device is invalid or session is NULL.
1126 int __rte_experimental
1127 rte_cryptodev_asym_session_clear(uint8_t dev_id,
1128 struct rte_cryptodev_asym_session *sess);
1131 * Get the size of the header session, for all registered drivers.
1134 * Size of the symmetric eader session.
1137 rte_cryptodev_sym_get_header_session_size(void);
1140 * Get the size of the header session from created session.
1143 * The sym cryptodev session pointer
1146 * - If sess is not NULL, return the size of the header session including
1147 * the private data size defined within sess.
1148 * - If sess is NULL, return 0.
1150 unsigned int __rte_experimental
1151 rte_cryptodev_sym_get_existing_header_session_size(
1152 struct rte_cryptodev_sym_session *sess);
1155 * Get the size of the asymmetric session header, for all registered drivers.
1158 * Size of the asymmetric header session.
1160 unsigned int __rte_experimental
1161 rte_cryptodev_asym_get_header_session_size(void);
1164 * Get the size of the private symmetric session data
1167 * @param dev_id The device identifier.
1170 * - Size of the private data, if successful
1171 * - 0 if device is invalid or does not have private
1175 rte_cryptodev_sym_get_private_session_size(uint8_t dev_id);
1178 * Get the size of the private data for asymmetric session
1181 * @param dev_id The device identifier.
1184 * - Size of the asymmetric private data, if successful
1185 * - 0 if device is invalid or does not have private session
1187 unsigned int __rte_experimental
1188 rte_cryptodev_asym_get_private_session_size(uint8_t dev_id);
1191 * Provide driver identifier.
1194 * The pointer to a driver name.
1196 * The driver type identifier or -1 if no driver found
1198 int rte_cryptodev_driver_id_get(const char *name);
1201 * Provide driver name.
1204 * The driver identifier.
1206 * The driver name or null if no driver found
1208 const char *rte_cryptodev_driver_name_get(uint8_t driver_id);
1211 * Store user data in a session.
1213 * @param sess Session pointer allocated by
1214 * *rte_cryptodev_sym_session_create*.
1215 * @param data Pointer to the user data.
1216 * @param size Size of the user data.
1219 * - On success, zero.
1220 * - On failure, a negative value.
1222 int __rte_experimental
1223 rte_cryptodev_sym_session_set_user_data(
1224 struct rte_cryptodev_sym_session *sess,
1229 * Get user data stored in a session.
1231 * @param sess Session pointer allocated by
1232 * *rte_cryptodev_sym_session_create*.
1235 * - On success return pointer to user data.
1236 * - On failure returns NULL.
1238 void * __rte_experimental
1239 rte_cryptodev_sym_session_get_user_data(
1240 struct rte_cryptodev_sym_session *sess);
1246 #endif /* _RTE_CRYPTODEV_H_ */