Merge branch 'timers-for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git...
[linux-2.6.git] / drivers / clocksource / sh_cmt.c
1 /*
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>
21 #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>
29 #include <linux/clocksource.h>
30 #include <linux/clockchips.h>
31 #include <linux/sh_timer.h>
32
33 struct sh_cmt_priv {
34         void __iomem *mapbase;
35         struct clk *clk;
36         unsigned long width; /* 16 or 32 bit version of hardware block */
37         unsigned long overflow_bit;
38         unsigned long clear_bits;
39         struct irqaction irqaction;
40         struct platform_device *pdev;
41
42         unsigned long flags;
43         unsigned long match_value;
44         unsigned long next_match_value;
45         unsigned long max_match_value;
46         unsigned long rate;
47         spinlock_t lock;
48         struct clock_event_device ced;
49         struct clocksource cs;
50         unsigned long total_cycles;
51 };
52
53 static DEFINE_SPINLOCK(sh_cmt_lock);
54
55 #define CMSTR -1 /* shared register */
56 #define CMCSR 0 /* channel register */
57 #define CMCNT 1 /* channel register */
58 #define CMCOR 2 /* channel register */
59
60 static inline unsigned long sh_cmt_read(struct sh_cmt_priv *p, int reg_nr)
61 {
62         struct sh_timer_config *cfg = p->pdev->dev.platform_data;
63         void __iomem *base = p->mapbase;
64         unsigned long offs;
65
66         if (reg_nr == CMSTR) {
67                 offs = 0;
68                 base -= cfg->channel_offset;
69         } else
70                 offs = reg_nr;
71
72         if (p->width == 16)
73                 offs <<= 1;
74         else {
75                 offs <<= 2;
76                 if ((reg_nr == CMCNT) || (reg_nr == CMCOR))
77                         return ioread32(base + offs);
78         }
79
80         return ioread16(base + offs);
81 }
82
83 static inline void sh_cmt_write(struct sh_cmt_priv *p, int reg_nr,
84                                 unsigned long value)
85 {
86         struct sh_timer_config *cfg = p->pdev->dev.platform_data;
87         void __iomem *base = p->mapbase;
88         unsigned long offs;
89
90         if (reg_nr == CMSTR) {
91                 offs = 0;
92                 base -= cfg->channel_offset;
93         } else
94                 offs = reg_nr;
95
96         if (p->width == 16)
97                 offs <<= 1;
98         else {
99                 offs <<= 2;
100                 if ((reg_nr == CMCNT) || (reg_nr == CMCOR)) {
101                         iowrite32(value, base + offs);
102                         return;
103                 }
104         }
105
106         iowrite16(value, base + offs);
107 }
108
109 static unsigned long sh_cmt_get_counter(struct sh_cmt_priv *p,
110                                         int *has_wrapped)
111 {
112         unsigned long v1, v2, v3;
113         int o1, o2;
114
115         o1 = sh_cmt_read(p, CMCSR) & p->overflow_bit;
116
117         /* Make sure the timer value is stable. Stolen from acpi_pm.c */
118         do {
119                 o2 = o1;
120                 v1 = sh_cmt_read(p, CMCNT);
121                 v2 = sh_cmt_read(p, CMCNT);
122                 v3 = sh_cmt_read(p, CMCNT);
123                 o1 = sh_cmt_read(p, CMCSR) & p->overflow_bit;
124         } while (unlikely((o1 != o2) || (v1 > v2 && v1 < v3)
125                           || (v2 > v3 && v2 < v1) || (v3 > v1 && v3 < v2)));
126
127         *has_wrapped = o1;
128         return v2;
129 }
130
131
132 static void sh_cmt_start_stop_ch(struct sh_cmt_priv *p, int start)
133 {
134         struct sh_timer_config *cfg = p->pdev->dev.platform_data;
135         unsigned long flags, value;
136
137         /* start stop register shared by multiple timer channels */
138         spin_lock_irqsave(&sh_cmt_lock, flags);
139         value = sh_cmt_read(p, CMSTR);
140
141         if (start)
142                 value |= 1 << cfg->timer_bit;
143         else
144                 value &= ~(1 << cfg->timer_bit);
145
146         sh_cmt_write(p, CMSTR, value);
147         spin_unlock_irqrestore(&sh_cmt_lock, flags);
148 }
149
150 static int sh_cmt_enable(struct sh_cmt_priv *p, unsigned long *rate)
151 {
152         struct sh_timer_config *cfg = p->pdev->dev.platform_data;
153         int ret;
154
155         /* enable clock */
156         ret = clk_enable(p->clk);
157         if (ret) {
158                 pr_err("sh_cmt: cannot enable clock \"%s\"\n", cfg->clk);
159                 return ret;
160         }
161
162         /* make sure channel is disabled */
163         sh_cmt_start_stop_ch(p, 0);
164
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);
169         } else {
170                 *rate = clk_get_rate(p->clk) / 8;
171                 sh_cmt_write(p, CMCSR, 0x01a4);
172         }
173
174         sh_cmt_write(p, CMCOR, 0xffffffff);
175         sh_cmt_write(p, CMCNT, 0);
176
177         /* enable channel */
178         sh_cmt_start_stop_ch(p, 1);
179         return 0;
180 }
181
182 static void sh_cmt_disable(struct sh_cmt_priv *p)
183 {
184         /* disable channel */
185         sh_cmt_start_stop_ch(p, 0);
186
187         /* disable interrupts in CMT block */
188         sh_cmt_write(p, CMCSR, 0);
189
190         /* stop clock */
191         clk_disable(p->clk);
192 }
193
194 /* private flags */
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)
200
201 static void sh_cmt_clock_event_program_verify(struct sh_cmt_priv *p,
202                                               int absolute)
203 {
204         unsigned long new_match;
205         unsigned long value = p->next_match_value;
206         unsigned long delay = 0;
207         unsigned long now = 0;
208         int has_wrapped;
209
210         now = sh_cmt_get_counter(p, &has_wrapped);
211         p->flags |= FLAG_REPROGRAM; /* force reprogram */
212
213         if (has_wrapped) {
214                 /* we're competing with the interrupt handler.
215                  *  -> let the interrupt handler reprogram the timer.
216                  *  -> interrupt number two handles the event.
217                  */
218                 p->flags |= FLAG_SKIPEVENT;
219                 return;
220         }
221
222         if (absolute)
223                 now = 0;
224
225         do {
226                 /* reprogram the timer hardware,
227                  * but don't save the new match value yet.
228                  */
229                 new_match = now + value + delay;
230                 if (new_match > p->max_match_value)
231                         new_match = p->max_match_value;
232
233                 sh_cmt_write(p, CMCOR, new_match);
234
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.
242                          */
243                         p->flags |= FLAG_SKIPEVENT;
244                         break;
245                 }
246
247                 if (has_wrapped) {
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.
253                          */
254                         p->match_value = new_match;
255                         break;
256                 }
257
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.
264                          */
265                         p->match_value = new_match;
266                         break;
267                 }
268
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.
274                  */
275                 if (delay)
276                         delay <<= 1;
277                 else
278                         delay = 1;
279
280                 if (!delay)
281                         pr_warning("sh_cmt: too long delay\n");
282
283         } while (delay);
284 }
285
286 static void sh_cmt_set_next(struct sh_cmt_priv *p, unsigned long delta)
287 {
288         unsigned long flags;
289
290         if (delta > p->max_match_value)
291                 pr_warning("sh_cmt: delta out of range\n");
292
293         spin_lock_irqsave(&p->lock, flags);
294         p->next_match_value = delta;
295         sh_cmt_clock_event_program_verify(p, 0);
296         spin_unlock_irqrestore(&p->lock, flags);
297 }
298
299 static irqreturn_t sh_cmt_interrupt(int irq, void *dev_id)
300 {
301         struct sh_cmt_priv *p = dev_id;
302
303         /* clear flags */
304         sh_cmt_write(p, CMCSR, sh_cmt_read(p, CMCSR) & p->clear_bits);
305
306         /* update clock source counter to begin with if enabled
307          * the wrap flag should be cleared by the timer specific
308          * isr before we end up here.
309          */
310         if (p->flags & FLAG_CLOCKSOURCE)
311                 p->total_cycles += p->match_value;
312
313         if (!(p->flags & FLAG_REPROGRAM))
314                 p->next_match_value = p->max_match_value;
315
316         p->flags |= FLAG_IRQCONTEXT;
317
318         if (p->flags & FLAG_CLOCKEVENT) {
319                 if (!(p->flags & FLAG_SKIPEVENT)) {
320                         if (p->ced.mode == CLOCK_EVT_MODE_ONESHOT) {
321                                 p->next_match_value = p->max_match_value;
322                                 p->flags |= FLAG_REPROGRAM;
323                         }
324
325                         p->ced.event_handler(&p->ced);
326                 }
327         }
328
329         p->flags &= ~FLAG_SKIPEVENT;
330
331         if (p->flags & FLAG_REPROGRAM) {
332                 p->flags &= ~FLAG_REPROGRAM;
333                 sh_cmt_clock_event_program_verify(p, 1);
334
335                 if (p->flags & FLAG_CLOCKEVENT)
336                         if ((p->ced.mode == CLOCK_EVT_MODE_SHUTDOWN)
337                             || (p->match_value == p->next_match_value))
338                                 p->flags &= ~FLAG_REPROGRAM;
339         }
340
341         p->flags &= ~FLAG_IRQCONTEXT;
342
343         return IRQ_HANDLED;
344 }
345
346 static int sh_cmt_start(struct sh_cmt_priv *p, unsigned long flag)
347 {
348         int ret = 0;
349         unsigned long flags;
350
351         spin_lock_irqsave(&p->lock, flags);
352
353         if (!(p->flags & (FLAG_CLOCKEVENT | FLAG_CLOCKSOURCE)))
354                 ret = sh_cmt_enable(p, &p->rate);
355
356         if (ret)
357                 goto out;
358         p->flags |= flag;
359
360         /* setup timeout if no clockevent */
361         if ((flag == FLAG_CLOCKSOURCE) && (!(p->flags & FLAG_CLOCKEVENT)))
362                 sh_cmt_set_next(p, p->max_match_value);
363  out:
364         spin_unlock_irqrestore(&p->lock, flags);
365
366         return ret;
367 }
368
369 static void sh_cmt_stop(struct sh_cmt_priv *p, unsigned long flag)
370 {
371         unsigned long flags;
372         unsigned long f;
373
374         spin_lock_irqsave(&p->lock, flags);
375
376         f = p->flags & (FLAG_CLOCKEVENT | FLAG_CLOCKSOURCE);
377         p->flags &= ~flag;
378
379         if (f && !(p->flags & (FLAG_CLOCKEVENT | FLAG_CLOCKSOURCE)))
380                 sh_cmt_disable(p);
381
382         /* adjust the timeout to maximum if only clocksource left */
383         if ((flag == FLAG_CLOCKEVENT) && (p->flags & FLAG_CLOCKSOURCE))
384                 sh_cmt_set_next(p, p->max_match_value);
385
386         spin_unlock_irqrestore(&p->lock, flags);
387 }
388
389 static struct sh_cmt_priv *cs_to_sh_cmt(struct clocksource *cs)
390 {
391         return container_of(cs, struct sh_cmt_priv, cs);
392 }
393
394 static cycle_t sh_cmt_clocksource_read(struct clocksource *cs)
395 {
396         struct sh_cmt_priv *p = cs_to_sh_cmt(cs);
397         unsigned long flags, raw;
398         unsigned long value;
399         int has_wrapped;
400
401         spin_lock_irqsave(&p->lock, flags);
402         value = p->total_cycles;
403         raw = sh_cmt_get_counter(p, &has_wrapped);
404
405         if (unlikely(has_wrapped))
406                 raw += p->match_value;
407         spin_unlock_irqrestore(&p->lock, flags);
408
409         return value + raw;
410 }
411
412 static int sh_cmt_clocksource_enable(struct clocksource *cs)
413 {
414         struct sh_cmt_priv *p = cs_to_sh_cmt(cs);
415         int ret;
416
417         p->total_cycles = 0;
418
419         ret = sh_cmt_start(p, FLAG_CLOCKSOURCE);
420         if (ret)
421                 return ret;
422
423         /* TODO: calculate good shift from rate and counter bit width */
424         cs->shift = 0;
425         cs->mult = clocksource_hz2mult(p->rate, cs->shift);
426         return 0;
427 }
428
429 static void sh_cmt_clocksource_disable(struct clocksource *cs)
430 {
431         sh_cmt_stop(cs_to_sh_cmt(cs), FLAG_CLOCKSOURCE);
432 }
433
434 static void sh_cmt_clocksource_resume(struct clocksource *cs)
435 {
436         sh_cmt_start(cs_to_sh_cmt(cs), FLAG_CLOCKSOURCE);
437 }
438
439 static int sh_cmt_register_clocksource(struct sh_cmt_priv *p,
440                                        char *name, unsigned long rating)
441 {
442         struct clocksource *cs = &p->cs;
443
444         cs->name = name;
445         cs->rating = rating;
446         cs->read = sh_cmt_clocksource_read;
447         cs->enable = sh_cmt_clocksource_enable;
448         cs->disable = sh_cmt_clocksource_disable;
449         cs->suspend = sh_cmt_clocksource_disable;
450         cs->resume = sh_cmt_clocksource_resume;
451         cs->mask = CLOCKSOURCE_MASK(sizeof(unsigned long) * 8);
452         cs->flags = CLOCK_SOURCE_IS_CONTINUOUS;
453         pr_info("sh_cmt: %s used as clock source\n", cs->name);
454         clocksource_register(cs);
455         return 0;
456 }
457
458 static struct sh_cmt_priv *ced_to_sh_cmt(struct clock_event_device *ced)
459 {
460         return container_of(ced, struct sh_cmt_priv, ced);
461 }
462
463 static void sh_cmt_clock_event_start(struct sh_cmt_priv *p, int periodic)
464 {
465         struct clock_event_device *ced = &p->ced;
466
467         sh_cmt_start(p, FLAG_CLOCKEVENT);
468
469         /* TODO: calculate good shift from rate and counter bit width */
470
471         ced->shift = 32;
472         ced->mult = div_sc(p->rate, NSEC_PER_SEC, ced->shift);
473         ced->max_delta_ns = clockevent_delta2ns(p->max_match_value, ced);
474         ced->min_delta_ns = clockevent_delta2ns(0x1f, ced);
475
476         if (periodic)
477                 sh_cmt_set_next(p, (p->rate + HZ/2) / HZ);
478         else
479                 sh_cmt_set_next(p, p->max_match_value);
480 }
481
482 static void sh_cmt_clock_event_mode(enum clock_event_mode mode,
483                                     struct clock_event_device *ced)
484 {
485         struct sh_cmt_priv *p = ced_to_sh_cmt(ced);
486
487         /* deal with old setting first */
488         switch (ced->mode) {
489         case CLOCK_EVT_MODE_PERIODIC:
490         case CLOCK_EVT_MODE_ONESHOT:
491                 sh_cmt_stop(p, FLAG_CLOCKEVENT);
492                 break;
493         default:
494                 break;
495         }
496
497         switch (mode) {
498         case CLOCK_EVT_MODE_PERIODIC:
499                 pr_info("sh_cmt: %s used for periodic clock events\n",
500                         ced->name);
501                 sh_cmt_clock_event_start(p, 1);
502                 break;
503         case CLOCK_EVT_MODE_ONESHOT:
504                 pr_info("sh_cmt: %s used for oneshot clock events\n",
505                         ced->name);
506                 sh_cmt_clock_event_start(p, 0);
507                 break;
508         case CLOCK_EVT_MODE_SHUTDOWN:
509         case CLOCK_EVT_MODE_UNUSED:
510                 sh_cmt_stop(p, FLAG_CLOCKEVENT);
511                 break;
512         default:
513                 break;
514         }
515 }
516
517 static int sh_cmt_clock_event_next(unsigned long delta,
518                                    struct clock_event_device *ced)
519 {
520         struct sh_cmt_priv *p = ced_to_sh_cmt(ced);
521
522         BUG_ON(ced->mode != CLOCK_EVT_MODE_ONESHOT);
523         if (likely(p->flags & FLAG_IRQCONTEXT))
524                 p->next_match_value = delta;
525         else
526                 sh_cmt_set_next(p, delta);
527
528         return 0;
529 }
530
531 static void sh_cmt_register_clockevent(struct sh_cmt_priv *p,
532                                        char *name, unsigned long rating)
533 {
534         struct clock_event_device *ced = &p->ced;
535
536         memset(ced, 0, sizeof(*ced));
537
538         ced->name = name;
539         ced->features = CLOCK_EVT_FEAT_PERIODIC;
540         ced->features |= CLOCK_EVT_FEAT_ONESHOT;
541         ced->rating = rating;
542         ced->cpumask = cpumask_of(0);
543         ced->set_next_event = sh_cmt_clock_event_next;
544         ced->set_mode = sh_cmt_clock_event_mode;
545
546         pr_info("sh_cmt: %s used for clock events\n", ced->name);
547         clockevents_register_device(ced);
548 }
549
550 static int sh_cmt_register(struct sh_cmt_priv *p, char *name,
551                            unsigned long clockevent_rating,
552                            unsigned long clocksource_rating)
553 {
554         if (p->width == (sizeof(p->max_match_value) * 8))
555                 p->max_match_value = ~0;
556         else
557                 p->max_match_value = (1 << p->width) - 1;
558
559         p->match_value = p->max_match_value;
560         spin_lock_init(&p->lock);
561
562         if (clockevent_rating)
563                 sh_cmt_register_clockevent(p, name, clockevent_rating);
564
565         if (clocksource_rating)
566                 sh_cmt_register_clocksource(p, name, clocksource_rating);
567
568         return 0;
569 }
570
571 static int sh_cmt_setup(struct sh_cmt_priv *p, struct platform_device *pdev)
572 {
573         struct sh_timer_config *cfg = pdev->dev.platform_data;
574         struct resource *res;
575         int irq, ret;
576         ret = -ENXIO;
577
578         memset(p, 0, sizeof(*p));
579         p->pdev = pdev;
580
581         if (!cfg) {
582                 dev_err(&p->pdev->dev, "missing platform data\n");
583                 goto err0;
584         }
585
586         platform_set_drvdata(pdev, p);
587
588         res = platform_get_resource(p->pdev, IORESOURCE_MEM, 0);
589         if (!res) {
590                 dev_err(&p->pdev->dev, "failed to get I/O memory\n");
591                 goto err0;
592         }
593
594         irq = platform_get_irq(p->pdev, 0);
595         if (irq < 0) {
596                 dev_err(&p->pdev->dev, "failed to get irq\n");
597                 goto err0;
598         }
599
600         /* map memory, let mapbase point to our channel */
601         p->mapbase = ioremap_nocache(res->start, resource_size(res));
602         if (p->mapbase == NULL) {
603                 pr_err("sh_cmt: failed to remap I/O memory\n");
604                 goto err0;
605         }
606
607         /* request irq using setup_irq() (too early for request_irq()) */
608         p->irqaction.name = cfg->name;
609         p->irqaction.handler = sh_cmt_interrupt;
610         p->irqaction.dev_id = p;
611         p->irqaction.flags = IRQF_DISABLED | IRQF_TIMER | IRQF_IRQPOLL;
612
613         /* get hold of clock */
614         p->clk = clk_get(&p->pdev->dev, cfg->clk);
615         if (IS_ERR(p->clk)) {
616                 pr_err("sh_cmt: cannot get clock \"%s\"\n", cfg->clk);
617                 ret = PTR_ERR(p->clk);
618                 goto err1;
619         }
620
621         if (resource_size(res) == 6) {
622                 p->width = 16;
623                 p->overflow_bit = 0x80;
624                 p->clear_bits = ~0x80;
625         } else {
626                 p->width = 32;
627                 p->overflow_bit = 0x8000;
628                 p->clear_bits = ~0xc000;
629         }
630
631         ret = sh_cmt_register(p, cfg->name,
632                               cfg->clockevent_rating,
633                               cfg->clocksource_rating);
634         if (ret) {
635                 pr_err("sh_cmt: registration failed\n");
636                 goto err1;
637         }
638
639         ret = setup_irq(irq, &p->irqaction);
640         if (ret) {
641                 pr_err("sh_cmt: failed to request irq %d\n", irq);
642                 goto err1;
643         }
644
645         return 0;
646
647 err1:
648         iounmap(p->mapbase);
649 err0:
650         return ret;
651 }
652
653 static int __devinit sh_cmt_probe(struct platform_device *pdev)
654 {
655         struct sh_cmt_priv *p = platform_get_drvdata(pdev);
656         struct sh_timer_config *cfg = pdev->dev.platform_data;
657         int ret;
658
659         if (p) {
660                 pr_info("sh_cmt: %s kept as earlytimer\n", cfg->name);
661                 return 0;
662         }
663
664         p = kmalloc(sizeof(*p), GFP_KERNEL);
665         if (p == NULL) {
666                 dev_err(&pdev->dev, "failed to allocate driver data\n");
667                 return -ENOMEM;
668         }
669
670         ret = sh_cmt_setup(p, pdev);
671         if (ret) {
672                 kfree(p);
673                 platform_set_drvdata(pdev, NULL);
674         }
675         return ret;
676 }
677
678 static int __devexit sh_cmt_remove(struct platform_device *pdev)
679 {
680         return -EBUSY; /* cannot unregister clockevent and clocksource */
681 }
682
683 static struct platform_driver sh_cmt_device_driver = {
684         .probe          = sh_cmt_probe,
685         .remove         = __devexit_p(sh_cmt_remove),
686         .driver         = {
687                 .name   = "sh_cmt",
688         }
689 };
690
691 static int __init sh_cmt_init(void)
692 {
693         return platform_driver_register(&sh_cmt_device_driver);
694 }
695
696 static void __exit sh_cmt_exit(void)
697 {
698         platform_driver_unregister(&sh_cmt_device_driver);
699 }
700
701 early_platform_init("earlytimer", &sh_cmt_device_driver);
702 module_init(sh_cmt_init);
703 module_exit(sh_cmt_exit);
704
705 MODULE_AUTHOR("Magnus Damm");
706 MODULE_DESCRIPTION("SuperH CMT Timer Driver");
707 MODULE_LICENSE("GPL v2");