Software APIs
dt_uart.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 uart and top darjeeling.
10 */
11
12#include "hw/top/dt/dt_uart.h"
13
14
15
16/**
17 * Description of instances.
18 */
19typedef struct dt_desc_uart {
20 dt_instance_id_t inst_id; /**< Instance ID */
21 uint32_t reg_addr[kDtUartRegBlockCount]; /**< Base address of each register block */
22 uint32_t mem_addr[kDtUartMemoryCount]; /**< Base address of each memory */
23 uint32_t mem_size[kDtUartMemoryCount]; /**< 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 /**
31 * Alert ID of the first Alert of this instance.
32 *
33 * This value is undefined if the block is not connected to the Alert Handler.
34 */
36 dt_clock_t clock[kDtUartClockCount]; /**< Clock signal connected to each clock port */
37 dt_reset_t reset[kDtUartResetCount]; /**< Reset signal connected to each reset port */
38 dt_periph_io_t periph_io[kDtUartPeriphIoCount]; /**< Description of each peripheral I/O */
40
41
42
43
44static const dt_desc_uart_t uart_desc[kDtUartCount] = {
45 [kDtUart0] = {
46 .inst_id = kDtInstanceIdUart0,
47 .reg_addr = {
48 [kDtUartRegBlockCore] = 0x30010000,
49 },
50 .mem_addr = {
51 },
52 .mem_size = {
53 },
56 .clock = {
58 },
59 .reset = {
61 },
62 .periph_io = {
63 [kDtUartPeriphIoRx] = {
64 .__internal = {
65 .type = kDtPeriphIoTypeDio,
66 .dir = kDtPeriphIoDirIn,
67 .periph_input_or_direct_pad = kTopDarjeelingDirectPadsUart0Rx,
68 .outsel_or_dt_pad = kDtPadUart0Rx,
69 },
70 },
71 [kDtUartPeriphIoTx] = {
72 .__internal = {
73 .type = kDtPeriphIoTypeDio,
74 .dir = kDtPeriphIoDirOut,
75 .periph_input_or_direct_pad = kTopDarjeelingDirectPadsUart0Tx,
76 .outsel_or_dt_pad = kDtPadUart0Tx,
77 },
78 },
79 },
80 },
81};
82
83/**
84 * Return a pointer to the `dt_uart_desc_t` structure of the requested
85 * `dt` if it's a valid index. Otherwise, this macro will `return` (i.e. exit
86 * the function) with the provided default value.
87 */
88#define TRY_GET_DT(dt, default) ({ if ((dt) < (dt_uart_t)0 || (dt) >= kDtUartCount) return (default); &uart_desc[dt]; })
89
91 if (inst_id >= kDtInstanceIdUart0 && inst_id <= kDtInstanceIdUart0) {
92 return (dt_uart_t)(inst_id - kDtInstanceIdUart0);
93 }
94 return (dt_uart_t)0;
95}
96
101
103 dt_uart_t dt,
104 dt_uart_reg_block_t reg_block) {
105 // Return a recognizable address in case of wrong argument.
106 return TRY_GET_DT(dt, 0xdeadbeef)->reg_addr[reg_block];
107}
108
110 dt_uart_t dt,
111 dt_uart_memory_t mem) {
112 // Return a recognizable address in case of wrong argument.
113 return TRY_GET_DT(dt, 0xdeadbeef)->mem_addr[mem];
114}
115
117 dt_uart_t dt,
118 dt_uart_memory_t mem) {
119 // Return an empty size in case of wrong argument.
120 return TRY_GET_DT(dt, 0)->mem_size[mem];
121}
122
124 dt_uart_t dt,
125 dt_uart_irq_t irq) {
126 dt_plic_irq_id_t first_irq = TRY_GET_DT(dt, kDtPlicIrqIdNone)->first_irq;
127 if (first_irq == kDtPlicIrqIdNone) {
128 return kDtPlicIrqIdNone;
129 }
130 return (dt_plic_irq_id_t)((uint32_t)first_irq + (uint32_t)irq);
131}
132
134 dt_uart_t dt,
135 dt_plic_irq_id_t irq) {
136 dt_uart_irq_t count = kDtUartIrqCount;
137 dt_plic_irq_id_t first_irq = TRY_GET_DT(dt, count)->first_irq;
138 if (first_irq == kDtPlicIrqIdNone) {
139 return count;
140 }
141 if (irq < first_irq || irq >= first_irq + (dt_plic_irq_id_t)count) {
142 return count;
143 }
144 return (dt_uart_irq_t)(irq - first_irq);
145}
146
147
149 dt_uart_t dt,
150 dt_uart_alert_t alert) {
151 return (dt_alert_id_t)((uint32_t)uart_desc[dt].first_alert + (uint32_t)alert);
152}
153
155 dt_uart_t dt,
156 dt_alert_id_t alert) {
157 dt_uart_alert_t count = kDtUartAlertCount;
158 if (alert < uart_desc[dt].first_alert || alert >= uart_desc[dt].first_alert + (dt_alert_id_t)count) {
159 return count;
160 }
161 return (dt_uart_alert_t)(alert - uart_desc[dt].first_alert);
162}
163
164
166 dt_uart_t dt,
168 // Return a harmless value in case of wrong argument.
169 return TRY_GET_DT(dt, kDtPeriphIoConstantHighZ)->periph_io[sig];
170}
171
173 dt_uart_t dt,
174 dt_uart_clock_t clk) {
175 // Return the first clock in case of invalid argument.
176 return TRY_GET_DT(dt, (dt_clock_t)0)->clock[clk];
177}
178
180 dt_uart_t dt,
181 dt_uart_reset_t rst) {
182 const dt_uart_reset_t count = kDtUartResetCount;
183 if (rst >= count) {
184 return kDtResetUnknown;
185 }
186 return TRY_GET_DT(dt, kDtResetUnknown)->reset[rst];
187}
188
189