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 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 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);
239 EXPORT_SYMBOL_GPL(vfio_platform_close_device);
241 int vfio_platform_open_device(struct vfio_device *core_vdev)
243 struct vfio_platform_device *vdev =
244 container_of(core_vdev, struct vfio_platform_device, vdev);
245 const char *extra_dbg = NULL;
248 ret = vfio_platform_regions_init(vdev);
252 ret = vfio_platform_irq_init(vdev);
256 ret = pm_runtime_get_sync(vdev->device);
260 ret = vfio_platform_call_reset(vdev, &extra_dbg);
261 if (ret && vdev->reset_required) {
264 "reset driver is required and reset call failed in open (%d) %s\n",
265 ret, extra_dbg ? extra_dbg : "");
271 pm_runtime_put(vdev->device);
272 vfio_platform_irq_cleanup(vdev);
274 vfio_platform_regions_cleanup(vdev);
277 EXPORT_SYMBOL_GPL(vfio_platform_open_device);
279 long vfio_platform_ioctl(struct vfio_device *core_vdev,
280 unsigned int cmd, unsigned long arg)
282 struct vfio_platform_device *vdev =
283 container_of(core_vdev, struct vfio_platform_device, vdev);
287 if (cmd == VFIO_DEVICE_GET_INFO) {
288 struct vfio_device_info info;
290 minsz = offsetofend(struct vfio_device_info, num_irqs);
292 if (copy_from_user(&info, (void __user *)arg, minsz))
295 if (info.argsz < minsz)
298 if (vfio_platform_has_reset(vdev))
299 vdev->flags |= VFIO_DEVICE_FLAGS_RESET;
300 info.flags = vdev->flags;
301 info.num_regions = vdev->num_regions;
302 info.num_irqs = vdev->num_irqs;
304 return copy_to_user((void __user *)arg, &info, minsz) ?
307 } else if (cmd == VFIO_DEVICE_GET_REGION_INFO) {
308 struct vfio_region_info info;
310 minsz = offsetofend(struct vfio_region_info, offset);
312 if (copy_from_user(&info, (void __user *)arg, minsz))
315 if (info.argsz < minsz)
318 if (info.index >= vdev->num_regions)
321 /* map offset to the physical address */
322 info.offset = VFIO_PLATFORM_INDEX_TO_OFFSET(info.index);
323 info.size = vdev->regions[info.index].size;
324 info.flags = vdev->regions[info.index].flags;
326 return copy_to_user((void __user *)arg, &info, minsz) ?
329 } else if (cmd == VFIO_DEVICE_GET_IRQ_INFO) {
330 struct vfio_irq_info info;
332 minsz = offsetofend(struct vfio_irq_info, count);
334 if (copy_from_user(&info, (void __user *)arg, minsz))
337 if (info.argsz < minsz)
340 if (info.index >= vdev->num_irqs)
343 info.flags = vdev->irqs[info.index].flags;
344 info.count = vdev->irqs[info.index].count;
346 return copy_to_user((void __user *)arg, &info, minsz) ?
349 } else if (cmd == VFIO_DEVICE_SET_IRQS) {
350 struct vfio_irq_set hdr;
353 size_t data_size = 0;
355 minsz = offsetofend(struct vfio_irq_set, count);
357 if (copy_from_user(&hdr, (void __user *)arg, minsz))
360 ret = vfio_set_irqs_validate_and_prepare(&hdr, vdev->num_irqs,
361 vdev->num_irqs, &data_size);
366 data = memdup_user((void __user *)(arg + minsz),
369 return PTR_ERR(data);
372 mutex_lock(&vdev->igate);
374 ret = vfio_platform_set_irqs_ioctl(vdev, hdr.flags, hdr.index,
375 hdr.start, hdr.count, data);
376 mutex_unlock(&vdev->igate);
381 } else if (cmd == VFIO_DEVICE_RESET) {
382 return vfio_platform_call_reset(vdev, NULL);
387 EXPORT_SYMBOL_GPL(vfio_platform_ioctl);
389 static ssize_t vfio_platform_read_mmio(struct vfio_platform_region *reg,
390 char __user *buf, size_t count,
393 unsigned int done = 0;
397 ioremap(reg->addr, reg->size);
406 if (count >= 4 && !(off % 4)) {
409 val = ioread32(reg->ioaddr + off);
410 if (copy_to_user(buf, &val, 4))
414 } else if (count >= 2 && !(off % 2)) {
417 val = ioread16(reg->ioaddr + off);
418 if (copy_to_user(buf, &val, 2))
425 val = ioread8(reg->ioaddr + off);
426 if (copy_to_user(buf, &val, 1))
444 ssize_t vfio_platform_read(struct vfio_device *core_vdev,
445 char __user *buf, size_t count, loff_t *ppos)
447 struct vfio_platform_device *vdev =
448 container_of(core_vdev, struct vfio_platform_device, vdev);
449 unsigned int index = VFIO_PLATFORM_OFFSET_TO_INDEX(*ppos);
450 loff_t off = *ppos & VFIO_PLATFORM_OFFSET_MASK;
452 if (index >= vdev->num_regions)
455 if (!(vdev->regions[index].flags & VFIO_REGION_INFO_FLAG_READ))
458 if (vdev->regions[index].type & VFIO_PLATFORM_REGION_TYPE_MMIO)
459 return vfio_platform_read_mmio(&vdev->regions[index],
461 else if (vdev->regions[index].type & VFIO_PLATFORM_REGION_TYPE_PIO)
462 return -EINVAL; /* not implemented */
466 EXPORT_SYMBOL_GPL(vfio_platform_read);
468 static ssize_t vfio_platform_write_mmio(struct vfio_platform_region *reg,
469 const char __user *buf, size_t count,
472 unsigned int done = 0;
476 ioremap(reg->addr, reg->size);
485 if (count >= 4 && !(off % 4)) {
488 if (copy_from_user(&val, buf, 4))
490 iowrite32(val, reg->ioaddr + off);
493 } else if (count >= 2 && !(off % 2)) {
496 if (copy_from_user(&val, buf, 2))
498 iowrite16(val, reg->ioaddr + off);
504 if (copy_from_user(&val, buf, 1))
506 iowrite8(val, reg->ioaddr + off);
522 ssize_t vfio_platform_write(struct vfio_device *core_vdev, const char __user *buf,
523 size_t count, loff_t *ppos)
525 struct vfio_platform_device *vdev =
526 container_of(core_vdev, struct vfio_platform_device, vdev);
527 unsigned int index = VFIO_PLATFORM_OFFSET_TO_INDEX(*ppos);
528 loff_t off = *ppos & VFIO_PLATFORM_OFFSET_MASK;
530 if (index >= vdev->num_regions)
533 if (!(vdev->regions[index].flags & VFIO_REGION_INFO_FLAG_WRITE))
536 if (vdev->regions[index].type & VFIO_PLATFORM_REGION_TYPE_MMIO)
537 return vfio_platform_write_mmio(&vdev->regions[index],
539 else if (vdev->regions[index].type & VFIO_PLATFORM_REGION_TYPE_PIO)
540 return -EINVAL; /* not implemented */
544 EXPORT_SYMBOL_GPL(vfio_platform_write);
546 static int vfio_platform_mmap_mmio(struct vfio_platform_region region,
547 struct vm_area_struct *vma)
549 u64 req_len, pgoff, req_start;
551 req_len = vma->vm_end - vma->vm_start;
552 pgoff = vma->vm_pgoff &
553 ((1U << (VFIO_PLATFORM_OFFSET_SHIFT - PAGE_SHIFT)) - 1);
554 req_start = pgoff << PAGE_SHIFT;
556 if (region.size < PAGE_SIZE || req_start + req_len > region.size)
559 vma->vm_page_prot = pgprot_noncached(vma->vm_page_prot);
560 vma->vm_pgoff = (region.addr >> PAGE_SHIFT) + pgoff;
562 return remap_pfn_range(vma, vma->vm_start, vma->vm_pgoff,
563 req_len, vma->vm_page_prot);
566 int vfio_platform_mmap(struct vfio_device *core_vdev, struct vm_area_struct *vma)
568 struct vfio_platform_device *vdev =
569 container_of(core_vdev, struct vfio_platform_device, vdev);
572 index = vma->vm_pgoff >> (VFIO_PLATFORM_OFFSET_SHIFT - PAGE_SHIFT);
574 if (vma->vm_end < vma->vm_start)
576 if (!(vma->vm_flags & VM_SHARED))
578 if (index >= vdev->num_regions)
580 if (vma->vm_start & ~PAGE_MASK)
582 if (vma->vm_end & ~PAGE_MASK)
585 if (!(vdev->regions[index].flags & VFIO_REGION_INFO_FLAG_MMAP))
588 if (!(vdev->regions[index].flags & VFIO_REGION_INFO_FLAG_READ)
589 && (vma->vm_flags & VM_READ))
592 if (!(vdev->regions[index].flags & VFIO_REGION_INFO_FLAG_WRITE)
593 && (vma->vm_flags & VM_WRITE))
596 vma->vm_private_data = vdev;
598 if (vdev->regions[index].type & VFIO_PLATFORM_REGION_TYPE_MMIO)
599 return vfio_platform_mmap_mmio(vdev->regions[index], vma);
601 else if (vdev->regions[index].type & VFIO_PLATFORM_REGION_TYPE_PIO)
602 return -EINVAL; /* not implemented */
606 EXPORT_SYMBOL_GPL(vfio_platform_mmap);
608 static int vfio_platform_of_probe(struct vfio_platform_device *vdev,
613 ret = device_property_read_string(dev, "compatible",
616 dev_err(dev, "Cannot retrieve compat for %s\n", vdev->name);
622 * There can be two kernel build combinations. One build where
623 * ACPI is not selected in Kconfig and another one with the ACPI Kconfig.
625 * In the first case, vfio_platform_acpi_probe will return since
626 * acpi_disabled is 1. DT user will not see any kind of messages from
629 * In the second case, both DT and ACPI is compiled in but the system is
630 * booting with any of these combinations.
632 * If the firmware is DT type, then acpi_disabled is 1. The ACPI probe routine
633 * terminates immediately without any messages.
635 * If the firmware is ACPI type, then acpi_disabled is 0. All other checks are
636 * valid checks. We cannot claim that this system is DT.
638 int vfio_platform_init_common(struct vfio_platform_device *vdev)
641 struct device *dev = vdev->vdev.dev;
643 ret = vfio_platform_acpi_probe(vdev, dev);
645 ret = vfio_platform_of_probe(vdev, dev);
651 mutex_init(&vdev->igate);
653 ret = vfio_platform_get_reset(vdev);
654 if (ret && vdev->reset_required)
655 dev_err(dev, "No reset function found for device %s\n",
659 EXPORT_SYMBOL_GPL(vfio_platform_init_common);
661 void vfio_platform_release_common(struct vfio_platform_device *vdev)
663 vfio_platform_put_reset(vdev);
665 EXPORT_SYMBOL_GPL(vfio_platform_release_common);
667 void __vfio_platform_register_reset(struct vfio_platform_reset_node *node)
669 mutex_lock(&driver_lock);
670 list_add(&node->link, &reset_list);
671 mutex_unlock(&driver_lock);
673 EXPORT_SYMBOL_GPL(__vfio_platform_register_reset);
675 void vfio_platform_unregister_reset(const char *compat,
676 vfio_platform_reset_fn_t fn)
678 struct vfio_platform_reset_node *iter, *temp;
680 mutex_lock(&driver_lock);
681 list_for_each_entry_safe(iter, temp, &reset_list, link) {
682 if (!strcmp(iter->compat, compat) && (iter->of_reset == fn)) {
683 list_del(&iter->link);
688 mutex_unlock(&driver_lock);
691 EXPORT_SYMBOL_GPL(vfio_platform_unregister_reset);
693 MODULE_VERSION(DRIVER_VERSION);
694 MODULE_LICENSE("GPL v2");
695 MODULE_AUTHOR(DRIVER_AUTHOR);
696 MODULE_DESCRIPTION(DRIVER_DESC);