1 /*- 2 * Copyright (c) 2009-2010 The FreeBSD Foundation 3 * All rights reserved. 4 * 5 * This software was developed by Semihalf under sponsorship from 6 * the FreeBSD Foundation. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 */ 29 30 #include <sys/cdefs.h> 31 __FBSDID("$FreeBSD$"); 32 33 #include "opt_platform.h" 34 #include <sys/param.h> 35 #include <sys/systm.h> 36 #include <sys/ktr.h> 37 #include <sys/kernel.h> 38 #include <sys/module.h> 39 #include <sys/bus.h> 40 #include <sys/rman.h> 41 #include <sys/malloc.h> 42 43 #include <dev/ofw/ofw_bus.h> 44 #include <dev/ofw/ofw_bus_subr.h> 45 #include <dev/ofw/openfirm.h> 46 47 #include "fdt_common.h" 48 #include "fdt_ic_if.h" 49 #include "ofw_bus_if.h" 50 51 #ifdef DEBUG 52 #define debugf(fmt, args...) do { printf("%s(): ", __func__); \ 53 printf(fmt,##args); } while (0) 54 #else 55 #define debugf(fmt, args...) 56 #endif 57 58 static MALLOC_DEFINE(M_SIMPLEBUS, "simplebus", "simplebus devices information"); 59 60 struct simplebus_softc { 61 int sc_addr_cells; 62 int sc_size_cells; 63 }; 64 65 struct simplebus_devinfo { 66 struct ofw_bus_devinfo di_ofw; 67 struct resource_list di_res; 68 69 /* Interrupts sense-level info for this device */ 70 struct fdt_sense_level di_intr_sl[DI_MAX_INTR_NUM]; 71 }; 72 73 /* 74 * Prototypes. 75 */ 76 static int simplebus_probe(device_t); 77 static int simplebus_attach(device_t); 78 79 static int simplebus_print_child(device_t, device_t); 80 static int simplebus_setup_intr(device_t, device_t, struct resource *, int, 81 driver_filter_t *, driver_intr_t *, void *, void **); 82 static int simplebus_teardown_intr(device_t, device_t, struct resource *, 83 void *); 84 85 static int simplebus_activate_resource(device_t, device_t, int, int, 86 struct resource *); 87 static struct resource *simplebus_alloc_resource(device_t, device_t, int, 88 int *, u_long, u_long, u_long, u_int); 89 static int simplebus_deactivate_resource(device_t, device_t, int, int, 90 struct resource *); 91 static int simplebus_release_resource(device_t, device_t, int, int, 92 struct resource *); 93 static device_t simplebus_get_interrupt_parent(device_t); 94 static struct resource_list *simplebus_get_resource_list(device_t, device_t); 95 96 static ofw_bus_get_devinfo_t simplebus_get_devinfo; 97 98 /* 99 * Bus interface definition. 100 */ 101 static device_method_t simplebus_methods[] = { 102 /* Device interface */ 103 DEVMETHOD(device_probe, simplebus_probe), 104 DEVMETHOD(device_attach, simplebus_attach), 105 DEVMETHOD(device_detach, bus_generic_detach), 106 DEVMETHOD(device_shutdown, bus_generic_shutdown), 107 DEVMETHOD(device_suspend, bus_generic_suspend), 108 DEVMETHOD(device_resume, bus_generic_resume), 109 110 /* Bus interface */ 111 DEVMETHOD(bus_print_child, simplebus_print_child), 112 DEVMETHOD(bus_alloc_resource, simplebus_alloc_resource), 113 DEVMETHOD(bus_release_resource, simplebus_release_resource), 114 DEVMETHOD(bus_activate_resource, simplebus_activate_resource), 115 DEVMETHOD(bus_deactivate_resource, simplebus_deactivate_resource), 116 DEVMETHOD(bus_setup_intr, simplebus_setup_intr), 117 DEVMETHOD(bus_teardown_intr, simplebus_teardown_intr), 118 DEVMETHOD(bus_get_resource_list, simplebus_get_resource_list), 119 120 /* OFW bus interface */ 121 DEVMETHOD(ofw_bus_get_devinfo, simplebus_get_devinfo), 122 DEVMETHOD(ofw_bus_get_compat, ofw_bus_gen_get_compat), 123 DEVMETHOD(ofw_bus_get_model, ofw_bus_gen_get_model), 124 DEVMETHOD(ofw_bus_get_name, ofw_bus_gen_get_name), 125 DEVMETHOD(ofw_bus_get_node, ofw_bus_gen_get_node), 126 DEVMETHOD(ofw_bus_get_type, ofw_bus_gen_get_type), 127 128 { 0, 0 } 129 }; 130 131 static driver_t simplebus_driver = { 132 "simplebus", 133 simplebus_methods, 134 sizeof(struct simplebus_softc) 135 }; 136 137 devclass_t simplebus_devclass; 138 139 DRIVER_MODULE(simplebus, nexus, simplebus_driver, simplebus_devclass, 0, 0); 140 DRIVER_MODULE(simplebus, simplebus, simplebus_driver, simplebus_devclass, 0, 141 0); 142 143 static int 144 simplebus_probe(device_t dev) 145 { 146 147 if (!ofw_bus_is_compatible(dev, "simple-bus")) 148 return (ENXIO); 149 150 device_set_desc(dev, "Flattened device tree simple bus"); 151 152 return (BUS_PROBE_GENERIC); 153 } 154 155 static int 156 simplebus_attach(device_t dev) 157 { 158 device_t dev_child; 159 struct simplebus_devinfo *di; 160 struct simplebus_softc *sc; 161 phandle_t dt_node, dt_child; 162 163 sc = device_get_softc(dev); 164 165 /* 166 * Walk simple-bus and add direct subordinates as our children. 167 */ 168 dt_node = ofw_bus_get_node(dev); 169 for (dt_child = OF_child(dt_node); dt_child != 0; 170 dt_child = OF_peer(dt_child)) { 171 172 /* Check and process 'status' property. */ 173 if (!(fdt_is_enabled(dt_child))) 174 continue; 175 176 if (!(fdt_pm_is_enabled(dt_child))) 177 continue; 178 179 di = malloc(sizeof(*di), M_SIMPLEBUS, M_WAITOK | M_ZERO); 180 181 if (ofw_bus_gen_setup_devinfo(&di->di_ofw, dt_child) != 0) { 182 free(di, M_SIMPLEBUS); 183 device_printf(dev, "could not set up devinfo\n"); 184 continue; 185 } 186 187 resource_list_init(&di->di_res); 188 if (fdt_reg_to_rl(dt_child, &di->di_res)) { 189 device_printf(dev, 190 "%s: could not process 'reg' " 191 "property\n", di->di_ofw.obd_name); 192 ofw_bus_gen_destroy_devinfo(&di->di_ofw); 193 free(di, M_SIMPLEBUS); 194 continue; 195 } 196 197 if (fdt_intr_to_rl(dev, dt_child, &di->di_res, di->di_intr_sl)) { 198 device_printf(dev, "%s: could not process " 199 "'interrupts' property\n", di->di_ofw.obd_name); 200 resource_list_free(&di->di_res); 201 ofw_bus_gen_destroy_devinfo(&di->di_ofw); 202 free(di, M_SIMPLEBUS); 203 continue; 204 } 205 206 /* Add newbus device for this FDT node */ 207 dev_child = device_add_child(dev, NULL, -1); 208 if (dev_child == NULL) { 209 device_printf(dev, "could not add child: %s\n", 210 di->di_ofw.obd_name); 211 resource_list_free(&di->di_res); 212 ofw_bus_gen_destroy_devinfo(&di->di_ofw); 213 free(di, M_SIMPLEBUS); 214 continue; 215 } 216 #ifdef DEBUG 217 device_printf(dev, "added child: %s\n\n", di->di_ofw.obd_name); 218 #endif 219 device_set_ivars(dev_child, di); 220 } 221 222 return (bus_generic_attach(dev)); 223 } 224 225 static int 226 simplebus_print_child(device_t dev, device_t child) 227 { 228 device_t ip; 229 struct simplebus_devinfo *di; 230 struct resource_list *rl; 231 int rv; 232 233 di = device_get_ivars(child); 234 rl = &di->di_res; 235 236 rv = 0; 237 rv += bus_print_child_header(dev, child); 238 rv += resource_list_print_type(rl, "mem", SYS_RES_MEMORY, "%#lx"); 239 rv += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld"); 240 if ((ip = simplebus_get_interrupt_parent(child)) != NULL) 241 rv += printf(" (%s)", device_get_nameunit(ip)); 242 rv += bus_print_child_footer(dev, child); 243 244 return (rv); 245 } 246 247 static struct resource * 248 simplebus_alloc_resource(device_t bus, device_t child, int type, int *rid, 249 u_long start, u_long end, u_long count, u_int flags) 250 { 251 device_t ic; 252 struct simplebus_devinfo *di; 253 struct resource_list_entry *rle; 254 255 /* 256 * Request for the default allocation with a given rid: use resource 257 * list stored in the local device info. 258 */ 259 if ((start == 0UL) && (end == ~0UL)) { 260 if ((di = device_get_ivars(child)) == NULL) 261 return (NULL); 262 263 if (type == SYS_RES_IOPORT) 264 type = SYS_RES_MEMORY; 265 266 rle = resource_list_find(&di->di_res, type, *rid); 267 if (rle == NULL) { 268 if (bootverbose) 269 device_printf(bus, "no default resources for " 270 "rid = %d, type = %d\n", *rid, type); 271 return (NULL); 272 } 273 start = rle->start; 274 end = rle->end; 275 count = rle->count; 276 } 277 278 if (type == SYS_RES_IRQ && 279 (ic = simplebus_get_interrupt_parent(child)) != NULL) 280 return(FDT_IC_ALLOC_INTR(ic, child, rid, start, flags)); 281 282 return (bus_generic_alloc_resource(bus, child, type, rid, start, end, 283 count, flags)); 284 } 285 286 static int 287 simplebus_activate_resource(device_t dev, device_t child, int type, int rid, 288 struct resource *r) 289 { 290 device_t ic; 291 292 if (type == SYS_RES_IRQ && 293 (ic = simplebus_get_interrupt_parent(child)) != NULL) 294 return (FDT_IC_ACTIVATE_INTR(ic, r)); 295 296 return (bus_generic_activate_resource(dev, child, type, rid, r)); 297 } 298 299 static int 300 simplebus_deactivate_resource(device_t dev, device_t child, int type, int rid, 301 struct resource *r) 302 { 303 device_t ic; 304 305 if (type == SYS_RES_IRQ && 306 (ic = simplebus_get_interrupt_parent(child)) != NULL) 307 return (FDT_IC_DEACTIVATE_INTR(ic, r)); 308 309 return (bus_generic_deactivate_resource(dev, child, type, rid, r)); 310 } 311 312 static int 313 simplebus_release_resource(device_t dev, device_t child, int type, int rid, 314 struct resource *r) 315 { 316 device_t ic; 317 318 if (type == SYS_RES_IRQ && 319 (ic = simplebus_get_interrupt_parent(child)) != NULL) 320 return (FDT_IC_RELEASE_INTR(ic, r)); 321 322 return (bus_generic_release_resource(dev, child, type, rid, r)); 323 } 324 325 static struct resource_list * 326 simplebus_get_resource_list(device_t bus, device_t child) 327 { 328 struct simplebus_devinfo *di; 329 330 di = device_get_ivars(child); 331 return (&di->di_res); 332 } 333 334 static device_t 335 simplebus_get_interrupt_parent(device_t dev) 336 { 337 struct simplebus_devinfo *di; 338 struct fdt_ic *ic; 339 device_t ip; 340 phandle_t ph, iph; 341 342 ip = NULL; 343 344 di = device_get_ivars(dev); 345 if (di == NULL) 346 return (NULL); 347 348 if (OF_getencprop(di->di_ofw.obd_node, "interrupt-parent", &iph, 349 sizeof(iph)) > 0) { 350 ph = OF_xref_phandle(iph); 351 SLIST_FOREACH(ic, &fdt_ic_list_head, fdt_ics) { 352 if (ic->iph == ph) { 353 ip = ic->dev; 354 break; 355 } 356 } 357 } 358 return (ip); 359 } 360 361 static int 362 simplebus_setup_intr(device_t bus, device_t child, struct resource *res, 363 int flags, driver_filter_t *filter, driver_intr_t *ihand, void *arg, 364 void **cookiep) 365 { 366 struct simplebus_devinfo *di; 367 device_t ic; 368 enum intr_trigger trig; 369 enum intr_polarity pol; 370 int error, irq, rid; 371 372 di = device_get_ivars(child); 373 if (di == NULL) 374 return (ENXIO); 375 376 if (res == NULL) 377 return (EINVAL); 378 379 rid = rman_get_rid(res); 380 if (rid >= DI_MAX_INTR_NUM) 381 return (ENOENT); 382 383 ic = simplebus_get_interrupt_parent(child); 384 385 trig = di->di_intr_sl[rid].trig; 386 pol = di->di_intr_sl[rid].pol; 387 if (trig != INTR_TRIGGER_CONFORM || pol != INTR_POLARITY_CONFORM) { 388 irq = rman_get_start(res); 389 if (ic != NULL) 390 error = FDT_IC_CONFIG_INTR(ic, irq, trig, pol); 391 else 392 error = bus_generic_config_intr(bus, irq, trig, pol); 393 if (error) 394 return (error); 395 } 396 397 if (ic != NULL) 398 error = FDT_IC_SETUP_INTR(ic, child, res, flags, filter, 399 ihand, arg, cookiep); 400 else 401 error = bus_generic_setup_intr(bus, child, res, flags, filter, 402 ihand, arg, cookiep); 403 return (error); 404 } 405 406 static int 407 simplebus_teardown_intr(device_t bus, device_t child, struct resource *res, 408 void *cookie) 409 { 410 device_t ic; 411 412 if ((ic = simplebus_get_interrupt_parent(child)) != NULL) 413 return (FDT_IC_TEARDOWN_INTR(ic, child, res, cookie)); 414 415 return (bus_generic_teardown_intr(bus, child, res, cookie)); 416 } 417 418 static const struct ofw_bus_devinfo * 419 simplebus_get_devinfo(device_t bus, device_t child) 420 { 421 struct simplebus_devinfo *di; 422 423 di = device_get_ivars(child); 424 return (&di->di_ofw); 425 } 426