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_pci.h>
  51 #include <rte_malloc.h>
  52 #include <rte_mbuf.h>
  53 #include <rte_mempool.h>
  54 #include <rte_log.h>
  55 #include <rte_common.h>
  56
  57 #include "rte_crypto.h"
  58 #include "rte_cryptodev.h"
  59
  60
  61 #ifdef RTE_LIBRTE_CRYPTODEV_DEBUG
  62 #define RTE_PMD_DEBUG_TRACE(...) \
  63         rte_pmd_debug_trace(__func__, __VA_ARGS__)
  64 #else
  65 #define RTE_PMD_DEBUG_TRACE(...)
  66 #endif
  67
  68 struct rte_cryptodev_session {
  69         RTE_STD_C11
  70         struct {
  71                 uint8_t dev_id;
  72                 enum rte_cryptodev_type type;
  73                 struct rte_mempool *mp;
  74         } __rte_aligned(8);
  75
  76         __extension__ char _private[0];
  77 };
  78
  79 struct rte_cryptodev_driver;
  80
  81 /**
  82  * Initialisation function of a crypto driver invoked for each matching
  83  * crypto PCI device detected during the PCI probing phase.
  84  *
  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.
  91  *
  92  * @return
  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.
  97  */
  98 typedef int (*cryptodev_init_t)(struct rte_cryptodev_driver *drv,
  99                 struct rte_cryptodev *dev);
 100
 101 /**
 102  * Finalisation function of a driver invoked for each matching
 103  * PCI device detected during the PCI closing phase.
 104  *
 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.
 111  *
 112  *  * @return
 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.
 117  */
 118 typedef int (*cryptodev_uninit_t)(const struct rte_cryptodev_driver  *drv,
 119                                 struct rte_cryptodev *dev);
 120
 121 /**
 122  * The structure associated with a PMD driver.
 123  *
 124  * Each driver acts as a PCI driver and is represented by a generic
 125  * *crypto_driver* structure that holds:
 126  *
 127  * - An *rte_pci_driver* structure (which must be the first field).
 128  *
 129  * - The *cryptodev_init* function invoked for each matching PCI device.
 130  *
 131  * - The size of the private data to allocate for each matching device.
 132  */
 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. */
 136
 137         cryptodev_init_t cryptodev_init;        /**< Device init function. */
 138         cryptodev_uninit_t cryptodev_uninit;    /**< Device uninit function. */
 139 };
 140
 141
 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 */
 149 };
 150
 151 /** pointer to global crypto devices data structure. */
 152 extern struct rte_cryptodev_global *rte_cryptodev_globals;
 153
 154 /**
 155  * Get the rte_cryptodev structure device pointer for the device. Assumes a
 156  * valid device index.
 157  *
 158  * @param       dev_id  Device ID value to select the device structure.
 159  *
 160  * @return
 161  *   - The rte_cryptodev structure pointer for the given device ID.
 162  */
 163 struct rte_cryptodev *
 164 rte_cryptodev_pmd_get_dev(uint8_t dev_id);
 165
 166 /**
 167  * Get the rte_cryptodev structure device pointer for the named device.
 168  *
 169  * @param       name    device name to select the device structure.
 170  *
 171  * @return
 172  *   - The rte_cryptodev structure pointer for the given device ID.
 173  */
 174 struct rte_cryptodev *
 175 rte_cryptodev_pmd_get_named_dev(const char *name);
 176
 177 /**
 178  * Validate if the crypto device index is valid attached crypto device.
 179  *
 180  * @param       dev_id  Crypto device index.
 181  *
 182  * @return
 183  *   - If the device index is valid (1) or not (0).
 184  */
 185 unsigned int
 186 rte_cryptodev_pmd_is_valid_dev(uint8_t dev_id);
 187
 188 /**
 189  * The pool of rte_cryptodev structures.
 190  */
 191 extern struct rte_cryptodev *rte_cryptodevs;
 192
 193
 194 /**
 195  * Definitions of all functions exported by a driver through the
 196  * the generic structure of type *crypto_dev_ops* supplied in the
 197  * *rte_cryptodev* structure associated with a device.
 198  */
 199
 200 /**
 201  *      Function used to configure device.
 202  *
 203  * @param       dev     Crypto device pointer
 204  *              config  Crypto device configurations
 205  *
 206  * @return      Returns 0 on success
 207  */
 208 typedef int (*cryptodev_configure_t)(struct rte_cryptodev *dev,
 209                 struct rte_cryptodev_config *config);
 210
 211 /**
 212  * Function used to start a configured device.
 213  *
 214  * @param       dev     Crypto device pointer
 215  *
 216  * @return      Returns 0 on success
 217  */
 218 typedef int (*cryptodev_start_t)(struct rte_cryptodev *dev);
 219
 220 /**
 221  * Function used to stop a configured device.
 222  *
 223  * @param       dev     Crypto device pointer
 224  */
 225 typedef void (*cryptodev_stop_t)(struct rte_cryptodev *dev);
 226
 227 /**
 228  * Function used to close a configured device.
 229  *
 230  * @param       dev     Crypto device pointer
 231  * @return
 232  * - 0 on success.
 233  * - EAGAIN if can't close as device is busy
 234  */
 235 typedef int (*cryptodev_close_t)(struct rte_cryptodev *dev);
 236
 237
 238 /**
 239  * Function used to get statistics of a device.
 240  *
 241  * @param       dev     Crypto device pointer
 242  * @param       stats   Pointer to crypto device stats structure to populate
 243  */
 244 typedef void (*cryptodev_stats_get_t)(struct rte_cryptodev *dev,
 245                                 struct rte_cryptodev_stats *stats);
 246
 247
 248 /**
 249  * Function used to reset statistics of a device.
 250  *
 251  * @param       dev     Crypto device pointer
 252  */
 253 typedef void (*cryptodev_stats_reset_t)(struct rte_cryptodev *dev);
 254
 255
 256 /**
 257  * Function used to get specific information of a device.
 258  *
 259  * @param       dev     Crypto device pointer
 260  */
 261 typedef void (*cryptodev_info_get_t)(struct rte_cryptodev *dev,
 262                                 struct rte_cryptodev_info *dev_info);
 263
 264 /**
 265  * Start queue pair of a device.
 266  *
 267  * @param       dev     Crypto device pointer
 268  * @param       qp_id   Queue Pair Index
 269  *
 270  * @return      Returns 0 on success.
 271  */
 272 typedef int (*cryptodev_queue_pair_start_t)(struct rte_cryptodev *dev,
 273                                 uint16_t qp_id);
 274
 275 /**
 276  * Stop queue pair of a device.
 277  *
 278  * @param       dev     Crypto device pointer
 279  * @param       qp_id   Queue Pair Index
 280  *
 281  * @return      Returns 0 on success.
 282  */
 283 typedef int (*cryptodev_queue_pair_stop_t)(struct rte_cryptodev *dev,
 284                                 uint16_t qp_id);
 285
 286 /**
 287  * Setup a queue pair for a device.
 288  *
 289  * @param       dev             Crypto device pointer
 290  * @param       qp_id           Queue Pair Index
 291  * @param       qp_conf         Queue configuration structure
 292  * @param       socket_id       Socket Index
 293  *
 294  * @return      Returns 0 on success.
 295  */
 296 typedef int (*cryptodev_queue_pair_setup_t)(struct rte_cryptodev *dev,
 297                 uint16_t qp_id, const struct rte_cryptodev_qp_conf *qp_conf,
 298                 int socket_id);
 299
 300 /**
 301  * Release memory resources allocated by given queue pair.
 302  *
 303  * @param       dev     Crypto device pointer
 304  * @param       qp_id   Queue Pair Index
 305  *
 306  * @return
 307  * - 0 on success.
 308  * - EAGAIN if can't close as device is busy
 309  */
 310 typedef int (*cryptodev_queue_pair_release_t)(struct rte_cryptodev *dev,
 311                 uint16_t qp_id);
 312
 313 /**
 314  * Get number of available queue pairs of a device.
 315  *
 316  * @param       dev     Crypto device pointer
 317  *
 318  * @return      Returns number of queue pairs on success.
 319  */
 320 typedef uint32_t (*cryptodev_queue_pair_count_t)(struct rte_cryptodev *dev);
 321
 322 /**
 323  * Create a session mempool to allocate sessions from
 324  *
 325  * @param       dev             Crypto device pointer
 326  * @param       nb_objs         number of sessions objects in mempool
 327  * @param       obj_cache       l-core object cache size, see *rte_ring_create*
 328  * @param       socket_id       Socket Id to allocate  mempool on.
 329  *
 330  * @return
 331  * - On success returns a pointer to a rte_mempool
 332  * - On failure returns a NULL pointer
 333  */
 334 typedef int (*cryptodev_sym_create_session_pool_t)(
 335                 struct rte_cryptodev *dev, unsigned nb_objs,
 336                 unsigned obj_cache_size, int socket_id);
 337
 338
 339 /**
 340  * Get the size of a cryptodev session
 341  *
 342  * @param       dev             Crypto device pointer
 343  *
 344  * @return
 345  *  - On success returns the size of the session structure for device
 346  *  - On failure returns 0
 347  */
 348 typedef unsigned (*cryptodev_sym_get_session_private_size_t)(
 349                 struct rte_cryptodev *dev);
 350
 351 /**
 352  * Initialize a Crypto session on a device.
 353  *
 354  * @param       dev             Crypto device pointer
 355  * @param       xform           Single or chain of crypto xforms
 356  * @param       priv_sess       Pointer to cryptodev's private session structure
 357  *
 358  * @return
 359  *  - Returns private session structure on success.
 360  *  - Returns NULL on failure.
 361  */
 362 typedef void (*cryptodev_sym_initialize_session_t)(struct rte_mempool *mempool,
 363                 void *session_private);
 364
 365 /**
 366  * Configure a Crypto session on a device.
 367  *
 368  * @param       dev             Crypto device pointer
 369  * @param       xform           Single or chain of crypto xforms
 370  * @param       priv_sess       Pointer to cryptodev's private session structure
 371  *
 372  * @return
 373  *  - Returns private session structure on success.
 374  *  - Returns NULL on failure.
 375  */
 376 typedef void * (*cryptodev_sym_configure_session_t)(struct rte_cryptodev *dev,
 377                 struct rte_crypto_sym_xform *xform, void *session_private);
 378
 379 /**
 380  * Free Crypto session.
 381  * @param       session         Cryptodev session structure to free
 382  */
 383 typedef void (*cryptodev_sym_free_session_t)(struct rte_cryptodev *dev,
 384                 void *session_private);
 385
 386 /**
 387  * Optional API for drivers to attach sessions with queue pair.
 388  * @param       dev             Crypto device pointer
 389  * @param       qp_id           queue pair id for attaching session
 390  * @param       priv_sess       Pointer to cryptodev's private session structure
 391  * @return
 392  *  - Return 0 on success
 393  */
 394 typedef int (*cryptodev_sym_queue_pair_attach_session_t)(
 395                   struct rte_cryptodev *dev,
 396                   uint16_t qp_id,
 397                   void *session_private);
 398
 399 /**
 400  * Optional API for drivers to detach sessions from queue pair.
 401  * @param       dev             Crypto device pointer
 402  * @param       qp_id           queue pair id for detaching session
 403  * @param       priv_sess       Pointer to cryptodev's private session structure
 404  * @return
 405  *  - Return 0 on success
 406  */
 407 typedef int (*cryptodev_sym_queue_pair_detach_session_t)(
 408                   struct rte_cryptodev *dev,
 409                   uint16_t qp_id,
 410                   void *session_private);
 411
 412 /** Crypto device operations function pointer table */
 413 struct rte_cryptodev_ops {
 414         cryptodev_configure_t dev_configure;    /**< Configure device. */
 415         cryptodev_start_t dev_start;            /**< Start device. */
 416         cryptodev_stop_t dev_stop;              /**< Stop device. */
 417         cryptodev_close_t dev_close;            /**< Close device. */
 418
 419         cryptodev_info_get_t dev_infos_get;     /**< Get device info. */
 420
 421         cryptodev_stats_get_t stats_get;
 422         /**< Get device statistics. */
 423         cryptodev_stats_reset_t stats_reset;
 424         /**< Reset device statistics. */
 425
 426         cryptodev_queue_pair_setup_t queue_pair_setup;
 427         /**< Set up a device queue pair. */
 428         cryptodev_queue_pair_release_t queue_pair_release;
 429         /**< Release a queue pair. */
 430         cryptodev_queue_pair_start_t queue_pair_start;
 431         /**< Start a queue pair. */
 432         cryptodev_queue_pair_stop_t queue_pair_stop;
 433         /**< Stop a queue pair. */
 434         cryptodev_queue_pair_count_t queue_pair_count;
 435         /**< Get count of the queue pairs. */
 436
 437         cryptodev_sym_get_session_private_size_t session_get_size;
 438         /**< Return private session. */
 439         cryptodev_sym_initialize_session_t session_initialize;
 440         /**< Initialization function for private session data */
 441         cryptodev_sym_configure_session_t session_configure;
 442         /**< Configure a Crypto session. */
 443         cryptodev_sym_free_session_t session_clear;
 444         /**< Clear a Crypto sessions private data. */
 445         cryptodev_sym_queue_pair_attach_session_t qp_attach_session;
 446         /**< Attach session to queue pair. */
 447         cryptodev_sym_queue_pair_attach_session_t qp_detach_session;
 448         /**< Detach session from queue pair. */
 449 };
 450
 451
 452 /**
 453  * Function for internal use by dummy drivers primarily, e.g. ring-based
 454  * driver.
 455  * Allocates a new cryptodev slot for an crypto device and returns the pointer
 456  * to that slot for the driver to use.
 457  *
 458  * @param       name            Unique identifier name for each device
 459  * @param       socket_id       Socket to allocate resources on.
 460  * @return
 461  *   - Slot in the rte_dev_devices array for a new device;
 462  */
 463 struct rte_cryptodev *
 464 rte_cryptodev_pmd_allocate(const char *name, int socket_id);
 465
 466 /**
 467  * Creates a new virtual crypto device and returns the pointer
 468  * to that device.
 469  *
 470  * @param       name                    PMD type name
 471  * @param       dev_private_size        Size of crypto PMDs private data
 472  * @param       socket_id               Socket to allocate resources on.
 473  *
 474  * @return
 475  *   - Cryptodev pointer if device is successfully created.
 476  *   - NULL if device cannot be created.
 477  */
 478 struct rte_cryptodev *
 479 rte_cryptodev_pmd_virtual_dev_init(const char *name, size_t dev_private_size,
 480                 int socket_id);
 481
 482
 483 /**
 484  * Function for internal use by dummy drivers primarily, e.g. ring-based
 485  * driver.
 486  * Release the specified cryptodev device.
 487  *
 488  * @param cryptodev
 489  * The *cryptodev* pointer is the address of the *rte_cryptodev* structure.
 490  * @return
 491  *   - 0 on success, negative on error
 492  */
 493 extern int
 494 rte_cryptodev_pmd_release_device(struct rte_cryptodev *cryptodev);
 495
 496 /**
 497  * Executes all the user application registered callbacks for the specific
 498  * device.
 499  *  *
 500  * @param       dev     Pointer to cryptodev struct
 501  * @param       event   Crypto device interrupt event type.
 502  *
 503  * @return
 504  *  void
 505  */
 506 void rte_cryptodev_pmd_callback_process(struct rte_cryptodev *dev,
 507                                 enum rte_cryptodev_event_type event);
 508
 509 /**
 510  * Wrapper for use by pci drivers as a .probe function to attach to a crypto
 511  * interface.
 512  */
 513 int rte_cryptodev_pci_probe(struct rte_pci_driver *pci_drv,
 514                             struct rte_pci_device *pci_dev);
 515
 516 /**
 517  * Wrapper for use by pci drivers as a .remove function to detach a crypto
 518  * interface.
 519  */
 520 int rte_cryptodev_pci_remove(struct rte_pci_device *pci_dev);
 521
 522 /**
 523  * @internal
 524  * Create unique device name
 525  */
 526 int
 527 rte_cryptodev_pmd_create_dev_name(char *name, const char *dev_name_prefix);
 528
 529 #ifdef __cplusplus
 530 }
 531 #endif
 532
 533 #endif /* _RTE_CRYPTODEV_PMD_H_ */