2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright 2003 by Peter Grehan. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following 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 * 3. The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
22 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
24 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
25 * 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
33 * A driver for the PIC found in the Heathrow/Paddington MacIO chips.
34 * This was superseded by an OpenPIC in the Keylargo and beyond
38 #include <sys/param.h>
39 #include <sys/systm.h>
40 #include <sys/module.h>
43 #include <sys/kernel.h>
46 #include <dev/ofw/ofw_bus.h>
47 #include <dev/ofw/openfirm.h>
49 #include <machine/bus.h>
50 #include <machine/intr_machdep.h>
51 #include <machine/md_var.h>
52 #include <machine/pio.h>
53 #include <machine/resource.h>
58 #include <powerpc/powermac/hrowpicvar.h>
65 static int hrowpic_probe(device_t);
66 static int hrowpic_attach(device_t);
68 static void hrowpic_dispatch(device_t, struct trapframe *);
69 static void hrowpic_enable(device_t, u_int, u_int, void **);
70 static void hrowpic_eoi(device_t, u_int, void *);
71 static void hrowpic_ipi(device_t, u_int);
72 static void hrowpic_mask(device_t, u_int, void *);
73 static void hrowpic_unmask(device_t, u_int, void *);
75 static device_method_t hrowpic_methods[] = {
76 /* Device interface */
77 DEVMETHOD(device_probe, hrowpic_probe),
78 DEVMETHOD(device_attach, hrowpic_attach),
81 DEVMETHOD(pic_dispatch, hrowpic_dispatch),
82 DEVMETHOD(pic_enable, hrowpic_enable),
83 DEVMETHOD(pic_eoi, hrowpic_eoi),
84 DEVMETHOD(pic_ipi, hrowpic_ipi),
85 DEVMETHOD(pic_mask, hrowpic_mask),
86 DEVMETHOD(pic_unmask, hrowpic_unmask),
91 static driver_t hrowpic_driver = {
94 sizeof(struct hrowpic_softc)
97 static devclass_t hrowpic_devclass;
99 DRIVER_MODULE(hrowpic, macio, hrowpic_driver, hrowpic_devclass, 0, 0);
102 hrowpic_read_reg(struct hrowpic_softc *sc, u_int reg, u_int bank)
104 if (bank == HPIC_PRIMARY)
105 reg += HPIC_1ST_OFFSET;
107 return (bus_space_read_4(sc->sc_bt, sc->sc_bh, reg));
111 hrowpic_write_reg(struct hrowpic_softc *sc, u_int reg, u_int bank,
115 if (bank == HPIC_PRIMARY)
116 reg += HPIC_1ST_OFFSET;
118 bus_space_write_4(sc->sc_bt, sc->sc_bh, reg, val);
120 /* XXX Issue a read to force the write to complete. */
121 bus_space_read_4(sc->sc_bt, sc->sc_bh, reg);
125 hrowpic_probe(device_t dev)
127 const char *type = ofw_bus_get_type(dev);
130 * OpenPIC cells have a type of "open-pic", so this
131 * is sufficient to identify a Heathrow cell
133 if (strcmp(type, "interrupt-controller") != 0)
137 * The description was already printed out in the nexus
138 * probe, so don't do it again here
140 device_set_desc(dev, "Heathrow MacIO interrupt controller");
145 hrowpic_attach(device_t dev)
147 struct hrowpic_softc *sc;
149 sc = device_get_softc(dev);
153 sc->sc_rres = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &sc->sc_rrid,
156 if (sc->sc_rres == NULL) {
157 device_printf(dev, "Could not alloc mem resource!\n");
161 sc->sc_bt = rman_get_bustag(sc->sc_rres);
162 sc->sc_bh = rman_get_bushandle(sc->sc_rres);
165 * Disable all interrupt sources and clear outstanding interrupts
167 hrowpic_write_reg(sc, HPIC_ENABLE, HPIC_PRIMARY, 0);
168 hrowpic_write_reg(sc, HPIC_CLEAR, HPIC_PRIMARY, 0xffffffff);
169 hrowpic_write_reg(sc, HPIC_ENABLE, HPIC_SECONDARY, 0);
170 hrowpic_write_reg(sc, HPIC_CLEAR, HPIC_SECONDARY, 0xffffffff);
172 powerpc_register_pic(dev, ofw_bus_get_node(dev), 64, 0, FALSE);
181 hrowpic_toggle_irq(struct hrowpic_softc *sc, int irq, int enable)
186 KASSERT((irq > 0) && (irq <= HROWPIC_IRQMAX), ("en irq out of range"));
189 * Humor the SMP layer if it wants to set up an IPI handler.
191 if (irq == HROWPIC_IRQMAX)
195 * Calculate prim/sec register bank for the IRQ, update soft copy,
196 * and enable the IRQ as an interrupt source
198 roffset = HPIC_INT_TO_BANK(irq);
199 rbit = HPIC_INT_TO_REGBIT(irq);
202 sc->sc_softreg[roffset] |= (1 << rbit);
204 sc->sc_softreg[roffset] &= ~(1 << rbit);
206 hrowpic_write_reg(sc, HPIC_ENABLE, roffset, sc->sc_softreg[roffset]);
214 hrowpic_dispatch(device_t dev, struct trapframe *tf)
216 struct hrowpic_softc *sc;
221 sc = device_get_softc(dev);
223 mask = hrowpic_read_reg(sc, HPIC_STATUS, HPIC_SECONDARY);
224 reg = hrowpic_read_reg(sc, HPIC_STATUS, HPIC_PRIMARY);
225 mask = (mask << 32) | reg;
230 while (irq < HROWPIC_IRQMAX) {
232 powerpc_dispatch_intr(sc->sc_vector[irq], tf);
240 hrowpic_enable(device_t dev, u_int irq, u_int vector, void **priv __unused)
242 struct hrowpic_softc *sc;
244 sc = device_get_softc(dev);
245 sc->sc_vector[irq] = vector;
246 hrowpic_toggle_irq(sc, irq, 1);
250 hrowpic_eoi(device_t dev, u_int irq, void *priv __unused)
252 struct hrowpic_softc *sc;
255 sc = device_get_softc(dev);
256 bank = (irq >= 32) ? HPIC_SECONDARY : HPIC_PRIMARY ;
257 hrowpic_write_reg(sc, HPIC_CLEAR, bank, 1U << (irq & 0x1f));
261 hrowpic_ipi(device_t dev, u_int irq)
263 /* No SMP support. */
267 hrowpic_mask(device_t dev, u_int irq, void *priv __unused)
269 struct hrowpic_softc *sc;
271 sc = device_get_softc(dev);
272 hrowpic_toggle_irq(sc, irq, 0);
276 hrowpic_unmask(device_t dev, u_int irq, void *priv __unused)
278 struct hrowpic_softc *sc;
280 sc = device_get_softc(dev);
281 hrowpic_toggle_irq(sc, irq, 1);