1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 2022 Beckhoff Automation GmbH & Co. KG 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25 * SUCH DAMAGE. 26 */ 27 28 #include <sys/cdefs.h> 29 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 39 #include <dev/fdt/simplebus.h> 40 41 #include <dev/ofw/openfirm.h> 42 #include <dev/ofw/ofw_bus.h> 43 #include <dev/ofw/ofw_bus_subr.h> 44 45 struct ofw_firmware_softc { 46 struct simplebus_softc sc; 47 device_t dev; 48 }; 49 50 static struct simplebus_devinfo * 51 ofw_firmware_setup_dinfo(device_t dev, phandle_t node, 52 struct simplebus_devinfo *di) 53 { 54 struct simplebus_softc *sc; 55 struct simplebus_devinfo *ndi; 56 57 sc = device_get_softc(dev); 58 if (di == NULL) 59 ndi = malloc(sizeof(*ndi), M_DEVBUF, M_WAITOK | M_ZERO); 60 else 61 ndi = di; 62 if (ofw_bus_gen_setup_devinfo(&ndi->obdinfo, node) != 0) { 63 if (di == NULL) 64 free(ndi, M_DEVBUF); 65 return (NULL); 66 } 67 68 /* reg resources is from the parent but interrupts is on the node itself */ 69 resource_list_init(&ndi->rl); 70 ofw_bus_reg_to_rl(dev, OF_parent(node), sc->acells, sc->scells, &ndi->rl); 71 ofw_bus_intr_to_rl(dev, node, &ndi->rl, NULL); 72 73 return (ndi); 74 } 75 76 static device_t 77 ofw_firmware_add_device(device_t dev, phandle_t node, u_int order, 78 const char *name, int unit, struct simplebus_devinfo *di) 79 { 80 struct simplebus_devinfo *ndi; 81 device_t cdev; 82 83 if ((ndi = ofw_firmware_setup_dinfo(dev, node, di)) == NULL) 84 return (NULL); 85 cdev = device_add_child_ordered(dev, order, name, unit); 86 if (cdev == NULL) { 87 device_printf(dev, "<%s>: device_add_child failed\n", 88 ndi->obdinfo.obd_name); 89 resource_list_free(&ndi->rl); 90 ofw_bus_gen_destroy_devinfo(&ndi->obdinfo); 91 if (di == NULL) 92 free(ndi, M_DEVBUF); 93 return (NULL); 94 } 95 device_set_ivars(cdev, ndi); 96 97 return(cdev); 98 } 99 100 static int 101 ofw_firmware_probe(device_t dev) 102 { 103 const char *name, *compat; 104 phandle_t root, parent; 105 106 name = ofw_bus_get_name(dev); 107 if (name == NULL || strcmp(name, "firmware") != 0) 108 return (ENXIO); 109 parent = OF_parent(ofw_bus_get_node(dev)); 110 root = OF_finddevice("/"); 111 if (parent != root) 112 return (ENXIO); 113 compat = ofw_bus_get_compat(dev); 114 if (compat != NULL) 115 return (ENXIO); 116 117 device_set_desc(dev, "OFW Firmware Group"); 118 return (BUS_PROBE_GENERIC); 119 } 120 121 static int 122 ofw_firmware_attach(device_t dev) 123 { 124 struct ofw_firmware_softc *sc; 125 phandle_t node, child; 126 device_t cdev; 127 128 sc = device_get_softc(dev); 129 sc->dev = dev; 130 node = ofw_bus_get_node(dev); 131 132 if (OF_getencprop(node, "#address-cells", &sc->sc.acells, 133 sizeof(sc->sc.acells)) == -1) { 134 if (OF_getencprop(OF_parent(node), "#address-cells", &sc->sc.acells, 135 sizeof(sc->sc.acells)) == -1) { 136 sc->sc.acells = 2; 137 } 138 } 139 if (OF_getencprop(node, "#size-cells", &sc->sc.scells, 140 sizeof(sc->sc.scells)) == -1) { 141 if (OF_getencprop(OF_parent(node), "#size-cells", &sc->sc.scells, 142 sizeof(sc->sc.scells)) == -1) { 143 sc->sc.scells = 1; 144 } 145 } 146 147 for (child = OF_child(node); child != 0; child = OF_peer(child)) { 148 cdev = ofw_firmware_add_device(dev, child, 0, NULL, -1, NULL); 149 if (cdev != NULL) 150 device_probe_and_attach(cdev); 151 } 152 153 return (bus_generic_attach(dev)); 154 } 155 156 static device_method_t ofw_firmware_methods[] = { 157 /* device_if */ 158 DEVMETHOD(device_probe, ofw_firmware_probe), 159 DEVMETHOD(device_attach, ofw_firmware_attach), 160 161 DEVMETHOD_END 162 }; 163 164 DEFINE_CLASS_1(ofw_firmware, ofw_firmware_driver, ofw_firmware_methods, 165 sizeof(struct ofw_firmware_softc), simplebus_driver); 166 167 EARLY_DRIVER_MODULE(ofw_firmware, simplebus, ofw_firmware_driver, 0, 0, 168 BUS_PASS_BUS + BUS_PASS_ORDER_MIDDLE); 169 MODULE_VERSION(ofw_firmware, 1); 170