1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2013 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/param.h> 30 #include <sys/systm.h> 31 #include <sys/module.h> 32 #include <sys/bus.h> 33 #include <sys/conf.h> 34 #include <sys/kernel.h> 35 #include <sys/rman.h> 36 37 #include <dev/ofw/openfirm.h> 38 #include <dev/ofw/ofw_bus.h> 39 #include <dev/ofw/ofw_bus_subr.h> 40 41 #include <dev/fdt/simplebus.h> 42 43 /* 44 * Bus interface. 45 */ 46 static int simplebus_probe(device_t dev); 47 static struct resource *simplebus_alloc_resource(device_t, device_t, int, 48 int *, rman_res_t, rman_res_t, rman_res_t, u_int); 49 static void simplebus_probe_nomatch(device_t bus, device_t child); 50 static int simplebus_print_child(device_t bus, device_t child); 51 static device_t simplebus_add_child(device_t dev, u_int order, 52 const char *name, int unit); 53 static struct resource_list *simplebus_get_resource_list(device_t bus, 54 device_t child); 55 56 static ssize_t simplebus_get_property(device_t bus, device_t child, 57 const char *propname, void *propvalue, size_t size, 58 device_property_type_t type); 59 /* 60 * ofw_bus interface 61 */ 62 static const struct ofw_bus_devinfo *simplebus_get_devinfo(device_t bus, 63 device_t child); 64 65 /* 66 * Driver methods. 67 */ 68 static device_method_t simplebus_methods[] = { 69 /* Device interface */ 70 DEVMETHOD(device_probe, simplebus_probe), 71 DEVMETHOD(device_attach, simplebus_attach), 72 DEVMETHOD(device_detach, simplebus_detach), 73 DEVMETHOD(device_shutdown, bus_generic_shutdown), 74 DEVMETHOD(device_suspend, bus_generic_suspend), 75 DEVMETHOD(device_resume, bus_generic_resume), 76 77 /* Bus interface */ 78 DEVMETHOD(bus_add_child, simplebus_add_child), 79 DEVMETHOD(bus_print_child, simplebus_print_child), 80 DEVMETHOD(bus_probe_nomatch, simplebus_probe_nomatch), 81 DEVMETHOD(bus_read_ivar, bus_generic_read_ivar), 82 DEVMETHOD(bus_write_ivar, bus_generic_write_ivar), 83 DEVMETHOD(bus_setup_intr, bus_generic_setup_intr), 84 DEVMETHOD(bus_teardown_intr, bus_generic_teardown_intr), 85 DEVMETHOD(bus_alloc_resource, simplebus_alloc_resource), 86 DEVMETHOD(bus_release_resource, bus_generic_release_resource), 87 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource), 88 DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource), 89 DEVMETHOD(bus_adjust_resource, bus_generic_adjust_resource), 90 DEVMETHOD(bus_map_resource, bus_generic_map_resource), 91 DEVMETHOD(bus_unmap_resource, bus_generic_unmap_resource), 92 DEVMETHOD(bus_set_resource, bus_generic_rl_set_resource), 93 DEVMETHOD(bus_get_resource, bus_generic_rl_get_resource), 94 DEVMETHOD(bus_delete_resource, bus_generic_rl_delete_resource), 95 DEVMETHOD(bus_child_pnpinfo, ofw_bus_gen_child_pnpinfo), 96 DEVMETHOD(bus_get_resource_list, simplebus_get_resource_list), 97 DEVMETHOD(bus_get_property, simplebus_get_property), 98 DEVMETHOD(bus_get_device_path, ofw_bus_gen_get_device_path), 99 100 /* ofw_bus interface */ 101 DEVMETHOD(ofw_bus_get_devinfo, simplebus_get_devinfo), 102 DEVMETHOD(ofw_bus_get_compat, ofw_bus_gen_get_compat), 103 DEVMETHOD(ofw_bus_get_model, ofw_bus_gen_get_model), 104 DEVMETHOD(ofw_bus_get_name, ofw_bus_gen_get_name), 105 DEVMETHOD(ofw_bus_get_node, ofw_bus_gen_get_node), 106 DEVMETHOD(ofw_bus_get_type, ofw_bus_gen_get_type), 107 108 DEVMETHOD_END 109 }; 110 111 DEFINE_CLASS_0(simplebus, simplebus_driver, simplebus_methods, 112 sizeof(struct simplebus_softc)); 113 114 EARLY_DRIVER_MODULE(simplebus, ofwbus, simplebus_driver, 0, 0, BUS_PASS_BUS); 115 EARLY_DRIVER_MODULE(simplebus, simplebus, simplebus_driver, 0, 0, 116 BUS_PASS_BUS + BUS_PASS_ORDER_MIDDLE); 117 118 static int 119 simplebus_probe(device_t dev) 120 { 121 122 if (!ofw_bus_status_okay(dev)) 123 return (ENXIO); 124 /* 125 * XXX We should attach only to pure' compatible = "simple-bus"', 126 * without any other compatible string. 127 * For now, filter only know cases: 128 * "syscon", "simple-bus"; is handled by fdt/syscon driver 129 * "simple-mfd", "simple-bus"; is handled by fdt/simple-mfd driver 130 */ 131 if (ofw_bus_is_compatible(dev, "syscon") || 132 ofw_bus_is_compatible(dev, "simple-mfd")) 133 return (ENXIO); 134 135 /* 136 * FDT data puts a "simple-bus" compatible string on many things that 137 * have children but aren't really buses in our world. Without a 138 * ranges property we will fail to attach, so just fail to probe too. 139 */ 140 if (!(ofw_bus_is_compatible(dev, "simple-bus") && 141 ofw_bus_has_prop(dev, "ranges")) && 142 (ofw_bus_get_type(dev) == NULL || strcmp(ofw_bus_get_type(dev), 143 "soc") != 0)) 144 return (ENXIO); 145 146 device_set_desc(dev, "Flattened device tree simple bus"); 147 148 return (BUS_PROBE_GENERIC); 149 } 150 151 int 152 simplebus_attach_impl(device_t dev) 153 { 154 struct simplebus_softc *sc; 155 phandle_t node; 156 157 sc = device_get_softc(dev); 158 simplebus_init(dev, 0); 159 if ((sc->flags & SB_FLAG_NO_RANGES) == 0 && 160 simplebus_fill_ranges(sc->node, sc) < 0) { 161 device_printf(dev, "could not get ranges\n"); 162 return (ENXIO); 163 } 164 165 /* 166 * In principle, simplebus could have an interrupt map, but ignore that 167 * for now 168 */ 169 170 for (node = OF_child(sc->node); node > 0; node = OF_peer(node)) 171 simplebus_add_device(dev, node, 0, NULL, -1, NULL); 172 173 return (0); 174 } 175 176 int 177 simplebus_attach(device_t dev) 178 { 179 int rv; 180 181 rv = simplebus_attach_impl(dev); 182 if (rv != 0) 183 return (rv); 184 185 return (bus_generic_attach(dev)); 186 } 187 188 int 189 simplebus_detach(device_t dev) 190 { 191 struct simplebus_softc *sc; 192 int rv; 193 194 rv = bus_generic_detach(dev); 195 if (rv != 0) 196 return (rv); 197 198 sc = device_get_softc(dev); 199 if (sc->ranges != NULL) 200 free(sc->ranges, M_DEVBUF); 201 202 return (0); 203 } 204 205 void 206 simplebus_init(device_t dev, phandle_t node) 207 { 208 struct simplebus_softc *sc; 209 210 sc = device_get_softc(dev); 211 if (node == 0) 212 node = ofw_bus_get_node(dev); 213 sc->dev = dev; 214 sc->node = node; 215 216 /* 217 * Some important numbers 218 */ 219 sc->acells = 2; 220 OF_getencprop(node, "#address-cells", &sc->acells, sizeof(sc->acells)); 221 sc->scells = 1; 222 OF_getencprop(node, "#size-cells", &sc->scells, sizeof(sc->scells)); 223 } 224 225 int 226 simplebus_fill_ranges(phandle_t node, struct simplebus_softc *sc) 227 { 228 int host_address_cells; 229 cell_t *base_ranges; 230 ssize_t nbase_ranges; 231 int err; 232 int i, j, k; 233 234 err = OF_searchencprop(OF_parent(node), "#address-cells", 235 &host_address_cells, sizeof(host_address_cells)); 236 if (err <= 0) 237 return (-1); 238 239 nbase_ranges = OF_getproplen(node, "ranges"); 240 if (nbase_ranges < 0) 241 return (-1); 242 sc->nranges = nbase_ranges / sizeof(cell_t) / 243 (sc->acells + host_address_cells + sc->scells); 244 if (sc->nranges == 0) 245 return (0); 246 247 sc->ranges = malloc(sc->nranges * sizeof(sc->ranges[0]), 248 M_DEVBUF, M_WAITOK); 249 base_ranges = malloc(nbase_ranges, M_DEVBUF, M_WAITOK); 250 OF_getencprop(node, "ranges", base_ranges, nbase_ranges); 251 252 for (i = 0, j = 0; i < sc->nranges; i++) { 253 sc->ranges[i].bus = 0; 254 for (k = 0; k < sc->acells; k++) { 255 sc->ranges[i].bus <<= 32; 256 sc->ranges[i].bus |= base_ranges[j++]; 257 } 258 sc->ranges[i].host = 0; 259 for (k = 0; k < host_address_cells; k++) { 260 sc->ranges[i].host <<= 32; 261 sc->ranges[i].host |= base_ranges[j++]; 262 } 263 sc->ranges[i].size = 0; 264 for (k = 0; k < sc->scells; k++) { 265 sc->ranges[i].size <<= 32; 266 sc->ranges[i].size |= base_ranges[j++]; 267 } 268 } 269 270 free(base_ranges, M_DEVBUF); 271 return (sc->nranges); 272 } 273 274 struct simplebus_devinfo * 275 simplebus_setup_dinfo(device_t dev, phandle_t node, 276 struct simplebus_devinfo *di) 277 { 278 struct simplebus_softc *sc; 279 struct simplebus_devinfo *ndi; 280 281 sc = device_get_softc(dev); 282 if (di == NULL) 283 ndi = malloc(sizeof(*ndi), M_DEVBUF, M_WAITOK | M_ZERO); 284 else 285 ndi = di; 286 if (ofw_bus_gen_setup_devinfo(&ndi->obdinfo, node) != 0) { 287 if (di == NULL) 288 free(ndi, M_DEVBUF); 289 return (NULL); 290 } 291 292 resource_list_init(&ndi->rl); 293 ofw_bus_reg_to_rl(dev, node, sc->acells, sc->scells, &ndi->rl); 294 ofw_bus_intr_to_rl(dev, node, &ndi->rl, NULL); 295 296 return (ndi); 297 } 298 299 device_t 300 simplebus_add_device(device_t dev, phandle_t node, u_int order, 301 const char *name, int unit, struct simplebus_devinfo *di) 302 { 303 struct simplebus_devinfo *ndi; 304 device_t cdev; 305 306 if ((ndi = simplebus_setup_dinfo(dev, node, di)) == NULL) 307 return (NULL); 308 cdev = device_add_child_ordered(dev, order, name, unit); 309 if (cdev == NULL) { 310 device_printf(dev, "<%s>: device_add_child failed\n", 311 ndi->obdinfo.obd_name); 312 resource_list_free(&ndi->rl); 313 ofw_bus_gen_destroy_devinfo(&ndi->obdinfo); 314 if (di == NULL) 315 free(ndi, M_DEVBUF); 316 return (NULL); 317 } 318 device_set_ivars(cdev, ndi); 319 320 return(cdev); 321 } 322 323 static device_t 324 simplebus_add_child(device_t dev, u_int order, const char *name, int unit) 325 { 326 device_t cdev; 327 struct simplebus_devinfo *ndi; 328 329 cdev = device_add_child_ordered(dev, order, name, unit); 330 if (cdev == NULL) 331 return (NULL); 332 333 ndi = malloc(sizeof(*ndi), M_DEVBUF, M_WAITOK | M_ZERO); 334 ndi->obdinfo.obd_node = -1; 335 resource_list_init(&ndi->rl); 336 device_set_ivars(cdev, ndi); 337 338 return (cdev); 339 } 340 341 static const struct ofw_bus_devinfo * 342 simplebus_get_devinfo(device_t bus __unused, device_t child) 343 { 344 struct simplebus_devinfo *ndi; 345 346 ndi = device_get_ivars(child); 347 if (ndi == NULL) 348 return (NULL); 349 return (&ndi->obdinfo); 350 } 351 352 static struct resource_list * 353 simplebus_get_resource_list(device_t bus __unused, device_t child) 354 { 355 struct simplebus_devinfo *ndi; 356 357 ndi = device_get_ivars(child); 358 if (ndi == NULL) 359 return (NULL); 360 return (&ndi->rl); 361 } 362 363 static ssize_t 364 simplebus_get_property(device_t bus, device_t child, const char *propname, 365 void *propvalue, size_t size, device_property_type_t type) 366 { 367 phandle_t node, xref; 368 ssize_t ret, i; 369 uint32_t *buffer; 370 uint64_t val; 371 372 switch (type) { 373 case DEVICE_PROP_ANY: 374 case DEVICE_PROP_BUFFER: 375 case DEVICE_PROP_UINT32: 376 case DEVICE_PROP_UINT64: 377 case DEVICE_PROP_HANDLE: 378 break; 379 default: 380 return (-1); 381 } 382 383 node = ofw_bus_get_node(child); 384 if (propvalue == NULL || size == 0) 385 return (OF_getproplen(node, propname)); 386 387 /* 388 * Integer values are stored in BE format. 389 * If caller declared that the underlying property type is uint32_t 390 * we need to do the conversion to match host endianness. 391 */ 392 if (type == DEVICE_PROP_UINT32) 393 return (OF_getencprop(node, propname, propvalue, size)); 394 395 /* 396 * uint64_t also requires endianness handling. 397 * In FDT every 8 byte value is stored using two uint32_t variables 398 * in BE format. Now, since the upper bits are stored as the first 399 * of the pair, both halves require swapping. 400 */ 401 if (type == DEVICE_PROP_UINT64) { 402 ret = OF_getencprop(node, propname, propvalue, size); 403 if (ret <= 0) { 404 return (ret); 405 } 406 407 buffer = (uint32_t *)propvalue; 408 409 for (i = 0; i < size / 4; i += 2) { 410 val = (uint64_t)buffer[i] << 32 | buffer[i + 1]; 411 ((uint64_t *)buffer)[i / 2] = val; 412 } 413 return (ret); 414 } 415 416 if (type == DEVICE_PROP_HANDLE) { 417 if (size < sizeof(node)) 418 return (-1); 419 ret = OF_getencprop(node, propname, &xref, sizeof(xref)); 420 if (ret <= 0) 421 return (ret); 422 423 node = OF_node_from_xref(xref); 424 if (propvalue != NULL) 425 *(uint32_t *)propvalue = node; 426 return (ret); 427 } 428 429 return (OF_getprop(node, propname, propvalue, size)); 430 } 431 432 static struct resource * 433 simplebus_alloc_resource(device_t bus, device_t child, int type, int *rid, 434 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags) 435 { 436 struct simplebus_softc *sc; 437 struct simplebus_devinfo *di; 438 struct resource_list_entry *rle; 439 int j; 440 441 sc = device_get_softc(bus); 442 443 /* 444 * Request for the default allocation with a given rid: use resource 445 * list stored in the local device info. 446 */ 447 if (RMAN_IS_DEFAULT_RANGE(start, end)) { 448 if ((di = device_get_ivars(child)) == NULL) 449 return (NULL); 450 451 rle = resource_list_find(&di->rl, type, *rid); 452 if (rle == NULL) { 453 if (bootverbose) 454 device_printf(bus, "no default resources for " 455 "rid = %d, type = %d\n", *rid, type); 456 return (NULL); 457 } 458 start = rle->start; 459 end = rle->end; 460 count = rle->count; 461 } 462 463 if (type == SYS_RES_IOPORT) 464 type = SYS_RES_MEMORY; 465 466 if (type == SYS_RES_MEMORY) { 467 /* Remap through ranges property */ 468 for (j = 0; j < sc->nranges; j++) { 469 if (start >= sc->ranges[j].bus && end < 470 sc->ranges[j].bus + sc->ranges[j].size) { 471 start -= sc->ranges[j].bus; 472 start += sc->ranges[j].host; 473 end -= sc->ranges[j].bus; 474 end += sc->ranges[j].host; 475 break; 476 } 477 } 478 if (j == sc->nranges && sc->nranges != 0) { 479 if (bootverbose) 480 device_printf(bus, "Could not map resource " 481 "%#jx-%#jx\n", start, end); 482 483 return (NULL); 484 } 485 } 486 487 return (bus_generic_alloc_resource(bus, child, type, rid, start, end, 488 count, flags)); 489 } 490 491 static int 492 simplebus_print_res(struct simplebus_devinfo *di) 493 { 494 int rv; 495 496 if (di == NULL) 497 return (0); 498 rv = 0; 499 rv += resource_list_print_type(&di->rl, "mem", SYS_RES_MEMORY, "%#jx"); 500 rv += resource_list_print_type(&di->rl, "irq", SYS_RES_IRQ, "%jd"); 501 return (rv); 502 } 503 504 static void 505 simplebus_probe_nomatch(device_t bus, device_t child) 506 { 507 const char *name, *type, *compat; 508 509 if (!bootverbose) 510 return; 511 512 compat = ofw_bus_get_compat(child); 513 if (compat == NULL) 514 return; 515 name = ofw_bus_get_name(child); 516 type = ofw_bus_get_type(child); 517 518 device_printf(bus, "<%s>", name != NULL ? name : "unknown"); 519 simplebus_print_res(device_get_ivars(child)); 520 if (!ofw_bus_status_okay(child)) 521 printf(" disabled"); 522 if (type) 523 printf(" type %s", type); 524 printf(" compat %s (no driver attached)\n", compat); 525 } 526 527 static int 528 simplebus_print_child(device_t bus, device_t child) 529 { 530 int rv; 531 532 rv = bus_print_child_header(bus, child); 533 rv += simplebus_print_res(device_get_ivars(child)); 534 if (!ofw_bus_status_okay(child)) 535 rv += printf(" disabled"); 536 rv += bus_print_child_footer(bus, child); 537 return (rv); 538 } 539