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_platform.h" 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 <arm/arm/nexusvar.h> 64 65 #ifdef FDT 66 #include <machine/fdt.h> 67 #include <dev/ofw/ofw_bus_subr.h> 68 #include "ofw_bus_if.h" 69 #endif 70 71 static MALLOC_DEFINE(M_NEXUSDEV, "nexusdev", "Nexus device"); 72 73 struct nexus_device { 74 struct resource_list nx_resources; 75 }; 76 77 #define DEVTONX(dev) ((struct nexus_device *)device_get_ivars(dev)) 78 79 static struct rman mem_rman; 80 static struct rman irq_rman; 81 82 static int nexus_probe(device_t); 83 static int nexus_attach(device_t); 84 static int nexus_print_child(device_t, device_t); 85 static device_t nexus_add_child(device_t, u_int, const char *, int); 86 static struct resource *nexus_alloc_resource(device_t, device_t, int, int *, 87 rman_res_t, rman_res_t, rman_res_t, u_int); 88 static int nexus_activate_resource(device_t, device_t, int, int, 89 struct resource *); 90 static int nexus_adjust_resource(device_t, device_t, int, struct resource *, 91 rman_res_t, rman_res_t); 92 static bus_space_tag_t nexus_get_bus_tag(device_t, device_t); 93 static bus_dma_tag_t nexus_get_dma_tag(device_t dev, device_t child); 94 #ifdef SMP 95 static int nexus_bind_intr(device_t, device_t, struct resource *, int); 96 #endif 97 static int nexus_config_intr(device_t dev, int irq, enum intr_trigger trig, 98 enum intr_polarity pol); 99 static int nexus_describe_intr(device_t dev, device_t child, 100 struct resource *irq, void *cookie, const char *descr); 101 static int nexus_deactivate_resource(device_t, device_t, int, int, 102 struct resource *); 103 static int nexus_release_resource(device_t, device_t, int, int, 104 struct resource *); 105 106 static int nexus_setup_intr(device_t dev, device_t child, struct resource *res, 107 int flags, driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep); 108 static int nexus_teardown_intr(device_t, device_t, struct resource *, void *); 109 110 #ifdef FDT 111 static int nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent, 112 int icells, pcell_t *intr); 113 #endif 114 115 /* 116 * Normally NULL (which results in defaults which are handled in 117 * busdma_machdep), platform init code can use nexus_set_dma_tag() to set this 118 * to a tag that will be inherited by all busses and devices on the platform. 119 */ 120 static bus_dma_tag_t nexus_dma_tag; 121 122 static device_method_t nexus_methods[] = { 123 /* Device interface */ 124 DEVMETHOD(device_probe, nexus_probe), 125 DEVMETHOD(device_attach, nexus_attach), 126 /* Bus interface */ 127 DEVMETHOD(bus_print_child, nexus_print_child), 128 DEVMETHOD(bus_add_child, nexus_add_child), 129 DEVMETHOD(bus_alloc_resource, nexus_alloc_resource), 130 DEVMETHOD(bus_activate_resource, nexus_activate_resource), 131 DEVMETHOD(bus_adjust_resource, nexus_adjust_resource), 132 DEVMETHOD(bus_config_intr, nexus_config_intr), 133 DEVMETHOD(bus_deactivate_resource, nexus_deactivate_resource), 134 DEVMETHOD(bus_release_resource, nexus_release_resource), 135 DEVMETHOD(bus_setup_intr, nexus_setup_intr), 136 DEVMETHOD(bus_teardown_intr, nexus_teardown_intr), 137 DEVMETHOD(bus_get_bus_tag, nexus_get_bus_tag), 138 DEVMETHOD(bus_get_dma_tag, nexus_get_dma_tag), 139 DEVMETHOD(bus_describe_intr, nexus_describe_intr), 140 #ifdef SMP 141 DEVMETHOD(bus_bind_intr, nexus_bind_intr), 142 #endif 143 #ifdef FDT 144 DEVMETHOD(ofw_bus_map_intr, nexus_ofw_map_intr), 145 #endif 146 { 0, 0 } 147 }; 148 149 static driver_t nexus_driver = { 150 "nexus", 151 nexus_methods, 152 1 /* no softc */ 153 }; 154 155 EARLY_DRIVER_MODULE(nexus, root, nexus_driver, 0, 0, 156 BUS_PASS_BUS + BUS_PASS_ORDER_EARLY); 157 158 static int 159 nexus_probe(device_t dev) 160 { 161 162 device_quiet(dev); /* suppress attach message for neatness */ 163 164 return (BUS_PROBE_DEFAULT); 165 } 166 167 static int 168 nexus_attach(device_t dev) 169 { 170 171 mem_rman.rm_start = 0; 172 mem_rman.rm_end = BUS_SPACE_MAXADDR; 173 mem_rman.rm_type = RMAN_ARRAY; 174 mem_rman.rm_descr = "I/O memory addresses"; 175 if (rman_init(&mem_rman) || 176 rman_manage_region(&mem_rman, 0, BUS_SPACE_MAXADDR)) 177 panic("nexus_probe mem_rman"); 178 irq_rman.rm_start = 0; 179 irq_rman.rm_end = ~0; 180 irq_rman.rm_type = RMAN_ARRAY; 181 irq_rman.rm_descr = "Interrupts"; 182 if (rman_init(&irq_rman) || rman_manage_region(&irq_rman, 0, ~0)) 183 panic("nexus_attach irq_rman"); 184 185 /* 186 * First, deal with the children we know about already 187 */ 188 bus_generic_probe(dev); 189 bus_generic_attach(dev); 190 191 return (0); 192 } 193 194 static int 195 nexus_print_child(device_t bus, device_t child) 196 { 197 int retval = 0; 198 199 retval += bus_print_child_header(bus, child); 200 retval += printf("\n"); 201 202 return (retval); 203 } 204 205 static device_t 206 nexus_add_child(device_t bus, u_int order, const char *name, int unit) 207 { 208 device_t child; 209 struct nexus_device *ndev; 210 211 ndev = malloc(sizeof(struct nexus_device), M_NEXUSDEV, M_NOWAIT|M_ZERO); 212 if (!ndev) 213 return (0); 214 resource_list_init(&ndev->nx_resources); 215 216 child = device_add_child_ordered(bus, order, name, unit); 217 218 /* should we free this in nexus_child_detached? */ 219 device_set_ivars(child, ndev); 220 221 return (child); 222 } 223 224 /* 225 * Allocate a resource on behalf of child. NB: child is usually going to be a 226 * child of one of our descendants, not a direct child of nexus0. 227 * (Exceptions include footbridge.) 228 */ 229 static struct resource * 230 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid, 231 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags) 232 { 233 struct resource *rv; 234 struct rman *rm; 235 int needactivate = flags & RF_ACTIVE; 236 237 flags &= ~RF_ACTIVE; 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 259 if (needactivate) { 260 if (bus_activate_resource(child, type, *rid, rv)) { 261 rman_release_resource(rv); 262 return (0); 263 } 264 } 265 266 return (rv); 267 } 268 269 static int 270 nexus_adjust_resource(device_t bus __unused, device_t child __unused, int type, 271 struct resource *r, rman_res_t start, rman_res_t end) 272 { 273 struct rman *rm; 274 275 switch (type) { 276 case SYS_RES_IRQ: 277 rm = &irq_rman; 278 break; 279 case SYS_RES_MEMORY: 280 rm = &mem_rman; 281 break; 282 default: 283 return (EINVAL); 284 } 285 if (rman_is_region_manager(r, rm) == 0) 286 return (EINVAL); 287 return (rman_adjust_resource(r, start, end)); 288 } 289 290 static int 291 nexus_release_resource(device_t bus, device_t child, int type, int rid, 292 struct resource *res) 293 { 294 int error; 295 296 if (rman_get_flags(res) & RF_ACTIVE) { 297 error = bus_deactivate_resource(child, type, rid, res); 298 if (error) 299 return (error); 300 } 301 return (rman_release_resource(res)); 302 } 303 304 static bus_space_tag_t 305 nexus_get_bus_tag(device_t bus __unused, device_t child __unused) 306 { 307 308 #ifdef FDT 309 return(fdtbus_bs_tag); 310 #else 311 return((void *)1); 312 #endif 313 } 314 315 static bus_dma_tag_t 316 nexus_get_dma_tag(device_t dev, device_t child) 317 { 318 319 return nexus_dma_tag; 320 } 321 322 void 323 nexus_set_dma_tag(bus_dma_tag_t tag) 324 { 325 326 nexus_dma_tag = tag; 327 } 328 329 static int 330 nexus_config_intr(device_t dev, int irq, enum intr_trigger trig, 331 enum intr_polarity pol) 332 { 333 int ret = ENODEV; 334 335 device_printf(dev, "bus_config_intr is obsolete and not supported!\n"); 336 ret = EOPNOTSUPP; 337 return (ret); 338 } 339 340 static int 341 nexus_setup_intr(device_t dev, device_t child, struct resource *res, int flags, 342 driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep) 343 { 344 345 if ((rman_get_flags(res) & RF_SHAREABLE) == 0) 346 flags |= INTR_EXCL; 347 348 return(intr_setup_irq(child, res, filt, intr, arg, flags, cookiep)); 349 } 350 351 static int 352 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih) 353 { 354 355 return (intr_teardown_irq(child, r, ih)); 356 } 357 358 static int 359 nexus_describe_intr(device_t dev, device_t child, struct resource *irq, 360 void *cookie, const char *descr) 361 { 362 363 return (intr_describe_irq(child, irq, cookie, descr)); 364 } 365 366 #ifdef SMP 367 static int 368 nexus_bind_intr(device_t dev, device_t child, struct resource *irq, int cpu) 369 { 370 371 return (intr_bind_irq(child, irq, cpu)); 372 } 373 #endif 374 375 static int 376 nexus_activate_resource(device_t bus, device_t child, int type, int rid, 377 struct resource *r) 378 { 379 int err; 380 bus_addr_t paddr; 381 bus_size_t psize; 382 bus_space_handle_t vaddr; 383 384 if ((err = rman_activate_resource(r)) != 0) 385 return (err); 386 387 /* 388 * If this is a memory resource, map it into the kernel. 389 */ 390 if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) { 391 paddr = (bus_addr_t)rman_get_start(r); 392 psize = (bus_size_t)rman_get_size(r); 393 #ifdef FDT 394 err = bus_space_map(fdtbus_bs_tag, paddr, psize, 0, &vaddr); 395 if (err != 0) { 396 rman_deactivate_resource(r); 397 return (err); 398 } 399 rman_set_bustag(r, fdtbus_bs_tag); 400 #else 401 vaddr = (bus_space_handle_t)pmap_mapdev((vm_paddr_t)paddr, 402 (vm_size_t)psize); 403 if (vaddr == 0) { 404 rman_deactivate_resource(r); 405 return (ENOMEM); 406 } 407 rman_set_bustag(r, (void *)1); 408 #endif 409 rman_set_virtual(r, (void *)vaddr); 410 rman_set_bushandle(r, vaddr); 411 return (0); 412 } else if (type == SYS_RES_IRQ) { 413 err = intr_activate_irq(child, r); 414 if (err != 0) { 415 rman_deactivate_resource(r); 416 return (err); 417 } 418 } 419 return (0); 420 } 421 422 static int 423 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid, 424 struct resource *r) 425 { 426 bus_size_t psize; 427 bus_space_handle_t vaddr; 428 429 if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) { 430 psize = (bus_size_t)rman_get_size(r); 431 vaddr = rman_get_bushandle(r); 432 433 if (vaddr != 0) { 434 #ifdef FDT 435 bus_space_unmap(fdtbus_bs_tag, vaddr, psize); 436 #else 437 pmap_unmapdev((void *)vaddr, (vm_size_t)psize); 438 #endif 439 rman_set_virtual(r, NULL); 440 rman_set_bushandle(r, 0); 441 } 442 } else if (type == SYS_RES_IRQ) { 443 intr_deactivate_irq(child, r); 444 } 445 446 return (rman_deactivate_resource(r)); 447 } 448 449 #ifdef FDT 450 static int 451 nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent, int icells, 452 pcell_t *intr) 453 { 454 u_int irq; 455 struct intr_map_data_fdt *fdt_data; 456 size_t len; 457 458 len = sizeof(*fdt_data) + icells * sizeof(pcell_t); 459 fdt_data = (struct intr_map_data_fdt *)intr_alloc_map_data( 460 INTR_MAP_DATA_FDT, len, M_WAITOK | M_ZERO); 461 fdt_data->iparent = iparent; 462 fdt_data->ncells = icells; 463 memcpy(fdt_data->cells, intr, icells * sizeof(pcell_t)); 464 irq = intr_map_irq(NULL, iparent, (struct intr_map_data *)fdt_data); 465 return (irq); 466 } 467 #endif /* FDT */ 468