xref: /openbmc/qemu/include/hw/timer/imx_gpt.h (revision b8116f4c)
1 /*
2  * i.MX 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  * Permission is hereby granted, free of charge, to any person obtaining a copy
11  * of this software and associated documentation files (the "Software"), to deal
12  * in the Software without restriction, including without limitation the rights
13  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14  * copies of the Software, and to permit persons to whom the Software is
15  * furnished to do so, subject to the following conditions:
16  *
17  * The above copyright notice and this permission notice shall be included in
18  * all copies or substantial portions of the Software.
19  *
20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
23  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
26  * THE SOFTWARE.
27  */
28 
29 #ifndef IMX_GPT_H
30 #define IMX_GPT_H
31 
32 #include "hw/sysbus.h"
33 #include "hw/ptimer.h"
34 #include "hw/misc/imx_ccm.h"
35 #include "qom/object.h"
36 
37 /*
38  * GPT : General purpose timer
39  *
40  * This timer counts up continuously while it is enabled, resetting itself
41  * to 0 when it reaches GPT_TIMER_MAX (in freerun mode) or when it
42  * reaches the value of one of the ocrX (in periodic mode).
43  */
44 
45 #define GPT_TIMER_MAX  0XFFFFFFFFUL
46 
47 /* Control register.  Not all of these bits have any effect (yet) */
48 #define GPT_CR_EN     (1 << 0)  /* GPT Enable */
49 #define GPT_CR_ENMOD  (1 << 1)  /* GPT Enable Mode */
50 #define GPT_CR_DBGEN  (1 << 2)  /* GPT Debug mode enable */
51 #define GPT_CR_WAITEN (1 << 3)  /* GPT Wait Mode Enable  */
52 #define GPT_CR_DOZEN  (1 << 4)  /* GPT Doze mode enable */
53 #define GPT_CR_STOPEN (1 << 5)  /* GPT Stop Mode Enable */
54 #define GPT_CR_CLKSRC_SHIFT (6)
55 #define GPT_CR_CLKSRC_MASK  (0x7)
56 
57 #define GPT_CR_FRR    (1 << 9)  /* Freerun or Restart */
58 #define GPT_CR_SWR    (1 << 15) /* Software Reset */
59 #define GPT_CR_IM1    (3 << 16) /* Input capture channel 1 mode (2 bits) */
60 #define GPT_CR_IM2    (3 << 18) /* Input capture channel 2 mode (2 bits) */
61 #define GPT_CR_OM1    (7 << 20) /* Output Compare Channel 1 Mode (3 bits) */
62 #define GPT_CR_OM2    (7 << 23) /* Output Compare Channel 2 Mode (3 bits) */
63 #define GPT_CR_OM3    (7 << 26) /* Output Compare Channel 3 Mode (3 bits) */
64 #define GPT_CR_FO1    (1 << 29) /* Force Output Compare Channel 1 */
65 #define GPT_CR_FO2    (1 << 30) /* Force Output Compare Channel 2 */
66 #define GPT_CR_FO3    (1 << 31) /* Force Output Compare Channel 3 */
67 
68 #define GPT_SR_OF1  (1 << 0)
69 #define GPT_SR_OF2  (1 << 1)
70 #define GPT_SR_OF3  (1 << 2)
71 #define GPT_SR_ROV  (1 << 5)
72 
73 #define GPT_IR_OF1IE  (1 << 0)
74 #define GPT_IR_OF2IE  (1 << 1)
75 #define GPT_IR_OF3IE  (1 << 2)
76 #define GPT_IR_ROVIE  (1 << 5)
77 
78 #define TYPE_IMX25_GPT "imx25.gpt"
79 #define TYPE_IMX31_GPT "imx31.gpt"
80 #define TYPE_IMX6_GPT "imx6.gpt"
81 #define TYPE_IMX6UL_GPT "imx6ul.gpt"
82 #define TYPE_IMX7_GPT "imx7.gpt"
83 
84 #define TYPE_IMX_GPT TYPE_IMX25_GPT
85 
86 typedef struct IMXGPTState IMXGPTState;
87 DECLARE_INSTANCE_CHECKER(IMXGPTState, IMX_GPT,
88                          TYPE_IMX_GPT)
89 
90 struct IMXGPTState {
91     /*< private >*/
92     SysBusDevice parent_obj;
93 
94     /*< public >*/
95     ptimer_state *timer;
96     MemoryRegion  iomem;
97     IMXCCMState  *ccm;
98 
99     uint32_t cr;
100     uint32_t pr;
101     uint32_t sr;
102     uint32_t ir;
103     uint32_t ocr1;
104     uint32_t ocr2;
105     uint32_t ocr3;
106     uint32_t icr1;
107     uint32_t icr2;
108     uint32_t cnt;
109 
110     uint32_t next_timeout;
111     uint32_t next_int;
112 
113     uint32_t freq;
114 
115     qemu_irq irq;
116 
117     const IMXClk *clocks;
118 };
119 
120 #endif /* IMX_GPT_H */
121