1/*-
2 * Copyright (c) 2014 Ruslan Bukin <br@bsdpad.com>
3 * Copyright (c) 2014 The FreeBSD Foundation
4 * All rights reserved.
5 *
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.
9 *
10 * Portions of this software were developed by Andrew Turner
11 * under sponsorship from the FreeBSD Foundation.
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
15 * are met:
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.
21 *
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
32 * SUCH DAMAGE.
33 */
34
35/*
36 * VirtIO MMIO interface.
37 * This driver is heavily based on VirtIO PCI interface driver.
38 */
39
40/*
41 * FDT example:
42 *		virtio_block@1000 {
43 *			compatible = "virtio,mmio";
44 *			reg = <0x1000 0x100>;
45 *			interrupts = <63>;
46 *			interrupt-parent = <&GIC>;
47 *		};
48 */
49
50#include "opt_platform.h"
51
52#include <sys/param.h>
53#include <sys/systm.h>
54#include <sys/bus.h>
55#include <sys/kernel.h>
56#include <sys/module.h>
57
58#include <dev/fdt/fdt_common.h>
59#include <dev/ofw/openfirm.h>
60#include <dev/ofw/ofw_bus.h>
61#include <dev/ofw/ofw_bus_subr.h>
62
63#include <dev/virtio/mmio/virtio_mmio.h>
64
65static int	vtmmio_fdt_probe(device_t);
66static int	vtmmio_fdt_attach(device_t);
67
68static device_method_t vtmmio_fdt_methods[] = {
69	/* Device interface. */
70	DEVMETHOD(device_probe,		vtmmio_fdt_probe),
71	DEVMETHOD(device_attach,	vtmmio_fdt_attach),
72
73	DEVMETHOD_END
74};
75
76DEFINE_CLASS_1(virtio_mmio, vtmmio_fdt_driver, vtmmio_fdt_methods,
77    sizeof(struct vtmmio_softc), vtmmio_driver);
78
79DRIVER_MODULE(virtio_mmio, simplebus, vtmmio_fdt_driver, 0, 0);
80DRIVER_MODULE(virtio_mmio, ofwbus, vtmmio_fdt_driver, 0,0);
81MODULE_DEPEND(virtio_mmio, simplebus, 1, 1, 1);
82MODULE_DEPEND(virtio_mmio, virtio, 1, 1, 1);
83
84static int
85vtmmio_fdt_probe(device_t dev)
86{
87
88	if (!ofw_bus_status_okay(dev))
89		return (ENXIO);
90
91	if (!ofw_bus_is_compatible(dev, "virtio,mmio"))
92		return (ENXIO);
93
94	return (vtmmio_probe(dev));
95}
96
97static int
98vtmmio_setup_platform(device_t dev, struct vtmmio_softc *sc)
99{
100	phandle_t platform_node;
101	struct fdt_ic *ic;
102	phandle_t xref;
103	phandle_t node;
104
105	sc->platform = NULL;
106
107	if ((node = ofw_bus_get_node(dev)) == -1)
108		return (ENXIO);
109
110	if (OF_searchencprop(node, "platform", &xref,
111		sizeof(xref)) == -1) {
112		return (ENXIO);
113	}
114
115	platform_node = OF_node_from_xref(xref);
116
117	SLIST_FOREACH(ic, &fdt_ic_list_head, fdt_ics) {
118		if (ic->iph == platform_node) {
119			sc->platform = ic->dev;
120			break;
121		}
122	}
123
124	if (sc->platform == NULL) {
125		/* No platform-specific device. Ignore it. */
126	}
127
128	return (0);
129}
130
131static int
132vtmmio_fdt_attach(device_t dev)
133{
134	struct vtmmio_softc *sc;
135
136	sc = device_get_softc(dev);
137	vtmmio_setup_platform(dev, sc);
138
139	return (vtmmio_attach(dev));
140}
141