Software APIs
dt_clkmgr.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_CLKMGR_H_
8#define OPENTITAN_DT_CLKMGR_H_
9
10/**
11 * @file
12 * @brief Device Tables (DT) for IP clkmgr and top darjeeling.
13 *
14 * This file contains the type definitions and global functions of the clkmgr.
15 */
16
17#include "dt_api.h"
18#include <stdint.h>
19
20
22
23
24/**
25 * List of instances.
26 */
27typedef enum dt_clkmgr {
28 kDtClkmgrAon = 0, /**< clkmgr_aon */
29 kDtClkmgrFirst = 0, /**< \internal First instance */
30 kDtClkmgrCount = 1, /**< \internal Number of instances */
32
33/**
34 * List of register blocks.
35 *
36 * Register blocks are guaranteed to start at 0 and to be consecutively numbered.
37 */
38typedef enum dt_clkmgr_reg_block {
39 kDtClkmgrRegBlockCore = 0, /**< */
40 kDtClkmgrRegBlockCount = 1, /**< \internal Number of register blocks */
42
43/** Primary register block (associated with the "primary" set of registers that control the IP). */
44static const dt_clkmgr_reg_block_t kDtClkmgrRegBlockPrimary = kDtClkmgrRegBlockCore;
45
46/**
47 * List of Alerts.
48 *
49 * Alerts are guaranteed to be numbered consecutively from 0.
50 */
51typedef enum dt_clkmgr_alert {
52 kDtClkmgrAlertRecovFault = 0, /**< This recoverable alert is triggered when there are measurement errors. */
53 kDtClkmgrAlertFatalFault = 1, /**< This fatal alert is triggered when a fatal TL-UL bus integrity fault is detected. */
54 kDtClkmgrAlertCount = 2, /**< \internal Number of Alerts */
56
57/**
58 * List of clock ports.
59 *
60 * Clock ports are guaranteed to be numbered consecutively from 0.
61 */
62typedef enum dt_clkmgr_clock {
63 kDtClkmgrClockClk = 0, /**< Clock port clk_i */
64 kDtClkmgrClockMain = 1, /**< Clock port clk_main_i */
65 kDtClkmgrClockIo = 2, /**< Clock port clk_io_i */
66 kDtClkmgrClockAon = 3, /**< Clock port clk_aon_i */
67 kDtClkmgrClockCount = 4, /**< \internal Number of clock ports */
69
70/**
71 * List of reset ports.
72 *
73 * Reset ports are guaranteed to be numbered consecutively from 0.
74 */
75typedef enum dt_clkmgr_reset {
76 kDtClkmgrResetRst = 0, /**< Reset port rst_ni */
77 kDtClkmgrResetRoot = 1, /**< Reset port rst_root_ni */
78 kDtClkmgrResetMain = 2, /**< Reset port rst_main_ni */
79 kDtClkmgrResetIo = 3, /**< Reset port rst_io_ni */
80 kDtClkmgrResetAon = 4, /**< Reset port rst_aon_ni */
81 kDtClkmgrResetIoDiv2 = 5, /**< Reset port rst_io_div2_ni */
82 kDtClkmgrResetIoDiv4 = 6, /**< Reset port rst_io_div4_ni */
83 kDtClkmgrResetRootMain = 7, /**< Reset port rst_root_main_ni */
84 kDtClkmgrResetRootIo = 8, /**< Reset port rst_root_io_ni */
85 kDtClkmgrResetRootIoDiv2 = 9, /**< Reset port rst_root_io_div2_ni */
86 kDtClkmgrResetRootIoDiv4 = 10, /**< Reset port rst_root_io_div4_ni */
87 kDtClkmgrResetCount = 11, /**< \internal Number of reset ports */
89
90/**
91 * List of supported hardware features.
92 */
93#define OPENTITAN_CLKMGR_HAS_ENABLE_IO_DIV4 1
94#define OPENTITAN_CLKMGR_HAS_ENABLE_IO_DIV2 1
95#define OPENTITAN_CLKMGR_HAS_HINT_AES 1
96#define OPENTITAN_CLKMGR_HAS_HINT_HMAC 1
97#define OPENTITAN_CLKMGR_HAS_HINT_KMAC 1
98#define OPENTITAN_CLKMGR_HAS_HINT_OTBN 1
99#define OPENTITAN_CLKMGR_HAS_MEAS_CTRL_REGWEN 1
100#define OPENTITAN_CLKMGR_HAS_MEAS_CTRL_IO_DIV4 1
101#define OPENTITAN_CLKMGR_HAS_MEAS_CTRL_MAIN 1
102#define OPENTITAN_CLKMGR_HAS_MEAS_CTRL_RECOV_ERR 1
103#define OPENTITAN_CLKMGR_HAS_LC_EXTCLK_SPEED 1
104#define OPENTITAN_CLKMGR_HAS_SW_EXTCLK_REGWEN 1
105#define OPENTITAN_CLKMGR_HAS_SW_EXTCLK_HIGH_SPEED 1
106#define OPENTITAN_CLKMGR_HAS_SW_EXTCLK_LOW_SPEED 1
107#define OPENTITAN_CLKMGR_HAS_JITTER_REGWEN 1
108#define OPENTITAN_CLKMGR_HAS_JITTER_ENABLE 1
109#define OPENTITAN_CLKMGR_HAS_ALERT_HANDLER_CLOCK_STATUS 1
110
111
112
113/**
114 * Get the clkmgr instance from an instance ID
115 *
116 * For example, `dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3`.
117 *
118 * @param inst_id Instance ID.
119 * @return A clkmgr instance.
120 *
121 * **Note:** This function only makes sense if the instance ID has device type clkmgr,
122 * otherwise the returned value is unspecified.
123 */
125
126/**
127 * Get the instance ID of an instance.
128 *
129 * @param dt Instance of clkmgr.
130 * @return The instance ID of that instance.
131 */
133
134/**
135 * Get the register base address of an instance.
136 *
137 * @param dt Instance of clkmgr.
138 * @param reg_block The register block requested.
139 * @return The register base address of the requested block.
140 */
141uint32_t dt_clkmgr_reg_block(
142 dt_clkmgr_t dt,
143 dt_clkmgr_reg_block_t reg_block);
144
145/**
146 * Get the primary register base address of an instance.
147 *
148 * This is just a convenience function, equivalent to
149 * `dt_clkmgr_reg_block(dt, kDtClkmgrRegBlockCore)`
150 *
151 * @param dt Instance of clkmgr.
152 * @return The register base address of the primary register block.
153 */
154static inline uint32_t dt_clkmgr_primary_reg_block(
155 dt_clkmgr_t dt) {
156 return dt_clkmgr_reg_block(dt, kDtClkmgrRegBlockCore);
157}
158
159
160/**
161 * Get the alert ID of a clkmgr alert for a given instance.
162 *
163 * **Note:** This function only makes sense if the instance is connected to the Alert Handler. For any
164 * instances where the instance is not connected, the return value is unspecified.
165 *
166 * @param dt Instance of clkmgr.
167 * @param alert A clkmgr alert.
168 * @return The Alert Handler alert ID of the alert of this instance.
169 */
171 dt_clkmgr_t dt,
172 dt_clkmgr_alert_t alert);
173
174/**
175 * Convert a global alert ID to a local clkmgr alert type.
176 *
177 * @param dt Instance of clkmgr.
178 * @param alert A global alert ID that belongs to this instance.
179 * @return The clkmgr alert, or `kDtClkmgrAlertCount`.
180 *
181 * **Note:** This function assumes that the global alert ID belongs to the
182 * instance of clkmgr passed in parameter. In other words, it must be the case
183 * that `dt_clkmgr_instance_id(dt) == dt_alert_id_to_instance_id(alert)`. Otherwise,
184 * this function will return `kDtClkmgrAlertCount`.
185 */
187 dt_clkmgr_t dt,
188 dt_alert_id_t alert);
189
190
191
192/**
193 * Get the clock signal connected to a clock port of an instance.
194 *
195 * @param dt Instance of clkmgr.
196 * @param clk Clock port.
197 * @return Clock signal.
198 */
200 dt_clkmgr_t dt,
202
203/**
204 * Get the reset signal connected to a reset port of an instance.
205 *
206 * @param dt Instance of clkmgr.
207 * @param rst Reset port.
208 * @return Reset signal.
209 */
211 dt_clkmgr_t dt,
213
214
215
216/**
217 * Get the number of software gateable clocks.
218 *
219 * @param dt Instance of clkmgr.
220 * @return Number of gateable clocks.
221 */
223
224/**
225 * Get the instance ID of a gateable clock.
226 *
227 * The clocks are ordered as they appear in the registers.
228 *
229 * @param dt Instance of clkmgr.
230 * @param idx Index of the gateable clock, between 0 and `dt_clkmgr_sw_clock_count(dt)-1`.
231 * @return Instance ID of the device whose clock is gateable.
232 */
234
235/**
236 * Get the number of software hintable clocks.
237 *
238 * @param dt Instance of clkmgr.
239 * @return Number of hintable clocks.
240 */
242
243/**
244 * Get the instance ID of a hintable clock.
245 *
246 * The clocks sources are ordered as they appear in the registers.
247 *
248 * @param dt Instance of clkmgr.
249 * @param idx Index of the hintable clock, between 0 and `dt_clkmgr_hint_clock_count(dt)-1`.
250 * @return Instance ID of the device whose clock is hintable.
251 */
253
254/**
255 * Description of a measurable clock.
256 *
257 */
258typedef struct dt_clkmgr_measurable_clk {
259 dt_clock_t clock; /**< Clock */
260 uint32_t meas_ctrl_en_off; /**< MEAS_CTRL_EN register offset */
261 bitfield_field32_t meas_ctrl_en_en_field; /**< MEAS_CTRL_EN_EN bitfield */
262 uint32_t meas_ctrl_shadowed_off; /**< CTRL_SHADOWED register offset */
263 bitfield_field32_t meas_ctrl_shadowed_lo_field; /**< CTRL_SHADOWED_LO bitfield */
264 bitfield_field32_t meas_ctrl_shadowed_hi_field; /**< CTRL_SHADOWED_HI bitfield */
266
267
268/**
269 * Get the number of measurable clocks.
270 *
271 * @param dt Instance of clkmgr.
272 * @return Number of measurable clocks.
273 */
275
276/**
277 * Get the description of a measurable clock.
278 *
279 * @param dt Instance of clkmgr.
280 * @param idx Index of the measurable clock, between 0 and
281 * `dt_clkmgr_measurable_clock_count(dt)-1`.
282 * @return Description of the measurable clock.
283 */
285
286
287
288#endif // OPENTITAN_DT_CLKMGR_H_