xref: /openbmc/qemu/hw/timer/imx_epit.c (revision e6e03dcf)
1 /*
2  * IMX EPIT 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 "qemu/osdep.h"
16 #include "hw/timer/imx_epit.h"
17 #include "migration/vmstate.h"
18 #include "hw/irq.h"
19 #include "hw/misc/imx_ccm.h"
20 #include "qemu/module.h"
21 #include "qemu/log.h"
22 
23 #ifndef DEBUG_IMX_EPIT
24 #define DEBUG_IMX_EPIT 0
25 #endif
26 
27 #define DPRINTF(fmt, args...) \
28     do { \
29         if (DEBUG_IMX_EPIT) { \
30             fprintf(stderr, "[%s]%s: " fmt , TYPE_IMX_EPIT, \
31                                              __func__, ##args); \
32         } \
33     } while (0)
34 
35 static const char *imx_epit_reg_name(uint32_t reg)
36 {
37     switch (reg) {
38     case 0:
39         return "CR";
40     case 1:
41         return "SR";
42     case 2:
43         return "LR";
44     case 3:
45         return "CMP";
46     case 4:
47         return "CNT";
48     default:
49         return "[?]";
50     }
51 }
52 
53 /*
54  * Exact clock frequencies vary from board to board.
55  * These are typical.
56  */
57 static const IMXClk imx_epit_clocks[] =  {
58     CLK_NONE,      /* 00 disabled */
59     CLK_IPG,       /* 01 ipg_clk, ~532MHz */
60     CLK_IPG_HIGH,  /* 10 ipg_clk_highfreq */
61     CLK_32k,       /* 11 ipg_clk_32k -- ~32kHz */
62 };
63 
64 /*
65  * Update interrupt status
66  */
67 static void imx_epit_update_int(IMXEPITState *s)
68 {
69     if (s->sr && (s->cr & CR_OCIEN) && (s->cr & CR_EN)) {
70         qemu_irq_raise(s->irq);
71     } else {
72         qemu_irq_lower(s->irq);
73     }
74 }
75 
76 /*
77  * Must be called from within a ptimer_transaction_begin/commit block
78  * for both s->timer_cmp and s->timer_reload.
79  */
80 static void imx_epit_set_freq(IMXEPITState *s)
81 {
82     uint32_t clksrc;
83     uint32_t prescaler;
84 
85     clksrc = extract32(s->cr, CR_CLKSRC_SHIFT, 2);
86     prescaler = 1 + extract32(s->cr, CR_PRESCALE_SHIFT, 12);
87 
88     s->freq = imx_ccm_get_clock_frequency(s->ccm,
89                                 imx_epit_clocks[clksrc]) / prescaler;
90 
91     DPRINTF("Setting ptimer frequency to %u\n", s->freq);
92 
93     if (s->freq) {
94         ptimer_set_freq(s->timer_reload, s->freq);
95         ptimer_set_freq(s->timer_cmp, s->freq);
96     }
97 }
98 
99 static void imx_epit_reset(DeviceState *dev)
100 {
101     IMXEPITState *s = IMX_EPIT(dev);
102 
103     /*
104      * Soft reset doesn't touch some bits; hard reset clears them
105      */
106     s->cr &= (CR_EN|CR_ENMOD|CR_STOPEN|CR_DOZEN|CR_WAITEN|CR_DBGEN);
107     s->sr = 0;
108     s->lr = EPIT_TIMER_MAX;
109     s->cmp = 0;
110     s->cnt = 0;
111     ptimer_transaction_begin(s->timer_cmp);
112     ptimer_transaction_begin(s->timer_reload);
113     /* stop both timers */
114     ptimer_stop(s->timer_cmp);
115     ptimer_stop(s->timer_reload);
116     /* compute new frequency */
117     imx_epit_set_freq(s);
118     /* init both timers to EPIT_TIMER_MAX */
119     ptimer_set_limit(s->timer_cmp, EPIT_TIMER_MAX, 1);
120     ptimer_set_limit(s->timer_reload, EPIT_TIMER_MAX, 1);
121     if (s->freq && (s->cr & CR_EN)) {
122         /* if the timer is still enabled, restart it */
123         ptimer_run(s->timer_reload, 0);
124     }
125     ptimer_transaction_commit(s->timer_cmp);
126     ptimer_transaction_commit(s->timer_reload);
127 }
128 
129 static uint32_t imx_epit_update_count(IMXEPITState *s)
130 {
131     s->cnt = ptimer_get_count(s->timer_reload);
132 
133     return s->cnt;
134 }
135 
136 static uint64_t imx_epit_read(void *opaque, hwaddr offset, unsigned size)
137 {
138     IMXEPITState *s = IMX_EPIT(opaque);
139     uint32_t reg_value = 0;
140 
141     switch (offset >> 2) {
142     case 0: /* Control Register */
143         reg_value = s->cr;
144         break;
145 
146     case 1: /* Status Register */
147         reg_value = s->sr;
148         break;
149 
150     case 2: /* LR - ticks*/
151         reg_value = s->lr;
152         break;
153 
154     case 3: /* CMP */
155         reg_value = s->cmp;
156         break;
157 
158     case 4: /* CNT */
159         imx_epit_update_count(s);
160         reg_value = s->cnt;
161         break;
162 
163     default:
164         qemu_log_mask(LOG_GUEST_ERROR, "[%s]%s: Bad register at offset 0x%"
165                       HWADDR_PRIx "\n", TYPE_IMX_EPIT, __func__, offset);
166         break;
167     }
168 
169     DPRINTF("(%s) = 0x%08x\n", imx_epit_reg_name(offset >> 2), reg_value);
170 
171     return reg_value;
172 }
173 
174 /* Must be called from ptimer_transaction_begin/commit block for s->timer_cmp */
175 static void imx_epit_reload_compare_timer(IMXEPITState *s)
176 {
177     if ((s->cr & (CR_EN | CR_OCIEN)) == (CR_EN | CR_OCIEN))  {
178         /* if the compare feature is on and timers are running */
179         uint32_t tmp = imx_epit_update_count(s);
180         uint64_t next;
181         if (tmp > s->cmp) {
182             /* It'll fire in this round of the timer */
183             next = tmp - s->cmp;
184         } else { /* catch it next time around */
185             next = tmp - s->cmp + ((s->cr & CR_RLD) ? EPIT_TIMER_MAX : s->lr);
186         }
187         ptimer_set_count(s->timer_cmp, next);
188     }
189 }
190 
191 static void imx_epit_write(void *opaque, hwaddr offset, uint64_t value,
192                            unsigned size)
193 {
194     IMXEPITState *s = IMX_EPIT(opaque);
195     uint64_t oldcr;
196 
197     DPRINTF("(%s, value = 0x%08x)\n", imx_epit_reg_name(offset >> 2),
198             (uint32_t)value);
199 
200     switch (offset >> 2) {
201     case 0: /* CR */
202         ptimer_transaction_begin(s->timer_cmp);
203         ptimer_transaction_begin(s->timer_reload);
204 
205         oldcr = s->cr;
206         s->cr = value & 0x03ffffff;
207         if (s->cr & CR_SWR) {
208             /* handle the reset */
209             imx_epit_reset(DEVICE(s));
210         } else {
211             imx_epit_set_freq(s);
212         }
213 
214         if (s->freq && (s->cr & CR_EN) && !(oldcr & CR_EN)) {
215             if (s->cr & CR_ENMOD) {
216                 if (s->cr & CR_RLD) {
217                     ptimer_set_limit(s->timer_reload, s->lr, 1);
218                     ptimer_set_limit(s->timer_cmp, s->lr, 1);
219                 } else {
220                     ptimer_set_limit(s->timer_reload, EPIT_TIMER_MAX, 1);
221                     ptimer_set_limit(s->timer_cmp, EPIT_TIMER_MAX, 1);
222                 }
223             }
224 
225             imx_epit_reload_compare_timer(s);
226             ptimer_run(s->timer_reload, 0);
227             if (s->cr & CR_OCIEN) {
228                 ptimer_run(s->timer_cmp, 0);
229             } else {
230                 ptimer_stop(s->timer_cmp);
231             }
232         } else if (!(s->cr & CR_EN)) {
233             /* stop both timers */
234             ptimer_stop(s->timer_reload);
235             ptimer_stop(s->timer_cmp);
236         } else  if (s->cr & CR_OCIEN) {
237             if (!(oldcr & CR_OCIEN)) {
238                 imx_epit_reload_compare_timer(s);
239                 ptimer_run(s->timer_cmp, 0);
240             }
241         } else {
242             ptimer_stop(s->timer_cmp);
243         }
244 
245         ptimer_transaction_commit(s->timer_cmp);
246         ptimer_transaction_commit(s->timer_reload);
247         break;
248 
249     case 1: /* SR - ACK*/
250         /* writing 1 to OCIF clear the OCIF bit */
251         if (value & 0x01) {
252             s->sr = 0;
253             imx_epit_update_int(s);
254         }
255         break;
256 
257     case 2: /* LR - set ticks */
258         s->lr = value;
259 
260         ptimer_transaction_begin(s->timer_cmp);
261         ptimer_transaction_begin(s->timer_reload);
262         if (s->cr & CR_RLD) {
263             /* Also set the limit if the LRD bit is set */
264             /* If IOVW bit is set then set the timer value */
265             ptimer_set_limit(s->timer_reload, s->lr, s->cr & CR_IOVW);
266             ptimer_set_limit(s->timer_cmp, s->lr, 0);
267         } else if (s->cr & CR_IOVW) {
268             /* If IOVW bit is set then set the timer value */
269             ptimer_set_count(s->timer_reload, s->lr);
270         }
271 
272         imx_epit_reload_compare_timer(s);
273         ptimer_transaction_commit(s->timer_cmp);
274         ptimer_transaction_commit(s->timer_reload);
275         break;
276 
277     case 3: /* CMP */
278         s->cmp = value;
279 
280         ptimer_transaction_begin(s->timer_cmp);
281         imx_epit_reload_compare_timer(s);
282         ptimer_transaction_commit(s->timer_cmp);
283 
284         break;
285 
286     default:
287         qemu_log_mask(LOG_GUEST_ERROR, "[%s]%s: Bad register at offset 0x%"
288                       HWADDR_PRIx "\n", TYPE_IMX_EPIT, __func__, offset);
289 
290         break;
291     }
292 }
293 static void imx_epit_cmp(void *opaque)
294 {
295     IMXEPITState *s = IMX_EPIT(opaque);
296 
297     DPRINTF("sr was %d\n", s->sr);
298 
299     s->sr = 1;
300     imx_epit_update_int(s);
301 }
302 
303 static void imx_epit_reload(void *opaque)
304 {
305     /* No action required on rollover of timer_reload */
306 }
307 
308 static const MemoryRegionOps imx_epit_ops = {
309     .read = imx_epit_read,
310     .write = imx_epit_write,
311     .endianness = DEVICE_NATIVE_ENDIAN,
312 };
313 
314 static const VMStateDescription vmstate_imx_timer_epit = {
315     .name = TYPE_IMX_EPIT,
316     .version_id = 2,
317     .minimum_version_id = 2,
318     .fields = (VMStateField[]) {
319         VMSTATE_UINT32(cr, IMXEPITState),
320         VMSTATE_UINT32(sr, IMXEPITState),
321         VMSTATE_UINT32(lr, IMXEPITState),
322         VMSTATE_UINT32(cmp, IMXEPITState),
323         VMSTATE_UINT32(cnt, IMXEPITState),
324         VMSTATE_UINT32(freq, IMXEPITState),
325         VMSTATE_PTIMER(timer_reload, IMXEPITState),
326         VMSTATE_PTIMER(timer_cmp, IMXEPITState),
327         VMSTATE_END_OF_LIST()
328     }
329 };
330 
331 static void imx_epit_realize(DeviceState *dev, Error **errp)
332 {
333     IMXEPITState *s = IMX_EPIT(dev);
334     SysBusDevice *sbd = SYS_BUS_DEVICE(dev);
335 
336     DPRINTF("\n");
337 
338     sysbus_init_irq(sbd, &s->irq);
339     memory_region_init_io(&s->iomem, OBJECT(s), &imx_epit_ops, s, TYPE_IMX_EPIT,
340                           0x00001000);
341     sysbus_init_mmio(sbd, &s->iomem);
342 
343     s->timer_reload = ptimer_init(imx_epit_reload, s, PTIMER_POLICY_DEFAULT);
344 
345     s->timer_cmp = ptimer_init(imx_epit_cmp, s, PTIMER_POLICY_DEFAULT);
346 }
347 
348 static void imx_epit_class_init(ObjectClass *klass, void *data)
349 {
350     DeviceClass *dc  = DEVICE_CLASS(klass);
351 
352     dc->realize = imx_epit_realize;
353     dc->reset = imx_epit_reset;
354     dc->vmsd = &vmstate_imx_timer_epit;
355     dc->desc = "i.MX periodic timer";
356 }
357 
358 static const TypeInfo imx_epit_info = {
359     .name = TYPE_IMX_EPIT,
360     .parent = TYPE_SYS_BUS_DEVICE,
361     .instance_size = sizeof(IMXEPITState),
362     .class_init = imx_epit_class_init,
363 };
364 
365 static void imx_epit_register_types(void)
366 {
367     type_register_static(&imx_epit_info);
368 }
369 
370 type_init(imx_epit_register_types)
371