blob: d9dd0f7892791047811c54d8a950c40660d0eaac [file] [log] [blame]
Pawel Molledfd52e2011-10-24 14:07:03 +01001/*
2 * Virtio memory mapped device driver
3 *
Pawel Moll1862ee22015-01-23 14:45:55 +10304 * Copyright 2011-2014, ARM Ltd.
Pawel Molledfd52e2011-10-24 14:07:03 +01005 *
6 * This module allows virtio devices to be used over a virtual, memory mapped
7 * platform device.
8 *
Pawel Moll81a054c2012-05-09 18:30:16 +01009 * The guest device(s) may be instantiated in one of three equivalent ways:
10 *
11 * 1. Static platform device in board's code, eg.:
12 *
13 * static struct platform_device v2m_virtio_device = {
14 * .name = "virtio-mmio",
15 * .id = -1,
16 * .num_resources = 2,
17 * .resource = (struct resource []) {
18 * {
19 * .start = 0x1001e000,
20 * .end = 0x1001e0ff,
21 * .flags = IORESOURCE_MEM,
22 * }, {
23 * .start = 42 + 32,
24 * .end = 42 + 32,
25 * .flags = IORESOURCE_IRQ,
26 * },
27 * }
28 * };
29 *
30 * 2. Device Tree node, eg.:
31 *
32 * virtio_block@1e000 {
33 * compatible = "virtio,mmio";
34 * reg = <0x1e000 0x100>;
35 * interrupts = <42>;
36 * }
37 *
38 * 3. Kernel module (or command line) parameter. Can be used more than once -
39 * one device will be created for each one. Syntax:
40 *
41 * [virtio_mmio.]device=<size>@<baseaddr>:<irq>[:<id>]
42 * where:
43 * <size> := size (can use standard suffixes like K, M or G)
44 * <baseaddr> := physical base address
45 * <irq> := interrupt number (as passed to request_irq())
46 * <id> := (optional) platform device id
47 * eg.:
48 * virtio_mmio.device=0x100@0x100b0000:48 \
49 * virtio_mmio.device=1K@0x1001e000:74
50 *
51 *
52 *
Pawel Molledfd52e2011-10-24 14:07:03 +010053 * Based on Virtio PCI driver by Anthony Liguori, copyright IBM Corp. 2007
54 *
55 * This work is licensed under the terms of the GNU GPL, version 2 or later.
56 * See the COPYING file in the top-level directory.
57 */
58
Pawel Moll81a054c2012-05-09 18:30:16 +010059#define pr_fmt(fmt) "virtio-mmio: " fmt
60
Graeme Gregory38c4ab82015-07-28 10:44:02 +010061#include <linux/acpi.h>
Robin Murphyf7f66342017-01-10 17:51:17 +000062#include <linux/dma-mapping.h>
Pawel Molledfd52e2011-10-24 14:07:03 +010063#include <linux/highmem.h>
64#include <linux/interrupt.h>
65#include <linux/io.h>
66#include <linux/list.h>
67#include <linux/module.h>
68#include <linux/platform_device.h>
69#include <linux/slab.h>
70#include <linux/spinlock.h>
71#include <linux/virtio.h>
72#include <linux/virtio_config.h>
Michael S. Tsirkin51be7a92017-01-12 23:36:32 +020073#include <uapi/linux/virtio_mmio.h>
Pawel Molledfd52e2011-10-24 14:07:03 +010074#include <linux/virtio_ring.h>
75
76
77
78/* The alignment to use between consumer and producer parts of vring.
79 * Currently hardcoded to the page size. */
80#define VIRTIO_MMIO_VRING_ALIGN PAGE_SIZE
81
82
83
84#define to_virtio_mmio_device(_plat_dev) \
85 container_of(_plat_dev, struct virtio_mmio_device, vdev)
86
87struct virtio_mmio_device {
88 struct virtio_device vdev;
89 struct platform_device *pdev;
90
91 void __iomem *base;
92 unsigned long version;
93
94 /* a list of queues so we can dispatch IRQs */
95 spinlock_t lock;
96 struct list_head virtqueues;
97};
98
99struct virtio_mmio_vq_info {
100 /* the actual virtqueue */
101 struct virtqueue *vq;
102
Pawel Molledfd52e2011-10-24 14:07:03 +0100103 /* the list node for the virtqueues list */
104 struct list_head node;
105};
106
107
108
109/* Configuration interface */
110
Michael S. Tsirkind0254772014-10-07 16:39:43 +0200111static u64 vm_get_features(struct virtio_device *vdev)
Pawel Molledfd52e2011-10-24 14:07:03 +0100112{
113 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
Pawel Moll1862ee22015-01-23 14:45:55 +1030114 u64 features;
Pawel Molledfd52e2011-10-24 14:07:03 +0100115
Pawel Moll1862ee22015-01-23 14:45:55 +1030116 writel(1, vm_dev->base + VIRTIO_MMIO_DEVICE_FEATURES_SEL);
117 features = readl(vm_dev->base + VIRTIO_MMIO_DEVICE_FEATURES);
118 features <<= 32;
Pawel Molledfd52e2011-10-24 14:07:03 +0100119
Pawel Moll1862ee22015-01-23 14:45:55 +1030120 writel(0, vm_dev->base + VIRTIO_MMIO_DEVICE_FEATURES_SEL);
121 features |= readl(vm_dev->base + VIRTIO_MMIO_DEVICE_FEATURES);
122
123 return features;
Pawel Molledfd52e2011-10-24 14:07:03 +0100124}
125
Michael S. Tsirkin5c609a52014-12-04 20:20:27 +0200126static int vm_finalize_features(struct virtio_device *vdev)
Pawel Molledfd52e2011-10-24 14:07:03 +0100127{
128 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
Pawel Molledfd52e2011-10-24 14:07:03 +0100129
130 /* Give virtio_ring a chance to accept features. */
131 vring_transport_features(vdev);
132
Pawel Moll1862ee22015-01-23 14:45:55 +1030133 /* Make sure there is are no mixed devices */
134 if (vm_dev->version == 2 &&
135 !__virtio_test_bit(vdev, VIRTIO_F_VERSION_1)) {
136 dev_err(&vdev->dev, "New virtio-mmio devices (version 2) must provide VIRTIO_F_VERSION_1 feature!\n");
137 return -EINVAL;
138 }
Michael S. Tsirkin93d389f2014-11-27 13:45:58 +0200139
Pawel Moll1862ee22015-01-23 14:45:55 +1030140 writel(1, vm_dev->base + VIRTIO_MMIO_DRIVER_FEATURES_SEL);
141 writel((u32)(vdev->features >> 32),
142 vm_dev->base + VIRTIO_MMIO_DRIVER_FEATURES);
143
144 writel(0, vm_dev->base + VIRTIO_MMIO_DRIVER_FEATURES_SEL);
145 writel((u32)vdev->features,
146 vm_dev->base + VIRTIO_MMIO_DRIVER_FEATURES);
Michael S. Tsirkin5c609a52014-12-04 20:20:27 +0200147
148 return 0;
Pawel Molledfd52e2011-10-24 14:07:03 +0100149}
150
151static void vm_get(struct virtio_device *vdev, unsigned offset,
152 void *buf, unsigned len)
153{
154 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
Michael S. Tsirkin704a0b52015-03-17 12:11:30 +1030155 void __iomem *base = vm_dev->base + VIRTIO_MMIO_CONFIG;
156 u8 b;
157 __le16 w;
158 __le32 l;
Pawel Molledfd52e2011-10-24 14:07:03 +0100159
Michael S. Tsirkin704a0b52015-03-17 12:11:30 +1030160 if (vm_dev->version == 1) {
161 u8 *ptr = buf;
162 int i;
163
164 for (i = 0; i < len; i++)
165 ptr[i] = readb(base + offset + i);
166 return;
167 }
168
169 switch (len) {
170 case 1:
171 b = readb(base + offset);
172 memcpy(buf, &b, sizeof b);
173 break;
174 case 2:
175 w = cpu_to_le16(readw(base + offset));
176 memcpy(buf, &w, sizeof w);
177 break;
178 case 4:
179 l = cpu_to_le32(readl(base + offset));
180 memcpy(buf, &l, sizeof l);
181 break;
182 case 8:
183 l = cpu_to_le32(readl(base + offset));
184 memcpy(buf, &l, sizeof l);
185 l = cpu_to_le32(ioread32(base + offset + sizeof l));
186 memcpy(buf + sizeof l, &l, sizeof l);
187 break;
188 default:
189 BUG();
190 }
Pawel Molledfd52e2011-10-24 14:07:03 +0100191}
192
193static void vm_set(struct virtio_device *vdev, unsigned offset,
194 const void *buf, unsigned len)
195{
196 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
Michael S. Tsirkin704a0b52015-03-17 12:11:30 +1030197 void __iomem *base = vm_dev->base + VIRTIO_MMIO_CONFIG;
198 u8 b;
199 __le16 w;
200 __le32 l;
Pawel Molledfd52e2011-10-24 14:07:03 +0100201
Michael S. Tsirkin704a0b52015-03-17 12:11:30 +1030202 if (vm_dev->version == 1) {
203 const u8 *ptr = buf;
204 int i;
205
206 for (i = 0; i < len; i++)
207 writeb(ptr[i], base + offset + i);
208
209 return;
210 }
211
212 switch (len) {
213 case 1:
214 memcpy(&b, buf, sizeof b);
215 writeb(b, base + offset);
216 break;
217 case 2:
218 memcpy(&w, buf, sizeof w);
219 writew(le16_to_cpu(w), base + offset);
220 break;
221 case 4:
222 memcpy(&l, buf, sizeof l);
223 writel(le32_to_cpu(l), base + offset);
224 break;
225 case 8:
226 memcpy(&l, buf, sizeof l);
227 writel(le32_to_cpu(l), base + offset);
228 memcpy(&l, buf + sizeof l, sizeof l);
229 writel(le32_to_cpu(l), base + offset + sizeof l);
230 break;
231 default:
232 BUG();
233 }
Pawel Molledfd52e2011-10-24 14:07:03 +0100234}
235
Michael S. Tsirkin87e7bf12015-03-12 12:56:43 +1030236static u32 vm_generation(struct virtio_device *vdev)
237{
238 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
239
240 if (vm_dev->version == 1)
241 return 0;
242 else
243 return readl(vm_dev->base + VIRTIO_MMIO_CONFIG_GENERATION);
244}
245
Pawel Molledfd52e2011-10-24 14:07:03 +0100246static u8 vm_get_status(struct virtio_device *vdev)
247{
248 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
249
250 return readl(vm_dev->base + VIRTIO_MMIO_STATUS) & 0xff;
251}
252
253static void vm_set_status(struct virtio_device *vdev, u8 status)
254{
255 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
256
257 /* We should never be setting status to 0. */
258 BUG_ON(status == 0);
259
260 writel(status, vm_dev->base + VIRTIO_MMIO_STATUS);
261}
262
263static void vm_reset(struct virtio_device *vdev)
264{
265 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
266
267 /* 0 status means a reset. */
268 writel(0, vm_dev->base + VIRTIO_MMIO_STATUS);
269}
270
271
272
273/* Transport interface */
274
275/* the notify function used when creating a virt queue */
Heinz Graalfs46f9c2b2013-10-29 09:38:50 +1030276static bool vm_notify(struct virtqueue *vq)
Pawel Molledfd52e2011-10-24 14:07:03 +0100277{
278 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vq->vdev);
Pawel Molledfd52e2011-10-24 14:07:03 +0100279
280 /* We write the queue's selector into the notification register to
281 * signal the other end */
Rusty Russell06ca2872012-10-16 23:56:14 +1030282 writel(vq->index, vm_dev->base + VIRTIO_MMIO_QUEUE_NOTIFY);
Heinz Graalfs46f9c2b2013-10-29 09:38:50 +1030283 return true;
Pawel Molledfd52e2011-10-24 14:07:03 +0100284}
285
286/* Notify all virtqueues on an interrupt. */
287static irqreturn_t vm_interrupt(int irq, void *opaque)
288{
289 struct virtio_mmio_device *vm_dev = opaque;
290 struct virtio_mmio_vq_info *info;
Pawel Molledfd52e2011-10-24 14:07:03 +0100291 unsigned long status;
292 unsigned long flags;
293 irqreturn_t ret = IRQ_NONE;
294
295 /* Read and acknowledge interrupts */
296 status = readl(vm_dev->base + VIRTIO_MMIO_INTERRUPT_STATUS);
297 writel(status, vm_dev->base + VIRTIO_MMIO_INTERRUPT_ACK);
298
Michael S. Tsirkin016c98c2014-10-14 10:40:34 +1030299 if (unlikely(status & VIRTIO_MMIO_INT_CONFIG)) {
300 virtio_config_changed(&vm_dev->vdev);
Pawel Molledfd52e2011-10-24 14:07:03 +0100301 ret = IRQ_HANDLED;
302 }
303
304 if (likely(status & VIRTIO_MMIO_INT_VRING)) {
305 spin_lock_irqsave(&vm_dev->lock, flags);
306 list_for_each_entry(info, &vm_dev->virtqueues, node)
307 ret |= vring_interrupt(irq, info->vq);
308 spin_unlock_irqrestore(&vm_dev->lock, flags);
309 }
310
311 return ret;
312}
313
314
315
316static void vm_del_vq(struct virtqueue *vq)
317{
318 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vq->vdev);
319 struct virtio_mmio_vq_info *info = vq->priv;
Andy Lutomirskib4211132016-02-02 21:46:38 -0800320 unsigned long flags;
Rusty Russell06ca2872012-10-16 23:56:14 +1030321 unsigned int index = vq->index;
Pawel Molledfd52e2011-10-24 14:07:03 +0100322
323 spin_lock_irqsave(&vm_dev->lock, flags);
324 list_del(&info->node);
325 spin_unlock_irqrestore(&vm_dev->lock, flags);
326
Pawel Molledfd52e2011-10-24 14:07:03 +0100327 /* Select and deactivate the queue */
Jason Wang17bb6d42012-08-28 13:54:13 +0200328 writel(index, vm_dev->base + VIRTIO_MMIO_QUEUE_SEL);
Pawel Moll1862ee22015-01-23 14:45:55 +1030329 if (vm_dev->version == 1) {
330 writel(0, vm_dev->base + VIRTIO_MMIO_QUEUE_PFN);
331 } else {
332 writel(0, vm_dev->base + VIRTIO_MMIO_QUEUE_READY);
333 WARN_ON(readl(vm_dev->base + VIRTIO_MMIO_QUEUE_READY));
334 }
Pawel Molledfd52e2011-10-24 14:07:03 +0100335
Andy Lutomirskib4211132016-02-02 21:46:38 -0800336 vring_del_virtqueue(vq);
337
Pawel Molledfd52e2011-10-24 14:07:03 +0100338 kfree(info);
339}
340
341static void vm_del_vqs(struct virtio_device *vdev)
342{
343 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
344 struct virtqueue *vq, *n;
345
346 list_for_each_entry_safe(vq, n, &vdev->vqs, list)
347 vm_del_vq(vq);
348
349 free_irq(platform_get_irq(vm_dev->pdev, 0), vm_dev);
350}
351
Pawel Molledfd52e2011-10-24 14:07:03 +0100352static struct virtqueue *vm_setup_vq(struct virtio_device *vdev, unsigned index,
353 void (*callback)(struct virtqueue *vq),
Michael S. Tsirkinf94682d2017-03-06 18:32:29 +0200354 const char *name, bool ctx)
Pawel Molledfd52e2011-10-24 14:07:03 +0100355{
356 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
357 struct virtio_mmio_vq_info *info;
358 struct virtqueue *vq;
Andy Lutomirskib4211132016-02-02 21:46:38 -0800359 unsigned long flags;
360 unsigned int num;
Pawel Molledfd52e2011-10-24 14:07:03 +0100361 int err;
362
Michael S. Tsirkin6457f122012-09-05 21:47:45 +0300363 if (!name)
364 return NULL;
365
Pawel Molledfd52e2011-10-24 14:07:03 +0100366 /* Select the queue we're interested in */
367 writel(index, vm_dev->base + VIRTIO_MMIO_QUEUE_SEL);
368
369 /* Queue shouldn't already be set up. */
Pawel Moll1862ee22015-01-23 14:45:55 +1030370 if (readl(vm_dev->base + (vm_dev->version == 1 ?
371 VIRTIO_MMIO_QUEUE_PFN : VIRTIO_MMIO_QUEUE_READY))) {
Pawel Molledfd52e2011-10-24 14:07:03 +0100372 err = -ENOENT;
373 goto error_available;
374 }
375
376 /* Allocate and fill out our active queue description */
377 info = kmalloc(sizeof(*info), GFP_KERNEL);
378 if (!info) {
379 err = -ENOMEM;
380 goto error_kmalloc;
381 }
Pawel Molledfd52e2011-10-24 14:07:03 +0100382
Andy Lutomirskib4211132016-02-02 21:46:38 -0800383 num = readl(vm_dev->base + VIRTIO_MMIO_QUEUE_NUM_MAX);
384 if (num == 0) {
Brian Foleyd78b5192012-09-24 14:33:42 +0100385 err = -ENOENT;
Andy Lutomirskib4211132016-02-02 21:46:38 -0800386 goto error_new_virtqueue;
Pawel Molledfd52e2011-10-24 14:07:03 +0100387 }
388
Pawel Molledfd52e2011-10-24 14:07:03 +0100389 /* Create the vring */
Andy Lutomirskib4211132016-02-02 21:46:38 -0800390 vq = vring_create_virtqueue(index, num, VIRTIO_MMIO_VRING_ALIGN, vdev,
Michael S. Tsirkinf94682d2017-03-06 18:32:29 +0200391 true, true, ctx, vm_notify, callback, name);
Pawel Molledfd52e2011-10-24 14:07:03 +0100392 if (!vq) {
393 err = -ENOMEM;
394 goto error_new_virtqueue;
395 }
396
Pawel Moll1862ee22015-01-23 14:45:55 +1030397 /* Activate the queue */
Andy Lutomirskib4211132016-02-02 21:46:38 -0800398 writel(virtqueue_get_vring_size(vq), vm_dev->base + VIRTIO_MMIO_QUEUE_NUM);
Pawel Moll1862ee22015-01-23 14:45:55 +1030399 if (vm_dev->version == 1) {
Suzuki K Poulose3fc92a92018-07-18 10:18:44 +0100400 u64 q_pfn = virtqueue_get_desc_addr(vq) >> PAGE_SHIFT;
401
402 /*
403 * virtio-mmio v1 uses a 32bit QUEUE PFN. If we have something
404 * that doesn't fit in 32bit, fail the setup rather than
405 * pretending to be successful.
406 */
407 if (q_pfn >> 32) {
408 dev_err(&vdev->dev,
409 "platform bug: legacy virtio-mmio must not be used with RAM above 0x%llxGB\n",
410 0x1ULL << (32 + PAGE_SHIFT - 30));
411 err = -E2BIG;
412 goto error_bad_pfn;
413 }
414
Pawel Moll1862ee22015-01-23 14:45:55 +1030415 writel(PAGE_SIZE, vm_dev->base + VIRTIO_MMIO_QUEUE_ALIGN);
Suzuki K Poulose3fc92a92018-07-18 10:18:44 +0100416 writel(q_pfn, vm_dev->base + VIRTIO_MMIO_QUEUE_PFN);
Pawel Moll1862ee22015-01-23 14:45:55 +1030417 } else {
418 u64 addr;
419
Andy Lutomirskib4211132016-02-02 21:46:38 -0800420 addr = virtqueue_get_desc_addr(vq);
Pawel Moll1862ee22015-01-23 14:45:55 +1030421 writel((u32)addr, vm_dev->base + VIRTIO_MMIO_QUEUE_DESC_LOW);
422 writel((u32)(addr >> 32),
423 vm_dev->base + VIRTIO_MMIO_QUEUE_DESC_HIGH);
424
Andy Lutomirskib4211132016-02-02 21:46:38 -0800425 addr = virtqueue_get_avail_addr(vq);
Pawel Moll1862ee22015-01-23 14:45:55 +1030426 writel((u32)addr, vm_dev->base + VIRTIO_MMIO_QUEUE_AVAIL_LOW);
427 writel((u32)(addr >> 32),
428 vm_dev->base + VIRTIO_MMIO_QUEUE_AVAIL_HIGH);
429
Andy Lutomirskib4211132016-02-02 21:46:38 -0800430 addr = virtqueue_get_used_addr(vq);
Pawel Moll1862ee22015-01-23 14:45:55 +1030431 writel((u32)addr, vm_dev->base + VIRTIO_MMIO_QUEUE_USED_LOW);
432 writel((u32)(addr >> 32),
433 vm_dev->base + VIRTIO_MMIO_QUEUE_USED_HIGH);
434
435 writel(1, vm_dev->base + VIRTIO_MMIO_QUEUE_READY);
436 }
437
Pawel Molledfd52e2011-10-24 14:07:03 +0100438 vq->priv = info;
439 info->vq = vq;
440
441 spin_lock_irqsave(&vm_dev->lock, flags);
442 list_add(&info->node, &vm_dev->virtqueues);
443 spin_unlock_irqrestore(&vm_dev->lock, flags);
444
445 return vq;
446
Suzuki K Poulose3fc92a92018-07-18 10:18:44 +0100447error_bad_pfn:
448 vring_del_virtqueue(vq);
Pawel Molledfd52e2011-10-24 14:07:03 +0100449error_new_virtqueue:
Pawel Moll1862ee22015-01-23 14:45:55 +1030450 if (vm_dev->version == 1) {
451 writel(0, vm_dev->base + VIRTIO_MMIO_QUEUE_PFN);
452 } else {
453 writel(0, vm_dev->base + VIRTIO_MMIO_QUEUE_READY);
454 WARN_ON(readl(vm_dev->base + VIRTIO_MMIO_QUEUE_READY));
455 }
Pawel Molledfd52e2011-10-24 14:07:03 +0100456 kfree(info);
457error_kmalloc:
458error_available:
459 return ERR_PTR(err);
460}
461
462static int vm_find_vqs(struct virtio_device *vdev, unsigned nvqs,
463 struct virtqueue *vqs[],
464 vq_callback_t *callbacks[],
Christoph Hellwigfb5e31d2017-02-05 18:15:22 +0100465 const char * const names[],
Michael S. Tsirkinf94682d2017-03-06 18:32:29 +0200466 const bool *ctx,
Christoph Hellwigfb5e31d2017-02-05 18:15:22 +0100467 struct irq_affinity *desc)
Pawel Molledfd52e2011-10-24 14:07:03 +0100468{
469 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
470 unsigned int irq = platform_get_irq(vm_dev->pdev, 0);
Wei Wanga2299892018-12-28 10:26:26 +0800471 int i, err, queue_idx = 0;
Pawel Molledfd52e2011-10-24 14:07:03 +0100472
473 err = request_irq(irq, vm_interrupt, IRQF_SHARED,
474 dev_name(&vdev->dev), vm_dev);
475 if (err)
476 return err;
477
478 for (i = 0; i < nvqs; ++i) {
Wei Wanga2299892018-12-28 10:26:26 +0800479 if (!names[i]) {
480 vqs[i] = NULL;
481 continue;
482 }
483
484 vqs[i] = vm_setup_vq(vdev, queue_idx++, callbacks[i], names[i],
Michael S. Tsirkinf94682d2017-03-06 18:32:29 +0200485 ctx ? ctx[i] : false);
Pawel Molledfd52e2011-10-24 14:07:03 +0100486 if (IS_ERR(vqs[i])) {
487 vm_del_vqs(vdev);
488 return PTR_ERR(vqs[i]);
489 }
490 }
491
492 return 0;
493}
494
Rick Jones66846042011-11-14 14:17:08 +0000495static const char *vm_bus_name(struct virtio_device *vdev)
496{
497 struct virtio_mmio_device *vm_dev = to_virtio_mmio_device(vdev);
Pawel Molledfd52e2011-10-24 14:07:03 +0100498
Rick Jones66846042011-11-14 14:17:08 +0000499 return vm_dev->pdev->name;
500}
Pawel Molledfd52e2011-10-24 14:07:03 +0100501
Stephen Hemminger93503932013-02-10 15:57:38 +1030502static const struct virtio_config_ops virtio_mmio_config_ops = {
Pawel Molledfd52e2011-10-24 14:07:03 +0100503 .get = vm_get,
504 .set = vm_set,
Michael S. Tsirkin87e7bf12015-03-12 12:56:43 +1030505 .generation = vm_generation,
Pawel Molledfd52e2011-10-24 14:07:03 +0100506 .get_status = vm_get_status,
507 .set_status = vm_set_status,
508 .reset = vm_reset,
509 .find_vqs = vm_find_vqs,
510 .del_vqs = vm_del_vqs,
511 .get_features = vm_get_features,
512 .finalize_features = vm_finalize_features,
Rick Jones66846042011-11-14 14:17:08 +0000513 .bus_name = vm_bus_name,
Pawel Molledfd52e2011-10-24 14:07:03 +0100514};
515
516
weiping zhang7eb781b2017-12-06 21:59:16 +0800517static void virtio_mmio_release_dev(struct device *_d)
518{
519 struct virtio_device *vdev =
520 container_of(_d, struct virtio_device, dev);
521 struct virtio_mmio_device *vm_dev =
522 container_of(vdev, struct virtio_mmio_device, vdev);
523 struct platform_device *pdev = vm_dev->pdev;
524
525 devm_kfree(&pdev->dev, vm_dev);
526}
Pawel Molledfd52e2011-10-24 14:07:03 +0100527
528/* Platform device */
529
Greg Kroah-Hartman8590dbc2012-12-21 13:05:30 -0800530static int virtio_mmio_probe(struct platform_device *pdev)
Pawel Molledfd52e2011-10-24 14:07:03 +0100531{
532 struct virtio_mmio_device *vm_dev;
533 struct resource *mem;
534 unsigned long magic;
Robin Murphyf7f66342017-01-10 17:51:17 +0000535 int rc;
Pawel Molledfd52e2011-10-24 14:07:03 +0100536
537 mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
538 if (!mem)
539 return -EINVAL;
540
541 if (!devm_request_mem_region(&pdev->dev, mem->start,
542 resource_size(mem), pdev->name))
543 return -EBUSY;
544
545 vm_dev = devm_kzalloc(&pdev->dev, sizeof(*vm_dev), GFP_KERNEL);
Mark Rutlandc2e90802017-12-12 13:45:50 +0000546 if (!vm_dev)
547 return -ENOMEM;
Pawel Molledfd52e2011-10-24 14:07:03 +0100548
549 vm_dev->vdev.dev.parent = &pdev->dev;
weiping zhang7eb781b2017-12-06 21:59:16 +0800550 vm_dev->vdev.dev.release = virtio_mmio_release_dev;
Pawel Molledfd52e2011-10-24 14:07:03 +0100551 vm_dev->vdev.config = &virtio_mmio_config_ops;
552 vm_dev->pdev = pdev;
553 INIT_LIST_HEAD(&vm_dev->virtqueues);
554 spin_lock_init(&vm_dev->lock);
555
556 vm_dev->base = devm_ioremap(&pdev->dev, mem->start, resource_size(mem));
Mark Rutlandc2e90802017-12-12 13:45:50 +0000557 if (vm_dev->base == NULL)
558 return -EFAULT;
Pawel Molledfd52e2011-10-24 14:07:03 +0100559
560 /* Check magic value */
561 magic = readl(vm_dev->base + VIRTIO_MMIO_MAGIC_VALUE);
Marc Zyngier4ae85372013-11-05 21:21:28 +1030562 if (magic != ('v' | 'i' << 8 | 'r' << 16 | 't' << 24)) {
Pawel Molledfd52e2011-10-24 14:07:03 +0100563 dev_warn(&pdev->dev, "Wrong magic value 0x%08lx!\n", magic);
Mark Rutlandc2e90802017-12-12 13:45:50 +0000564 return -ENODEV;
Pawel Molledfd52e2011-10-24 14:07:03 +0100565 }
566
567 /* Check device version */
568 vm_dev->version = readl(vm_dev->base + VIRTIO_MMIO_VERSION);
Pawel Moll1862ee22015-01-23 14:45:55 +1030569 if (vm_dev->version < 1 || vm_dev->version > 2) {
Pawel Molledfd52e2011-10-24 14:07:03 +0100570 dev_err(&pdev->dev, "Version %ld not supported!\n",
571 vm_dev->version);
Mark Rutlandc2e90802017-12-12 13:45:50 +0000572 return -ENXIO;
Pawel Molledfd52e2011-10-24 14:07:03 +0100573 }
574
575 vm_dev->vdev.id.device = readl(vm_dev->base + VIRTIO_MMIO_DEVICE_ID);
Pawel Moll1862ee22015-01-23 14:45:55 +1030576 if (vm_dev->vdev.id.device == 0) {
577 /*
578 * virtio-mmio device with an ID 0 is a (dummy) placeholder
579 * with no function. End probing now with no error reported.
580 */
Mark Rutlandc2e90802017-12-12 13:45:50 +0000581 return -ENODEV;
Pawel Moll1862ee22015-01-23 14:45:55 +1030582 }
Pawel Molledfd52e2011-10-24 14:07:03 +0100583 vm_dev->vdev.id.vendor = readl(vm_dev->base + VIRTIO_MMIO_VENDOR_ID);
584
Robin Murphyf7f66342017-01-10 17:51:17 +0000585 if (vm_dev->version == 1) {
Pawel Moll1862ee22015-01-23 14:45:55 +1030586 writel(PAGE_SIZE, vm_dev->base + VIRTIO_MMIO_GUEST_PAGE_SIZE);
Pawel Molledfd52e2011-10-24 14:07:03 +0100587
Robin Murphyf7f66342017-01-10 17:51:17 +0000588 rc = dma_set_mask(&pdev->dev, DMA_BIT_MASK(64));
589 /*
590 * In the legacy case, ensure our coherently-allocated virtio
591 * ring will be at an address expressable as a 32-bit PFN.
592 */
593 if (!rc)
594 dma_set_coherent_mask(&pdev->dev,
595 DMA_BIT_MASK(32 + PAGE_SHIFT));
596 } else {
597 rc = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(64));
598 }
599 if (rc)
600 rc = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
601 if (rc)
602 dev_warn(&pdev->dev, "Failed to enable 64-bit or 32-bit DMA. Trying to continue, but this might not work.\n");
603
Pawel Molledfd52e2011-10-24 14:07:03 +0100604 platform_set_drvdata(pdev, vm_dev);
605
weiping zhang7eb781b2017-12-06 21:59:16 +0800606 rc = register_virtio_device(&vm_dev->vdev);
Mark Rutlandc2e90802017-12-12 13:45:50 +0000607 if (rc)
weiping zhang7eb781b2017-12-06 21:59:16 +0800608 put_device(&vm_dev->vdev.dev);
Mark Rutlandc2e90802017-12-12 13:45:50 +0000609
weiping zhang7eb781b2017-12-06 21:59:16 +0800610 return rc;
Pawel Molledfd52e2011-10-24 14:07:03 +0100611}
612
Greg Kroah-Hartman8590dbc2012-12-21 13:05:30 -0800613static int virtio_mmio_remove(struct platform_device *pdev)
Pawel Molledfd52e2011-10-24 14:07:03 +0100614{
615 struct virtio_mmio_device *vm_dev = platform_get_drvdata(pdev);
Pawel Molledfd52e2011-10-24 14:07:03 +0100616 unregister_virtio_device(&vm_dev->vdev);
617
618 return 0;
619}
620
621
622
Pawel Moll81a054c2012-05-09 18:30:16 +0100623/* Devices list parameter */
624
625#if defined(CONFIG_VIRTIO_MMIO_CMDLINE_DEVICES)
626
627static struct device vm_cmdline_parent = {
628 .init_name = "virtio-mmio-cmdline",
629};
630
631static int vm_cmdline_parent_registered;
632static int vm_cmdline_id;
633
634static int vm_cmdline_set(const char *device,
635 const struct kernel_param *kp)
636{
637 int err;
638 struct resource resources[2] = {};
639 char *str;
Pawel Moll40f99382012-11-22 12:30:24 +1030640 long long int base, size;
641 unsigned int irq;
Pawel Moll81a054c2012-05-09 18:30:16 +0100642 int processed, consumed = 0;
643 struct platform_device *pdev;
644
Pawel Moll40f99382012-11-22 12:30:24 +1030645 /* Consume "size" part of the command line parameter */
646 size = memparse(device, &str);
Pawel Moll81a054c2012-05-09 18:30:16 +0100647
Pawel Moll40f99382012-11-22 12:30:24 +1030648 /* Get "@<base>:<irq>[:<id>]" chunks */
Pawel Moll81a054c2012-05-09 18:30:16 +0100649 processed = sscanf(str, "@%lli:%u%n:%d%n",
Pawel Moll40f99382012-11-22 12:30:24 +1030650 &base, &irq, &consumed,
Pawel Moll81a054c2012-05-09 18:30:16 +0100651 &vm_cmdline_id, &consumed);
652
Pawel Moll40f99382012-11-22 12:30:24 +1030653 /*
654 * sscanf() must processes at least 2 chunks; also there
655 * must be no extra characters after the last chunk, so
656 * str[consumed] must be '\0'
657 */
658 if (processed < 2 || str[consumed])
Pawel Moll81a054c2012-05-09 18:30:16 +0100659 return -EINVAL;
660
Pawel Moll40f99382012-11-22 12:30:24 +1030661 resources[0].flags = IORESOURCE_MEM;
Pawel Moll81a054c2012-05-09 18:30:16 +0100662 resources[0].start = base;
Pawel Moll40f99382012-11-22 12:30:24 +1030663 resources[0].end = base + size - 1;
664
665 resources[1].flags = IORESOURCE_IRQ;
666 resources[1].start = resources[1].end = irq;
Pawel Moll81a054c2012-05-09 18:30:16 +0100667
668 if (!vm_cmdline_parent_registered) {
669 err = device_register(&vm_cmdline_parent);
670 if (err) {
671 pr_err("Failed to register parent device!\n");
672 return err;
673 }
674 vm_cmdline_parent_registered = 1;
675 }
676
677 pr_info("Registering device virtio-mmio.%d at 0x%llx-0x%llx, IRQ %d.\n",
678 vm_cmdline_id,
679 (unsigned long long)resources[0].start,
680 (unsigned long long)resources[0].end,
681 (int)resources[1].start);
682
683 pdev = platform_device_register_resndata(&vm_cmdline_parent,
684 "virtio-mmio", vm_cmdline_id++,
685 resources, ARRAY_SIZE(resources), NULL, 0);
Pawel Moll81a054c2012-05-09 18:30:16 +0100686
Vasyl Gomonovychc2c9f9b2017-11-28 16:15:47 +0100687 return PTR_ERR_OR_ZERO(pdev);
Pawel Moll81a054c2012-05-09 18:30:16 +0100688}
689
690static int vm_cmdline_get_device(struct device *dev, void *data)
691{
692 char *buffer = data;
693 unsigned int len = strlen(buffer);
694 struct platform_device *pdev = to_platform_device(dev);
695
696 snprintf(buffer + len, PAGE_SIZE - len, "0x%llx@0x%llx:%llu:%d\n",
697 pdev->resource[0].end - pdev->resource[0].start + 1ULL,
698 (unsigned long long)pdev->resource[0].start,
699 (unsigned long long)pdev->resource[1].start,
700 pdev->id);
701 return 0;
702}
703
704static int vm_cmdline_get(char *buffer, const struct kernel_param *kp)
705{
706 buffer[0] = '\0';
707 device_for_each_child(&vm_cmdline_parent, buffer,
708 vm_cmdline_get_device);
709 return strlen(buffer) + 1;
710}
711
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930712static const struct kernel_param_ops vm_cmdline_param_ops = {
Pawel Moll81a054c2012-05-09 18:30:16 +0100713 .set = vm_cmdline_set,
714 .get = vm_cmdline_get,
715};
716
717device_param_cb(device, &vm_cmdline_param_ops, NULL, S_IRUSR);
718
719static int vm_unregister_cmdline_device(struct device *dev,
720 void *data)
721{
722 platform_device_unregister(to_platform_device(dev));
723
724 return 0;
725}
726
727static void vm_unregister_cmdline_devices(void)
728{
729 if (vm_cmdline_parent_registered) {
730 device_for_each_child(&vm_cmdline_parent, NULL,
731 vm_unregister_cmdline_device);
732 device_unregister(&vm_cmdline_parent);
733 vm_cmdline_parent_registered = 0;
734 }
735}
736
737#else
738
739static void vm_unregister_cmdline_devices(void)
740{
741}
742
743#endif
744
Pawel Molledfd52e2011-10-24 14:07:03 +0100745/* Platform driver */
746
Arvind Yadav31919142017-06-19 11:44:41 +0530747static const struct of_device_id virtio_mmio_match[] = {
Pawel Molledfd52e2011-10-24 14:07:03 +0100748 { .compatible = "virtio,mmio", },
749 {},
750};
751MODULE_DEVICE_TABLE(of, virtio_mmio_match);
752
Graeme Gregory38c4ab82015-07-28 10:44:02 +0100753#ifdef CONFIG_ACPI
754static const struct acpi_device_id virtio_mmio_acpi_match[] = {
755 { "LNRO0005", },
756 { }
757};
758MODULE_DEVICE_TABLE(acpi, virtio_mmio_acpi_match);
759#endif
760
Pawel Molledfd52e2011-10-24 14:07:03 +0100761static struct platform_driver virtio_mmio_driver = {
762 .probe = virtio_mmio_probe,
Greg Kroah-Hartman8590dbc2012-12-21 13:05:30 -0800763 .remove = virtio_mmio_remove,
Pawel Molledfd52e2011-10-24 14:07:03 +0100764 .driver = {
765 .name = "virtio-mmio",
Pawel Molledfd52e2011-10-24 14:07:03 +0100766 .of_match_table = virtio_mmio_match,
Graeme Gregory38c4ab82015-07-28 10:44:02 +0100767 .acpi_match_table = ACPI_PTR(virtio_mmio_acpi_match),
Pawel Molledfd52e2011-10-24 14:07:03 +0100768 },
769};
770
771static int __init virtio_mmio_init(void)
772{
773 return platform_driver_register(&virtio_mmio_driver);
774}
775
776static void __exit virtio_mmio_exit(void)
777{
778 platform_driver_unregister(&virtio_mmio_driver);
Pawel Moll81a054c2012-05-09 18:30:16 +0100779 vm_unregister_cmdline_devices();
Pawel Molledfd52e2011-10-24 14:07:03 +0100780}
781
782module_init(virtio_mmio_init);
783module_exit(virtio_mmio_exit);
784
785MODULE_AUTHOR("Pawel Moll <pawel.moll@arm.com>");
786MODULE_DESCRIPTION("Platform bus driver for memory mapped virtio devices");
787MODULE_LICENSE("GPL");