lib/librte_cryptodev/rte_cryptodev_pmd.h

   1 /*-
   2  *
   3  *   Copyright(c) 2015-2016 Intel Corporation. All rights reserved.
   4  *
   5  *   Redistribution and use in source and binary forms, with or without
   6  *   modification, are permitted provided that the following conditions
   7  *   are met:
   8  *
   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
  14  *       distribution.
  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.
  18  *
  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.
  30  */
  31
  32 #ifndef _RTE_CRYPTODEV_PMD_H_
  33 #define _RTE_CRYPTODEV_PMD_H_
  34
  35 /** @file
  36  * RTE Crypto PMD APIs
  37  *
  38  * @note
  39  * These API are from crypto PMD only and user applications should not call
  40  * them directly.
  41  */
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47 #include <string.h>
  48
  49 #include <rte_dev.h>
  50 #include <rte_malloc.h>
  51 #include <rte_mbuf.h>
  52 #include <rte_mempool.h>
  53 #include <rte_log.h>
  54 #include <rte_common.h>
  55
  56 #include "rte_crypto.h"
  57 #include "rte_cryptodev.h"
  58
  59 /** Global structure used for maintaining state of allocated crypto devices */
  60 struct rte_cryptodev_global {
  61         struct rte_cryptodev *devs;     /**< Device information array */
  62         struct rte_cryptodev_data *data[RTE_CRYPTO_MAX_DEVS];
  63         /**< Device private data */
  64         uint8_t nb_devs;                /**< Number of devices found */
  65         uint8_t max_devs;               /**< Max number of devices */
  66 };
  67
  68 /** pointer to global crypto devices data structure. */
  69 extern struct rte_cryptodev_global *rte_cryptodev_globals;
  70
  71 /**
  72  * Get the rte_cryptodev structure device pointer for the device. Assumes a
  73  * valid device index.
  74  *
  75  * @param       dev_id  Device ID value to select the device structure.
  76  *
  77  * @return
  78  *   - The rte_cryptodev structure pointer for the given device ID.
  79  */
  80 struct rte_cryptodev *
  81 rte_cryptodev_pmd_get_dev(uint8_t dev_id);
  82
  83 /**
  84  * Get the rte_cryptodev structure device pointer for the named device.
  85  *
  86  * @param       name    device name to select the device structure.
  87  *
  88  * @return
  89  *   - The rte_cryptodev structure pointer for the given device ID.
  90  */
  91 struct rte_cryptodev *
  92 rte_cryptodev_pmd_get_named_dev(const char *name);
  93
  94 /**
  95  * Validate if the crypto device index is valid attached crypto device.
  96  *
  97  * @param       dev_id  Crypto device index.
  98  *
  99  * @return
 100  *   - If the device index is valid (1) or not (0).
 101  */
 102 unsigned int
 103 rte_cryptodev_pmd_is_valid_dev(uint8_t dev_id);
 104
 105 /**
 106  * The pool of rte_cryptodev structures.
 107  */
 108 extern struct rte_cryptodev *rte_cryptodevs;
 109
 110
 111 /**
 112  * Definitions of all functions exported by a driver through the
 113  * the generic structure of type *crypto_dev_ops* supplied in the
 114  * *rte_cryptodev* structure associated with a device.
 115  */
 116
 117 /**
 118  *      Function used to configure device.
 119  *
 120  * @param       dev     Crypto device pointer
 121  *              config  Crypto device configurations
 122  *
 123  * @return      Returns 0 on success
 124  */
 125 typedef int (*cryptodev_configure_t)(struct rte_cryptodev *dev,
 126                 struct rte_cryptodev_config *config);
 127
 128 /**
 129  * Function used to start a configured device.
 130  *
 131  * @param       dev     Crypto device pointer
 132  *
 133  * @return      Returns 0 on success
 134  */
 135 typedef int (*cryptodev_start_t)(struct rte_cryptodev *dev);
 136
 137 /**
 138  * Function used to stop a configured device.
 139  *
 140  * @param       dev     Crypto device pointer
 141  */
 142 typedef void (*cryptodev_stop_t)(struct rte_cryptodev *dev);
 143
 144 /**
 145  * Function used to close a configured device.
 146  *
 147  * @param       dev     Crypto device pointer
 148  * @return
 149  * - 0 on success.
 150  * - EAGAIN if can't close as device is busy
 151  */
 152 typedef int (*cryptodev_close_t)(struct rte_cryptodev *dev);
 153
 154
 155 /**
 156  * Function used to get statistics of a device.
 157  *
 158  * @param       dev     Crypto device pointer
 159  * @param       stats   Pointer to crypto device stats structure to populate
 160  */
 161 typedef void (*cryptodev_stats_get_t)(struct rte_cryptodev *dev,
 162                                 struct rte_cryptodev_stats *stats);
 163
 164
 165 /**
 166  * Function used to reset statistics of a device.
 167  *
 168  * @param       dev     Crypto device pointer
 169  */
 170 typedef void (*cryptodev_stats_reset_t)(struct rte_cryptodev *dev);
 171
 172
 173 /**
 174  * Function used to get specific information of a device.
 175  *
 176  * @param       dev     Crypto device pointer
 177  */
 178 typedef void (*cryptodev_info_get_t)(struct rte_cryptodev *dev,
 179                                 struct rte_cryptodev_info *dev_info);
 180
 181 /**
 182  * Start queue pair of a device.
 183  *
 184  * @param       dev     Crypto device pointer
 185  * @param       qp_id   Queue Pair Index
 186  *
 187  * @return      Returns 0 on success.
 188  */
 189 typedef int (*cryptodev_queue_pair_start_t)(struct rte_cryptodev *dev,
 190                                 uint16_t qp_id);
 191
 192 /**
 193  * Stop queue pair of a device.
 194  *
 195  * @param       dev     Crypto device pointer
 196  * @param       qp_id   Queue Pair Index
 197  *
 198  * @return      Returns 0 on success.
 199  */
 200 typedef int (*cryptodev_queue_pair_stop_t)(struct rte_cryptodev *dev,
 201                                 uint16_t qp_id);
 202
 203 /**
 204  * Setup a queue pair for a device.
 205  *
 206  * @param       dev             Crypto device pointer
 207  * @param       qp_id           Queue Pair Index
 208  * @param       qp_conf         Queue configuration structure
 209  * @param       socket_id       Socket Index
 210  *
 211  * @return      Returns 0 on success.
 212  */
 213 typedef int (*cryptodev_queue_pair_setup_t)(struct rte_cryptodev *dev,
 214                 uint16_t qp_id, const struct rte_cryptodev_qp_conf *qp_conf,
 215                 int socket_id);
 216
 217 /**
 218  * Release memory resources allocated by given queue pair.
 219  *
 220  * @param       dev     Crypto device pointer
 221  * @param       qp_id   Queue Pair Index
 222  *
 223  * @return
 224  * - 0 on success.
 225  * - EAGAIN if can't close as device is busy
 226  */
 227 typedef int (*cryptodev_queue_pair_release_t)(struct rte_cryptodev *dev,
 228                 uint16_t qp_id);
 229
 230 /**
 231  * Get number of available queue pairs of a device.
 232  *
 233  * @param       dev     Crypto device pointer
 234  *
 235  * @return      Returns number of queue pairs on success.
 236  */
 237 typedef uint32_t (*cryptodev_queue_pair_count_t)(struct rte_cryptodev *dev);
 238
 239 /**
 240  * Create a session mempool to allocate sessions from
 241  *
 242  * @param       dev             Crypto device pointer
 243  * @param       nb_objs         number of sessions objects in mempool
 244  * @param       obj_cache       l-core object cache size, see *rte_ring_create*
 245  * @param       socket_id       Socket Id to allocate  mempool on.
 246  *
 247  * @return
 248  * - On success returns a pointer to a rte_mempool
 249  * - On failure returns a NULL pointer
 250  */
 251 typedef int (*cryptodev_sym_create_session_pool_t)(
 252                 struct rte_cryptodev *dev, unsigned nb_objs,
 253                 unsigned obj_cache_size, int socket_id);
 254
 255
 256 /**
 257  * Get the size of a cryptodev session
 258  *
 259  * @param       dev             Crypto device pointer
 260  *
 261  * @return
 262  *  - On success returns the size of the session structure for device
 263  *  - On failure returns 0
 264  */
 265 typedef unsigned (*cryptodev_sym_get_session_private_size_t)(
 266                 struct rte_cryptodev *dev);
 267
 268 /**
 269  * Initialize a Crypto session on a device.
 270  *
 271  * @param       dev             Crypto device pointer
 272  * @param       xform           Single or chain of crypto xforms
 273  * @param       priv_sess       Pointer to cryptodev's private session structure
 274  *
 275  * @return
 276  *  - Returns private session structure on success.
 277  *  - Returns NULL on failure.
 278  */
 279 typedef void (*cryptodev_sym_initialize_session_t)(struct rte_mempool *mempool,
 280                 void *session_private);
 281
 282 /**
 283  * Configure a Crypto session on a device.
 284  *
 285  * @param       dev             Crypto device pointer
 286  * @param       xform           Single or chain of crypto xforms
 287  * @param       priv_sess       Pointer to cryptodev's private session structure
 288  *
 289  * @return
 290  *  - Returns private session structure on success.
 291  *  - Returns NULL on failure.
 292  */
 293 typedef void * (*cryptodev_sym_configure_session_t)(struct rte_cryptodev *dev,
 294                 struct rte_crypto_sym_xform *xform, void *session_private);
 295
 296 /**
 297  * Free Crypto session.
 298  * @param       session         Cryptodev session structure to free
 299  */
 300 typedef void (*cryptodev_sym_free_session_t)(struct rte_cryptodev *dev,
 301                 void *session_private);
 302
 303 /**
 304  * Optional API for drivers to attach sessions with queue pair.
 305  * @param       dev             Crypto device pointer
 306  * @param       qp_id           queue pair id for attaching session
 307  * @param       priv_sess       Pointer to cryptodev's private session structure
 308  * @return
 309  *  - Return 0 on success
 310  */
 311 typedef int (*cryptodev_sym_queue_pair_attach_session_t)(
 312                   struct rte_cryptodev *dev,
 313                   uint16_t qp_id,
 314                   void *session_private);
 315
 316 /**
 317  * Optional API for drivers to detach sessions from queue pair.
 318  * @param       dev             Crypto device pointer
 319  * @param       qp_id           queue pair id for detaching session
 320  * @param       priv_sess       Pointer to cryptodev's private session structure
 321  * @return
 322  *  - Return 0 on success
 323  */
 324 typedef int (*cryptodev_sym_queue_pair_detach_session_t)(
 325                   struct rte_cryptodev *dev,
 326                   uint16_t qp_id,
 327                   void *session_private);
 328
 329 /** Crypto device operations function pointer table */
 330 struct rte_cryptodev_ops {
 331         cryptodev_configure_t dev_configure;    /**< Configure device. */
 332         cryptodev_start_t dev_start;            /**< Start device. */
 333         cryptodev_stop_t dev_stop;              /**< Stop device. */
 334         cryptodev_close_t dev_close;            /**< Close device. */
 335
 336         cryptodev_info_get_t dev_infos_get;     /**< Get device info. */
 337
 338         cryptodev_stats_get_t stats_get;
 339         /**< Get device statistics. */
 340         cryptodev_stats_reset_t stats_reset;
 341         /**< Reset device statistics. */
 342
 343         cryptodev_queue_pair_setup_t queue_pair_setup;
 344         /**< Set up a device queue pair. */
 345         cryptodev_queue_pair_release_t queue_pair_release;
 346         /**< Release a queue pair. */
 347         cryptodev_queue_pair_start_t queue_pair_start;
 348         /**< Start a queue pair. */
 349         cryptodev_queue_pair_stop_t queue_pair_stop;
 350         /**< Stop a queue pair. */
 351         cryptodev_queue_pair_count_t queue_pair_count;
 352         /**< Get count of the queue pairs. */
 353
 354         cryptodev_sym_get_session_private_size_t session_get_size;
 355         /**< Return private session. */
 356         cryptodev_sym_initialize_session_t session_initialize;
 357         /**< Initialization function for private session data */
 358         cryptodev_sym_configure_session_t session_configure;
 359         /**< Configure a Crypto session. */
 360         cryptodev_sym_free_session_t session_clear;
 361         /**< Clear a Crypto sessions private data. */
 362         cryptodev_sym_queue_pair_attach_session_t qp_attach_session;
 363         /**< Attach session to queue pair. */
 364         cryptodev_sym_queue_pair_attach_session_t qp_detach_session;
 365         /**< Detach session from queue pair. */
 366 };
 367
 368
 369 /**
 370  * Function for internal use by dummy drivers primarily, e.g. ring-based
 371  * driver.
 372  * Allocates a new cryptodev slot for an crypto device and returns the pointer
 373  * to that slot for the driver to use.
 374  *
 375  * @param       name            Unique identifier name for each device
 376  * @param       socket_id       Socket to allocate resources on.
 377  * @return
 378  *   - Slot in the rte_dev_devices array for a new device;
 379  */
 380 struct rte_cryptodev *
 381 rte_cryptodev_pmd_allocate(const char *name, int socket_id);
 382
 383 /**
 384  * Function for internal use by dummy drivers primarily, e.g. ring-based
 385  * driver.
 386  * Release the specified cryptodev device.
 387  *
 388  * @param cryptodev
 389  * The *cryptodev* pointer is the address of the *rte_cryptodev* structure.
 390  * @return
 391  *   - 0 on success, negative on error
 392  */
 393 extern int
 394 rte_cryptodev_pmd_release_device(struct rte_cryptodev *cryptodev);
 395
 396 /**
 397  * Executes all the user application registered callbacks for the specific
 398  * device.
 399  *  *
 400  * @param       dev     Pointer to cryptodev struct
 401  * @param       event   Crypto device interrupt event type.
 402  *
 403  * @return
 404  *  void
 405  */
 406 void rte_cryptodev_pmd_callback_process(struct rte_cryptodev *dev,
 407                                 enum rte_cryptodev_event_type event);
 408
 409 /**
 410  * @internal
 411  * Create unique device name
 412  */
 413 int
 414 rte_cryptodev_pmd_create_dev_name(char *name, const char *dev_name_prefix);
 415
 416 #ifdef __cplusplus
 417 }
 418 #endif
 419
 420 #endif /* _RTE_CRYPTODEV_PMD_H_ */