raw/ioat: probe idxd PCI
[dpdk.git] / drivers / raw / ioat / idxd_pci.c
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2020 Intel Corporation
3  */
4
5 #include <rte_bus_pci.h>
6 #include <rte_memzone.h>
7
8 #include "ioat_private.h"
9 #include "ioat_spec.h"
10
11 #define IDXD_VENDOR_ID          0x8086
12 #define IDXD_DEVICE_ID_SPR      0x0B25
13
14 #define IDXD_PMD_RAWDEV_NAME_PCI rawdev_idxd_pci
15
16 const struct rte_pci_id pci_id_idxd_map[] = {
17         { RTE_PCI_DEVICE(IDXD_VENDOR_ID, IDXD_DEVICE_ID_SPR) },
18         { .vendor_id = 0, /* sentinel */ },
19 };
20
21 static inline int
22 idxd_pci_dev_command(struct idxd_rawdev *idxd, enum rte_idxd_cmds command)
23 {
24         uint8_t err_code;
25         uint16_t qid = idxd->qid;
26         int i = 0;
27
28         if (command >= idxd_disable_wq && command <= idxd_reset_wq)
29                 qid = (1 << qid);
30         rte_spinlock_lock(&idxd->u.pci->lk);
31         idxd->u.pci->regs->cmd = (command << IDXD_CMD_SHIFT) | qid;
32
33         do {
34                 rte_pause();
35                 err_code = idxd->u.pci->regs->cmdstatus;
36                 if (++i >= 1000) {
37                         IOAT_PMD_ERR("Timeout waiting for command response from HW");
38                         rte_spinlock_unlock(&idxd->u.pci->lk);
39                         return err_code;
40                 }
41         } while (idxd->u.pci->regs->cmdstatus & CMDSTATUS_ACTIVE_MASK);
42         rte_spinlock_unlock(&idxd->u.pci->lk);
43
44         return err_code & CMDSTATUS_ERR_MASK;
45 }
46
47 static int
48 idxd_is_wq_enabled(struct idxd_rawdev *idxd)
49 {
50         uint32_t state = idxd->u.pci->wq_regs[idxd->qid].wqcfg[WQ_STATE_IDX];
51         return ((state >> WQ_STATE_SHIFT) & WQ_STATE_MASK) == 0x1;
52 }
53
54 static const struct rte_rawdev_ops idxd_pci_ops = {
55                 .dev_close = idxd_rawdev_close,
56                 .dev_selftest = idxd_rawdev_test,
57 };
58
59 /* each portal uses 4 x 4k pages */
60 #define IDXD_PORTAL_SIZE (4096 * 4)
61
62 static int
63 init_pci_device(struct rte_pci_device *dev, struct idxd_rawdev *idxd)
64 {
65         struct idxd_pci_common *pci;
66         uint8_t nb_groups, nb_engines, nb_wqs;
67         uint16_t grp_offset, wq_offset; /* how far into bar0 the regs are */
68         uint16_t wq_size, total_wq_size;
69         uint8_t lg2_max_batch, lg2_max_copy_size;
70         unsigned int i, err_code;
71
72         pci = malloc(sizeof(*pci));
73         if (pci == NULL) {
74                 IOAT_PMD_ERR("%s: Can't allocate memory", __func__);
75                 goto err;
76         }
77         rte_spinlock_init(&pci->lk);
78
79         /* assign the bar registers, and then configure device */
80         pci->regs = dev->mem_resource[0].addr;
81         grp_offset = (uint16_t)pci->regs->offsets[0];
82         pci->grp_regs = RTE_PTR_ADD(pci->regs, grp_offset * 0x100);
83         wq_offset = (uint16_t)(pci->regs->offsets[0] >> 16);
84         pci->wq_regs = RTE_PTR_ADD(pci->regs, wq_offset * 0x100);
85         pci->portals = dev->mem_resource[2].addr;
86
87         /* sanity check device status */
88         if (pci->regs->gensts & GENSTS_DEV_STATE_MASK) {
89                 /* need function-level-reset (FLR) or is enabled */
90                 IOAT_PMD_ERR("Device status is not disabled, cannot init");
91                 goto err;
92         }
93         if (pci->regs->cmdstatus & CMDSTATUS_ACTIVE_MASK) {
94                 /* command in progress */
95                 IOAT_PMD_ERR("Device has a command in progress, cannot init");
96                 goto err;
97         }
98
99         /* read basic info about the hardware for use when configuring */
100         nb_groups = (uint8_t)pci->regs->grpcap;
101         nb_engines = (uint8_t)pci->regs->engcap;
102         nb_wqs = (uint8_t)(pci->regs->wqcap >> 16);
103         total_wq_size = (uint16_t)pci->regs->wqcap;
104         lg2_max_copy_size = (uint8_t)(pci->regs->gencap >> 16) & 0x1F;
105         lg2_max_batch = (uint8_t)(pci->regs->gencap >> 21) & 0x0F;
106
107         IOAT_PMD_DEBUG("nb_groups = %u, nb_engines = %u, nb_wqs = %u",
108                         nb_groups, nb_engines, nb_wqs);
109
110         /* zero out any old config */
111         for (i = 0; i < nb_groups; i++) {
112                 pci->grp_regs[i].grpengcfg = 0;
113                 pci->grp_regs[i].grpwqcfg[0] = 0;
114         }
115         for (i = 0; i < nb_wqs; i++)
116                 pci->wq_regs[i].wqcfg[0] = 0;
117
118         /* put each engine into a separate group to avoid reordering */
119         if (nb_groups > nb_engines)
120                 nb_groups = nb_engines;
121         if (nb_groups < nb_engines)
122                 nb_engines = nb_groups;
123
124         /* assign engines to groups, round-robin style */
125         for (i = 0; i < nb_engines; i++) {
126                 IOAT_PMD_DEBUG("Assigning engine %u to group %u",
127                                 i, i % nb_groups);
128                 pci->grp_regs[i % nb_groups].grpengcfg |= (1ULL << i);
129         }
130
131         /* now do the same for queues and give work slots to each queue */
132         wq_size = total_wq_size / nb_wqs;
133         IOAT_PMD_DEBUG("Work queue size = %u, max batch = 2^%u, max copy = 2^%u",
134                         wq_size, lg2_max_batch, lg2_max_copy_size);
135         for (i = 0; i < nb_wqs; i++) {
136                 /* add engine "i" to a group */
137                 IOAT_PMD_DEBUG("Assigning work queue %u to group %u",
138                                 i, i % nb_groups);
139                 pci->grp_regs[i % nb_groups].grpwqcfg[0] |= (1ULL << i);
140                 /* now configure it, in terms of size, max batch, mode */
141                 pci->wq_regs[i].wqcfg[WQ_SIZE_IDX] = wq_size;
142                 pci->wq_regs[i].wqcfg[WQ_MODE_IDX] = (1 << WQ_PRIORITY_SHIFT) |
143                                 WQ_MODE_DEDICATED;
144                 pci->wq_regs[i].wqcfg[WQ_SIZES_IDX] = lg2_max_copy_size |
145                                 (lg2_max_batch << WQ_BATCH_SZ_SHIFT);
146         }
147
148         /* dump the group configuration to output */
149         for (i = 0; i < nb_groups; i++) {
150                 IOAT_PMD_DEBUG("## Group %d", i);
151                 IOAT_PMD_DEBUG("    GRPWQCFG: %"PRIx64, pci->grp_regs[i].grpwqcfg[0]);
152                 IOAT_PMD_DEBUG("    GRPENGCFG: %"PRIx64, pci->grp_regs[i].grpengcfg);
153                 IOAT_PMD_DEBUG("    GRPFLAGS: %"PRIx32, pci->grp_regs[i].grpflags);
154         }
155
156         idxd->u.pci = pci;
157         idxd->max_batches = wq_size;
158
159         /* enable the device itself */
160         err_code = idxd_pci_dev_command(idxd, idxd_enable_dev);
161         if (err_code) {
162                 IOAT_PMD_ERR("Error enabling device: code %#x", err_code);
163                 return err_code;
164         }
165         IOAT_PMD_DEBUG("IDXD Device enabled OK");
166
167         return nb_wqs;
168
169 err:
170         free(pci);
171         return -1;
172 }
173
174 static int
175 idxd_rawdev_probe_pci(struct rte_pci_driver *drv, struct rte_pci_device *dev)
176 {
177         struct idxd_rawdev idxd = {{0}}; /* Double {} to avoid error on BSD12 */
178         uint8_t nb_wqs;
179         int qid, ret = 0;
180         char name[PCI_PRI_STR_SIZE];
181
182         rte_pci_device_name(&dev->addr, name, sizeof(name));
183         IOAT_PMD_INFO("Init %s on NUMA node %d", name, dev->device.numa_node);
184         dev->device.driver = &drv->driver;
185
186         ret = init_pci_device(dev, &idxd);
187         if (ret < 0) {
188                 IOAT_PMD_ERR("Error initializing PCI hardware");
189                 return ret;
190         }
191         nb_wqs = (uint8_t)ret;
192
193         /* set up one device for each queue */
194         for (qid = 0; qid < nb_wqs; qid++) {
195                 char qname[32];
196
197                 /* add the queue number to each device name */
198                 snprintf(qname, sizeof(qname), "%s-q%d", name, qid);
199                 idxd.qid = qid;
200                 idxd.public.portal = RTE_PTR_ADD(idxd.u.pci->portals,
201                                 qid * IDXD_PORTAL_SIZE);
202                 if (idxd_is_wq_enabled(&idxd))
203                         IOAT_PMD_ERR("Error, WQ %u seems enabled", qid);
204                 ret = idxd_rawdev_create(qname, &dev->device,
205                                 &idxd, &idxd_pci_ops);
206                 if (ret != 0) {
207                         IOAT_PMD_ERR("Failed to create rawdev %s", name);
208                         if (qid == 0) /* if no devices using this, free pci */
209                                 free(idxd.u.pci);
210                         return ret;
211                 }
212         }
213
214         return 0;
215 }
216
217 static int
218 idxd_rawdev_destroy(const char *name)
219 {
220         int ret;
221         uint8_t err_code;
222         struct rte_rawdev *rdev;
223         struct idxd_rawdev *idxd;
224
225         if (!name) {
226                 IOAT_PMD_ERR("Invalid device name");
227                 return -EINVAL;
228         }
229
230         rdev = rte_rawdev_pmd_get_named_dev(name);
231         if (!rdev) {
232                 IOAT_PMD_ERR("Invalid device name (%s)", name);
233                 return -EINVAL;
234         }
235
236         idxd = rdev->dev_private;
237
238         /* disable the device */
239         err_code = idxd_pci_dev_command(idxd, idxd_disable_dev);
240         if (err_code) {
241                 IOAT_PMD_ERR("Error disabling device: code %#x", err_code);
242                 return err_code;
243         }
244         IOAT_PMD_DEBUG("IDXD Device disabled OK");
245
246         /* free device memory */
247         if (rdev->dev_private != NULL) {
248                 IOAT_PMD_DEBUG("Freeing device driver memory");
249                 rdev->dev_private = NULL;
250                 rte_free(idxd->public.batch_ring);
251                 rte_free(idxd->public.hdl_ring);
252                 rte_memzone_free(idxd->mz);
253         }
254
255         /* rte_rawdev_close is called by pmd_release */
256         ret = rte_rawdev_pmd_release(rdev);
257         if (ret)
258                 IOAT_PMD_DEBUG("Device cleanup failed");
259
260         return 0;
261 }
262
263 static int
264 idxd_rawdev_remove_pci(struct rte_pci_device *dev)
265 {
266         char name[PCI_PRI_STR_SIZE];
267         int ret = 0;
268
269         rte_pci_device_name(&dev->addr, name, sizeof(name));
270
271         IOAT_PMD_INFO("Closing %s on NUMA node %d",
272                         name, dev->device.numa_node);
273
274         ret = idxd_rawdev_destroy(name);
275
276         return ret;
277 }
278
279 struct rte_pci_driver idxd_pmd_drv_pci = {
280         .id_table = pci_id_idxd_map,
281         .drv_flags = RTE_PCI_DRV_NEED_MAPPING,
282         .probe = idxd_rawdev_probe_pci,
283         .remove = idxd_rawdev_remove_pci,
284 };
285
286 RTE_PMD_REGISTER_PCI(IDXD_PMD_RAWDEV_NAME_PCI, idxd_pmd_drv_pci);
287 RTE_PMD_REGISTER_PCI_TABLE(IDXD_PMD_RAWDEV_NAME_PCI, pci_id_idxd_map);
288 RTE_PMD_REGISTER_KMOD_DEP(IDXD_PMD_RAWDEV_NAME_PCI,
289                           "* igb_uio | uio_pci_generic | vfio-pci");