xref: /kernel/linux/linux-5.10/drivers/dma/idxd/init.c (revision 8c2ecf20)
1// SPDX-License-Identifier: GPL-2.0
2/* Copyright(c) 2019 Intel Corporation. All rights rsvd. */
3#include <linux/init.h>
4#include <linux/kernel.h>
5#include <linux/module.h>
6#include <linux/slab.h>
7#include <linux/pci.h>
8#include <linux/interrupt.h>
9#include <linux/delay.h>
10#include <linux/dma-mapping.h>
11#include <linux/workqueue.h>
12#include <linux/aer.h>
13#include <linux/fs.h>
14#include <linux/io-64-nonatomic-lo-hi.h>
15#include <linux/device.h>
16#include <linux/idr.h>
17#include <uapi/linux/idxd.h>
18#include <linux/dmaengine.h>
19#include "../dmaengine.h"
20#include "registers.h"
21#include "idxd.h"
22
23MODULE_VERSION(IDXD_DRIVER_VERSION);
24MODULE_LICENSE("GPL v2");
25MODULE_AUTHOR("Intel Corporation");
26
27#define DRV_NAME "idxd"
28
29static struct idr idxd_idrs[IDXD_TYPE_MAX];
30static struct mutex idxd_idr_lock;
31
32static struct pci_device_id idxd_pci_tbl[] = {
33	/* DSA ver 1.0 platforms */
34	{ PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_DSA_SPR0) },
35	{ 0, }
36};
37MODULE_DEVICE_TABLE(pci, idxd_pci_tbl);
38
39static char *idxd_name[] = {
40	"dsa",
41};
42
43const char *idxd_get_dev_name(struct idxd_device *idxd)
44{
45	return idxd_name[idxd->type];
46}
47
48static int idxd_setup_interrupts(struct idxd_device *idxd)
49{
50	struct pci_dev *pdev = idxd->pdev;
51	struct device *dev = &pdev->dev;
52	struct msix_entry *msix;
53	struct idxd_irq_entry *irq_entry;
54	int i, msixcnt;
55	int rc = 0;
56
57	msixcnt = pci_msix_vec_count(pdev);
58	if (msixcnt < 0) {
59		dev_err(dev, "Not MSI-X interrupt capable.\n");
60		goto err_no_irq;
61	}
62
63	idxd->msix_entries = devm_kzalloc(dev, sizeof(struct msix_entry) *
64			msixcnt, GFP_KERNEL);
65	if (!idxd->msix_entries) {
66		rc = -ENOMEM;
67		goto err_no_irq;
68	}
69
70	for (i = 0; i < msixcnt; i++)
71		idxd->msix_entries[i].entry = i;
72
73	rc = pci_enable_msix_exact(pdev, idxd->msix_entries, msixcnt);
74	if (rc) {
75		dev_err(dev, "Failed enabling %d MSIX entries.\n", msixcnt);
76		goto err_no_irq;
77	}
78	dev_dbg(dev, "Enabled %d msix vectors\n", msixcnt);
79
80	/*
81	 * We implement 1 completion list per MSI-X entry except for
82	 * entry 0, which is for errors and others.
83	 */
84	idxd->irq_entries = devm_kcalloc(dev, msixcnt,
85					 sizeof(struct idxd_irq_entry),
86					 GFP_KERNEL);
87	if (!idxd->irq_entries) {
88		rc = -ENOMEM;
89		goto err_no_irq;
90	}
91
92	for (i = 0; i < msixcnt; i++) {
93		idxd->irq_entries[i].id = i;
94		idxd->irq_entries[i].idxd = idxd;
95	}
96
97	msix = &idxd->msix_entries[0];
98	irq_entry = &idxd->irq_entries[0];
99	rc = devm_request_threaded_irq(dev, msix->vector, idxd_irq_handler,
100				       idxd_misc_thread, 0, "idxd-misc",
101				       irq_entry);
102	if (rc < 0) {
103		dev_err(dev, "Failed to allocate misc interrupt.\n");
104		goto err_no_irq;
105	}
106
107	dev_dbg(dev, "Allocated idxd-misc handler on msix vector %d\n",
108		msix->vector);
109
110	/* first MSI-X entry is not for wq interrupts */
111	idxd->num_wq_irqs = msixcnt - 1;
112
113	for (i = 1; i < msixcnt; i++) {
114		msix = &idxd->msix_entries[i];
115		irq_entry = &idxd->irq_entries[i];
116
117		init_llist_head(&idxd->irq_entries[i].pending_llist);
118		INIT_LIST_HEAD(&idxd->irq_entries[i].work_list);
119		rc = devm_request_threaded_irq(dev, msix->vector,
120					       idxd_irq_handler,
121					       idxd_wq_thread, 0,
122					       "idxd-portal", irq_entry);
123		if (rc < 0) {
124			dev_err(dev, "Failed to allocate irq %d.\n",
125				msix->vector);
126			goto err_no_irq;
127		}
128		dev_dbg(dev, "Allocated idxd-msix %d for vector %d\n",
129			i, msix->vector);
130	}
131
132	idxd_unmask_error_interrupts(idxd);
133
134	return 0;
135
136 err_no_irq:
137	/* Disable error interrupt generation */
138	idxd_mask_error_interrupts(idxd);
139	pci_disable_msix(pdev);
140	dev_err(dev, "No usable interrupts\n");
141	return rc;
142}
143
144static int idxd_setup_internals(struct idxd_device *idxd)
145{
146	struct device *dev = &idxd->pdev->dev;
147	int i;
148
149	init_waitqueue_head(&idxd->cmd_waitq);
150	idxd->groups = devm_kcalloc(dev, idxd->max_groups,
151				    sizeof(struct idxd_group), GFP_KERNEL);
152	if (!idxd->groups)
153		return -ENOMEM;
154
155	for (i = 0; i < idxd->max_groups; i++) {
156		idxd->groups[i].idxd = idxd;
157		idxd->groups[i].id = i;
158		idxd->groups[i].tc_a = -1;
159		idxd->groups[i].tc_b = -1;
160	}
161
162	idxd->wqs = devm_kcalloc(dev, idxd->max_wqs, sizeof(struct idxd_wq),
163				 GFP_KERNEL);
164	if (!idxd->wqs)
165		return -ENOMEM;
166
167	idxd->engines = devm_kcalloc(dev, idxd->max_engines,
168				     sizeof(struct idxd_engine), GFP_KERNEL);
169	if (!idxd->engines)
170		return -ENOMEM;
171
172	for (i = 0; i < idxd->max_wqs; i++) {
173		struct idxd_wq *wq = &idxd->wqs[i];
174
175		wq->id = i;
176		wq->idxd = idxd;
177		mutex_init(&wq->wq_lock);
178		init_waitqueue_head(&wq->err_queue);
179		wq->max_xfer_bytes = idxd->max_xfer_bytes;
180		wq->max_batch_size = idxd->max_batch_size;
181		wq->wqcfg = devm_kzalloc(dev, idxd->wqcfg_size, GFP_KERNEL);
182		if (!wq->wqcfg)
183			return -ENOMEM;
184	}
185
186	for (i = 0; i < idxd->max_engines; i++) {
187		idxd->engines[i].idxd = idxd;
188		idxd->engines[i].id = i;
189	}
190
191	idxd->wq = create_workqueue(dev_name(dev));
192	if (!idxd->wq)
193		return -ENOMEM;
194
195	return 0;
196}
197
198static void idxd_read_table_offsets(struct idxd_device *idxd)
199{
200	union offsets_reg offsets;
201	struct device *dev = &idxd->pdev->dev;
202
203	offsets.bits[0] = ioread64(idxd->reg_base + IDXD_TABLE_OFFSET);
204	offsets.bits[1] = ioread64(idxd->reg_base + IDXD_TABLE_OFFSET
205			+ sizeof(u64));
206	idxd->grpcfg_offset = offsets.grpcfg * 0x100;
207	dev_dbg(dev, "IDXD Group Config Offset: %#x\n", idxd->grpcfg_offset);
208	idxd->wqcfg_offset = offsets.wqcfg * 0x100;
209	dev_dbg(dev, "IDXD Work Queue Config Offset: %#x\n",
210		idxd->wqcfg_offset);
211	idxd->msix_perm_offset = offsets.msix_perm * 0x100;
212	dev_dbg(dev, "IDXD MSIX Permission Offset: %#x\n",
213		idxd->msix_perm_offset);
214	idxd->perfmon_offset = offsets.perfmon * 0x100;
215	dev_dbg(dev, "IDXD Perfmon Offset: %#x\n", idxd->perfmon_offset);
216}
217
218static void idxd_read_caps(struct idxd_device *idxd)
219{
220	struct device *dev = &idxd->pdev->dev;
221	int i;
222
223	/* reading generic capabilities */
224	idxd->hw.gen_cap.bits = ioread64(idxd->reg_base + IDXD_GENCAP_OFFSET);
225	dev_dbg(dev, "gen_cap: %#llx\n", idxd->hw.gen_cap.bits);
226	idxd->max_xfer_bytes = 1ULL << idxd->hw.gen_cap.max_xfer_shift;
227	dev_dbg(dev, "max xfer size: %llu bytes\n", idxd->max_xfer_bytes);
228	idxd->max_batch_size = 1U << idxd->hw.gen_cap.max_batch_shift;
229	dev_dbg(dev, "max batch size: %u\n", idxd->max_batch_size);
230	if (idxd->hw.gen_cap.config_en)
231		set_bit(IDXD_FLAG_CONFIGURABLE, &idxd->flags);
232
233	/* reading group capabilities */
234	idxd->hw.group_cap.bits =
235		ioread64(idxd->reg_base + IDXD_GRPCAP_OFFSET);
236	dev_dbg(dev, "group_cap: %#llx\n", idxd->hw.group_cap.bits);
237	idxd->max_groups = idxd->hw.group_cap.num_groups;
238	dev_dbg(dev, "max groups: %u\n", idxd->max_groups);
239	idxd->max_tokens = idxd->hw.group_cap.total_tokens;
240	dev_dbg(dev, "max tokens: %u\n", idxd->max_tokens);
241	idxd->nr_tokens = idxd->max_tokens;
242
243	/* read engine capabilities */
244	idxd->hw.engine_cap.bits =
245		ioread64(idxd->reg_base + IDXD_ENGCAP_OFFSET);
246	dev_dbg(dev, "engine_cap: %#llx\n", idxd->hw.engine_cap.bits);
247	idxd->max_engines = idxd->hw.engine_cap.num_engines;
248	dev_dbg(dev, "max engines: %u\n", idxd->max_engines);
249
250	/* read workqueue capabilities */
251	idxd->hw.wq_cap.bits = ioread64(idxd->reg_base + IDXD_WQCAP_OFFSET);
252	dev_dbg(dev, "wq_cap: %#llx\n", idxd->hw.wq_cap.bits);
253	idxd->max_wq_size = idxd->hw.wq_cap.total_wq_size;
254	dev_dbg(dev, "total workqueue size: %u\n", idxd->max_wq_size);
255	idxd->max_wqs = idxd->hw.wq_cap.num_wqs;
256	dev_dbg(dev, "max workqueues: %u\n", idxd->max_wqs);
257	idxd->wqcfg_size = 1 << (idxd->hw.wq_cap.wqcfg_size + IDXD_WQCFG_MIN);
258	dev_dbg(dev, "wqcfg size: %u\n", idxd->wqcfg_size);
259
260	/* reading operation capabilities */
261	for (i = 0; i < 4; i++) {
262		idxd->hw.opcap.bits[i] = ioread64(idxd->reg_base +
263				IDXD_OPCAP_OFFSET + i * sizeof(u64));
264		dev_dbg(dev, "opcap[%d]: %#llx\n", i, idxd->hw.opcap.bits[i]);
265	}
266}
267
268static struct idxd_device *idxd_alloc(struct pci_dev *pdev,
269				      void __iomem * const *iomap)
270{
271	struct device *dev = &pdev->dev;
272	struct idxd_device *idxd;
273
274	idxd = devm_kzalloc(dev, sizeof(struct idxd_device), GFP_KERNEL);
275	if (!idxd)
276		return NULL;
277
278	idxd->pdev = pdev;
279	idxd->reg_base = iomap[IDXD_MMIO_BAR];
280	spin_lock_init(&idxd->dev_lock);
281
282	return idxd;
283}
284
285static int idxd_probe(struct idxd_device *idxd)
286{
287	struct pci_dev *pdev = idxd->pdev;
288	struct device *dev = &pdev->dev;
289	int rc;
290
291	dev_dbg(dev, "%s entered and resetting device\n", __func__);
292	rc = idxd_device_init_reset(idxd);
293	if (rc < 0)
294		return rc;
295
296	dev_dbg(dev, "IDXD reset complete\n");
297
298	idxd_read_caps(idxd);
299	idxd_read_table_offsets(idxd);
300
301	rc = idxd_setup_internals(idxd);
302	if (rc)
303		goto err_setup;
304
305	rc = idxd_setup_interrupts(idxd);
306	if (rc)
307		goto err_setup;
308
309	dev_dbg(dev, "IDXD interrupt setup complete.\n");
310
311	mutex_lock(&idxd_idr_lock);
312	idxd->id = idr_alloc(&idxd_idrs[idxd->type], idxd, 0, 0, GFP_KERNEL);
313	mutex_unlock(&idxd_idr_lock);
314	if (idxd->id < 0) {
315		rc = -ENOMEM;
316		goto err_idr_fail;
317	}
318
319	idxd->major = idxd_cdev_get_major(idxd);
320
321	dev_dbg(dev, "IDXD device %d probed successfully\n", idxd->id);
322	return 0;
323
324 err_idr_fail:
325	idxd_mask_error_interrupts(idxd);
326	idxd_mask_msix_vectors(idxd);
327 err_setup:
328	return rc;
329}
330
331static int idxd_pci_probe(struct pci_dev *pdev, const struct pci_device_id *id)
332{
333	void __iomem * const *iomap;
334	struct device *dev = &pdev->dev;
335	struct idxd_device *idxd;
336	int rc;
337	unsigned int mask;
338
339	rc = pcim_enable_device(pdev);
340	if (rc)
341		return rc;
342
343	dev_dbg(dev, "Mapping BARs\n");
344	mask = (1 << IDXD_MMIO_BAR);
345	rc = pcim_iomap_regions(pdev, mask, DRV_NAME);
346	if (rc)
347		return rc;
348
349	iomap = pcim_iomap_table(pdev);
350	if (!iomap)
351		return -ENOMEM;
352
353	dev_dbg(dev, "Set DMA masks\n");
354	rc = pci_set_dma_mask(pdev, DMA_BIT_MASK(64));
355	if (rc)
356		rc = pci_set_dma_mask(pdev, DMA_BIT_MASK(32));
357	if (rc)
358		return rc;
359
360	rc = pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(64));
361	if (rc)
362		rc = pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(32));
363	if (rc)
364		return rc;
365
366	dev_dbg(dev, "Alloc IDXD context\n");
367	idxd = idxd_alloc(pdev, iomap);
368	if (!idxd)
369		return -ENOMEM;
370
371	idxd_set_type(idxd);
372
373	dev_dbg(dev, "Set PCI master\n");
374	pci_set_master(pdev);
375	pci_set_drvdata(pdev, idxd);
376
377	idxd->hw.version = ioread32(idxd->reg_base + IDXD_VER_OFFSET);
378	rc = idxd_probe(idxd);
379	if (rc) {
380		dev_err(dev, "Intel(R) IDXD DMA Engine init failed\n");
381		return -ENODEV;
382	}
383
384	rc = idxd_setup_sysfs(idxd);
385	if (rc) {
386		dev_err(dev, "IDXD sysfs setup failed\n");
387		return -ENODEV;
388	}
389
390	idxd->state = IDXD_DEV_CONF_READY;
391
392	dev_info(&pdev->dev, "Intel(R) Accelerator Device (v%x)\n",
393		 idxd->hw.version);
394
395	return 0;
396}
397
398static void idxd_flush_pending_llist(struct idxd_irq_entry *ie)
399{
400	struct idxd_desc *desc, *itr;
401	struct llist_node *head;
402
403	head = llist_del_all(&ie->pending_llist);
404	if (!head)
405		return;
406
407	llist_for_each_entry_safe(desc, itr, head, llnode) {
408		idxd_dma_complete_txd(desc, IDXD_COMPLETE_ABORT);
409		idxd_free_desc(desc->wq, desc);
410	}
411}
412
413static void idxd_flush_work_list(struct idxd_irq_entry *ie)
414{
415	struct idxd_desc *desc, *iter;
416
417	list_for_each_entry_safe(desc, iter, &ie->work_list, list) {
418		list_del(&desc->list);
419		idxd_dma_complete_txd(desc, IDXD_COMPLETE_ABORT);
420		idxd_free_desc(desc->wq, desc);
421	}
422}
423
424static void idxd_shutdown(struct pci_dev *pdev)
425{
426	struct idxd_device *idxd = pci_get_drvdata(pdev);
427	int rc, i;
428	struct idxd_irq_entry *irq_entry;
429	int msixcnt = pci_msix_vec_count(pdev);
430
431	rc = idxd_device_disable(idxd);
432	if (rc)
433		dev_err(&pdev->dev, "Disabling device failed\n");
434
435	dev_dbg(&pdev->dev, "%s called\n", __func__);
436	idxd_mask_msix_vectors(idxd);
437	idxd_mask_error_interrupts(idxd);
438
439	for (i = 0; i < msixcnt; i++) {
440		irq_entry = &idxd->irq_entries[i];
441		synchronize_irq(idxd->msix_entries[i].vector);
442		if (i == 0)
443			continue;
444		idxd_flush_pending_llist(irq_entry);
445		idxd_flush_work_list(irq_entry);
446	}
447
448	destroy_workqueue(idxd->wq);
449}
450
451static void idxd_remove(struct pci_dev *pdev)
452{
453	struct idxd_device *idxd = pci_get_drvdata(pdev);
454
455	dev_dbg(&pdev->dev, "%s called\n", __func__);
456	idxd_cleanup_sysfs(idxd);
457	idxd_shutdown(pdev);
458	mutex_lock(&idxd_idr_lock);
459	idr_remove(&idxd_idrs[idxd->type], idxd->id);
460	mutex_unlock(&idxd_idr_lock);
461}
462
463static struct pci_driver idxd_pci_driver = {
464	.name		= DRV_NAME,
465	.id_table	= idxd_pci_tbl,
466	.probe		= idxd_pci_probe,
467	.remove		= idxd_remove,
468	.shutdown	= idxd_shutdown,
469};
470
471static int __init idxd_init_module(void)
472{
473	int err, i;
474
475	/*
476	 * If the CPU does not support write512, there's no point in
477	 * enumerating the device. We can not utilize it.
478	 */
479	if (!boot_cpu_has(X86_FEATURE_MOVDIR64B)) {
480		pr_warn("idxd driver failed to load without MOVDIR64B.\n");
481		return -ENODEV;
482	}
483
484	pr_info("%s: Intel(R) Accelerator Devices Driver %s\n",
485		DRV_NAME, IDXD_DRIVER_VERSION);
486
487	mutex_init(&idxd_idr_lock);
488	for (i = 0; i < IDXD_TYPE_MAX; i++)
489		idr_init(&idxd_idrs[i]);
490
491	err = idxd_register_bus_type();
492	if (err < 0)
493		return err;
494
495	err = idxd_register_driver();
496	if (err < 0)
497		goto err_idxd_driver_register;
498
499	err = idxd_cdev_register();
500	if (err)
501		goto err_cdev_register;
502
503	err = pci_register_driver(&idxd_pci_driver);
504	if (err)
505		goto err_pci_register;
506
507	return 0;
508
509err_pci_register:
510	idxd_cdev_remove();
511err_cdev_register:
512	idxd_unregister_driver();
513err_idxd_driver_register:
514	idxd_unregister_bus_type();
515	return err;
516}
517module_init(idxd_init_module);
518
519static void __exit idxd_exit_module(void)
520{
521	idxd_unregister_driver();
522	pci_unregister_driver(&idxd_pci_driver);
523	idxd_cdev_remove();
524	idxd_unregister_bus_type();
525}
526module_exit(idxd_exit_module);
527