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