bootloader_common_get_sha256_of_partition() function

Calculates a sha-256 for a given partition or returns a appended digest. This function can be used to return the SHA-256 digest of application, bootloader and data partitions. For apps with SHA-256 appended to the app image, the result is the appended SHA-256 value for the app image content. The hash is verified before returning, if app content is invalid then the function returns ESP_ERR_IMAGE_INVALID. For apps without SHA-256 appended to the image, the result is the SHA-256 of all bytes in the app image. For other partition types, the result is the SHA-256 of the entire partition.

Syntax

Show:

Summary

Declaration

Definition

from bootloader_common.h:142

esp_err_t bootloader_common_get_sha256_of_partition(uint32_t address, uint32_t size, int type, uint8_t *out_sha_256);

Implemented in bootloader_common.c:143

Arguments

Argument

Description

address

Address of partition.

size

Size of partition.

type

Type of partition. For applications the type is 0, otherwise type is data.

out_sha_256

Returned SHA-256 digest for a given partition.

Return value

- ESP_OK: In case of successful operation. - ESP_ERR_INVALID_ARG: The size was 0 or the sha_256 was NULL. - ESP_ERR_NO_MEM: Cannot allocate memory for sha256 operation. - ESP_ERR_IMAGE_INVALID: App partition doesn't contain a valid app image. - ESP_FAIL: An allocation error occurred.