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/device.h>
21 #include <linux/kernel.h>
22 #include <linux/slab.h>
23 #include <linux/vmalloc.h>
24 #include <linux/cdev.h>
25 #include <linux/vfio.h>
26 #include <linux/iommu.h>
27 #include <linux/sysfs.h>
28 #include <linux/mdev.h>
29 #include <linux/pci.h>
30 #include <drm/drm_fourcc.h>
31 #include "mdpy-defs.h"
33 #define MDPY_NAME "mdpy"
34 #define MDPY_CLASS_NAME "mdpy"
36 #define MDPY_CONFIG_SPACE_SIZE 0xff
37 #define MDPY_MEMORY_BAR_OFFSET PAGE_SIZE
38 #define MDPY_DISPLAY_REGION 16
40 #define STORE_LE16(addr, val) (*(u16 *)addr = val)
41 #define STORE_LE32(addr, val) (*(u32 *)addr = val)
44 MODULE_LICENSE("GPL v2");
46 static int max_devices = 4;
47 module_param_named(count, max_devices, int, 0444);
48 MODULE_PARM_DESC(count, "number of " MDPY_NAME " devices");
51 #define MDPY_TYPE_1 "vga"
52 #define MDPY_TYPE_2 "xga"
53 #define MDPY_TYPE_3 "hd"
55 static const struct mdpy_type {
63 .name = MDPY_CLASS_NAME "-" MDPY_TYPE_1,
64 .format = DRM_FORMAT_XRGB8888,
69 .name = MDPY_CLASS_NAME "-" MDPY_TYPE_2,
70 .format = DRM_FORMAT_XRGB8888,
75 .name = MDPY_CLASS_NAME "-" MDPY_TYPE_3,
76 .format = DRM_FORMAT_XRGB8888,
83 static dev_t mdpy_devt;
84 static struct class *mdpy_class;
85 static struct cdev mdpy_cdev;
86 static struct device mdpy_dev;
87 static u32 mdpy_count;
89 /* State of each mdev device */
93 struct mutex ops_lock;
94 struct mdev_device *mdev;
95 struct vfio_device_info dev_info;
97 const struct mdpy_type *type;
102 static void mdpy_create_config_space(struct mdev_state *mdev_state)
104 STORE_LE16((u16 *) &mdev_state->vconfig[PCI_VENDOR_ID],
106 STORE_LE16((u16 *) &mdev_state->vconfig[PCI_DEVICE_ID],
108 STORE_LE16((u16 *) &mdev_state->vconfig[PCI_SUBSYSTEM_VENDOR_ID],
109 MDPY_PCI_SUBVENDOR_ID);
110 STORE_LE16((u16 *) &mdev_state->vconfig[PCI_SUBSYSTEM_ID],
111 MDPY_PCI_SUBDEVICE_ID);
113 STORE_LE16((u16 *) &mdev_state->vconfig[PCI_COMMAND],
114 PCI_COMMAND_IO | PCI_COMMAND_MEMORY);
115 STORE_LE16((u16 *) &mdev_state->vconfig[PCI_STATUS],
116 PCI_STATUS_CAP_LIST);
117 STORE_LE16((u16 *) &mdev_state->vconfig[PCI_CLASS_DEVICE],
118 PCI_CLASS_DISPLAY_OTHER);
119 mdev_state->vconfig[PCI_CLASS_REVISION] = 0x01;
121 STORE_LE32((u32 *) &mdev_state->vconfig[PCI_BASE_ADDRESS_0],
122 PCI_BASE_ADDRESS_SPACE_MEMORY |
123 PCI_BASE_ADDRESS_MEM_TYPE_32 |
124 PCI_BASE_ADDRESS_MEM_PREFETCH);
125 mdev_state->bar_mask = ~(mdev_state->memsize) + 1;
127 /* vendor specific capability for the config registers */
128 mdev_state->vconfig[PCI_CAPABILITY_LIST] = MDPY_VENDORCAP_OFFSET;
129 mdev_state->vconfig[MDPY_VENDORCAP_OFFSET + 0] = 0x09; /* vendor cap */
130 mdev_state->vconfig[MDPY_VENDORCAP_OFFSET + 1] = 0x00; /* next ptr */
131 mdev_state->vconfig[MDPY_VENDORCAP_OFFSET + 2] = MDPY_VENDORCAP_SIZE;
132 STORE_LE32((u32 *) &mdev_state->vconfig[MDPY_FORMAT_OFFSET],
133 mdev_state->type->format);
134 STORE_LE32((u32 *) &mdev_state->vconfig[MDPY_WIDTH_OFFSET],
135 mdev_state->type->width);
136 STORE_LE32((u32 *) &mdev_state->vconfig[MDPY_HEIGHT_OFFSET],
137 mdev_state->type->height);
140 static void handle_pci_cfg_write(struct mdev_state *mdev_state, u16 offset,
141 char *buf, u32 count)
143 struct device *dev = mdev_dev(mdev_state->mdev);
147 case PCI_BASE_ADDRESS_0:
148 cfg_addr = *(u32 *)buf;
150 if (cfg_addr == 0xffffffff) {
151 cfg_addr = (cfg_addr & mdev_state->bar_mask);
153 cfg_addr &= PCI_BASE_ADDRESS_MEM_MASK;
155 dev_info(dev, "BAR0 @ 0x%x\n", cfg_addr);
158 cfg_addr |= (mdev_state->vconfig[offset] &
159 ~PCI_BASE_ADDRESS_MEM_MASK);
160 STORE_LE32(&mdev_state->vconfig[offset], cfg_addr);
165 static ssize_t mdev_access(struct mdev_device *mdev, char *buf, size_t count,
166 loff_t pos, bool is_write)
168 struct mdev_state *mdev_state = mdev_get_drvdata(mdev);
169 struct device *dev = mdev_dev(mdev);
172 mutex_lock(&mdev_state->ops_lock);
174 if (pos < MDPY_CONFIG_SPACE_SIZE) {
176 handle_pci_cfg_write(mdev_state, pos, buf, count);
178 memcpy(buf, (mdev_state->vconfig + pos), count);
180 } else if ((pos >= MDPY_MEMORY_BAR_OFFSET) &&
182 MDPY_MEMORY_BAR_OFFSET + mdev_state->memsize)) {
183 pos -= MDPY_MEMORY_BAR_OFFSET;
185 memcpy(mdev_state->memblk, buf, count);
187 memcpy(buf, mdev_state->memblk, count);
190 dev_info(dev, "%s: %s @0x%llx (unhandled)\n",
191 __func__, is_write ? "WR" : "RD", pos);
200 mutex_unlock(&mdev_state->ops_lock);
205 static int mdpy_reset(struct mdev_device *mdev)
207 struct mdev_state *mdev_state = mdev_get_drvdata(mdev);
210 /* initialize with gray gradient */
211 stride = mdev_state->type->width * mdev_state->type->bytepp;
212 for (i = 0; i < mdev_state->type->height; i++)
213 memset(mdev_state->memblk + i * stride,
214 i * 255 / mdev_state->type->height,
219 static int mdpy_create(struct mdev_device *mdev)
221 const struct mdpy_type *type =
222 &mdpy_types[mdev_get_type_group_id(mdev)];
223 struct device *dev = mdev_dev(mdev);
224 struct mdev_state *mdev_state;
227 if (mdpy_count >= max_devices)
230 mdev_state = kzalloc(sizeof(struct mdev_state), GFP_KERNEL);
231 if (mdev_state == NULL)
234 mdev_state->vconfig = kzalloc(MDPY_CONFIG_SPACE_SIZE, GFP_KERNEL);
235 if (mdev_state->vconfig == NULL) {
240 fbsize = roundup_pow_of_two(type->width * type->height * type->bytepp);
242 mdev_state->memblk = vmalloc_user(fbsize);
243 if (!mdev_state->memblk) {
244 kfree(mdev_state->vconfig);
248 dev_info(dev, "%s: %s (%dx%d)\n", __func__, type->name, type->width,
251 mutex_init(&mdev_state->ops_lock);
252 mdev_state->mdev = mdev;
253 mdev_set_drvdata(mdev, mdev_state);
255 mdev_state->type = type;
256 mdev_state->memsize = fbsize;
257 mdpy_create_config_space(mdev_state);
264 static int mdpy_remove(struct mdev_device *mdev)
266 struct mdev_state *mdev_state = mdev_get_drvdata(mdev);
267 struct device *dev = mdev_dev(mdev);
269 dev_info(dev, "%s\n", __func__);
271 mdev_set_drvdata(mdev, NULL);
272 vfree(mdev_state->memblk);
273 kfree(mdev_state->vconfig);
280 static ssize_t mdpy_read(struct mdev_device *mdev, char __user *buf,
281 size_t count, loff_t *ppos)
283 unsigned int done = 0;
289 if (count >= 4 && !(*ppos % 4)) {
292 ret = mdev_access(mdev, (char *)&val, sizeof(val),
297 if (copy_to_user(buf, &val, sizeof(val)))
301 } else if (count >= 2 && !(*ppos % 2)) {
304 ret = mdev_access(mdev, (char *)&val, sizeof(val),
309 if (copy_to_user(buf, &val, sizeof(val)))
316 ret = mdev_access(mdev, (char *)&val, sizeof(val),
321 if (copy_to_user(buf, &val, sizeof(val)))
339 static ssize_t mdpy_write(struct mdev_device *mdev, const char __user *buf,
340 size_t count, loff_t *ppos)
342 unsigned int done = 0;
348 if (count >= 4 && !(*ppos % 4)) {
351 if (copy_from_user(&val, buf, sizeof(val)))
354 ret = mdev_access(mdev, (char *)&val, sizeof(val),
360 } else if (count >= 2 && !(*ppos % 2)) {
363 if (copy_from_user(&val, buf, sizeof(val)))
366 ret = mdev_access(mdev, (char *)&val, sizeof(val),
375 if (copy_from_user(&val, buf, sizeof(val)))
378 ret = mdev_access(mdev, (char *)&val, sizeof(val),
396 static int mdpy_mmap(struct mdev_device *mdev, struct vm_area_struct *vma)
398 struct mdev_state *mdev_state = mdev_get_drvdata(mdev);
400 if (vma->vm_pgoff != MDPY_MEMORY_BAR_OFFSET >> PAGE_SHIFT)
402 if (vma->vm_end < vma->vm_start)
404 if (vma->vm_end - vma->vm_start > mdev_state->memsize)
406 if ((vma->vm_flags & VM_SHARED) == 0)
409 return remap_vmalloc_range(vma, mdev_state->memblk, 0);
412 static int mdpy_get_region_info(struct mdev_device *mdev,
413 struct vfio_region_info *region_info,
414 u16 *cap_type_id, void **cap_type)
416 struct mdev_state *mdev_state;
418 mdev_state = mdev_get_drvdata(mdev);
422 if (region_info->index >= VFIO_PCI_NUM_REGIONS &&
423 region_info->index != MDPY_DISPLAY_REGION)
426 switch (region_info->index) {
427 case VFIO_PCI_CONFIG_REGION_INDEX:
428 region_info->offset = 0;
429 region_info->size = MDPY_CONFIG_SPACE_SIZE;
430 region_info->flags = (VFIO_REGION_INFO_FLAG_READ |
431 VFIO_REGION_INFO_FLAG_WRITE);
433 case VFIO_PCI_BAR0_REGION_INDEX:
434 case MDPY_DISPLAY_REGION:
435 region_info->offset = MDPY_MEMORY_BAR_OFFSET;
436 region_info->size = mdev_state->memsize;
437 region_info->flags = (VFIO_REGION_INFO_FLAG_READ |
438 VFIO_REGION_INFO_FLAG_WRITE |
439 VFIO_REGION_INFO_FLAG_MMAP);
442 region_info->size = 0;
443 region_info->offset = 0;
444 region_info->flags = 0;
450 static int mdpy_get_irq_info(struct mdev_device *mdev,
451 struct vfio_irq_info *irq_info)
457 static int mdpy_get_device_info(struct mdev_device *mdev,
458 struct vfio_device_info *dev_info)
460 dev_info->flags = VFIO_DEVICE_FLAGS_PCI;
461 dev_info->num_regions = VFIO_PCI_NUM_REGIONS;
462 dev_info->num_irqs = VFIO_PCI_NUM_IRQS;
466 static int mdpy_query_gfx_plane(struct mdev_device *mdev,
467 struct vfio_device_gfx_plane_info *plane)
469 struct mdev_state *mdev_state = mdev_get_drvdata(mdev);
471 if (plane->flags & VFIO_GFX_PLANE_TYPE_PROBE) {
472 if (plane->flags == (VFIO_GFX_PLANE_TYPE_PROBE |
473 VFIO_GFX_PLANE_TYPE_REGION))
478 if (plane->flags != VFIO_GFX_PLANE_TYPE_REGION)
481 plane->drm_format = mdev_state->type->format;
482 plane->width = mdev_state->type->width;
483 plane->height = mdev_state->type->height;
484 plane->stride = (mdev_state->type->width *
485 mdev_state->type->bytepp);
486 plane->size = mdev_state->memsize;
487 plane->region_index = MDPY_DISPLAY_REGION;
490 plane->drm_format_mod = 0;
499 static long mdpy_ioctl(struct mdev_device *mdev, unsigned int cmd,
504 struct mdev_state *mdev_state;
506 mdev_state = mdev_get_drvdata(mdev);
509 case VFIO_DEVICE_GET_INFO:
511 struct vfio_device_info info;
513 minsz = offsetofend(struct vfio_device_info, num_irqs);
515 if (copy_from_user(&info, (void __user *)arg, minsz))
518 if (info.argsz < minsz)
521 ret = mdpy_get_device_info(mdev, &info);
525 memcpy(&mdev_state->dev_info, &info, sizeof(info));
527 if (copy_to_user((void __user *)arg, &info, minsz))
532 case VFIO_DEVICE_GET_REGION_INFO:
534 struct vfio_region_info info;
536 void *cap_type = NULL;
538 minsz = offsetofend(struct vfio_region_info, offset);
540 if (copy_from_user(&info, (void __user *)arg, minsz))
543 if (info.argsz < minsz)
546 ret = mdpy_get_region_info(mdev, &info, &cap_type_id,
551 if (copy_to_user((void __user *)arg, &info, minsz))
557 case VFIO_DEVICE_GET_IRQ_INFO:
559 struct vfio_irq_info info;
561 minsz = offsetofend(struct vfio_irq_info, count);
563 if (copy_from_user(&info, (void __user *)arg, minsz))
566 if ((info.argsz < minsz) ||
567 (info.index >= mdev_state->dev_info.num_irqs))
570 ret = mdpy_get_irq_info(mdev, &info);
574 if (copy_to_user((void __user *)arg, &info, minsz))
580 case VFIO_DEVICE_QUERY_GFX_PLANE:
582 struct vfio_device_gfx_plane_info plane;
584 minsz = offsetofend(struct vfio_device_gfx_plane_info,
587 if (copy_from_user(&plane, (void __user *)arg, minsz))
590 if (plane.argsz < minsz)
593 ret = mdpy_query_gfx_plane(mdev, &plane);
597 if (copy_to_user((void __user *)arg, &plane, minsz))
603 case VFIO_DEVICE_SET_IRQS:
606 case VFIO_DEVICE_RESET:
607 return mdpy_reset(mdev);
612 static int mdpy_open(struct mdev_device *mdev)
614 if (!try_module_get(THIS_MODULE))
620 static void mdpy_close(struct mdev_device *mdev)
622 module_put(THIS_MODULE);
626 resolution_show(struct device *dev, struct device_attribute *attr,
629 struct mdev_device *mdev = mdev_from_dev(dev);
630 struct mdev_state *mdev_state = mdev_get_drvdata(mdev);
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 name_show(struct mdev_type *mtype,
654 struct mdev_type_attribute *attr, char *buf)
656 const struct mdpy_type *type =
657 &mdpy_types[mtype_get_type_group_id(mtype)];
659 return sprintf(buf, "%s\n", type->name);
661 static MDEV_TYPE_ATTR_RO(name);
663 static ssize_t description_show(struct mdev_type *mtype,
664 struct mdev_type_attribute *attr, char *buf)
666 const struct mdpy_type *type =
667 &mdpy_types[mtype_get_type_group_id(mtype)];
669 return sprintf(buf, "virtual display, %dx%d framebuffer\n",
670 type->width, type->height);
672 static MDEV_TYPE_ATTR_RO(description);
674 static ssize_t available_instances_show(struct mdev_type *mtype,
675 struct mdev_type_attribute *attr,
678 return sprintf(buf, "%d\n", max_devices - mdpy_count);
680 static MDEV_TYPE_ATTR_RO(available_instances);
682 static ssize_t device_api_show(struct mdev_type *mtype,
683 struct mdev_type_attribute *attr, char *buf)
685 return sprintf(buf, "%s\n", VFIO_DEVICE_API_PCI_STRING);
687 static MDEV_TYPE_ATTR_RO(device_api);
689 static struct attribute *mdev_types_attrs[] = {
690 &mdev_type_attr_name.attr,
691 &mdev_type_attr_description.attr,
692 &mdev_type_attr_device_api.attr,
693 &mdev_type_attr_available_instances.attr,
697 static struct attribute_group mdev_type_group1 = {
699 .attrs = mdev_types_attrs,
702 static struct attribute_group mdev_type_group2 = {
704 .attrs = mdev_types_attrs,
707 static struct attribute_group mdev_type_group3 = {
709 .attrs = mdev_types_attrs,
712 static struct attribute_group *mdev_type_groups[] = {
719 static const struct mdev_parent_ops mdev_fops = {
720 .owner = THIS_MODULE,
721 .mdev_attr_groups = mdev_dev_groups,
722 .supported_type_groups = mdev_type_groups,
723 .create = mdpy_create,
724 .remove = mdpy_remove,
726 .release = mdpy_close,
733 static const struct file_operations vd_fops = {
734 .owner = THIS_MODULE,
737 static void mdpy_device_release(struct device *dev)
742 static int __init mdpy_dev_init(void)
746 ret = alloc_chrdev_region(&mdpy_devt, 0, MINORMASK + 1, MDPY_NAME);
748 pr_err("Error: failed to register mdpy_dev, err: %d\n", ret);
751 cdev_init(&mdpy_cdev, &vd_fops);
752 cdev_add(&mdpy_cdev, mdpy_devt, MINORMASK + 1);
753 pr_info("%s: major %d\n", __func__, MAJOR(mdpy_devt));
755 mdpy_class = class_create(THIS_MODULE, MDPY_CLASS_NAME);
756 if (IS_ERR(mdpy_class)) {
757 pr_err("Error: failed to register mdpy_dev class\n");
758 ret = PTR_ERR(mdpy_class);
761 mdpy_dev.class = mdpy_class;
762 mdpy_dev.release = mdpy_device_release;
763 dev_set_name(&mdpy_dev, "%s", MDPY_NAME);
765 ret = device_register(&mdpy_dev);
769 ret = mdev_register_device(&mdpy_dev, &mdev_fops);
776 device_unregister(&mdpy_dev);
778 class_destroy(mdpy_class);
780 cdev_del(&mdpy_cdev);
781 unregister_chrdev_region(mdpy_devt, MINORMASK + 1);
785 static void __exit mdpy_dev_exit(void)
788 mdev_unregister_device(&mdpy_dev);
790 device_unregister(&mdpy_dev);
791 cdev_del(&mdpy_cdev);
792 unregister_chrdev_region(mdpy_devt, MINORMASK + 1);
793 class_destroy(mdpy_class);
797 module_init(mdpy_dev_init)
798 module_exit(mdpy_dev_exit)