3 * Copyright(c) 2015-2017 Intel Corporation. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
9 * * Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * * Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in
13 * the documentation and/or other materials provided with the
15 * * Neither the name of Intel Corporation nor the names of its
16 * contributors may be used to endorse or promote products derived
17 * from this software without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 #ifndef _RTE_CRYPTODEV_H_
33 #define _RTE_CRYPTODEV_H_
36 * @file rte_cryptodev.h
38 * RTE Cryptographic Device APIs
40 * Defines RTE Crypto Device APIs for the provisioning of cipher and
41 * authentication operations.
48 #include "rte_kvargs.h"
49 #include "rte_crypto.h"
51 #include <rte_common.h>
53 #define CRYPTODEV_NAME_NULL_PMD crypto_null
54 /**< Null crypto PMD device name */
55 #define CRYPTODEV_NAME_AESNI_MB_PMD crypto_aesni_mb
56 /**< AES-NI Multi buffer PMD device name */
57 #define CRYPTODEV_NAME_AESNI_GCM_PMD crypto_aesni_gcm
58 /**< AES-NI GCM PMD device name */
59 #define CRYPTODEV_NAME_OPENSSL_PMD crypto_openssl
60 /**< Open SSL Crypto PMD device name */
61 #define CRYPTODEV_NAME_QAT_SYM_PMD crypto_qat
62 /**< Intel QAT Symmetric Crypto PMD device name */
63 #define CRYPTODEV_NAME_SNOW3G_PMD crypto_snow3g
64 /**< SNOW 3G PMD device name */
65 #define CRYPTODEV_NAME_KASUMI_PMD crypto_kasumi
66 /**< KASUMI PMD device name */
67 #define CRYPTODEV_NAME_ZUC_PMD crypto_zuc
68 /**< KASUMI PMD device name */
69 #define CRYPTODEV_NAME_ARMV8_PMD crypto_armv8
70 /**< ARMv8 Crypto PMD device name */
71 #define CRYPTODEV_NAME_SCHEDULER_PMD crypto_scheduler
72 /**< Scheduler Crypto PMD device name */
74 /** Crypto device type */
75 enum rte_cryptodev_type {
76 RTE_CRYPTODEV_NULL_PMD = 1, /**< Null crypto PMD */
77 RTE_CRYPTODEV_AESNI_GCM_PMD, /**< AES-NI GCM PMD */
78 RTE_CRYPTODEV_AESNI_MB_PMD, /**< AES-NI multi buffer PMD */
79 RTE_CRYPTODEV_QAT_SYM_PMD, /**< QAT PMD Symmetric Crypto */
80 RTE_CRYPTODEV_SNOW3G_PMD, /**< SNOW 3G PMD */
81 RTE_CRYPTODEV_KASUMI_PMD, /**< KASUMI PMD */
82 RTE_CRYPTODEV_ZUC_PMD, /**< ZUC PMD */
83 RTE_CRYPTODEV_OPENSSL_PMD, /**< OpenSSL PMD */
84 RTE_CRYPTODEV_ARMV8_PMD, /**< ARMv8 crypto PMD */
85 RTE_CRYPTODEV_SCHEDULER_PMD, /**< Crypto Scheduler PMD */
88 extern const char **rte_cyptodev_names;
92 #define CDEV_LOG_ERR(...) \
93 RTE_LOG(ERR, CRYPTODEV, \
94 RTE_FMT("%s() line %u: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
95 __func__, __LINE__, RTE_FMT_TAIL(__VA_ARGS__,)))
97 #define CDEV_PMD_LOG_ERR(dev, ...) \
98 RTE_LOG(ERR, CRYPTODEV, \
99 RTE_FMT("[%s] %s() line %u: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
100 dev, __func__, __LINE__, RTE_FMT_TAIL(__VA_ARGS__,)))
102 #ifdef RTE_LIBRTE_CRYPTODEV_DEBUG
103 #define CDEV_LOG_DEBUG(...) \
104 RTE_LOG(DEBUG, CRYPTODEV, \
105 RTE_FMT("%s() line %u: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
106 __func__, __LINE__, RTE_FMT_TAIL(__VA_ARGS__,)))
108 #define CDEV_PMD_TRACE(...) \
109 RTE_LOG(DEBUG, CRYPTODEV, \
110 RTE_FMT("[%s] %s: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
111 dev, __func__, RTE_FMT_TAIL(__VA_ARGS__,)))
114 #define CDEV_LOG_DEBUG(...) (void)0
115 #define CDEV_PMD_TRACE(...) (void)0
119 * Crypto parameters range description
121 struct rte_crypto_param_range {
122 uint16_t min; /**< minimum size */
123 uint16_t max; /**< maximum size */
125 /**< if a range of sizes are supported,
126 * this parameter is used to indicate
127 * increments in byte size that are supported
128 * between the minimum and maximum
133 * Symmetric Crypto Capability
135 struct rte_cryptodev_symmetric_capability {
136 enum rte_crypto_sym_xform_type xform_type;
137 /**< Transform type : Authentication / Cipher */
141 enum rte_crypto_auth_algorithm algo;
142 /**< authentication algorithm */
144 /**< algorithm block size */
145 struct rte_crypto_param_range key_size;
146 /**< auth key size range */
147 struct rte_crypto_param_range digest_size;
148 /**< digest size range */
149 struct rte_crypto_param_range aad_size;
150 /**< Additional authentication data size range */
152 /**< Symmetric Authentication transform capabilities */
154 enum rte_crypto_cipher_algorithm algo;
155 /**< cipher algorithm */
157 /**< algorithm block size */
158 struct rte_crypto_param_range key_size;
159 /**< cipher key size range */
160 struct rte_crypto_param_range iv_size;
161 /**< Initialisation vector data size range */
163 /**< Symmetric Cipher transform capabilities */
167 /** Structure used to capture a capability of a crypto device */
168 struct rte_cryptodev_capabilities {
169 enum rte_crypto_op_type op;
170 /**< Operation type */
174 struct rte_cryptodev_symmetric_capability sym;
175 /**< Symmetric operation capability parameters */
179 /** Structure used to describe crypto algorithms */
180 struct rte_cryptodev_sym_capability_idx {
181 enum rte_crypto_sym_xform_type type;
183 enum rte_crypto_cipher_algorithm cipher;
184 enum rte_crypto_auth_algorithm auth;
189 * Provide capabilities available for defined device and algorithm
191 * @param dev_id The identifier of the device.
192 * @param idx Description of crypto algorithms.
195 * - Return description of the symmetric crypto capability if exist.
196 * - Return NULL if the capability not exist.
198 const struct rte_cryptodev_symmetric_capability *
199 rte_cryptodev_sym_capability_get(uint8_t dev_id,
200 const struct rte_cryptodev_sym_capability_idx *idx);
203 * Check if key size and initial vector are supported
204 * in crypto cipher capability
206 * @param capability Description of the symmetric crypto capability.
207 * @param key_size Cipher key size.
208 * @param iv_size Cipher initial vector size.
211 * - Return 0 if the parameters are in range of the capability.
212 * - Return -1 if the parameters are out of range of the capability.
215 rte_cryptodev_sym_capability_check_cipher(
216 const struct rte_cryptodev_symmetric_capability *capability,
217 uint16_t key_size, uint16_t iv_size);
220 * Check if key size and initial vector are supported
221 * in crypto auth capability
223 * @param capability Description of the symmetric crypto capability.
224 * @param key_size Auth key size.
225 * @param digest_size Auth digest size.
226 * @param aad_size Auth aad size.
229 * - Return 0 if the parameters are in range of the capability.
230 * - Return -1 if the parameters are out of range of the capability.
233 rte_cryptodev_sym_capability_check_auth(
234 const struct rte_cryptodev_symmetric_capability *capability,
235 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);
267 /** Macro used at end of crypto PMD list */
268 #define RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST() \
269 { RTE_CRYPTO_OP_TYPE_UNDEFINED }
273 * Crypto device supported feature flags
276 * New features flags should be added to the end of the list
278 * Keep these flags synchronised with rte_cryptodev_get_feature_name()
280 #define RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO (1ULL << 0)
281 /**< Symmetric crypto operations are supported */
282 #define RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO (1ULL << 1)
283 /**< Asymmetric crypto operations are supported */
284 #define RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING (1ULL << 2)
285 /**< Chaining symmetric crypto operations are supported */
286 #define RTE_CRYPTODEV_FF_CPU_SSE (1ULL << 3)
287 /**< Utilises CPU SIMD SSE instructions */
288 #define RTE_CRYPTODEV_FF_CPU_AVX (1ULL << 4)
289 /**< Utilises CPU SIMD AVX instructions */
290 #define RTE_CRYPTODEV_FF_CPU_AVX2 (1ULL << 5)
291 /**< Utilises CPU SIMD AVX2 instructions */
292 #define RTE_CRYPTODEV_FF_CPU_AESNI (1ULL << 6)
293 /**< Utilises CPU AES-NI instructions */
294 #define RTE_CRYPTODEV_FF_HW_ACCELERATED (1ULL << 7)
295 /**< Operations are off-loaded to an external hardware accelerator */
296 #define RTE_CRYPTODEV_FF_CPU_AVX512 (1ULL << 8)
297 /**< Utilises CPU SIMD AVX512 instructions */
298 #define RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER (1ULL << 9)
299 /**< Scatter-gather mbufs are supported */
300 #define RTE_CRYPTODEV_FF_CPU_NEON (1ULL << 10)
301 /**< Utilises CPU NEON instructions */
302 #define RTE_CRYPTODEV_FF_CPU_ARM_CE (1ULL << 11)
303 /**< Utilises ARM CPU Cryptographic Extensions */
307 * Get the name of a crypto device feature flag
309 * @param flag The mask describing the flag.
312 * The name of this flag, or NULL if it's not a valid feature flag.
316 rte_cryptodev_get_feature_name(uint64_t flag);
318 /** Crypto device information */
319 struct rte_cryptodev_info {
320 const char *driver_name; /**< Driver name. */
321 enum rte_cryptodev_type dev_type; /**< Device type */
322 struct rte_pci_device *pci_dev; /**< PCI information. */
324 uint64_t feature_flags; /**< Feature flags */
326 const struct rte_cryptodev_capabilities *capabilities;
327 /**< Array of devices supported capabilities */
329 unsigned max_nb_queue_pairs;
330 /**< Maximum number of queues pairs supported by device. */
333 unsigned max_nb_sessions;
334 /**< Maximum number of sessions supported by device. */
338 #define RTE_CRYPTODEV_DETACHED (0)
339 #define RTE_CRYPTODEV_ATTACHED (1)
341 /** Definitions of Crypto device event types */
342 enum rte_cryptodev_event_type {
343 RTE_CRYPTODEV_EVENT_UNKNOWN, /**< unknown event type */
344 RTE_CRYPTODEV_EVENT_ERROR, /**< error interrupt event */
345 RTE_CRYPTODEV_EVENT_MAX /**< max value of this enum */
348 /** Crypto device queue pair configuration structure. */
349 struct rte_cryptodev_qp_conf {
350 uint32_t nb_descriptors; /**< Number of descriptors per queue pair */
354 * Typedef for application callback function to be registered by application
355 * software for notification of device events
357 * @param dev_id Crypto device identifier
358 * @param event Crypto device event to register for notification of.
359 * @param cb_arg User specified parameter to be passed as to passed to
360 * users callback function.
362 typedef void (*rte_cryptodev_cb_fn)(uint8_t dev_id,
363 enum rte_cryptodev_event_type event, void *cb_arg);
366 /** Crypto Device statistics */
367 struct rte_cryptodev_stats {
368 uint64_t enqueued_count;
369 /**< Count of all operations enqueued */
370 uint64_t dequeued_count;
371 /**< Count of all operations dequeued */
373 uint64_t enqueue_err_count;
374 /**< Total error count on operations enqueued */
375 uint64_t dequeue_err_count;
376 /**< Total error count on operations dequeued */
379 #define RTE_CRYPTODEV_NAME_MAX_LEN (64)
380 /**< Max length of name of crypto PMD */
381 #define RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_QUEUE_PAIRS 8
382 #define RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_SESSIONS 2048
386 * Initialisation parameters for virtual crypto devices
388 struct rte_crypto_vdev_init_params {
389 unsigned max_nb_queue_pairs;
390 unsigned max_nb_sessions;
392 char name[RTE_CRYPTODEV_NAME_MAX_LEN];
396 * Parse virtual device initialisation parameters input arguments
399 * @params params Initialisation parameters with defaults set.
400 * @params input_args Command line arguments
403 * 0 on successful parse
404 * <0 on failure to parse
407 rte_cryptodev_parse_vdev_init_params(
408 struct rte_crypto_vdev_init_params *params,
409 const char *input_args);
412 * Create a virtual crypto device
414 * @param name Cryptodev PMD name of device to be created.
415 * @param args Options arguments for device.
418 * - On successful creation of the cryptodev the device index is returned,
419 * which will be between 0 and rte_cryptodev_count().
420 * - In the case of a failure, returns -1.
423 rte_cryptodev_create_vdev(const char *name, const char *args);
426 * Get the device identifier for the named crypto device.
428 * @param name device name to select the device structure.
431 * - Returns crypto device identifier on success.
432 * - Return -1 on failure to find named crypto device.
435 rte_cryptodev_get_dev_id(const char *name);
438 * Get the total number of crypto devices that have been successfully
442 * - The total number of usable crypto devices.
445 rte_cryptodev_count(void);
448 * Get number of crypto device defined type.
450 * @param type type of device.
453 * Returns number of crypto device.
456 rte_cryptodev_count_devtype(enum rte_cryptodev_type type);
459 * Get number and identifiers of attached crypto device.
461 * @param dev_name device name.
462 * @param devices output devices identifiers.
463 * @param nb_devices maximal number of devices.
466 * Returns number of attached crypto device.
469 rte_cryptodev_devices_get(const char *dev_name, uint8_t *devices,
472 * Return the NUMA socket to which a device is connected
475 * The identifier of the device
477 * The NUMA socket id to which the device is connected or
478 * a default of zero if the socket could not be determined.
479 * -1 if returned is the dev_id value is out of range.
482 rte_cryptodev_socket_id(uint8_t dev_id);
484 /** Crypto device configuration structure */
485 struct rte_cryptodev_config {
486 int socket_id; /**< Socket to allocate resources on */
487 uint16_t nb_queue_pairs;
488 /**< Number of queue pairs to configure on device */
491 uint32_t nb_objs; /**< Number of objects in mempool */
492 uint32_t cache_size; /**< l-core object cache size */
493 } session_mp; /**< Session mempool configuration */
497 * Configure a device.
499 * This function must be invoked first before any other function in the
500 * API. This function can also be re-invoked when a device is in the
503 * @param dev_id The identifier of the device to configure.
504 * @param config The crypto device configuration structure.
507 * - 0: Success, device configured.
508 * - <0: Error code returned by the driver configuration function.
511 rte_cryptodev_configure(uint8_t dev_id, struct rte_cryptodev_config *config);
516 * The device start step is the last one and consists of setting the configured
517 * offload features and in starting the transmit and the receive units of the
519 * On success, all basic functions exported by the API (link status,
520 * receive/transmit, and so on) can be invoked.
523 * The identifier of the device.
525 * - 0: Success, device started.
526 * - <0: Error code of the driver device start function.
529 rte_cryptodev_start(uint8_t dev_id);
532 * Stop an device. The device can be restarted with a call to
533 * rte_cryptodev_start()
535 * @param dev_id The identifier of the device.
538 rte_cryptodev_stop(uint8_t dev_id);
541 * Close an device. The device cannot be restarted!
543 * @param dev_id The identifier of the device.
546 * - 0 on successfully closing device
547 * - <0 on failure to close device
550 rte_cryptodev_close(uint8_t dev_id);
553 * Allocate and set up a receive queue pair for a device.
556 * @param dev_id The identifier of the device.
557 * @param queue_pair_id The index of the queue pairs to set up. The
558 * value must be in the range [0, nb_queue_pair
559 * - 1] previously supplied to
560 * rte_cryptodev_configure().
561 * @param qp_conf The pointer to the configuration data to be
562 * used for the queue pair. NULL value is
563 * allowed, in which case default configuration
565 * @param socket_id The *socket_id* argument is the socket
566 * identifier in case of NUMA. The value can be
567 * *SOCKET_ID_ANY* if there is no NUMA constraint
568 * for the DMA memory allocated for the receive
572 * - 0: Success, queue pair correctly set up.
573 * - <0: Queue pair configuration failed
576 rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
577 const struct rte_cryptodev_qp_conf *qp_conf, int socket_id);
580 * Start a specified queue pair of a device. It is used
581 * when deferred_start flag of the specified queue is true.
583 * @param dev_id The identifier of the device
584 * @param queue_pair_id The index of the queue pair to start. The value
585 * must be in the range [0, nb_queue_pair - 1]
586 * previously supplied to
587 * rte_crypto_dev_configure().
589 * - 0: Success, the transmit queue is correctly set up.
590 * - -EINVAL: The dev_id or the queue_id out of range.
591 * - -ENOTSUP: The function not supported in PMD driver.
594 rte_cryptodev_queue_pair_start(uint8_t dev_id, uint16_t queue_pair_id);
597 * Stop specified queue pair of a device
599 * @param dev_id The identifier of the device
600 * @param queue_pair_id The index of the queue pair to stop. The value
601 * must be in the range [0, nb_queue_pair - 1]
602 * previously supplied to
603 * rte_cryptodev_configure().
605 * - 0: Success, the transmit queue is correctly set up.
606 * - -EINVAL: The dev_id or the queue_id out of range.
607 * - -ENOTSUP: The function not supported in PMD driver.
610 rte_cryptodev_queue_pair_stop(uint8_t dev_id, uint16_t queue_pair_id);
613 * Get the number of queue pairs on a specific crypto device
615 * @param dev_id Crypto device identifier.
617 * - The number of configured queue pairs.
620 rte_cryptodev_queue_pair_count(uint8_t dev_id);
624 * Retrieve the general I/O statistics of a device.
626 * @param dev_id The identifier of the device.
627 * @param stats A pointer to a structure of type
628 * *rte_cryptodev_stats* to be filled with the
629 * values of device counters.
631 * - Zero if successful.
632 * - Non-zero otherwise.
635 rte_cryptodev_stats_get(uint8_t dev_id, struct rte_cryptodev_stats *stats);
638 * Reset the general I/O statistics of a device.
640 * @param dev_id The identifier of the device.
643 rte_cryptodev_stats_reset(uint8_t dev_id);
646 * Retrieve the contextual information of a device.
648 * @param dev_id The identifier of the device.
649 * @param dev_info A pointer to a structure of type
650 * *rte_cryptodev_info* to be filled with the
651 * contextual information of the device.
654 rte_cryptodev_info_get(uint8_t dev_id, struct rte_cryptodev_info *dev_info);
658 * Register a callback function for specific device id.
660 * @param dev_id Device id.
661 * @param event Event interested.
662 * @param cb_fn User supplied callback function to be called.
663 * @param cb_arg Pointer to the parameters for the registered
667 * - On success, zero.
668 * - On failure, a negative value.
671 rte_cryptodev_callback_register(uint8_t dev_id,
672 enum rte_cryptodev_event_type event,
673 rte_cryptodev_cb_fn cb_fn, void *cb_arg);
676 * Unregister a callback function for specific device id.
678 * @param dev_id The device identifier.
679 * @param event Event interested.
680 * @param cb_fn User supplied callback function to be called.
681 * @param cb_arg Pointer to the parameters for the registered
685 * - On success, zero.
686 * - On failure, a negative value.
689 rte_cryptodev_callback_unregister(uint8_t dev_id,
690 enum rte_cryptodev_event_type event,
691 rte_cryptodev_cb_fn cb_fn, void *cb_arg);
694 typedef uint16_t (*dequeue_pkt_burst_t)(void *qp,
695 struct rte_crypto_op **ops, uint16_t nb_ops);
696 /**< Dequeue processed packets from queue pair of a device. */
698 typedef uint16_t (*enqueue_pkt_burst_t)(void *qp,
699 struct rte_crypto_op **ops, uint16_t nb_ops);
700 /**< Enqueue packets for processing on queue pair of a device. */
705 struct rte_cryptodev_callback;
707 /** Structure to keep track of registered callbacks */
708 TAILQ_HEAD(rte_cryptodev_cb_list, rte_cryptodev_callback);
710 /** The data structure associated with each crypto device. */
711 struct rte_cryptodev {
712 dequeue_pkt_burst_t dequeue_burst;
713 /**< Pointer to PMD receive function. */
714 enqueue_pkt_burst_t enqueue_burst;
715 /**< Pointer to PMD transmit function. */
717 const struct rte_cryptodev_driver *driver;
718 /**< Driver for this device */
719 struct rte_cryptodev_data *data;
720 /**< Pointer to device data */
721 struct rte_cryptodev_ops *dev_ops;
722 /**< Functions exported by PMD */
723 uint64_t feature_flags;
724 /**< Supported features */
725 struct rte_device *device;
726 /**< Backing device */
728 enum rte_cryptodev_type dev_type;
729 /**< Crypto device type */
731 struct rte_cryptodev_cb_list link_intr_cbs;
732 /**< User application callback for interrupts if present */
735 uint8_t attached : 1;
736 /**< Flag indicating the device is attached */
737 } __rte_cache_aligned;
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 struct rte_cryptodev_sym_session {
866 enum rte_cryptodev_type dev_type;
867 /** Crypto Device type session created on */
868 struct rte_mempool *mp;
869 /**< Mempool session allocated from */
871 /**< Public symmetric session details */
873 __extension__ char _private[0];
874 /**< Private session material */
879 * Initialise a session for symmetric cryptographic operations.
881 * This function is used by the client to initialize immutable
882 * parameters of symmetric cryptographic operation.
883 * To perform the operation the rte_cryptodev_enqueue_burst function is
884 * used. Each mbuf should contain a reference to the session
885 * pointer returned from this function contained within it's crypto_op if a
886 * session-based operation is being provisioned. Memory to contain the session
887 * information is allocated from within mempool managed by the cryptodev.
889 * The rte_cryptodev_session_free must be called to free allocated
890 * memory when the session is no longer required.
892 * @param dev_id The device identifier.
893 * @param xform Crypto transform chain.
897 * Pointer to the created session or NULL
899 extern struct rte_cryptodev_sym_session *
900 rte_cryptodev_sym_session_create(uint8_t dev_id,
901 struct rte_crypto_sym_xform *xform);
904 * Free the memory associated with a previously allocated session.
906 * @param dev_id The device identifier.
907 * @param session Session pointer previously allocated by
908 * *rte_cryptodev_sym_session_create*.
911 * NULL on successful freeing of session.
912 * Session pointer on failure to free session.
914 extern struct rte_cryptodev_sym_session *
915 rte_cryptodev_sym_session_free(uint8_t dev_id,
916 struct rte_cryptodev_sym_session *session);
923 #endif /* _RTE_CRYPTODEV_H_ */