apb.c revision 187517
1/*- 2 * Copyright (c) 2009, Oleksandr Tymoshenko <gonzo@FreeBSD.org> 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice unmodified, this list of conditions, and the following 10 * disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25 * SUCH DAMAGE. 26 */ 27 28#include <sys/cdefs.h> 29__FBSDID("$FreeBSD$"); 30 31#include <sys/param.h> 32#include <sys/systm.h> 33#include <sys/bus.h> 34#include <sys/interrupt.h> 35#include <sys/kernel.h> 36#include <sys/module.h> 37#include <sys/rman.h> 38#include <sys/malloc.h> 39 40#include <machine/bus.h> 41 42#include <mips/atheros/apbvar.h> 43#include <mips/atheros/ar71xxreg.h> 44 45static int apb_activate_resource(device_t, device_t, int, int, 46 struct resource *); 47static device_t apb_add_child(device_t, int, const char *, int); 48static struct resource * 49 apb_alloc_resource(device_t, device_t, int, int *, u_long, 50 u_long, u_long, u_int); 51static int apb_attach(device_t); 52static int apb_deactivate_resource(device_t, device_t, int, int, 53 struct resource *); 54static struct resource_list * 55 apb_get_resource_list(device_t, device_t); 56static void apb_hinted_child(device_t, const char *, int); 57static int apb_intr(void *); 58static int apb_probe(device_t); 59static int apb_release_resource(device_t, device_t, int, int, 60 struct resource *); 61static int apb_setup_intr(device_t, device_t, struct resource *, int, 62 driver_filter_t *, driver_intr_t *, void *, void **); 63static int apb_teardown_intr(device_t, device_t, struct resource *, 64 void *); 65 66static void apb_mask_irq(unsigned int irq) 67{ 68 uint32_t reg; 69 70 reg = ATH_READ_REG(AR71XX_MISC_INTR_MASK); 71 ATH_WRITE_REG(AR71XX_MISC_INTR_MASK, reg & ~(1 << irq)); 72 73} 74 75static void apb_unmask_irq(unsigned int irq) 76{ 77 uint32_t reg; 78 79 reg = ATH_READ_REG(AR71XX_MISC_INTR_MASK); 80 ATH_WRITE_REG(AR71XX_MISC_INTR_MASK, reg | (1 << irq)); 81} 82 83static int 84apb_probe(device_t dev) 85{ 86 87 return (0); 88} 89 90static int 91apb_attach(device_t dev) 92{ 93 struct apb_softc *sc = device_get_softc(dev); 94 int rid = 0; 95 96 device_set_desc(dev, "APB Bus bridge"); 97 sc->apb_mem_rman.rm_type = RMAN_ARRAY; 98 sc->apb_mem_rman.rm_descr = "APB memory"; 99 if (rman_init(&sc->apb_mem_rman) != 0 || 100 rman_manage_region(&sc->apb_mem_rman, APB_MEM_START, 101 APB_MEM_END) != 0) 102 panic("apb_attach: failed to set up I/O rman"); 103 104 sc->apb_irq_rman.rm_type = RMAN_ARRAY; 105 sc->apb_irq_rman.rm_descr = "APB IRQ"; 106 107 if (rman_init(&sc->apb_irq_rman) != 0 || 108 rman_manage_region(&sc->apb_irq_rman, 109 APB_IRQ_BASE, APB_IRQ_END) != 0) 110 panic("apb_attach: failed to set up IRQ rman"); 111 112 if ((sc->sc_misc_irq = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, 113 RF_SHAREABLE | RF_ACTIVE)) == NULL) { 114 device_printf(dev, "unable to allocate IRQ resource\n"); 115 return (ENXIO); 116 } 117 118 if ((bus_setup_intr(dev, sc->sc_misc_irq, INTR_TYPE_MISC, 119 apb_intr, NULL, sc, &sc->sc_misc_ih))) { 120 device_printf(dev, 121 "WARNING: unable to register interrupt handler\n"); 122 return (ENXIO); 123 } 124 125 bus_generic_probe(dev); 126 bus_enumerate_hinted_children(dev); 127 bus_generic_attach(dev); 128 129 return (0); 130} 131 132static struct resource * 133apb_alloc_resource(device_t bus, device_t child, int type, int *rid, 134 u_long start, u_long end, u_long count, u_int flags) 135{ 136 struct apb_softc *sc = device_get_softc(bus); 137 struct apb_ivar *ivar = device_get_ivars(child); 138 struct resource *rv; 139 struct resource_list_entry *rle; 140 struct rman *rm; 141 int isdefault, needactivate, passthrough; 142 143 isdefault = (start == 0UL && end == ~0UL); 144 needactivate = flags & RF_ACTIVE; 145 passthrough = (device_get_parent(child) != bus); 146 rle = NULL; 147 148 if (passthrough) 149 return (BUS_ALLOC_RESOURCE(device_get_parent(bus), child, type, 150 rid, start, end, count, flags)); 151 152 /* 153 * If this is an allocation of the "default" range for a given RID, 154 * and we know what the resources for this device are (ie. they aren't 155 * maintained by a child bus), then work out the start/end values. 156 */ 157 158 if (isdefault) { 159 rle = resource_list_find(&ivar->resources, type, *rid); 160 if (rle == NULL) { 161 return (NULL); 162 } 163 164 if (rle->res != NULL) { 165 panic("%s: resource entry is busy", __func__); 166 } 167 start = rle->start; 168 end = rle->end; 169 count = rle->count; 170 } 171 172 switch (type) { 173 case SYS_RES_IRQ: 174 rm = &sc->apb_irq_rman; 175 break; 176 case SYS_RES_MEMORY: 177 rm = &sc->apb_mem_rman; 178 break; 179 default: 180 printf("%s: unknown resource type %d\n", __func__, type); 181 return (0); 182 } 183 184 rv = rman_reserve_resource(rm, start, end, count, flags, child); 185 if (rv == 0) { 186 printf("%s: could not reserve resource\n", __func__); 187 return (0); 188 } 189 190 rman_set_rid(rv, *rid); 191 192 if (needactivate) { 193 if (bus_activate_resource(child, type, *rid, rv)) { 194 printf("%s: could not activate resource\n", __func__); 195 rman_release_resource(rv); 196 return (0); 197 } 198 } 199 200 return (rv); 201} 202 203static int 204apb_activate_resource(device_t bus, device_t child, int type, int rid, 205 struct resource *r) 206{ 207 208 /* XXX: should we mask/unmask IRQ here? */ 209 return (BUS_ACTIVATE_RESOURCE(device_get_parent(bus), child, 210 type, rid, r)); 211} 212 213static int 214apb_deactivate_resource(device_t bus, device_t child, int type, int rid, 215 struct resource *r) 216{ 217 218 /* XXX: should we mask/unmask IRQ here? */ 219 return (BUS_DEACTIVATE_RESOURCE(device_get_parent(bus), child, 220 type, rid, r)); 221} 222 223static int 224apb_release_resource(device_t dev, device_t child, int type, 225 int rid, struct resource *r) 226{ 227 struct resource_list *rl; 228 struct resource_list_entry *rle; 229 230 rl = apb_get_resource_list(dev, child); 231 if (rl == NULL) 232 return (EINVAL); 233 rle = resource_list_find(rl, type, rid); 234 if (rle == NULL) 235 return (EINVAL); 236 rman_release_resource(r); 237 rle->res = NULL; 238 239 return (0); 240} 241 242static int 243apb_setup_intr(device_t bus, device_t child, struct resource *ires, 244 int flags, driver_filter_t *filt, driver_intr_t *handler, 245 void *arg, void **cookiep) 246{ 247 struct apb_softc *sc = device_get_softc(bus); 248 struct intr_event *event; 249 int irq, error; 250 251 irq = rman_get_start(ires); 252 253 if (irq > APB_IRQ_END) 254 panic("%s: bad irq %d", __func__, irq); 255 256 event = sc->sc_eventstab[irq]; 257 if (event == NULL) { 258 error = intr_event_create(&event, (void *)irq, 0, irq, 259 (mask_fn)apb_mask_irq, (mask_fn)apb_unmask_irq, 260 NULL, NULL, 261 "apb intr%d:", irq); 262 263 sc->sc_eventstab[irq] = event; 264 } 265 266 intr_event_add_handler(event, device_get_nameunit(child), filt, 267 handler, arg, intr_priority(flags), flags, cookiep); 268 269 return (0); 270} 271 272static int 273apb_teardown_intr(device_t dev, device_t child, struct resource *ires, 274 void *cookie) 275{ 276 struct apb_softc *sc = device_get_softc(dev); 277 int irq, result; 278 279 irq = rman_get_start(ires); 280 if (irq > APB_IRQ_END) 281 panic("%s: bad irq %d", __func__, irq); 282 283 if (sc->sc_eventstab[irq] == NULL) 284 panic("Trying to teardown unoccupied IRQ"); 285 286 apb_mask_irq(irq); 287 288 result = intr_event_remove_handler(cookie); 289 if (!result) 290 sc->sc_eventstab[irq] = NULL; 291 292 return (result); 293} 294 295static int 296apb_intr(void *arg) 297{ 298 struct apb_softc *sc = arg; 299 struct intr_event *event; 300 uint32_t reg, irq; 301 302 reg = ATH_READ_REG(AR71XX_MISC_INTR_STATUS); 303 for (irq = 0; irq < APB_NIRQS; irq++) { 304 if (reg & (1 << irq)) { 305 event = sc->sc_eventstab[irq]; 306 if (!event || TAILQ_EMPTY(&event->ie_handlers)) { 307 printf("Stray IRQ %d\n", irq); 308 continue; 309 } 310 311 /* TODO: frame instead of NULL? */ 312 intr_event_handle(event, NULL); 313 } 314 } 315 316 return (FILTER_HANDLED); 317} 318 319static void 320apb_hinted_child(device_t bus, const char *dname, int dunit) 321{ 322 device_t child; 323 long maddr; 324 int msize; 325 int irq; 326 int result; 327 int mem_hints_count; 328 329 child = BUS_ADD_CHILD(bus, 0, dname, dunit); 330 331 /* 332 * Set hard-wired resources for hinted child using 333 * specific RIDs. 334 */ 335 mem_hints_count = 0; 336 if (resource_long_value(dname, dunit, "maddr", &maddr) == 0) 337 mem_hints_count++; 338 if (resource_int_value(dname, dunit, "msize", &msize) == 0) 339 mem_hints_count++; 340 341 /* check if all info for mem resource has been provided */ 342 if ((mem_hints_count > 0) && (mem_hints_count < 2)) { 343 printf("Either maddr or msize hint is missing for %s%d\n", 344 dname, dunit); 345 } else if (mem_hints_count) { 346 result = bus_set_resource(child, SYS_RES_MEMORY, 0, 347 maddr, msize); 348 if (result != 0) 349 device_printf(bus, 350 "warning: bus_set_resource() failed\n"); 351 } 352 353 if (resource_int_value(dname, dunit, "irq", &irq) == 0) { 354 result = bus_set_resource(child, SYS_RES_IRQ, 0, irq, 1); 355 if (result != 0) 356 device_printf(bus, 357 "warning: bus_set_resource() failed\n"); 358 } 359} 360 361static device_t 362apb_add_child(device_t bus, int order, const char *name, int unit) 363{ 364 device_t child; 365 struct apb_ivar *ivar; 366 367 ivar = malloc(sizeof(struct apb_ivar), M_DEVBUF, M_WAITOK | M_ZERO); 368 if (ivar == NULL) { 369 printf("Failed to allocate ivar\n"); 370 return (0); 371 } 372 resource_list_init(&ivar->resources); 373 374 child = device_add_child_ordered(bus, order, name, unit); 375 if (child == NULL) { 376 printf("Can't add child %s%d ordered\n", name, unit); 377 return (0); 378 } 379 380 device_set_ivars(child, ivar); 381 382 return (child); 383} 384 385/* 386 * Helper routine for bus_generic_rl_get_resource/bus_generic_rl_set_resource 387 * Provides pointer to resource_list for these routines 388 */ 389static struct resource_list * 390apb_get_resource_list(device_t dev, device_t child) 391{ 392 struct apb_ivar *ivar; 393 394 ivar = device_get_ivars(child); 395 return (&(ivar->resources)); 396} 397 398static device_method_t apb_methods[] = { 399 DEVMETHOD(bus_activate_resource, apb_activate_resource), 400 DEVMETHOD(bus_add_child, apb_add_child), 401 DEVMETHOD(bus_alloc_resource, apb_alloc_resource), 402 DEVMETHOD(bus_deactivate_resource, apb_deactivate_resource), 403 DEVMETHOD(bus_get_resource_list, apb_get_resource_list), 404 DEVMETHOD(bus_hinted_child, apb_hinted_child), 405 DEVMETHOD(bus_print_child, bus_generic_print_child), 406 DEVMETHOD(bus_release_resource, apb_release_resource), 407 DEVMETHOD(bus_setup_intr, apb_setup_intr), 408 DEVMETHOD(bus_teardown_intr, apb_teardown_intr), 409 DEVMETHOD(device_attach, apb_attach), 410 DEVMETHOD(device_probe, apb_probe), 411 DEVMETHOD(bus_get_resource, bus_generic_rl_get_resource), 412 DEVMETHOD(bus_set_resource, bus_generic_rl_set_resource), 413 414 {0, 0}, 415}; 416 417static driver_t apb_driver = { 418 "apb", 419 apb_methods, 420 sizeof(struct apb_softc), 421}; 422static devclass_t apb_devclass; 423 424DRIVER_MODULE(apb, nexus, apb_driver, apb_devclass, 0, 0); 425