1 // SPDX-License-Identifier: GPL-2.0+
3 #include <linux/clocksource.h>
4 #include <linux/clockchips.h>
5 #include <linux/cpuhotplug.h>
6 #include <linux/interrupt.h>
8 #include <linux/iopoll.h>
11 #include <linux/of_address.h>
12 #include <linux/of_irq.h>
13 #include <linux/sched_clock.h>
15 #include <linux/clk/clk-conf.h>
17 #include <clocksource/timer-ti-dm.h>
18 #include <dt-bindings/bus/ti-sysc.h>
20 /* For type1, set SYSC_OMAP2_CLOCKACTIVITY for fck off on idle, l4 clock on */
21 #define DMTIMER_TYPE1_ENABLE ((1 << 9) | (SYSC_IDLE_SMART << 3) | \
22 SYSC_OMAP2_ENAWAKEUP | SYSC_OMAP2_AUTOIDLE)
23 #define DMTIMER_TYPE1_DISABLE (SYSC_OMAP2_SOFTRESET | SYSC_OMAP2_AUTOIDLE)
24 #define DMTIMER_TYPE2_ENABLE (SYSC_IDLE_SMART_WKUP << 2)
25 #define DMTIMER_RESET_WAIT 100000
27 #define DMTIMER_INST_DONT_CARE ~0U
29 static int counter_32k;
30 static u32 clocksource;
31 static u32 clockevent;
34 * Subset of the timer registers we use. Note that the register offsets
35 * depend on the timer revision detected.
37 struct dmtimer_systimer {
53 struct dmtimer_clockevent {
54 struct clock_event_device dev;
55 struct dmtimer_systimer t;
59 struct dmtimer_clocksource {
60 struct clocksource dev;
61 struct dmtimer_systimer t;
65 /* Assumes v1 ip if bits [31:16] are zero */
66 static bool dmtimer_systimer_revision1(struct dmtimer_systimer *t)
68 u32 tidr = readl_relaxed(t->base);
73 static void dmtimer_systimer_enable(struct dmtimer_systimer *t)
77 if (dmtimer_systimer_revision1(t))
78 val = DMTIMER_TYPE1_ENABLE;
80 val = DMTIMER_TYPE2_ENABLE;
82 writel_relaxed(val, t->base + t->sysc);
85 static void dmtimer_systimer_disable(struct dmtimer_systimer *t)
87 if (!dmtimer_systimer_revision1(t))
90 writel_relaxed(DMTIMER_TYPE1_DISABLE, t->base + t->sysc);
93 static int __init dmtimer_systimer_type1_reset(struct dmtimer_systimer *t)
95 void __iomem *syss = t->base + OMAP_TIMER_V1_SYS_STAT_OFFSET;
99 dmtimer_systimer_enable(t);
100 writel_relaxed(BIT(1) | BIT(2), t->base + t->ifctrl);
101 ret = readl_poll_timeout_atomic(syss, l, l & BIT(0), 100,
107 /* Note we must use io_base instead of func_base for type2 OCP regs */
108 static int __init dmtimer_systimer_type2_reset(struct dmtimer_systimer *t)
110 void __iomem *sysc = t->base + t->sysc;
113 dmtimer_systimer_enable(t);
114 l = readl_relaxed(sysc);
116 writel_relaxed(l, sysc);
118 return readl_poll_timeout_atomic(sysc, l, !(l & BIT(0)), 100,
122 static int __init dmtimer_systimer_reset(struct dmtimer_systimer *t)
126 if (dmtimer_systimer_revision1(t))
127 ret = dmtimer_systimer_type1_reset(t);
129 ret = dmtimer_systimer_type2_reset(t);
131 pr_err("%s failed with %i\n", __func__, ret);
139 static const struct of_device_id counter_match_table[] = {
140 { .compatible = "ti,omap-counter32k" },
145 * Check if the SoC als has a usable working 32 KiHz counter. The 32 KiHz
146 * counter is handled by timer-ti-32k, but we need to detect it as it
147 * affects the preferred dmtimer system timer configuration. There is
148 * typically no use for a dmtimer clocksource if the 32 KiHz counter is
149 * present, except on am437x as described below.
151 static void __init dmtimer_systimer_check_counter32k(void)
153 struct device_node *np;
158 np = of_find_matching_node(NULL, counter_match_table);
160 counter_32k = -ENODEV;
165 if (of_device_is_available(np))
168 counter_32k = -ENODEV;
173 static const struct of_device_id dmtimer_match_table[] = {
174 { .compatible = "ti,omap2420-timer", },
175 { .compatible = "ti,omap3430-timer", },
176 { .compatible = "ti,omap4430-timer", },
177 { .compatible = "ti,omap5430-timer", },
178 { .compatible = "ti,am335x-timer", },
179 { .compatible = "ti,am335x-timer-1ms", },
180 { .compatible = "ti,dm814-timer", },
181 { .compatible = "ti,dm816-timer", },
186 * Checks that system timers are configured to not reset and idle during
187 * the generic timer-ti-dm device driver probe. And that the system timer
188 * source clocks are properly configured. Also, let's not hog any DSP and
189 * PWM capable timers unnecessarily as system timers.
191 static bool __init dmtimer_is_preferred(struct device_node *np)
193 if (!of_device_is_available(np))
196 if (!of_property_read_bool(np->parent,
197 "ti,no-reset-on-init"))
200 if (!of_property_read_bool(np->parent, "ti,no-idle"))
203 /* Secure gptimer12 is always clocked with a fixed source */
204 if (!of_property_read_bool(np, "ti,timer-secure")) {
205 if (!of_property_read_bool(np, "assigned-clocks"))
208 if (!of_property_read_bool(np, "assigned-clock-parents"))
212 if (of_property_read_bool(np, "ti,timer-dsp"))
215 if (of_property_read_bool(np, "ti,timer-pwm"))
222 * Finds the first available usable always-on timer, and assigns it to either
223 * clockevent or clocksource depending if the counter_32k is available on the
226 * Some omap3 boards with unreliable oscillator must not use the counter_32k
227 * or dmtimer1 with 32 KiHz source. Additionally, the boards with unreliable
228 * oscillator should really set counter_32k as disabled, and delete dmtimer1
229 * ti,always-on property, but let's not count on it. For these quirky cases,
230 * we prefer using the always-on secure dmtimer12 with the internal 32 KiHz
231 * clock as the clocksource, and any available dmtimer as clockevent.
233 * For am437x, we are using am335x style dmtimer clocksource. It is unclear
234 * if this quirk handling is really needed, but let's change it separately
235 * based on testing as it might cause side effects.
237 static void __init dmtimer_systimer_assign_alwon(void)
239 struct device_node *np;
241 bool quirk_unreliable_oscillator = false;
243 /* Quirk unreliable 32 KiHz oscillator with incomplete dts */
244 if (of_machine_is_compatible("ti,omap3-beagle-ab4")) {
245 quirk_unreliable_oscillator = true;
246 counter_32k = -ENODEV;
249 /* Quirk am437x using am335x style dmtimer clocksource */
250 if (of_machine_is_compatible("ti,am43"))
251 counter_32k = -ENODEV;
253 for_each_matching_node(np, dmtimer_match_table) {
255 if (!dmtimer_is_preferred(np))
258 if (!of_property_read_bool(np, "ti,timer-alwon"))
261 if (of_address_to_resource(np, 0, &res))
266 /* Quirky omap3 boards must use dmtimer12 */
267 if (quirk_unreliable_oscillator && pa == 0x48318000)
274 /* Usually no need for dmtimer clocksource if we have counter32 */
275 if (counter_32k >= 0) {
280 clockevent = DMTIMER_INST_DONT_CARE;
284 /* Finds the first usable dmtimer, used for the don't care case */
285 static u32 __init dmtimer_systimer_find_first_available(void)
287 struct device_node *np;
290 for_each_matching_node(np, dmtimer_match_table) {
292 if (!dmtimer_is_preferred(np))
295 if (of_address_to_resource(np, 0, &res))
298 if (res.start == clocksource || res.start == clockevent)
309 /* Selects the best clocksource and clockevent to use */
310 static void __init dmtimer_systimer_select_best(void)
312 dmtimer_systimer_check_counter32k();
313 dmtimer_systimer_assign_alwon();
315 if (clockevent == DMTIMER_INST_DONT_CARE)
316 clockevent = dmtimer_systimer_find_first_available();
318 pr_debug("%s: counter_32k: %i clocksource: %08x clockevent: %08x\n",
319 __func__, counter_32k, clocksource, clockevent);
322 /* Interface clocks are only available on some SoCs variants */
323 static int __init dmtimer_systimer_init_clock(struct dmtimer_systimer *t,
324 struct device_node *np,
333 is_ick = !strncmp(name, "ick", 3);
335 clock = of_clk_get_by_name(np, name);
336 if ((PTR_ERR(clock) == -EINVAL) && is_ick)
338 else if (IS_ERR(clock))
339 return PTR_ERR(clock);
341 error = clk_prepare_enable(clock);
345 r = clk_get_rate(clock);
347 clk_disable_unprepare(clock);
361 static int __init dmtimer_systimer_setup(struct device_node *np,
362 struct dmtimer_systimer *t)
368 if (!of_device_is_compatible(np->parent, "ti,sysc"))
371 t->base = of_iomap(np, 0);
376 * Enable optional assigned-clock-parents configured at the timer
377 * node level. For regular device drivers, this is done automatically
378 * by bus related code such as platform_drv_probe().
380 error = of_clk_set_defaults(np, false);
382 pr_err("%s: clock source init failed: %i\n", __func__, error);
384 /* For ti-sysc, we have timer clocks at the parent module level */
385 error = dmtimer_systimer_init_clock(t, np->parent, "fck", &rate);
391 error = dmtimer_systimer_init_clock(t, np->parent, "ick", &rate);
395 if (dmtimer_systimer_revision1(t)) {
396 t->irq_stat = OMAP_TIMER_V1_STAT_OFFSET;
397 t->irq_ena = OMAP_TIMER_V1_INT_EN_OFFSET;
398 t->pend = _OMAP_TIMER_WRITE_PEND_OFFSET;
401 t->irq_stat = OMAP_TIMER_V2_IRQSTATUS;
402 t->irq_ena = OMAP_TIMER_V2_IRQENABLE_SET;
403 regbase = OMAP_TIMER_V2_FUNC_OFFSET;
404 t->pend = regbase + _OMAP_TIMER_WRITE_PEND_OFFSET;
407 t->sysc = OMAP_TIMER_OCP_CFG_OFFSET;
408 t->load = regbase + _OMAP_TIMER_LOAD_OFFSET;
409 t->counter = regbase + _OMAP_TIMER_COUNTER_OFFSET;
410 t->ctrl = regbase + _OMAP_TIMER_CTRL_OFFSET;
411 t->wakeup = regbase + _OMAP_TIMER_WAKEUP_EN_OFFSET;
412 t->ifctrl = regbase + _OMAP_TIMER_IF_CTRL_OFFSET;
414 dmtimer_systimer_reset(t);
415 dmtimer_systimer_enable(t);
416 pr_debug("dmtimer rev %08x sysc %08x\n", readl_relaxed(t->base),
417 readl_relaxed(t->base + t->sysc));
428 static struct dmtimer_clockevent *
429 to_dmtimer_clockevent(struct clock_event_device *clockevent)
431 return container_of(clockevent, struct dmtimer_clockevent, dev);
434 static irqreturn_t dmtimer_clockevent_interrupt(int irq, void *data)
436 struct dmtimer_clockevent *clkevt = data;
437 struct dmtimer_systimer *t = &clkevt->t;
439 writel_relaxed(OMAP_TIMER_INT_OVERFLOW, t->base + t->irq_stat);
440 clkevt->dev.event_handler(&clkevt->dev);
445 static int dmtimer_set_next_event(unsigned long cycles,
446 struct clock_event_device *evt)
448 struct dmtimer_clockevent *clkevt = to_dmtimer_clockevent(evt);
449 struct dmtimer_systimer *t = &clkevt->t;
450 void __iomem *pend = t->base + t->pend;
452 while (readl_relaxed(pend) & WP_TCRR)
454 writel_relaxed(0xffffffff - cycles, t->base + t->counter);
456 while (readl_relaxed(pend) & WP_TCLR)
458 writel_relaxed(OMAP_TIMER_CTRL_ST, t->base + t->ctrl);
463 static int dmtimer_clockevent_shutdown(struct clock_event_device *evt)
465 struct dmtimer_clockevent *clkevt = to_dmtimer_clockevent(evt);
466 struct dmtimer_systimer *t = &clkevt->t;
467 void __iomem *ctrl = t->base + t->ctrl;
470 l = readl_relaxed(ctrl);
471 if (l & OMAP_TIMER_CTRL_ST) {
473 writel_relaxed(l, ctrl);
474 /* Flush posted write */
475 l = readl_relaxed(ctrl);
476 /* Wait for functional clock period x 3.5 */
477 udelay(3500000 / t->rate + 1);
479 writel_relaxed(OMAP_TIMER_INT_OVERFLOW, t->base + t->irq_stat);
484 static int dmtimer_set_periodic(struct clock_event_device *evt)
486 struct dmtimer_clockevent *clkevt = to_dmtimer_clockevent(evt);
487 struct dmtimer_systimer *t = &clkevt->t;
488 void __iomem *pend = t->base + t->pend;
490 dmtimer_clockevent_shutdown(evt);
492 /* Looks like we need to first set the load value separately */
493 while (readl_relaxed(pend) & WP_TLDR)
495 writel_relaxed(clkevt->period, t->base + t->load);
497 while (readl_relaxed(pend) & WP_TCRR)
499 writel_relaxed(clkevt->period, t->base + t->counter);
501 while (readl_relaxed(pend) & WP_TCLR)
503 writel_relaxed(OMAP_TIMER_CTRL_AR | OMAP_TIMER_CTRL_ST,
509 static void omap_clockevent_idle(struct clock_event_device *evt)
511 struct dmtimer_clockevent *clkevt = to_dmtimer_clockevent(evt);
512 struct dmtimer_systimer *t = &clkevt->t;
514 dmtimer_systimer_disable(t);
518 static void omap_clockevent_unidle(struct clock_event_device *evt)
520 struct dmtimer_clockevent *clkevt = to_dmtimer_clockevent(evt);
521 struct dmtimer_systimer *t = &clkevt->t;
524 error = clk_enable(t->fck);
526 pr_err("could not enable timer fck on resume: %i\n", error);
528 dmtimer_systimer_enable(t);
529 writel_relaxed(OMAP_TIMER_INT_OVERFLOW, t->base + t->irq_ena);
530 writel_relaxed(OMAP_TIMER_INT_OVERFLOW, t->base + t->wakeup);
533 static int __init dmtimer_clkevt_init_common(struct dmtimer_clockevent *clkevt,
534 struct device_node *np,
535 unsigned int features,
536 const struct cpumask *cpumask,
540 struct clock_event_device *dev;
541 struct dmtimer_systimer *t;
548 * We mostly use cpuidle_coupled with ARM local timers for runtime,
549 * so there's probably no use for CLOCK_EVT_FEAT_DYNIRQ here.
551 dev->features = features;
552 dev->rating = rating;
553 dev->set_next_event = dmtimer_set_next_event;
554 dev->set_state_shutdown = dmtimer_clockevent_shutdown;
555 dev->set_state_periodic = dmtimer_set_periodic;
556 dev->set_state_oneshot = dmtimer_clockevent_shutdown;
557 dev->set_state_oneshot_stopped = dmtimer_clockevent_shutdown;
558 dev->tick_resume = dmtimer_clockevent_shutdown;
559 dev->cpumask = cpumask;
561 dev->irq = irq_of_parse_and_map(np, 0);
565 error = dmtimer_systimer_setup(np, &clkevt->t);
569 clkevt->period = 0xffffffff - DIV_ROUND_CLOSEST(t->rate, HZ);
572 * For clock-event timers we never read the timer counter and
573 * so we are not impacted by errata i103 and i767. Therefore,
574 * we can safely ignore this errata for clock-event timers.
576 writel_relaxed(OMAP_TIMER_CTRL_POSTED, t->base + t->ifctrl);
578 error = request_irq(dev->irq, dmtimer_clockevent_interrupt,
579 IRQF_TIMER, name, clkevt);
583 writel_relaxed(OMAP_TIMER_INT_OVERFLOW, t->base + t->irq_ena);
584 writel_relaxed(OMAP_TIMER_INT_OVERFLOW, t->base + t->wakeup);
586 pr_info("TI gptimer %s: %s%lu Hz at %pOF\n",
587 name, of_property_read_bool(np, "ti,timer-alwon") ?
588 "always-on " : "", t->rate, np->parent);
598 static int __init dmtimer_clockevent_init(struct device_node *np)
600 struct dmtimer_clockevent *clkevt;
603 clkevt = kzalloc(sizeof(*clkevt), GFP_KERNEL);
607 error = dmtimer_clkevt_init_common(clkevt, np,
608 CLOCK_EVT_FEAT_PERIODIC |
609 CLOCK_EVT_FEAT_ONESHOT,
610 cpu_possible_mask, "clockevent",
615 clockevents_config_and_register(&clkevt->dev, clkevt->t.rate,
616 3, /* Timer internal resync latency */
619 if (of_machine_is_compatible("ti,am33xx") ||
620 of_machine_is_compatible("ti,am43")) {
621 clkevt->dev.suspend = omap_clockevent_idle;
622 clkevt->dev.resume = omap_clockevent_unidle;
633 /* Dmtimer as percpu timer. See dra7 ARM architected timer wrap erratum i940 */
634 static DEFINE_PER_CPU(struct dmtimer_clockevent, dmtimer_percpu_timer);
636 static int __init dmtimer_percpu_timer_init(struct device_node *np, int cpu)
638 struct dmtimer_clockevent *clkevt;
641 if (!cpu_possible(cpu))
644 if (!of_property_read_bool(np->parent, "ti,no-reset-on-init") ||
645 !of_property_read_bool(np->parent, "ti,no-idle"))
646 pr_warn("Incomplete dtb for percpu dmtimer %pOF\n", np->parent);
648 clkevt = per_cpu_ptr(&dmtimer_percpu_timer, cpu);
650 error = dmtimer_clkevt_init_common(clkevt, np, CLOCK_EVT_FEAT_ONESHOT,
651 cpumask_of(cpu), "percpu-dmtimer",
659 /* See TRM for timer internal resynch latency */
660 static int omap_dmtimer_starting_cpu(unsigned int cpu)
662 struct dmtimer_clockevent *clkevt = per_cpu_ptr(&dmtimer_percpu_timer, cpu);
663 struct clock_event_device *dev = &clkevt->dev;
664 struct dmtimer_systimer *t = &clkevt->t;
666 clockevents_config_and_register(dev, t->rate, 3, ULONG_MAX);
667 irq_force_affinity(dev->irq, cpumask_of(cpu));
672 static int __init dmtimer_percpu_timer_startup(void)
674 struct dmtimer_clockevent *clkevt = per_cpu_ptr(&dmtimer_percpu_timer, 0);
675 struct dmtimer_systimer *t = &clkevt->t;
678 cpuhp_setup_state(CPUHP_AP_TI_GP_TIMER_STARTING,
679 "clockevents/omap/gptimer:starting",
680 omap_dmtimer_starting_cpu, NULL);
685 subsys_initcall(dmtimer_percpu_timer_startup);
687 static int __init dmtimer_percpu_quirk_init(struct device_node *np, u32 pa)
689 struct device_node *arm_timer;
691 arm_timer = of_find_compatible_node(NULL, NULL, "arm,armv7-timer");
692 if (of_device_is_available(arm_timer)) {
693 pr_warn_once("ARM architected timer wrap issue i940 detected\n");
697 if (pa == 0x4882c000) /* dra7 dmtimer15 */
698 return dmtimer_percpu_timer_init(np, 0);
699 else if (pa == 0x4882e000) /* dra7 dmtimer16 */
700 return dmtimer_percpu_timer_init(np, 1);
706 static struct dmtimer_clocksource *
707 to_dmtimer_clocksource(struct clocksource *cs)
709 return container_of(cs, struct dmtimer_clocksource, dev);
712 static u64 dmtimer_clocksource_read_cycles(struct clocksource *cs)
714 struct dmtimer_clocksource *clksrc = to_dmtimer_clocksource(cs);
715 struct dmtimer_systimer *t = &clksrc->t;
717 return (u64)readl_relaxed(t->base + t->counter);
720 static void __iomem *dmtimer_sched_clock_counter;
722 static u64 notrace dmtimer_read_sched_clock(void)
724 return readl_relaxed(dmtimer_sched_clock_counter);
727 static void dmtimer_clocksource_suspend(struct clocksource *cs)
729 struct dmtimer_clocksource *clksrc = to_dmtimer_clocksource(cs);
730 struct dmtimer_systimer *t = &clksrc->t;
732 clksrc->loadval = readl_relaxed(t->base + t->counter);
733 dmtimer_systimer_disable(t);
737 static void dmtimer_clocksource_resume(struct clocksource *cs)
739 struct dmtimer_clocksource *clksrc = to_dmtimer_clocksource(cs);
740 struct dmtimer_systimer *t = &clksrc->t;
743 error = clk_enable(t->fck);
745 pr_err("could not enable timer fck on resume: %i\n", error);
747 dmtimer_systimer_enable(t);
748 writel_relaxed(clksrc->loadval, t->base + t->counter);
749 writel_relaxed(OMAP_TIMER_CTRL_ST | OMAP_TIMER_CTRL_AR,
753 static int __init dmtimer_clocksource_init(struct device_node *np)
755 struct dmtimer_clocksource *clksrc;
756 struct dmtimer_systimer *t;
757 struct clocksource *dev;
760 clksrc = kzalloc(sizeof(*clksrc), GFP_KERNEL);
767 error = dmtimer_systimer_setup(np, t);
771 dev->name = "dmtimer";
773 dev->read = dmtimer_clocksource_read_cycles;
774 dev->mask = CLOCKSOURCE_MASK(32);
775 dev->flags = CLOCK_SOURCE_IS_CONTINUOUS;
777 /* Unlike for clockevent, legacy code sets suspend only for am4 */
778 if (of_machine_is_compatible("ti,am43")) {
779 dev->suspend = dmtimer_clocksource_suspend;
780 dev->resume = dmtimer_clocksource_resume;
783 writel_relaxed(0, t->base + t->counter);
784 writel_relaxed(OMAP_TIMER_CTRL_ST | OMAP_TIMER_CTRL_AR,
787 pr_info("TI gptimer clocksource: %s%pOF\n",
788 of_property_read_bool(np, "ti,timer-alwon") ?
789 "always-on " : "", np->parent);
791 if (!dmtimer_sched_clock_counter) {
792 dmtimer_sched_clock_counter = t->base + t->counter;
793 sched_clock_register(dmtimer_read_sched_clock, 32, t->rate);
796 if (clocksource_register_hz(dev, t->rate))
797 pr_err("Could not register clocksource %pOF\n", np);
808 * To detect between a clocksource and clockevent, we assume the device tree
809 * has no interrupts configured for a clocksource timer.
811 static int __init dmtimer_systimer_init(struct device_node *np)
816 /* One time init for the preferred timer configuration */
817 if (!clocksource && !clockevent)
818 dmtimer_systimer_select_best();
820 if (!clocksource && !clockevent) {
821 pr_err("%s: unable to detect system timers, update dtb?\n",
828 of_address_to_resource(np, 0, &res);
833 if (counter_32k <= 0 && clocksource == pa)
834 return dmtimer_clocksource_init(np);
836 if (clockevent == pa)
837 return dmtimer_clockevent_init(np);
839 if (of_machine_is_compatible("ti,dra7"))
840 return dmtimer_percpu_quirk_init(np, pa);
845 TIMER_OF_DECLARE(systimer_omap2, "ti,omap2420-timer", dmtimer_systimer_init);
846 TIMER_OF_DECLARE(systimer_omap3, "ti,omap3430-timer", dmtimer_systimer_init);
847 TIMER_OF_DECLARE(systimer_omap4, "ti,omap4430-timer", dmtimer_systimer_init);
848 TIMER_OF_DECLARE(systimer_omap5, "ti,omap5430-timer", dmtimer_systimer_init);
849 TIMER_OF_DECLARE(systimer_am33x, "ti,am335x-timer", dmtimer_systimer_init);
850 TIMER_OF_DECLARE(systimer_am3ms, "ti,am335x-timer-1ms", dmtimer_systimer_init);
851 TIMER_OF_DECLARE(systimer_dm814, "ti,dm814-timer", dmtimer_systimer_init);
852 TIMER_OF_DECLARE(systimer_dm816, "ti,dm816-timer", dmtimer_systimer_init);