Skip to main content

Module sleep

Module sleep 

Source
Available on crate feature unstable only.
Expand description

§RTC Control Sleep Module

§Overview

The sleep module allows configuring various wakeup sources and setting up the sleep behavior based on those sources. The supported wakeup sources include:

  • GPIO pins - light sleep only
  • timers
  • SDIO (Secure Digital Input/Output) - light sleep only
  • MAC (Media Access Control) wake - light sleep only
  • UART0 - light sleep only
  • UART1 - light sleep only
  • touch
  • ULP (Ultra-Low Power) wake
  • BT (Bluetooth) wake - light sleep only

Structs§

LowPower
Low-power management.
RtcSleepConfig
Configuration for the RTC sleep behavior.
WrappedSleepConfig
The sleep configuration, as the entry hook of a wakeup source can see it.

Enums§

LightSleep
The result of a light sleep.

Constants§

DG_WRAP_POWERUP_CYCLES
Power-up cycles for the digital wrap components.
DG_WRAP_WAIT_CYCLES
Waits cycles for the digital wrap components.
ROM_RAM_POWERUP_CYCLES
Power-up cycles for ROM and RAM.
ROM_RAM_WAIT_CYCLES
Waits cycles for ROM and RAM.
RTC_CK8M_ENABLE_WAIT_DEFAULT
Default wait cycles to enable the 8 MHz clock.
RTC_CNTL_CK8M_WAIT_DEFAULT
Default wait cycles for the 8 MHz clock.
RTC_CNTL_CK8M_WAIT_SLP_CYCLES
Cycles to wait for the 8 MHz clock to stabilize.
RTC_CNTL_DBG_ATTEN_DEFAULT
Default debug attenuation value.
RTC_CNTL_DBIAS_0V90
RTC digital bias setting corresponding to 0.90V.
RTC_CNTL_DBIAS_0V95
RTC digital bias setting corresponding to 0.95V.
RTC_CNTL_DBIAS_1V00
RTC digital bias setting corresponding to 1.00V.
RTC_CNTL_DBIAS_1V05
RTC digital bias setting corresponding to 1.05V.
RTC_CNTL_DBIAS_1V10
RTC digital bias setting corresponding to 1.10V.
RTC_CNTL_DBIAS_1V15
RTC digital bias setting corresponding to 1.15V.
RTC_CNTL_DBIAS_1V20
RTC digital bias setting corresponding to 1.20V.
RTC_CNTL_DBIAS_1V25
RTC digital bias setting corresponding to 1.25V.
RTC_CNTL_MIN_SLP_VAL_MIN
Minimum sleep value (in cycles).
RTC_CNTL_OTHER_BLOCKS_POWERUP_CYCLES
Power-up cycles for other blocks.
RTC_CNTL_OTHER_BLOCKS_WAIT_CYCLES
Waits cycles for other blocks.
RTC_CNTL_PLL_BUF_WAIT_SLP_CYCLES
Cycles to wait for PLL buffer stabilization.
RTC_CNTL_WAKEUP_DELAY_CYCLES
Delay in cycles for wakeup signal to be applied.
RTC_CNTL_XTL_BUF_WAIT_SLP_US
Time (in microseconds) for waiting the XTL buffer to stabilize during sleep.
RTC_MEM_POWERUP_CYCLES
Power-up cycles for RTC memory.
RTC_MEM_WAIT_CYCLES
Waits cycles for RTC memory.
RTC_POWERUP_CYCLES
Power-up cycles for RTC components.
RTC_WAIT_CYCLES
Waits cycles for RTC components.
WIFI_POWERUP_CYCLES
Power-up cycles for Wi-Fi.
WIFI_WAIT_CYCLES
Waits cycles for Wi-Fi.

Type Aliases§

SleepEntryHook
Runs at sleep entry, before the sleep configuration reaches hardware.
SleepExitHook
Runs after a light sleep.