Skip to content

[esp32] Document disable_libc_locks_in_iram option #5425

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

Draft
wants to merge 1 commit into
base: next
Choose a base branch
from
Draft

[esp32] Document disable_libc_locks_in_iram option #5425

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions content/components/esp32.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,10 @@ LWIP (Lightweight IP) behavior. Some options improve performance while others sa
- **enable_lwip_check_thread_safety** (*Optional*, boolean): Enable LWIP thread safety checks to detect incorrect usage of
the TCP/IP stack from multiple threads. This helps catch thread safety issues when core locking is enabled. Defaults to `true`.

- **disable_libc_locks_in_iram** (*Optional*, boolean): Disable placing libc lock functions in IRAM. This saves approximately
1.6KB of IRAM by placing these functions in flash memory instead. This is safe for ESPHome since no IRAM interrupt service
routines (ISRs that run while cache is disabled) use libc lock APIs. Defaults to `true` (IRAM placement disabled to save RAM).

Some options can be disabled to save flash memory without affecting typical ESPHome functionality. The performance
options (defaulting to `true` ) improve socket operation performance but can be disabled if you need better
multi-threaded scalability (which is uncommon since ESPHome uses an event loop).
Expand All @@ -182,6 +186,7 @@ esp32:
enable_lwip_check_thread_safety: true # Thread safety validation

# Memory saving options
disable_libc_locks_in_iram: true # Enabled by default, saves 1.6KB IRAM
enable_lwip_dhcp_server: false # Disabled by default, only needed for AP mode
enable_lwip_mdns_queries: false # Enabled by default, can disable if not using .local hostnames
enable_lwip_bridge_interface: false # Disabled by default
Expand Down