Loading...
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * Virtio memory mapped device driver
4 *
5 * Copyright 2011-2014, ARM Ltd.
6 *
7 * This module allows virtio devices to be used over a virtual, memory mapped
8 * platform device.
9 *
10 * The guest device(s) may be instantiated in one of three equivalent ways:
11 *
12 * 1. Static platform device in board's code, eg.:
13 *
14 * static struct platform_device v2m_virtio_device = {
15 * .name = "virtio-mmio",
16 * .id = -1,
17 * .num_resources = 2,
18 * .resource = (struct resource []) {
19 * {
20 * .start = 0x1001e000,
21 * .end = 0x1001e0ff,
22 * .flags = IORESOURCE_MEM,
23 * }, {
24 * .start = 42 + 32,
25 * .end = 42 + 32,
26 * .flags = IORESOURCE_IRQ,
27 * },
28 * }
29 * };
30 *
31 * 2. Device Tree node, eg.:
32 *
33 * virtio_block@1e000 {
34 * compatible = "virtio,mmio";
35 * reg = <0x1e000 0x100>;
36 * interrupts = <42>;
37 * }
38 *
39 * 3. Kernel module (or command line) parameter. Can be used more than once -
40 * one device will be created for each one. Syntax:
41 *
42 * [virtio_mmio.]device=<size>@<baseaddr>:<irq>[:<id>]
43 * where:
44 * <size> := size (can use standard suffixes like K, M or G)
45 * <baseaddr> := physical base address
46 * <irq> := interrupt number (as passed to request_irq())
47 * <id> := (optional) platform device id
48 * eg.:
49 * virtio_mmio.device=0x100@0x100b0000:48 \
50 * virtio_mmio.device=1K@0x1001e000:74
51 *
52 * Based on Virtio PCI driver by Anthony Liguori, copyright IBM Corp. 2007
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/* The alignment to use between consumer and producer parts of vring.
75 * Currently hardcoded to the page size. */
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 /* a list of queues so we can dispatch IRQs */
91 spinlock_t lock;
92 struct list_head virtqueues;
93};
94
95struct virtio_mmio_vq_info {
96 /* the actual virtqueue */
97 struct virtqueue *vq;
98
99 /* the list node for the virtqueues list */
100 struct list_head node;
101};
102
103
104
105/* Configuration interface */
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 /* Give virtio_ring a chance to accept features. */
127 vring_transport_features(vdev);
128
129 /* Make sure there is are no mixed devices */
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 /* We should never be setting status to 0. */
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 /* 0 status means a reset. */
264 writel(0, vm_dev->base + VIRTIO_MMIO_STATUS);
265}
266
267
268
269/* Transport interface */
270
271/* the notify function used when creating a virt queue */
272static bool vm_notify(struct virtqueue *vq)
273{
274 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vq->vdev);
275
276 /* We write the queue's selector into the notification register to
277 * signal the other end */
278 writel(vq->index, vm_dev->base + VIRTIO_MMIO_QUEUE_NOTIFY);
279 return true;
280}
281
282/* Notify all virtqueues on an interrupt. */
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 /* Read and acknowledge interrupts */
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 /* Select and deactivate the queue */
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 /* Select the queue we're interested in */
363 writel(index, vm_dev->base + VIRTIO_MMIO_QUEUE_SEL);
364
365 /* Queue shouldn't already be set up. */
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 /* Allocate and fill out our active queue description */
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 /* Create the vring */
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 /* Activate the queue */
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 * virtio-mmio v1 uses a 32bit QUEUE PFN. If we have something
400 * that doesn't fit in 32bit, fail the setup rather than
401 * pretending to be successful.
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 return irq;
471
472 err = request_irq(irq, vm_interrupt, IRQF_SHARED,
473 dev_name(&vdev->dev), vm_dev);
474 if (err)
475 return err;
476
477 for (i = 0; i < nvqs; ++i) {
478 if (!names[i]) {
479 vqs[i] = NULL;
480 continue;
481 }
482
483 vqs[i] = vm_setup_vq(vdev, queue_idx++, callbacks[i], names[i],
484 ctx ? ctx[i] : false);
485 if (IS_ERR(vqs[i])) {
486 vm_del_vqs(vdev);
487 return PTR_ERR(vqs[i]);
488 }
489 }
490
491 return 0;
492}
493
494static const char *vm_bus_name(struct virtio_device *vdev)
495{
496 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
497
498 return vm_dev->pdev->name;
499}
500
501static const struct virtio_config_ops virtio_mmio_config_ops = {
502 .get = vm_get,
503 .set = vm_set,
504 .generation = vm_generation,
505 .get_status = vm_get_status,
506 .set_status = vm_set_status,
507 .reset = vm_reset,
508 .find_vqs = vm_find_vqs,
509 .del_vqs = vm_del_vqs,
510 .get_features = vm_get_features,
511 .finalize_features = vm_finalize_features,
512 .bus_name = vm_bus_name,
513};
514
515
516static void virtio_mmio_release_dev(struct device *_d)
517{
518 struct virtio_device *vdev =
519 container_of(_d, struct virtio_device, dev);
520 struct virtio_mmio_device *vm_dev =
521 container_of(vdev, struct virtio_mmio_device, vdev);
522 struct platform_device *pdev = vm_dev->pdev;
523
524 devm_kfree(&pdev->dev, vm_dev);
525}
526
527/* Platform device */
528
529static int virtio_mmio_probe(struct platform_device *pdev)
530{
531 struct virtio_mmio_device *vm_dev;
532 unsigned long magic;
533 int rc;
534
535 vm_dev = devm_kzalloc(&pdev->dev, sizeof(*vm_dev), GFP_KERNEL);
536 if (!vm_dev)
537 return -ENOMEM;
538
539 vm_dev->vdev.dev.parent = &pdev->dev;
540 vm_dev->vdev.dev.release = virtio_mmio_release_dev;
541 vm_dev->vdev.config = &virtio_mmio_config_ops;
542 vm_dev->pdev = pdev;
543 INIT_LIST_HEAD(&vm_dev->virtqueues);
544 spin_lock_init(&vm_dev->lock);
545
546 vm_dev->base = devm_platform_ioremap_resource(pdev, 0);
547 if (IS_ERR(vm_dev->base))
548 return PTR_ERR(vm_dev->base);
549
550 /* Check magic value */
551 magic = readl(vm_dev->base + VIRTIO_MMIO_MAGIC_VALUE);
552 if (magic != ('v' | 'i' << 8 | 'r' << 16 | 't' << 24)) {
553 dev_warn(&pdev->dev, "Wrong magic value 0x%08lx!\n", magic);
554 return -ENODEV;
555 }
556
557 /* Check device version */
558 vm_dev->version = readl(vm_dev->base + VIRTIO_MMIO_VERSION);
559 if (vm_dev->version < 1 || vm_dev->version > 2) {
560 dev_err(&pdev->dev, "Version %ld not supported!\n",
561 vm_dev->version);
562 return -ENXIO;
563 }
564
565 vm_dev->vdev.id.device = readl(vm_dev->base + VIRTIO_MMIO_DEVICE_ID);
566 if (vm_dev->vdev.id.device == 0) {
567 /*
568 * virtio-mmio device with an ID 0 is a (dummy) placeholder
569 * with no function. End probing now with no error reported.
570 */
571 return -ENODEV;
572 }
573 vm_dev->vdev.id.vendor = readl(vm_dev->base + VIRTIO_MMIO_VENDOR_ID);
574
575 if (vm_dev->version == 1) {
576 writel(PAGE_SIZE, vm_dev->base + VIRTIO_MMIO_GUEST_PAGE_SIZE);
577
578 rc = dma_set_mask(&pdev->dev, DMA_BIT_MASK(64));
579 /*
580 * In the legacy case, ensure our coherently-allocated virtio
581 * ring will be at an address expressable as a 32-bit PFN.
582 */
583 if (!rc)
584 dma_set_coherent_mask(&pdev->dev,
585 DMA_BIT_MASK(32 + PAGE_SHIFT));
586 } else {
587 rc = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(64));
588 }
589 if (rc)
590 rc = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
591 if (rc)
592 dev_warn(&pdev->dev, "Failed to enable 64-bit or 32-bit DMA. Trying to continue, but this might not work.\n");
593
594 platform_set_drvdata(pdev, vm_dev);
595
596 rc = register_virtio_device(&vm_dev->vdev);
597 if (rc)
598 put_device(&vm_dev->vdev.dev);
599
600 return rc;
601}
602
603static int virtio_mmio_remove(struct platform_device *pdev)
604{
605 struct virtio_mmio_device *vm_dev = platform_get_drvdata(pdev);
606 unregister_virtio_device(&vm_dev->vdev);
607
608 return 0;
609}
610
611
612
613/* Devices list parameter */
614
615#if defined(CONFIG_VIRTIO_MMIO_CMDLINE_DEVICES)
616
617static struct device vm_cmdline_parent = {
618 .init_name = "virtio-mmio-cmdline",
619};
620
621static int vm_cmdline_parent_registered;
622static int vm_cmdline_id;
623
624static int vm_cmdline_set(const char *device,
625 const struct kernel_param *kp)
626{
627 int err;
628 struct resource resources[2] = {};
629 char *str;
630 long long int base, size;
631 unsigned int irq;
632 int processed, consumed = 0;
633 struct platform_device *pdev;
634
635 /* Consume "size" part of the command line parameter */
636 size = memparse(device, &str);
637
638 /* Get "@<base>:<irq>[:<id>]" chunks */
639 processed = sscanf(str, "@%lli:%u%n:%d%n",
640 &base, &irq, &consumed,
641 &vm_cmdline_id, &consumed);
642
643 /*
644 * sscanf() must process at least 2 chunks; also there
645 * must be no extra characters after the last chunk, so
646 * str[consumed] must be '\0'
647 */
648 if (processed < 2 || str[consumed] || irq == 0)
649 return -EINVAL;
650
651 resources[0].flags = IORESOURCE_MEM;
652 resources[0].start = base;
653 resources[0].end = base + size - 1;
654
655 resources[1].flags = IORESOURCE_IRQ;
656 resources[1].start = resources[1].end = irq;
657
658 if (!vm_cmdline_parent_registered) {
659 err = device_register(&vm_cmdline_parent);
660 if (err) {
661 pr_err("Failed to register parent device!\n");
662 return err;
663 }
664 vm_cmdline_parent_registered = 1;
665 }
666
667 pr_info("Registering device virtio-mmio.%d at 0x%llx-0x%llx, IRQ %d.\n",
668 vm_cmdline_id,
669 (unsigned long long)resources[0].start,
670 (unsigned long long)resources[0].end,
671 (int)resources[1].start);
672
673 pdev = platform_device_register_resndata(&vm_cmdline_parent,
674 "virtio-mmio", vm_cmdline_id++,
675 resources, ARRAY_SIZE(resources), NULL, 0);
676
677 return PTR_ERR_OR_ZERO(pdev);
678}
679
680static int vm_cmdline_get_device(struct device *dev, void *data)
681{
682 char *buffer = data;
683 unsigned int len = strlen(buffer);
684 struct platform_device *pdev = to_platform_device(dev);
685
686 snprintf(buffer + len, PAGE_SIZE - len, "0x%llx@0x%llx:%llu:%d\n",
687 pdev->resource[0].end - pdev->resource[0].start + 1ULL,
688 (unsigned long long)pdev->resource[0].start,
689 (unsigned long long)pdev->resource[1].start,
690 pdev->id);
691 return 0;
692}
693
694static int vm_cmdline_get(char *buffer, const struct kernel_param *kp)
695{
696 buffer[0] = '\0';
697 device_for_each_child(&vm_cmdline_parent, buffer,
698 vm_cmdline_get_device);
699 return strlen(buffer) + 1;
700}
701
702static const struct kernel_param_ops vm_cmdline_param_ops = {
703 .set = vm_cmdline_set,
704 .get = vm_cmdline_get,
705};
706
707device_param_cb(device, &vm_cmdline_param_ops, NULL, S_IRUSR);
708
709static int vm_unregister_cmdline_device(struct device *dev,
710 void *data)
711{
712 platform_device_unregister(to_platform_device(dev));
713
714 return 0;
715}
716
717static void vm_unregister_cmdline_devices(void)
718{
719 if (vm_cmdline_parent_registered) {
720 device_for_each_child(&vm_cmdline_parent, NULL,
721 vm_unregister_cmdline_device);
722 device_unregister(&vm_cmdline_parent);
723 vm_cmdline_parent_registered = 0;
724 }
725}
726
727#else
728
729static void vm_unregister_cmdline_devices(void)
730{
731}
732
733#endif
734
735/* Platform driver */
736
737static const struct of_device_id virtio_mmio_match[] = {
738 { .compatible = "virtio,mmio", },
739 {},
740};
741MODULE_DEVICE_TABLE(of, virtio_mmio_match);
742
743#ifdef CONFIG_ACPI
744static const struct acpi_device_id virtio_mmio_acpi_match[] = {
745 { "LNRO0005", },
746 { }
747};
748MODULE_DEVICE_TABLE(acpi, virtio_mmio_acpi_match);
749#endif
750
751static struct platform_driver virtio_mmio_driver = {
752 .probe = virtio_mmio_probe,
753 .remove = virtio_mmio_remove,
754 .driver = {
755 .name = "virtio-mmio",
756 .of_match_table = virtio_mmio_match,
757 .acpi_match_table = ACPI_PTR(virtio_mmio_acpi_match),
758 },
759};
760
761static int __init virtio_mmio_init(void)
762{
763 return platform_driver_register(&virtio_mmio_driver);
764}
765
766static void __exit virtio_mmio_exit(void)
767{
768 platform_driver_unregister(&virtio_mmio_driver);
769 vm_unregister_cmdline_devices();
770}
771
772module_init(virtio_mmio_init);
773module_exit(virtio_mmio_exit);
774
775MODULE_AUTHOR("Pawel Moll <pawel.moll@arm.com>");
776MODULE_DESCRIPTION("Platform bus driver for memory mapped virtio devices");
777MODULE_LICENSE("GPL");
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * Virtio memory mapped device driver
4 *
5 * Copyright 2011-2014, ARM Ltd.
6 *
7 * This module allows virtio devices to be used over a virtual, memory mapped
8 * platform device.
9 *
10 * The guest device(s) may be instantiated in one of three equivalent ways:
11 *
12 * 1. Static platform device in board's code, eg.:
13 *
14 * static struct platform_device v2m_virtio_device = {
15 * .name = "virtio-mmio",
16 * .id = -1,
17 * .num_resources = 2,
18 * .resource = (struct resource []) {
19 * {
20 * .start = 0x1001e000,
21 * .end = 0x1001e0ff,
22 * .flags = IORESOURCE_MEM,
23 * }, {
24 * .start = 42 + 32,
25 * .end = 42 + 32,
26 * .flags = IORESOURCE_IRQ,
27 * },
28 * }
29 * };
30 *
31 * 2. Device Tree node, eg.:
32 *
33 * virtio_block@1e000 {
34 * compatible = "virtio,mmio";
35 * reg = <0x1e000 0x100>;
36 * interrupts = <42>;
37 * }
38 *
39 * 3. Kernel module (or command line) parameter. Can be used more than once -
40 * one device will be created for each one. Syntax:
41 *
42 * [virtio_mmio.]device=<size>@<baseaddr>:<irq>[:<id>]
43 * where:
44 * <size> := size (can use standard suffixes like K, M or G)
45 * <baseaddr> := physical base address
46 * <irq> := interrupt number (as passed to request_irq())
47 * <id> := (optional) platform device id
48 * eg.:
49 * virtio_mmio.device=0x100@0x100b0000:48 \
50 * virtio_mmio.device=1K@0x1001e000:74
51 *
52 * Based on Virtio PCI driver by Anthony Liguori, copyright IBM Corp. 2007
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/pm.h>
66#include <linux/slab.h>
67#include <linux/spinlock.h>
68#include <linux/virtio.h>
69#include <linux/virtio_config.h>
70#include <uapi/linux/virtio_mmio.h>
71#include <linux/virtio_ring.h>
72
73
74
75/* The alignment to use between consumer and producer parts of vring.
76 * Currently hardcoded to the page size. */
77#define VIRTIO_MMIO_VRING_ALIGN PAGE_SIZE
78
79
80
81#define to_virtio_mmio_device(_plat_dev) \
82 container_of(_plat_dev, struct virtio_mmio_device, vdev)
83
84struct virtio_mmio_device {
85 struct virtio_device vdev;
86 struct platform_device *pdev;
87
88 void __iomem *base;
89 unsigned long version;
90
91 /* a list of queues so we can dispatch IRQs */
92 spinlock_t lock;
93 struct list_head virtqueues;
94};
95
96struct virtio_mmio_vq_info {
97 /* the actual virtqueue */
98 struct virtqueue *vq;
99
100 /* the list node for the virtqueues list */
101 struct list_head node;
102};
103
104
105
106/* Configuration interface */
107
108static u64 vm_get_features(struct virtio_device *vdev)
109{
110 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
111 u64 features;
112
113 writel(1, vm_dev->base + VIRTIO_MMIO_DEVICE_FEATURES_SEL);
114 features = readl(vm_dev->base + VIRTIO_MMIO_DEVICE_FEATURES);
115 features <<= 32;
116
117 writel(0, vm_dev->base + VIRTIO_MMIO_DEVICE_FEATURES_SEL);
118 features |= readl(vm_dev->base + VIRTIO_MMIO_DEVICE_FEATURES);
119
120 return features;
121}
122
123static int vm_finalize_features(struct virtio_device *vdev)
124{
125 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
126
127 /* Give virtio_ring a chance to accept features. */
128 vring_transport_features(vdev);
129
130 /* Make sure there are no mixed devices */
131 if (vm_dev->version == 2 &&
132 !__virtio_test_bit(vdev, VIRTIO_F_VERSION_1)) {
133 dev_err(&vdev->dev, "New virtio-mmio devices (version 2) must provide VIRTIO_F_VERSION_1 feature!\n");
134 return -EINVAL;
135 }
136
137 writel(1, vm_dev->base + VIRTIO_MMIO_DRIVER_FEATURES_SEL);
138 writel((u32)(vdev->features >> 32),
139 vm_dev->base + VIRTIO_MMIO_DRIVER_FEATURES);
140
141 writel(0, vm_dev->base + VIRTIO_MMIO_DRIVER_FEATURES_SEL);
142 writel((u32)vdev->features,
143 vm_dev->base + VIRTIO_MMIO_DRIVER_FEATURES);
144
145 return 0;
146}
147
148static void vm_get(struct virtio_device *vdev, unsigned int offset,
149 void *buf, unsigned int len)
150{
151 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
152 void __iomem *base = vm_dev->base + VIRTIO_MMIO_CONFIG;
153 u8 b;
154 __le16 w;
155 __le32 l;
156
157 if (vm_dev->version == 1) {
158 u8 *ptr = buf;
159 int i;
160
161 for (i = 0; i < len; i++)
162 ptr[i] = readb(base + offset + i);
163 return;
164 }
165
166 switch (len) {
167 case 1:
168 b = readb(base + offset);
169 memcpy(buf, &b, sizeof b);
170 break;
171 case 2:
172 w = cpu_to_le16(readw(base + offset));
173 memcpy(buf, &w, sizeof w);
174 break;
175 case 4:
176 l = cpu_to_le32(readl(base + offset));
177 memcpy(buf, &l, sizeof l);
178 break;
179 case 8:
180 l = cpu_to_le32(readl(base + offset));
181 memcpy(buf, &l, sizeof l);
182 l = cpu_to_le32(ioread32(base + offset + sizeof l));
183 memcpy(buf + sizeof l, &l, sizeof l);
184 break;
185 default:
186 BUG();
187 }
188}
189
190static void vm_set(struct virtio_device *vdev, unsigned int offset,
191 const void *buf, unsigned int len)
192{
193 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
194 void __iomem *base = vm_dev->base + VIRTIO_MMIO_CONFIG;
195 u8 b;
196 __le16 w;
197 __le32 l;
198
199 if (vm_dev->version == 1) {
200 const u8 *ptr = buf;
201 int i;
202
203 for (i = 0; i < len; i++)
204 writeb(ptr[i], base + offset + i);
205
206 return;
207 }
208
209 switch (len) {
210 case 1:
211 memcpy(&b, buf, sizeof b);
212 writeb(b, base + offset);
213 break;
214 case 2:
215 memcpy(&w, buf, sizeof w);
216 writew(le16_to_cpu(w), base + offset);
217 break;
218 case 4:
219 memcpy(&l, buf, sizeof l);
220 writel(le32_to_cpu(l), base + offset);
221 break;
222 case 8:
223 memcpy(&l, buf, sizeof l);
224 writel(le32_to_cpu(l), base + offset);
225 memcpy(&l, buf + sizeof l, sizeof l);
226 writel(le32_to_cpu(l), base + offset + sizeof l);
227 break;
228 default:
229 BUG();
230 }
231}
232
233static u32 vm_generation(struct virtio_device *vdev)
234{
235 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
236
237 if (vm_dev->version == 1)
238 return 0;
239 else
240 return readl(vm_dev->base + VIRTIO_MMIO_CONFIG_GENERATION);
241}
242
243static u8 vm_get_status(struct virtio_device *vdev)
244{
245 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
246
247 return readl(vm_dev->base + VIRTIO_MMIO_STATUS) & 0xff;
248}
249
250static void vm_set_status(struct virtio_device *vdev, u8 status)
251{
252 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
253
254 /* We should never be setting status to 0. */
255 BUG_ON(status == 0);
256
257 /*
258 * Per memory-barriers.txt, wmb() is not needed to guarantee
259 * that the cache coherent memory writes have completed
260 * before writing to the MMIO region.
261 */
262 writel(status, vm_dev->base + VIRTIO_MMIO_STATUS);
263}
264
265static void vm_reset(struct virtio_device *vdev)
266{
267 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
268
269 /* 0 status means a reset. */
270 writel(0, vm_dev->base + VIRTIO_MMIO_STATUS);
271}
272
273
274
275/* Transport interface */
276
277/* the notify function used when creating a virt queue */
278static bool vm_notify(struct virtqueue *vq)
279{
280 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vq->vdev);
281
282 /* We write the queue's selector into the notification register to
283 * signal the other end */
284 writel(vq->index, vm_dev->base + VIRTIO_MMIO_QUEUE_NOTIFY);
285 return true;
286}
287
288/* Notify all virtqueues on an interrupt. */
289static irqreturn_t vm_interrupt(int irq, void *opaque)
290{
291 struct virtio_mmio_device *vm_dev = opaque;
292 struct virtio_mmio_vq_info *info;
293 unsigned long status;
294 unsigned long flags;
295 irqreturn_t ret = IRQ_NONE;
296
297 /* Read and acknowledge interrupts */
298 status = readl(vm_dev->base + VIRTIO_MMIO_INTERRUPT_STATUS);
299 writel(status, vm_dev->base + VIRTIO_MMIO_INTERRUPT_ACK);
300
301 if (unlikely(status & VIRTIO_MMIO_INT_CONFIG)) {
302 virtio_config_changed(&vm_dev->vdev);
303 ret = IRQ_HANDLED;
304 }
305
306 if (likely(status & VIRTIO_MMIO_INT_VRING)) {
307 spin_lock_irqsave(&vm_dev->lock, flags);
308 list_for_each_entry(info, &vm_dev->virtqueues, node)
309 ret |= vring_interrupt(irq, info->vq);
310 spin_unlock_irqrestore(&vm_dev->lock, flags);
311 }
312
313 return ret;
314}
315
316
317
318static void vm_del_vq(struct virtqueue *vq)
319{
320 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vq->vdev);
321 struct virtio_mmio_vq_info *info = vq->priv;
322 unsigned long flags;
323 unsigned int index = vq->index;
324
325 spin_lock_irqsave(&vm_dev->lock, flags);
326 list_del(&info->node);
327 spin_unlock_irqrestore(&vm_dev->lock, flags);
328
329 /* Select and deactivate the queue */
330 writel(index, vm_dev->base + VIRTIO_MMIO_QUEUE_SEL);
331 if (vm_dev->version == 1) {
332 writel(0, vm_dev->base + VIRTIO_MMIO_QUEUE_PFN);
333 } else {
334 writel(0, vm_dev->base + VIRTIO_MMIO_QUEUE_READY);
335 WARN_ON(readl(vm_dev->base + VIRTIO_MMIO_QUEUE_READY));
336 }
337
338 vring_del_virtqueue(vq);
339
340 kfree(info);
341}
342
343static void vm_del_vqs(struct virtio_device *vdev)
344{
345 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
346 struct virtqueue *vq, *n;
347
348 list_for_each_entry_safe(vq, n, &vdev->vqs, list)
349 vm_del_vq(vq);
350
351 free_irq(platform_get_irq(vm_dev->pdev, 0), vm_dev);
352}
353
354static void vm_synchronize_cbs(struct virtio_device *vdev)
355{
356 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
357
358 synchronize_irq(platform_get_irq(vm_dev->pdev, 0));
359}
360
361static struct virtqueue *vm_setup_vq(struct virtio_device *vdev, unsigned int index,
362 void (*callback)(struct virtqueue *vq),
363 const char *name, bool ctx)
364{
365 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
366 struct virtio_mmio_vq_info *info;
367 struct virtqueue *vq;
368 unsigned long flags;
369 unsigned int num;
370 int err;
371
372 if (!name)
373 return NULL;
374
375 /* Select the queue we're interested in */
376 writel(index, vm_dev->base + VIRTIO_MMIO_QUEUE_SEL);
377
378 /* Queue shouldn't already be set up. */
379 if (readl(vm_dev->base + (vm_dev->version == 1 ?
380 VIRTIO_MMIO_QUEUE_PFN : VIRTIO_MMIO_QUEUE_READY))) {
381 err = -ENOENT;
382 goto error_available;
383 }
384
385 /* Allocate and fill out our active queue description */
386 info = kmalloc(sizeof(*info), GFP_KERNEL);
387 if (!info) {
388 err = -ENOMEM;
389 goto error_kmalloc;
390 }
391
392 num = readl(vm_dev->base + VIRTIO_MMIO_QUEUE_NUM_MAX);
393 if (num == 0) {
394 err = -ENOENT;
395 goto error_new_virtqueue;
396 }
397
398 /* Create the vring */
399 vq = vring_create_virtqueue(index, num, VIRTIO_MMIO_VRING_ALIGN, vdev,
400 true, true, ctx, vm_notify, callback, name);
401 if (!vq) {
402 err = -ENOMEM;
403 goto error_new_virtqueue;
404 }
405
406 vq->num_max = num;
407
408 /* Activate the queue */
409 writel(virtqueue_get_vring_size(vq), vm_dev->base + VIRTIO_MMIO_QUEUE_NUM);
410 if (vm_dev->version == 1) {
411 u64 q_pfn = virtqueue_get_desc_addr(vq) >> PAGE_SHIFT;
412
413 /*
414 * virtio-mmio v1 uses a 32bit QUEUE PFN. If we have something
415 * that doesn't fit in 32bit, fail the setup rather than
416 * pretending to be successful.
417 */
418 if (q_pfn >> 32) {
419 dev_err(&vdev->dev,
420 "platform bug: legacy virtio-mmio must not be used with RAM above 0x%llxGB\n",
421 0x1ULL << (32 + PAGE_SHIFT - 30));
422 err = -E2BIG;
423 goto error_bad_pfn;
424 }
425
426 writel(PAGE_SIZE, vm_dev->base + VIRTIO_MMIO_QUEUE_ALIGN);
427 writel(q_pfn, vm_dev->base + VIRTIO_MMIO_QUEUE_PFN);
428 } else {
429 u64 addr;
430
431 addr = virtqueue_get_desc_addr(vq);
432 writel((u32)addr, vm_dev->base + VIRTIO_MMIO_QUEUE_DESC_LOW);
433 writel((u32)(addr >> 32),
434 vm_dev->base + VIRTIO_MMIO_QUEUE_DESC_HIGH);
435
436 addr = virtqueue_get_avail_addr(vq);
437 writel((u32)addr, vm_dev->base + VIRTIO_MMIO_QUEUE_AVAIL_LOW);
438 writel((u32)(addr >> 32),
439 vm_dev->base + VIRTIO_MMIO_QUEUE_AVAIL_HIGH);
440
441 addr = virtqueue_get_used_addr(vq);
442 writel((u32)addr, vm_dev->base + VIRTIO_MMIO_QUEUE_USED_LOW);
443 writel((u32)(addr >> 32),
444 vm_dev->base + VIRTIO_MMIO_QUEUE_USED_HIGH);
445
446 writel(1, vm_dev->base + VIRTIO_MMIO_QUEUE_READY);
447 }
448
449 vq->priv = info;
450 info->vq = vq;
451
452 spin_lock_irqsave(&vm_dev->lock, flags);
453 list_add(&info->node, &vm_dev->virtqueues);
454 spin_unlock_irqrestore(&vm_dev->lock, flags);
455
456 return vq;
457
458error_bad_pfn:
459 vring_del_virtqueue(vq);
460error_new_virtqueue:
461 if (vm_dev->version == 1) {
462 writel(0, vm_dev->base + VIRTIO_MMIO_QUEUE_PFN);
463 } else {
464 writel(0, vm_dev->base + VIRTIO_MMIO_QUEUE_READY);
465 WARN_ON(readl(vm_dev->base + VIRTIO_MMIO_QUEUE_READY));
466 }
467 kfree(info);
468error_kmalloc:
469error_available:
470 return ERR_PTR(err);
471}
472
473static int vm_find_vqs(struct virtio_device *vdev, unsigned int nvqs,
474 struct virtqueue *vqs[],
475 vq_callback_t *callbacks[],
476 const char * const names[],
477 const bool *ctx,
478 struct irq_affinity *desc)
479{
480 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
481 int irq = platform_get_irq(vm_dev->pdev, 0);
482 int i, err, queue_idx = 0;
483
484 if (irq < 0)
485 return irq;
486
487 err = request_irq(irq, vm_interrupt, IRQF_SHARED,
488 dev_name(&vdev->dev), vm_dev);
489 if (err)
490 return err;
491
492 if (of_property_read_bool(vm_dev->pdev->dev.of_node, "wakeup-source"))
493 enable_irq_wake(irq);
494
495 for (i = 0; i < nvqs; ++i) {
496 if (!names[i]) {
497 vqs[i] = NULL;
498 continue;
499 }
500
501 vqs[i] = vm_setup_vq(vdev, queue_idx++, callbacks[i], names[i],
502 ctx ? ctx[i] : false);
503 if (IS_ERR(vqs[i])) {
504 vm_del_vqs(vdev);
505 return PTR_ERR(vqs[i]);
506 }
507 }
508
509 return 0;
510}
511
512static const char *vm_bus_name(struct virtio_device *vdev)
513{
514 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
515
516 return vm_dev->pdev->name;
517}
518
519static bool vm_get_shm_region(struct virtio_device *vdev,
520 struct virtio_shm_region *region, u8 id)
521{
522 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
523 u64 len, addr;
524
525 /* Select the region we're interested in */
526 writel(id, vm_dev->base + VIRTIO_MMIO_SHM_SEL);
527
528 /* Read the region size */
529 len = (u64) readl(vm_dev->base + VIRTIO_MMIO_SHM_LEN_LOW);
530 len |= (u64) readl(vm_dev->base + VIRTIO_MMIO_SHM_LEN_HIGH) << 32;
531
532 region->len = len;
533
534 /* Check if region length is -1. If that's the case, the shared memory
535 * region does not exist and there is no need to proceed further.
536 */
537 if (len == ~(u64)0)
538 return false;
539
540 /* Read the region base address */
541 addr = (u64) readl(vm_dev->base + VIRTIO_MMIO_SHM_BASE_LOW);
542 addr |= (u64) readl(vm_dev->base + VIRTIO_MMIO_SHM_BASE_HIGH) << 32;
543
544 region->addr = addr;
545
546 return true;
547}
548
549static const struct virtio_config_ops virtio_mmio_config_ops = {
550 .get = vm_get,
551 .set = vm_set,
552 .generation = vm_generation,
553 .get_status = vm_get_status,
554 .set_status = vm_set_status,
555 .reset = vm_reset,
556 .find_vqs = vm_find_vqs,
557 .del_vqs = vm_del_vqs,
558 .get_features = vm_get_features,
559 .finalize_features = vm_finalize_features,
560 .bus_name = vm_bus_name,
561 .get_shm_region = vm_get_shm_region,
562 .synchronize_cbs = vm_synchronize_cbs,
563};
564
565#ifdef CONFIG_PM_SLEEP
566static int virtio_mmio_freeze(struct device *dev)
567{
568 struct virtio_mmio_device *vm_dev = dev_get_drvdata(dev);
569
570 return virtio_device_freeze(&vm_dev->vdev);
571}
572
573static int virtio_mmio_restore(struct device *dev)
574{
575 struct virtio_mmio_device *vm_dev = dev_get_drvdata(dev);
576
577 if (vm_dev->version == 1)
578 writel(PAGE_SIZE, vm_dev->base + VIRTIO_MMIO_GUEST_PAGE_SIZE);
579
580 return virtio_device_restore(&vm_dev->vdev);
581}
582
583static const struct dev_pm_ops virtio_mmio_pm_ops = {
584 SET_SYSTEM_SLEEP_PM_OPS(virtio_mmio_freeze, virtio_mmio_restore)
585};
586#endif
587
588static void virtio_mmio_release_dev(struct device *_d)
589{
590 struct virtio_device *vdev =
591 container_of(_d, struct virtio_device, dev);
592 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
593 struct platform_device *pdev = vm_dev->pdev;
594
595 devm_kfree(&pdev->dev, vm_dev);
596}
597
598/* Platform device */
599
600static int virtio_mmio_probe(struct platform_device *pdev)
601{
602 struct virtio_mmio_device *vm_dev;
603 unsigned long magic;
604 int rc;
605
606 vm_dev = devm_kzalloc(&pdev->dev, sizeof(*vm_dev), GFP_KERNEL);
607 if (!vm_dev)
608 return -ENOMEM;
609
610 vm_dev->vdev.dev.parent = &pdev->dev;
611 vm_dev->vdev.dev.release = virtio_mmio_release_dev;
612 vm_dev->vdev.config = &virtio_mmio_config_ops;
613 vm_dev->pdev = pdev;
614 INIT_LIST_HEAD(&vm_dev->virtqueues);
615 spin_lock_init(&vm_dev->lock);
616
617 vm_dev->base = devm_platform_ioremap_resource(pdev, 0);
618 if (IS_ERR(vm_dev->base))
619 return PTR_ERR(vm_dev->base);
620
621 /* Check magic value */
622 magic = readl(vm_dev->base + VIRTIO_MMIO_MAGIC_VALUE);
623 if (magic != ('v' | 'i' << 8 | 'r' << 16 | 't' << 24)) {
624 dev_warn(&pdev->dev, "Wrong magic value 0x%08lx!\n", magic);
625 return -ENODEV;
626 }
627
628 /* Check device version */
629 vm_dev->version = readl(vm_dev->base + VIRTIO_MMIO_VERSION);
630 if (vm_dev->version < 1 || vm_dev->version > 2) {
631 dev_err(&pdev->dev, "Version %ld not supported!\n",
632 vm_dev->version);
633 return -ENXIO;
634 }
635
636 vm_dev->vdev.id.device = readl(vm_dev->base + VIRTIO_MMIO_DEVICE_ID);
637 if (vm_dev->vdev.id.device == 0) {
638 /*
639 * virtio-mmio device with an ID 0 is a (dummy) placeholder
640 * with no function. End probing now with no error reported.
641 */
642 return -ENODEV;
643 }
644 vm_dev->vdev.id.vendor = readl(vm_dev->base + VIRTIO_MMIO_VENDOR_ID);
645
646 if (vm_dev->version == 1) {
647 writel(PAGE_SIZE, vm_dev->base + VIRTIO_MMIO_GUEST_PAGE_SIZE);
648
649 rc = dma_set_mask(&pdev->dev, DMA_BIT_MASK(64));
650 /*
651 * In the legacy case, ensure our coherently-allocated virtio
652 * ring will be at an address expressable as a 32-bit PFN.
653 */
654 if (!rc)
655 dma_set_coherent_mask(&pdev->dev,
656 DMA_BIT_MASK(32 + PAGE_SHIFT));
657 } else {
658 rc = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(64));
659 }
660 if (rc)
661 rc = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
662 if (rc)
663 dev_warn(&pdev->dev, "Failed to enable 64-bit or 32-bit DMA. Trying to continue, but this might not work.\n");
664
665 platform_set_drvdata(pdev, vm_dev);
666
667 rc = register_virtio_device(&vm_dev->vdev);
668 if (rc)
669 put_device(&vm_dev->vdev.dev);
670
671 return rc;
672}
673
674static int virtio_mmio_remove(struct platform_device *pdev)
675{
676 struct virtio_mmio_device *vm_dev = platform_get_drvdata(pdev);
677 unregister_virtio_device(&vm_dev->vdev);
678
679 return 0;
680}
681
682
683
684/* Devices list parameter */
685
686#if defined(CONFIG_VIRTIO_MMIO_CMDLINE_DEVICES)
687
688static struct device vm_cmdline_parent = {
689 .init_name = "virtio-mmio-cmdline",
690};
691
692static int vm_cmdline_parent_registered;
693static int vm_cmdline_id;
694
695static int vm_cmdline_set(const char *device,
696 const struct kernel_param *kp)
697{
698 int err;
699 struct resource resources[2] = {};
700 char *str;
701 long long base, size;
702 unsigned int irq;
703 int processed, consumed = 0;
704 struct platform_device *pdev;
705
706 /* Consume "size" part of the command line parameter */
707 size = memparse(device, &str);
708
709 /* Get "@<base>:<irq>[:<id>]" chunks */
710 processed = sscanf(str, "@%lli:%u%n:%d%n",
711 &base, &irq, &consumed,
712 &vm_cmdline_id, &consumed);
713
714 /*
715 * sscanf() must process at least 2 chunks; also there
716 * must be no extra characters after the last chunk, so
717 * str[consumed] must be '\0'
718 */
719 if (processed < 2 || str[consumed] || irq == 0)
720 return -EINVAL;
721
722 resources[0].flags = IORESOURCE_MEM;
723 resources[0].start = base;
724 resources[0].end = base + size - 1;
725
726 resources[1].flags = IORESOURCE_IRQ;
727 resources[1].start = resources[1].end = irq;
728
729 if (!vm_cmdline_parent_registered) {
730 err = device_register(&vm_cmdline_parent);
731 if (err) {
732 put_device(&vm_cmdline_parent);
733 pr_err("Failed to register parent device!\n");
734 return err;
735 }
736 vm_cmdline_parent_registered = 1;
737 }
738
739 pr_info("Registering device virtio-mmio.%d at 0x%llx-0x%llx, IRQ %d.\n",
740 vm_cmdline_id,
741 (unsigned long long)resources[0].start,
742 (unsigned long long)resources[0].end,
743 (int)resources[1].start);
744
745 pdev = platform_device_register_resndata(&vm_cmdline_parent,
746 "virtio-mmio", vm_cmdline_id++,
747 resources, ARRAY_SIZE(resources), NULL, 0);
748
749 return PTR_ERR_OR_ZERO(pdev);
750}
751
752static int vm_cmdline_get_device(struct device *dev, void *data)
753{
754 char *buffer = data;
755 unsigned int len = strlen(buffer);
756 struct platform_device *pdev = to_platform_device(dev);
757
758 snprintf(buffer + len, PAGE_SIZE - len, "0x%llx@0x%llx:%llu:%d\n",
759 pdev->resource[0].end - pdev->resource[0].start + 1ULL,
760 (unsigned long long)pdev->resource[0].start,
761 (unsigned long long)pdev->resource[1].start,
762 pdev->id);
763 return 0;
764}
765
766static int vm_cmdline_get(char *buffer, const struct kernel_param *kp)
767{
768 buffer[0] = '\0';
769 device_for_each_child(&vm_cmdline_parent, buffer,
770 vm_cmdline_get_device);
771 return strlen(buffer) + 1;
772}
773
774static const struct kernel_param_ops vm_cmdline_param_ops = {
775 .set = vm_cmdline_set,
776 .get = vm_cmdline_get,
777};
778
779device_param_cb(device, &vm_cmdline_param_ops, NULL, S_IRUSR);
780
781static int vm_unregister_cmdline_device(struct device *dev,
782 void *data)
783{
784 platform_device_unregister(to_platform_device(dev));
785
786 return 0;
787}
788
789static void vm_unregister_cmdline_devices(void)
790{
791 if (vm_cmdline_parent_registered) {
792 device_for_each_child(&vm_cmdline_parent, NULL,
793 vm_unregister_cmdline_device);
794 device_unregister(&vm_cmdline_parent);
795 vm_cmdline_parent_registered = 0;
796 }
797}
798
799#else
800
801static void vm_unregister_cmdline_devices(void)
802{
803}
804
805#endif
806
807/* Platform driver */
808
809static const struct of_device_id virtio_mmio_match[] = {
810 { .compatible = "virtio,mmio", },
811 {},
812};
813MODULE_DEVICE_TABLE(of, virtio_mmio_match);
814
815#ifdef CONFIG_ACPI
816static const struct acpi_device_id virtio_mmio_acpi_match[] = {
817 { "LNRO0005", },
818 { }
819};
820MODULE_DEVICE_TABLE(acpi, virtio_mmio_acpi_match);
821#endif
822
823static struct platform_driver virtio_mmio_driver = {
824 .probe = virtio_mmio_probe,
825 .remove = virtio_mmio_remove,
826 .driver = {
827 .name = "virtio-mmio",
828 .of_match_table = virtio_mmio_match,
829 .acpi_match_table = ACPI_PTR(virtio_mmio_acpi_match),
830#ifdef CONFIG_PM_SLEEP
831 .pm = &virtio_mmio_pm_ops,
832#endif
833 },
834};
835
836static int __init virtio_mmio_init(void)
837{
838 return platform_driver_register(&virtio_mmio_driver);
839}
840
841static void __exit virtio_mmio_exit(void)
842{
843 platform_driver_unregister(&virtio_mmio_driver);
844 vm_unregister_cmdline_devices();
845}
846
847module_init(virtio_mmio_init);
848module_exit(virtio_mmio_exit);
849
850MODULE_AUTHOR("Pawel Moll <pawel.moll@arm.com>");
851MODULE_DESCRIPTION("Platform bus driver for memory mapped virtio devices");
852MODULE_LICENSE("GPL");