crypto/qat: register appropriately named device
[dpdk.git] / drivers / crypto / qat / qat_sym_pmd.c
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2015-2018 Intel Corporation
3  */
4
5 #include <rte_bus_pci.h>
6 #include <rte_common.h>
7 #include <rte_dev.h>
8 #include <rte_malloc.h>
9 #include <rte_pci.h>
10 #include <rte_cryptodev_pmd.h>
11
12 #include "qat_logs.h"
13 #include "qat_sym.h"
14 #include "qat_sym_session.h"
15 #include "qat_sym_pmd.h"
16
17 uint8_t cryptodev_qat_driver_id;
18
19 static const struct rte_cryptodev_capabilities qat_gen1_sym_capabilities[] = {
20         QAT_BASE_GEN1_SYM_CAPABILITIES,
21         RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST()
22 };
23
24 static const struct rte_cryptodev_capabilities qat_gen2_sym_capabilities[] = {
25         QAT_BASE_GEN1_SYM_CAPABILITIES,
26         QAT_EXTRA_GEN2_SYM_CAPABILITIES,
27         RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST()
28 };
29
30 static int qat_sym_qp_release(struct rte_cryptodev *dev,
31         uint16_t queue_pair_id);
32
33 static int qat_sym_dev_config(__rte_unused struct rte_cryptodev *dev,
34                 __rte_unused struct rte_cryptodev_config *config)
35 {
36         PMD_INIT_FUNC_TRACE();
37         return 0;
38 }
39
40 static int qat_sym_dev_start(__rte_unused struct rte_cryptodev *dev)
41 {
42         PMD_INIT_FUNC_TRACE();
43         return 0;
44 }
45
46 static void qat_sym_dev_stop(__rte_unused struct rte_cryptodev *dev)
47 {
48         PMD_INIT_FUNC_TRACE();
49 }
50
51 static int qat_sym_dev_close(struct rte_cryptodev *dev)
52 {
53         int i, ret;
54
55         PMD_INIT_FUNC_TRACE();
56
57         for (i = 0; i < dev->data->nb_queue_pairs; i++) {
58                 ret = qat_sym_qp_release(dev, i);
59                 if (ret < 0)
60                         return ret;
61         }
62
63         return 0;
64 }
65
66 static void qat_sym_dev_info_get(struct rte_cryptodev *dev,
67                         struct rte_cryptodev_info *info)
68 {
69         struct qat_sym_dev_private *internals = dev->data->dev_private;
70         const struct qat_qp_hw_data *sym_hw_qps =
71                 qat_gen_config[internals->qat_dev->qat_dev_gen]
72                               .qp_hw_data[QAT_SERVICE_SYMMETRIC];
73
74         PMD_INIT_FUNC_TRACE();
75         if (info != NULL) {
76                 info->max_nb_queue_pairs =
77                         qat_qps_per_service(sym_hw_qps, QAT_SERVICE_SYMMETRIC);
78                 info->feature_flags = dev->feature_flags;
79                 info->capabilities = internals->qat_dev_capabilities;
80                 info->sym.max_nb_sessions = RTE_QAT_PMD_MAX_NB_SESSIONS;
81                 info->driver_id = cryptodev_qat_driver_id;
82                 info->pci_dev = RTE_DEV_TO_PCI(dev->device);
83         }
84 }
85
86 static void qat_sym_stats_get(struct rte_cryptodev *dev,
87                 struct rte_cryptodev_stats *stats)
88 {
89         struct qat_common_stats qat_stats = {0};
90         struct qat_sym_dev_private *qat_priv;
91
92         if (stats == NULL || dev == NULL) {
93                 PMD_DRV_LOG(ERR, "invalid ptr: stats %p, dev %p", stats, dev);
94                 return;
95         }
96         qat_priv = dev->data->dev_private;
97
98         qat_stats_get(qat_priv->qat_dev, &qat_stats, QAT_SERVICE_SYMMETRIC);
99         stats->enqueued_count = qat_stats.enqueued_count;
100         stats->dequeued_count = qat_stats.dequeued_count;
101         stats->enqueue_err_count = qat_stats.enqueue_err_count;
102         stats->dequeue_err_count = qat_stats.dequeue_err_count;
103 }
104
105 static void qat_sym_stats_reset(struct rte_cryptodev *dev)
106 {
107         struct qat_sym_dev_private *qat_priv;
108
109         if (dev == NULL) {
110                 PMD_DRV_LOG(ERR, "invalid cryptodev ptr %p", dev);
111                 return;
112         }
113         qat_priv = dev->data->dev_private;
114
115         qat_stats_reset(qat_priv->qat_dev, QAT_SERVICE_SYMMETRIC);
116
117 }
118
119 static int qat_sym_qp_release(struct rte_cryptodev *dev, uint16_t queue_pair_id)
120 {
121         struct qat_sym_dev_private *qat_private = dev->data->dev_private;
122
123         PMD_DRV_LOG(DEBUG, "Release sym qp %u on device %d",
124                                 queue_pair_id, dev->data->dev_id);
125
126         qat_private->qat_dev->qps_in_use[QAT_SERVICE_SYMMETRIC][queue_pair_id]
127                                                 = NULL;
128
129         return qat_qp_release((struct qat_qp **)
130                         &(dev->data->queue_pairs[queue_pair_id]));
131 }
132
133 static int qat_sym_qp_setup(struct rte_cryptodev *dev, uint16_t qp_id,
134         const struct rte_cryptodev_qp_conf *qp_conf,
135         int socket_id, struct rte_mempool *session_pool __rte_unused)
136 {
137         struct qat_qp *qp;
138         int ret = 0;
139         uint32_t i;
140         struct qat_qp_config qat_qp_conf;
141
142         struct qat_qp **qp_addr =
143                         (struct qat_qp **)&(dev->data->queue_pairs[qp_id]);
144         struct qat_sym_dev_private *qat_private = dev->data->dev_private;
145         const struct qat_qp_hw_data *sym_hw_qps =
146                         qat_gen_config[qat_private->qat_dev->qat_dev_gen]
147                                       .qp_hw_data[QAT_SERVICE_SYMMETRIC];
148         const struct qat_qp_hw_data *qp_hw_data = sym_hw_qps + qp_id;
149
150         /* If qp is already in use free ring memory and qp metadata. */
151         if (*qp_addr != NULL) {
152                 ret = qat_sym_qp_release(dev, qp_id);
153                 if (ret < 0)
154                         return ret;
155         }
156         if (qp_id >= qat_qps_per_service(sym_hw_qps, QAT_SERVICE_SYMMETRIC)) {
157                 PMD_DRV_LOG(ERR, "qp_id %u invalid for this device", qp_id);
158                 return -EINVAL;
159         }
160
161         qat_qp_conf.hw = qp_hw_data;
162         qat_qp_conf.build_request = qat_sym_build_request;
163         qat_qp_conf.process_response = qat_sym_process_response;
164         qat_qp_conf.cookie_size = sizeof(struct qat_sym_op_cookie);
165         qat_qp_conf.nb_descriptors = qp_conf->nb_descriptors;
166         qat_qp_conf.socket_id = socket_id;
167         qat_qp_conf.service_str = "sym";
168
169         ret = qat_qp_setup(qat_private->qat_dev, qp_addr, qp_id, &qat_qp_conf);
170         if (ret != 0)
171                 return ret;
172
173         /* store a link to the qp in the qat_pci_device */
174         qat_private->qat_dev->qps_in_use[QAT_SERVICE_SYMMETRIC][qp_id]
175                                                         = *qp_addr;
176
177         qp = (struct qat_qp *)*qp_addr;
178
179         for (i = 0; i < qp->nb_descriptors; i++) {
180
181                 struct qat_sym_op_cookie *cookie =
182                                 qp->op_cookies[i];
183
184                 cookie->qat_sgl_src_phys_addr =
185                                 rte_mempool_virt2iova(cookie) +
186                                 offsetof(struct qat_sym_op_cookie,
187                                 qat_sgl_src);
188
189                 cookie->qat_sgl_dst_phys_addr =
190                                 rte_mempool_virt2iova(cookie) +
191                                 offsetof(struct qat_sym_op_cookie,
192                                 qat_sgl_dst);
193         }
194
195         return ret;
196 }
197
198 static struct rte_cryptodev_ops crypto_qat_ops = {
199
200                 /* Device related operations */
201                 .dev_configure          = qat_sym_dev_config,
202                 .dev_start              = qat_sym_dev_start,
203                 .dev_stop               = qat_sym_dev_stop,
204                 .dev_close              = qat_sym_dev_close,
205                 .dev_infos_get          = qat_sym_dev_info_get,
206
207                 .stats_get              = qat_sym_stats_get,
208                 .stats_reset            = qat_sym_stats_reset,
209                 .queue_pair_setup       = qat_sym_qp_setup,
210                 .queue_pair_release     = qat_sym_qp_release,
211                 .queue_pair_start       = NULL,
212                 .queue_pair_stop        = NULL,
213                 .queue_pair_count       = NULL,
214
215                 /* Crypto related operations */
216                 .session_get_size       = qat_sym_session_get_private_size,
217                 .session_configure      = qat_sym_session_configure,
218                 .session_clear          = qat_sym_session_clear
219 };
220
221 static uint16_t
222 qat_sym_pmd_enqueue_op_burst(void *qp, struct rte_crypto_op **ops,
223                 uint16_t nb_ops)
224 {
225         return qat_enqueue_op_burst(qp, (void **)ops, nb_ops);
226 }
227
228 static uint16_t
229 qat_sym_pmd_dequeue_op_burst(void *qp, struct rte_crypto_op **ops,
230                 uint16_t nb_ops)
231 {
232         return qat_dequeue_op_burst(qp, (void **)ops, nb_ops);
233 }
234
235 /* An rte_driver is needed in the registration of both the device and the driver
236  * with cryptodev.
237  * The actual qat pci's rte_driver can't be used as its name represents
238  * the whole pci device with all services. Think of this as a holder for a name
239  * for the crypto part of the pci device.
240  */
241 static const char qat_sym_drv_name[] = RTE_STR(CRYPTODEV_NAME_QAT_SYM_PMD);
242 static const struct rte_driver cryptodev_qat_sym_driver = {
243         .name = qat_sym_drv_name,
244         .alias = qat_sym_drv_name
245 };
246
247 int
248 qat_sym_dev_create(struct qat_pci_device *qat_pci_dev)
249 {
250         struct rte_cryptodev_pmd_init_params init_params = {
251                         .name = "",
252                         .socket_id = qat_pci_dev->pci_dev->device.numa_node,
253                         .private_data_size = sizeof(struct qat_sym_dev_private),
254                         .max_nb_sessions = RTE_QAT_PMD_MAX_NB_SESSIONS
255         };
256         char name[RTE_CRYPTODEV_NAME_MAX_LEN];
257         struct rte_cryptodev *cryptodev;
258         struct qat_sym_dev_private *internals;
259
260         snprintf(name, RTE_CRYPTODEV_NAME_MAX_LEN, "%s_%s",
261                         qat_pci_dev->name, "sym");
262         PMD_DRV_LOG(DEBUG, "Creating QAT SYM device %s", name);
263
264         /* Populate subset device to use in cryptodev device creation */
265         qat_pci_dev->sym_rte_dev.driver = &cryptodev_qat_sym_driver;
266         qat_pci_dev->sym_rte_dev.numa_node =
267                                 qat_pci_dev->pci_dev->device.numa_node;
268         qat_pci_dev->sym_rte_dev.devargs = NULL;
269
270         cryptodev = rte_cryptodev_pmd_create(name,
271                         &(qat_pci_dev->sym_rte_dev), &init_params);
272
273         if (cryptodev == NULL)
274                 return -ENODEV;
275
276         qat_pci_dev->sym_rte_dev.name = cryptodev->data->name;
277         cryptodev->driver_id = cryptodev_qat_driver_id;
278         cryptodev->dev_ops = &crypto_qat_ops;
279
280         cryptodev->enqueue_burst = qat_sym_pmd_enqueue_op_burst;
281         cryptodev->dequeue_burst = qat_sym_pmd_dequeue_op_burst;
282
283         cryptodev->feature_flags = RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO |
284                         RTE_CRYPTODEV_FF_HW_ACCELERATED |
285                         RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING |
286                         RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER;
287
288         internals = cryptodev->data->dev_private;
289         internals->qat_dev = qat_pci_dev;
290         qat_pci_dev->sym_dev = internals;
291
292         internals->sym_dev_id = cryptodev->data->dev_id;
293         switch (qat_pci_dev->qat_dev_gen) {
294         case QAT_GEN1:
295                 internals->qat_dev_capabilities = qat_gen1_sym_capabilities;
296                 break;
297         case QAT_GEN2:
298                 internals->qat_dev_capabilities = qat_gen2_sym_capabilities;
299                 break;
300         default:
301                 internals->qat_dev_capabilities = qat_gen2_sym_capabilities;
302                 PMD_DRV_LOG(DEBUG,
303                         "QAT gen %d capabilities unknown, default to GEN2",
304                                         qat_pci_dev->qat_dev_gen);
305                 break;
306         }
307
308         PMD_DRV_LOG(DEBUG, "Created QAT SYM device %s as cryptodev instance %d",
309                         cryptodev->data->name, internals->sym_dev_id);
310         return 0;
311 }
312
313 int
314 qat_sym_dev_destroy(struct qat_pci_device *qat_pci_dev)
315 {
316         struct rte_cryptodev *cryptodev;
317
318         if (qat_pci_dev == NULL)
319                 return -ENODEV;
320         if (qat_pci_dev->sym_dev == NULL)
321                 return 0;
322
323         /* free crypto device */
324         cryptodev = rte_cryptodev_pmd_get_dev(qat_pci_dev->sym_dev->sym_dev_id);
325         rte_cryptodev_pmd_destroy(cryptodev);
326         qat_pci_dev->sym_rte_dev.name = NULL;
327         qat_pci_dev->sym_dev = NULL;
328
329         return 0;
330 }
331
332
333 static struct cryptodev_driver qat_crypto_drv;
334 RTE_PMD_REGISTER_CRYPTO_DRIVER(qat_crypto_drv,
335                 cryptodev_qat_sym_driver,
336                 cryptodev_qat_driver_id);