nexus.c revision 308382
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, DMA requests (which rightfully should be a part of the 38 * ISA code but it's easier to do it here for now), I/O port addresses, 39 * and I/O memory address space. 40 */ 41 42#include "opt_acpi.h" 43#include "opt_platform.h" 44 45#include <sys/cdefs.h> 46__FBSDID("$FreeBSD: stable/11/sys/arm64/arm64/nexus.c 308382 2016-11-06 18:40:12Z gonzo $"); 47 48#include <sys/param.h> 49#include <sys/systm.h> 50#include <sys/bus.h> 51#include <sys/kernel.h> 52#include <sys/malloc.h> 53#include <sys/module.h> 54#include <machine/bus.h> 55#include <sys/rman.h> 56#include <sys/interrupt.h> 57 58#include <machine/vmparam.h> 59#include <machine/pcb.h> 60#include <vm/vm.h> 61#include <vm/pmap.h> 62 63#include <machine/resource.h> 64#include <machine/intr.h> 65 66#ifdef FDT 67#include <dev/ofw/ofw_bus_subr.h> 68#include <dev/ofw/openfirm.h> 69#include "ofw_bus_if.h" 70#endif 71#ifdef DEV_ACPI 72#include <contrib/dev/acpica/include/acpi.h> 73#include <dev/acpica/acpivar.h> 74#endif 75 76extern struct bus_space memmap_bus; 77 78static MALLOC_DEFINE(M_NEXUSDEV, "nexusdev", "Nexus device"); 79 80struct nexus_device { 81 struct resource_list nx_resources; 82}; 83 84#define DEVTONX(dev) ((struct nexus_device *)device_get_ivars(dev)) 85 86static struct rman mem_rman; 87static struct rman irq_rman; 88 89static int nexus_attach(device_t); 90 91#ifdef FDT 92static device_probe_t nexus_fdt_probe; 93static device_attach_t nexus_fdt_attach; 94#endif 95#ifdef DEV_ACPI 96static device_probe_t nexus_acpi_probe; 97static device_attach_t nexus_acpi_attach; 98#endif 99 100static int nexus_print_child(device_t, device_t); 101static device_t nexus_add_child(device_t, u_int, const char *, int); 102static struct resource *nexus_alloc_resource(device_t, device_t, int, int *, 103 rman_res_t, rman_res_t, rman_res_t, u_int); 104static int nexus_activate_resource(device_t, device_t, int, int, 105 struct resource *); 106static int nexus_config_intr(device_t dev, int irq, enum intr_trigger trig, 107 enum intr_polarity pol); 108static struct resource_list *nexus_get_reslist(device_t, device_t); 109static int nexus_set_resource(device_t, device_t, int, int, 110 rman_res_t, rman_res_t); 111static int nexus_deactivate_resource(device_t, device_t, int, int, 112 struct resource *); 113 114static int nexus_setup_intr(device_t dev, device_t child, struct resource *res, 115 int flags, driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep); 116static int nexus_teardown_intr(device_t, device_t, struct resource *, void *); 117static bus_space_tag_t nexus_get_bus_tag(device_t, device_t); 118#ifdef SMP 119static int nexus_bind_intr(device_t, device_t, struct resource *, int); 120#endif 121 122#ifdef FDT 123static int nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent, 124 int icells, pcell_t *intr); 125#endif 126 127static device_method_t nexus_methods[] = { 128 /* Bus interface */ 129 DEVMETHOD(bus_print_child, nexus_print_child), 130 DEVMETHOD(bus_add_child, nexus_add_child), 131 DEVMETHOD(bus_alloc_resource, nexus_alloc_resource), 132 DEVMETHOD(bus_activate_resource, nexus_activate_resource), 133 DEVMETHOD(bus_config_intr, nexus_config_intr), 134 DEVMETHOD(bus_get_resource_list, nexus_get_reslist), 135 DEVMETHOD(bus_set_resource, nexus_set_resource), 136 DEVMETHOD(bus_deactivate_resource, nexus_deactivate_resource), 137 DEVMETHOD(bus_setup_intr, nexus_setup_intr), 138 DEVMETHOD(bus_teardown_intr, nexus_teardown_intr), 139 DEVMETHOD(bus_get_bus_tag, nexus_get_bus_tag), 140#ifdef SMP 141 DEVMETHOD(bus_bind_intr, nexus_bind_intr), 142#endif 143 { 0, 0 } 144}; 145 146static driver_t nexus_driver = { 147 "nexus", 148 nexus_methods, 149 1 /* no softc */ 150}; 151 152static int 153nexus_attach(device_t dev) 154{ 155 156 mem_rman.rm_start = 0; 157 mem_rman.rm_end = BUS_SPACE_MAXADDR; 158 mem_rman.rm_type = RMAN_ARRAY; 159 mem_rman.rm_descr = "I/O memory addresses"; 160 if (rman_init(&mem_rman) || 161 rman_manage_region(&mem_rman, 0, BUS_SPACE_MAXADDR)) 162 panic("nexus_attach mem_rman"); 163 irq_rman.rm_start = 0; 164 irq_rman.rm_end = ~0; 165 irq_rman.rm_type = RMAN_ARRAY; 166 irq_rman.rm_descr = "Interrupts"; 167 if (rman_init(&irq_rman) || rman_manage_region(&irq_rman, 0, ~0)) 168 panic("nexus_attach irq_rman"); 169 170 bus_generic_probe(dev); 171 bus_generic_attach(dev); 172 173 return (0); 174} 175 176static int 177nexus_print_child(device_t bus, device_t child) 178{ 179 int retval = 0; 180 181 retval += bus_print_child_header(bus, child); 182 retval += printf("\n"); 183 184 return (retval); 185} 186 187static device_t 188nexus_add_child(device_t bus, u_int order, const char *name, int unit) 189{ 190 device_t child; 191 struct nexus_device *ndev; 192 193 ndev = malloc(sizeof(struct nexus_device), M_NEXUSDEV, M_NOWAIT|M_ZERO); 194 if (!ndev) 195 return (0); 196 resource_list_init(&ndev->nx_resources); 197 198 child = device_add_child_ordered(bus, order, name, unit); 199 200 /* should we free this in nexus_child_detached? */ 201 device_set_ivars(child, ndev); 202 203 return (child); 204} 205 206 207/* 208 * Allocate a resource on behalf of child. NB: child is usually going to be a 209 * child of one of our descendants, not a direct child of nexus0. 210 * (Exceptions include footbridge.) 211 */ 212static struct resource * 213nexus_alloc_resource(device_t bus, device_t child, int type, int *rid, 214 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags) 215{ 216 struct nexus_device *ndev = DEVTONX(child); 217 struct resource *rv; 218 struct resource_list_entry *rle; 219 struct rman *rm; 220 int needactivate = flags & RF_ACTIVE; 221 222 /* 223 * If this is an allocation of the "default" range for a given 224 * RID, and we know what the resources for this device are 225 * (ie. they aren't maintained by a child bus), then work out 226 * the start/end values. 227 */ 228 if (RMAN_IS_DEFAULT_RANGE(start, end) && (count == 1)) { 229 if (device_get_parent(child) != bus || ndev == NULL) 230 return(NULL); 231 rle = resource_list_find(&ndev->nx_resources, type, *rid); 232 if (rle == NULL) 233 return(NULL); 234 start = rle->start; 235 end = rle->end; 236 count = rle->count; 237 } 238 239 switch (type) { 240 case SYS_RES_IRQ: 241 rm = &irq_rman; 242 break; 243 244 case SYS_RES_MEMORY: 245 case SYS_RES_IOPORT: 246 rm = &mem_rman; 247 break; 248 249 default: 250 return (NULL); 251 } 252 253 rv = rman_reserve_resource(rm, start, end, count, flags, child); 254 if (rv == NULL) 255 return (NULL); 256 257 rman_set_rid(rv, *rid); 258 rman_set_bushandle(rv, rman_get_start(rv)); 259 260 if (needactivate) { 261 if (bus_activate_resource(child, type, *rid, rv)) { 262 rman_release_resource(rv); 263 return (NULL); 264 } 265 } 266 267 return (rv); 268} 269 270static int 271nexus_config_intr(device_t dev, int irq, enum intr_trigger trig, 272 enum intr_polarity pol) 273{ 274 275 /* TODO: This is wrong, it's needed for ACPI */ 276 device_printf(dev, "bus_config_intr is obsolete and not supported!\n"); 277 return (EOPNOTSUPP); 278} 279 280static int 281nexus_setup_intr(device_t dev, device_t child, struct resource *res, int flags, 282 driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep) 283{ 284 int error; 285 286 if ((rman_get_flags(res) & RF_SHAREABLE) == 0) 287 flags |= INTR_EXCL; 288 289 /* We depend here on rman_activate_resource() being idempotent. */ 290 error = rman_activate_resource(res); 291 if (error) 292 return (error); 293 294 error = intr_setup_irq(child, res, filt, intr, arg, flags, cookiep); 295 296 return (error); 297} 298 299static int 300nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih) 301{ 302 303 return (intr_teardown_irq(child, r, ih)); 304} 305 306#ifdef SMP 307static int 308nexus_bind_intr(device_t dev, device_t child, struct resource *irq, int cpu) 309{ 310 311 return (intr_bind_irq(child, irq, cpu)); 312} 313#endif 314 315static bus_space_tag_t 316nexus_get_bus_tag(device_t bus __unused, device_t child __unused) 317{ 318 319 return(&memmap_bus); 320} 321 322static int 323nexus_activate_resource(device_t bus, device_t child, int type, int rid, 324 struct resource *r) 325{ 326 int err; 327 bus_addr_t paddr; 328 bus_size_t psize; 329 bus_space_handle_t vaddr; 330 331 if ((err = rman_activate_resource(r)) != 0) 332 return (err); 333 334 /* 335 * If this is a memory resource, map it into the kernel. 336 */ 337 if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) { 338 paddr = (bus_addr_t)rman_get_start(r); 339 psize = (bus_size_t)rman_get_size(r); 340 err = bus_space_map(&memmap_bus, paddr, psize, 0, &vaddr); 341 if (err != 0) { 342 rman_deactivate_resource(r); 343 return (err); 344 } 345 rman_set_bustag(r, &memmap_bus); 346 rman_set_virtual(r, (void *)vaddr); 347 rman_set_bushandle(r, vaddr); 348 } else if (type == SYS_RES_IRQ) { 349 err = intr_activate_irq(child, r); 350 if (err != 0) { 351 rman_deactivate_resource(r); 352 return (err); 353 } 354 } 355 return (0); 356} 357 358static struct resource_list * 359nexus_get_reslist(device_t dev, device_t child) 360{ 361 struct nexus_device *ndev = DEVTONX(child); 362 363 return (&ndev->nx_resources); 364} 365 366static int 367nexus_set_resource(device_t dev, device_t child, int type, int rid, 368 rman_res_t start, rman_res_t count) 369{ 370 struct nexus_device *ndev = DEVTONX(child); 371 struct resource_list *rl = &ndev->nx_resources; 372 373 /* XXX this should return a success/failure indicator */ 374 resource_list_add(rl, type, rid, start, start + count - 1, count); 375 376 return(0); 377} 378 379 380static int 381nexus_deactivate_resource(device_t bus, device_t child, int type, int rid, 382 struct resource *r) 383{ 384 bus_size_t psize; 385 bus_space_handle_t vaddr; 386 387 if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) { 388 psize = (bus_size_t)rman_get_size(r); 389 vaddr = rman_get_bushandle(r); 390 391 if (vaddr != 0) { 392 bus_space_unmap(&memmap_bus, vaddr, psize); 393 rman_set_virtual(r, NULL); 394 rman_set_bushandle(r, 0); 395 } 396 } else if (type == SYS_RES_IRQ) { 397 intr_deactivate_irq(child, r); 398 } 399 400 return (rman_deactivate_resource(r)); 401} 402 403#ifdef FDT 404static device_method_t nexus_fdt_methods[] = { 405 /* Device interface */ 406 DEVMETHOD(device_probe, nexus_fdt_probe), 407 DEVMETHOD(device_attach, nexus_fdt_attach), 408 409 /* OFW interface */ 410 DEVMETHOD(ofw_bus_map_intr, nexus_ofw_map_intr), 411}; 412 413#define nexus_baseclasses nexus_fdt_baseclasses 414DEFINE_CLASS_1(nexus, nexus_fdt_driver, nexus_fdt_methods, 1, nexus_driver); 415#undef nexus_baseclasses 416static devclass_t nexus_fdt_devclass; 417 418EARLY_DRIVER_MODULE(nexus_fdt, root, nexus_fdt_driver, nexus_fdt_devclass, 419 0, 0, BUS_PASS_BUS + BUS_PASS_ORDER_FIRST); 420 421static int 422nexus_fdt_probe(device_t dev) 423{ 424 425 if (OF_peer(0) == 0) 426 return (ENXIO); 427 428 device_quiet(dev); 429 return (BUS_PROBE_DEFAULT); 430} 431 432static int 433nexus_fdt_attach(device_t dev) 434{ 435 436 nexus_add_child(dev, 10, "ofwbus", 0); 437 return (nexus_attach(dev)); 438} 439 440static int 441nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent, int icells, 442 pcell_t *intr) 443{ 444 u_int irq; 445 struct intr_map_data_fdt *fdt_data; 446 size_t len; 447 448 len = sizeof(*fdt_data) + icells * sizeof(pcell_t); 449 fdt_data = (struct intr_map_data_fdt *)intr_alloc_map_data( 450 INTR_MAP_DATA_FDT, len, M_WAITOK | M_ZERO); 451 fdt_data->iparent = iparent; 452 fdt_data->ncells = icells; 453 memcpy(fdt_data->cells, intr, icells * sizeof(pcell_t)); 454 irq = intr_map_irq(NULL, iparent, (struct intr_map_data *)fdt_data); 455 return (irq); 456} 457#endif 458 459#ifdef DEV_ACPI 460static device_method_t nexus_acpi_methods[] = { 461 /* Device interface */ 462 DEVMETHOD(device_probe, nexus_acpi_probe), 463 DEVMETHOD(device_attach, nexus_acpi_attach), 464}; 465 466#define nexus_baseclasses nexus_acpi_baseclasses 467DEFINE_CLASS_1(nexus, nexus_acpi_driver, nexus_acpi_methods, 1, 468 nexus_driver); 469#undef nexus_baseclasses 470static devclass_t nexus_acpi_devclass; 471 472EARLY_DRIVER_MODULE(nexus_acpi, root, nexus_acpi_driver, nexus_acpi_devclass, 473 0, 0, BUS_PASS_BUS + BUS_PASS_ORDER_FIRST); 474 475static int 476nexus_acpi_probe(device_t dev) 477{ 478 479 if (acpi_identify() != 0) 480 return (ENXIO); 481 482 device_quiet(dev); 483 return (BUS_PROBE_LOW_PRIORITY); 484} 485 486static int 487nexus_acpi_attach(device_t dev) 488{ 489 490 nexus_add_child(dev, 10, "acpi", 0); 491 return (nexus_attach(dev)); 492} 493#endif 494