Implement sleep and wakeup functionalities for ESP32C2 #1920 (#1922)

This commit is contained in:
M4tsuri 2024-09-05 21:39:46 +08:00 committed by GitHub
parent a2af2ac65e
commit 4f97befdde
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
8 changed files with 903 additions and 17 deletions

View File

@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Implement `embedded-hal` output pin traits for `DummyPin` (#2019) - Implement `embedded-hal` output pin traits for `DummyPin` (#2019)
- Added `esp_hal::init` to simplify HAL initialisation (#1970, #1999) - Added `esp_hal::init` to simplify HAL initialisation (#1970, #1999)
- Added sleep and wakeup support for esp32c2 (#1922)
### Changed ### Changed
- Make saving and restoring SHA digest state an explicit operation (#2049) - Make saving and restoring SHA digest state an explicit operation (#2049)

View File

@ -60,7 +60,7 @@ use procmacros::ram;
#[cfg(any(adc, dac))] #[cfg(any(adc, dac))]
pub(crate) use crate::analog; pub(crate) use crate::analog;
pub(crate) use crate::gpio; pub(crate) use crate::gpio;
#[cfg(any(xtensa, esp32c3))] #[cfg(any(xtensa, esp32c3, esp32c2))]
pub(crate) use crate::rtc_pins; pub(crate) use crate::rtc_pins;
pub use crate::soc::gpio::*; pub use crate::soc::gpio::*;
use crate::{ use crate::{
@ -236,7 +236,7 @@ pub trait RtcPin: Pin {
/// ///
/// The `level` argument needs to be a valid setting for the /// The `level` argument needs to be a valid setting for the
/// `rtc_cntl.gpio_wakeup.gpio_pinX_int_type`. /// `rtc_cntl.gpio_wakeup.gpio_pinX_int_type`.
#[cfg(any(esp32c3, esp32c6))] #[cfg(any(esp32c3, esp32c2, esp32c6))]
unsafe fn apply_wakeup(&mut self, wakeup: bool, level: u8); unsafe fn apply_wakeup(&mut self, wakeup: bool, level: u8);
} }
@ -1568,6 +1568,47 @@ macro_rules! rtc_pins {
( $( $pin_num:expr )+ ) => { $( $crate::gpio::rtc_pins!($pin_num); )+ }; ( $( $pin_num:expr )+ ) => { $( $crate::gpio::rtc_pins!($pin_num); )+ };
} }
#[cfg(esp32c2)]
#[doc(hidden)]
#[macro_export]
macro_rules! rtc_pins {
(
$pin_num:expr
) => {
impl $crate::gpio::RtcPin for GpioPin<$pin_num> {
unsafe fn apply_wakeup(&mut self, wakeup: bool, level: u8) {
let rtc_cntl = unsafe { &*$crate::peripherals::RTC_CNTL::ptr() };
paste::paste! {
rtc_cntl.cntl_gpio_wakeup().modify(|_, w| w.[< gpio_pin $pin_num _wakeup_enable >]().bit(wakeup));
rtc_cntl.cntl_gpio_wakeup().modify(|_, w| w.[< gpio_pin $pin_num _int_type >]().bits(level));
}
}
fn rtcio_pad_hold(&mut self, enable: bool) {
let rtc_cntl = unsafe { &*$crate::peripherals::RTC_CNTL::ptr() };
paste::paste! {
rtc_cntl.pad_hold().modify(|_, w| w.[< gpio_pin $pin_num _hold >]().bit(enable));
}
}
}
impl $crate::gpio::RtcPinWithResistors for GpioPin<$pin_num> {
fn rtcio_pullup(&mut self, enable: bool) {
let io_mux = unsafe { &*$crate::peripherals::IO_MUX::ptr() };
io_mux.gpio($pin_num).modify(|_, w| w.fun_wpu().bit(enable));
}
fn rtcio_pulldown(&mut self, enable: bool) {
let io_mux = unsafe { &*$crate::peripherals::IO_MUX::ptr() };
io_mux.gpio($pin_num).modify(|_, w| w.fun_wpd().bit(enable));
}
}
};
( $( $pin_num:expr )+ ) => { $( $crate::gpio::rtc_pins!($pin_num); )+ };
}
// Following code enables `into_analog` // Following code enables `into_analog`
#[doc(hidden)] #[doc(hidden)]

View File

@ -79,7 +79,7 @@ use crate::efuse::Efuse;
use crate::peripherals::{LPWR, TIMG0}; use crate::peripherals::{LPWR, TIMG0};
#[cfg(any(esp32c6, esp32h2))] #[cfg(any(esp32c6, esp32h2))]
use crate::peripherals::{LP_TIMER, LP_WDT}; use crate::peripherals::{LP_TIMER, LP_WDT};
#[cfg(any(esp32, esp32s3, esp32c3, esp32c6))] #[cfg(any(esp32, esp32s3, esp32c3, esp32c6, esp32c2))]
use crate::rtc_cntl::sleep::{RtcSleepConfig, WakeSource, WakeTriggers}; use crate::rtc_cntl::sleep::{RtcSleepConfig, WakeSource, WakeTriggers};
use crate::{ use crate::{
clock::Clock, clock::Clock,
@ -91,7 +91,7 @@ use crate::{
InterruptConfigurable, InterruptConfigurable,
}; };
// only include sleep where its been implemented // only include sleep where its been implemented
#[cfg(any(esp32, esp32s3, esp32c3, esp32c6))] #[cfg(any(esp32, esp32s3, esp32c3, esp32c6, esp32c2))]
pub mod sleep; pub mod sleep;
#[cfg_attr(esp32, path = "rtc/esp32.rs")] #[cfg_attr(esp32, path = "rtc/esp32.rs")]
@ -203,7 +203,7 @@ impl<'d> Rtc<'d> {
swd: Swd::new(), swd: Swd::new(),
}; };
#[cfg(any(esp32, esp32s3, esp32c3, esp32c6))] #[cfg(any(esp32, esp32s3, esp32c3, esp32c6, esp32c2))]
RtcSleepConfig::base_settings(&this); RtcSleepConfig::base_settings(&this);
this this
@ -264,7 +264,7 @@ impl<'d> Rtc<'d> {
} }
/// Enter deep sleep and wake with the provided `wake_sources`. /// Enter deep sleep and wake with the provided `wake_sources`.
#[cfg(any(esp32, esp32s3, esp32c3, esp32c6))] #[cfg(any(esp32, esp32s3, esp32c3, esp32c6, esp32c2))]
pub fn sleep_deep(&mut self, wake_sources: &[&dyn WakeSource]) -> ! { pub fn sleep_deep(&mut self, wake_sources: &[&dyn WakeSource]) -> ! {
let config = RtcSleepConfig::deep(); let config = RtcSleepConfig::deep();
self.sleep(&config, wake_sources); self.sleep(&config, wake_sources);
@ -272,7 +272,7 @@ impl<'d> Rtc<'d> {
} }
/// Enter light sleep and wake with the provided `wake_sources`. /// Enter light sleep and wake with the provided `wake_sources`.
#[cfg(any(esp32, esp32s3, esp32c3, esp32c6))] #[cfg(any(esp32, esp32s3, esp32c3, esp32c6, esp32c2))]
pub fn sleep_light(&mut self, wake_sources: &[&dyn WakeSource]) { pub fn sleep_light(&mut self, wake_sources: &[&dyn WakeSource]) {
let config = RtcSleepConfig::default(); let config = RtcSleepConfig::default();
self.sleep(&config, wake_sources); self.sleep(&config, wake_sources);
@ -280,7 +280,7 @@ impl<'d> Rtc<'d> {
/// Enter sleep with the provided `config` and wake with the provided /// Enter sleep with the provided `config` and wake with the provided
/// `wake_sources`. /// `wake_sources`.
#[cfg(any(esp32, esp32s3, esp32c3, esp32c6))] #[cfg(any(esp32, esp32s3, esp32c3, esp32c6, esp32c2))]
pub fn sleep(&mut self, config: &RtcSleepConfig, wake_sources: &[&dyn WakeSource]) { pub fn sleep(&mut self, config: &RtcSleepConfig, wake_sources: &[&dyn WakeSource]) {
let mut config = *config; let mut config = *config;
let mut wakeup_triggers = WakeTriggers::default(); let mut wakeup_triggers = WakeTriggers::default();

View File

@ -0,0 +1,834 @@
use super::{TimerWakeupSource, WakeSource, WakeTriggers, WakeupLevel};
use crate::{
gpio::{RtcFunction, RtcPinWithResistors},
regi2c_write_mask,
rtc_cntl::{sleep::RtcioWakeupSource, Clock, Rtc, RtcClock},
};
const I2C_DIG_REG: u32 = 0x6D;
const I2C_DIG_REG_HOSTID: u32 = 0;
const I2C_DIG_REG_EXT_RTC_DREG: u32 = 4;
const I2C_DIG_REG_EXT_RTC_DREG_MSB: u32 = 4;
const I2C_DIG_REG_EXT_RTC_DREG_LSB: u32 = 0;
const I2C_DIG_REG_EXT_RTC_DREG_SLEEP: u32 = 5;
const I2C_DIG_REG_EXT_RTC_DREG_SLEEP_MSB: u32 = 4;
const I2C_DIG_REG_EXT_RTC_DREG_SLEEP_LSB: u32 = 0;
const I2C_DIG_REG_EXT_DIG_DREG: u32 = 6;
const I2C_DIG_REG_EXT_DIG_DREG_MSB: u32 = 4;
const I2C_DIG_REG_EXT_DIG_DREG_LSB: u32 = 0;
const I2C_DIG_REG_EXT_DIG_DREG_SLEEP: u32 = 7;
const I2C_DIG_REG_EXT_DIG_DREG_SLEEP_MSB: u32 = 4;
const I2C_DIG_REG_EXT_DIG_DREG_SLEEP_LSB: u32 = 0;
const I2C_DIG_REG_XPD_RTC_REG: u32 = 13;
const I2C_DIG_REG_XPD_RTC_REG_MSB: u32 = 2;
const I2C_DIG_REG_XPD_RTC_REG_LSB: u32 = 2;
const I2C_DIG_REG_XPD_DIG_REG: u32 = 13;
const I2C_DIG_REG_XPD_DIG_REG_MSB: u32 = 3;
const I2C_DIG_REG_XPD_DIG_REG_LSB: u32 = 3;
const I2C_ULP_IR_FORCE_XPD_CK: u8 = 0;
const I2C_ULP_IR_FORCE_XPD_CK_MSB: u8 = 2;
const I2C_ULP_IR_FORCE_XPD_CK_LSB: u8 = 2;
const I2C_ULP: u8 = 0x61;
const I2C_ULP_HOSTID: u8 = 0;
// Approximate mapping of voltages to RTC_CNTL_DBIAS_WAK, RTC_CNTL_DBIAS_SLP,
// RTC_CNTL_DIG_DBIAS_WAK, RTC_CNTL_DIG_DBIAS_SLP values.
// Valid if RTC_CNTL_DBG_ATTEN is 0.
/// Digital bias voltage level of 0.90V.
pub const RTC_CNTL_DBIAS_0V90: u32 = 13;
/// Digital bias voltage level of 0.95V.
pub const RTC_CNTL_DBIAS_0V95: u32 = 16;
/// Digital bias voltage level of 1.00V.
pub const RTC_CNTL_DBIAS_1V00: u32 = 18;
/// Digital bias voltage level of 1.05V.
pub const RTC_CNTL_DBIAS_1V05: u32 = 20;
/// Digital bias voltage level of 1.10V.
pub const RTC_CNTL_DBIAS_1V10: u32 = 23;
/// Digital bias voltage level of 1.15V.
pub const RTC_CNTL_DBIAS_1V15: u32 = 25;
/// Digital bias voltage level of 1.20V.
pub const RTC_CNTL_DBIAS_1V20: u32 = 28;
/// Digital bias voltage level of 1.25V.
pub const RTC_CNTL_DBIAS_1V25: u32 = 30;
/// Digital bias voltage level of approximately 1.34V.
pub const RTC_CNTL_DBIAS_1V30: u32 = 31;
/// Default attenuation setting during light sleep, with a voltage drop.
pub const RTC_CNTL_DBG_ATTEN_LIGHTSLEEP_DEFAULT: u8 = 5;
/// No attenuation (no voltage drop) during light sleep.
pub const RTC_CNTL_DBG_ATTEN_LIGHTSLEEP_NODROP: u8 = 0;
/// Default attenuation setting during deep sleep, with maximum voltage drop.
pub const RTC_CNTL_DBG_ATTEN_DEEPSLEEP_DEFAULT: u8 = 15;
/// No attenuation (no voltage drop) during deep sleep.
pub const RTC_CNTL_DBG_ATTEN_DEEPSLEEP_NODROP: u8 = 0;
/// Default bias setting during sleep mode.
pub const RTC_CNTL_BIASSLP_SLEEP_DEFAULT: u8 = 1;
/// Keeps the bias for ultra-low power sleep mode always on.
pub const RTC_CNTL_BIASSLP_SLEEP_ON: u8 = 0;
/// Default power-down current setting during sleep mode.
pub const RTC_CNTL_PD_CUR_SLEEP_DEFAULT: u8 = 1;
/// Keeps the power-down current setting for sleep mode always on.
pub const RTC_CNTL_PD_CUR_SLEEP_ON: u8 = 0;
/// Default driver bias setting for the digital domain during sleep mode.
pub const RTC_CNTL_DG_VDD_DRV_B_SLP_DEFAULT: u8 = 254;
/// Default debug attenuation setting for the monitor mode.
pub const RTC_CNTL_DBG_ATTEN_MONITOR_DEFAULT: u8 = 0;
/// Default bias setting for sleep mode in the monitor mode.
pub const RTC_CNTL_BIASSLP_MONITOR_DEFAULT: bool = false;
/// Default power-down current setting for the monitor mode.
pub const RTC_CNTL_PD_CUR_MONITOR_DEFAULT: bool = false;
/// Default number of cycles to wait for the PLL buffer to stabilize.
pub const RTC_CNTL_PLL_BUF_WAIT_DEFAULT: u8 = 20;
/// Default number of cycles to wait for the XTL buffer to stabilize.
pub const RTC_CNTL_XTL_BUF_WAIT_DEFAULT: u8 = 100;
/// Default number of cycles to wait for the internal 8MHz clock to stabilize.
pub const RTC_CNTL_CK8M_WAIT_DEFAULT: u8 = 20;
/// Default number of cycles required to enable the internal 8MHz clock.
pub const RTC_CK8M_ENABLE_WAIT_DEFAULT: u8 = 5;
/// Minimum number of cycles for sleep duration.
pub const RTC_CNTL_MIN_SLP_VAL_MIN: u8 = 2;
/// Power-up cycles for other hardware blocks.
pub const OTHER_BLOCKS_POWERUP: u8 = 1;
/// Wait cycles for other hardware blocks to stabilize.
pub const OTHER_BLOCKS_WAIT: u16 = 1;
/// Disables GPIO interrupt.
pub const GPIO_INTR_DISABLE: u8 = 0;
/// Sets GPIO interrupt to trigger on a low level signal.
pub const GPIO_INTR_LOW_LEVEL: u8 = 4;
/// Sets GPIO interrupt to trigger on a high level signal.
pub const GPIO_INTR_HIGH_LEVEL: u8 = 5;
/// Specifies the function configuration for GPIO pins.
pub const PIN_FUNC_GPIO: u8 = 1;
/// Index for signaling GPIO output.
pub const SIG_GPIO_OUT_IDX: u32 = 128;
/// Maximum number of GPIO pins supported.
pub const GPIO_NUM_MAX: usize = 22;
impl WakeSource for TimerWakeupSource {
fn apply(
&self,
rtc: &Rtc<'_>,
triggers: &mut WakeTriggers,
_sleep_config: &mut RtcSleepConfig,
) {
triggers.set_timer(true);
let rtc_cntl = unsafe { &*esp32c2::RTC_CNTL::ptr() };
let clock_freq = RtcClock::get_slow_freq();
// TODO: maybe add sleep time adjustlemnt like idf
// TODO: maybe add check to prevent overflow?
let clock_hz = clock_freq.frequency().to_Hz() as u64;
let ticks = self.duration.as_micros() as u64 * clock_hz / 1_000_000u64;
// "alarm" time in slow rtc ticks
let now = rtc.get_time_raw();
let time_in_ticks = now + ticks;
unsafe {
rtc_cntl
.slp_timer0()
.write(|w| w.slp_val_lo().bits((time_in_ticks & 0xffffffff) as u32));
rtc_cntl
.int_clr()
.write(|w| w.main_timer().clear_bit_by_one());
rtc_cntl.slp_timer1().write(|w| {
w.slp_val_hi()
.bits(((time_in_ticks >> 32) & 0xffff) as u16)
.main_timer_alarm_en()
.set_bit()
});
}
}
}
impl<'a, 'b> RtcioWakeupSource<'a, 'b> {
fn apply_pin(&self, pin: &mut dyn RtcPinWithResistors, level: WakeupLevel) {
// The pullup/pulldown part is like in gpio_deep_sleep_wakeup_prepare
let level = match level {
WakeupLevel::High => {
pin.rtcio_pullup(false);
pin.rtcio_pulldown(true);
GPIO_INTR_HIGH_LEVEL
}
WakeupLevel::Low => {
pin.rtcio_pullup(true);
pin.rtcio_pulldown(false);
GPIO_INTR_LOW_LEVEL
}
};
pin.rtcio_pad_hold(true);
// apply_wakeup does the same as idf's esp_deep_sleep_enable_gpio_wakeup
unsafe {
pin.apply_wakeup(true, level);
}
}
}
fn isolate_digital_gpio() {
// like esp_sleep_isolate_digital_gpio
let rtc_cntl = unsafe { &*crate::peripherals::RTC_CNTL::ptr() };
let io_mux = unsafe { &*crate::peripherals::IO_MUX::ptr() };
let gpio = unsafe { &*crate::peripherals::GPIO::ptr() };
let dig_iso = &rtc_cntl.dig_iso().read();
let deep_sleep_hold_is_en =
!dig_iso.dg_pad_force_unhold().bit() && dig_iso.dg_pad_autohold_en().bit();
if !deep_sleep_hold_is_en {
return;
}
// TODO: assert that the task stack is not in external ram
for pin_num in 0..GPIO_NUM_MAX {
let pin_hold = rtc_cntl.dig_pad_hold().read().bits() & (1 << pin_num) != 0;
if !pin_hold {
// input disable, like gpio_ll_input_disable
io_mux.gpio(pin_num).modify(|_, w| w.fun_ie().clear_bit());
// output disable, like gpio_ll_output_disable
unsafe {
gpio.func_out_sel_cfg(pin_num)
.modify(|_, w| w.bits(SIG_GPIO_OUT_IDX));
}
// disable pull-up and pull-down
io_mux.gpio(pin_num).modify(|_, w| w.fun_wpu().clear_bit());
io_mux.gpio(pin_num).modify(|_, w| w.fun_wpd().clear_bit());
// make pad work as gpio (otherwise, deep_sleep bottom current will rise)
io_mux
.gpio(pin_num)
.modify(|_, w| unsafe { w.mcu_sel().bits(RtcFunction::Digital as u8) });
}
}
}
impl WakeSource for RtcioWakeupSource<'_, '_> {
fn apply(
&self,
_rtc: &Rtc<'_>,
triggers: &mut WakeTriggers,
sleep_config: &mut RtcSleepConfig,
) {
let mut pins = self.pins.borrow_mut();
if pins.is_empty() {
return;
}
triggers.set_gpio(true);
// If deep sleep is enabled, esp_start_sleep calls
// gpio_deep_sleep_wakeup_prepare which sets these pullup and
// pulldown values. But later in esp_start_sleep it calls
// esp_sleep_isolate_digital_gpio, which disables the pullup and pulldown (but
// only if it isn't held).
// But it looks like gpio_deep_sleep_wakeup_prepare enables hold for all pins
// in the wakeup mask.
//
// So: all pins in the wake mask should get this treatment here, and all pins
// not in the wake mask should get
// - pullup and pulldowns disabled
// - input and output disabled, and
// - their func should get set to GPIO.
// But this last block of things gets skipped if hold is disabled globally (see
// gpio_ll_deep_sleep_hold_is_en)
let rtc_cntl = unsafe { &*crate::peripherals::RTC_CNTL::PTR };
rtc_cntl
.cntl_gpio_wakeup()
.modify(|_, w| w.gpio_pin_clk_gate().set_bit());
rtc_cntl
.ext_wakeup_conf()
.modify(|_, w| w.gpio_wakeup_filter().set_bit());
if sleep_config.deep_slp() {
for (pin, level) in pins.iter_mut() {
self.apply_pin(*pin, *level);
}
isolate_digital_gpio();
}
// like rtc_cntl_ll_gpio_clear_wakeup_status, as called from
// gpio_deep_sleep_wakeup_prepare
rtc_cntl
.cntl_gpio_wakeup()
.modify(|_, w| w.gpio_wakeup_status_clr().set_bit());
rtc_cntl
.cntl_gpio_wakeup()
.modify(|_, w| w.gpio_wakeup_status_clr().clear_bit());
}
}
// impl Drop for RtcioWakeupSource<'_, '_> {
// fn drop(&mut self) {
// should we have saved the pin configuration first?
// set pin back to IO_MUX (input_enable and func have no effect when pin is sent
// to IO_MUX)
// let mut pins = self.pins.borrow_mut();
// for (pin, _level) in pins.iter_mut() {
// pin.rtc_set_config(true, false, RtcFunction::Rtc);
// }
// }
// }
bitfield::bitfield! {
#[derive(Clone, Copy)]
/// RTC Configuration.
pub struct RtcConfig(u32);
impl Debug;
/// Number of rtc_fast_clk cycles to wait for 8M clock to be ready
pub u8, ck8m_wait, set_ck8m_wait: 7, 0;
/// Number of rtc_fast_clk cycles to wait for XTAL clock to be ready
pub u8, xtal_wait, set_xtal_wait: 15, 8;
/// Number of rtc_fast_clk cycles to wait for PLL clock to be ready
pub u8, pll_wait, set_pll_wait: 23, 16;
/// Perform clock control related initialization.
pub clkctl_init, set_clkctl_init: 24;
/// Perform power control related initialization.
pub pwrctl_init, set_pwrctl_init: 25;
/// Force power down RTC_DBOOST
pub rtc_dboost_fpd, set_rtc_dboost_fpd: 26;
/// Keep the XTAL oscillator powered up in sleep.
pub xtal_fpu, set_xtal_fpu: 27;
/// Keep the BBPLL oscillator powered up in sleep.
pub bbpll_fpu, set_bbpll_fpu: 28;
/// Enable clock gating when the CPU is in wait-for-interrupt state.
pub cpu_waiti_clk_gate, set_cpu_waiti_clk_gate: 29;
/// Calibrate Ocode to make bandgap voltage more precise.
pub cali_ocode, set_cali_ocode: 30;
}
impl Default for RtcConfig {
fn default() -> Self {
let mut cfg = Self(Default::default());
cfg.set_ck8m_wait(RTC_CNTL_CK8M_WAIT_DEFAULT);
cfg.set_xtal_wait(RTC_CNTL_XTL_BUF_WAIT_DEFAULT);
cfg.set_pll_wait(RTC_CNTL_PLL_BUF_WAIT_DEFAULT);
cfg.set_clkctl_init(true);
cfg.set_pwrctl_init(true);
cfg.set_rtc_dboost_fpd(true);
cfg.set_cpu_waiti_clk_gate(true);
cfg
}
}
bitfield::bitfield! {
#[derive(Clone, Copy)]
/// Configuration for RTC initialization.
pub struct RtcInitConfig(u128);
impl Debug;
/// Number of cycles required to power up WiFi
pub u8, wifi_powerup_cycles, set_wifi_powerup_cycles: 6, 0;
/// Number of wait cycles for WiFi to stabilize
pub u16, wifi_wait_cycles, set_wifi_wait_cycles: 15, 7;
/// Number of cycles required to power up Bluetooth
pub u8, bt_powerup_cycles, set_bt_powerup_cycles: 22, 16;
/// Number of wait cycles for Bluetooth to stabilize
pub u16, bt_wait_cycles, set_bt_wait_cycles: 31, 23;
/// Number of cycles required to power up the top CPU
pub u8, cpu_top_powerup_cycles, set_cpu_top_powerup_cycles: 38, 32;
/// Number of wait cycles for the top CPU to stabilize
pub u16, cpu_top_wait_cycles, set_cpu_top_wait_cycles: 47, 39;
/// Number of cycles required to power up the digital wrapper
pub u8, dg_wrap_powerup_cycles, set_dg_wrap_powerup_cycles: 54, 48;
/// Number of wait cycles for the digital wrapper to stabilize
pub u16, dg_wrap_wait_cycles, set_dg_wrap_wait_cycles: 63, 55;
/// Number of cycles required to power up the digital peripherals
pub u8, dg_peri_powerup_cycles, set_dg_peri_powerup_cycles: 70, 64;
/// Number of wait cycles for the digital peripherals to stabilize
pub u16, dg_peri_wait_cycles, set_dg_peri_wait_cycles: 79, 71;
}
impl Default for RtcInitConfig {
fn default() -> Self {
let mut cfg = Self(Default::default());
cfg.set_wifi_powerup_cycles(OTHER_BLOCKS_POWERUP);
cfg.set_bt_powerup_cycles(OTHER_BLOCKS_POWERUP);
cfg.set_cpu_top_powerup_cycles(OTHER_BLOCKS_POWERUP);
cfg.set_dg_wrap_powerup_cycles(OTHER_BLOCKS_POWERUP);
cfg.set_dg_peri_powerup_cycles(OTHER_BLOCKS_POWERUP);
cfg.set_wifi_wait_cycles(OTHER_BLOCKS_WAIT);
cfg.set_bt_wait_cycles(OTHER_BLOCKS_WAIT);
cfg.set_cpu_top_wait_cycles(OTHER_BLOCKS_WAIT);
cfg.set_dg_wrap_wait_cycles(OTHER_BLOCKS_WAIT);
cfg.set_dg_peri_wait_cycles(OTHER_BLOCKS_WAIT);
cfg
}
}
bitfield::bitfield! {
#[derive(Clone, Copy)]
/// Configuration for RTC sleep mode.
pub struct RtcSleepConfig(u64);
impl Debug;
/// force normal voltage in sleep mode (digital domain memory)
pub lslp_mem_inf_fpu, set_lslp_mem_inf_fpu: 0;
/// keep low voltage in sleep mode (even if ULP/touch is used)
pub rtc_mem_inf_follow_cpu, set_rtc_mem_inf_follow_cpu: 1;
/// power down RTC fast memory
pub rtc_fastmem_pd_en, set_rtc_fastmem_pd_en: 2;
/// power down RTC slow memory
pub rtc_slowmem_pd_en, set_rtc_slowmem_pd_en: 3;
/// power down RTC peripherals
pub rtc_peri_pd_en, set_rtc_peri_pd_en: 4;
/// power down WiFi
pub wifi_pd_en, set_wifi_pd_en: 5;
/// power down BT
pub bt_pd_en, set_bt_pd_en: 6;
/// power down CPU, but not restart when lightsleep.
pub cpu_pd_en, set_cpu_pd_en: 7;
/// Power down Internal 8M oscillator
pub int_8m_pd_en, set_int_8m_pd_en: 8;
/// power down digital peripherals
pub dig_peri_pd_en, set_dig_peri_pd_en: 9;
/// power down digital domain
pub deep_slp, set_deep_slp: 10;
/// enable WDT flashboot mode
pub wdt_flashboot_mod_en, set_wdt_flashboot_mod_en: 11;
/// set bias for digital domain, in sleep mode
pub u32, dig_dbias_slp, set_dig_dbias_slp: 16, 12;
/// set bias for RTC domain, in sleep mode
pub u32, rtc_dbias_slp, set_rtc_dbias_slp: 21, 17;
/// voltage parameter, in sleep mode
pub u8, dbg_atten_slp, set_dbg_atten_slp: 25, 22;
/// circuit control parameter, in monitor mode
pub bias_sleep_monitor, set_bias_sleep_monitor: 26;
/// circuit control parameter, in sleep mode
pub bias_sleep_slp, set_bias_sleep_slp: 27;
/// circuit control parameter, in monitor mode
pub pd_cur_slp, set_pd_cur_slp: 28;
/// power down VDDSDIO regulator
pub vddsdio_pd_en, set_vddsdio_pd_en: 29;
/// keep main XTAL powered up in sleep
pub xtal_fpu, set_xtal_fpu: 30;
/// keep rtc regulator powered up in sleep
pub rtc_regulator_fpu, set_rtc_regulator_fpu: 31;
/// enable deep sleep reject
pub deep_slp_reject, set_deep_slp_reject: 32;
/// enable light sleep reject
pub light_slp_reject, set_light_slp_reject: 33;
}
impl Default for RtcSleepConfig {
fn default() -> Self {
let mut cfg = Self(Default::default());
cfg.set_deep_slp_reject(true);
cfg.set_light_slp_reject(true);
cfg.set_rtc_dbias_slp(RTC_CNTL_DBIAS_1V10);
cfg.set_dig_dbias_slp(RTC_CNTL_DBIAS_1V10);
cfg
}
}
const DR_REG_NRX_BASE: u32 = 0x6001CC00;
const DR_REG_FE_BASE: u32 = 0x60006000;
const DR_REG_FE2_BASE: u32 = 0x60005000;
const NRXPD_CTRL: u32 = DR_REG_NRX_BASE + 0x00d4;
const FE_GEN_CTRL: u32 = DR_REG_FE_BASE + 0x0090;
const FE2_TX_INTERP_CTRL: u32 = DR_REG_FE2_BASE + 0x00f0;
const SYSCON_SRAM_POWER_UP: u8 = 0x0000000F;
const SYSCON_ROM_POWER_UP: u8 = 0x00000003;
const NRX_RX_ROT_FORCE_PU: u32 = 1 << 5;
const NRX_VIT_FORCE_PU: u32 = 1 << 3;
const NRX_DEMAP_FORCE_PU: u32 = 1 << 1;
const FE_IQ_EST_FORCE_PU: u32 = 1 << 5;
const FE2_TX_INF_FORCE_PU: u32 = 1 << 10;
fn modify_register(reg: u32, mask: u32, value: u32) {
let reg = reg as *mut u32;
unsafe { reg.write_volatile((reg.read_volatile() & !mask) | value) };
}
fn register_modify_bits(reg: u32, bits: u32, set: bool) {
if set {
modify_register(reg, bits, bits);
} else {
modify_register(reg, bits, 0);
}
}
fn rtc_sleep_pu(val: bool) {
let rtc_cntl = unsafe { &*esp32c2::RTC_CNTL::ptr() };
let syscon = unsafe { &*esp32c2::APB_CTRL::ptr() };
let bb = unsafe { &*esp32c2::BB::ptr() };
rtc_cntl
.dig_pwc()
.modify(|_, w| w.lslp_mem_force_pu().bit(val));
syscon.front_end_mem_pd().modify(|_r, w| {
w.dc_mem_force_pu()
.bit(val)
.pbus_mem_force_pu()
.bit(val)
.agc_mem_force_pu()
.bit(val)
});
bb.bbpd_ctrl()
.modify(|_r, w| w.fft_force_pu().bit(val).dc_est_force_pu().bit(val));
register_modify_bits(
NRXPD_CTRL,
NRX_RX_ROT_FORCE_PU | NRX_VIT_FORCE_PU | NRX_DEMAP_FORCE_PU,
val,
);
register_modify_bits(FE_GEN_CTRL, FE_IQ_EST_FORCE_PU, val);
register_modify_bits(FE2_TX_INTERP_CTRL, FE2_TX_INF_FORCE_PU, val);
syscon.mem_power_up().modify(|_r, w| unsafe {
w.sram_power_up()
.bits(if val { SYSCON_SRAM_POWER_UP } else { 0 })
.rom_power_up()
.bits(if val { SYSCON_ROM_POWER_UP } else { 0 })
});
}
impl RtcSleepConfig {
/// Configures the RTC for deep sleep mode.
pub fn deep() -> Self {
// Set up for ultra-low power sleep. Wakeup sources may modify these settings.
let mut cfg = Self::default();
cfg.set_lslp_mem_inf_fpu(false);
cfg.set_rtc_mem_inf_follow_cpu(true); // ?
cfg.set_rtc_fastmem_pd_en(true);
cfg.set_rtc_slowmem_pd_en(true);
cfg.set_rtc_peri_pd_en(true);
cfg.set_wifi_pd_en(true);
cfg.set_bt_pd_en(true);
cfg.set_cpu_pd_en(true);
cfg.set_int_8m_pd_en(true);
cfg.set_dig_peri_pd_en(true);
cfg.set_dig_dbias_slp(0); // because of dig_peri_pd_en
cfg.set_deep_slp(true);
cfg.set_wdt_flashboot_mod_en(false);
cfg.set_vddsdio_pd_en(true);
cfg.set_xtal_fpu(false);
cfg.set_deep_slp_reject(true);
cfg.set_light_slp_reject(true);
cfg.set_rtc_dbias_slp(RTC_CNTL_DBIAS_1V10);
// because of dig_peri_pd_en
cfg.set_rtc_regulator_fpu(false);
cfg.set_dbg_atten_slp(RTC_CNTL_DBG_ATTEN_DEEPSLEEP_DEFAULT);
// because of xtal_fpu
cfg.set_bias_sleep_monitor(true);
cfg.set_bias_sleep_slp(true);
cfg.set_pd_cur_slp(true);
cfg
}
pub(crate) fn base_settings(_rtc: &Rtc<'_>) {
let cfg = RtcConfig::default();
// settings derived from esp_clk_init -> rtc_init
unsafe {
let rtc_cntl = &*esp32c2::RTC_CNTL::ptr();
let extmem = &*esp32c2::EXTMEM::ptr();
let system = &*esp32c2::SYSTEM::ptr();
regi2c_write_mask!(I2C_DIG_REG, I2C_DIG_REG_XPD_RTC_REG, 0);
regi2c_write_mask!(I2C_DIG_REG, I2C_DIG_REG_XPD_DIG_REG, 0);
rtc_cntl.timer1().modify(|_, w| {
w.pll_buf_wait()
.bits(cfg.pll_wait())
.ck8m_wait()
.bits(cfg.ck8m_wait())
});
// Moved from rtc sleep to rtc init to save sleep function running time
// set shortest possible sleep time limit
rtc_cntl
.timer5()
.modify(|_, w| w.min_slp_val().bits(RTC_CNTL_MIN_SLP_VAL_MIN));
// TODO: something about cali_ocode
// Reset RTC bias to default value (needed if waking up from deep sleep)
regi2c_write_mask!(
I2C_DIG_REG,
I2C_DIG_REG_EXT_RTC_DREG_SLEEP,
RTC_CNTL_DBIAS_1V10
);
// LDO dbias initialization
// TODO: this modifies g_rtc_dbias_pvt_non_240m and g_dig_dbias_pvt_non_240m.
// We're using a high enough default but we should read from the efuse.
// set_rtc_dig_dbias();
regi2c_write_mask!(I2C_DIG_REG, I2C_DIG_REG_EXT_RTC_DREG, RTC_CNTL_DBIAS_1V25);
regi2c_write_mask!(I2C_DIG_REG, I2C_DIG_REG_EXT_DIG_DREG, RTC_CNTL_DBIAS_1V25);
if cfg.clkctl_init() {
// clear CMMU clock force on
extmem
.cache_mmu_power_ctrl()
.modify(|_, w| w.cache_mmu_mem_force_on().clear_bit());
// clear tag clock force on
extmem
.icache_tag_power_ctrl()
.modify(|_, w| w.icache_tag_mem_force_on().clear_bit());
// clear register clock force on
// clear register clock force on
(*esp32c2::SPI0::ptr())
.clock_gate()
.modify(|_, w| w.clk_en().clear_bit());
(*esp32c2::SPI1::ptr())
.clock_gate()
.modify(|_, w| w.clk_en().clear_bit());
}
if cfg.pwrctl_init() {
rtc_cntl
.clk_conf()
.modify(|_, w| w.ck8m_force_pu().clear_bit());
rtc_cntl
.options0()
.modify(|_, w| w.xtl_force_pu().bit(cfg.xtal_fpu() || cfg.bbpll_fpu()));
// cancel bbpll force pu if setting no force power up
rtc_cntl.options0().modify(|_, w| {
w.bbpll_force_pu()
.bit(cfg.bbpll_fpu())
.bbpll_i2c_force_pu()
.bit(cfg.bbpll_fpu())
.bb_i2c_force_pu()
.bit(cfg.bbpll_fpu())
});
rtc_cntl
.rtc_cntl()
.modify(|_, w| w.regulator_force_pu().clear_bit());
// If this mask is enabled, all soc memories cannot enter power down mode
// We should control soc memory power down mode from RTC, so we will not touch
// this register any more
system
.mem_pd_mask()
.modify(|_, w| w.lslp_mem_pd_mask().clear_bit());
// If this pd_cfg is set to 1, all memory won't enter low power mode during
// light sleep If this pd_cfg is set to 0, all memory will enter low
// power mode during light sleep
rtc_sleep_pu(false);
rtc_cntl
.dig_pwc()
.modify(|_, w| w.dg_wrap_force_pu().clear_bit());
rtc_cntl
.dig_iso()
.modify(|_, w| w.dg_wrap_force_noiso().clear_bit());
// if SYSTEM_CPU_WAIT_MODE_FORCE_ON == 0 , the cpu clk will be closed when cpu
// enter WAITI mode
system
.cpu_per_conf()
.modify(|_, w| w.cpu_wait_mode_force_on().bit(!cfg.cpu_waiti_clk_gate()));
// cancel digital PADS force no iso
rtc_cntl.dig_iso().modify(|_, w| {
w.dg_pad_force_unhold()
.clear_bit()
.dg_pad_force_noiso()
.clear_bit()
});
}
rtc_cntl.int_ena().write(|w| w.bits(0));
rtc_cntl.int_clr().write(|w| w.bits(u32::MAX));
regi2c_write_mask!(I2C_ULP, I2C_ULP_IR_FORCE_XPD_CK, 1);
}
}
pub(crate) fn apply(&self) {
// like esp-idf rtc_sleep_init()
let rtc_cntl = unsafe { &*esp32c2::RTC_CNTL::ptr() };
if self.lslp_mem_inf_fpu() {
rtc_sleep_pu(true);
}
unsafe {
assert!(!self.pd_cur_slp() || self.bias_sleep_slp());
regi2c_write_mask!(
I2C_DIG_REG,
I2C_DIG_REG_EXT_RTC_DREG_SLEEP,
self.rtc_dbias_slp()
);
regi2c_write_mask!(
I2C_DIG_REG,
I2C_DIG_REG_EXT_DIG_DREG_SLEEP,
self.dig_dbias_slp()
);
rtc_cntl.bias_conf().modify(|_, w| {
w.dbg_atten_monitor()
.bits(RTC_CNTL_DBG_ATTEN_MONITOR_DEFAULT)
// We have config values for this in self, so I don't know why we're setting
// hardcoded defaults for these next two. It's what IDF does...
.bias_sleep_monitor()
.bit(RTC_CNTL_BIASSLP_MONITOR_DEFAULT)
.pd_cur_monitor()
.bit(RTC_CNTL_PD_CUR_MONITOR_DEFAULT)
});
rtc_cntl.bias_conf().modify(|_, w| {
w.dbg_atten_deep_slp()
.bits(self.dbg_atten_slp())
.bias_sleep_deep_slp()
.bit(self.bias_sleep_slp())
.pd_cur_deep_slp()
.bit(self.pd_cur_slp())
});
if self.deep_slp() {
regi2c_write_mask!(I2C_ULP, I2C_ULP_IR_FORCE_XPD_CK, 0);
rtc_cntl
.dig_pwc()
.modify(|_, w| w.dg_wrap_pd_en().set_bit());
rtc_cntl.ana_conf().modify(|_, w| {
w.ckgen_i2c_pu()
.clear_bit()
.pll_i2c_pu()
.clear_bit()
.rfrx_pbus_pu()
.clear_bit()
.txrf_i2c_pu()
.clear_bit()
});
rtc_cntl
.options0()
.modify(|_, w| w.bb_i2c_force_pu().clear_bit());
} else {
rtc_cntl.bias_conf().modify(|_, w| {
w.dg_vdd_drv_b_slp_en()
.set_bit()
.dg_vdd_drv_b_slp()
.bits(RTC_CNTL_DG_VDD_DRV_B_SLP_DEFAULT)
});
rtc_cntl
.dig_pwc()
.modify(|_, w| w.dg_wrap_pd_en().clear_bit());
}
rtc_cntl
.rtc_cntl()
.modify(|_, w| w.regulator_force_pu().bit(self.rtc_regulator_fpu()));
rtc_cntl.clk_conf().modify(|_, w| {
w.ck8m_force_pu()
.bit(!self.int_8m_pd_en())
.ck8m_force_nogating()
.bit(!self.int_8m_pd_en())
});
// enable VDDSDIO control by state machine
rtc_cntl.dig_pwc().modify(|_, w| {
w.vdd_spi_pwr_force()
.clear_bit()
.vdd_spi_pd_en()
.bit(self.vddsdio_pd_en())
});
rtc_cntl.slp_reject_conf().modify(|_, w| {
w.deep_slp_reject_en()
.bit(self.deep_slp_reject())
.light_slp_reject_en()
.bit(self.light_slp_reject())
});
rtc_cntl
.options0()
.modify(|_, w| w.xtl_force_pu().bit(self.xtal_fpu()));
rtc_cntl
.clk_conf()
.modify(|_, w| w.xtal_global_force_nogating().bit(self.xtal_fpu()));
}
}
pub(crate) fn start_sleep(&self, wakeup_triggers: WakeTriggers) {
unsafe {
let rtc_cntl = &*esp32c2::RTC_CNTL::ptr();
// set bits for what can wake us up
rtc_cntl
.wakeup_state()
.modify(|_, w| w.wakeup_ena().bits(wakeup_triggers.0.into()));
rtc_cntl
.state0()
.write(|w| w.sleep_en().set_bit().slp_wakeup().set_bit());
}
}
pub(crate) fn finish_sleep(&self) {
// In deep sleep mode, we never get here
unsafe {
let rtc_cntl = &*esp32c2::RTC_CNTL::ptr();
rtc_cntl.int_clr().write(|w| {
w.slp_reject()
.clear_bit_by_one()
.slp_wakeup()
.clear_bit_by_one()
});
// restore config if it is a light sleep
if self.lslp_mem_inf_fpu() {
rtc_sleep_pu(true);
}
}
}
}

View File

@ -15,12 +15,12 @@
//! * `BT (Bluetooth) wake` - light sleep only //! * `BT (Bluetooth) wake` - light sleep only
use core::cell::RefCell; use core::cell::RefCell;
#[cfg(any(esp32, esp32c3, esp32s3, esp32c6))] #[cfg(any(esp32, esp32c3, esp32s3, esp32c6, esp32c2))]
use core::time::Duration; use core::time::Duration;
#[cfg(any(esp32, esp32s3))] #[cfg(any(esp32, esp32s3))]
use crate::gpio::RtcPin as RtcIoWakeupPinType; use crate::gpio::RtcPin as RtcIoWakeupPinType;
#[cfg(any(esp32c3, esp32c6))] #[cfg(any(esp32c3, esp32c6, esp32c2))]
use crate::gpio::RtcPinWithResistors as RtcIoWakeupPinType; use crate::gpio::RtcPinWithResistors as RtcIoWakeupPinType;
use crate::rtc_cntl::Rtc; use crate::rtc_cntl::Rtc;
@ -28,6 +28,7 @@ use crate::rtc_cntl::Rtc;
#[cfg_attr(esp32s3, path = "esp32s3.rs")] #[cfg_attr(esp32s3, path = "esp32s3.rs")]
#[cfg_attr(esp32c3, path = "esp32c3.rs")] #[cfg_attr(esp32c3, path = "esp32c3.rs")]
#[cfg_attr(esp32c6, path = "esp32c6.rs")] #[cfg_attr(esp32c6, path = "esp32c6.rs")]
#[cfg_attr(esp32c2, path = "esp32c2.rs")]
mod sleep_impl; mod sleep_impl;
pub use sleep_impl::*; pub use sleep_impl::*;
@ -45,13 +46,13 @@ pub enum WakeupLevel {
/// Represents a timer wake-up source, triggering an event after a specified /// Represents a timer wake-up source, triggering an event after a specified
/// duration. /// duration.
#[derive(Debug, Default, Clone, Copy)] #[derive(Debug, Default, Clone, Copy)]
#[cfg(any(esp32, esp32c3, esp32s3, esp32c6))] #[cfg(any(esp32, esp32c3, esp32s3, esp32c6, esp32c2))]
pub struct TimerWakeupSource { pub struct TimerWakeupSource {
/// The duration after which the wake-up event is triggered. /// The duration after which the wake-up event is triggered.
duration: Duration, duration: Duration,
} }
#[cfg(any(esp32, esp32c3, esp32s3, esp32c6))] #[cfg(any(esp32, esp32c3, esp32s3, esp32c6, esp32c2))]
impl TimerWakeupSource { impl TimerWakeupSource {
/// Creates a new timer wake-up source with the specified duration. /// Creates a new timer wake-up source with the specified duration.
pub fn new(duration: Duration) -> Self { pub fn new(duration: Duration) -> Self {
@ -134,12 +135,12 @@ impl<'a, 'b> Ext1WakeupSource<'a, 'b> {
/// RTC_IO wakeup allows configuring any combination of RTC_IO pins with /// RTC_IO wakeup allows configuring any combination of RTC_IO pins with
/// arbitrary wakeup levels to wake up the chip from sleep. This wakeup source /// arbitrary wakeup levels to wake up the chip from sleep. This wakeup source
/// can be used to wake up from both light and deep sleep. /// can be used to wake up from both light and deep sleep.
#[cfg(any(esp32c3, esp32s3))] #[cfg(any(esp32c3, esp32s3, esp32c2))]
pub struct RtcioWakeupSource<'a, 'b> { pub struct RtcioWakeupSource<'a, 'b> {
pins: RefCell<&'a mut [(&'b mut dyn RtcIoWakeupPinType, WakeupLevel)]>, pins: RefCell<&'a mut [(&'b mut dyn RtcIoWakeupPinType, WakeupLevel)]>,
} }
#[cfg(any(esp32c3, esp32s3))] #[cfg(any(esp32c3, esp32s3, esp32c2))]
impl<'a, 'b> RtcioWakeupSource<'a, 'b> { impl<'a, 'b> RtcioWakeupSource<'a, 'b> {
/// Creates a new external wake-up source (Ext1). /// Creates a new external wake-up source (Ext1).
pub fn new(pins: &'a mut [(&'b mut dyn RtcIoWakeupPinType, WakeupLevel)]) -> Self { pub fn new(pins: &'a mut [(&'b mut dyn RtcIoWakeupPinType, WakeupLevel)]) -> Self {

View File

@ -198,6 +198,15 @@ crate::gpio::gpio! {
(20, 0, InputOutput (0 => U0RXD) ()) (20, 0, InputOutput (0 => U0RXD) ())
} }
crate::gpio::rtc_pins! {
0
1
2
3
4
5
}
crate::gpio::analog! { crate::gpio::analog! {
0 0
1 1

View File

@ -1,6 +1,6 @@
//! Demonstrates deep sleep with timer wakeup //! Demonstrates deep sleep with timer wakeup
//% CHIPS: esp32 esp32c3 esp32c6 esp32s3 //% CHIPS: esp32 esp32c3 esp32c6 esp32s3 esp32c2
#![no_std] #![no_std]
#![no_main] #![no_main]

View File

@ -7,7 +7,7 @@
//! The following wiring is assumed for ESP32S3: //! The following wiring is assumed for ESP32S3:
//! - RTC wakeup pin => GPIO18 (low level) //! - RTC wakeup pin => GPIO18 (low level)
//% CHIPS: esp32c3 esp32s3 //% CHIPS: esp32c3 esp32s3 esp32c2
#![no_std] #![no_std]
#![no_main] #![no_main]
@ -48,7 +48,7 @@ fn main() -> ! {
let timer = TimerWakeupSource::new(Duration::from_secs(10)); let timer = TimerWakeupSource::new(Duration::from_secs(10));
cfg_if::cfg_if! { cfg_if::cfg_if! {
if #[cfg(feature = "esp32c3")] { if #[cfg(any(feature = "esp32c3", feature = "esp32c2"))] {
let wakeup_pins: &mut [(&mut dyn gpio::RtcPinWithResistors, WakeupLevel)] = &mut [ let wakeup_pins: &mut [(&mut dyn gpio::RtcPinWithResistors, WakeupLevel)] = &mut [
(&mut io.pins.gpio2, WakeupLevel::Low), (&mut io.pins.gpio2, WakeupLevel::Low),
(&mut io.pins.gpio3, WakeupLevel::High), (&mut io.pins.gpio3, WakeupLevel::High),