esp_partition.h File Reference

#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>
#include "esp_err.h"

Go to the source code of this file.

Data Structures
struct	esp_partition_t

Macros
#define	ESP_PARTITION_LABEL_MAX   16

Typedefs
typedef uint32_t	esp_partition_mmap_handle_t
typedef struct esp_partition_t	esp_partition_t
typedef struct esp_partition_iterator_opaque_t *	esp_partition_iterator_t

Enumerations
enum	esp_partition_type_t {   ESP_PARTITION_TYPE_APP = 0x00 ,   ESP_PARTITION_TYPE_DATA = 0x01 ,   ESP_PARTITION_TYPE_ANY = 0xFF }
enum	esp_partition_subtype_t {   ESP_PARTITION_SUBTYPE_APP_FACTORY = 0x00 ,   ESP_PARTITION_SUBTYPE_APP_OTA_MIN = 0x10 ,   ESP_PARTITION_SUBTYPE_APP_OTA_0 = 0x10 ,   ESP_PARTITION_SUBTYPE_APP_OTA_1 = 0x11 ,   ESP_PARTITION_SUBTYPE_APP_OTA_MAX = 0x1F ,   ESP_PARTITION_SUBTYPE_APP_TEST = 0x20 ,   ESP_PARTITION_SUBTYPE_DATA_OTA = 0x00 ,   ESP_PARTITION_SUBTYPE_DATA_PHY = 0x01 ,   ESP_PARTITION_SUBTYPE_DATA_NVS = 0x02 ,   ESP_PARTITION_SUBTYPE_DATA_COREDUMP = 0x03 ,   ESP_PARTITION_SUBTYPE_DATA_NVS_KEYS = 0x04 ,   ESP_PARTITION_SUBTYPE_DATA_EFUSE_EM = 0x05 ,   ESP_PARTITION_SUBTYPE_DATA_UNDEFINED = 0x06 ,   ESP_PARTITION_SUBTYPE_DATA_ESPHTTPD = 0x80 ,   ESP_PARTITION_SUBTYPE_DATA_FAT = 0x81 ,   ESP_PARTITION_SUBTYPE_DATA_SPIFFS = 0x82 ,   ESP_PARTITION_SUBTYPE_DATA_LITTLEFS = 0x83 ,   ESP_PARTITION_SUBTYPE_ANY = 0xFF }
enum	esp_partition_mmap_memory_t {   ESP_PARTITION_MMAP_DATA = 0 ,   ESP_PARTITION_MMAP_INST = 1 }

Functions
esp_partition_iterator_t	esp_partition_find (esp_partition_type_t type, esp_partition_subtype_t subtype, const char *label)
const esp_partition_t *	esp_partition_find_first (esp_partition_type_t type, esp_partition_subtype_t subtype, const char *label)
const esp_partition_t *	esp_partition_get (esp_partition_iterator_t iterator)
esp_partition_iterator_t	esp_partition_next (esp_partition_iterator_t iterator)
void	esp_partition_iterator_release (esp_partition_iterator_t iterator)
bool	esp_partition_check_identity (const esp_partition_t *a, const esp_partition_t *b)
esp_err_t	esp_partition_read (const esp_partition_t *partition, size_t src_offset, void *dst, size_t size)
esp_err_t	esp_partition_write (const esp_partition_t *partition, size_t dst_offset, const void *src, size_t size)
esp_err_t	esp_partition_erase_range (const esp_partition_t *partition, size_t offset, size_t size)
esp_err_t	esp_partition_read_raw (const esp_partition_t *partition, size_t src_offset, void *dst, size_t size)
esp_err_t	esp_partition_write_raw (const esp_partition_t *partition, size_t dst_offset, const void *src, size_t size)
esp_err_t	esp_partition_mmap (const esp_partition_t *partition, size_t offset, size_t size, esp_partition_mmap_memory_t memory, const void **out_ptr, esp_partition_mmap_handle_t *out_handle)
void	esp_partition_munmap (esp_partition_mmap_handle_t handle)
const esp_partition_t *	esp_partition_verify (const esp_partition_t *partition)
esp_err_t	esp_partition_register_external (void *flash_chip, size_t offset, size_t size, const char *label, esp_partition_type_t type, esp_partition_subtype_t subtype, const esp_partition_t **out_partition)
esp_err_t	esp_partition_deregister_external (const esp_partition_t *partition)

Macro Definition Documentation

ESP_PARTITION_LABEL_MAX

#define ESP_PARTITION_LABEL_MAX   16

Typedef Documentation

esp_partition_mmap_handle_t

typedef uint32_t esp_partition_mmap_handle_t

esp_partition_t

typedef struct esp_partition_t esp_partition_t

esp_partition_iterator_t

typedef struct esp_partition_iterator_opaque_t* esp_partition_iterator_t

Enumeration Type Documentation

esp_partition_type_t

enum esp_partition_type_t

Enumerator
ESP_PARTITION_TYPE_APP
ESP_PARTITION_TYPE_DATA
ESP_PARTITION_TYPE_ANY

esp_partition_subtype_t

enum esp_partition_subtype_t

Enumerator
ESP_PARTITION_SUBTYPE_APP_FACTORY
ESP_PARTITION_SUBTYPE_APP_OTA_MIN
ESP_PARTITION_SUBTYPE_APP_OTA_0
ESP_PARTITION_SUBTYPE_APP_OTA_1
ESP_PARTITION_SUBTYPE_APP_OTA_MAX
ESP_PARTITION_SUBTYPE_APP_TEST
ESP_PARTITION_SUBTYPE_DATA_OTA
ESP_PARTITION_SUBTYPE_DATA_PHY
ESP_PARTITION_SUBTYPE_DATA_NVS
ESP_PARTITION_SUBTYPE_DATA_COREDUMP
ESP_PARTITION_SUBTYPE_DATA_NVS_KEYS
ESP_PARTITION_SUBTYPE_DATA_EFUSE_EM
ESP_PARTITION_SUBTYPE_DATA_UNDEFINED
ESP_PARTITION_SUBTYPE_DATA_ESPHTTPD
ESP_PARTITION_SUBTYPE_DATA_FAT
ESP_PARTITION_SUBTYPE_DATA_SPIFFS
ESP_PARTITION_SUBTYPE_DATA_LITTLEFS
ESP_PARTITION_SUBTYPE_ANY

esp_partition_mmap_memory_t

enum esp_partition_mmap_memory_t

Enumerator
ESP_PARTITION_MMAP_DATA
ESP_PARTITION_MMAP_INST

Function Documentation

esp_partition_find()

esp_partition_iterator_t esp_partition_find ( esp_partition_type_t  type, esp_partition_subtype_t  subtype, const char *  label  )

extern

esp_partition_find_first()

const esp_partition_t * esp_partition_find_first ( esp_partition_type_t  type, esp_partition_subtype_t  subtype, const char *  label  )

extern

esp_partition_get()

const esp_partition_t * esp_partition_get ( esp_partition_iterator_t  iterator )

extern

esp_partition_next()

esp_partition_iterator_t esp_partition_next ( esp_partition_iterator_t  iterator )

extern

esp_partition_iterator_release()

void esp_partition_iterator_release ( esp_partition_iterator_t  iterator )

extern

esp_partition_check_identity()

bool esp_partition_check_identity ( const esp_partition_t *  a, const esp_partition_t *  b  )

extern

esp_partition_read()

esp_err_t esp_partition_read ( const esp_partition_t *  partition, size_t  src_offset, void *  dst, size_t  size  )

extern

esp_partition_write()

esp_err_t esp_partition_write ( const esp_partition_t *  partition, size_t  dst_offset, const void *  src, size_t  size  )

extern

esp_partition_erase_range()

esp_err_t esp_partition_erase_range ( const esp_partition_t *  partition, size_t  offset, size_t  size  )

extern

esp_partition_read_raw()

esp_err_t esp_partition_read_raw ( const esp_partition_t *  partition, size_t  src_offset, void *  dst, size_t  size  )

extern

esp_partition_write_raw()

esp_err_t esp_partition_write_raw ( const esp_partition_t *  partition, size_t  dst_offset, const void *  src, size_t  size  )

extern

esp_partition_mmap()

esp_err_t esp_partition_mmap ( const esp_partition_t *  partition, size_t  offset, size_t  size, esp_partition_mmap_memory_t  memory, const void **  out_ptr, esp_partition_mmap_handle_t *  out_handle  )

extern

esp_partition_munmap()

void esp_partition_munmap ( esp_partition_mmap_handle_t  handle )

extern

esp_partition_verify()

const esp_partition_t * esp_partition_verify ( const esp_partition_t *  partition )

extern

esp_partition_register_external()

esp_err_t esp_partition_register_external ( void *  flash_chip, size_t  offset, size_t  size, const char *  label, esp_partition_type_t  type, esp_partition_subtype_t  subtype, const esp_partition_t **  out_partition  )

extern

esp_partition_deregister_external()

esp_err_t esp_partition_deregister_external ( const esp_partition_t *  partition )

extern