Software APIs
dt_rstmgr.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 rstmgr and top darjeeling.
10 */
11
12#include "hw/top/dt/dt_rstmgr.h"
13
14
15#include "dt_aon_timer.h"
16#include "dt_soc_proxy.h"
17
18
19
20/**
21 * Description of instances.
22 */
23typedef struct dt_desc_rstmgr {
24 dt_instance_id_t inst_id; /**< Instance ID */
25 uint32_t reg_addr[kDtRstmgrRegBlockCount]; /**< Base address of each register block */
26 uint32_t mem_addr[kDtRstmgrMemoryCount]; /**< Base address of each memory */
27 uint32_t mem_size[kDtRstmgrMemoryCount]; /**< Size in bytes of each memory */
28 /**
29 * Alert ID of the first Alert of this instance.
30 *
31 * This value is undefined if the block is not connected to the Alert Handler.
32 */
34 dt_clock_t clock[kDtRstmgrClockCount]; /**< Clock signal connected to each clock port */
35 dt_reset_t reset[kDtRstmgrResetCount]; /**< Reset signal connected to each reset port */
36 struct {
37 dt_reset_t sw_rst[3]; /**< List of software resets, in the order of the register fields */
38 dt_rstmgr_reset_req_src_t hw_req[5]; /**< List of hardware reset requests, in the order of the register fields */
39 } rstmgr_ext; /**< Extension */
41
42
43
44
45static const dt_desc_rstmgr_t rstmgr_desc[kDtRstmgrCount] = {
46 [kDtRstmgrAon] = {
47 .inst_id = kDtInstanceIdRstmgrAon,
48 .reg_addr = {
49 [kDtRstmgrRegBlockCore] = 0x30410000,
50 },
51 .mem_addr = {
52 },
53 .mem_size = {
54 },
56 .clock = {
64 },
65 .reset = {
68 },
69 .rstmgr_ext = {
70 .sw_rst = {
72 [1] = kDtResetSpiHost0,
73 [2] = kDtResetI2c0,
74 },
75 .hw_req = {
76 [0] = {
77 .inst_id = kDtInstanceIdAonTimerAon,
78 .reset_req = kDtAonTimerResetReqAonTimer,
79 },
80 [1] = {
81 .inst_id = kDtInstanceIdSocProxy,
82 .reset_req = kDtSocProxyResetReqExternal,
83 },
84 [2] = {
85 .inst_id = kDtInstanceIdPwrmgrAon,
86 .reset_req = 0,
87 },
88 [3] = {
90 .reset_req = 0,
91 },
92 [4] = {
93 .inst_id = kDtInstanceIdRvDm,
94 .reset_req = 0,
95 },
96 },
97 },
98 },
99};
100
101/**
102 * Return a pointer to the `dt_rstmgr_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_rstmgr_t)0 || (dt) >= kDtRstmgrCount) return (default); &rstmgr_desc[dt]; })
107
109 if (inst_id >= kDtInstanceIdRstmgrAon && inst_id <= kDtInstanceIdRstmgrAon) {
110 return (dt_rstmgr_t)(inst_id - kDtInstanceIdRstmgrAon);
111 }
112 return (dt_rstmgr_t)0;
113}
114
119
121 dt_rstmgr_t dt,
122 dt_rstmgr_reg_block_t reg_block) {
123 // Return a recognizable address in case of wrong argument.
124 return TRY_GET_DT(dt, 0xdeadbeef)->reg_addr[reg_block];
125}
126
128 dt_rstmgr_t dt,
129 dt_rstmgr_memory_t mem) {
130 // Return a recognizable address in case of wrong argument.
131 return TRY_GET_DT(dt, 0xdeadbeef)->mem_addr[mem];
132}
133
135 dt_rstmgr_t dt,
136 dt_rstmgr_memory_t mem) {
137 // Return an empty size in case of wrong argument.
138 return TRY_GET_DT(dt, 0)->mem_size[mem];
139}
140
141
143 dt_rstmgr_t dt,
144 dt_rstmgr_alert_t alert) {
145 return (dt_alert_id_t)((uint32_t)rstmgr_desc[dt].first_alert + (uint32_t)alert);
146}
147
149 dt_rstmgr_t dt,
150 dt_alert_id_t alert) {
151 dt_rstmgr_alert_t count = kDtRstmgrAlertCount;
152 if (alert < rstmgr_desc[dt].first_alert || alert >= rstmgr_desc[dt].first_alert + (dt_alert_id_t)count) {
153 return count;
154 }
155 return (dt_rstmgr_alert_t)(alert - rstmgr_desc[dt].first_alert);
156}
157
158
159
161 dt_rstmgr_t dt,
162 dt_rstmgr_clock_t clk) {
163 // Return the first clock in case of invalid argument.
164 return TRY_GET_DT(dt, (dt_clock_t)0)->clock[clk];
165}
166
168 dt_rstmgr_t dt,
169 dt_rstmgr_reset_t rst) {
170 const dt_rstmgr_reset_t count = kDtRstmgrResetCount;
171 if (rst >= count) {
172 return kDtResetUnknown;
173 }
174 return TRY_GET_DT(dt, kDtResetUnknown)->reset[rst];
175}
176
177
178
180 return 3;
181}
182
184 if (idx >= 3) {
185 return kDtResetUnknown;
186 }
187 return TRY_GET_DT(dt, kDtResetUnknown)->rstmgr_ext.sw_rst[idx];
188}
189
191 return 5;
192}
193
195 dt_rstmgr_reset_req_src_t invalid_req = {
196 .inst_id = kDtInstanceIdUnknown,
197 .reset_req = kDtResetUnknown,
198 };
199 if (idx >= 5) {
200 return invalid_req;
201 }
202 return TRY_GET_DT(dt, invalid_req)->rstmgr_ext.hw_req[idx];
203}
204
205