Software APIs
entropy_src_testutils.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#include "sw/device/lib/testing/entropy_src_testutils.h"
5
6#include "sw/device/lib/base/crc32.h"
9#include "sw/device/lib/testing/test_framework/check.h"
10
11#include "hw/top/entropy_src_regs.h" // Generated.
12
13#define MODULE_ID MAKE_MODULE_ID('e', 'n', 's')
14
15status_t entropy_src_testutils_fw_override_enable(
16 dif_entropy_src_t *entropy_src, uint8_t buffer_threshold,
17 bool route_to_firmware, bool bypass_conditioner) {
18 const dif_entropy_src_fw_override_config_t fw_override_config = {
19 .entropy_insert_enable = true,
20 .buffer_threshold = buffer_threshold,
21 };
22 TRY(dif_entropy_src_fw_override_configure(entropy_src, fw_override_config,
24
25 const dif_entropy_src_config_t config = {
26 .fips_enable = true,
27 .fips_flag = true,
28 .rng_fips = true,
29 .route_to_firmware = route_to_firmware,
30 .bypass_conditioner = bypass_conditioner,
31 .clear_esfinal_fifo_while_disabled = true,
32 .single_bit_mode = kDifEntropySrcSingleBitModeDisabled,
33 .health_test_threshold_scope = false,
34 .health_test_window_size = 0x0200,
35 .alert_threshold = 2,
36 };
37 TRY(dif_entropy_src_configure(entropy_src, config, kDifToggleEnabled));
38 return OK_STATUS();
39}
40
41status_t entropy_src_testutils_wait_for_state(
42 const dif_entropy_src_t *entropy_src, dif_entropy_src_main_fsm_t state) {
44
45 do {
46 TRY(dif_entropy_src_get_main_fsm_state(entropy_src, &cur_state));
47 } while (cur_state != state);
48 return OK_STATUS();
49}
50
51status_t entropy_src_testutils_drain_observe_fifo(
52 dif_entropy_src_t *entropy_src) {
53 // This value is arbitrary, it could be 1 but since there is some
54 // overhead in dif_entropy_src_observe_fifo_nonblocking_read, it's better
55 // to read several words every time to drain the FIFO quickly.
56 const size_t kDrainCount = 32;
57 size_t len;
58 // Read from the FIFO until we get a short read which means that the FIFO was
59 // emptied.
60 do {
61 len = kDrainCount;
62 TRY(dif_entropy_src_observe_fifo_nonblocking_read(entropy_src, NULL, &len));
63 } while (len == kDrainCount);
64
65 return OK_STATUS();
66}
67
68status_t entropy_src_testutils_disable_health_tests(
69 dif_entropy_src_t *entropy_src) {
70 static dif_entropy_src_test_t kHealthTest[] = {
77 for (size_t i = 0; i < ARRAYSIZE(kHealthTest); i++) {
78 TRY(dif_entropy_src_health_test_configure(
79 entropy_src,
80 (dif_entropy_src_health_test_config_t){.test_type = kHealthTest[i],
81 .high_threshold = 0xffff,
82 .low_threshold = 0}));
83 }
84
85 return OK_STATUS();
86}
87
88uint32_t entropy_src_config_crc32(dif_entropy_src_t *entropy_src) {
89 uint32_t ctx;
90 crc32_init(&ctx);
91
92 // Health test thresholds.
93 crc32_add32(&ctx,
94 mmio_region_read32(entropy_src->base_addr,
95 ENTROPY_SRC_REPCNT_THRESHOLD_REG_OFFSET));
96 crc32_add32(&ctx,
97 mmio_region_read32(entropy_src->base_addr,
98 ENTROPY_SRC_REPCNTS_THRESHOLD_REG_OFFSET));
99 crc32_add32(&ctx,
100 mmio_region_read32(entropy_src->base_addr,
101 ENTROPY_SRC_ADAPTP_HI_THRESHOLD_REG_OFFSET));
102 crc32_add32(&ctx,
103 mmio_region_read32(entropy_src->base_addr,
104 ENTROPY_SRC_ADAPTP_LO_THRESHOLD_REG_OFFSET));
105 crc32_add32(&ctx,
106 mmio_region_read32(entropy_src->base_addr,
107 ENTROPY_SRC_ADAPTPS_THRESHOLD_REG_OFFSET));
108 crc32_add32(&ctx,
109 mmio_region_read32(entropy_src->base_addr,
110 ENTROPY_SRC_BUCKET_THRESHOLD_REG_OFFSET));
111 crc32_add32(&ctx,
112 mmio_region_read32(entropy_src->base_addr,
113 ENTROPY_SRC_MARKOV_HI_THRESHOLD_REG_OFFSET));
114 crc32_add32(&ctx,
115 mmio_region_read32(entropy_src->base_addr,
116 ENTROPY_SRC_MARKOV_LO_THRESHOLD_REG_OFFSET));
117 crc32_add32(&ctx,
118 mmio_region_read32(entropy_src->base_addr,
119 ENTROPY_SRC_EXTHT_HI_THRESHOLD_REG_OFFSET));
120 crc32_add32(&ctx,
121 mmio_region_read32(entropy_src->base_addr,
122 ENTROPY_SRC_EXTHT_LO_THRESHOLD_REG_OFFSET));
123
124 // Alert threshold.
125 crc32_add32(&ctx, mmio_region_read32(entropy_src->base_addr,
126 ENTROPY_SRC_ALERT_THRESHOLD_REG_OFFSET));
127
128 return crc32_finish(&ctx);
129}