DPDK  19.11.1
rte_cryptodev_pmd.h
Go to the documentation of this file.
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 
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 
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 
60  struct rte_cryptodev *devs;
61  struct rte_cryptodev_data *data[RTE_CRYPTO_MAX_DEVS];
63  uint8_t nb_devs;
64 };
65 
66 /* Cryptodev driver, containing the driver ID */
67 struct cryptodev_driver {
68  TAILQ_ENTRY(cryptodev_driver) next;
69  const struct rte_driver *driver;
70  uint8_t id;
71 };
72 
82 struct rte_cryptodev *
83 rte_cryptodev_pmd_get_dev(uint8_t dev_id);
84 
93 struct rte_cryptodev *
94 rte_cryptodev_pmd_get_named_dev(const char *name);
95 
104 unsigned int
105 rte_cryptodev_pmd_is_valid_dev(uint8_t dev_id);
106 
110 extern struct rte_cryptodev *rte_cryptodevs;
111 
112 
127 typedef int (*cryptodev_configure_t)(struct rte_cryptodev *dev,
128  struct rte_cryptodev_config *config);
129 
137 typedef int (*cryptodev_start_t)(struct rte_cryptodev *dev);
138 
144 typedef void (*cryptodev_stop_t)(struct rte_cryptodev *dev);
145 
154 typedef int (*cryptodev_close_t)(struct rte_cryptodev *dev);
155 
156 
163 typedef void (*cryptodev_stats_get_t)(struct rte_cryptodev *dev,
164  struct rte_cryptodev_stats *stats);
165 
166 
172 typedef void (*cryptodev_stats_reset_t)(struct rte_cryptodev *dev);
173 
174 
180 typedef void (*cryptodev_info_get_t)(struct rte_cryptodev *dev,
181  struct rte_cryptodev_info *dev_info);
182 
193 typedef int (*cryptodev_queue_pair_setup_t)(struct rte_cryptodev *dev,
194  uint16_t qp_id, const struct rte_cryptodev_qp_conf *qp_conf,
195  int socket_id);
196 
208  uint16_t qp_id);
209 
217 typedef uint32_t (*cryptodev_queue_pair_count_t)(struct rte_cryptodev *dev);
218 
232  struct rte_cryptodev *dev, unsigned nb_objs,
233  unsigned obj_cache_size, int socket_id);
234 
235 
246  struct rte_cryptodev *dev);
257  struct rte_cryptodev *dev);
258 
274  struct rte_crypto_sym_xform *xform,
275  struct rte_cryptodev_sym_session *session,
276  struct rte_mempool *mp);
292  struct rte_crypto_asym_xform *xform,
293  struct rte_cryptodev_asym_session *session,
294  struct rte_mempool *mp);
301 typedef void (*cryptodev_sym_free_session_t)(struct rte_cryptodev *dev,
302  struct rte_cryptodev_sym_session *sess);
309 typedef void (*cryptodev_asym_free_session_t)(struct rte_cryptodev *dev,
310  struct rte_cryptodev_asym_session *sess);
311 
345 };
346 
347 
359 struct rte_cryptodev *
360 rte_cryptodev_pmd_allocate(const char *name, int socket_id);
361 
372 extern int
374 
375 
393 int
394 rte_cryptodev_pmd_parse_input_args(
395  struct rte_cryptodev_pmd_init_params *params,
396  const char *args);
397 
412 struct rte_cryptodev *
413 rte_cryptodev_pmd_create(const char *name,
414  struct rte_device *device,
415  struct rte_cryptodev_pmd_init_params *params);
416 
429 int
430 rte_cryptodev_pmd_destroy(struct rte_cryptodev *cryptodev);
431 
443  enum rte_cryptodev_event_type event);
444 
449 int
450 rte_cryptodev_pmd_create_dev_name(char *name, const char *dev_name_prefix);
451 
464 uint8_t rte_cryptodev_allocate_driver(struct cryptodev_driver *crypto_drv,
465  const struct rte_driver *drv);
466 
467 
468 #define RTE_PMD_REGISTER_CRYPTO_DRIVER(crypto_drv, drv, driver_id)\
469 RTE_INIT(init_ ##driver_id)\
470 {\
471  driver_id = rte_cryptodev_allocate_driver(&crypto_drv, &(drv));\
472 }
473 
474 static inline void *
475 get_sym_session_private_data(const struct rte_cryptodev_sym_session *sess,
476  uint8_t driver_id) {
477  if (unlikely(sess->nb_drivers <= driver_id))
478  return NULL;
479 
480  return sess->sess_data[driver_id].data;
481 }
482 
483 static inline void
484 set_sym_session_private_data(struct rte_cryptodev_sym_session *sess,
485  uint8_t driver_id, void *private_data)
486 {
487  if (unlikely(sess->nb_drivers <= driver_id)) {
488  CDEV_LOG_ERR("Set private data for driver %u not allowed\n",
489  driver_id);
490  return;
491  }
492 
493  sess->sess_data[driver_id].data = private_data;
494 }
495 
496 static inline void *
497 get_asym_session_private_data(const struct rte_cryptodev_asym_session *sess,
498  uint8_t driver_id) {
499  return sess->sess_private_data[driver_id];
500 }
501 
502 static inline void
503 set_asym_session_private_data(struct rte_cryptodev_asym_session *sess,
504  uint8_t driver_id, void *private_data)
505 {
506  sess->sess_private_data[driver_id] = private_data;
507 }
508 
509 #ifdef __cplusplus
510 }
511 #endif
512 
513 #endif /* _RTE_CRYPTODEV_PMD_H_ */
cryptodev_sym_free_session_t
void(* cryptodev_sym_free_session_t)(struct rte_cryptodev *dev, struct rte_cryptodev_sym_session *sess)
Definition: rte_cryptodev_pmd.h:301
cryptodev_info_get_t
void(* cryptodev_info_get_t)(struct rte_cryptodev *dev, struct rte_cryptodev_info *dev_info)
Definition: rte_cryptodev_pmd.h:180
rte_cryptodev_ops::queue_pair_setup
cryptodev_queue_pair_setup_t queue_pair_setup
Definition: rte_cryptodev_pmd.h:326
rte_cryptodev_info
Definition: rte_cryptodev.h:468
rte_driver
Definition: rte_dev.h:89
rte_cryptodev_pmd_release_device
int rte_cryptodev_pmd_release_device(struct rte_cryptodev *cryptodev)
cryptodev_stop_t
void(* cryptodev_stop_t)(struct rte_cryptodev *dev)
Definition: rte_cryptodev_pmd.h:144
rte_cryptodev_ops::asym_session_get_size
cryptodev_asym_get_session_private_size_t asym_session_get_size
Definition: rte_cryptodev_pmd.h:335
rte_malloc.h
rte_cryptodev_ops::queue_pair_release
cryptodev_queue_pair_release_t queue_pair_release
Definition: rte_cryptodev_pmd.h:328
unlikely
#define unlikely(x)
Definition: rte_branch_prediction.h:38
rte_crypto.h
rte_cryptodev
Definition: rte_cryptodev.h:817
rte_cryptodev_ops::dev_configure
cryptodev_configure_t dev_configure
Definition: rte_cryptodev_pmd.h:314
rte_cryptodev_global::nb_devs
uint8_t nb_devs
Definition: rte_cryptodev_pmd.h:63
rte_log.h
cryptodev_asym_free_session_t
void(* cryptodev_asym_free_session_t)(struct rte_cryptodev *dev, struct rte_cryptodev_asym_session *sess)
Definition: rte_cryptodev_pmd.h:309
rte_cryptodev_sym_session::nb_drivers
uint16_t nb_drivers
Definition: rte_cryptodev.h:977
rte_cryptodev_global::data
struct rte_cryptodev_data * data[RTE_CRYPTO_MAX_DEVS]
Definition: rte_cryptodev_pmd.h:61
RTE_CRYPTODEV_NAME_MAX_LEN
#define RTE_CRYPTODEV_NAME_MAX_LEN
Definition: rte_cryptodev.h:542
rte_cryptodev.h
rte_cryptodev_ops::dev_close
cryptodev_close_t dev_close
Definition: rte_cryptodev_pmd.h:317
rte_cryptodev_ops::stats_get
cryptodev_stats_get_t stats_get
Definition: rte_cryptodev_pmd.h:321
rte_cryptodev_qp_conf
Definition: rte_cryptodev.h:508
rte_cryptodev_ops::asym_session_clear
cryptodev_asym_free_session_t asym_session_clear
Definition: rte_cryptodev_pmd.h:343
cryptodev_sym_configure_session_t
int(* cryptodev_sym_configure_session_t)(struct rte_cryptodev *dev, struct rte_crypto_sym_xform *xform, struct rte_cryptodev_sym_session *session, struct rte_mempool *mp)
Definition: rte_cryptodev_pmd.h:273
rte_cryptodev_pmd_callback_process
void rte_cryptodev_pmd_callback_process(struct rte_cryptodev *dev, enum rte_cryptodev_event_type event)
rte_cryptodev_ops::stats_reset
cryptodev_stats_reset_t stats_reset
Definition: rte_cryptodev_pmd.h:323
rte_cryptodev_global::devs
struct rte_cryptodev * devs
Definition: rte_cryptodev_pmd.h:60
cryptodev_queue_pair_count_t
uint32_t(* cryptodev_queue_pair_count_t)(struct rte_cryptodev *dev)
Definition: rte_cryptodev_pmd.h:217
rte_cryptodev_global
Definition: rte_cryptodev_pmd.h:59
rte_cryptodev_sym_session::sess_data
__extension__ struct rte_cryptodev_sym_session::@130 sess_data[0]
rte_cryptodev_pmd_allocate
struct rte_cryptodev * rte_cryptodev_pmd_allocate(const char *name, int socket_id)
rte_cryptodev_pmd_is_valid_dev
unsigned int rte_cryptodev_pmd_is_valid_dev(uint8_t dev_id)
rte_cryptodev_event_type
rte_cryptodev_event_type
Definition: rte_cryptodev.h:501
rte_cryptodev_pmd_get_named_dev
struct rte_cryptodev * rte_cryptodev_pmd_get_named_dev(const char *name)
rte_common.h
cryptodev_queue_pair_setup_t
int(* cryptodev_queue_pair_setup_t)(struct rte_cryptodev *dev, uint16_t qp_id, const struct rte_cryptodev_qp_conf *qp_conf, int socket_id)
Definition: rte_cryptodev_pmd.h:193
rte_cryptodev_pmd_get_dev
struct rte_cryptodev * rte_cryptodev_pmd_get_dev(uint8_t dev_id)
cryptodev_close_t
int(* cryptodev_close_t)(struct rte_cryptodev *dev)
Definition: rte_cryptodev_pmd.h:154
cryptodev_configure_t
int(* cryptodev_configure_t)(struct rte_cryptodev *dev, struct rte_cryptodev_config *config)
Definition: rte_cryptodev_pmd.h:127
rte_cryptodev_asym_session
Definition: rte_cryptodev.h:989
rte_cryptodev_ops::dev_infos_get
cryptodev_info_get_t dev_infos_get
Definition: rte_cryptodev_pmd.h:319
rte_crypto_sym_xform
Definition: rte_crypto_sym.h:440
rte_cryptodev_ops::dev_start
cryptodev_start_t dev_start
Definition: rte_cryptodev_pmd.h:315
rte_mempool
Definition: rte_mempool.h:216
rte_cryptodev::device
struct rte_device * device
Definition: rte_cryptodev.h:829
rte_cryptodev_ops::asym_session_configure
cryptodev_asym_configure_session_t asym_session_configure
Definition: rte_cryptodev_pmd.h:339
cryptodev_queue_pair_release_t
int(* cryptodev_queue_pair_release_t)(struct rte_cryptodev *dev, uint16_t qp_id)
Definition: rte_cryptodev_pmd.h:207
rte_cryptodev_sym_session
Definition: rte_cryptodev.h:974
cryptodev_sym_get_session_private_size_t
unsigned(* cryptodev_sym_get_session_private_size_t)(struct rte_cryptodev *dev)
Definition: rte_cryptodev_pmd.h:245
rte_mempool.h
cryptodev_stats_get_t
void(* cryptodev_stats_get_t)(struct rte_cryptodev *dev, struct rte_cryptodev_stats *stats)
Definition: rte_cryptodev_pmd.h:163
cryptodev_stats_reset_t
void(* cryptodev_stats_reset_t)(struct rte_cryptodev *dev)
Definition: rte_cryptodev_pmd.h:172
rte_cryptodev_stats
Definition: rte_cryptodev.h:530
rte_mbuf.h
rte_cryptodev_ops::sym_session_get_size
cryptodev_sym_get_session_private_size_t sym_session_get_size
Definition: rte_cryptodev_pmd.h:333
cryptodev_asym_configure_session_t
int(* cryptodev_asym_configure_session_t)(struct rte_cryptodev *dev, struct rte_crypto_asym_xform *xform, struct rte_cryptodev_asym_session *session, struct rte_mempool *mp)
Definition: rte_cryptodev_pmd.h:291
rte_cryptodevs
struct rte_cryptodev * rte_cryptodevs
rte_cryptodev_ops::dev_stop
cryptodev_stop_t dev_stop
Definition: rte_cryptodev_pmd.h:316
cryptodev_start_t
int(* cryptodev_start_t)(struct rte_cryptodev *dev)
Definition: rte_cryptodev_pmd.h:137
cryptodev_sym_create_session_pool_t
int(* cryptodev_sym_create_session_pool_t)(struct rte_cryptodev *dev, unsigned nb_objs, unsigned obj_cache_size, int socket_id)
Definition: rte_cryptodev_pmd.h:231
rte_cryptodev_ops::sym_session_clear
cryptodev_sym_free_session_t sym_session_clear
Definition: rte_cryptodev_pmd.h:341
rte_cryptodev_ops
Definition: rte_cryptodev_pmd.h:313
rte_device
Definition: rte_dev.h:104
rte_cryptodev_ops::sym_session_configure
cryptodev_sym_configure_session_t sym_session_configure
Definition: rte_cryptodev_pmd.h:337
rte_cryptodev_config
Definition: rte_cryptodev.h:619
rte_crypto_asym_xform
Definition: rte_crypto_asym.h:353
rte_cryptodev_data
Definition: rte_cryptodev.h:856
rte_cryptodev::driver_id
uint8_t driver_id
Definition: rte_cryptodev.h:832
cryptodev_asym_get_session_private_size_t
unsigned int(* cryptodev_asym_get_session_private_size_t)(struct rte_cryptodev *dev)
Definition: rte_cryptodev_pmd.h:256
rte_cryptodev_asym_session::sess_private_data
__extension__ void * sess_private_data[0]
Definition: rte_cryptodev.h:990
rte_cryptodev_ops::queue_pair_count
cryptodev_queue_pair_count_t queue_pair_count
Definition: rte_cryptodev_pmd.h:330
rte_dev.h