1 /* $NetBSD: obio.c,v 1.11 2003/07/15 00:25:05 lukem Exp $ */
4 * Copyright (c) 2001, 2002, 2003 Wasabi Systems, Inc.
7 * Written by Jason R. Thorpe for Wasabi Systems, Inc.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 3. All advertising materials mentioning features or use of this software
18 * must display the following acknowledgement:
19 * This product includes software developed for the NetBSD Project by
20 * Wasabi Systems, Inc.
21 * 4. The name of Wasabi Systems, Inc. may not be used to endorse
22 * or promote products derived from this software without specific prior
25 * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
26 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WASABI SYSTEMS, INC
29 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35 * POSSIBILITY OF SUCH DAMAGE.
38 #include <sys/cdefs.h>
39 __FBSDID("$FreeBSD$");
41 #include <sys/param.h>
42 #include <sys/systm.h>
44 #include <sys/interrupt.h>
45 #include <sys/kernel.h>
46 #include <sys/module.h>
48 #include <sys/malloc.h>
50 #include <machine/bus.h>
52 #include <mips/adm5120/adm5120reg.h>
53 #include <mips/adm5120/obiovar.h>
55 /* MIPS HW interrupts of IRQ/FIQ respectively */
56 #define ADM5120_INTR 0
57 #define ADM5120_FAST_INTR 1
59 /* Interrupt levels */
63 int irq_priorities[NIRQS] = {
68 INTR_IRQ, /* unknown */
69 INTR_IRQ, /* unknown */
70 INTR_IRQ, /* unknown */
71 INTR_IRQ, /* unknown */
72 INTR_IRQ, /* unknown */
74 INTR_IRQ, /* unknown */
75 INTR_IRQ, /* unknown */
76 INTR_IRQ, /* unknown */
77 INTR_IRQ, /* unknown */
78 INTR_IRQ, /* unknown */
79 INTR_IRQ, /* unknown */
80 INTR_IRQ, /* unknown */
81 INTR_IRQ, /* unknown */
82 INTR_IRQ, /* unknown */
83 INTR_IRQ, /* unknown */
84 INTR_IRQ, /* unknown */
85 INTR_IRQ, /* unknown */
86 INTR_IRQ, /* unknown */
87 INTR_IRQ, /* unknown */
88 INTR_IRQ, /* unknown */
89 INTR_IRQ, /* unknown */
90 INTR_IRQ, /* unknown */
91 INTR_IRQ, /* unknown */
92 INTR_IRQ, /* unknown */
93 INTR_IRQ, /* unknown */
94 INTR_IRQ, /* unknown */
95 INTR_IRQ, /* unknown */
99 #define REG_READ(o) *((volatile uint32_t *)MIPS_PHYS_TO_KSEG1(ADM5120_BASE_ICU + (o)))
100 #define REG_WRITE(o,v) (REG_READ(o)) = (v)
102 static int obio_activate_resource(device_t, device_t, int, int,
104 static device_t obio_add_child(device_t, u_int, const char *, int);
105 static struct resource *
106 obio_alloc_resource(device_t, device_t, int, int *, u_long,
107 u_long, u_long, u_int);
108 static int obio_attach(device_t);
109 static int obio_deactivate_resource(device_t, device_t, int, int,
111 static struct resource_list *
112 obio_get_resource_list(device_t, device_t);
113 static void obio_hinted_child(device_t, const char *, int);
114 static int obio_intr(void *);
115 static int obio_probe(device_t);
116 static int obio_release_resource(device_t, device_t, int, int,
118 static int obio_setup_intr(device_t, device_t, struct resource *, int,
119 driver_filter_t *, driver_intr_t *, void *, void **);
120 static int obio_teardown_intr(device_t, device_t, struct resource *,
124 obio_mask_irq(void *arg)
126 /* XXX need to write */
128 unsigned int irq = (unsigned int)arg;
129 int ip_bit, mask, mask_register;
132 mask_register = ICU_IRQ_MASK_REG(irq);
133 ip_bit = ICU_IP_BIT(irq);
135 mask = ICU_REG_READ(mask_register);
136 ICU_REG_WRITE(mask_register, mask | ip_bit);
141 obio_unmask_irq(void *arg)
143 /* XXX need to write */
145 unsigned int irq = (unsigned int)arg;
146 int ip_bit, mask, mask_register;
149 mask_register = ICU_IRQ_MASK_REG(irq);
150 ip_bit = ICU_IP_BIT(irq);
152 mask = ICU_REG_READ(mask_register);
153 ICU_REG_WRITE(mask_register, mask & ~ip_bit);
158 obio_probe(device_t dev)
165 obio_attach(device_t dev)
167 struct obio_softc *sc = device_get_softc(dev);
170 sc->oba_mem_rman.rm_type = RMAN_ARRAY;
171 sc->oba_mem_rman.rm_descr = "OBIO memeory";
172 if (rman_init(&sc->oba_mem_rman) != 0 ||
173 rman_manage_region(&sc->oba_mem_rman, OBIO_MEM_START,
174 OBIO_MEM_START + OBIO_MEM_SIZE) != 0)
175 panic("obio_attach: failed to set up I/O rman");
177 sc->oba_irq_rman.rm_type = RMAN_ARRAY;
178 sc->oba_irq_rman.rm_descr = "OBIO IRQ";
180 if (rman_init(&sc->oba_irq_rman) != 0 ||
181 rman_manage_region(&sc->oba_irq_rman, 0, NIRQS-1) != 0)
182 panic("obio_attach: failed to set up IRQ rman");
184 /* Hook up our interrupt handler. */
185 if ((sc->sc_irq = bus_alloc_resource(dev, SYS_RES_IRQ, &rid,
186 ADM5120_INTR, ADM5120_INTR, 1,
187 RF_SHAREABLE | RF_ACTIVE)) == NULL) {
188 device_printf(dev, "unable to allocate IRQ resource\n");
192 if ((bus_setup_intr(dev, sc->sc_irq, INTR_TYPE_MISC, obio_intr, NULL,
195 "WARNING: unable to register interrupt handler\n");
199 /* Hook up our FAST interrupt handler. */
200 if ((sc->sc_fast_irq = bus_alloc_resource(dev, SYS_RES_IRQ, &rid,
201 ADM5120_FAST_INTR, ADM5120_FAST_INTR, 1,
202 RF_SHAREABLE | RF_ACTIVE)) == NULL) {
203 device_printf(dev, "unable to allocate IRQ resource\n");
207 if ((bus_setup_intr(dev, sc->sc_fast_irq, INTR_TYPE_MISC, obio_intr,
208 NULL, sc, &sc->sc_fast_ih))) {
210 "WARNING: unable to register interrupt handler\n");
214 /* disable all interrupts */
215 REG_WRITE(ICU_ENABLE_REG, ICU_INT_MASK);
217 bus_generic_probe(dev);
218 bus_enumerate_hinted_children(dev);
219 bus_generic_attach(dev);
224 static struct resource *
225 obio_alloc_resource(device_t bus, device_t child, int type, int *rid,
226 u_long start, u_long end, u_long count, u_int flags)
228 struct obio_softc *sc = device_get_softc(bus);
229 struct obio_ivar *ivar = device_get_ivars(child);
231 struct resource_list_entry *rle;
233 int isdefault, needactivate, passthrough;
235 isdefault = (start == 0UL && end == ~0UL && count == 1);
236 needactivate = flags & RF_ACTIVE;
237 passthrough = (device_get_parent(child) != bus);
241 return (BUS_ALLOC_RESOURCE(device_get_parent(bus), child, type,
242 rid, start, end, count, flags));
245 * If this is an allocation of the "default" range for a given RID,
246 * and we know what the resources for this device are (ie. they aren't
247 * maintained by a child bus), then work out the start/end values.
250 rle = resource_list_find(&ivar->resources, type, *rid);
253 if (rle->res != NULL) {
254 panic("%s: resource entry is busy", __func__);
263 rm = &sc->oba_irq_rman;
266 rm = &sc->oba_mem_rman;
269 printf("%s: unknown resource type %d\n", __func__, type);
273 rv = rman_reserve_resource(rm, start, end, count, flags, child);
275 printf("%s: could not reserve resource\n", __func__);
279 rman_set_rid(rv, *rid);
282 if (bus_activate_resource(child, type, *rid, rv)) {
283 printf("%s: could not activate resource\n", __func__);
284 rman_release_resource(rv);
293 obio_activate_resource(device_t bus, device_t child, int type, int rid,
298 * If this is a memory resource, track the direct mapping
299 * in the uncached MIPS KSEG1 segment.
301 if (type == SYS_RES_MEMORY) {
304 vaddr = (void *)MIPS_PHYS_TO_KSEG1((intptr_t)rman_get_start(r));
305 rman_set_virtual(r, vaddr);
306 rman_set_bustag(r, mips_bus_space_generic);
307 rman_set_bushandle(r, (bus_space_handle_t)vaddr);
310 return (rman_activate_resource(r));
314 obio_deactivate_resource(device_t bus, device_t child, int type, int rid,
318 return (rman_deactivate_resource(r));
322 obio_release_resource(device_t dev, device_t child, int type,
323 int rid, struct resource *r)
325 struct resource_list *rl;
326 struct resource_list_entry *rle;
328 rl = obio_get_resource_list(dev, child);
331 rle = resource_list_find(rl, type, rid);
334 rman_release_resource(r);
341 obio_setup_intr(device_t dev, device_t child, struct resource *ires,
342 int flags, driver_filter_t *filt, driver_intr_t *handler,
343 void *arg, void **cookiep)
345 struct obio_softc *sc = device_get_softc(dev);
346 struct intr_event *event;
347 int irq, error, priority;
350 irq = rman_get_start(ires);
353 panic("%s: bad irq %d", __func__, irq);
355 event = sc->sc_eventstab[irq];
357 error = intr_event_create(&event, (void *)irq, 0, irq,
358 obio_mask_irq, obio_unmask_irq,
360 "obio intr%d:", irq);
362 sc->sc_eventstab[irq] = event;
365 panic("obio: Can't share IRQs");
367 intr_event_add_handler(event, device_get_nameunit(child), filt,
368 handler, arg, intr_priority(flags), flags, cookiep);
371 priority = irq_priorities[irq];
373 if (priority == INTR_FIQ)
374 REG_WRITE(ICU_MODE_REG, REG_READ(ICU_MODE_REG) | irqmask);
376 REG_WRITE(ICU_MODE_REG, REG_READ(ICU_MODE_REG) & ~irqmask);
379 REG_WRITE(ICU_ENABLE_REG, irqmask);
385 obio_teardown_intr(device_t dev, device_t child, struct resource *ires,
388 struct obio_softc *sc = device_get_softc(dev);
392 irq = rman_get_start(ires);
394 panic("%s: bad irq %d", __func__, irq);
396 if (sc->sc_eventstab[irq] == NULL)
397 panic("Trying to teardown unoccupied IRQ");
399 irqmask = 1 << irq; /* only used as a mask from here on */
401 /* disable this irq in HW */
402 REG_WRITE(ICU_DISABLE_REG, irqmask);
404 result = intr_event_remove_handler(cookie);
406 sc->sc_eventstab[irq] = NULL;
415 struct obio_softc *sc = arg;
416 struct intr_event *event;
420 irqstat = REG_READ(ICU_FIQ_STATUS_REG);
421 irqstat |= REG_READ(ICU_STATUS_REG);
424 while (irqstat != 0) {
425 if ((irqstat & 1) == 1) {
426 event = sc->sc_eventstab[irq];
427 if (!event || TAILQ_EMPTY(&event->ie_handlers))
430 /* TODO: pass frame as an argument*/
431 /* TODO: log stray interrupt */
432 intr_event_handle(event, NULL);
439 return (FILTER_HANDLED);
443 obio_hinted_child(device_t bus, const char *dname, int dunit)
451 child = BUS_ADD_CHILD(bus, 0, dname, dunit);
454 * Set hard-wired resources for hinted child using
457 resource_long_value(dname, dunit, "maddr", &maddr);
458 resource_int_value(dname, dunit, "msize", &msize);
461 result = bus_set_resource(child, SYS_RES_MEMORY, 0,
464 device_printf(bus, "warning: bus_set_resource() failed\n");
466 if (resource_int_value(dname, dunit, "irq", &irq) == 0) {
467 result = bus_set_resource(child, SYS_RES_IRQ, 0, irq, 1);
470 "warning: bus_set_resource() failed\n");
475 obio_add_child(device_t bus, u_int order, const char *name, int unit)
478 struct obio_ivar *ivar;
480 ivar = malloc(sizeof(struct obio_ivar), M_DEVBUF, M_WAITOK | M_ZERO);
482 printf("Failed to allocate ivar\n");
485 resource_list_init(&ivar->resources);
487 child = device_add_child_ordered(bus, order, name, unit);
489 printf("Can't add child %s%d ordered\n", name, unit);
493 device_set_ivars(child, ivar);
499 * Helper routine for bus_generic_rl_get_resource/bus_generic_rl_set_resource
500 * Provides pointer to resource_list for these routines
502 static struct resource_list *
503 obio_get_resource_list(device_t dev, device_t child)
505 struct obio_ivar *ivar;
507 ivar = device_get_ivars(child);
508 return (&(ivar->resources));
511 static device_method_t obio_methods[] = {
512 DEVMETHOD(bus_activate_resource, obio_activate_resource),
513 DEVMETHOD(bus_add_child, obio_add_child),
514 DEVMETHOD(bus_alloc_resource, obio_alloc_resource),
515 DEVMETHOD(bus_deactivate_resource, obio_deactivate_resource),
516 DEVMETHOD(bus_get_resource_list, obio_get_resource_list),
517 DEVMETHOD(bus_hinted_child, obio_hinted_child),
518 DEVMETHOD(bus_release_resource, obio_release_resource),
519 DEVMETHOD(bus_setup_intr, obio_setup_intr),
520 DEVMETHOD(bus_teardown_intr, obio_teardown_intr),
521 DEVMETHOD(device_attach, obio_attach),
522 DEVMETHOD(device_probe, obio_probe),
523 DEVMETHOD(bus_get_resource, bus_generic_rl_get_resource),
524 DEVMETHOD(bus_set_resource, bus_generic_rl_set_resource),
529 static driver_t obio_driver = {
532 sizeof(struct obio_softc),
534 static devclass_t obio_devclass;
536 DRIVER_MODULE(obio, nexus, obio_driver, obio_devclass, 0, 0);