Marius Vikhammer 8efb2bb1ed ci: run Example_GENERIC for C3 4 years ago
..
main 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 years ago
CMakeLists.txt 9459526e50 examples: Add partition API examples 7 years ago
Makefile 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 years ago
README.md 9459526e50 examples: Add partition API examples 7 years ago
partition_mmap_example_test.py 8efb2bb1ed ci: run Example_GENERIC for C3 4 years ago
partitions_example.csv 26800ed71e global: update note in the partition tables 6 years ago
sdkconfig.defaults 3c63f49591 examples: remove non-existent options from sdkconfig.defaults 6 years ago

README.md

Partition Memory Map Example

This example demonstrates how to use esp_partition_mmap to configure MMU and map a partition into memory address space for read operations.

Example Flow

The example uses a custom partition table, with a data partition storage used for demonstration. Before mapping this partition to memory, data is written to the partition used for verification.

The partition API function esp_partition_mmap is used to get a pointer to the mapped memory region and a handle to the mapping. The pointer is used to transparently read back the verification data written previously. Once the data written and read are verified to be the same, the function spi_flash_munmap is used to release the mapping.

Output

I (309) example: Written sample data to partition: ESP-IDF Partition Memory Map Example
I (309) example: Mapped partition to data memory address 0x3f410000
I (319) example: Read sample data from partition using mapped memory: ESP-IDF Partition Memory Map Example
I (329) example: Data matches
I (329) example: Unmapped partition from data memory
I (339) example: Example end

Others

Detailed functional description of partition API is provided in documentation.

See the README.md file in the upper level 'examples' directory for more information about examples.