Software APIs
Data Fields
entropy_src_config Struct Reference

Entropy source configuration settings. More...

Data Fields

multi_bit_bool_t fips_enable
 If set, FIPS compliant entropy will be generated by this module after being processed by an SP 800-90B compliant conditioning function.
 
multi_bit_bool_t fips_flag
 If set, the produced output entropy is marked as FIPS compliant through the FIPS bit being set to high.
 
multi_bit_bool_t rng_fips
 If set, the noise source is instructed to produce high quality entropy.
 
multi_bit_bool_t route_to_firmware
 If set, entropy will be routed to a firmware-visible register instead of being distributed to other hardware IPs.
 
multi_bit_bool_t bypass_conditioner
 If set, raw entropy will be sent to CSRNG, bypassing the conditioner block and disabling the FIPS hardware generated flag.
 
multi_bit_bool_t single_bit_mode
 Enables single bit entropy mode.
 
uint16_t fips_test_window_size
 The size of the window used for health tests.
 
uint16_t alert_threshold
 The number of health test failures that must occur before an alert is triggered. More...
 
uint16_t repcnt_threshold
 Repetition count test threshold.
 
uint16_t repcnts_threshold
 Repetition count symbol test threshold.
 
uint16_t adaptp_hi_threshold
 Adaptive proportion test high threshold.
 
uint16_t adaptp_lo_threshold
 Adaptive proportion test low threshold.
 
uint16_t bucket_threshold
 Bucket test threshold.
 
uint16_t markov_hi_threshold
 Markov test high threshold.
 
uint16_t markov_lo_threshold
 Markov test low threshold.
 
uint16_t extht_hi_threshold
 External health test high threshold.
 
uint16_t extht_lo_threshold
 External health test low threshold.
 

Detailed Description

Entropy source configuration settings.

Definition at line 117 of file entropy.c.

Field Documentation

◆ adaptp_hi_threshold

uint16_t entropy_src_config::adaptp_hi_threshold

Adaptive proportion test high threshold.

Definition at line 166 of file entropy.c.

◆ adaptp_lo_threshold

uint16_t entropy_src_config::adaptp_lo_threshold

Adaptive proportion test low threshold.

Definition at line 170 of file entropy.c.

◆ alert_threshold

uint16_t entropy_src_config::alert_threshold

The number of health test failures that must occur before an alert is triggered.

When set to 0, alerts are disabled.

Definition at line 154 of file entropy.c.

◆ bucket_threshold

uint16_t entropy_src_config::bucket_threshold

Bucket test threshold.

Definition at line 174 of file entropy.c.

◆ bypass_conditioner

multi_bit_bool_t entropy_src_config::bypass_conditioner

If set, raw entropy will be sent to CSRNG, bypassing the conditioner block and disabling the FIPS hardware generated flag.

Definition at line 141 of file entropy.c.

◆ extht_hi_threshold

uint16_t entropy_src_config::extht_hi_threshold

External health test high threshold.

Definition at line 186 of file entropy.c.

◆ extht_lo_threshold

uint16_t entropy_src_config::extht_lo_threshold

External health test low threshold.

Definition at line 190 of file entropy.c.

◆ fips_enable

multi_bit_bool_t entropy_src_config::fips_enable

If set, FIPS compliant entropy will be generated by this module after being processed by an SP 800-90B compliant conditioning function.

Definition at line 122 of file entropy.c.

◆ fips_flag

multi_bit_bool_t entropy_src_config::fips_flag

If set, the produced output entropy is marked as FIPS compliant through the FIPS bit being set to high.

Definition at line 127 of file entropy.c.

◆ fips_test_window_size

uint16_t entropy_src_config::fips_test_window_size

The size of the window used for health tests.

Definition at line 149 of file entropy.c.

◆ markov_hi_threshold

uint16_t entropy_src_config::markov_hi_threshold

Markov test high threshold.

Definition at line 178 of file entropy.c.

◆ markov_lo_threshold

uint16_t entropy_src_config::markov_lo_threshold

Markov test low threshold.

Definition at line 182 of file entropy.c.

◆ repcnt_threshold

uint16_t entropy_src_config::repcnt_threshold

Repetition count test threshold.

Definition at line 158 of file entropy.c.

◆ repcnts_threshold

uint16_t entropy_src_config::repcnts_threshold

Repetition count symbol test threshold.

Definition at line 162 of file entropy.c.

◆ rng_fips

multi_bit_bool_t entropy_src_config::rng_fips

If set, the noise source is instructed to produce high quality entropy.

Definition at line 131 of file entropy.c.

◆ route_to_firmware

multi_bit_bool_t entropy_src_config::route_to_firmware

If set, entropy will be routed to a firmware-visible register instead of being distributed to other hardware IPs.

Definition at line 136 of file entropy.c.

◆ single_bit_mode

multi_bit_bool_t entropy_src_config::single_bit_mode

Enables single bit entropy mode.

Definition at line 145 of file entropy.c.