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