Software APIs
dt_ast.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 ast and top darjeeling.
10 */
11
12#include "hw/top/dt/dt_ast.h"
13
14
15
16/**
17 * Description of instances.
18 */
19typedef struct dt_desc_ast {
20 dt_instance_id_t inst_id; /**< Instance ID */
21 uint32_t reg_addr[kDtAstRegBlockCount]; /**< Base address of each register block */
22 uint32_t mem_addr[kDtAstMemoryCount]; /**< Base address of each memory */
23 uint32_t mem_size[kDtAstMemoryCount]; /**< Size in bytes of each memory */
24 dt_clock_t clock[kDtAstClockCount]; /**< Clock signal connected to each clock port */
25 dt_reset_t reset[kDtAstResetCount]; /**< Reset signal connected to each reset port */
27
28
29
30
31static const dt_desc_ast_t ast_desc[kDtAstCount] = {
32 [kDtAst] = {
33 .inst_id = kDtInstanceIdAst,
34 .reg_addr = {
35 [kDtAstRegBlockCore] = 0x30480000,
36 },
37 .mem_addr = {
38 },
39 .mem_size = {
40 },
41 .clock = {
46 },
47 .reset = {
52 },
53 },
54};
55
56/**
57 * Return a pointer to the `dt_ast_desc_t` structure of the requested
58 * `dt` if it's a valid index. Otherwise, this macro will `return` (i.e. exit
59 * the function) with the provided default value.
60 */
61#define TRY_GET_DT(dt, default) ({ if ((dt) < (dt_ast_t)0 || (dt) >= kDtAstCount) return (default); &ast_desc[dt]; })
62
64 if (inst_id >= kDtInstanceIdAst && inst_id <= kDtInstanceIdAst) {
65 return (dt_ast_t)(inst_id - kDtInstanceIdAst);
66 }
67 return (dt_ast_t)0;
68}
69
74
76 dt_ast_t dt,
77 dt_ast_reg_block_t reg_block) {
78 // Return a recognizable address in case of wrong argument.
79 return TRY_GET_DT(dt, 0xdeadbeef)->reg_addr[reg_block];
80}
81
83 dt_ast_t dt,
84 dt_ast_memory_t mem) {
85 // Return a recognizable address in case of wrong argument.
86 return TRY_GET_DT(dt, 0xdeadbeef)->mem_addr[mem];
87}
88
90 dt_ast_t dt,
91 dt_ast_memory_t mem) {
92 // Return an empty size in case of wrong argument.
93 return TRY_GET_DT(dt, 0)->mem_size[mem];
94}
95
96
97
98
100 dt_ast_t dt,
101 dt_ast_clock_t clk) {
102 // Return the first clock in case of invalid argument.
103 return TRY_GET_DT(dt, (dt_clock_t)0)->clock[clk];
104}
105
107 dt_ast_t dt,
108 dt_ast_reset_t rst) {
109 const dt_ast_reset_t count = kDtAstResetCount;
110 if (rst >= count) {
111 return kDtResetUnknown;
112 }
113 return TRY_GET_DT(dt, kDtResetUnknown)->reset[rst];
114}
115
116