xref: /netbsd-src/sys/arch/arm/cortex/a9tmr.c (revision a4ddc2c8fb9af816efe3b1c375a5530aef0e89e9)
1 /*	$NetBSD: a9tmr.c,v 1.4 2012/11/29 17:36:56 matt Exp $	*/
2 
3 /*-
4  * Copyright (c) 2012 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Matt Thomas
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 #include <sys/cdefs.h>
33 __KERNEL_RCSID(0, "$NetBSD: a9tmr.c,v 1.4 2012/11/29 17:36:56 matt Exp $");
34 
35 #include <sys/param.h>
36 #include <sys/bus.h>
37 #include <sys/device.h>
38 #include <sys/intr.h>
39 #include <sys/kernel.h>
40 #include <sys/proc.h>
41 #include <sys/systm.h>
42 #include <sys/timetc.h>
43 
44 #include <prop/proplib.h>
45 
46 #include <arm/cortex/a9tmr_reg.h>
47 #include <arm/cortex/a9tmr_var.h>
48 
49 #include <arm/cortex/mpcore_var.h>
50 
51 static int a9tmr_match(device_t, cfdata_t, void *);
52 static void a9tmr_attach(device_t, device_t, void *);
53 
54 static int clockhandler(void *);
55 
56 static u_int a9tmr_get_timecount(struct timecounter *);
57 
58 static struct a9tmr_softc a9tmr_sc;
59 
60 static struct timecounter a9tmr_timecounter = {
61 	.tc_get_timecount = a9tmr_get_timecount,
62 	.tc_poll_pps = 0,
63 	.tc_counter_mask = ~0u,
64 	.tc_frequency = 0,			/* set by cpu_initclocks() */
65 	.tc_name = NULL,			/* set by attach */
66 	.tc_quality = 500,
67 	.tc_priv = &a9tmr_sc,
68 	.tc_next = NULL,
69 };
70 
71 CFATTACH_DECL_NEW(a9tmr, 0, a9tmr_match, a9tmr_attach, NULL, NULL);
72 
73 static inline uint32_t
74 a9tmr_global_read(struct a9tmr_softc *sc, bus_size_t o)
75 {
76 	return bus_space_read_4(sc->sc_memt, sc->sc_global_memh, o);
77 }
78 
79 static inline void
80 a9tmr_global_write(struct a9tmr_softc *sc, bus_size_t o, uint32_t v)
81 {
82 	bus_space_write_4(sc->sc_memt, sc->sc_global_memh, o, v);
83 }
84 
85 
86 /* ARGSUSED */
87 static int
88 a9tmr_match(device_t parent, cfdata_t cf, void *aux)
89 {
90 	struct mpcore_attach_args * const mpcaa = aux;
91 
92 	if (a9tmr_sc.sc_dev != NULL)
93 		return 0;
94 
95 	if (!CPU_ID_CORTEX_A9_P(curcpu()->ci_arm_cpuid))
96 		return 0;
97 
98 	if (strcmp(mpcaa->mpcaa_name, cf->cf_name) != 0)
99 		return 0;
100 
101 	/*
102 	 * This isn't present on UP A9s (since CBAR isn't present).
103 	 */
104 	uint32_t mpidr = armreg_mpidr_read();
105 	if (mpidr == 0 || (mpidr & MPIDR_U))
106 		return 0;
107 
108 	return 1;
109 }
110 
111 static void
112 a9tmr_attach(device_t parent, device_t self, void *aux)
113 {
114         struct a9tmr_softc *sc = &a9tmr_sc;
115 	struct mpcore_attach_args * const mpcaa = aux;
116 	prop_dictionary_t dict = device_properties(self);
117 	char freqbuf[sizeof("XXX SHz")];
118 
119 	/*
120 	 * This runs at the ARM PERIPHCLOCK which should be 1/2 of the CPU clock.
121 	 * The MD code should have setup our frequency for us.
122 	 */
123 	prop_number_t pn = prop_dictionary_get(dict, "frequency");
124 	KASSERT(pn != NULL);
125 	sc->sc_freq = prop_number_unsigned_integer_value(pn);
126 
127 	humanize_number(freqbuf, sizeof(freqbuf), sc->sc_freq, "Hz", 1000);
128 
129 	aprint_naive("\n");
130 	aprint_normal(": A9 Global 64-bit Timer (%s)\n", freqbuf);
131 
132 	self->dv_private = sc;
133 	sc->sc_dev = self;
134 	sc->sc_memt = mpcaa->mpcaa_memt;
135 	sc->sc_memh = mpcaa->mpcaa_memh;
136 
137 	evcnt_attach_dynamic(&sc->sc_ev_missing_ticks, EVCNT_TYPE_MISC, NULL,
138 	    device_xname(self), "missing interrupts");
139 
140 	bus_space_subregion(sc->sc_memt, sc->sc_memh,
141 	    TMR_GLOBAL_BASE, TMR_GLOBAL_BASE, &sc->sc_global_memh);
142 	bus_space_subregion(sc->sc_memt, sc->sc_memh,
143 	    TMR_PRIVATE_BASE, TMR_PRIVATE_SIZE, &sc->sc_private_memh);
144 	bus_space_subregion(sc->sc_memt, sc->sc_memh,
145 	    TMR_WDOG_BASE, TMR_WDOG_SIZE, &sc->sc_wdog_memh);
146 
147 	sc->sc_global_ih = intr_establish(IRQ_A9TMR_PPI_GTIMER, IPL_CLOCK,
148 	    IST_EDGE, clockhandler, NULL);
149 	if (sc->sc_global_ih == NULL)
150 		panic("%s: unable to register timer interrupt", __func__);
151 	aprint_normal_dev(sc->sc_dev, "interrupting on irq %d\n",
152 	    IRQ_A9TMR_PPI_GTIMER);
153 }
154 
155 static inline uint64_t
156 a9tmr_gettime(struct a9tmr_softc *sc)
157 {
158 	uint32_t lo, hi;
159 
160 	do {
161 		hi = a9tmr_global_read(sc, TMR_GBL_CTR_U);
162 		lo = a9tmr_global_read(sc, TMR_GBL_CTR_L);
163 	} while (hi != a9tmr_global_read(sc, TMR_GBL_CTR_U));
164 
165 	return ((uint64_t)hi << 32) | lo;
166 }
167 
168 void
169 a9tmr_init_cpu_clock(struct cpu_info *ci)
170 {
171 	struct a9tmr_softc * const sc = &a9tmr_sc;
172 	uint64_t now = a9tmr_gettime(sc);
173 
174 	KASSERT(ci == curcpu());
175 
176 	ci->ci_lastintr = now;
177 
178 	a9tmr_global_write(sc, TMR_GBL_AUTOINC, sc->sc_autoinc);
179 
180 	/*
181 	 * To update the compare register we have to disable comparisions first.
182 	 */
183 	uint32_t ctl = a9tmr_global_read(sc, TMR_GBL_CTL);
184 	if (ctl & TMR_GBL_CTL_CMP_ENABLE) {
185 		a9tmr_global_write(sc, TMR_GBL_CTL, ctl & ~TMR_GBL_CTL_CMP_ENABLE);
186 	}
187 
188 	/*
189 	 * Schedule the next interrupt.
190 	 */
191 	now += sc->sc_autoinc;
192 	a9tmr_global_write(sc, TMR_GBL_CMP_L, (uint32_t) now);
193 	a9tmr_global_write(sc, TMR_GBL_CMP_H, (uint32_t) (now >> 32));
194 
195 	/*
196 	 * Re-enable the comparator and now enable interrupts.
197 	 */
198 	a9tmr_global_write(sc, TMR_GBL_INT, 1);	/* clear interrupt pending */
199 	ctl |= TMR_GBL_CTL_CMP_ENABLE | TMR_GBL_CTL_INT_ENABLE | TMR_GBL_CTL_AUTO_INC | TMR_CTL_ENABLE;
200 	a9tmr_global_write(sc, TMR_GBL_CTL, ctl);
201 #if 0
202 	printf("%s: %s: ctl %#x autoinc %u cmp %#x%08x now %#"PRIx64"\n",
203 	    __func__, ci->ci_data.cpu_name,
204 	    a9tmr_global_read(sc, TMR_GBL_CTL),
205 	    a9tmr_global_read(sc, TMR_GBL_AUTOINC),
206 	    a9tmr_global_read(sc, TMR_GBL_CMP_H),
207 	    a9tmr_global_read(sc, TMR_GBL_CMP_L),
208 	    a9tmr_gettime(sc));
209 
210 	int s = splsched();
211 	uint64_t when = now;
212 	u_int n = 0;
213 	while ((now = a9tmr_gettime(sc)) < when) {
214 		/* spin */
215 		n++;
216 		KASSERTMSG(n <= sc->sc_autoinc,
217 		    "spun %u times but only %"PRIu64" has passed",
218 		    n, when - now);
219 	}
220 	printf("%s: %s: status %#x cmp %#x%08x now %#"PRIx64"\n",
221 	    __func__, ci->ci_data.cpu_name,
222 	    a9tmr_global_read(sc, TMR_GBL_INT),
223 	    a9tmr_global_read(sc, TMR_GBL_CMP_H),
224 	    a9tmr_global_read(sc, TMR_GBL_CMP_L),
225 	    a9tmr_gettime(sc));
226 	splx(s);
227 #elif 0
228 	delay(1000000 / hz + 1000);
229 #endif
230 }
231 
232 void
233 cpu_initclocks(void)
234 {
235 	struct a9tmr_softc * const sc = &a9tmr_sc;
236 
237 	KASSERT(sc->sc_dev != NULL);
238 	KASSERT(sc->sc_freq != 0);
239 
240 	sc->sc_autoinc = sc->sc_freq / hz;
241 
242 	a9tmr_init_cpu_clock(curcpu());
243 
244 	a9tmr_timecounter.tc_name = device_xname(sc->sc_dev);
245 	a9tmr_timecounter.tc_frequency = sc->sc_freq;
246 
247 	tc_init(&a9tmr_timecounter);
248 }
249 
250 void
251 a9tmr_delay(unsigned int n)
252 {
253 	struct a9tmr_softc * const sc = &a9tmr_sc;
254 
255 	KASSERT(sc != NULL);
256 
257 	uint32_t freq = sc->sc_freq ? sc->sc_freq : curcpu()->ci_data.cpu_cc_freq / 2;
258 	KASSERT(freq != 0);
259 
260 	/*
261 	 * not quite divide by 1000000 but close enough
262 	 * (higher by 1.3% which means we wait 1.3% longer).
263 	 */
264 	const uint64_t incr_per_us = (freq >> 20) + (freq >> 24);
265 
266 	const uint64_t delta = n * incr_per_us;
267 	const uint64_t base = a9tmr_gettime(sc);
268 	const uint64_t finish = base + delta;
269 
270 	while (a9tmr_gettime(sc) < finish) {
271 		/* spin */
272 	}
273 }
274 
275 /*
276  * clockhandler:
277  *
278  *	Handle the hardclock interrupt.
279  */
280 static int
281 clockhandler(void *arg)
282 {
283 	struct clockframe * const cf = arg;
284 	struct a9tmr_softc * const sc = &a9tmr_sc;
285 	struct cpu_info * const ci = curcpu();
286 
287 	const uint64_t now = a9tmr_gettime(sc);
288 	uint64_t delta = now - ci->ci_lastintr;
289 
290 	a9tmr_global_write(sc, TMR_GBL_INT, 1);	// Ack the interrupt
291 
292 #if 0
293 	printf("%s(%p): %s: now %#"PRIx64" delta %"PRIu64"\n",
294 	     __func__, cf, ci->ci_data.cpu_name, now, delta);
295 #endif
296 	KASSERTMSG(delta > sc->sc_autoinc / 100,
297 	    "%s: interrupting too quickly (delta=%"PRIu64")",
298 	    ci->ci_data.cpu_name, delta);
299 
300 	ci->ci_lastintr = now;
301 
302 	hardclock(cf);
303 
304 #if 0
305 	/*
306 	 * Try to make up up to a seconds amount of missed clock interrupts
307 	 */
308 	u_int ticks = hz;
309 	for (delta -= sc->sc_autoinc;
310 	     ticks > 0 && delta >= sc->sc_autoinc;
311 	     delta -= sc->sc_autoinc, ticks--) {
312 		hardclock(cf);
313 	}
314 #else
315 	if (delta > sc->sc_autoinc)
316 		sc->sc_ev_missing_ticks.ev_count += delta / sc->sc_autoinc;
317 #endif
318 
319 	return 1;
320 }
321 
322 void
323 setstatclockrate(int newhz)
324 {
325 }
326 
327 static u_int
328 a9tmr_get_timecount(struct timecounter *tc)
329 {
330 	struct a9tmr_softc * const sc = tc->tc_priv;
331 
332 	return (u_int) (a9tmr_gettime(sc));
333 }
334