Software APIs
dif_soc_proxy_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
13// hw/top_darjeeling/ip/soc_proxy/data/soc_proxy.hjson -o
14// bazel-out/k8-fastbuild-ST-24cc6a2908d2/bin/sw/device/lib/dif/autogen
15
16
17#include <stdint.h>
18
19#include "sw/device/lib/dif/dif_base.h"
20#include "sw/device/lib/dif/autogen/dif_soc_proxy_autogen.h"
21
22#include "soc_proxy_regs.h" // Generated.
23
24
25OT_WARN_UNUSED_RESULT
26dif_result_t dif_soc_proxy_init(
27 mmio_region_t base_addr,
28 dif_soc_proxy_t *soc_proxy) {
29 if (soc_proxy == NULL) {
30 return kDifBadArg;
31 }
32
33 soc_proxy->dt = kDtSocProxyCount;
34 soc_proxy->base_addr = base_addr;
35
36 return kDifOk;
37}
38
39OT_WARN_UNUSED_RESULT
40dif_result_t dif_soc_proxy_init_from_dt(
41 dt_soc_proxy_t dt,
42 dif_soc_proxy_t *soc_proxy) {
43 if (soc_proxy == NULL) {
44 return kDifBadArg;
45 }
46
47 soc_proxy->dt = dt;
48 soc_proxy->base_addr = mmio_region_from_addr(dt_soc_proxy_primary_reg_block(dt));
49
50 return kDifOk;
51}
52
53dif_result_t dif_soc_proxy_get_dt(
54 const dif_soc_proxy_t *soc_proxy,
55 dt_soc_proxy_t *dt) {
56 if (soc_proxy->dt == kDtSocProxyCount || dt == NULL) {
57 return kDifBadArg;
58 }
59 *dt = soc_proxy->dt;
60 return kDifOk;
61}
62
63 dif_result_t dif_soc_proxy_alert_force(
64 const dif_soc_proxy_t *soc_proxy,
65 dif_soc_proxy_alert_t alert) {
66 if (soc_proxy == NULL) {
67 return kDifBadArg;
68 }
69
70 bitfield_bit32_index_t alert_idx;
71 switch (alert) {
72 case kDifSocProxyAlertFatalAlertIntg:
73 alert_idx = SOC_PROXY_ALERT_TEST_FATAL_ALERT_INTG_BIT;
74 break;
75 case kDifSocProxyAlertFatalAlertExternal0:
76 alert_idx = SOC_PROXY_ALERT_TEST_FATAL_ALERT_EXTERNAL_0_BIT;
77 break;
78 case kDifSocProxyAlertFatalAlertExternal1:
79 alert_idx = SOC_PROXY_ALERT_TEST_FATAL_ALERT_EXTERNAL_1_BIT;
80 break;
81 case kDifSocProxyAlertFatalAlertExternal2:
82 alert_idx = SOC_PROXY_ALERT_TEST_FATAL_ALERT_EXTERNAL_2_BIT;
83 break;
84 case kDifSocProxyAlertFatalAlertExternal3:
85 alert_idx = SOC_PROXY_ALERT_TEST_FATAL_ALERT_EXTERNAL_3_BIT;
86 break;
87 case kDifSocProxyAlertFatalAlertExternal4:
88 alert_idx = SOC_PROXY_ALERT_TEST_FATAL_ALERT_EXTERNAL_4_BIT;
89 break;
90 case kDifSocProxyAlertFatalAlertExternal5:
91 alert_idx = SOC_PROXY_ALERT_TEST_FATAL_ALERT_EXTERNAL_5_BIT;
92 break;
93 case kDifSocProxyAlertFatalAlertExternal6:
94 alert_idx = SOC_PROXY_ALERT_TEST_FATAL_ALERT_EXTERNAL_6_BIT;
95 break;
96 case kDifSocProxyAlertFatalAlertExternal7:
97 alert_idx = SOC_PROXY_ALERT_TEST_FATAL_ALERT_EXTERNAL_7_BIT;
98 break;
99 case kDifSocProxyAlertFatalAlertExternal8:
100 alert_idx = SOC_PROXY_ALERT_TEST_FATAL_ALERT_EXTERNAL_8_BIT;
101 break;
102 case kDifSocProxyAlertFatalAlertExternal9:
103 alert_idx = SOC_PROXY_ALERT_TEST_FATAL_ALERT_EXTERNAL_9_BIT;
104 break;
105 case kDifSocProxyAlertFatalAlertExternal10:
106 alert_idx = SOC_PROXY_ALERT_TEST_FATAL_ALERT_EXTERNAL_10_BIT;
107 break;
108 case kDifSocProxyAlertFatalAlertExternal11:
109 alert_idx = SOC_PROXY_ALERT_TEST_FATAL_ALERT_EXTERNAL_11_BIT;
110 break;
111 case kDifSocProxyAlertFatalAlertExternal12:
112 alert_idx = SOC_PROXY_ALERT_TEST_FATAL_ALERT_EXTERNAL_12_BIT;
113 break;
114 case kDifSocProxyAlertFatalAlertExternal13:
115 alert_idx = SOC_PROXY_ALERT_TEST_FATAL_ALERT_EXTERNAL_13_BIT;
116 break;
117 case kDifSocProxyAlertFatalAlertExternal14:
118 alert_idx = SOC_PROXY_ALERT_TEST_FATAL_ALERT_EXTERNAL_14_BIT;
119 break;
120 case kDifSocProxyAlertFatalAlertExternal15:
121 alert_idx = SOC_PROXY_ALERT_TEST_FATAL_ALERT_EXTERNAL_15_BIT;
122 break;
123 case kDifSocProxyAlertFatalAlertExternal16:
124 alert_idx = SOC_PROXY_ALERT_TEST_FATAL_ALERT_EXTERNAL_16_BIT;
125 break;
126 case kDifSocProxyAlertFatalAlertExternal17:
127 alert_idx = SOC_PROXY_ALERT_TEST_FATAL_ALERT_EXTERNAL_17_BIT;
128 break;
129 case kDifSocProxyAlertFatalAlertExternal18:
130 alert_idx = SOC_PROXY_ALERT_TEST_FATAL_ALERT_EXTERNAL_18_BIT;
131 break;
132 case kDifSocProxyAlertFatalAlertExternal19:
133 alert_idx = SOC_PROXY_ALERT_TEST_FATAL_ALERT_EXTERNAL_19_BIT;
134 break;
135 case kDifSocProxyAlertFatalAlertExternal20:
136 alert_idx = SOC_PROXY_ALERT_TEST_FATAL_ALERT_EXTERNAL_20_BIT;
137 break;
138 case kDifSocProxyAlertFatalAlertExternal21:
139 alert_idx = SOC_PROXY_ALERT_TEST_FATAL_ALERT_EXTERNAL_21_BIT;
140 break;
141 case kDifSocProxyAlertFatalAlertExternal22:
142 alert_idx = SOC_PROXY_ALERT_TEST_FATAL_ALERT_EXTERNAL_22_BIT;
143 break;
144 case kDifSocProxyAlertFatalAlertExternal23:
145 alert_idx = SOC_PROXY_ALERT_TEST_FATAL_ALERT_EXTERNAL_23_BIT;
146 break;
147 case kDifSocProxyAlertRecovAlertExternal0:
148 alert_idx = SOC_PROXY_ALERT_TEST_RECOV_ALERT_EXTERNAL_0_BIT;
149 break;
150 case kDifSocProxyAlertRecovAlertExternal1:
151 alert_idx = SOC_PROXY_ALERT_TEST_RECOV_ALERT_EXTERNAL_1_BIT;
152 break;
153 case kDifSocProxyAlertRecovAlertExternal2:
154 alert_idx = SOC_PROXY_ALERT_TEST_RECOV_ALERT_EXTERNAL_2_BIT;
155 break;
156 case kDifSocProxyAlertRecovAlertExternal3:
157 alert_idx = SOC_PROXY_ALERT_TEST_RECOV_ALERT_EXTERNAL_3_BIT;
158 break;
159 default:
160 return kDifBadArg;
161 }
162
163 uint32_t alert_test_reg = bitfield_bit32_write(0, alert_idx, true);
164 mmio_region_write32(
165 soc_proxy->base_addr,
166 (ptrdiff_t)SOC_PROXY_ALERT_TEST_REG_OFFSET,
167 alert_test_reg);
168
169
170 return kDifOk;
171}
172
173
174 /**
175 * Get the corresponding interrupt register bit offset of the IRQ.
176 */
177 static bool soc_proxy_get_irq_bit_index(
178 dif_soc_proxy_irq_t irq,
179 bitfield_bit32_index_t *index_out) {
180
181 switch (irq) {
182 case kDtSocProxyIrqExternal0:
183 *index_out = 0;
184 break;
185 case kDtSocProxyIrqExternal1:
186 *index_out = 1;
187 break;
188 case kDtSocProxyIrqExternal2:
189 *index_out = 2;
190 break;
191 case kDtSocProxyIrqExternal3:
192 *index_out = 3;
193 break;
194 case kDtSocProxyIrqExternal4:
195 *index_out = 4;
196 break;
197 case kDtSocProxyIrqExternal5:
198 *index_out = 5;
199 break;
200 case kDtSocProxyIrqExternal6:
201 *index_out = 6;
202 break;
203 case kDtSocProxyIrqExternal7:
204 *index_out = 7;
205 break;
206 case kDtSocProxyIrqExternal8:
207 *index_out = 8;
208 break;
209 case kDtSocProxyIrqExternal9:
210 *index_out = 9;
211 break;
212 case kDtSocProxyIrqExternal10:
213 *index_out = 10;
214 break;
215 case kDtSocProxyIrqExternal11:
216 *index_out = 11;
217 break;
218 case kDtSocProxyIrqExternal12:
219 *index_out = 12;
220 break;
221 case kDtSocProxyIrqExternal13:
222 *index_out = 13;
223 break;
224 case kDtSocProxyIrqExternal14:
225 *index_out = 14;
226 break;
227 case kDtSocProxyIrqExternal15:
228 *index_out = 15;
229 break;
230 case kDtSocProxyIrqExternal16:
231 *index_out = 16;
232 break;
233 case kDtSocProxyIrqExternal17:
234 *index_out = 17;
235 break;
236 case kDtSocProxyIrqExternal18:
237 *index_out = 18;
238 break;
239 case kDtSocProxyIrqExternal19:
240 *index_out = 19;
241 break;
242 case kDtSocProxyIrqExternal20:
243 *index_out = 20;
244 break;
245 case kDtSocProxyIrqExternal21:
246 *index_out = 21;
247 break;
248 case kDtSocProxyIrqExternal22:
249 *index_out = 22;
250 break;
251 case kDtSocProxyIrqExternal23:
252 *index_out = 23;
253 break;
254 case kDtSocProxyIrqExternal24:
255 *index_out = 24;
256 break;
257 case kDtSocProxyIrqExternal25:
258 *index_out = 25;
259 break;
260 case kDtSocProxyIrqExternal26:
261 *index_out = 26;
262 break;
263 case kDtSocProxyIrqExternal27:
264 *index_out = 27;
265 break;
266 case kDtSocProxyIrqExternal28:
267 *index_out = 28;
268 break;
269 case kDtSocProxyIrqExternal29:
270 *index_out = 29;
271 break;
272 case kDtSocProxyIrqExternal30:
273 *index_out = 30;
274 break;
275 case kDtSocProxyIrqExternal31:
276 *index_out = 31;
277 break;
278 default:
279 return false;
280 }
281
282 return true;
283 }
284
285 static dif_irq_type_t irq_types[] = {
286 kDifIrqTypeEvent, kDifIrqTypeEvent, kDifIrqTypeEvent, kDifIrqTypeEvent, kDifIrqTypeEvent, kDifIrqTypeEvent, kDifIrqTypeEvent, kDifIrqTypeEvent, kDifIrqTypeEvent, kDifIrqTypeEvent, kDifIrqTypeEvent, kDifIrqTypeEvent, kDifIrqTypeEvent, kDifIrqTypeEvent, kDifIrqTypeEvent, kDifIrqTypeEvent, kDifIrqTypeEvent, kDifIrqTypeEvent, kDifIrqTypeEvent, kDifIrqTypeEvent, kDifIrqTypeEvent, kDifIrqTypeEvent, kDifIrqTypeEvent, kDifIrqTypeEvent, kDifIrqTypeEvent, kDifIrqTypeEvent, kDifIrqTypeEvent, kDifIrqTypeEvent, kDifIrqTypeEvent, kDifIrqTypeEvent, kDifIrqTypeEvent, kDifIrqTypeEvent,
287 };
288
289 OT_WARN_UNUSED_RESULT
290 dif_result_t dif_soc_proxy_irq_get_type(
291 const dif_soc_proxy_t *soc_proxy,
292 dif_soc_proxy_irq_t irq,
293 dif_irq_type_t *type) {
294
295
296 if (soc_proxy == NULL ||
297 type == NULL ||
298 irq < kDifSocProxyIrqExternal0 ||
299 irq > kDifSocProxyIrqExternal31) {
300 return kDifBadArg;
301 }
302
303 *type = irq_types[irq];
304
305 return kDifOk;
306 }
307
308 OT_WARN_UNUSED_RESULT
309 dif_result_t dif_soc_proxy_irq_get_state(
310 const dif_soc_proxy_t *soc_proxy,
311 dif_soc_proxy_irq_state_snapshot_t *snapshot) {
312
313 if (soc_proxy == NULL || snapshot == NULL) {
314 return kDifBadArg;
315 }
316
317 *snapshot = mmio_region_read32(
318 soc_proxy->base_addr,
319 (ptrdiff_t)SOC_PROXY_INTR_STATE_REG_OFFSET);
320
321
322 return kDifOk;
323 }
324
325 OT_WARN_UNUSED_RESULT
326 dif_result_t dif_soc_proxy_irq_acknowledge_state(
327 const dif_soc_proxy_t *soc_proxy,
328 dif_soc_proxy_irq_state_snapshot_t snapshot) {
329 if (soc_proxy == NULL) {
330 return kDifBadArg;
331 }
332
333 mmio_region_write32(
334 soc_proxy->base_addr,
335 (ptrdiff_t)SOC_PROXY_INTR_STATE_REG_OFFSET,
336 snapshot);
337
338
339 return kDifOk;
340 }
341
342 OT_WARN_UNUSED_RESULT
343 dif_result_t dif_soc_proxy_irq_is_pending(
344 const dif_soc_proxy_t *soc_proxy,
345 dif_soc_proxy_irq_t irq,
346 bool *is_pending) {
347
348 if (soc_proxy == NULL || is_pending == NULL) {
349 return kDifBadArg;
350 }
351
352 bitfield_bit32_index_t index;
353 if (!soc_proxy_get_irq_bit_index(irq, &index)) {
354 return kDifBadArg;
355 }
356
357 uint32_t intr_state_reg = mmio_region_read32(
358 soc_proxy->base_addr,
359 (ptrdiff_t)SOC_PROXY_INTR_STATE_REG_OFFSET);
360
361
362 *is_pending = bitfield_bit32_read(intr_state_reg, index);
363
364 return kDifOk;
365 }
366
367 OT_WARN_UNUSED_RESULT
368 dif_result_t dif_soc_proxy_irq_acknowledge_all(
369 const dif_soc_proxy_t *soc_proxy
370 ) {
371
372 if (soc_proxy == NULL) {
373 return kDifBadArg;
374 }
375
376 // Writing to the register clears the corresponding bits (Write-one clear).
377 mmio_region_write32(
378 soc_proxy->base_addr,
379 (ptrdiff_t)SOC_PROXY_INTR_STATE_REG_OFFSET,
380 UINT32_MAX);
381
382
383 return kDifOk;
384 }
385
386 OT_WARN_UNUSED_RESULT
387 dif_result_t dif_soc_proxy_irq_acknowledge(
388 const dif_soc_proxy_t *soc_proxy,
389 dif_soc_proxy_irq_t irq) {
390
391 if (soc_proxy == NULL) {
392 return kDifBadArg;
393 }
394
395 bitfield_bit32_index_t index;
396 if (!soc_proxy_get_irq_bit_index(irq, &index)) {
397 return kDifBadArg;
398 }
399
400 // Writing to the register clears the corresponding bits (Write-one clear).
401 uint32_t intr_state_reg = bitfield_bit32_write(0, index, true);
402 mmio_region_write32(
403 soc_proxy->base_addr,
404 (ptrdiff_t)SOC_PROXY_INTR_STATE_REG_OFFSET,
405 intr_state_reg);
406
407
408 return kDifOk;
409 }
410
411 OT_WARN_UNUSED_RESULT
412 dif_result_t dif_soc_proxy_irq_force(
413 const dif_soc_proxy_t *soc_proxy,
414 dif_soc_proxy_irq_t irq,
415 const bool val) {
416
417 if (soc_proxy == NULL) {
418 return kDifBadArg;
419 }
420
421 bitfield_bit32_index_t index;
422 if (!soc_proxy_get_irq_bit_index(irq, &index)) {
423 return kDifBadArg;
424 }
425
426 uint32_t intr_test_reg = bitfield_bit32_write(0, index, val);
427 mmio_region_write32(
428 soc_proxy->base_addr,
429 (ptrdiff_t)SOC_PROXY_INTR_TEST_REG_OFFSET,
430 intr_test_reg);
431
432
433 return kDifOk;
434 }
435
436 OT_WARN_UNUSED_RESULT
437 dif_result_t dif_soc_proxy_irq_get_enabled(
438 const dif_soc_proxy_t *soc_proxy,
439 dif_soc_proxy_irq_t irq,
440 dif_toggle_t *state) {
441
442 if (soc_proxy == NULL || state == NULL) {
443 return kDifBadArg;
444 }
445
446 bitfield_bit32_index_t index;
447 if (!soc_proxy_get_irq_bit_index(irq, &index)) {
448 return kDifBadArg;
449 }
450
451 uint32_t intr_enable_reg = mmio_region_read32(
452 soc_proxy->base_addr,
453 (ptrdiff_t)SOC_PROXY_INTR_ENABLE_REG_OFFSET);
454
455
456 bool is_enabled = bitfield_bit32_read(intr_enable_reg, index);
457 *state = is_enabled ?
458 kDifToggleEnabled : kDifToggleDisabled;
459
460 return kDifOk;
461 }
462
463 OT_WARN_UNUSED_RESULT
464 dif_result_t dif_soc_proxy_irq_set_enabled(
465 const dif_soc_proxy_t *soc_proxy,
466 dif_soc_proxy_irq_t irq,
467 dif_toggle_t state) {
468
469 if (soc_proxy == NULL) {
470 return kDifBadArg;
471 }
472
473 bitfield_bit32_index_t index;
474 if (!soc_proxy_get_irq_bit_index(irq, &index)) {
475 return kDifBadArg;
476 }
477
478 uint32_t intr_enable_reg = mmio_region_read32(
479 soc_proxy->base_addr,
480 (ptrdiff_t)SOC_PROXY_INTR_ENABLE_REG_OFFSET);
481
482
483 bool enable_bit = (state == kDifToggleEnabled) ? true : false;
484 intr_enable_reg = bitfield_bit32_write(intr_enable_reg, index, enable_bit);
485 mmio_region_write32(
486 soc_proxy->base_addr,
487 (ptrdiff_t)SOC_PROXY_INTR_ENABLE_REG_OFFSET,
488 intr_enable_reg);
489
490
491 return kDifOk;
492 }
493
494 OT_WARN_UNUSED_RESULT
495 dif_result_t dif_soc_proxy_irq_disable_all(
496 const dif_soc_proxy_t *soc_proxy,
497 dif_soc_proxy_irq_enable_snapshot_t *snapshot) {
498
499 if (soc_proxy == NULL) {
500 return kDifBadArg;
501 }
502
503 // Pass the current interrupt state to the caller, if requested.
504 if (snapshot != NULL) {
505 *snapshot = mmio_region_read32(
506 soc_proxy->base_addr,
507 (ptrdiff_t)SOC_PROXY_INTR_ENABLE_REG_OFFSET);
508
509 }
510
511 // Disable all interrupts.
512 mmio_region_write32(
513 soc_proxy->base_addr,
514 (ptrdiff_t)SOC_PROXY_INTR_ENABLE_REG_OFFSET,
515 0u);
516
517
518 return kDifOk;
519 }
520
521 OT_WARN_UNUSED_RESULT
522 dif_result_t dif_soc_proxy_irq_restore_all(
523 const dif_soc_proxy_t *soc_proxy,
524 const dif_soc_proxy_irq_enable_snapshot_t *snapshot) {
525
526 if (soc_proxy == NULL || snapshot == NULL) {
527 return kDifBadArg;
528 }
529
530 mmio_region_write32(
531 soc_proxy->base_addr,
532 (ptrdiff_t)SOC_PROXY_INTR_ENABLE_REG_OFFSET,
533 *snapshot);
534
535
536 return kDifOk;
537 }
538