mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00

History

Jeroen Domburg a1ba660b4a change(system): heap_caps_alloc returns aligned memory if caps indicate a need for it The implicit promise of heap_alloc_caps() and friends is that the memory it returns is fit for the purpose as requested in the caps field. Before this commit, that did not happen; e.g. DMA-capable memory wass returned from a correct region, but not aligned/sized to something the DMA subsystem can handle. This commit adds an API to the esp_mm component that is then used by the heap component to adjust allocation alignment, caps and size dependent on the hardware requirement of the requested allocation caps.		2024-05-27 12:41:18 +08:00
..
main	tools: setting components to main to reduce build time	2023-04-25 15:42:22 +08:00
CMakeLists.txt	tools: setting components to main to reduce build time	2023-04-25 15:42:22 +08:00
pytest_ram_loadable_app.py	ci(p4): added todo jira for disabled tests on p4	2024-01-04 09:36:38 +08:00
README.md	change(ram_app): added --no-reset for ran_app readme	2023-12-05 11:38:35 +08:00
sdkconfig.ci.defaults	ci: add pytests for ram_loadable_app	2023-02-01 17:57:28 +08:00
sdkconfig.ci.pure_ram	ci: add pytests for ram_loadable_app	2023-02-01 17:57:28 +08:00
sdkconfig.defaults	change(system): heap_caps_alloc returns aligned memory if caps indicate a need for it	2024-05-27 12:41:18 +08:00

README.md

Supported Targets	ESP32	ESP32-C2	ESP32-C3	ESP32-C6	ESP32-H2	ESP32-P4	ESP32-S2	ESP32-S3

RAM loadable app Example

Starts a FreeRTOS task to print "Hello World". The segments of this application are fully linked and run in internal RAM.

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

How to use example

Hardware Required

This example should be able to run on any commonly available ESP32 development board.

Configure the project

idf.py menuconfig

This step is optional, the default settings in sdkconfig.defaults are already set to enable the ram_loadable app feature.

CONFIG_APP_BUILD_TYPE_RAM is enable by default so that all programs and data are linked into internal RAM. For more information about CONFIG_APP_BUILD_TYPE_RAM you can refer to the description in menuconfig.

(Enabling APP_BUILD_TYPE_PURE_RAM_APP option IDF will not compile the spi_flash related code into bin, which will save a lot of internal ram space. For esp32 target, limited by its RAM layout, the available RAM space for the app is too small to accommodate this example without this option enabled, so this option is selected by default for esp32 target.)

Build and Load to RAM

Build the project and load it to the chip's internal RAM, then run monitor tool to view serial output:

idf.py set-target {target name}

idf.py build

esptool.py -p PORT --no-stub load_ram build/ram_loadable_app.bin

idf.py -p PORT monitor --no-reset

(Replace PORT with the name of the serial port to use.)

(To exit the serial monitor, type Ctrl-].)

(For ram_loadable_app, after the chip is reset, it will start from flash by default, so the program will be executed directly after loading to ram. This is the reason why we use --no-reset. Besides, manually opening idf.py monitor will lose part of the log at startup because the serial port cannot be opened in time, so it is recommended to use a separate serial converter to monitor the output of the UART TX pin)

See the Getting Started Guide for full steps to configure and use ESP-IDF to build projects.