lib/librte_cryptodev/rte_cryptodev_pmd.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2015-2016 Intel Corporation.
   3  */
   4
   5 #ifndef _RTE_CRYPTODEV_PMD_H_
   6 #define _RTE_CRYPTODEV_PMD_H_
   7
   8 /** @file
   9  * RTE Crypto PMD APIs
  10  *
  11  * @note
  12  * These API are from crypto PMD only and user applications should not call
  13  * them directly.
  14  */
  15
  16 #ifdef __cplusplus
  17 extern "C" {
  18 #endif
  19
  20 #include <string.h>
  21
  22 #include <rte_config.h>
  23 #include <rte_dev.h>
  24 #include <rte_malloc.h>
  25 #include <rte_mbuf.h>
  26 #include <rte_mempool.h>
  27 #include <rte_log.h>
  28 #include <rte_common.h>
  29
  30 #include "rte_crypto.h"
  31 #include "rte_cryptodev.h"
  32
  33
  34 #define RTE_CRYPTODEV_PMD_DEFAULT_MAX_NB_QUEUE_PAIRS    8
  35
  36 #define RTE_CRYPTODEV_PMD_NAME_ARG                      ("name")
  37 #define RTE_CRYPTODEV_PMD_MAX_NB_QP_ARG                 ("max_nb_queue_pairs")
  38 #define RTE_CRYPTODEV_PMD_SOCKET_ID_ARG                 ("socket_id")
  39
  40
  41 static const char * const cryptodev_pmd_valid_params[] = {
  42         RTE_CRYPTODEV_PMD_NAME_ARG,
  43         RTE_CRYPTODEV_PMD_MAX_NB_QP_ARG,
  44         RTE_CRYPTODEV_PMD_SOCKET_ID_ARG
  45 };
  46
  47 /**
  48  * @internal
  49  * Initialisation parameters for crypto devices
  50  */
  51 struct rte_cryptodev_pmd_init_params {
  52         char name[RTE_CRYPTODEV_NAME_MAX_LEN];
  53         size_t private_data_size;
  54         int socket_id;
  55         unsigned int max_nb_queue_pairs;
  56 };
  57
  58 /** Global structure used for maintaining state of allocated crypto devices */
  59 struct rte_cryptodev_global {
  60         struct rte_cryptodev *devs;     /**< Device information array */
  61         struct rte_cryptodev_data *data[RTE_CRYPTO_MAX_DEVS];
  62         /**< Device private data */
  63         uint8_t nb_devs;                /**< Number of devices found */
  64         uint8_t max_devs;               /**< Max number of devices */
  65 };
  66
  67 /* Cryptodev driver, containing the driver ID */
  68 struct cryptodev_driver {
  69         TAILQ_ENTRY(cryptodev_driver) next; /**< Next in list. */
  70         const struct rte_driver *driver;
  71         uint8_t id;
  72 };
  73
  74 /** pointer to global crypto devices data structure. */
  75 extern struct rte_cryptodev_global *rte_cryptodev_globals;
  76
  77 /**
  78  * Get the rte_cryptodev structure device pointer for the device. Assumes a
  79  * valid device index.
  80  *
  81  * @param       dev_id  Device ID value to select the device structure.
  82  *
  83  * @return
  84  *   - The rte_cryptodev structure pointer for the given device ID.
  85  */
  86 struct rte_cryptodev *
  87 rte_cryptodev_pmd_get_dev(uint8_t dev_id);
  88
  89 /**
  90  * Get the rte_cryptodev structure device pointer for the named device.
  91  *
  92  * @param       name    device name to select the device structure.
  93  *
  94  * @return
  95  *   - The rte_cryptodev structure pointer for the given device ID.
  96  */
  97 struct rte_cryptodev *
  98 rte_cryptodev_pmd_get_named_dev(const char *name);
  99
 100 /**
 101  * Validate if the crypto device index is valid attached crypto device.
 102  *
 103  * @param       dev_id  Crypto device index.
 104  *
 105  * @return
 106  *   - If the device index is valid (1) or not (0).
 107  */
 108 unsigned int
 109 rte_cryptodev_pmd_is_valid_dev(uint8_t dev_id);
 110
 111 /**
 112  * The pool of rte_cryptodev structures.
 113  */
 114 extern struct rte_cryptodev *rte_cryptodevs;
 115
 116
 117 /**
 118  * Definitions of all functions exported by a driver through the
 119  * the generic structure of type *crypto_dev_ops* supplied in the
 120  * *rte_cryptodev* structure associated with a device.
 121  */
 122
 123 /**
 124  *      Function used to configure device.
 125  *
 126  * @param       dev     Crypto device pointer
 127  *              config  Crypto device configurations
 128  *
 129  * @return      Returns 0 on success
 130  */
 131 typedef int (*cryptodev_configure_t)(struct rte_cryptodev *dev,
 132                 struct rte_cryptodev_config *config);
 133
 134 /**
 135  * Function used to start a configured device.
 136  *
 137  * @param       dev     Crypto device pointer
 138  *
 139  * @return      Returns 0 on success
 140  */
 141 typedef int (*cryptodev_start_t)(struct rte_cryptodev *dev);
 142
 143 /**
 144  * Function used to stop a configured device.
 145  *
 146  * @param       dev     Crypto device pointer
 147  */
 148 typedef void (*cryptodev_stop_t)(struct rte_cryptodev *dev);
 149
 150 /**
 151  * Function used to close a configured device.
 152  *
 153  * @param       dev     Crypto device pointer
 154  * @return
 155  * - 0 on success.
 156  * - EAGAIN if can't close as device is busy
 157  */
 158 typedef int (*cryptodev_close_t)(struct rte_cryptodev *dev);
 159
 160
 161 /**
 162  * Function used to get statistics of a device.
 163  *
 164  * @param       dev     Crypto device pointer
 165  * @param       stats   Pointer to crypto device stats structure to populate
 166  */
 167 typedef void (*cryptodev_stats_get_t)(struct rte_cryptodev *dev,
 168                                 struct rte_cryptodev_stats *stats);
 169
 170
 171 /**
 172  * Function used to reset statistics of a device.
 173  *
 174  * @param       dev     Crypto device pointer
 175  */
 176 typedef void (*cryptodev_stats_reset_t)(struct rte_cryptodev *dev);
 177
 178
 179 /**
 180  * Function used to get specific information of a device.
 181  *
 182  * @param       dev     Crypto device pointer
 183  */
 184 typedef void (*cryptodev_info_get_t)(struct rte_cryptodev *dev,
 185                                 struct rte_cryptodev_info *dev_info);
 186
 187 /**
 188  * Setup a queue pair for a device.
 189  *
 190  * @param       dev             Crypto device pointer
 191  * @param       qp_id           Queue Pair Index
 192  * @param       qp_conf         Queue configuration structure
 193  * @param       socket_id       Socket Index
 194  * @param       session_pool    Pointer to device session mempool
 195  *
 196  * @return      Returns 0 on success.
 197  */
 198 typedef int (*cryptodev_queue_pair_setup_t)(struct rte_cryptodev *dev,
 199                 uint16_t qp_id, const struct rte_cryptodev_qp_conf *qp_conf,
 200                 int socket_id, struct rte_mempool *session_pool);
 201
 202 /**
 203  * Release memory resources allocated by given queue pair.
 204  *
 205  * @param       dev     Crypto device pointer
 206  * @param       qp_id   Queue Pair Index
 207  *
 208  * @return
 209  * - 0 on success.
 210  * - EAGAIN if can't close as device is busy
 211  */
 212 typedef int (*cryptodev_queue_pair_release_t)(struct rte_cryptodev *dev,
 213                 uint16_t qp_id);
 214
 215 /**
 216  * Get number of available queue pairs of a device.
 217  *
 218  * @param       dev     Crypto device pointer
 219  *
 220  * @return      Returns number of queue pairs on success.
 221  */
 222 typedef uint32_t (*cryptodev_queue_pair_count_t)(struct rte_cryptodev *dev);
 223
 224 /**
 225  * Create a session mempool to allocate sessions from
 226  *
 227  * @param       dev             Crypto device pointer
 228  * @param       nb_objs         number of sessions objects in mempool
 229  * @param       obj_cache       l-core object cache size, see *rte_ring_create*
 230  * @param       socket_id       Socket Id to allocate  mempool on.
 231  *
 232  * @return
 233  * - On success returns a pointer to a rte_mempool
 234  * - On failure returns a NULL pointer
 235  */
 236 typedef int (*cryptodev_sym_create_session_pool_t)(
 237                 struct rte_cryptodev *dev, unsigned nb_objs,
 238                 unsigned obj_cache_size, int socket_id);
 239
 240
 241 /**
 242  * Get the size of a cryptodev session
 243  *
 244  * @param       dev             Crypto device pointer
 245  *
 246  * @return
 247  *  - On success returns the size of the session structure for device
 248  *  - On failure returns 0
 249  */
 250 typedef unsigned (*cryptodev_sym_get_session_private_size_t)(
 251                 struct rte_cryptodev *dev);
 252
 253 /**
 254  * Configure a Crypto session on a device.
 255  *
 256  * @param       dev             Crypto device pointer
 257  * @param       xform           Single or chain of crypto xforms
 258  * @param       priv_sess       Pointer to cryptodev's private session structure
 259  * @param       mp              Mempool where the private session is allocated
 260  *
 261  * @return
 262  *  - Returns 0 if private session structure have been created successfully.
 263  *  - Returns -EINVAL if input parameters are invalid.
 264  *  - Returns -ENOTSUP if crypto device does not support the crypto transform.
 265  *  - Returns -ENOMEM if the private session could not be allocated.
 266  */
 267 typedef int (*cryptodev_sym_configure_session_t)(struct rte_cryptodev *dev,
 268                 struct rte_crypto_sym_xform *xform,
 269                 struct rte_cryptodev_sym_session *session,
 270                 struct rte_mempool *mp);
 271
 272 /**
 273  * Free driver private session data.
 274  *
 275  * @param       dev             Crypto device pointer
 276  * @param       sess            Cryptodev session structure
 277  */
 278 typedef void (*cryptodev_sym_free_session_t)(struct rte_cryptodev *dev,
 279                 struct rte_cryptodev_sym_session *sess);
 280
 281 /**
 282  * Optional API for drivers to attach sessions with queue pair.
 283  * @param       dev             Crypto device pointer
 284  * @param       qp_id           queue pair id for attaching session
 285  * @param       priv_sess       Pointer to cryptodev's private session structure
 286  * @return
 287  *  - Return 0 on success
 288  */
 289 typedef int (*cryptodev_sym_queue_pair_attach_session_t)(
 290                   struct rte_cryptodev *dev,
 291                   uint16_t qp_id,
 292                   void *session_private);
 293
 294 /**
 295  * Optional API for drivers to detach sessions from queue pair.
 296  * @param       dev             Crypto device pointer
 297  * @param       qp_id           queue pair id for detaching session
 298  * @param       priv_sess       Pointer to cryptodev's private session structure
 299  * @return
 300  *  - Return 0 on success
 301  */
 302 typedef int (*cryptodev_sym_queue_pair_detach_session_t)(
 303                   struct rte_cryptodev *dev,
 304                   uint16_t qp_id,
 305                   void *session_private);
 306
 307 /** Crypto device operations function pointer table */
 308 struct rte_cryptodev_ops {
 309         cryptodev_configure_t dev_configure;    /**< Configure device. */
 310         cryptodev_start_t dev_start;            /**< Start device. */
 311         cryptodev_stop_t dev_stop;              /**< Stop device. */
 312         cryptodev_close_t dev_close;            /**< Close device. */
 313
 314         cryptodev_info_get_t dev_infos_get;     /**< Get device info. */
 315
 316         cryptodev_stats_get_t stats_get;
 317         /**< Get device statistics. */
 318         cryptodev_stats_reset_t stats_reset;
 319         /**< Reset device statistics. */
 320
 321         cryptodev_queue_pair_setup_t queue_pair_setup;
 322         /**< Set up a device queue pair. */
 323         cryptodev_queue_pair_release_t queue_pair_release;
 324         /**< Release a queue pair. */
 325         cryptodev_queue_pair_count_t queue_pair_count;
 326         /**< Get count of the queue pairs. */
 327
 328         cryptodev_sym_get_session_private_size_t session_get_size;
 329         /**< Return private session. */
 330         cryptodev_sym_configure_session_t session_configure;
 331         /**< Configure a Crypto session. */
 332         cryptodev_sym_free_session_t session_clear;
 333         /**< Clear a Crypto sessions private data. */
 334         cryptodev_sym_queue_pair_attach_session_t qp_attach_session;
 335         /**< Attach session to queue pair. */
 336         cryptodev_sym_queue_pair_detach_session_t qp_detach_session;
 337         /**< Detach session from queue pair. */
 338 };
 339
 340
 341 /**
 342  * Function for internal use by dummy drivers primarily, e.g. ring-based
 343  * driver.
 344  * Allocates a new cryptodev slot for an crypto device and returns the pointer
 345  * to that slot for the driver to use.
 346  *
 347  * @param       name            Unique identifier name for each device
 348  * @param       socket_id       Socket to allocate resources on.
 349  * @return
 350  *   - Slot in the rte_dev_devices array for a new device;
 351  */
 352 struct rte_cryptodev *
 353 rte_cryptodev_pmd_allocate(const char *name, int socket_id);
 354
 355 /**
 356  * Function for internal use by dummy drivers primarily, e.g. ring-based
 357  * driver.
 358  * Release the specified cryptodev device.
 359  *
 360  * @param cryptodev
 361  * The *cryptodev* pointer is the address of the *rte_cryptodev* structure.
 362  * @return
 363  *   - 0 on success, negative on error
 364  */
 365 extern int
 366 rte_cryptodev_pmd_release_device(struct rte_cryptodev *cryptodev);
 367
 368
 369 /**
 370  * @internal
 371  *
 372  * PMD assist function to parse initialisation arguments for crypto driver
 373  * when creating a new crypto PMD device instance.
 374  *
 375  * PMD driver should set default values for that PMD before calling function,
 376  * these default values will be over-written with successfully parsed values
 377  * from args string.
 378  *
 379  * @param       params  parsed PMD initialisation parameters
 380  * @param       args    input argument string to parse
 381  *
 382  * @return
 383  *  - 0 on success
 384  *  - errno on failure
 385  */
 386 int
 387 rte_cryptodev_pmd_parse_input_args(
 388                 struct rte_cryptodev_pmd_init_params *params,
 389                 const char *args);
 390
 391 /**
 392  * @internal
 393  *
 394  * PMD assist function to provide boiler plate code for crypto driver to create
 395  * and allocate resources for a new crypto PMD device instance.
 396  *
 397  * @param       name    crypto device name.
 398  * @param       device  base device instance
 399  * @param       params  PMD initialisation parameters
 400  *
 401  * @return
 402  *  - crypto device instance on success
 403  *  - NULL on creation failure
 404  */
 405 struct rte_cryptodev *
 406 rte_cryptodev_pmd_create(const char *name,
 407                 struct rte_device *device,
 408                 struct rte_cryptodev_pmd_init_params *params);
 409
 410 /**
 411  * @internal
 412  *
 413  * PMD assist function to provide boiler plate code for crypto driver to
 414  * destroy and free resources associated with a crypto PMD device instance.
 415  *
 416  * @param       cryptodev       crypto device handle.
 417  *
 418  * @return
 419  *  - 0 on success
 420  *  - errno on failure
 421  */
 422 int
 423 rte_cryptodev_pmd_destroy(struct rte_cryptodev *cryptodev);
 424
 425 /**
 426  * Executes all the user application registered callbacks for the specific
 427  * device.
 428  *  *
 429  * @param       dev     Pointer to cryptodev struct
 430  * @param       event   Crypto device interrupt event type.
 431  *
 432  * @return
 433  *  void
 434  */
 435 void rte_cryptodev_pmd_callback_process(struct rte_cryptodev *dev,
 436                                 enum rte_cryptodev_event_type event);
 437
 438 /**
 439  * @internal
 440  * Create unique device name
 441  */
 442 int
 443 rte_cryptodev_pmd_create_dev_name(char *name, const char *dev_name_prefix);
 444
 445 /**
 446  * @internal
 447  * Allocate Cryptodev driver.
 448  *
 449  * @param crypto_drv
 450  *   Pointer to cryptodev_driver.
 451  * @param drv
 452  *   Pointer to rte_driver.
 453  *
 454  * @return
 455  *  The driver type identifier
 456  */
 457 uint8_t rte_cryptodev_allocate_driver(struct cryptodev_driver *crypto_drv,
 458                 const struct rte_driver *drv);
 459
 460
 461 #define RTE_PMD_REGISTER_CRYPTO_DRIVER(crypto_drv, drv, driver_id)\
 462 RTE_INIT(init_ ##driver_id);\
 463 static void init_ ##driver_id(void)\
 464 {\
 465         driver_id = rte_cryptodev_allocate_driver(&crypto_drv, &(drv));\
 466 }
 467
 468 static inline void *
 469 get_session_private_data(const struct rte_cryptodev_sym_session *sess,
 470                 uint8_t driver_id) {
 471         return sess->sess_private_data[driver_id];
 472 }
 473
 474 static inline void
 475 set_session_private_data(struct rte_cryptodev_sym_session *sess,
 476                 uint8_t driver_id, void *private_data)
 477 {
 478         sess->sess_private_data[driver_id] = private_data;
 479 }
 480
 481 #ifdef __cplusplus
 482 }
 483 #endif
 484
 485 #endif /* _RTE_CRYPTODEV_PMD_H_ */