Software APIs
dt_rv_timer.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 rv_timer and top englishbreakfast.
10 */
11
12#include "hw/top/dt/dt_rv_timer.h"
13
14
15
16/**
17 * Description of instances.
18 */
19typedef struct dt_desc_rv_timer {
20 dt_instance_id_t inst_id; /**< Instance ID */
21 uint32_t reg_addr[kDtRvTimerRegBlockCount]; /**< Base address of each register block */
22 uint32_t mem_addr[kDtRvTimerMemoryCount]; /**< Base address of each memory */
23 uint32_t mem_size[kDtRvTimerMemoryCount]; /**< Size in bytes of each memory */
24 /**
25 * PLIC ID of the first IRQ of this instance
26 *
27 * This can be `kDtPlicIrqIdNone` if the block is not connected to the PLIC.
28 */
30 dt_clock_t clock[kDtRvTimerClockCount]; /**< Clock signal connected to each clock port */
31 dt_reset_t reset[kDtRvTimerResetCount]; /**< Reset signal connected to each reset port */
33
34
35
36
37static const dt_desc_rv_timer_t rv_timer_desc[kDtRvTimerCount] = {
38 [kDtRvTimer] = {
39 .inst_id = kDtInstanceIdRvTimer,
40 .reg_addr = {
41 [kDtRvTimerRegBlockCore] = 0x40100000,
42 },
43 .mem_addr = {
44 },
45 .mem_size = {
46 },
48 .clock = {
50 },
51 .reset = {
53 },
54 },
55};
56
57/**
58 * Return a pointer to the `dt_rv_timer_desc_t` structure of the requested
59 * `dt` if it's a valid index. Otherwise, this macro will `return` (i.e. exit
60 * the function) with the provided default value.
61 */
62#define TRY_GET_DT(dt, default) ({ if ((dt) < (dt_rv_timer_t)0 || (dt) >= kDtRvTimerCount) return (default); &rv_timer_desc[dt]; })
63
65 if (inst_id >= kDtInstanceIdRvTimer && inst_id <= kDtInstanceIdRvTimer) {
66 return (dt_rv_timer_t)(inst_id - kDtInstanceIdRvTimer);
67 }
68 return (dt_rv_timer_t)0;
69}
70
75
78 dt_rv_timer_reg_block_t reg_block) {
79 // Return a recognizable address in case of wrong argument.
80 return TRY_GET_DT(dt, 0xdeadbeef)->reg_addr[reg_block];
81}
82
86 // Return a recognizable address in case of wrong argument.
87 return TRY_GET_DT(dt, 0xdeadbeef)->mem_addr[mem];
88}
89
93 // Return an empty size in case of wrong argument.
94 return TRY_GET_DT(dt, 0)->mem_size[mem];
95}
96
100 dt_plic_irq_id_t first_irq = TRY_GET_DT(dt, kDtPlicIrqIdNone)->first_irq;
101 if (first_irq == kDtPlicIrqIdNone) {
102 return kDtPlicIrqIdNone;
103 }
104 return (dt_plic_irq_id_t)((uint32_t)first_irq + (uint32_t)irq);
105}
106
108 dt_rv_timer_t dt,
109 dt_plic_irq_id_t irq) {
110 dt_rv_timer_irq_t count = kDtRvTimerIrqCount;
111 dt_plic_irq_id_t first_irq = TRY_GET_DT(dt, count)->first_irq;
112 if (first_irq == kDtPlicIrqIdNone) {
113 return count;
114 }
115 if (irq < first_irq || irq >= first_irq + (dt_plic_irq_id_t)count) {
116 return count;
117 }
118 return (dt_rv_timer_irq_t)(irq - first_irq);
119}
120
121
122
123
125 dt_rv_timer_t dt,
127 // Return the first clock in case of invalid argument.
128 return TRY_GET_DT(dt, (dt_clock_t)0)->clock[clk];
129}
130
132 dt_rv_timer_t dt,
134 const dt_rv_timer_reset_t count = kDtRvTimerResetCount;
135 if (rst >= count) {
136 return kDtResetUnknown;
137 }
138 return TRY_GET_DT(dt, kDtResetUnknown)->reset[rst];
139}
140
141