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>
54 extern const char **rte_cyptodev_names;
58 #define CDEV_LOG_ERR(...) \
59 RTE_LOG(ERR, CRYPTODEV, \
60 RTE_FMT("%s() line %u: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
61 __func__, __LINE__, RTE_FMT_TAIL(__VA_ARGS__,)))
63 #define CDEV_PMD_LOG_ERR(dev, ...) \
64 RTE_LOG(ERR, CRYPTODEV, \
65 RTE_FMT("[%s] %s() line %u: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
66 dev, __func__, __LINE__, RTE_FMT_TAIL(__VA_ARGS__,)))
68 #ifdef RTE_LIBRTE_CRYPTODEV_DEBUG
69 #define CDEV_LOG_DEBUG(...) \
70 RTE_LOG(DEBUG, CRYPTODEV, \
71 RTE_FMT("%s() line %u: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
72 __func__, __LINE__, RTE_FMT_TAIL(__VA_ARGS__,)))
74 #define CDEV_PMD_TRACE(...) \
75 RTE_LOG(DEBUG, CRYPTODEV, \
76 RTE_FMT("[%s] %s: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
77 dev, __func__, RTE_FMT_TAIL(__VA_ARGS__,)))
80 #define CDEV_LOG_DEBUG(...) (void)0
81 #define CDEV_PMD_TRACE(...) (void)0
87 * A macro that points to an offset from the start
88 * of the crypto operation structure (rte_crypto_op)
90 * The returned pointer is cast to type t.
93 * The crypto operation.
95 * The offset from the start of the crypto operation.
97 * The type to cast the result into.
99 #define rte_crypto_op_ctod_offset(c, t, o) \
100 ((t)((char *)(c) + (o)))
103 * A macro that returns the physical address that points
104 * to an offset from the start of the crypto operation
108 * The crypto operation.
110 * The offset from the start of the crypto operation
111 * to calculate address from.
113 #define rte_crypto_op_ctophys_offset(c, o) \
114 (phys_addr_t)((c)->phys_addr + (o))
117 * Crypto parameters range description
119 struct rte_crypto_param_range {
120 uint16_t min; /**< minimum size */
121 uint16_t max; /**< maximum size */
123 /**< if a range of sizes are supported,
124 * this parameter is used to indicate
125 * increments in byte size that are supported
126 * between the minimum and maximum
131 * Symmetric Crypto Capability
133 struct rte_cryptodev_symmetric_capability {
134 enum rte_crypto_sym_xform_type xform_type;
135 /**< Transform type : Authentication / Cipher / AEAD */
139 enum rte_crypto_auth_algorithm algo;
140 /**< authentication algorithm */
142 /**< algorithm block size */
143 struct rte_crypto_param_range key_size;
144 /**< auth key size range */
145 struct rte_crypto_param_range digest_size;
146 /**< digest size range */
147 struct rte_crypto_param_range aad_size;
148 /**< Additional authentication data size range */
149 struct rte_crypto_param_range iv_size;
150 /**< Initialisation vector 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 */
165 enum rte_crypto_aead_algorithm algo;
166 /**< AEAD algorithm */
168 /**< algorithm block size */
169 struct rte_crypto_param_range key_size;
170 /**< AEAD key size range */
171 struct rte_crypto_param_range digest_size;
172 /**< digest size range */
173 struct rte_crypto_param_range aad_size;
174 /**< Additional authentication data size range */
175 struct rte_crypto_param_range iv_size;
176 /**< Initialisation vector data size range */
181 /** Structure used to capture a capability of a crypto device */
182 struct rte_cryptodev_capabilities {
183 enum rte_crypto_op_type op;
184 /**< Operation type */
188 struct rte_cryptodev_symmetric_capability sym;
189 /**< Symmetric operation capability parameters */
193 /** Structure used to describe crypto algorithms */
194 struct rte_cryptodev_sym_capability_idx {
195 enum rte_crypto_sym_xform_type type;
197 enum rte_crypto_cipher_algorithm cipher;
198 enum rte_crypto_auth_algorithm auth;
199 enum rte_crypto_aead_algorithm aead;
204 * Provide capabilities available for defined device and algorithm
206 * @param dev_id The identifier of the device.
207 * @param idx Description of crypto algorithms.
210 * - Return description of the symmetric crypto capability if exist.
211 * - Return NULL if the capability not exist.
213 const struct rte_cryptodev_symmetric_capability *
214 rte_cryptodev_sym_capability_get(uint8_t dev_id,
215 const struct rte_cryptodev_sym_capability_idx *idx);
218 * Check if key size and initial vector are supported
219 * in crypto cipher capability
221 * @param capability Description of the symmetric crypto capability.
222 * @param key_size Cipher key size.
223 * @param iv_size Cipher initial vector size.
226 * - Return 0 if the parameters are in range of the capability.
227 * - Return -1 if the parameters are out of range of the capability.
230 rte_cryptodev_sym_capability_check_cipher(
231 const struct rte_cryptodev_symmetric_capability *capability,
232 uint16_t key_size, uint16_t iv_size);
235 * Check if key size and initial vector are supported
236 * in crypto auth capability
238 * @param capability Description of the symmetric crypto capability.
239 * @param key_size Auth key size.
240 * @param digest_size Auth digest size.
241 * @param iv_size Auth initial vector size.
244 * - Return 0 if the parameters are in range of the capability.
245 * - Return -1 if the parameters are out of range of the capability.
248 rte_cryptodev_sym_capability_check_auth(
249 const struct rte_cryptodev_symmetric_capability *capability,
250 uint16_t key_size, uint16_t digest_size, uint16_t iv_size);
253 * Check if key, digest, AAD and initial vector sizes are supported
254 * in crypto AEAD capability
256 * @param capability Description of the symmetric crypto capability.
257 * @param key_size AEAD key size.
258 * @param digest_size AEAD digest size.
259 * @param aad_size AEAD AAD size.
260 * @param iv_size AEAD IV size.
263 * - Return 0 if the parameters are in range of the capability.
264 * - Return -1 if the parameters are out of range of the capability.
267 rte_cryptodev_sym_capability_check_aead(
268 const struct rte_cryptodev_symmetric_capability *capability,
269 uint16_t key_size, uint16_t digest_size, uint16_t aad_size,
273 * Provide the cipher algorithm enum, given an algorithm string
275 * @param algo_enum A pointer to the cipher algorithm
277 * @param algo_string Authentication algo string
280 * - Return -1 if string is not valid
281 * - Return 0 is the string is valid
284 rte_cryptodev_get_cipher_algo_enum(enum rte_crypto_cipher_algorithm *algo_enum,
285 const char *algo_string);
288 * Provide the authentication algorithm enum, given an algorithm string
290 * @param algo_enum A pointer to the authentication algorithm
292 * @param algo_string Authentication algo string
295 * - Return -1 if string is not valid
296 * - Return 0 is the string is valid
299 rte_cryptodev_get_auth_algo_enum(enum rte_crypto_auth_algorithm *algo_enum,
300 const char *algo_string);
303 * Provide the AEAD algorithm enum, given an algorithm string
305 * @param algo_enum A pointer to the AEAD algorithm
307 * @param algo_string AEAD algorithm string
310 * - Return -1 if string is not valid
311 * - Return 0 is the string is valid
314 rte_cryptodev_get_aead_algo_enum(enum rte_crypto_aead_algorithm *algo_enum,
315 const char *algo_string);
317 /** Macro used at end of crypto PMD list */
318 #define RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST() \
319 { RTE_CRYPTO_OP_TYPE_UNDEFINED }
323 * Crypto device supported feature flags
326 * New features flags should be added to the end of the list
328 * Keep these flags synchronised with rte_cryptodev_get_feature_name()
330 #define RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO (1ULL << 0)
331 /**< Symmetric crypto operations are supported */
332 #define RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO (1ULL << 1)
333 /**< Asymmetric crypto operations are supported */
334 #define RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING (1ULL << 2)
335 /**< Chaining symmetric crypto operations are supported */
336 #define RTE_CRYPTODEV_FF_CPU_SSE (1ULL << 3)
337 /**< Utilises CPU SIMD SSE instructions */
338 #define RTE_CRYPTODEV_FF_CPU_AVX (1ULL << 4)
339 /**< Utilises CPU SIMD AVX instructions */
340 #define RTE_CRYPTODEV_FF_CPU_AVX2 (1ULL << 5)
341 /**< Utilises CPU SIMD AVX2 instructions */
342 #define RTE_CRYPTODEV_FF_CPU_AESNI (1ULL << 6)
343 /**< Utilises CPU AES-NI instructions */
344 #define RTE_CRYPTODEV_FF_HW_ACCELERATED (1ULL << 7)
345 /**< Operations are off-loaded to an external hardware accelerator */
346 #define RTE_CRYPTODEV_FF_CPU_AVX512 (1ULL << 8)
347 /**< Utilises CPU SIMD AVX512 instructions */
348 #define RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER (1ULL << 9)
349 /**< Scatter-gather mbufs are supported */
350 #define RTE_CRYPTODEV_FF_CPU_NEON (1ULL << 10)
351 /**< Utilises CPU NEON instructions */
352 #define RTE_CRYPTODEV_FF_CPU_ARM_CE (1ULL << 11)
353 /**< Utilises ARM CPU Cryptographic Extensions */
357 * Get the name of a crypto device feature flag
359 * @param flag The mask describing the flag.
362 * The name of this flag, or NULL if it's not a valid feature flag.
366 rte_cryptodev_get_feature_name(uint64_t flag);
368 /** Crypto device information */
369 struct rte_cryptodev_info {
370 const char *driver_name; /**< Driver name. */
371 uint8_t driver_id; /**< Driver identifier */
372 struct rte_pci_device *pci_dev; /**< PCI information. */
374 uint64_t feature_flags; /**< Feature flags */
376 const struct rte_cryptodev_capabilities *capabilities;
377 /**< Array of devices supported capabilities */
379 unsigned max_nb_queue_pairs;
380 /**< Maximum number of queues pairs supported by device. */
383 unsigned max_nb_sessions;
384 /**< Maximum number of sessions supported by device. */
385 unsigned int max_nb_sessions_per_qp;
386 /**< Maximum number of sessions per queue pair.
387 * Default 0 for infinite sessions
392 #define RTE_CRYPTODEV_DETACHED (0)
393 #define RTE_CRYPTODEV_ATTACHED (1)
395 /** Definitions of Crypto device event types */
396 enum rte_cryptodev_event_type {
397 RTE_CRYPTODEV_EVENT_UNKNOWN, /**< unknown event type */
398 RTE_CRYPTODEV_EVENT_ERROR, /**< error interrupt event */
399 RTE_CRYPTODEV_EVENT_MAX /**< max value of this enum */
402 /** Crypto device queue pair configuration structure. */
403 struct rte_cryptodev_qp_conf {
404 uint32_t nb_descriptors; /**< Number of descriptors per queue pair */
408 * Typedef for application callback function to be registered by application
409 * software for notification of device events
411 * @param dev_id Crypto device identifier
412 * @param event Crypto device event to register for notification of.
413 * @param cb_arg User specified parameter to be passed as to passed to
414 * users callback function.
416 typedef void (*rte_cryptodev_cb_fn)(uint8_t dev_id,
417 enum rte_cryptodev_event_type event, void *cb_arg);
420 /** Crypto Device statistics */
421 struct rte_cryptodev_stats {
422 uint64_t enqueued_count;
423 /**< Count of all operations enqueued */
424 uint64_t dequeued_count;
425 /**< Count of all operations dequeued */
427 uint64_t enqueue_err_count;
428 /**< Total error count on operations enqueued */
429 uint64_t dequeue_err_count;
430 /**< Total error count on operations dequeued */
433 #define RTE_CRYPTODEV_NAME_MAX_LEN (64)
434 /**< Max length of name of crypto PMD */
439 * Create a virtual crypto device
441 * @param name Cryptodev PMD name of device to be created.
442 * @param args Options arguments for device.
445 * - On successful creation of the cryptodev the device index is returned,
446 * which will be between 0 and rte_cryptodev_count().
447 * - In the case of a failure, returns -1.
451 rte_cryptodev_create_vdev(const char *name, const char *args);
454 * Get the device identifier for the named crypto device.
456 * @param name device name to select the device structure.
459 * - Returns crypto device identifier on success.
460 * - Return -1 on failure to find named crypto device.
463 rte_cryptodev_get_dev_id(const char *name);
466 * Get the total number of crypto devices that have been successfully
470 * - The total number of usable crypto devices.
473 rte_cryptodev_count(void);
476 * Get number of crypto device defined type.
478 * @param driver_id driver identifier.
481 * Returns number of crypto device.
484 rte_cryptodev_device_count_by_driver(uint8_t driver_id);
487 * Get number and identifiers of attached crypto devices that
488 * use the same crypto driver.
490 * @param driver_name driver name.
491 * @param devices output devices identifiers.
492 * @param nb_devices maximal number of devices.
495 * Returns number of attached crypto device.
498 rte_cryptodev_devices_get(const char *driver_name, uint8_t *devices,
501 * Return the NUMA socket to which a device is connected
504 * The identifier of the device
506 * The NUMA socket id to which the device is connected or
507 * a default of zero if the socket could not be determined.
508 * -1 if returned is the dev_id value is out of range.
511 rte_cryptodev_socket_id(uint8_t dev_id);
513 /** Crypto device configuration structure */
514 struct rte_cryptodev_config {
515 int socket_id; /**< Socket to allocate resources on */
516 uint16_t nb_queue_pairs;
517 /**< Number of queue pairs to configure on device */
521 * Configure a device.
523 * This function must be invoked first before any other function in the
524 * API. This function can also be re-invoked when a device is in the
527 * @param dev_id The identifier of the device to configure.
528 * @param config The crypto device configuration structure.
531 * - 0: Success, device configured.
532 * - <0: Error code returned by the driver configuration function.
535 rte_cryptodev_configure(uint8_t dev_id, struct rte_cryptodev_config *config);
540 * The device start step is the last one and consists of setting the configured
541 * offload features and in starting the transmit and the receive units of the
543 * On success, all basic functions exported by the API (link status,
544 * receive/transmit, and so on) can be invoked.
547 * The identifier of the device.
549 * - 0: Success, device started.
550 * - <0: Error code of the driver device start function.
553 rte_cryptodev_start(uint8_t dev_id);
556 * Stop an device. The device can be restarted with a call to
557 * rte_cryptodev_start()
559 * @param dev_id The identifier of the device.
562 rte_cryptodev_stop(uint8_t dev_id);
565 * Close an device. The device cannot be restarted!
567 * @param dev_id The identifier of the device.
570 * - 0 on successfully closing device
571 * - <0 on failure to close device
574 rte_cryptodev_close(uint8_t dev_id);
577 * Allocate and set up a receive queue pair for a device.
580 * @param dev_id The identifier of the device.
581 * @param queue_pair_id The index of the queue pairs to set up. The
582 * value must be in the range [0, nb_queue_pair
583 * - 1] previously supplied to
584 * rte_cryptodev_configure().
585 * @param qp_conf The pointer to the configuration data to be
586 * used for the queue pair. NULL value is
587 * allowed, in which case default configuration
589 * @param socket_id The *socket_id* argument is the socket
590 * identifier in case of NUMA. The value can be
591 * *SOCKET_ID_ANY* if there is no NUMA constraint
592 * for the DMA memory allocated for the receive
594 * @param session_pool Pointer to device session mempool, used
595 * for session-less operations.
598 * - 0: Success, queue pair correctly set up.
599 * - <0: Queue pair configuration failed
602 rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
603 const struct rte_cryptodev_qp_conf *qp_conf, int socket_id,
604 struct rte_mempool *session_pool);
607 * Start a specified queue pair of a device. It is used
608 * when deferred_start flag of the specified queue is true.
610 * @param dev_id The identifier of the device
611 * @param queue_pair_id The index of the queue pair to start. The value
612 * must be in the range [0, nb_queue_pair - 1]
613 * previously supplied to
614 * rte_crypto_dev_configure().
616 * - 0: Success, the transmit queue is correctly set up.
617 * - -EINVAL: The dev_id or the queue_id out of range.
618 * - -ENOTSUP: The function not supported in PMD driver.
621 rte_cryptodev_queue_pair_start(uint8_t dev_id, uint16_t queue_pair_id);
624 * Stop specified queue pair of a device
626 * @param dev_id The identifier of the device
627 * @param queue_pair_id The index of the queue pair to stop. The value
628 * must be in the range [0, nb_queue_pair - 1]
629 * previously supplied to
630 * rte_cryptodev_configure().
632 * - 0: Success, the transmit queue is correctly set up.
633 * - -EINVAL: The dev_id or the queue_id out of range.
634 * - -ENOTSUP: The function not supported in PMD driver.
637 rte_cryptodev_queue_pair_stop(uint8_t dev_id, uint16_t queue_pair_id);
640 * Get the number of queue pairs on a specific crypto device
642 * @param dev_id Crypto device identifier.
644 * - The number of configured queue pairs.
647 rte_cryptodev_queue_pair_count(uint8_t dev_id);
651 * Retrieve the general I/O statistics of a device.
653 * @param dev_id The identifier of the device.
654 * @param stats A pointer to a structure of type
655 * *rte_cryptodev_stats* to be filled with the
656 * values of device counters.
658 * - Zero if successful.
659 * - Non-zero otherwise.
662 rte_cryptodev_stats_get(uint8_t dev_id, struct rte_cryptodev_stats *stats);
665 * Reset the general I/O statistics of a device.
667 * @param dev_id The identifier of the device.
670 rte_cryptodev_stats_reset(uint8_t dev_id);
673 * Retrieve the contextual information of a device.
675 * @param dev_id The identifier of the device.
676 * @param dev_info A pointer to a structure of type
677 * *rte_cryptodev_info* to be filled with the
678 * contextual information of the device.
681 rte_cryptodev_info_get(uint8_t dev_id, struct rte_cryptodev_info *dev_info);
685 * Register a callback function for specific device id.
687 * @param dev_id Device id.
688 * @param event Event interested.
689 * @param cb_fn User supplied callback function to be called.
690 * @param cb_arg Pointer to the parameters for the registered
694 * - On success, zero.
695 * - On failure, a negative value.
698 rte_cryptodev_callback_register(uint8_t dev_id,
699 enum rte_cryptodev_event_type event,
700 rte_cryptodev_cb_fn cb_fn, void *cb_arg);
703 * Unregister a callback function for specific device id.
705 * @param dev_id The device identifier.
706 * @param event Event interested.
707 * @param cb_fn User supplied callback function to be called.
708 * @param cb_arg Pointer to the parameters for the registered
712 * - On success, zero.
713 * - On failure, a negative value.
716 rte_cryptodev_callback_unregister(uint8_t dev_id,
717 enum rte_cryptodev_event_type event,
718 rte_cryptodev_cb_fn cb_fn, void *cb_arg);
721 typedef uint16_t (*dequeue_pkt_burst_t)(void *qp,
722 struct rte_crypto_op **ops, uint16_t nb_ops);
723 /**< Dequeue processed packets from queue pair of a device. */
725 typedef uint16_t (*enqueue_pkt_burst_t)(void *qp,
726 struct rte_crypto_op **ops, uint16_t nb_ops);
727 /**< Enqueue packets for processing on queue pair of a device. */
732 struct rte_cryptodev_callback;
734 /** Structure to keep track of registered callbacks */
735 TAILQ_HEAD(rte_cryptodev_cb_list, rte_cryptodev_callback);
737 /** The data structure associated with each crypto device. */
738 struct rte_cryptodev {
739 dequeue_pkt_burst_t dequeue_burst;
740 /**< Pointer to PMD receive function. */
741 enqueue_pkt_burst_t enqueue_burst;
742 /**< Pointer to PMD transmit function. */
744 struct rte_cryptodev_data *data;
745 /**< Pointer to device data */
746 struct rte_cryptodev_ops *dev_ops;
747 /**< Functions exported by PMD */
748 uint64_t feature_flags;
749 /**< Supported features */
750 struct rte_device *device;
751 /**< Backing device */
754 /**< Crypto driver identifier*/
756 struct rte_cryptodev_cb_list link_intr_cbs;
757 /**< User application callback for interrupts if present */
760 uint8_t attached : 1;
761 /**< Flag indicating the device is attached */
762 } __rte_cache_aligned;
766 * The data part, with no function pointers, associated with each device.
768 * This structure is safe to place in shared memory to be common among
769 * different processes in a multi-process configuration.
771 struct rte_cryptodev_data {
773 /**< Device ID for this instance */
775 /**< Socket ID where memory is allocated */
776 char name[RTE_CRYPTODEV_NAME_MAX_LEN];
777 /**< Unique identifier name */
780 uint8_t dev_started : 1;
781 /**< Device state: STARTED(1)/STOPPED(0) */
783 struct rte_mempool *session_pool;
784 /**< Session memory pool */
786 /**< Array of pointers to queue pairs. */
787 uint16_t nb_queue_pairs;
788 /**< Number of device queue pairs. */
791 /**< PMD-specific private data */
792 } __rte_cache_aligned;
794 extern struct rte_cryptodev *rte_cryptodevs;
797 * Dequeue a burst of processed crypto operations from a queue on the crypto
798 * device. The dequeued operation are stored in *rte_crypto_op* structures
799 * whose pointers are supplied in the *ops* array.
801 * The rte_cryptodev_dequeue_burst() function returns the number of ops
802 * actually dequeued, which is the number of *rte_crypto_op* data structures
803 * effectively supplied into the *ops* array.
805 * A return value equal to *nb_ops* indicates that the queue contained
806 * at least *nb_ops* operations, and this is likely to signify that other
807 * processed operations remain in the devices output queue. Applications
808 * implementing a "retrieve as many processed operations as possible" policy
809 * can check this specific case and keep invoking the
810 * rte_cryptodev_dequeue_burst() function until a value less than
811 * *nb_ops* is returned.
813 * The rte_cryptodev_dequeue_burst() function does not provide any error
814 * notification to avoid the corresponding overhead.
816 * @param dev_id The symmetric crypto device identifier
817 * @param qp_id The index of the queue pair from which to
818 * retrieve processed packets. The value must be
819 * in the range [0, nb_queue_pair - 1] previously
820 * supplied to rte_cryptodev_configure().
821 * @param ops The address of an array of pointers to
822 * *rte_crypto_op* structures that must be
823 * large enough to store *nb_ops* pointers in it.
824 * @param nb_ops The maximum number of operations to dequeue.
827 * - The number of operations actually dequeued, which is the number
828 * of pointers to *rte_crypto_op* structures effectively supplied to the
831 static inline uint16_t
832 rte_cryptodev_dequeue_burst(uint8_t dev_id, uint16_t qp_id,
833 struct rte_crypto_op **ops, uint16_t nb_ops)
835 struct rte_cryptodev *dev = &rte_cryptodevs[dev_id];
837 nb_ops = (*dev->dequeue_burst)
838 (dev->data->queue_pairs[qp_id], ops, nb_ops);
844 * Enqueue a burst of operations for processing on a crypto device.
846 * The rte_cryptodev_enqueue_burst() function is invoked to place
847 * crypto operations on the queue *qp_id* of the device designated by
850 * The *nb_ops* parameter is the number of operations to process which are
851 * supplied in the *ops* array of *rte_crypto_op* structures.
853 * The rte_cryptodev_enqueue_burst() function returns the number of
854 * operations it actually enqueued for processing. A return value equal to
855 * *nb_ops* means that all packets have been enqueued.
857 * @param dev_id The identifier of the device.
858 * @param qp_id The index of the queue pair which packets are
859 * to be enqueued for processing. The value
860 * must be in the range [0, nb_queue_pairs - 1]
861 * previously supplied to
862 * *rte_cryptodev_configure*.
863 * @param ops The address of an array of *nb_ops* pointers
864 * to *rte_crypto_op* structures which contain
865 * the crypto operations to be processed.
866 * @param nb_ops The number of operations to process.
869 * The number of operations actually enqueued on the crypto device. The return
870 * value can be less than the value of the *nb_ops* parameter when the
871 * crypto devices queue is full or if invalid parameters are specified in
874 static inline uint16_t
875 rte_cryptodev_enqueue_burst(uint8_t dev_id, uint16_t qp_id,
876 struct rte_crypto_op **ops, uint16_t nb_ops)
878 struct rte_cryptodev *dev = &rte_cryptodevs[dev_id];
880 return (*dev->enqueue_burst)(
881 dev->data->queue_pairs[qp_id], ops, nb_ops);
885 /** Cryptodev symmetric crypto session */
886 struct rte_cryptodev_sym_session {
887 __extension__ void *sess_private_data[0];
888 /**< Private session material */
893 * Create symmetric crypto session header (generic with no private data)
895 * @param mempool Symmetric session mempool to allocate session
898 * - On success return pointer to sym-session
899 * - On failure returns NULL
901 struct rte_cryptodev_sym_session *
902 rte_cryptodev_sym_session_create(struct rte_mempool *mempool);
905 * Frees symmetric crypto session header, after checking that all
906 * the device private data has been freed, returning it
907 * to its original mempool.
909 * @param sess Session header to be freed.
913 * - -EINVAL if session is NULL.
914 * - -EBUSY if not all device private data has been freed.
917 rte_cryptodev_sym_session_free(struct rte_cryptodev_sym_session *sess);
920 * Fill out private data for the device id, based on its device type.
922 * @param dev_id ID of device that we want the session to be used on
923 * @param sess Session where the private data will be attached to
924 * @param xforms Symmetric crypto transform operations to apply on flow
925 * processed with this session
926 * @param mempool Mempool where the private data is allocated.
929 * - On success, zero.
930 * - -EINVAL if input parameters are invalid.
931 * - -ENOTSUP if crypto device does not support the crypto transform.
932 * - -ENOMEM if the private session could not be allocated.
935 rte_cryptodev_sym_session_init(uint8_t dev_id,
936 struct rte_cryptodev_sym_session *sess,
937 struct rte_crypto_sym_xform *xforms,
938 struct rte_mempool *mempool);
941 * Frees private data for the device id, based on its device type,
942 * returning it to its mempool.
944 * @param dev_id ID of device that uses the session.
945 * @param sess Session containing the reference to the private data
949 * - -EINVAL if device is invalid or session is NULL.
952 rte_cryptodev_sym_session_clear(uint8_t dev_id,
953 struct rte_cryptodev_sym_session *sess);
956 * Get the size of the header session, for all registered drivers.
959 * Size of the header session.
962 rte_cryptodev_get_header_session_size(void);
965 * Get the size of the private session data for a device.
967 * @param dev_id The device identifier.
970 * - Size of the private data, if successful
971 * - 0 if device is invalid or does not have private session
974 rte_cryptodev_get_private_session_size(uint8_t dev_id);
977 * Attach queue pair with sym session.
979 * @param dev_id Device to which the session will be attached.
980 * @param qp_id Queue pair to which the session will be attached.
981 * @param session Session pointer previously allocated by
982 * *rte_cryptodev_sym_session_create*.
985 * - On success, zero.
986 * - On failure, a negative value.
989 rte_cryptodev_queue_pair_attach_sym_session(uint8_t dev_id, uint16_t qp_id,
990 struct rte_cryptodev_sym_session *session);
993 * Detach queue pair with sym session.
995 * @param dev_id Device to which the session is attached.
996 * @param qp_id Queue pair to which the session is attached.
997 * @param session Session pointer previously allocated by
998 * *rte_cryptodev_sym_session_create*.
1001 * - On success, zero.
1002 * - On failure, a negative value.
1005 rte_cryptodev_queue_pair_detach_sym_session(uint8_t dev_id, uint16_t qp_id,
1006 struct rte_cryptodev_sym_session *session);
1009 * Provide driver identifier.
1012 * The pointer to a driver name.
1014 * The driver type identifier or -1 if no driver found
1016 int rte_cryptodev_driver_id_get(const char *name);
1019 * Provide driver name.
1022 * The driver identifier.
1024 * The driver name or null if no driver found
1026 const char *rte_cryptodev_driver_name_get(uint8_t driver_id);
1030 * Allocate Cryptodev driver.
1033 * Pointer to rte_driver.
1035 * The driver type identifier
1037 uint8_t rte_cryptodev_allocate_driver(const struct rte_driver *driver);
1040 #define RTE_PMD_REGISTER_CRYPTO_DRIVER(drv, driver_id)\
1041 RTE_INIT(init_ ##driver_id);\
1042 static void init_ ##driver_id(void)\
1044 driver_id = rte_cryptodev_allocate_driver(&(drv).driver);\
1052 #endif /* _RTE_CRYPTODEV_H_ */