blob: f363fbeb5ab0cf0c3e006de5c4d9e724c0cb5691 [file] [log] [blame]
Thomas Gleixnerf33f5fe2019-05-22 09:51:24 +02001// SPDX-License-Identifier: GPL-2.0-or-later
Pawel Molledfd52e2011-10-24 14:07:03 +01002/*
3 * Virtio memory mapped device driver
4 *
Pawel Moll1862ee22015-01-23 14:45:55 +10305 * Copyright 2011-2014, ARM Ltd.
Pawel Molledfd52e2011-10-24 14:07:03 +01006 *
7 * This module allows virtio devices to be used over a virtual, memory mapped
8 * platform device.
9 *
Pawel Moll81a054c2012-05-09 18:30:16 +010010 * 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 *
Pawel Molledfd52e2011-10-24 14:07:03 +010052 * Based on Virtio PCI driver by Anthony Liguori, copyright IBM Corp. 2007
Pawel Molledfd52e2011-10-24 14:07:03 +010053 */
54
Pawel Moll81a054c2012-05-09 18:30:16 +010055#define pr_fmt(fmt) "virtio-mmio: " fmt
56
Graeme Gregory38c4ab82015-07-28 10:44:02 +010057#include <linux/acpi.h>
Robin Murphyf7f66342017-01-10 17:51:17 +000058#include <linux/dma-mapping.h>
Pawel Molledfd52e2011-10-24 14:07:03 +010059#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>
Michael S. Tsirkin51be7a92017-01-12 23:36:32 +020069#include <uapi/linux/virtio_mmio.h>
Pawel Molledfd52e2011-10-24 14:07:03 +010070#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
Pawel Molledfd52e2011-10-24 14:07:03 +010099 /* the list node for the virtqueues list */
100 struct list_head node;
101};
102
103
104
105/* Configuration interface */
106
Michael S. Tsirkind0254772014-10-07 16:39:43 +0200107static u64 vm_get_features(struct virtio_device *vdev)
Pawel Molledfd52e2011-10-24 14:07:03 +0100108{
109 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
Pawel Moll1862ee22015-01-23 14:45:55 +1030110 u64 features;
Pawel Molledfd52e2011-10-24 14:07:03 +0100111
Pawel Moll1862ee22015-01-23 14:45:55 +1030112 writel(1, vm_dev->base + VIRTIO_MMIO_DEVICE_FEATURES_SEL);
113 features = readl(vm_dev->base + VIRTIO_MMIO_DEVICE_FEATURES);
114 features <<= 32;
Pawel Molledfd52e2011-10-24 14:07:03 +0100115
Pawel Moll1862ee22015-01-23 14:45:55 +1030116 writel(0, vm_dev->base + VIRTIO_MMIO_DEVICE_FEATURES_SEL);
117 features |= readl(vm_dev->base + VIRTIO_MMIO_DEVICE_FEATURES);
118
119 return features;
Pawel Molledfd52e2011-10-24 14:07:03 +0100120}
121
Michael S. Tsirkin5c609a52014-12-04 20:20:27 +0200122static int vm_finalize_features(struct virtio_device *vdev)
Pawel Molledfd52e2011-10-24 14:07:03 +0100123{
124 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
Pawel Molledfd52e2011-10-24 14:07:03 +0100125
126 /* Give virtio_ring a chance to accept features. */
127 vring_transport_features(vdev);
128
Pawel Moll1862ee22015-01-23 14:45:55 +1030129 /* 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 }
Michael S. Tsirkin93d389f2014-11-27 13:45:58 +0200135
Pawel Moll1862ee22015-01-23 14:45:55 +1030136 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);
Michael S. Tsirkin5c609a52014-12-04 20:20:27 +0200143
144 return 0;
Pawel Molledfd52e2011-10-24 14:07:03 +0100145}
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);
Michael S. Tsirkin704a0b52015-03-17 12:11:30 +1030151 void __iomem *base = vm_dev->base + VIRTIO_MMIO_CONFIG;
152 u8 b;
153 __le16 w;
154 __le32 l;
Pawel Molledfd52e2011-10-24 14:07:03 +0100155
Michael S. Tsirkin704a0b52015-03-17 12:11:30 +1030156 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 }
Pawel Molledfd52e2011-10-24 14:07:03 +0100187}
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);
Michael S. Tsirkin704a0b52015-03-17 12:11:30 +1030193 void __iomem *base = vm_dev->base + VIRTIO_MMIO_CONFIG;
194 u8 b;
195 __le16 w;
196 __le32 l;
Pawel Molledfd52e2011-10-24 14:07:03 +0100197
Michael S. Tsirkin704a0b52015-03-17 12:11:30 +1030198 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 }
Pawel Molledfd52e2011-10-24 14:07:03 +0100230}
231
Michael S. Tsirkin87e7bf12015-03-12 12:56:43 +1030232static 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
Pawel Molledfd52e2011-10-24 14:07:03 +0100242static 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 */
Heinz Graalfs46f9c2b2013-10-29 09:38:50 +1030272static bool vm_notify(struct virtqueue *vq)
Pawel Molledfd52e2011-10-24 14:07:03 +0100273{
274 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vq->vdev);
Pawel Molledfd52e2011-10-24 14:07:03 +0100275
276 /* We write the queue's selector into the notification register to
277 * signal the other end */
Rusty Russell06ca2872012-10-16 23:56:14 +1030278 writel(vq->index, vm_dev->base + VIRTIO_MMIO_QUEUE_NOTIFY);
Heinz Graalfs46f9c2b2013-10-29 09:38:50 +1030279 return true;
Pawel Molledfd52e2011-10-24 14:07:03 +0100280}
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;
Pawel Molledfd52e2011-10-24 14:07:03 +0100287 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
Michael S. Tsirkin016c98c2014-10-14 10:40:34 +1030295 if (unlikely(status & VIRTIO_MMIO_INT_CONFIG)) {
296 virtio_config_changed(&vm_dev->vdev);
Pawel Molledfd52e2011-10-24 14:07:03 +0100297 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;
Andy Lutomirskib4211132016-02-02 21:46:38 -0800316 unsigned long flags;
Rusty Russell06ca2872012-10-16 23:56:14 +1030317 unsigned int index = vq->index;
Pawel Molledfd52e2011-10-24 14:07:03 +0100318
319 spin_lock_irqsave(&vm_dev->lock, flags);
320 list_del(&info->node);
321 spin_unlock_irqrestore(&vm_dev->lock, flags);
322
Pawel Molledfd52e2011-10-24 14:07:03 +0100323 /* Select and deactivate the queue */
Jason Wang17bb6d42012-08-28 13:54:13 +0200324 writel(index, vm_dev->base + VIRTIO_MMIO_QUEUE_SEL);
Pawel Moll1862ee22015-01-23 14:45:55 +1030325 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 }
Pawel Molledfd52e2011-10-24 14:07:03 +0100331
Andy Lutomirskib4211132016-02-02 21:46:38 -0800332 vring_del_virtqueue(vq);
333
Pawel Molledfd52e2011-10-24 14:07:03 +0100334 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
Pawel Molledfd52e2011-10-24 14:07:03 +0100348static struct virtqueue *vm_setup_vq(struct virtio_device *vdev, unsigned index,
349 void (*callback)(struct virtqueue *vq),
Michael S. Tsirkinf94682d2017-03-06 18:32:29 +0200350 const char *name, bool ctx)
Pawel Molledfd52e2011-10-24 14:07:03 +0100351{
352 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
353 struct virtio_mmio_vq_info *info;
354 struct virtqueue *vq;
Andy Lutomirskib4211132016-02-02 21:46:38 -0800355 unsigned long flags;
356 unsigned int num;
Pawel Molledfd52e2011-10-24 14:07:03 +0100357 int err;
358
Michael S. Tsirkin6457f122012-09-05 21:47:45 +0300359 if (!name)
360 return NULL;
361
Pawel Molledfd52e2011-10-24 14:07:03 +0100362 /* 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. */
Pawel Moll1862ee22015-01-23 14:45:55 +1030366 if (readl(vm_dev->base + (vm_dev->version == 1 ?
367 VIRTIO_MMIO_QUEUE_PFN : VIRTIO_MMIO_QUEUE_READY))) {
Pawel Molledfd52e2011-10-24 14:07:03 +0100368 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 }
Pawel Molledfd52e2011-10-24 14:07:03 +0100378
Andy Lutomirskib4211132016-02-02 21:46:38 -0800379 num = readl(vm_dev->base + VIRTIO_MMIO_QUEUE_NUM_MAX);
380 if (num == 0) {
Brian Foleyd78b5192012-09-24 14:33:42 +0100381 err = -ENOENT;
Andy Lutomirskib4211132016-02-02 21:46:38 -0800382 goto error_new_virtqueue;
Pawel Molledfd52e2011-10-24 14:07:03 +0100383 }
384
Pawel Molledfd52e2011-10-24 14:07:03 +0100385 /* Create the vring */
Andy Lutomirskib4211132016-02-02 21:46:38 -0800386 vq = vring_create_virtqueue(index, num, VIRTIO_MMIO_VRING_ALIGN, vdev,
Michael S. Tsirkinf94682d2017-03-06 18:32:29 +0200387 true, true, ctx, vm_notify, callback, name);
Pawel Molledfd52e2011-10-24 14:07:03 +0100388 if (!vq) {
389 err = -ENOMEM;
390 goto error_new_virtqueue;
391 }
392
Pawel Moll1862ee22015-01-23 14:45:55 +1030393 /* Activate the queue */
Andy Lutomirskib4211132016-02-02 21:46:38 -0800394 writel(virtqueue_get_vring_size(vq), vm_dev->base + VIRTIO_MMIO_QUEUE_NUM);
Pawel Moll1862ee22015-01-23 14:45:55 +1030395 if (vm_dev->version == 1) {
Suzuki K Poulose3fc92a92018-07-18 10:18:44 +0100396 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
Pawel Moll1862ee22015-01-23 14:45:55 +1030411 writel(PAGE_SIZE, vm_dev->base + VIRTIO_MMIO_QUEUE_ALIGN);
Suzuki K Poulose3fc92a92018-07-18 10:18:44 +0100412 writel(q_pfn, vm_dev->base + VIRTIO_MMIO_QUEUE_PFN);
Pawel Moll1862ee22015-01-23 14:45:55 +1030413 } else {
414 u64 addr;
415
Andy Lutomirskib4211132016-02-02 21:46:38 -0800416 addr = virtqueue_get_desc_addr(vq);
Pawel Moll1862ee22015-01-23 14:45:55 +1030417 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
Andy Lutomirskib4211132016-02-02 21:46:38 -0800421 addr = virtqueue_get_avail_addr(vq);
Pawel Moll1862ee22015-01-23 14:45:55 +1030422 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
Andy Lutomirskib4211132016-02-02 21:46:38 -0800426 addr = virtqueue_get_used_addr(vq);
Pawel Moll1862ee22015-01-23 14:45:55 +1030427 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
Pawel Molledfd52e2011-10-24 14:07:03 +0100434 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
Suzuki K Poulose3fc92a92018-07-18 10:18:44 +0100443error_bad_pfn:
444 vring_del_virtqueue(vq);
Pawel Molledfd52e2011-10-24 14:07:03 +0100445error_new_virtqueue:
Pawel Moll1862ee22015-01-23 14:45:55 +1030446 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 }
Pawel Molledfd52e2011-10-24 14:07:03 +0100452 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[],
Christoph Hellwigfb5e31d2017-02-05 18:15:22 +0100461 const char * const names[],
Michael S. Tsirkinf94682d2017-03-06 18:32:29 +0200462 const bool *ctx,
Christoph Hellwigfb5e31d2017-02-05 18:15:22 +0100463 struct irq_affinity *desc)
Pawel Molledfd52e2011-10-24 14:07:03 +0100464{
465 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
466 unsigned int irq = platform_get_irq(vm_dev->pdev, 0);
Wei Wanga2299892018-12-28 10:26:26 +0800467 int i, err, queue_idx = 0;
Pawel Molledfd52e2011-10-24 14:07:03 +0100468
469 err = request_irq(irq, vm_interrupt, IRQF_SHARED,
470 dev_name(&vdev->dev), vm_dev);
471 if (err)
472 return err;
473
474 for (i = 0; i < nvqs; ++i) {
Wei Wanga2299892018-12-28 10:26:26 +0800475 if (!names[i]) {
476 vqs[i] = NULL;
477 continue;
478 }
479
480 vqs[i] = vm_setup_vq(vdev, queue_idx++, callbacks[i], names[i],
Michael S. Tsirkinf94682d2017-03-06 18:32:29 +0200481 ctx ? ctx[i] : false);
Pawel Molledfd52e2011-10-24 14:07:03 +0100482 if (IS_ERR(vqs[i])) {
483 vm_del_vqs(vdev);
484 return PTR_ERR(vqs[i]);
485 }
486 }
487
488 return 0;
489}
490
Rick Jones66846042011-11-14 14:17:08 +0000491static const char *vm_bus_name(struct virtio_device *vdev)
492{
493 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
Pawel Molledfd52e2011-10-24 14:07:03 +0100494
Rick Jones66846042011-11-14 14:17:08 +0000495 return vm_dev->pdev->name;
496}
Pawel Molledfd52e2011-10-24 14:07:03 +0100497
Stephen Hemminger93503932013-02-10 15:57:38 +1030498static const struct virtio_config_ops virtio_mmio_config_ops = {
Pawel Molledfd52e2011-10-24 14:07:03 +0100499 .get = vm_get,
500 .set = vm_set,
Michael S. Tsirkin87e7bf12015-03-12 12:56:43 +1030501 .generation = vm_generation,
Pawel Molledfd52e2011-10-24 14:07:03 +0100502 .get_status = vm_get_status,
503 .set_status = vm_set_status,
504 .reset = vm_reset,
505 .find_vqs = vm_find_vqs,
506 .del_vqs = vm_del_vqs,
507 .get_features = vm_get_features,
508 .finalize_features = vm_finalize_features,
Rick Jones66846042011-11-14 14:17:08 +0000509 .bus_name = vm_bus_name,
Pawel Molledfd52e2011-10-24 14:07:03 +0100510};
511
512
weiping zhang7eb781b2017-12-06 21:59:16 +0800513static void virtio_mmio_release_dev(struct device *_d)
514{
515 struct virtio_device *vdev =
516 container_of(_d, struct virtio_device, dev);
517 struct virtio_mmio_device *vm_dev =
518 container_of(vdev, struct virtio_mmio_device, vdev);
519 struct platform_device *pdev = vm_dev->pdev;
520
521 devm_kfree(&pdev->dev, vm_dev);
522}
Pawel Molledfd52e2011-10-24 14:07:03 +0100523
524/* Platform device */
525
Greg Kroah-Hartman8590dbc2012-12-21 13:05:30 -0800526static int virtio_mmio_probe(struct platform_device *pdev)
Pawel Molledfd52e2011-10-24 14:07:03 +0100527{
528 struct virtio_mmio_device *vm_dev;
529 struct resource *mem;
530 unsigned long magic;
Robin Murphyf7f66342017-01-10 17:51:17 +0000531 int rc;
Pawel Molledfd52e2011-10-24 14:07:03 +0100532
533 mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
534 if (!mem)
535 return -EINVAL;
536
537 if (!devm_request_mem_region(&pdev->dev, mem->start,
538 resource_size(mem), pdev->name))
539 return -EBUSY;
540
541 vm_dev = devm_kzalloc(&pdev->dev, sizeof(*vm_dev), GFP_KERNEL);
Mark Rutlandc2e90802017-12-12 13:45:50 +0000542 if (!vm_dev)
543 return -ENOMEM;
Pawel Molledfd52e2011-10-24 14:07:03 +0100544
545 vm_dev->vdev.dev.parent = &pdev->dev;
weiping zhang7eb781b2017-12-06 21:59:16 +0800546 vm_dev->vdev.dev.release = virtio_mmio_release_dev;
Pawel Molledfd52e2011-10-24 14:07:03 +0100547 vm_dev->vdev.config = &virtio_mmio_config_ops;
548 vm_dev->pdev = pdev;
549 INIT_LIST_HEAD(&vm_dev->virtqueues);
550 spin_lock_init(&vm_dev->lock);
551
552 vm_dev->base = devm_ioremap(&pdev->dev, mem->start, resource_size(mem));
Mark Rutlandc2e90802017-12-12 13:45:50 +0000553 if (vm_dev->base == NULL)
554 return -EFAULT;
Pawel Molledfd52e2011-10-24 14:07:03 +0100555
556 /* Check magic value */
557 magic = readl(vm_dev->base + VIRTIO_MMIO_MAGIC_VALUE);
Marc Zyngier4ae85372013-11-05 21:21:28 +1030558 if (magic != ('v' | 'i' << 8 | 'r' << 16 | 't' << 24)) {
Pawel Molledfd52e2011-10-24 14:07:03 +0100559 dev_warn(&pdev->dev, "Wrong magic value 0x%08lx!\n", magic);
Mark Rutlandc2e90802017-12-12 13:45:50 +0000560 return -ENODEV;
Pawel Molledfd52e2011-10-24 14:07:03 +0100561 }
562
563 /* Check device version */
564 vm_dev->version = readl(vm_dev->base + VIRTIO_MMIO_VERSION);
Pawel Moll1862ee22015-01-23 14:45:55 +1030565 if (vm_dev->version < 1 || vm_dev->version > 2) {
Pawel Molledfd52e2011-10-24 14:07:03 +0100566 dev_err(&pdev->dev, "Version %ld not supported!\n",
567 vm_dev->version);
Mark Rutlandc2e90802017-12-12 13:45:50 +0000568 return -ENXIO;
Pawel Molledfd52e2011-10-24 14:07:03 +0100569 }
570
571 vm_dev->vdev.id.device = readl(vm_dev->base + VIRTIO_MMIO_DEVICE_ID);
Pawel Moll1862ee22015-01-23 14:45:55 +1030572 if (vm_dev->vdev.id.device == 0) {
573 /*
574 * virtio-mmio device with an ID 0 is a (dummy) placeholder
575 * with no function. End probing now with no error reported.
576 */
Mark Rutlandc2e90802017-12-12 13:45:50 +0000577 return -ENODEV;
Pawel Moll1862ee22015-01-23 14:45:55 +1030578 }
Pawel Molledfd52e2011-10-24 14:07:03 +0100579 vm_dev->vdev.id.vendor = readl(vm_dev->base + VIRTIO_MMIO_VENDOR_ID);
580
Robin Murphyf7f66342017-01-10 17:51:17 +0000581 if (vm_dev->version == 1) {
Pawel Moll1862ee22015-01-23 14:45:55 +1030582 writel(PAGE_SIZE, vm_dev->base + VIRTIO_MMIO_GUEST_PAGE_SIZE);
Pawel Molledfd52e2011-10-24 14:07:03 +0100583
Robin Murphyf7f66342017-01-10 17:51:17 +0000584 rc = dma_set_mask(&pdev->dev, DMA_BIT_MASK(64));
585 /*
586 * In the legacy case, ensure our coherently-allocated virtio
587 * ring will be at an address expressable as a 32-bit PFN.
588 */
589 if (!rc)
590 dma_set_coherent_mask(&pdev->dev,
591 DMA_BIT_MASK(32 + PAGE_SHIFT));
592 } else {
593 rc = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(64));
594 }
595 if (rc)
596 rc = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
597 if (rc)
598 dev_warn(&pdev->dev, "Failed to enable 64-bit or 32-bit DMA. Trying to continue, but this might not work.\n");
599
Pawel Molledfd52e2011-10-24 14:07:03 +0100600 platform_set_drvdata(pdev, vm_dev);
601
weiping zhang7eb781b2017-12-06 21:59:16 +0800602 rc = register_virtio_device(&vm_dev->vdev);
Mark Rutlandc2e90802017-12-12 13:45:50 +0000603 if (rc)
weiping zhang7eb781b2017-12-06 21:59:16 +0800604 put_device(&vm_dev->vdev.dev);
Mark Rutlandc2e90802017-12-12 13:45:50 +0000605
weiping zhang7eb781b2017-12-06 21:59:16 +0800606 return rc;
Pawel Molledfd52e2011-10-24 14:07:03 +0100607}
608
Greg Kroah-Hartman8590dbc2012-12-21 13:05:30 -0800609static int virtio_mmio_remove(struct platform_device *pdev)
Pawel Molledfd52e2011-10-24 14:07:03 +0100610{
611 struct virtio_mmio_device *vm_dev = platform_get_drvdata(pdev);
Pawel Molledfd52e2011-10-24 14:07:03 +0100612 unregister_virtio_device(&vm_dev->vdev);
613
614 return 0;
615}
616
617
618
Pawel Moll81a054c2012-05-09 18:30:16 +0100619/* Devices list parameter */
620
621#if defined(CONFIG_VIRTIO_MMIO_CMDLINE_DEVICES)
622
623static struct device vm_cmdline_parent = {
624 .init_name = "virtio-mmio-cmdline",
625};
626
627static int vm_cmdline_parent_registered;
628static int vm_cmdline_id;
629
630static int vm_cmdline_set(const char *device,
631 const struct kernel_param *kp)
632{
633 int err;
634 struct resource resources[2] = {};
635 char *str;
Pawel Moll40f99382012-11-22 12:30:24 +1030636 long long int base, size;
637 unsigned int irq;
Pawel Moll81a054c2012-05-09 18:30:16 +0100638 int processed, consumed = 0;
639 struct platform_device *pdev;
640
Pawel Moll40f99382012-11-22 12:30:24 +1030641 /* Consume "size" part of the command line parameter */
642 size = memparse(device, &str);
Pawel Moll81a054c2012-05-09 18:30:16 +0100643
Pawel Moll40f99382012-11-22 12:30:24 +1030644 /* Get "@<base>:<irq>[:<id>]" chunks */
Pawel Moll81a054c2012-05-09 18:30:16 +0100645 processed = sscanf(str, "@%lli:%u%n:%d%n",
Pawel Moll40f99382012-11-22 12:30:24 +1030646 &base, &irq, &consumed,
Pawel Moll81a054c2012-05-09 18:30:16 +0100647 &vm_cmdline_id, &consumed);
648
Pawel Moll40f99382012-11-22 12:30:24 +1030649 /*
650 * sscanf() must processes at least 2 chunks; also there
651 * must be no extra characters after the last chunk, so
652 * str[consumed] must be '\0'
653 */
654 if (processed < 2 || str[consumed])
Pawel Moll81a054c2012-05-09 18:30:16 +0100655 return -EINVAL;
656
Pawel Moll40f99382012-11-22 12:30:24 +1030657 resources[0].flags = IORESOURCE_MEM;
Pawel Moll81a054c2012-05-09 18:30:16 +0100658 resources[0].start = base;
Pawel Moll40f99382012-11-22 12:30:24 +1030659 resources[0].end = base + size - 1;
660
661 resources[1].flags = IORESOURCE_IRQ;
662 resources[1].start = resources[1].end = irq;
Pawel Moll81a054c2012-05-09 18:30:16 +0100663
664 if (!vm_cmdline_parent_registered) {
665 err = device_register(&vm_cmdline_parent);
666 if (err) {
667 pr_err("Failed to register parent device!\n");
668 return err;
669 }
670 vm_cmdline_parent_registered = 1;
671 }
672
673 pr_info("Registering device virtio-mmio.%d at 0x%llx-0x%llx, IRQ %d.\n",
674 vm_cmdline_id,
675 (unsigned long long)resources[0].start,
676 (unsigned long long)resources[0].end,
677 (int)resources[1].start);
678
679 pdev = platform_device_register_resndata(&vm_cmdline_parent,
680 "virtio-mmio", vm_cmdline_id++,
681 resources, ARRAY_SIZE(resources), NULL, 0);
Pawel Moll81a054c2012-05-09 18:30:16 +0100682
Vasyl Gomonovychc2c9f9b2017-11-28 16:15:47 +0100683 return PTR_ERR_OR_ZERO(pdev);
Pawel Moll81a054c2012-05-09 18:30:16 +0100684}
685
686static int vm_cmdline_get_device(struct device *dev, void *data)
687{
688 char *buffer = data;
689 unsigned int len = strlen(buffer);
690 struct platform_device *pdev = to_platform_device(dev);
691
692 snprintf(buffer + len, PAGE_SIZE - len, "0x%llx@0x%llx:%llu:%d\n",
693 pdev->resource[0].end - pdev->resource[0].start + 1ULL,
694 (unsigned long long)pdev->resource[0].start,
695 (unsigned long long)pdev->resource[1].start,
696 pdev->id);
697 return 0;
698}
699
700static int vm_cmdline_get(char *buffer, const struct kernel_param *kp)
701{
702 buffer[0] = '\0';
703 device_for_each_child(&vm_cmdline_parent, buffer,
704 vm_cmdline_get_device);
705 return strlen(buffer) + 1;
706}
707
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930708static const struct kernel_param_ops vm_cmdline_param_ops = {
Pawel Moll81a054c2012-05-09 18:30:16 +0100709 .set = vm_cmdline_set,
710 .get = vm_cmdline_get,
711};
712
713device_param_cb(device, &vm_cmdline_param_ops, NULL, S_IRUSR);
714
715static int vm_unregister_cmdline_device(struct device *dev,
716 void *data)
717{
718 platform_device_unregister(to_platform_device(dev));
719
720 return 0;
721}
722
723static void vm_unregister_cmdline_devices(void)
724{
725 if (vm_cmdline_parent_registered) {
726 device_for_each_child(&vm_cmdline_parent, NULL,
727 vm_unregister_cmdline_device);
728 device_unregister(&vm_cmdline_parent);
729 vm_cmdline_parent_registered = 0;
730 }
731}
732
733#else
734
735static void vm_unregister_cmdline_devices(void)
736{
737}
738
739#endif
740
Pawel Molledfd52e2011-10-24 14:07:03 +0100741/* Platform driver */
742
Arvind Yadav31919142017-06-19 11:44:41 +0530743static const struct of_device_id virtio_mmio_match[] = {
Pawel Molledfd52e2011-10-24 14:07:03 +0100744 { .compatible = "virtio,mmio", },
745 {},
746};
747MODULE_DEVICE_TABLE(of, virtio_mmio_match);
748
Graeme Gregory38c4ab82015-07-28 10:44:02 +0100749#ifdef CONFIG_ACPI
750static const struct acpi_device_id virtio_mmio_acpi_match[] = {
751 { "LNRO0005", },
752 { }
753};
754MODULE_DEVICE_TABLE(acpi, virtio_mmio_acpi_match);
755#endif
756
Pawel Molledfd52e2011-10-24 14:07:03 +0100757static struct platform_driver virtio_mmio_driver = {
758 .probe = virtio_mmio_probe,
Greg Kroah-Hartman8590dbc2012-12-21 13:05:30 -0800759 .remove = virtio_mmio_remove,
Pawel Molledfd52e2011-10-24 14:07:03 +0100760 .driver = {
761 .name = "virtio-mmio",
Pawel Molledfd52e2011-10-24 14:07:03 +0100762 .of_match_table = virtio_mmio_match,
Graeme Gregory38c4ab82015-07-28 10:44:02 +0100763 .acpi_match_table = ACPI_PTR(virtio_mmio_acpi_match),
Pawel Molledfd52e2011-10-24 14:07:03 +0100764 },
765};
766
767static int __init virtio_mmio_init(void)
768{
769 return platform_driver_register(&virtio_mmio_driver);
770}
771
772static void __exit virtio_mmio_exit(void)
773{
774 platform_driver_unregister(&virtio_mmio_driver);
Pawel Moll81a054c2012-05-09 18:30:16 +0100775 vm_unregister_cmdline_devices();
Pawel Molledfd52e2011-10-24 14:07:03 +0100776}
777
778module_init(virtio_mmio_init);
779module_exit(virtio_mmio_exit);
780
781MODULE_AUTHOR("Pawel Moll <pawel.moll@arm.com>");
782MODULE_DESCRIPTION("Platform bus driver for memory mapped virtio devices");
783MODULE_LICENSE("GPL");