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 englishbreakfast.
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 dt_clock_t clock[kDtClkmgrClockCount]; /**< Clock signal connected to each clock port */
25 dt_reset_t reset[kDtClkmgrResetCount]; /**< Reset signal connected to each reset port */
26 struct {
27 dt_instance_id_t sw_clks[3]; /**< List of gateable clocks, in the order of the register fields */
28 dt_instance_id_t hint_clks[1]; /**< List of hintable clocks, in the order of the register fields */
29 dt_clkmgr_measurable_clk_t measurable_clks[4]; /**< List of measurables clocks */
30 } clkmgr_ext; /**< Extension */
32
33
34
35
36static const dt_desc_clkmgr_t clkmgr_desc[kDtClkmgrCount] = {
37 [kDtClkmgr] = {
38 .inst_id = kDtInstanceIdClkmgr,
39 .reg_addr = {
40 [kDtClkmgrRegBlockCore] = 0x40420000,
41 },
42 .clock = {
48 },
49 .reset = {
61 },
62 .clkmgr_ext = {
63 .sw_clks = {
67 },
68 .hint_clks = {
69 [0] = kDtInstanceIdAes,
70 },
71 .measurable_clks = {
72 [0] = {
73 .clock = kDtClockIo,
74 .meas_ctrl_en_off = CLKMGR_IO_MEAS_CTRL_EN_REG_OFFSET,
75 .meas_ctrl_en_en_field = CLKMGR_IO_MEAS_CTRL_EN_EN_FIELD,
76 .meas_ctrl_shadowed_off = CLKMGR_IO_MEAS_CTRL_SHADOWED_REG_OFFSET,
77 .meas_ctrl_shadowed_lo_field = CLKMGR_IO_MEAS_CTRL_SHADOWED_LO_FIELD,
78 .meas_ctrl_shadowed_hi_field = CLKMGR_IO_MEAS_CTRL_SHADOWED_HI_FIELD,
79 },
80 [1] = {
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 [2] = {
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 [3] = {
97 .clock = kDtClockUsb,
98 .meas_ctrl_en_off = CLKMGR_USB_MEAS_CTRL_EN_REG_OFFSET,
99 .meas_ctrl_en_en_field = CLKMGR_USB_MEAS_CTRL_EN_EN_FIELD,
100 .meas_ctrl_shadowed_off = CLKMGR_USB_MEAS_CTRL_SHADOWED_REG_OFFSET,
101 .meas_ctrl_shadowed_lo_field = CLKMGR_USB_MEAS_CTRL_SHADOWED_LO_FIELD,
102 .meas_ctrl_shadowed_hi_field = CLKMGR_USB_MEAS_CTRL_SHADOWED_HI_FIELD,
103 },
104 },
105 },
106 },
107};
108
109/**
110 * Return a pointer to the `dt_clkmgr_desc_t` structure of the requested
111 * `dt` if it's a valid index. Otherwise, this macro will `return` (i.e. exit
112 * the function) with the provided default value.
113 */
114#define TRY_GET_DT(dt, default) ({ if ((dt) < (dt_clkmgr_t)0 || (int)(dt) >= kDtClkmgrCount) return (default); &clkmgr_desc[dt]; })
115
117 if (inst_id >= kDtInstanceIdClkmgr && inst_id <= kDtInstanceIdClkmgr) {
118 return (dt_clkmgr_t)(inst_id - kDtInstanceIdClkmgr);
119 }
120 return (dt_clkmgr_t)0;
121}
122
127
129 dt_clkmgr_t dt,
130 dt_clkmgr_reg_block_t reg_block) {
131 // Return a recognizable address in case of wrong argument.
132 return TRY_GET_DT(dt, 0xdeadbeef)->reg_addr[reg_block];
133}
134
135
136
137
139 dt_clkmgr_t dt,
140 dt_clkmgr_clock_t clk) {
141 // Return the first clock in case of invalid argument.
142 return TRY_GET_DT(dt, (dt_clock_t)0)->clock[clk];
143}
144
146 dt_clkmgr_t dt,
147 dt_clkmgr_reset_t rst) {
149 if (rst >= count) {
150 return kDtResetUnknown;
151 }
152 return TRY_GET_DT(dt, kDtResetUnknown)->reset[rst];
153}
154
155
156
158 return 3;
159}
160
162 return TRY_GET_DT(dt, kDtInstanceIdUnknown)->clkmgr_ext.sw_clks[idx];
163}
164
166 return 1;
167}
168
170 return TRY_GET_DT(dt, kDtInstanceIdUnknown)->clkmgr_ext.hint_clks[idx];
171}
172
174 return 4;
175}
176
178 dt_clkmgr_measurable_clk_t invalid_clk = {
179 .clock = kDtClockCount,
180 .meas_ctrl_en_off = 0xdead,
181 .meas_ctrl_en_en_field = ((bitfield_field32_t) { .mask = 0, .index = 0 }),
182 .meas_ctrl_shadowed_off = 0xdead,
183 .meas_ctrl_shadowed_lo_field = ((bitfield_field32_t) { .mask = 0, .index = 0 }),
184 .meas_ctrl_shadowed_hi_field = ((bitfield_field32_t) { .mask = 0, .index = 0 }),
185 };
186 return TRY_GET_DT(dt, invalid_clk)->clkmgr_ext.measurable_clks[idx];
187}
188
189