xref: /openbmc/linux/drivers/clocksource/timer-mediatek.c (revision 56d52d3f56192049221105efa6ee76251a949c0e)
17ec58e52SStanley Chu /*
27ec58e52SStanley Chu  * Mediatek SoCs General-Purpose Timer handling.
37ec58e52SStanley Chu  *
47ec58e52SStanley Chu  * Copyright (C) 2014 Matthias Brugger
57ec58e52SStanley Chu  *
67ec58e52SStanley Chu  * Matthias Brugger <matthias.bgg@gmail.com>
77ec58e52SStanley Chu  *
87ec58e52SStanley Chu  * This program is free software; you can redistribute it and/or modify
97ec58e52SStanley Chu  * it under the terms of the GNU General Public License as published by
107ec58e52SStanley Chu  * the Free Software Foundation; either version 2 of the License, or
117ec58e52SStanley Chu  * (at your option) any later version.
127ec58e52SStanley Chu  *
137ec58e52SStanley Chu  * This program is distributed in the hope that it will be useful,
147ec58e52SStanley Chu  * but WITHOUT ANY WARRANTY; without even the implied warranty of
157ec58e52SStanley Chu  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
167ec58e52SStanley Chu  * GNU General Public License for more details.
177ec58e52SStanley Chu  */
187ec58e52SStanley Chu 
197ec58e52SStanley Chu #define pr_fmt(fmt)	KBUILD_MODNAME ": " fmt
207ec58e52SStanley Chu 
217ec58e52SStanley Chu #include <linux/clk.h>
227ec58e52SStanley Chu #include <linux/clockchips.h>
237ec58e52SStanley Chu #include <linux/interrupt.h>
247ec58e52SStanley Chu #include <linux/irq.h>
257ec58e52SStanley Chu #include <linux/irqreturn.h>
267ec58e52SStanley Chu #include <linux/of.h>
277ec58e52SStanley Chu #include <linux/of_address.h>
287ec58e52SStanley Chu #include <linux/of_irq.h>
297ec58e52SStanley Chu #include <linux/sched_clock.h>
307ec58e52SStanley Chu #include <linux/slab.h>
317ec58e52SStanley Chu 
32*56d52d3fSStanley Chu #define TIMER_CLK_EVT           (1)
33*56d52d3fSStanley Chu #define TIMER_CLK_SRC           (2)
34*56d52d3fSStanley Chu 
35*56d52d3fSStanley Chu #define TIMER_SYNC_TICKS        (3)
36*56d52d3fSStanley Chu 
37*56d52d3fSStanley Chu /* gpt */
387ec58e52SStanley Chu #define GPT_IRQ_EN_REG          0x00
397ec58e52SStanley Chu #define GPT_IRQ_ENABLE(val)     BIT((val) - 1)
407ec58e52SStanley Chu #define GPT_IRQ_ACK_REG	        0x08
417ec58e52SStanley Chu #define GPT_IRQ_ACK(val)        BIT((val) - 1)
427ec58e52SStanley Chu 
43*56d52d3fSStanley Chu #define GPT_CTRL_REG(val)       (0x10 * (val))
44*56d52d3fSStanley Chu #define GPT_CTRL_OP(val)        (((val) & 0x3) << 4)
45*56d52d3fSStanley Chu #define GPT_CTRL_OP_ONESHOT     (0)
46*56d52d3fSStanley Chu #define GPT_CTRL_OP_REPEAT      (1)
47*56d52d3fSStanley Chu #define GPT_CTRL_OP_FREERUN     (3)
48*56d52d3fSStanley Chu #define GPT_CTRL_CLEAR          (2)
49*56d52d3fSStanley Chu #define GPT_CTRL_ENABLE         (1)
50*56d52d3fSStanley Chu #define GPT_CTRL_DISABLE        (0)
517ec58e52SStanley Chu 
52*56d52d3fSStanley Chu #define GPT_CLK_REG(val)        (0x04 + (0x10 * (val)))
53*56d52d3fSStanley Chu #define GPT_CLK_SRC(val)        (((val) & 0x1) << 4)
54*56d52d3fSStanley Chu #define GPT_CLK_SRC_SYS13M      (0)
55*56d52d3fSStanley Chu #define GPT_CLK_SRC_RTC32K      (1)
56*56d52d3fSStanley Chu #define GPT_CLK_DIV1            (0x0)
57*56d52d3fSStanley Chu #define GPT_CLK_DIV2            (0x1)
587ec58e52SStanley Chu 
59*56d52d3fSStanley Chu #define GPT_CNT_REG(val)        (0x08 + (0x10 * (val)))
60*56d52d3fSStanley Chu #define GPT_CMP_REG(val)        (0x0C + (0x10 * (val)))
617ec58e52SStanley Chu 
627ec58e52SStanley Chu struct mtk_clock_event_device {
637ec58e52SStanley Chu 	void __iomem *gpt_base;
647ec58e52SStanley Chu 	u32 ticks_per_jiffy;
657ec58e52SStanley Chu 	struct clock_event_device dev;
667ec58e52SStanley Chu };
677ec58e52SStanley Chu 
687ec58e52SStanley Chu static void __iomem *gpt_sched_reg __read_mostly;
697ec58e52SStanley Chu 
70*56d52d3fSStanley Chu static u64 notrace mtk_gpt_read_sched_clock(void)
717ec58e52SStanley Chu {
727ec58e52SStanley Chu 	return readl_relaxed(gpt_sched_reg);
737ec58e52SStanley Chu }
747ec58e52SStanley Chu 
757ec58e52SStanley Chu static inline struct mtk_clock_event_device *to_mtk_clk(
767ec58e52SStanley Chu 				struct clock_event_device *c)
777ec58e52SStanley Chu {
787ec58e52SStanley Chu 	return container_of(c, struct mtk_clock_event_device, dev);
797ec58e52SStanley Chu }
807ec58e52SStanley Chu 
81*56d52d3fSStanley Chu static void mtk_gpt_clkevt_time_stop(struct mtk_clock_event_device *evt, u8 timer)
827ec58e52SStanley Chu {
837ec58e52SStanley Chu 	u32 val;
847ec58e52SStanley Chu 
85*56d52d3fSStanley Chu 	val = readl(evt->gpt_base + GPT_CTRL_REG(timer));
86*56d52d3fSStanley Chu 	writel(val & ~GPT_CTRL_ENABLE, evt->gpt_base +
87*56d52d3fSStanley Chu 			GPT_CTRL_REG(timer));
887ec58e52SStanley Chu }
897ec58e52SStanley Chu 
90*56d52d3fSStanley Chu static void mtk_gpt_clkevt_time_setup(struct mtk_clock_event_device *evt,
917ec58e52SStanley Chu 				unsigned long delay, u8 timer)
927ec58e52SStanley Chu {
93*56d52d3fSStanley Chu 	writel(delay, evt->gpt_base + GPT_CMP_REG(timer));
947ec58e52SStanley Chu }
957ec58e52SStanley Chu 
96*56d52d3fSStanley Chu static void mtk_gpt_clkevt_time_start(struct mtk_clock_event_device *evt,
977ec58e52SStanley Chu 		bool periodic, u8 timer)
987ec58e52SStanley Chu {
997ec58e52SStanley Chu 	u32 val;
1007ec58e52SStanley Chu 
1017ec58e52SStanley Chu 	/* Acknowledge interrupt */
1027ec58e52SStanley Chu 	writel(GPT_IRQ_ACK(timer), evt->gpt_base + GPT_IRQ_ACK_REG);
1037ec58e52SStanley Chu 
104*56d52d3fSStanley Chu 	val = readl(evt->gpt_base + GPT_CTRL_REG(timer));
1057ec58e52SStanley Chu 
1067ec58e52SStanley Chu 	/* Clear 2 bit timer operation mode field */
107*56d52d3fSStanley Chu 	val &= ~GPT_CTRL_OP(0x3);
1087ec58e52SStanley Chu 
1097ec58e52SStanley Chu 	if (periodic)
110*56d52d3fSStanley Chu 		val |= GPT_CTRL_OP(GPT_CTRL_OP_REPEAT);
1117ec58e52SStanley Chu 	else
112*56d52d3fSStanley Chu 		val |= GPT_CTRL_OP(GPT_CTRL_OP_ONESHOT);
1137ec58e52SStanley Chu 
114*56d52d3fSStanley Chu 	writel(val | GPT_CTRL_ENABLE | GPT_CTRL_CLEAR,
115*56d52d3fSStanley Chu 	       evt->gpt_base + GPT_CTRL_REG(timer));
1167ec58e52SStanley Chu }
1177ec58e52SStanley Chu 
118*56d52d3fSStanley Chu static int mtk_gpt_clkevt_shutdown(struct clock_event_device *clk)
1197ec58e52SStanley Chu {
120*56d52d3fSStanley Chu 	mtk_gpt_clkevt_time_stop(to_mtk_clk(clk), TIMER_CLK_EVT);
1217ec58e52SStanley Chu 	return 0;
1227ec58e52SStanley Chu }
1237ec58e52SStanley Chu 
124*56d52d3fSStanley Chu static int mtk_gpt_clkevt_set_periodic(struct clock_event_device *clk)
1257ec58e52SStanley Chu {
1267ec58e52SStanley Chu 	struct mtk_clock_event_device *evt = to_mtk_clk(clk);
1277ec58e52SStanley Chu 
128*56d52d3fSStanley Chu 	mtk_gpt_clkevt_time_stop(evt, TIMER_CLK_EVT);
129*56d52d3fSStanley Chu 	mtk_gpt_clkevt_time_setup(evt, evt->ticks_per_jiffy, TIMER_CLK_EVT);
130*56d52d3fSStanley Chu 	mtk_gpt_clkevt_time_start(evt, true, TIMER_CLK_EVT);
1317ec58e52SStanley Chu 	return 0;
1327ec58e52SStanley Chu }
1337ec58e52SStanley Chu 
134*56d52d3fSStanley Chu static int mtk_gpt_clkevt_next_event(unsigned long event,
1357ec58e52SStanley Chu 				   struct clock_event_device *clk)
1367ec58e52SStanley Chu {
1377ec58e52SStanley Chu 	struct mtk_clock_event_device *evt = to_mtk_clk(clk);
1387ec58e52SStanley Chu 
139*56d52d3fSStanley Chu 	mtk_gpt_clkevt_time_stop(evt, TIMER_CLK_EVT);
140*56d52d3fSStanley Chu 	mtk_gpt_clkevt_time_setup(evt, event, TIMER_CLK_EVT);
141*56d52d3fSStanley Chu 	mtk_gpt_clkevt_time_start(evt, false, TIMER_CLK_EVT);
1427ec58e52SStanley Chu 
1437ec58e52SStanley Chu 	return 0;
1447ec58e52SStanley Chu }
1457ec58e52SStanley Chu 
146*56d52d3fSStanley Chu static irqreturn_t mtk_gpt_interrupt(int irq, void *dev_id)
1477ec58e52SStanley Chu {
1487ec58e52SStanley Chu 	struct mtk_clock_event_device *evt = dev_id;
1497ec58e52SStanley Chu 
1507ec58e52SStanley Chu 	/* Acknowledge timer0 irq */
151*56d52d3fSStanley Chu 	writel(GPT_IRQ_ACK(TIMER_CLK_EVT), evt->gpt_base + GPT_IRQ_ACK_REG);
1527ec58e52SStanley Chu 	evt->dev.event_handler(&evt->dev);
1537ec58e52SStanley Chu 
1547ec58e52SStanley Chu 	return IRQ_HANDLED;
1557ec58e52SStanley Chu }
1567ec58e52SStanley Chu 
1577ec58e52SStanley Chu static void
158*56d52d3fSStanley Chu __init mtk_gpt_setup(struct mtk_clock_event_device *evt, u8 timer, u8 option)
1597ec58e52SStanley Chu {
160*56d52d3fSStanley Chu 	writel(GPT_CTRL_CLEAR | GPT_CTRL_DISABLE,
161*56d52d3fSStanley Chu 		evt->gpt_base + GPT_CTRL_REG(timer));
1627ec58e52SStanley Chu 
163*56d52d3fSStanley Chu 	writel(GPT_CLK_SRC(GPT_CLK_SRC_SYS13M) | GPT_CLK_DIV1,
164*56d52d3fSStanley Chu 			evt->gpt_base + GPT_CLK_REG(timer));
1657ec58e52SStanley Chu 
166*56d52d3fSStanley Chu 	writel(0x0, evt->gpt_base + GPT_CMP_REG(timer));
1677ec58e52SStanley Chu 
168*56d52d3fSStanley Chu 	writel(GPT_CTRL_OP(option) | GPT_CTRL_ENABLE,
169*56d52d3fSStanley Chu 			evt->gpt_base + GPT_CTRL_REG(timer));
1707ec58e52SStanley Chu }
1717ec58e52SStanley Chu 
172*56d52d3fSStanley Chu static void mtk_gpt_enable_irq(struct mtk_clock_event_device *evt, u8 timer)
1737ec58e52SStanley Chu {
1747ec58e52SStanley Chu 	u32 val;
1757ec58e52SStanley Chu 
1767ec58e52SStanley Chu 	/* Disable all interrupts */
1777ec58e52SStanley Chu 	writel(0x0, evt->gpt_base + GPT_IRQ_EN_REG);
1787ec58e52SStanley Chu 
1797ec58e52SStanley Chu 	/* Acknowledge all spurious pending interrupts */
1807ec58e52SStanley Chu 	writel(0x3f, evt->gpt_base + GPT_IRQ_ACK_REG);
1817ec58e52SStanley Chu 
1827ec58e52SStanley Chu 	val = readl(evt->gpt_base + GPT_IRQ_EN_REG);
1837ec58e52SStanley Chu 	writel(val | GPT_IRQ_ENABLE(timer),
1847ec58e52SStanley Chu 			evt->gpt_base + GPT_IRQ_EN_REG);
1857ec58e52SStanley Chu }
1867ec58e52SStanley Chu 
187*56d52d3fSStanley Chu static int __init mtk_gpt_init(struct device_node *node)
1887ec58e52SStanley Chu {
1897ec58e52SStanley Chu 	struct mtk_clock_event_device *evt;
1907ec58e52SStanley Chu 	struct resource res;
1917ec58e52SStanley Chu 	unsigned long rate = 0;
1927ec58e52SStanley Chu 	struct clk *clk;
1937ec58e52SStanley Chu 
1947ec58e52SStanley Chu 	evt = kzalloc(sizeof(*evt), GFP_KERNEL);
1957ec58e52SStanley Chu 	if (!evt)
1967ec58e52SStanley Chu 		return -ENOMEM;
1977ec58e52SStanley Chu 
1987ec58e52SStanley Chu 	evt->dev.name = "mtk_tick";
1997ec58e52SStanley Chu 	evt->dev.rating = 300;
2007ec58e52SStanley Chu 	evt->dev.features = CLOCK_EVT_FEAT_PERIODIC | CLOCK_EVT_FEAT_ONESHOT;
201*56d52d3fSStanley Chu 	evt->dev.set_state_shutdown = mtk_gpt_clkevt_shutdown;
202*56d52d3fSStanley Chu 	evt->dev.set_state_periodic = mtk_gpt_clkevt_set_periodic;
203*56d52d3fSStanley Chu 	evt->dev.set_state_oneshot = mtk_gpt_clkevt_shutdown;
204*56d52d3fSStanley Chu 	evt->dev.tick_resume = mtk_gpt_clkevt_shutdown;
205*56d52d3fSStanley Chu 	evt->dev.set_next_event = mtk_gpt_clkevt_next_event;
2067ec58e52SStanley Chu 	evt->dev.cpumask = cpu_possible_mask;
2077ec58e52SStanley Chu 
208*56d52d3fSStanley Chu 	evt->gpt_base = of_io_request_and_map(node, 0, "mtk-timer-gpt");
2097ec58e52SStanley Chu 	if (IS_ERR(evt->gpt_base)) {
2107ec58e52SStanley Chu 		pr_err("Can't get resource\n");
2117ec58e52SStanley Chu 		goto err_kzalloc;
2127ec58e52SStanley Chu 	}
2137ec58e52SStanley Chu 
2147ec58e52SStanley Chu 	evt->dev.irq = irq_of_parse_and_map(node, 0);
2157ec58e52SStanley Chu 	if (evt->dev.irq <= 0) {
2167ec58e52SStanley Chu 		pr_err("Can't parse IRQ\n");
2177ec58e52SStanley Chu 		goto err_mem;
2187ec58e52SStanley Chu 	}
2197ec58e52SStanley Chu 
2207ec58e52SStanley Chu 	clk = of_clk_get(node, 0);
2217ec58e52SStanley Chu 	if (IS_ERR(clk)) {
2227ec58e52SStanley Chu 		pr_err("Can't get timer clock\n");
2237ec58e52SStanley Chu 		goto err_irq;
2247ec58e52SStanley Chu 	}
2257ec58e52SStanley Chu 
2267ec58e52SStanley Chu 	if (clk_prepare_enable(clk)) {
2277ec58e52SStanley Chu 		pr_err("Can't prepare clock\n");
2287ec58e52SStanley Chu 		goto err_clk_put;
2297ec58e52SStanley Chu 	}
2307ec58e52SStanley Chu 	rate = clk_get_rate(clk);
2317ec58e52SStanley Chu 
232*56d52d3fSStanley Chu 	if (request_irq(evt->dev.irq, mtk_gpt_interrupt,
2337ec58e52SStanley Chu 			IRQF_TIMER | IRQF_IRQPOLL, "mtk_timer", evt)) {
2347ec58e52SStanley Chu 		pr_err("failed to setup irq %d\n", evt->dev.irq);
2357ec58e52SStanley Chu 		goto err_clk_disable;
2367ec58e52SStanley Chu 	}
2377ec58e52SStanley Chu 
2387ec58e52SStanley Chu 	evt->ticks_per_jiffy = DIV_ROUND_UP(rate, HZ);
2397ec58e52SStanley Chu 
2407ec58e52SStanley Chu 	/* Configure clock source */
241*56d52d3fSStanley Chu 	mtk_gpt_setup(evt, TIMER_CLK_SRC, GPT_CTRL_OP_FREERUN);
242*56d52d3fSStanley Chu 	clocksource_mmio_init(evt->gpt_base + GPT_CNT_REG(TIMER_CLK_SRC),
2437ec58e52SStanley Chu 			node->name, rate, 300, 32, clocksource_mmio_readl_up);
244*56d52d3fSStanley Chu 	gpt_sched_reg = evt->gpt_base + GPT_CNT_REG(TIMER_CLK_SRC);
245*56d52d3fSStanley Chu 	sched_clock_register(mtk_gpt_read_sched_clock, 32, rate);
2467ec58e52SStanley Chu 
2477ec58e52SStanley Chu 	/* Configure clock event */
248*56d52d3fSStanley Chu 	mtk_gpt_setup(evt, TIMER_CLK_EVT, GPT_CTRL_OP_REPEAT);
249*56d52d3fSStanley Chu 	clockevents_config_and_register(&evt->dev, rate, TIMER_SYNC_TICKS,
2507ec58e52SStanley Chu 					0xffffffff);
2517ec58e52SStanley Chu 
252*56d52d3fSStanley Chu 	mtk_gpt_enable_irq(evt, TIMER_CLK_EVT);
2537ec58e52SStanley Chu 
2547ec58e52SStanley Chu 	return 0;
2557ec58e52SStanley Chu 
2567ec58e52SStanley Chu err_clk_disable:
2577ec58e52SStanley Chu 	clk_disable_unprepare(clk);
2587ec58e52SStanley Chu err_clk_put:
2597ec58e52SStanley Chu 	clk_put(clk);
2607ec58e52SStanley Chu err_irq:
2617ec58e52SStanley Chu 	irq_dispose_mapping(evt->dev.irq);
2627ec58e52SStanley Chu err_mem:
2637ec58e52SStanley Chu 	iounmap(evt->gpt_base);
2647ec58e52SStanley Chu 	of_address_to_resource(node, 0, &res);
2657ec58e52SStanley Chu 	release_mem_region(res.start, resource_size(&res));
2667ec58e52SStanley Chu err_kzalloc:
2677ec58e52SStanley Chu 	kfree(evt);
2687ec58e52SStanley Chu 
2697ec58e52SStanley Chu 	return -EINVAL;
2707ec58e52SStanley Chu }
271*56d52d3fSStanley Chu TIMER_OF_DECLARE(mtk_mt6577, "mediatek,mt6577-timer", mtk_gpt_init);
272