1 // SPDX-License-Identifier: GPL-2.0
3 * Physical device callbacks for vfio_ccw
5 * Copyright IBM Corp. 2017
6 * Copyright Red Hat, Inc. 2019
8 * Author(s): Dong Jia Shi <bjsdjshi@linux.vnet.ibm.com>
9 * Xiao Feng Ren <renxiaof@linux.vnet.ibm.com>
10 * Cornelia Huck <cohuck@redhat.com>
13 #include <linux/vfio.h>
14 #include <linux/mdev.h>
15 #include <linux/nospec.h>
16 #include <linux/slab.h>
18 #include "vfio_ccw_private.h"
20 static const struct vfio_device_ops vfio_ccw_dev_ops;
22 static int vfio_ccw_mdev_reset(struct vfio_ccw_private *private)
24 struct subchannel *sch;
30 * In the cureent stage, some things like "no I/O running" and "no
31 * interrupt pending" are clear, but we are not sure what other state
32 * we need to care about.
33 * There are still a lot more instructions need to be handled. We
34 * should come back here later.
36 ret = vfio_ccw_sch_quiesce(sch);
40 ret = cio_enable_subchannel(sch, (u32)(unsigned long)sch);
42 private->state = VFIO_CCW_STATE_IDLE;
47 static int vfio_ccw_mdev_notifier(struct notifier_block *nb,
51 struct vfio_ccw_private *private =
52 container_of(nb, struct vfio_ccw_private, nb);
55 * Vendor drivers MUST unpin pages in response to an
58 if (action == VFIO_IOMMU_NOTIFY_DMA_UNMAP) {
59 struct vfio_iommu_type1_dma_unmap *unmap = data;
61 if (!cp_iova_pinned(&private->cp, unmap->iova))
64 if (vfio_ccw_mdev_reset(private))
67 cp_free(&private->cp);
74 static ssize_t name_show(struct mdev_type *mtype,
75 struct mdev_type_attribute *attr, char *buf)
77 return sprintf(buf, "I/O subchannel (Non-QDIO)\n");
79 static MDEV_TYPE_ATTR_RO(name);
81 static ssize_t device_api_show(struct mdev_type *mtype,
82 struct mdev_type_attribute *attr, char *buf)
84 return sprintf(buf, "%s\n", VFIO_DEVICE_API_CCW_STRING);
86 static MDEV_TYPE_ATTR_RO(device_api);
88 static ssize_t available_instances_show(struct mdev_type *mtype,
89 struct mdev_type_attribute *attr,
92 struct vfio_ccw_private *private =
93 dev_get_drvdata(mtype_get_parent_dev(mtype));
95 return sprintf(buf, "%d\n", atomic_read(&private->avail));
97 static MDEV_TYPE_ATTR_RO(available_instances);
99 static struct attribute *mdev_types_attrs[] = {
100 &mdev_type_attr_name.attr,
101 &mdev_type_attr_device_api.attr,
102 &mdev_type_attr_available_instances.attr,
106 static struct attribute_group mdev_type_group = {
108 .attrs = mdev_types_attrs,
111 static struct attribute_group *mdev_type_groups[] = {
116 static int vfio_ccw_mdev_probe(struct mdev_device *mdev)
118 struct vfio_ccw_private *private = dev_get_drvdata(mdev->dev.parent);
121 if (private->state == VFIO_CCW_STATE_NOT_OPER)
124 if (atomic_dec_if_positive(&private->avail) < 0)
127 memset(&private->vdev, 0, sizeof(private->vdev));
128 vfio_init_group_dev(&private->vdev, &mdev->dev,
131 private->mdev = mdev;
132 private->state = VFIO_CCW_STATE_IDLE;
134 VFIO_CCW_MSG_EVENT(2, "mdev %pUl, sch %x.%x.%04x: create\n",
135 mdev_uuid(mdev), private->sch->schid.cssid,
136 private->sch->schid.ssid,
137 private->sch->schid.sch_no);
139 ret = vfio_register_emulated_iommu_dev(&private->vdev);
142 dev_set_drvdata(&mdev->dev, private);
146 vfio_uninit_group_dev(&private->vdev);
147 atomic_inc(&private->avail);
148 private->mdev = NULL;
149 private->state = VFIO_CCW_STATE_IDLE;
153 static void vfio_ccw_mdev_remove(struct mdev_device *mdev)
155 struct vfio_ccw_private *private = dev_get_drvdata(mdev->dev.parent);
157 VFIO_CCW_MSG_EVENT(2, "mdev %pUl, sch %x.%x.%04x: remove\n",
158 mdev_uuid(mdev), private->sch->schid.cssid,
159 private->sch->schid.ssid,
160 private->sch->schid.sch_no);
162 vfio_unregister_group_dev(&private->vdev);
164 if ((private->state != VFIO_CCW_STATE_NOT_OPER) &&
165 (private->state != VFIO_CCW_STATE_STANDBY)) {
166 if (!vfio_ccw_sch_quiesce(private->sch))
167 private->state = VFIO_CCW_STATE_STANDBY;
168 /* The state will be NOT_OPER on error. */
171 vfio_uninit_group_dev(&private->vdev);
172 cp_free(&private->cp);
173 private->mdev = NULL;
174 atomic_inc(&private->avail);
177 static int vfio_ccw_mdev_open_device(struct vfio_device *vdev)
179 struct vfio_ccw_private *private =
180 container_of(vdev, struct vfio_ccw_private, vdev);
181 unsigned long events = VFIO_IOMMU_NOTIFY_DMA_UNMAP;
184 private->nb.notifier_call = vfio_ccw_mdev_notifier;
186 ret = vfio_register_notifier(vdev->dev, VFIO_IOMMU_NOTIFY,
187 &events, &private->nb);
191 ret = vfio_ccw_register_async_dev_regions(private);
195 ret = vfio_ccw_register_schib_dev_regions(private);
199 ret = vfio_ccw_register_crw_dev_regions(private);
206 vfio_ccw_unregister_dev_regions(private);
207 vfio_unregister_notifier(vdev->dev, VFIO_IOMMU_NOTIFY,
212 static void vfio_ccw_mdev_close_device(struct vfio_device *vdev)
214 struct vfio_ccw_private *private =
215 container_of(vdev, struct vfio_ccw_private, vdev);
217 if ((private->state != VFIO_CCW_STATE_NOT_OPER) &&
218 (private->state != VFIO_CCW_STATE_STANDBY)) {
219 if (!vfio_ccw_mdev_reset(private))
220 private->state = VFIO_CCW_STATE_STANDBY;
221 /* The state will be NOT_OPER on error. */
224 cp_free(&private->cp);
225 vfio_ccw_unregister_dev_regions(private);
226 vfio_unregister_notifier(vdev->dev, VFIO_IOMMU_NOTIFY, &private->nb);
229 static ssize_t vfio_ccw_mdev_read_io_region(struct vfio_ccw_private *private,
230 char __user *buf, size_t count,
233 loff_t pos = *ppos & VFIO_CCW_OFFSET_MASK;
234 struct ccw_io_region *region;
237 if (pos + count > sizeof(*region))
240 mutex_lock(&private->io_mutex);
241 region = private->io_region;
242 if (copy_to_user(buf, (void *)region + pos, count))
246 mutex_unlock(&private->io_mutex);
250 static ssize_t vfio_ccw_mdev_read(struct vfio_device *vdev,
255 struct vfio_ccw_private *private =
256 container_of(vdev, struct vfio_ccw_private, vdev);
257 unsigned int index = VFIO_CCW_OFFSET_TO_INDEX(*ppos);
259 if (index >= VFIO_CCW_NUM_REGIONS + private->num_regions)
263 case VFIO_CCW_CONFIG_REGION_INDEX:
264 return vfio_ccw_mdev_read_io_region(private, buf, count, ppos);
266 index -= VFIO_CCW_NUM_REGIONS;
267 return private->region[index].ops->read(private, buf, count,
274 static ssize_t vfio_ccw_mdev_write_io_region(struct vfio_ccw_private *private,
275 const char __user *buf,
276 size_t count, loff_t *ppos)
278 loff_t pos = *ppos & VFIO_CCW_OFFSET_MASK;
279 struct ccw_io_region *region;
282 if (pos + count > sizeof(*region))
285 if (!mutex_trylock(&private->io_mutex))
288 region = private->io_region;
289 if (copy_from_user((void *)region + pos, buf, count)) {
294 vfio_ccw_fsm_event(private, VFIO_CCW_EVENT_IO_REQ);
295 ret = (region->ret_code != 0) ? region->ret_code : count;
298 mutex_unlock(&private->io_mutex);
302 static ssize_t vfio_ccw_mdev_write(struct vfio_device *vdev,
303 const char __user *buf,
307 struct vfio_ccw_private *private =
308 container_of(vdev, struct vfio_ccw_private, vdev);
309 unsigned int index = VFIO_CCW_OFFSET_TO_INDEX(*ppos);
311 if (index >= VFIO_CCW_NUM_REGIONS + private->num_regions)
315 case VFIO_CCW_CONFIG_REGION_INDEX:
316 return vfio_ccw_mdev_write_io_region(private, buf, count, ppos);
318 index -= VFIO_CCW_NUM_REGIONS;
319 return private->region[index].ops->write(private, buf, count,
326 static int vfio_ccw_mdev_get_device_info(struct vfio_ccw_private *private,
327 struct vfio_device_info *info)
329 info->flags = VFIO_DEVICE_FLAGS_CCW | VFIO_DEVICE_FLAGS_RESET;
330 info->num_regions = VFIO_CCW_NUM_REGIONS + private->num_regions;
331 info->num_irqs = VFIO_CCW_NUM_IRQS;
336 static int vfio_ccw_mdev_get_region_info(struct vfio_ccw_private *private,
337 struct vfio_region_info *info,
342 switch (info->index) {
343 case VFIO_CCW_CONFIG_REGION_INDEX:
345 info->size = sizeof(struct ccw_io_region);
346 info->flags = VFIO_REGION_INFO_FLAG_READ
347 | VFIO_REGION_INFO_FLAG_WRITE;
349 default: /* all other regions are handled via capability chain */
351 struct vfio_info_cap caps = { .buf = NULL, .size = 0 };
352 struct vfio_region_info_cap_type cap_type = {
353 .header.id = VFIO_REGION_INFO_CAP_TYPE,
354 .header.version = 1 };
358 VFIO_CCW_NUM_REGIONS + private->num_regions)
361 info->index = array_index_nospec(info->index,
362 VFIO_CCW_NUM_REGIONS +
363 private->num_regions);
365 i = info->index - VFIO_CCW_NUM_REGIONS;
367 info->offset = VFIO_CCW_INDEX_TO_OFFSET(info->index);
368 info->size = private->region[i].size;
369 info->flags = private->region[i].flags;
371 cap_type.type = private->region[i].type;
372 cap_type.subtype = private->region[i].subtype;
374 ret = vfio_info_add_capability(&caps, &cap_type.header,
379 info->flags |= VFIO_REGION_INFO_FLAG_CAPS;
380 if (info->argsz < sizeof(*info) + caps.size) {
381 info->argsz = sizeof(*info) + caps.size;
382 info->cap_offset = 0;
384 vfio_info_cap_shift(&caps, sizeof(*info));
385 if (copy_to_user((void __user *)arg + sizeof(*info),
386 caps.buf, caps.size)) {
390 info->cap_offset = sizeof(*info);
400 static int vfio_ccw_mdev_get_irq_info(struct vfio_irq_info *info)
402 switch (info->index) {
403 case VFIO_CCW_IO_IRQ_INDEX:
404 case VFIO_CCW_CRW_IRQ_INDEX:
405 case VFIO_CCW_REQ_IRQ_INDEX:
407 info->flags = VFIO_IRQ_INFO_EVENTFD;
416 static int vfio_ccw_mdev_set_irqs(struct vfio_ccw_private *private,
421 struct eventfd_ctx **ctx;
423 if (!(flags & VFIO_IRQ_SET_ACTION_TRIGGER))
427 case VFIO_CCW_IO_IRQ_INDEX:
428 ctx = &private->io_trigger;
430 case VFIO_CCW_CRW_IRQ_INDEX:
431 ctx = &private->crw_trigger;
433 case VFIO_CCW_REQ_IRQ_INDEX:
434 ctx = &private->req_trigger;
440 switch (flags & VFIO_IRQ_SET_DATA_TYPE_MASK) {
441 case VFIO_IRQ_SET_DATA_NONE:
444 eventfd_signal(*ctx, 1);
447 case VFIO_IRQ_SET_DATA_BOOL:
451 if (get_user(trigger, (uint8_t __user *)data))
455 eventfd_signal(*ctx, 1);
458 case VFIO_IRQ_SET_DATA_EVENTFD:
462 if (get_user(fd, (int32_t __user *)data))
467 eventfd_ctx_put(*ctx);
469 } else if (fd >= 0) {
470 struct eventfd_ctx *efdctx;
472 efdctx = eventfd_ctx_fdget(fd);
474 return PTR_ERR(efdctx);
477 eventfd_ctx_put(*ctx);
490 int vfio_ccw_register_dev_region(struct vfio_ccw_private *private,
491 unsigned int subtype,
492 const struct vfio_ccw_regops *ops,
493 size_t size, u32 flags, void *data)
495 struct vfio_ccw_region *region;
497 region = krealloc(private->region,
498 (private->num_regions + 1) * sizeof(*region),
503 private->region = region;
504 private->region[private->num_regions].type = VFIO_REGION_TYPE_CCW;
505 private->region[private->num_regions].subtype = subtype;
506 private->region[private->num_regions].ops = ops;
507 private->region[private->num_regions].size = size;
508 private->region[private->num_regions].flags = flags;
509 private->region[private->num_regions].data = data;
511 private->num_regions++;
516 void vfio_ccw_unregister_dev_regions(struct vfio_ccw_private *private)
520 for (i = 0; i < private->num_regions; i++)
521 private->region[i].ops->release(private, &private->region[i]);
522 private->num_regions = 0;
523 kfree(private->region);
524 private->region = NULL;
527 static ssize_t vfio_ccw_mdev_ioctl(struct vfio_device *vdev,
531 struct vfio_ccw_private *private =
532 container_of(vdev, struct vfio_ccw_private, vdev);
537 case VFIO_DEVICE_GET_INFO:
539 struct vfio_device_info info;
541 minsz = offsetofend(struct vfio_device_info, num_irqs);
543 if (copy_from_user(&info, (void __user *)arg, minsz))
546 if (info.argsz < minsz)
549 ret = vfio_ccw_mdev_get_device_info(private, &info);
553 return copy_to_user((void __user *)arg, &info, minsz) ? -EFAULT : 0;
555 case VFIO_DEVICE_GET_REGION_INFO:
557 struct vfio_region_info info;
559 minsz = offsetofend(struct vfio_region_info, offset);
561 if (copy_from_user(&info, (void __user *)arg, minsz))
564 if (info.argsz < minsz)
567 ret = vfio_ccw_mdev_get_region_info(private, &info, arg);
571 return copy_to_user((void __user *)arg, &info, minsz) ? -EFAULT : 0;
573 case VFIO_DEVICE_GET_IRQ_INFO:
575 struct vfio_irq_info info;
577 minsz = offsetofend(struct vfio_irq_info, count);
579 if (copy_from_user(&info, (void __user *)arg, minsz))
582 if (info.argsz < minsz || info.index >= VFIO_CCW_NUM_IRQS)
585 ret = vfio_ccw_mdev_get_irq_info(&info);
589 if (info.count == -1)
592 return copy_to_user((void __user *)arg, &info, minsz) ? -EFAULT : 0;
594 case VFIO_DEVICE_SET_IRQS:
596 struct vfio_irq_set hdr;
600 minsz = offsetofend(struct vfio_irq_set, count);
602 if (copy_from_user(&hdr, (void __user *)arg, minsz))
605 ret = vfio_set_irqs_validate_and_prepare(&hdr, 1,
611 data = (void __user *)(arg + minsz);
612 return vfio_ccw_mdev_set_irqs(private, hdr.flags, hdr.index,
615 case VFIO_DEVICE_RESET:
616 return vfio_ccw_mdev_reset(private);
622 /* Request removal of the device*/
623 static void vfio_ccw_mdev_request(struct vfio_device *vdev, unsigned int count)
625 struct vfio_ccw_private *private =
626 container_of(vdev, struct vfio_ccw_private, vdev);
627 struct device *dev = vdev->dev;
629 if (private->req_trigger) {
631 dev_notice_ratelimited(dev,
632 "Relaying device request to user (#%u)\n",
635 eventfd_signal(private->req_trigger, 1);
636 } else if (count == 0) {
638 "No device request channel registered, blocked until released by user\n");
642 static const struct vfio_device_ops vfio_ccw_dev_ops = {
643 .open_device = vfio_ccw_mdev_open_device,
644 .close_device = vfio_ccw_mdev_close_device,
645 .read = vfio_ccw_mdev_read,
646 .write = vfio_ccw_mdev_write,
647 .ioctl = vfio_ccw_mdev_ioctl,
648 .request = vfio_ccw_mdev_request,
651 struct mdev_driver vfio_ccw_mdev_driver = {
653 .name = "vfio_ccw_mdev",
654 .owner = THIS_MODULE,
655 .mod_name = KBUILD_MODNAME,
657 .probe = vfio_ccw_mdev_probe,
658 .remove = vfio_ccw_mdev_remove,
661 static const struct mdev_parent_ops vfio_ccw_mdev_ops = {
662 .owner = THIS_MODULE,
663 .device_driver = &vfio_ccw_mdev_driver,
664 .supported_type_groups = mdev_type_groups,
667 int vfio_ccw_mdev_reg(struct subchannel *sch)
669 return mdev_register_device(&sch->dev, &vfio_ccw_mdev_ops);
672 void vfio_ccw_mdev_unreg(struct subchannel *sch)
674 mdev_unregister_device(&sch->dev);