Espressif ESP32-S2 - Page 833

Chapter 2. API Reference
const esp_efuse_desc_t **esp_efuse_get_purpose_field(esp_efuse_block_t block)
Returns a pointer to a key purpose for an efuse key block.
To get the value of this field use esp_efuse_read_field_blob() or esp_efuse_get_key_purpose().
Parameters
• [in] block: A key block in the range EFUSE_BLK_KEY0..EFUSE_BLK_KEY_MAX
Return Pointer: If Successful returns a pointer to the corresponding efuse field otherwise NULL.
const esp_efuse_desc_t **esp_efuse_get_key(esp_efuse_block_t block)
Returns a pointer to a key block.
Return Pointer: If Successful returns a pointer to the corresponding efuse field otherwise NULL.
Parameters
• [in] block: A key block in the range EFUSE_BLK_KEY0..EFUSE_BLK_KEY_MAX
esp_err_t esp_efuse_set_key_purpose(esp_efuse_block_t block, esp_efuse_purpose_t purpose)
Sets a key purpose for an efuse key block.
Return
• ESP_OK: Successful.
• ESP_ERR_INVALID_ARG: Error in the passed arguments.
• ESP_ERR_EFUSE_REPEATED_PROG: Error repeated programming of programmed bits is
strictly forbidden.
• ESP_ERR_CODING: Error range of data does not match the coding scheme.
Parameters
• [in] block: A key block in the range EFUSE_BLK_KEY0..EFUSE_BLK_KEY_MAX
• [in] purpose: Key purpose.
esp_err_t esp_efuse_set_keypurpose_dis_write(esp_efuse_block_t block)
Sets a write protection of the key purpose field for an efuse key block.
Return
• ESP_OK: Successful.
• ESP_ERR_INVALID_ARG: Error in the passed arguments.
• ESP_ERR_EFUSE_REPEATED_PROG: Error repeated programming of programmed bits is
strictly forbidden.
• ESP_ERR_CODING: Error range of data does not match the coding scheme.
Parameters
• [in] block: A key block in the range EFUSE_BLK_KEY0..EFUSE_BLK_KEY_MAX
esp_efuse_block_t esp_efuse_find_unused_key_block(void)
Search for an unused key block and return the first one found.
See esp_efuse_key_block_unused for a description of an unused key block.
Return First unused key block, or EFUSE_BLK_KEY_MAX if no unused key block is found.
unsigned esp_efuse_count_unused_key_blocks(void)
Return the number of unused efuse key blocks in the range EFUSE_BLK_KEY0..EFUSE_BLK_KEY_MAX.
bool esp_efuse_get_digest_revoke(unsigned num_digest)
Returns the status of the Secure Boot public key digest revocation bit.
Return
• True: If key digest is revoked,
• False; If key digest is not revoked.
Parameters
• [in] num_digest: The number of digest in range 0..2
esp_err_t esp_efuse_set_digest_revoke(unsigned num_digest)
Sets the Secure Boot public key digest revocation bit.
Return
• ESP_OK: Successful.
• ESP_ERR_INVALID_ARG: Error in the passed arguments.
Espressif Systems 822
Submit Document Feedback
Release v4.4