DPDK  20.11.6
rte_cryptodev_pmd.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2015-2020 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  NULL
46 };
47 
52 struct rte_cryptodev_pmd_init_params {
53  char name[RTE_CRYPTODEV_NAME_MAX_LEN];
54  size_t private_data_size;
55  int socket_id;
56  unsigned int max_nb_queue_pairs;
57 };
58 
61  struct rte_cryptodev *devs;
62  struct rte_cryptodev_data *data[RTE_CRYPTO_MAX_DEVS];
64  uint8_t nb_devs;
65 };
66 
67 /* Cryptodev driver, containing the driver ID */
68 struct cryptodev_driver {
69  TAILQ_ENTRY(cryptodev_driver) next;
70  const struct rte_driver *driver;
71  uint8_t id;
72 };
73 
83 struct rte_cryptodev *
84 rte_cryptodev_pmd_get_dev(uint8_t dev_id);
85 
94 struct rte_cryptodev *
95 rte_cryptodev_pmd_get_named_dev(const char *name);
96 
105 unsigned int
106 rte_cryptodev_pmd_is_valid_dev(uint8_t dev_id);
107 
111 extern struct rte_cryptodev *rte_cryptodevs;
112 
113 
128 typedef int (*cryptodev_configure_t)(struct rte_cryptodev *dev,
129  struct rte_cryptodev_config *config);
130 
138 typedef int (*cryptodev_start_t)(struct rte_cryptodev *dev);
139 
145 typedef void (*cryptodev_stop_t)(struct rte_cryptodev *dev);
146 
155 typedef int (*cryptodev_close_t)(struct rte_cryptodev *dev);
156 
157 
164 typedef void (*cryptodev_stats_get_t)(struct rte_cryptodev *dev,
165  struct rte_cryptodev_stats *stats);
166 
167 
173 typedef void (*cryptodev_stats_reset_t)(struct rte_cryptodev *dev);
174 
175 
182 typedef void (*cryptodev_info_get_t)(struct rte_cryptodev *dev,
183  struct rte_cryptodev_info *dev_info);
184 
195 typedef int (*cryptodev_queue_pair_setup_t)(struct rte_cryptodev *dev,
196  uint16_t qp_id, const struct rte_cryptodev_qp_conf *qp_conf,
197  int socket_id);
198 
210  uint16_t qp_id);
211 
225  struct rte_cryptodev *dev, unsigned nb_objs,
226  unsigned obj_cache_size, int socket_id);
227 
228 
239  struct rte_cryptodev *dev);
250  struct rte_cryptodev *dev);
251 
267  struct rte_crypto_sym_xform *xform,
268  struct rte_cryptodev_sym_session *session,
269  struct rte_mempool *mp);
285  struct rte_crypto_asym_xform *xform,
286  struct rte_cryptodev_asym_session *session,
287  struct rte_mempool *mp);
294 typedef void (*cryptodev_sym_free_session_t)(struct rte_cryptodev *dev,
295  struct rte_cryptodev_sym_session *sess);
302 typedef void (*cryptodev_asym_free_session_t)(struct rte_cryptodev *dev,
303  struct rte_cryptodev_asym_session *sess);
317 typedef uint32_t (*cryptodev_sym_cpu_crypto_process_t)
318  (struct rte_cryptodev *dev, struct rte_cryptodev_sym_session *sess,
319  union rte_crypto_sym_ofs ofs, struct rte_crypto_sym_vec *vec);
320 
331 
352  struct rte_cryptodev *dev, uint16_t qp_id,
353  struct rte_crypto_raw_dp_ctx *ctx,
354  enum rte_crypto_op_sess_type sess_type,
355  union rte_cryptodev_session_ctx session_ctx, uint8_t is_update);
356 
388  union {
391  __extension__
392  struct {
399  };
400  };
401 };
402 
403 
415 struct rte_cryptodev *
416 rte_cryptodev_pmd_allocate(const char *name, int socket_id);
417 
428 extern int
430 
431 
449 int
450 rte_cryptodev_pmd_parse_input_args(
451  struct rte_cryptodev_pmd_init_params *params,
452  const char *args);
453 
468 struct rte_cryptodev *
469 rte_cryptodev_pmd_create(const char *name,
470  struct rte_device *device,
471  struct rte_cryptodev_pmd_init_params *params);
472 
485 int
486 rte_cryptodev_pmd_destroy(struct rte_cryptodev *cryptodev);
487 
499  enum rte_cryptodev_event_type event);
500 
505 int
506 rte_cryptodev_pmd_create_dev_name(char *name, const char *dev_name_prefix);
507 
520 uint8_t rte_cryptodev_allocate_driver(struct cryptodev_driver *crypto_drv,
521  const struct rte_driver *drv);
522 
523 
524 #define RTE_PMD_REGISTER_CRYPTO_DRIVER(crypto_drv, drv, driver_id)\
525 RTE_INIT(init_ ##driver_id)\
526 {\
527  driver_id = rte_cryptodev_allocate_driver(&crypto_drv, &(drv));\
528 }
529 
530 static inline void *
531 get_sym_session_private_data(const struct rte_cryptodev_sym_session *sess,
532  uint8_t driver_id) {
533  if (unlikely(sess->nb_drivers <= driver_id))
534  return NULL;
535 
536  return sess->sess_data[driver_id].data;
537 }
538 
539 static inline void
540 set_sym_session_private_data(struct rte_cryptodev_sym_session *sess,
541  uint8_t driver_id, void *private_data)
542 {
543  if (unlikely(sess->nb_drivers <= driver_id)) {
544  CDEV_LOG_ERR("Set private data for driver %u not allowed\n",
545  driver_id);
546  return;
547  }
548 
549  sess->sess_data[driver_id].data = private_data;
550 }
551 
552 static inline void *
553 get_asym_session_private_data(const struct rte_cryptodev_asym_session *sess,
554  uint8_t driver_id) {
555  return sess->sess_private_data[driver_id];
556 }
557 
558 static inline void
559 set_asym_session_private_data(struct rte_cryptodev_asym_session *sess,
560  uint8_t driver_id, void *private_data)
561 {
562  sess->sess_private_data[driver_id] = private_data;
563 }
564 
565 #ifdef __cplusplus
566 }
567 #endif
568 
569 #endif /* _RTE_CRYPTODEV_PMD_H_ */
void(* cryptodev_stop_t)(struct rte_cryptodev *dev)
int(* cryptodev_sym_configure_raw_dp_ctx_t)(struct rte_cryptodev *dev, uint16_t qp_id, struct rte_crypto_raw_dp_ctx *ctx, enum rte_crypto_op_sess_type sess_type, union rte_cryptodev_session_ctx session_ctx, uint8_t is_update)
void(* cryptodev_info_get_t)(struct rte_cryptodev *dev, struct rte_cryptodev_info *dev_info)
cryptodev_close_t dev_close
unsigned int(* cryptodev_asym_get_session_private_size_t)(struct rte_cryptodev *dev)
int rte_cryptodev_pmd_release_device(struct rte_cryptodev *cryptodev)
void(* cryptodev_asym_free_session_t)(struct rte_cryptodev *dev, struct rte_cryptodev_asym_session *sess)
cryptodev_stop_t dev_stop
cryptodev_asym_get_session_private_size_t asym_session_get_size
struct rte_cryptodev * devs
cryptodev_sym_get_session_private_size_t sym_session_get_size
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)
uint32_t(* cryptodev_sym_cpu_crypto_process_t)(struct rte_cryptodev *dev, struct rte_cryptodev_sym_session *sess, union rte_crypto_sym_ofs ofs, struct rte_crypto_sym_vec *vec)
uint8_t driver_id
cryptodev_sym_configure_session_t sym_session_configure
__extension__ void * sess_private_data[0]
struct rte_cryptodev * rte_cryptodev_pmd_get_named_dev(const char *name)
#define unlikely(x)
#define RTE_CRYPTODEV_NAME_MAX_LEN
cryptodev_sym_free_session_t sym_session_clear
struct rte_cryptodev * rte_cryptodev_pmd_get_dev(uint8_t dev_id)
unsigned(* cryptodev_sym_get_session_private_size_t)(struct rte_cryptodev *dev)
struct rte_cryptodev * rte_cryptodev_pmd_allocate(const char *name, int socket_id)
int(* cryptodev_configure_t)(struct rte_cryptodev *dev, struct rte_cryptodev_config *config)
cryptodev_sym_cpu_crypto_process_t sym_cpu_process
void rte_cryptodev_pmd_callback_process(struct rte_cryptodev *dev, enum rte_cryptodev_event_type event)
unsigned int rte_cryptodev_pmd_is_valid_dev(uint8_t dev_id)
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)
int(* cryptodev_queue_pair_release_t)(struct rte_cryptodev *dev, uint16_t qp_id)
cryptodev_stats_get_t stats_get
cryptodev_asym_configure_session_t asym_session_configure
int(* cryptodev_sym_create_session_pool_t)(struct rte_cryptodev *dev, unsigned nb_objs, unsigned obj_cache_size, int socket_id)
cryptodev_configure_t dev_configure
rte_crypto_op_sess_type
Definition: rte_crypto.h:62
void(* cryptodev_stats_reset_t)(struct rte_cryptodev *dev)
cryptodev_info_get_t dev_infos_get
cryptodev_start_t dev_start
int(* cryptodev_close_t)(struct rte_cryptodev *dev)
struct rte_device * device
cryptodev_stats_reset_t stats_reset
rte_cryptodev_event_type
cryptodev_queue_pair_setup_t queue_pair_setup
cryptodev_sym_get_raw_dp_ctx_size_t sym_get_raw_dp_ctx_size
void(* cryptodev_stats_get_t)(struct rte_cryptodev *dev, struct rte_cryptodev_stats *stats)
void(* cryptodev_sym_free_session_t)(struct rte_cryptodev *dev, struct rte_cryptodev_sym_session *sess)
cryptodev_queue_pair_release_t queue_pair_release
int(* cryptodev_sym_get_raw_dp_ctx_size_t)(struct rte_cryptodev *dev)
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)
__extension__ struct rte_cryptodev_sym_session::@146 sess_data[0]
cryptodev_asym_free_session_t asym_session_clear
struct rte_cryptodev * rte_cryptodevs
cryptodev_sym_configure_raw_dp_ctx_t sym_configure_raw_dp_ctx
int(* cryptodev_start_t)(struct rte_cryptodev *dev)