1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * Copyright (C) 2013 - Virtual Open Systems
4  * Author: Antonios Motakis <a.motakis@virtualopensystems.com>
5  */
6 
7 #include <linux/module.h>
8 #include <linux/slab.h>
9 #include <linux/vfio.h>
10 #include <linux/pm_runtime.h>
11 #include <linux/platform_device.h>
12 
13 #include "vfio_platform_private.h"
14 
15 #define DRIVER_VERSION  "0.10"
16 #define DRIVER_AUTHOR   "Antonios Motakis <a.motakis@virtualopensystems.com>"
17 #define DRIVER_DESC     "VFIO for platform devices - User Level meta-driver"
18 
19 static bool reset_required = true;
20 module_param(reset_required, bool, 0444);
21 MODULE_PARM_DESC(reset_required, "override reset requirement (default: 1)");
22 
23 /* probing devices from the linux platform bus */
24 
25 static struct resource *get_platform_resource(struct vfio_platform_device *vdev,
26 					      int num)
27 {
28 	struct platform_device *dev = (struct platform_device *) vdev->opaque;
29 
30 	return platform_get_mem_or_io(dev, num);
31 }
32 
33 static int get_platform_irq(struct vfio_platform_device *vdev, int i)
34 {
35 	struct platform_device *pdev = (struct platform_device *) vdev->opaque;
36 
37 	return platform_get_irq_optional(pdev, i);
38 }
39 
40 static int vfio_platform_init_dev(struct vfio_device *core_vdev)
41 {
42 	struct vfio_platform_device *vdev =
43 		container_of(core_vdev, struct vfio_platform_device, vdev);
44 	struct platform_device *pdev = to_platform_device(core_vdev->dev);
45 
46 	vdev->opaque = (void *) pdev;
47 	vdev->name = pdev->name;
48 	vdev->flags = VFIO_DEVICE_FLAGS_PLATFORM;
49 	vdev->get_resource = get_platform_resource;
50 	vdev->get_irq = get_platform_irq;
51 	vdev->reset_required = reset_required;
52 
53 	return vfio_platform_init_common(vdev);
54 }
55 
56 static const struct vfio_device_ops vfio_platform_ops;
57 static int vfio_platform_probe(struct platform_device *pdev)
58 {
59 	struct vfio_platform_device *vdev;
60 	int ret;
61 
62 	vdev = vfio_alloc_device(vfio_platform_device, vdev, &pdev->dev,
63 				 &vfio_platform_ops);
64 	if (IS_ERR(vdev))
65 		return PTR_ERR(vdev);
66 
67 	ret = vfio_register_group_dev(&vdev->vdev);
68 	if (ret)
69 		goto out_put_vdev;
70 
71 	pm_runtime_enable(&pdev->dev);
72 	dev_set_drvdata(&pdev->dev, vdev);
73 	return 0;
74 
75 out_put_vdev:
76 	vfio_put_device(&vdev->vdev);
77 	return ret;
78 }
79 
80 static void vfio_platform_release_dev(struct vfio_device *core_vdev)
81 {
82 	struct vfio_platform_device *vdev =
83 		container_of(core_vdev, struct vfio_platform_device, vdev);
84 
85 	vfio_platform_release_common(vdev);
86 	vfio_free_device(core_vdev);
87 }
88 
89 static int vfio_platform_remove(struct platform_device *pdev)
90 {
91 	struct vfio_platform_device *vdev = dev_get_drvdata(&pdev->dev);
92 
93 	vfio_unregister_group_dev(&vdev->vdev);
94 	pm_runtime_disable(vdev->device);
95 	vfio_put_device(&vdev->vdev);
96 	return 0;
97 }
98 
99 static const struct vfio_device_ops vfio_platform_ops = {
100 	.name		= "vfio-platform",
101 	.init		= vfio_platform_init_dev,
102 	.release	= vfio_platform_release_dev,
103 	.open_device	= vfio_platform_open_device,
104 	.close_device	= vfio_platform_close_device,
105 	.ioctl		= vfio_platform_ioctl,
106 	.read		= vfio_platform_read,
107 	.write		= vfio_platform_write,
108 	.mmap		= vfio_platform_mmap,
109 };
110 
111 static struct platform_driver vfio_platform_driver = {
112 	.probe		= vfio_platform_probe,
113 	.remove		= vfio_platform_remove,
114 	.driver	= {
115 		.name	= "vfio-platform",
116 	},
117 	.driver_managed_dma = true,
118 };
119 
120 module_platform_driver(vfio_platform_driver);
121 
122 MODULE_VERSION(DRIVER_VERSION);
123 MODULE_LICENSE("GPL v2");
124 MODULE_AUTHOR(DRIVER_AUTHOR);
125 MODULE_DESCRIPTION(DRIVER_DESC);
126