pci: introduce library and driver
[dpdk.git] / drivers / crypto / qat / rte_qat_cryptodev.c
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2015-2017 Intel Corporation. All rights reserved.
5  *   All rights reserved.
6  *
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following conditions
9  *   are met:
10  *
11  *     * Redistributions of source code must retain the above copyright
12  *       notice, this list of conditions and the following disclaimer.
13  *     * Redistributions in binary form must reproduce the above copyright
14  *       notice, this list of conditions and the following disclaimer in
15  *       the documentation and/or other materials provided with the
16  *       distribution.
17  *     * Neither the name of Intel Corporation nor the names of its
18  *       contributors may be used to endorse or promote products derived
19  *       from this software without specific prior written permission.
20  *
21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33
34 #include <rte_bus_pci.h>
35 #include <rte_common.h>
36 #include <rte_dev.h>
37 #include <rte_malloc.h>
38 #include <rte_pci.h>
39 #include <rte_cryptodev_pmd.h>
40
41 #include "qat_crypto.h"
42 #include "qat_logs.h"
43
44 uint8_t cryptodev_qat_driver_id;
45
46 static const struct rte_cryptodev_capabilities qat_gen1_capabilities[] = {
47         QAT_BASE_GEN1_SYM_CAPABILITIES,
48         RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST()
49 };
50
51 static const struct rte_cryptodev_capabilities qat_gen2_capabilities[] = {
52         QAT_BASE_GEN1_SYM_CAPABILITIES,
53         QAT_EXTRA_GEN2_SYM_CAPABILITIES,
54         RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST()
55 };
56
57 static struct rte_cryptodev_ops crypto_qat_ops = {
58
59                 /* Device related operations */
60                 .dev_configure          = qat_dev_config,
61                 .dev_start              = qat_dev_start,
62                 .dev_stop               = qat_dev_stop,
63                 .dev_close              = qat_dev_close,
64                 .dev_infos_get          = qat_dev_info_get,
65
66                 .stats_get              = qat_crypto_sym_stats_get,
67                 .stats_reset            = qat_crypto_sym_stats_reset,
68                 .queue_pair_setup       = qat_crypto_sym_qp_setup,
69                 .queue_pair_release     = qat_crypto_sym_qp_release,
70                 .queue_pair_start       = NULL,
71                 .queue_pair_stop        = NULL,
72                 .queue_pair_count       = NULL,
73
74                 /* Crypto related operations */
75                 .session_get_size       = qat_crypto_sym_get_session_private_size,
76                 .session_configure      = qat_crypto_sym_configure_session,
77                 .session_clear          = qat_crypto_sym_clear_session
78 };
79
80 /*
81  * The set of PCI devices this driver supports
82  */
83
84 static const struct rte_pci_id pci_id_qat_map[] = {
85                 {
86                         RTE_PCI_DEVICE(0x8086, 0x0443),
87                 },
88                 {
89                         RTE_PCI_DEVICE(0x8086, 0x37c9),
90                 },
91                 {
92                         RTE_PCI_DEVICE(0x8086, 0x19e3),
93                 },
94                 {
95                         RTE_PCI_DEVICE(0x8086, 0x6f55),
96                 },
97                 {.device_id = 0},
98 };
99
100 static int
101 crypto_qat_create(const char *name, struct rte_pci_device *pci_dev,
102                 struct rte_cryptodev_pmd_init_params *init_params)
103 {
104         struct rte_cryptodev *cryptodev;
105         struct qat_pmd_private *internals;
106
107         PMD_INIT_FUNC_TRACE();
108
109         cryptodev = rte_cryptodev_pmd_create(name, &pci_dev->device,
110                         init_params);
111         if (cryptodev == NULL)
112                 return -ENODEV;
113
114         cryptodev->driver_id = cryptodev_qat_driver_id;
115         cryptodev->dev_ops = &crypto_qat_ops;
116
117         cryptodev->enqueue_burst = qat_pmd_enqueue_op_burst;
118         cryptodev->dequeue_burst = qat_pmd_dequeue_op_burst;
119
120         cryptodev->feature_flags = RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO |
121                         RTE_CRYPTODEV_FF_HW_ACCELERATED |
122                         RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING |
123                         RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER;
124
125         internals = cryptodev->data->dev_private;
126         internals->max_nb_sessions = init_params->max_nb_sessions;
127         switch (pci_dev->id.device_id) {
128         case 0x0443:
129                 internals->qat_dev_gen = QAT_GEN1;
130                 internals->qat_dev_capabilities = qat_gen1_capabilities;
131                 break;
132         case 0x37c9:
133         case 0x19e3:
134         case 0x6f55:
135                 internals->qat_dev_gen = QAT_GEN2;
136                 internals->qat_dev_capabilities = qat_gen2_capabilities;
137                 break;
138         default:
139                 PMD_DRV_LOG(ERR,
140                         "Invalid dev_id, can't determine capabilities");
141                 break;
142         }
143
144         /*
145          * For secondary processes, we don't initialise any further as primary
146          * has already done this work. Only check we don't need a different
147          * RX function
148          */
149         if (rte_eal_process_type() != RTE_PROC_PRIMARY) {
150                 PMD_DRV_LOG(DEBUG, "Device already initialised by primary process");
151                 return 0;
152         }
153
154         return 0;
155 }
156
157 static int crypto_qat_pci_probe(struct rte_pci_driver *pci_drv __rte_unused,
158                 struct rte_pci_device *pci_dev)
159 {
160         struct rte_cryptodev_pmd_init_params init_params = {
161                 .name = "",
162                 .socket_id = rte_socket_id(),
163                 .private_data_size = sizeof(struct qat_pmd_private),
164                 .max_nb_sessions = RTE_QAT_PMD_MAX_NB_SESSIONS
165         };
166         char name[RTE_CRYPTODEV_NAME_MAX_LEN];
167
168         PMD_DRV_LOG(DEBUG, "Found QAT device at %02x:%02x.%x",
169                         pci_dev->addr.bus,
170                         pci_dev->addr.devid,
171                         pci_dev->addr.function);
172
173         rte_pci_device_name(&pci_dev->addr, name, sizeof(name));
174
175         return crypto_qat_create(name, pci_dev, &init_params);
176 }
177
178 static int crypto_qat_pci_remove(struct rte_pci_device *pci_dev)
179 {
180         struct rte_cryptodev *cryptodev;
181         char cryptodev_name[RTE_CRYPTODEV_NAME_MAX_LEN];
182
183         if (pci_dev == NULL)
184                 return -EINVAL;
185
186         rte_pci_device_name(&pci_dev->addr, cryptodev_name,
187                         sizeof(cryptodev_name));
188
189         cryptodev = rte_cryptodev_pmd_get_named_dev(cryptodev_name);
190         if (cryptodev == NULL)
191                 return -ENODEV;
192
193         /* free crypto device */
194         return rte_cryptodev_pmd_destroy(cryptodev);
195 }
196
197 static struct rte_pci_driver rte_qat_pmd = {
198         .id_table = pci_id_qat_map,
199         .drv_flags = RTE_PCI_DRV_NEED_MAPPING,
200         .probe = crypto_qat_pci_probe,
201         .remove = crypto_qat_pci_remove
202 };
203
204 static struct cryptodev_driver qat_crypto_drv;
205
206 RTE_PMD_REGISTER_PCI(CRYPTODEV_NAME_QAT_SYM_PMD, rte_qat_pmd);
207 RTE_PMD_REGISTER_PCI_TABLE(CRYPTODEV_NAME_QAT_SYM_PMD, pci_id_qat_map);
208 RTE_PMD_REGISTER_CRYPTO_DRIVER(qat_crypto_drv, rte_qat_pmd,
209                 cryptodev_qat_driver_id);