blob: 08d0c418c94ae5ed3e4c5791ab929fc6501d0de3 [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;
40 struct clk *clk;
41 unsigned long width; /* 16 or 32 bit version of hardware block */
42 unsigned long overflow_bit;
43 unsigned long clear_bits;
44 struct irqaction irqaction;
45 struct platform_device *pdev;
46
47 unsigned long flags;
48 unsigned long match_value;
49 unsigned long next_match_value;
50 unsigned long max_match_value;
51 unsigned long rate;
Paul Mundt7d0c3992012-05-25 13:36:43 +090052 raw_spinlock_t lock;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +000053 struct clock_event_device ced;
Magnus Damm19bdc9d2009-04-17 05:26:31 +000054 struct clocksource cs;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +000055 unsigned long total_cycles;
Rafael J. Wysockibad81382012-08-06 01:48:57 +020056 bool cs_enabled;
Magnus Damma6a912c2012-12-14 14:54:19 +090057
Magnus Dammcccd7042012-12-14 14:54:28 +090058 /* callbacks for CMSTR and CMCSR access */
59 unsigned long (*read_control)(void __iomem *base, unsigned long offs);
60 void (*write_control)(void __iomem *base, unsigned long offs,
61 unsigned long value);
62
Magnus Damma6a912c2012-12-14 14:54:19 +090063 /* callbacks for CMCNT and CMCOR access */
64 unsigned long (*read_count)(void __iomem *base, unsigned long offs);
65 void (*write_count)(void __iomem *base, unsigned long offs,
66 unsigned long value);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +000067};
68
Magnus Damm118aee42012-12-14 14:54:37 +090069/* Examples of supported CMT timer register layouts and I/O access widths:
70 *
71 * "16-bit counter and 16-bit control" as found on sh7263:
72 * CMSTR 0xfffec000 16-bit
73 * CMCSR 0xfffec002 16-bit
74 * CMCNT 0xfffec004 16-bit
75 * CMCOR 0xfffec006 16-bit
76 *
77 * "32-bit counter and 16-bit control" as found on sh7372, sh73a0, r8a7740:
78 * CMSTR 0xffca0000 16-bit
79 * CMCSR 0xffca0060 16-bit
80 * CMCNT 0xffca0064 32-bit
81 * CMCOR 0xffca0068 32-bit
82 */
83
Magnus Damma6a912c2012-12-14 14:54:19 +090084static unsigned long sh_cmt_read16(void __iomem *base, unsigned long offs)
Magnus Damm587acb32012-12-14 14:54:10 +090085{
86 return ioread16(base + (offs << 1));
87}
Magnus Damm3fb1b6a2009-01-22 09:55:59 +000088
Magnus Damma6a912c2012-12-14 14:54:19 +090089static unsigned long sh_cmt_read32(void __iomem *base, unsigned long offs)
90{
91 return ioread32(base + (offs << 2));
92}
93
94static void sh_cmt_write16(void __iomem *base, unsigned long offs,
95 unsigned long value)
Magnus Damm587acb32012-12-14 14:54:10 +090096{
97 iowrite16(value, base + (offs << 1));
98}
99
Magnus Damma6a912c2012-12-14 14:54:19 +0900100static void sh_cmt_write32(void __iomem *base, unsigned long offs,
101 unsigned long value)
102{
103 iowrite32(value, base + (offs << 2));
104}
105
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000106#define CMCSR 0 /* channel register */
107#define CMCNT 1 /* channel register */
108#define CMCOR 2 /* channel register */
109
Magnus Damm1b56b962012-12-14 14:54:00 +0900110static inline unsigned long sh_cmt_read_cmstr(struct sh_cmt_priv *p)
111{
Magnus Damm587acb32012-12-14 14:54:10 +0900112 struct sh_timer_config *cfg = p->pdev->dev.platform_data;
113
Magnus Dammcccd7042012-12-14 14:54:28 +0900114 return p->read_control(p->mapbase - cfg->channel_offset, 0);
Magnus Damm1b56b962012-12-14 14:54:00 +0900115}
116
117static inline unsigned long sh_cmt_read_cmcsr(struct sh_cmt_priv *p)
118{
Magnus Dammcccd7042012-12-14 14:54:28 +0900119 return p->read_control(p->mapbase, CMCSR);
Magnus Damm1b56b962012-12-14 14:54:00 +0900120}
121
122static inline unsigned long sh_cmt_read_cmcnt(struct sh_cmt_priv *p)
123{
Magnus Damma6a912c2012-12-14 14:54:19 +0900124 return p->read_count(p->mapbase, CMCNT);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000125}
126
Magnus Damm1b56b962012-12-14 14:54:00 +0900127static inline void sh_cmt_write_cmstr(struct sh_cmt_priv *p,
128 unsigned long value)
129{
Magnus Damm587acb32012-12-14 14:54:10 +0900130 struct sh_timer_config *cfg = p->pdev->dev.platform_data;
131
Magnus Dammcccd7042012-12-14 14:54:28 +0900132 p->write_control(p->mapbase - cfg->channel_offset, 0, value);
Magnus Damm1b56b962012-12-14 14:54:00 +0900133}
134
135static inline void sh_cmt_write_cmcsr(struct sh_cmt_priv *p,
136 unsigned long value)
137{
Magnus Dammcccd7042012-12-14 14:54:28 +0900138 p->write_control(p->mapbase, CMCSR, value);
Magnus Damm1b56b962012-12-14 14:54:00 +0900139}
140
141static inline void sh_cmt_write_cmcnt(struct sh_cmt_priv *p,
142 unsigned long value)
143{
Magnus Damma6a912c2012-12-14 14:54:19 +0900144 p->write_count(p->mapbase, CMCNT, value);
Magnus Damm1b56b962012-12-14 14:54:00 +0900145}
146
147static inline void sh_cmt_write_cmcor(struct sh_cmt_priv *p,
148 unsigned long value)
149{
Magnus Damma6a912c2012-12-14 14:54:19 +0900150 p->write_count(p->mapbase, CMCOR, value);
Magnus Damm1b56b962012-12-14 14:54:00 +0900151}
152
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000153static unsigned long sh_cmt_get_counter(struct sh_cmt_priv *p,
154 int *has_wrapped)
155{
156 unsigned long v1, v2, v3;
Magnus Damm5b644c72009-04-28 08:17:54 +0000157 int o1, o2;
158
Magnus Damm1b56b962012-12-14 14:54:00 +0900159 o1 = sh_cmt_read_cmcsr(p) & p->overflow_bit;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000160
161 /* Make sure the timer value is stable. Stolen from acpi_pm.c */
162 do {
Magnus Damm5b644c72009-04-28 08:17:54 +0000163 o2 = o1;
Magnus Damm1b56b962012-12-14 14:54:00 +0900164 v1 = sh_cmt_read_cmcnt(p);
165 v2 = sh_cmt_read_cmcnt(p);
166 v3 = sh_cmt_read_cmcnt(p);
167 o1 = sh_cmt_read_cmcsr(p) & p->overflow_bit;
Magnus Damm5b644c72009-04-28 08:17:54 +0000168 } while (unlikely((o1 != o2) || (v1 > v2 && v1 < v3)
169 || (v2 > v3 && v2 < v1) || (v3 > v1 && v3 < v2)));
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000170
Magnus Damm5b644c72009-04-28 08:17:54 +0000171 *has_wrapped = o1;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000172 return v2;
173}
174
Magnus Damm587acb32012-12-14 14:54:10 +0900175static DEFINE_RAW_SPINLOCK(sh_cmt_lock);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000176
177static void sh_cmt_start_stop_ch(struct sh_cmt_priv *p, int start)
178{
Paul Mundt46a12f72009-05-03 17:57:17 +0900179 struct sh_timer_config *cfg = p->pdev->dev.platform_data;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000180 unsigned long flags, value;
181
182 /* start stop register shared by multiple timer channels */
Paul Mundt7d0c3992012-05-25 13:36:43 +0900183 raw_spin_lock_irqsave(&sh_cmt_lock, flags);
Magnus Damm1b56b962012-12-14 14:54:00 +0900184 value = sh_cmt_read_cmstr(p);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000185
186 if (start)
187 value |= 1 << cfg->timer_bit;
188 else
189 value &= ~(1 << cfg->timer_bit);
190
Magnus Damm1b56b962012-12-14 14:54:00 +0900191 sh_cmt_write_cmstr(p, value);
Paul Mundt7d0c3992012-05-25 13:36:43 +0900192 raw_spin_unlock_irqrestore(&sh_cmt_lock, flags);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000193}
194
195static int sh_cmt_enable(struct sh_cmt_priv *p, unsigned long *rate)
196{
Magnus Damm3f7e5e22011-07-13 07:59:48 +0000197 int k, ret;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000198
Rafael J. Wysockibad81382012-08-06 01:48:57 +0200199 pm_runtime_get_sync(&p->pdev->dev);
200 dev_pm_syscore_device(&p->pdev->dev, true);
201
Paul Mundt9436b4a2011-05-31 15:26:42 +0900202 /* enable clock */
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000203 ret = clk_enable(p->clk);
204 if (ret) {
Paul Mundt214a6072010-03-10 16:26:25 +0900205 dev_err(&p->pdev->dev, "cannot enable clock\n");
Magnus Damm3f7e5e22011-07-13 07:59:48 +0000206 goto err0;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000207 }
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000208
209 /* make sure channel is disabled */
210 sh_cmt_start_stop_ch(p, 0);
211
212 /* configure channel, periodic mode and maximum timeout */
Magnus Damm3014f472009-04-29 14:50:37 +0000213 if (p->width == 16) {
214 *rate = clk_get_rate(p->clk) / 512;
Magnus Damm1b56b962012-12-14 14:54:00 +0900215 sh_cmt_write_cmcsr(p, 0x43);
Magnus Damm3014f472009-04-29 14:50:37 +0000216 } else {
217 *rate = clk_get_rate(p->clk) / 8;
Magnus Damm1b56b962012-12-14 14:54:00 +0900218 sh_cmt_write_cmcsr(p, 0x01a4);
Magnus Damm3014f472009-04-29 14:50:37 +0000219 }
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000220
Magnus Damm1b56b962012-12-14 14:54:00 +0900221 sh_cmt_write_cmcor(p, 0xffffffff);
222 sh_cmt_write_cmcnt(p, 0);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000223
Magnus Damm3f7e5e22011-07-13 07:59:48 +0000224 /*
225 * According to the sh73a0 user's manual, as CMCNT can be operated
226 * only by the RCLK (Pseudo 32 KHz), there's one restriction on
227 * modifying CMCNT register; two RCLK cycles are necessary before
228 * this register is either read or any modification of the value
229 * it holds is reflected in the LSI's actual operation.
230 *
231 * While at it, we're supposed to clear out the CMCNT as of this
232 * moment, so make sure it's processed properly here. This will
233 * take RCLKx2 at maximum.
234 */
235 for (k = 0; k < 100; k++) {
Magnus Damm1b56b962012-12-14 14:54:00 +0900236 if (!sh_cmt_read_cmcnt(p))
Magnus Damm3f7e5e22011-07-13 07:59:48 +0000237 break;
238 udelay(1);
239 }
240
Magnus Damm1b56b962012-12-14 14:54:00 +0900241 if (sh_cmt_read_cmcnt(p)) {
Magnus Damm3f7e5e22011-07-13 07:59:48 +0000242 dev_err(&p->pdev->dev, "cannot clear CMCNT\n");
243 ret = -ETIMEDOUT;
244 goto err1;
245 }
246
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000247 /* enable channel */
248 sh_cmt_start_stop_ch(p, 1);
249 return 0;
Magnus Damm3f7e5e22011-07-13 07:59:48 +0000250 err1:
251 /* stop clock */
252 clk_disable(p->clk);
253
254 err0:
255 return ret;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000256}
257
258static void sh_cmt_disable(struct sh_cmt_priv *p)
259{
260 /* disable channel */
261 sh_cmt_start_stop_ch(p, 0);
262
Magnus Dammbe890a12009-06-17 05:04:04 +0000263 /* disable interrupts in CMT block */
Magnus Damm1b56b962012-12-14 14:54:00 +0900264 sh_cmt_write_cmcsr(p, 0);
Magnus Dammbe890a12009-06-17 05:04:04 +0000265
Paul Mundt9436b4a2011-05-31 15:26:42 +0900266 /* stop clock */
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000267 clk_disable(p->clk);
Rafael J. Wysockibad81382012-08-06 01:48:57 +0200268
269 dev_pm_syscore_device(&p->pdev->dev, false);
270 pm_runtime_put(&p->pdev->dev);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000271}
272
273/* private flags */
274#define FLAG_CLOCKEVENT (1 << 0)
275#define FLAG_CLOCKSOURCE (1 << 1)
276#define FLAG_REPROGRAM (1 << 2)
277#define FLAG_SKIPEVENT (1 << 3)
278#define FLAG_IRQCONTEXT (1 << 4)
279
280static void sh_cmt_clock_event_program_verify(struct sh_cmt_priv *p,
281 int absolute)
282{
283 unsigned long new_match;
284 unsigned long value = p->next_match_value;
285 unsigned long delay = 0;
286 unsigned long now = 0;
287 int has_wrapped;
288
289 now = sh_cmt_get_counter(p, &has_wrapped);
290 p->flags |= FLAG_REPROGRAM; /* force reprogram */
291
292 if (has_wrapped) {
293 /* we're competing with the interrupt handler.
294 * -> let the interrupt handler reprogram the timer.
295 * -> interrupt number two handles the event.
296 */
297 p->flags |= FLAG_SKIPEVENT;
298 return;
299 }
300
301 if (absolute)
302 now = 0;
303
304 do {
305 /* reprogram the timer hardware,
306 * but don't save the new match value yet.
307 */
308 new_match = now + value + delay;
309 if (new_match > p->max_match_value)
310 new_match = p->max_match_value;
311
Magnus Damm1b56b962012-12-14 14:54:00 +0900312 sh_cmt_write_cmcor(p, new_match);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000313
314 now = sh_cmt_get_counter(p, &has_wrapped);
315 if (has_wrapped && (new_match > p->match_value)) {
316 /* we are changing to a greater match value,
317 * so this wrap must be caused by the counter
318 * matching the old value.
319 * -> first interrupt reprograms the timer.
320 * -> interrupt number two handles the event.
321 */
322 p->flags |= FLAG_SKIPEVENT;
323 break;
324 }
325
326 if (has_wrapped) {
327 /* we are changing to a smaller match value,
328 * so the wrap must be caused by the counter
329 * matching the new value.
330 * -> save programmed match value.
331 * -> let isr handle the event.
332 */
333 p->match_value = new_match;
334 break;
335 }
336
337 /* be safe: verify hardware settings */
338 if (now < new_match) {
339 /* timer value is below match value, all good.
340 * this makes sure we won't miss any match events.
341 * -> save programmed match value.
342 * -> let isr handle the event.
343 */
344 p->match_value = new_match;
345 break;
346 }
347
348 /* the counter has reached a value greater
349 * than our new match value. and since the
350 * has_wrapped flag isn't set we must have
351 * programmed a too close event.
352 * -> increase delay and retry.
353 */
354 if (delay)
355 delay <<= 1;
356 else
357 delay = 1;
358
359 if (!delay)
Paul Mundt214a6072010-03-10 16:26:25 +0900360 dev_warn(&p->pdev->dev, "too long delay\n");
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000361
362 } while (delay);
363}
364
Takashi YOSHII65ada542010-12-17 07:25:09 +0000365static void __sh_cmt_set_next(struct sh_cmt_priv *p, unsigned long delta)
366{
367 if (delta > p->max_match_value)
368 dev_warn(&p->pdev->dev, "delta out of range\n");
369
370 p->next_match_value = delta;
371 sh_cmt_clock_event_program_verify(p, 0);
372}
373
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000374static void sh_cmt_set_next(struct sh_cmt_priv *p, unsigned long delta)
375{
376 unsigned long flags;
377
Paul Mundt7d0c3992012-05-25 13:36:43 +0900378 raw_spin_lock_irqsave(&p->lock, flags);
Takashi YOSHII65ada542010-12-17 07:25:09 +0000379 __sh_cmt_set_next(p, delta);
Paul Mundt7d0c3992012-05-25 13:36:43 +0900380 raw_spin_unlock_irqrestore(&p->lock, flags);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000381}
382
383static irqreturn_t sh_cmt_interrupt(int irq, void *dev_id)
384{
385 struct sh_cmt_priv *p = dev_id;
386
387 /* clear flags */
Magnus Damm1b56b962012-12-14 14:54:00 +0900388 sh_cmt_write_cmcsr(p, sh_cmt_read_cmcsr(p) & p->clear_bits);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000389
390 /* update clock source counter to begin with if enabled
391 * the wrap flag should be cleared by the timer specific
392 * isr before we end up here.
393 */
394 if (p->flags & FLAG_CLOCKSOURCE)
Magnus Damm43809472010-08-04 04:31:38 +0000395 p->total_cycles += p->match_value + 1;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000396
397 if (!(p->flags & FLAG_REPROGRAM))
398 p->next_match_value = p->max_match_value;
399
400 p->flags |= FLAG_IRQCONTEXT;
401
402 if (p->flags & FLAG_CLOCKEVENT) {
403 if (!(p->flags & FLAG_SKIPEVENT)) {
404 if (p->ced.mode == CLOCK_EVT_MODE_ONESHOT) {
405 p->next_match_value = p->max_match_value;
406 p->flags |= FLAG_REPROGRAM;
407 }
408
409 p->ced.event_handler(&p->ced);
410 }
411 }
412
413 p->flags &= ~FLAG_SKIPEVENT;
414
415 if (p->flags & FLAG_REPROGRAM) {
416 p->flags &= ~FLAG_REPROGRAM;
417 sh_cmt_clock_event_program_verify(p, 1);
418
419 if (p->flags & FLAG_CLOCKEVENT)
420 if ((p->ced.mode == CLOCK_EVT_MODE_SHUTDOWN)
421 || (p->match_value == p->next_match_value))
422 p->flags &= ~FLAG_REPROGRAM;
423 }
424
425 p->flags &= ~FLAG_IRQCONTEXT;
426
427 return IRQ_HANDLED;
428}
429
430static int sh_cmt_start(struct sh_cmt_priv *p, unsigned long flag)
431{
432 int ret = 0;
433 unsigned long flags;
434
Paul Mundt7d0c3992012-05-25 13:36:43 +0900435 raw_spin_lock_irqsave(&p->lock, flags);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000436
437 if (!(p->flags & (FLAG_CLOCKEVENT | FLAG_CLOCKSOURCE)))
438 ret = sh_cmt_enable(p, &p->rate);
439
440 if (ret)
441 goto out;
442 p->flags |= flag;
443
444 /* setup timeout if no clockevent */
445 if ((flag == FLAG_CLOCKSOURCE) && (!(p->flags & FLAG_CLOCKEVENT)))
Takashi YOSHII65ada542010-12-17 07:25:09 +0000446 __sh_cmt_set_next(p, p->max_match_value);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000447 out:
Paul Mundt7d0c3992012-05-25 13:36:43 +0900448 raw_spin_unlock_irqrestore(&p->lock, flags);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000449
450 return ret;
451}
452
453static void sh_cmt_stop(struct sh_cmt_priv *p, unsigned long flag)
454{
455 unsigned long flags;
456 unsigned long f;
457
Paul Mundt7d0c3992012-05-25 13:36:43 +0900458 raw_spin_lock_irqsave(&p->lock, flags);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000459
460 f = p->flags & (FLAG_CLOCKEVENT | FLAG_CLOCKSOURCE);
461 p->flags &= ~flag;
462
463 if (f && !(p->flags & (FLAG_CLOCKEVENT | FLAG_CLOCKSOURCE)))
464 sh_cmt_disable(p);
465
466 /* adjust the timeout to maximum if only clocksource left */
467 if ((flag == FLAG_CLOCKEVENT) && (p->flags & FLAG_CLOCKSOURCE))
Takashi YOSHII65ada542010-12-17 07:25:09 +0000468 __sh_cmt_set_next(p, p->max_match_value);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000469
Paul Mundt7d0c3992012-05-25 13:36:43 +0900470 raw_spin_unlock_irqrestore(&p->lock, flags);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000471}
472
Magnus Damm19bdc9d2009-04-17 05:26:31 +0000473static struct sh_cmt_priv *cs_to_sh_cmt(struct clocksource *cs)
474{
475 return container_of(cs, struct sh_cmt_priv, cs);
476}
477
478static cycle_t sh_cmt_clocksource_read(struct clocksource *cs)
479{
480 struct sh_cmt_priv *p = cs_to_sh_cmt(cs);
481 unsigned long flags, raw;
482 unsigned long value;
483 int has_wrapped;
484
Paul Mundt7d0c3992012-05-25 13:36:43 +0900485 raw_spin_lock_irqsave(&p->lock, flags);
Magnus Damm19bdc9d2009-04-17 05:26:31 +0000486 value = p->total_cycles;
487 raw = sh_cmt_get_counter(p, &has_wrapped);
488
489 if (unlikely(has_wrapped))
Magnus Damm43809472010-08-04 04:31:38 +0000490 raw += p->match_value + 1;
Paul Mundt7d0c3992012-05-25 13:36:43 +0900491 raw_spin_unlock_irqrestore(&p->lock, flags);
Magnus Damm19bdc9d2009-04-17 05:26:31 +0000492
493 return value + raw;
494}
495
496static int sh_cmt_clocksource_enable(struct clocksource *cs)
497{
Magnus Damm3593f5f2011-04-25 22:32:11 +0900498 int ret;
Magnus Damm19bdc9d2009-04-17 05:26:31 +0000499 struct sh_cmt_priv *p = cs_to_sh_cmt(cs);
Magnus Damm19bdc9d2009-04-17 05:26:31 +0000500
Rafael J. Wysockibad81382012-08-06 01:48:57 +0200501 WARN_ON(p->cs_enabled);
502
Magnus Damm19bdc9d2009-04-17 05:26:31 +0000503 p->total_cycles = 0;
504
Magnus Damm3593f5f2011-04-25 22:32:11 +0900505 ret = sh_cmt_start(p, FLAG_CLOCKSOURCE);
Rafael J. Wysockibad81382012-08-06 01:48:57 +0200506 if (!ret) {
Magnus Damm3593f5f2011-04-25 22:32:11 +0900507 __clocksource_updatefreq_hz(cs, p->rate);
Rafael J. Wysockibad81382012-08-06 01:48:57 +0200508 p->cs_enabled = true;
509 }
Magnus Damm3593f5f2011-04-25 22:32:11 +0900510 return ret;
Magnus Damm19bdc9d2009-04-17 05:26:31 +0000511}
512
513static void sh_cmt_clocksource_disable(struct clocksource *cs)
514{
Rafael J. Wysockibad81382012-08-06 01:48:57 +0200515 struct sh_cmt_priv *p = cs_to_sh_cmt(cs);
516
517 WARN_ON(!p->cs_enabled);
518
519 sh_cmt_stop(p, FLAG_CLOCKSOURCE);
520 p->cs_enabled = false;
Magnus Damm19bdc9d2009-04-17 05:26:31 +0000521}
522
Rafael J. Wysocki9bb5ec82012-08-06 01:43:03 +0200523static void sh_cmt_clocksource_suspend(struct clocksource *cs)
524{
525 struct sh_cmt_priv *p = cs_to_sh_cmt(cs);
526
527 sh_cmt_stop(p, FLAG_CLOCKSOURCE);
528 pm_genpd_syscore_poweroff(&p->pdev->dev);
529}
530
Magnus Dammc8162882010-02-02 14:41:40 -0800531static void sh_cmt_clocksource_resume(struct clocksource *cs)
532{
Rafael J. Wysocki9bb5ec82012-08-06 01:43:03 +0200533 struct sh_cmt_priv *p = cs_to_sh_cmt(cs);
534
535 pm_genpd_syscore_poweron(&p->pdev->dev);
536 sh_cmt_start(p, FLAG_CLOCKSOURCE);
Magnus Dammc8162882010-02-02 14:41:40 -0800537}
538
Magnus Damm19bdc9d2009-04-17 05:26:31 +0000539static int sh_cmt_register_clocksource(struct sh_cmt_priv *p,
540 char *name, unsigned long rating)
541{
542 struct clocksource *cs = &p->cs;
543
544 cs->name = name;
545 cs->rating = rating;
546 cs->read = sh_cmt_clocksource_read;
547 cs->enable = sh_cmt_clocksource_enable;
548 cs->disable = sh_cmt_clocksource_disable;
Rafael J. Wysocki9bb5ec82012-08-06 01:43:03 +0200549 cs->suspend = sh_cmt_clocksource_suspend;
Magnus Dammc8162882010-02-02 14:41:40 -0800550 cs->resume = sh_cmt_clocksource_resume;
Magnus Damm19bdc9d2009-04-17 05:26:31 +0000551 cs->mask = CLOCKSOURCE_MASK(sizeof(unsigned long) * 8);
552 cs->flags = CLOCK_SOURCE_IS_CONTINUOUS;
Paul Mundtf4d7c352010-06-02 17:10:44 +0900553
Paul Mundt214a6072010-03-10 16:26:25 +0900554 dev_info(&p->pdev->dev, "used as clock source\n");
Paul Mundtf4d7c352010-06-02 17:10:44 +0900555
Magnus Damm3593f5f2011-04-25 22:32:11 +0900556 /* Register with dummy 1 Hz value, gets updated in ->enable() */
557 clocksource_register_hz(cs, 1);
Magnus Damm19bdc9d2009-04-17 05:26:31 +0000558 return 0;
559}
560
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000561static struct sh_cmt_priv *ced_to_sh_cmt(struct clock_event_device *ced)
562{
563 return container_of(ced, struct sh_cmt_priv, ced);
564}
565
566static void sh_cmt_clock_event_start(struct sh_cmt_priv *p, int periodic)
567{
568 struct clock_event_device *ced = &p->ced;
569
570 sh_cmt_start(p, FLAG_CLOCKEVENT);
571
572 /* TODO: calculate good shift from rate and counter bit width */
573
574 ced->shift = 32;
575 ced->mult = div_sc(p->rate, NSEC_PER_SEC, ced->shift);
576 ced->max_delta_ns = clockevent_delta2ns(p->max_match_value, ced);
577 ced->min_delta_ns = clockevent_delta2ns(0x1f, ced);
578
579 if (periodic)
Magnus Damm43809472010-08-04 04:31:38 +0000580 sh_cmt_set_next(p, ((p->rate + HZ/2) / HZ) - 1);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000581 else
582 sh_cmt_set_next(p, p->max_match_value);
583}
584
585static void sh_cmt_clock_event_mode(enum clock_event_mode mode,
586 struct clock_event_device *ced)
587{
588 struct sh_cmt_priv *p = ced_to_sh_cmt(ced);
589
590 /* deal with old setting first */
591 switch (ced->mode) {
592 case CLOCK_EVT_MODE_PERIODIC:
593 case CLOCK_EVT_MODE_ONESHOT:
594 sh_cmt_stop(p, FLAG_CLOCKEVENT);
595 break;
596 default:
597 break;
598 }
599
600 switch (mode) {
601 case CLOCK_EVT_MODE_PERIODIC:
Paul Mundt214a6072010-03-10 16:26:25 +0900602 dev_info(&p->pdev->dev, "used for periodic clock events\n");
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000603 sh_cmt_clock_event_start(p, 1);
604 break;
605 case CLOCK_EVT_MODE_ONESHOT:
Paul Mundt214a6072010-03-10 16:26:25 +0900606 dev_info(&p->pdev->dev, "used for oneshot clock events\n");
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000607 sh_cmt_clock_event_start(p, 0);
608 break;
609 case CLOCK_EVT_MODE_SHUTDOWN:
610 case CLOCK_EVT_MODE_UNUSED:
611 sh_cmt_stop(p, FLAG_CLOCKEVENT);
612 break;
613 default:
614 break;
615 }
616}
617
618static int sh_cmt_clock_event_next(unsigned long delta,
619 struct clock_event_device *ced)
620{
621 struct sh_cmt_priv *p = ced_to_sh_cmt(ced);
622
623 BUG_ON(ced->mode != CLOCK_EVT_MODE_ONESHOT);
624 if (likely(p->flags & FLAG_IRQCONTEXT))
Magnus Damm43809472010-08-04 04:31:38 +0000625 p->next_match_value = delta - 1;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000626 else
Magnus Damm43809472010-08-04 04:31:38 +0000627 sh_cmt_set_next(p, delta - 1);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000628
629 return 0;
630}
631
Rafael J. Wysocki9bb5ec82012-08-06 01:43:03 +0200632static void sh_cmt_clock_event_suspend(struct clock_event_device *ced)
633{
634 pm_genpd_syscore_poweroff(&ced_to_sh_cmt(ced)->pdev->dev);
635}
636
637static void sh_cmt_clock_event_resume(struct clock_event_device *ced)
638{
639 pm_genpd_syscore_poweron(&ced_to_sh_cmt(ced)->pdev->dev);
640}
641
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000642static void sh_cmt_register_clockevent(struct sh_cmt_priv *p,
643 char *name, unsigned long rating)
644{
645 struct clock_event_device *ced = &p->ced;
646
647 memset(ced, 0, sizeof(*ced));
648
649 ced->name = name;
650 ced->features = CLOCK_EVT_FEAT_PERIODIC;
651 ced->features |= CLOCK_EVT_FEAT_ONESHOT;
652 ced->rating = rating;
653 ced->cpumask = cpumask_of(0);
654 ced->set_next_event = sh_cmt_clock_event_next;
655 ced->set_mode = sh_cmt_clock_event_mode;
Rafael J. Wysocki9bb5ec82012-08-06 01:43:03 +0200656 ced->suspend = sh_cmt_clock_event_suspend;
657 ced->resume = sh_cmt_clock_event_resume;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000658
Paul Mundt214a6072010-03-10 16:26:25 +0900659 dev_info(&p->pdev->dev, "used for clock events\n");
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000660 clockevents_register_device(ced);
661}
662
Paul Mundtd1fcc0a2009-05-03 18:05:42 +0900663static int sh_cmt_register(struct sh_cmt_priv *p, char *name,
664 unsigned long clockevent_rating,
665 unsigned long clocksource_rating)
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000666{
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000667 if (clockevent_rating)
668 sh_cmt_register_clockevent(p, name, clockevent_rating);
669
Magnus Damm19bdc9d2009-04-17 05:26:31 +0000670 if (clocksource_rating)
671 sh_cmt_register_clocksource(p, name, clocksource_rating);
672
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000673 return 0;
674}
675
676static int sh_cmt_setup(struct sh_cmt_priv *p, struct platform_device *pdev)
677{
Paul Mundt46a12f72009-05-03 17:57:17 +0900678 struct sh_timer_config *cfg = pdev->dev.platform_data;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000679 struct resource *res;
680 int irq, ret;
681 ret = -ENXIO;
682
683 memset(p, 0, sizeof(*p));
684 p->pdev = pdev;
685
686 if (!cfg) {
687 dev_err(&p->pdev->dev, "missing platform data\n");
688 goto err0;
689 }
690
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000691 res = platform_get_resource(p->pdev, IORESOURCE_MEM, 0);
692 if (!res) {
693 dev_err(&p->pdev->dev, "failed to get I/O memory\n");
694 goto err0;
695 }
696
697 irq = platform_get_irq(p->pdev, 0);
698 if (irq < 0) {
699 dev_err(&p->pdev->dev, "failed to get irq\n");
700 goto err0;
701 }
702
703 /* map memory, let mapbase point to our channel */
704 p->mapbase = ioremap_nocache(res->start, resource_size(res));
705 if (p->mapbase == NULL) {
Paul Mundt214a6072010-03-10 16:26:25 +0900706 dev_err(&p->pdev->dev, "failed to remap I/O memory\n");
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000707 goto err0;
708 }
709
710 /* request irq using setup_irq() (too early for request_irq()) */
Paul Mundt214a6072010-03-10 16:26:25 +0900711 p->irqaction.name = dev_name(&p->pdev->dev);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000712 p->irqaction.handler = sh_cmt_interrupt;
713 p->irqaction.dev_id = p;
Paul Mundtfecf0662010-04-15 11:59:28 +0900714 p->irqaction.flags = IRQF_DISABLED | IRQF_TIMER | \
715 IRQF_IRQPOLL | IRQF_NOBALANCING;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000716
717 /* get hold of clock */
Paul Mundtc2a25e82010-03-29 16:55:43 +0900718 p->clk = clk_get(&p->pdev->dev, "cmt_fck");
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000719 if (IS_ERR(p->clk)) {
Magnus Damm03ff8582010-10-13 07:36:38 +0000720 dev_err(&p->pdev->dev, "cannot get clock\n");
721 ret = PTR_ERR(p->clk);
722 goto err1;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000723 }
724
Magnus Dammcccd7042012-12-14 14:54:28 +0900725 p->read_control = sh_cmt_read16;
726 p->write_control = sh_cmt_write16;
727
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000728 if (resource_size(res) == 6) {
729 p->width = 16;
Magnus Damma6a912c2012-12-14 14:54:19 +0900730 p->read_count = sh_cmt_read16;
731 p->write_count = sh_cmt_write16;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000732 p->overflow_bit = 0x80;
Magnus Damm3014f472009-04-29 14:50:37 +0000733 p->clear_bits = ~0x80;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000734 } else {
735 p->width = 32;
Magnus Damma6a912c2012-12-14 14:54:19 +0900736 p->read_count = sh_cmt_read32;
737 p->write_count = sh_cmt_write32;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000738 p->overflow_bit = 0x8000;
739 p->clear_bits = ~0xc000;
740 }
741
Magnus Damm44a10f92012-12-14 14:53:41 +0900742 if (p->width == (sizeof(p->max_match_value) * 8))
743 p->max_match_value = ~0;
744 else
745 p->max_match_value = (1 << p->width) - 1;
746
747 p->match_value = p->max_match_value;
748 raw_spin_lock_init(&p->lock);
749
Paul Mundt214a6072010-03-10 16:26:25 +0900750 ret = sh_cmt_register(p, (char *)dev_name(&p->pdev->dev),
Paul Mundtda64c2a2010-02-25 16:37:46 +0900751 cfg->clockevent_rating,
752 cfg->clocksource_rating);
753 if (ret) {
Paul Mundt214a6072010-03-10 16:26:25 +0900754 dev_err(&p->pdev->dev, "registration failed\n");
Magnus Damm2fd61b32012-12-14 14:53:32 +0900755 goto err2;
Paul Mundtda64c2a2010-02-25 16:37:46 +0900756 }
Rafael J. Wysockibad81382012-08-06 01:48:57 +0200757 p->cs_enabled = false;
Paul Mundtda64c2a2010-02-25 16:37:46 +0900758
759 ret = setup_irq(irq, &p->irqaction);
760 if (ret) {
Paul Mundt214a6072010-03-10 16:26:25 +0900761 dev_err(&p->pdev->dev, "failed to request irq %d\n", irq);
Magnus Damm2fd61b32012-12-14 14:53:32 +0900762 goto err2;
Paul Mundtda64c2a2010-02-25 16:37:46 +0900763 }
764
Magnus Dammadccc692012-12-14 14:53:51 +0900765 platform_set_drvdata(pdev, p);
766
Paul Mundtda64c2a2010-02-25 16:37:46 +0900767 return 0;
Magnus Damm2fd61b32012-12-14 14:53:32 +0900768err2:
769 clk_put(p->clk);
Paul Mundtda64c2a2010-02-25 16:37:46 +0900770
771err1:
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000772 iounmap(p->mapbase);
Paul Mundtda64c2a2010-02-25 16:37:46 +0900773err0:
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000774 return ret;
775}
776
Greg Kroah-Hartman18505142012-12-21 15:11:38 -0800777static int sh_cmt_probe(struct platform_device *pdev)
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000778{
779 struct sh_cmt_priv *p = platform_get_drvdata(pdev);
Rafael J. Wysockibad81382012-08-06 01:48:57 +0200780 struct sh_timer_config *cfg = pdev->dev.platform_data;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000781 int ret;
782
Rafael J. Wysocki9bb5ec82012-08-06 01:43:03 +0200783 if (!is_early_platform_device(pdev)) {
Rafael J. Wysockibad81382012-08-06 01:48:57 +0200784 pm_runtime_set_active(&pdev->dev);
785 pm_runtime_enable(&pdev->dev);
Rafael J. Wysocki9bb5ec82012-08-06 01:43:03 +0200786 }
Rafael J. Wysocki615a4452012-03-13 22:40:06 +0100787
Magnus Damme475eed2009-04-15 10:50:04 +0000788 if (p) {
Paul Mundt214a6072010-03-10 16:26:25 +0900789 dev_info(&pdev->dev, "kept as earlytimer\n");
Rafael J. Wysockibad81382012-08-06 01:48:57 +0200790 goto out;
Magnus Damme475eed2009-04-15 10:50:04 +0000791 }
792
Magnus Damm8e0b8422009-04-28 08:19:50 +0000793 p = kmalloc(sizeof(*p), GFP_KERNEL);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000794 if (p == NULL) {
795 dev_err(&pdev->dev, "failed to allocate driver data\n");
796 return -ENOMEM;
797 }
798
799 ret = sh_cmt_setup(p, pdev);
800 if (ret) {
Magnus Damm8e0b8422009-04-28 08:19:50 +0000801 kfree(p);
Rafael J. Wysockibad81382012-08-06 01:48:57 +0200802 pm_runtime_idle(&pdev->dev);
803 return ret;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000804 }
Rafael J. Wysockibad81382012-08-06 01:48:57 +0200805 if (is_early_platform_device(pdev))
806 return 0;
807
808 out:
809 if (cfg->clockevent_rating || cfg->clocksource_rating)
810 pm_runtime_irq_safe(&pdev->dev);
811 else
812 pm_runtime_idle(&pdev->dev);
813
814 return 0;
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000815}
816
Greg Kroah-Hartman18505142012-12-21 15:11:38 -0800817static int sh_cmt_remove(struct platform_device *pdev)
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000818{
819 return -EBUSY; /* cannot unregister clockevent and clocksource */
820}
821
822static struct platform_driver sh_cmt_device_driver = {
823 .probe = sh_cmt_probe,
Greg Kroah-Hartman18505142012-12-21 15:11:38 -0800824 .remove = sh_cmt_remove,
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000825 .driver = {
826 .name = "sh_cmt",
827 }
828};
829
830static int __init sh_cmt_init(void)
831{
832 return platform_driver_register(&sh_cmt_device_driver);
833}
834
835static void __exit sh_cmt_exit(void)
836{
837 platform_driver_unregister(&sh_cmt_device_driver);
838}
839
Magnus Damme475eed2009-04-15 10:50:04 +0000840early_platform_init("earlytimer", &sh_cmt_device_driver);
Simon Hormane903a032013-03-05 15:40:42 +0900841subsys_initcall(sh_cmt_init);
Magnus Damm3fb1b6a2009-01-22 09:55:59 +0000842module_exit(sh_cmt_exit);
843
844MODULE_AUTHOR("Magnus Damm");
845MODULE_DESCRIPTION("SuperH CMT Timer Driver");
846MODULE_LICENSE("GPL v2");