1 /*- 2 * Copyright 1998 Massachusetts Institute of Technology 3 * 4 * Permission to use, copy, modify, and distribute this software and 5 * its documentation for any purpose and without fee is hereby 6 * granted, provided that both the above copyright notice and this 7 * permission notice appear in all copies, that both the above 8 * copyright notice and this permission notice appear in all 9 * supporting documentation, and that the name of M.I.T. not be used 10 * in advertising or publicity pertaining to distribution of the 11 * software without specific, written prior permission. M.I.T. makes 12 * no representations about the suitability of this software for any 13 * purpose. It is provided "as is" without express or implied 14 * warranty. 15 * 16 * THIS SOFTWARE IS PROVIDED BY M.I.T. ``AS IS''. M.I.T. DISCLAIMS 17 * ALL EXPRESS OR IMPLIED WARRANTIES WITH REGARD TO THIS SOFTWARE, 18 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 19 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT 20 * SHALL M.I.T. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 23 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 24 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 25 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 26 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 * 29 */ 30 31 /* 32 * This code implements a `root nexus' for Arm Architecture 33 * machines. The function of the root nexus is to serve as an 34 * attachment point for both processors and buses, and to manage 35 * resources which are common to all of them. In particular, 36 * this code implements the core resource managers for interrupt 37 * requests and I/O memory address space. 38 */ 39 40 #include "opt_acpi.h" 41 #include "opt_platform.h" 42 43 #include <sys/cdefs.h> 44 __FBSDID("$FreeBSD$"); 45 46 #include <sys/param.h> 47 #include <sys/systm.h> 48 #include <sys/bus.h> 49 #include <sys/interrupt.h> 50 #include <sys/kernel.h> 51 #include <sys/malloc.h> 52 #include <sys/module.h> 53 #include <sys/rman.h> 54 #include <sys/sysctl.h> 55 56 #include <vm/vm.h> 57 #include <vm/pmap.h> 58 59 #include <machine/bus.h> 60 #include <machine/intr.h> 61 #include <machine/machdep.h> 62 #include <machine/pcb.h> 63 #include <machine/resource.h> 64 #include <machine/vmparam.h> 65 66 #ifdef FDT 67 #include <dev/ofw/ofw_bus_subr.h> 68 #include <dev/ofw/ofw_bus.h> 69 #include <dev/ofw/openfirm.h> 70 #include "ofw_bus_if.h" 71 #endif 72 #ifdef DEV_ACPI 73 #include <contrib/dev/acpica/include/acpi.h> 74 #include <dev/acpica/acpivar.h> 75 #include "acpi_bus_if.h" 76 #endif 77 78 extern struct bus_space memmap_bus; 79 80 static MALLOC_DEFINE(M_NEXUSDEV, "nexusdev", "Nexus device"); 81 82 struct nexus_device { 83 struct resource_list nx_resources; 84 }; 85 86 static int force_np; 87 SYSCTL_INT(_kern, OID_AUTO, force_nonposted, CTLFLAG_RDTUN, &force_np, 0, 88 "Force all devices to use non-posted device memory"); 89 90 #define DEVTONX(dev) ((struct nexus_device *)device_get_ivars(dev)) 91 92 static struct rman mem_rman; 93 static struct rman irq_rman; 94 95 static int nexus_attach(device_t); 96 97 #ifdef FDT 98 static device_probe_t nexus_fdt_probe; 99 static device_attach_t nexus_fdt_attach; 100 static bus_activate_resource_t nexus_fdt_activate_resource; 101 #endif 102 #ifdef DEV_ACPI 103 static device_probe_t nexus_acpi_probe; 104 static device_attach_t nexus_acpi_attach; 105 #endif 106 107 static bus_add_child_t nexus_add_child; 108 static bus_print_child_t nexus_print_child; 109 110 static bus_activate_resource_t nexus_activate_resource; 111 static bus_adjust_resource_t nexus_adjust_resource; 112 static bus_alloc_resource_t nexus_alloc_resource; 113 static bus_deactivate_resource_t nexus_deactivate_resource; 114 static bus_get_resource_list_t nexus_get_reslist; 115 static bus_map_resource_t nexus_map_resource; 116 static bus_release_resource_t nexus_release_resource; 117 static bus_set_resource_t nexus_set_resource; 118 119 #ifdef SMP 120 static bus_bind_intr_t nexus_bind_intr; 121 #endif 122 static bus_config_intr_t nexus_config_intr; 123 static bus_describe_intr_t nexus_describe_intr; 124 static bus_setup_intr_t nexus_setup_intr; 125 static bus_teardown_intr_t nexus_teardown_intr; 126 127 static bus_get_bus_tag_t nexus_get_bus_tag; 128 129 #ifdef FDT 130 static ofw_bus_map_intr_t nexus_ofw_map_intr; 131 #endif 132 133 static device_method_t nexus_methods[] = { 134 /* Bus interface */ 135 DEVMETHOD(bus_add_child, nexus_add_child), 136 DEVMETHOD(bus_print_child, nexus_print_child), 137 DEVMETHOD(bus_activate_resource, nexus_activate_resource), 138 DEVMETHOD(bus_adjust_resource, nexus_adjust_resource), 139 DEVMETHOD(bus_alloc_resource, nexus_alloc_resource), 140 DEVMETHOD(bus_deactivate_resource, nexus_deactivate_resource), 141 DEVMETHOD(bus_get_resource_list, nexus_get_reslist), 142 DEVMETHOD(bus_map_resource, nexus_map_resource), 143 DEVMETHOD(bus_release_resource, nexus_release_resource), 144 DEVMETHOD(bus_set_resource, nexus_set_resource), 145 #ifdef SMP 146 DEVMETHOD(bus_bind_intr, nexus_bind_intr), 147 #endif 148 DEVMETHOD(bus_config_intr, nexus_config_intr), 149 DEVMETHOD(bus_setup_intr, nexus_setup_intr), 150 DEVMETHOD(bus_teardown_intr, nexus_teardown_intr), 151 DEVMETHOD(bus_get_bus_tag, nexus_get_bus_tag), 152 153 DEVMETHOD_END 154 }; 155 156 static driver_t nexus_driver = { 157 "nexus", 158 nexus_methods, 159 1 /* no softc */ 160 }; 161 162 static int 163 nexus_attach(device_t dev) 164 { 165 166 mem_rman.rm_start = 0; 167 mem_rman.rm_end = BUS_SPACE_MAXADDR; 168 mem_rman.rm_type = RMAN_ARRAY; 169 mem_rman.rm_descr = "I/O memory addresses"; 170 if (rman_init(&mem_rman) || 171 rman_manage_region(&mem_rman, 0, BUS_SPACE_MAXADDR)) 172 panic("nexus_attach mem_rman"); 173 irq_rman.rm_start = 0; 174 irq_rman.rm_end = ~0; 175 irq_rman.rm_type = RMAN_ARRAY; 176 irq_rman.rm_descr = "Interrupts"; 177 if (rman_init(&irq_rman) || rman_manage_region(&irq_rman, 0, ~0)) 178 panic("nexus_attach irq_rman"); 179 180 bus_generic_probe(dev); 181 bus_generic_attach(dev); 182 183 return (0); 184 } 185 186 static int 187 nexus_print_child(device_t bus, device_t child) 188 { 189 int retval = 0; 190 191 retval += bus_print_child_header(bus, child); 192 retval += printf("\n"); 193 194 return (retval); 195 } 196 197 static device_t 198 nexus_add_child(device_t bus, u_int order, const char *name, int unit) 199 { 200 device_t child; 201 struct nexus_device *ndev; 202 203 ndev = malloc(sizeof(struct nexus_device), M_NEXUSDEV, M_NOWAIT|M_ZERO); 204 if (!ndev) 205 return (0); 206 resource_list_init(&ndev->nx_resources); 207 208 child = device_add_child_ordered(bus, order, name, unit); 209 210 /* should we free this in nexus_child_detached? */ 211 device_set_ivars(child, ndev); 212 213 return (child); 214 } 215 216 /* 217 * Allocate a resource on behalf of child. NB: child is usually going to be a 218 * child of one of our descendants, not a direct child of nexus0. 219 */ 220 static struct resource * 221 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid, 222 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags) 223 { 224 struct nexus_device *ndev = DEVTONX(child); 225 struct resource *rv; 226 struct resource_list_entry *rle; 227 struct rman *rm; 228 int needactivate = flags & RF_ACTIVE; 229 230 /* 231 * If this is an allocation of the "default" range for a given 232 * RID, and we know what the resources for this device are 233 * (ie. they aren't maintained by a child bus), then work out 234 * the start/end values. 235 */ 236 if (RMAN_IS_DEFAULT_RANGE(start, end) && (count == 1)) { 237 if (device_get_parent(child) != bus || ndev == NULL) 238 return (NULL); 239 rle = resource_list_find(&ndev->nx_resources, type, *rid); 240 if (rle == NULL) 241 return (NULL); 242 start = rle->start; 243 end = rle->end; 244 count = rle->count; 245 } 246 247 switch (type) { 248 case SYS_RES_IRQ: 249 rm = &irq_rman; 250 break; 251 252 case SYS_RES_MEMORY: 253 case SYS_RES_IOPORT: 254 rm = &mem_rman; 255 break; 256 257 default: 258 return (NULL); 259 } 260 261 rv = rman_reserve_resource(rm, start, end, count, flags, child); 262 if (rv == NULL) 263 return (NULL); 264 265 rman_set_rid(rv, *rid); 266 rman_set_bushandle(rv, rman_get_start(rv)); 267 268 if (needactivate) { 269 if (bus_activate_resource(child, type, *rid, rv)) { 270 rman_release_resource(rv); 271 return (NULL); 272 } 273 } 274 275 return (rv); 276 } 277 278 static int 279 nexus_adjust_resource(device_t bus __unused, device_t child __unused, int type, 280 struct resource *r, rman_res_t start, rman_res_t end) 281 { 282 struct rman *rm; 283 284 switch (type) { 285 case SYS_RES_IRQ: 286 rm = &irq_rman; 287 break; 288 case SYS_RES_MEMORY: 289 rm = &mem_rman; 290 break; 291 default: 292 return (EINVAL); 293 } 294 if (rman_is_region_manager(r, rm) == 0) 295 return (EINVAL); 296 return (rman_adjust_resource(r, start, end)); 297 } 298 299 static int 300 nexus_release_resource(device_t bus, device_t child, int type, int rid, 301 struct resource *res) 302 { 303 int error; 304 305 if (rman_get_flags(res) & RF_ACTIVE) { 306 error = bus_deactivate_resource(child, type, rid, res); 307 if (error) 308 return (error); 309 } 310 return (rman_release_resource(res)); 311 } 312 313 static int 314 nexus_config_intr(device_t dev, int irq, enum intr_trigger trig, 315 enum intr_polarity pol) 316 { 317 318 /* 319 * On arm64 (due to INTRNG), ACPI interrupt configuration is 320 * done in nexus_acpi_map_intr(). 321 */ 322 return (0); 323 } 324 325 static int 326 nexus_setup_intr(device_t dev, device_t child, struct resource *res, int flags, 327 driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep) 328 { 329 int error; 330 331 if ((rman_get_flags(res) & RF_SHAREABLE) == 0) 332 flags |= INTR_EXCL; 333 334 /* We depend here on rman_activate_resource() being idempotent. */ 335 error = rman_activate_resource(res); 336 if (error) 337 return (error); 338 339 error = intr_setup_irq(child, res, filt, intr, arg, flags, cookiep); 340 341 return (error); 342 } 343 344 static int 345 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih) 346 { 347 348 return (intr_teardown_irq(child, r, ih)); 349 } 350 351 #ifdef SMP 352 static int 353 nexus_bind_intr(device_t dev, device_t child, struct resource *irq, int cpu) 354 { 355 356 return (intr_bind_irq(child, irq, cpu)); 357 } 358 #endif 359 360 static bus_space_tag_t 361 nexus_get_bus_tag(device_t bus __unused, device_t child __unused) 362 { 363 364 return (&memmap_bus); 365 } 366 367 static int 368 nexus_activate_resource_flags(device_t bus, device_t child, int type, int rid, 369 struct resource *r, int flags) 370 { 371 struct resource_map_request args; 372 struct resource_map map; 373 int err, use_np; 374 375 if ((err = rman_activate_resource(r)) != 0) 376 return (err); 377 378 /* 379 * If this is a memory resource, map it into the kernel. 380 */ 381 switch (type) { 382 case SYS_RES_IOPORT: 383 case SYS_RES_MEMORY: 384 if ((rman_get_flags(r) & RF_UNMAPPED) == 0) { 385 resource_init_map_request(&args); 386 use_np = (flags & BUS_SPACE_MAP_NONPOSTED) != 0 || 387 force_np; 388 if (!use_np) 389 resource_int_value(device_get_name(child), 390 device_get_unit(child), "force_nonposted", 391 &use_np); 392 if (use_np) 393 args.memattr = VM_MEMATTR_DEVICE_NP; 394 err = nexus_map_resource(bus, child, type, r, &args, 395 &map); 396 if (err != 0) { 397 rman_deactivate_resource(r); 398 return (err); 399 } 400 401 rman_set_mapping(r, &map); 402 } 403 break; 404 case SYS_RES_IRQ: 405 err = intr_activate_irq(child, r); 406 if (err != 0) { 407 rman_deactivate_resource(r); 408 return (err); 409 } 410 } 411 return (0); 412 } 413 414 static int 415 nexus_activate_resource(device_t dev, device_t child, int type, int rid, 416 struct resource *r) 417 { 418 return (nexus_activate_resource_flags(dev, child, type, rid, r, 0)); 419 } 420 421 static struct resource_list * 422 nexus_get_reslist(device_t dev, device_t child) 423 { 424 struct nexus_device *ndev = DEVTONX(child); 425 426 return (&ndev->nx_resources); 427 } 428 429 static int 430 nexus_set_resource(device_t dev, device_t child, int type, int rid, 431 rman_res_t start, rman_res_t count) 432 { 433 struct nexus_device *ndev = DEVTONX(child); 434 struct resource_list *rl = &ndev->nx_resources; 435 436 /* XXX this should return a success/failure indicator */ 437 resource_list_add(rl, type, rid, start, start + count - 1, count); 438 439 return (0); 440 } 441 442 static int 443 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid, 444 struct resource *r) 445 { 446 bus_size_t psize; 447 bus_space_handle_t vaddr; 448 449 if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) { 450 psize = (bus_size_t)rman_get_size(r); 451 vaddr = rman_get_bushandle(r); 452 453 if (vaddr != 0) { 454 bus_space_unmap(&memmap_bus, vaddr, psize); 455 rman_set_virtual(r, NULL); 456 rman_set_bushandle(r, 0); 457 } 458 } else if (type == SYS_RES_IRQ) { 459 intr_deactivate_irq(child, r); 460 } 461 462 return (rman_deactivate_resource(r)); 463 } 464 465 static int 466 nexus_map_resource(device_t bus, device_t child, int type, struct resource *r, 467 struct resource_map_request *argsp, struct resource_map *map) 468 { 469 struct resource_map_request args; 470 rman_res_t end, length, start; 471 472 /* Resources must be active to be mapped. */ 473 if ((rman_get_flags(r) & RF_ACTIVE) == 0) 474 return (ENXIO); 475 476 /* Mappings are only supported on I/O and memory resources. */ 477 switch (type) { 478 case SYS_RES_IOPORT: 479 case SYS_RES_MEMORY: 480 break; 481 default: 482 return (EINVAL); 483 } 484 485 resource_init_map_request(&args); 486 if (argsp != NULL) 487 bcopy(argsp, &args, imin(argsp->size, args.size)); 488 start = rman_get_start(r) + args.offset; 489 if (args.length == 0) 490 length = rman_get_size(r); 491 else 492 length = args.length; 493 end = start + length - 1; 494 if (start > rman_get_end(r) || start < rman_get_start(r)) 495 return (EINVAL); 496 if (end > rman_get_end(r) || end < start) 497 return (EINVAL); 498 499 map->r_vaddr = pmap_mapdev_attr(start, length, args.memattr); 500 map->r_bustag = &memmap_bus; 501 map->r_size = length; 502 503 /* 504 * The handle is the virtual address. 505 */ 506 map->r_bushandle = (bus_space_handle_t)map->r_vaddr; 507 return (0); 508 } 509 510 #ifdef FDT 511 static device_method_t nexus_fdt_methods[] = { 512 /* Device interface */ 513 DEVMETHOD(device_probe, nexus_fdt_probe), 514 DEVMETHOD(device_attach, nexus_fdt_attach), 515 516 /* Bus interface */ 517 DEVMETHOD(bus_activate_resource, nexus_fdt_activate_resource), 518 519 /* OFW interface */ 520 DEVMETHOD(ofw_bus_map_intr, nexus_ofw_map_intr), 521 522 DEVMETHOD_END, 523 }; 524 525 #define nexus_baseclasses nexus_fdt_baseclasses 526 DEFINE_CLASS_1(nexus, nexus_fdt_driver, nexus_fdt_methods, 1, nexus_driver); 527 #undef nexus_baseclasses 528 529 EARLY_DRIVER_MODULE(nexus_fdt, root, nexus_fdt_driver, 0, 0, 530 BUS_PASS_BUS + BUS_PASS_ORDER_FIRST); 531 532 static int 533 nexus_fdt_probe(device_t dev) 534 { 535 536 if (arm64_bus_method != ARM64_BUS_FDT) 537 return (ENXIO); 538 539 device_quiet(dev); 540 return (BUS_PROBE_DEFAULT); 541 } 542 543 static int 544 nexus_fdt_attach(device_t dev) 545 { 546 547 nexus_add_child(dev, 10, "ofwbus", 0); 548 return (nexus_attach(dev)); 549 } 550 551 static int 552 nexus_fdt_activate_resource(device_t bus, device_t child, int type, int rid, 553 struct resource *r) 554 { 555 phandle_t node, parent; 556 int flags; 557 558 flags = 0; 559 switch (type) { 560 case SYS_RES_MEMORY: 561 case SYS_RES_IOPORT: 562 /* 563 * If the fdt parent has the nonposted-mmio property we 564 * need to use non-posted IO to access the device. When 565 * we find this property set the BUS_SPACE_MAP_NONPOSTED 566 * flag to be passed to bus_space_map. 567 */ 568 node = ofw_bus_get_node(child); 569 if (node != -1) { 570 parent = OF_parent(node); 571 if (parent != 0 && 572 OF_hasprop(parent, "nonposted-mmio")) { 573 flags |= BUS_SPACE_MAP_NONPOSTED; 574 } 575 } 576 break; 577 default: 578 break; 579 } 580 581 return (nexus_activate_resource_flags(bus, child, type, rid, r, flags)); 582 } 583 584 static int 585 nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent, int icells, 586 pcell_t *intr) 587 { 588 u_int irq; 589 struct intr_map_data_fdt *fdt_data; 590 size_t len; 591 592 len = sizeof(*fdt_data) + icells * sizeof(pcell_t); 593 fdt_data = (struct intr_map_data_fdt *)intr_alloc_map_data( 594 INTR_MAP_DATA_FDT, len, M_WAITOK | M_ZERO); 595 fdt_data->iparent = iparent; 596 fdt_data->ncells = icells; 597 memcpy(fdt_data->cells, intr, icells * sizeof(pcell_t)); 598 irq = intr_map_irq(NULL, iparent, (struct intr_map_data *)fdt_data); 599 return (irq); 600 } 601 #endif 602 603 #ifdef DEV_ACPI 604 static int nexus_acpi_map_intr(device_t dev, device_t child, u_int irq, int trig, int pol); 605 606 static device_method_t nexus_acpi_methods[] = { 607 /* Device interface */ 608 DEVMETHOD(device_probe, nexus_acpi_probe), 609 DEVMETHOD(device_attach, nexus_acpi_attach), 610 611 /* ACPI interface */ 612 DEVMETHOD(acpi_bus_map_intr, nexus_acpi_map_intr), 613 614 DEVMETHOD_END, 615 }; 616 617 #define nexus_baseclasses nexus_acpi_baseclasses 618 DEFINE_CLASS_1(nexus, nexus_acpi_driver, nexus_acpi_methods, 1, 619 nexus_driver); 620 #undef nexus_baseclasses 621 622 EARLY_DRIVER_MODULE(nexus_acpi, root, nexus_acpi_driver, 0, 0, 623 BUS_PASS_BUS + BUS_PASS_ORDER_FIRST); 624 625 static int 626 nexus_acpi_probe(device_t dev) 627 { 628 629 if (arm64_bus_method != ARM64_BUS_ACPI || acpi_identify() != 0) 630 return (ENXIO); 631 632 device_quiet(dev); 633 return (BUS_PROBE_LOW_PRIORITY); 634 } 635 636 static int 637 nexus_acpi_attach(device_t dev) 638 { 639 640 nexus_add_child(dev, 10, "acpi", 0); 641 return (nexus_attach(dev)); 642 } 643 644 static int 645 nexus_acpi_map_intr(device_t dev, device_t child, u_int irq, int trig, int pol) 646 { 647 struct intr_map_data_acpi *acpi_data; 648 size_t len; 649 650 len = sizeof(*acpi_data); 651 acpi_data = (struct intr_map_data_acpi *)intr_alloc_map_data( 652 INTR_MAP_DATA_ACPI, len, M_WAITOK | M_ZERO); 653 acpi_data->irq = irq; 654 acpi_data->pol = pol; 655 acpi_data->trig = trig; 656 657 /* 658 * TODO: This will only handle a single interrupt controller. 659 * ACPI will map multiple controllers into a single virtual IRQ 660 * space. Each controller has a System Vector Base to hold the 661 * first irq it handles in this space. As such the correct way 662 * to handle interrupts with ACPI is to search through the 663 * controllers for the largest base value that is no larger than 664 * the IRQ value. 665 */ 666 irq = intr_map_irq(NULL, ACPI_INTR_XREF, 667 (struct intr_map_data *)acpi_data); 668 return (irq); 669 } 670 #endif 671