mirror of
https://github.com/liquidraver/ZephCore.git
synced 2026-10-15 17:19:55 +00:00
ESP32 light sleep (devdocs/lld/13-power-management.md)
Light sleep on the S3 repeaters never worked as designed, for two
independent reasons:
- No S3 repeater ever slept. Every one carries WiFi OTA, the WiFi
driver starts WiFi at boot (NULL mode), and a started WiFi library
holds its modem PM lock. Measured on the XIAO: zero sleep entries
with WiFi compiled in. helpers/pm_esp32_wake.c now stops WiFi at
boot on PM builds; `start ota` and a station connect start it again
(verified: AP up, sleep blocked for the session, sleeping after
`stop ota`).
- DIO1 was not a wake source. GPIO_INT_WAKEUP means EXT1 in Zephyr's
ESP32 driver: RTC pads only, one trigger polarity for all pins on
the S3, and pads left on the RTC mux after every sleep. Since 1.17.1
pm_esp32.overlay also armed the active-low user button; gpio-keys
configures first, so the driver refused the active-high DIO1.
The new helper arms the radio IRQ line and the user button (sw0) as
per-pin level GPIO wakes (ESP-IDF gpio_wakeup_enable, any pad) for the
length of each sleep, masks their CPU interrupt while in level mode,
and re-raises the interrupt a sleep swallowed through status_w1ts, so
the radio's dio1_isr and gpio-keys run as usual. EXT1 is no longer
used: patch 0003 configures DIO1 as a plain input again and drops the
d7cc4cb pad-restore notifier (preamble section rewritten). Non-RTC
DIO1 boards (XIAO GPIO39, Station G2 GPIO48) can now light-sleep.
Each light sleep is also bounded by the next esp_timer alarm
(pm_policy_next_custom_ticks, CONFIG_PM_CUSTOM_TICKS_HOOK), as ESP-IDF
does; the BLE controller's modem-sleep wake timer lives there.
Light sleep isolates every pad that is not held, RTC or digital, while
the radio keeps receiving. Holds (ESP32_GPIO_SLEEP_HOLD_EN, inert
without PM) now live in each board's own files: NSS and RESET on all
PM-capable boards, VFEM_Ctrl (GPIO7) and Vext on V4/V4.3/V4 R8/WTv2,
CPS on V4, RXEN on the XIAO. The shared overlay keeps only &rtc_timer
and the GPIO wake source; the wrong RTC_PERIPH explanations are gone.
Also:
- `powersaving` (upstream's command and replies) gates light sleep;
light-sleep builds default to on, and a stored 0 without the new
pwr_sav_set marker (the field did nothing before) becomes on once.
`powersaving off` persists and keeps the node (and its USB) awake.
- `get pm`: asleep %, sleeps, wake causes, per-pin wake counts.
- The console window reopens on every user-button press.
- XIAO ESP32-S3: GPIO21 is both the kit's user button and the board's
led0; the heartbeat drove it low and every sleep woke as a button
press. led0 is deleted, the button gets a pull-up.
- Station G2: button active-low with pull-up, as upstream reads it
(was active-high). Untested on hardware.
Verified on the XIAO ESP32-S3 as a light-sleep repeater on the live
mesh (repeat off, 2 dBm) against a T1000-E on the same channel: awake
20 min, ratio of floods heard 0.95; asleep 30.5 min (96.6 % of
uptime), 119 vs 119, ratio 1.00. TX: sent == flood + direct. Heltec
boards: build-only (no unit on the bench).
Companion light sleep stays off by default; the esp_timer bound makes
it possible. Spike on the XIAO (pm_esp32.conf by hand, BLE only): a
held connection survives, 35 min with a poll every minute and no
miss, the SoC asleep ~91 % between connection events, LoRa RX 130 vs
~130 on the T1000-E. Pairing while asleep fails; USB CDC and UI still
need locks before companions can ship with it.
Flash wear (storage)
The companion marked contacts dirty on is_new, but upstream's is_new
means "not in contacts[]": auto-add declined the node (type filter,
hop limit, full table). Every advert from such a node forced a 5 s
full rewrite of an unchanged contacts3, while a contact that really
was just added only got the liveness deadline. onAdvertRecv now
snapshots the stored record first. is_new never dirties. An addition
or a changed name, type or position flushes in 5 s, and a plain
re-advert waits the liveness deadline, now 1 h instead of 10 min.
A new weak hook, zephcore_persist_before_off(), flushes the deferred
writes before every clean reboot and power-off. It is called from
zephcore_power_off(), the ZephyrBoard reboot, bootloader and BLE-OTA
paths, the UI save-and-restart, the joystick restart and wifi_ota.
Off the main thread it posts MESH_EVENT_PERSIST and waits up to 5 s.
Before this, only CMD_REBOOT flushed.
The repeater saved its ACL on every admin login. It now saves only
when the role or secret changed; the secret is the ECDH of two fixed
keys, so re-logins store nothing new. The room server likewise skips
the lazy write unless the role, sync_since or secret changed.
zephcore_prefs_json_save() compares the serialised JSON with the file
and skips an identical rewrite. Not tested on hardware.
Builds and tests: role_builds.sh 10/10; the ESP32 PM set on the
combined tree (five Heltec repeaters, V4 R8, Station G2, XIAO repeater
and companion) 9/9, repeaters at 69-71 % dram0; board_manifest check
clean; host tests quick 114/114. heltec_companion dram0 at 99.80 %
(776 B left, +88 B for both changes together).
64 lines
2.9 KiB
Plaintext
64 lines
2.9 KiB
Plaintext
/*
|
|
* SPDX-License-Identifier: MIT
|
|
* Devicetree half of boards/common/pm_esp32.conf — auto-paired by
|
|
* zephcore_auto_pair_overlay() in CMakeLists.txt, so passing the .conf is
|
|
* enough; this file does not need to be listed separately.
|
|
*
|
|
* Only the board-independent part lives here. Pin holds are wiring facts and
|
|
* live in each board's DTS/overlay (see "PAD HOLD" below).
|
|
*/
|
|
|
|
/*
|
|
* The RTC timer is the wake source for every timed sleep. Upstream leaves it
|
|
* status = "disabled" (zephyr/dts/xtensa/espressif/esp32s3/esp32s3_common.dtsi),
|
|
* and soc/espressif/common/power.c checks for it in rtc_wakeup_enable():
|
|
* without a wakeup-capable rtc_timer device it logs "Sleep skipped. Make sure
|
|
* '&rtc_timer' is enabled as a wakeup source." and returns false — so
|
|
* CONFIG_PM=y on its own is a silent no-op. This is the single easiest thing
|
|
* to forget when enabling ESP32 PM.
|
|
*/
|
|
&rtc_timer {
|
|
status = "okay";
|
|
wakeup-source;
|
|
};
|
|
|
|
/*
|
|
* Switches on the ESP32 GPIO wake source (ESP_SLEEP_WAKEUP_GPIO):
|
|
* gpio_esp32_pm_action() calls esp_sleep_enable_gpio_wakeup() on RESUME, which
|
|
* pm_device_driver_init() runs at boot, when the port is wakeup-capable. The
|
|
* source is SoC-wide, so gpio0 alone also covers pins on gpio1.
|
|
*
|
|
* WHICH pins wake the SoC is decided by helpers/pm_esp32_wake.c: the LoRa IRQ
|
|
* line and the user button (alias sw0) become level wakes for the length of
|
|
* each sleep. GPIO_INT_WAKEUP is deliberately NOT used anywhere: in Zephyr's
|
|
* ESP32 driver it means EXT1, which takes RTC pads only, has one trigger
|
|
* polarity for all its pins on the S3 (an active-low button and an active-high
|
|
* DIO1 cannot both be armed: the one configured second is refused), and leaves
|
|
* each pad on the RTC mux after a sleep. devdocs/lld/13-power-management.md
|
|
* F-1/F-2.
|
|
*
|
|
* Side effect worth knowing: this trigger keeps RTC_PERIPH powered in every
|
|
* light sleep (esp_sleep_start forces it ON for RTC_GPIO_TRIG_EN).
|
|
*/
|
|
&gpio0 {
|
|
wakeup-source;
|
|
};
|
|
|
|
/*
|
|
* PAD HOLD — with CONFIG_PM, gpio_esp32_sys_init() (and the HAL's
|
|
* esp_sleep_startup_init()) give every pad an isolated sleep configuration —
|
|
* input off, output off, no pulls — and turn on the automatic switch to it on
|
|
* sleep entry. So EVERY output that is not held floats for the length of each
|
|
* sleep, whatever its power domain: RTC pads and digital pads alike. Only
|
|
* ESP32_GPIO_SLEEP_HOLD_EN (esp32_sleep_gpio_prepare() in power.c) keeps a
|
|
* level through a sleep.
|
|
*
|
|
* The radio keeps receiving while the SoC sleeps, so every line it depends on
|
|
* must be held by the board: NSS (a floating chip-select lets the sleeping
|
|
* SX1262 clock garbage into its retention RAM — the node then transmits ~30 dB
|
|
* down until reboot), RESET, an MCU-driven RF switch or FEM enable, and the
|
|
* FEM's supply regulator. The flag is inert when CONFIG_PM=n, so boards carry
|
|
* it unconditionally. Check a board's radio lines before declaring
|
|
* `light_sleep: true` in its zephcore.yml.
|
|
*/
|