231dc0e884
Drivers that allocate from the unencrypted PSRAM carve-out via MALLOC_CAP_SPIRAM_NO_ENC currently have no way to verify after the fact which pool a buffer came from. This is particularly relevant for callers using heap_caps_malloc_prefer(MALLOC_CAP_SPIRAM_NO_ENC, MALLOC_CAP_SPIRAM), where a silent fallback to encrypted PSRAM would still pass the typical esp_ptr_external_ram() check. Expose esp_psram_ptr_is_no_enc() in the public esp_psram.h header. It performs a range check against the carve-out's virtual-address window and returns false when PSRAM is not initialized or CONFIG_SPIRAM_ENC_EXEMPT is disabled, so callers do not need to guard the call site with #if. Also reference the helper from the External RAM documentation alongside the heap_caps_malloc(MALLOC_CAP_SPIRAM_NO_ENC) usage example.
Documentation Source Folder
This folder contains source files of ESP-IDF documentation available in English and Chinese.
The sources do not render well in GitHub and some information is not visible without building the documentation.
Use the actual documentation, which is generated within about 20 minutes of each commit:
Hosted Documentation
- English: https://docs.espressif.com/projects/esp-idf/en/latest/
- Chinese: https://docs.espressif.com/projects/esp-idf/zh_CN/latest/
After clicking any link to ESP-IDF Programming Guide, go to the top of the sidebar, then make sure you have the correct Espressif chip (target) and ESP-IDF version selected in the dropdown menus. You can also find a link at the bottom right to download the HTML version as a zip for offline reading.
Building Documentation
The documentation is built using the Python package esp-docs, which can be installed by running:
pip install esp-docs
For a summary of available options, run:
build-docs --help
For more information, see the esp-docs documentation at https://github.com/espressif/esp-docs/blob/master/README.md