Crate esp_bootloader_esp_idf

Source
Expand description

§Bootloader Support Library supplementing esp-hal

§Overview

This crate contains functionality related to the ESP-IDF 2nd stage bootloader.

  • populating the application-descriptor
  • read the partition table
  • conveniently use a partition to read and write flash contents

§Additional configuration

We’ve exposed some configuration options that don’t fit into cargo features. These can be set via environment variables, or via cargo’s [env] section inside .cargo/config.toml. Below is a table of tunable parameters for this crate:

NameDescriptionDefault valueAllowed value

ESP_BOOTLOADER_ESP_IDF_CONFIG_MMU_PAGE_SIZE

⚠️ Unstable

ESP32-C2, ESP32-C6 and ESP32-H2 support configurable page sizes. This is currently only used to populate the app descriptor.

64k
One of:
  • 8k
  • 16k
  • 32k
  • 64k

ESP_BOOTLOADER_ESP_IDF_CONFIG_ESP_IDF_VERSION

⚠️ Unstable

ESP-IDF version used in the application descriptor. Currently it’s not checked by the bootloader.

0.0.0

ESP_BOOTLOADER_ESP_IDF_CONFIG_PARTITION_TABLE_OFFSET

⚠️ Unstable

The address of partition table (by default 0x8000). Allows you to move the partition table, it gives more space for the bootloader. Note that the bootloader and app will both need to be compiled with the same PARTITION_TABLE_OFFSET value.

32768
Positive integer

§Feature Flags

  • validation (enabled by default) — Enable MD5 validation of the partition table.
  • log — Enable support for the log crate
  • defmt — Enable support for defmt

Modules§

ota
Over The Air Updates (OTA)
partitions
Partition Table Support

Macros§

esp_app_desc
This macro populates the application descriptor (see EspAppDesc) which is available as a static named ESP_APP_DESC

Structs§

EspAppDesc
ESP-IDF compatible application descriptor

Constants§

BUILD_DATE
Build date
BUILD_TIME
Build time
ESP_IDF_COMPATIBLE_VERSION
The (pretended) ESP-IDF version
MMU_PAGE_SIZE
MMU page size in bytes