3 * Copyright(c) 2015-2016 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_PMD_H_
33 #define _RTE_CRYPTODEV_PMD_H_
39 * These API are from crypto PMD only and user applications should not call
51 #include <rte_malloc.h>
53 #include <rte_mempool.h>
55 #include <rte_common.h>
57 #include "rte_crypto.h"
58 #include "rte_cryptodev.h"
61 #ifdef RTE_LIBRTE_CRYPTODEV_DEBUG
62 #define RTE_PMD_DEBUG_TRACE(...) \
63 rte_pmd_debug_trace(__func__, __VA_ARGS__)
65 #define RTE_PMD_DEBUG_TRACE(...)
68 struct rte_cryptodev_session {
72 enum rte_cryptodev_type type;
73 struct rte_mempool *mp;
76 __extension__ char _private[0];
79 struct rte_cryptodev_driver;
82 * Initialisation function of a crypto driver invoked for each matching
83 * crypto PCI device detected during the PCI probing phase.
85 * @param drv The pointer to the [matching] crypto driver structure
86 * supplied by the PMD when it registered itself.
87 * @param dev The dev pointer is the address of the *rte_cryptodev*
88 * structure associated with the matching device and which
89 * has been [automatically] allocated in the
90 * *rte_crypto_devices* array.
93 * - 0: Success, the device is properly initialised by the driver.
94 * In particular, the driver MUST have set up the *dev_ops* pointer
95 * of the *dev* structure.
96 * - <0: Error code of the device initialisation failure.
98 typedef int (*cryptodev_init_t)(struct rte_cryptodev_driver *drv,
99 struct rte_cryptodev *dev);
102 * Finalisation function of a driver invoked for each matching
103 * PCI device detected during the PCI closing phase.
105 * @param drv The pointer to the [matching] driver structure supplied
106 * by the PMD when it registered itself.
107 * @param dev The dev pointer is the address of the *rte_cryptodev*
108 * structure associated with the matching device and which
109 * has been [automatically] allocated in the
110 * *rte_crypto_devices* array.
113 * - 0: Success, the device is properly finalised by the driver.
114 * In particular, the driver MUST free the *dev_ops* pointer
115 * of the *dev* structure.
116 * - <0: Error code of the device initialisation failure.
118 typedef int (*cryptodev_uninit_t)(const struct rte_cryptodev_driver *drv,
119 struct rte_cryptodev *dev);
122 * The structure associated with a PMD driver.
124 * Each driver acts as a PCI driver and is represented by a generic
125 * *crypto_driver* structure that holds:
127 * - An *rte_pci_driver* structure (which must be the first field).
129 * - The *cryptodev_init* function invoked for each matching PCI device.
131 * - The size of the private data to allocate for each matching device.
133 struct rte_cryptodev_driver {
134 struct rte_pci_driver pci_drv; /**< The PMD is also a PCI driver. */
135 unsigned dev_private_size; /**< Size of device private data. */
137 cryptodev_init_t cryptodev_init; /**< Device init function. */
138 cryptodev_uninit_t cryptodev_uninit; /**< Device uninit function. */
142 /** Global structure used for maintaining state of allocated crypto devices */
143 struct rte_cryptodev_global {
144 struct rte_cryptodev *devs; /**< Device information array */
145 struct rte_cryptodev_data *data[RTE_CRYPTO_MAX_DEVS];
146 /**< Device private data */
147 uint8_t nb_devs; /**< Number of devices found */
148 uint8_t max_devs; /**< Max number of devices */
151 /** pointer to global crypto devices data structure. */
152 extern struct rte_cryptodev_global *rte_cryptodev_globals;
155 * Get the rte_cryptodev structure device pointer for the device. Assumes a
156 * valid device index.
158 * @param dev_id Device ID value to select the device structure.
161 * - The rte_cryptodev structure pointer for the given device ID.
163 static inline struct rte_cryptodev *
164 rte_cryptodev_pmd_get_dev(uint8_t dev_id)
166 return &rte_cryptodev_globals->devs[dev_id];
170 * Get the rte_cryptodev structure device pointer for the named device.
172 * @param name device name to select the device structure.
175 * - The rte_cryptodev structure pointer for the given device ID.
177 static inline struct rte_cryptodev *
178 rte_cryptodev_pmd_get_named_dev(const char *name)
180 struct rte_cryptodev *dev;
186 for (i = 0; i < rte_cryptodev_globals->max_devs; i++) {
187 dev = &rte_cryptodev_globals->devs[i];
189 if ((dev->attached == RTE_CRYPTODEV_ATTACHED) &&
190 (strcmp(dev->data->name, name) == 0))
198 * Validate if the crypto device index is valid attached crypto device.
200 * @param dev_id Crypto device index.
203 * - If the device index is valid (1) or not (0).
205 static inline unsigned
206 rte_cryptodev_pmd_is_valid_dev(uint8_t dev_id)
208 struct rte_cryptodev *dev = NULL;
210 if (dev_id >= rte_cryptodev_globals->nb_devs)
213 dev = rte_cryptodev_pmd_get_dev(dev_id);
214 if (dev->attached != RTE_CRYPTODEV_ATTACHED)
221 * The pool of rte_cryptodev structures.
223 extern struct rte_cryptodev *rte_cryptodevs;
227 * Definitions of all functions exported by a driver through the
228 * the generic structure of type *crypto_dev_ops* supplied in the
229 * *rte_cryptodev* structure associated with a device.
233 * Function used to configure device.
235 * @param dev Crypto device pointer
237 * @return Returns 0 on success
239 typedef int (*cryptodev_configure_t)(struct rte_cryptodev *dev);
242 * Function used to start a configured device.
244 * @param dev Crypto device pointer
246 * @return Returns 0 on success
248 typedef int (*cryptodev_start_t)(struct rte_cryptodev *dev);
251 * Function used to stop a configured device.
253 * @param dev Crypto device pointer
255 typedef void (*cryptodev_stop_t)(struct rte_cryptodev *dev);
258 * Function used to close a configured device.
260 * @param dev Crypto device pointer
263 * - EAGAIN if can't close as device is busy
265 typedef int (*cryptodev_close_t)(struct rte_cryptodev *dev);
269 * Function used to get statistics of a device.
271 * @param dev Crypto device pointer
272 * @param stats Pointer to crypto device stats structure to populate
274 typedef void (*cryptodev_stats_get_t)(struct rte_cryptodev *dev,
275 struct rte_cryptodev_stats *stats);
279 * Function used to reset statistics of a device.
281 * @param dev Crypto device pointer
283 typedef void (*cryptodev_stats_reset_t)(struct rte_cryptodev *dev);
287 * Function used to get specific information of a device.
289 * @param dev Crypto device pointer
291 typedef void (*cryptodev_info_get_t)(struct rte_cryptodev *dev,
292 struct rte_cryptodev_info *dev_info);
295 * Start queue pair of a device.
297 * @param dev Crypto device pointer
298 * @param qp_id Queue Pair Index
300 * @return Returns 0 on success.
302 typedef int (*cryptodev_queue_pair_start_t)(struct rte_cryptodev *dev,
306 * Stop queue pair of a device.
308 * @param dev Crypto device pointer
309 * @param qp_id Queue Pair Index
311 * @return Returns 0 on success.
313 typedef int (*cryptodev_queue_pair_stop_t)(struct rte_cryptodev *dev,
317 * Setup a queue pair for a device.
319 * @param dev Crypto device pointer
320 * @param qp_id Queue Pair Index
321 * @param qp_conf Queue configuration structure
322 * @param socket_id Socket Index
324 * @return Returns 0 on success.
326 typedef int (*cryptodev_queue_pair_setup_t)(struct rte_cryptodev *dev,
327 uint16_t qp_id, const struct rte_cryptodev_qp_conf *qp_conf,
331 * Release memory resources allocated by given queue pair.
333 * @param dev Crypto device pointer
334 * @param qp_id Queue Pair Index
338 * - EAGAIN if can't close as device is busy
340 typedef int (*cryptodev_queue_pair_release_t)(struct rte_cryptodev *dev,
344 * Get number of available queue pairs of a device.
346 * @param dev Crypto device pointer
348 * @return Returns number of queue pairs on success.
350 typedef uint32_t (*cryptodev_queue_pair_count_t)(struct rte_cryptodev *dev);
353 * Create a session mempool to allocate sessions from
355 * @param dev Crypto device pointer
356 * @param nb_objs number of sessions objects in mempool
357 * @param obj_cache l-core object cache size, see *rte_ring_create*
358 * @param socket_id Socket Id to allocate mempool on.
361 * - On success returns a pointer to a rte_mempool
362 * - On failure returns a NULL pointer
364 typedef int (*cryptodev_sym_create_session_pool_t)(
365 struct rte_cryptodev *dev, unsigned nb_objs,
366 unsigned obj_cache_size, int socket_id);
370 * Get the size of a cryptodev session
372 * @param dev Crypto device pointer
375 * - On success returns the size of the session structure for device
376 * - On failure returns 0
378 typedef unsigned (*cryptodev_sym_get_session_private_size_t)(
379 struct rte_cryptodev *dev);
382 * Initialize a Crypto session on a device.
384 * @param dev Crypto device pointer
385 * @param xform Single or chain of crypto xforms
386 * @param priv_sess Pointer to cryptodev's private session structure
389 * - Returns private session structure on success.
390 * - Returns NULL on failure.
392 typedef void (*cryptodev_sym_initialize_session_t)(struct rte_mempool *mempool,
393 void *session_private);
396 * Configure a Crypto session on a device.
398 * @param dev Crypto device pointer
399 * @param xform Single or chain of crypto xforms
400 * @param priv_sess Pointer to cryptodev's private session structure
403 * - Returns private session structure on success.
404 * - Returns NULL on failure.
406 typedef void * (*cryptodev_sym_configure_session_t)(struct rte_cryptodev *dev,
407 struct rte_crypto_sym_xform *xform, void *session_private);
410 * Free Crypto session.
411 * @param session Cryptodev session structure to free
413 typedef void (*cryptodev_sym_free_session_t)(struct rte_cryptodev *dev,
414 void *session_private);
417 /** Crypto device operations function pointer table */
418 struct rte_cryptodev_ops {
419 cryptodev_configure_t dev_configure; /**< Configure device. */
420 cryptodev_start_t dev_start; /**< Start device. */
421 cryptodev_stop_t dev_stop; /**< Stop device. */
422 cryptodev_close_t dev_close; /**< Close device. */
424 cryptodev_info_get_t dev_infos_get; /**< Get device info. */
426 cryptodev_stats_get_t stats_get;
427 /**< Get device statistics. */
428 cryptodev_stats_reset_t stats_reset;
429 /**< Reset device statistics. */
431 cryptodev_queue_pair_setup_t queue_pair_setup;
432 /**< Set up a device queue pair. */
433 cryptodev_queue_pair_release_t queue_pair_release;
434 /**< Release a queue pair. */
435 cryptodev_queue_pair_start_t queue_pair_start;
436 /**< Start a queue pair. */
437 cryptodev_queue_pair_stop_t queue_pair_stop;
438 /**< Stop a queue pair. */
439 cryptodev_queue_pair_count_t queue_pair_count;
440 /**< Get count of the queue pairs. */
442 cryptodev_sym_get_session_private_size_t session_get_size;
443 /**< Return private session. */
444 cryptodev_sym_initialize_session_t session_initialize;
445 /**< Initialization function for private session data */
446 cryptodev_sym_configure_session_t session_configure;
447 /**< Configure a Crypto session. */
448 cryptodev_sym_free_session_t session_clear;
449 /**< Clear a Crypto sessions private data. */
454 * Function for internal use by dummy drivers primarily, e.g. ring-based
456 * Allocates a new cryptodev slot for an crypto device and returns the pointer
457 * to that slot for the driver to use.
459 * @param name Unique identifier name for each device
460 * @param socket_id Socket to allocate resources on.
462 * - Slot in the rte_dev_devices array for a new device;
464 struct rte_cryptodev *
465 rte_cryptodev_pmd_allocate(const char *name, int socket_id);
468 * Creates a new virtual crypto device and returns the pointer
471 * @param name PMD type name
472 * @param dev_private_size Size of crypto PMDs private data
473 * @param socket_id Socket to allocate resources on.
476 * - Cryptodev pointer if device is successfully created.
477 * - NULL if device cannot be created.
479 struct rte_cryptodev *
480 rte_cryptodev_pmd_virtual_dev_init(const char *name, size_t dev_private_size,
485 * Function for internal use by dummy drivers primarily, e.g. ring-based
487 * Release the specified cryptodev device.
490 * The *cryptodev* pointer is the address of the *rte_cryptodev* structure.
492 * - 0 on success, negative on error
495 rte_cryptodev_pmd_release_device(struct rte_cryptodev *cryptodev);
498 * Executes all the user application registered callbacks for the specific
501 * @param dev Pointer to cryptodev struct
502 * @param event Crypto device interrupt event type.
507 void rte_cryptodev_pmd_callback_process(struct rte_cryptodev *dev,
508 enum rte_cryptodev_event_type event);
511 * Wrapper for use by pci drivers as a .probe function to attach to a crypto
514 int rte_cryptodev_pci_probe(struct rte_pci_driver *pci_drv,
515 struct rte_pci_device *pci_dev);
518 * Wrapper for use by pci drivers as a .remove function to detach a crypto
521 int rte_cryptodev_pci_remove(struct rte_pci_device *pci_dev);
527 #endif /* _RTE_CRYPTODEV_PMD_H_ */