Software APIs
dt_ast.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_AST_H_
8
#define OPENTITAN_DT_AST_H_
9
10
#ifdef __cplusplus
11
extern
"C"
{
12
#endif
// __cplusplus
13
14
/**
15
* @file
16
* @brief Device Tables (DT) for IP ast and top earlgrey.
17
*
18
* This file contains the type definitions and global functions of the ast.
19
*/
20
21
#include "
dt_api.h
"
22
#include <stdint.h>
23
24
25
26
/**
27
* List of instances.
28
*/
29
typedef
enum
dt_ast
{
30
kDtAst
= 0,
/**< ast */
31
kDtAstFirst = 0,
/**< \internal First instance */
32
kDtAstCount = 1,
/**< \internal Number of instances */
33
}
dt_ast_t
;
34
35
/**
36
* List of register blocks.
37
*
38
* Register blocks are guaranteed to start at 0 and to be consecutively numbered.
39
*/
40
typedef
enum
dt_ast_reg_block
{
41
kDtAstRegBlockCore = 0,
/**< */
42
kDtAstRegBlockCount = 1,
/**< \internal Number of register blocks */
43
}
dt_ast_reg_block_t
;
44
45
/** Primary register block (associated with the "primary" set of registers that control the IP). */
46
static
const
dt_ast_reg_block_t
kDtAstRegBlockPrimary = kDtAstRegBlockCore;
47
48
/**
49
* List of clock ports.
50
*
51
* Clock ports are guaranteed to be numbered consecutively from 0.
52
*/
53
typedef
enum
dt_ast_clock
{
54
kDtAstClockAstTlul
= 0,
/**< Clock port clk_ast_tlul_i */
55
kDtAstClockAstAdc
= 1,
/**< Clock port clk_ast_adc_i */
56
kDtAstClockAstAlert
= 2,
/**< Clock port clk_ast_alert_i */
57
kDtAstClockAstEs
= 3,
/**< Clock port clk_ast_es_i */
58
kDtAstClockAstRng
= 4,
/**< Clock port clk_ast_rng_i */
59
kDtAstClockAstUsb
= 5,
/**< Clock port clk_ast_usb_i */
60
kDtAstClockCount = 6,
/**< \internal Number of clock ports */
61
}
dt_ast_clock_t
;
62
63
/**
64
* List of reset ports.
65
*
66
* Reset ports are guaranteed to be numbered consecutively from 0.
67
*/
68
typedef
enum
dt_ast_reset
{
69
kDtAstResetAstTlul
= 0,
/**< Reset port rst_ast_tlul_ni */
70
kDtAstResetAstAdc
= 1,
/**< Reset port rst_ast_adc_ni */
71
kDtAstResetAstAlert
= 2,
/**< Reset port rst_ast_alert_ni */
72
kDtAstResetAstEs
= 3,
/**< Reset port rst_ast_es_ni */
73
kDtAstResetAstRng
= 4,
/**< Reset port rst_ast_rng_ni */
74
kDtAstResetAstUsb
= 5,
/**< Reset port rst_ast_usb_ni */
75
kDtAstResetCount = 6,
/**< \internal Number of reset ports */
76
}
dt_ast_reset_t
;
77
78
79
/**
80
* Get the ast instance from an instance ID
81
*
82
* For example, `dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3`.
83
*
84
* @param inst_id Instance ID.
85
* @return A ast instance.
86
*
87
* **Note:** This function only makes sense if the instance ID has device type ast,
88
* otherwise the returned value is unspecified.
89
*/
90
dt_ast_t
dt_ast_from_instance_id
(
dt_instance_id_t
inst_id);
91
92
/**
93
* Get the instance ID of an instance.
94
*
95
* @param dt Instance of ast.
96
* @return The instance ID of that instance.
97
*/
98
dt_instance_id_t
dt_ast_instance_id
(
dt_ast_t
dt);
99
100
/**
101
* Get the register base address of an instance.
102
*
103
* @param dt Instance of ast.
104
* @param reg_block The register block requested.
105
* @return The register base address of the requested block.
106
*/
107
uint32_t
dt_ast_reg_block
(
108
dt_ast_t
dt,
109
dt_ast_reg_block_t
reg_block);
110
111
/**
112
* Get the primary register base address of an instance.
113
*
114
* This is just a convenience function, equivalent to
115
* `dt_ast_reg_block(dt, kDtAstRegBlockCore)`
116
*
117
* @param dt Instance of ast.
118
* @return The register base address of the primary register block.
119
*/
120
static
inline
uint32_t dt_ast_primary_reg_block(
121
dt_ast_t
dt) {
122
return
dt_ast_reg_block
(dt, kDtAstRegBlockCore);
123
}
124
125
126
127
128
/**
129
* Get the clock signal connected to a clock port of an instance.
130
*
131
* @param dt Instance of ast.
132
* @param clk Clock port.
133
* @return Clock signal.
134
*/
135
dt_clock_t
dt_ast_clock
(
136
dt_ast_t
dt,
137
dt_ast_clock_t
clk);
138
139
/**
140
* Get the reset signal connected to a reset port of an instance.
141
*
142
* @param dt Instance of ast.
143
* @param rst Reset port.
144
* @return Reset signal.
145
*/
146
dt_reset_t
dt_ast_reset
(
147
dt_ast_t
dt,
148
dt_ast_reset_t
rst);
149
150
151
152
#ifdef __cplusplus
153
}
// extern "C"
154
#endif
// __cplusplus
155
156
#endif
// OPENTITAN_DT_AST_H_
(earlgrey)
hw
top
dt
dt_ast.h
Return to
OpenTitan Documentation