Software APIs
dt_ac_range_check.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 ac_range_check and top darjeeling.
10
*/
11
12
#include "
hw/top/dt/dt_ac_range_check.h
"
13
14
15
16
17
18
/**
19
* Description of instances.
20
*/
21
typedef
struct
dt_desc_ac_range_check
{
22
dt_instance_id_t
inst_id
;
/**< Instance ID */
23
uint32_t
reg_addr
[kDtAcRangeCheckRegBlockCount];
/**< Base address of each register block */
24
uint32_t
mem_addr
[kDtAcRangeCheckMemoryCount];
/**< Base address of each memory */
25
uint32_t
mem_size
[kDtAcRangeCheckMemoryCount];
/**< Size in bytes of each memory */
26
/**
27
* PLIC ID of the first IRQ of this instance
28
*
29
* This can be `kDtPlicIrqIdNone` if the block is not connected to the PLIC.
30
*/
31
top_darjeeling_plic_irq_id_t
first_irq
;
32
/**
33
* Alert ID of the first Alert of this instance.
34
*
35
* This value is undefined if the block is not connected to the Alert Handler.
36
*/
37
top_darjeeling_alert_id_t
first_alert
;
38
dt_clock_t
clock
[kDtAcRangeCheckClockCount];
/**< Clock signal connected to each clock port */
39
dt_reset_t
reset
[kDtAcRangeCheckResetCount];
/**< Reset signal connected to each reset port */
40
struct
{
41
uint8_t
num_ranges
;
/**< Number of range registers */
42
}
ipgen_ext
;
/**< Extension */
43
}
dt_desc_ac_range_check_t
;
44
45
46
47
48
static
const
dt_desc_ac_range_check_t
ac_range_check_desc[kDtAcRangeCheckCount] = {
49
[
kDtAcRangeCheck
] = {
50
.inst_id =
kDtInstanceIdAcRangeCheck
,
51
.reg_addr = {
52
[kDtAcRangeCheckRegBlockCore] = 0xffffffff,
53
},
54
.mem_addr = {
55
},
56
.mem_size = {
57
},
58
.first_irq =
kTopDarjeelingPlicIrqIdAcRangeCheckDenyCntReached
,
59
.first_alert =
kTopDarjeelingAlertIdAcRangeCheckRecovCtrlUpdateErr
,
60
.clock = {
61
[
kDtAcRangeCheckClockClk
] =
kDtClockMain
,
62
},
63
.reset = {
64
[
kDtAcRangeCheckResetRst
] =
kDtResetLc
,
65
},
66
.ipgen_ext = {
67
.num_ranges = 32,
68
},
69
},
70
};
71
72
/**
73
* Return a pointer to the `dt_ac_range_check_desc_t` structure of the requested
74
* `dt` if it's a valid index. Otherwise, this macro will `return` (i.e. exit
75
* the function) with the provided default value.
76
*/
77
#define TRY_GET_DT(dt, default) ({ if ((dt) < (dt_ac_range_check_t)0 || (dt) >= kDtAcRangeCheckCount) return (default); &ac_range_check_desc[dt]; })
78
79
dt_ac_range_check_t
dt_ac_range_check_from_instance_id
(
dt_instance_id_t
inst_id) {
80
if
(inst_id >=
kDtInstanceIdAcRangeCheck
&& inst_id <=
kDtInstanceIdAcRangeCheck
) {
81
return
(
dt_ac_range_check_t
)(inst_id -
kDtInstanceIdAcRangeCheck
);
82
}
83
return
(
dt_ac_range_check_t
)0;
84
}
85
86
dt_instance_id_t
dt_ac_range_check_instance_id
(
87
dt_ac_range_check_t
dt) {
88
return
TRY_GET_DT
(dt,
kDtInstanceIdUnknown
)->inst_id;
89
}
90
91
uint32_t
dt_ac_range_check_reg_block
(
92
dt_ac_range_check_t
dt,
93
dt_ac_range_check_reg_block_t
reg_block) {
94
// Return a recognizable address in case of wrong argument.
95
return
TRY_GET_DT
(dt, 0xdeadbeef)->reg_addr[reg_block];
96
}
97
98
uint32_t
dt_ac_range_check_memory_base
(
99
dt_ac_range_check_t
dt,
100
dt_ac_range_check_memory_t
mem) {
101
// Return a recognizable address in case of wrong argument.
102
return
TRY_GET_DT
(dt, 0xdeadbeef)->mem_addr[mem];
103
}
104
105
uint32_t
dt_ac_range_check_memory_size
(
106
dt_ac_range_check_t
dt,
107
dt_ac_range_check_memory_t
mem) {
108
// Return an empty size in case of wrong argument.
109
return
TRY_GET_DT
(dt, 0)->mem_size[mem];
110
}
111
112
dt_plic_irq_id_t
dt_ac_range_check_irq_to_plic_id
(
113
dt_ac_range_check_t
dt,
114
dt_ac_range_check_irq_t
irq) {
115
dt_plic_irq_id_t
first_irq =
TRY_GET_DT
(dt, kDtPlicIrqIdNone)->first_irq;
116
if
(first_irq == kDtPlicIrqIdNone) {
117
return
kDtPlicIrqIdNone;
118
}
119
return
(
dt_plic_irq_id_t
)((uint32_t)first_irq + (uint32_t)irq);
120
}
121
122
dt_ac_range_check_irq_t
dt_ac_range_check_irq_from_plic_id
(
123
dt_ac_range_check_t
dt,
124
dt_plic_irq_id_t
irq) {
125
dt_ac_range_check_irq_t
count = kDtAcRangeCheckIrqCount;
126
dt_plic_irq_id_t
first_irq =
TRY_GET_DT
(dt, count)->first_irq;
127
if
(first_irq == kDtPlicIrqIdNone) {
128
return
count;
129
}
130
if
(irq < first_irq || irq >= first_irq + (
dt_plic_irq_id_t
)count) {
131
return
count;
132
}
133
return
(
dt_ac_range_check_irq_t
)(irq - first_irq);
134
}
135
136
137
dt_alert_id_t
dt_ac_range_check_alert_to_alert_id
(
138
dt_ac_range_check_t
dt,
139
dt_ac_range_check_alert_t
alert) {
140
return
(
dt_alert_id_t
)((uint32_t)ac_range_check_desc[dt].first_alert + (uint32_t)alert);
141
}
142
143
dt_ac_range_check_alert_t
dt_ac_range_check_alert_from_alert_id
(
144
dt_ac_range_check_t
dt,
145
dt_alert_id_t
alert) {
146
dt_ac_range_check_alert_t
count = kDtAcRangeCheckAlertCount;
147
if
(alert < ac_range_check_desc[dt].first_alert || alert >= ac_range_check_desc[dt].first_alert + (
dt_alert_id_t
)count) {
148
return
count;
149
}
150
return
(
dt_ac_range_check_alert_t
)(alert - ac_range_check_desc[dt].first_alert);
151
}
152
153
154
155
dt_clock_t
dt_ac_range_check_clock
(
156
dt_ac_range_check_t
dt,
157
dt_ac_range_check_clock_t
clk) {
158
// Return the first clock in case of invalid argument.
159
return
TRY_GET_DT
(dt, (
dt_clock_t
)0)->clock[clk];
160
}
161
162
dt_reset_t
dt_ac_range_check_reset
(
163
dt_ac_range_check_t
dt,
164
dt_ac_range_check_reset_t
rst) {
165
const
dt_ac_range_check_reset_t
count = kDtAcRangeCheckResetCount;
166
if
(rst >= count) {
167
return
kDtResetUnknown
;
168
}
169
return
TRY_GET_DT
(dt,
kDtResetUnknown
)->reset[rst];
170
}
171
172
173
174
uint8_t
dt_ac_range_check_num_ranges
(
dt_ac_range_check_t
dt) {
175
return
TRY_GET_DT
(dt, 0)->ipgen_ext.num_ranges;
176
}
177
178
(darjeeling)
hw
top
dt
dt_ac_range_check.c
Return to
OpenTitan Documentation