1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) 2013 - Virtual Open Systems
7 #define dev_fmt(fmt) "VFIO: " fmt
9 #include <linux/device.h>
10 #include <linux/acpi.h>
11 #include <linux/iommu.h>
12 #include <linux/module.h>
13 #include <linux/mutex.h>
14 #include <linux/pm_runtime.h>
15 #include <linux/slab.h>
16 #include <linux/types.h>
17 #include <linux/uaccess.h>
18 #include <linux/vfio.h>
20 #include "vfio_platform_private.h"
22 #define DRIVER_VERSION "0.10"
24 #define DRIVER_DESC "VFIO platform base module"
26 #define VFIO_PLATFORM_IS_ACPI(vdev) ((vdev)->acpihid != NULL)
28 static LIST_HEAD(reset_list);
29 static DEFINE_MUTEX(driver_lock);
31 static vfio_platform_reset_fn_t vfio_platform_lookup_reset(const char *compat,
32 struct module **module)
34 struct vfio_platform_reset_node *iter;
35 vfio_platform_reset_fn_t reset_fn = NULL;
37 mutex_lock(&driver_lock);
38 list_for_each_entry(iter, &reset_list, link) {
39 if (!strcmp(iter->compat, compat) &&
40 try_module_get(iter->owner)) {
41 *module = iter->owner;
42 reset_fn = iter->of_reset;
46 mutex_unlock(&driver_lock);
50 static int vfio_platform_acpi_probe(struct vfio_platform_device *vdev,
53 struct acpi_device *adev;
58 adev = ACPI_COMPANION(dev);
60 dev_err(dev, "ACPI companion device not found for %s\n",
66 vdev->acpihid = acpi_device_hid(adev);
68 return WARN_ON(!vdev->acpihid) ? -EINVAL : 0;
71 static int vfio_platform_acpi_call_reset(struct vfio_platform_device *vdev,
72 const char **extra_dbg)
75 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
76 struct device *dev = vdev->device;
77 acpi_handle handle = ACPI_HANDLE(dev);
80 acpi_ret = acpi_evaluate_object(handle, "_RST", NULL, &buffer);
81 if (ACPI_FAILURE(acpi_ret)) {
83 *extra_dbg = acpi_format_exception(acpi_ret);
93 static bool vfio_platform_acpi_has_reset(struct vfio_platform_device *vdev)
96 struct device *dev = vdev->device;
97 acpi_handle handle = ACPI_HANDLE(dev);
99 return acpi_has_method(handle, "_RST");
105 static bool vfio_platform_has_reset(struct vfio_platform_device *vdev)
107 if (VFIO_PLATFORM_IS_ACPI(vdev))
108 return vfio_platform_acpi_has_reset(vdev);
110 return vdev->of_reset ? true : false;
113 static int vfio_platform_get_reset(struct vfio_platform_device *vdev)
115 if (VFIO_PLATFORM_IS_ACPI(vdev))
116 return vfio_platform_acpi_has_reset(vdev) ? 0 : -ENOENT;
118 vdev->of_reset = vfio_platform_lookup_reset(vdev->compat,
119 &vdev->reset_module);
120 if (!vdev->of_reset) {
121 request_module("vfio-reset:%s", vdev->compat);
122 vdev->of_reset = vfio_platform_lookup_reset(vdev->compat,
123 &vdev->reset_module);
126 return vdev->of_reset ? 0 : -ENOENT;
129 static void vfio_platform_put_reset(struct vfio_platform_device *vdev)
131 if (VFIO_PLATFORM_IS_ACPI(vdev))
135 module_put(vdev->reset_module);
138 static int vfio_platform_regions_init(struct vfio_platform_device *vdev)
142 while (vdev->get_resource(vdev, cnt))
145 vdev->regions = kcalloc(cnt, sizeof(struct vfio_platform_region),
150 for (i = 0; i < cnt; i++) {
151 struct resource *res =
152 vdev->get_resource(vdev, i);
157 vdev->regions[i].addr = res->start;
158 vdev->regions[i].size = resource_size(res);
159 vdev->regions[i].flags = 0;
161 switch (resource_type(res)) {
163 vdev->regions[i].type = VFIO_PLATFORM_REGION_TYPE_MMIO;
164 vdev->regions[i].flags |= VFIO_REGION_INFO_FLAG_READ;
165 if (!(res->flags & IORESOURCE_READONLY))
166 vdev->regions[i].flags |=
167 VFIO_REGION_INFO_FLAG_WRITE;
170 * Only regions addressed with PAGE granularity may be
173 if (!(vdev->regions[i].addr & ~PAGE_MASK) &&
174 !(vdev->regions[i].size & ~PAGE_MASK))
175 vdev->regions[i].flags |=
176 VFIO_REGION_INFO_FLAG_MMAP;
180 vdev->regions[i].type = VFIO_PLATFORM_REGION_TYPE_PIO;
187 vdev->num_regions = cnt;
191 kfree(vdev->regions);
195 static void vfio_platform_regions_cleanup(struct vfio_platform_device *vdev)
199 for (i = 0; i < vdev->num_regions; i++)
200 iounmap(vdev->regions[i].ioaddr);
202 vdev->num_regions = 0;
203 kfree(vdev->regions);
206 static int vfio_platform_call_reset(struct vfio_platform_device *vdev,
207 const char **extra_dbg)
209 if (VFIO_PLATFORM_IS_ACPI(vdev)) {
210 dev_info(vdev->device, "reset\n");
211 return vfio_platform_acpi_call_reset(vdev, extra_dbg);
212 } else if (vdev->of_reset) {
213 dev_info(vdev->device, "reset\n");
214 return vdev->of_reset(vdev);
217 dev_warn(vdev->device, "no reset function found!\n");
221 static void vfio_platform_close_device(struct vfio_device *core_vdev)
223 struct vfio_platform_device *vdev =
224 container_of(core_vdev, struct vfio_platform_device, vdev);
225 const char *extra_dbg = NULL;
228 ret = vfio_platform_call_reset(vdev, &extra_dbg);
229 if (WARN_ON(ret && vdev->reset_required)) {
232 "reset driver is required and reset call failed in release (%d) %s\n",
233 ret, extra_dbg ? extra_dbg : "");
235 pm_runtime_put(vdev->device);
236 vfio_platform_regions_cleanup(vdev);
237 vfio_platform_irq_cleanup(vdev);
240 static int vfio_platform_open_device(struct vfio_device *core_vdev)
242 struct vfio_platform_device *vdev =
243 container_of(core_vdev, struct vfio_platform_device, vdev);
244 const char *extra_dbg = NULL;
247 ret = vfio_platform_regions_init(vdev);
251 ret = vfio_platform_irq_init(vdev);
255 ret = pm_runtime_get_sync(vdev->device);
259 ret = vfio_platform_call_reset(vdev, &extra_dbg);
260 if (ret && vdev->reset_required) {
263 "reset driver is required and reset call failed in open (%d) %s\n",
264 ret, extra_dbg ? extra_dbg : "");
270 pm_runtime_put(vdev->device);
271 vfio_platform_irq_cleanup(vdev);
273 vfio_platform_regions_cleanup(vdev);
277 static long vfio_platform_ioctl(struct vfio_device *core_vdev,
278 unsigned int cmd, unsigned long arg)
280 struct vfio_platform_device *vdev =
281 container_of(core_vdev, struct vfio_platform_device, vdev);
285 if (cmd == VFIO_DEVICE_GET_INFO) {
286 struct vfio_device_info info;
288 minsz = offsetofend(struct vfio_device_info, num_irqs);
290 if (copy_from_user(&info, (void __user *)arg, minsz))
293 if (info.argsz < minsz)
296 if (vfio_platform_has_reset(vdev))
297 vdev->flags |= VFIO_DEVICE_FLAGS_RESET;
298 info.flags = vdev->flags;
299 info.num_regions = vdev->num_regions;
300 info.num_irqs = vdev->num_irqs;
302 return copy_to_user((void __user *)arg, &info, minsz) ?
305 } else if (cmd == VFIO_DEVICE_GET_REGION_INFO) {
306 struct vfio_region_info info;
308 minsz = offsetofend(struct vfio_region_info, offset);
310 if (copy_from_user(&info, (void __user *)arg, minsz))
313 if (info.argsz < minsz)
316 if (info.index >= vdev->num_regions)
319 /* map offset to the physical address */
320 info.offset = VFIO_PLATFORM_INDEX_TO_OFFSET(info.index);
321 info.size = vdev->regions[info.index].size;
322 info.flags = vdev->regions[info.index].flags;
324 return copy_to_user((void __user *)arg, &info, minsz) ?
327 } else if (cmd == VFIO_DEVICE_GET_IRQ_INFO) {
328 struct vfio_irq_info info;
330 minsz = offsetofend(struct vfio_irq_info, count);
332 if (copy_from_user(&info, (void __user *)arg, minsz))
335 if (info.argsz < minsz)
338 if (info.index >= vdev->num_irqs)
341 info.flags = vdev->irqs[info.index].flags;
342 info.count = vdev->irqs[info.index].count;
344 return copy_to_user((void __user *)arg, &info, minsz) ?
347 } else if (cmd == VFIO_DEVICE_SET_IRQS) {
348 struct vfio_irq_set hdr;
351 size_t data_size = 0;
353 minsz = offsetofend(struct vfio_irq_set, count);
355 if (copy_from_user(&hdr, (void __user *)arg, minsz))
358 ret = vfio_set_irqs_validate_and_prepare(&hdr, vdev->num_irqs,
359 vdev->num_irqs, &data_size);
364 data = memdup_user((void __user *)(arg + minsz),
367 return PTR_ERR(data);
370 mutex_lock(&vdev->igate);
372 ret = vfio_platform_set_irqs_ioctl(vdev, hdr.flags, hdr.index,
373 hdr.start, hdr.count, data);
374 mutex_unlock(&vdev->igate);
379 } else if (cmd == VFIO_DEVICE_RESET) {
380 return vfio_platform_call_reset(vdev, NULL);
386 static ssize_t vfio_platform_read_mmio(struct vfio_platform_region *reg,
387 char __user *buf, size_t count,
390 unsigned int done = 0;
394 ioremap(reg->addr, reg->size);
403 if (count >= 4 && !(off % 4)) {
406 val = ioread32(reg->ioaddr + off);
407 if (copy_to_user(buf, &val, 4))
411 } else if (count >= 2 && !(off % 2)) {
414 val = ioread16(reg->ioaddr + off);
415 if (copy_to_user(buf, &val, 2))
422 val = ioread8(reg->ioaddr + off);
423 if (copy_to_user(buf, &val, 1))
441 static ssize_t vfio_platform_read(struct vfio_device *core_vdev,
442 char __user *buf, size_t count, loff_t *ppos)
444 struct vfio_platform_device *vdev =
445 container_of(core_vdev, struct vfio_platform_device, vdev);
446 unsigned int index = VFIO_PLATFORM_OFFSET_TO_INDEX(*ppos);
447 loff_t off = *ppos & VFIO_PLATFORM_OFFSET_MASK;
449 if (index >= vdev->num_regions)
452 if (!(vdev->regions[index].flags & VFIO_REGION_INFO_FLAG_READ))
455 if (vdev->regions[index].type & VFIO_PLATFORM_REGION_TYPE_MMIO)
456 return vfio_platform_read_mmio(&vdev->regions[index],
458 else if (vdev->regions[index].type & VFIO_PLATFORM_REGION_TYPE_PIO)
459 return -EINVAL; /* not implemented */
464 static ssize_t vfio_platform_write_mmio(struct vfio_platform_region *reg,
465 const char __user *buf, size_t count,
468 unsigned int done = 0;
472 ioremap(reg->addr, reg->size);
481 if (count >= 4 && !(off % 4)) {
484 if (copy_from_user(&val, buf, 4))
486 iowrite32(val, reg->ioaddr + off);
489 } else if (count >= 2 && !(off % 2)) {
492 if (copy_from_user(&val, buf, 2))
494 iowrite16(val, reg->ioaddr + off);
500 if (copy_from_user(&val, buf, 1))
502 iowrite8(val, reg->ioaddr + off);
518 static ssize_t vfio_platform_write(struct vfio_device *core_vdev, const char __user *buf,
519 size_t count, loff_t *ppos)
521 struct vfio_platform_device *vdev =
522 container_of(core_vdev, struct vfio_platform_device, vdev);
523 unsigned int index = VFIO_PLATFORM_OFFSET_TO_INDEX(*ppos);
524 loff_t off = *ppos & VFIO_PLATFORM_OFFSET_MASK;
526 if (index >= vdev->num_regions)
529 if (!(vdev->regions[index].flags & VFIO_REGION_INFO_FLAG_WRITE))
532 if (vdev->regions[index].type & VFIO_PLATFORM_REGION_TYPE_MMIO)
533 return vfio_platform_write_mmio(&vdev->regions[index],
535 else if (vdev->regions[index].type & VFIO_PLATFORM_REGION_TYPE_PIO)
536 return -EINVAL; /* not implemented */
541 static int vfio_platform_mmap_mmio(struct vfio_platform_region region,
542 struct vm_area_struct *vma)
544 u64 req_len, pgoff, req_start;
546 req_len = vma->vm_end - vma->vm_start;
547 pgoff = vma->vm_pgoff &
548 ((1U << (VFIO_PLATFORM_OFFSET_SHIFT - PAGE_SHIFT)) - 1);
549 req_start = pgoff << PAGE_SHIFT;
551 if (region.size < PAGE_SIZE || req_start + req_len > region.size)
554 vma->vm_page_prot = pgprot_noncached(vma->vm_page_prot);
555 vma->vm_pgoff = (region.addr >> PAGE_SHIFT) + pgoff;
557 return remap_pfn_range(vma, vma->vm_start, vma->vm_pgoff,
558 req_len, vma->vm_page_prot);
561 static int vfio_platform_mmap(struct vfio_device *core_vdev, struct vm_area_struct *vma)
563 struct vfio_platform_device *vdev =
564 container_of(core_vdev, struct vfio_platform_device, vdev);
567 index = vma->vm_pgoff >> (VFIO_PLATFORM_OFFSET_SHIFT - PAGE_SHIFT);
569 if (vma->vm_end < vma->vm_start)
571 if (!(vma->vm_flags & VM_SHARED))
573 if (index >= vdev->num_regions)
575 if (vma->vm_start & ~PAGE_MASK)
577 if (vma->vm_end & ~PAGE_MASK)
580 if (!(vdev->regions[index].flags & VFIO_REGION_INFO_FLAG_MMAP))
583 if (!(vdev->regions[index].flags & VFIO_REGION_INFO_FLAG_READ)
584 && (vma->vm_flags & VM_READ))
587 if (!(vdev->regions[index].flags & VFIO_REGION_INFO_FLAG_WRITE)
588 && (vma->vm_flags & VM_WRITE))
591 vma->vm_private_data = vdev;
593 if (vdev->regions[index].type & VFIO_PLATFORM_REGION_TYPE_MMIO)
594 return vfio_platform_mmap_mmio(vdev->regions[index], vma);
596 else if (vdev->regions[index].type & VFIO_PLATFORM_REGION_TYPE_PIO)
597 return -EINVAL; /* not implemented */
602 static const struct vfio_device_ops vfio_platform_ops = {
603 .name = "vfio-platform",
604 .open_device = vfio_platform_open_device,
605 .close_device = vfio_platform_close_device,
606 .ioctl = vfio_platform_ioctl,
607 .read = vfio_platform_read,
608 .write = vfio_platform_write,
609 .mmap = vfio_platform_mmap,
612 static int vfio_platform_of_probe(struct vfio_platform_device *vdev,
617 ret = device_property_read_string(dev, "compatible",
620 dev_err(dev, "Cannot retrieve compat for %s\n", vdev->name);
626 * There can be two kernel build combinations. One build where
627 * ACPI is not selected in Kconfig and another one with the ACPI Kconfig.
629 * In the first case, vfio_platform_acpi_probe will return since
630 * acpi_disabled is 1. DT user will not see any kind of messages from
633 * In the second case, both DT and ACPI is compiled in but the system is
634 * booting with any of these combinations.
636 * If the firmware is DT type, then acpi_disabled is 1. The ACPI probe routine
637 * terminates immediately without any messages.
639 * If the firmware is ACPI type, then acpi_disabled is 0. All other checks are
640 * valid checks. We cannot claim that this system is DT.
642 int vfio_platform_probe_common(struct vfio_platform_device *vdev,
647 vfio_init_group_dev(&vdev->vdev, dev, &vfio_platform_ops);
649 ret = vfio_platform_acpi_probe(vdev, dev);
651 ret = vfio_platform_of_probe(vdev, dev);
658 ret = vfio_platform_get_reset(vdev);
659 if (ret && vdev->reset_required) {
660 dev_err(dev, "No reset function found for device %s\n",
665 ret = vfio_register_group_dev(&vdev->vdev);
669 mutex_init(&vdev->igate);
671 pm_runtime_enable(dev);
675 vfio_platform_put_reset(vdev);
677 vfio_uninit_group_dev(&vdev->vdev);
680 EXPORT_SYMBOL_GPL(vfio_platform_probe_common);
682 void vfio_platform_remove_common(struct vfio_platform_device *vdev)
684 vfio_unregister_group_dev(&vdev->vdev);
686 pm_runtime_disable(vdev->device);
687 vfio_platform_put_reset(vdev);
688 vfio_uninit_group_dev(&vdev->vdev);
690 EXPORT_SYMBOL_GPL(vfio_platform_remove_common);
692 void __vfio_platform_register_reset(struct vfio_platform_reset_node *node)
694 mutex_lock(&driver_lock);
695 list_add(&node->link, &reset_list);
696 mutex_unlock(&driver_lock);
698 EXPORT_SYMBOL_GPL(__vfio_platform_register_reset);
700 void vfio_platform_unregister_reset(const char *compat,
701 vfio_platform_reset_fn_t fn)
703 struct vfio_platform_reset_node *iter, *temp;
705 mutex_lock(&driver_lock);
706 list_for_each_entry_safe(iter, temp, &reset_list, link) {
707 if (!strcmp(iter->compat, compat) && (iter->of_reset == fn)) {
708 list_del(&iter->link);
713 mutex_unlock(&driver_lock);
716 EXPORT_SYMBOL_GPL(vfio_platform_unregister_reset);
718 MODULE_VERSION(DRIVER_VERSION);
719 MODULE_LICENSE("GPL v2");
720 MODULE_AUTHOR(DRIVER_AUTHOR);
721 MODULE_DESCRIPTION(DRIVER_DESC);