apb.c revision 191837
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 45#undef APB_DEBUG 46#ifdef APB_DEBUG 47#define dprintf printf 48#else 49#define dprintf(x, arg...) 50#endif /* APB_DEBUG */ 51 52static int apb_activate_resource(device_t, device_t, int, int, 53 struct resource *); 54static device_t apb_add_child(device_t, int, const char *, int); 55static struct resource * 56 apb_alloc_resource(device_t, device_t, int, int *, u_long, 57 u_long, u_long, u_int); 58static int apb_attach(device_t); 59static int apb_deactivate_resource(device_t, device_t, int, int, 60 struct resource *); 61static struct resource_list * 62 apb_get_resource_list(device_t, device_t); 63static void apb_hinted_child(device_t, const char *, int); 64static int apb_intr(void *); 65static int apb_probe(device_t); 66static int apb_release_resource(device_t, device_t, int, int, 67 struct resource *); 68static int apb_setup_intr(device_t, device_t, struct resource *, int, 69 driver_filter_t *, driver_intr_t *, void *, void **); 70static int apb_teardown_intr(device_t, device_t, struct resource *, 71 void *); 72 73static void apb_mask_irq(unsigned int irq) 74{ 75 uint32_t reg; 76 77 reg = ATH_READ_REG(AR71XX_MISC_INTR_MASK); 78 ATH_WRITE_REG(AR71XX_MISC_INTR_MASK, reg & ~(1 << irq)); 79 80} 81 82static void apb_unmask_irq(unsigned int irq) 83{ 84 uint32_t reg; 85 86 reg = ATH_READ_REG(AR71XX_MISC_INTR_MASK); 87 ATH_WRITE_REG(AR71XX_MISC_INTR_MASK, reg | (1 << irq)); 88} 89 90static int 91apb_probe(device_t dev) 92{ 93 94 return (0); 95} 96 97static int 98apb_attach(device_t dev) 99{ 100 struct apb_softc *sc = device_get_softc(dev); 101 int rid = 0; 102 103 device_set_desc(dev, "APB Bus bridge"); 104 105 sc->apb_mem_rman.rm_type = RMAN_ARRAY; 106 sc->apb_mem_rman.rm_descr = "APB memory window"; 107 108 if (rman_init(&sc->apb_mem_rman) != 0 || 109 rman_manage_region(&sc->apb_mem_rman, 110 AR71XX_APB_BASE, 111 AR71XX_APB_BASE + AR71XX_APB_SIZE - 1) != 0) 112 panic("apb_attach: failed to set up memory rman"); 113 114 sc->apb_irq_rman.rm_type = RMAN_ARRAY; 115 sc->apb_irq_rman.rm_descr = "APB IRQ"; 116 117 if (rman_init(&sc->apb_irq_rman) != 0 || 118 rman_manage_region(&sc->apb_irq_rman, 119 APB_IRQ_BASE, APB_IRQ_END) != 0) 120 panic("apb_attach: failed to set up IRQ rman"); 121 122 if ((sc->sc_misc_irq = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, 123 RF_SHAREABLE | RF_ACTIVE)) == NULL) { 124 device_printf(dev, "unable to allocate IRQ resource\n"); 125 return (ENXIO); 126 } 127 128 if ((bus_setup_intr(dev, sc->sc_misc_irq, INTR_TYPE_MISC, 129 apb_intr, NULL, sc, &sc->sc_misc_ih))) { 130 device_printf(dev, 131 "WARNING: unable to register interrupt handler\n"); 132 return (ENXIO); 133 } 134 135 bus_generic_probe(dev); 136 bus_enumerate_hinted_children(dev); 137 bus_generic_attach(dev); 138 139 return (0); 140} 141 142static struct resource * 143apb_alloc_resource(device_t bus, device_t child, int type, int *rid, 144 u_long start, u_long end, u_long count, u_int flags) 145{ 146 struct apb_softc *sc = device_get_softc(bus); 147 struct apb_ivar *ivar = device_get_ivars(child); 148 struct resource *rv; 149 struct resource_list_entry *rle; 150 struct rman *rm; 151 int isdefault, needactivate, passthrough; 152 153 isdefault = (start == 0UL && end == ~0UL); 154 needactivate = flags & RF_ACTIVE; 155 /* 156 * Pass memory requests to nexus device 157 */ 158 passthrough = (device_get_parent(child) != bus); 159 rle = NULL; 160 161 dprintf("%s: entry (%p, %p, %d, %d, %p, %p, %ld, %d)\n", 162 __func__, bus, child, type, *rid, (void *)(intptr_t)start, 163 (void *)(intptr_t)end, count, flags); 164 165 if (passthrough) 166 return (BUS_ALLOC_RESOURCE(device_get_parent(bus), child, type, 167 rid, start, end, count, flags)); 168 169 printf("not pass through\n"); 170 171 /* 172 * If this is an allocation of the "default" range for a given RID, 173 * and we know what the resources for this device are (ie. they aren't 174 * maintained by a child bus), then work out the start/end values. 175 */ 176 177 if (isdefault) { 178 rle = resource_list_find(&ivar->resources, type, *rid); 179 if (rle == NULL) { 180 return (NULL); 181 } 182 183 if (rle->res != NULL) { 184 panic("%s: resource entry is busy", __func__); 185 } 186 start = rle->start; 187 end = rle->end; 188 count = rle->count; 189 190 dprintf("%s: default resource (%p, %p, %ld)\n", 191 __func__, (void *)(intptr_t)start, 192 (void *)(intptr_t)end, count); 193 } 194 195 switch (type) { 196 case SYS_RES_IRQ: 197 rm = &sc->apb_irq_rman; 198 break; 199 case SYS_RES_MEMORY: 200 rm = &sc->apb_mem_rman; 201 break; 202 default: 203 printf("%s: unknown resource type %d\n", __func__, type); 204 return (0); 205 } 206 207 rv = rman_reserve_resource(rm, start, end, count, flags, child); 208 if (rv == 0) { 209 printf("%s: could not reserve resource\n", __func__); 210 return (0); 211 } 212 213 rman_set_rid(rv, *rid); 214 215 if (needactivate) { 216 if (bus_activate_resource(child, type, *rid, rv)) { 217 printf("%s: could not activate resource\n", __func__); 218 rman_release_resource(rv); 219 return (0); 220 } 221 } 222 223 return (rv); 224} 225 226static int 227apb_activate_resource(device_t bus, device_t child, int type, int rid, 228 struct resource *r) 229{ 230 231 /* XXX: should we mask/unmask IRQ here? */ 232 return (BUS_ACTIVATE_RESOURCE(device_get_parent(bus), child, 233 type, rid, r)); 234} 235 236static int 237apb_deactivate_resource(device_t bus, device_t child, int type, int rid, 238 struct resource *r) 239{ 240 241 /* XXX: should we mask/unmask IRQ here? */ 242 return (BUS_DEACTIVATE_RESOURCE(device_get_parent(bus), child, 243 type, rid, r)); 244} 245 246static int 247apb_release_resource(device_t dev, device_t child, int type, 248 int rid, struct resource *r) 249{ 250 struct resource_list *rl; 251 struct resource_list_entry *rle; 252 253 rl = apb_get_resource_list(dev, child); 254 if (rl == NULL) 255 return (EINVAL); 256 rle = resource_list_find(rl, type, rid); 257 if (rle == NULL) 258 return (EINVAL); 259 rman_release_resource(r); 260 rle->res = NULL; 261 262 return (0); 263} 264 265static int 266apb_setup_intr(device_t bus, device_t child, struct resource *ires, 267 int flags, driver_filter_t *filt, driver_intr_t *handler, 268 void *arg, void **cookiep) 269{ 270 struct apb_softc *sc = device_get_softc(bus); 271 struct intr_event *event; 272 int irq, error; 273 274 irq = rman_get_start(ires); 275 276 if (irq > APB_IRQ_END) 277 panic("%s: bad irq %d", __func__, irq); 278 279 event = sc->sc_eventstab[irq]; 280 if (event == NULL) { 281 error = intr_event_create(&event, (void *)irq, 0, irq, 282 (mask_fn)apb_mask_irq, (mask_fn)apb_unmask_irq, 283 NULL, NULL, 284 "apb intr%d:", irq); 285 286 sc->sc_eventstab[irq] = event; 287 } 288 289 intr_event_add_handler(event, device_get_nameunit(child), filt, 290 handler, arg, intr_priority(flags), flags, cookiep); 291 292 apb_unmask_irq(irq); 293 294 return (0); 295} 296 297static int 298apb_teardown_intr(device_t dev, device_t child, struct resource *ires, 299 void *cookie) 300{ 301 struct apb_softc *sc = device_get_softc(dev); 302 int irq, result; 303 304 irq = rman_get_start(ires); 305 if (irq > APB_IRQ_END) 306 panic("%s: bad irq %d", __func__, irq); 307 308 if (sc->sc_eventstab[irq] == NULL) 309 panic("Trying to teardown unoccupied IRQ"); 310 311 apb_mask_irq(irq); 312 313 result = intr_event_remove_handler(cookie); 314 if (!result) 315 sc->sc_eventstab[irq] = NULL; 316 317 return (result); 318} 319 320static int 321apb_intr(void *arg) 322{ 323 struct apb_softc *sc = arg; 324 struct intr_event *event; 325 uint32_t reg, irq; 326 327 reg = ATH_READ_REG(AR71XX_MISC_INTR_STATUS); 328 for (irq = 0; irq < APB_NIRQS; irq++) { 329 if (reg & (1 << irq)) { 330 event = sc->sc_eventstab[irq]; 331 if (!event || TAILQ_EMPTY(&event->ie_handlers)) { 332 /* Ignore timer interrupts */ 333 if (irq != 0) 334 printf("Stray IRQ %d\n", irq); 335 continue; 336 } 337 338 /* TODO: frame instead of NULL? */ 339 intr_event_handle(event, NULL); 340 } 341 } 342 343 return (FILTER_HANDLED); 344} 345 346static void 347apb_hinted_child(device_t bus, const char *dname, int dunit) 348{ 349 device_t child; 350 long maddr; 351 int msize; 352 int irq; 353 int result; 354 int mem_hints_count; 355 356 child = BUS_ADD_CHILD(bus, 0, dname, dunit); 357 358 /* 359 * Set hard-wired resources for hinted child using 360 * specific RIDs. 361 */ 362 mem_hints_count = 0; 363 if (resource_long_value(dname, dunit, "maddr", &maddr) == 0) 364 mem_hints_count++; 365 if (resource_int_value(dname, dunit, "msize", &msize) == 0) 366 mem_hints_count++; 367 368 /* check if all info for mem resource has been provided */ 369 if ((mem_hints_count > 0) && (mem_hints_count < 2)) { 370 printf("Either maddr or msize hint is missing for %s%d\n", 371 dname, dunit); 372 } else if (mem_hints_count) { 373 result = bus_set_resource(child, SYS_RES_MEMORY, 0, 374 maddr, msize); 375 if (result != 0) 376 device_printf(bus, 377 "warning: bus_set_resource() failed\n"); 378 } 379 380 if (resource_int_value(dname, dunit, "irq", &irq) == 0) { 381 result = bus_set_resource(child, SYS_RES_IRQ, 0, irq, 1); 382 if (result != 0) 383 device_printf(bus, 384 "warning: bus_set_resource() failed\n"); 385 } 386} 387 388static device_t 389apb_add_child(device_t bus, int order, const char *name, int unit) 390{ 391 device_t child; 392 struct apb_ivar *ivar; 393 394 ivar = malloc(sizeof(struct apb_ivar), M_DEVBUF, M_WAITOK | M_ZERO); 395 if (ivar == NULL) { 396 printf("Failed to allocate ivar\n"); 397 return (0); 398 } 399 resource_list_init(&ivar->resources); 400 401 child = device_add_child_ordered(bus, order, name, unit); 402 if (child == NULL) { 403 printf("Can't add child %s%d ordered\n", name, unit); 404 return (0); 405 } 406 407 device_set_ivars(child, ivar); 408 409 return (child); 410} 411 412/* 413 * Helper routine for bus_generic_rl_get_resource/bus_generic_rl_set_resource 414 * Provides pointer to resource_list for these routines 415 */ 416static struct resource_list * 417apb_get_resource_list(device_t dev, device_t child) 418{ 419 struct apb_ivar *ivar; 420 421 ivar = device_get_ivars(child); 422 return (&(ivar->resources)); 423} 424 425static device_method_t apb_methods[] = { 426 DEVMETHOD(bus_activate_resource, apb_activate_resource), 427 DEVMETHOD(bus_add_child, apb_add_child), 428 DEVMETHOD(bus_alloc_resource, apb_alloc_resource), 429 DEVMETHOD(bus_deactivate_resource, apb_deactivate_resource), 430 DEVMETHOD(bus_get_resource_list, apb_get_resource_list), 431 DEVMETHOD(bus_hinted_child, apb_hinted_child), 432 DEVMETHOD(bus_print_child, bus_generic_print_child), 433 DEVMETHOD(bus_release_resource, apb_release_resource), 434 DEVMETHOD(bus_setup_intr, apb_setup_intr), 435 DEVMETHOD(bus_teardown_intr, apb_teardown_intr), 436 DEVMETHOD(device_attach, apb_attach), 437 DEVMETHOD(device_probe, apb_probe), 438 DEVMETHOD(bus_get_resource, bus_generic_rl_get_resource), 439 DEVMETHOD(bus_set_resource, bus_generic_rl_set_resource), 440 441 {0, 0}, 442}; 443 444static driver_t apb_driver = { 445 "apb", 446 apb_methods, 447 sizeof(struct apb_softc), 448}; 449static devclass_t apb_devclass; 450 451DRIVER_MODULE(apb, nexus, apb_driver, apb_devclass, 0, 0); 452