Software APIs
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 earlgrey.
10
*/
11
12
#include "hw/top/dt/rstmgr.h"
13
14
15
#include "
hw/top/dt/sysrst_ctrl.h
"
16
#include "hw/top/dt/aon_timer.h"
17
18
19
20
/**
21
* Description of instances.
22
*/
23
typedef
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
/**
27
* Alert ID of the first Alert of this instance.
28
*
29
* This value is undefined if the block is not connected to the Alert Handler.
30
*/
31
top_earlgrey_alert_id_t
first_alert
;
32
dt_clock_t
clock
[
kDtRstmgrClockCount
];
/**< Clock signal connected to each clock port */
33
dt_reset_t
reset
[
kDtRstmgrResetCount
];
/**< Reset signal connected to each reset port */
34
struct
{
35
dt_reset_t
sw_rst[10];
/**< List of software resets, in the order of the register fields */
36
dt_rstmgr_reset_req_src_t
hw_req[5];
/**< List of hardware reset requests, in the order of the register fields */
37
}
rstmgr_ext
;
/**< Extension */
38
}
dt_desc_rstmgr_t
;
39
40
41
42
43
static
const
dt_desc_rstmgr_t
rstmgr_desc[
kDtRstmgrCount
] = {
44
[
kDtRstmgr
] = {
45
.inst_id =
kDtInstanceIdRstmgr
,
46
.reg_addr = {
47
[kDtRstmgrRegBlockCore] = 0x40410000,
48
},
49
.first_alert =
kTopEarlgreyAlertIdRstmgrFatalFault
,
50
.clock = {
51
[
kDtRstmgrClockClk
] =
kDtClockIoDiv4
,
52
[
kDtRstmgrClockPor
] =
kDtClockIoDiv4
,
53
[
kDtRstmgrClockAon
] =
kDtClockAon
,
54
[
kDtRstmgrClockMain
] =
kDtClockMain
,
55
[
kDtRstmgrClockIo
] =
kDtClockIo
,
56
[
kDtRstmgrClockUsb
] =
kDtClockUsb
,
57
[
kDtRstmgrClockIoDiv4
] =
kDtClockIoDiv4
,
58
},
59
.reset = {
60
[
kDtRstmgrResetRst
] =
kDtResetLcIoDiv4
,
61
[
kDtRstmgrResetPor
] =
kDtResetPorIoDiv4
,
62
},
63
.rstmgr_ext = {
64
.sw_rst = {
65
[0] =
kDtResetSpiDevice
,
66
[1] =
kDtResetSpiHost0
,
67
[2] =
kDtResetSpiHost1
,
68
[3] =
kDtResetUsb
,
69
[4] =
kDtResetUsbAon
,
70
[5] =
kDtResetI2c0
,
71
[6] =
kDtResetI2c1
,
72
[7] =
kDtResetI2c2
,
73
[8] =
kDtResetI3c0
,
74
[9] =
kDtResetI3c1
,
75
},
76
.hw_req = {
77
[0] = {
78
.inst_id =
kDtInstanceIdSysrstCtrl
,
79
.reset_req =
kDtSysrstCtrlResetReqRstReq
,
80
},
81
[1] = {
82
.inst_id =
kDtInstanceIdAonTimer
,
83
.reset_req =
kDtAonTimerResetReqAonTimer
,
84
},
85
[2] = {
86
.inst_id =
kDtInstanceIdPwrmgr
,
87
.reset_req = 0,
88
},
89
[3] = {
90
.inst_id =
kDtInstanceIdAlertHandler
,
91
.reset_req = 0,
92
},
93
[4] = {
94
.inst_id =
kDtInstanceIdRvDm
,
95
.reset_req = 0,
96
},
97
},
98
},
99
},
100
};
101
102
/**
103
* Return a pointer to the `dt_rstmgr_desc_t` structure of the requested
104
* `dt` if it's a valid index. Otherwise, this macro will `return` (i.e. exit
105
* the function) with the provided default value.
106
*/
107
#define TRY_GET_DT(dt, default) ({ if ((dt) < (dt_rstmgr_t)0 || (int)(dt) >= kDtRstmgrCount) return (default); &rstmgr_desc[dt]; })
108
109
dt_rstmgr_t
dt_rstmgr_from_instance_id
(
dt_instance_id_t
inst_id) {
110
if
(inst_id >=
kDtInstanceIdRstmgr
&& inst_id <=
kDtInstanceIdRstmgr
) {
111
return
(
dt_rstmgr_t
)(inst_id -
kDtInstanceIdRstmgr
);
112
}
113
return
(
dt_rstmgr_t
)0;
114
}
115
116
dt_instance_id_t
dt_rstmgr_instance_id
(
117
dt_rstmgr_t
dt) {
118
return
TRY_GET_DT
(dt,
kDtInstanceIdUnknown
)->inst_id;
119
}
120
121
uint32_t
dt_rstmgr_reg_block
(
122
dt_rstmgr_t
dt,
123
dt_rstmgr_reg_block_t
reg_block) {
124
// Return a recognizable address in case of wrong argument.
125
return
TRY_GET_DT
(dt, 0xdeadbeef)->reg_addr[reg_block];
126
}
127
128
129
dt_alert_id_t
dt_rstmgr_alert_to_alert_id
(
130
dt_rstmgr_t
dt,
131
dt_rstmgr_alert_t
alert) {
132
return
(
dt_alert_id_t
)((uint32_t)rstmgr_desc[dt].first_alert + (uint32_t)alert);
133
}
134
135
dt_rstmgr_alert_t
dt_rstmgr_alert_from_alert_id
(
136
dt_rstmgr_t
dt,
137
dt_alert_id_t
alert) {
138
dt_rstmgr_alert_t
count =
kDtRstmgrAlertCount
;
139
if
(alert < rstmgr_desc[dt].first_alert || alert >= rstmgr_desc[dt].first_alert + (
dt_alert_id_t
)count) {
140
return
count;
141
}
142
return
(
dt_rstmgr_alert_t
)(alert - rstmgr_desc[dt].first_alert);
143
}
144
145
146
147
dt_clock_t
dt_rstmgr_clock
(
148
dt_rstmgr_t
dt,
149
dt_rstmgr_clock_t
clk) {
150
// Return the first clock in case of invalid argument.
151
return
TRY_GET_DT
(dt, (
dt_clock_t
)0)->clock[clk];
152
}
153
154
dt_reset_t
dt_rstmgr_reset
(
155
dt_rstmgr_t
dt,
156
dt_rstmgr_reset_t
rst) {
157
const
dt_rstmgr_reset_t
count =
kDtRstmgrResetCount
;
158
if
(rst >= count) {
159
return
kDtResetUnknown
;
160
}
161
return
TRY_GET_DT
(dt,
kDtResetUnknown
)->reset[rst];
162
}
163
164
165
166
size_t
dt_rstmgr_sw_reset_count
(
dt_rstmgr_t
dt) {
167
return
10;
168
}
169
170
dt_reset_t
dt_rstmgr_sw_reset
(
dt_rstmgr_t
dt,
size_t
idx) {
171
if
(idx >= 10) {
172
return
kDtResetUnknown
;
173
}
174
return
TRY_GET_DT
(dt,
kDtResetUnknown
)->rstmgr_ext.sw_rst[idx];
175
}
176
177
size_t
dt_rstmgr_hw_reset_req_src_count
(
dt_rstmgr_t
dt) {
178
return
5;
179
}
180
181
dt_rstmgr_reset_req_src_t
dt_rstmgr_hw_reset_req_src
(
dt_rstmgr_t
dt,
size_t
idx) {
182
dt_rstmgr_reset_req_src_t
invalid_req = {
183
.inst_id =
kDtInstanceIdUnknown
,
184
.reset_req =
kDtResetUnknown
,
185
};
186
if
(idx >= 5) {
187
return
invalid_req;
188
}
189
return
TRY_GET_DT
(dt, invalid_req)->rstmgr_ext.hw_req[idx];
190
}
191
192
(earlgrey)
hw
top
dt
rstmgr.c
Return to
OpenTitan Documentation