xref: /openbmc/qemu/include/hw/timer/armv7m_systick.h (revision 99abcbc7600c62c294e973db340adf6939932a93)
1 /*
2  * ARMv7M SysTick timer
3  *
4  * Copyright (c) 2006-2007 CodeSourcery.
5  * Written by Paul Brook
6  * Copyright (c) 2017 Linaro Ltd
7  * Written by Peter Maydell
8  *
9  * This code is licensed under the GPL (version 2 or later).
10  */
11 
12 #ifndef HW_TIMER_ARMV7M_SYSTICK_H
13 #define HW_TIMER_ARMV7M_SYSTICK_H
14 
15 #include "hw/sysbus.h"
16 #include "qom/object.h"
17 #include "hw/ptimer.h"
18 #include "hw/clock.h"
19 
20 #define TYPE_SYSTICK "armv7m_systick"
21 
22 OBJECT_DECLARE_SIMPLE_TYPE(SysTickState, SYSTICK)
23 
24 /*
25  * QEMU interface:
26  *  + sysbus MMIO region 0 is the register interface (covering
27  *    the registers which are mapped at address 0xE000E010)
28  *  + sysbus IRQ 0 is the interrupt line to the NVIC
29  *  + Clock input "refclk" is the external reference clock
30  *    (used when SYST_CSR.CLKSOURCE == 0)
31  *  + Clock input "cpuclk" is the main CPU clock
32  *    (used when SYST_CSR.CLKSOURCE == 1)
33  */
34 
35 struct SysTickState {
36     /*< private >*/
37     SysBusDevice parent_obj;
38     /*< public >*/
39 
40     uint32_t control;
41     uint32_t reload;
42     int64_t tick;
43     ptimer_state *ptimer;
44     MemoryRegion iomem;
45     qemu_irq irq;
46     Clock *refclk;
47     Clock *cpuclk;
48 };
49 
50 /*
51  * Multiplication factor to convert from system clock ticks to qemu timer
52  * ticks. This should be set (by board code, usually) to a value
53  * equal to NANOSECONDS_PER_SECOND / frq, where frq is the clock frequency
54  * in Hz of the CPU.
55  *
56  * This value is used by the systick device when it is running in
57  * its "use the CPU clock" mode (ie when SYST_CSR.CLKSOURCE == 1) to
58  * set how fast the timer should tick.
59  *
60  * TODO: we should refactor this so that rather than using a global
61  * we use a device property or something similar. This is complicated
62  * because (a) the property would need to be plumbed through from the
63  * board code down through various layers to the systick device
64  * and (b) the property needs to be modifiable after realize, because
65  * the stellaris board uses this to implement the behaviour where the
66  * guest can reprogram the PLL registers to downclock the CPU, and the
67  * systick device needs to react accordingly. Possibly this should
68  * be deferred until we have a good API for modelling clock trees.
69  */
70 extern int system_clock_scale;
71 
72 #endif
73