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 englishbreakfast.
10
*/
11
12
#include "hw/top/dt/rstmgr.h"
13
14
15
#include "hw/top/dt/aon_timer.h"
16
17
18
19
/**
20
* Description of instances.
21
*/
22
typedef
struct
dt_desc_rstmgr
{
23
dt_instance_id_t
inst_id
;
/**< Instance ID */
24
uint32_t
reg_addr
[
kDtRstmgrRegBlockCount
];
/**< Base address of each register block */
25
dt_clock_t
clock
[
kDtRstmgrClockCount
];
/**< Clock signal connected to each clock port */
26
dt_reset_t
reset
[
kDtRstmgrResetCount
];
/**< Reset signal connected to each reset port */
27
struct
{
28
dt_reset_t
sw_rst
[3];
/**< List of software resets, in the order of the register fields */
29
dt_rstmgr_reset_req_src_t
hw_req
[4];
/**< List of hardware reset requests, in the order of the register fields */
30
}
rstmgr_ext
;
/**< Extension */
31
}
dt_desc_rstmgr_t
;
32
33
34
35
36
static
const
dt_desc_rstmgr_t
rstmgr_desc[
kDtRstmgrCount
] = {
37
[
kDtRstmgr
] = {
38
.inst_id =
kDtInstanceIdRstmgr
,
39
.reg_addr = {
40
[kDtRstmgrRegBlockCore] = 0x40410000,
41
},
42
.clock = {
43
[
kDtRstmgrClockClk
] =
kDtClockIoDiv4
,
44
[
kDtRstmgrClockPor
] =
kDtClockIoDiv4
,
45
[
kDtRstmgrClockAon
] =
kDtClockAon
,
46
[
kDtRstmgrClockMain
] =
kDtClockMain
,
47
[
kDtRstmgrClockIo
] =
kDtClockIo
,
48
[
kDtRstmgrClockUsb
] =
kDtClockUsb
,
49
[
kDtRstmgrClockIoDiv4
] =
kDtClockIoDiv4
,
50
},
51
.reset = {
52
[
kDtRstmgrResetRst
] =
kDtResetLcIoDiv4
,
53
[
kDtRstmgrResetPor
] =
kDtResetPorIoDiv4
,
54
},
55
.rstmgr_ext = {
56
.sw_rst = {
57
[0] =
kDtResetSpiDevice
,
58
[1] =
kDtResetSpiHost0
,
59
[2] =
kDtResetUsb
,
60
},
61
.hw_req = {
62
[0] = {
63
.inst_id =
kDtInstanceIdAonTimer
,
64
.reset_req =
kDtAonTimerResetReqAonTimer
,
65
},
66
[1] = {
67
.inst_id =
kDtInstanceIdPwrmgr
,
68
.reset_req = 0,
69
},
70
[2] = {
71
.inst_id =
kDtInstanceIdUnknown
,
72
.reset_req = 0,
73
},
74
[3] = {
75
.inst_id =
kDtInstanceIdUnknown
,
76
.reset_req = 0,
77
},
78
},
79
},
80
},
81
};
82
83
/**
84
* Return a pointer to the `dt_rstmgr_desc_t` structure of the requested
85
* `dt` if it's a valid index. Otherwise, this macro will `return` (i.e. exit
86
* the function) with the provided default value.
87
*/
88
#define TRY_GET_DT(dt, default) ({ if ((dt) < (dt_rstmgr_t)0 || (int)(dt) >= kDtRstmgrCount) return (default); &rstmgr_desc[dt]; })
89
90
dt_rstmgr_t
dt_rstmgr_from_instance_id
(
dt_instance_id_t
inst_id) {
91
if
(inst_id >=
kDtInstanceIdRstmgr
&& inst_id <=
kDtInstanceIdRstmgr
) {
92
return
(
dt_rstmgr_t
)(inst_id -
kDtInstanceIdRstmgr
);
93
}
94
return
(
dt_rstmgr_t
)0;
95
}
96
97
dt_instance_id_t
dt_rstmgr_instance_id
(
98
dt_rstmgr_t
dt) {
99
return
TRY_GET_DT
(dt,
kDtInstanceIdUnknown
)->inst_id;
100
}
101
102
uint32_t
dt_rstmgr_reg_block
(
103
dt_rstmgr_t
dt,
104
dt_rstmgr_reg_block_t
reg_block) {
105
// Return a recognizable address in case of wrong argument.
106
return
TRY_GET_DT
(dt, 0xdeadbeef)->reg_addr[reg_block];
107
}
108
109
110
111
112
dt_clock_t
dt_rstmgr_clock
(
113
dt_rstmgr_t
dt,
114
dt_rstmgr_clock_t
clk) {
115
// Return the first clock in case of invalid argument.
116
return
TRY_GET_DT
(dt, (
dt_clock_t
)0)->clock[clk];
117
}
118
119
dt_reset_t
dt_rstmgr_reset
(
120
dt_rstmgr_t
dt,
121
dt_rstmgr_reset_t
rst) {
122
const
dt_rstmgr_reset_t
count =
kDtRstmgrResetCount
;
123
if
(rst >= count) {
124
return
kDtResetUnknown
;
125
}
126
return
TRY_GET_DT
(dt,
kDtResetUnknown
)->reset[rst];
127
}
128
129
130
131
size_t
dt_rstmgr_sw_reset_count
(
dt_rstmgr_t
dt) {
132
return
3;
133
}
134
135
dt_reset_t
dt_rstmgr_sw_reset
(
dt_rstmgr_t
dt,
size_t
idx) {
136
if
(idx >= 3) {
137
return
kDtResetUnknown
;
138
}
139
return
TRY_GET_DT
(dt,
kDtResetUnknown
)->rstmgr_ext.sw_rst[idx];
140
}
141
142
size_t
dt_rstmgr_hw_reset_req_src_count
(
dt_rstmgr_t
dt) {
143
return
4;
144
}
145
146
dt_rstmgr_reset_req_src_t
dt_rstmgr_hw_reset_req_src
(
dt_rstmgr_t
dt,
size_t
idx) {
147
dt_rstmgr_reset_req_src_t
invalid_req = {
148
.inst_id =
kDtInstanceIdUnknown
,
149
.reset_req =
kDtResetUnknown
,
150
};
151
if
(idx >= 4) {
152
return
invalid_req;
153
}
154
return
TRY_GET_DT
(dt, invalid_req)->rstmgr_ext.hw_req[idx];
155
}
156
157
(englishbreakfast)
hw
top
dt
rstmgr.c
Return to
OpenTitan Documentation