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.
43 * compatible = "virtio,mmio";
44 * reg = <0x1000 0x100>;
46 * interrupt-parent = <&GIC>;
50 #include <sys/cdefs.h>
51 __FBSDID("$FreeBSD$");
53 #include <sys/param.h>
54 #include <sys/systm.h>
56 #include <sys/kernel.h>
57 #include <sys/module.h>
58 #include <sys/malloc.h>
61 #include <machine/bus.h>
62 #include <machine/resource.h>
64 #include <dev/fdt/fdt_common.h>
65 #include <dev/ofw/openfirm.h>
66 #include <dev/ofw/ofw_bus.h>
67 #include <dev/ofw/ofw_bus_subr.h>
69 #include <dev/virtio/virtio.h>
70 #include <dev/virtio/virtqueue.h>
71 #include <dev/virtio/mmio/virtio_mmio.h>
73 #include "virtio_mmio_if.h"
74 #include "virtio_bus_if.h"
75 #include "virtio_if.h"
79 struct vtmmio_virtqueue {
80 struct virtqueue *vtv_vq;
87 struct resource *res[2];
89 uint64_t vtmmio_features;
90 uint32_t vtmmio_flags;
92 /* This "bus" will only ever have one child. */
93 device_t vtmmio_child_dev;
94 struct virtio_feature_desc *vtmmio_child_feat_desc;
97 struct vtmmio_virtqueue *vtmmio_vqs;
101 static int vtmmio_probe(device_t);
102 static int vtmmio_attach(device_t);
103 static int vtmmio_detach(device_t);
104 static int vtmmio_suspend(device_t);
105 static int vtmmio_resume(device_t);
106 static int vtmmio_shutdown(device_t);
107 static void vtmmio_driver_added(device_t, driver_t *);
108 static void vtmmio_child_detached(device_t, device_t);
109 static int vtmmio_read_ivar(device_t, device_t, int, uintptr_t *);
110 static int vtmmio_write_ivar(device_t, device_t, int, uintptr_t);
111 static uint64_t vtmmio_negotiate_features(device_t, uint64_t);
112 static int vtmmio_with_feature(device_t, uint64_t);
113 static int vtmmio_alloc_virtqueues(device_t, int, int,
114 struct vq_alloc_info *);
115 static int vtmmio_setup_intr(device_t, enum intr_type);
116 static void vtmmio_stop(device_t);
117 static void vtmmio_poll(device_t);
118 static int vtmmio_reinit(device_t, uint64_t);
119 static void vtmmio_reinit_complete(device_t);
120 static void vtmmio_notify_virtqueue(device_t, uint16_t);
121 static uint8_t vtmmio_get_status(device_t);
122 static void vtmmio_set_status(device_t, uint8_t);
123 static void vtmmio_read_dev_config(device_t, bus_size_t, void *, int);
124 static void vtmmio_write_dev_config(device_t, bus_size_t, void *, int);
125 static void vtmmio_describe_features(struct vtmmio_softc *, const char *,
127 static void vtmmio_probe_and_attach_child(struct vtmmio_softc *);
128 static int vtmmio_reinit_virtqueue(struct vtmmio_softc *, int);
129 static void vtmmio_free_interrupts(struct vtmmio_softc *);
130 static void vtmmio_free_virtqueues(struct vtmmio_softc *);
131 static void vtmmio_release_child_resources(struct vtmmio_softc *);
132 static void vtmmio_reset(struct vtmmio_softc *);
133 static void vtmmio_select_virtqueue(struct vtmmio_softc *, int);
134 static void vtmmio_vq_intr(void *);
137 * I/O port read/write wrappers.
139 #define vtmmio_write_config_1(sc, o, v) \
141 if (sc->platform != NULL) \
142 VIRTIO_MMIO_PREWRITE(sc->platform, (o), (v)); \
143 bus_write_1((sc)->res[0], (o), (v)); \
144 if (sc->platform != NULL) \
145 VIRTIO_MMIO_NOTE(sc->platform, (o), (v)); \
147 #define vtmmio_write_config_2(sc, o, v) \
149 if (sc->platform != NULL) \
150 VIRTIO_MMIO_PREWRITE(sc->platform, (o), (v)); \
151 bus_write_2((sc)->res[0], (o), (v)); \
152 if (sc->platform != NULL) \
153 VIRTIO_MMIO_NOTE(sc->platform, (o), (v)); \
155 #define vtmmio_write_config_4(sc, o, v) \
157 if (sc->platform != NULL) \
158 VIRTIO_MMIO_PREWRITE(sc->platform, (o), (v)); \
159 bus_write_4((sc)->res[0], (o), (v)); \
160 if (sc->platform != NULL) \
161 VIRTIO_MMIO_NOTE(sc->platform, (o), (v)); \
164 #define vtmmio_read_config_1(sc, o) \
165 bus_read_1((sc)->res[0], (o))
166 #define vtmmio_read_config_2(sc, o) \
167 bus_read_2((sc)->res[0], (o))
168 #define vtmmio_read_config_4(sc, o) \
169 bus_read_4((sc)->res[0], (o))
171 static device_method_t vtmmio_methods[] = {
172 /* Device interface. */
173 DEVMETHOD(device_probe, vtmmio_probe),
174 DEVMETHOD(device_attach, vtmmio_attach),
175 DEVMETHOD(device_detach, vtmmio_detach),
176 DEVMETHOD(device_suspend, vtmmio_suspend),
177 DEVMETHOD(device_resume, vtmmio_resume),
178 DEVMETHOD(device_shutdown, vtmmio_shutdown),
181 DEVMETHOD(bus_driver_added, vtmmio_driver_added),
182 DEVMETHOD(bus_child_detached, vtmmio_child_detached),
183 DEVMETHOD(bus_read_ivar, vtmmio_read_ivar),
184 DEVMETHOD(bus_write_ivar, vtmmio_write_ivar),
186 /* VirtIO bus interface. */
187 DEVMETHOD(virtio_bus_negotiate_features, vtmmio_negotiate_features),
188 DEVMETHOD(virtio_bus_with_feature, vtmmio_with_feature),
189 DEVMETHOD(virtio_bus_alloc_virtqueues, vtmmio_alloc_virtqueues),
190 DEVMETHOD(virtio_bus_setup_intr, vtmmio_setup_intr),
191 DEVMETHOD(virtio_bus_stop, vtmmio_stop),
192 DEVMETHOD(virtio_bus_poll, vtmmio_poll),
193 DEVMETHOD(virtio_bus_reinit, vtmmio_reinit),
194 DEVMETHOD(virtio_bus_reinit_complete, vtmmio_reinit_complete),
195 DEVMETHOD(virtio_bus_notify_vq, vtmmio_notify_virtqueue),
196 DEVMETHOD(virtio_bus_read_device_config, vtmmio_read_dev_config),
197 DEVMETHOD(virtio_bus_write_device_config, vtmmio_write_dev_config),
202 static driver_t vtmmio_driver = {
205 sizeof(struct vtmmio_softc)
208 devclass_t vtmmio_devclass;
210 DRIVER_MODULE(virtio_mmio, simplebus, vtmmio_driver, vtmmio_devclass, 0, 0);
211 DRIVER_MODULE(virtio_mmio, ofwbus, vtmmio_driver, vtmmio_devclass, 0, 0);
212 MODULE_VERSION(virtio_mmio, 1);
213 MODULE_DEPEND(virtio_mmio, simplebus, 1, 1, 1);
214 MODULE_DEPEND(virtio_mmio, virtio, 1, 1, 1);
217 vtmmio_setup_intr(device_t dev, enum intr_type type)
219 struct vtmmio_softc *sc;
223 sc = device_get_softc(dev);
225 if (sc->platform != NULL) {
226 err = VIRTIO_MMIO_SETUP_INTR(sc->platform, sc->dev,
229 /* Okay we have backend-specific interrupts */
235 sc->res[1] = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
238 device_printf(dev, "Can't allocate interrupt\n");
242 if (bus_setup_intr(dev, sc->res[1], INTR_TYPE_MISC | INTR_MPSAFE,
243 NULL, vtmmio_vq_intr, sc, &sc->ih)) {
244 device_printf(dev, "Can't setup the interrupt\n");
252 vtmmio_probe(device_t dev)
255 if (!ofw_bus_status_okay(dev))
258 if (!ofw_bus_is_compatible(dev, "virtio,mmio"))
261 device_set_desc(dev, "VirtIO MMIO adapter");
262 return (BUS_PROBE_DEFAULT);
266 vtmmio_setup_platform(struct vtmmio_softc *sc)
268 phandle_t platform_node;
275 if ((node = ofw_bus_get_node(sc->dev)) == -1)
278 if (OF_searchencprop(node, "platform", &xref,
279 sizeof(xref)) == -1) {
283 platform_node = OF_node_from_xref(xref);
285 SLIST_FOREACH(ic, &fdt_ic_list_head, fdt_ics) {
286 if (ic->iph == platform_node) {
287 sc->platform = ic->dev;
292 if (sc->platform == NULL) {
293 /* No platform-specific device. Ignore it. */
300 vtmmio_attach(device_t dev)
302 struct vtmmio_softc *sc;
306 sc = device_get_softc(dev);
309 vtmmio_setup_platform(sc);
312 sc->res[0] = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid,
315 device_printf(dev, "Cannot allocate memory window.\n");
321 /* Tell the host we've noticed this device. */
322 vtmmio_set_status(dev, VIRTIO_CONFIG_STATUS_ACK);
324 if ((child = device_add_child(dev, NULL, -1)) == NULL) {
325 device_printf(dev, "Cannot create child device.\n");
326 vtmmio_set_status(dev, VIRTIO_CONFIG_STATUS_FAILED);
331 sc->vtmmio_child_dev = child;
332 vtmmio_probe_and_attach_child(sc);
338 vtmmio_detach(device_t dev)
340 struct vtmmio_softc *sc;
344 sc = device_get_softc(dev);
346 if ((child = sc->vtmmio_child_dev) != NULL) {
347 error = device_delete_child(dev, child);
350 sc->vtmmio_child_dev = NULL;
355 if (sc->res[0] != NULL) {
356 bus_release_resource(dev, SYS_RES_MEMORY, 0,
365 vtmmio_suspend(device_t dev)
368 return (bus_generic_suspend(dev));
372 vtmmio_resume(device_t dev)
375 return (bus_generic_resume(dev));
379 vtmmio_shutdown(device_t dev)
382 (void) bus_generic_shutdown(dev);
384 /* Forcibly stop the host device. */
391 vtmmio_driver_added(device_t dev, driver_t *driver)
393 struct vtmmio_softc *sc;
395 sc = device_get_softc(dev);
397 vtmmio_probe_and_attach_child(sc);
401 vtmmio_child_detached(device_t dev, device_t child)
403 struct vtmmio_softc *sc;
405 sc = device_get_softc(dev);
408 vtmmio_release_child_resources(sc);
412 vtmmio_read_ivar(device_t dev, device_t child, int index, uintptr_t *result)
414 struct vtmmio_softc *sc;
416 sc = device_get_softc(dev);
418 if (sc->vtmmio_child_dev != child)
422 case VIRTIO_IVAR_DEVTYPE:
423 case VIRTIO_IVAR_SUBDEVICE:
424 *result = vtmmio_read_config_4(sc, VIRTIO_MMIO_DEVICE_ID);
426 case VIRTIO_IVAR_VENDOR:
427 *result = vtmmio_read_config_4(sc, VIRTIO_MMIO_VENDOR_ID);
437 vtmmio_write_ivar(device_t dev, device_t child, int index, uintptr_t value)
439 struct vtmmio_softc *sc;
441 sc = device_get_softc(dev);
443 if (sc->vtmmio_child_dev != child)
447 case VIRTIO_IVAR_FEATURE_DESC:
448 sc->vtmmio_child_feat_desc = (void *) value;
458 vtmmio_negotiate_features(device_t dev, uint64_t child_features)
460 struct vtmmio_softc *sc;
461 uint64_t host_features, features;
463 sc = device_get_softc(dev);
465 host_features = vtmmio_read_config_4(sc, VIRTIO_MMIO_HOST_FEATURES);
466 vtmmio_describe_features(sc, "host", host_features);
469 * Limit negotiated features to what the driver, virtqueue, and
472 features = host_features & child_features;
473 features = virtqueue_filter_features(features);
474 sc->vtmmio_features = features;
476 vtmmio_describe_features(sc, "negotiated", features);
477 vtmmio_write_config_4(sc, VIRTIO_MMIO_GUEST_FEATURES, features);
483 vtmmio_with_feature(device_t dev, uint64_t feature)
485 struct vtmmio_softc *sc;
487 sc = device_get_softc(dev);
489 return ((sc->vtmmio_features & feature) != 0);
493 vtmmio_alloc_virtqueues(device_t dev, int flags, int nvqs,
494 struct vq_alloc_info *vq_info)
496 struct vtmmio_virtqueue *vqx;
497 struct vq_alloc_info *info;
498 struct vtmmio_softc *sc;
499 struct virtqueue *vq;
503 sc = device_get_softc(dev);
505 if (sc->vtmmio_nvqs != 0)
510 sc->vtmmio_vqs = malloc(nvqs * sizeof(struct vtmmio_virtqueue),
511 M_DEVBUF, M_NOWAIT | M_ZERO);
512 if (sc->vtmmio_vqs == NULL)
515 vtmmio_write_config_4(sc, VIRTIO_MMIO_GUEST_PAGE_SIZE, 1 << PAGE_SHIFT);
517 for (idx = 0; idx < nvqs; idx++) {
518 vqx = &sc->vtmmio_vqs[idx];
519 info = &vq_info[idx];
521 vtmmio_write_config_4(sc, VIRTIO_MMIO_QUEUE_SEL, idx);
523 vtmmio_select_virtqueue(sc, idx);
524 size = vtmmio_read_config_4(sc, VIRTIO_MMIO_QUEUE_NUM_MAX);
526 error = virtqueue_alloc(dev, idx, size,
527 VIRTIO_MMIO_VRING_ALIGN, 0xFFFFFFFFUL, info, &vq);
530 "cannot allocate virtqueue %d: %d\n",
535 vtmmio_write_config_4(sc, VIRTIO_MMIO_QUEUE_NUM, size);
536 vtmmio_write_config_4(sc, VIRTIO_MMIO_QUEUE_ALIGN,
537 VIRTIO_MMIO_VRING_ALIGN);
539 device_printf(dev, "virtqueue paddr 0x%08lx\n",
540 (uint64_t)virtqueue_paddr(vq));
542 vtmmio_write_config_4(sc, VIRTIO_MMIO_QUEUE_PFN,
543 virtqueue_paddr(vq) >> PAGE_SHIFT);
545 vqx->vtv_vq = *info->vqai_vq = vq;
546 vqx->vtv_no_intr = info->vqai_intr == NULL;
552 vtmmio_free_virtqueues(sc);
558 vtmmio_stop(device_t dev)
561 vtmmio_reset(device_get_softc(dev));
565 vtmmio_poll(device_t dev)
567 struct vtmmio_softc *sc;
569 sc = device_get_softc(dev);
571 if (sc->platform != NULL)
572 VIRTIO_MMIO_POLL(sc->platform);
576 vtmmio_reinit(device_t dev, uint64_t features)
578 struct vtmmio_softc *sc;
581 sc = device_get_softc(dev);
583 if (vtmmio_get_status(dev) != VIRTIO_CONFIG_STATUS_RESET)
587 * Quickly drive the status through ACK and DRIVER. The device
588 * does not become usable again until vtmmio_reinit_complete().
590 vtmmio_set_status(dev, VIRTIO_CONFIG_STATUS_ACK);
591 vtmmio_set_status(dev, VIRTIO_CONFIG_STATUS_DRIVER);
593 vtmmio_negotiate_features(dev, features);
595 for (idx = 0; idx < sc->vtmmio_nvqs; idx++) {
596 error = vtmmio_reinit_virtqueue(sc, idx);
605 vtmmio_reinit_complete(device_t dev)
608 vtmmio_set_status(dev, VIRTIO_CONFIG_STATUS_DRIVER_OK);
612 vtmmio_notify_virtqueue(device_t dev, uint16_t queue)
614 struct vtmmio_softc *sc;
616 sc = device_get_softc(dev);
618 vtmmio_write_config_4(sc, VIRTIO_MMIO_QUEUE_NOTIFY, queue);
622 vtmmio_get_status(device_t dev)
624 struct vtmmio_softc *sc;
626 sc = device_get_softc(dev);
628 return (vtmmio_read_config_4(sc, VIRTIO_MMIO_STATUS));
632 vtmmio_set_status(device_t dev, uint8_t status)
634 struct vtmmio_softc *sc;
636 sc = device_get_softc(dev);
638 if (status != VIRTIO_CONFIG_STATUS_RESET)
639 status |= vtmmio_get_status(dev);
641 vtmmio_write_config_4(sc, VIRTIO_MMIO_STATUS, status);
645 vtmmio_read_dev_config(device_t dev, bus_size_t offset,
646 void *dst, int length)
648 struct vtmmio_softc *sc;
653 sc = device_get_softc(dev);
654 off = VIRTIO_MMIO_CONFIG + offset;
656 for (d = dst; length > 0; d += size, off += size, length -= size) {
657 #ifdef ALLOW_WORD_ALIGNED_ACCESS
660 *(uint32_t *)d = vtmmio_read_config_4(sc, off);
661 } else if (length >= 2) {
663 *(uint16_t *)d = vtmmio_read_config_2(sc, off);
668 *d = vtmmio_read_config_1(sc, off);
674 vtmmio_write_dev_config(device_t dev, bus_size_t offset,
675 void *src, int length)
677 struct vtmmio_softc *sc;
682 sc = device_get_softc(dev);
683 off = VIRTIO_MMIO_CONFIG + offset;
685 for (s = src; length > 0; s += size, off += size, length -= size) {
686 #ifdef ALLOW_WORD_ALIGNED_ACCESS
689 vtmmio_write_config_4(sc, off, *(uint32_t *)s);
690 } else if (length >= 2) {
692 vtmmio_write_config_2(sc, off, *(uint16_t *)s);
697 vtmmio_write_config_1(sc, off, *s);
703 vtmmio_describe_features(struct vtmmio_softc *sc, const char *msg,
709 child = sc->vtmmio_child_dev;
711 if (device_is_attached(child) || bootverbose == 0)
714 virtio_describe(dev, msg, features, sc->vtmmio_child_feat_desc);
718 vtmmio_probe_and_attach_child(struct vtmmio_softc *sc)
723 child = sc->vtmmio_child_dev;
728 if (device_get_state(child) != DS_NOTPRESENT) {
732 if (device_probe(child) != 0) {
736 vtmmio_set_status(dev, VIRTIO_CONFIG_STATUS_DRIVER);
737 if (device_attach(child) != 0) {
738 vtmmio_set_status(dev, VIRTIO_CONFIG_STATUS_FAILED);
740 vtmmio_release_child_resources(sc);
741 /* Reset status for future attempt. */
742 vtmmio_set_status(dev, VIRTIO_CONFIG_STATUS_ACK);
744 vtmmio_set_status(dev, VIRTIO_CONFIG_STATUS_DRIVER_OK);
745 VIRTIO_ATTACH_COMPLETED(child);
750 vtmmio_reinit_virtqueue(struct vtmmio_softc *sc, int idx)
752 struct vtmmio_virtqueue *vqx;
753 struct virtqueue *vq;
757 vqx = &sc->vtmmio_vqs[idx];
760 KASSERT(vq != NULL, ("%s: vq %d not allocated", __func__, idx));
762 vtmmio_select_virtqueue(sc, idx);
763 size = vtmmio_read_config_4(sc, VIRTIO_MMIO_QUEUE_NUM_MAX);
765 error = virtqueue_reinit(vq, size);
769 vtmmio_write_config_4(sc, VIRTIO_MMIO_QUEUE_PFN,
770 virtqueue_paddr(vq) >> PAGE_SHIFT);
776 vtmmio_free_interrupts(struct vtmmio_softc *sc)
780 bus_teardown_intr(sc->dev, sc->res[1], sc->ih);
782 if (sc->res[1] != NULL)
783 bus_release_resource(sc->dev, SYS_RES_IRQ, 0, sc->res[1]);
787 vtmmio_free_virtqueues(struct vtmmio_softc *sc)
789 struct vtmmio_virtqueue *vqx;
792 for (idx = 0; idx < sc->vtmmio_nvqs; idx++) {
793 vqx = &sc->vtmmio_vqs[idx];
795 vtmmio_select_virtqueue(sc, idx);
796 vtmmio_write_config_4(sc, VIRTIO_MMIO_QUEUE_PFN, 0);
798 virtqueue_free(vqx->vtv_vq);
802 free(sc->vtmmio_vqs, M_DEVBUF);
803 sc->vtmmio_vqs = NULL;
808 vtmmio_release_child_resources(struct vtmmio_softc *sc)
811 vtmmio_free_interrupts(sc);
812 vtmmio_free_virtqueues(sc);
816 vtmmio_reset(struct vtmmio_softc *sc)
820 * Setting the status to RESET sets the host device to
821 * the original, uninitialized state.
823 vtmmio_set_status(sc->dev, VIRTIO_CONFIG_STATUS_RESET);
827 vtmmio_select_virtqueue(struct vtmmio_softc *sc, int idx)
830 vtmmio_write_config_4(sc, VIRTIO_MMIO_QUEUE_SEL, idx);
834 vtmmio_vq_intr(void *arg)
836 struct vtmmio_virtqueue *vqx;
837 struct vtmmio_softc *sc;
838 struct virtqueue *vq;
844 status = vtmmio_read_config_4(sc, VIRTIO_MMIO_INTERRUPT_STATUS);
845 vtmmio_write_config_4(sc, VIRTIO_MMIO_INTERRUPT_ACK, status);
847 /* The config changed */
848 if (status & VIRTIO_MMIO_INT_CONFIG)
849 if (sc->vtmmio_child_dev != NULL)
850 VIRTIO_CONFIG_CHANGE(sc->vtmmio_child_dev);
852 /* Notify all virtqueues. */
853 if (status & VIRTIO_MMIO_INT_VRING) {
854 for (idx = 0; idx < sc->vtmmio_nvqs; idx++) {
855 vqx = &sc->vtmmio_vqs[idx];
856 if (vqx->vtv_no_intr == 0) {