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>
36 #include <linux/pm_runtime.h>
39 void __iomem *mapbase;
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;
48 unsigned long match_value;
49 unsigned long next_match_value;
50 unsigned long max_match_value;
53 struct clock_event_device ced;
54 struct clocksource cs;
55 unsigned long total_cycles;
59 static DEFINE_RAW_SPINLOCK(sh_cmt_lock);
61 #define CMSTR -1 /* shared register */
62 #define CMCSR 0 /* channel register */
63 #define CMCNT 1 /* channel register */
64 #define CMCOR 2 /* channel register */
66 static inline unsigned long sh_cmt_read(struct sh_cmt_priv *p, int reg_nr)
68 struct sh_timer_config *cfg = p->pdev->dev.platform_data;
69 void __iomem *base = p->mapbase;
72 if (reg_nr == CMSTR) {
74 base -= cfg->channel_offset;
82 if ((reg_nr == CMCNT) || (reg_nr == CMCOR))
83 return ioread32(base + offs);
86 return ioread16(base + offs);
89 static inline void sh_cmt_write(struct sh_cmt_priv *p, int reg_nr,
92 struct sh_timer_config *cfg = p->pdev->dev.platform_data;
93 void __iomem *base = p->mapbase;
96 if (reg_nr == CMSTR) {
98 base -= cfg->channel_offset;
106 if ((reg_nr == CMCNT) || (reg_nr == CMCOR)) {
107 iowrite32(value, base + offs);
112 iowrite16(value, base + offs);
115 static unsigned long sh_cmt_get_counter(struct sh_cmt_priv *p,
118 unsigned long v1, v2, v3;
121 o1 = sh_cmt_read(p, CMCSR) & p->overflow_bit;
123 /* Make sure the timer value is stable. Stolen from acpi_pm.c */
126 v1 = sh_cmt_read(p, CMCNT);
127 v2 = sh_cmt_read(p, CMCNT);
128 v3 = sh_cmt_read(p, CMCNT);
129 o1 = sh_cmt_read(p, CMCSR) & p->overflow_bit;
130 } while (unlikely((o1 != o2) || (v1 > v2 && v1 < v3)
131 || (v2 > v3 && v2 < v1) || (v3 > v1 && v3 < v2)));
138 static void sh_cmt_start_stop_ch(struct sh_cmt_priv *p, int start)
140 struct sh_timer_config *cfg = p->pdev->dev.platform_data;
141 unsigned long flags, value;
143 /* start stop register shared by multiple timer channels */
144 raw_spin_lock_irqsave(&sh_cmt_lock, flags);
145 value = sh_cmt_read(p, CMSTR);
148 value |= 1 << cfg->timer_bit;
150 value &= ~(1 << cfg->timer_bit);
152 sh_cmt_write(p, CMSTR, value);
153 raw_spin_unlock_irqrestore(&sh_cmt_lock, flags);
156 static int sh_cmt_enable(struct sh_cmt_priv *p, unsigned long *rate)
160 pm_runtime_get_sync(&p->pdev->dev);
161 dev_pm_syscore_device(&p->pdev->dev, true);
164 ret = clk_enable(p->clk);
166 dev_err(&p->pdev->dev, "cannot enable clock\n");
170 /* make sure channel is disabled */
171 sh_cmt_start_stop_ch(p, 0);
173 /* configure channel, periodic mode and maximum timeout */
174 if (p->width == 16) {
175 *rate = clk_get_rate(p->clk) / 512;
176 sh_cmt_write(p, CMCSR, 0x43);
178 *rate = clk_get_rate(p->clk) / 8;
179 sh_cmt_write(p, CMCSR, 0x01a4);
182 sh_cmt_write(p, CMCOR, 0xffffffff);
183 sh_cmt_write(p, CMCNT, 0);
186 * According to the sh73a0 user's manual, as CMCNT can be operated
187 * only by the RCLK (Pseudo 32 KHz), there's one restriction on
188 * modifying CMCNT register; two RCLK cycles are necessary before
189 * this register is either read or any modification of the value
190 * it holds is reflected in the LSI's actual operation.
192 * While at it, we're supposed to clear out the CMCNT as of this
193 * moment, so make sure it's processed properly here. This will
194 * take RCLKx2 at maximum.
196 for (k = 0; k < 100; k++) {
197 if (!sh_cmt_read(p, CMCNT))
202 if (sh_cmt_read(p, CMCNT)) {
203 dev_err(&p->pdev->dev, "cannot clear CMCNT\n");
209 sh_cmt_start_stop_ch(p, 1);
219 static void sh_cmt_disable(struct sh_cmt_priv *p)
221 /* disable channel */
222 sh_cmt_start_stop_ch(p, 0);
224 /* disable interrupts in CMT block */
225 sh_cmt_write(p, CMCSR, 0);
230 dev_pm_syscore_device(&p->pdev->dev, false);
231 pm_runtime_put(&p->pdev->dev);
235 #define FLAG_CLOCKEVENT (1 << 0)
236 #define FLAG_CLOCKSOURCE (1 << 1)
237 #define FLAG_REPROGRAM (1 << 2)
238 #define FLAG_SKIPEVENT (1 << 3)
239 #define FLAG_IRQCONTEXT (1 << 4)
241 static void sh_cmt_clock_event_program_verify(struct sh_cmt_priv *p,
244 unsigned long new_match;
245 unsigned long value = p->next_match_value;
246 unsigned long delay = 0;
247 unsigned long now = 0;
250 now = sh_cmt_get_counter(p, &has_wrapped);
251 p->flags |= FLAG_REPROGRAM; /* force reprogram */
254 /* we're competing with the interrupt handler.
255 * -> let the interrupt handler reprogram the timer.
256 * -> interrupt number two handles the event.
258 p->flags |= FLAG_SKIPEVENT;
266 /* reprogram the timer hardware,
267 * but don't save the new match value yet.
269 new_match = now + value + delay;
270 if (new_match > p->max_match_value)
271 new_match = p->max_match_value;
273 sh_cmt_write(p, CMCOR, new_match);
275 now = sh_cmt_get_counter(p, &has_wrapped);
276 if (has_wrapped && (new_match > p->match_value)) {
277 /* we are changing to a greater match value,
278 * so this wrap must be caused by the counter
279 * matching the old value.
280 * -> first interrupt reprograms the timer.
281 * -> interrupt number two handles the event.
283 p->flags |= FLAG_SKIPEVENT;
288 /* we are changing to a smaller match value,
289 * so the wrap must be caused by the counter
290 * matching the new value.
291 * -> save programmed match value.
292 * -> let isr handle the event.
294 p->match_value = new_match;
298 /* be safe: verify hardware settings */
299 if (now < new_match) {
300 /* timer value is below match value, all good.
301 * this makes sure we won't miss any match events.
302 * -> save programmed match value.
303 * -> let isr handle the event.
305 p->match_value = new_match;
309 /* the counter has reached a value greater
310 * than our new match value. and since the
311 * has_wrapped flag isn't set we must have
312 * programmed a too close event.
313 * -> increase delay and retry.
321 dev_warn(&p->pdev->dev, "too long delay\n");
326 static void __sh_cmt_set_next(struct sh_cmt_priv *p, unsigned long delta)
328 if (delta > p->max_match_value)
329 dev_warn(&p->pdev->dev, "delta out of range\n");
331 p->next_match_value = delta;
332 sh_cmt_clock_event_program_verify(p, 0);
335 static void sh_cmt_set_next(struct sh_cmt_priv *p, unsigned long delta)
339 raw_spin_lock_irqsave(&p->lock, flags);
340 __sh_cmt_set_next(p, delta);
341 raw_spin_unlock_irqrestore(&p->lock, flags);
344 static irqreturn_t sh_cmt_interrupt(int irq, void *dev_id)
346 struct sh_cmt_priv *p = dev_id;
349 sh_cmt_write(p, CMCSR, sh_cmt_read(p, CMCSR) & p->clear_bits);
351 /* update clock source counter to begin with if enabled
352 * the wrap flag should be cleared by the timer specific
353 * isr before we end up here.
355 if (p->flags & FLAG_CLOCKSOURCE)
356 p->total_cycles += p->match_value + 1;
358 if (!(p->flags & FLAG_REPROGRAM))
359 p->next_match_value = p->max_match_value;
361 p->flags |= FLAG_IRQCONTEXT;
363 if (p->flags & FLAG_CLOCKEVENT) {
364 if (!(p->flags & FLAG_SKIPEVENT)) {
365 if (p->ced.mode == CLOCK_EVT_MODE_ONESHOT) {
366 p->next_match_value = p->max_match_value;
367 p->flags |= FLAG_REPROGRAM;
370 p->ced.event_handler(&p->ced);
374 p->flags &= ~FLAG_SKIPEVENT;
376 if (p->flags & FLAG_REPROGRAM) {
377 p->flags &= ~FLAG_REPROGRAM;
378 sh_cmt_clock_event_program_verify(p, 1);
380 if (p->flags & FLAG_CLOCKEVENT)
381 if ((p->ced.mode == CLOCK_EVT_MODE_SHUTDOWN)
382 || (p->match_value == p->next_match_value))
383 p->flags &= ~FLAG_REPROGRAM;
386 p->flags &= ~FLAG_IRQCONTEXT;
391 static int sh_cmt_start(struct sh_cmt_priv *p, unsigned long flag)
396 raw_spin_lock_irqsave(&p->lock, flags);
398 if (!(p->flags & (FLAG_CLOCKEVENT | FLAG_CLOCKSOURCE)))
399 ret = sh_cmt_enable(p, &p->rate);
405 /* setup timeout if no clockevent */
406 if ((flag == FLAG_CLOCKSOURCE) && (!(p->flags & FLAG_CLOCKEVENT)))
407 __sh_cmt_set_next(p, p->max_match_value);
409 raw_spin_unlock_irqrestore(&p->lock, flags);
414 static void sh_cmt_stop(struct sh_cmt_priv *p, unsigned long flag)
419 raw_spin_lock_irqsave(&p->lock, flags);
421 f = p->flags & (FLAG_CLOCKEVENT | FLAG_CLOCKSOURCE);
424 if (f && !(p->flags & (FLAG_CLOCKEVENT | FLAG_CLOCKSOURCE)))
427 /* adjust the timeout to maximum if only clocksource left */
428 if ((flag == FLAG_CLOCKEVENT) && (p->flags & FLAG_CLOCKSOURCE))
429 __sh_cmt_set_next(p, p->max_match_value);
431 raw_spin_unlock_irqrestore(&p->lock, flags);
434 static struct sh_cmt_priv *cs_to_sh_cmt(struct clocksource *cs)
436 return container_of(cs, struct sh_cmt_priv, cs);
439 static cycle_t sh_cmt_clocksource_read(struct clocksource *cs)
441 struct sh_cmt_priv *p = cs_to_sh_cmt(cs);
442 unsigned long flags, raw;
446 raw_spin_lock_irqsave(&p->lock, flags);
447 value = p->total_cycles;
448 raw = sh_cmt_get_counter(p, &has_wrapped);
450 if (unlikely(has_wrapped))
451 raw += p->match_value + 1;
452 raw_spin_unlock_irqrestore(&p->lock, flags);
457 static int sh_cmt_clocksource_enable(struct clocksource *cs)
460 struct sh_cmt_priv *p = cs_to_sh_cmt(cs);
462 WARN_ON(p->cs_enabled);
466 ret = sh_cmt_start(p, FLAG_CLOCKSOURCE);
468 __clocksource_updatefreq_hz(cs, p->rate);
469 p->cs_enabled = true;
474 static void sh_cmt_clocksource_disable(struct clocksource *cs)
476 struct sh_cmt_priv *p = cs_to_sh_cmt(cs);
478 WARN_ON(!p->cs_enabled);
480 sh_cmt_stop(p, FLAG_CLOCKSOURCE);
481 p->cs_enabled = false;
484 static void sh_cmt_clocksource_suspend(struct clocksource *cs)
486 struct sh_cmt_priv *p = cs_to_sh_cmt(cs);
488 sh_cmt_stop(p, FLAG_CLOCKSOURCE);
489 pm_genpd_syscore_poweroff(&p->pdev->dev);
492 static void sh_cmt_clocksource_resume(struct clocksource *cs)
494 struct sh_cmt_priv *p = cs_to_sh_cmt(cs);
496 pm_genpd_syscore_poweron(&p->pdev->dev);
497 sh_cmt_start(p, FLAG_CLOCKSOURCE);
500 static int sh_cmt_register_clocksource(struct sh_cmt_priv *p,
501 char *name, unsigned long rating)
503 struct clocksource *cs = &p->cs;
507 cs->read = sh_cmt_clocksource_read;
508 cs->enable = sh_cmt_clocksource_enable;
509 cs->disable = sh_cmt_clocksource_disable;
510 cs->suspend = sh_cmt_clocksource_suspend;
511 cs->resume = sh_cmt_clocksource_resume;
512 cs->mask = CLOCKSOURCE_MASK(sizeof(unsigned long) * 8);
513 cs->flags = CLOCK_SOURCE_IS_CONTINUOUS;
515 dev_info(&p->pdev->dev, "used as clock source\n");
517 /* Register with dummy 1 Hz value, gets updated in ->enable() */
518 clocksource_register_hz(cs, 1);
522 static struct sh_cmt_priv *ced_to_sh_cmt(struct clock_event_device *ced)
524 return container_of(ced, struct sh_cmt_priv, ced);
527 static void sh_cmt_clock_event_start(struct sh_cmt_priv *p, int periodic)
529 struct clock_event_device *ced = &p->ced;
531 sh_cmt_start(p, FLAG_CLOCKEVENT);
533 /* TODO: calculate good shift from rate and counter bit width */
536 ced->mult = div_sc(p->rate, NSEC_PER_SEC, ced->shift);
537 ced->max_delta_ns = clockevent_delta2ns(p->max_match_value, ced);
538 ced->min_delta_ns = clockevent_delta2ns(0x1f, ced);
541 sh_cmt_set_next(p, ((p->rate + HZ/2) / HZ) - 1);
543 sh_cmt_set_next(p, p->max_match_value);
546 static void sh_cmt_clock_event_mode(enum clock_event_mode mode,
547 struct clock_event_device *ced)
549 struct sh_cmt_priv *p = ced_to_sh_cmt(ced);
551 /* deal with old setting first */
553 case CLOCK_EVT_MODE_PERIODIC:
554 case CLOCK_EVT_MODE_ONESHOT:
555 sh_cmt_stop(p, FLAG_CLOCKEVENT);
562 case CLOCK_EVT_MODE_PERIODIC:
563 dev_info(&p->pdev->dev, "used for periodic clock events\n");
564 sh_cmt_clock_event_start(p, 1);
566 case CLOCK_EVT_MODE_ONESHOT:
567 dev_info(&p->pdev->dev, "used for oneshot clock events\n");
568 sh_cmt_clock_event_start(p, 0);
570 case CLOCK_EVT_MODE_SHUTDOWN:
571 case CLOCK_EVT_MODE_UNUSED:
572 sh_cmt_stop(p, FLAG_CLOCKEVENT);
579 static int sh_cmt_clock_event_next(unsigned long delta,
580 struct clock_event_device *ced)
582 struct sh_cmt_priv *p = ced_to_sh_cmt(ced);
584 BUG_ON(ced->mode != CLOCK_EVT_MODE_ONESHOT);
585 if (likely(p->flags & FLAG_IRQCONTEXT))
586 p->next_match_value = delta - 1;
588 sh_cmt_set_next(p, delta - 1);
593 static void sh_cmt_clock_event_suspend(struct clock_event_device *ced)
595 pm_genpd_syscore_poweroff(&ced_to_sh_cmt(ced)->pdev->dev);
598 static void sh_cmt_clock_event_resume(struct clock_event_device *ced)
600 pm_genpd_syscore_poweron(&ced_to_sh_cmt(ced)->pdev->dev);
603 static void sh_cmt_register_clockevent(struct sh_cmt_priv *p,
604 char *name, unsigned long rating)
606 struct clock_event_device *ced = &p->ced;
608 memset(ced, 0, sizeof(*ced));
611 ced->features = CLOCK_EVT_FEAT_PERIODIC;
612 ced->features |= CLOCK_EVT_FEAT_ONESHOT;
613 ced->rating = rating;
614 ced->cpumask = cpumask_of(0);
615 ced->set_next_event = sh_cmt_clock_event_next;
616 ced->set_mode = sh_cmt_clock_event_mode;
617 ced->suspend = sh_cmt_clock_event_suspend;
618 ced->resume = sh_cmt_clock_event_resume;
620 dev_info(&p->pdev->dev, "used for clock events\n");
621 clockevents_register_device(ced);
624 static int sh_cmt_register(struct sh_cmt_priv *p, char *name,
625 unsigned long clockevent_rating,
626 unsigned long clocksource_rating)
628 if (p->width == (sizeof(p->max_match_value) * 8))
629 p->max_match_value = ~0;
631 p->max_match_value = (1 << p->width) - 1;
633 p->match_value = p->max_match_value;
634 raw_spin_lock_init(&p->lock);
636 if (clockevent_rating)
637 sh_cmt_register_clockevent(p, name, clockevent_rating);
639 if (clocksource_rating)
640 sh_cmt_register_clocksource(p, name, clocksource_rating);
645 static int sh_cmt_setup(struct sh_cmt_priv *p, struct platform_device *pdev)
647 struct sh_timer_config *cfg = pdev->dev.platform_data;
648 struct resource *res;
652 memset(p, 0, sizeof(*p));
656 dev_err(&p->pdev->dev, "missing platform data\n");
660 platform_set_drvdata(pdev, p);
662 res = platform_get_resource(p->pdev, IORESOURCE_MEM, 0);
664 dev_err(&p->pdev->dev, "failed to get I/O memory\n");
668 irq = platform_get_irq(p->pdev, 0);
670 dev_err(&p->pdev->dev, "failed to get irq\n");
674 /* map memory, let mapbase point to our channel */
675 p->mapbase = ioremap_nocache(res->start, resource_size(res));
676 if (p->mapbase == NULL) {
677 dev_err(&p->pdev->dev, "failed to remap I/O memory\n");
681 /* request irq using setup_irq() (too early for request_irq()) */
682 p->irqaction.name = dev_name(&p->pdev->dev);
683 p->irqaction.handler = sh_cmt_interrupt;
684 p->irqaction.dev_id = p;
685 p->irqaction.flags = IRQF_DISABLED | IRQF_TIMER | \
686 IRQF_IRQPOLL | IRQF_NOBALANCING;
688 /* get hold of clock */
689 p->clk = clk_get(&p->pdev->dev, "cmt_fck");
690 if (IS_ERR(p->clk)) {
691 dev_err(&p->pdev->dev, "cannot get clock\n");
692 ret = PTR_ERR(p->clk);
696 if (resource_size(res) == 6) {
698 p->overflow_bit = 0x80;
699 p->clear_bits = ~0x80;
702 p->overflow_bit = 0x8000;
703 p->clear_bits = ~0xc000;
706 ret = sh_cmt_register(p, (char *)dev_name(&p->pdev->dev),
707 cfg->clockevent_rating,
708 cfg->clocksource_rating);
710 dev_err(&p->pdev->dev, "registration failed\n");
713 p->cs_enabled = false;
715 ret = setup_irq(irq, &p->irqaction);
717 dev_err(&p->pdev->dev, "failed to request irq %d\n", irq);
729 static int __devinit sh_cmt_probe(struct platform_device *pdev)
731 struct sh_cmt_priv *p = platform_get_drvdata(pdev);
732 struct sh_timer_config *cfg = pdev->dev.platform_data;
735 if (!is_early_platform_device(pdev)) {
736 pm_runtime_set_active(&pdev->dev);
737 pm_runtime_enable(&pdev->dev);
741 dev_info(&pdev->dev, "kept as earlytimer\n");
745 p = kmalloc(sizeof(*p), GFP_KERNEL);
747 dev_err(&pdev->dev, "failed to allocate driver data\n");
751 ret = sh_cmt_setup(p, pdev);
754 platform_set_drvdata(pdev, NULL);
755 pm_runtime_idle(&pdev->dev);
758 if (is_early_platform_device(pdev))
762 if (cfg->clockevent_rating || cfg->clocksource_rating)
763 pm_runtime_irq_safe(&pdev->dev);
765 pm_runtime_idle(&pdev->dev);
770 static int __devexit sh_cmt_remove(struct platform_device *pdev)
772 return -EBUSY; /* cannot unregister clockevent and clocksource */
775 static struct platform_driver sh_cmt_device_driver = {
776 .probe = sh_cmt_probe,
777 .remove = __devexit_p(sh_cmt_remove),
783 static int __init sh_cmt_init(void)
785 return platform_driver_register(&sh_cmt_device_driver);
788 static void __exit sh_cmt_exit(void)
790 platform_driver_unregister(&sh_cmt_device_driver);
793 early_platform_init("earlytimer", &sh_cmt_device_driver);
794 module_init(sh_cmt_init);
795 module_exit(sh_cmt_exit);
797 MODULE_AUTHOR("Magnus Damm");
798 MODULE_DESCRIPTION("SuperH CMT Timer Driver");
799 MODULE_LICENSE("GPL v2");