2 * Copyright (c) 2014 Ruslan Bukin <br@bsdpad.com>
3 * Copyright (c) 2014 The FreeBSD Foundation
6 * This software was developed by SRI International and the University of
7 * Cambridge Computer Laboratory under DARPA/AFRL contract (FA8750-10-C-0237)
8 * ("CTSRD"), as part of the DARPA CRASH research programme.
10 * Portions of this software were developed by Andrew Turner
11 * under sponsorship from the FreeBSD Foundation.
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 * VirtIO MMIO interface.
37 * This driver is heavily based on VirtIO PCI interface driver.
40 #include <sys/cdefs.h>
41 __FBSDID("$FreeBSD$");
43 #include <sys/param.h>
44 #include <sys/systm.h>
46 #include <sys/kernel.h>
47 #include <sys/module.h>
48 #include <sys/malloc.h>
51 #include <machine/bus.h>
52 #include <machine/resource.h>
54 #include <dev/virtio/virtio.h>
55 #include <dev/virtio/virtqueue.h>
56 #include <dev/virtio/mmio/virtio_mmio.h>
58 #include "virtio_mmio_if.h"
59 #include "virtio_bus_if.h"
60 #include "virtio_if.h"
64 struct vtmmio_virtqueue {
65 struct virtqueue *vtv_vq;
69 static int vtmmio_detach(device_t);
70 static int vtmmio_suspend(device_t);
71 static int vtmmio_resume(device_t);
72 static int vtmmio_shutdown(device_t);
73 static void vtmmio_driver_added(device_t, driver_t *);
74 static void vtmmio_child_detached(device_t, device_t);
75 static int vtmmio_read_ivar(device_t, device_t, int, uintptr_t *);
76 static int vtmmio_write_ivar(device_t, device_t, int, uintptr_t);
77 static uint64_t vtmmio_negotiate_features(device_t, uint64_t);
78 static int vtmmio_with_feature(device_t, uint64_t);
79 static int vtmmio_alloc_virtqueues(device_t, int, int,
80 struct vq_alloc_info *);
81 static int vtmmio_setup_intr(device_t, enum intr_type);
82 static void vtmmio_stop(device_t);
83 static void vtmmio_poll(device_t);
84 static int vtmmio_reinit(device_t, uint64_t);
85 static void vtmmio_reinit_complete(device_t);
86 static void vtmmio_notify_virtqueue(device_t, uint16_t);
87 static uint8_t vtmmio_get_status(device_t);
88 static void vtmmio_set_status(device_t, uint8_t);
89 static void vtmmio_read_dev_config(device_t, bus_size_t, void *, int);
90 static void vtmmio_write_dev_config(device_t, bus_size_t, void *, int);
91 static void vtmmio_describe_features(struct vtmmio_softc *, const char *,
93 static void vtmmio_probe_and_attach_child(struct vtmmio_softc *);
94 static int vtmmio_reinit_virtqueue(struct vtmmio_softc *, int);
95 static void vtmmio_free_interrupts(struct vtmmio_softc *);
96 static void vtmmio_free_virtqueues(struct vtmmio_softc *);
97 static void vtmmio_release_child_resources(struct vtmmio_softc *);
98 static void vtmmio_reset(struct vtmmio_softc *);
99 static void vtmmio_select_virtqueue(struct vtmmio_softc *, int);
100 static void vtmmio_vq_intr(void *);
103 * I/O port read/write wrappers.
105 #define vtmmio_write_config_1(sc, o, v) \
107 if (sc->platform != NULL) \
108 VIRTIO_MMIO_PREWRITE(sc->platform, (o), (v)); \
109 bus_write_1((sc)->res[0], (o), (v)); \
110 if (sc->platform != NULL) \
111 VIRTIO_MMIO_NOTE(sc->platform, (o), (v)); \
113 #define vtmmio_write_config_2(sc, o, v) \
115 if (sc->platform != NULL) \
116 VIRTIO_MMIO_PREWRITE(sc->platform, (o), (v)); \
117 bus_write_2((sc)->res[0], (o), (v)); \
118 if (sc->platform != NULL) \
119 VIRTIO_MMIO_NOTE(sc->platform, (o), (v)); \
121 #define vtmmio_write_config_4(sc, o, v) \
123 if (sc->platform != NULL) \
124 VIRTIO_MMIO_PREWRITE(sc->platform, (o), (v)); \
125 bus_write_4((sc)->res[0], (o), (v)); \
126 if (sc->platform != NULL) \
127 VIRTIO_MMIO_NOTE(sc->platform, (o), (v)); \
130 #define vtmmio_read_config_1(sc, o) \
131 bus_read_1((sc)->res[0], (o))
132 #define vtmmio_read_config_2(sc, o) \
133 bus_read_2((sc)->res[0], (o))
134 #define vtmmio_read_config_4(sc, o) \
135 bus_read_4((sc)->res[0], (o))
137 static device_method_t vtmmio_methods[] = {
138 /* Device interface. */
139 DEVMETHOD(device_attach, vtmmio_attach),
140 DEVMETHOD(device_detach, vtmmio_detach),
141 DEVMETHOD(device_suspend, vtmmio_suspend),
142 DEVMETHOD(device_resume, vtmmio_resume),
143 DEVMETHOD(device_shutdown, vtmmio_shutdown),
146 DEVMETHOD(bus_driver_added, vtmmio_driver_added),
147 DEVMETHOD(bus_child_detached, vtmmio_child_detached),
148 DEVMETHOD(bus_child_pnpinfo_str, virtio_child_pnpinfo_str),
149 DEVMETHOD(bus_read_ivar, vtmmio_read_ivar),
150 DEVMETHOD(bus_write_ivar, vtmmio_write_ivar),
152 /* VirtIO bus interface. */
153 DEVMETHOD(virtio_bus_negotiate_features, vtmmio_negotiate_features),
154 DEVMETHOD(virtio_bus_with_feature, vtmmio_with_feature),
155 DEVMETHOD(virtio_bus_alloc_virtqueues, vtmmio_alloc_virtqueues),
156 DEVMETHOD(virtio_bus_setup_intr, vtmmio_setup_intr),
157 DEVMETHOD(virtio_bus_stop, vtmmio_stop),
158 DEVMETHOD(virtio_bus_poll, vtmmio_poll),
159 DEVMETHOD(virtio_bus_reinit, vtmmio_reinit),
160 DEVMETHOD(virtio_bus_reinit_complete, vtmmio_reinit_complete),
161 DEVMETHOD(virtio_bus_notify_vq, vtmmio_notify_virtqueue),
162 DEVMETHOD(virtio_bus_read_device_config, vtmmio_read_dev_config),
163 DEVMETHOD(virtio_bus_write_device_config, vtmmio_write_dev_config),
168 DEFINE_CLASS_0(virtio_mmio, vtmmio_driver, vtmmio_methods,
169 sizeof(struct vtmmio_softc));
171 MODULE_VERSION(virtio_mmio, 1);
174 vtmmio_setup_intr(device_t dev, enum intr_type type)
176 struct vtmmio_softc *sc;
180 sc = device_get_softc(dev);
182 if (sc->platform != NULL) {
183 err = VIRTIO_MMIO_SETUP_INTR(sc->platform, sc->dev,
186 /* Okay we have backend-specific interrupts */
192 sc->res[1] = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
195 device_printf(dev, "Can't allocate interrupt\n");
199 if (bus_setup_intr(dev, sc->res[1], type | INTR_MPSAFE,
200 NULL, vtmmio_vq_intr, sc, &sc->ih)) {
201 device_printf(dev, "Can't setup the interrupt\n");
209 vtmmio_attach(device_t dev)
211 struct vtmmio_softc *sc;
215 sc = device_get_softc(dev);
219 sc->res[0] = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid,
222 device_printf(dev, "Cannot allocate memory window.\n");
228 /* Tell the host we've noticed this device. */
229 vtmmio_set_status(dev, VIRTIO_CONFIG_STATUS_ACK);
231 if ((child = device_add_child(dev, NULL, -1)) == NULL) {
232 device_printf(dev, "Cannot create child device.\n");
233 vtmmio_set_status(dev, VIRTIO_CONFIG_STATUS_FAILED);
238 sc->vtmmio_child_dev = child;
239 vtmmio_probe_and_attach_child(sc);
245 vtmmio_detach(device_t dev)
247 struct vtmmio_softc *sc;
251 sc = device_get_softc(dev);
253 if ((child = sc->vtmmio_child_dev) != NULL) {
254 error = device_delete_child(dev, child);
257 sc->vtmmio_child_dev = NULL;
262 if (sc->res[0] != NULL) {
263 bus_release_resource(dev, SYS_RES_MEMORY, 0,
272 vtmmio_suspend(device_t dev)
275 return (bus_generic_suspend(dev));
279 vtmmio_resume(device_t dev)
282 return (bus_generic_resume(dev));
286 vtmmio_shutdown(device_t dev)
289 (void) bus_generic_shutdown(dev);
291 /* Forcibly stop the host device. */
298 vtmmio_driver_added(device_t dev, driver_t *driver)
300 struct vtmmio_softc *sc;
302 sc = device_get_softc(dev);
304 vtmmio_probe_and_attach_child(sc);
308 vtmmio_child_detached(device_t dev, device_t child)
310 struct vtmmio_softc *sc;
312 sc = device_get_softc(dev);
315 vtmmio_release_child_resources(sc);
319 vtmmio_read_ivar(device_t dev, device_t child, int index, uintptr_t *result)
321 struct vtmmio_softc *sc;
323 sc = device_get_softc(dev);
325 if (sc->vtmmio_child_dev != child)
329 case VIRTIO_IVAR_DEVTYPE:
330 case VIRTIO_IVAR_SUBDEVICE:
331 *result = vtmmio_read_config_4(sc, VIRTIO_MMIO_DEVICE_ID);
333 case VIRTIO_IVAR_VENDOR:
334 *result = vtmmio_read_config_4(sc, VIRTIO_MMIO_VENDOR_ID);
336 case VIRTIO_IVAR_SUBVENDOR:
337 case VIRTIO_IVAR_DEVICE:
339 * Dummy value for fields not present in this bus. Used by
340 * bus-agnostic virtio_child_pnpinfo_str.
352 vtmmio_write_ivar(device_t dev, device_t child, int index, uintptr_t value)
354 struct vtmmio_softc *sc;
356 sc = device_get_softc(dev);
358 if (sc->vtmmio_child_dev != child)
362 case VIRTIO_IVAR_FEATURE_DESC:
363 sc->vtmmio_child_feat_desc = (void *) value;
373 vtmmio_negotiate_features(device_t dev, uint64_t child_features)
375 struct vtmmio_softc *sc;
376 uint64_t host_features, features;
378 sc = device_get_softc(dev);
380 host_features = vtmmio_read_config_4(sc, VIRTIO_MMIO_HOST_FEATURES);
381 vtmmio_describe_features(sc, "host", host_features);
384 * Limit negotiated features to what the driver, virtqueue, and
387 features = host_features & child_features;
388 features = virtqueue_filter_features(features);
389 sc->vtmmio_features = features;
391 vtmmio_describe_features(sc, "negotiated", features);
392 vtmmio_write_config_4(sc, VIRTIO_MMIO_GUEST_FEATURES, features);
398 vtmmio_with_feature(device_t dev, uint64_t feature)
400 struct vtmmio_softc *sc;
402 sc = device_get_softc(dev);
404 return ((sc->vtmmio_features & feature) != 0);
408 vtmmio_alloc_virtqueues(device_t dev, int flags, int nvqs,
409 struct vq_alloc_info *vq_info)
411 struct vtmmio_virtqueue *vqx;
412 struct vq_alloc_info *info;
413 struct vtmmio_softc *sc;
414 struct virtqueue *vq;
418 sc = device_get_softc(dev);
420 if (sc->vtmmio_nvqs != 0)
425 sc->vtmmio_vqs = malloc(nvqs * sizeof(struct vtmmio_virtqueue),
426 M_DEVBUF, M_NOWAIT | M_ZERO);
427 if (sc->vtmmio_vqs == NULL)
430 vtmmio_write_config_4(sc, VIRTIO_MMIO_GUEST_PAGE_SIZE,
433 for (idx = 0; idx < nvqs; idx++) {
434 vqx = &sc->vtmmio_vqs[idx];
435 info = &vq_info[idx];
437 vtmmio_write_config_4(sc, VIRTIO_MMIO_QUEUE_SEL, idx);
439 vtmmio_select_virtqueue(sc, idx);
440 size = vtmmio_read_config_4(sc, VIRTIO_MMIO_QUEUE_NUM_MAX);
442 error = virtqueue_alloc(dev, idx, size,
443 VIRTIO_MMIO_VRING_ALIGN, ~(vm_paddr_t)0, info, &vq);
446 "cannot allocate virtqueue %d: %d\n",
451 vtmmio_write_config_4(sc, VIRTIO_MMIO_QUEUE_NUM, size);
452 vtmmio_write_config_4(sc, VIRTIO_MMIO_QUEUE_ALIGN,
453 VIRTIO_MMIO_VRING_ALIGN);
455 device_printf(dev, "virtqueue paddr 0x%08lx\n",
456 (uint64_t)virtqueue_paddr(vq));
458 vtmmio_write_config_4(sc, VIRTIO_MMIO_QUEUE_PFN,
459 virtqueue_paddr(vq) >> PAGE_SHIFT);
461 vqx->vtv_vq = *info->vqai_vq = vq;
462 vqx->vtv_no_intr = info->vqai_intr == NULL;
468 vtmmio_free_virtqueues(sc);
474 vtmmio_stop(device_t dev)
477 vtmmio_reset(device_get_softc(dev));
481 vtmmio_poll(device_t dev)
483 struct vtmmio_softc *sc;
485 sc = device_get_softc(dev);
487 if (sc->platform != NULL)
488 VIRTIO_MMIO_POLL(sc->platform);
492 vtmmio_reinit(device_t dev, uint64_t features)
494 struct vtmmio_softc *sc;
497 sc = device_get_softc(dev);
499 if (vtmmio_get_status(dev) != VIRTIO_CONFIG_STATUS_RESET)
503 * Quickly drive the status through ACK and DRIVER. The device
504 * does not become usable again until vtmmio_reinit_complete().
506 vtmmio_set_status(dev, VIRTIO_CONFIG_STATUS_ACK);
507 vtmmio_set_status(dev, VIRTIO_CONFIG_STATUS_DRIVER);
509 vtmmio_negotiate_features(dev, features);
511 vtmmio_write_config_4(sc, VIRTIO_MMIO_GUEST_PAGE_SIZE,
514 for (idx = 0; idx < sc->vtmmio_nvqs; idx++) {
515 error = vtmmio_reinit_virtqueue(sc, idx);
524 vtmmio_reinit_complete(device_t dev)
527 vtmmio_set_status(dev, VIRTIO_CONFIG_STATUS_DRIVER_OK);
531 vtmmio_notify_virtqueue(device_t dev, uint16_t queue)
533 struct vtmmio_softc *sc;
535 sc = device_get_softc(dev);
537 vtmmio_write_config_4(sc, VIRTIO_MMIO_QUEUE_NOTIFY, queue);
541 vtmmio_get_status(device_t dev)
543 struct vtmmio_softc *sc;
545 sc = device_get_softc(dev);
547 return (vtmmio_read_config_4(sc, VIRTIO_MMIO_STATUS));
551 vtmmio_set_status(device_t dev, uint8_t status)
553 struct vtmmio_softc *sc;
555 sc = device_get_softc(dev);
557 if (status != VIRTIO_CONFIG_STATUS_RESET)
558 status |= vtmmio_get_status(dev);
560 vtmmio_write_config_4(sc, VIRTIO_MMIO_STATUS, status);
564 vtmmio_read_dev_config(device_t dev, bus_size_t offset,
565 void *dst, int length)
567 struct vtmmio_softc *sc;
572 sc = device_get_softc(dev);
573 off = VIRTIO_MMIO_CONFIG + offset;
575 for (d = dst; length > 0; d += size, off += size, length -= size) {
576 #ifdef ALLOW_WORD_ALIGNED_ACCESS
579 *(uint32_t *)d = vtmmio_read_config_4(sc, off);
580 } else if (length >= 2) {
582 *(uint16_t *)d = vtmmio_read_config_2(sc, off);
587 *d = vtmmio_read_config_1(sc, off);
593 vtmmio_write_dev_config(device_t dev, bus_size_t offset,
594 void *src, int length)
596 struct vtmmio_softc *sc;
601 sc = device_get_softc(dev);
602 off = VIRTIO_MMIO_CONFIG + offset;
604 for (s = src; length > 0; s += size, off += size, length -= size) {
605 #ifdef ALLOW_WORD_ALIGNED_ACCESS
608 vtmmio_write_config_4(sc, off, *(uint32_t *)s);
609 } else if (length >= 2) {
611 vtmmio_write_config_2(sc, off, *(uint16_t *)s);
616 vtmmio_write_config_1(sc, off, *s);
622 vtmmio_describe_features(struct vtmmio_softc *sc, const char *msg,
628 child = sc->vtmmio_child_dev;
630 if (device_is_attached(child) || bootverbose == 0)
633 virtio_describe(dev, msg, features, sc->vtmmio_child_feat_desc);
637 vtmmio_probe_and_attach_child(struct vtmmio_softc *sc)
642 child = sc->vtmmio_child_dev;
647 if (device_get_state(child) != DS_NOTPRESENT) {
651 if (device_probe(child) != 0) {
655 vtmmio_set_status(dev, VIRTIO_CONFIG_STATUS_DRIVER);
656 if (device_attach(child) != 0) {
657 vtmmio_set_status(dev, VIRTIO_CONFIG_STATUS_FAILED);
659 vtmmio_release_child_resources(sc);
660 /* Reset status for future attempt. */
661 vtmmio_set_status(dev, VIRTIO_CONFIG_STATUS_ACK);
663 vtmmio_set_status(dev, VIRTIO_CONFIG_STATUS_DRIVER_OK);
664 VIRTIO_ATTACH_COMPLETED(child);
669 vtmmio_reinit_virtqueue(struct vtmmio_softc *sc, int idx)
671 struct vtmmio_virtqueue *vqx;
672 struct virtqueue *vq;
676 vqx = &sc->vtmmio_vqs[idx];
679 KASSERT(vq != NULL, ("%s: vq %d not allocated", __func__, idx));
681 vtmmio_select_virtqueue(sc, idx);
682 size = vtmmio_read_config_4(sc, VIRTIO_MMIO_QUEUE_NUM_MAX);
684 error = virtqueue_reinit(vq, size);
688 vtmmio_write_config_4(sc, VIRTIO_MMIO_QUEUE_NUM, size);
689 vtmmio_write_config_4(sc, VIRTIO_MMIO_QUEUE_ALIGN,
690 VIRTIO_MMIO_VRING_ALIGN);
692 device_printf(sc->dev, "virtqueue paddr 0x%08lx\n",
693 (uint64_t)virtqueue_paddr(vq));
695 vtmmio_write_config_4(sc, VIRTIO_MMIO_QUEUE_PFN,
696 virtqueue_paddr(vq) >> PAGE_SHIFT);
702 vtmmio_free_interrupts(struct vtmmio_softc *sc)
706 bus_teardown_intr(sc->dev, sc->res[1], sc->ih);
708 if (sc->res[1] != NULL)
709 bus_release_resource(sc->dev, SYS_RES_IRQ, 0, sc->res[1]);
713 vtmmio_free_virtqueues(struct vtmmio_softc *sc)
715 struct vtmmio_virtqueue *vqx;
718 for (idx = 0; idx < sc->vtmmio_nvqs; idx++) {
719 vqx = &sc->vtmmio_vqs[idx];
721 vtmmio_select_virtqueue(sc, idx);
722 vtmmio_write_config_4(sc, VIRTIO_MMIO_QUEUE_PFN, 0);
724 virtqueue_free(vqx->vtv_vq);
728 free(sc->vtmmio_vqs, M_DEVBUF);
729 sc->vtmmio_vqs = NULL;
734 vtmmio_release_child_resources(struct vtmmio_softc *sc)
737 vtmmio_free_interrupts(sc);
738 vtmmio_free_virtqueues(sc);
742 vtmmio_reset(struct vtmmio_softc *sc)
746 * Setting the status to RESET sets the host device to
747 * the original, uninitialized state.
749 vtmmio_set_status(sc->dev, VIRTIO_CONFIG_STATUS_RESET);
753 vtmmio_select_virtqueue(struct vtmmio_softc *sc, int idx)
756 vtmmio_write_config_4(sc, VIRTIO_MMIO_QUEUE_SEL, idx);
760 vtmmio_vq_intr(void *arg)
762 struct vtmmio_virtqueue *vqx;
763 struct vtmmio_softc *sc;
764 struct virtqueue *vq;
770 status = vtmmio_read_config_4(sc, VIRTIO_MMIO_INTERRUPT_STATUS);
771 vtmmio_write_config_4(sc, VIRTIO_MMIO_INTERRUPT_ACK, status);
773 /* The config changed */
774 if (status & VIRTIO_MMIO_INT_CONFIG)
775 if (sc->vtmmio_child_dev != NULL)
776 VIRTIO_CONFIG_CHANGE(sc->vtmmio_child_dev);
778 /* Notify all virtqueues. */
779 if (status & VIRTIO_MMIO_INT_VRING) {
780 for (idx = 0; idx < sc->vtmmio_nvqs; idx++) {
781 vqx = &sc->vtmmio_vqs[idx];
782 if (vqx->vtv_no_intr == 0) {