1 // SPDX-License-Identifier: GPL-2.0
3 * Mediated virtual PCI display host device driver
5 * See mdpy-defs.h for device specs
7 * (c) Gerd Hoffmann <kraxel@redhat.com>
9 * based on mtty driver which is:
10 * Copyright (c) 2016, NVIDIA CORPORATION. All rights reserved.
11 * Author: Neo Jia <cjia@nvidia.com>
12 * Kirti Wankhede <kwankhede@nvidia.com>
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License version 2 as
16 * published by the Free Software Foundation.
18 #include <linux/init.h>
19 #include <linux/module.h>
20 #include <linux/kernel.h>
21 #include <linux/slab.h>
22 #include <linux/vmalloc.h>
23 #include <linux/cdev.h>
24 #include <linux/vfio.h>
25 #include <linux/iommu.h>
26 #include <linux/sysfs.h>
27 #include <linux/mdev.h>
28 #include <linux/pci.h>
29 #include <drm/drm_fourcc.h>
30 #include "mdpy-defs.h"
32 #define MDPY_NAME "mdpy"
33 #define MDPY_CLASS_NAME "mdpy"
35 #define MDPY_CONFIG_SPACE_SIZE 0xff
36 #define MDPY_MEMORY_BAR_OFFSET PAGE_SIZE
37 #define MDPY_DISPLAY_REGION 16
39 #define STORE_LE16(addr, val) (*(u16 *)addr = val)
40 #define STORE_LE32(addr, val) (*(u32 *)addr = val)
43 MODULE_LICENSE("GPL v2");
45 #define MDPY_TYPE_1 "vga"
46 #define MDPY_TYPE_2 "xga"
47 #define MDPY_TYPE_3 "hd"
49 static struct mdpy_type {
50 struct mdev_type type;
57 .type.sysfs_name = MDPY_TYPE_1,
58 .type.pretty_name = MDPY_CLASS_NAME "-" MDPY_TYPE_1,
59 .format = DRM_FORMAT_XRGB8888,
64 .type.sysfs_name = MDPY_TYPE_2,
65 .type.pretty_name = MDPY_CLASS_NAME "-" MDPY_TYPE_2,
66 .format = DRM_FORMAT_XRGB8888,
71 .type.sysfs_name = MDPY_TYPE_3,
72 .type.pretty_name = MDPY_CLASS_NAME "-" MDPY_TYPE_3,
73 .format = DRM_FORMAT_XRGB8888,
80 static struct mdev_type *mdpy_mdev_types[] = {
86 static dev_t mdpy_devt;
87 static const struct class mdpy_class = {
88 .name = MDPY_CLASS_NAME,
90 static struct cdev mdpy_cdev;
91 static struct device mdpy_dev;
92 static struct mdev_parent mdpy_parent;
93 static const struct vfio_device_ops mdpy_dev_ops;
95 /* State of each mdev device */
97 struct vfio_device vdev;
100 struct mutex ops_lock;
101 struct mdev_device *mdev;
102 struct vfio_device_info dev_info;
104 const struct mdpy_type *type;
109 static void mdpy_create_config_space(struct mdev_state *mdev_state)
111 STORE_LE16((u16 *) &mdev_state->vconfig[PCI_VENDOR_ID],
113 STORE_LE16((u16 *) &mdev_state->vconfig[PCI_DEVICE_ID],
115 STORE_LE16((u16 *) &mdev_state->vconfig[PCI_SUBSYSTEM_VENDOR_ID],
116 MDPY_PCI_SUBVENDOR_ID);
117 STORE_LE16((u16 *) &mdev_state->vconfig[PCI_SUBSYSTEM_ID],
118 MDPY_PCI_SUBDEVICE_ID);
120 STORE_LE16((u16 *) &mdev_state->vconfig[PCI_COMMAND],
121 PCI_COMMAND_IO | PCI_COMMAND_MEMORY);
122 STORE_LE16((u16 *) &mdev_state->vconfig[PCI_STATUS],
123 PCI_STATUS_CAP_LIST);
124 STORE_LE16((u16 *) &mdev_state->vconfig[PCI_CLASS_DEVICE],
125 PCI_CLASS_DISPLAY_OTHER);
126 mdev_state->vconfig[PCI_CLASS_REVISION] = 0x01;
128 STORE_LE32((u32 *) &mdev_state->vconfig[PCI_BASE_ADDRESS_0],
129 PCI_BASE_ADDRESS_SPACE_MEMORY |
130 PCI_BASE_ADDRESS_MEM_TYPE_32 |
131 PCI_BASE_ADDRESS_MEM_PREFETCH);
132 mdev_state->bar_mask = ~(mdev_state->memsize) + 1;
134 /* vendor specific capability for the config registers */
135 mdev_state->vconfig[PCI_CAPABILITY_LIST] = MDPY_VENDORCAP_OFFSET;
136 mdev_state->vconfig[MDPY_VENDORCAP_OFFSET + 0] = 0x09; /* vendor cap */
137 mdev_state->vconfig[MDPY_VENDORCAP_OFFSET + 1] = 0x00; /* next ptr */
138 mdev_state->vconfig[MDPY_VENDORCAP_OFFSET + 2] = MDPY_VENDORCAP_SIZE;
139 STORE_LE32((u32 *) &mdev_state->vconfig[MDPY_FORMAT_OFFSET],
140 mdev_state->type->format);
141 STORE_LE32((u32 *) &mdev_state->vconfig[MDPY_WIDTH_OFFSET],
142 mdev_state->type->width);
143 STORE_LE32((u32 *) &mdev_state->vconfig[MDPY_HEIGHT_OFFSET],
144 mdev_state->type->height);
147 static void handle_pci_cfg_write(struct mdev_state *mdev_state, u16 offset,
148 char *buf, u32 count)
150 struct device *dev = mdev_dev(mdev_state->mdev);
154 case PCI_BASE_ADDRESS_0:
155 cfg_addr = *(u32 *)buf;
157 if (cfg_addr == 0xffffffff) {
158 cfg_addr = (cfg_addr & mdev_state->bar_mask);
160 cfg_addr &= PCI_BASE_ADDRESS_MEM_MASK;
162 dev_info(dev, "BAR0 @ 0x%x\n", cfg_addr);
165 cfg_addr |= (mdev_state->vconfig[offset] &
166 ~PCI_BASE_ADDRESS_MEM_MASK);
167 STORE_LE32(&mdev_state->vconfig[offset], cfg_addr);
172 static ssize_t mdev_access(struct mdev_state *mdev_state, char *buf,
173 size_t count, loff_t pos, bool is_write)
177 mutex_lock(&mdev_state->ops_lock);
179 if (pos < MDPY_CONFIG_SPACE_SIZE) {
181 handle_pci_cfg_write(mdev_state, pos, buf, count);
183 memcpy(buf, (mdev_state->vconfig + pos), count);
185 } else if ((pos >= MDPY_MEMORY_BAR_OFFSET) &&
187 MDPY_MEMORY_BAR_OFFSET + mdev_state->memsize)) {
188 pos -= MDPY_MEMORY_BAR_OFFSET;
190 memcpy(mdev_state->memblk, buf, count);
192 memcpy(buf, mdev_state->memblk, count);
195 dev_info(mdev_state->vdev.dev,
196 "%s: %s @0x%llx (unhandled)\n", __func__,
197 is_write ? "WR" : "RD", pos);
206 mutex_unlock(&mdev_state->ops_lock);
211 static int mdpy_reset(struct mdev_state *mdev_state)
215 /* initialize with gray gradient */
216 stride = mdev_state->type->width * mdev_state->type->bytepp;
217 for (i = 0; i < mdev_state->type->height; i++)
218 memset(mdev_state->memblk + i * stride,
219 i * 255 / mdev_state->type->height,
224 static int mdpy_init_dev(struct vfio_device *vdev)
226 struct mdev_state *mdev_state =
227 container_of(vdev, struct mdev_state, vdev);
228 struct mdev_device *mdev = to_mdev_device(vdev->dev);
229 const struct mdpy_type *type =
230 container_of(mdev->type, struct mdpy_type, type);
234 mdev_state->vconfig = kzalloc(MDPY_CONFIG_SPACE_SIZE, GFP_KERNEL);
235 if (!mdev_state->vconfig)
238 fbsize = roundup_pow_of_two(type->width * type->height * type->bytepp);
240 mdev_state->memblk = vmalloc_user(fbsize);
241 if (!mdev_state->memblk)
244 mutex_init(&mdev_state->ops_lock);
245 mdev_state->mdev = mdev;
246 mdev_state->type = type;
247 mdev_state->memsize = fbsize;
248 mdpy_create_config_space(mdev_state);
249 mdpy_reset(mdev_state);
251 dev_info(vdev->dev, "%s: %s (%dx%d)\n", __func__, type->type.pretty_name,
252 type->width, type->height);
256 kfree(mdev_state->vconfig);
260 static int mdpy_probe(struct mdev_device *mdev)
262 struct mdev_state *mdev_state;
265 mdev_state = vfio_alloc_device(mdev_state, vdev, &mdev->dev,
267 if (IS_ERR(mdev_state))
268 return PTR_ERR(mdev_state);
270 ret = vfio_register_emulated_iommu_dev(&mdev_state->vdev);
273 dev_set_drvdata(&mdev->dev, mdev_state);
277 vfio_put_device(&mdev_state->vdev);
281 static void mdpy_release_dev(struct vfio_device *vdev)
283 struct mdev_state *mdev_state =
284 container_of(vdev, struct mdev_state, vdev);
286 vfree(mdev_state->memblk);
287 kfree(mdev_state->vconfig);
290 static void mdpy_remove(struct mdev_device *mdev)
292 struct mdev_state *mdev_state = dev_get_drvdata(&mdev->dev);
294 dev_info(&mdev->dev, "%s\n", __func__);
296 vfio_unregister_group_dev(&mdev_state->vdev);
297 vfio_put_device(&mdev_state->vdev);
300 static ssize_t mdpy_read(struct vfio_device *vdev, char __user *buf,
301 size_t count, loff_t *ppos)
303 struct mdev_state *mdev_state =
304 container_of(vdev, struct mdev_state, vdev);
305 unsigned int done = 0;
311 if (count >= 4 && !(*ppos % 4)) {
314 ret = mdev_access(mdev_state, (char *)&val, sizeof(val),
319 if (copy_to_user(buf, &val, sizeof(val)))
323 } else if (count >= 2 && !(*ppos % 2)) {
326 ret = mdev_access(mdev_state, (char *)&val, sizeof(val),
331 if (copy_to_user(buf, &val, sizeof(val)))
338 ret = mdev_access(mdev_state, (char *)&val, sizeof(val),
343 if (copy_to_user(buf, &val, sizeof(val)))
361 static ssize_t mdpy_write(struct vfio_device *vdev, const char __user *buf,
362 size_t count, loff_t *ppos)
364 struct mdev_state *mdev_state =
365 container_of(vdev, struct mdev_state, vdev);
366 unsigned int done = 0;
372 if (count >= 4 && !(*ppos % 4)) {
375 if (copy_from_user(&val, buf, sizeof(val)))
378 ret = mdev_access(mdev_state, (char *)&val, sizeof(val),
384 } else if (count >= 2 && !(*ppos % 2)) {
387 if (copy_from_user(&val, buf, sizeof(val)))
390 ret = mdev_access(mdev_state, (char *)&val, sizeof(val),
399 if (copy_from_user(&val, buf, sizeof(val)))
402 ret = mdev_access(mdev_state, (char *)&val, sizeof(val),
420 static int mdpy_mmap(struct vfio_device *vdev, struct vm_area_struct *vma)
422 struct mdev_state *mdev_state =
423 container_of(vdev, struct mdev_state, vdev);
425 if (vma->vm_pgoff != MDPY_MEMORY_BAR_OFFSET >> PAGE_SHIFT)
427 if (vma->vm_end < vma->vm_start)
429 if (vma->vm_end - vma->vm_start > mdev_state->memsize)
431 if ((vma->vm_flags & VM_SHARED) == 0)
434 return remap_vmalloc_range(vma, mdev_state->memblk, 0);
437 static int mdpy_get_region_info(struct mdev_state *mdev_state,
438 struct vfio_region_info *region_info,
439 u16 *cap_type_id, void **cap_type)
441 if (region_info->index >= VFIO_PCI_NUM_REGIONS &&
442 region_info->index != MDPY_DISPLAY_REGION)
445 switch (region_info->index) {
446 case VFIO_PCI_CONFIG_REGION_INDEX:
447 region_info->offset = 0;
448 region_info->size = MDPY_CONFIG_SPACE_SIZE;
449 region_info->flags = (VFIO_REGION_INFO_FLAG_READ |
450 VFIO_REGION_INFO_FLAG_WRITE);
452 case VFIO_PCI_BAR0_REGION_INDEX:
453 case MDPY_DISPLAY_REGION:
454 region_info->offset = MDPY_MEMORY_BAR_OFFSET;
455 region_info->size = mdev_state->memsize;
456 region_info->flags = (VFIO_REGION_INFO_FLAG_READ |
457 VFIO_REGION_INFO_FLAG_WRITE |
458 VFIO_REGION_INFO_FLAG_MMAP);
461 region_info->size = 0;
462 region_info->offset = 0;
463 region_info->flags = 0;
469 static int mdpy_get_irq_info(struct vfio_irq_info *irq_info)
475 static int mdpy_get_device_info(struct vfio_device_info *dev_info)
477 dev_info->flags = VFIO_DEVICE_FLAGS_PCI;
478 dev_info->num_regions = VFIO_PCI_NUM_REGIONS;
479 dev_info->num_irqs = VFIO_PCI_NUM_IRQS;
483 static int mdpy_query_gfx_plane(struct mdev_state *mdev_state,
484 struct vfio_device_gfx_plane_info *plane)
486 if (plane->flags & VFIO_GFX_PLANE_TYPE_PROBE) {
487 if (plane->flags == (VFIO_GFX_PLANE_TYPE_PROBE |
488 VFIO_GFX_PLANE_TYPE_REGION))
493 if (plane->flags != VFIO_GFX_PLANE_TYPE_REGION)
496 plane->drm_format = mdev_state->type->format;
497 plane->width = mdev_state->type->width;
498 plane->height = mdev_state->type->height;
499 plane->stride = (mdev_state->type->width *
500 mdev_state->type->bytepp);
501 plane->size = mdev_state->memsize;
502 plane->region_index = MDPY_DISPLAY_REGION;
505 plane->drm_format_mod = 0;
514 static long mdpy_ioctl(struct vfio_device *vdev, unsigned int cmd,
519 struct mdev_state *mdev_state =
520 container_of(vdev, struct mdev_state, vdev);
523 case VFIO_DEVICE_GET_INFO:
525 struct vfio_device_info info;
527 minsz = offsetofend(struct vfio_device_info, num_irqs);
529 if (copy_from_user(&info, (void __user *)arg, minsz))
532 if (info.argsz < minsz)
535 ret = mdpy_get_device_info(&info);
539 memcpy(&mdev_state->dev_info, &info, sizeof(info));
541 if (copy_to_user((void __user *)arg, &info, minsz))
546 case VFIO_DEVICE_GET_REGION_INFO:
548 struct vfio_region_info info;
550 void *cap_type = NULL;
552 minsz = offsetofend(struct vfio_region_info, offset);
554 if (copy_from_user(&info, (void __user *)arg, minsz))
557 if (info.argsz < minsz)
560 ret = mdpy_get_region_info(mdev_state, &info, &cap_type_id,
565 if (copy_to_user((void __user *)arg, &info, minsz))
571 case VFIO_DEVICE_GET_IRQ_INFO:
573 struct vfio_irq_info info;
575 minsz = offsetofend(struct vfio_irq_info, count);
577 if (copy_from_user(&info, (void __user *)arg, minsz))
580 if ((info.argsz < minsz) ||
581 (info.index >= mdev_state->dev_info.num_irqs))
584 ret = mdpy_get_irq_info(&info);
588 if (copy_to_user((void __user *)arg, &info, minsz))
594 case VFIO_DEVICE_QUERY_GFX_PLANE:
596 struct vfio_device_gfx_plane_info plane = {};
598 minsz = offsetofend(struct vfio_device_gfx_plane_info,
601 if (copy_from_user(&plane, (void __user *)arg, minsz))
604 if (plane.argsz < minsz)
607 ret = mdpy_query_gfx_plane(mdev_state, &plane);
611 if (copy_to_user((void __user *)arg, &plane, minsz))
617 case VFIO_DEVICE_SET_IRQS:
620 case VFIO_DEVICE_RESET:
621 return mdpy_reset(mdev_state);
627 resolution_show(struct device *dev, struct device_attribute *attr,
630 struct mdev_state *mdev_state = dev_get_drvdata(dev);
632 return sprintf(buf, "%dx%d\n",
633 mdev_state->type->width,
634 mdev_state->type->height);
636 static DEVICE_ATTR_RO(resolution);
638 static struct attribute *mdev_dev_attrs[] = {
639 &dev_attr_resolution.attr,
643 static const struct attribute_group mdev_dev_group = {
645 .attrs = mdev_dev_attrs,
648 static const struct attribute_group *mdev_dev_groups[] = {
653 static ssize_t mdpy_show_description(struct mdev_type *mtype, char *buf)
655 struct mdpy_type *type = container_of(mtype, struct mdpy_type, type);
657 return sprintf(buf, "virtual display, %dx%d framebuffer\n",
658 type->width, type->height);
661 static const struct vfio_device_ops mdpy_dev_ops = {
662 .init = mdpy_init_dev,
663 .release = mdpy_release_dev,
668 .bind_iommufd = vfio_iommufd_emulated_bind,
669 .unbind_iommufd = vfio_iommufd_emulated_unbind,
670 .attach_ioas = vfio_iommufd_emulated_attach_ioas,
671 .detach_ioas = vfio_iommufd_emulated_detach_ioas,
674 static struct mdev_driver mdpy_driver = {
675 .device_api = VFIO_DEVICE_API_PCI_STRING,
679 .owner = THIS_MODULE,
680 .mod_name = KBUILD_MODNAME,
681 .dev_groups = mdev_dev_groups,
684 .remove = mdpy_remove,
685 .show_description = mdpy_show_description,
688 static const struct file_operations vd_fops = {
689 .owner = THIS_MODULE,
692 static void mdpy_device_release(struct device *dev)
697 static int __init mdpy_dev_init(void)
701 ret = alloc_chrdev_region(&mdpy_devt, 0, MINORMASK + 1, MDPY_NAME);
703 pr_err("Error: failed to register mdpy_dev, err: %d\n", ret);
706 cdev_init(&mdpy_cdev, &vd_fops);
707 cdev_add(&mdpy_cdev, mdpy_devt, MINORMASK + 1);
708 pr_info("%s: major %d\n", __func__, MAJOR(mdpy_devt));
710 ret = mdev_register_driver(&mdpy_driver);
714 ret = class_register(&mdpy_class);
717 mdpy_dev.class = &mdpy_class;
718 mdpy_dev.release = mdpy_device_release;
719 dev_set_name(&mdpy_dev, "%s", MDPY_NAME);
721 ret = device_register(&mdpy_dev);
725 ret = mdev_register_parent(&mdpy_parent, &mdpy_dev, &mdpy_driver,
727 ARRAY_SIZE(mdpy_mdev_types));
734 device_del(&mdpy_dev);
736 put_device(&mdpy_dev);
737 class_unregister(&mdpy_class);
739 mdev_unregister_driver(&mdpy_driver);
741 cdev_del(&mdpy_cdev);
742 unregister_chrdev_region(mdpy_devt, MINORMASK + 1);
746 static void __exit mdpy_dev_exit(void)
749 mdev_unregister_parent(&mdpy_parent);
751 device_unregister(&mdpy_dev);
752 mdev_unregister_driver(&mdpy_driver);
753 cdev_del(&mdpy_cdev);
754 unregister_chrdev_region(mdpy_devt, MINORMASK + 1);
755 class_unregister(&mdpy_class);
758 module_param_named(count, mdpy_driver.max_instances, int, 0444);
759 MODULE_PARM_DESC(count, "number of " MDPY_NAME " devices");
761 module_init(mdpy_dev_init)
762 module_exit(mdpy_dev_exit)