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 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 void vfio_platform_close_device(struct vfio_device *core_vdev)
222 struct vfio_platform_device *vdev =
223 container_of(core_vdev, struct vfio_platform_device, vdev);
224 const char *extra_dbg = NULL;
227 ret = vfio_platform_call_reset(vdev, &extra_dbg);
228 if (WARN_ON(ret && vdev->reset_required)) {
231 "reset driver is required and reset call failed in release (%d) %s\n",
232 ret, extra_dbg ? extra_dbg : "");
234 pm_runtime_put(vdev->device);
235 vfio_platform_regions_cleanup(vdev);
236 vfio_platform_irq_cleanup(vdev);
238 EXPORT_SYMBOL_GPL(vfio_platform_close_device);
240 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);
276 EXPORT_SYMBOL_GPL(vfio_platform_open_device);
278 long vfio_platform_ioctl(struct vfio_device *core_vdev,
279 unsigned int cmd, unsigned long arg)
281 struct vfio_platform_device *vdev =
282 container_of(core_vdev, struct vfio_platform_device, vdev);
286 if (cmd == VFIO_DEVICE_GET_INFO) {
287 struct vfio_device_info info;
289 minsz = offsetofend(struct vfio_device_info, num_irqs);
291 if (copy_from_user(&info, (void __user *)arg, minsz))
294 if (info.argsz < minsz)
297 if (vfio_platform_has_reset(vdev))
298 vdev->flags |= VFIO_DEVICE_FLAGS_RESET;
299 info.flags = vdev->flags;
300 info.num_regions = vdev->num_regions;
301 info.num_irqs = vdev->num_irqs;
303 return copy_to_user((void __user *)arg, &info, minsz) ?
306 } else if (cmd == VFIO_DEVICE_GET_REGION_INFO) {
307 struct vfio_region_info info;
309 minsz = offsetofend(struct vfio_region_info, offset);
311 if (copy_from_user(&info, (void __user *)arg, minsz))
314 if (info.argsz < minsz)
317 if (info.index >= vdev->num_regions)
320 /* map offset to the physical address */
321 info.offset = VFIO_PLATFORM_INDEX_TO_OFFSET(info.index);
322 info.size = vdev->regions[info.index].size;
323 info.flags = vdev->regions[info.index].flags;
325 return copy_to_user((void __user *)arg, &info, minsz) ?
328 } else if (cmd == VFIO_DEVICE_GET_IRQ_INFO) {
329 struct vfio_irq_info info;
331 minsz = offsetofend(struct vfio_irq_info, count);
333 if (copy_from_user(&info, (void __user *)arg, minsz))
336 if (info.argsz < minsz)
339 if (info.index >= vdev->num_irqs)
342 info.flags = vdev->irqs[info.index].flags;
343 info.count = vdev->irqs[info.index].count;
345 return copy_to_user((void __user *)arg, &info, minsz) ?
348 } else if (cmd == VFIO_DEVICE_SET_IRQS) {
349 struct vfio_irq_set hdr;
352 size_t data_size = 0;
354 minsz = offsetofend(struct vfio_irq_set, count);
356 if (copy_from_user(&hdr, (void __user *)arg, minsz))
359 ret = vfio_set_irqs_validate_and_prepare(&hdr, vdev->num_irqs,
360 vdev->num_irqs, &data_size);
365 data = memdup_user((void __user *)(arg + minsz),
368 return PTR_ERR(data);
371 mutex_lock(&vdev->igate);
373 ret = vfio_platform_set_irqs_ioctl(vdev, hdr.flags, hdr.index,
374 hdr.start, hdr.count, data);
375 mutex_unlock(&vdev->igate);
380 } else if (cmd == VFIO_DEVICE_RESET) {
381 return vfio_platform_call_reset(vdev, NULL);
386 EXPORT_SYMBOL_GPL(vfio_platform_ioctl);
388 static ssize_t vfio_platform_read_mmio(struct vfio_platform_region *reg,
389 char __user *buf, size_t count,
392 unsigned int done = 0;
396 ioremap(reg->addr, reg->size);
405 if (count >= 4 && !(off % 4)) {
408 val = ioread32(reg->ioaddr + off);
409 if (copy_to_user(buf, &val, 4))
413 } else if (count >= 2 && !(off % 2)) {
416 val = ioread16(reg->ioaddr + off);
417 if (copy_to_user(buf, &val, 2))
424 val = ioread8(reg->ioaddr + off);
425 if (copy_to_user(buf, &val, 1))
443 ssize_t vfio_platform_read(struct vfio_device *core_vdev,
444 char __user *buf, size_t count, loff_t *ppos)
446 struct vfio_platform_device *vdev =
447 container_of(core_vdev, struct vfio_platform_device, vdev);
448 unsigned int index = VFIO_PLATFORM_OFFSET_TO_INDEX(*ppos);
449 loff_t off = *ppos & VFIO_PLATFORM_OFFSET_MASK;
451 if (index >= vdev->num_regions)
454 if (!(vdev->regions[index].flags & VFIO_REGION_INFO_FLAG_READ))
457 if (vdev->regions[index].type & VFIO_PLATFORM_REGION_TYPE_MMIO)
458 return vfio_platform_read_mmio(&vdev->regions[index],
460 else if (vdev->regions[index].type & VFIO_PLATFORM_REGION_TYPE_PIO)
461 return -EINVAL; /* not implemented */
465 EXPORT_SYMBOL_GPL(vfio_platform_read);
467 static ssize_t vfio_platform_write_mmio(struct vfio_platform_region *reg,
468 const char __user *buf, size_t count,
471 unsigned int done = 0;
475 ioremap(reg->addr, reg->size);
484 if (count >= 4 && !(off % 4)) {
487 if (copy_from_user(&val, buf, 4))
489 iowrite32(val, reg->ioaddr + off);
492 } else if (count >= 2 && !(off % 2)) {
495 if (copy_from_user(&val, buf, 2))
497 iowrite16(val, reg->ioaddr + off);
503 if (copy_from_user(&val, buf, 1))
505 iowrite8(val, reg->ioaddr + off);
521 ssize_t vfio_platform_write(struct vfio_device *core_vdev, const char __user *buf,
522 size_t count, loff_t *ppos)
524 struct vfio_platform_device *vdev =
525 container_of(core_vdev, struct vfio_platform_device, vdev);
526 unsigned int index = VFIO_PLATFORM_OFFSET_TO_INDEX(*ppos);
527 loff_t off = *ppos & VFIO_PLATFORM_OFFSET_MASK;
529 if (index >= vdev->num_regions)
532 if (!(vdev->regions[index].flags & VFIO_REGION_INFO_FLAG_WRITE))
535 if (vdev->regions[index].type & VFIO_PLATFORM_REGION_TYPE_MMIO)
536 return vfio_platform_write_mmio(&vdev->regions[index],
538 else if (vdev->regions[index].type & VFIO_PLATFORM_REGION_TYPE_PIO)
539 return -EINVAL; /* not implemented */
543 EXPORT_SYMBOL_GPL(vfio_platform_write);
545 static int vfio_platform_mmap_mmio(struct vfio_platform_region region,
546 struct vm_area_struct *vma)
548 u64 req_len, pgoff, req_start;
550 req_len = vma->vm_end - vma->vm_start;
551 pgoff = vma->vm_pgoff &
552 ((1U << (VFIO_PLATFORM_OFFSET_SHIFT - PAGE_SHIFT)) - 1);
553 req_start = pgoff << PAGE_SHIFT;
555 if (region.size < PAGE_SIZE || req_start + req_len > region.size)
558 vma->vm_page_prot = pgprot_noncached(vma->vm_page_prot);
559 vma->vm_pgoff = (region.addr >> PAGE_SHIFT) + pgoff;
561 return remap_pfn_range(vma, vma->vm_start, vma->vm_pgoff,
562 req_len, vma->vm_page_prot);
565 int vfio_platform_mmap(struct vfio_device *core_vdev, struct vm_area_struct *vma)
567 struct vfio_platform_device *vdev =
568 container_of(core_vdev, struct vfio_platform_device, vdev);
571 index = vma->vm_pgoff >> (VFIO_PLATFORM_OFFSET_SHIFT - PAGE_SHIFT);
573 if (vma->vm_end < vma->vm_start)
575 if (!(vma->vm_flags & VM_SHARED))
577 if (index >= vdev->num_regions)
579 if (vma->vm_start & ~PAGE_MASK)
581 if (vma->vm_end & ~PAGE_MASK)
584 if (!(vdev->regions[index].flags & VFIO_REGION_INFO_FLAG_MMAP))
587 if (!(vdev->regions[index].flags & VFIO_REGION_INFO_FLAG_READ)
588 && (vma->vm_flags & VM_READ))
591 if (!(vdev->regions[index].flags & VFIO_REGION_INFO_FLAG_WRITE)
592 && (vma->vm_flags & VM_WRITE))
595 vma->vm_private_data = vdev;
597 if (vdev->regions[index].type & VFIO_PLATFORM_REGION_TYPE_MMIO)
598 return vfio_platform_mmap_mmio(vdev->regions[index], vma);
600 else if (vdev->regions[index].type & VFIO_PLATFORM_REGION_TYPE_PIO)
601 return -EINVAL; /* not implemented */
605 EXPORT_SYMBOL_GPL(vfio_platform_mmap);
607 static int vfio_platform_of_probe(struct vfio_platform_device *vdev,
612 ret = device_property_read_string(dev, "compatible",
615 dev_err(dev, "Cannot retrieve compat for %s\n", vdev->name);
621 * There can be two kernel build combinations. One build where
622 * ACPI is not selected in Kconfig and another one with the ACPI Kconfig.
624 * In the first case, vfio_platform_acpi_probe will return since
625 * acpi_disabled is 1. DT user will not see any kind of messages from
628 * In the second case, both DT and ACPI is compiled in but the system is
629 * booting with any of these combinations.
631 * If the firmware is DT type, then acpi_disabled is 1. The ACPI probe routine
632 * terminates immediately without any messages.
634 * If the firmware is ACPI type, then acpi_disabled is 0. All other checks are
635 * valid checks. We cannot claim that this system is DT.
637 int vfio_platform_init_common(struct vfio_platform_device *vdev)
640 struct device *dev = vdev->vdev.dev;
642 ret = vfio_platform_acpi_probe(vdev, dev);
644 ret = vfio_platform_of_probe(vdev, dev);
650 mutex_init(&vdev->igate);
652 ret = vfio_platform_get_reset(vdev);
653 if (ret && vdev->reset_required)
654 dev_err(dev, "No reset function found for device %s\n",
658 EXPORT_SYMBOL_GPL(vfio_platform_init_common);
660 void vfio_platform_release_common(struct vfio_platform_device *vdev)
662 vfio_platform_put_reset(vdev);
664 EXPORT_SYMBOL_GPL(vfio_platform_release_common);
666 void __vfio_platform_register_reset(struct vfio_platform_reset_node *node)
668 mutex_lock(&driver_lock);
669 list_add(&node->link, &reset_list);
670 mutex_unlock(&driver_lock);
672 EXPORT_SYMBOL_GPL(__vfio_platform_register_reset);
674 void vfio_platform_unregister_reset(const char *compat,
675 vfio_platform_reset_fn_t fn)
677 struct vfio_platform_reset_node *iter, *temp;
679 mutex_lock(&driver_lock);
680 list_for_each_entry_safe(iter, temp, &reset_list, link) {
681 if (!strcmp(iter->compat, compat) && (iter->of_reset == fn)) {
682 list_del(&iter->link);
687 mutex_unlock(&driver_lock);
690 EXPORT_SYMBOL_GPL(vfio_platform_unregister_reset);
692 MODULE_VERSION(DRIVER_VERSION);
693 MODULE_LICENSE("GPL v2");
694 MODULE_AUTHOR(DRIVER_AUTHOR);
695 MODULE_DESCRIPTION(DRIVER_DESC);