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/clocksource.h>
30 #include <linux/clockchips.h>
31 #include <linux/sh_timer.h>
32 #include <linux/slab.h>
35 void __iomem *mapbase;
37 unsigned long width; /* 16 or 32 bit version of hardware block */
38 unsigned long overflow_bit;
39 unsigned long clear_bits;
40 struct irqaction irqaction;
41 struct platform_device *pdev;
44 unsigned long match_value;
45 unsigned long next_match_value;
46 unsigned long max_match_value;
49 struct clock_event_device ced;
50 struct clocksource cs;
51 unsigned long total_cycles;
54 static DEFINE_SPINLOCK(sh_cmt_lock);
56 #define CMSTR -1 /* shared register */
57 #define CMCSR 0 /* channel register */
58 #define CMCNT 1 /* channel register */
59 #define CMCOR 2 /* channel register */
61 static inline unsigned long sh_cmt_read(struct sh_cmt_priv *p, int reg_nr)
63 struct sh_timer_config *cfg = p->pdev->dev.platform_data;
64 void __iomem *base = p->mapbase;
67 if (reg_nr == CMSTR) {
69 base -= cfg->channel_offset;
77 if ((reg_nr == CMCNT) || (reg_nr == CMCOR))
78 return ioread32(base + offs);
81 return ioread16(base + offs);
84 static inline void sh_cmt_write(struct sh_cmt_priv *p, int reg_nr,
87 struct sh_timer_config *cfg = p->pdev->dev.platform_data;
88 void __iomem *base = p->mapbase;
91 if (reg_nr == CMSTR) {
93 base -= cfg->channel_offset;
101 if ((reg_nr == CMCNT) || (reg_nr == CMCOR)) {
102 iowrite32(value, base + offs);
107 iowrite16(value, base + offs);
110 static unsigned long sh_cmt_get_counter(struct sh_cmt_priv *p,
113 unsigned long v1, v2, v3;
116 o1 = sh_cmt_read(p, CMCSR) & p->overflow_bit;
118 /* Make sure the timer value is stable. Stolen from acpi_pm.c */
121 v1 = sh_cmt_read(p, CMCNT);
122 v2 = sh_cmt_read(p, CMCNT);
123 v3 = sh_cmt_read(p, CMCNT);
124 o1 = sh_cmt_read(p, CMCSR) & p->overflow_bit;
125 } while (unlikely((o1 != o2) || (v1 > v2 && v1 < v3)
126 || (v2 > v3 && v2 < v1) || (v3 > v1 && v3 < v2)));
133 static void sh_cmt_start_stop_ch(struct sh_cmt_priv *p, int start)
135 struct sh_timer_config *cfg = p->pdev->dev.platform_data;
136 unsigned long flags, value;
138 /* start stop register shared by multiple timer channels */
139 spin_lock_irqsave(&sh_cmt_lock, flags);
140 value = sh_cmt_read(p, CMSTR);
143 value |= 1 << cfg->timer_bit;
145 value &= ~(1 << cfg->timer_bit);
147 sh_cmt_write(p, CMSTR, value);
148 spin_unlock_irqrestore(&sh_cmt_lock, flags);
151 static int sh_cmt_enable(struct sh_cmt_priv *p, unsigned long *rate)
156 ret = clk_enable(p->clk);
158 dev_err(&p->pdev->dev, "cannot enable clock\n");
162 /* make sure channel is disabled */
163 sh_cmt_start_stop_ch(p, 0);
165 /* configure channel, periodic mode and maximum timeout */
166 if (p->width == 16) {
167 *rate = clk_get_rate(p->clk) / 512;
168 sh_cmt_write(p, CMCSR, 0x43);
170 *rate = clk_get_rate(p->clk) / 8;
171 sh_cmt_write(p, CMCSR, 0x01a4);
174 sh_cmt_write(p, CMCOR, 0xffffffff);
175 sh_cmt_write(p, CMCNT, 0);
178 sh_cmt_start_stop_ch(p, 1);
182 static void sh_cmt_disable(struct sh_cmt_priv *p)
184 /* disable channel */
185 sh_cmt_start_stop_ch(p, 0);
187 /* disable interrupts in CMT block */
188 sh_cmt_write(p, CMCSR, 0);
195 #define FLAG_CLOCKEVENT (1 << 0)
196 #define FLAG_CLOCKSOURCE (1 << 1)
197 #define FLAG_REPROGRAM (1 << 2)
198 #define FLAG_SKIPEVENT (1 << 3)
199 #define FLAG_IRQCONTEXT (1 << 4)
201 static void sh_cmt_clock_event_program_verify(struct sh_cmt_priv *p,
204 unsigned long new_match;
205 unsigned long value = p->next_match_value;
206 unsigned long delay = 0;
207 unsigned long now = 0;
210 now = sh_cmt_get_counter(p, &has_wrapped);
211 p->flags |= FLAG_REPROGRAM; /* force reprogram */
214 /* we're competing with the interrupt handler.
215 * -> let the interrupt handler reprogram the timer.
216 * -> interrupt number two handles the event.
218 p->flags |= FLAG_SKIPEVENT;
226 /* reprogram the timer hardware,
227 * but don't save the new match value yet.
229 new_match = now + value + delay;
230 if (new_match > p->max_match_value)
231 new_match = p->max_match_value;
233 sh_cmt_write(p, CMCOR, new_match);
235 now = sh_cmt_get_counter(p, &has_wrapped);
236 if (has_wrapped && (new_match > p->match_value)) {
237 /* we are changing to a greater match value,
238 * so this wrap must be caused by the counter
239 * matching the old value.
240 * -> first interrupt reprograms the timer.
241 * -> interrupt number two handles the event.
243 p->flags |= FLAG_SKIPEVENT;
248 /* we are changing to a smaller match value,
249 * so the wrap must be caused by the counter
250 * matching the new value.
251 * -> save programmed match value.
252 * -> let isr handle the event.
254 p->match_value = new_match;
258 /* be safe: verify hardware settings */
259 if (now < new_match) {
260 /* timer value is below match value, all good.
261 * this makes sure we won't miss any match events.
262 * -> save programmed match value.
263 * -> let isr handle the event.
265 p->match_value = new_match;
269 /* the counter has reached a value greater
270 * than our new match value. and since the
271 * has_wrapped flag isn't set we must have
272 * programmed a too close event.
273 * -> increase delay and retry.
281 dev_warn(&p->pdev->dev, "too long delay\n");
286 static void __sh_cmt_set_next(struct sh_cmt_priv *p, unsigned long delta)
288 if (delta > p->max_match_value)
289 dev_warn(&p->pdev->dev, "delta out of range\n");
291 p->next_match_value = delta;
292 sh_cmt_clock_event_program_verify(p, 0);
295 static void sh_cmt_set_next(struct sh_cmt_priv *p, unsigned long delta)
299 spin_lock_irqsave(&p->lock, flags);
300 __sh_cmt_set_next(p, delta);
301 spin_unlock_irqrestore(&p->lock, flags);
304 static irqreturn_t sh_cmt_interrupt(int irq, void *dev_id)
306 struct sh_cmt_priv *p = dev_id;
309 sh_cmt_write(p, CMCSR, sh_cmt_read(p, CMCSR) & p->clear_bits);
311 /* update clock source counter to begin with if enabled
312 * the wrap flag should be cleared by the timer specific
313 * isr before we end up here.
315 if (p->flags & FLAG_CLOCKSOURCE)
316 p->total_cycles += p->match_value + 1;
318 if (!(p->flags & FLAG_REPROGRAM))
319 p->next_match_value = p->max_match_value;
321 p->flags |= FLAG_IRQCONTEXT;
323 if (p->flags & FLAG_CLOCKEVENT) {
324 if (!(p->flags & FLAG_SKIPEVENT)) {
325 if (p->ced.mode == CLOCK_EVT_MODE_ONESHOT) {
326 p->next_match_value = p->max_match_value;
327 p->flags |= FLAG_REPROGRAM;
330 p->ced.event_handler(&p->ced);
334 p->flags &= ~FLAG_SKIPEVENT;
336 if (p->flags & FLAG_REPROGRAM) {
337 p->flags &= ~FLAG_REPROGRAM;
338 sh_cmt_clock_event_program_verify(p, 1);
340 if (p->flags & FLAG_CLOCKEVENT)
341 if ((p->ced.mode == CLOCK_EVT_MODE_SHUTDOWN)
342 || (p->match_value == p->next_match_value))
343 p->flags &= ~FLAG_REPROGRAM;
346 p->flags &= ~FLAG_IRQCONTEXT;
351 static int sh_cmt_start(struct sh_cmt_priv *p, unsigned long flag)
356 spin_lock_irqsave(&p->lock, flags);
358 if (!(p->flags & (FLAG_CLOCKEVENT | FLAG_CLOCKSOURCE)))
359 ret = sh_cmt_enable(p, &p->rate);
365 /* setup timeout if no clockevent */
366 if ((flag == FLAG_CLOCKSOURCE) && (!(p->flags & FLAG_CLOCKEVENT)))
367 __sh_cmt_set_next(p, p->max_match_value);
369 spin_unlock_irqrestore(&p->lock, flags);
374 static void sh_cmt_stop(struct sh_cmt_priv *p, unsigned long flag)
379 spin_lock_irqsave(&p->lock, flags);
381 f = p->flags & (FLAG_CLOCKEVENT | FLAG_CLOCKSOURCE);
384 if (f && !(p->flags & (FLAG_CLOCKEVENT | FLAG_CLOCKSOURCE)))
387 /* adjust the timeout to maximum if only clocksource left */
388 if ((flag == FLAG_CLOCKEVENT) && (p->flags & FLAG_CLOCKSOURCE))
389 __sh_cmt_set_next(p, p->max_match_value);
391 spin_unlock_irqrestore(&p->lock, flags);
394 static struct sh_cmt_priv *cs_to_sh_cmt(struct clocksource *cs)
396 return container_of(cs, struct sh_cmt_priv, cs);
399 static cycle_t sh_cmt_clocksource_read(struct clocksource *cs)
401 struct sh_cmt_priv *p = cs_to_sh_cmt(cs);
402 unsigned long flags, raw;
406 spin_lock_irqsave(&p->lock, flags);
407 value = p->total_cycles;
408 raw = sh_cmt_get_counter(p, &has_wrapped);
410 if (unlikely(has_wrapped))
411 raw += p->match_value + 1;
412 spin_unlock_irqrestore(&p->lock, flags);
417 static int sh_cmt_clocksource_enable(struct clocksource *cs)
419 struct sh_cmt_priv *p = cs_to_sh_cmt(cs);
423 return sh_cmt_start(p, FLAG_CLOCKSOURCE);
426 static void sh_cmt_clocksource_disable(struct clocksource *cs)
428 sh_cmt_stop(cs_to_sh_cmt(cs), FLAG_CLOCKSOURCE);
431 static void sh_cmt_clocksource_resume(struct clocksource *cs)
433 sh_cmt_start(cs_to_sh_cmt(cs), FLAG_CLOCKSOURCE);
436 static int sh_cmt_register_clocksource(struct sh_cmt_priv *p,
437 char *name, unsigned long rating)
439 struct clocksource *cs = &p->cs;
443 cs->read = sh_cmt_clocksource_read;
444 cs->enable = sh_cmt_clocksource_enable;
445 cs->disable = sh_cmt_clocksource_disable;
446 cs->suspend = sh_cmt_clocksource_disable;
447 cs->resume = sh_cmt_clocksource_resume;
448 cs->mask = CLOCKSOURCE_MASK(sizeof(unsigned long) * 8);
449 cs->flags = CLOCK_SOURCE_IS_CONTINUOUS;
451 /* clk_get_rate() needs an enabled clock */
453 p->rate = clk_get_rate(p->clk) / ((p->width == 16) ? 512 : 8);
456 /* TODO: calculate good shift from rate and counter bit width */
458 cs->mult = clocksource_hz2mult(p->rate, cs->shift);
460 dev_info(&p->pdev->dev, "used as clock source\n");
462 clocksource_register(cs);
467 static struct sh_cmt_priv *ced_to_sh_cmt(struct clock_event_device *ced)
469 return container_of(ced, struct sh_cmt_priv, ced);
472 static void sh_cmt_clock_event_start(struct sh_cmt_priv *p, int periodic)
474 struct clock_event_device *ced = &p->ced;
476 sh_cmt_start(p, FLAG_CLOCKEVENT);
478 /* TODO: calculate good shift from rate and counter bit width */
481 ced->mult = div_sc(p->rate, NSEC_PER_SEC, ced->shift);
482 ced->max_delta_ns = clockevent_delta2ns(p->max_match_value, ced);
483 ced->min_delta_ns = clockevent_delta2ns(0x1f, ced);
486 sh_cmt_set_next(p, ((p->rate + HZ/2) / HZ) - 1);
488 sh_cmt_set_next(p, p->max_match_value);
491 static void sh_cmt_clock_event_mode(enum clock_event_mode mode,
492 struct clock_event_device *ced)
494 struct sh_cmt_priv *p = ced_to_sh_cmt(ced);
496 /* deal with old setting first */
498 case CLOCK_EVT_MODE_PERIODIC:
499 case CLOCK_EVT_MODE_ONESHOT:
500 sh_cmt_stop(p, FLAG_CLOCKEVENT);
507 case CLOCK_EVT_MODE_PERIODIC:
508 dev_info(&p->pdev->dev, "used for periodic clock events\n");
509 sh_cmt_clock_event_start(p, 1);
511 case CLOCK_EVT_MODE_ONESHOT:
512 dev_info(&p->pdev->dev, "used for oneshot clock events\n");
513 sh_cmt_clock_event_start(p, 0);
515 case CLOCK_EVT_MODE_SHUTDOWN:
516 case CLOCK_EVT_MODE_UNUSED:
517 sh_cmt_stop(p, FLAG_CLOCKEVENT);
524 static int sh_cmt_clock_event_next(unsigned long delta,
525 struct clock_event_device *ced)
527 struct sh_cmt_priv *p = ced_to_sh_cmt(ced);
529 BUG_ON(ced->mode != CLOCK_EVT_MODE_ONESHOT);
530 if (likely(p->flags & FLAG_IRQCONTEXT))
531 p->next_match_value = delta - 1;
533 sh_cmt_set_next(p, delta - 1);
538 static void sh_cmt_register_clockevent(struct sh_cmt_priv *p,
539 char *name, unsigned long rating)
541 struct clock_event_device *ced = &p->ced;
543 memset(ced, 0, sizeof(*ced));
546 ced->features = CLOCK_EVT_FEAT_PERIODIC;
547 ced->features |= CLOCK_EVT_FEAT_ONESHOT;
548 ced->rating = rating;
549 ced->cpumask = cpumask_of(0);
550 ced->set_next_event = sh_cmt_clock_event_next;
551 ced->set_mode = sh_cmt_clock_event_mode;
553 dev_info(&p->pdev->dev, "used for clock events\n");
554 clockevents_register_device(ced);
557 static int sh_cmt_register(struct sh_cmt_priv *p, char *name,
558 unsigned long clockevent_rating,
559 unsigned long clocksource_rating)
561 if (p->width == (sizeof(p->max_match_value) * 8))
562 p->max_match_value = ~0;
564 p->max_match_value = (1 << p->width) - 1;
566 p->match_value = p->max_match_value;
567 spin_lock_init(&p->lock);
569 if (clockevent_rating)
570 sh_cmt_register_clockevent(p, name, clockevent_rating);
572 if (clocksource_rating)
573 sh_cmt_register_clocksource(p, name, clocksource_rating);
578 static int sh_cmt_setup(struct sh_cmt_priv *p, struct platform_device *pdev)
580 struct sh_timer_config *cfg = pdev->dev.platform_data;
581 struct resource *res;
585 memset(p, 0, sizeof(*p));
589 dev_err(&p->pdev->dev, "missing platform data\n");
593 platform_set_drvdata(pdev, p);
595 res = platform_get_resource(p->pdev, IORESOURCE_MEM, 0);
597 dev_err(&p->pdev->dev, "failed to get I/O memory\n");
601 irq = platform_get_irq(p->pdev, 0);
603 dev_err(&p->pdev->dev, "failed to get irq\n");
607 /* map memory, let mapbase point to our channel */
608 p->mapbase = ioremap_nocache(res->start, resource_size(res));
609 if (p->mapbase == NULL) {
610 dev_err(&p->pdev->dev, "failed to remap I/O memory\n");
614 /* request irq using setup_irq() (too early for request_irq()) */
615 p->irqaction.name = dev_name(&p->pdev->dev);
616 p->irqaction.handler = sh_cmt_interrupt;
617 p->irqaction.dev_id = p;
618 p->irqaction.flags = IRQF_DISABLED | IRQF_TIMER | \
619 IRQF_IRQPOLL | IRQF_NOBALANCING;
621 /* get hold of clock */
622 p->clk = clk_get(&p->pdev->dev, "cmt_fck");
623 if (IS_ERR(p->clk)) {
624 dev_err(&p->pdev->dev, "cannot get clock\n");
625 ret = PTR_ERR(p->clk);
629 if (resource_size(res) == 6) {
631 p->overflow_bit = 0x80;
632 p->clear_bits = ~0x80;
635 p->overflow_bit = 0x8000;
636 p->clear_bits = ~0xc000;
639 ret = sh_cmt_register(p, (char *)dev_name(&p->pdev->dev),
640 cfg->clockevent_rating,
641 cfg->clocksource_rating);
643 dev_err(&p->pdev->dev, "registration failed\n");
647 ret = setup_irq(irq, &p->irqaction);
649 dev_err(&p->pdev->dev, "failed to request irq %d\n", irq);
661 static int __devinit sh_cmt_probe(struct platform_device *pdev)
663 struct sh_cmt_priv *p = platform_get_drvdata(pdev);
667 dev_info(&pdev->dev, "kept as earlytimer\n");
671 p = kmalloc(sizeof(*p), GFP_KERNEL);
673 dev_err(&pdev->dev, "failed to allocate driver data\n");
677 ret = sh_cmt_setup(p, pdev);
680 platform_set_drvdata(pdev, NULL);
685 static int __devexit sh_cmt_remove(struct platform_device *pdev)
687 return -EBUSY; /* cannot unregister clockevent and clocksource */
690 static struct platform_driver sh_cmt_device_driver = {
691 .probe = sh_cmt_probe,
692 .remove = __devexit_p(sh_cmt_remove),
698 static int __init sh_cmt_init(void)
700 return platform_driver_register(&sh_cmt_device_driver);
703 static void __exit sh_cmt_exit(void)
705 platform_driver_unregister(&sh_cmt_device_driver);
708 early_platform_init("earlytimer", &sh_cmt_device_driver);
709 module_init(sh_cmt_init);
710 module_exit(sh_cmt_exit);
712 MODULE_AUTHOR("Magnus Damm");
713 MODULE_DESCRIPTION("SuperH CMT Timer Driver");
714 MODULE_LICENSE("GPL v2");