Software APIs
dt_soc_dbg_ctrl.h
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#ifndef OPENTITAN_DT_SOC_DBG_CTRL_H_
8#define OPENTITAN_DT_SOC_DBG_CTRL_H_
9
10#ifdef __cplusplus
11extern "C" {
12#endif // __cplusplus
13
14/**
15 * @file
16 * @brief Device Tables (DT) for IP soc_dbg_ctrl and top darjeeling.
17 *
18 * This file contains the type definitions and global functions of the soc_dbg_ctrl.
19 */
20
21#include "dt_api.h"
22#include <stdint.h>
23
24
25
26/**
27 * List of instances.
28 */
29typedef enum dt_soc_dbg_ctrl {
30 kDtSocDbgCtrl = 0, /**< soc_dbg_ctrl */
31 kDtSocDbgCtrlFirst = 0, /**< \internal First instance */
32 kDtSocDbgCtrlCount = 1, /**< \internal Number of instances */
34
35/**
36 * List of register blocks.
37 *
38 * Register blocks are guaranteed to start at 0 and to be consecutively numbered.
39 */
41 kDtSocDbgCtrlRegBlockCore = 0, /**< */
42 kDtSocDbgCtrlRegBlockJtag = 1, /**< */
43 kDtSocDbgCtrlRegBlockCount = 2, /**< \internal Number of register blocks */
45
46/** Primary register block (associated with the "primary" set of registers that control the IP). */
47static const dt_soc_dbg_ctrl_reg_block_t kDtSocDbgCtrlRegBlockPrimary = kDtSocDbgCtrlRegBlockCore;
48
49/**
50 * List of Alerts.
51 *
52 * Alerts are guaranteed to be numbered consecutively from 0.
53 */
55 kDtSocDbgCtrlAlertFatalFault = 0, /**< This fatal alert is triggered when a fatal TL-UL bus integrity fault is detected. */
56 kDtSocDbgCtrlAlertRecovCtrlUpdateErr = 1, /**< This recoverable alert is triggered upon detecting an update error in the shadowed Control Register. */
57 kDtSocDbgCtrlAlertCount = 2, /**< \internal Number of Alerts */
59
60/**
61 * List of clock ports.
62 *
63 * Clock ports are guaranteed to be numbered consecutively from 0.
64 */
66 kDtSocDbgCtrlClockClk = 0, /**< Clock port clk_i */
67 kDtSocDbgCtrlClockCount = 1, /**< \internal Number of clock ports */
69
70/**
71 * List of reset ports.
72 *
73 * Reset ports are guaranteed to be numbered consecutively from 0.
74 */
76 kDtSocDbgCtrlResetRst = 0, /**< Reset port rst_ni */
77 kDtSocDbgCtrlResetCount = 1, /**< \internal Number of reset ports */
79
80
81/**
82 * Get the soc_dbg_ctrl instance from an instance ID
83 *
84 * For example, `dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3`.
85 *
86 * @param inst_id Instance ID.
87 * @return A soc_dbg_ctrl instance.
88 *
89 * **Note:** This function only makes sense if the instance ID has device type soc_dbg_ctrl,
90 * otherwise the returned value is unspecified.
91 */
93
94/**
95 * Get the instance ID of an instance.
96 *
97 * @param dt Instance of soc_dbg_ctrl.
98 * @return The instance ID of that instance.
99 */
101
102/**
103 * Get the register base address of an instance.
104 *
105 * @param dt Instance of soc_dbg_ctrl.
106 * @param reg_block The register block requested.
107 * @return The register base address of the requested block.
108 */
112
113/**
114 * Get the primary register base address of an instance.
115 *
116 * This is just a convenience function, equivalent to
117 * `dt_soc_dbg_ctrl_reg_block(dt, kDtSocDbgCtrlRegBlockCore)`
118 *
119 * @param dt Instance of soc_dbg_ctrl.
120 * @return The register base address of the primary register block.
121 */
122static inline uint32_t dt_soc_dbg_ctrl_primary_reg_block(
124 return dt_soc_dbg_ctrl_reg_block(dt, kDtSocDbgCtrlRegBlockCore);
125}
126
127
128/**
129 * Get the alert ID of a soc_dbg_ctrl alert for a given instance.
130 *
131 * **Note:** This function only makes sense if the instance is connected to the Alert Handler. For any
132 * instances where the instance is not connected, the return value is unspecified.
133 *
134 * @param dt Instance of soc_dbg_ctrl.
135 * @param alert A soc_dbg_ctrl alert.
136 * @return The Alert Handler alert ID of the alert of this instance.
137 */
141
142/**
143 * Convert a global alert ID to a local soc_dbg_ctrl alert type.
144 *
145 * @param dt Instance of soc_dbg_ctrl.
146 * @param alert A global alert ID that belongs to this instance.
147 * @return The soc_dbg_ctrl alert, or `kDtSocDbgCtrlAlertCount`.
148 *
149 * **Note:** This function assumes that the global alert ID belongs to the
150 * instance of soc_dbg_ctrl passed in parameter. In other words, it must be the case
151 * that `dt_soc_dbg_ctrl_instance_id(dt) == dt_alert_id_to_instance_id(alert)`. Otherwise,
152 * this function will return `kDtSocDbgCtrlAlertCount`.
153 */
156 dt_alert_id_t alert);
157
158
159
160/**
161 * Get the clock signal connected to a clock port of an instance.
162 *
163 * @param dt Instance of soc_dbg_ctrl.
164 * @param clk Clock port.
165 * @return Clock signal.
166 */
170
171/**
172 * Get the reset signal connected to a reset port of an instance.
173 *
174 * @param dt Instance of soc_dbg_ctrl.
175 * @param rst Reset port.
176 * @return Reset signal.
177 */
181
182
183
184#ifdef __cplusplus
185} // extern "C"
186#endif // __cplusplus
187
188#endif // OPENTITAN_DT_SOC_DBG_CTRL_H_