imx23_icoll.c revision 1.2.2.3 1 1.2.2.2 yamt /* $Id: imx23_icoll.c,v 1.2.2.3 2013/01/23 00:05:41 yamt Exp $ */
2 1.2.2.2 yamt
3 1.2.2.2 yamt /*
4 1.2.2.2 yamt * Copyright (c) 2012 The NetBSD Foundation, Inc.
5 1.2.2.2 yamt * All rights reserved.
6 1.2.2.2 yamt *
7 1.2.2.2 yamt * This code is derived from software contributed to The NetBSD Foundation
8 1.2.2.2 yamt * by Petri Laakso.
9 1.2.2.2 yamt *
10 1.2.2.2 yamt * Redistribution and use in source and binary forms, with or without
11 1.2.2.2 yamt * modification, are permitted provided that the following conditions
12 1.2.2.2 yamt * are met:
13 1.2.2.2 yamt * 1. Redistributions of source code must retain the above copyright
14 1.2.2.2 yamt * notice, this list of conditions and the following disclaimer.
15 1.2.2.2 yamt * 2. Redistributions in binary form must reproduce the above copyright
16 1.2.2.2 yamt * notice, this list of conditions and the following disclaimer in the
17 1.2.2.2 yamt * documentation and/or other materials provided with the distribution.
18 1.2.2.2 yamt *
19 1.2.2.2 yamt * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 1.2.2.2 yamt * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 1.2.2.2 yamt * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 1.2.2.2 yamt * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 1.2.2.2 yamt * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 1.2.2.2 yamt * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 1.2.2.2 yamt * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 1.2.2.2 yamt * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 1.2.2.2 yamt * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 1.2.2.2 yamt * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 1.2.2.2 yamt * POSSIBILITY OF SUCH DAMAGE.
30 1.2.2.2 yamt */
31 1.2.2.2 yamt
32 1.2.2.2 yamt #include <sys/param.h>
33 1.2.2.2 yamt #include <sys/bus.h>
34 1.2.2.2 yamt #include <sys/cpu.h>
35 1.2.2.2 yamt #include <sys/device.h>
36 1.2.2.2 yamt #include <sys/errno.h>
37 1.2.2.2 yamt #include <sys/systm.h>
38 1.2.2.2 yamt
39 1.2.2.2 yamt #define _INTR_PRIVATE
40 1.2.2.2 yamt #include <arm/pic/picvar.h>
41 1.2.2.2 yamt
42 1.2.2.2 yamt #include <arm/imx/imx23_icollreg.h>
43 1.2.2.2 yamt #include <arm/imx/imx23var.h>
44 1.2.2.2 yamt
45 1.2.2.2 yamt #define ICOLL_SOFT_RST_LOOP 455 /* At least 1 us ... */
46 1.2.2.2 yamt #define ICOLL_READ(sc, reg) \
47 1.2.2.2 yamt bus_space_read_4(sc->sc_iot, sc->sc_hdl, (reg))
48 1.2.2.2 yamt #define ICOLL_WRITE(sc, reg, val) \
49 1.2.2.2 yamt bus_space_write_4(sc->sc_iot, sc->sc_hdl, (reg), (val))
50 1.2.2.2 yamt
51 1.2.2.2 yamt #define ICOLL_IRQ_REG_SIZE 0x10
52 1.2.2.2 yamt #define ICOLL_CLR_IRQ(sc, irq) \
53 1.2.2.2 yamt ICOLL_WRITE(sc, HW_ICOLL_INTERRUPT0_CLR + \
54 1.2.2.2 yamt (irq) * ICOLL_IRQ_REG_SIZE, \
55 1.2.2.2 yamt HW_ICOLL_INTERRUPT_ENABLE)
56 1.2.2.2 yamt #define ICOLL_SET_IRQ(sc, irq) \
57 1.2.2.2 yamt ICOLL_WRITE(sc, HW_ICOLL_INTERRUPT0_SET + \
58 1.2.2.2 yamt (irq) * ICOLL_IRQ_REG_SIZE, \
59 1.2.2.2 yamt HW_ICOLL_INTERRUPT_ENABLE)
60 1.2.2.2 yamt #define ICOLL_GET_PRIO(sc, irq) \
61 1.2.2.2 yamt __SHIFTOUT(ICOLL_READ(sc, HW_ICOLL_INTERRUPT0 + \
62 1.2.2.2 yamt (irq) * ICOLL_IRQ_REG_SIZE), \
63 1.2.2.2 yamt HW_ICOLL_INTERRUPT_PRIORITY)
64 1.2.2.2 yamt
65 1.2.2.2 yamt #define PICTOSOFTC(pic) \
66 1.2.2.2 yamt ((struct icoll_softc *)((char *)(pic) - \
67 1.2.2.2 yamt offsetof(struct icoll_softc, sc_pic)))
68 1.2.2.2 yamt
69 1.2.2.2 yamt /*
70 1.2.2.2 yamt * pic callbacks.
71 1.2.2.2 yamt */
72 1.2.2.2 yamt static void icoll_unblock_irqs(struct pic_softc *, size_t, uint32_t);
73 1.2.2.2 yamt static void icoll_block_irqs(struct pic_softc *, size_t, uint32_t);
74 1.2.2.2 yamt static int icoll_find_pending_irqs(struct pic_softc *);
75 1.2.2.2 yamt static void icoll_establish_irq(struct pic_softc *, struct intrsource *);
76 1.2.2.2 yamt static void icoll_source_name(struct pic_softc *, int, char *, size_t);
77 1.2.2.2 yamt static void icoll_set_priority(struct pic_softc *, int);
78 1.2.2.2 yamt
79 1.2.2.2 yamt /*
80 1.2.2.2 yamt * autoconf(9) callbacks.
81 1.2.2.2 yamt */
82 1.2.2.2 yamt static int icoll_match(device_t, cfdata_t, void *);
83 1.2.2.2 yamt static void icoll_attach(device_t, device_t, void *);
84 1.2.2.2 yamt static int icoll_activate(device_t, enum devact);
85 1.2.2.2 yamt
86 1.2.2.2 yamt /*
87 1.2.2.2 yamt * ARM interrupt handler.
88 1.2.2.2 yamt */
89 1.2.2.2 yamt void imx23_intr_dispatch(struct clockframe *);
90 1.2.2.2 yamt
91 1.2.2.2 yamt const static struct pic_ops icoll_pic_ops = {
92 1.2.2.2 yamt .pic_unblock_irqs = icoll_unblock_irqs,
93 1.2.2.2 yamt .pic_block_irqs = icoll_block_irqs,
94 1.2.2.2 yamt .pic_find_pending_irqs = icoll_find_pending_irqs,
95 1.2.2.2 yamt .pic_establish_irq = icoll_establish_irq,
96 1.2.2.2 yamt .pic_source_name = icoll_source_name,
97 1.2.2.2 yamt .pic_set_priority = icoll_set_priority
98 1.2.2.2 yamt };
99 1.2.2.2 yamt
100 1.2.2.2 yamt struct icoll_softc {
101 1.2.2.2 yamt device_t sc_dev;
102 1.2.2.2 yamt struct pic_softc sc_pic;
103 1.2.2.2 yamt bus_space_tag_t sc_iot;
104 1.2.2.2 yamt bus_space_handle_t sc_hdl;
105 1.2.2.2 yamt };
106 1.2.2.2 yamt
107 1.2.2.2 yamt /* For IRQ handler. */
108 1.2.2.2 yamt static struct icoll_softc *icoll_sc;
109 1.2.2.2 yamt
110 1.2.2.2 yamt /*
111 1.2.2.2 yamt * Private to driver.
112 1.2.2.2 yamt */
113 1.2.2.2 yamt static void icoll_reset(struct icoll_softc *);
114 1.2.2.2 yamt
115 1.2.2.2 yamt CFATTACH_DECL3_NEW(icoll,
116 1.2.2.2 yamt sizeof(struct icoll_softc),
117 1.2.2.2 yamt icoll_match,
118 1.2.2.2 yamt icoll_attach,
119 1.2.2.2 yamt NULL,
120 1.2.2.2 yamt icoll_activate,
121 1.2.2.2 yamt NULL,
122 1.2.2.2 yamt NULL,
123 1.2.2.2 yamt 0);
124 1.2.2.2 yamt
125 1.2.2.2 yamt /*
126 1.2.2.2 yamt * ARM interrupt handler.
127 1.2.2.2 yamt */
128 1.2.2.2 yamt void
129 1.2.2.2 yamt imx23_intr_dispatch(struct clockframe *frame)
130 1.2.2.2 yamt {
131 1.2.2.2 yamt struct cpu_info * const ci = curcpu();
132 1.2.2.2 yamt struct pic_softc *pic_sc;
133 1.2.2.2 yamt int saved_spl;
134 1.2.2.2 yamt uint8_t irq;
135 1.2.2.2 yamt uint8_t prio;
136 1.2.2.2 yamt
137 1.2.2.2 yamt pic_sc = &icoll_sc->sc_pic;
138 1.2.2.2 yamt
139 1.2.2.2 yamt ci->ci_data.cpu_nintr++;
140 1.2.2.2 yamt
141 1.2.2.2 yamt /* Save current spl. */
142 1.2.2.2 yamt saved_spl = curcpl();
143 1.2.2.2 yamt
144 1.2.2.2 yamt /* IRQ to be handled. */
145 1.2.2.2 yamt irq = __SHIFTOUT(ICOLL_READ(icoll_sc, HW_ICOLL_STAT),
146 1.2.2.2 yamt HW_ICOLL_STAT_VECTOR_NUMBER);
147 1.2.2.2 yamt
148 1.2.2.2 yamt /* Save IRQ's priority. Acknowledge it later. */
149 1.2.2.2 yamt prio = ICOLL_GET_PRIO(icoll_sc, irq);
150 1.2.2.2 yamt
151 1.2.2.2 yamt /*
152 1.2.2.2 yamt * Notify ICOLL to deassert IRQ before re-enabling the IRQ's.
153 1.2.2.2 yamt * This is done by writing anything to HW_ICOLL_VECTOR.
154 1.2.2.2 yamt */
155 1.2.2.2 yamt ICOLL_WRITE(icoll_sc, HW_ICOLL_VECTOR,
156 1.2.2.2 yamt __SHIFTIN(0x3fffffff, HW_ICOLL_VECTOR_IRQVECTOR));
157 1.2.2.2 yamt
158 1.2.2.2 yamt /* Bogus IRQ. */
159 1.2.2.2 yamt if (irq == 0x7f) {
160 1.2.2.2 yamt cpsie(I32_bit);
161 1.2.2.2 yamt ICOLL_WRITE(icoll_sc, HW_ICOLL_LEVELACK, (1<<prio));
162 1.2.2.2 yamt cpsid(I32_bit);
163 1.2.2.2 yamt return;
164 1.2.2.2 yamt }
165 1.2.2.2 yamt
166 1.2.2.2 yamt /* Raise the spl to the level of the IRQ. */
167 1.2.2.2 yamt if (pic_sc->pic_sources[irq]->is_ipl > ci->ci_cpl)
168 1.2.2.2 yamt saved_spl = _splraise(pic_sc->pic_sources[irq]->is_ipl);
169 1.2.2.2 yamt
170 1.2.2.2 yamt /* Call the handler registered for the IRQ. */
171 1.2.2.2 yamt cpsie(I32_bit);
172 1.2.2.2 yamt pic_dispatch(pic_sc->pic_sources[irq], frame);
173 1.2.2.2 yamt
174 1.2.2.2 yamt /*
175 1.2.2.2 yamt * Acknowledge the IRQ by writing its priority to HW_ICOLL_LEVELACK.
176 1.2.2.2 yamt * Interrupts should be enabled.
177 1.2.2.2 yamt */
178 1.2.2.2 yamt ICOLL_WRITE(icoll_sc, HW_ICOLL_LEVELACK, (1<<prio));
179 1.2.2.2 yamt cpsid(I32_bit);
180 1.2.2.2 yamt
181 1.2.2.2 yamt /* Restore the saved spl. */
182 1.2.2.2 yamt splx(saved_spl);
183 1.2.2.2 yamt
184 1.2.2.2 yamt return;
185 1.2.2.2 yamt }
186 1.2.2.2 yamt
187 1.2.2.2 yamt /*
188 1.2.2.2 yamt * pic callbacks.
189 1.2.2.2 yamt */
190 1.2.2.2 yamt static void
191 1.2.2.2 yamt icoll_unblock_irqs(struct pic_softc *pic, size_t irq_base, uint32_t irq_mask)
192 1.2.2.2 yamt {
193 1.2.2.2 yamt struct icoll_softc *sc = PICTOSOFTC(pic);
194 1.2.2.2 yamt uint8_t b;
195 1.2.2.2 yamt
196 1.2.2.2 yamt for (;;) {
197 1.2.2.2 yamt b = ffs(irq_mask);
198 1.2.2.2 yamt if (b == 0) break;
199 1.2.2.2 yamt b--; /* Zero based index. */
200 1.2.2.2 yamt ICOLL_SET_IRQ(sc, irq_base + b);
201 1.2.2.2 yamt irq_mask &= ~(1<<b);
202 1.2.2.2 yamt }
203 1.2.2.2 yamt
204 1.2.2.2 yamt return;
205 1.2.2.2 yamt }
206 1.2.2.2 yamt
207 1.2.2.2 yamt static void
208 1.2.2.2 yamt icoll_block_irqs(struct pic_softc *pic, size_t irq_base, uint32_t irq_mask)
209 1.2.2.2 yamt {
210 1.2.2.2 yamt struct icoll_softc *sc = PICTOSOFTC(pic);
211 1.2.2.2 yamt uint8_t b;
212 1.2.2.2 yamt
213 1.2.2.2 yamt for (;;) {
214 1.2.2.2 yamt b = ffs(irq_mask);
215 1.2.2.2 yamt if (b == 0) break;
216 1.2.2.2 yamt b--; /* Zero based index. */
217 1.2.2.2 yamt ICOLL_CLR_IRQ(sc, irq_base + b);
218 1.2.2.2 yamt irq_mask &= ~(1<<b);
219 1.2.2.2 yamt }
220 1.2.2.2 yamt
221 1.2.2.2 yamt return;
222 1.2.2.2 yamt }
223 1.2.2.2 yamt
224 1.2.2.2 yamt static int
225 1.2.2.2 yamt icoll_find_pending_irqs(struct pic_softc *pic)
226 1.2.2.2 yamt {
227 1.2.2.2 yamt return 0; /* ICOLL HW doesn't provide list of pending interrupts. */
228 1.2.2.2 yamt }
229 1.2.2.2 yamt
230 1.2.2.2 yamt static void
231 1.2.2.2 yamt icoll_establish_irq(struct pic_softc *pic, struct intrsource *is)
232 1.2.2.2 yamt {
233 1.2.2.2 yamt return; /* Nothing to establish. */
234 1.2.2.2 yamt }
235 1.2.2.2 yamt
236 1.2.2.2 yamt static void
237 1.2.2.2 yamt icoll_source_name(struct pic_softc *pic, int irq, char *is_source, size_t size)
238 1.2.2.2 yamt {
239 1.2.2.2 yamt snprintf(is_source, size, "irq %d", irq);
240 1.2.2.2 yamt }
241 1.2.2.2 yamt
242 1.2.2.2 yamt /*
243 1.2.2.2 yamt * Set new interrupt priority level by enabling or disabling IRQ's.
244 1.2.2.2 yamt */
245 1.2.2.2 yamt static void
246 1.2.2.2 yamt icoll_set_priority(struct pic_softc *pic, int newipl)
247 1.2.2.2 yamt {
248 1.2.2.2 yamt struct icoll_softc *sc = PICTOSOFTC(pic);
249 1.2.2.2 yamt struct intrsource *is;
250 1.2.2.2 yamt int i;
251 1.2.2.2 yamt
252 1.2.2.2 yamt for (i = 0; i < pic->pic_maxsources; i++) {
253 1.2.2.2 yamt is = pic->pic_sources[i];
254 1.2.2.2 yamt if (is == NULL)
255 1.2.2.2 yamt continue;
256 1.2.2.2 yamt if (is->is_ipl > newipl)
257 1.2.2.2 yamt ICOLL_SET_IRQ(sc, pic->pic_irqbase + is->is_irq);
258 1.2.2.2 yamt else
259 1.2.2.2 yamt ICOLL_CLR_IRQ(sc, pic->pic_irqbase + is->is_irq);
260 1.2.2.2 yamt }
261 1.2.2.2 yamt }
262 1.2.2.2 yamt
263 1.2.2.2 yamt /*
264 1.2.2.2 yamt * autoconf(9) callbacks.
265 1.2.2.2 yamt */
266 1.2.2.2 yamt static int
267 1.2.2.2 yamt icoll_match(device_t parent, cfdata_t match, void *aux)
268 1.2.2.2 yamt {
269 1.2.2.2 yamt struct apb_attach_args *aa = aux;
270 1.2.2.2 yamt
271 1.2.2.2 yamt if ((aa->aa_addr == HW_ICOLL_BASE) && (aa->aa_size == HW_ICOLL_SIZE))
272 1.2.2.2 yamt return 1;
273 1.2.2.2 yamt
274 1.2.2.2 yamt return 0;
275 1.2.2.2 yamt }
276 1.2.2.2 yamt
277 1.2.2.2 yamt static void
278 1.2.2.2 yamt icoll_attach(device_t parent, device_t self, void *aux)
279 1.2.2.2 yamt {
280 1.2.2.2 yamt static int icoll_attached = 0;
281 1.2.2.2 yamt struct icoll_softc *sc = device_private(self);
282 1.2.2.2 yamt struct apb_attach_args *aa = aux;
283 1.2.2.2 yamt
284 1.2.2.2 yamt if (icoll_attached)
285 1.2.2.2 yamt return;
286 1.2.2.2 yamt
287 1.2.2.2 yamt icoll_sc = sc;
288 1.2.2.2 yamt
289 1.2.2.2 yamt sc->sc_dev = self;
290 1.2.2.2 yamt sc->sc_iot = aa->aa_iot;
291 1.2.2.2 yamt
292 1.2.2.2 yamt sc->sc_pic.pic_maxsources = IRQ_LAST + 1;
293 1.2.2.2 yamt sc->sc_pic.pic_ops = &icoll_pic_ops;
294 1.2.2.2 yamt strlcpy(sc->sc_pic.pic_name, device_xname(self),
295 1.2.2.2 yamt sizeof(sc->sc_pic.pic_name));
296 1.2.2.2 yamt
297 1.2.2.2 yamt if (bus_space_map(sc->sc_iot,
298 1.2.2.2 yamt aa->aa_addr, aa->aa_size, 0, &(sc->sc_hdl))) {
299 1.2.2.2 yamt aprint_error_dev(sc->sc_dev, "unable to map bus space\n");
300 1.2.2.2 yamt return;
301 1.2.2.2 yamt }
302 1.2.2.2 yamt
303 1.2.2.2 yamt icoll_reset(sc);
304 1.2.2.2 yamt pic_add(&sc->sc_pic, 0);
305 1.2.2.2 yamt aprint_normal("\n");
306 1.2.2.2 yamt icoll_attached = 1;
307 1.2.2.2 yamt
308 1.2.2.2 yamt return;
309 1.2.2.2 yamt }
310 1.2.2.2 yamt
311 1.2.2.2 yamt static int
312 1.2.2.2 yamt icoll_activate(device_t self, enum devact act)
313 1.2.2.2 yamt {
314 1.2.2.2 yamt return EOPNOTSUPP;
315 1.2.2.2 yamt }
316 1.2.2.2 yamt
317 1.2.2.2 yamt /*
318 1.2.2.2 yamt * Reset the ICOLL block.
319 1.2.2.2 yamt *
320 1.2.2.3 yamt * Inspired by i.MX23 RM "39.3.10 Correct Way to Soft Reset a Block"
321 1.2.2.2 yamt */
322 1.2.2.2 yamt static void
323 1.2.2.2 yamt icoll_reset(struct icoll_softc *sc)
324 1.2.2.2 yamt {
325 1.2.2.2 yamt unsigned int loop;
326 1.2.2.2 yamt
327 1.2.2.2 yamt /*
328 1.2.2.2 yamt * Prepare for soft-reset by making sure that SFTRST is not currently
329 1.2.2.2 yamt * asserted. Also clear CLKGATE so we can wait for its assertion below.
330 1.2.2.2 yamt */
331 1.2.2.2 yamt ICOLL_WRITE(sc, HW_ICOLL_CTRL_CLR, HW_ICOLL_CTRL_SFTRST);
332 1.2.2.2 yamt
333 1.2.2.2 yamt /* Wait at least a microsecond for SFTRST to deassert. */
334 1.2.2.2 yamt loop = 0;
335 1.2.2.2 yamt while ((ICOLL_READ(sc, HW_ICOLL_CTRL) & HW_ICOLL_CTRL_SFTRST) ||
336 1.2.2.2 yamt (loop < ICOLL_SOFT_RST_LOOP)) {
337 1.2.2.2 yamt loop++;
338 1.2.2.2 yamt }
339 1.2.2.2 yamt
340 1.2.2.2 yamt /* Clear CLKGATE so we can wait for its assertion below. */
341 1.2.2.2 yamt ICOLL_WRITE(sc, HW_ICOLL_CTRL_CLR, HW_ICOLL_CTRL_CLKGATE);
342 1.2.2.2 yamt
343 1.2.2.2 yamt /* Soft-reset the block. */
344 1.2.2.2 yamt ICOLL_WRITE(sc, HW_ICOLL_CTRL_SET, HW_ICOLL_CTRL_SFTRST);
345 1.2.2.2 yamt
346 1.2.2.2 yamt /* Wait until clock is in the gated state. */
347 1.2.2.2 yamt while (!(ICOLL_READ(sc, HW_ICOLL_CTRL) & HW_ICOLL_CTRL_CLKGATE));
348 1.2.2.2 yamt
349 1.2.2.2 yamt /* Bring block out of reset. */
350 1.2.2.2 yamt ICOLL_WRITE(sc, HW_ICOLL_CTRL_CLR, HW_ICOLL_CTRL_SFTRST);
351 1.2.2.2 yamt
352 1.2.2.2 yamt loop = 0;
353 1.2.2.2 yamt while ((ICOLL_READ(sc, HW_ICOLL_CTRL) & HW_ICOLL_CTRL_SFTRST) ||
354 1.2.2.2 yamt (loop < ICOLL_SOFT_RST_LOOP)) {
355 1.2.2.2 yamt loop++;
356 1.2.2.2 yamt }
357 1.2.2.2 yamt
358 1.2.2.2 yamt ICOLL_WRITE(sc, HW_ICOLL_CTRL_CLR, HW_ICOLL_CTRL_CLKGATE);
359 1.2.2.2 yamt
360 1.2.2.2 yamt /* Wait until clock is in the NON-gated state. */
361 1.2.2.2 yamt while (ICOLL_READ(sc, HW_ICOLL_CTRL) & HW_ICOLL_CTRL_CLKGATE);
362 1.2.2.2 yamt
363 1.2.2.2 yamt return;
364 1.2.2.2 yamt }
365