Software APIs
dt_rv_timer.h
Go to the documentation of this file.
1
// Copyright lowRISC contributors (OpenTitan project).
2
// Licensed under the Apache License, Version 2.0, see LICENSE for details.
3
// SPDX-License-Identifier: Apache-2.0
4
//
5
// Device table API auto-generated by `dtgen`
6
7
#ifndef OPENTITAN_DT_RV_TIMER_H_
8
#define OPENTITAN_DT_RV_TIMER_H_
9
10
#ifdef __cplusplus
11
extern
"C"
{
12
#endif
// __cplusplus
13
14
/**
15
* @file
16
* @brief Device Tables (DT) for IP rv_timer and top earlgrey.
17
*
18
* This file contains the type definitions and global functions of the rv_timer.
19
*/
20
21
#include "hw/top/dt/dt_api.h"
22
#include <stdint.h>
23
24
25
26
/**
27
* List of instances.
28
*/
29
typedef
enum
dt_rv_timer
{
30
kDtRvTimer
= 0,
/**< rv_timer */
31
kDtRvTimerFirst = 0,
/**< \internal First instance */
32
kDtRvTimerCount = 1,
/**< \internal Number of instances */
33
}
dt_rv_timer_t
;
34
35
/**
36
* List of register blocks.
37
*
38
* Register blocks are guaranteed to start at 0 and to be consecutively numbered.
39
*/
40
typedef
enum
dt_rv_timer_reg_block
{
41
kDtRvTimerRegBlockCore = 0,
/**< */
42
kDtRvTimerRegBlockCount = 1,
/**< \internal Number of register blocks */
43
}
dt_rv_timer_reg_block_t
;
44
45
/**
46
* List of memories.
47
*
48
* Memories are guaranteed to start at 0 and to be consecutively numbered.
49
*/
50
typedef
enum
dt_rv_timer_memory
{
51
kDtRvTimerMemoryCount = 0,
/**< \internal Number of memories */
52
}
dt_rv_timer_memory_t
;
53
54
/** Primary register block (associated with the "primary" set of registers that control the IP). */
55
static
const
dt_rv_timer_reg_block_t
kDtRvTimerRegBlockPrimary = kDtRvTimerRegBlockCore;
56
57
/**
58
* List of IRQs.
59
*
60
* IRQs are guaranteed to be numbered consecutively from 0.
61
*/
62
typedef
enum
dt_rv_timer_irq
{
63
kDtRvTimerIrqTimerExpiredHart0Timer0
= 0,
/**< raised if hart0's timer0 expired (mtimecmp >= mtime) */
64
kDtRvTimerIrqCount = 1,
/**< \internal Number of IRQs */
65
}
dt_rv_timer_irq_t
;
66
67
/**
68
* List of Alerts.
69
*
70
* Alerts are guaranteed to be numbered consecutively from 0.
71
*/
72
typedef
enum
dt_rv_timer_alert
{
73
kDtRvTimerAlertFatalFault
= 0,
/**< This fatal alert is triggered when a fatal TL-UL bus integrity fault is detected inside the RV_TIMER unit. */
74
kDtRvTimerAlertCount = 1,
/**< \internal Number of Alerts */
75
}
dt_rv_timer_alert_t
;
76
77
/**
78
* List of clock ports.
79
*
80
* Clock ports are guaranteed to be numbered consecutively from 0.
81
*/
82
typedef
enum
dt_rv_timer_clock
{
83
kDtRvTimerClockClk
= 0,
/**< Clock port clk_i */
84
kDtRvTimerClockCount = 1,
/**< \internal Number of clock ports */
85
}
dt_rv_timer_clock_t
;
86
87
/**
88
* List of reset ports.
89
*
90
* Reset ports are guaranteed to be numbered consecutively from 0.
91
*/
92
typedef
enum
dt_rv_timer_reset
{
93
kDtRvTimerResetRst
= 0,
/**< Reset port rst_ni */
94
kDtRvTimerResetCount = 1,
/**< \internal Number of reset ports */
95
}
dt_rv_timer_reset_t
;
96
97
/**
98
* List of supported hardware features.
99
*/
100
#define OPENTITAN_RV_TIMER_HAS_RISCV_CSRS_INTEGRATION 1
101
#define OPENTITAN_RV_TIMER_HAS_ENABLE 1
102
#define OPENTITAN_RV_TIMER_HAS_DISABLE 1
103
#define OPENTITAN_RV_TIMER_HAS_INTERRUPT 1
104
#define OPENTITAN_RV_TIMER_HAS_CONFIG 1
105
#define OPENTITAN_RV_TIMER_HAS_COUNTER 1
106
#define OPENTITAN_RV_TIMER_HAS_COMPARE 1
107
108
109
110
/**
111
* Get the rv_timer instance from an instance ID
112
*
113
* For example, `dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3`.
114
*
115
* @param inst_id Instance ID.
116
* @return A rv_timer instance.
117
*
118
* **Note:** This function only makes sense if the instance ID has device type rv_timer,
119
* otherwise the returned value is unspecified.
120
*/
121
dt_rv_timer_t
dt_rv_timer_from_instance_id
(
dt_instance_id_t
inst_id);
122
123
/**
124
* Get the instance ID of an instance.
125
*
126
* @param dt Instance of rv_timer.
127
* @return The instance ID of that instance.
128
*/
129
dt_instance_id_t
dt_rv_timer_instance_id
(
dt_rv_timer_t
dt);
130
131
/**
132
* Get the register base address of an instance.
133
*
134
* @param dt Instance of rv_timer.
135
* @param reg_block The register block requested.
136
* @return The register base address of the requested block.
137
*/
138
uint32_t
dt_rv_timer_reg_block
(
139
dt_rv_timer_t
dt,
140
dt_rv_timer_reg_block_t
reg_block);
141
142
/**
143
* Get the primary register base address of an instance.
144
*
145
* This is just a convenience function, equivalent to
146
* `dt_rv_timer_reg_block(dt, kDtRvTimerRegBlockCore)`
147
*
148
* @param dt Instance of rv_timer.
149
* @return The register base address of the primary register block.
150
*/
151
static
inline
uint32_t dt_rv_timer_primary_reg_block(
152
dt_rv_timer_t
dt) {
153
return
dt_rv_timer_reg_block
(dt, kDtRvTimerRegBlockCore);
154
}
155
156
/**
157
* Get the base address of a memory.
158
*
159
* @param dt Instance of rv_timer.
160
* @param mem The memory requested.
161
* @return The base address of the requested memory.
162
*/
163
uint32_t
dt_rv_timer_memory_base
(
164
dt_rv_timer_t
dt,
165
dt_rv_timer_memory_t
mem);
166
167
/**
168
* Get the size of a memory.
169
*
170
* @param dt Instance of rv_timer.
171
* @param mem The memory requested.
172
* @return The size of the requested memory.
173
*/
174
uint32_t
dt_rv_timer_memory_size
(
175
dt_rv_timer_t
dt,
176
dt_rv_timer_memory_t
mem);
177
178
/**
179
* Get the PLIC ID of a rv_timer IRQ for a given instance.
180
*
181
* If the instance is not connected to the PLIC, this function
182
* will return `kDtPlicIrqIdNone`.
183
*
184
* @param dt Instance of rv_timer.
185
* @param irq A rv_timer IRQ.
186
* @return The PLIC ID of the IRQ of this instance.
187
*/
188
dt_plic_irq_id_t
dt_rv_timer_irq_to_plic_id
(
189
dt_rv_timer_t
dt,
190
dt_rv_timer_irq_t
irq);
191
192
/**
193
* Convert a global IRQ ID to a local rv_timer IRQ type.
194
*
195
* @param dt Instance of rv_timer.
196
* @param irq A PLIC ID that belongs to this instance.
197
* @return The rv_timer IRQ, or `kDtRvTimerIrqCount`.
198
*
199
* **Note:** This function assumes that the PLIC ID belongs to the instance
200
* of rv_timer passed in parameter. In other words, it must be the case that
201
* `dt_rv_timer_instance_id(dt) == dt_plic_id_to_instance_id(irq)`. Otherwise, this function
202
* will return `kDtRvTimerIrqCount`.
203
*/
204
dt_rv_timer_irq_t
dt_rv_timer_irq_from_plic_id
(
205
dt_rv_timer_t
dt,
206
dt_plic_irq_id_t
irq);
207
208
209
/**
210
* Get the alert ID of a rv_timer alert for a given instance.
211
*
212
* **Note:** This function only makes sense if the instance is connected to the Alert Handler. For any
213
* instances where the instance is not connected, the return value is unspecified.
214
*
215
* @param dt Instance of rv_timer.
216
* @param alert A rv_timer alert.
217
* @return The Alert Handler alert ID of the alert of this instance.
218
*/
219
dt_alert_id_t
dt_rv_timer_alert_to_alert_id
(
220
dt_rv_timer_t
dt,
221
dt_rv_timer_alert_t
alert);
222
223
/**
224
* Convert a global alert ID to a local rv_timer alert type.
225
*
226
* @param dt Instance of rv_timer.
227
* @param alert A global alert ID that belongs to this instance.
228
* @return The rv_timer alert, or `kDtRvTimerAlertCount`.
229
*
230
* **Note:** This function assumes that the global alert ID belongs to the
231
* instance of rv_timer passed in parameter. In other words, it must be the case
232
* that `dt_rv_timer_instance_id(dt) == dt_alert_id_to_instance_id(alert)`. Otherwise,
233
* this function will return `kDtRvTimerAlertCount`.
234
*/
235
dt_rv_timer_alert_t
dt_rv_timer_alert_from_alert_id
(
236
dt_rv_timer_t
dt,
237
dt_alert_id_t
alert);
238
239
240
241
/**
242
* Get the clock signal connected to a clock port of an instance.
243
*
244
* @param dt Instance of rv_timer.
245
* @param clk Clock port.
246
* @return Clock signal.
247
*/
248
dt_clock_t
dt_rv_timer_clock
(
249
dt_rv_timer_t
dt,
250
dt_rv_timer_clock_t
clk);
251
252
/**
253
* Get the reset signal connected to a reset port of an instance.
254
*
255
* @param dt Instance of rv_timer.
256
* @param rst Reset port.
257
* @return Reset signal.
258
*/
259
dt_reset_t
dt_rv_timer_reset
(
260
dt_rv_timer_t
dt,
261
dt_rv_timer_reset_t
rst);
262
263
264
265
#ifdef __cplusplus
266
}
// extern "C"
267
#endif
// __cplusplus
268
269
#endif
// OPENTITAN_DT_RV_TIMER_H_
(earlgrey)
hw
top
dt
dt_rv_timer.h
Return to
OpenTitan Documentation