1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55#define pr_fmt(fmt) "virtio-mmio: " fmt
56
57#include <linux/acpi.h>
58#include <linux/dma-mapping.h>
59#include <linux/highmem.h>
60#include <linux/interrupt.h>
61#include <linux/io.h>
62#include <linux/list.h>
63#include <linux/module.h>
64#include <linux/platform_device.h>
65#include <linux/slab.h>
66#include <linux/spinlock.h>
67#include <linux/virtio.h>
68#include <linux/virtio_config.h>
69#include <uapi/linux/virtio_mmio.h>
70#include <linux/virtio_ring.h>
71
72
73
74
75
76#define VIRTIO_MMIO_VRING_ALIGN PAGE_SIZE
77
78
79
80#define to_virtio_mmio_device(_plat_dev) \
81 container_of(_plat_dev, struct virtio_mmio_device, vdev)
82
83struct virtio_mmio_device {
84 struct virtio_device vdev;
85 struct platform_device *pdev;
86
87 void __iomem *base;
88 unsigned long version;
89
90
91 spinlock_t lock;
92 struct list_head virtqueues;
93};
94
95struct virtio_mmio_vq_info {
96
97 struct virtqueue *vq;
98
99
100 struct list_head node;
101};
102
103
104
105
106
107static u64 vm_get_features(struct virtio_device *vdev)
108{
109 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
110 u64 features;
111
112 writel(1, vm_dev->base + VIRTIO_MMIO_DEVICE_FEATURES_SEL);
113 features = readl(vm_dev->base + VIRTIO_MMIO_DEVICE_FEATURES);
114 features <<= 32;
115
116 writel(0, vm_dev->base + VIRTIO_MMIO_DEVICE_FEATURES_SEL);
117 features |= readl(vm_dev->base + VIRTIO_MMIO_DEVICE_FEATURES);
118
119 return features;
120}
121
122static int vm_finalize_features(struct virtio_device *vdev)
123{
124 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
125
126
127 vring_transport_features(vdev);
128
129
130 if (vm_dev->version == 2 &&
131 !__virtio_test_bit(vdev, VIRTIO_F_VERSION_1)) {
132 dev_err(&vdev->dev, "New virtio-mmio devices (version 2) must provide VIRTIO_F_VERSION_1 feature!\n");
133 return -EINVAL;
134 }
135
136 writel(1, vm_dev->base + VIRTIO_MMIO_DRIVER_FEATURES_SEL);
137 writel((u32)(vdev->features >> 32),
138 vm_dev->base + VIRTIO_MMIO_DRIVER_FEATURES);
139
140 writel(0, vm_dev->base + VIRTIO_MMIO_DRIVER_FEATURES_SEL);
141 writel((u32)vdev->features,
142 vm_dev->base + VIRTIO_MMIO_DRIVER_FEATURES);
143
144 return 0;
145}
146
147static void vm_get(struct virtio_device *vdev, unsigned offset,
148 void *buf, unsigned len)
149{
150 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
151 void __iomem *base = vm_dev->base + VIRTIO_MMIO_CONFIG;
152 u8 b;
153 __le16 w;
154 __le32 l;
155
156 if (vm_dev->version == 1) {
157 u8 *ptr = buf;
158 int i;
159
160 for (i = 0; i < len; i++)
161 ptr[i] = readb(base + offset + i);
162 return;
163 }
164
165 switch (len) {
166 case 1:
167 b = readb(base + offset);
168 memcpy(buf, &b, sizeof b);
169 break;
170 case 2:
171 w = cpu_to_le16(readw(base + offset));
172 memcpy(buf, &w, sizeof w);
173 break;
174 case 4:
175 l = cpu_to_le32(readl(base + offset));
176 memcpy(buf, &l, sizeof l);
177 break;
178 case 8:
179 l = cpu_to_le32(readl(base + offset));
180 memcpy(buf, &l, sizeof l);
181 l = cpu_to_le32(ioread32(base + offset + sizeof l));
182 memcpy(buf + sizeof l, &l, sizeof l);
183 break;
184 default:
185 BUG();
186 }
187}
188
189static void vm_set(struct virtio_device *vdev, unsigned offset,
190 const void *buf, unsigned len)
191{
192 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
193 void __iomem *base = vm_dev->base + VIRTIO_MMIO_CONFIG;
194 u8 b;
195 __le16 w;
196 __le32 l;
197
198 if (vm_dev->version == 1) {
199 const u8 *ptr = buf;
200 int i;
201
202 for (i = 0; i < len; i++)
203 writeb(ptr[i], base + offset + i);
204
205 return;
206 }
207
208 switch (len) {
209 case 1:
210 memcpy(&b, buf, sizeof b);
211 writeb(b, base + offset);
212 break;
213 case 2:
214 memcpy(&w, buf, sizeof w);
215 writew(le16_to_cpu(w), base + offset);
216 break;
217 case 4:
218 memcpy(&l, buf, sizeof l);
219 writel(le32_to_cpu(l), base + offset);
220 break;
221 case 8:
222 memcpy(&l, buf, sizeof l);
223 writel(le32_to_cpu(l), base + offset);
224 memcpy(&l, buf + sizeof l, sizeof l);
225 writel(le32_to_cpu(l), base + offset + sizeof l);
226 break;
227 default:
228 BUG();
229 }
230}
231
232static u32 vm_generation(struct virtio_device *vdev)
233{
234 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
235
236 if (vm_dev->version == 1)
237 return 0;
238 else
239 return readl(vm_dev->base + VIRTIO_MMIO_CONFIG_GENERATION);
240}
241
242static u8 vm_get_status(struct virtio_device *vdev)
243{
244 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
245
246 return readl(vm_dev->base + VIRTIO_MMIO_STATUS) & 0xff;
247}
248
249static void vm_set_status(struct virtio_device *vdev, u8 status)
250{
251 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
252
253
254 BUG_ON(status == 0);
255
256 writel(status, vm_dev->base + VIRTIO_MMIO_STATUS);
257}
258
259static void vm_reset(struct virtio_device *vdev)
260{
261 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
262
263
264 writel(0, vm_dev->base + VIRTIO_MMIO_STATUS);
265}
266
267
268
269
270
271
272static bool vm_notify(struct virtqueue *vq)
273{
274 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vq->vdev);
275
276
277
278 writel(vq->index, vm_dev->base + VIRTIO_MMIO_QUEUE_NOTIFY);
279 return true;
280}
281
282
283static irqreturn_t vm_interrupt(int irq, void *opaque)
284{
285 struct virtio_mmio_device *vm_dev = opaque;
286 struct virtio_mmio_vq_info *info;
287 unsigned long status;
288 unsigned long flags;
289 irqreturn_t ret = IRQ_NONE;
290
291
292 status = readl(vm_dev->base + VIRTIO_MMIO_INTERRUPT_STATUS);
293 writel(status, vm_dev->base + VIRTIO_MMIO_INTERRUPT_ACK);
294
295 if (unlikely(status & VIRTIO_MMIO_INT_CONFIG)) {
296 virtio_config_changed(&vm_dev->vdev);
297 ret = IRQ_HANDLED;
298 }
299
300 if (likely(status & VIRTIO_MMIO_INT_VRING)) {
301 spin_lock_irqsave(&vm_dev->lock, flags);
302 list_for_each_entry(info, &vm_dev->virtqueues, node)
303 ret |= vring_interrupt(irq, info->vq);
304 spin_unlock_irqrestore(&vm_dev->lock, flags);
305 }
306
307 return ret;
308}
309
310
311
312static void vm_del_vq(struct virtqueue *vq)
313{
314 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vq->vdev);
315 struct virtio_mmio_vq_info *info = vq->priv;
316 unsigned long flags;
317 unsigned int index = vq->index;
318
319 spin_lock_irqsave(&vm_dev->lock, flags);
320 list_del(&info->node);
321 spin_unlock_irqrestore(&vm_dev->lock, flags);
322
323
324 writel(index, vm_dev->base + VIRTIO_MMIO_QUEUE_SEL);
325 if (vm_dev->version == 1) {
326 writel(0, vm_dev->base + VIRTIO_MMIO_QUEUE_PFN);
327 } else {
328 writel(0, vm_dev->base + VIRTIO_MMIO_QUEUE_READY);
329 WARN_ON(readl(vm_dev->base + VIRTIO_MMIO_QUEUE_READY));
330 }
331
332 vring_del_virtqueue(vq);
333
334 kfree(info);
335}
336
337static void vm_del_vqs(struct virtio_device *vdev)
338{
339 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
340 struct virtqueue *vq, *n;
341
342 list_for_each_entry_safe(vq, n, &vdev->vqs, list)
343 vm_del_vq(vq);
344
345 free_irq(platform_get_irq(vm_dev->pdev, 0), vm_dev);
346}
347
348static struct virtqueue *vm_setup_vq(struct virtio_device *vdev, unsigned index,
349 void (*callback)(struct virtqueue *vq),
350 const char *name, bool ctx)
351{
352 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
353 struct virtio_mmio_vq_info *info;
354 struct virtqueue *vq;
355 unsigned long flags;
356 unsigned int num;
357 int err;
358
359 if (!name)
360 return NULL;
361
362
363 writel(index, vm_dev->base + VIRTIO_MMIO_QUEUE_SEL);
364
365
366 if (readl(vm_dev->base + (vm_dev->version == 1 ?
367 VIRTIO_MMIO_QUEUE_PFN : VIRTIO_MMIO_QUEUE_READY))) {
368 err = -ENOENT;
369 goto error_available;
370 }
371
372
373 info = kmalloc(sizeof(*info), GFP_KERNEL);
374 if (!info) {
375 err = -ENOMEM;
376 goto error_kmalloc;
377 }
378
379 num = readl(vm_dev->base + VIRTIO_MMIO_QUEUE_NUM_MAX);
380 if (num == 0) {
381 err = -ENOENT;
382 goto error_new_virtqueue;
383 }
384
385
386 vq = vring_create_virtqueue(index, num, VIRTIO_MMIO_VRING_ALIGN, vdev,
387 true, true, ctx, vm_notify, callback, name);
388 if (!vq) {
389 err = -ENOMEM;
390 goto error_new_virtqueue;
391 }
392
393
394 writel(virtqueue_get_vring_size(vq), vm_dev->base + VIRTIO_MMIO_QUEUE_NUM);
395 if (vm_dev->version == 1) {
396 u64 q_pfn = virtqueue_get_desc_addr(vq) >> PAGE_SHIFT;
397
398
399
400
401
402
403 if (q_pfn >> 32) {
404 dev_err(&vdev->dev,
405 "platform bug: legacy virtio-mmio must not be used with RAM above 0x%llxGB\n",
406 0x1ULL << (32 + PAGE_SHIFT - 30));
407 err = -E2BIG;
408 goto error_bad_pfn;
409 }
410
411 writel(PAGE_SIZE, vm_dev->base + VIRTIO_MMIO_QUEUE_ALIGN);
412 writel(q_pfn, vm_dev->base + VIRTIO_MMIO_QUEUE_PFN);
413 } else {
414 u64 addr;
415
416 addr = virtqueue_get_desc_addr(vq);
417 writel((u32)addr, vm_dev->base + VIRTIO_MMIO_QUEUE_DESC_LOW);
418 writel((u32)(addr >> 32),
419 vm_dev->base + VIRTIO_MMIO_QUEUE_DESC_HIGH);
420
421 addr = virtqueue_get_avail_addr(vq);
422 writel((u32)addr, vm_dev->base + VIRTIO_MMIO_QUEUE_AVAIL_LOW);
423 writel((u32)(addr >> 32),
424 vm_dev->base + VIRTIO_MMIO_QUEUE_AVAIL_HIGH);
425
426 addr = virtqueue_get_used_addr(vq);
427 writel((u32)addr, vm_dev->base + VIRTIO_MMIO_QUEUE_USED_LOW);
428 writel((u32)(addr >> 32),
429 vm_dev->base + VIRTIO_MMIO_QUEUE_USED_HIGH);
430
431 writel(1, vm_dev->base + VIRTIO_MMIO_QUEUE_READY);
432 }
433
434 vq->priv = info;
435 info->vq = vq;
436
437 spin_lock_irqsave(&vm_dev->lock, flags);
438 list_add(&info->node, &vm_dev->virtqueues);
439 spin_unlock_irqrestore(&vm_dev->lock, flags);
440
441 return vq;
442
443error_bad_pfn:
444 vring_del_virtqueue(vq);
445error_new_virtqueue:
446 if (vm_dev->version == 1) {
447 writel(0, vm_dev->base + VIRTIO_MMIO_QUEUE_PFN);
448 } else {
449 writel(0, vm_dev->base + VIRTIO_MMIO_QUEUE_READY);
450 WARN_ON(readl(vm_dev->base + VIRTIO_MMIO_QUEUE_READY));
451 }
452 kfree(info);
453error_kmalloc:
454error_available:
455 return ERR_PTR(err);
456}
457
458static int vm_find_vqs(struct virtio_device *vdev, unsigned nvqs,
459 struct virtqueue *vqs[],
460 vq_callback_t *callbacks[],
461 const char * const names[],
462 const bool *ctx,
463 struct irq_affinity *desc)
464{
465 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
466 int irq = platform_get_irq(vm_dev->pdev, 0);
467 int i, err, queue_idx = 0;
468
469 if (irq < 0) {
470 dev_err(&vdev->dev, "Cannot get IRQ resource\n");
471 return irq;
472 }
473
474 err = request_irq(irq, vm_interrupt, IRQF_SHARED,
475 dev_name(&vdev->dev), vm_dev);
476 if (err)
477 return err;
478
479 for (i = 0; i < nvqs; ++i) {
480 if (!names[i]) {
481 vqs[i] = NULL;
482 continue;
483 }
484
485 vqs[i] = vm_setup_vq(vdev, queue_idx++, callbacks[i], names[i],
486 ctx ? ctx[i] : false);
487 if (IS_ERR(vqs[i])) {
488 vm_del_vqs(vdev);
489 return PTR_ERR(vqs[i]);
490 }
491 }
492
493 return 0;
494}
495
496static const char *vm_bus_name(struct virtio_device *vdev)
497{
498 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
499
500 return vm_dev->pdev->name;
501}
502
503static const struct virtio_config_ops virtio_mmio_config_ops = {
504 .get = vm_get,
505 .set = vm_set,
506 .generation = vm_generation,
507 .get_status = vm_get_status,
508 .set_status = vm_set_status,
509 .reset = vm_reset,
510 .find_vqs = vm_find_vqs,
511 .del_vqs = vm_del_vqs,
512 .get_features = vm_get_features,
513 .finalize_features = vm_finalize_features,
514 .bus_name = vm_bus_name,
515};
516
517
518static void virtio_mmio_release_dev(struct device *_d)
519{
520 struct virtio_device *vdev =
521 container_of(_d, struct virtio_device, dev);
522 struct virtio_mmio_device *vm_dev =
523 container_of(vdev, struct virtio_mmio_device, vdev);
524 struct platform_device *pdev = vm_dev->pdev;
525
526 devm_kfree(&pdev->dev, vm_dev);
527}
528
529
530
531static int virtio_mmio_probe(struct platform_device *pdev)
532{
533 struct virtio_mmio_device *vm_dev;
534 unsigned long magic;
535 int rc;
536
537 vm_dev = devm_kzalloc(&pdev->dev, sizeof(*vm_dev), GFP_KERNEL);
538 if (!vm_dev)
539 return -ENOMEM;
540
541 vm_dev->vdev.dev.parent = &pdev->dev;
542 vm_dev->vdev.dev.release = virtio_mmio_release_dev;
543 vm_dev->vdev.config = &virtio_mmio_config_ops;
544 vm_dev->pdev = pdev;
545 INIT_LIST_HEAD(&vm_dev->virtqueues);
546 spin_lock_init(&vm_dev->lock);
547
548 vm_dev->base = devm_platform_ioremap_resource(pdev, 0);
549 if (IS_ERR(vm_dev->base))
550 return PTR_ERR(vm_dev->base);
551
552
553 magic = readl(vm_dev->base + VIRTIO_MMIO_MAGIC_VALUE);
554 if (magic != ('v' | 'i' << 8 | 'r' << 16 | 't' << 24)) {
555 dev_warn(&pdev->dev, "Wrong magic value 0x%08lx!\n", magic);
556 return -ENODEV;
557 }
558
559
560 vm_dev->version = readl(vm_dev->base + VIRTIO_MMIO_VERSION);
561 if (vm_dev->version < 1 || vm_dev->version > 2) {
562 dev_err(&pdev->dev, "Version %ld not supported!\n",
563 vm_dev->version);
564 return -ENXIO;
565 }
566
567 vm_dev->vdev.id.device = readl(vm_dev->base + VIRTIO_MMIO_DEVICE_ID);
568 if (vm_dev->vdev.id.device == 0) {
569
570
571
572
573 return -ENODEV;
574 }
575 vm_dev->vdev.id.vendor = readl(vm_dev->base + VIRTIO_MMIO_VENDOR_ID);
576
577 if (vm_dev->version == 1) {
578 writel(PAGE_SIZE, vm_dev->base + VIRTIO_MMIO_GUEST_PAGE_SIZE);
579
580 rc = dma_set_mask(&pdev->dev, DMA_BIT_MASK(64));
581
582
583
584
585 if (!rc)
586 dma_set_coherent_mask(&pdev->dev,
587 DMA_BIT_MASK(32 + PAGE_SHIFT));
588 } else {
589 rc = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(64));
590 }
591 if (rc)
592 rc = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
593 if (rc)
594 dev_warn(&pdev->dev, "Failed to enable 64-bit or 32-bit DMA. Trying to continue, but this might not work.\n");
595
596 platform_set_drvdata(pdev, vm_dev);
597
598 rc = register_virtio_device(&vm_dev->vdev);
599 if (rc)
600 put_device(&vm_dev->vdev.dev);
601
602 return rc;
603}
604
605static int virtio_mmio_remove(struct platform_device *pdev)
606{
607 struct virtio_mmio_device *vm_dev = platform_get_drvdata(pdev);
608 unregister_virtio_device(&vm_dev->vdev);
609
610 return 0;
611}
612
613
614
615
616
617#if defined(CONFIG_VIRTIO_MMIO_CMDLINE_DEVICES)
618
619static struct device vm_cmdline_parent = {
620 .init_name = "virtio-mmio-cmdline",
621};
622
623static int vm_cmdline_parent_registered;
624static int vm_cmdline_id;
625
626static int vm_cmdline_set(const char *device,
627 const struct kernel_param *kp)
628{
629 int err;
630 struct resource resources[2] = {};
631 char *str;
632 long long int base, size;
633 unsigned int irq;
634 int processed, consumed = 0;
635 struct platform_device *pdev;
636
637
638 size = memparse(device, &str);
639
640
641 processed = sscanf(str, "@%lli:%u%n:%d%n",
642 &base, &irq, &consumed,
643 &vm_cmdline_id, &consumed);
644
645
646
647
648
649
650 if (processed < 2 || str[consumed])
651 return -EINVAL;
652
653 resources[0].flags = IORESOURCE_MEM;
654 resources[0].start = base;
655 resources[0].end = base + size - 1;
656
657 resources[1].flags = IORESOURCE_IRQ;
658 resources[1].start = resources[1].end = irq;
659
660 if (!vm_cmdline_parent_registered) {
661 err = device_register(&vm_cmdline_parent);
662 if (err) {
663 pr_err("Failed to register parent device!\n");
664 return err;
665 }
666 vm_cmdline_parent_registered = 1;
667 }
668
669 pr_info("Registering device virtio-mmio.%d at 0x%llx-0x%llx, IRQ %d.\n",
670 vm_cmdline_id,
671 (unsigned long long)resources[0].start,
672 (unsigned long long)resources[0].end,
673 (int)resources[1].start);
674
675 pdev = platform_device_register_resndata(&vm_cmdline_parent,
676 "virtio-mmio", vm_cmdline_id++,
677 resources, ARRAY_SIZE(resources), NULL, 0);
678
679 return PTR_ERR_OR_ZERO(pdev);
680}
681
682static int vm_cmdline_get_device(struct device *dev, void *data)
683{
684 char *buffer = data;
685 unsigned int len = strlen(buffer);
686 struct platform_device *pdev = to_platform_device(dev);
687
688 snprintf(buffer + len, PAGE_SIZE - len, "0x%llx@0x%llx:%llu:%d\n",
689 pdev->resource[0].end - pdev->resource[0].start + 1ULL,
690 (unsigned long long)pdev->resource[0].start,
691 (unsigned long long)pdev->resource[1].start,
692 pdev->id);
693 return 0;
694}
695
696static int vm_cmdline_get(char *buffer, const struct kernel_param *kp)
697{
698 buffer[0] = '\0';
699 device_for_each_child(&vm_cmdline_parent, buffer,
700 vm_cmdline_get_device);
701 return strlen(buffer) + 1;
702}
703
704static const struct kernel_param_ops vm_cmdline_param_ops = {
705 .set = vm_cmdline_set,
706 .get = vm_cmdline_get,
707};
708
709device_param_cb(device, &vm_cmdline_param_ops, NULL, S_IRUSR);
710
711static int vm_unregister_cmdline_device(struct device *dev,
712 void *data)
713{
714 platform_device_unregister(to_platform_device(dev));
715
716 return 0;
717}
718
719static void vm_unregister_cmdline_devices(void)
720{
721 if (vm_cmdline_parent_registered) {
722 device_for_each_child(&vm_cmdline_parent, NULL,
723 vm_unregister_cmdline_device);
724 device_unregister(&vm_cmdline_parent);
725 vm_cmdline_parent_registered = 0;
726 }
727}
728
729#else
730
731static void vm_unregister_cmdline_devices(void)
732{
733}
734
735#endif
736
737
738
739static const struct of_device_id virtio_mmio_match[] = {
740 { .compatible = "virtio,mmio", },
741 {},
742};
743MODULE_DEVICE_TABLE(of, virtio_mmio_match);
744
745#ifdef CONFIG_ACPI
746static const struct acpi_device_id virtio_mmio_acpi_match[] = {
747 { "LNRO0005", },
748 { }
749};
750MODULE_DEVICE_TABLE(acpi, virtio_mmio_acpi_match);
751#endif
752
753static struct platform_driver virtio_mmio_driver = {
754 .probe = virtio_mmio_probe,
755 .remove = virtio_mmio_remove,
756 .driver = {
757 .name = "virtio-mmio",
758 .of_match_table = virtio_mmio_match,
759 .acpi_match_table = ACPI_PTR(virtio_mmio_acpi_match),
760 },
761};
762
763static int __init virtio_mmio_init(void)
764{
765 return platform_driver_register(&virtio_mmio_driver);
766}
767
768static void __exit virtio_mmio_exit(void)
769{
770 platform_driver_unregister(&virtio_mmio_driver);
771 vm_unregister_cmdline_devices();
772}
773
774module_init(virtio_mmio_init);
775module_exit(virtio_mmio_exit);
776
777MODULE_AUTHOR("Pawel Moll <pawel.moll@arm.com>");
778MODULE_DESCRIPTION("Platform bus driver for memory mapped virtio devices");
779MODULE_LICENSE("GPL");
780