Chapter 2. API Reference
• ESP_ERR_INVALID_ARG if the partition comes from the partition table
• ESP_ERR_INVALID_ARG if the partition was not registered using esp_partition_register_external
function.
Parameters
• partition: pointer to the partition structure obtained from esp_partition_register_external,
Structures
struct esp_partition_t
partition information structure
This is not the format in flash, that format is esp_partition_info_t.
However, this is the format used by this API.
Public Members
esp_flash_t *flash_chip
SPI flash chip on which the partition resides
esp_partition_type_t type
partition type (app/data)
esp_partition_subtype_t subtype
partition subtype
uint32_t address
starting address of the partition in flash
uint32_t size
size of the partition, in bytes
char label[17]
partition label, zero-terminated ASCII string
bool encrypted
flag is set to true if partition is encrypted
Macros
ESP_PARTITION_SUBTYPE_OTA(i)
Convenience macro to get esp_partition_subtype_t value for the i-th OTA partition.
Type Definitions
typedef struct esp_partition_iterator_opaque_ *esp_partition_iterator_t
Opaque partition iterator type.
Enumerations
enum esp_partition_type_t
Partition type.
Note Partition types with integer value 0x00-0x3F are reserved for partition types defined by ESP-IDF. Any
other integer value 0x40-0xFE can be used by individual applications, without restriction.
Values:
ESP_PARTITION_TYPE_APP = 0x00
Application partition type.
ESP_PARTITION_TYPE_DATA = 0x01
Data partition type.
Espressif Systems 761
Submit Document Feedback
Release v4.4
To Next Page
Loading...