esp_ota_get_partition_description() function

Pointer to app partition. (only app partition)

Structure of info about app.

Read data from the partition Partitions marked with an encryption flag will automatically be be read and decrypted via a cache mapping.

Erase part of the partition

Write data to the partition Before writing data to flash, corresponding region of flash needs to be erased. This can be done using esp_partition_erase_range function. Partitions marked with an encryption flag will automatically be written via the esp_flash_write_encrypted() function. If writing to an encrypted partition, all write offsets and lengths must be multiples of 16 bytes. See the esp_flash_write_encrypted() function for more details. Unencrypted partitions do not have this restriction.

Get SHA-256 digest for required partition. 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.

Configure MMU to map partition into data memory Unlike spi_flash_mmap function, which requires a 64kB aligned base address, this function doesn't impose such a requirement. If offset results in a flash address which is not aligned to 64kB boundary, address will be rounded to the lower 64kB boundary, so that mapped region includes requested range. Pointer returned via out_ptr argument will be adjusted to point to the requested offset (not necessarily to the beginning of mmap-ed region). To release mapped memory, pass handle returned via out_handle argument to esp_partition_munmap function.

Read data from the partition without any transformation/decryption.

Write data to the partition without any transformation/encryption. Before writing data to flash, corresponding region of flash needs to be erased. This can be done using esp_partition_erase_range function.

Commence an OTA update writing to the specified partition. The specified partition is erased to the specified image size. If image size is not yet known, pass OTA_SIZE_UNKNOWN which will cause the entire partition to be erased. On success, this function allocates memory that remains in use until esp_ota_end() is called with the returned handle. Note: If the rollback option is enabled and the running application has the ESP_OTA_IMG_PENDING_VERIFY state then it will lead to the ESP_ERR_OTA_ROLLBACK_INVALID_STATE error. Confirm the running app before to run download a new app, use esp_ota_mark_app_valid_cancel_rollback() function for it (this should be done as early as possible when you first download a new application).

Configure OTA data for a new boot partition

Return the next OTA app partition which should be written with a new firmware. Call this function to find an OTA app partition which can be passed to esp_ota_begin(). Finds next partition round-robin, starting from the current running partition.

Verify partition data Given a pointer to partition data, verify this partition exists in the partition table (all fields match.) This function is also useful to take partition data which may be in a RAM buffer and convert it to a pointer to the permanent partition data stored in flash. Pointers returned from this function can be compared directly to the address of any pointer returned from esp_partition_get(), as a test for equality.

Mount WL for defined partition

Returns state for given partition.

Register a partition on an external flash chip This API allows designating certain areas of external flash chips (identified by the esp_flash_t structure) as partitions. This allows using them with components which access SPI flash through the esp_partition API.

Copy partition_name to mPartitionName and initialize mESPPartition.

Returns the description structure of the bootloader.

Deregister the partition previously registered using esp_partition_register_external

Copy data from a source partition at a specific offset to a destination partition at a specific offset. The destination offset must be aligned to the flash sector size (SPI_FLASH_SEC_SIZE = 0x1000). If "size" is SIZE_MAX, the entire destination partition (from dest_offset onward) will be erased, and the function will copy all of the source partition starting from src_offset into the destination. The function ensures that the destination partition is erased on sector boundaries (erase size is aligned up SPI_FLASH_SEC_SIZE). This function does the following: - erases the destination partition from dest_offset to the specified size (or the whole partition if "size" == SIZE_MAX), - maps data from the source partition in chunks, - writes the source data into the destination partition in corresponding chunks.

Check for the identity of two partitions by SHA-256 digest.

Initialize NVS flash storage for the partition specified by partition pointer.

Erase custom partition. Erase all content of specified custom partition.

Generate and store NVS keys in the provided esp partition

Read NVS security configuration from a partition.