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 <machine/bus.h> 56 #include <machine/resource.h> 57 #include <machine/intr.h> 58 59 #ifdef FDT 60 #include <dev/ofw/ofw_bus_subr.h> 61 #include <dev/ofw/openfirm.h> 62 #include "ofw_bus_if.h" 63 #endif 64 65 extern struct bus_space memmap_bus; 66 67 static MALLOC_DEFINE(M_NEXUSDEV, "nexusdev", "Nexus device"); 68 69 struct nexus_device { 70 struct resource_list nx_resources; 71 }; 72 73 #define DEVTONX(dev) ((struct nexus_device *)device_get_ivars(dev)) 74 75 static struct rman mem_rman; 76 static struct rman irq_rman; 77 78 static device_probe_t nexus_fdt_probe; 79 static int nexus_attach(device_t); 80 81 static int nexus_print_child(device_t, device_t); 82 static device_t nexus_add_child(device_t, u_int, const char *, int); 83 static struct resource *nexus_alloc_resource(device_t, device_t, int, int *, 84 u_long, u_long, u_long, u_int); 85 static int nexus_activate_resource(device_t, device_t, int, int, 86 struct resource *); 87 static int nexus_config_intr(device_t dev, int irq, enum intr_trigger trig, 88 enum intr_polarity pol); 89 static struct resource_list *nexus_get_reslist(device_t, device_t); 90 static int nexus_set_resource(device_t, device_t, int, int, u_long, u_long); 91 static int nexus_deactivate_resource(device_t, device_t, int, int, 92 struct resource *); 93 94 static int nexus_setup_intr(device_t dev, device_t child, struct resource *res, 95 int flags, driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep); 96 static int nexus_teardown_intr(device_t, device_t, struct resource *, void *); 97 98 static int nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent, 99 int icells, pcell_t *intr); 100 101 static device_method_t nexus_methods[] = { 102 /* Device interface */ 103 DEVMETHOD(device_probe, nexus_fdt_probe), 104 DEVMETHOD(device_attach, nexus_attach), 105 106 /* OFW interface */ 107 DEVMETHOD(ofw_bus_map_intr, nexus_ofw_map_intr), 108 109 /* Bus interface */ 110 DEVMETHOD(bus_print_child, nexus_print_child), 111 DEVMETHOD(bus_add_child, nexus_add_child), 112 DEVMETHOD(bus_alloc_resource, nexus_alloc_resource), 113 DEVMETHOD(bus_activate_resource, nexus_activate_resource), 114 DEVMETHOD(bus_config_intr, nexus_config_intr), 115 DEVMETHOD(bus_get_resource_list, nexus_get_reslist), 116 DEVMETHOD(bus_set_resource, nexus_set_resource), 117 DEVMETHOD(bus_deactivate_resource, nexus_deactivate_resource), 118 DEVMETHOD(bus_setup_intr, nexus_setup_intr), 119 DEVMETHOD(bus_teardown_intr, nexus_teardown_intr), 120 121 { 0, 0 } 122 }; 123 124 static driver_t nexus_fdt_driver = { 125 "nexus", 126 nexus_methods, 127 1 /* no softc */ 128 }; 129 130 static int 131 nexus_fdt_probe(device_t dev) 132 { 133 134 device_quiet(dev); 135 return (BUS_PROBE_DEFAULT); 136 } 137 138 static int 139 nexus_attach(device_t dev) 140 { 141 142 mem_rman.rm_start = 0; 143 mem_rman.rm_end = BUS_SPACE_MAXADDR; 144 mem_rman.rm_type = RMAN_ARRAY; 145 mem_rman.rm_descr = "I/O memory addresses"; 146 if (rman_init(&mem_rman) || 147 rman_manage_region(&mem_rman, 0, BUS_SPACE_MAXADDR)) 148 panic("nexus_attach mem_rman"); 149 irq_rman.rm_start = 0; 150 irq_rman.rm_end = ~0; 151 irq_rman.rm_type = RMAN_ARRAY; 152 irq_rman.rm_descr = "Interrupts"; 153 if (rman_init(&irq_rman) || rman_manage_region(&irq_rman, 0, ~0)) 154 panic("nexus_attach irq_rman"); 155 156 nexus_add_child(dev, 8, "timer", 0); 157 nexus_add_child(dev, 9, "rcons", 0); 158 nexus_add_child(dev, 10, "ofwbus", 0); 159 160 bus_generic_probe(dev); 161 bus_generic_attach(dev); 162 163 return (0); 164 } 165 166 static int 167 nexus_print_child(device_t bus, device_t child) 168 { 169 int retval = 0; 170 171 retval += bus_print_child_header(bus, child); 172 retval += printf("\n"); 173 174 return (retval); 175 } 176 177 static device_t 178 nexus_add_child(device_t bus, u_int order, const char *name, int unit) 179 { 180 device_t child; 181 struct nexus_device *ndev; 182 183 ndev = malloc(sizeof(struct nexus_device), M_NEXUSDEV, M_NOWAIT|M_ZERO); 184 if (!ndev) 185 return (0); 186 resource_list_init(&ndev->nx_resources); 187 188 child = device_add_child_ordered(bus, order, name, unit); 189 190 /* should we free this in nexus_child_detached? */ 191 device_set_ivars(child, ndev); 192 193 return (child); 194 } 195 196 197 /* 198 * Allocate a resource on behalf of child. NB: child is usually going to be a 199 * child of one of our descendants, not a direct child of nexus0. 200 * (Exceptions include footbridge.) 201 */ 202 static struct resource * 203 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid, 204 u_long start, u_long end, u_long count, u_int flags) 205 { 206 struct nexus_device *ndev = DEVTONX(child); 207 struct resource *rv; 208 struct resource_list_entry *rle; 209 struct rman *rm; 210 int needactivate = flags & RF_ACTIVE; 211 212 /* 213 * If this is an allocation of the "default" range for a given 214 * RID, and we know what the resources for this device are 215 * (ie. they aren't maintained by a child bus), then work out 216 * the start/end values. 217 */ 218 if (RMAN_IS_DEFAULT_RANGE(start, end) && (count == 1)) { 219 if (device_get_parent(child) != bus || ndev == NULL) 220 return(NULL); 221 rle = resource_list_find(&ndev->nx_resources, type, *rid); 222 if (rle == NULL) 223 return(NULL); 224 start = rle->start; 225 end = rle->end; 226 count = rle->count; 227 } 228 229 switch (type) { 230 case SYS_RES_IRQ: 231 rm = &irq_rman; 232 break; 233 234 case SYS_RES_MEMORY: 235 case SYS_RES_IOPORT: 236 rm = &mem_rman; 237 break; 238 239 default: 240 return (NULL); 241 } 242 243 rv = rman_reserve_resource(rm, start, end, count, flags, child); 244 if (rv == NULL) 245 return (NULL); 246 247 rman_set_rid(rv, *rid); 248 rman_set_bushandle(rv, rman_get_start(rv)); 249 250 if (needactivate) { 251 if (bus_activate_resource(child, type, *rid, rv)) { 252 rman_release_resource(rv); 253 return (NULL); 254 } 255 } 256 257 return (rv); 258 } 259 260 static int 261 nexus_config_intr(device_t dev, int irq, enum intr_trigger trig, 262 enum intr_polarity pol) 263 { 264 265 return (EOPNOTSUPP); 266 } 267 268 static int 269 nexus_setup_intr(device_t dev, device_t child, struct resource *res, int flags, 270 driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep) 271 { 272 int error; 273 274 if ((rman_get_flags(res) & RF_SHAREABLE) == 0) 275 flags |= INTR_EXCL; 276 277 /* We depend here on rman_activate_resource() being idempotent. */ 278 error = rman_activate_resource(res); 279 if (error) 280 return (error); 281 282 error = intr_setup_irq(child, res, filt, intr, arg, flags, cookiep); 283 284 return (error); 285 } 286 287 static int 288 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih) 289 { 290 291 return (intr_teardown_irq(child, r, ih)); 292 } 293 294 static int 295 nexus_activate_resource(device_t bus, device_t child, int type, int rid, 296 struct resource *r) 297 { 298 int err; 299 bus_addr_t paddr; 300 bus_size_t psize; 301 bus_space_handle_t vaddr; 302 303 if ((err = rman_activate_resource(r)) != 0) 304 return (err); 305 306 /* 307 * If this is a memory resource, map it into the kernel. 308 */ 309 if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) { 310 paddr = (bus_addr_t)rman_get_start(r); 311 psize = (bus_size_t)rman_get_size(r); 312 err = bus_space_map(&memmap_bus, paddr, psize, 0, &vaddr); 313 if (err != 0) { 314 rman_deactivate_resource(r); 315 return (err); 316 } 317 rman_set_bustag(r, &memmap_bus); 318 rman_set_virtual(r, (void *)vaddr); 319 rman_set_bushandle(r, vaddr); 320 } else if (type == SYS_RES_IRQ) { 321 err = intr_activate_irq(child, r); 322 if (err != 0) { 323 rman_deactivate_resource(r); 324 return (err); 325 } 326 } 327 328 return (0); 329 } 330 331 static struct resource_list * 332 nexus_get_reslist(device_t dev, device_t child) 333 { 334 struct nexus_device *ndev = DEVTONX(child); 335 336 return (&ndev->nx_resources); 337 } 338 339 static int 340 nexus_set_resource(device_t dev, device_t child, int type, int rid, 341 u_long start, u_long count) 342 { 343 struct nexus_device *ndev = DEVTONX(child); 344 struct resource_list *rl = &ndev->nx_resources; 345 346 /* XXX this should return a success/failure indicator */ 347 resource_list_add(rl, type, rid, start, start + count - 1, count); 348 349 return(0); 350 } 351 352 353 static int 354 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid, 355 struct resource *r) 356 { 357 bus_size_t psize; 358 bus_space_handle_t vaddr; 359 360 if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) { 361 psize = (bus_size_t)rman_get_size(r); 362 vaddr = rman_get_bushandle(r); 363 364 if (vaddr != 0) { 365 bus_space_unmap(&memmap_bus, vaddr, psize); 366 rman_set_virtual(r, NULL); 367 rman_set_bushandle(r, 0); 368 } 369 } else if (type == SYS_RES_IRQ) { 370 intr_deactivate_irq(child, r); 371 } 372 373 return (rman_deactivate_resource(r)); 374 } 375 376 static devclass_t nexus_fdt_devclass; 377 378 EARLY_DRIVER_MODULE(nexus_fdt, root, nexus_fdt_driver, nexus_fdt_devclass, 379 0, 0, BUS_PASS_BUS + BUS_PASS_ORDER_FIRST); 380 381 static int 382 nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent, int icells, 383 pcell_t *intr) 384 { 385 struct intr_map_data_fdt *fdt_data; 386 size_t len; 387 u_int irq; 388 389 len = sizeof(*fdt_data) + icells * sizeof(pcell_t); 390 fdt_data = (struct intr_map_data_fdt *)intr_alloc_map_data( 391 INTR_MAP_DATA_FDT, len, M_WAITOK | M_ZERO); 392 fdt_data->iparent = iparent; 393 fdt_data->ncells = icells; 394 memcpy(fdt_data->cells, intr, icells * sizeof(pcell_t)); 395 irq = intr_map_irq(NULL, iparent, (struct intr_map_data *)fdt_data); 396 397 return (irq); 398 } 399