kernel/drivers/clocksource/timer-atmel-pit.c

   1 /*
   2  * at91sam926x_time.c - Periodic Interval Timer (PIT) for at91sam926x
   3  *
   4  * Copyright (C) 2005-2006 M. Amine SAYA, ATMEL Rousset, France
   5  * Revision      2005 M. Nicolas Diremdjian, ATMEL Rousset, France
   6  * Converted to ClockSource/ClockEvents by David Brownell.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 as
  10  * published by the Free Software Foundation.
  11  */
  12
  13 #define pr_fmt(fmt)     "AT91: PIT: " fmt
  14
  15 #include <linux/clk.h>
  16 #include <linux/clockchips.h>
  17 #include <linux/interrupt.h>
  18 #include <linux/irq.h>
  19 #include <linux/kernel.h>
  20 #include <linux/of.h>
  21 #include <linux/of_address.h>
  22 #include <linux/of_irq.h>
  23 #include <linux/slab.h>
  24
  25 #define AT91_PIT_MR             0x00                    /* Mode Register */
  26 #define AT91_PIT_PITIEN                 BIT(25)                 /* Timer Interrupt Enable */
  27 #define AT91_PIT_PITEN                  BIT(24)                 /* Timer Enabled */
  28 #define AT91_PIT_PIV                    GENMASK(19, 0)          /* Periodic Interval Value */
  29
  30 #define AT91_PIT_SR             0x04                    /* Status Register */
  31 #define AT91_PIT_PITS                   BIT(0)                  /* Timer Status */
  32
  33 #define AT91_PIT_PIVR           0x08                    /* Periodic Interval Value Register */
  34 #define AT91_PIT_PIIR           0x0c                    /* Periodic Interval Image Register */
  35 #define AT91_PIT_PICNT                  GENMASK(31, 20)         /* Interval Counter */
  36 #define AT91_PIT_CPIV                   GENMASK(19, 0)          /* Inverval Value */
  37
  38 #define PIT_CPIV(x)     ((x) & AT91_PIT_CPIV)
  39 #define PIT_PICNT(x)    (((x) & AT91_PIT_PICNT) >> 20)
  40
  41 struct pit_data {
  42         struct clock_event_device       clkevt;
  43         struct clocksource              clksrc;
  44
  45         void __iomem    *base;
  46         u32             cycle;
  47         u32             cnt;
  48         unsigned int    irq;
  49         bool            irq_requested;
  50         struct clk      *mck;
  51 };
  52
  53 static inline struct pit_data *clksrc_to_pit_data(struct clocksource *clksrc)
  54 {
  55         return container_of(clksrc, struct pit_data, clksrc);
  56 }
  57
  58 static inline struct pit_data *clkevt_to_pit_data(struct clock_event_device *clkevt)
  59 {
  60         return container_of(clkevt, struct pit_data, clkevt);
  61 }
  62
  63 static inline unsigned int pit_read(void __iomem *base, unsigned int reg_offset)
  64 {
  65         return readl_relaxed(base + reg_offset);
  66 }
  67
  68 static inline void pit_write(void __iomem *base, unsigned int reg_offset, unsigned long value)
  69 {
  70         writel_relaxed(value, base + reg_offset);
  71 }
  72
  73 /*
  74  * Clocksource:  just a monotonic counter of MCK/16 cycles.
  75  * We don't care whether or not PIT irqs are enabled.
  76  */
  77 static cycle_t read_pit_clk(struct clocksource *cs)
  78 {
  79         struct pit_data *data = clksrc_to_pit_data(cs);
  80         unsigned long flags;
  81         u32 elapsed;
  82         u32 t;
  83
  84         raw_local_irq_save(flags);
  85         elapsed = data->cnt;
  86         t = pit_read(data->base, AT91_PIT_PIIR);
  87         raw_local_irq_restore(flags);
  88
  89         elapsed += PIT_PICNT(t) * data->cycle;
  90         elapsed += PIT_CPIV(t);
  91         return elapsed;
  92 }
  93
  94 static int pit_clkevt_shutdown(struct clock_event_device *dev)
  95 {
  96         struct pit_data *data = clkevt_to_pit_data(dev);
  97
  98         /* disable irq, leaving the clocksource active */
  99         pit_write(data->base, AT91_PIT_MR, (data->cycle - 1) | AT91_PIT_PITEN);
 100         if (data->irq_requested) {
 101                 free_irq(data->irq, data);
 102                 data->irq_requested = false;
 103         }
 104         return 0;
 105 }
 106
 107 static irqreturn_t at91sam926x_pit_interrupt(int irq, void *dev_id);
 108 /*
 109  * Clockevent device:  interrupts every 1/HZ (== pit_cycles * MCK/16)
 110  */
 111 static int pit_clkevt_set_periodic(struct clock_event_device *dev)
 112 {
 113         struct pit_data *data = clkevt_to_pit_data(dev);
 114         int ret;
 115
 116         ret = request_irq(data->irq, at91sam926x_pit_interrupt,
 117                           IRQF_SHARED | IRQF_TIMER | IRQF_IRQPOLL,
 118                           "at91_tick", data);
 119         if (ret)
 120                 panic(pr_fmt("Unable to setup IRQ\n"));
 121
 122         data->irq_requested = true;
 123
 124         /* update clocksource counter */
 125         data->cnt += data->cycle * PIT_PICNT(pit_read(data->base, AT91_PIT_PIVR));
 126         pit_write(data->base, AT91_PIT_MR,
 127                   (data->cycle - 1) | AT91_PIT_PITEN | AT91_PIT_PITIEN);
 128         return 0;
 129 }
 130
 131 static void at91sam926x_pit_suspend(struct clock_event_device *cedev)
 132 {
 133         struct pit_data *data = clkevt_to_pit_data(cedev);
 134
 135         /* Disable timer */
 136         pit_write(data->base, AT91_PIT_MR, 0);
 137 }
 138
 139 static void at91sam926x_pit_reset(struct pit_data *data)
 140 {
 141         /* Disable timer and irqs */
 142         pit_write(data->base, AT91_PIT_MR, 0);
 143
 144         /* Clear any pending interrupts, wait for PIT to stop counting */
 145         while (PIT_CPIV(pit_read(data->base, AT91_PIT_PIVR)) != 0)
 146                 cpu_relax();
 147
 148         /* Start PIT but don't enable IRQ */
 149         pit_write(data->base, AT91_PIT_MR,
 150                   (data->cycle - 1) | AT91_PIT_PITEN);
 151 }
 152
 153 static void at91sam926x_pit_resume(struct clock_event_device *cedev)
 154 {
 155         struct pit_data *data = clkevt_to_pit_data(cedev);
 156
 157         at91sam926x_pit_reset(data);
 158 }
 159
 160 /*
 161  * IRQ handler for the timer.
 162  */
 163 static irqreturn_t at91sam926x_pit_interrupt(int irq, void *dev_id)
 164 {
 165         struct pit_data *data = dev_id;
 166
 167         /*
 168          * irqs should be disabled here, but as the irq is shared they are only
 169          * guaranteed to be off if the timer irq is registered first.
 170          */
 171         WARN_ON_ONCE(!irqs_disabled());
 172
 173         /* The PIT interrupt may be disabled, and is shared */
 174         if (clockevent_state_periodic(&data->clkevt) &&
 175             (pit_read(data->base, AT91_PIT_SR) & AT91_PIT_PITS)) {
 176                 unsigned nr_ticks;
 177
 178                 /* Get number of ticks performed before irq, and ack it */
 179                 nr_ticks = PIT_PICNT(pit_read(data->base, AT91_PIT_PIVR));
 180                 do {
 181                         data->cnt += data->cycle;
 182                         data->clkevt.event_handler(&data->clkevt);
 183                         nr_ticks--;
 184                 } while (nr_ticks);
 185
 186                 return IRQ_HANDLED;
 187         }
 188
 189         return IRQ_NONE;
 190 }
 191
 192 /*
 193  * Set up both clocksource and clockevent support.
 194  */
 195 static void __init at91sam926x_pit_common_init(struct pit_data *data)
 196 {
 197         unsigned long   pit_rate;
 198         unsigned        bits;
 199
 200         /*
 201          * Use our actual MCK to figure out how many MCK/16 ticks per
 202          * 1/HZ period (instead of a compile-time constant LATCH).
 203          */
 204         pit_rate = clk_get_rate(data->mck) / 16;
 205         data->cycle = DIV_ROUND_CLOSEST(pit_rate, HZ);
 206         WARN_ON(((data->cycle - 1) & ~AT91_PIT_PIV) != 0);
 207
 208         /* Initialize and enable the timer */
 209         at91sam926x_pit_reset(data);
 210
 211         /*
 212          * Register clocksource.  The high order bits of PIV are unused,
 213          * so this isn't a 32-bit counter unless we get clockevent irqs.
 214          */
 215         bits = 12 /* PICNT */ + ilog2(data->cycle) /* PIV */;
 216         data->clksrc.mask = CLOCKSOURCE_MASK(bits);
 217         data->clksrc.name = "pit";
 218         data->clksrc.rating = 175;
 219         data->clksrc.read = read_pit_clk;
 220         data->clksrc.flags = CLOCK_SOURCE_IS_CONTINUOUS;
 221         clocksource_register_hz(&data->clksrc, pit_rate);
 222
 223         /* Set up and register clockevents */
 224         data->clkevt.name = "pit";
 225         data->clkevt.features = CLOCK_EVT_FEAT_PERIODIC;
 226         data->clkevt.shift = 32;
 227         data->clkevt.mult = div_sc(pit_rate, NSEC_PER_SEC, data->clkevt.shift);
 228         data->clkevt.rating = 100;
 229         data->clkevt.cpumask = cpumask_of(0);
 230
 231         data->clkevt.set_state_shutdown = pit_clkevt_shutdown;
 232         data->clkevt.set_state_periodic = pit_clkevt_set_periodic;
 233         data->clkevt.resume = at91sam926x_pit_resume;
 234         data->clkevt.suspend = at91sam926x_pit_suspend;
 235         clockevents_register_device(&data->clkevt);
 236 }
 237
 238 static void __init at91sam926x_pit_dt_init(struct device_node *node)
 239 {
 240         struct pit_data *data;
 241
 242         data = kzalloc(sizeof(*data), GFP_KERNEL);
 243         if (!data)
 244                 panic(pr_fmt("Unable to allocate memory\n"));
 245
 246         data->base = of_iomap(node, 0);
 247         if (!data->base)
 248                 panic(pr_fmt("Could not map PIT address\n"));
 249
 250         data->mck = of_clk_get(node, 0);
 251         if (IS_ERR(data->mck))
 252                 /* Fallback on clkdev for !CCF-based boards */
 253                 data->mck = clk_get(NULL, "mck");
 254
 255         if (IS_ERR(data->mck))
 256                 panic(pr_fmt("Unable to get mck clk\n"));
 257
 258         /* Get the interrupts property */
 259         data->irq = irq_of_parse_and_map(node, 0);
 260         if (!data->irq)
 261                 panic(pr_fmt("Unable to get IRQ from DT\n"));
 262
 263         at91sam926x_pit_common_init(data);
 264 }
 265 CLOCKSOURCE_OF_DECLARE(at91sam926x_pit, "atmel,at91sam9260-pit",
 266                        at91sam926x_pit_dt_init);