Software APIs
dt_clkmgr.c
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/**
8 * @file
9 * @brief Device Tables (DT) for IP clkmgr and top darjeeling.
10 */
11
12#include "dt/dt_clkmgr.h"
13
14
15#include "clkmgr_regs.h"
16
17
18/**
19 * Description of instances.
20 */
21typedef struct dt_desc_clkmgr {
22 dt_instance_id_t inst_id; /**< Instance ID */
23 uint32_t base_addr[kDtClkmgrRegBlockCount]; /**< Base address of each register block */
24 /**
25 * Alert ID of the first Alert of this instance.
26 *
27 * This value is undefined if the block is not connected to the Alert Handler.
28 */
30 dt_clock_t clock[kDtClkmgrClockCount]; /**< Clock signal connected to each clock port */
31 dt_reset_t reset[kDtClkmgrResetCount]; /**< Reset signal connected to each reset port */
32 struct {
33 dt_instance_id_t sw_clks[2]; /**< List of gateable clocks, in the order of the register fields */
34 dt_instance_id_t hint_clks[4]; /**< List of hintable clocks, in the order of the register fields */
35 dt_clkmgr_measurable_clk_t measurable_clks[2]; /**< List of measurables clocks */
36 } clkmgr_ext; /**< Extension */
38
39
40
41
42static const dt_desc_clkmgr_t clkmgr_desc[kDtClkmgrCount] = {
43 [kDtClkmgrAon] = {
44 .inst_id = kDtInstanceIdClkmgrAon,
45 .base_addr = {
46 [kDtClkmgrRegBlockCore] = 0x30420000,
47 },
49 .clock = {
54 },
55 .reset = {
67 },
68 .clkmgr_ext = {
69 .sw_clks = {
72 },
73 .hint_clks = {
74 [0] = kDtInstanceIdAes,
78 },
79 .measurable_clks = {
80 [0] = {
81 .clock = kDtClockIoDiv4,
82 .meas_ctrl_en_off = CLKMGR_IO_DIV4_MEAS_CTRL_EN_REG_OFFSET,
83 .meas_ctrl_en_en_field = CLKMGR_IO_DIV4_MEAS_CTRL_EN_EN_FIELD,
84 .meas_ctrl_shadowed_off = CLKMGR_IO_DIV4_MEAS_CTRL_SHADOWED_REG_OFFSET,
85 .meas_ctrl_shadowed_lo_field = CLKMGR_IO_DIV4_MEAS_CTRL_SHADOWED_LO_FIELD,
86 .meas_ctrl_shadowed_hi_field = CLKMGR_IO_DIV4_MEAS_CTRL_SHADOWED_HI_FIELD,
87 },
88 [1] = {
89 .clock = kDtClockMain,
90 .meas_ctrl_en_off = CLKMGR_MAIN_MEAS_CTRL_EN_REG_OFFSET,
91 .meas_ctrl_en_en_field = CLKMGR_MAIN_MEAS_CTRL_EN_EN_FIELD,
92 .meas_ctrl_shadowed_off = CLKMGR_MAIN_MEAS_CTRL_SHADOWED_REG_OFFSET,
93 .meas_ctrl_shadowed_lo_field = CLKMGR_MAIN_MEAS_CTRL_SHADOWED_LO_FIELD,
94 .meas_ctrl_shadowed_hi_field = CLKMGR_MAIN_MEAS_CTRL_SHADOWED_HI_FIELD,
95 },
96 },
97 },
98 },
99};
100
101/**
102 * Return a pointer to the `dt_clkmgr_desc_t` structure of the requested
103 * `dt` if it's a valid index. Otherwise, this macro will `return` (i.e. exit
104 * the function) with the provided default value.
105 */
106#define TRY_GET_DT(dt, default) ({ if ((dt) < (dt_clkmgr_t)0 || (dt) >= kDtClkmgrCount) return (default); &clkmgr_desc[dt]; })
107
109 if (inst_id >= kDtInstanceIdClkmgrAon && inst_id <= kDtInstanceIdClkmgrAon) {
110 return (dt_clkmgr_t)(inst_id - kDtInstanceIdClkmgrAon);
111 }
112 return (dt_clkmgr_t)0;
113}
114
119
121 dt_clkmgr_t dt,
122 dt_clkmgr_reg_block_t reg_block) {
123 // Return a recognizable address in case of wrong argument.
124 return TRY_GET_DT(dt, 0xdeadbeef)->base_addr[reg_block];
125}
126
127
129 dt_clkmgr_t dt,
130 dt_clkmgr_alert_t alert) {
131 return (dt_alert_id_t)((uint32_t)clkmgr_desc[dt].first_alert + (uint32_t)alert);
132}
133
135 dt_clkmgr_t dt,
136 dt_alert_id_t alert) {
137 dt_clkmgr_alert_t count = kDtClkmgrAlertCount;
138 if (alert < clkmgr_desc[dt].first_alert || alert >= clkmgr_desc[dt].first_alert + (dt_alert_id_t)count) {
139 return count;
140 }
141 return (dt_clkmgr_alert_t)(alert - clkmgr_desc[dt].first_alert);
142}
143
144
145
147 dt_clkmgr_t dt,
148 dt_clkmgr_clock_t clk) {
149 // Return the first clock in case of invalid argument.
150 return TRY_GET_DT(dt, (dt_clock_t)0)->clock[clk];
151}
152
154 dt_clkmgr_t dt,
155 dt_clkmgr_reset_t rst) {
156 const dt_clkmgr_reset_t count = kDtClkmgrResetCount;
157 if (rst >= count) {
158 return kDtResetUnknown;
159 }
160 return TRY_GET_DT(dt, kDtResetUnknown)->reset[rst];
161}
162
163
164
166 return 2;
167}
168
170 return TRY_GET_DT(dt, kDtInstanceIdUnknown)->clkmgr_ext.sw_clks[idx];
171}
172
174 return 4;
175}
176
178 return TRY_GET_DT(dt, kDtInstanceIdUnknown)->clkmgr_ext.hint_clks[idx];
179}
180
182 return 2;
183}
184
186 dt_clkmgr_measurable_clk_t invalid_clk = {
187 .clock = kDtClockCount,
188 .meas_ctrl_en_off = 0xdead,
189 .meas_ctrl_en_en_field = ((bitfield_field32_t) { .mask = 0, .index = 0 }),
190 .meas_ctrl_shadowed_off = 0xdead,
191 .meas_ctrl_shadowed_lo_field = ((bitfield_field32_t) { .mask = 0, .index = 0 }),
192 .meas_ctrl_shadowed_hi_field = ((bitfield_field32_t) { .mask = 0, .index = 0 }),
193 };
194 return TRY_GET_DT(dt, invalid_clk)->clkmgr_ext.measurable_clks[idx];
195}
196
197