2 * Intel MIC Platform Software Stack (MPSS)
4 * Copyright(c) 2016 Intel Corporation.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License, version 2, as
8 * published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * The full GNU General Public License is included in this distribution in
16 * the file called "COPYING".
20 * virtio for kvm on s390
22 * Copyright IBM Corp. 2008
24 * This program is free software; you can redistribute it and/or modify
25 * it under the terms of the GNU General Public License (version 2 only)
26 * as published by the Free Software Foundation.
28 * Author(s): Christian Borntraeger <borntraeger@de.ibm.com>
30 * Intel Virtio Over PCIe (VOP) driver.
33 #include <linux/delay.h>
34 #include <linux/module.h>
35 #include <linux/sched.h>
36 #include <linux/dma-mapping.h>
40 #define VOP_MAX_VRINGS 4
43 * _vop_vdev - Allocated per virtio device instance injected by the peer.
45 * @vdev: Virtio device
46 * @desc: Virtio device page descriptor
47 * @dc: Virtio device control
48 * @vpdev: VOP device which is the parent for this virtio device
49 * @vr: Buffer for accessing the VRING
50 * @used: Buffer for used
51 * @used_size: Size of the used buffer
52 * @reset_done: Track whether VOP reset is complete
53 * @virtio_cookie: Cookie returned upon requesting a interrupt
54 * @c2h_vdev_db: The doorbell used by the guest to interrupt the host
55 * @h2c_vdev_db: The doorbell used by the host to interrupt the guest
56 * @dnode: The destination node
59 struct virtio_device vdev;
60 struct mic_device_desc __iomem *desc;
61 struct mic_device_ctrl __iomem *dc;
62 struct vop_device *vpdev;
63 void __iomem *vr[VOP_MAX_VRINGS];
64 dma_addr_t used[VOP_MAX_VRINGS];
65 int used_size[VOP_MAX_VRINGS];
66 struct completion reset_done;
67 struct mic_irq *virtio_cookie;
73 #define to_vopvdev(vd) container_of(vd, struct _vop_vdev, vdev)
75 #define _vop_aligned_desc_size(d) __mic_align(_vop_desc_size(d), 8)
77 /* Helper API to obtain the parent of the virtio device */
78 static inline struct device *_vop_dev(struct _vop_vdev *vdev)
80 return vdev->vdev.dev.parent;
83 static inline unsigned _vop_desc_size(struct mic_device_desc __iomem *desc)
86 + ioread8(&desc->num_vq) * sizeof(struct mic_vqconfig)
87 + ioread8(&desc->feature_len) * 2
88 + ioread8(&desc->config_len);
91 static inline struct mic_vqconfig __iomem *
92 _vop_vq_config(struct mic_device_desc __iomem *desc)
94 return (struct mic_vqconfig __iomem *)(desc + 1);
97 static inline u8 __iomem *
98 _vop_vq_features(struct mic_device_desc __iomem *desc)
100 return (u8 __iomem *)(_vop_vq_config(desc) + ioread8(&desc->num_vq));
103 static inline u8 __iomem *
104 _vop_vq_configspace(struct mic_device_desc __iomem *desc)
106 return _vop_vq_features(desc) + ioread8(&desc->feature_len) * 2;
109 static inline unsigned
110 _vop_total_desc_size(struct mic_device_desc __iomem *desc)
112 return _vop_aligned_desc_size(desc) + sizeof(struct mic_device_ctrl);
115 /* This gets the device's feature bits. */
116 static u64 vop_get_features(struct virtio_device *vdev)
118 unsigned int i, bits;
120 struct mic_device_desc __iomem *desc = to_vopvdev(vdev)->desc;
121 u8 __iomem *in_features = _vop_vq_features(desc);
122 int feature_len = ioread8(&desc->feature_len);
124 bits = min_t(unsigned, feature_len, sizeof(vdev->features)) * 8;
125 for (i = 0; i < bits; i++)
126 if (ioread8(&in_features[i / 8]) & (BIT(i % 8)))
132 static int vop_finalize_features(struct virtio_device *vdev)
134 unsigned int i, bits;
135 struct mic_device_desc __iomem *desc = to_vopvdev(vdev)->desc;
136 u8 feature_len = ioread8(&desc->feature_len);
137 /* Second half of bitmap is features we accept. */
138 u8 __iomem *out_features =
139 _vop_vq_features(desc) + feature_len;
141 /* Give virtio_ring a chance to accept features. */
142 vring_transport_features(vdev);
144 memset_io(out_features, 0, feature_len);
145 bits = min_t(unsigned, feature_len,
146 sizeof(vdev->features)) * 8;
147 for (i = 0; i < bits; i++) {
148 if (__virtio_test_bit(vdev, i))
149 iowrite8(ioread8(&out_features[i / 8]) | (1 << (i % 8)),
150 &out_features[i / 8]);
156 * Reading and writing elements in config space
158 static void vop_get(struct virtio_device *vdev, unsigned int offset,
159 void *buf, unsigned len)
161 struct mic_device_desc __iomem *desc = to_vopvdev(vdev)->desc;
163 if (offset + len > ioread8(&desc->config_len))
165 memcpy_fromio(buf, _vop_vq_configspace(desc) + offset, len);
168 static void vop_set(struct virtio_device *vdev, unsigned int offset,
169 const void *buf, unsigned len)
171 struct mic_device_desc __iomem *desc = to_vopvdev(vdev)->desc;
173 if (offset + len > ioread8(&desc->config_len))
175 memcpy_toio(_vop_vq_configspace(desc) + offset, buf, len);
179 * The operations to get and set the status word just access the status
180 * field of the device descriptor. set_status also interrupts the host
181 * to tell about status changes.
183 static u8 vop_get_status(struct virtio_device *vdev)
185 return ioread8(&to_vopvdev(vdev)->desc->status);
188 static void vop_set_status(struct virtio_device *dev, u8 status)
190 struct _vop_vdev *vdev = to_vopvdev(dev);
191 struct vop_device *vpdev = vdev->vpdev;
195 iowrite8(status, &vdev->desc->status);
196 vpdev->hw_ops->send_intr(vpdev, vdev->c2h_vdev_db);
199 /* Inform host on a virtio device reset and wait for ack from host */
200 static void vop_reset_inform_host(struct virtio_device *dev)
202 struct _vop_vdev *vdev = to_vopvdev(dev);
203 struct mic_device_ctrl __iomem *dc = vdev->dc;
204 struct vop_device *vpdev = vdev->vpdev;
207 iowrite8(0, &dc->host_ack);
208 iowrite8(1, &dc->vdev_reset);
209 vpdev->hw_ops->send_intr(vpdev, vdev->c2h_vdev_db);
211 /* Wait till host completes all card accesses and acks the reset */
212 for (retry = 100; retry--;) {
213 if (ioread8(&dc->host_ack))
218 dev_dbg(_vop_dev(vdev), "%s: retry: %d\n", __func__, retry);
220 /* Reset status to 0 in case we timed out */
221 iowrite8(0, &vdev->desc->status);
224 static void vop_reset(struct virtio_device *dev)
226 struct _vop_vdev *vdev = to_vopvdev(dev);
228 dev_dbg(_vop_dev(vdev), "%s: virtio id %d\n",
229 __func__, dev->id.device);
231 vop_reset_inform_host(dev);
232 complete_all(&vdev->reset_done);
236 * The virtio_ring code calls this API when it wants to notify the Host.
238 static bool vop_notify(struct virtqueue *vq)
240 struct _vop_vdev *vdev = vq->priv;
241 struct vop_device *vpdev = vdev->vpdev;
243 vpdev->hw_ops->send_intr(vpdev, vdev->c2h_vdev_db);
247 static void vop_del_vq(struct virtqueue *vq, int n)
249 struct _vop_vdev *vdev = to_vopvdev(vq->vdev);
250 struct vring *vr = (struct vring *)(vq + 1);
251 struct vop_device *vpdev = vdev->vpdev;
253 dma_unmap_single(&vpdev->dev, vdev->used[n],
254 vdev->used_size[n], DMA_BIDIRECTIONAL);
255 free_pages((unsigned long)vr->used, get_order(vdev->used_size[n]));
256 vring_del_virtqueue(vq);
257 vpdev->hw_ops->iounmap(vpdev, vdev->vr[n]);
261 static void vop_del_vqs(struct virtio_device *dev)
263 struct _vop_vdev *vdev = to_vopvdev(dev);
264 struct virtqueue *vq, *n;
267 dev_dbg(_vop_dev(vdev), "%s\n", __func__);
269 list_for_each_entry_safe(vq, n, &dev->vqs, list)
270 vop_del_vq(vq, idx++);
274 * This routine will assign vring's allocated in host/io memory. Code in
275 * virtio_ring.c however continues to access this io memory as if it were local
276 * memory without io accessors.
278 static struct virtqueue *vop_find_vq(struct virtio_device *dev,
280 void (*callback)(struct virtqueue *vq),
281 const char *name, bool ctx)
283 struct _vop_vdev *vdev = to_vopvdev(dev);
284 struct vop_device *vpdev = vdev->vpdev;
285 struct mic_vqconfig __iomem *vqconfig;
286 struct mic_vqconfig config;
287 struct virtqueue *vq;
289 struct _mic_vring_info __iomem *info;
291 int vr_size, _vr_size, err, magic;
293 u8 type = ioread8(&vdev->desc->type);
295 if (index >= ioread8(&vdev->desc->num_vq))
296 return ERR_PTR(-ENOENT);
299 return ERR_PTR(-ENOENT);
301 /* First assign the vring's allocated in host memory */
302 vqconfig = _vop_vq_config(vdev->desc) + index;
303 memcpy_fromio(&config, vqconfig, sizeof(config));
304 _vr_size = vring_size(le16_to_cpu(config.num), MIC_VIRTIO_RING_ALIGN);
305 vr_size = PAGE_ALIGN(_vr_size + sizeof(struct _mic_vring_info));
306 va = vpdev->hw_ops->ioremap(vpdev, le64_to_cpu(config.address),
309 return ERR_PTR(-ENOMEM);
310 vdev->vr[index] = va;
311 memset_io(va, 0x0, _vr_size);
312 vq = vring_new_virtqueue(
314 le16_to_cpu(config.num), MIC_VIRTIO_RING_ALIGN,
318 (void __force *)va, vop_notify, callback, name);
323 info = va + _vr_size;
324 magic = ioread32(&info->magic);
326 if (WARN(magic != MIC_MAGIC + type + index, "magic mismatch")) {
331 /* Allocate and reassign used ring now */
332 vdev->used_size[index] = PAGE_ALIGN(sizeof(__u16) * 3 +
333 sizeof(struct vring_used_elem) *
334 le16_to_cpu(config.num));
335 used = (void *)__get_free_pages(GFP_KERNEL | __GFP_ZERO,
336 get_order(vdev->used_size[index]));
339 dev_err(_vop_dev(vdev), "%s %d err %d\n",
340 __func__, __LINE__, err);
343 vdev->used[index] = dma_map_single(&vpdev->dev, used,
344 vdev->used_size[index],
346 if (dma_mapping_error(&vpdev->dev, vdev->used[index])) {
348 dev_err(_vop_dev(vdev), "%s %d err %d\n",
349 __func__, __LINE__, err);
352 writeq(vdev->used[index], &vqconfig->used_address);
354 * To reassign the used ring here we are directly accessing
355 * struct vring_virtqueue which is a private data structure
356 * in virtio_ring.c. At the minimum, a BUILD_BUG_ON() in
357 * vring_new_virtqueue() would ensure that
358 * (&vq->vring == (struct vring *) (&vq->vq + 1));
360 vr = (struct vring *)(vq + 1);
366 free_pages((unsigned long)used,
367 get_order(vdev->used_size[index]));
369 vring_del_virtqueue(vq);
371 vpdev->hw_ops->iounmap(vpdev, vdev->vr[index]);
375 static int vop_find_vqs(struct virtio_device *dev, unsigned nvqs,
376 struct virtqueue *vqs[],
377 vq_callback_t *callbacks[],
378 const char * const names[], const bool *ctx,
379 struct irq_affinity *desc)
381 struct _vop_vdev *vdev = to_vopvdev(dev);
382 struct vop_device *vpdev = vdev->vpdev;
383 struct mic_device_ctrl __iomem *dc = vdev->dc;
386 /* We must have this many virtqueues. */
387 if (nvqs > ioread8(&vdev->desc->num_vq))
390 for (i = 0; i < nvqs; ++i) {
391 dev_dbg(_vop_dev(vdev), "%s: %d: %s\n",
392 __func__, i, names[i]);
393 vqs[i] = vop_find_vq(dev, i, callbacks[i], names[i],
394 ctx ? ctx[i] : false);
395 if (IS_ERR(vqs[i])) {
396 err = PTR_ERR(vqs[i]);
401 iowrite8(1, &dc->used_address_updated);
403 * Send an interrupt to the host to inform it that used
404 * rings have been re-assigned.
406 vpdev->hw_ops->send_intr(vpdev, vdev->c2h_vdev_db);
407 for (retry = 100; --retry;) {
408 if (!ioread8(&dc->used_address_updated))
413 dev_dbg(_vop_dev(vdev), "%s: retry: %d\n", __func__, retry);
426 * The config ops structure as defined by virtio config
428 static struct virtio_config_ops vop_vq_config_ops = {
429 .get_features = vop_get_features,
430 .finalize_features = vop_finalize_features,
433 .get_status = vop_get_status,
434 .set_status = vop_set_status,
436 .find_vqs = vop_find_vqs,
437 .del_vqs = vop_del_vqs,
440 static irqreturn_t vop_virtio_intr_handler(int irq, void *data)
442 struct _vop_vdev *vdev = data;
443 struct vop_device *vpdev = vdev->vpdev;
444 struct virtqueue *vq;
446 vpdev->hw_ops->ack_interrupt(vpdev, vdev->h2c_vdev_db);
447 list_for_each_entry(vq, &vdev->vdev.vqs, list)
448 vring_interrupt(0, vq);
453 static void vop_virtio_release_dev(struct device *_d)
455 struct virtio_device *vdev =
456 container_of(_d, struct virtio_device, dev);
457 struct _vop_vdev *vop_vdev =
458 container_of(vdev, struct _vop_vdev, vdev);
464 * adds a new device and register it with virtio
465 * appropriate drivers are loaded by the device model
467 static int _vop_add_device(struct mic_device_desc __iomem *d,
468 unsigned int offset, struct vop_device *vpdev,
471 struct _vop_vdev *vdev, *reg_dev = NULL;
473 u8 type = ioread8(&d->type);
475 vdev = kzalloc(sizeof(*vdev), GFP_KERNEL);
480 vdev->vdev.dev.parent = &vpdev->dev;
481 vdev->vdev.dev.release = vop_virtio_release_dev;
482 vdev->vdev.id.device = type;
483 vdev->vdev.config = &vop_vq_config_ops;
485 vdev->dc = (void __iomem *)d + _vop_aligned_desc_size(d);
487 vdev->vdev.priv = (void *)(u64)dnode;
488 init_completion(&vdev->reset_done);
490 vdev->h2c_vdev_db = vpdev->hw_ops->next_db(vpdev);
491 vdev->virtio_cookie = vpdev->hw_ops->request_irq(vpdev,
492 vop_virtio_intr_handler, "virtio intr",
493 vdev, vdev->h2c_vdev_db);
494 if (IS_ERR(vdev->virtio_cookie)) {
495 ret = PTR_ERR(vdev->virtio_cookie);
498 iowrite8((u8)vdev->h2c_vdev_db, &vdev->dc->h2c_vdev_db);
499 vdev->c2h_vdev_db = ioread8(&vdev->dc->c2h_vdev_db);
501 ret = register_virtio_device(&vdev->vdev);
504 dev_err(_vop_dev(vdev),
505 "Failed to register vop device %u type %u\n",
509 writeq((u64)vdev, &vdev->dc->vdev);
510 dev_dbg(_vop_dev(vdev), "%s: registered vop device %u type %u vdev %p\n",
511 __func__, offset, type, vdev);
516 vpdev->hw_ops->free_irq(vpdev, vdev->virtio_cookie, vdev);
519 put_device(&vdev->vdev.dev);
526 * match for a vop device with a specific desc pointer
528 static int vop_match_desc(struct device *dev, void *data)
530 struct virtio_device *_dev = dev_to_virtio(dev);
531 struct _vop_vdev *vdev = to_vopvdev(_dev);
533 return vdev->desc == (void __iomem *)data;
536 static void _vop_handle_config_change(struct mic_device_desc __iomem *d,
538 struct vop_device *vpdev)
540 struct mic_device_ctrl __iomem *dc
541 = (void __iomem *)d + _vop_aligned_desc_size(d);
542 struct _vop_vdev *vdev = (struct _vop_vdev *)readq(&dc->vdev);
544 if (ioread8(&dc->config_change) != MIC_VIRTIO_PARAM_CONFIG_CHANGED)
547 dev_dbg(&vpdev->dev, "%s %d\n", __func__, __LINE__);
548 virtio_config_changed(&vdev->vdev);
549 iowrite8(1, &dc->guest_ack);
553 * removes a virtio device if a hot remove event has been
554 * requested by the host.
556 static int _vop_remove_device(struct mic_device_desc __iomem *d,
557 unsigned int offset, struct vop_device *vpdev)
559 struct mic_device_ctrl __iomem *dc
560 = (void __iomem *)d + _vop_aligned_desc_size(d);
561 struct _vop_vdev *vdev = (struct _vop_vdev *)readq(&dc->vdev);
565 if (ioread8(&dc->config_change) == MIC_VIRTIO_PARAM_DEV_REMOVE) {
567 "%s %d config_change %d type %d vdev %p\n",
569 ioread8(&dc->config_change), ioread8(&d->type), vdev);
570 status = ioread8(&d->status);
571 reinit_completion(&vdev->reset_done);
572 unregister_virtio_device(&vdev->vdev);
573 vpdev->hw_ops->free_irq(vpdev, vdev->virtio_cookie, vdev);
574 iowrite8(-1, &dc->h2c_vdev_db);
575 if (status & VIRTIO_CONFIG_S_DRIVER_OK)
576 wait_for_completion(&vdev->reset_done);
577 put_device(&vdev->vdev.dev);
578 iowrite8(1, &dc->guest_ack);
579 dev_dbg(&vpdev->dev, "%s %d guest_ack %d\n",
580 __func__, __LINE__, ioread8(&dc->guest_ack));
581 iowrite8(-1, &d->type);
587 #define REMOVE_DEVICES true
589 static void _vop_scan_devices(void __iomem *dp, struct vop_device *vpdev,
590 bool remove, int dnode)
594 struct mic_device_desc __iomem *d;
595 struct mic_device_ctrl __iomem *dc;
599 for (i = sizeof(struct mic_bootparam);
600 i < MIC_DP_SIZE; i += _vop_total_desc_size(d)) {
602 dc = (void __iomem *)d + _vop_aligned_desc_size(d);
604 * This read barrier is paired with the corresponding write
605 * barrier on the host which is inserted before adding or
606 * removing a virtio device descriptor, by updating the type.
609 type = ioread8(&d->type);
618 /* device already exists */
619 dev = device_find_child(&vpdev->dev, (void __force *)d,
623 iowrite8(MIC_VIRTIO_PARAM_DEV_REMOVE,
626 _vop_handle_config_change(d, i, vpdev);
627 ret = _vop_remove_device(d, i, vpdev);
629 iowrite8(0, &dc->config_change);
630 iowrite8(0, &dc->guest_ack);
636 dev_dbg(&vpdev->dev, "%s %d Adding new virtio device %p\n",
637 __func__, __LINE__, d);
639 _vop_add_device(d, i, vpdev, dnode);
643 static void vop_scan_devices(struct vop_info *vi,
644 struct vop_device *vpdev, bool remove)
646 void __iomem *dp = vpdev->hw_ops->get_remote_dp(vpdev);
650 mutex_lock(&vi->vop_mutex);
651 _vop_scan_devices(dp, vpdev, remove, vpdev->dnode);
652 mutex_unlock(&vi->vop_mutex);
656 * vop_hotplug_device tries to find changes in the device page.
658 static void vop_hotplug_devices(struct work_struct *work)
660 struct vop_info *vi = container_of(work, struct vop_info,
663 vop_scan_devices(vi, vi->vpdev, !REMOVE_DEVICES);
667 * Interrupt handler for hot plug/config changes etc.
669 static irqreturn_t vop_extint_handler(int irq, void *data)
671 struct vop_info *vi = data;
672 struct mic_bootparam __iomem *bp;
673 struct vop_device *vpdev = vi->vpdev;
675 bp = vpdev->hw_ops->get_remote_dp(vpdev);
676 dev_dbg(&vpdev->dev, "%s %d hotplug work\n",
678 vpdev->hw_ops->ack_interrupt(vpdev, ioread8(&bp->h2c_config_db));
679 schedule_work(&vi->hotplug_work);
683 static int vop_driver_probe(struct vop_device *vpdev)
688 vi = kzalloc(sizeof(*vi), GFP_KERNEL);
693 dev_set_drvdata(&vpdev->dev, vi);
696 mutex_init(&vi->vop_mutex);
697 INIT_WORK(&vi->hotplug_work, vop_hotplug_devices);
699 rc = vop_host_init(vi);
703 struct mic_bootparam __iomem *bootparam;
705 vop_scan_devices(vi, vpdev, !REMOVE_DEVICES);
707 vi->h2c_config_db = vpdev->hw_ops->next_db(vpdev);
708 vi->cookie = vpdev->hw_ops->request_irq(vpdev,
710 "virtio_config_intr",
711 vi, vi->h2c_config_db);
712 if (IS_ERR(vi->cookie)) {
713 rc = PTR_ERR(vi->cookie);
716 bootparam = vpdev->hw_ops->get_remote_dp(vpdev);
717 iowrite8(vi->h2c_config_db, &bootparam->h2c_config_db);
719 vop_init_debugfs(vi);
727 static void vop_driver_remove(struct vop_device *vpdev)
729 struct vop_info *vi = dev_get_drvdata(&vpdev->dev);
734 struct mic_bootparam __iomem *bootparam =
735 vpdev->hw_ops->get_remote_dp(vpdev);
737 iowrite8(-1, &bootparam->h2c_config_db);
738 vpdev->hw_ops->free_irq(vpdev, vi->cookie, vi);
739 flush_work(&vi->hotplug_work);
740 vop_scan_devices(vi, vpdev, REMOVE_DEVICES);
742 vop_exit_debugfs(vi);
746 static struct vop_device_id id_table[] = {
747 { VOP_DEV_TRNSP, VOP_DEV_ANY_ID },
751 static struct vop_driver vop_driver = {
752 .driver.name = KBUILD_MODNAME,
753 .driver.owner = THIS_MODULE,
754 .id_table = id_table,
755 .probe = vop_driver_probe,
756 .remove = vop_driver_remove,
759 module_vop_driver(vop_driver);
761 MODULE_DEVICE_TABLE(mbus, id_table);
762 MODULE_AUTHOR("Intel Corporation");
763 MODULE_DESCRIPTION("Intel(R) Virtio Over PCIe (VOP) driver");
764 MODULE_LICENSE("GPL v2");