2 * SuperH Timer Support - CMT
4 * Copyright (C) 2008 Magnus Damm
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
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.
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
20 #include <linux/init.h>
21 #include <linux/platform_device.h>
22 #include <linux/spinlock.h>
23 #include <linux/interrupt.h>
24 #include <linux/ioport.h>
26 #include <linux/clk.h>
27 #include <linux/irq.h>
28 #include <linux/err.h>
29 #include <linux/delay.h>
30 #include <linux/clocksource.h>
31 #include <linux/clockchips.h>
32 #include <linux/sh_timer.h>
33 #include <linux/slab.h>
34 #include <linux/module.h>
35 #include <linux/pm_domain.h>
38 void __iomem
*mapbase
;
40 unsigned long width
; /* 16 or 32 bit version of hardware block */
41 unsigned long overflow_bit
;
42 unsigned long clear_bits
;
43 struct irqaction irqaction
;
44 struct platform_device
*pdev
;
47 unsigned long match_value
;
48 unsigned long next_match_value
;
49 unsigned long max_match_value
;
52 struct clock_event_device ced
;
53 struct clocksource cs
;
54 unsigned long total_cycles
;
57 static DEFINE_SPINLOCK(sh_cmt_lock
);
59 #define CMSTR -1 /* shared register */
60 #define CMCSR 0 /* channel register */
61 #define CMCNT 1 /* channel register */
62 #define CMCOR 2 /* channel register */
64 static inline unsigned long sh_cmt_read(struct sh_cmt_priv
*p
, int reg_nr
)
66 struct sh_timer_config
*cfg
= p
->pdev
->dev
.platform_data
;
67 void __iomem
*base
= p
->mapbase
;
70 if (reg_nr
== CMSTR
) {
72 base
-= cfg
->channel_offset
;
80 if ((reg_nr
== CMCNT
) || (reg_nr
== CMCOR
))
81 return ioread32(base
+ offs
);
84 return ioread16(base
+ offs
);
87 static inline void sh_cmt_write(struct sh_cmt_priv
*p
, int reg_nr
,
90 struct sh_timer_config
*cfg
= p
->pdev
->dev
.platform_data
;
91 void __iomem
*base
= p
->mapbase
;
94 if (reg_nr
== CMSTR
) {
96 base
-= cfg
->channel_offset
;
104 if ((reg_nr
== CMCNT
) || (reg_nr
== CMCOR
)) {
105 iowrite32(value
, base
+ offs
);
110 iowrite16(value
, base
+ offs
);
113 static unsigned long sh_cmt_get_counter(struct sh_cmt_priv
*p
,
116 unsigned long v1
, v2
, v3
;
119 o1
= sh_cmt_read(p
, CMCSR
) & p
->overflow_bit
;
121 /* Make sure the timer value is stable. Stolen from acpi_pm.c */
124 v1
= sh_cmt_read(p
, CMCNT
);
125 v2
= sh_cmt_read(p
, CMCNT
);
126 v3
= sh_cmt_read(p
, CMCNT
);
127 o1
= sh_cmt_read(p
, CMCSR
) & p
->overflow_bit
;
128 } while (unlikely((o1
!= o2
) || (v1
> v2
&& v1
< v3
)
129 || (v2
> v3
&& v2
< v1
) || (v3
> v1
&& v3
< v2
)));
136 static void sh_cmt_start_stop_ch(struct sh_cmt_priv
*p
, int start
)
138 struct sh_timer_config
*cfg
= p
->pdev
->dev
.platform_data
;
139 unsigned long flags
, value
;
141 /* start stop register shared by multiple timer channels */
142 spin_lock_irqsave(&sh_cmt_lock
, flags
);
143 value
= sh_cmt_read(p
, CMSTR
);
146 value
|= 1 << cfg
->timer_bit
;
148 value
&= ~(1 << cfg
->timer_bit
);
150 sh_cmt_write(p
, CMSTR
, value
);
151 spin_unlock_irqrestore(&sh_cmt_lock
, flags
);
154 static int sh_cmt_enable(struct sh_cmt_priv
*p
, unsigned long *rate
)
159 ret
= clk_enable(p
->clk
);
161 dev_err(&p
->pdev
->dev
, "cannot enable clock\n");
165 /* make sure channel is disabled */
166 sh_cmt_start_stop_ch(p
, 0);
168 /* configure channel, periodic mode and maximum timeout */
169 if (p
->width
== 16) {
170 *rate
= clk_get_rate(p
->clk
) / 512;
171 sh_cmt_write(p
, CMCSR
, 0x43);
173 *rate
= clk_get_rate(p
->clk
) / 8;
174 sh_cmt_write(p
, CMCSR
, 0x01a4);
177 sh_cmt_write(p
, CMCOR
, 0xffffffff);
178 sh_cmt_write(p
, CMCNT
, 0);
181 * According to the sh73a0 user's manual, as CMCNT can be operated
182 * only by the RCLK (Pseudo 32 KHz), there's one restriction on
183 * modifying CMCNT register; two RCLK cycles are necessary before
184 * this register is either read or any modification of the value
185 * it holds is reflected in the LSI's actual operation.
187 * While at it, we're supposed to clear out the CMCNT as of this
188 * moment, so make sure it's processed properly here. This will
189 * take RCLKx2 at maximum.
191 for (k
= 0; k
< 100; k
++) {
192 if (!sh_cmt_read(p
, CMCNT
))
197 if (sh_cmt_read(p
, CMCNT
)) {
198 dev_err(&p
->pdev
->dev
, "cannot clear CMCNT\n");
204 sh_cmt_start_stop_ch(p
, 1);
214 static void sh_cmt_disable(struct sh_cmt_priv
*p
)
216 /* disable channel */
217 sh_cmt_start_stop_ch(p
, 0);
219 /* disable interrupts in CMT block */
220 sh_cmt_write(p
, CMCSR
, 0);
227 #define FLAG_CLOCKEVENT (1 << 0)
228 #define FLAG_CLOCKSOURCE (1 << 1)
229 #define FLAG_REPROGRAM (1 << 2)
230 #define FLAG_SKIPEVENT (1 << 3)
231 #define FLAG_IRQCONTEXT (1 << 4)
233 static void sh_cmt_clock_event_program_verify(struct sh_cmt_priv
*p
,
236 unsigned long new_match
;
237 unsigned long value
= p
->next_match_value
;
238 unsigned long delay
= 0;
239 unsigned long now
= 0;
242 now
= sh_cmt_get_counter(p
, &has_wrapped
);
243 p
->flags
|= FLAG_REPROGRAM
; /* force reprogram */
246 /* we're competing with the interrupt handler.
247 * -> let the interrupt handler reprogram the timer.
248 * -> interrupt number two handles the event.
250 p
->flags
|= FLAG_SKIPEVENT
;
258 /* reprogram the timer hardware,
259 * but don't save the new match value yet.
261 new_match
= now
+ value
+ delay
;
262 if (new_match
> p
->max_match_value
)
263 new_match
= p
->max_match_value
;
265 sh_cmt_write(p
, CMCOR
, new_match
);
267 now
= sh_cmt_get_counter(p
, &has_wrapped
);
268 if (has_wrapped
&& (new_match
> p
->match_value
)) {
269 /* we are changing to a greater match value,
270 * so this wrap must be caused by the counter
271 * matching the old value.
272 * -> first interrupt reprograms the timer.
273 * -> interrupt number two handles the event.
275 p
->flags
|= FLAG_SKIPEVENT
;
280 /* we are changing to a smaller match value,
281 * so the wrap must be caused by the counter
282 * matching the new value.
283 * -> save programmed match value.
284 * -> let isr handle the event.
286 p
->match_value
= new_match
;
290 /* be safe: verify hardware settings */
291 if (now
< new_match
) {
292 /* timer value is below match value, all good.
293 * this makes sure we won't miss any match events.
294 * -> save programmed match value.
295 * -> let isr handle the event.
297 p
->match_value
= new_match
;
301 /* the counter has reached a value greater
302 * than our new match value. and since the
303 * has_wrapped flag isn't set we must have
304 * programmed a too close event.
305 * -> increase delay and retry.
313 dev_warn(&p
->pdev
->dev
, "too long delay\n");
318 static void __sh_cmt_set_next(struct sh_cmt_priv
*p
, unsigned long delta
)
320 if (delta
> p
->max_match_value
)
321 dev_warn(&p
->pdev
->dev
, "delta out of range\n");
323 p
->next_match_value
= delta
;
324 sh_cmt_clock_event_program_verify(p
, 0);
327 static void sh_cmt_set_next(struct sh_cmt_priv
*p
, unsigned long delta
)
331 spin_lock_irqsave(&p
->lock
, flags
);
332 __sh_cmt_set_next(p
, delta
);
333 spin_unlock_irqrestore(&p
->lock
, flags
);
336 static irqreturn_t
sh_cmt_interrupt(int irq
, void *dev_id
)
338 struct sh_cmt_priv
*p
= dev_id
;
341 sh_cmt_write(p
, CMCSR
, sh_cmt_read(p
, CMCSR
) & p
->clear_bits
);
343 /* update clock source counter to begin with if enabled
344 * the wrap flag should be cleared by the timer specific
345 * isr before we end up here.
347 if (p
->flags
& FLAG_CLOCKSOURCE
)
348 p
->total_cycles
+= p
->match_value
+ 1;
350 if (!(p
->flags
& FLAG_REPROGRAM
))
351 p
->next_match_value
= p
->max_match_value
;
353 p
->flags
|= FLAG_IRQCONTEXT
;
355 if (p
->flags
& FLAG_CLOCKEVENT
) {
356 if (!(p
->flags
& FLAG_SKIPEVENT
)) {
357 if (p
->ced
.mode
== CLOCK_EVT_MODE_ONESHOT
) {
358 p
->next_match_value
= p
->max_match_value
;
359 p
->flags
|= FLAG_REPROGRAM
;
362 p
->ced
.event_handler(&p
->ced
);
366 p
->flags
&= ~FLAG_SKIPEVENT
;
368 if (p
->flags
& FLAG_REPROGRAM
) {
369 p
->flags
&= ~FLAG_REPROGRAM
;
370 sh_cmt_clock_event_program_verify(p
, 1);
372 if (p
->flags
& FLAG_CLOCKEVENT
)
373 if ((p
->ced
.mode
== CLOCK_EVT_MODE_SHUTDOWN
)
374 || (p
->match_value
== p
->next_match_value
))
375 p
->flags
&= ~FLAG_REPROGRAM
;
378 p
->flags
&= ~FLAG_IRQCONTEXT
;
383 static int sh_cmt_start(struct sh_cmt_priv
*p
, unsigned long flag
)
388 spin_lock_irqsave(&p
->lock
, flags
);
390 if (!(p
->flags
& (FLAG_CLOCKEVENT
| FLAG_CLOCKSOURCE
)))
391 ret
= sh_cmt_enable(p
, &p
->rate
);
397 /* setup timeout if no clockevent */
398 if ((flag
== FLAG_CLOCKSOURCE
) && (!(p
->flags
& FLAG_CLOCKEVENT
)))
399 __sh_cmt_set_next(p
, p
->max_match_value
);
401 spin_unlock_irqrestore(&p
->lock
, flags
);
406 static void sh_cmt_stop(struct sh_cmt_priv
*p
, unsigned long flag
)
411 spin_lock_irqsave(&p
->lock
, flags
);
413 f
= p
->flags
& (FLAG_CLOCKEVENT
| FLAG_CLOCKSOURCE
);
416 if (f
&& !(p
->flags
& (FLAG_CLOCKEVENT
| FLAG_CLOCKSOURCE
)))
419 /* adjust the timeout to maximum if only clocksource left */
420 if ((flag
== FLAG_CLOCKEVENT
) && (p
->flags
& FLAG_CLOCKSOURCE
))
421 __sh_cmt_set_next(p
, p
->max_match_value
);
423 spin_unlock_irqrestore(&p
->lock
, flags
);
426 static struct sh_cmt_priv
*cs_to_sh_cmt(struct clocksource
*cs
)
428 return container_of(cs
, struct sh_cmt_priv
, cs
);
431 static cycle_t
sh_cmt_clocksource_read(struct clocksource
*cs
)
433 struct sh_cmt_priv
*p
= cs_to_sh_cmt(cs
);
434 unsigned long flags
, raw
;
438 spin_lock_irqsave(&p
->lock
, flags
);
439 value
= p
->total_cycles
;
440 raw
= sh_cmt_get_counter(p
, &has_wrapped
);
442 if (unlikely(has_wrapped
))
443 raw
+= p
->match_value
+ 1;
444 spin_unlock_irqrestore(&p
->lock
, flags
);
449 static int sh_cmt_clocksource_enable(struct clocksource
*cs
)
452 struct sh_cmt_priv
*p
= cs_to_sh_cmt(cs
);
456 ret
= sh_cmt_start(p
, FLAG_CLOCKSOURCE
);
458 __clocksource_updatefreq_hz(cs
, p
->rate
);
462 static void sh_cmt_clocksource_disable(struct clocksource
*cs
)
464 sh_cmt_stop(cs_to_sh_cmt(cs
), FLAG_CLOCKSOURCE
);
467 static void sh_cmt_clocksource_resume(struct clocksource
*cs
)
469 sh_cmt_start(cs_to_sh_cmt(cs
), FLAG_CLOCKSOURCE
);
472 static int sh_cmt_register_clocksource(struct sh_cmt_priv
*p
,
473 char *name
, unsigned long rating
)
475 struct clocksource
*cs
= &p
->cs
;
479 cs
->read
= sh_cmt_clocksource_read
;
480 cs
->enable
= sh_cmt_clocksource_enable
;
481 cs
->disable
= sh_cmt_clocksource_disable
;
482 cs
->suspend
= sh_cmt_clocksource_disable
;
483 cs
->resume
= sh_cmt_clocksource_resume
;
484 cs
->mask
= CLOCKSOURCE_MASK(sizeof(unsigned long) * 8);
485 cs
->flags
= CLOCK_SOURCE_IS_CONTINUOUS
;
487 dev_info(&p
->pdev
->dev
, "used as clock source\n");
489 /* Register with dummy 1 Hz value, gets updated in ->enable() */
490 clocksource_register_hz(cs
, 1);
494 static struct sh_cmt_priv
*ced_to_sh_cmt(struct clock_event_device
*ced
)
496 return container_of(ced
, struct sh_cmt_priv
, ced
);
499 static void sh_cmt_clock_event_start(struct sh_cmt_priv
*p
, int periodic
)
501 struct clock_event_device
*ced
= &p
->ced
;
503 sh_cmt_start(p
, FLAG_CLOCKEVENT
);
505 /* TODO: calculate good shift from rate and counter bit width */
508 ced
->mult
= div_sc(p
->rate
, NSEC_PER_SEC
, ced
->shift
);
509 ced
->max_delta_ns
= clockevent_delta2ns(p
->max_match_value
, ced
);
510 ced
->min_delta_ns
= clockevent_delta2ns(0x1f, ced
);
513 sh_cmt_set_next(p
, ((p
->rate
+ HZ
/2) / HZ
) - 1);
515 sh_cmt_set_next(p
, p
->max_match_value
);
518 static void sh_cmt_clock_event_mode(enum clock_event_mode mode
,
519 struct clock_event_device
*ced
)
521 struct sh_cmt_priv
*p
= ced_to_sh_cmt(ced
);
523 /* deal with old setting first */
525 case CLOCK_EVT_MODE_PERIODIC
:
526 case CLOCK_EVT_MODE_ONESHOT
:
527 sh_cmt_stop(p
, FLAG_CLOCKEVENT
);
534 case CLOCK_EVT_MODE_PERIODIC
:
535 dev_info(&p
->pdev
->dev
, "used for periodic clock events\n");
536 sh_cmt_clock_event_start(p
, 1);
538 case CLOCK_EVT_MODE_ONESHOT
:
539 dev_info(&p
->pdev
->dev
, "used for oneshot clock events\n");
540 sh_cmt_clock_event_start(p
, 0);
542 case CLOCK_EVT_MODE_SHUTDOWN
:
543 case CLOCK_EVT_MODE_UNUSED
:
544 sh_cmt_stop(p
, FLAG_CLOCKEVENT
);
551 static int sh_cmt_clock_event_next(unsigned long delta
,
552 struct clock_event_device
*ced
)
554 struct sh_cmt_priv
*p
= ced_to_sh_cmt(ced
);
556 BUG_ON(ced
->mode
!= CLOCK_EVT_MODE_ONESHOT
);
557 if (likely(p
->flags
& FLAG_IRQCONTEXT
))
558 p
->next_match_value
= delta
- 1;
560 sh_cmt_set_next(p
, delta
- 1);
565 static void sh_cmt_register_clockevent(struct sh_cmt_priv
*p
,
566 char *name
, unsigned long rating
)
568 struct clock_event_device
*ced
= &p
->ced
;
570 memset(ced
, 0, sizeof(*ced
));
573 ced
->features
= CLOCK_EVT_FEAT_PERIODIC
;
574 ced
->features
|= CLOCK_EVT_FEAT_ONESHOT
;
575 ced
->rating
= rating
;
576 ced
->cpumask
= cpumask_of(0);
577 ced
->set_next_event
= sh_cmt_clock_event_next
;
578 ced
->set_mode
= sh_cmt_clock_event_mode
;
580 dev_info(&p
->pdev
->dev
, "used for clock events\n");
581 clockevents_register_device(ced
);
584 static int sh_cmt_register(struct sh_cmt_priv
*p
, char *name
,
585 unsigned long clockevent_rating
,
586 unsigned long clocksource_rating
)
588 if (p
->width
== (sizeof(p
->max_match_value
) * 8))
589 p
->max_match_value
= ~0;
591 p
->max_match_value
= (1 << p
->width
) - 1;
593 p
->match_value
= p
->max_match_value
;
594 spin_lock_init(&p
->lock
);
596 if (clockevent_rating
)
597 sh_cmt_register_clockevent(p
, name
, clockevent_rating
);
599 if (clocksource_rating
)
600 sh_cmt_register_clocksource(p
, name
, clocksource_rating
);
605 static int sh_cmt_setup(struct sh_cmt_priv
*p
, struct platform_device
*pdev
)
607 struct sh_timer_config
*cfg
= pdev
->dev
.platform_data
;
608 struct resource
*res
;
612 memset(p
, 0, sizeof(*p
));
616 dev_err(&p
->pdev
->dev
, "missing platform data\n");
620 platform_set_drvdata(pdev
, p
);
622 res
= platform_get_resource(p
->pdev
, IORESOURCE_MEM
, 0);
624 dev_err(&p
->pdev
->dev
, "failed to get I/O memory\n");
628 irq
= platform_get_irq(p
->pdev
, 0);
630 dev_err(&p
->pdev
->dev
, "failed to get irq\n");
634 /* map memory, let mapbase point to our channel */
635 p
->mapbase
= ioremap_nocache(res
->start
, resource_size(res
));
636 if (p
->mapbase
== NULL
) {
637 dev_err(&p
->pdev
->dev
, "failed to remap I/O memory\n");
641 /* request irq using setup_irq() (too early for request_irq()) */
642 p
->irqaction
.name
= dev_name(&p
->pdev
->dev
);
643 p
->irqaction
.handler
= sh_cmt_interrupt
;
644 p
->irqaction
.dev_id
= p
;
645 p
->irqaction
.flags
= IRQF_DISABLED
| IRQF_TIMER
| \
646 IRQF_IRQPOLL
| IRQF_NOBALANCING
;
648 /* get hold of clock */
649 p
->clk
= clk_get(&p
->pdev
->dev
, "cmt_fck");
650 if (IS_ERR(p
->clk
)) {
651 dev_err(&p
->pdev
->dev
, "cannot get clock\n");
652 ret
= PTR_ERR(p
->clk
);
656 if (resource_size(res
) == 6) {
658 p
->overflow_bit
= 0x80;
659 p
->clear_bits
= ~0x80;
662 p
->overflow_bit
= 0x8000;
663 p
->clear_bits
= ~0xc000;
666 ret
= sh_cmt_register(p
, (char *)dev_name(&p
->pdev
->dev
),
667 cfg
->clockevent_rating
,
668 cfg
->clocksource_rating
);
670 dev_err(&p
->pdev
->dev
, "registration failed\n");
674 ret
= setup_irq(irq
, &p
->irqaction
);
676 dev_err(&p
->pdev
->dev
, "failed to request irq %d\n", irq
);
688 static int __devinit
sh_cmt_probe(struct platform_device
*pdev
)
690 struct sh_cmt_priv
*p
= platform_get_drvdata(pdev
);
693 if (!is_early_platform_device(pdev
))
694 pm_genpd_dev_always_on(&pdev
->dev
, true);
697 dev_info(&pdev
->dev
, "kept as earlytimer\n");
701 p
= kmalloc(sizeof(*p
), GFP_KERNEL
);
703 dev_err(&pdev
->dev
, "failed to allocate driver data\n");
707 ret
= sh_cmt_setup(p
, pdev
);
710 platform_set_drvdata(pdev
, NULL
);
715 static int __devexit
sh_cmt_remove(struct platform_device
*pdev
)
717 return -EBUSY
; /* cannot unregister clockevent and clocksource */
720 static struct platform_driver sh_cmt_device_driver
= {
721 .probe
= sh_cmt_probe
,
722 .remove
= __devexit_p(sh_cmt_remove
),
728 static int __init
sh_cmt_init(void)
730 return platform_driver_register(&sh_cmt_device_driver
);
733 static void __exit
sh_cmt_exit(void)
735 platform_driver_unregister(&sh_cmt_device_driver
);
738 early_platform_init("earlytimer", &sh_cmt_device_driver
);
739 module_init(sh_cmt_init
);
740 module_exit(sh_cmt_exit
);
742 MODULE_AUTHOR("Magnus Damm");
743 MODULE_DESCRIPTION("SuperH CMT Timer Driver");
744 MODULE_LICENSE("GPL v2");