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