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_PERI_POWERUP_CYCLES
DG peripheral power-up cycles.
DG_PERI_WAIT_CYCLES
DG peripheral wait cycles.
DG_WRAP_POWERUP_CYCLES
DG wrap power-up cycles.
DG_WRAP_WAIT_CYCLES
DG wrap wait cycles.
OTHER_BLOCKS_POWERUP
Power-up setting for other blocks.
OTHER_BLOCKS_WAIT
Waits cycles for other blocks.
RTC_CNTL_CK8M_WAIT_DEFAULT
Default wait time for CK8M during startup.
RTC_CNTL_DBG_ATTEN_DEEPSLEEP_DEFAULT
Deep sleep debug attenuation setting for ultra-low power mode.
RTC_CNTL_DBG_ATTEN_MONITOR_DEFAULT
Default monitor debug attenuation value.
RTC_CNTL_DBIAS_0V90
Digital bias setting for 0.90V.
RTC_CNTL_DBIAS_0V95
Digital bias setting for 0.95V.
RTC_CNTL_DBIAS_1V00
Digital bias setting for 1.00V.
RTC_CNTL_DBIAS_1V05
Digital bias setting for 1.05V.
RTC_CNTL_DBIAS_1V10
Digital bias setting for 1.10V.
RTC_CNTL_DBIAS_1V15
Digital bias setting for 1.15V.
RTC_CNTL_DBIAS_1V20
Digital bias setting for 1.20V.
RTC_CNTL_DBIAS_1V25
Digital bias setting for 1.25V.
RTC_CNTL_MIN_SLP_VAL_MIN
Minimum sleep value.
RTC_CNTL_PLL_BUF_WAIT_DEFAULT
Default wait time for PLL buffer during startup.
RTC_CNTL_ULPCP_TOUCH_START_WAIT_DEFAULT
ULP co-processor touch start wait time default value.
RTC_CNTL_ULPCP_TOUCH_START_WAIT_IN_SLEEP
ULP co-processor touch start wait time during sleep, set to maximum.
RTC_CNTL_XTL_BUF_WAIT_DEFAULT
Default wait time for XTL buffer during startup.
RTC_MEM_POWERUP_CYCLES
RTC memory power-up cycles.
RTC_MEM_WAIT_CYCLES
RTC memory wait cycles.
RTC_POWERUP_CYCLES
RTC power-up cycles.
RTC_WAIT_CYCLES
RTC wait cycles.
WIFI_POWERUP_CYCLES
WiFi power-up cycles.
WIFI_WAIT_CYCLES
WiFi wait cycles.

Type Aliases§

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