2 * Copyright (c) 2009, Oleksandr Tymoshenko <gonzo@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice unmodified, this list of conditions, and the following
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.
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
28 #include <sys/cdefs.h>
29 __FBSDID("$FreeBSD$");
31 #include <sys/param.h>
32 #include <sys/systm.h>
34 #include <sys/interrupt.h>
35 #include <sys/kernel.h>
36 #include <sys/module.h>
38 #include <sys/malloc.h>
40 #include <machine/bus.h>
41 #include <machine/intr_machdep.h>
43 #include <mips/atheros/apbvar.h>
44 #include <mips/atheros/ar71xxreg.h>
48 #define dprintf printf
50 #define dprintf(x, arg...)
51 #endif /* APB_DEBUG */
53 static int apb_activate_resource(device_t, device_t, int, int,
55 static device_t apb_add_child(device_t, u_int, const char *, int);
56 static struct resource *
57 apb_alloc_resource(device_t, device_t, int, int *, u_long,
58 u_long, u_long, u_int);
59 static int apb_attach(device_t);
60 static int apb_deactivate_resource(device_t, device_t, int, int,
62 static struct resource_list *
63 apb_get_resource_list(device_t, device_t);
64 static void apb_hinted_child(device_t, const char *, int);
65 static int apb_intr(void *);
66 static int apb_probe(device_t);
67 static int apb_release_resource(device_t, device_t, int, int,
69 static int apb_setup_intr(device_t, device_t, struct resource *, int,
70 driver_filter_t *, driver_intr_t *, void *, void **);
71 static int apb_teardown_intr(device_t, device_t, struct resource *,
75 apb_mask_irq(void *source)
77 unsigned int irq = (unsigned int)source;
80 reg = ATH_READ_REG(AR71XX_MISC_INTR_MASK);
81 ATH_WRITE_REG(AR71XX_MISC_INTR_MASK, reg & ~(1 << irq));
86 apb_unmask_irq(void *source)
89 unsigned int irq = (unsigned int)source;
91 reg = ATH_READ_REG(AR71XX_MISC_INTR_MASK);
92 ATH_WRITE_REG(AR71XX_MISC_INTR_MASK, reg | (1 << irq));
96 apb_probe(device_t dev)
103 apb_attach(device_t dev)
105 struct apb_softc *sc = device_get_softc(dev);
108 device_set_desc(dev, "APB Bus bridge");
110 sc->apb_mem_rman.rm_type = RMAN_ARRAY;
111 sc->apb_mem_rman.rm_descr = "APB memory window";
113 if (rman_init(&sc->apb_mem_rman) != 0 ||
114 rman_manage_region(&sc->apb_mem_rman,
116 AR71XX_APB_BASE + AR71XX_APB_SIZE - 1) != 0)
117 panic("apb_attach: failed to set up memory rman");
119 sc->apb_irq_rman.rm_type = RMAN_ARRAY;
120 sc->apb_irq_rman.rm_descr = "APB IRQ";
122 if (rman_init(&sc->apb_irq_rman) != 0 ||
123 rman_manage_region(&sc->apb_irq_rman,
124 APB_IRQ_BASE, APB_IRQ_END) != 0)
125 panic("apb_attach: failed to set up IRQ rman");
127 if ((sc->sc_misc_irq = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
128 RF_SHAREABLE | RF_ACTIVE)) == NULL) {
129 device_printf(dev, "unable to allocate IRQ resource\n");
133 if ((bus_setup_intr(dev, sc->sc_misc_irq, INTR_TYPE_MISC,
134 apb_intr, NULL, sc, &sc->sc_misc_ih))) {
136 "WARNING: unable to register interrupt handler\n");
140 bus_generic_probe(dev);
141 bus_enumerate_hinted_children(dev);
142 bus_generic_attach(dev);
147 static struct resource *
148 apb_alloc_resource(device_t bus, device_t child, int type, int *rid,
149 u_long start, u_long end, u_long count, u_int flags)
151 struct apb_softc *sc = device_get_softc(bus);
152 struct apb_ivar *ivar = device_get_ivars(child);
154 struct resource_list_entry *rle;
156 int isdefault, needactivate, passthrough;
158 isdefault = (start == 0UL && end == ~0UL);
159 needactivate = flags & RF_ACTIVE;
161 * Pass memory requests to nexus device
163 passthrough = (device_get_parent(child) != bus);
166 dprintf("%s: entry (%p, %p, %d, %d, %p, %p, %ld, %d)\n",
167 __func__, bus, child, type, *rid, (void *)(intptr_t)start,
168 (void *)(intptr_t)end, count, flags);
171 return (BUS_ALLOC_RESOURCE(device_get_parent(bus), child, type,
172 rid, start, end, count, flags));
175 * If this is an allocation of the "default" range for a given RID,
176 * and we know what the resources for this device are (ie. they aren't
177 * maintained by a child bus), then work out the start/end values.
181 rle = resource_list_find(&ivar->resources, type, *rid);
186 if (rle->res != NULL) {
187 panic("%s: resource entry is busy", __func__);
193 dprintf("%s: default resource (%p, %p, %ld)\n",
194 __func__, (void *)(intptr_t)start,
195 (void *)(intptr_t)end, count);
200 rm = &sc->apb_irq_rman;
203 rm = &sc->apb_mem_rman;
206 printf("%s: unknown resource type %d\n", __func__, type);
210 rv = rman_reserve_resource(rm, start, end, count, flags, child);
212 printf("%s: could not reserve resource\n", __func__);
216 rman_set_rid(rv, *rid);
219 if (bus_activate_resource(child, type, *rid, rv)) {
220 printf("%s: could not activate resource\n", __func__);
221 rman_release_resource(rv);
230 apb_activate_resource(device_t bus, device_t child, int type, int rid,
234 /* XXX: should we mask/unmask IRQ here? */
235 return (BUS_ACTIVATE_RESOURCE(device_get_parent(bus), child,
240 apb_deactivate_resource(device_t bus, device_t child, int type, int rid,
244 /* XXX: should we mask/unmask IRQ here? */
245 return (BUS_DEACTIVATE_RESOURCE(device_get_parent(bus), child,
250 apb_release_resource(device_t dev, device_t child, int type,
251 int rid, struct resource *r)
253 struct resource_list *rl;
254 struct resource_list_entry *rle;
256 rl = apb_get_resource_list(dev, child);
259 rle = resource_list_find(rl, type, rid);
262 rman_release_resource(r);
269 apb_setup_intr(device_t bus, device_t child, struct resource *ires,
270 int flags, driver_filter_t *filt, driver_intr_t *handler,
271 void *arg, void **cookiep)
273 struct apb_softc *sc = device_get_softc(bus);
274 struct intr_event *event;
277 irq = rman_get_start(ires);
279 if (irq > APB_IRQ_END)
280 panic("%s: bad irq %d", __func__, irq);
282 event = sc->sc_eventstab[irq];
284 error = intr_event_create(&event, (void *)irq, 0, irq,
285 apb_mask_irq, apb_unmask_irq,
290 sc->sc_eventstab[irq] = event;
291 sc->sc_intr_counter[irq] =
292 mips_intrcnt_create(event->ie_name);
298 intr_event_add_handler(event, device_get_nameunit(child), filt,
299 handler, arg, intr_priority(flags), flags, cookiep);
300 mips_intrcnt_setname(sc->sc_intr_counter[irq], event->ie_fullname);
302 apb_unmask_irq((void*)irq);
308 apb_teardown_intr(device_t dev, device_t child, struct resource *ires,
311 struct apb_softc *sc = device_get_softc(dev);
314 irq = rman_get_start(ires);
315 if (irq > APB_IRQ_END)
316 panic("%s: bad irq %d", __func__, irq);
318 if (sc->sc_eventstab[irq] == NULL)
319 panic("Trying to teardown unoccupied IRQ");
321 apb_mask_irq((void*)irq);
323 result = intr_event_remove_handler(cookie);
325 sc->sc_eventstab[irq] = NULL;
333 struct apb_softc *sc = arg;
334 struct intr_event *event;
337 reg = ATH_READ_REG(AR71XX_MISC_INTR_STATUS);
338 for (irq = 0; irq < APB_NIRQS; irq++) {
339 if (reg & (1 << irq)) {
340 event = sc->sc_eventstab[irq];
341 if (!event || TAILQ_EMPTY(&event->ie_handlers)) {
342 /* Ignore timer interrupts */
344 printf("Stray APB IRQ %d\n", irq);
348 /* TODO: frame instead of NULL? */
349 intr_event_handle(event, NULL);
350 mips_intrcnt_inc(sc->sc_intr_counter[irq]);
354 return (FILTER_HANDLED);
358 apb_hinted_child(device_t bus, const char *dname, int dunit)
367 child = BUS_ADD_CHILD(bus, 0, dname, dunit);
370 * Set hard-wired resources for hinted child using
374 if (resource_long_value(dname, dunit, "maddr", &maddr) == 0)
376 if (resource_int_value(dname, dunit, "msize", &msize) == 0)
379 /* check if all info for mem resource has been provided */
380 if ((mem_hints_count > 0) && (mem_hints_count < 2)) {
381 printf("Either maddr or msize hint is missing for %s%d\n",
383 } else if (mem_hints_count) {
384 result = bus_set_resource(child, SYS_RES_MEMORY, 0,
388 "warning: bus_set_resource() failed\n");
391 if (resource_int_value(dname, dunit, "irq", &irq) == 0) {
392 result = bus_set_resource(child, SYS_RES_IRQ, 0, irq, 1);
395 "warning: bus_set_resource() failed\n");
400 apb_add_child(device_t bus, u_int order, const char *name, int unit)
403 struct apb_ivar *ivar;
405 ivar = malloc(sizeof(struct apb_ivar), M_DEVBUF, M_WAITOK | M_ZERO);
407 printf("Failed to allocate ivar\n");
410 resource_list_init(&ivar->resources);
412 child = device_add_child_ordered(bus, order, name, unit);
414 printf("Can't add child %s%d ordered\n", name, unit);
418 device_set_ivars(child, ivar);
424 * Helper routine for bus_generic_rl_get_resource/bus_generic_rl_set_resource
425 * Provides pointer to resource_list for these routines
427 static struct resource_list *
428 apb_get_resource_list(device_t dev, device_t child)
430 struct apb_ivar *ivar;
432 ivar = device_get_ivars(child);
433 return (&(ivar->resources));
436 static device_method_t apb_methods[] = {
437 DEVMETHOD(bus_activate_resource, apb_activate_resource),
438 DEVMETHOD(bus_add_child, apb_add_child),
439 DEVMETHOD(bus_alloc_resource, apb_alloc_resource),
440 DEVMETHOD(bus_deactivate_resource, apb_deactivate_resource),
441 DEVMETHOD(bus_get_resource_list, apb_get_resource_list),
442 DEVMETHOD(bus_hinted_child, apb_hinted_child),
443 DEVMETHOD(bus_print_child, bus_generic_print_child),
444 DEVMETHOD(bus_release_resource, apb_release_resource),
445 DEVMETHOD(bus_setup_intr, apb_setup_intr),
446 DEVMETHOD(bus_teardown_intr, apb_teardown_intr),
447 DEVMETHOD(device_attach, apb_attach),
448 DEVMETHOD(device_probe, apb_probe),
449 DEVMETHOD(bus_get_resource, bus_generic_rl_get_resource),
450 DEVMETHOD(bus_set_resource, bus_generic_rl_set_resource),
455 static driver_t apb_driver = {
458 sizeof(struct apb_softc),
460 static devclass_t apb_devclass;
462 DRIVER_MODULE(apb, nexus, apb_driver, apb_devclass, 0, 0);