Chapter 2. API Reference
(continued from previous page)
BLOCK_KEY0 (BLOCK4 ) [4 ] read_regs: 00000000 00000000␣
,→00000000 00000000 00000000 00000000 00000000 00000000
BLOCK_KEY1 (BLOCK5 ) [5 ] read_regs: 00000000 00000000␣
,→00000000 00000000 00000000 00000000 00000000 00000000
BLOCK_KEY2 (BLOCK6 ) [6 ] read_regs: 00000000 00000000␣
,→00000000 00000000 00000000 00000000 00000000 00000000
BLOCK_KEY3 (BLOCK7 ) [7 ] read_regs: 00000000 00000000␣
,→00000000 00000000 00000000 00000000 00000000 00000000
BLOCK_KEY4 (BLOCK8 ) [8 ] read_regs: 00000000 00000000␣
,→00000000 00000000 00000000 00000000 00000000 00000000
BLOCK_KEY5 (BLOCK9 ) [9 ] read_regs: 00000000 00000000␣
,→00000000 00000000 00000000 00000000 00000000 00000000
BLOCK_SYS_DATA2 (BLOCK10 ) [10] read_regs: 00000000 00000000␣
,→00000000 00000000 00000000 00000000 00000000 00000000
espefuse.py v3.1-dev
Header File
• components/efuse/include/esp_efuse.h
Functions
esp_err_t esp_efuse_read_field_blob(const esp_efuse_desc_t *field[], void *dst, size_t
dst_size_bits)
Reads bits from EFUSE field and writes it into an array.
The number of read bits will be limited to the minimum value from the description of the bits in “field”
structure or“dst_size_bits”required size. Use“esp_efuse_get_field_size()”function to determine the length
of the field.
Note Please note that reading in the batch mode does not show uncommitted changes.
Return
• ESP_OK: The operation was successfully completed.
• ESP_ERR_INVALID_ARG: Error in the passed arguments.
Parameters
• [in] field: A pointer to the structure describing the fields of efuse.
• [out] dst: A pointer to array that will contain the result of reading.
• [in] dst_size_bits: The number of bits required to read. If the requested number of bits
is greater than the field, the number will be limited to the field size.
bool esp_efuse_read_field_bit(const esp_efuse_desc_t *field[])
Read a single bit eFuse field as a boolean value.
Note The value must exist and must be a single bit wide. If there is any possibility of an error in the provided
arguments, call esp_efuse_read_field_blob() and check the returned value instead.
Note If assertions are enabled and the parameter is invalid, execution will abort
Note Please note that reading in the batch mode does not show uncommitted changes.
Return
• true: The field parameter is valid and the bit is set.
• false: The bit is not set, or the parameter is invalid and assertions are disabled.
Parameters
• [in] field: A pointer to the structure describing the fields of efuse.
esp_err_t esp_efuse_read_field_cnt(const esp_efuse_desc_t *field[], size_t *out_cnt)
Reads bits from EFUSE field and returns number of bits programmed as “1”.
If the bits are set not sequentially, they will still be counted.
Note Please note that reading in the batch mode does not show uncommitted changes.
Return
• ESP_OK: The operation was successfully completed.
• ESP_ERR_INVALID_ARG: Error in the passed arguments.
Espressif Systems 815
Submit Document Feedback
Release v4.4