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