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 Arm 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 40 #include "opt_platform.h" 41 42 #include <sys/cdefs.h> 43 __FBSDID("$FreeBSD$"); 44 45 #include <sys/param.h> 46 #include <sys/systm.h> 47 #include <sys/bus.h> 48 #include <sys/kernel.h> 49 #include <sys/malloc.h> 50 #include <sys/module.h> 51 #include <machine/bus.h> 52 #include <sys/rman.h> 53 #include <sys/interrupt.h> 54 55 #include <machine/vmparam.h> 56 #include <machine/pcb.h> 57 #include <vm/vm.h> 58 #include <vm/pmap.h> 59 60 #include <machine/resource.h> 61 #include <machine/intr.h> 62 63 #include <arm/arm/nexusvar.h> 64 65 #ifdef FDT 66 #include <machine/fdt.h> 67 #include <dev/ofw/ofw_bus_subr.h> 68 #include "ofw_bus_if.h" 69 #endif 70 71 static MALLOC_DEFINE(M_NEXUSDEV, "nexusdev", "Nexus device"); 72 73 struct nexus_device { 74 struct resource_list nx_resources; 75 }; 76 77 #define DEVTONX(dev) ((struct nexus_device *)device_get_ivars(dev)) 78 79 static struct rman mem_rman; 80 81 static int nexus_probe(device_t); 82 static int nexus_attach(device_t); 83 static int nexus_print_child(device_t, device_t); 84 static device_t nexus_add_child(device_t, u_int, const char *, int); 85 static struct resource *nexus_alloc_resource(device_t, device_t, int, int *, 86 rman_res_t, rman_res_t, rman_res_t, u_int); 87 static int nexus_activate_resource(device_t, device_t, int, int, 88 struct resource *); 89 static bus_space_tag_t nexus_get_bus_tag(device_t, device_t); 90 static bus_dma_tag_t nexus_get_dma_tag(device_t dev, device_t child); 91 #ifdef SMP 92 static int nexus_bind_intr(device_t, device_t, struct resource *, int); 93 #endif 94 static int nexus_config_intr(device_t dev, int irq, enum intr_trigger trig, 95 enum intr_polarity pol); 96 static int nexus_describe_intr(device_t dev, device_t child, 97 struct resource *irq, void *cookie, const char *descr); 98 static int nexus_deactivate_resource(device_t, device_t, int, int, 99 struct resource *); 100 static int nexus_release_resource(device_t, device_t, int, int, 101 struct resource *); 102 103 static int nexus_setup_intr(device_t dev, device_t child, struct resource *res, 104 int flags, driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep); 105 static int nexus_teardown_intr(device_t, device_t, struct resource *, void *); 106 107 #ifdef FDT 108 static int nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent, 109 int icells, pcell_t *intr); 110 #endif 111 112 /* 113 * Normally NULL (which results in defaults which are handled in 114 * busdma_machdep), platform init code can use nexus_set_dma_tag() to set this 115 * to a tag that will be inherited by all busses and devices on the platform. 116 */ 117 static bus_dma_tag_t nexus_dma_tag; 118 119 static device_method_t nexus_methods[] = { 120 /* Device interface */ 121 DEVMETHOD(device_probe, nexus_probe), 122 DEVMETHOD(device_attach, nexus_attach), 123 /* Bus interface */ 124 DEVMETHOD(bus_print_child, nexus_print_child), 125 DEVMETHOD(bus_add_child, nexus_add_child), 126 DEVMETHOD(bus_alloc_resource, nexus_alloc_resource), 127 DEVMETHOD(bus_activate_resource, nexus_activate_resource), 128 DEVMETHOD(bus_config_intr, nexus_config_intr), 129 DEVMETHOD(bus_deactivate_resource, nexus_deactivate_resource), 130 DEVMETHOD(bus_release_resource, nexus_release_resource), 131 DEVMETHOD(bus_setup_intr, nexus_setup_intr), 132 DEVMETHOD(bus_teardown_intr, nexus_teardown_intr), 133 DEVMETHOD(bus_get_bus_tag, nexus_get_bus_tag), 134 DEVMETHOD(bus_get_dma_tag, nexus_get_dma_tag), 135 DEVMETHOD(bus_describe_intr, nexus_describe_intr), 136 #ifdef SMP 137 DEVMETHOD(bus_bind_intr, nexus_bind_intr), 138 #endif 139 #ifdef FDT 140 DEVMETHOD(ofw_bus_map_intr, nexus_ofw_map_intr), 141 #endif 142 { 0, 0 } 143 }; 144 145 static devclass_t nexus_devclass; 146 static driver_t nexus_driver = { 147 "nexus", 148 nexus_methods, 149 1 /* no softc */ 150 }; 151 EARLY_DRIVER_MODULE(nexus, root, nexus_driver, nexus_devclass, 0, 0, 152 BUS_PASS_BUS + BUS_PASS_ORDER_EARLY); 153 154 static int 155 nexus_probe(device_t dev) 156 { 157 158 device_quiet(dev); /* suppress attach message for neatness */ 159 160 return (BUS_PROBE_DEFAULT); 161 } 162 163 static int 164 nexus_attach(device_t dev) 165 { 166 167 mem_rman.rm_start = 0; 168 mem_rman.rm_end = BUS_SPACE_MAXADDR; 169 mem_rman.rm_type = RMAN_ARRAY; 170 mem_rman.rm_descr = "I/O memory addresses"; 171 if (rman_init(&mem_rman) || 172 rman_manage_region(&mem_rman, 0, BUS_SPACE_MAXADDR)) 173 panic("nexus_probe mem_rman"); 174 175 /* 176 * First, deal with the children we know about already 177 */ 178 bus_generic_probe(dev); 179 bus_generic_attach(dev); 180 181 return (0); 182 } 183 184 static int 185 nexus_print_child(device_t bus, device_t child) 186 { 187 int retval = 0; 188 189 retval += bus_print_child_header(bus, child); 190 retval += printf("\n"); 191 192 return (retval); 193 } 194 195 static device_t 196 nexus_add_child(device_t bus, u_int order, const char *name, int unit) 197 { 198 device_t child; 199 struct nexus_device *ndev; 200 201 ndev = malloc(sizeof(struct nexus_device), M_NEXUSDEV, M_NOWAIT|M_ZERO); 202 if (!ndev) 203 return (0); 204 resource_list_init(&ndev->nx_resources); 205 206 child = device_add_child_ordered(bus, order, name, unit); 207 208 /* should we free this in nexus_child_detached? */ 209 device_set_ivars(child, ndev); 210 211 return (child); 212 } 213 214 /* 215 * Allocate a resource on behalf of child. NB: child is usually going to be a 216 * child of one of our descendants, not a direct child of nexus0. 217 * (Exceptions include footbridge.) 218 */ 219 static struct resource * 220 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid, 221 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags) 222 { 223 struct resource *rv; 224 struct rman *rm; 225 int needactivate = flags & RF_ACTIVE; 226 227 flags &= ~RF_ACTIVE; 228 229 switch (type) { 230 case SYS_RES_MEMORY: 231 case SYS_RES_IOPORT: 232 rm = &mem_rman; 233 break; 234 235 default: 236 return (NULL); 237 } 238 239 rv = rman_reserve_resource(rm, start, end, count, flags, child); 240 if (rv == NULL) 241 return (NULL); 242 243 rman_set_rid(rv, *rid); 244 245 if (needactivate) { 246 if (bus_activate_resource(child, type, *rid, rv)) { 247 rman_release_resource(rv); 248 return (0); 249 } 250 } 251 252 return (rv); 253 } 254 255 static int 256 nexus_release_resource(device_t bus, device_t child, int type, int rid, 257 struct resource *res) 258 { 259 int error; 260 261 if (rman_get_flags(res) & RF_ACTIVE) { 262 error = bus_deactivate_resource(child, type, rid, res); 263 if (error) 264 return (error); 265 } 266 return (rman_release_resource(res)); 267 } 268 269 static bus_space_tag_t 270 nexus_get_bus_tag(device_t bus __unused, device_t child __unused) 271 { 272 273 #ifdef FDT 274 return(fdtbus_bs_tag); 275 #else 276 return((void *)1); 277 #endif 278 } 279 280 static bus_dma_tag_t 281 nexus_get_dma_tag(device_t dev, device_t child) 282 { 283 284 return nexus_dma_tag; 285 } 286 287 void 288 nexus_set_dma_tag(bus_dma_tag_t tag) 289 { 290 291 nexus_dma_tag = tag; 292 } 293 294 static int 295 nexus_config_intr(device_t dev, int irq, enum intr_trigger trig, 296 enum intr_polarity pol) 297 { 298 int ret = ENODEV; 299 300 device_printf(dev, "bus_config_intr is obsolete and not supported!\n"); 301 ret = EOPNOTSUPP; 302 return (ret); 303 } 304 305 static int 306 nexus_setup_intr(device_t dev, device_t child, struct resource *res, int flags, 307 driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep) 308 { 309 310 if ((rman_get_flags(res) & RF_SHAREABLE) == 0) 311 flags |= INTR_EXCL; 312 313 return(intr_setup_irq(child, res, filt, intr, arg, flags, cookiep)); 314 } 315 316 static int 317 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih) 318 { 319 320 return (intr_teardown_irq(child, r, ih)); 321 } 322 323 static int 324 nexus_describe_intr(device_t dev, device_t child, struct resource *irq, 325 void *cookie, const char *descr) 326 { 327 328 return (intr_describe_irq(child, irq, cookie, descr)); 329 } 330 331 #ifdef SMP 332 static int 333 nexus_bind_intr(device_t dev, device_t child, struct resource *irq, int cpu) 334 { 335 336 return (intr_bind_irq(child, irq, cpu)); 337 } 338 #endif 339 340 static int 341 nexus_activate_resource(device_t bus, device_t child, int type, int rid, 342 struct resource *r) 343 { 344 int err; 345 bus_addr_t paddr; 346 bus_size_t psize; 347 bus_space_handle_t vaddr; 348 349 if ((err = rman_activate_resource(r)) != 0) 350 return (err); 351 352 /* 353 * If this is a memory resource, map it into the kernel. 354 */ 355 if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) { 356 paddr = (bus_addr_t)rman_get_start(r); 357 psize = (bus_size_t)rman_get_size(r); 358 #ifdef FDT 359 err = bus_space_map(fdtbus_bs_tag, paddr, psize, 0, &vaddr); 360 if (err != 0) { 361 rman_deactivate_resource(r); 362 return (err); 363 } 364 rman_set_bustag(r, fdtbus_bs_tag); 365 #else 366 vaddr = (bus_space_handle_t)pmap_mapdev((vm_offset_t)paddr, 367 (vm_size_t)psize); 368 if (vaddr == 0) { 369 rman_deactivate_resource(r); 370 return (ENOMEM); 371 } 372 rman_set_bustag(r, (void *)1); 373 #endif 374 rman_set_virtual(r, (void *)vaddr); 375 rman_set_bushandle(r, vaddr); 376 return (0); 377 } else if (type == SYS_RES_IRQ) { 378 err = intr_activate_irq(child, r); 379 if (err != 0) { 380 rman_deactivate_resource(r); 381 return (err); 382 } 383 } 384 return (0); 385 } 386 387 static int 388 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid, 389 struct resource *r) 390 { 391 bus_size_t psize; 392 bus_space_handle_t vaddr; 393 394 if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) { 395 psize = (bus_size_t)rman_get_size(r); 396 vaddr = rman_get_bushandle(r); 397 398 if (vaddr != 0) { 399 #ifdef FDT 400 bus_space_unmap(fdtbus_bs_tag, vaddr, psize); 401 #else 402 pmap_unmapdev((vm_offset_t)vaddr, (vm_size_t)psize); 403 #endif 404 rman_set_virtual(r, NULL); 405 rman_set_bushandle(r, 0); 406 } 407 } else if (type == SYS_RES_IRQ) { 408 intr_deactivate_irq(child, r); 409 } 410 411 return (rman_deactivate_resource(r)); 412 } 413 414 #ifdef FDT 415 static int 416 nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent, int icells, 417 pcell_t *intr) 418 { 419 u_int irq; 420 struct intr_map_data_fdt *fdt_data; 421 size_t len; 422 423 len = sizeof(*fdt_data) + icells * sizeof(pcell_t); 424 fdt_data = (struct intr_map_data_fdt *)intr_alloc_map_data( 425 INTR_MAP_DATA_FDT, len, M_WAITOK | M_ZERO); 426 fdt_data->iparent = iparent; 427 fdt_data->ncells = icells; 428 memcpy(fdt_data->cells, intr, icells * sizeof(pcell_t)); 429 irq = intr_map_irq(NULL, iparent, (struct intr_map_data *)fdt_data); 430 return (irq); 431 } 432 #endif /* FDT */ 433