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 /* 169 * Add direct children of nexus. Devices will be probed and attached 170 * through ofwbus0. 171 */ 172 nexus_add_child(dev, 0, "timer", 0); 173 nexus_add_child(dev, 1, "rcons", 0); 174 nexus_add_child(dev, 2, "ofwbus", 0); 175 176 bus_generic_probe(dev); 177 bus_generic_attach(dev); 178 179 return (0); 180 } 181 182 static int 183 nexus_print_child(device_t bus, device_t child) 184 { 185 int retval = 0; 186 187 retval += bus_print_child_header(bus, child); 188 retval += printf("\n"); 189 190 return (retval); 191 } 192 193 static device_t 194 nexus_add_child(device_t bus, u_int order, const char *name, int unit) 195 { 196 device_t child; 197 struct nexus_device *ndev; 198 199 ndev = malloc(sizeof(struct nexus_device), M_NEXUSDEV, M_NOWAIT|M_ZERO); 200 if (!ndev) 201 return (0); 202 resource_list_init(&ndev->nx_resources); 203 204 child = device_add_child_ordered(bus, order, name, unit); 205 206 /* should we free this in nexus_child_detached? */ 207 device_set_ivars(child, ndev); 208 209 return (child); 210 } 211 212 /* 213 * Allocate a resource on behalf of child. NB: child is usually going to be a 214 * child of one of our descendants, not a direct child of nexus0. 215 * (Exceptions include footbridge.) 216 */ 217 static struct resource * 218 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid, 219 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags) 220 { 221 struct nexus_device *ndev = DEVTONX(child); 222 struct resource *rv; 223 struct resource_list_entry *rle; 224 struct rman *rm; 225 int needactivate = flags & RF_ACTIVE; 226 227 /* 228 * If this is an allocation of the "default" range for a given 229 * RID, and we know what the resources for this device are 230 * (ie. they aren't maintained by a child bus), then work out 231 * the start/end values. 232 */ 233 if (RMAN_IS_DEFAULT_RANGE(start, end) && (count == 1)) { 234 if (device_get_parent(child) != bus || ndev == NULL) 235 return(NULL); 236 rle = resource_list_find(&ndev->nx_resources, type, *rid); 237 if (rle == NULL) 238 return(NULL); 239 start = rle->start; 240 end = rle->end; 241 count = rle->count; 242 } 243 244 switch (type) { 245 case SYS_RES_IRQ: 246 rm = &irq_rman; 247 break; 248 249 case SYS_RES_MEMORY: 250 case SYS_RES_IOPORT: 251 rm = &mem_rman; 252 break; 253 254 default: 255 return (NULL); 256 } 257 258 rv = rman_reserve_resource(rm, start, end, count, flags, child); 259 if (rv == NULL) 260 return (NULL); 261 262 rman_set_rid(rv, *rid); 263 rman_set_bushandle(rv, rman_get_start(rv)); 264 265 if (needactivate) { 266 if (bus_activate_resource(child, type, *rid, rv)) { 267 rman_release_resource(rv); 268 return (NULL); 269 } 270 } 271 272 return (rv); 273 } 274 275 static int 276 nexus_adjust_resource(device_t bus __unused, device_t child __unused, int type, 277 struct resource *r, rman_res_t start, rman_res_t end) 278 { 279 struct rman *rm; 280 281 switch (type) { 282 case SYS_RES_IRQ: 283 rm = &irq_rman; 284 break; 285 case SYS_RES_MEMORY: 286 rm = &mem_rman; 287 break; 288 default: 289 return (EINVAL); 290 } 291 if (rman_is_region_manager(r, rm) == 0) 292 return (EINVAL); 293 return (rman_adjust_resource(r, start, end)); 294 } 295 296 static int 297 nexus_release_resource(device_t bus, device_t child, int type, int rid, 298 struct resource *res) 299 { 300 int error; 301 302 if (rman_get_flags(res) & RF_ACTIVE) { 303 error = bus_deactivate_resource(child, type, rid, res); 304 if (error) 305 return (error); 306 } 307 return (rman_release_resource(res)); 308 } 309 310 static int 311 nexus_config_intr(device_t dev, int irq, enum intr_trigger trig, 312 enum intr_polarity pol) 313 { 314 315 return (EOPNOTSUPP); 316 } 317 318 static int 319 nexus_setup_intr(device_t dev, device_t child, struct resource *res, int flags, 320 driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep) 321 { 322 int error; 323 324 if ((rman_get_flags(res) & RF_SHAREABLE) == 0) 325 flags |= INTR_EXCL; 326 327 /* We depend here on rman_activate_resource() being idempotent. */ 328 error = rman_activate_resource(res); 329 if (error) 330 return (error); 331 332 error = intr_setup_irq(child, res, filt, intr, arg, flags, cookiep); 333 334 return (error); 335 } 336 337 static int 338 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih) 339 { 340 341 return (intr_teardown_irq(child, r, ih)); 342 } 343 344 static bus_space_tag_t 345 nexus_get_bus_tag(device_t bus __unused, device_t child __unused) 346 { 347 348 return (&memmap_bus); 349 } 350 351 static int 352 nexus_activate_resource(device_t bus, device_t child, int type, int rid, 353 struct resource *r) 354 { 355 struct resource_map map; 356 int err; 357 358 if ((err = rman_activate_resource(r)) != 0) 359 return (err); 360 361 /* 362 * If this is a memory resource, map it into the kernel. 363 */ 364 switch (type) { 365 case SYS_RES_IOPORT: 366 case SYS_RES_MEMORY: 367 if ((rman_get_flags(r) & RF_UNMAPPED) == 0) { 368 err = nexus_map_resource(bus, child, type, r, NULL, 369 &map); 370 if (err != 0) { 371 rman_deactivate_resource(r); 372 return (err); 373 } 374 375 rman_set_mapping(r, &map); 376 } 377 break; 378 case SYS_RES_IRQ: 379 err = intr_activate_irq(child, r); 380 if (err != 0) { 381 rman_deactivate_resource(r); 382 return (err); 383 } 384 } 385 return (0); 386 } 387 388 static struct resource_list * 389 nexus_get_reslist(device_t dev, device_t child) 390 { 391 struct nexus_device *ndev = DEVTONX(child); 392 393 return (&ndev->nx_resources); 394 } 395 396 static int 397 nexus_set_resource(device_t dev, device_t child, int type, int rid, 398 rman_res_t start, rman_res_t count) 399 { 400 struct nexus_device *ndev = DEVTONX(child); 401 struct resource_list *rl = &ndev->nx_resources; 402 403 /* XXX this should return a success/failure indicator */ 404 resource_list_add(rl, type, rid, start, start + count - 1, count); 405 406 return(0); 407 } 408 409 static int 410 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid, 411 struct resource *r) 412 { 413 bus_size_t psize; 414 bus_space_handle_t vaddr; 415 416 if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) { 417 psize = (bus_size_t)rman_get_size(r); 418 vaddr = rman_get_bushandle(r); 419 420 if (vaddr != 0) { 421 bus_space_unmap(&memmap_bus, vaddr, psize); 422 rman_set_virtual(r, NULL); 423 rman_set_bushandle(r, 0); 424 } 425 } else if (type == SYS_RES_IRQ) { 426 intr_deactivate_irq(child, r); 427 } 428 429 return (rman_deactivate_resource(r)); 430 } 431 432 static int 433 nexus_map_resource(device_t bus, device_t child, int type, struct resource *r, 434 struct resource_map_request *argsp, struct resource_map *map) 435 { 436 struct resource_map_request args; 437 rman_res_t end, length, start; 438 439 /* Resources must be active to be mapped. */ 440 if ((rman_get_flags(r) & RF_ACTIVE) == 0) 441 return (ENXIO); 442 443 /* Mappings are only supported on I/O and memory resources. */ 444 switch (type) { 445 case SYS_RES_IOPORT: 446 case SYS_RES_MEMORY: 447 break; 448 default: 449 return (EINVAL); 450 } 451 452 resource_init_map_request(&args); 453 if (argsp != NULL) 454 bcopy(argsp, &args, imin(argsp->size, args.size)); 455 start = rman_get_start(r) + args.offset; 456 if (args.length == 0) 457 length = rman_get_size(r); 458 else 459 length = args.length; 460 end = start + length - 1; 461 if (start > rman_get_end(r) || start < rman_get_start(r)) 462 return (EINVAL); 463 if (end > rman_get_end(r) || end < start) 464 return (EINVAL); 465 466 map->r_vaddr = pmap_mapdev(start, length); 467 map->r_bustag = &memmap_bus; 468 map->r_size = length; 469 470 /* 471 * The handle is the virtual address. 472 */ 473 map->r_bushandle = (bus_space_handle_t)map->r_vaddr; 474 return (0); 475 } 476 477 EARLY_DRIVER_MODULE(nexus_fdt, root, nexus_fdt_driver, 0, 0, 478 BUS_PASS_BUS + BUS_PASS_ORDER_FIRST); 479 480 static int 481 nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent, int icells, 482 pcell_t *intr) 483 { 484 struct intr_map_data_fdt *fdt_data; 485 size_t len; 486 u_int irq; 487 488 len = sizeof(*fdt_data) + icells * sizeof(pcell_t); 489 fdt_data = (struct intr_map_data_fdt *)intr_alloc_map_data( 490 INTR_MAP_DATA_FDT, len, M_WAITOK | M_ZERO); 491 fdt_data->iparent = iparent; 492 fdt_data->ncells = icells; 493 memcpy(fdt_data->cells, intr, icells * sizeof(pcell_t)); 494 irq = intr_map_irq(NULL, iparent, (struct intr_map_data *)fdt_data); 495 496 return (irq); 497 } 498