xref: /openbmc/qemu/hw/timer/imx_gpt.c (revision 61b9251a)
1 /*
2  * IMX GPT Timer
3  *
4  * Copyright (c) 2008 OK Labs
5  * Copyright (c) 2011 NICTA Pty Ltd
6  * Originally written by Hans Jiang
7  * Updated by Peter Chubb
8  * Updated by Jean-Christophe Dubois <jcd@tribudubois.net>
9  *
10  * This code is licensed under GPL version 2 or later.  See
11  * the COPYING file in the top-level directory.
12  *
13  */
14 
15 #include "hw/timer/imx_gpt.h"
16 #include "hw/misc/imx_ccm.h"
17 #include "qemu/main-loop.h"
18 
19 #ifndef DEBUG_IMX_GPT
20 #define DEBUG_IMX_GPT 0
21 #endif
22 
23 #define DPRINTF(fmt, args...) \
24     do { \
25         if (DEBUG_IMX_GPT) { \
26             fprintf(stderr, "[%s]%s: " fmt , TYPE_IMX_GPT, \
27                                              __func__, ##args); \
28         } \
29     } while (0)
30 
31 static char const *imx_gpt_reg_name(uint32_t reg)
32 {
33     switch (reg) {
34     case 0:
35         return "CR";
36     case 1:
37         return "PR";
38     case 2:
39         return "SR";
40     case 3:
41         return "IR";
42     case 4:
43         return "OCR1";
44     case 5:
45         return "OCR2";
46     case 6:
47         return "OCR3";
48     case 7:
49         return "ICR1";
50     case 8:
51         return "ICR2";
52     case 9:
53         return "CNT";
54     default:
55         return "[?]";
56     }
57 }
58 
59 static const VMStateDescription vmstate_imx_timer_gpt = {
60     .name = TYPE_IMX_GPT,
61     .version_id = 3,
62     .minimum_version_id = 3,
63     .fields = (VMStateField[]) {
64         VMSTATE_UINT32(cr, IMXGPTState),
65         VMSTATE_UINT32(pr, IMXGPTState),
66         VMSTATE_UINT32(sr, IMXGPTState),
67         VMSTATE_UINT32(ir, IMXGPTState),
68         VMSTATE_UINT32(ocr1, IMXGPTState),
69         VMSTATE_UINT32(ocr2, IMXGPTState),
70         VMSTATE_UINT32(ocr3, IMXGPTState),
71         VMSTATE_UINT32(icr1, IMXGPTState),
72         VMSTATE_UINT32(icr2, IMXGPTState),
73         VMSTATE_UINT32(cnt, IMXGPTState),
74         VMSTATE_UINT32(next_timeout, IMXGPTState),
75         VMSTATE_UINT32(next_int, IMXGPTState),
76         VMSTATE_UINT32(freq, IMXGPTState),
77         VMSTATE_PTIMER(timer, IMXGPTState),
78         VMSTATE_END_OF_LIST()
79     }
80 };
81 
82 static const IMXClk imx_gpt_clocks[] = {
83     NOCLK,    /* 000 No clock source */
84     IPG,      /* 001 ipg_clk, 532MHz*/
85     IPG,      /* 010 ipg_clk_highfreq */
86     NOCLK,    /* 011 not defined */
87     CLK_32k,  /* 100 ipg_clk_32k */
88     NOCLK,    /* 101 not defined */
89     NOCLK,    /* 110 not defined */
90     NOCLK,    /* 111 not defined */
91 };
92 
93 static void imx_gpt_set_freq(IMXGPTState *s)
94 {
95     uint32_t clksrc = extract32(s->cr, GPT_CR_CLKSRC_SHIFT, 3);
96     uint32_t freq = imx_clock_frequency(s->ccm, imx_gpt_clocks[clksrc])
97                     / (1 + s->pr);
98     s->freq = freq;
99 
100     DPRINTF("Setting clksrc %d to frequency %d\n", clksrc, freq);
101 
102     if (freq) {
103         ptimer_set_freq(s->timer, freq);
104     }
105 }
106 
107 static void imx_gpt_update_int(IMXGPTState *s)
108 {
109     if ((s->sr & s->ir) && (s->cr & GPT_CR_EN)) {
110         qemu_irq_raise(s->irq);
111     } else {
112         qemu_irq_lower(s->irq);
113     }
114 }
115 
116 static uint32_t imx_gpt_update_count(IMXGPTState *s)
117 {
118     s->cnt = s->next_timeout - (uint32_t)ptimer_get_count(s->timer);
119 
120     return s->cnt;
121 }
122 
123 static inline uint32_t imx_gpt_find_limit(uint32_t count, uint32_t reg,
124                                           uint32_t timeout)
125 {
126     if ((count < reg) && (timeout > reg)) {
127         timeout = reg;
128     }
129 
130     return timeout;
131 }
132 
133 static void imx_gpt_compute_next_timeout(IMXGPTState *s, bool event)
134 {
135     uint32_t timeout = GPT_TIMER_MAX;
136     uint32_t count = 0;
137     long long limit;
138 
139     if (!(s->cr & GPT_CR_EN)) {
140         /* if not enabled just return */
141         return;
142     }
143 
144     if (event) {
145         /* This is a timer event  */
146 
147         if ((s->cr & GPT_CR_FRR)  && (s->next_timeout != GPT_TIMER_MAX)) {
148             /*
149              * if we are in free running mode and we have not reached
150              * the GPT_TIMER_MAX limit, then update the count
151              */
152             count = imx_gpt_update_count(s);
153         }
154     } else {
155         /* not a timer event, then just update the count */
156 
157         count = imx_gpt_update_count(s);
158     }
159 
160     /* now, find the next timeout related to count */
161 
162     if (s->ir & GPT_IR_OF1IE) {
163         timeout = imx_gpt_find_limit(count, s->ocr1, timeout);
164     }
165     if (s->ir & GPT_IR_OF2IE) {
166         timeout = imx_gpt_find_limit(count, s->ocr2, timeout);
167     }
168     if (s->ir & GPT_IR_OF3IE) {
169         timeout = imx_gpt_find_limit(count, s->ocr3, timeout);
170     }
171 
172     /* find the next set of interrupts to raise for next timer event */
173 
174     s->next_int = 0;
175     if ((s->ir & GPT_IR_OF1IE) && (timeout == s->ocr1)) {
176         s->next_int |= GPT_SR_OF1;
177     }
178     if ((s->ir & GPT_IR_OF2IE) && (timeout == s->ocr2)) {
179         s->next_int |= GPT_SR_OF2;
180     }
181     if ((s->ir & GPT_IR_OF3IE) && (timeout == s->ocr3)) {
182         s->next_int |= GPT_SR_OF3;
183     }
184     if ((s->ir & GPT_IR_ROVIE) && (timeout == GPT_TIMER_MAX)) {
185         s->next_int |= GPT_SR_ROV;
186     }
187 
188     /* the new range to count down from */
189     limit = timeout - imx_gpt_update_count(s);
190 
191     if (limit < 0) {
192         /*
193          * if we reach here, then QEMU is running too slow and we pass the
194          * timeout limit while computing it. Let's deliver the interrupt
195          * and compute a new limit.
196          */
197         s->sr |= s->next_int;
198 
199         imx_gpt_compute_next_timeout(s, event);
200 
201         imx_gpt_update_int(s);
202     } else {
203         /* New timeout value */
204         s->next_timeout = timeout;
205 
206         /* reset the limit to the computed range */
207         ptimer_set_limit(s->timer, limit, 1);
208     }
209 }
210 
211 static uint64_t imx_gpt_read(void *opaque, hwaddr offset, unsigned size)
212 {
213     IMXGPTState *s = IMX_GPT(opaque);
214     uint32_t reg_value = 0;
215 
216     switch (offset >> 2) {
217     case 0: /* Control Register */
218         reg_value = s->cr;
219         break;
220 
221     case 1: /* prescaler */
222         reg_value = s->pr;
223         break;
224 
225     case 2: /* Status Register */
226         reg_value = s->sr;
227         break;
228 
229     case 3: /* Interrupt Register */
230         reg_value = s->ir;
231         break;
232 
233     case 4: /* Output Compare Register 1 */
234         reg_value = s->ocr1;
235         break;
236 
237     case 5: /* Output Compare Register 2 */
238         reg_value = s->ocr2;
239         break;
240 
241     case 6: /* Output Compare Register 3 */
242         reg_value = s->ocr3;
243         break;
244 
245     case 7: /* input Capture Register 1 */
246         qemu_log_mask(LOG_UNIMP, "[%s]%s: icr1 feature is not implemented\n",
247                       TYPE_IMX_GPT, __func__);
248         reg_value = s->icr1;
249         break;
250 
251     case 8: /* input Capture Register 2 */
252         qemu_log_mask(LOG_UNIMP, "[%s]%s: icr2 feature is not implemented\n",
253                       TYPE_IMX_GPT, __func__);
254         reg_value = s->icr2;
255         break;
256 
257     case 9: /* cnt */
258         imx_gpt_update_count(s);
259         reg_value = s->cnt;
260         break;
261 
262     default:
263         qemu_log_mask(LOG_GUEST_ERROR, "[%s]%s: Bad register at offset 0x%"
264                       HWADDR_PRIx "\n", TYPE_IMX_GPT, __func__, offset);
265         break;
266     }
267 
268     DPRINTF("(%s) = 0x%08x\n", imx_gpt_reg_name(offset >> 2), reg_value);
269 
270     return reg_value;
271 }
272 
273 static void imx_gpt_reset(DeviceState *dev)
274 {
275     IMXGPTState *s = IMX_GPT(dev);
276 
277     /* stop timer */
278     ptimer_stop(s->timer);
279 
280     /*
281      * Soft reset doesn't touch some bits; hard reset clears them
282      */
283     s->cr &= ~(GPT_CR_EN|GPT_CR_ENMOD|GPT_CR_STOPEN|GPT_CR_DOZEN|
284                GPT_CR_WAITEN|GPT_CR_DBGEN);
285     s->sr = 0;
286     s->pr = 0;
287     s->ir = 0;
288     s->cnt = 0;
289     s->ocr1 = GPT_TIMER_MAX;
290     s->ocr2 = GPT_TIMER_MAX;
291     s->ocr3 = GPT_TIMER_MAX;
292     s->icr1 = 0;
293     s->icr2 = 0;
294 
295     s->next_timeout = GPT_TIMER_MAX;
296     s->next_int = 0;
297 
298     /* compute new freq */
299     imx_gpt_set_freq(s);
300 
301     /* reset the limit to GPT_TIMER_MAX */
302     ptimer_set_limit(s->timer, GPT_TIMER_MAX, 1);
303 
304     /* if the timer is still enabled, restart it */
305     if (s->freq && (s->cr & GPT_CR_EN)) {
306         ptimer_run(s->timer, 1);
307     }
308 }
309 
310 static void imx_gpt_write(void *opaque, hwaddr offset, uint64_t value,
311                           unsigned size)
312 {
313     IMXGPTState *s = IMX_GPT(opaque);
314     uint32_t oldreg;
315 
316     DPRINTF("(%s, value = 0x%08x)\n", imx_gpt_reg_name(offset >> 2),
317             (uint32_t)value);
318 
319     switch (offset >> 2) {
320     case 0:
321         oldreg = s->cr;
322         s->cr = value & ~0x7c14;
323         if (s->cr & GPT_CR_SWR) { /* force reset */
324             /* handle the reset */
325             imx_gpt_reset(DEVICE(s));
326         } else {
327             /* set our freq, as the source might have changed */
328             imx_gpt_set_freq(s);
329 
330             if ((oldreg ^ s->cr) & GPT_CR_EN) {
331                 if (s->cr & GPT_CR_EN) {
332                     if (s->cr & GPT_CR_ENMOD) {
333                         s->next_timeout = GPT_TIMER_MAX;
334                         ptimer_set_count(s->timer, GPT_TIMER_MAX);
335                         imx_gpt_compute_next_timeout(s, false);
336                     }
337                     ptimer_run(s->timer, 1);
338                 } else {
339                     /* stop timer */
340                     ptimer_stop(s->timer);
341                 }
342             }
343         }
344         break;
345 
346     case 1: /* Prescaler */
347         s->pr = value & 0xfff;
348         imx_gpt_set_freq(s);
349         break;
350 
351     case 2: /* SR */
352         s->sr &= ~(value & 0x3f);
353         imx_gpt_update_int(s);
354         break;
355 
356     case 3: /* IR -- interrupt register */
357         s->ir = value & 0x3f;
358         imx_gpt_update_int(s);
359 
360         imx_gpt_compute_next_timeout(s, false);
361 
362         break;
363 
364     case 4: /* OCR1 -- output compare register */
365         s->ocr1 = value;
366 
367         /* In non-freerun mode, reset count when this register is written */
368         if (!(s->cr & GPT_CR_FRR)) {
369             s->next_timeout = GPT_TIMER_MAX;
370             ptimer_set_limit(s->timer, GPT_TIMER_MAX, 1);
371         }
372 
373         /* compute the new timeout */
374         imx_gpt_compute_next_timeout(s, false);
375 
376         break;
377 
378     case 5: /* OCR2 -- output compare register */
379         s->ocr2 = value;
380 
381         /* compute the new timeout */
382         imx_gpt_compute_next_timeout(s, false);
383 
384         break;
385 
386     case 6: /* OCR3 -- output compare register */
387         s->ocr3 = value;
388 
389         /* compute the new timeout */
390         imx_gpt_compute_next_timeout(s, false);
391 
392         break;
393 
394     default:
395         qemu_log_mask(LOG_GUEST_ERROR, "[%s]%s: Bad register at offset 0x%"
396                       HWADDR_PRIx "\n", TYPE_IMX_GPT, __func__, offset);
397         break;
398     }
399 }
400 
401 static void imx_gpt_timeout(void *opaque)
402 {
403     IMXGPTState *s = IMX_GPT(opaque);
404 
405     DPRINTF("\n");
406 
407     s->sr |= s->next_int;
408     s->next_int = 0;
409 
410     imx_gpt_compute_next_timeout(s, true);
411 
412     imx_gpt_update_int(s);
413 
414     if (s->freq && (s->cr & GPT_CR_EN)) {
415         ptimer_run(s->timer, 1);
416     }
417 }
418 
419 static const MemoryRegionOps imx_gpt_ops = {
420     .read = imx_gpt_read,
421     .write = imx_gpt_write,
422     .endianness = DEVICE_NATIVE_ENDIAN,
423 };
424 
425 
426 static void imx_gpt_realize(DeviceState *dev, Error **errp)
427 {
428     IMXGPTState *s = IMX_GPT(dev);
429     SysBusDevice *sbd = SYS_BUS_DEVICE(dev);
430     QEMUBH *bh;
431 
432     sysbus_init_irq(sbd, &s->irq);
433     memory_region_init_io(&s->iomem, OBJECT(s), &imx_gpt_ops, s, TYPE_IMX_GPT,
434                           0x00001000);
435     sysbus_init_mmio(sbd, &s->iomem);
436 
437     bh = qemu_bh_new(imx_gpt_timeout, s);
438     s->timer = ptimer_init(bh);
439 }
440 
441 static void imx_gpt_class_init(ObjectClass *klass, void *data)
442 {
443     DeviceClass *dc = DEVICE_CLASS(klass);
444 
445     dc->realize = imx_gpt_realize;
446     dc->reset = imx_gpt_reset;
447     dc->vmsd = &vmstate_imx_timer_gpt;
448     dc->desc = "i.MX general timer";
449 }
450 
451 static const TypeInfo imx_gpt_info = {
452     .name = TYPE_IMX_GPT,
453     .parent = TYPE_SYS_BUS_DEVICE,
454     .instance_size = sizeof(IMXGPTState),
455     .class_init = imx_gpt_class_init,
456 };
457 
458 static void imx_gpt_register_types(void)
459 {
460     type_register_static(&imx_gpt_info);
461 }
462 
463 type_init(imx_gpt_register_types)
464