xref: /freebsd/sys/powerpc/pseries/vdevice.c (revision 7ec2f6bce5d28e6662c29e63f6ab6b7ef57d98b2)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
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 __FBSDID("$FreeBSD$");
31 
32 #include <sys/param.h>
33 #include <sys/systm.h>
34 #include <sys/kernel.h>
35 #include <sys/module.h>
36 #include <sys/malloc.h>
37 #include <sys/bus.h>
38 #include <sys/cpu.h>
39 #include <machine/bus.h>
40 #include <machine/intr_machdep.h>
41 
42 #include <dev/ofw/openfirm.h>
43 #include <dev/ofw/ofw_bus.h>
44 #include <dev/ofw/ofw_bus_subr.h>
45 
46 #include <powerpc/pseries/plpar_iommu.h>
47 
48 #include "iommu_if.h"
49 
50 static int	vdevice_probe(device_t);
51 static int	vdevice_attach(device_t);
52 static const struct ofw_bus_devinfo *vdevice_get_devinfo(device_t dev,
53     device_t child);
54 static int	vdevice_print_child(device_t dev, device_t child);
55 static struct resource_list *vdevice_get_resource_list(device_t, device_t);
56 static bus_dma_tag_t vdevice_get_dma_tag(device_t dev, device_t child);
57 
58 /*
59  * VDevice devinfo
60  */
61 struct vdevice_devinfo {
62 	struct ofw_bus_devinfo mdi_obdinfo;
63 	struct resource_list mdi_resources;
64 	bus_dma_tag_t mdi_dma_tag;
65 };
66 
67 static device_method_t vdevice_methods[] = {
68 	/* Device interface */
69 	DEVMETHOD(device_probe,		vdevice_probe),
70 	DEVMETHOD(device_attach,	vdevice_attach),
71 
72 	/* Bus interface */
73 	DEVMETHOD(bus_add_child,	bus_generic_add_child),
74 	DEVMETHOD(bus_child_pnpinfo_str, ofw_bus_gen_child_pnpinfo_str),
75 	DEVMETHOD(bus_print_child,	vdevice_print_child),
76 	DEVMETHOD(bus_setup_intr,	bus_generic_setup_intr),
77 	DEVMETHOD(bus_teardown_intr,	bus_generic_teardown_intr),
78 	DEVMETHOD(bus_alloc_resource,	bus_generic_rl_alloc_resource),
79 	DEVMETHOD(bus_release_resource,	bus_generic_rl_release_resource),
80 	DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
81 	DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
82 	DEVMETHOD(bus_get_resource_list, vdevice_get_resource_list),
83 
84 	/* ofw_bus interface */
85 	DEVMETHOD(ofw_bus_get_devinfo,	vdevice_get_devinfo),
86 	DEVMETHOD(ofw_bus_get_compat,	ofw_bus_gen_get_compat),
87 	DEVMETHOD(ofw_bus_get_model,	ofw_bus_gen_get_model),
88 	DEVMETHOD(ofw_bus_get_name,	ofw_bus_gen_get_name),
89 	DEVMETHOD(ofw_bus_get_node,	ofw_bus_gen_get_node),
90 	DEVMETHOD(ofw_bus_get_type,	ofw_bus_gen_get_type),
91 
92 	/* IOMMU interface */
93 	DEVMETHOD(bus_get_dma_tag,	vdevice_get_dma_tag),
94 	DEVMETHOD(iommu_map,		phyp_iommu_map),
95 	DEVMETHOD(iommu_unmap,		phyp_iommu_unmap),
96 
97 	DEVMETHOD_END
98 };
99 
100 static driver_t vdevice_driver = {
101 	"vdevice",
102 	vdevice_methods,
103 	0
104 };
105 
106 static devclass_t vdevice_devclass;
107 
108 DRIVER_MODULE(vdevice, ofwbus, vdevice_driver, vdevice_devclass, 0, 0);
109 
110 static int
111 vdevice_probe(device_t dev)
112 {
113 	const char	*name;
114 
115 	name = ofw_bus_get_name(dev);
116 
117 	if (name == NULL || strcmp(name, "vdevice") != 0)
118 		return (ENXIO);
119 
120 	if (!ofw_bus_is_compatible(dev, "IBM,vdevice"))
121 		return (ENXIO);
122 
123 	device_set_desc(dev, "POWER Hypervisor Virtual Device Root");
124 
125 	return (0);
126 }
127 
128 static int
129 vdevice_attach(device_t dev)
130 {
131 	phandle_t root, child;
132 	device_t cdev;
133 	struct vdevice_devinfo *dinfo;
134 
135 	root = ofw_bus_get_node(dev);
136 
137 	/* The XICP (root PIC) will handle all our interrupts */
138 	powerpc_register_pic(root_pic, OF_xref_from_node(root),
139 	    1 << 24 /* 24-bit XIRR field */, 1 /* Number of IPIs */, FALSE);
140 
141 	for (child = OF_child(root); child != 0; child = OF_peer(child)) {
142 		dinfo = malloc(sizeof(*dinfo), M_DEVBUF, M_WAITOK | M_ZERO);
143 
144                 if (ofw_bus_gen_setup_devinfo(&dinfo->mdi_obdinfo,
145 		    child) != 0) {
146                         free(dinfo, M_DEVBUF);
147                         continue;
148                 }
149 		resource_list_init(&dinfo->mdi_resources);
150 
151 		ofw_bus_intr_to_rl(dev, child, &dinfo->mdi_resources, NULL);
152 
153                 cdev = device_add_child(dev, NULL, -1);
154                 if (cdev == NULL) {
155                         device_printf(dev, "<%s>: device_add_child failed\n",
156                             dinfo->mdi_obdinfo.obd_name);
157                         ofw_bus_gen_destroy_devinfo(&dinfo->mdi_obdinfo);
158                         free(dinfo, M_DEVBUF);
159                         continue;
160                 }
161 		device_set_ivars(cdev, dinfo);
162 	}
163 
164 	return (bus_generic_attach(dev));
165 }
166 
167 static const struct ofw_bus_devinfo *
168 vdevice_get_devinfo(device_t dev, device_t child)
169 {
170 	return (device_get_ivars(child));
171 }
172 
173 static int
174 vdevice_print_child(device_t dev, device_t child)
175 {
176 	struct vdevice_devinfo *dinfo;
177 	struct resource_list *rl;
178 	int retval = 0;
179 
180 	dinfo = device_get_ivars(child);
181 	rl = &dinfo->mdi_resources;
182 
183 	retval += bus_print_child_header(dev, child);
184 
185 	retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%jd");
186 
187 	retval += bus_print_child_footer(dev, child);
188 
189 	return (retval);
190 }
191 
192 static struct resource_list *
193 vdevice_get_resource_list (device_t dev, device_t child)
194 {
195         struct vdevice_devinfo *dinfo;
196 
197         dinfo = device_get_ivars(child);
198         return (&dinfo->mdi_resources);
199 }
200 
201 static bus_dma_tag_t
202 vdevice_get_dma_tag(device_t dev, device_t child)
203 {
204 	struct vdevice_devinfo *dinfo;
205 	while (child != NULL && device_get_parent(child) != dev)
206 		child = device_get_parent(child);
207         dinfo = device_get_ivars(child);
208 
209 	if (dinfo->mdi_dma_tag == NULL) {
210 		bus_dma_tag_create(bus_get_dma_tag(dev),
211 		    1, 0, BUS_SPACE_MAXADDR, BUS_SPACE_MAXADDR,
212 		    NULL, NULL, BUS_SPACE_MAXSIZE, BUS_SPACE_UNRESTRICTED,
213 		    BUS_SPACE_MAXSIZE, 0, NULL, NULL, &dinfo->mdi_dma_tag);
214 		phyp_iommu_set_dma_tag(dev, child, dinfo->mdi_dma_tag);
215 	}
216 
217         return (dinfo->mdi_dma_tag);
218 }
219