1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) 2013 - Virtual Open Systems
4 * Author: Antonios Motakis <a.motakis@virtualopensystems.com>
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"
23 #define DRIVER_AUTHOR "Antonios Motakis <a.motakis@virtualopensystems.com>"
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 device *dev = vdev->device;
76 acpi_handle handle = ACPI_HANDLE(dev);
79 acpi_ret = acpi_evaluate_object(handle, "_RST", NULL, NULL);
80 if (ACPI_FAILURE(acpi_ret)) {
82 *extra_dbg = acpi_format_exception(acpi_ret);
92 static bool vfio_platform_acpi_has_reset(struct vfio_platform_device *vdev)
95 struct device *dev = vdev->device;
96 acpi_handle handle = ACPI_HANDLE(dev);
98 return acpi_has_method(handle, "_RST");
104 static bool vfio_platform_has_reset(struct vfio_platform_device *vdev)
106 if (VFIO_PLATFORM_IS_ACPI(vdev))
107 return vfio_platform_acpi_has_reset(vdev);
109 return vdev->of_reset ? true : false;
112 static int vfio_platform_get_reset(struct vfio_platform_device *vdev)
114 if (VFIO_PLATFORM_IS_ACPI(vdev))
115 return vfio_platform_acpi_has_reset(vdev) ? 0 : -ENOENT;
117 vdev->of_reset = vfio_platform_lookup_reset(vdev->compat,
118 &vdev->reset_module);
119 if (!vdev->of_reset) {
120 request_module("vfio-reset:%s", vdev->compat);
121 vdev->of_reset = vfio_platform_lookup_reset(vdev->compat,
122 &vdev->reset_module);
125 return vdev->of_reset ? 0 : -ENOENT;
128 static void vfio_platform_put_reset(struct vfio_platform_device *vdev)
130 if (VFIO_PLATFORM_IS_ACPI(vdev))
134 module_put(vdev->reset_module);
137 static int vfio_platform_regions_init(struct vfio_platform_device *vdev)
141 while (vdev->get_resource(vdev, cnt))
144 vdev->regions = kcalloc(cnt, sizeof(struct vfio_platform_region),
149 for (i = 0; i < cnt; i++) {
150 struct resource *res =
151 vdev->get_resource(vdev, i);
156 vdev->regions[i].addr = res->start;
157 vdev->regions[i].size = resource_size(res);
158 vdev->regions[i].flags = 0;
160 switch (resource_type(res)) {
162 vdev->regions[i].type = VFIO_PLATFORM_REGION_TYPE_MMIO;
163 vdev->regions[i].flags |= VFIO_REGION_INFO_FLAG_READ;
164 if (!(res->flags & IORESOURCE_READONLY))
165 vdev->regions[i].flags |=
166 VFIO_REGION_INFO_FLAG_WRITE;
169 * Only regions addressed with PAGE granularity may be
172 if (!(vdev->regions[i].addr & ~PAGE_MASK) &&
173 !(vdev->regions[i].size & ~PAGE_MASK))
174 vdev->regions[i].flags |=
175 VFIO_REGION_INFO_FLAG_MMAP;
179 vdev->regions[i].type = VFIO_PLATFORM_REGION_TYPE_PIO;
186 vdev->num_regions = cnt;
190 kfree(vdev->regions);
194 static void vfio_platform_regions_cleanup(struct vfio_platform_device *vdev)
198 for (i = 0; i < vdev->num_regions; i++)
199 iounmap(vdev->regions[i].ioaddr);
201 vdev->num_regions = 0;
202 kfree(vdev->regions);
205 static int vfio_platform_call_reset(struct vfio_platform_device *vdev,
206 const char **extra_dbg)
208 if (VFIO_PLATFORM_IS_ACPI(vdev)) {
209 dev_info(vdev->device, "reset\n");
210 return vfio_platform_acpi_call_reset(vdev, extra_dbg);
211 } else if (vdev->of_reset) {
212 dev_info(vdev->device, "reset\n");
213 return vdev->of_reset(vdev);
216 dev_warn(vdev->device, "no reset function found!\n");
220 static void vfio_platform_release(void *device_data)
222 struct vfio_platform_device *vdev = device_data;
224 mutex_lock(&driver_lock);
226 if (!(--vdev->refcnt)) {
227 const char *extra_dbg = NULL;
230 ret = vfio_platform_call_reset(vdev, &extra_dbg);
231 if (ret && vdev->reset_required) {
232 dev_warn(vdev->device, "reset driver is required and reset call failed in release (%d) %s\n",
233 ret, extra_dbg ? extra_dbg : "");
236 pm_runtime_put(vdev->device);
237 vfio_platform_regions_cleanup(vdev);
238 vfio_platform_irq_cleanup(vdev);
241 mutex_unlock(&driver_lock);
243 module_put(vdev->parent_module);
246 static int vfio_platform_open(void *device_data)
248 struct vfio_platform_device *vdev = device_data;
251 if (!try_module_get(vdev->parent_module))
254 mutex_lock(&driver_lock);
257 const char *extra_dbg = NULL;
259 ret = vfio_platform_regions_init(vdev);
263 ret = vfio_platform_irq_init(vdev);
267 ret = pm_runtime_get_sync(vdev->device);
271 ret = vfio_platform_call_reset(vdev, &extra_dbg);
272 if (ret && vdev->reset_required) {
273 dev_warn(vdev->device, "reset driver is required and reset call failed in open (%d) %s\n",
274 ret, extra_dbg ? extra_dbg : "");
281 mutex_unlock(&driver_lock);
285 pm_runtime_put(vdev->device);
286 vfio_platform_irq_cleanup(vdev);
288 vfio_platform_regions_cleanup(vdev);
290 mutex_unlock(&driver_lock);
291 module_put(vdev->parent_module);
295 static long vfio_platform_ioctl(void *device_data,
296 unsigned int cmd, unsigned long arg)
298 struct vfio_platform_device *vdev = device_data;
301 if (cmd == VFIO_DEVICE_GET_INFO) {
302 struct vfio_device_info info;
304 minsz = offsetofend(struct vfio_device_info, num_irqs);
306 if (copy_from_user(&info, (void __user *)arg, minsz))
309 if (info.argsz < minsz)
312 if (vfio_platform_has_reset(vdev))
313 vdev->flags |= VFIO_DEVICE_FLAGS_RESET;
314 info.flags = vdev->flags;
315 info.num_regions = vdev->num_regions;
316 info.num_irqs = vdev->num_irqs;
318 return copy_to_user((void __user *)arg, &info, minsz) ?
321 } else if (cmd == VFIO_DEVICE_GET_REGION_INFO) {
322 struct vfio_region_info info;
324 minsz = offsetofend(struct vfio_region_info, offset);
326 if (copy_from_user(&info, (void __user *)arg, minsz))
329 if (info.argsz < minsz)
332 if (info.index >= vdev->num_regions)
335 /* map offset to the physical address */
336 info.offset = VFIO_PLATFORM_INDEX_TO_OFFSET(info.index);
337 info.size = vdev->regions[info.index].size;
338 info.flags = vdev->regions[info.index].flags;
340 return copy_to_user((void __user *)arg, &info, minsz) ?
343 } else if (cmd == VFIO_DEVICE_GET_IRQ_INFO) {
344 struct vfio_irq_info info;
346 minsz = offsetofend(struct vfio_irq_info, count);
348 if (copy_from_user(&info, (void __user *)arg, minsz))
351 if (info.argsz < minsz)
354 if (info.index >= vdev->num_irqs)
357 info.flags = vdev->irqs[info.index].flags;
358 info.count = vdev->irqs[info.index].count;
360 return copy_to_user((void __user *)arg, &info, minsz) ?
363 } else if (cmd == VFIO_DEVICE_SET_IRQS) {
364 struct vfio_irq_set hdr;
367 size_t data_size = 0;
369 minsz = offsetofend(struct vfio_irq_set, count);
371 if (copy_from_user(&hdr, (void __user *)arg, minsz))
374 ret = vfio_set_irqs_validate_and_prepare(&hdr, vdev->num_irqs,
375 vdev->num_irqs, &data_size);
380 data = memdup_user((void __user *)(arg + minsz),
383 return PTR_ERR(data);
386 mutex_lock(&vdev->igate);
388 ret = vfio_platform_set_irqs_ioctl(vdev, hdr.flags, hdr.index,
389 hdr.start, hdr.count, data);
390 mutex_unlock(&vdev->igate);
395 } else if (cmd == VFIO_DEVICE_RESET) {
396 return vfio_platform_call_reset(vdev, NULL);
402 static ssize_t vfio_platform_read_mmio(struct vfio_platform_region *reg,
403 char __user *buf, size_t count,
406 unsigned int done = 0;
410 ioremap(reg->addr, reg->size);
419 if (count >= 4 && !(off % 4)) {
422 val = ioread32(reg->ioaddr + off);
423 if (copy_to_user(buf, &val, 4))
427 } else if (count >= 2 && !(off % 2)) {
430 val = ioread16(reg->ioaddr + off);
431 if (copy_to_user(buf, &val, 2))
438 val = ioread8(reg->ioaddr + off);
439 if (copy_to_user(buf, &val, 1))
457 static ssize_t vfio_platform_read(void *device_data, char __user *buf,
458 size_t count, loff_t *ppos)
460 struct vfio_platform_device *vdev = device_data;
461 unsigned int index = VFIO_PLATFORM_OFFSET_TO_INDEX(*ppos);
462 loff_t off = *ppos & VFIO_PLATFORM_OFFSET_MASK;
464 if (index >= vdev->num_regions)
467 if (!(vdev->regions[index].flags & VFIO_REGION_INFO_FLAG_READ))
470 if (vdev->regions[index].type & VFIO_PLATFORM_REGION_TYPE_MMIO)
471 return vfio_platform_read_mmio(&vdev->regions[index],
473 else if (vdev->regions[index].type & VFIO_PLATFORM_REGION_TYPE_PIO)
474 return -EINVAL; /* not implemented */
479 static ssize_t vfio_platform_write_mmio(struct vfio_platform_region *reg,
480 const char __user *buf, size_t count,
483 unsigned int done = 0;
487 ioremap(reg->addr, reg->size);
496 if (count >= 4 && !(off % 4)) {
499 if (copy_from_user(&val, buf, 4))
501 iowrite32(val, reg->ioaddr + off);
504 } else if (count >= 2 && !(off % 2)) {
507 if (copy_from_user(&val, buf, 2))
509 iowrite16(val, reg->ioaddr + off);
515 if (copy_from_user(&val, buf, 1))
517 iowrite8(val, reg->ioaddr + off);
533 static ssize_t vfio_platform_write(void *device_data, const char __user *buf,
534 size_t count, loff_t *ppos)
536 struct vfio_platform_device *vdev = device_data;
537 unsigned int index = VFIO_PLATFORM_OFFSET_TO_INDEX(*ppos);
538 loff_t off = *ppos & VFIO_PLATFORM_OFFSET_MASK;
540 if (index >= vdev->num_regions)
543 if (!(vdev->regions[index].flags & VFIO_REGION_INFO_FLAG_WRITE))
546 if (vdev->regions[index].type & VFIO_PLATFORM_REGION_TYPE_MMIO)
547 return vfio_platform_write_mmio(&vdev->regions[index],
549 else if (vdev->regions[index].type & VFIO_PLATFORM_REGION_TYPE_PIO)
550 return -EINVAL; /* not implemented */
555 static int vfio_platform_mmap_mmio(struct vfio_platform_region region,
556 struct vm_area_struct *vma)
558 u64 req_len, pgoff, req_start;
560 req_len = vma->vm_end - vma->vm_start;
561 pgoff = vma->vm_pgoff &
562 ((1U << (VFIO_PLATFORM_OFFSET_SHIFT - PAGE_SHIFT)) - 1);
563 req_start = pgoff << PAGE_SHIFT;
565 if (region.size < PAGE_SIZE || req_start + req_len > region.size)
568 vma->vm_page_prot = pgprot_noncached(vma->vm_page_prot);
569 vma->vm_pgoff = (region.addr >> PAGE_SHIFT) + pgoff;
571 return remap_pfn_range(vma, vma->vm_start, vma->vm_pgoff,
572 req_len, vma->vm_page_prot);
575 static int vfio_platform_mmap(void *device_data, struct vm_area_struct *vma)
577 struct vfio_platform_device *vdev = device_data;
580 index = vma->vm_pgoff >> (VFIO_PLATFORM_OFFSET_SHIFT - PAGE_SHIFT);
582 if (vma->vm_end < vma->vm_start)
584 if (!(vma->vm_flags & VM_SHARED))
586 if (index >= vdev->num_regions)
588 if (vma->vm_start & ~PAGE_MASK)
590 if (vma->vm_end & ~PAGE_MASK)
593 if (!(vdev->regions[index].flags & VFIO_REGION_INFO_FLAG_MMAP))
596 if (!(vdev->regions[index].flags & VFIO_REGION_INFO_FLAG_READ)
597 && (vma->vm_flags & VM_READ))
600 if (!(vdev->regions[index].flags & VFIO_REGION_INFO_FLAG_WRITE)
601 && (vma->vm_flags & VM_WRITE))
604 vma->vm_private_data = vdev;
606 if (vdev->regions[index].type & VFIO_PLATFORM_REGION_TYPE_MMIO)
607 return vfio_platform_mmap_mmio(vdev->regions[index], vma);
609 else if (vdev->regions[index].type & VFIO_PLATFORM_REGION_TYPE_PIO)
610 return -EINVAL; /* not implemented */
615 static const struct vfio_device_ops vfio_platform_ops = {
616 .name = "vfio-platform",
617 .open = vfio_platform_open,
618 .release = vfio_platform_release,
619 .ioctl = vfio_platform_ioctl,
620 .read = vfio_platform_read,
621 .write = vfio_platform_write,
622 .mmap = vfio_platform_mmap,
625 static int vfio_platform_of_probe(struct vfio_platform_device *vdev,
630 ret = device_property_read_string(dev, "compatible",
633 dev_err(dev, "Cannot retrieve compat for %s\n", vdev->name);
639 * There can be two kernel build combinations. One build where
640 * ACPI is not selected in Kconfig and another one with the ACPI Kconfig.
642 * In the first case, vfio_platform_acpi_probe will return since
643 * acpi_disabled is 1. DT user will not see any kind of messages from
646 * In the second case, both DT and ACPI is compiled in but the system is
647 * booting with any of these combinations.
649 * If the firmware is DT type, then acpi_disabled is 1. The ACPI probe routine
650 * terminates immediately without any messages.
652 * If the firmware is ACPI type, then acpi_disabled is 0. All other checks are
653 * valid checks. We cannot claim that this system is DT.
655 int vfio_platform_probe_common(struct vfio_platform_device *vdev,
658 struct iommu_group *group;
664 ret = vfio_platform_acpi_probe(vdev, dev);
666 ret = vfio_platform_of_probe(vdev, dev);
673 ret = vfio_platform_get_reset(vdev);
674 if (ret && vdev->reset_required) {
675 dev_err(dev, "No reset function found for device %s\n",
680 group = vfio_iommu_group_get(dev);
682 dev_err(dev, "No IOMMU group for device %s\n", vdev->name);
687 ret = vfio_add_group_dev(dev, &vfio_platform_ops, vdev);
691 mutex_init(&vdev->igate);
693 pm_runtime_enable(vdev->device);
697 vfio_iommu_group_put(group, dev);
699 vfio_platform_put_reset(vdev);
702 EXPORT_SYMBOL_GPL(vfio_platform_probe_common);
704 struct vfio_platform_device *vfio_platform_remove_common(struct device *dev)
706 struct vfio_platform_device *vdev;
708 vdev = vfio_del_group_dev(dev);
711 pm_runtime_disable(vdev->device);
712 vfio_platform_put_reset(vdev);
713 vfio_iommu_group_put(dev->iommu_group, dev);
718 EXPORT_SYMBOL_GPL(vfio_platform_remove_common);
720 void __vfio_platform_register_reset(struct vfio_platform_reset_node *node)
722 mutex_lock(&driver_lock);
723 list_add(&node->link, &reset_list);
724 mutex_unlock(&driver_lock);
726 EXPORT_SYMBOL_GPL(__vfio_platform_register_reset);
728 void vfio_platform_unregister_reset(const char *compat,
729 vfio_platform_reset_fn_t fn)
731 struct vfio_platform_reset_node *iter, *temp;
733 mutex_lock(&driver_lock);
734 list_for_each_entry_safe(iter, temp, &reset_list, link) {
735 if (!strcmp(iter->compat, compat) && (iter->of_reset == fn)) {
736 list_del(&iter->link);
741 mutex_unlock(&driver_lock);
744 EXPORT_SYMBOL_GPL(vfio_platform_unregister_reset);
746 MODULE_VERSION(DRIVER_VERSION);
747 MODULE_LICENSE("GPL v2");
748 MODULE_AUTHOR(DRIVER_AUTHOR);
749 MODULE_DESCRIPTION(DRIVER_DESC);