Commit Graph
75 Commits
Author SHA1 Message Date
wuzhenghui d3c628c759 change(heap): reserve DMA pool with low priority MALLOC_CAP_DEFAULT caps 2026-07-09 17:31:43 +08:00
Mahavir Jain 9dd7a89fde docs(esp_psram): mirror carve-out review-feedback updates in zh_CN
Mirror the recent EN-side updates in the Chinese External RAM guide:

- Replace "PSRAM 顶部" with "PSRAM 上端(最高物理地址区)" to match the
  clarified wording on the EN side.
- Add the verification-helper pointer next to the heap_caps_malloc
  example so Chinese readers also learn about esp_psram_ptr_is_no_enc().

Also drop the :cpp:func: cross-reference for esp_psram_ptr_is_no_enc on
the EN side: esp_psram.h is not in any chip-specific Doxyfile, so
Sphinx/Breathe cannot resolve the reference. Use a plain inline code
literal instead, matching the existing reference style for
esp_psram_get_size and other esp_psram functions in the docs.
2026-05-21 20:54:31 +05:30
Mahavir Jain 77e85b886a docs(esp_psram): clarify carve-out location is at upper end of PSRAM
The previous wording "top of PSRAM" was ambiguous: the carve-out is
actually mapped at the highest physical addresses of PSRAM (after the
rodata, text, and main heap mappings). Update the Kconfig help text for
SPIRAM_ENC_EXEMPT and SPIRAM_ENC_EXEMPT_SIZE, the External RAM
documentation, and the internal layout comment to say "upper end of PSRAM
(highest physical addresses)" instead.
2026-05-21 20:54:31 +05:30
Mahavir Jain ef7192fc73 feat(esp_psram): add esp_psram_ptr_is_no_enc() helper
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.
2026-05-21 20:54:31 +05:30
Mahavir Jain 10d2d9cb9f docs(esp_psram): document MALLOC_CAP_SPIRAM_NO_ENC carve-out
Extends the External RAM encryption section to describe
CONFIG_SPIRAM_ENC_EXEMPT and the MALLOC_CAP_SPIRAM_NO_ENC heap
capability, including a security warning and a typical DMA-alignment
use case. Mirrors the change in zh_CN.
2026-05-21 20:54:30 +05:30
Marius Vikhammer 430b404637 Merge branch 'fix/issue-18391-psram-default-docs_v6.0' into 'release/v6.0'
docs: clarify PSRAM default allocation behavior (v6.0)

See merge request espressif/esp-idf!47053
2026-04-29 11:22:07 +08:00
Mahavir Jain 64c744abb7 docs: update PSRAM and flash encryption docs with per-page and separate key capabilities 2026-04-02 12:20:24 +05:30
Marius Vikhammer d09e551417 docs: clarify PSRAM default allocation behavior
Clarify that MALLOC_CAP_DEFAULT describes a memory capability
rather than the malloc() placement policy, so PSRAM-backed
capability allocations are documented correctly when malloc()
remains internal-only by default.

Closes https://github.com/espressif/esp-idf/issues/18391

Made-with: Cursor
2026-03-27 10:05:28 +08:00
luweike 3a2185b5e8 docs: Update external RAM voltage control for ESP32-S2/S3 2025-09-01 15:15:42 +08:00
Zhang Shuxian 7462166a8d docs: Provide translation for toolchain 2025-07-01 14:23:00 +08:00
Zhang Shuxian a6fdc2677e docs: Update CN translation for minimal build documentation 2025-01-17 16:10:48 +08:00
Frantisek Hrbata 90ca881dab docs: improve minimal build documentation
Follow-up improvements to the minimal build documentation.

Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
2025-01-16 18:24:14 +08:00
Frantisek Hrbata e0113d81d2 docs(build_system): describe MINIMAL_BUILD build property
Include a description of the MINIMAL_BUILD property, which serves as a
shortcut for set(COMPONENTS main). Additionally, add a note to the
relevant components indicating that they must be included in the build
to allow for their configuration.

Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
2024-11-20 20:14:40 +01:00
morris 709fbf0a19 Merge branch 'docs/update_pthread_cn' into 'master'
docs: Update the CN translation for pthread.rst/ota ‎.rst‎

Closes DOC-8536 and DOC-9081

See merge request espressif/esp-idf!32531
2024-10-12 18:45:24 +08:00
morris aebf700919 refactor(freertos): rename SPIRAM_ALLOW_STACK_EXTERNAL_MEMORY and move to freertos 2024-10-09 13:32:03 +08:00
shenmengjing c0f296dafc docs: Update the CN translation for several docs 2024-09-29 10:53:29 +08:00
Armando 6c4fb48783 doc(psram): clarify why psram speed is faster than flash 2024-09-14 11:13:20 +08:00
Chen Jichang 057b6b72ba docs(psram): sync psram noinit description 2024-09-06 14:30:54 +08:00
Chen Jichang 1c1f536235 feat(psram): add psram noinit segment support on S2/S3/P4/C5
Closes https://github.com/espressif/esp-idf/issues/14253
2024-08-21 12:13:16 +08:00
Linda e5019c9da0 docs: update application examples related to system 2024-08-16 16:16:58 +08:00
Armando 702b0560ab change(psram): improved xip psram docs on p4 2024-07-26 16:30:46 +08:00
Zhang Shuxian 08eecfee22 docs: Implement comments 2024-07-03 10:23:23 +08:00
Armando 10d3912c70 feat(xip_psram): support xip psram feature on esp32p4 2024-05-22 15:56:07 +08:00
Marius Vikhammer f1e65b8373 docs(misc): fixed typos found with codespell 2024-03-28 11:50:58 +08:00
morris cf59c00564 change(mpll): clean up mpll clock acquire with ldo driver 2024-03-25 22:03:49 +08:00
Jakob Hasse 1deef8bee9 docs(heap): Fixed mistake in the heap allocator docs
Closes https://github.com/espressif/esp-idf/issues/13353
2024-03-12 10:24:35 +08:00
Kapil Gupta 685fcf4278 Merge branch 'feature/supplicant_bss_extmem' into 'master'
WiFi: Add support to move supplicant BSS to external memory

See merge request espressif/esp-idf!27891
2024-01-11 15:55:14 +08:00
mofeifei 009e6945aa docs: Updated cn trans for esp_http_client and external_ram 2024-01-02 16:06:03 +08:00
Armando 7e0f298608 change(psram): update doc about ldo 2023-12-26 11:43:33 +08:00
Armando 92e19af4ea doc(psram): updated voltage supply for psram programming guide 2023-12-18 15:18:07 +08:00
Kapil Gupta 36c38943c8 fix(wifi): Add support to move supplicant BSS to external memory 2023-12-13 16:07:13 +00:00
renpeiying f341f04146 docs: Update Chinese translation for external-ram.rst and kconfig.rst 2023-10-18 16:02:04 +08:00
Armando f519e036eb doc(psram): updated psram programming guide to esp32p4 2023-10-12 19:36:21 +08:00
Cai Xin Ying 2fac98d2e0 docs:update format issues for files under api-guides 2023-09-07 15:26:05 +08:00
Cai Xin Ying 29f3221b56 Merge branch 'docs/add_Chinese_translation_for_linux-host-requirements.rst_and_external-ram-esp32-notes.rst' into 'master'
docs: provide CN translation for linux-host-requirements.rst and external-ram-esp32-notes.rst

Closes DOC-5412

See merge request espressif/esp-idf!24115
2023-06-28 20:03:49 +08:00
caixinying-git a33b276671 docs: provide CN translation for linux-host-requirements.rst and external-ram-esp32-notes.rst 2023-06-28 16:42:17 +08:00
Mo Fei Fei 85970f8cf7 Docs: update CN translation for external-ram.rst 2023-06-20 10:45:23 +08:00
Armando 9c1b38d061 psram: remove reference to spi ram, use PSRAM instead as the reference to the physical memory 2023-06-14 19:43:56 +08:00
Armando 043a8f93f7 psram: fixed wrong virtual address for PSRAM in external-ram.rst 2023-06-14 19:29:12 +08:00
Armando 0b1f773517 doc: update s3 psram vaddr max range size 2023-05-19 09:05:59 +00:00
Mo Fei Fei 0d2549a4f1 Docs: update CN translation for esp_http_client.rst, external-ram.rst, bootloader.rst 2023-04-19 10:37:49 +08:00
Armando 384b3bdc60 docs: update external ram programming guide edma chapter 2023-04-03 10:30:50 +08:00
Wang Zi Yan c85a19edbf docs: update translation for external-ram 2022-10-26 17:02:10 +08:00
gaoxu 2cb2ff99af docs: add description about flash content moved to psram feature 2022-10-11 15:15:04 +08:00
Marius Vikhammer 342f4f315c psram: make SPIRAM_ALLOW_STACK_EXTERNAL_MEMORY configurable on S2 and S3
SPIRAM_ALLOW_STACK_EXTERNAL_MEMORY was always enabled on S2 and S3, but this option is not
compatible with ESP_COREDUMP_ENABLE_TO_FLASH. Make it configurable to allow users to deactive
it so that ESP_COREDUMP_ENABLE_TO_FLASH can be used.
2022-07-06 12:11:15 +08:00
Armando b5de3ec953 esp_common: rename EXT_RAM_ATTR to EXT_RAM_BSS_ATTR to make it clearer
EXT_RAM_ATTR is deprecated. To put .bss on PSRAM, use this new macro EXT_RAM_BSS_ATTR
2022-04-19 19:48:00 +08:00
Armando f8249550f8 psram: support .bss on psram on esp32s3 2022-04-19 19:48:00 +08:00
Marius Vikhammer 36ef485c4e soc: support placing task stacks in external memory for S2 and S3 2022-03-04 15:25:52 +08:00
Shang Zhou 4d9db3382e docs: add note for MALLOC_CAP_DMA for ESP32-S2 according to customer feedback 2022-03-02 16:57:21 +08:00
daiziyan 9e7f31337d docs: updated CN trans for memory-types and external-ram 2022-01-08 15:21:17 +08:00