blob: 0b1836a6c53975aade352b7f56b815d6c7ce1cb5 [file] [log] [blame]
Magnus Damm3fb1b6a2009-01-22 09:55:59 +00001/*
2 * SuperH Timer Support - CMT
3 *
4 * Copyright (C) 2008 Magnus Damm
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 */
19
20#include <linux/init.h>
Magnus Damm3fb1b6a2009-01-22 09:55:59 +000021#include <linux/platform_device.h>
22#include <linux/spinlock.h>
23#include <linux/interrupt.h>
24#include <linux/ioport.h>
25#include <linux/io.h>
26#include <linux/clk.h>
27#include <linux/irq.h>
28#include <linux/err.h>
Magnus Damm3f7e5e22011-07-13 07:59:48 +000029#include <linux/delay.h>
Magnus Damm3fb1b6a2009-01-22 09:55:59 +000030#include <linux/clocksource.h>
31#include <linux/clockchips.h>
Paul Mundt46a12f72009-05-03 17:57:17 +090032#include <linux/sh_timer.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090033#include <linux/slab.h>
Paul Gortmaker7deeab52011-07-03 13:36:22 -040034#include <linux/module.h>
Rafael J. Wysocki615a4452012-03-13 22:40:06 +010035#include <linux/pm_domain.h>
Rafael J. Wysockibad81382012-08-06 01:48:57 +020036#include <linux/pm_runtime.h>
Magnus Damm3fb1b6a2009-01-22 09:55:59 +000037
38struct sh_cmt_priv {
39 void __iomem *mapbase;
Magnus Damm8874c5e2013-06-17 15:40:52 +090040 void __iomem *mapbase_str;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +000041 struct clk *clk;
42 unsigned long width; /* 16 or 32 bit version of hardware block */
43 unsigned long overflow_bit;
44 unsigned long clear_bits;
45 struct irqaction irqaction;
46 struct platform_device *pdev;
47
48 unsigned long flags;
49 unsigned long match_value;
50 unsigned long next_match_value;
51 unsigned long max_match_value;
52 unsigned long rate;
Paul Mundt7d0c3992012-05-25 13:36:43 +090053 raw_spinlock_t lock;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +000054 struct clock_event_device ced;
Magnus Damm19bdc9d2009-04-17 05:26:31 +000055 struct clocksource cs;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +000056 unsigned long total_cycles;
Rafael J. Wysockibad81382012-08-06 01:48:57 +020057 bool cs_enabled;
Magnus Damma6a912c2012-12-14 14:54:19 +090058
Magnus Dammcccd7042012-12-14 14:54:28 +090059 /* callbacks for CMSTR and CMCSR access */
60 unsigned long (*read_control)(void __iomem *base, unsigned long offs);
61 void (*write_control)(void __iomem *base, unsigned long offs,
62 unsigned long value);
63
Magnus Damma6a912c2012-12-14 14:54:19 +090064 /* callbacks for CMCNT and CMCOR access */
65 unsigned long (*read_count)(void __iomem *base, unsigned long offs);
66 void (*write_count)(void __iomem *base, unsigned long offs,
67 unsigned long value);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +000068};
69
Magnus Damm118aee42012-12-14 14:54:37 +090070/* Examples of supported CMT timer register layouts and I/O access widths:
71 *
72 * "16-bit counter and 16-bit control" as found on sh7263:
73 * CMSTR 0xfffec000 16-bit
74 * CMCSR 0xfffec002 16-bit
75 * CMCNT 0xfffec004 16-bit
76 * CMCOR 0xfffec006 16-bit
77 *
78 * "32-bit counter and 16-bit control" as found on sh7372, sh73a0, r8a7740:
79 * CMSTR 0xffca0000 16-bit
80 * CMCSR 0xffca0060 16-bit
81 * CMCNT 0xffca0064 32-bit
82 * CMCOR 0xffca0068 32-bit
Magnus Damm8874c5e2013-06-17 15:40:52 +090083 *
84 * "32-bit counter and 32-bit control" as found on r8a73a4 and r8a7790:
85 * CMSTR 0xffca0500 32-bit
86 * CMCSR 0xffca0510 32-bit
87 * CMCNT 0xffca0514 32-bit
88 * CMCOR 0xffca0518 32-bit
Magnus Damm118aee42012-12-14 14:54:37 +090089 */
90
Magnus Damma6a912c2012-12-14 14:54:19 +090091static unsigned long sh_cmt_read16(void __iomem *base, unsigned long offs)
Magnus Damm587acb32012-12-14 14:54:10 +090092{
93 return ioread16(base + (offs << 1));
94}
Magnus Damm3fb1b6a2009-01-22 09:55:59 +000095
Magnus Damma6a912c2012-12-14 14:54:19 +090096static unsigned long sh_cmt_read32(void __iomem *base, unsigned long offs)
97{
98 return ioread32(base + (offs << 2));
99}
100
101static void sh_cmt_write16(void __iomem *base, unsigned long offs,
102 unsigned long value)
Magnus Damm587acb32012-12-14 14:54:10 +0900103{
104 iowrite16(value, base + (offs << 1));
105}
106
Magnus Damma6a912c2012-12-14 14:54:19 +0900107static void sh_cmt_write32(void __iomem *base, unsigned long offs,
108 unsigned long value)
109{
110 iowrite32(value, base + (offs << 2));
111}
112
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000113#define CMCSR 0 /* channel register */
114#define CMCNT 1 /* channel register */
115#define CMCOR 2 /* channel register */
116
Magnus Damm1b56b962012-12-14 14:54:00 +0900117static inline unsigned long sh_cmt_read_cmstr(struct sh_cmt_priv *p)
118{
Magnus Damm8874c5e2013-06-17 15:40:52 +0900119 return p->read_control(p->mapbase_str, 0);
Magnus Damm1b56b962012-12-14 14:54:00 +0900120}
121
122static inline unsigned long sh_cmt_read_cmcsr(struct sh_cmt_priv *p)
123{
Magnus Dammcccd7042012-12-14 14:54:28 +0900124 return p->read_control(p->mapbase, CMCSR);
Magnus Damm1b56b962012-12-14 14:54:00 +0900125}
126
127static inline unsigned long sh_cmt_read_cmcnt(struct sh_cmt_priv *p)
128{
Magnus Damma6a912c2012-12-14 14:54:19 +0900129 return p->read_count(p->mapbase, CMCNT);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000130}
131
Magnus Damm1b56b962012-12-14 14:54:00 +0900132static inline void sh_cmt_write_cmstr(struct sh_cmt_priv *p,
133 unsigned long value)
134{
Magnus Damm8874c5e2013-06-17 15:40:52 +0900135 p->write_control(p->mapbase_str, 0, value);
Magnus Damm1b56b962012-12-14 14:54:00 +0900136}
137
138static inline void sh_cmt_write_cmcsr(struct sh_cmt_priv *p,
139 unsigned long value)
140{
Magnus Dammcccd7042012-12-14 14:54:28 +0900141 p->write_control(p->mapbase, CMCSR, value);
Magnus Damm1b56b962012-12-14 14:54:00 +0900142}
143
144static inline void sh_cmt_write_cmcnt(struct sh_cmt_priv *p,
145 unsigned long value)
146{
Magnus Damma6a912c2012-12-14 14:54:19 +0900147 p->write_count(p->mapbase, CMCNT, value);
Magnus Damm1b56b962012-12-14 14:54:00 +0900148}
149
150static inline void sh_cmt_write_cmcor(struct sh_cmt_priv *p,
151 unsigned long value)
152{
Magnus Damma6a912c2012-12-14 14:54:19 +0900153 p->write_count(p->mapbase, CMCOR, value);
Magnus Damm1b56b962012-12-14 14:54:00 +0900154}
155
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000156static unsigned long sh_cmt_get_counter(struct sh_cmt_priv *p,
157 int *has_wrapped)
158{
159 unsigned long v1, v2, v3;
Magnus Damm5b644c72009-04-28 08:17:54 +0000160 int o1, o2;
161
Magnus Damm1b56b962012-12-14 14:54:00 +0900162 o1 = sh_cmt_read_cmcsr(p) & p->overflow_bit;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000163
164 /* Make sure the timer value is stable. Stolen from acpi_pm.c */
165 do {
Magnus Damm5b644c72009-04-28 08:17:54 +0000166 o2 = o1;
Magnus Damm1b56b962012-12-14 14:54:00 +0900167 v1 = sh_cmt_read_cmcnt(p);
168 v2 = sh_cmt_read_cmcnt(p);
169 v3 = sh_cmt_read_cmcnt(p);
170 o1 = sh_cmt_read_cmcsr(p) & p->overflow_bit;
Magnus Damm5b644c72009-04-28 08:17:54 +0000171 } while (unlikely((o1 != o2) || (v1 > v2 && v1 < v3)
172 || (v2 > v3 && v2 < v1) || (v3 > v1 && v3 < v2)));
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000173
Magnus Damm5b644c72009-04-28 08:17:54 +0000174 *has_wrapped = o1;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000175 return v2;
176}
177
Magnus Damm587acb32012-12-14 14:54:10 +0900178static DEFINE_RAW_SPINLOCK(sh_cmt_lock);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000179
180static void sh_cmt_start_stop_ch(struct sh_cmt_priv *p, int start)
181{
Paul Mundt46a12f72009-05-03 17:57:17 +0900182 struct sh_timer_config *cfg = p->pdev->dev.platform_data;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000183 unsigned long flags, value;
184
185 /* start stop register shared by multiple timer channels */
Paul Mundt7d0c3992012-05-25 13:36:43 +0900186 raw_spin_lock_irqsave(&sh_cmt_lock, flags);
Magnus Damm1b56b962012-12-14 14:54:00 +0900187 value = sh_cmt_read_cmstr(p);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000188
189 if (start)
190 value |= 1 << cfg->timer_bit;
191 else
192 value &= ~(1 << cfg->timer_bit);
193
Magnus Damm1b56b962012-12-14 14:54:00 +0900194 sh_cmt_write_cmstr(p, value);
Paul Mundt7d0c3992012-05-25 13:36:43 +0900195 raw_spin_unlock_irqrestore(&sh_cmt_lock, flags);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000196}
197
198static int sh_cmt_enable(struct sh_cmt_priv *p, unsigned long *rate)
199{
Magnus Damm3f7e5e22011-07-13 07:59:48 +0000200 int k, ret;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000201
Rafael J. Wysockibad81382012-08-06 01:48:57 +0200202 pm_runtime_get_sync(&p->pdev->dev);
203 dev_pm_syscore_device(&p->pdev->dev, true);
204
Paul Mundt9436b4a2011-05-31 15:26:42 +0900205 /* enable clock */
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000206 ret = clk_enable(p->clk);
207 if (ret) {
Paul Mundt214a6072010-03-10 16:26:25 +0900208 dev_err(&p->pdev->dev, "cannot enable clock\n");
Magnus Damm3f7e5e22011-07-13 07:59:48 +0000209 goto err0;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000210 }
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000211
212 /* make sure channel is disabled */
213 sh_cmt_start_stop_ch(p, 0);
214
215 /* configure channel, periodic mode and maximum timeout */
Magnus Damm3014f472009-04-29 14:50:37 +0000216 if (p->width == 16) {
217 *rate = clk_get_rate(p->clk) / 512;
Magnus Damm1b56b962012-12-14 14:54:00 +0900218 sh_cmt_write_cmcsr(p, 0x43);
Magnus Damm3014f472009-04-29 14:50:37 +0000219 } else {
220 *rate = clk_get_rate(p->clk) / 8;
Magnus Damm1b56b962012-12-14 14:54:00 +0900221 sh_cmt_write_cmcsr(p, 0x01a4);
Magnus Damm3014f472009-04-29 14:50:37 +0000222 }
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000223
Magnus Damm1b56b962012-12-14 14:54:00 +0900224 sh_cmt_write_cmcor(p, 0xffffffff);
225 sh_cmt_write_cmcnt(p, 0);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000226
Magnus Damm3f7e5e22011-07-13 07:59:48 +0000227 /*
228 * According to the sh73a0 user's manual, as CMCNT can be operated
229 * only by the RCLK (Pseudo 32 KHz), there's one restriction on
230 * modifying CMCNT register; two RCLK cycles are necessary before
231 * this register is either read or any modification of the value
232 * it holds is reflected in the LSI's actual operation.
233 *
234 * While at it, we're supposed to clear out the CMCNT as of this
235 * moment, so make sure it's processed properly here. This will
236 * take RCLKx2 at maximum.
237 */
238 for (k = 0; k < 100; k++) {
Magnus Damm1b56b962012-12-14 14:54:00 +0900239 if (!sh_cmt_read_cmcnt(p))
Magnus Damm3f7e5e22011-07-13 07:59:48 +0000240 break;
241 udelay(1);
242 }
243
Magnus Damm1b56b962012-12-14 14:54:00 +0900244 if (sh_cmt_read_cmcnt(p)) {
Magnus Damm3f7e5e22011-07-13 07:59:48 +0000245 dev_err(&p->pdev->dev, "cannot clear CMCNT\n");
246 ret = -ETIMEDOUT;
247 goto err1;
248 }
249
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000250 /* enable channel */
251 sh_cmt_start_stop_ch(p, 1);
252 return 0;
Magnus Damm3f7e5e22011-07-13 07:59:48 +0000253 err1:
254 /* stop clock */
255 clk_disable(p->clk);
256
257 err0:
258 return ret;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000259}
260
261static void sh_cmt_disable(struct sh_cmt_priv *p)
262{
263 /* disable channel */
264 sh_cmt_start_stop_ch(p, 0);
265
Magnus Dammbe890a12009-06-17 05:04:04 +0000266 /* disable interrupts in CMT block */
Magnus Damm1b56b962012-12-14 14:54:00 +0900267 sh_cmt_write_cmcsr(p, 0);
Magnus Dammbe890a12009-06-17 05:04:04 +0000268
Paul Mundt9436b4a2011-05-31 15:26:42 +0900269 /* stop clock */
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000270 clk_disable(p->clk);
Rafael J. Wysockibad81382012-08-06 01:48:57 +0200271
272 dev_pm_syscore_device(&p->pdev->dev, false);
273 pm_runtime_put(&p->pdev->dev);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000274}
275
276/* private flags */
277#define FLAG_CLOCKEVENT (1 << 0)
278#define FLAG_CLOCKSOURCE (1 << 1)
279#define FLAG_REPROGRAM (1 << 2)
280#define FLAG_SKIPEVENT (1 << 3)
281#define FLAG_IRQCONTEXT (1 << 4)
282
283static void sh_cmt_clock_event_program_verify(struct sh_cmt_priv *p,
284 int absolute)
285{
286 unsigned long new_match;
287 unsigned long value = p->next_match_value;
288 unsigned long delay = 0;
289 unsigned long now = 0;
290 int has_wrapped;
291
292 now = sh_cmt_get_counter(p, &has_wrapped);
293 p->flags |= FLAG_REPROGRAM; /* force reprogram */
294
295 if (has_wrapped) {
296 /* we're competing with the interrupt handler.
297 * -> let the interrupt handler reprogram the timer.
298 * -> interrupt number two handles the event.
299 */
300 p->flags |= FLAG_SKIPEVENT;
301 return;
302 }
303
304 if (absolute)
305 now = 0;
306
307 do {
308 /* reprogram the timer hardware,
309 * but don't save the new match value yet.
310 */
311 new_match = now + value + delay;
312 if (new_match > p->max_match_value)
313 new_match = p->max_match_value;
314
Magnus Damm1b56b962012-12-14 14:54:00 +0900315 sh_cmt_write_cmcor(p, new_match);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000316
317 now = sh_cmt_get_counter(p, &has_wrapped);
318 if (has_wrapped && (new_match > p->match_value)) {
319 /* we are changing to a greater match value,
320 * so this wrap must be caused by the counter
321 * matching the old value.
322 * -> first interrupt reprograms the timer.
323 * -> interrupt number two handles the event.
324 */
325 p->flags |= FLAG_SKIPEVENT;
326 break;
327 }
328
329 if (has_wrapped) {
330 /* we are changing to a smaller match value,
331 * so the wrap must be caused by the counter
332 * matching the new value.
333 * -> save programmed match value.
334 * -> let isr handle the event.
335 */
336 p->match_value = new_match;
337 break;
338 }
339
340 /* be safe: verify hardware settings */
341 if (now < new_match) {
342 /* timer value is below match value, all good.
343 * this makes sure we won't miss any match events.
344 * -> save programmed match value.
345 * -> let isr handle the event.
346 */
347 p->match_value = new_match;
348 break;
349 }
350
351 /* the counter has reached a value greater
352 * than our new match value. and since the
353 * has_wrapped flag isn't set we must have
354 * programmed a too close event.
355 * -> increase delay and retry.
356 */
357 if (delay)
358 delay <<= 1;
359 else
360 delay = 1;
361
362 if (!delay)
Paul Mundt214a6072010-03-10 16:26:25 +0900363 dev_warn(&p->pdev->dev, "too long delay\n");
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000364
365 } while (delay);
366}
367
Takashi YOSHII65ada542010-12-17 07:25:09 +0000368static void __sh_cmt_set_next(struct sh_cmt_priv *p, unsigned long delta)
369{
370 if (delta > p->max_match_value)
371 dev_warn(&p->pdev->dev, "delta out of range\n");
372
373 p->next_match_value = delta;
374 sh_cmt_clock_event_program_verify(p, 0);
375}
376
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000377static void sh_cmt_set_next(struct sh_cmt_priv *p, unsigned long delta)
378{
379 unsigned long flags;
380
Paul Mundt7d0c3992012-05-25 13:36:43 +0900381 raw_spin_lock_irqsave(&p->lock, flags);
Takashi YOSHII65ada542010-12-17 07:25:09 +0000382 __sh_cmt_set_next(p, delta);
Paul Mundt7d0c3992012-05-25 13:36:43 +0900383 raw_spin_unlock_irqrestore(&p->lock, flags);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000384}
385
386static irqreturn_t sh_cmt_interrupt(int irq, void *dev_id)
387{
388 struct sh_cmt_priv *p = dev_id;
389
390 /* clear flags */
Magnus Damm1b56b962012-12-14 14:54:00 +0900391 sh_cmt_write_cmcsr(p, sh_cmt_read_cmcsr(p) & p->clear_bits);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000392
393 /* update clock source counter to begin with if enabled
394 * the wrap flag should be cleared by the timer specific
395 * isr before we end up here.
396 */
397 if (p->flags & FLAG_CLOCKSOURCE)
Magnus Damm43809472010-08-04 04:31:38 +0000398 p->total_cycles += p->match_value + 1;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000399
400 if (!(p->flags & FLAG_REPROGRAM))
401 p->next_match_value = p->max_match_value;
402
403 p->flags |= FLAG_IRQCONTEXT;
404
405 if (p->flags & FLAG_CLOCKEVENT) {
406 if (!(p->flags & FLAG_SKIPEVENT)) {
407 if (p->ced.mode == CLOCK_EVT_MODE_ONESHOT) {
408 p->next_match_value = p->max_match_value;
409 p->flags |= FLAG_REPROGRAM;
410 }
411
412 p->ced.event_handler(&p->ced);
413 }
414 }
415
416 p->flags &= ~FLAG_SKIPEVENT;
417
418 if (p->flags & FLAG_REPROGRAM) {
419 p->flags &= ~FLAG_REPROGRAM;
420 sh_cmt_clock_event_program_verify(p, 1);
421
422 if (p->flags & FLAG_CLOCKEVENT)
423 if ((p->ced.mode == CLOCK_EVT_MODE_SHUTDOWN)
424 || (p->match_value == p->next_match_value))
425 p->flags &= ~FLAG_REPROGRAM;
426 }
427
428 p->flags &= ~FLAG_IRQCONTEXT;
429
430 return IRQ_HANDLED;
431}
432
433static int sh_cmt_start(struct sh_cmt_priv *p, unsigned long flag)
434{
435 int ret = 0;
436 unsigned long flags;
437
Paul Mundt7d0c3992012-05-25 13:36:43 +0900438 raw_spin_lock_irqsave(&p->lock, flags);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000439
440 if (!(p->flags & (FLAG_CLOCKEVENT | FLAG_CLOCKSOURCE)))
441 ret = sh_cmt_enable(p, &p->rate);
442
443 if (ret)
444 goto out;
445 p->flags |= flag;
446
447 /* setup timeout if no clockevent */
448 if ((flag == FLAG_CLOCKSOURCE) && (!(p->flags & FLAG_CLOCKEVENT)))
Takashi YOSHII65ada542010-12-17 07:25:09 +0000449 __sh_cmt_set_next(p, p->max_match_value);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000450 out:
Paul Mundt7d0c3992012-05-25 13:36:43 +0900451 raw_spin_unlock_irqrestore(&p->lock, flags);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000452
453 return ret;
454}
455
456static void sh_cmt_stop(struct sh_cmt_priv *p, unsigned long flag)
457{
458 unsigned long flags;
459 unsigned long f;
460
Paul Mundt7d0c3992012-05-25 13:36:43 +0900461 raw_spin_lock_irqsave(&p->lock, flags);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000462
463 f = p->flags & (FLAG_CLOCKEVENT | FLAG_CLOCKSOURCE);
464 p->flags &= ~flag;
465
466 if (f && !(p->flags & (FLAG_CLOCKEVENT | FLAG_CLOCKSOURCE)))
467 sh_cmt_disable(p);
468
469 /* adjust the timeout to maximum if only clocksource left */
470 if ((flag == FLAG_CLOCKEVENT) && (p->flags & FLAG_CLOCKSOURCE))
Takashi YOSHII65ada542010-12-17 07:25:09 +0000471 __sh_cmt_set_next(p, p->max_match_value);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000472
Paul Mundt7d0c3992012-05-25 13:36:43 +0900473 raw_spin_unlock_irqrestore(&p->lock, flags);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000474}
475
Magnus Damm19bdc9d2009-04-17 05:26:31 +0000476static struct sh_cmt_priv *cs_to_sh_cmt(struct clocksource *cs)
477{
478 return container_of(cs, struct sh_cmt_priv, cs);
479}
480
481static cycle_t sh_cmt_clocksource_read(struct clocksource *cs)
482{
483 struct sh_cmt_priv *p = cs_to_sh_cmt(cs);
484 unsigned long flags, raw;
485 unsigned long value;
486 int has_wrapped;
487
Paul Mundt7d0c3992012-05-25 13:36:43 +0900488 raw_spin_lock_irqsave(&p->lock, flags);
Magnus Damm19bdc9d2009-04-17 05:26:31 +0000489 value = p->total_cycles;
490 raw = sh_cmt_get_counter(p, &has_wrapped);
491
492 if (unlikely(has_wrapped))
Magnus Damm43809472010-08-04 04:31:38 +0000493 raw += p->match_value + 1;
Paul Mundt7d0c3992012-05-25 13:36:43 +0900494 raw_spin_unlock_irqrestore(&p->lock, flags);
Magnus Damm19bdc9d2009-04-17 05:26:31 +0000495
496 return value + raw;
497}
498
499static int sh_cmt_clocksource_enable(struct clocksource *cs)
500{
Magnus Damm3593f5f2011-04-25 22:32:11 +0900501 int ret;
Magnus Damm19bdc9d2009-04-17 05:26:31 +0000502 struct sh_cmt_priv *p = cs_to_sh_cmt(cs);
Magnus Damm19bdc9d2009-04-17 05:26:31 +0000503
Rafael J. Wysockibad81382012-08-06 01:48:57 +0200504 WARN_ON(p->cs_enabled);
505
Magnus Damm19bdc9d2009-04-17 05:26:31 +0000506 p->total_cycles = 0;
507
Magnus Damm3593f5f2011-04-25 22:32:11 +0900508 ret = sh_cmt_start(p, FLAG_CLOCKSOURCE);
Rafael J. Wysockibad81382012-08-06 01:48:57 +0200509 if (!ret) {
Magnus Damm3593f5f2011-04-25 22:32:11 +0900510 __clocksource_updatefreq_hz(cs, p->rate);
Rafael J. Wysockibad81382012-08-06 01:48:57 +0200511 p->cs_enabled = true;
512 }
Magnus Damm3593f5f2011-04-25 22:32:11 +0900513 return ret;
Magnus Damm19bdc9d2009-04-17 05:26:31 +0000514}
515
516static void sh_cmt_clocksource_disable(struct clocksource *cs)
517{
Rafael J. Wysockibad81382012-08-06 01:48:57 +0200518 struct sh_cmt_priv *p = cs_to_sh_cmt(cs);
519
520 WARN_ON(!p->cs_enabled);
521
522 sh_cmt_stop(p, FLAG_CLOCKSOURCE);
523 p->cs_enabled = false;
Magnus Damm19bdc9d2009-04-17 05:26:31 +0000524}
525
Rafael J. Wysocki9bb5ec82012-08-06 01:43:03 +0200526static void sh_cmt_clocksource_suspend(struct clocksource *cs)
527{
528 struct sh_cmt_priv *p = cs_to_sh_cmt(cs);
529
530 sh_cmt_stop(p, FLAG_CLOCKSOURCE);
531 pm_genpd_syscore_poweroff(&p->pdev->dev);
532}
533
Magnus Dammc8162882010-02-02 14:41:40 -0800534static void sh_cmt_clocksource_resume(struct clocksource *cs)
535{
Rafael J. Wysocki9bb5ec82012-08-06 01:43:03 +0200536 struct sh_cmt_priv *p = cs_to_sh_cmt(cs);
537
538 pm_genpd_syscore_poweron(&p->pdev->dev);
539 sh_cmt_start(p, FLAG_CLOCKSOURCE);
Magnus Dammc8162882010-02-02 14:41:40 -0800540}
541
Magnus Damm19bdc9d2009-04-17 05:26:31 +0000542static int sh_cmt_register_clocksource(struct sh_cmt_priv *p,
543 char *name, unsigned long rating)
544{
545 struct clocksource *cs = &p->cs;
546
547 cs->name = name;
548 cs->rating = rating;
549 cs->read = sh_cmt_clocksource_read;
550 cs->enable = sh_cmt_clocksource_enable;
551 cs->disable = sh_cmt_clocksource_disable;
Rafael J. Wysocki9bb5ec82012-08-06 01:43:03 +0200552 cs->suspend = sh_cmt_clocksource_suspend;
Magnus Dammc8162882010-02-02 14:41:40 -0800553 cs->resume = sh_cmt_clocksource_resume;
Magnus Damm19bdc9d2009-04-17 05:26:31 +0000554 cs->mask = CLOCKSOURCE_MASK(sizeof(unsigned long) * 8);
555 cs->flags = CLOCK_SOURCE_IS_CONTINUOUS;
Paul Mundtf4d7c352010-06-02 17:10:44 +0900556
Paul Mundt214a6072010-03-10 16:26:25 +0900557 dev_info(&p->pdev->dev, "used as clock source\n");
Paul Mundtf4d7c352010-06-02 17:10:44 +0900558
Magnus Damm3593f5f2011-04-25 22:32:11 +0900559 /* Register with dummy 1 Hz value, gets updated in ->enable() */
560 clocksource_register_hz(cs, 1);
Magnus Damm19bdc9d2009-04-17 05:26:31 +0000561 return 0;
562}
563
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000564static struct sh_cmt_priv *ced_to_sh_cmt(struct clock_event_device *ced)
565{
566 return container_of(ced, struct sh_cmt_priv, ced);
567}
568
569static void sh_cmt_clock_event_start(struct sh_cmt_priv *p, int periodic)
570{
571 struct clock_event_device *ced = &p->ced;
572
573 sh_cmt_start(p, FLAG_CLOCKEVENT);
574
575 /* TODO: calculate good shift from rate and counter bit width */
576
577 ced->shift = 32;
578 ced->mult = div_sc(p->rate, NSEC_PER_SEC, ced->shift);
579 ced->max_delta_ns = clockevent_delta2ns(p->max_match_value, ced);
580 ced->min_delta_ns = clockevent_delta2ns(0x1f, ced);
581
582 if (periodic)
Magnus Damm43809472010-08-04 04:31:38 +0000583 sh_cmt_set_next(p, ((p->rate + HZ/2) / HZ) - 1);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000584 else
585 sh_cmt_set_next(p, p->max_match_value);
586}
587
588static void sh_cmt_clock_event_mode(enum clock_event_mode mode,
589 struct clock_event_device *ced)
590{
591 struct sh_cmt_priv *p = ced_to_sh_cmt(ced);
592
593 /* deal with old setting first */
594 switch (ced->mode) {
595 case CLOCK_EVT_MODE_PERIODIC:
596 case CLOCK_EVT_MODE_ONESHOT:
597 sh_cmt_stop(p, FLAG_CLOCKEVENT);
598 break;
599 default:
600 break;
601 }
602
603 switch (mode) {
604 case CLOCK_EVT_MODE_PERIODIC:
Paul Mundt214a6072010-03-10 16:26:25 +0900605 dev_info(&p->pdev->dev, "used for periodic clock events\n");
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000606 sh_cmt_clock_event_start(p, 1);
607 break;
608 case CLOCK_EVT_MODE_ONESHOT:
Paul Mundt214a6072010-03-10 16:26:25 +0900609 dev_info(&p->pdev->dev, "used for oneshot clock events\n");
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000610 sh_cmt_clock_event_start(p, 0);
611 break;
612 case CLOCK_EVT_MODE_SHUTDOWN:
613 case CLOCK_EVT_MODE_UNUSED:
614 sh_cmt_stop(p, FLAG_CLOCKEVENT);
615 break;
616 default:
617 break;
618 }
619}
620
621static int sh_cmt_clock_event_next(unsigned long delta,
622 struct clock_event_device *ced)
623{
624 struct sh_cmt_priv *p = ced_to_sh_cmt(ced);
625
626 BUG_ON(ced->mode != CLOCK_EVT_MODE_ONESHOT);
627 if (likely(p->flags & FLAG_IRQCONTEXT))
Magnus Damm43809472010-08-04 04:31:38 +0000628 p->next_match_value = delta - 1;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000629 else
Magnus Damm43809472010-08-04 04:31:38 +0000630 sh_cmt_set_next(p, delta - 1);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000631
632 return 0;
633}
634
Rafael J. Wysocki9bb5ec82012-08-06 01:43:03 +0200635static void sh_cmt_clock_event_suspend(struct clock_event_device *ced)
636{
Laurent Pinchart57dee992013-12-14 15:07:32 +0900637 struct sh_cmt_priv *p = ced_to_sh_cmt(ced);
638
639 pm_genpd_syscore_poweroff(&p->pdev->dev);
640 clk_unprepare(p->clk);
Rafael J. Wysocki9bb5ec82012-08-06 01:43:03 +0200641}
642
643static void sh_cmt_clock_event_resume(struct clock_event_device *ced)
644{
Laurent Pinchart57dee992013-12-14 15:07:32 +0900645 struct sh_cmt_priv *p = ced_to_sh_cmt(ced);
646
647 clk_prepare(p->clk);
648 pm_genpd_syscore_poweron(&p->pdev->dev);
Rafael J. Wysocki9bb5ec82012-08-06 01:43:03 +0200649}
650
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000651static void sh_cmt_register_clockevent(struct sh_cmt_priv *p,
652 char *name, unsigned long rating)
653{
654 struct clock_event_device *ced = &p->ced;
655
656 memset(ced, 0, sizeof(*ced));
657
658 ced->name = name;
659 ced->features = CLOCK_EVT_FEAT_PERIODIC;
660 ced->features |= CLOCK_EVT_FEAT_ONESHOT;
661 ced->rating = rating;
662 ced->cpumask = cpumask_of(0);
663 ced->set_next_event = sh_cmt_clock_event_next;
664 ced->set_mode = sh_cmt_clock_event_mode;
Rafael J. Wysocki9bb5ec82012-08-06 01:43:03 +0200665 ced->suspend = sh_cmt_clock_event_suspend;
666 ced->resume = sh_cmt_clock_event_resume;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000667
Paul Mundt214a6072010-03-10 16:26:25 +0900668 dev_info(&p->pdev->dev, "used for clock events\n");
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000669 clockevents_register_device(ced);
670}
671
Paul Mundtd1fcc0a2009-05-03 18:05:42 +0900672static int sh_cmt_register(struct sh_cmt_priv *p, char *name,
673 unsigned long clockevent_rating,
674 unsigned long clocksource_rating)
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000675{
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000676 if (clockevent_rating)
677 sh_cmt_register_clockevent(p, name, clockevent_rating);
678
Magnus Damm19bdc9d2009-04-17 05:26:31 +0000679 if (clocksource_rating)
680 sh_cmt_register_clocksource(p, name, clocksource_rating);
681
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000682 return 0;
683}
684
685static int sh_cmt_setup(struct sh_cmt_priv *p, struct platform_device *pdev)
686{
Paul Mundt46a12f72009-05-03 17:57:17 +0900687 struct sh_timer_config *cfg = pdev->dev.platform_data;
Magnus Damm8874c5e2013-06-17 15:40:52 +0900688 struct resource *res, *res2;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000689 int irq, ret;
690 ret = -ENXIO;
691
692 memset(p, 0, sizeof(*p));
693 p->pdev = pdev;
694
695 if (!cfg) {
696 dev_err(&p->pdev->dev, "missing platform data\n");
697 goto err0;
698 }
699
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000700 res = platform_get_resource(p->pdev, IORESOURCE_MEM, 0);
701 if (!res) {
702 dev_err(&p->pdev->dev, "failed to get I/O memory\n");
703 goto err0;
704 }
705
Magnus Damm8874c5e2013-06-17 15:40:52 +0900706 /* optional resource for the shared timer start/stop register */
707 res2 = platform_get_resource(p->pdev, IORESOURCE_MEM, 1);
708
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000709 irq = platform_get_irq(p->pdev, 0);
710 if (irq < 0) {
711 dev_err(&p->pdev->dev, "failed to get irq\n");
712 goto err0;
713 }
714
715 /* map memory, let mapbase point to our channel */
716 p->mapbase = ioremap_nocache(res->start, resource_size(res));
717 if (p->mapbase == NULL) {
Paul Mundt214a6072010-03-10 16:26:25 +0900718 dev_err(&p->pdev->dev, "failed to remap I/O memory\n");
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000719 goto err0;
720 }
721
Magnus Damm8874c5e2013-06-17 15:40:52 +0900722 /* map second resource for CMSTR */
723 p->mapbase_str = ioremap_nocache(res2 ? res2->start :
724 res->start - cfg->channel_offset,
725 res2 ? resource_size(res2) : 2);
726 if (p->mapbase_str == NULL) {
727 dev_err(&p->pdev->dev, "failed to remap I/O second memory\n");
728 goto err1;
729 }
730
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000731 /* request irq using setup_irq() (too early for request_irq()) */
Paul Mundt214a6072010-03-10 16:26:25 +0900732 p->irqaction.name = dev_name(&p->pdev->dev);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000733 p->irqaction.handler = sh_cmt_interrupt;
734 p->irqaction.dev_id = p;
Michael Opdenacker38c30a82013-12-09 10:12:10 +0100735 p->irqaction.flags = IRQF_TIMER | IRQF_IRQPOLL | IRQF_NOBALANCING;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000736
737 /* get hold of clock */
Paul Mundtc2a25e82010-03-29 16:55:43 +0900738 p->clk = clk_get(&p->pdev->dev, "cmt_fck");
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000739 if (IS_ERR(p->clk)) {
Magnus Damm03ff8582010-10-13 07:36:38 +0000740 dev_err(&p->pdev->dev, "cannot get clock\n");
741 ret = PTR_ERR(p->clk);
Magnus Damm8874c5e2013-06-17 15:40:52 +0900742 goto err2;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000743 }
744
Laurent Pinchart57dee992013-12-14 15:07:32 +0900745 ret = clk_prepare(p->clk);
746 if (ret < 0)
747 goto err3;
748
Magnus Damm8874c5e2013-06-17 15:40:52 +0900749 if (res2 && (resource_size(res2) == 4)) {
750 /* assume both CMSTR and CMCSR to be 32-bit */
751 p->read_control = sh_cmt_read32;
752 p->write_control = sh_cmt_write32;
753 } else {
754 p->read_control = sh_cmt_read16;
755 p->write_control = sh_cmt_write16;
756 }
Magnus Dammcccd7042012-12-14 14:54:28 +0900757
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000758 if (resource_size(res) == 6) {
759 p->width = 16;
Magnus Damma6a912c2012-12-14 14:54:19 +0900760 p->read_count = sh_cmt_read16;
761 p->write_count = sh_cmt_write16;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000762 p->overflow_bit = 0x80;
Magnus Damm3014f472009-04-29 14:50:37 +0000763 p->clear_bits = ~0x80;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000764 } else {
765 p->width = 32;
Magnus Damma6a912c2012-12-14 14:54:19 +0900766 p->read_count = sh_cmt_read32;
767 p->write_count = sh_cmt_write32;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000768 p->overflow_bit = 0x8000;
769 p->clear_bits = ~0xc000;
770 }
771
Magnus Damm44a10f92012-12-14 14:53:41 +0900772 if (p->width == (sizeof(p->max_match_value) * 8))
773 p->max_match_value = ~0;
774 else
775 p->max_match_value = (1 << p->width) - 1;
776
777 p->match_value = p->max_match_value;
778 raw_spin_lock_init(&p->lock);
779
Paul Mundt214a6072010-03-10 16:26:25 +0900780 ret = sh_cmt_register(p, (char *)dev_name(&p->pdev->dev),
Paul Mundtda64c2a2010-02-25 16:37:46 +0900781 cfg->clockevent_rating,
782 cfg->clocksource_rating);
783 if (ret) {
Paul Mundt214a6072010-03-10 16:26:25 +0900784 dev_err(&p->pdev->dev, "registration failed\n");
Laurent Pinchart57dee992013-12-14 15:07:32 +0900785 goto err4;
Paul Mundtda64c2a2010-02-25 16:37:46 +0900786 }
Rafael J. Wysockibad81382012-08-06 01:48:57 +0200787 p->cs_enabled = false;
Paul Mundtda64c2a2010-02-25 16:37:46 +0900788
789 ret = setup_irq(irq, &p->irqaction);
790 if (ret) {
Paul Mundt214a6072010-03-10 16:26:25 +0900791 dev_err(&p->pdev->dev, "failed to request irq %d\n", irq);
Laurent Pinchart57dee992013-12-14 15:07:32 +0900792 goto err4;
Paul Mundtda64c2a2010-02-25 16:37:46 +0900793 }
794
Magnus Dammadccc692012-12-14 14:53:51 +0900795 platform_set_drvdata(pdev, p);
796
Paul Mundtda64c2a2010-02-25 16:37:46 +0900797 return 0;
Laurent Pinchart57dee992013-12-14 15:07:32 +0900798err4:
799 clk_unprepare(p->clk);
Magnus Damm8874c5e2013-06-17 15:40:52 +0900800err3:
Magnus Damm2fd61b32012-12-14 14:53:32 +0900801 clk_put(p->clk);
Magnus Damm8874c5e2013-06-17 15:40:52 +0900802err2:
803 iounmap(p->mapbase_str);
Paul Mundtda64c2a2010-02-25 16:37:46 +0900804err1:
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000805 iounmap(p->mapbase);
Paul Mundtda64c2a2010-02-25 16:37:46 +0900806err0:
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000807 return ret;
808}
809
Greg Kroah-Hartman18505142012-12-21 15:11:38 -0800810static int sh_cmt_probe(struct platform_device *pdev)
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000811{
812 struct sh_cmt_priv *p = platform_get_drvdata(pdev);
Rafael J. Wysockibad81382012-08-06 01:48:57 +0200813 struct sh_timer_config *cfg = pdev->dev.platform_data;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000814 int ret;
815
Rafael J. Wysocki9bb5ec82012-08-06 01:43:03 +0200816 if (!is_early_platform_device(pdev)) {
Rafael J. Wysockibad81382012-08-06 01:48:57 +0200817 pm_runtime_set_active(&pdev->dev);
818 pm_runtime_enable(&pdev->dev);
Rafael J. Wysocki9bb5ec82012-08-06 01:43:03 +0200819 }
Rafael J. Wysocki615a4452012-03-13 22:40:06 +0100820
Magnus Damme475eed2009-04-15 10:50:04 +0000821 if (p) {
Paul Mundt214a6072010-03-10 16:26:25 +0900822 dev_info(&pdev->dev, "kept as earlytimer\n");
Rafael J. Wysockibad81382012-08-06 01:48:57 +0200823 goto out;
Magnus Damme475eed2009-04-15 10:50:04 +0000824 }
825
Magnus Damm8e0b8422009-04-28 08:19:50 +0000826 p = kmalloc(sizeof(*p), GFP_KERNEL);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000827 if (p == NULL) {
828 dev_err(&pdev->dev, "failed to allocate driver data\n");
829 return -ENOMEM;
830 }
831
832 ret = sh_cmt_setup(p, pdev);
833 if (ret) {
Magnus Damm8e0b8422009-04-28 08:19:50 +0000834 kfree(p);
Rafael J. Wysockibad81382012-08-06 01:48:57 +0200835 pm_runtime_idle(&pdev->dev);
836 return ret;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000837 }
Rafael J. Wysockibad81382012-08-06 01:48:57 +0200838 if (is_early_platform_device(pdev))
839 return 0;
840
841 out:
842 if (cfg->clockevent_rating || cfg->clocksource_rating)
843 pm_runtime_irq_safe(&pdev->dev);
844 else
845 pm_runtime_idle(&pdev->dev);
846
847 return 0;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000848}
849
Greg Kroah-Hartman18505142012-12-21 15:11:38 -0800850static int sh_cmt_remove(struct platform_device *pdev)
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000851{
852 return -EBUSY; /* cannot unregister clockevent and clocksource */
853}
854
855static struct platform_driver sh_cmt_device_driver = {
856 .probe = sh_cmt_probe,
Greg Kroah-Hartman18505142012-12-21 15:11:38 -0800857 .remove = sh_cmt_remove,
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000858 .driver = {
859 .name = "sh_cmt",
860 }
861};
862
863static int __init sh_cmt_init(void)
864{
865 return platform_driver_register(&sh_cmt_device_driver);
866}
867
868static void __exit sh_cmt_exit(void)
869{
870 platform_driver_unregister(&sh_cmt_device_driver);
871}
872
Magnus Damme475eed2009-04-15 10:50:04 +0000873early_platform_init("earlytimer", &sh_cmt_device_driver);
Simon Hormane903a032013-03-05 15:40:42 +0900874subsys_initcall(sh_cmt_init);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000875module_exit(sh_cmt_exit);
876
877MODULE_AUTHOR("Magnus Damm");
878MODULE_DESCRIPTION("SuperH CMT Timer Driver");
879MODULE_LICENSE("GPL v2");