Software APIs
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 earlgrey.
10 */
11
12#include "hw/top/dt/clkmgr.h"
13
14
15#include "hw/top/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 reg_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[4]; /**< 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[4]; /**< List of measurables clocks */
36 } clkmgr_ext; /**< Extension */
38
39
40
41
42static const dt_desc_clkmgr_t clkmgr_desc[kDtClkmgrCount] = {
43 [kDtClkmgr] = {
44 .inst_id = kDtInstanceIdClkmgr,
45 .reg_addr = {
46 [kDtClkmgrRegBlockCore] = 0x40420000,
47 },
49 .clock = {
55 },
56 .reset = {
68 },
69 .clkmgr_ext = {
70 .sw_clks = {
75 },
76 .hint_clks = {
77 [0] = kDtInstanceIdAes,
81 },
82 .measurable_clks = {
83 [0] = {
84 .clock = kDtClockIo,
85 .meas_ctrl_en_off = CLKMGR_IO_MEAS_CTRL_EN_REG_OFFSET,
86 .meas_ctrl_en_en_field = CLKMGR_IO_MEAS_CTRL_EN_EN_FIELD,
87 .meas_ctrl_shadowed_off = CLKMGR_IO_MEAS_CTRL_SHADOWED_REG_OFFSET,
88 .meas_ctrl_shadowed_lo_field = CLKMGR_IO_MEAS_CTRL_SHADOWED_LO_FIELD,
89 .meas_ctrl_shadowed_hi_field = CLKMGR_IO_MEAS_CTRL_SHADOWED_HI_FIELD,
90 },
91 [1] = {
92 .clock = kDtClockIoDiv4,
93 .meas_ctrl_en_off = CLKMGR_IO_DIV4_MEAS_CTRL_EN_REG_OFFSET,
94 .meas_ctrl_en_en_field = CLKMGR_IO_DIV4_MEAS_CTRL_EN_EN_FIELD,
95 .meas_ctrl_shadowed_off = CLKMGR_IO_DIV4_MEAS_CTRL_SHADOWED_REG_OFFSET,
96 .meas_ctrl_shadowed_lo_field = CLKMGR_IO_DIV4_MEAS_CTRL_SHADOWED_LO_FIELD,
97 .meas_ctrl_shadowed_hi_field = CLKMGR_IO_DIV4_MEAS_CTRL_SHADOWED_HI_FIELD,
98 },
99 [2] = {
100 .clock = kDtClockMain,
101 .meas_ctrl_en_off = CLKMGR_MAIN_MEAS_CTRL_EN_REG_OFFSET,
102 .meas_ctrl_en_en_field = CLKMGR_MAIN_MEAS_CTRL_EN_EN_FIELD,
103 .meas_ctrl_shadowed_off = CLKMGR_MAIN_MEAS_CTRL_SHADOWED_REG_OFFSET,
104 .meas_ctrl_shadowed_lo_field = CLKMGR_MAIN_MEAS_CTRL_SHADOWED_LO_FIELD,
105 .meas_ctrl_shadowed_hi_field = CLKMGR_MAIN_MEAS_CTRL_SHADOWED_HI_FIELD,
106 },
107 [3] = {
108 .clock = kDtClockUsb,
109 .meas_ctrl_en_off = CLKMGR_USB_MEAS_CTRL_EN_REG_OFFSET,
110 .meas_ctrl_en_en_field = CLKMGR_USB_MEAS_CTRL_EN_EN_FIELD,
111 .meas_ctrl_shadowed_off = CLKMGR_USB_MEAS_CTRL_SHADOWED_REG_OFFSET,
112 .meas_ctrl_shadowed_lo_field = CLKMGR_USB_MEAS_CTRL_SHADOWED_LO_FIELD,
113 .meas_ctrl_shadowed_hi_field = CLKMGR_USB_MEAS_CTRL_SHADOWED_HI_FIELD,
114 },
115 },
116 },
117 },
118};
119
120/**
121 * Return a pointer to the `dt_clkmgr_desc_t` structure of the requested
122 * `dt` if it's a valid index. Otherwise, this macro will `return` (i.e. exit
123 * the function) with the provided default value.
124 */
125#define TRY_GET_DT(dt, default) ({ if ((dt) < (dt_clkmgr_t)0 || (int)(dt) >= kDtClkmgrCount) return (default); &clkmgr_desc[dt]; })
126
128 if (inst_id >= kDtInstanceIdClkmgr && inst_id <= kDtInstanceIdClkmgr) {
129 return (dt_clkmgr_t)(inst_id - kDtInstanceIdClkmgr);
130 }
131 return (dt_clkmgr_t)0;
132}
133
138
140 dt_clkmgr_t dt,
141 dt_clkmgr_reg_block_t reg_block) {
142 // Return a recognizable address in case of wrong argument.
143 return TRY_GET_DT(dt, 0xdeadbeef)->reg_addr[reg_block];
144}
145
146
148 dt_clkmgr_t dt,
149 dt_clkmgr_alert_t alert) {
150 return (dt_alert_id_t)((uint32_t)clkmgr_desc[dt].first_alert + (uint32_t)alert);
151}
152
154 dt_clkmgr_t dt,
155 dt_alert_id_t alert) {
157 if (alert < clkmgr_desc[dt].first_alert || alert >= clkmgr_desc[dt].first_alert + (dt_alert_id_t)count) {
158 return count;
159 }
160 return (dt_clkmgr_alert_t)(alert - clkmgr_desc[dt].first_alert);
161}
162
163
164
166 dt_clkmgr_t dt,
167 dt_clkmgr_clock_t clk) {
168 // Return the first clock in case of invalid argument.
169 return TRY_GET_DT(dt, (dt_clock_t)0)->clock[clk];
170}
171
173 dt_clkmgr_t dt,
174 dt_clkmgr_reset_t rst) {
176 if (rst >= count) {
177 return kDtResetUnknown;
178 }
179 return TRY_GET_DT(dt, kDtResetUnknown)->reset[rst];
180}
181
182
183
185 return 4;
186}
187
189 return TRY_GET_DT(dt, kDtInstanceIdUnknown)->clkmgr_ext.sw_clks[idx];
190}
191
193 return 4;
194}
195
197 return TRY_GET_DT(dt, kDtInstanceIdUnknown)->clkmgr_ext.hint_clks[idx];
198}
199
201 return 4;
202}
203
205 dt_clkmgr_measurable_clk_t invalid_clk = {
206 .clock = kDtClockCount,
207 .meas_ctrl_en_off = 0xdead,
208 .meas_ctrl_en_en_field = ((bitfield_field32_t) { .mask = 0, .index = 0 }),
209 .meas_ctrl_shadowed_off = 0xdead,
210 .meas_ctrl_shadowed_lo_field = ((bitfield_field32_t) { .mask = 0, .index = 0 }),
211 .meas_ctrl_shadowed_hi_field = ((bitfield_field32_t) { .mask = 0, .index = 0 }),
212 };
213 return TRY_GET_DT(dt, invalid_clk)->clkmgr_ext.measurable_clks[idx];
214}
215
216