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>
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>
14 #include <linux/io-64-nonatomic-lo-hi.h>
15 #include <linux/device.h>
16 #include <linux/idr.h>
17 #include <linux/intel-svm.h>
18 #include <linux/iommu.h>
19 #include <uapi/linux/idxd.h>
20 #include <linux/dmaengine.h>
21 #include "../dmaengine.h"
22 #include "registers.h"
26 MODULE_VERSION(IDXD_DRIVER_VERSION);
27 MODULE_LICENSE("GPL v2");
28 MODULE_AUTHOR("Intel Corporation");
30 static bool sva = true;
31 module_param(sva, bool, 0644);
32 MODULE_PARM_DESC(sva, "Toggle SVA support on/off");
34 #define DRV_NAME "idxd"
39 static struct idxd_driver_data idxd_driver_data[] = {
42 .type = IDXD_TYPE_DSA,
43 .compl_size = sizeof(struct dsa_completion_record),
45 .dev_type = &dsa_device_type,
49 .type = IDXD_TYPE_IAX,
50 .compl_size = sizeof(struct iax_completion_record),
52 .dev_type = &iax_device_type,
56 static struct pci_device_id idxd_pci_tbl[] = {
57 /* DSA ver 1.0 platforms */
58 { PCI_DEVICE_DATA(INTEL, DSA_SPR0, &idxd_driver_data[IDXD_TYPE_DSA]) },
60 /* IAX ver 1.0 platforms */
61 { PCI_DEVICE_DATA(INTEL, IAX_SPR0, &idxd_driver_data[IDXD_TYPE_IAX]) },
64 MODULE_DEVICE_TABLE(pci, idxd_pci_tbl);
66 static int idxd_setup_interrupts(struct idxd_device *idxd)
68 struct pci_dev *pdev = idxd->pdev;
69 struct device *dev = &pdev->dev;
70 struct idxd_irq_entry *irq_entry;
74 msixcnt = pci_msix_vec_count(pdev);
76 dev_err(dev, "Not MSI-X interrupt capable.\n");
80 rc = pci_alloc_irq_vectors(pdev, msixcnt, msixcnt, PCI_IRQ_MSIX);
82 dev_err(dev, "Failed enabling %d MSIX entries: %d\n", msixcnt, rc);
85 dev_dbg(dev, "Enabled %d msix vectors\n", msixcnt);
88 * We implement 1 completion list per MSI-X entry except for
89 * entry 0, which is for errors and others.
91 idxd->irq_entries = kcalloc_node(msixcnt, sizeof(struct idxd_irq_entry),
92 GFP_KERNEL, dev_to_node(dev));
93 if (!idxd->irq_entries) {
98 for (i = 0; i < msixcnt; i++) {
99 idxd->irq_entries[i].id = i;
100 idxd->irq_entries[i].idxd = idxd;
101 idxd->irq_entries[i].vector = pci_irq_vector(pdev, i);
102 spin_lock_init(&idxd->irq_entries[i].list_lock);
105 irq_entry = &idxd->irq_entries[0];
106 rc = request_threaded_irq(irq_entry->vector, NULL, idxd_misc_thread,
107 0, "idxd-misc", irq_entry);
109 dev_err(dev, "Failed to allocate misc interrupt.\n");
113 dev_dbg(dev, "Allocated idxd-misc handler on msix vector %d\n", irq_entry->vector);
115 /* first MSI-X entry is not for wq interrupts */
116 idxd->num_wq_irqs = msixcnt - 1;
118 for (i = 1; i < msixcnt; i++) {
119 irq_entry = &idxd->irq_entries[i];
121 init_llist_head(&idxd->irq_entries[i].pending_llist);
122 INIT_LIST_HEAD(&idxd->irq_entries[i].work_list);
123 rc = request_threaded_irq(irq_entry->vector, NULL,
124 idxd_wq_thread, 0, "idxd-portal", irq_entry);
126 dev_err(dev, "Failed to allocate irq %d.\n", irq_entry->vector);
130 dev_dbg(dev, "Allocated idxd-msix %d for vector %d\n", i, irq_entry->vector);
131 if (idxd->hw.cmd_cap & BIT(IDXD_CMD_REQUEST_INT_HANDLE)) {
133 * The MSIX vector enumeration starts at 1 with vector 0 being the
134 * misc interrupt that handles non I/O completion events. The
135 * interrupt handles are for IMS enumeration on guest. The misc
136 * interrupt vector does not require a handle and therefore we start
137 * the int_handles at index 0. Since 'i' starts at 1, the first
138 * int_handles index will be 0.
140 rc = idxd_device_request_int_handle(idxd, i, &idxd->int_handles[i - 1],
143 free_irq(irq_entry->vector, irq_entry);
146 dev_dbg(dev, "int handle requested: %u\n", idxd->int_handles[i - 1]);
150 idxd_unmask_error_interrupts(idxd);
151 idxd_msix_perm_setup(idxd);
156 irq_entry = &idxd->irq_entries[i];
157 free_irq(irq_entry->vector, irq_entry);
159 idxd_device_release_int_handle(idxd,
160 idxd->int_handles[i], IDXD_IRQ_MSIX);
163 /* Disable error interrupt generation */
164 idxd_mask_error_interrupts(idxd);
166 pci_free_irq_vectors(pdev);
167 dev_err(dev, "No usable interrupts\n");
171 static int idxd_setup_wqs(struct idxd_device *idxd)
173 struct device *dev = &idxd->pdev->dev;
177 idxd->wqs = kcalloc_node(idxd->max_wqs, sizeof(struct idxd_wq *),
178 GFP_KERNEL, dev_to_node(dev));
182 for (i = 0; i < idxd->max_wqs; i++) {
183 wq = kzalloc_node(sizeof(*wq), GFP_KERNEL, dev_to_node(dev));
191 device_initialize(&wq->conf_dev);
192 wq->conf_dev.parent = &idxd->conf_dev;
193 wq->conf_dev.bus = &dsa_bus_type;
194 wq->conf_dev.type = &idxd_wq_device_type;
195 rc = dev_set_name(&wq->conf_dev, "wq%d.%d", idxd->id, wq->id);
197 put_device(&wq->conf_dev);
201 mutex_init(&wq->wq_lock);
202 init_waitqueue_head(&wq->err_queue);
203 init_completion(&wq->wq_dead);
204 wq->max_xfer_bytes = idxd->max_xfer_bytes;
205 wq->max_batch_size = idxd->max_batch_size;
206 wq->wqcfg = kzalloc_node(idxd->wqcfg_size, GFP_KERNEL, dev_to_node(dev));
208 put_device(&wq->conf_dev);
219 put_device(&idxd->wqs[i]->conf_dev);
223 static int idxd_setup_engines(struct idxd_device *idxd)
225 struct idxd_engine *engine;
226 struct device *dev = &idxd->pdev->dev;
229 idxd->engines = kcalloc_node(idxd->max_engines, sizeof(struct idxd_engine *),
230 GFP_KERNEL, dev_to_node(dev));
234 for (i = 0; i < idxd->max_engines; i++) {
235 engine = kzalloc_node(sizeof(*engine), GFP_KERNEL, dev_to_node(dev));
243 device_initialize(&engine->conf_dev);
244 engine->conf_dev.parent = &idxd->conf_dev;
245 engine->conf_dev.type = &idxd_engine_device_type;
246 rc = dev_set_name(&engine->conf_dev, "engine%d.%d", idxd->id, engine->id);
248 put_device(&engine->conf_dev);
252 idxd->engines[i] = engine;
259 put_device(&idxd->engines[i]->conf_dev);
263 static int idxd_setup_groups(struct idxd_device *idxd)
265 struct device *dev = &idxd->pdev->dev;
266 struct idxd_group *group;
269 idxd->groups = kcalloc_node(idxd->max_groups, sizeof(struct idxd_group *),
270 GFP_KERNEL, dev_to_node(dev));
274 for (i = 0; i < idxd->max_groups; i++) {
275 group = kzalloc_node(sizeof(*group), GFP_KERNEL, dev_to_node(dev));
283 device_initialize(&group->conf_dev);
284 group->conf_dev.parent = &idxd->conf_dev;
285 group->conf_dev.bus = &dsa_bus_type;
286 group->conf_dev.type = &idxd_group_device_type;
287 rc = dev_set_name(&group->conf_dev, "group%d.%d", idxd->id, group->id);
289 put_device(&group->conf_dev);
293 idxd->groups[i] = group;
302 put_device(&idxd->groups[i]->conf_dev);
306 static int idxd_setup_internals(struct idxd_device *idxd)
308 struct device *dev = &idxd->pdev->dev;
311 init_waitqueue_head(&idxd->cmd_waitq);
313 if (idxd->hw.cmd_cap & BIT(IDXD_CMD_REQUEST_INT_HANDLE)) {
314 idxd->int_handles = devm_kcalloc(dev, idxd->max_wqs, sizeof(int), GFP_KERNEL);
315 if (!idxd->int_handles)
319 rc = idxd_setup_wqs(idxd);
323 rc = idxd_setup_engines(idxd);
327 rc = idxd_setup_groups(idxd);
331 idxd->wq = create_workqueue(dev_name(dev));
340 for (i = 0; i < idxd->max_groups; i++)
341 put_device(&idxd->groups[i]->conf_dev);
343 for (i = 0; i < idxd->max_engines; i++)
344 put_device(&idxd->engines[i]->conf_dev);
346 for (i = 0; i < idxd->max_wqs; i++)
347 put_device(&idxd->wqs[i]->conf_dev);
349 kfree(idxd->int_handles);
353 static void idxd_read_table_offsets(struct idxd_device *idxd)
355 union offsets_reg offsets;
356 struct device *dev = &idxd->pdev->dev;
358 offsets.bits[0] = ioread64(idxd->reg_base + IDXD_TABLE_OFFSET);
359 offsets.bits[1] = ioread64(idxd->reg_base + IDXD_TABLE_OFFSET + sizeof(u64));
360 idxd->grpcfg_offset = offsets.grpcfg * IDXD_TABLE_MULT;
361 dev_dbg(dev, "IDXD Group Config Offset: %#x\n", idxd->grpcfg_offset);
362 idxd->wqcfg_offset = offsets.wqcfg * IDXD_TABLE_MULT;
363 dev_dbg(dev, "IDXD Work Queue Config Offset: %#x\n", idxd->wqcfg_offset);
364 idxd->msix_perm_offset = offsets.msix_perm * IDXD_TABLE_MULT;
365 dev_dbg(dev, "IDXD MSIX Permission Offset: %#x\n", idxd->msix_perm_offset);
366 idxd->perfmon_offset = offsets.perfmon * IDXD_TABLE_MULT;
367 dev_dbg(dev, "IDXD Perfmon Offset: %#x\n", idxd->perfmon_offset);
370 static void idxd_read_caps(struct idxd_device *idxd)
372 struct device *dev = &idxd->pdev->dev;
375 /* reading generic capabilities */
376 idxd->hw.gen_cap.bits = ioread64(idxd->reg_base + IDXD_GENCAP_OFFSET);
377 dev_dbg(dev, "gen_cap: %#llx\n", idxd->hw.gen_cap.bits);
379 if (idxd->hw.gen_cap.cmd_cap) {
380 idxd->hw.cmd_cap = ioread32(idxd->reg_base + IDXD_CMDCAP_OFFSET);
381 dev_dbg(dev, "cmd_cap: %#x\n", idxd->hw.cmd_cap);
384 idxd->max_xfer_bytes = 1ULL << idxd->hw.gen_cap.max_xfer_shift;
385 dev_dbg(dev, "max xfer size: %llu bytes\n", idxd->max_xfer_bytes);
386 idxd->max_batch_size = 1U << idxd->hw.gen_cap.max_batch_shift;
387 dev_dbg(dev, "max batch size: %u\n", idxd->max_batch_size);
388 if (idxd->hw.gen_cap.config_en)
389 set_bit(IDXD_FLAG_CONFIGURABLE, &idxd->flags);
391 /* reading group capabilities */
392 idxd->hw.group_cap.bits =
393 ioread64(idxd->reg_base + IDXD_GRPCAP_OFFSET);
394 dev_dbg(dev, "group_cap: %#llx\n", idxd->hw.group_cap.bits);
395 idxd->max_groups = idxd->hw.group_cap.num_groups;
396 dev_dbg(dev, "max groups: %u\n", idxd->max_groups);
397 idxd->max_tokens = idxd->hw.group_cap.total_tokens;
398 dev_dbg(dev, "max tokens: %u\n", idxd->max_tokens);
399 idxd->nr_tokens = idxd->max_tokens;
401 /* read engine capabilities */
402 idxd->hw.engine_cap.bits =
403 ioread64(idxd->reg_base + IDXD_ENGCAP_OFFSET);
404 dev_dbg(dev, "engine_cap: %#llx\n", idxd->hw.engine_cap.bits);
405 idxd->max_engines = idxd->hw.engine_cap.num_engines;
406 dev_dbg(dev, "max engines: %u\n", idxd->max_engines);
408 /* read workqueue capabilities */
409 idxd->hw.wq_cap.bits = ioread64(idxd->reg_base + IDXD_WQCAP_OFFSET);
410 dev_dbg(dev, "wq_cap: %#llx\n", idxd->hw.wq_cap.bits);
411 idxd->max_wq_size = idxd->hw.wq_cap.total_wq_size;
412 dev_dbg(dev, "total workqueue size: %u\n", idxd->max_wq_size);
413 idxd->max_wqs = idxd->hw.wq_cap.num_wqs;
414 dev_dbg(dev, "max workqueues: %u\n", idxd->max_wqs);
415 idxd->wqcfg_size = 1 << (idxd->hw.wq_cap.wqcfg_size + IDXD_WQCFG_MIN);
416 dev_dbg(dev, "wqcfg size: %u\n", idxd->wqcfg_size);
418 /* reading operation capabilities */
419 for (i = 0; i < 4; i++) {
420 idxd->hw.opcap.bits[i] = ioread64(idxd->reg_base +
421 IDXD_OPCAP_OFFSET + i * sizeof(u64));
422 dev_dbg(dev, "opcap[%d]: %#llx\n", i, idxd->hw.opcap.bits[i]);
426 static struct idxd_device *idxd_alloc(struct pci_dev *pdev, struct idxd_driver_data *data)
428 struct device *dev = &pdev->dev;
429 struct idxd_device *idxd;
432 idxd = kzalloc_node(sizeof(*idxd), GFP_KERNEL, dev_to_node(dev));
438 idxd->id = ida_alloc(&idxd_ida, GFP_KERNEL);
442 device_initialize(&idxd->conf_dev);
443 idxd->conf_dev.parent = dev;
444 idxd->conf_dev.bus = &dsa_bus_type;
445 idxd->conf_dev.type = idxd->data->dev_type;
446 rc = dev_set_name(&idxd->conf_dev, "%s%d", idxd->data->name_prefix, idxd->id);
448 put_device(&idxd->conf_dev);
452 spin_lock_init(&idxd->dev_lock);
453 spin_lock_init(&idxd->cmd_lock);
458 static int idxd_enable_system_pasid(struct idxd_device *idxd)
462 struct iommu_sva *sva;
464 flags = SVM_FLAG_SUPERVISOR_MODE;
466 sva = iommu_sva_bind_device(&idxd->pdev->dev, NULL, &flags);
468 dev_warn(&idxd->pdev->dev,
469 "iommu sva bind failed: %ld\n", PTR_ERR(sva));
473 pasid = iommu_sva_get_pasid(sva);
474 if (pasid == IOMMU_PASID_INVALID) {
475 iommu_sva_unbind_device(sva);
481 dev_dbg(&idxd->pdev->dev, "system pasid: %u\n", pasid);
485 static void idxd_disable_system_pasid(struct idxd_device *idxd)
488 iommu_sva_unbind_device(idxd->sva);
492 static int idxd_probe(struct idxd_device *idxd)
494 struct pci_dev *pdev = idxd->pdev;
495 struct device *dev = &pdev->dev;
498 dev_dbg(dev, "%s entered and resetting device\n", __func__);
499 rc = idxd_device_init_reset(idxd);
503 dev_dbg(dev, "IDXD reset complete\n");
505 if (IS_ENABLED(CONFIG_INTEL_IDXD_SVM) && sva) {
506 rc = iommu_dev_enable_feature(dev, IOMMU_DEV_FEAT_SVA);
508 rc = idxd_enable_system_pasid(idxd);
510 iommu_dev_disable_feature(dev, IOMMU_DEV_FEAT_SVA);
511 dev_warn(dev, "Failed to enable PASID. No SVA support: %d\n", rc);
513 set_bit(IDXD_FLAG_PASID_ENABLED, &idxd->flags);
516 dev_warn(dev, "Unable to turn on SVA feature.\n");
519 dev_warn(dev, "User forced SVA off via module param.\n");
522 idxd_read_caps(idxd);
523 idxd_read_table_offsets(idxd);
525 rc = idxd_setup_internals(idxd);
529 /* If the configs are readonly, then load them from device */
530 if (!test_bit(IDXD_FLAG_CONFIGURABLE, &idxd->flags)) {
531 dev_dbg(dev, "Loading RO device config\n");
532 rc = idxd_device_load_config(idxd);
537 rc = idxd_setup_interrupts(idxd);
541 dev_dbg(dev, "IDXD interrupt setup complete.\n");
543 idxd->major = idxd_cdev_get_major(idxd);
545 rc = perfmon_pmu_init(idxd);
547 dev_warn(dev, "Failed to initialize perfmon. No PMU support: %d\n", rc);
549 dev_dbg(dev, "IDXD device %d probed successfully\n", idxd->id);
553 if (device_pasid_enabled(idxd))
554 idxd_disable_system_pasid(idxd);
555 iommu_dev_disable_feature(dev, IOMMU_DEV_FEAT_SVA);
559 static int idxd_pci_probe(struct pci_dev *pdev, const struct pci_device_id *id)
561 struct device *dev = &pdev->dev;
562 struct idxd_device *idxd;
563 struct idxd_driver_data *data = (struct idxd_driver_data *)id->driver_data;
566 rc = pci_enable_device(pdev);
570 dev_dbg(dev, "Alloc IDXD context\n");
571 idxd = idxd_alloc(pdev, data);
577 dev_dbg(dev, "Mapping BARs\n");
578 idxd->reg_base = pci_iomap(pdev, IDXD_MMIO_BAR, 0);
579 if (!idxd->reg_base) {
584 dev_dbg(dev, "Set DMA masks\n");
585 rc = pci_set_dma_mask(pdev, DMA_BIT_MASK(64));
587 rc = pci_set_dma_mask(pdev, DMA_BIT_MASK(32));
591 rc = pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(64));
593 rc = pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(32));
597 dev_dbg(dev, "Set PCI master\n");
598 pci_set_master(pdev);
599 pci_set_drvdata(pdev, idxd);
601 idxd->hw.version = ioread32(idxd->reg_base + IDXD_VER_OFFSET);
602 rc = idxd_probe(idxd);
604 dev_err(dev, "Intel(R) IDXD DMA Engine init failed\n");
608 rc = idxd_register_devices(idxd);
610 dev_err(dev, "IDXD sysfs setup failed\n");
614 idxd->state = IDXD_DEV_CONF_READY;
616 dev_info(&pdev->dev, "Intel(R) Accelerator Device (v%x)\n",
622 pci_iounmap(pdev, idxd->reg_base);
624 put_device(&idxd->conf_dev);
626 pci_disable_device(pdev);
630 static void idxd_flush_pending_llist(struct idxd_irq_entry *ie)
632 struct idxd_desc *desc, *itr;
633 struct llist_node *head;
635 head = llist_del_all(&ie->pending_llist);
639 llist_for_each_entry_safe(desc, itr, head, llnode) {
640 idxd_dma_complete_txd(desc, IDXD_COMPLETE_ABORT);
641 idxd_free_desc(desc->wq, desc);
645 static void idxd_flush_work_list(struct idxd_irq_entry *ie)
647 struct idxd_desc *desc, *iter;
649 list_for_each_entry_safe(desc, iter, &ie->work_list, list) {
650 list_del(&desc->list);
651 idxd_dma_complete_txd(desc, IDXD_COMPLETE_ABORT);
652 idxd_free_desc(desc->wq, desc);
656 void idxd_wqs_quiesce(struct idxd_device *idxd)
661 for (i = 0; i < idxd->max_wqs; i++) {
663 if (wq->state == IDXD_WQ_ENABLED && wq->type == IDXD_WQT_KERNEL)
668 static void idxd_release_int_handles(struct idxd_device *idxd)
670 struct device *dev = &idxd->pdev->dev;
673 for (i = 0; i < idxd->num_wq_irqs; i++) {
674 if (idxd->hw.cmd_cap & BIT(IDXD_CMD_RELEASE_INT_HANDLE)) {
675 rc = idxd_device_release_int_handle(idxd, idxd->int_handles[i],
678 dev_warn(dev, "irq handle %d release failed\n",
679 idxd->int_handles[i]);
681 dev_dbg(dev, "int handle requested: %u\n", idxd->int_handles[i]);
686 static void idxd_shutdown(struct pci_dev *pdev)
688 struct idxd_device *idxd = pci_get_drvdata(pdev);
690 struct idxd_irq_entry *irq_entry;
691 int msixcnt = pci_msix_vec_count(pdev);
693 rc = idxd_device_disable(idxd);
695 dev_err(&pdev->dev, "Disabling device failed\n");
697 dev_dbg(&pdev->dev, "%s called\n", __func__);
698 idxd_mask_msix_vectors(idxd);
699 idxd_mask_error_interrupts(idxd);
701 for (i = 0; i < msixcnt; i++) {
702 irq_entry = &idxd->irq_entries[i];
703 synchronize_irq(irq_entry->vector);
704 free_irq(irq_entry->vector, irq_entry);
707 idxd_flush_pending_llist(irq_entry);
708 idxd_flush_work_list(irq_entry);
711 idxd_msix_perm_clear(idxd);
712 idxd_release_int_handles(idxd);
713 pci_free_irq_vectors(pdev);
714 pci_iounmap(pdev, idxd->reg_base);
715 pci_disable_device(pdev);
716 destroy_workqueue(idxd->wq);
719 static void idxd_remove(struct pci_dev *pdev)
721 struct idxd_device *idxd = pci_get_drvdata(pdev);
723 dev_dbg(&pdev->dev, "%s called\n", __func__);
725 if (device_pasid_enabled(idxd))
726 idxd_disable_system_pasid(idxd);
727 idxd_unregister_devices(idxd);
728 perfmon_pmu_remove(idxd);
729 iommu_dev_disable_feature(&pdev->dev, IOMMU_DEV_FEAT_SVA);
732 static struct pci_driver idxd_pci_driver = {
734 .id_table = idxd_pci_tbl,
735 .probe = idxd_pci_probe,
736 .remove = idxd_remove,
737 .shutdown = idxd_shutdown,
740 static int __init idxd_init_module(void)
745 * If the CPU does not support MOVDIR64B or ENQCMDS, there's no point in
746 * enumerating the device. We can not utilize it.
748 if (!boot_cpu_has(X86_FEATURE_MOVDIR64B)) {
749 pr_warn("idxd driver failed to load without MOVDIR64B.\n");
753 if (!boot_cpu_has(X86_FEATURE_ENQCMD))
754 pr_warn("Platform does not have ENQCMD(S) support.\n");
756 support_enqcmd = true;
760 err = idxd_register_bus_type();
764 err = idxd_register_driver();
766 goto err_idxd_driver_register;
768 err = idxd_cdev_register();
770 goto err_cdev_register;
772 err = pci_register_driver(&idxd_pci_driver);
774 goto err_pci_register;
781 idxd_unregister_driver();
782 err_idxd_driver_register:
783 idxd_unregister_bus_type();
786 module_init(idxd_init_module);
788 static void __exit idxd_exit_module(void)
790 pci_unregister_driver(&idxd_pci_driver);
792 idxd_unregister_bus_type();
795 module_exit(idxd_exit_module);