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