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 aad_size Auth aad size.
242 * @param iv_size Auth initial vector size.
245 * - Return 0 if the parameters are in range of the capability.
246 * - Return -1 if the parameters are out of range of the capability.
249 rte_cryptodev_sym_capability_check_auth(
250 const struct rte_cryptodev_symmetric_capability *capability,
251 uint16_t key_size, uint16_t digest_size, uint16_t aad_size,
255 * Check if key, digest, AAD and initial vector sizes are supported
256 * in crypto AEAD capability
258 * @param capability Description of the symmetric crypto capability.
259 * @param key_size AEAD key size.
260 * @param digest_size AEAD digest size.
261 * @param aad_size AEAD AAD size.
262 * @param iv_size AEAD IV size.
265 * - Return 0 if the parameters are in range of the capability.
266 * - Return -1 if the parameters are out of range of the capability.
269 rte_cryptodev_sym_capability_check_aead(
270 const struct rte_cryptodev_symmetric_capability *capability,
271 uint16_t key_size, uint16_t digest_size, uint16_t aad_size,
275 * Provide the cipher algorithm enum, given an algorithm string
277 * @param algo_enum A pointer to the cipher algorithm
279 * @param algo_string Authentication algo string
282 * - Return -1 if string is not valid
283 * - Return 0 is the string is valid
286 rte_cryptodev_get_cipher_algo_enum(enum rte_crypto_cipher_algorithm *algo_enum,
287 const char *algo_string);
290 * Provide the authentication algorithm enum, given an algorithm string
292 * @param algo_enum A pointer to the authentication algorithm
294 * @param algo_string Authentication algo string
297 * - Return -1 if string is not valid
298 * - Return 0 is the string is valid
301 rte_cryptodev_get_auth_algo_enum(enum rte_crypto_auth_algorithm *algo_enum,
302 const char *algo_string);
305 * Provide the AEAD algorithm enum, given an algorithm string
307 * @param algo_enum A pointer to the AEAD algorithm
309 * @param algo_string AEAD algorithm string
312 * - Return -1 if string is not valid
313 * - Return 0 is the string is valid
316 rte_cryptodev_get_aead_algo_enum(enum rte_crypto_aead_algorithm *algo_enum,
317 const char *algo_string);
319 /** Macro used at end of crypto PMD list */
320 #define RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST() \
321 { RTE_CRYPTO_OP_TYPE_UNDEFINED }
325 * Crypto device supported feature flags
328 * New features flags should be added to the end of the list
330 * Keep these flags synchronised with rte_cryptodev_get_feature_name()
332 #define RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO (1ULL << 0)
333 /**< Symmetric crypto operations are supported */
334 #define RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO (1ULL << 1)
335 /**< Asymmetric crypto operations are supported */
336 #define RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING (1ULL << 2)
337 /**< Chaining symmetric crypto operations are supported */
338 #define RTE_CRYPTODEV_FF_CPU_SSE (1ULL << 3)
339 /**< Utilises CPU SIMD SSE instructions */
340 #define RTE_CRYPTODEV_FF_CPU_AVX (1ULL << 4)
341 /**< Utilises CPU SIMD AVX instructions */
342 #define RTE_CRYPTODEV_FF_CPU_AVX2 (1ULL << 5)
343 /**< Utilises CPU SIMD AVX2 instructions */
344 #define RTE_CRYPTODEV_FF_CPU_AESNI (1ULL << 6)
345 /**< Utilises CPU AES-NI instructions */
346 #define RTE_CRYPTODEV_FF_HW_ACCELERATED (1ULL << 7)
347 /**< Operations are off-loaded to an external hardware accelerator */
348 #define RTE_CRYPTODEV_FF_CPU_AVX512 (1ULL << 8)
349 /**< Utilises CPU SIMD AVX512 instructions */
350 #define RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER (1ULL << 9)
351 /**< Scatter-gather mbufs are supported */
352 #define RTE_CRYPTODEV_FF_CPU_NEON (1ULL << 10)
353 /**< Utilises CPU NEON instructions */
354 #define RTE_CRYPTODEV_FF_CPU_ARM_CE (1ULL << 11)
355 /**< Utilises ARM CPU Cryptographic Extensions */
359 * Get the name of a crypto device feature flag
361 * @param flag The mask describing the flag.
364 * The name of this flag, or NULL if it's not a valid feature flag.
368 rte_cryptodev_get_feature_name(uint64_t flag);
370 /** Crypto device information */
371 struct rte_cryptodev_info {
372 const char *driver_name; /**< Driver name. */
373 uint8_t driver_id; /**< Driver identifier */
374 struct rte_pci_device *pci_dev; /**< PCI information. */
376 uint64_t feature_flags; /**< Feature flags */
378 const struct rte_cryptodev_capabilities *capabilities;
379 /**< Array of devices supported capabilities */
381 unsigned max_nb_queue_pairs;
382 /**< Maximum number of queues pairs supported by device. */
385 unsigned max_nb_sessions;
386 /**< Maximum number of sessions supported by device. */
387 unsigned int max_nb_sessions_per_qp;
388 /**< Maximum number of sessions per queue pair.
389 * Default 0 for infinite sessions
394 #define RTE_CRYPTODEV_DETACHED (0)
395 #define RTE_CRYPTODEV_ATTACHED (1)
397 /** Definitions of Crypto device event types */
398 enum rte_cryptodev_event_type {
399 RTE_CRYPTODEV_EVENT_UNKNOWN, /**< unknown event type */
400 RTE_CRYPTODEV_EVENT_ERROR, /**< error interrupt event */
401 RTE_CRYPTODEV_EVENT_MAX /**< max value of this enum */
404 /** Crypto device queue pair configuration structure. */
405 struct rte_cryptodev_qp_conf {
406 uint32_t nb_descriptors; /**< Number of descriptors per queue pair */
410 * Typedef for application callback function to be registered by application
411 * software for notification of device events
413 * @param dev_id Crypto device identifier
414 * @param event Crypto device event to register for notification of.
415 * @param cb_arg User specified parameter to be passed as to passed to
416 * users callback function.
418 typedef void (*rte_cryptodev_cb_fn)(uint8_t dev_id,
419 enum rte_cryptodev_event_type event, void *cb_arg);
422 /** Crypto Device statistics */
423 struct rte_cryptodev_stats {
424 uint64_t enqueued_count;
425 /**< Count of all operations enqueued */
426 uint64_t dequeued_count;
427 /**< Count of all operations dequeued */
429 uint64_t enqueue_err_count;
430 /**< Total error count on operations enqueued */
431 uint64_t dequeue_err_count;
432 /**< Total error count on operations dequeued */
435 #define RTE_CRYPTODEV_NAME_MAX_LEN (64)
436 /**< 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.
450 rte_cryptodev_create_vdev(const char *name, const char *args);
453 * Get the device identifier for the named crypto device.
455 * @param name device name to select the device structure.
458 * - Returns crypto device identifier on success.
459 * - Return -1 on failure to find named crypto device.
462 rte_cryptodev_get_dev_id(const char *name);
465 * Get the total number of crypto devices that have been successfully
469 * - The total number of usable crypto devices.
472 rte_cryptodev_count(void);
475 * Get number of crypto device defined type.
477 * @param driver_id driver identifier.
480 * Returns number of crypto device.
483 rte_cryptodev_device_count_by_driver(uint8_t driver_id);
486 * Get number and identifiers of attached crypto devices that
487 * use the same crypto driver.
489 * @param driver_name driver name.
490 * @param devices output devices identifiers.
491 * @param nb_devices maximal number of devices.
494 * Returns number of attached crypto device.
497 rte_cryptodev_devices_get(const char *driver_name, uint8_t *devices,
500 * Return the NUMA socket to which a device is connected
503 * The identifier of the device
505 * The NUMA socket id to which the device is connected or
506 * a default of zero if the socket could not be determined.
507 * -1 if returned is the dev_id value is out of range.
510 rte_cryptodev_socket_id(uint8_t dev_id);
512 /** Crypto device configuration structure */
513 struct rte_cryptodev_config {
514 int socket_id; /**< Socket to allocate resources on */
515 uint16_t nb_queue_pairs;
516 /**< Number of queue pairs to configure on device */
520 * Configure a device.
522 * This function must be invoked first before any other function in the
523 * API. This function can also be re-invoked when a device is in the
526 * @param dev_id The identifier of the device to configure.
527 * @param config The crypto device configuration structure.
528 * @param session_pool Pointer to device session mempool
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,
536 struct rte_mempool *session_pool);
541 * The device start step is the last one and consists of setting the configured
542 * offload features and in starting the transmit and the receive units of the
544 * On success, all basic functions exported by the API (link status,
545 * receive/transmit, and so on) can be invoked.
548 * The identifier of the device.
550 * - 0: Success, device started.
551 * - <0: Error code of the driver device start function.
554 rte_cryptodev_start(uint8_t dev_id);
557 * Stop an device. The device can be restarted with a call to
558 * rte_cryptodev_start()
560 * @param dev_id The identifier of the device.
563 rte_cryptodev_stop(uint8_t dev_id);
566 * Close an device. The device cannot be restarted!
568 * @param dev_id The identifier of the device.
571 * - 0 on successfully closing device
572 * - <0 on failure to close device
575 rte_cryptodev_close(uint8_t dev_id);
578 * Allocate and set up a receive queue pair for a device.
581 * @param dev_id The identifier of the device.
582 * @param queue_pair_id The index of the queue pairs to set up. The
583 * value must be in the range [0, nb_queue_pair
584 * - 1] previously supplied to
585 * rte_cryptodev_configure().
586 * @param qp_conf The pointer to the configuration data to be
587 * used for the queue pair. NULL value is
588 * allowed, in which case default configuration
590 * @param socket_id The *socket_id* argument is the socket
591 * identifier in case of NUMA. The value can be
592 * *SOCKET_ID_ANY* if there is no NUMA constraint
593 * for the DMA memory allocated for the receive
597 * - 0: Success, queue pair correctly set up.
598 * - <0: Queue pair configuration failed
601 rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
602 const struct rte_cryptodev_qp_conf *qp_conf, int socket_id);
605 * Start a specified queue pair of a device. It is used
606 * when deferred_start flag of the specified queue is true.
608 * @param dev_id The identifier of the device
609 * @param queue_pair_id The index of the queue pair to start. The value
610 * must be in the range [0, nb_queue_pair - 1]
611 * previously supplied to
612 * rte_crypto_dev_configure().
614 * - 0: Success, the transmit queue is correctly set up.
615 * - -EINVAL: The dev_id or the queue_id out of range.
616 * - -ENOTSUP: The function not supported in PMD driver.
619 rte_cryptodev_queue_pair_start(uint8_t dev_id, uint16_t queue_pair_id);
622 * Stop specified queue pair of a device
624 * @param dev_id The identifier of the device
625 * @param queue_pair_id The index of the queue pair to stop. The value
626 * must be in the range [0, nb_queue_pair - 1]
627 * previously supplied to
628 * rte_cryptodev_configure().
630 * - 0: Success, the transmit queue is correctly set up.
631 * - -EINVAL: The dev_id or the queue_id out of range.
632 * - -ENOTSUP: The function not supported in PMD driver.
635 rte_cryptodev_queue_pair_stop(uint8_t dev_id, uint16_t queue_pair_id);
638 * Get the number of queue pairs on a specific crypto device
640 * @param dev_id Crypto device identifier.
642 * - The number of configured queue pairs.
645 rte_cryptodev_queue_pair_count(uint8_t dev_id);
649 * Retrieve the general I/O statistics of a device.
651 * @param dev_id The identifier of the device.
652 * @param stats A pointer to a structure of type
653 * *rte_cryptodev_stats* to be filled with the
654 * values of device counters.
656 * - Zero if successful.
657 * - Non-zero otherwise.
660 rte_cryptodev_stats_get(uint8_t dev_id, struct rte_cryptodev_stats *stats);
663 * Reset the general I/O statistics of a device.
665 * @param dev_id The identifier of the device.
668 rte_cryptodev_stats_reset(uint8_t dev_id);
671 * Retrieve the contextual information of a device.
673 * @param dev_id The identifier of the device.
674 * @param dev_info A pointer to a structure of type
675 * *rte_cryptodev_info* to be filled with the
676 * contextual information of the device.
679 rte_cryptodev_info_get(uint8_t dev_id, struct rte_cryptodev_info *dev_info);
683 * Register a callback function for specific device id.
685 * @param dev_id Device id.
686 * @param event Event interested.
687 * @param cb_fn User supplied callback function to be called.
688 * @param cb_arg Pointer to the parameters for the registered
692 * - On success, zero.
693 * - On failure, a negative value.
696 rte_cryptodev_callback_register(uint8_t dev_id,
697 enum rte_cryptodev_event_type event,
698 rte_cryptodev_cb_fn cb_fn, void *cb_arg);
701 * Unregister a callback function for specific device id.
703 * @param dev_id The device identifier.
704 * @param event Event interested.
705 * @param cb_fn User supplied callback function to be called.
706 * @param cb_arg Pointer to the parameters for the registered
710 * - On success, zero.
711 * - On failure, a negative value.
714 rte_cryptodev_callback_unregister(uint8_t dev_id,
715 enum rte_cryptodev_event_type event,
716 rte_cryptodev_cb_fn cb_fn, void *cb_arg);
719 typedef uint16_t (*dequeue_pkt_burst_t)(void *qp,
720 struct rte_crypto_op **ops, uint16_t nb_ops);
721 /**< Dequeue processed packets from queue pair of a device. */
723 typedef uint16_t (*enqueue_pkt_burst_t)(void *qp,
724 struct rte_crypto_op **ops, uint16_t nb_ops);
725 /**< Enqueue packets for processing on queue pair of a device. */
730 struct rte_cryptodev_callback;
732 /** Structure to keep track of registered callbacks */
733 TAILQ_HEAD(rte_cryptodev_cb_list, rte_cryptodev_callback);
735 /** The data structure associated with each crypto device. */
736 struct rte_cryptodev {
737 dequeue_pkt_burst_t dequeue_burst;
738 /**< Pointer to PMD receive function. */
739 enqueue_pkt_burst_t enqueue_burst;
740 /**< Pointer to PMD transmit function. */
742 struct rte_cryptodev_data *data;
743 /**< Pointer to device data */
744 struct rte_cryptodev_ops *dev_ops;
745 /**< Functions exported by PMD */
746 uint64_t feature_flags;
747 /**< Supported features */
748 struct rte_device *device;
749 /**< Backing device */
752 /**< Crypto driver identifier*/
754 struct rte_cryptodev_cb_list link_intr_cbs;
755 /**< User application callback for interrupts if present */
758 uint8_t attached : 1;
759 /**< Flag indicating the device is attached */
760 } __rte_cache_aligned;
764 * The data part, with no function pointers, associated with each device.
766 * This structure is safe to place in shared memory to be common among
767 * different processes in a multi-process configuration.
769 struct rte_cryptodev_data {
771 /**< Device ID for this instance */
773 /**< Socket ID where memory is allocated */
774 char name[RTE_CRYPTODEV_NAME_MAX_LEN];
775 /**< Unique identifier name */
778 uint8_t dev_started : 1;
779 /**< Device state: STARTED(1)/STOPPED(0) */
781 struct rte_mempool *session_pool;
782 /**< Session memory pool */
784 /**< Array of pointers to queue pairs. */
785 uint16_t nb_queue_pairs;
786 /**< Number of device queue pairs. */
789 /**< PMD-specific private data */
790 } __rte_cache_aligned;
792 extern struct rte_cryptodev *rte_cryptodevs;
795 * Dequeue a burst of processed crypto operations from a queue on the crypto
796 * device. The dequeued operation are stored in *rte_crypto_op* structures
797 * whose pointers are supplied in the *ops* array.
799 * The rte_cryptodev_dequeue_burst() function returns the number of ops
800 * actually dequeued, which is the number of *rte_crypto_op* data structures
801 * effectively supplied into the *ops* array.
803 * A return value equal to *nb_ops* indicates that the queue contained
804 * at least *nb_ops* operations, and this is likely to signify that other
805 * processed operations remain in the devices output queue. Applications
806 * implementing a "retrieve as many processed operations as possible" policy
807 * can check this specific case and keep invoking the
808 * rte_cryptodev_dequeue_burst() function until a value less than
809 * *nb_ops* is returned.
811 * The rte_cryptodev_dequeue_burst() function does not provide any error
812 * notification to avoid the corresponding overhead.
814 * @param dev_id The symmetric crypto device identifier
815 * @param qp_id The index of the queue pair from which to
816 * retrieve processed packets. The value must be
817 * in the range [0, nb_queue_pair - 1] previously
818 * supplied to rte_cryptodev_configure().
819 * @param ops The address of an array of pointers to
820 * *rte_crypto_op* structures that must be
821 * large enough to store *nb_ops* pointers in it.
822 * @param nb_ops The maximum number of operations to dequeue.
825 * - The number of operations actually dequeued, which is the number
826 * of pointers to *rte_crypto_op* structures effectively supplied to the
829 static inline uint16_t
830 rte_cryptodev_dequeue_burst(uint8_t dev_id, uint16_t qp_id,
831 struct rte_crypto_op **ops, uint16_t nb_ops)
833 struct rte_cryptodev *dev = &rte_cryptodevs[dev_id];
835 nb_ops = (*dev->dequeue_burst)
836 (dev->data->queue_pairs[qp_id], ops, nb_ops);
842 * Enqueue a burst of operations for processing on a crypto device.
844 * The rte_cryptodev_enqueue_burst() function is invoked to place
845 * crypto operations on the queue *qp_id* of the device designated by
848 * The *nb_ops* parameter is the number of operations to process which are
849 * supplied in the *ops* array of *rte_crypto_op* structures.
851 * The rte_cryptodev_enqueue_burst() function returns the number of
852 * operations it actually enqueued for processing. A return value equal to
853 * *nb_ops* means that all packets have been enqueued.
855 * @param dev_id The identifier of the device.
856 * @param qp_id The index of the queue pair which packets are
857 * to be enqueued for processing. The value
858 * must be in the range [0, nb_queue_pairs - 1]
859 * previously supplied to
860 * *rte_cryptodev_configure*.
861 * @param ops The address of an array of *nb_ops* pointers
862 * to *rte_crypto_op* structures which contain
863 * the crypto operations to be processed.
864 * @param nb_ops The number of operations to process.
867 * The number of operations actually enqueued on the crypto device. The return
868 * value can be less than the value of the *nb_ops* parameter when the
869 * crypto devices queue is full or if invalid parameters are specified in
872 static inline uint16_t
873 rte_cryptodev_enqueue_burst(uint8_t dev_id, uint16_t qp_id,
874 struct rte_crypto_op **ops, uint16_t nb_ops)
876 struct rte_cryptodev *dev = &rte_cryptodevs[dev_id];
878 return (*dev->enqueue_burst)(
879 dev->data->queue_pairs[qp_id], ops, nb_ops);
883 /** Cryptodev symmetric crypto session */
884 struct rte_cryptodev_sym_session {
890 /** Crypto driver identifier session created on */
891 struct rte_mempool *mp;
892 /**< Mempool session allocated from */
894 /**< Public symmetric session details */
896 __extension__ char _private[0];
897 /**< Private session material */
902 * Initialise a session for symmetric cryptographic operations.
904 * This function is used by the client to initialize immutable
905 * parameters of symmetric cryptographic operation.
906 * To perform the operation the rte_cryptodev_enqueue_burst function is
907 * used. Each mbuf should contain a reference to the session
908 * pointer returned from this function contained within it's crypto_op if a
909 * session-based operation is being provisioned. Memory to contain the session
910 * information is allocated from within mempool managed by the cryptodev.
912 * The rte_cryptodev_session_free must be called to free allocated
913 * memory when the session is no longer required.
915 * @param dev_id The device identifier.
916 * @param xform Crypto transform chain.
920 * Pointer to the created session or NULL
922 extern struct rte_cryptodev_sym_session *
923 rte_cryptodev_sym_session_create(uint8_t dev_id,
924 struct rte_crypto_sym_xform *xform);
927 * Free the memory associated with a previously allocated session.
929 * @param dev_id The device identifier.
930 * @param session Session pointer previously allocated by
931 * *rte_cryptodev_sym_session_create*.
934 * NULL on successful freeing of session.
935 * Session pointer on failure to free session.
937 extern struct rte_cryptodev_sym_session *
938 rte_cryptodev_sym_session_free(uint8_t dev_id,
939 struct rte_cryptodev_sym_session *session);
942 * Get the size of the private session data for a device.
944 * @param dev_id The device identifier.
947 * - Size of the private data, if successful
948 * - 0 if device is invalid or does not have private session
951 rte_cryptodev_get_private_session_size(uint8_t dev_id);
954 * Attach queue pair with sym session.
956 * @param dev_id Device to which the session will be attached.
957 * @param qp_id Queue pair to which the session will be attached.
958 * @param session Session pointer previously allocated by
959 * *rte_cryptodev_sym_session_create*.
962 * - On success, zero.
963 * - On failure, a negative value.
966 rte_cryptodev_queue_pair_attach_sym_session(uint8_t dev_id, uint16_t qp_id,
967 struct rte_cryptodev_sym_session *session);
970 * Detach queue pair with sym session.
972 * @param dev_id Device to which the session is attached.
973 * @param qp_id Queue pair to which the session is attached.
974 * @param session Session pointer previously allocated by
975 * *rte_cryptodev_sym_session_create*.
978 * - On success, zero.
979 * - On failure, a negative value.
982 rte_cryptodev_queue_pair_detach_sym_session(uint8_t dev_id, uint16_t qp_id,
983 struct rte_cryptodev_sym_session *session);
986 * Provide driver identifier.
989 * The pointer to a driver name.
991 * The driver type identifier or -1 if no driver found
993 int rte_cryptodev_driver_id_get(const char *name);
996 * Provide driver name.
999 * The driver identifier.
1001 * The driver name or null if no driver found
1003 const char *rte_cryptodev_driver_name_get(uint8_t driver_id);
1007 * Allocate Cryptodev driver.
1010 * Pointer to rte_driver.
1012 * The driver type identifier
1014 uint8_t rte_cryptodev_allocate_driver(const struct rte_driver *driver);
1017 #define RTE_PMD_REGISTER_CRYPTO_DRIVER(drv, driver_id)\
1018 RTE_INIT(init_ ##driver_id);\
1019 static void init_ ##driver_id(void)\
1021 driver_id = rte_cryptodev_allocate_driver(&(drv).driver);\
1029 #endif /* _RTE_CRYPTODEV_H_ */