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