crypto/qat: define gen-specific structs and functions
[dpdk.git] / drivers / crypto / qat / qat_crypto.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2021 Intel Corporation
3  */
4
5  #ifndef _QAT_CRYPTO_H_
6  #define _QAT_CRYPTO_H_
7
8 #include <rte_cryptodev.h>
9 #ifdef RTE_LIB_SECURITY
10 #include <rte_security.h>
11 #endif
12
13 #include "qat_device.h"
14
15 extern uint8_t qat_sym_driver_id;
16 extern uint8_t qat_asym_driver_id;
17
18 /** helper macro to set cryptodev capability range **/
19 #define CAP_RNG(n, l, r, i) .n = {.min = l, .max = r, .increment = i}
20
21 #define CAP_RNG_ZERO(n) .n = {.min = 0, .max = 0, .increment = 0}
22 /** helper macro to set cryptodev capability value **/
23 #define CAP_SET(n, v) .n = v
24
25 /** private data structure for a QAT device.
26  * there can be one of these on each qat_pci_device (VF).
27  */
28 struct qat_cryptodev_private {
29         struct qat_pci_device *qat_dev;
30         /**< The qat pci device hosting the service */
31         uint8_t dev_id;
32         /**< Device instance for this rte_cryptodev */
33         const struct rte_cryptodev_capabilities *qat_dev_capabilities;
34         /* QAT device symmetric crypto capabilities */
35         const struct rte_memzone *capa_mz;
36         /* Shared memzone for storing capabilities */
37         uint16_t min_enq_burst_threshold;
38         uint32_t internal_capabilities; /* see flags QAT_SYM_CAP_xxx */
39         enum qat_service_type service_type;
40 };
41
42 struct qat_capabilities_info {
43         struct rte_cryptodev_capabilities *data;
44         uint64_t size;
45 };
46
47 typedef struct qat_capabilities_info (*get_capabilities_info_t)
48                         (struct qat_pci_device *qat_dev);
49
50 typedef uint64_t (*get_feature_flags_t)(struct qat_pci_device *qat_dev);
51
52 typedef void * (*create_security_ctx_t)(void *cryptodev);
53
54 struct qat_crypto_gen_dev_ops {
55         get_feature_flags_t get_feature_flags;
56         get_capabilities_info_t get_capabilities;
57         struct rte_cryptodev_ops *cryptodev_ops;
58 #ifdef RTE_LIB_SECURITY
59         create_security_ctx_t create_security_ctx;
60 #endif
61 };
62
63 int
64 qat_cryptodev_config(struct rte_cryptodev *dev,
65                 struct rte_cryptodev_config *config);
66
67 int
68 qat_cryptodev_start(struct rte_cryptodev *dev);
69
70 void
71 qat_cryptodev_stop(struct rte_cryptodev *dev);
72
73 int
74 qat_cryptodev_close(struct rte_cryptodev *dev);
75
76 void
77 qat_cryptodev_info_get(struct rte_cryptodev *dev,
78                 struct rte_cryptodev_info *info);
79
80 void
81 qat_cryptodev_stats_get(struct rte_cryptodev *dev,
82                 struct rte_cryptodev_stats *stats);
83
84 void
85 qat_cryptodev_stats_reset(struct rte_cryptodev *dev);
86
87 int
88 qat_cryptodev_qp_setup(struct rte_cryptodev *dev, uint16_t qp_id,
89         const struct rte_cryptodev_qp_conf *qp_conf, int socket_id);
90
91 int
92 qat_cryptodev_qp_release(struct rte_cryptodev *dev, uint16_t queue_pair_id);
93
94 #endif