nexus.c revision 206717
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 MIPS 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 memory address space. 38 */ 39 40#include <sys/cdefs.h> 41__FBSDID("$FreeBSD: head/sys/mips/mips/nexus.c 206717 2010-04-17 01:17:31Z jmallett $"); 42 43#include <sys/param.h> 44#include <sys/systm.h> 45#include <sys/bus.h> 46#include <sys/kernel.h> 47#include <sys/malloc.h> 48#include <sys/module.h> 49#include <sys/rman.h> 50#include <sys/interrupt.h> 51 52#include <vm/vm.h> 53#include <vm/pmap.h> 54 55#include <machine/bus.h> 56#include <machine/intr_machdep.h> 57#include <machine/pmap.h> 58#include <machine/resource.h> 59#include <machine/vmparam.h> 60 61#undef NEXUS_DEBUG 62#ifdef NEXUS_DEBUG 63#define dprintf printf 64#else 65#define dprintf(x, arg...) 66#endif /* NEXUS_DEBUG */ 67 68static MALLOC_DEFINE(M_NEXUSDEV, "nexusdev", "Nexus device"); 69 70struct nexus_device { 71 struct resource_list nx_resources; 72}; 73 74#define DEVTONX(dev) ((struct nexus_device *)device_get_ivars(dev)) 75#define NUM_MIPS_IRQS 6 76 77static struct rman irq_rman; 78static struct rman mem_rman; 79 80static struct resource * 81 nexus_alloc_resource(device_t, device_t, int, int *, u_long, 82 u_long, u_long, u_int); 83static int nexus_activate_resource(device_t, device_t, int, int, 84 struct resource *); 85static device_t nexus_add_child(device_t, int, const char *, int); 86static int nexus_attach(device_t); 87static int nexus_deactivate_resource(device_t, device_t, int, int, 88 struct resource *); 89static void nexus_delete_resource(device_t, device_t, int, int); 90static struct resource_list * 91 nexus_get_reslist(device_t, device_t); 92static int nexus_get_resource(device_t, device_t, int, int, u_long *, 93 u_long *); 94static void nexus_hinted_child(device_t, const char *, int); 95static int nexus_print_child(device_t, device_t); 96static int nexus_print_all_resources(device_t dev); 97static int nexus_probe(device_t); 98static int nexus_release_resource(device_t, device_t, int, int, 99 struct resource *); 100static int nexus_set_resource(device_t, device_t, int, int, u_long, 101 u_long); 102static int nexus_setup_intr(device_t dev, device_t child, 103 struct resource *res, int flags, driver_filter_t *filt, 104 driver_intr_t *intr, void *arg, void **cookiep); 105static int nexus_teardown_intr(device_t, device_t, struct resource *, 106 void *); 107 108static device_method_t nexus_methods[] = { 109 /* Device interface */ 110 DEVMETHOD(device_probe, nexus_probe), 111 DEVMETHOD(device_attach, nexus_attach), 112 113 /* Bus interface */ 114 DEVMETHOD(bus_add_child, nexus_add_child), 115 DEVMETHOD(bus_activate_resource,nexus_activate_resource), 116 DEVMETHOD(bus_alloc_resource, nexus_alloc_resource), 117 DEVMETHOD(bus_deactivate_resource, nexus_deactivate_resource), 118 DEVMETHOD(bus_delete_resource, nexus_delete_resource), 119 DEVMETHOD(bus_get_resource, nexus_get_resource), 120 DEVMETHOD(bus_get_resource_list, nexus_get_reslist), 121 DEVMETHOD(bus_hinted_child, nexus_hinted_child), 122 DEVMETHOD(bus_print_child, nexus_print_child), 123 DEVMETHOD(bus_release_resource, nexus_release_resource), 124 DEVMETHOD(bus_set_resource, nexus_set_resource), 125 DEVMETHOD(bus_setup_intr, nexus_setup_intr), 126 DEVMETHOD(bus_teardown_intr, nexus_teardown_intr), 127 128 { 0, 0 } 129}; 130 131static driver_t nexus_driver = { 132 "nexus", 133 nexus_methods, 134 1 /* no softc */ 135}; 136static devclass_t nexus_devclass; 137 138static int 139nexus_probe(device_t dev) 140{ 141 142 device_set_desc(dev, "MIPS32 root nexus"); 143 144 irq_rman.rm_start = 0; 145 irq_rman.rm_end = NUM_MIPS_IRQS - 1; 146 irq_rman.rm_type = RMAN_ARRAY; 147 irq_rman.rm_descr = "Hardware IRQs"; 148 if (rman_init(&irq_rman) != 0 || 149 rman_manage_region(&irq_rman, 0, NUM_MIPS_IRQS - 1) != 0) { 150 panic("%s: irq_rman", __func__); 151 } 152 153 mem_rman.rm_start = 0; 154 mem_rman.rm_end = ~0u; 155 mem_rman.rm_type = RMAN_ARRAY; 156 mem_rman.rm_descr = "Memory addresses"; 157 if (rman_init(&mem_rman) != 0 || 158 rman_manage_region(&mem_rman, 0, ~0) != 0) { 159 panic("%s: mem_rman", __func__); 160 } 161 162 return (0); 163} 164 165static int 166nexus_setup_intr(device_t dev, device_t child, struct resource *res, int flags, 167 driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep) 168{ 169 register_t s; 170 int irq; 171 172 s = intr_disable(); 173 irq = rman_get_start(res); 174 if (irq >= NUM_MIPS_IRQS) { 175 intr_restore(s); 176 return (0); 177 } 178 179 cpu_establish_hardintr(device_get_nameunit(child), filt, intr, arg, 180 irq, flags, cookiep); 181 intr_restore(s); 182 return (0); 183} 184 185static int 186nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih) 187{ 188 189 printf("Unimplemented %s at %s:%d\n", __func__, __FILE__, __LINE__); 190 return (0); 191} 192 193static int 194nexus_attach(device_t dev) 195{ 196 197 bus_generic_probe(dev); 198 bus_enumerate_hinted_children(dev); 199 bus_generic_attach(dev); 200 201 return (0); 202} 203 204static int 205nexus_print_child(device_t bus, device_t child) 206{ 207 int retval = 0; 208 209 retval += bus_print_child_header(bus, child); 210 retval += nexus_print_all_resources(child); 211 if (device_get_flags(child)) 212 retval += printf(" flags %#x", device_get_flags(child)); 213 retval += printf(" on %s\n", device_get_nameunit(bus)); 214 215 return (retval); 216} 217 218static int 219nexus_print_all_resources(device_t dev) 220{ 221 struct nexus_device *ndev = DEVTONX(dev); 222 struct resource_list *rl = &ndev->nx_resources; 223 int retval = 0; 224 225 if (STAILQ_FIRST(rl)) 226 retval += printf(" at"); 227 228 retval += resource_list_print_type(rl, "mem", SYS_RES_MEMORY, "%#lx"); 229 retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld"); 230 231 return (retval); 232} 233 234static void 235nexus_hinted_child(device_t bus, const char *dname, int dunit) 236{ 237 device_t child; 238 long maddr; 239 int msize; 240 int result; 241 int irq; 242 int mem_hints_count; 243 244 child = BUS_ADD_CHILD(bus, 0, dname, dunit); 245 if (child == NULL) 246 return; 247 248 /* 249 * Set hard-wired resources for hinted child using 250 * specific RIDs. 251 */ 252 mem_hints_count = 0; 253 if (resource_long_value(dname, dunit, "maddr", &maddr) == 0) 254 mem_hints_count++; 255 if (resource_int_value(dname, dunit, "msize", &msize) == 0) 256 mem_hints_count++; 257 258 /* check if all info for mem resource has been provided */ 259 if ((mem_hints_count > 0) && (mem_hints_count < 2)) { 260 printf("Either maddr or msize hint is missing for %s%d\n", 261 dname, dunit); 262 } 263 else if (mem_hints_count) { 264 dprintf("%s: discovered hinted child %s at maddr %p(%d)\n", 265 __func__, device_get_nameunit(child), 266 (void *)(intptr_t)maddr, msize); 267 268 result = bus_set_resource(child, SYS_RES_MEMORY, 0, maddr, 269 msize); 270 if (result != 0) { 271 device_printf(bus, 272 "warning: bus_set_resource() failed\n"); 273 } 274 } 275 276 if (resource_int_value(dname, dunit, "irq", &irq) == 0) { 277 result = bus_set_resource(child, SYS_RES_IRQ, 0, irq, 1); 278 if (result != 0) 279 device_printf(bus, 280 "warning: bus_set_resource() failed\n"); 281 } 282} 283 284static device_t 285nexus_add_child(device_t bus, int order, const char *name, int unit) 286{ 287 device_t child; 288 struct nexus_device *ndev; 289 290 ndev = malloc(sizeof(struct nexus_device), M_NEXUSDEV, M_NOWAIT|M_ZERO); 291 if (!ndev) 292 return (0); 293 resource_list_init(&ndev->nx_resources); 294 295 child = device_add_child_ordered(bus, order, name, unit); 296 if (child == NULL) { 297 device_printf(bus, "failed to add child: %s%d\n", name, unit); 298 return (0); 299 } 300 301 /* should we free this in nexus_child_detached? */ 302 device_set_ivars(child, ndev); 303 304 return (child); 305} 306 307/* 308 * Allocate a resource on behalf of child. NB: child is usually going to be a 309 * child of one of our descendants, not a direct child of nexus0. 310 * (Exceptions include footbridge.) 311 */ 312static struct resource * 313nexus_alloc_resource(device_t bus, device_t child, int type, int *rid, 314 u_long start, u_long end, u_long count, u_int flags) 315{ 316 struct nexus_device *ndev = DEVTONX(child); 317 struct resource *rv; 318 struct resource_list_entry *rle; 319 struct rman *rm; 320 int isdefault, needactivate, passthrough; 321 322 dprintf("%s: entry (%p, %p, %d, %p, %p, %p, %ld, %d)\n", 323 __func__, bus, child, type, rid, (void *)(intptr_t)start, 324 (void *)(intptr_t)end, count, flags); 325 dprintf("%s: requested rid is %d\n", __func__, *rid); 326 327 isdefault = (start == 0UL && end == ~0UL && count == 1); 328 needactivate = flags & RF_ACTIVE; 329 passthrough = (device_get_parent(child) != bus); 330 rle = NULL; 331 332 /* 333 * If this is an allocation of the "default" range for a given RID, 334 * and we know what the resources for this device are (ie. they aren't 335 * maintained by a child bus), then work out the start/end values. 336 */ 337 if (isdefault) { 338 rle = resource_list_find(&ndev->nx_resources, type, *rid); 339 if (rle == NULL) 340 return (NULL); 341 if (rle->res != NULL) { 342 panic("%s: resource entry is busy", __func__); 343 } 344 start = rle->start; 345 end = rle->end; 346 count = rle->count; 347 } 348 349 switch (type) { 350 case SYS_RES_IRQ: 351 rm = &irq_rman; 352 break; 353 case SYS_RES_MEMORY: 354 rm = &mem_rman; 355 break; 356 default: 357 printf("%s: unknown resource type %d\n", __func__, type); 358 return (0); 359 } 360 361 rv = rman_reserve_resource(rm, start, end, count, flags, child); 362 if (rv == 0) { 363 printf("%s: could not reserve resource for %s\n", __func__, 364 device_get_nameunit(child)); 365 return (0); 366 } 367 368 rman_set_rid(rv, *rid); 369 370 if (needactivate) { 371 if (bus_activate_resource(child, type, *rid, rv)) { 372 printf("%s: could not activate resource\n", __func__); 373 rman_release_resource(rv); 374 return (0); 375 } 376 } 377 378 return (rv); 379} 380 381static int 382nexus_activate_resource(device_t bus, device_t child, int type, int rid, 383 struct resource *r) 384{ 385 void *vaddr; 386 u_int32_t paddr, psize; 387 388 /* 389 * If this is a memory resource, track the direct mapping 390 * in the uncached MIPS KSEG1 segment. 391 */ 392 if (type == SYS_RES_MEMORY) { 393 paddr = rman_get_start(r); 394 psize = rman_get_size(r); 395 vaddr = pmap_mapdev(paddr, psize); 396 397 rman_set_virtual(r, vaddr); 398 rman_set_bustag(r, mips_bus_space_generic); 399 rman_set_bushandle(r, (bus_space_handle_t)(uintptr_t)vaddr); 400 } 401 402 return (rman_activate_resource(r)); 403} 404 405static struct resource_list * 406nexus_get_reslist(device_t dev, device_t child) 407{ 408 struct nexus_device *ndev = DEVTONX(child); 409 410 return (&ndev->nx_resources); 411} 412 413static int 414nexus_set_resource(device_t dev, device_t child, int type, int rid, 415 u_long start, u_long count) 416{ 417 struct nexus_device *ndev = DEVTONX(child); 418 struct resource_list *rl = &ndev->nx_resources; 419 struct resource_list_entry *rle; 420 421 dprintf("%s: entry (%p, %p, %d, %d, %p, %ld)\n", 422 __func__, dev, child, type, rid, (void *)(intptr_t)start, count); 423 424 rle = resource_list_add(rl, type, rid, start, start + count - 1, 425 count); 426 if (rle == NULL) 427 return (ENXIO); 428 429 return (0); 430} 431 432static int 433nexus_get_resource(device_t dev, device_t child, int type, int rid, 434 u_long *startp, u_long *countp) 435{ 436 struct nexus_device *ndev = DEVTONX(child); 437 struct resource_list *rl = &ndev->nx_resources; 438 struct resource_list_entry *rle; 439 440 rle = resource_list_find(rl, type, rid); 441 if (!rle) 442 return(ENOENT); 443 if (startp) 444 *startp = rle->start; 445 if (countp) 446 *countp = rle->count; 447 return (0); 448} 449 450static void 451nexus_delete_resource(device_t dev, device_t child, int type, int rid) 452{ 453 struct nexus_device *ndev = DEVTONX(child); 454 struct resource_list *rl = &ndev->nx_resources; 455 456 dprintf("%s: entry\n", __func__); 457 458 resource_list_delete(rl, type, rid); 459} 460 461static int 462nexus_release_resource(device_t bus, device_t child, int type, int rid, 463 struct resource *r) 464{ 465 dprintf("%s: entry\n", __func__); 466 467 if (rman_get_flags(r) & RF_ACTIVE) { 468 int error = bus_deactivate_resource(child, type, rid, r); 469 if (error) 470 return error; 471 } 472 473 return (rman_release_resource(r)); 474} 475 476static int 477nexus_deactivate_resource(device_t bus, device_t child, int type, int rid, 478 struct resource *r) 479{ 480 vm_offset_t va; 481 482 if (type == SYS_RES_MEMORY) { 483 va = (vm_offset_t)rman_get_virtual(r); 484 pmap_unmapdev(va, rman_get_size(r)); 485 } 486 487 return (rman_deactivate_resource(r)); 488} 489 490DRIVER_MODULE(nexus, root, nexus_driver, nexus_devclass, 0, 0); 491