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