sunxi_intc.c revision 1.3.6.1 1 /* $NetBSD: sunxi_intc.c,v 1.3.6.1 2020/04/08 14:07:31 martin Exp $ */
2
3 /*-
4 * Copyright (c) 2017 Jared McNeill <jmcneill (at) invisible.ca>
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 */
28
29 #define _INTR_PRIVATE
30
31 #include <sys/cdefs.h>
32 __KERNEL_RCSID(0, "$NetBSD: sunxi_intc.c,v 1.3.6.1 2020/04/08 14:07:31 martin Exp $");
33
34 #include <sys/param.h>
35 #include <sys/bus.h>
36 #include <sys/device.h>
37 #include <sys/intr.h>
38 #include <sys/kernel.h>
39 #include <sys/lwp.h>
40 #include <sys/systm.h>
41
42 #include <dev/fdt/fdtvar.h>
43
44 #include <arm/cpu.h>
45 #include <arm/pic/picvar.h>
46 #include <arm/fdt/arm_fdtvar.h>
47
48 #define INTC_MAX_SOURCES 96
49 #define INTC_MAX_GROUPS 3
50
51 #define INTC_VECTOR_REG 0x00
52 #define INTC_BASE_ADDR_REG 0x04
53 #define INTC_PROTECT_REG 0x08
54 #define INTC_PROTECT_EN __BIT(0)
55 #define INTC_NMII_CTRL_REG 0x0c
56 #define INTC_IRQ_PEND_REG(n) (0x10 + ((n) * 4))
57 #define INTC_FIQ_PEND_REG(n) (0x20 + ((n) * 4))
58 #define INTC_SEL_REG(n) (0x30 + ((n) * 4))
59 #define INTC_EN_REG(n) (0x40 + ((n) * 4))
60 #define INTC_MASK_REG(n) (0x50 + ((n) * 4))
61 #define INTC_RESP_REG(n) (0x60 + ((n) * 4))
62 #define INTC_FORCE_REG(n) (0x70 + ((n) * 4))
63 #define INTC_SRC_PRIO_REG(n) (0x80 + ((n) * 4))
64
65 static const char * const compatible[] = {
66 "allwinner,sun4i-a10-ic",
67 NULL
68 };
69
70 struct sunxi_intc_softc {
71 device_t sc_dev;
72 bus_space_tag_t sc_bst;
73 bus_space_handle_t sc_bsh;
74 int sc_phandle;
75
76 uint32_t sc_enabled_irqs[INTC_MAX_GROUPS];
77
78 struct pic_softc sc_pic;
79 };
80
81 static struct sunxi_intc_softc *intc_softc;
82
83 #define PICTOSOFTC(pic) \
84 ((void *)((uintptr_t)(pic) - offsetof(struct sunxi_intc_softc, sc_pic)))
85
86 #define INTC_READ(sc, reg) \
87 bus_space_read_4((sc)->sc_bst, (sc)->sc_bsh, (reg))
88 #define INTC_WRITE(sc, reg, val) \
89 bus_space_write_4((sc)->sc_bst, (sc)->sc_bsh, (reg), (val))
90
91 static void
92 sunxi_intc_unblock_irqs(struct pic_softc *pic, size_t irqbase, uint32_t mask)
93 {
94 struct sunxi_intc_softc * const sc = PICTOSOFTC(pic);
95 const u_int group = irqbase / 32;
96
97 KASSERT((mask & sc->sc_enabled_irqs[group]) == 0);
98 sc->sc_enabled_irqs[group] |= mask;
99 INTC_WRITE(sc, INTC_EN_REG(group), sc->sc_enabled_irqs[group]);
100 INTC_WRITE(sc, INTC_MASK_REG(group), ~sc->sc_enabled_irqs[group]);
101 }
102
103 static void
104 sunxi_intc_block_irqs(struct pic_softc *pic, size_t irqbase, uint32_t mask)
105 {
106 struct sunxi_intc_softc * const sc = PICTOSOFTC(pic);
107 const u_int group = irqbase / 32;
108
109 sc->sc_enabled_irqs[group] &= ~mask;
110 INTC_WRITE(sc, INTC_EN_REG(group), sc->sc_enabled_irqs[group]);
111 INTC_WRITE(sc, INTC_MASK_REG(group), ~sc->sc_enabled_irqs[group]);
112 }
113
114 static void
115 sunxi_intc_establish_irq(struct pic_softc *pic, struct intrsource *is)
116 {
117 KASSERT(is->is_irq < INTC_MAX_SOURCES);
118 KASSERT(is->is_type == IST_LEVEL);
119 }
120
121 static void
122 sunxi_intc_set_priority(struct pic_softc *pic, int ipl)
123 {
124 }
125
126 static const struct pic_ops sunxi_intc_picops = {
127 .pic_unblock_irqs = sunxi_intc_unblock_irqs,
128 .pic_block_irqs = sunxi_intc_block_irqs,
129 .pic_establish_irq = sunxi_intc_establish_irq,
130 .pic_set_priority = sunxi_intc_set_priority,
131 };
132
133 static void *
134 sunxi_intc_fdt_establish(device_t dev, u_int *specifier, int ipl, int flags,
135 int (*func)(void *), void *arg)
136 {
137 /* 1st cell is the interrupt number */
138 const u_int irq = be32toh(specifier[0]);
139
140 if (irq >= INTC_MAX_SOURCES) {
141 #ifdef DIAGNOSTIC
142 device_printf(dev, "IRQ %u is invalid\n", irq);
143 #endif
144 return NULL;
145 }
146
147 const u_int mpsafe = (flags & FDT_INTR_MPSAFE) ? IST_MPSAFE : 0;
148
149 return intr_establish(irq, ipl, IST_LEVEL | mpsafe, func, arg);
150 }
151
152 static void
153 sunxi_intc_fdt_disestablish(device_t dev, void *ih)
154 {
155 intr_disestablish(ih);
156 }
157
158 static bool
159 sunxi_intc_fdt_intrstr(device_t dev, u_int *specifier, char *buf, size_t buflen)
160 {
161 /* 1st cell is the interrupt number */
162 if (!specifier)
163 return false;
164 const u_int irq = be32toh(specifier[0]);
165
166 snprintf(buf, buflen, "INTC irq %d", irq);
167
168 return true;
169 }
170
171 static const struct fdtbus_interrupt_controller_func sunxi_intc_fdt_funcs = {
172 .establish = sunxi_intc_fdt_establish,
173 .disestablish = sunxi_intc_fdt_disestablish,
174 .intrstr = sunxi_intc_fdt_intrstr,
175 };
176
177 static int
178 sunxi_intc_find_pending_irqs(struct sunxi_intc_softc *sc, u_int group)
179 {
180 uint32_t pend;
181
182 pend = INTC_READ(sc, INTC_IRQ_PEND_REG(group));
183 pend &= sc->sc_enabled_irqs[group];
184
185 if (pend == 0)
186 return 0;
187
188 INTC_WRITE(sc, INTC_IRQ_PEND_REG(group), pend);
189
190 return pic_mark_pending_sources(&sc->sc_pic, group * 32, pend);
191 }
192
193 static void
194 sunxi_intc_irq_handler(void *frame)
195 {
196 struct cpu_info * const ci = curcpu();
197 struct sunxi_intc_softc * const sc = intc_softc;
198 const int oldipl = ci->ci_cpl;
199 const uint32_t oldipl_mask = __BIT(oldipl);
200 int ipl_mask = 0;
201
202 ci->ci_data.cpu_nintr++;
203
204 if (sc->sc_enabled_irqs[0])
205 ipl_mask |= sunxi_intc_find_pending_irqs(sc, 0);
206 if (sc->sc_enabled_irqs[1])
207 ipl_mask |= sunxi_intc_find_pending_irqs(sc, 1);
208 if (sc->sc_enabled_irqs[2])
209 ipl_mask |= sunxi_intc_find_pending_irqs(sc, 2);
210
211 if ((ipl_mask & ~oldipl_mask) > oldipl_mask)
212 pic_do_pending_ints(I32_bit, oldipl, frame);
213 }
214
215 static int
216 sunxi_intc_match(device_t parent, cfdata_t cf, void *aux)
217 {
218 struct fdt_attach_args * const faa = aux;
219
220 return of_match_compatible(faa->faa_phandle, compatible);
221 }
222
223 static void
224 sunxi_intc_attach(device_t parent, device_t self, void *aux)
225 {
226 struct sunxi_intc_softc * const sc = device_private(self);
227 struct fdt_attach_args * const faa = aux;
228 const int phandle = faa->faa_phandle;
229 bus_addr_t addr;
230 bus_size_t size;
231 int error, i;
232
233 if (fdtbus_get_reg(phandle, 0, &addr, &size) != 0) {
234 aprint_error(": couldn't get registers\n");
235 return;
236 }
237
238 sc->sc_dev = self;
239 sc->sc_phandle = phandle;
240 sc->sc_bst = faa->faa_bst;
241 if (bus_space_map(sc->sc_bst, addr, size, 0, &sc->sc_bsh) != 0) {
242 aprint_error(": couldn't map registers\n");
243 return;
244 }
245
246 aprint_naive("\n");
247 aprint_normal(": Interrupt Controller\n");
248
249 /* Disable IRQs */
250 for (i = 0; i < INTC_MAX_GROUPS; i++) {
251 INTC_WRITE(sc, INTC_EN_REG(i), 0);
252 INTC_WRITE(sc, INTC_MASK_REG(i), ~0U);
253 INTC_WRITE(sc, INTC_IRQ_PEND_REG(i),
254 INTC_READ(sc, INTC_IRQ_PEND_REG(i)));
255 }
256 /* Disable user mode access to intc registers */
257 INTC_WRITE(sc, INTC_PROTECT_REG, INTC_PROTECT_EN);
258
259 sc->sc_pic.pic_ops = &sunxi_intc_picops;
260 sc->sc_pic.pic_maxsources = INTC_MAX_SOURCES;
261 snprintf(sc->sc_pic.pic_name, sizeof(sc->sc_pic.pic_name), "intc");
262 pic_add(&sc->sc_pic, 0);
263
264 error = fdtbus_register_interrupt_controller(self, phandle,
265 &sunxi_intc_fdt_funcs);
266 if (error) {
267 aprint_error_dev(self, "couldn't register with fdtbus: %d\n",
268 error);
269 return;
270 }
271
272 KASSERT(intc_softc == NULL);
273 intc_softc = sc;
274 arm_fdt_irq_set_handler(sunxi_intc_irq_handler);
275 }
276
277 CFATTACH_DECL_NEW(sunxi_intc, sizeof(struct sunxi_intc_softc),
278 sunxi_intc_match, sunxi_intc_attach, NULL, NULL);
279