xref: /freebsd/sys/powerpc/pseries/vdevice.c (revision 031beb4e239bfce798af17f5fe8dba8bcaf13d99)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2011 Nathan Whitehorn
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #include <sys/cdefs.h>
30 #include <sys/param.h>
31 #include <sys/systm.h>
32 #include <sys/kernel.h>
33 #include <sys/module.h>
34 #include <sys/malloc.h>
35 #include <sys/bus.h>
36 #include <sys/cpu.h>
37 #include <machine/bus.h>
38 #include <machine/intr_machdep.h>
39 
40 #include <dev/ofw/openfirm.h>
41 #include <dev/ofw/ofw_bus.h>
42 #include <dev/ofw/ofw_bus_subr.h>
43 
44 #include <powerpc/pseries/plpar_iommu.h>
45 
46 #include "iommu_if.h"
47 
48 static int	vdevice_probe(device_t);
49 static int	vdevice_attach(device_t);
50 static const struct ofw_bus_devinfo *vdevice_get_devinfo(device_t dev,
51     device_t child);
52 static int	vdevice_print_child(device_t dev, device_t child);
53 static struct resource_list *vdevice_get_resource_list(device_t, device_t);
54 static bus_dma_tag_t vdevice_get_dma_tag(device_t dev, device_t child);
55 
56 /*
57  * VDevice devinfo
58  */
59 struct vdevice_devinfo {
60 	struct ofw_bus_devinfo mdi_obdinfo;
61 	struct resource_list mdi_resources;
62 	bus_dma_tag_t mdi_dma_tag;
63 };
64 
65 static device_method_t vdevice_methods[] = {
66 	/* Device interface */
67 	DEVMETHOD(device_probe,		vdevice_probe),
68 	DEVMETHOD(device_attach,	vdevice_attach),
69 
70 	/* Bus interface */
71 	DEVMETHOD(bus_add_child,	bus_generic_add_child),
72 	DEVMETHOD(bus_child_pnpinfo,	ofw_bus_gen_child_pnpinfo),
73 	DEVMETHOD(bus_print_child,	vdevice_print_child),
74 	DEVMETHOD(bus_setup_intr,	bus_generic_setup_intr),
75 	DEVMETHOD(bus_teardown_intr,	bus_generic_teardown_intr),
76 	DEVMETHOD(bus_alloc_resource,	bus_generic_rl_alloc_resource),
77 	DEVMETHOD(bus_release_resource,	bus_generic_rl_release_resource),
78 	DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
79 	DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
80 	DEVMETHOD(bus_get_resource_list, vdevice_get_resource_list),
81 
82 	/* ofw_bus interface */
83 	DEVMETHOD(ofw_bus_get_devinfo,	vdevice_get_devinfo),
84 	DEVMETHOD(ofw_bus_get_compat,	ofw_bus_gen_get_compat),
85 	DEVMETHOD(ofw_bus_get_model,	ofw_bus_gen_get_model),
86 	DEVMETHOD(ofw_bus_get_name,	ofw_bus_gen_get_name),
87 	DEVMETHOD(ofw_bus_get_node,	ofw_bus_gen_get_node),
88 	DEVMETHOD(ofw_bus_get_type,	ofw_bus_gen_get_type),
89 
90 	/* IOMMU interface */
91 	DEVMETHOD(bus_get_dma_tag,	vdevice_get_dma_tag),
92 	DEVMETHOD(iommu_map,		phyp_iommu_map),
93 	DEVMETHOD(iommu_unmap,		phyp_iommu_unmap),
94 
95 	DEVMETHOD_END
96 };
97 
98 static driver_t vdevice_driver = {
99 	"vdevice",
100 	vdevice_methods,
101 	0
102 };
103 
104 DRIVER_MODULE(vdevice, ofwbus, vdevice_driver, 0, 0);
105 
106 static int
107 vdevice_probe(device_t dev)
108 {
109 	const char	*name;
110 
111 	name = ofw_bus_get_name(dev);
112 
113 	if (name == NULL || strcmp(name, "vdevice") != 0)
114 		return (ENXIO);
115 
116 	if (!ofw_bus_is_compatible(dev, "IBM,vdevice"))
117 		return (ENXIO);
118 
119 	device_set_desc(dev, "POWER Hypervisor Virtual Device Root");
120 
121 	return (0);
122 }
123 
124 static int
125 vdevice_attach(device_t dev)
126 {
127 	phandle_t root, child;
128 	device_t cdev;
129 	struct vdevice_devinfo *dinfo;
130 
131 	root = ofw_bus_get_node(dev);
132 
133 	/* The XICP (root PIC) will handle all our interrupts */
134 	powerpc_register_pic(root_pic, OF_xref_from_node(root),
135 	    1 << 24 /* 24-bit XIRR field */, 1 /* Number of IPIs */, FALSE);
136 
137 	for (child = OF_child(root); child != 0; child = OF_peer(child)) {
138 		dinfo = malloc(sizeof(*dinfo), M_DEVBUF, M_WAITOK | M_ZERO);
139 
140                 if (ofw_bus_gen_setup_devinfo(&dinfo->mdi_obdinfo,
141 		    child) != 0) {
142                         free(dinfo, M_DEVBUF);
143                         continue;
144                 }
145 		resource_list_init(&dinfo->mdi_resources);
146 
147 		ofw_bus_intr_to_rl(dev, child, &dinfo->mdi_resources, NULL);
148 
149                 cdev = device_add_child(dev, NULL, -1);
150                 if (cdev == NULL) {
151                         device_printf(dev, "<%s>: device_add_child failed\n",
152                             dinfo->mdi_obdinfo.obd_name);
153                         ofw_bus_gen_destroy_devinfo(&dinfo->mdi_obdinfo);
154                         free(dinfo, M_DEVBUF);
155                         continue;
156                 }
157 		device_set_ivars(cdev, dinfo);
158 	}
159 
160 	return (bus_generic_attach(dev));
161 }
162 
163 static const struct ofw_bus_devinfo *
164 vdevice_get_devinfo(device_t dev, device_t child)
165 {
166 	return (device_get_ivars(child));
167 }
168 
169 static int
170 vdevice_print_child(device_t dev, device_t child)
171 {
172 	struct vdevice_devinfo *dinfo;
173 	struct resource_list *rl;
174 	int retval = 0;
175 
176 	dinfo = device_get_ivars(child);
177 	rl = &dinfo->mdi_resources;
178 
179 	retval += bus_print_child_header(dev, child);
180 
181 	retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%jd");
182 
183 	retval += bus_print_child_footer(dev, child);
184 
185 	return (retval);
186 }
187 
188 static struct resource_list *
189 vdevice_get_resource_list (device_t dev, device_t child)
190 {
191         struct vdevice_devinfo *dinfo;
192 
193         dinfo = device_get_ivars(child);
194         return (&dinfo->mdi_resources);
195 }
196 
197 static bus_dma_tag_t
198 vdevice_get_dma_tag(device_t dev, device_t child)
199 {
200 	struct vdevice_devinfo *dinfo;
201 	while (child != NULL && device_get_parent(child) != dev)
202 		child = device_get_parent(child);
203         dinfo = device_get_ivars(child);
204 
205 	if (dinfo->mdi_dma_tag == NULL) {
206 		bus_dma_tag_create(bus_get_dma_tag(dev),
207 		    1, 0, BUS_SPACE_MAXADDR, BUS_SPACE_MAXADDR,
208 		    NULL, NULL, BUS_SPACE_MAXSIZE, BUS_SPACE_UNRESTRICTED,
209 		    BUS_SPACE_MAXSIZE, 0, NULL, NULL, &dinfo->mdi_dma_tag);
210 		phyp_iommu_set_dma_tag(dev, child, dinfo->mdi_dma_tag);
211 	}
212 
213         return (dinfo->mdi_dma_tag);
214 }
215