Skip to content

[esp32_hosted] Document use_psram option #6688

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
swoboda1337 wants to merge 2 commits into
base: next
Choose a base branch
from
+8 −0
Open

[esp32_hosted] Document use_psram option #6688

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
03a94fc
[esp32_hosted] Document use_psram option
swoboda1337 May 25, 2026
cf2994c
[esp32_hosted] Clarify use_psram PSRAM requirement and transport asse…
swoboda1337 May 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/content/docs/components/esp32_hosted.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,10 @@ wifi:
- **sdio_frequency** (*Optional*, frequency): Set the speed of communication between the host and
the co-processor. If you experience loss of communication, or reboots, then try reducing this value.
The value can be between 400kHz and 50MHz, with a default of 40MHz.
- **use_psram** (*Optional*, boolean): Place the SDIO transport buffer pool in PSRAM instead of
internal RAM. Requires the host MCU to have DMA-capable PSRAM enabled (ESP32-P4, ESP32-S3).
Recommended when the host firmware uses most of internal RAM (for example, a large LVGL UI);
without it, boot can fail with an `sdio_mempool_create` assert. Defaults to `false`.

## SPI Transport

Expand Down Expand Up @@ -110,6 +114,10 @@ wifi:
- **frequency** (*Optional*, frequency): The SPI clock frequency. Maximum depends on variant: 10MHz for ESP32, 40MHz for all other variants. Defaults to the maximum for each variant.
- **handshake_active_high** (*Optional*, boolean): Polarity of the handshake signal. Defaults to `true`.
- **data_ready_active_high** (*Optional*, boolean): Polarity of the data ready signal. Defaults to `true`.
- **use_psram** (*Optional*, boolean): Place the SPI transport buffer pool in PSRAM instead of
internal RAM. Requires the host MCU to have DMA-capable PSRAM enabled (ESP32-P4, ESP32-S3).
Recommended when the host firmware uses most of internal RAM (for example, a large LVGL UI);
without it, boot can fail with an `spi_mempool_create` assert. Defaults to `false`.

## Updating co-processor firmware

Expand Down