Software APIs
dif_uart_autogen.c
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
6
7
8
9
10
11// THIS FILE HAS BEEN GENERATED, DO NOT EDIT MANUALLY. COMMAND:
12// util/autogen_dif.py -i hw/ip/uart/data/uart.hjson -o
13// bazel-out/k8-fastbuild/bin/sw/device/lib/dif/autogen
14
15
16#include <stdint.h>
17
18#include "sw/device/lib/dif/dif_base.h"
19#include "sw/device/lib/dif/autogen/dif_uart_autogen.h"
20
21#include "hw/top/uart_regs.h" // Generated.
22
23
24OT_WARN_UNUSED_RESULT
25dif_result_t dif_uart_init(
26 mmio_region_t base_addr,
27 dif_uart_t *uart) {
28 if (uart == NULL) {
29 return kDifBadArg;
30 }
31
32 uart->dt = kDtUartCount;
33 uart->base_addr = base_addr;
34
35 return kDifOk;
36}
37
38OT_WARN_UNUSED_RESULT
39dif_result_t dif_uart_init_from_dt(
40 dt_uart_t dt,
41 dif_uart_t *uart) {
42 if (uart == NULL) {
43 return kDifBadArg;
44 }
45
46 uart->dt = dt;
47 uart->base_addr = mmio_region_from_addr(dt_uart_primary_reg_block(dt));
48
49 return kDifOk;
50}
51
52dif_result_t dif_uart_get_dt(
53 const dif_uart_t *uart,
54 dt_uart_t *dt) {
55 if (uart->dt == kDtUartCount || dt == NULL) {
56 return kDifBadArg;
57 }
58 *dt = uart->dt;
59 return kDifOk;
60}
61
62 dif_result_t dif_uart_alert_force(
63 const dif_uart_t *uart,
64 dif_uart_alert_t alert) {
65 if (uart == NULL) {
66 return kDifBadArg;
67 }
68
69 bitfield_bit32_index_t alert_idx;
70 switch (alert) {
71 case kDifUartAlertFatalFault:
72 alert_idx = UART_ALERT_TEST_FATAL_FAULT_BIT;
73 break;
74 default:
75 return kDifBadArg;
76 }
77
78 uint32_t alert_test_reg = bitfield_bit32_write(0, alert_idx, true);
79 mmio_region_write32(
80 uart->base_addr,
81 (ptrdiff_t)UART_ALERT_TEST_REG_OFFSET,
82 alert_test_reg);
83
84
85 return kDifOk;
86}
87
88
89 /**
90 * Get the corresponding interrupt register bit offset of the IRQ.
91 */
92 static bool uart_get_irq_bit_index(
93 dif_uart_irq_t irq,
94 bitfield_bit32_index_t *index_out) {
95
96 switch (irq) {
97 case kDtUartIrqTxWatermark:
98 *index_out = UART_INTR_COMMON_TX_WATERMARK_BIT;
99 break;
100 case kDtUartIrqRxWatermark:
101 *index_out = UART_INTR_COMMON_RX_WATERMARK_BIT;
102 break;
103 case kDtUartIrqTxDone:
104 *index_out = UART_INTR_COMMON_TX_DONE_BIT;
105 break;
106 case kDtUartIrqRxOverflow:
107 *index_out = UART_INTR_COMMON_RX_OVERFLOW_BIT;
108 break;
109 case kDtUartIrqRxFrameErr:
110 *index_out = UART_INTR_COMMON_RX_FRAME_ERR_BIT;
111 break;
112 case kDtUartIrqRxBreakErr:
113 *index_out = UART_INTR_COMMON_RX_BREAK_ERR_BIT;
114 break;
115 case kDtUartIrqRxTimeout:
116 *index_out = UART_INTR_COMMON_RX_TIMEOUT_BIT;
117 break;
118 case kDtUartIrqRxParityErr:
119 *index_out = UART_INTR_COMMON_RX_PARITY_ERR_BIT;
120 break;
121 case kDtUartIrqTxEmpty:
122 *index_out = UART_INTR_COMMON_TX_EMPTY_BIT;
123 break;
124 default:
125 return false;
126 }
127
128 return true;
129 }
130
131 static dif_irq_type_t irq_types[] = {
132 kDifIrqTypeStatus,
133 kDifIrqTypeStatus,
134 kDifIrqTypeEvent,
135 kDifIrqTypeEvent,
136 kDifIrqTypeEvent,
137 kDifIrqTypeEvent,
138 kDifIrqTypeEvent,
139 kDifIrqTypeEvent,
140 kDifIrqTypeStatus,
141 };
142
143 OT_WARN_UNUSED_RESULT
144 dif_result_t dif_uart_irq_get_type(
145 const dif_uart_t *uart,
146 dif_uart_irq_t irq,
147 dif_irq_type_t *type) {
148
149
150 if (uart == NULL ||
151 type == NULL ||
152 irq < kDifUartIrqTxWatermark ||
153 irq > kDifUartIrqTxEmpty) {
154 return kDifBadArg;
155 }
156
157 *type = irq_types[irq];
158
159 return kDifOk;
160 }
161
162 OT_WARN_UNUSED_RESULT
163 dif_result_t dif_uart_irq_get_state(
164 const dif_uart_t *uart,
165 dif_uart_irq_state_snapshot_t *snapshot) {
166
167 if (uart == NULL || snapshot == NULL) {
168 return kDifBadArg;
169 }
170
171 *snapshot = mmio_region_read32(
172 uart->base_addr,
173 (ptrdiff_t)UART_INTR_STATE_REG_OFFSET);
174
175
176 return kDifOk;
177 }
178
179 OT_WARN_UNUSED_RESULT
180 dif_result_t dif_uart_irq_acknowledge_state(
181 const dif_uart_t *uart,
182 dif_uart_irq_state_snapshot_t snapshot) {
183 if (uart == NULL) {
184 return kDifBadArg;
185 }
186
187 mmio_region_write32(
188 uart->base_addr,
189 (ptrdiff_t)UART_INTR_STATE_REG_OFFSET,
190 snapshot);
191
192
193 return kDifOk;
194 }
195
196 OT_WARN_UNUSED_RESULT
197 dif_result_t dif_uart_irq_is_pending(
198 const dif_uart_t *uart,
199 dif_uart_irq_t irq,
200 bool *is_pending) {
201
202 if (uart == NULL || is_pending == NULL) {
203 return kDifBadArg;
204 }
205
206 bitfield_bit32_index_t index;
207 if (!uart_get_irq_bit_index(irq, &index)) {
208 return kDifBadArg;
209 }
210
211 uint32_t intr_state_reg = mmio_region_read32(
212 uart->base_addr,
213 (ptrdiff_t)UART_INTR_STATE_REG_OFFSET);
214
215
216 *is_pending = bitfield_bit32_read(intr_state_reg, index);
217
218 return kDifOk;
219 }
220
221 OT_WARN_UNUSED_RESULT
222 dif_result_t dif_uart_irq_acknowledge_all(
223 const dif_uart_t *uart
224 ) {
225
226 if (uart == NULL) {
227 return kDifBadArg;
228 }
229
230 // Writing to the register clears the corresponding bits (Write-one clear).
231 mmio_region_write32(
232 uart->base_addr,
233 (ptrdiff_t)UART_INTR_STATE_REG_OFFSET,
234 UINT32_MAX);
235
236
237 return kDifOk;
238 }
239
240 OT_WARN_UNUSED_RESULT
241 dif_result_t dif_uart_irq_acknowledge(
242 const dif_uart_t *uart,
243 dif_uart_irq_t irq) {
244
245 if (uart == NULL) {
246 return kDifBadArg;
247 }
248
249 bitfield_bit32_index_t index;
250 if (!uart_get_irq_bit_index(irq, &index)) {
251 return kDifBadArg;
252 }
253
254 // Writing to the register clears the corresponding bits (Write-one clear).
255 uint32_t intr_state_reg = bitfield_bit32_write(0, index, true);
256 mmio_region_write32(
257 uart->base_addr,
258 (ptrdiff_t)UART_INTR_STATE_REG_OFFSET,
259 intr_state_reg);
260
261
262 return kDifOk;
263 }
264
265 OT_WARN_UNUSED_RESULT
266 dif_result_t dif_uart_irq_force(
267 const dif_uart_t *uart,
268 dif_uart_irq_t irq,
269 const bool val) {
270
271 if (uart == NULL) {
272 return kDifBadArg;
273 }
274
275 bitfield_bit32_index_t index;
276 if (!uart_get_irq_bit_index(irq, &index)) {
277 return kDifBadArg;
278 }
279
280 uint32_t intr_test_reg = bitfield_bit32_write(0, index, val);
281 mmio_region_write32(
282 uart->base_addr,
283 (ptrdiff_t)UART_INTR_TEST_REG_OFFSET,
284 intr_test_reg);
285
286
287 return kDifOk;
288 }
289
290 OT_WARN_UNUSED_RESULT
291 dif_result_t dif_uart_irq_get_enabled(
292 const dif_uart_t *uart,
293 dif_uart_irq_t irq,
294 dif_toggle_t *state) {
295
296 if (uart == NULL || state == NULL) {
297 return kDifBadArg;
298 }
299
300 bitfield_bit32_index_t index;
301 if (!uart_get_irq_bit_index(irq, &index)) {
302 return kDifBadArg;
303 }
304
305 uint32_t intr_enable_reg = mmio_region_read32(
306 uart->base_addr,
307 (ptrdiff_t)UART_INTR_ENABLE_REG_OFFSET);
308
309
310 bool is_enabled = bitfield_bit32_read(intr_enable_reg, index);
311 *state = is_enabled ?
312 kDifToggleEnabled : kDifToggleDisabled;
313
314 return kDifOk;
315 }
316
317 OT_WARN_UNUSED_RESULT
318 dif_result_t dif_uart_irq_set_enabled(
319 const dif_uart_t *uart,
320 dif_uart_irq_t irq,
321 dif_toggle_t state) {
322
323 if (uart == NULL) {
324 return kDifBadArg;
325 }
326
327 bitfield_bit32_index_t index;
328 if (!uart_get_irq_bit_index(irq, &index)) {
329 return kDifBadArg;
330 }
331
332 uint32_t intr_enable_reg = mmio_region_read32(
333 uart->base_addr,
334 (ptrdiff_t)UART_INTR_ENABLE_REG_OFFSET);
335
336
337 bool enable_bit = (state == kDifToggleEnabled) ? true : false;
338 intr_enable_reg = bitfield_bit32_write(intr_enable_reg, index, enable_bit);
339 mmio_region_write32(
340 uart->base_addr,
341 (ptrdiff_t)UART_INTR_ENABLE_REG_OFFSET,
342 intr_enable_reg);
343
344
345 return kDifOk;
346 }
347
348 OT_WARN_UNUSED_RESULT
349 dif_result_t dif_uart_irq_disable_all(
350 const dif_uart_t *uart,
351 dif_uart_irq_enable_snapshot_t *snapshot) {
352
353 if (uart == NULL) {
354 return kDifBadArg;
355 }
356
357 // Pass the current interrupt state to the caller, if requested.
358 if (snapshot != NULL) {
359 *snapshot = mmio_region_read32(
360 uart->base_addr,
361 (ptrdiff_t)UART_INTR_ENABLE_REG_OFFSET);
362
363 }
364
365 // Disable all interrupts.
366 mmio_region_write32(
367 uart->base_addr,
368 (ptrdiff_t)UART_INTR_ENABLE_REG_OFFSET,
369 0u);
370
371
372 return kDifOk;
373 }
374
375 OT_WARN_UNUSED_RESULT
376 dif_result_t dif_uart_irq_restore_all(
377 const dif_uart_t *uart,
378 const dif_uart_irq_enable_snapshot_t *snapshot) {
379
380 if (uart == NULL || snapshot == NULL) {
381 return kDifBadArg;
382 }
383
384 mmio_region_write32(
385 uart->base_addr,
386 (ptrdiff_t)UART_INTR_ENABLE_REG_OFFSET,
387 *snapshot);
388
389
390 return kDifOk;
391 }
392