// Copyright 2015-2017 Espressif Systems (Shanghai) PTE LTD // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. #pragma once #include #include #include #include "soc/soc.h" #ifdef __cplusplus extern "C" { #endif /** * @file rtc.h * @brief Low-level RTC power, clock, and sleep functions. * * Functions in this file facilitate configuration of ESP32's RTC_CNTL peripheral. * RTC_CNTL peripheral handles many functions: * - enables/disables clocks and power to various parts of the chip; this is * done using direct register access (forcing power up or power down) or by * allowing state machines to control power and clocks automatically * - handles sleep and wakeup functions * - maintains a 48-bit counter which can be used for timekeeping * * These functions are not thread safe, and should not be viewed as high level * APIs. For example, while this file provides a function which can switch * CPU frequency, this function is on its own is not sufficient to implement * frequency switching in ESP-IDF context: some coordination with RTOS, * peripheral drivers, and WiFi/BT stacks is also required. * * These functions will normally not be used in applications directly. * ESP-IDF provides, or will provide, drivers and other facilities to use * RTC subsystem functionality. * * The functions are loosely split into the following groups: * - rtc_clk: clock switching, calibration * - rtc_time: reading RTC counter, conversion between counter values and time * - rtc_sleep: entry into sleep modes * - rtc_init: initialization */ #ifndef __ZEPHYR__ #define MHZ (1000000) #endif #define RTC_SLOW_CLK_X32K_CAL_TIMEOUT_THRES(cycles) (cycles << 12) #define RTC_SLOW_CLK_8MD256_CAL_TIMEOUT_THRES(cycles) (cycles << 12) #define RTC_SLOW_CLK_90K_CAL_TIMEOUT_THRES(cycles) (cycles << 10) #define RTC_SLOW_CLK_FREQ_90K 90000 #define RTC_SLOW_CLK_FREQ_8MD256 (RTC_FAST_CLK_FREQ_APPROX / 256) #define RTC_SLOW_CLK_FREQ_32K 32768 #define OTHER_BLOCKS_POWERUP 1 #define OTHER_BLOCKS_WAIT 1 /* 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. */ #define RTC_CNTL_DBIAS_0V90 0 #define RTC_CNTL_DBIAS_0V95 1 #define RTC_CNTL_DBIAS_1V00 2 #define RTC_CNTL_DBIAS_1V05 3 #define RTC_CNTL_DBIAS_1V10 4 #define RTC_CNTL_DBIAS_1V15 5 #define RTC_CNTL_DBIAS_1V20 6 #define RTC_CNTL_DBIAS_1V25 7 #define DELAY_FAST_CLK_SWITCH 3 #define DELAY_SLOW_CLK_SWITCH 300 #define DELAY_8M_ENABLE 50 /* Number of 8M/256 clock cycles to use for XTAL frequency estimation. * 10 cycles will take approximately 300 microseconds. */ #define XTAL_FREQ_EST_CYCLES 10 /* Core voltage needs to be increased in two cases: * 1. running at 240 MHz * 2. running with 80MHz Flash frequency */ #ifdef CONFIG_ESPTOOLPY_FLASHFREQ_80M #define DIG_DBIAS_80M_160M RTC_CNTL_DBIAS_1V25 #else #define DIG_DBIAS_80M_160M RTC_CNTL_DBIAS_1V10 #endif #define DIG_DBIAS_240M RTC_CNTL_DBIAS_1V25 #define DIG_DBIAS_XTAL RTC_CNTL_DBIAS_1V10 #define DIG_DBIAS_2M RTC_CNTL_DBIAS_1V00 #define RTC_CNTL_PLL_BUF_WAIT_DEFAULT 20 #define RTC_CNTL_XTL_BUF_WAIT_DEFAULT 100 #define RTC_CNTL_CK8M_WAIT_DEFAULT 20 #define RTC_CK8M_ENABLE_WAIT_DEFAULT 5 /* Various delays to be programmed into power control state machines */ #define RTC_CNTL_PLL_BUF_WAIT_SLP_CYCLES (1) #define RTC_CNTL_XTL_BUF_WAIT_SLP_US (1000) #define RTC_CNTL_CK8M_WAIT_SLP_CYCLES (4) #define RTC_CNTL_WAKEUP_DELAY_CYCLES (4) #define RTC_CNTL_CK8M_DFREQ_DEFAULT 172 #define RTC_CNTL_SCK_DCAP_DEFAULT 255 #define RTC_CNTL_ULPCP_TOUCH_START_WAIT_IN_SLEEP (0xFF) #define RTC_CNTL_ULPCP_TOUCH_START_WAIT_DEFAULT (0x10) /* set sleep_init default param */ #define RTC_CNTL_DBG_ATTEN_LIGHTSLEEP_DEFAULT 6 #define RTC_CNTL_DBG_ATTEN_LIGHTSLEEP_NODROP 0 #define RTC_CNTL_DBG_ATTEN_DEEPSLEEP_DEFAULT 15 #define RTC_CNTL_DBG_ATTEN_MONITOR_DEFAULT 0 #define RTC_CNTL_BIASSLP_MONITOR_DEFAULT 0 #define RTC_CNTL_BIASSLP_SLEEP_ON 0 #define RTC_CNTL_BIASSLP_SLEEP_DEFAULT 1 #define RTC_CNTL_PD_CUR_MONITOR_DEFAULT 1 #define RTC_CNTL_PD_CUR_SLEEP_ON 0 #define RTC_CNTL_PD_CUR_SLEEP_DEFAULT 1 #define APLL_SDM_STOP_VAL_1 0x09 #define APLL_SDM_STOP_VAL_2_REV0 0x69 #define APLL_SDM_STOP_VAL_2_REV1 0x49 #define APLL_CAL_DELAY_1 0x0f #define APLL_CAL_DELAY_2 0x3f #define APLL_CAL_DELAY_3 0x1f /** * @brief Possible main XTAL frequency values. * * Enum values should be equal to frequency in MHz. */ typedef enum { RTC_XTAL_FREQ_40M = 40, //!< 40 MHz XTAL } rtc_xtal_freq_t; /** @brief Fixed crystal frequency for this SoC On an SoC where only one crystal frequency is supported, using this macro is an alternative to calling rtc_clk_xtal_freq_get() */ #define RTC_XTAL_FREQ RTC_XTAL_FREQ_40M /** * @brief CPU frequency values */ typedef enum { RTC_CPU_FREQ_XTAL = 0, //!< Main XTAL frequency RTC_CPU_FREQ_80M = 1, //!< 80 MHz RTC_CPU_FREQ_160M = 2, //!< 160 MHz RTC_CPU_FREQ_240M = 3, //!< 240 MHz RTC_CPU_FREQ_2M = 4, //!< 2 MHz RTC_CPU_320M_80M = 5, //!< for test RTC_CPU_320M_160M = 6, //!< for test RTC_CPU_FREQ_XTAL_DIV2 = 7, //!< XTAL/2 after reset } rtc_cpu_freq_t; /** * @brief CPU clock source */ typedef enum { RTC_CPU_FREQ_SRC_XTAL, //!< XTAL RTC_CPU_FREQ_SRC_PLL, //!< PLL (480M or 320M) RTC_CPU_FREQ_SRC_8M, //!< Internal 8M RTC oscillator RTC_CPU_FREQ_SRC_APLL //!< APLL } rtc_cpu_freq_src_t; /** * @brief CPU clock configuration structure */ typedef struct rtc_cpu_freq_config_s { rtc_cpu_freq_src_t source; //!< The clock from which CPU clock is derived uint32_t source_freq_mhz; //!< Source clock frequency uint32_t div; //!< Divider, freq_mhz = source_freq_mhz / div uint32_t freq_mhz; //!< CPU clock frequency } rtc_cpu_freq_config_t; /** * @brief RTC SLOW_CLK frequency values */ typedef enum { RTC_SLOW_FREQ_RTC = 0, //!< Internal 90 kHz RC oscillator RTC_SLOW_FREQ_32K_XTAL = 1, //!< External 32 kHz XTAL RTC_SLOW_FREQ_8MD256 = 2, //!< Internal 8 MHz RC oscillator, divided by 256 } rtc_slow_freq_t; /** * @brief RTC FAST_CLK frequency values */ typedef enum { RTC_FAST_FREQ_XTALD4 = 0, //!< Main XTAL, divided by 4 RTC_FAST_FREQ_8M = 1, //!< Internal 8 MHz RC oscillator } rtc_fast_freq_t; /* With the default value of CK8M_DFREQ, 8M clock frequency is 8.5 MHz +/- 7% */ #define RTC_FAST_CLK_FREQ_APPROX 8500000 #define RTC_CLK_CAL_FRACT 19 //!< Number of fractional bits in values returned by rtc_clk_cal #define RTC_VDDSDIO_TIEH_1_8V 0 //!< TIEH field value for 1.8V VDDSDIO #define RTC_VDDSDIO_TIEH_3_3V 1 //!< TIEH field value for 3.3V VDDSDIO /** * @brief Clock source to be calibrated using rtc_clk_cal function */ typedef enum { RTC_CAL_RTC_MUX = 0, //!< Currently selected RTC SLOW_CLK RTC_CAL_8MD256 = 1, //!< Internal 8 MHz RC oscillator, divided by 256 RTC_CAL_32K_XTAL = 2, //!< External 32 kHz XTAL RTC_CAL_INTERNAL_OSC = 3 //!< Internal 150 kHz oscillator } rtc_cal_sel_t; /** * Initialization parameters for rtc_clk_init */ typedef struct { rtc_xtal_freq_t xtal_freq : 8; //!< Main XTAL frequency uint32_t cpu_freq_mhz : 10; //!< CPU frequency to set, in MHz rtc_fast_freq_t fast_freq : 1; //!< RTC_FAST_CLK frequency to set rtc_slow_freq_t slow_freq : 2; //!< RTC_SLOW_CLK frequency to set uint32_t clk_rtc_clk_div : 8; uint32_t clk_8m_clk_div : 3; //!< RTC 8M clock divider (division is by clk_8m_div+1, i.e. 0 means 8MHz frequency) uint32_t slow_clk_dcap : 8; //!< RTC 90k clock adjustment parameter (higher value leads to lower frequency) uint32_t clk_8m_dfreq : 8; //!< RTC 8m clock adjustment parameter (higher value leads to higher frequency) } rtc_clk_config_t; /** * Default initializer for rtc_clk_config_t */ #define RTC_CLK_CONFIG_DEFAULT() { \ .xtal_freq = RTC_XTAL_FREQ_40M, \ .cpu_freq_mhz = 80, \ .fast_freq = RTC_FAST_FREQ_8M, \ .slow_freq = RTC_SLOW_FREQ_RTC, \ .clk_rtc_clk_div = 0, \ .clk_8m_clk_div = 0, \ .slow_clk_dcap = RTC_CNTL_SCK_DCAP_DEFAULT, \ .clk_8m_dfreq = RTC_CNTL_CK8M_DFREQ_DEFAULT, \ } typedef struct { uint32_t dac : 6; uint32_t dres : 3; uint32_t dgm : 3; uint32_t dbuf: 1; } x32k_config_t; #define X32K_CONFIG_DEFAULT() { \ .dac = 3, \ .dres = 3, \ .dgm = 3, \ .dbuf = 1, \ } #if 0 #define X32K_CONFIG_BOOTSTRAP_DEFAULT() { \ .dac = 3, \ .dres = 3, \ .dgm = 0, \ } typedef struct { x32k_config_t x32k_cfg; uint32_t bt_lpck_div_num : 12; uint32_t bt_lpck_div_a : 12; uint32_t bt_lpck_div_b : 12; } x32k_bootstrap_config_t; #define X32K_BOOTSTRAP_CONFIG_DEFAULT() { \ .x32k_cfg = X32K_CONFIG_BOOTSTRAP_DEFAULT(), \ .bt_lpck_div_num = 2441, \ .bt_lpck_div_a = 32, \ .bt_lpck_div_b = 13, \ } #endif typedef struct { uint16_t wifi_powerup_cycles : 7; uint16_t wifi_wait_cycles : 9; uint16_t rtc_powerup_cycles : 7; uint16_t rtc_wait_cycles : 9; uint16_t dg_wrap_powerup_cycles : 7; uint16_t dg_wrap_wait_cycles : 9; uint16_t rtc_mem_powerup_cycles : 7; uint16_t rtc_mem_wait_cycles : 9; } rtc_init_config_t; #define RTC_INIT_CONFIG_DEFAULT() { \ .wifi_powerup_cycles = OTHER_BLOCKS_POWERUP, \ .wifi_wait_cycles = OTHER_BLOCKS_WAIT, \ .rtc_powerup_cycles = OTHER_BLOCKS_POWERUP, \ .rtc_wait_cycles = OTHER_BLOCKS_WAIT, \ .dg_wrap_powerup_cycles = OTHER_BLOCKS_POWERUP, \ .dg_wrap_wait_cycles = OTHER_BLOCKS_WAIT, \ .rtc_mem_powerup_cycles = OTHER_BLOCKS_POWERUP, \ .rtc_mem_wait_cycles = OTHER_BLOCKS_WAIT, \ } /* Two different calibration mode for slow clock */ #define RTC_TIME_CAL_ONEOFF_MODE 0 #define RTC_TIME_CAL_CYCLING_MODE 1 void rtc_clk_divider_set(uint32_t div); void rtc_clk_8m_divider_set(uint32_t div); /** * Initialize clocks and set CPU frequency * * @param cfg clock configuration as rtc_clk_config_t */ void rtc_clk_init(rtc_clk_config_t cfg); /** * @brief Get main XTAL frequency * * Result is a constant as XTAL frequency is fixed. * * @note Function is included for ESP32 compatible code only. Code which only * needs to support this SoC can use the macro RTC_XTAL_FREQ for this SoC's * fixed crystal value. * * @return XTAL frequency in MHz, RTC_XTAL_FREQ_40M */ rtc_xtal_freq_t rtc_clk_xtal_freq_get(void); /** * @brief Enable or disable 32 kHz XTAL oscillator * @param en true to enable, false to disable */ void rtc_clk_32k_enable(bool en); /** * @brief Configure 32 kHz XTAL oscillator to accept external clock signal */ void rtc_clk_32k_enable_external(void); /** * @brief Get the state of 32k XTAL oscillator * @return true if 32k XTAL oscillator has been enabled */ bool rtc_clk_32k_enabled(void); /** * @brief Enable 32k oscillator, configuring it for fast startup time. * Note: to achieve higher frequency stability, rtc_clk_32k_enable function * must be called one the 32k XTAL oscillator has started up. This function * will initially disable the 32k XTAL oscillator, so it should not be called * when the system is using 32k XTAL as RTC_SLOW_CLK. * * @param cycle Number of 32kHz cycles to bootstrap external crystal. * If 0, no square wave will be used to bootstrap crystal oscillation. */ void rtc_clk_32k_bootstrap(uint32_t cycle); /** * @brief Enable or disable 8 MHz internal oscillator * * Output from 8 MHz internal oscillator is passed into a configurable * divider, which by default divides the input clock frequency by 256. * Output of the divider may be used as RTC_SLOW_CLK source. * Output of the divider is referred to in register descriptions and code as * 8md256 or simply d256. Divider values other than 256 may be configured, but * this facility is not currently needed, so is not exposed in the code. * * When 8MHz/256 divided output is not needed, the divider should be disabled * to reduce power consumption. * * @param clk_8m_en true to enable 8MHz generator * @param d256_en true to enable /256 divider */ void rtc_clk_8m_enable(bool clk_8m_en, bool d256_en); /** * @brief Get the state of 8 MHz internal oscillator * @return true if the oscillator is enabled */ bool rtc_clk_8m_enabled(void); /** * @brief Get the state of /256 divider which is applied to 8MHz clock * @return true if the divided output is enabled */ bool rtc_clk_8md256_enabled(void); /** * @brief Enable or disable APLL * * Output frequency is given by the formula: * apll_freq = xtal_freq * (4 + sdm2 + sdm1/256 + sdm0/65536)/((o_div + 2) * 2) * * The dividend in this expression should be in the range of 240 - 600 MHz. * * In rev. 0 of ESP32, sdm0 and sdm1 are unused and always set to 0. * * @param enable true to enable, false to disable * @param sdm0 frequency adjustment parameter, 0..255 * @param sdm1 frequency adjustment parameter, 0..255 * @param sdm2 frequency adjustment parameter, 0..63 * @param o_div frequency divider, 0..31 */ void rtc_clk_apll_enable(bool enable, uint32_t sdm0, uint32_t sdm1, uint32_t sdm2, uint32_t o_div); /** * @brief Select source for RTC_SLOW_CLK * @param slow_freq clock source (one of rtc_slow_freq_t values) */ void rtc_clk_slow_freq_set(rtc_slow_freq_t slow_freq); /** * @brief Get the RTC_SLOW_CLK source * @return currently selected clock source (one of rtc_slow_freq_t values) */ rtc_slow_freq_t rtc_clk_slow_freq_get(void); /** * @brief Get the approximate frequency of RTC_SLOW_CLK, in Hz * * - if RTC_SLOW_FREQ_RTC is selected, returns ~90000 * - if RTC_SLOW_FREQ_32K_XTAL is selected, returns 32768 * - if RTC_SLOW_FREQ_8MD256 is selected, returns ~33000 * * rtc_clk_cal function can be used to get more precise value by comparing * RTC_SLOW_CLK frequency to the frequency of main XTAL. * * @return RTC_SLOW_CLK frequency, in Hz */ uint32_t rtc_clk_slow_freq_get_hz(void); /** * @brief Select source for RTC_FAST_CLK * @param fast_freq clock source (one of rtc_fast_freq_t values) */ void rtc_clk_fast_freq_set(rtc_fast_freq_t fast_freq); /** * @brief Get the RTC_FAST_CLK source * @return currently selected clock source (one of rtc_fast_freq_t values) */ rtc_fast_freq_t rtc_clk_fast_freq_get(void); /** * @brief Get CPU frequency config for a given frequency * @param freq_mhz Frequency in MHz * @param[out] out_config Output, CPU frequency configuration structure * @return true if frequency can be obtained, false otherwise */ bool rtc_clk_cpu_freq_mhz_to_config(uint32_t freq_mhz, rtc_cpu_freq_config_t* out_config); /** * @brief Switch CPU frequency * * This function sets CPU frequency according to the given configuration * structure. It enables PLLs, if necessary. * * @note This function in not intended to be called by applications in FreeRTOS * environment. This is because it does not adjust various timers based on the * new CPU frequency. * * @param config CPU frequency configuration structure */ void rtc_clk_cpu_freq_set_config(const rtc_cpu_freq_config_t* config); /** * @brief Switch CPU frequency (optimized for speed) * * This function is a faster equivalent of rtc_clk_cpu_freq_set_config. * It works faster because it does not disable PLLs when switching from PLL to * XTAL and does not enabled them when switching back. If PLL is not already * enabled when this function is called to switch from XTAL to PLL frequency, * or the PLL which is enabled is the wrong one, this function will fall back * to calling rtc_clk_cpu_freq_set_config. * * Unlike rtc_clk_cpu_freq_set_config, this function relies on static data, * so it is less safe to use it e.g. from a panic handler (when memory might * be corrupted). * * @note This function in not intended to be called by applications in FreeRTOS * environment. This is because it does not adjust various timers based on the * new CPU frequency. * * @param config CPU frequency configuration structure */ void rtc_clk_cpu_freq_set_config_fast(const rtc_cpu_freq_config_t* config); /** * @brief Get the currently used CPU frequency configuration * @param[out] out_config Output, CPU frequency configuration structure */ void rtc_clk_cpu_freq_get_config(rtc_cpu_freq_config_t* out_config); /** * @brief Switch CPU clock source to XTAL * * Short form for filling in rtc_cpu_freq_config_t structure and calling * rtc_clk_cpu_freq_set_config when a switch to XTAL is needed. * Assumes that XTAL frequency has been determined — don't call in startup code. */ void rtc_clk_cpu_freq_set_xtal(void); /** * @brief Store new APB frequency value into RTC_APB_FREQ_REG * * This function doesn't change any hardware clocks. * * Functions which perform frequency switching and change APB frequency call * this function to update the value of APB frequency stored in RTC_APB_FREQ_REG * (one of RTC general purpose retention registers). This should not normally * be called from application code. * * @param apb_freq new APB frequency, in Hz */ void rtc_clk_apb_freq_update(uint32_t apb_freq); /** * @brief Get the current stored APB frequency. * @return The APB frequency value as last set via rtc_clk_apb_freq_update(), in Hz. */ uint32_t rtc_clk_apb_freq_get(void); uint32_t rtc_clk_cal_internal(rtc_cal_sel_t cal_clk, uint32_t slowclk_cycles, uint32_t cal_mode); /** * @brief Measure RTC slow clock's period, based on main XTAL frequency * * This function will time out and return 0 if the time for the given number * of cycles to be counted exceeds the expected time twice. This may happen if * 32k XTAL is being calibrated, but the oscillator has not started up (due to * incorrect loading capacitance, board design issue, or lack of 32 XTAL on board). * * @param cal_clk clock to be measured * @param slow_clk_cycles number of slow clock cycles to average * @return average slow clock period in microseconds, Q13.19 fixed point format, * or 0 if calibration has timed out */ uint32_t rtc_clk_cal(rtc_cal_sel_t cal_clk, uint32_t slow_clk_cycles); /** * @brief Measure ratio between XTAL frequency and RTC slow clock frequency * @param cal_clk slow clock to be measured * @param slow_clk_cycles number of slow clock cycles to average * @return average ratio between XTAL frequency and slow clock frequency, * Q13.19 fixed point format, or 0 if calibration has timed out. */ uint32_t rtc_clk_cal_ratio(rtc_cal_sel_t cal_clk, uint32_t slow_clk_cycles); /** * @brief Convert time interval from microseconds to RTC_SLOW_CLK cycles * @param time_in_us Time interval in microseconds * @param slow_clk_period Period of slow clock in microseconds, Q13.19 * fixed point format (as returned by rtc_slowck_cali). * @return number of slow clock cycles */ uint64_t rtc_time_us_to_slowclk(uint64_t time_in_us, uint32_t period); /** * @brief Convert time interval from RTC_SLOW_CLK to microseconds * @param time_in_us Time interval in RTC_SLOW_CLK cycles * @param slow_clk_period Period of slow clock in microseconds, Q13.19 * fixed point format (as returned by rtc_slowck_cali). * @return time interval in microseconds */ uint64_t rtc_time_slowclk_to_us(uint64_t rtc_cycles, uint32_t period); /** * @brief Get current value of RTC counter * * RTC has a 48-bit counter which is incremented by 2 every 2 RTC_SLOW_CLK * cycles. Counter value is not writable by software. The value is not adjusted * when switching to a different RTC_SLOW_CLK source. * * Note: this function may take up to 1 RTC_SLOW_CLK cycle to execute * * @return current value of RTC counter */ uint64_t rtc_time_get(void); uint64_t rtc_light_slp_time_get(void); uint64_t rtc_deep_slp_time_get(void); /** * @brief Busy loop until next RTC_SLOW_CLK cycle * * This function returns not earlier than the next RTC_SLOW_CLK clock cycle. * In some cases (e.g. when RTC_SLOW_CLK cycle is very close), it may return * one RTC_SLOW_CLK cycle later. */ void rtc_clk_wait_for_slow_cycle(void); /** * @brief Enable the rtc digital 8M clock * * This function is used to enable the digital rtc 8M clock to support peripherals. * For enabling the analog 8M clock, using `rtc_clk_8M_enable` function above. */ void rtc_dig_clk8m_enable(void); /** * @brief Disable the rtc digital 8M clock * * This function is used to disable the digital rtc 8M clock, which is only used to support peripherals. */ void rtc_dig_clk8m_disable(void); /** * @brief Calculate the real clock value after the clock calibration * * @param cal_val Average slow clock period in microseconds, fixed point value as returned from `rtc_clk_cal` * @return Frequency of the clock in Hz */ uint32_t rtc_clk_freq_cal(uint32_t cal_val); /** * @brief Power down flags for rtc_sleep_pd function */ typedef struct { uint32_t dig_fpu : 1; //!< Set to 1 to power down digital part in sleep uint32_t rtc_fpu : 1; //!< Set to 1 to power down RTC memories in sleep uint32_t cpu_fpu : 1; //!< Set to 1 to power down digital memories and CPU in sleep uint32_t i2s_fpu : 1; //!< Set to 1 to power down I2S in sleep uint32_t bb_fpu : 1; //!< Set to 1 to power down WiFi in sleep uint32_t nrx_fpu : 1; //!< Set to 1 to power down WiFi in sleep uint32_t fe_fpu : 1; //!< Set to 1 to power down WiFi in sleep } rtc_sleep_pd_config_t; /** * Initializer for rtc_sleep_pd_config_t which sets all flags to the same value */ #define RTC_SLEEP_PD_CONFIG_ALL(val) {\ .dig_fpu = (val), \ .rtc_fpu = (val), \ .cpu_fpu = (val), \ .i2s_fpu = (val), \ .bb_fpu = (val), \ .nrx_fpu = (val), \ .fe_fpu = (val), \ } void rtc_sleep_pd(rtc_sleep_pd_config_t cfg); /** * @brief sleep configuration for rtc_sleep_init function */ typedef struct { uint32_t lslp_mem_inf_fpu : 1; //!< force normal voltage in sleep mode (digital domain memory) uint32_t rtc_mem_inf_follow_cpu : 1;//!< keep low voltage in sleep mode (even if ULP/touch is used) uint32_t rtc_fastmem_pd_en : 1; //!< power down RTC fast memory uint32_t rtc_slowmem_pd_en : 1; //!< power down RTC slow memory uint32_t rtc_peri_pd_en : 1; //!< power down RTC peripherals uint32_t wifi_pd_en : 1; //!< power down WiFi uint32_t int_8m_pd_en : 1; //!< Power down Internal 8M oscillator uint32_t deep_slp : 1; //!< power down digital domain uint32_t wdt_flashboot_mod_en : 1; //!< enable WDT flashboot mode uint32_t dig_dbias_wak : 3; //!< set bias for digital domain, in active mode uint32_t dig_dbias_slp : 3; //!< set bias for digital domain, in sleep mode uint32_t rtc_dbias_wak : 3; //!< set bias for RTC domain, in active mode uint32_t rtc_dbias_slp : 3; //!< set bias for RTC domain, in sleep mode uint32_t vddsdio_pd_en : 1; //!< power down VDDSDIO regulator uint32_t xtal_fpu : 1; //!< keep main XTAL powered up in sleep uint32_t deep_slp_reject : 1; uint32_t light_slp_reject : 1; } rtc_sleep_config_t; /** * Default initializer for rtc_sleep_config_t * * This initializer sets all fields to "reasonable" values (e.g. suggested for * production use) based on a combination of RTC_SLEEP_PD_x flags. * * @param RTC_SLEEP_PD_x flags combined using bitwise OR */ #define is_dslp(pd_flags) ((pd_flags) & RTC_SLEEP_PD_DIG) #define RTC_SLEEP_CONFIG_DEFAULT(sleep_flags) { \ .lslp_mem_inf_fpu = 0, \ .rtc_mem_inf_follow_cpu = ((sleep_flags) & RTC_SLEEP_PD_RTC_MEM_FOLLOW_CPU) ? 1 : 0, \ .rtc_fastmem_pd_en = ((sleep_flags) & RTC_SLEEP_PD_RTC_FAST_MEM) ? 1 : 0, \ .rtc_slowmem_pd_en = ((sleep_flags) & RTC_SLEEP_PD_RTC_SLOW_MEM) ? 1 : 0, \ .rtc_peri_pd_en = ((sleep_flags) & RTC_SLEEP_PD_RTC_PERIPH) ? 1 : 0, \ .wifi_pd_en = ((sleep_flags) & RTC_SLEEP_PD_WIFI) ? 1 : 0, \ .int_8m_pd_en = is_dslp(sleep_flags) ? 1 : ((sleep_flags) & RTC_SLEEP_PD_INT_8M) ? 1 : 0, \ .deep_slp = ((sleep_flags) & RTC_SLEEP_PD_DIG) ? 1 : 0, \ .wdt_flashboot_mod_en = 0, \ .dig_dbias_wak = RTC_CNTL_DIG_DBIAS_1V10, \ .dig_dbias_slp = is_dslp(sleep_flags) ? RTC_CNTL_DIG_DBIAS_0V90 \ : !((sleep_flags) & RTC_SLEEP_PD_INT_8M) ? RTC_CNTL_DIG_DBIAS_1V10 \ : !((sleep_flags) & RTC_SLEEP_PD_XTAL) ? RTC_CNTL_DIG_DBIAS_1V10 \ : RTC_CNTL_DIG_DBIAS_0V90, \ .rtc_dbias_wak = RTC_CNTL_DBIAS_1V10, \ .rtc_dbias_slp = is_dslp(sleep_flags) ? RTC_CNTL_DBIAS_1V00 \ : !((sleep_flags) & RTC_SLEEP_PD_INT_8M) ? RTC_CNTL_DBIAS_1V10 \ : !((sleep_flags) & RTC_SLEEP_PD_XTAL) ? RTC_CNTL_DBIAS_1V10 \ : RTC_CNTL_DBIAS_1V00, \ .vddsdio_pd_en = ((sleep_flags) & RTC_SLEEP_PD_VDDSDIO) ? 1 : 0, \ .xtal_fpu = is_dslp(sleep_flags) ? 0 : ((sleep_flags) & RTC_SLEEP_PD_XTAL) ? 0 : 1, \ .deep_slp_reject = 1, \ .light_slp_reject = 1 \ }; #define RTC_SLEEP_PD_DIG BIT(0) //!< Deep sleep (power down digital domain) #define RTC_SLEEP_PD_RTC_PERIPH BIT(1) //!< Power down RTC peripherals #define RTC_SLEEP_PD_RTC_SLOW_MEM BIT(2) //!< Power down RTC SLOW memory #define RTC_SLEEP_PD_RTC_FAST_MEM BIT(3) //!< Power down RTC FAST memory #define RTC_SLEEP_PD_RTC_MEM_FOLLOW_CPU BIT(4) //!< RTC FAST and SLOW memories are automatically powered up and down along with the CPU #define RTC_SLEEP_PD_VDDSDIO BIT(5) //!< Power down VDDSDIO regulator #define RTC_SLEEP_PD_WIFI BIT(6) #define RTC_SLEEP_PD_INT_8M BIT(7) //!< Power down Internal 8M oscillator #define RTC_SLEEP_PD_XTAL BIT(8) //!< Power down main XTAL /** * @brief Prepare the chip to enter sleep mode * * This function configures various power control state machines to handle * entry into light sleep or deep sleep mode, switches APB and CPU clock source * (usually to XTAL), and sets bias voltages for digital and RTC power domains. * * This function does not actually enter sleep mode; this is done using * rtc_sleep_start function. Software may do some other actions between * rtc_sleep_init and rtc_sleep_start, such as set wakeup timer and configure * wakeup sources. * @param cfg sleep mode configuration */ void rtc_sleep_init(rtc_sleep_config_t cfg); /** * @brief Low level initialize for rtc state machine waiting cycles after waking up * * This function configures the cycles chip need to wait for internal 8MHz * oscillator and external 40MHz crystal. As we configure fixed time for waiting * crystal, we need to pass period to calculate cycles. Now this function only * used in lightsleep mode. * * @param slowclk_period re-calibrated slow clock period */ void rtc_sleep_low_init(uint32_t slowclk_period); #define RTC_EXT0_TRIG_EN BIT(0) //!< EXT0 GPIO wakeup #define RTC_EXT1_TRIG_EN BIT(1) //!< EXT1 GPIO wakeup #define RTC_GPIO_TRIG_EN BIT(2) //!< GPIO wakeup (light sleep only) #define RTC_TIMER_TRIG_EN BIT(3) //!< Timer wakeup #define RTC_SDIO_TRIG_EN BIT(4) //!< SDIO wakeup (light sleep only) #define RTC_WIFI_TRIG_EN BIT(5) //!< WIFI wakeup (light sleep only) #define RTC_UART0_TRIG_EN BIT(6) //!< UART0 wakeup (light sleep only) #define RTC_UART1_TRIG_EN BIT(7) //!< UART1 wakeup (light sleep only) #define RTC_TOUCH_TRIG_EN BIT(8) //!< Touch wakeup #define RTC_ULP_TRIG_EN BIT(9) //!< ULP wakeup #define RTC_BT_TRIG_EN BIT(10) //!< BT wakeup (light sleep only) #define RTC_COCPU_TRIG_EN BIT(11) #define RTC_XTAL32K_DEAD_TRIG_EN BIT(12) #define RTC_COCPU_TRAP_TRIG_EN BIT(13) #define RTC_USB_TRIG_EN BIT(14) /** * @brief Enter deep or light sleep mode * * This function enters the sleep mode previously configured using rtc_sleep_init * function. Before entering sleep, software should configure wake up sources * appropriately (set up GPIO wakeup registers, timer wakeup registers, * and so on). * * If deep sleep mode was configured using rtc_sleep_init, and sleep is not * rejected by hardware (based on reject_opt flags), this function never returns. * When the chip wakes up from deep sleep, CPU is reset and execution starts * from ROM bootloader. * * If light sleep mode was configured using rtc_sleep_init, this function * returns on wakeup, or if sleep is rejected by hardware. * * @param wakeup_opt bit mask wake up reasons to enable (RTC_xxx_TRIG_EN flags * combined with OR) * @param reject_opt bit mask of sleep reject reasons: * - RTC_CNTL_GPIO_REJECT_EN * - RTC_CNTL_SDIO_REJECT_EN * These flags are used to prevent entering sleep when e.g. * an external host is communicating via SDIO slave * @param lslp_mem_inf_fpu If non-zero then the low power config is restored * immediately on wake. Recommended for light sleep, * has no effect if the system goes into deep sleep. * @return non-zero if sleep was rejected by hardware */ uint32_t rtc_sleep_start(uint32_t wakeup_opt, uint32_t reject_opt, uint32_t lslp_mem_inf_fpu); /** * @brief Enter deep sleep mode * * Similar to rtc_sleep_start(), but additionally uses hardware to calculate the CRC value * of RTC FAST memory. On wake, this CRC is used to determine if a deep sleep wake * stub is valid to execute (if a wake address is set). * * No RAM is accessed while calculating the CRC and going into deep sleep, which makes * this function safe to use even if the caller's stack is in RTC FAST memory. * * @note If no deep sleep wake stub address is set then calling rtc_sleep_start() will * have the same effect and takes less time as CRC calculation is skipped. * * @note This function should only be called after rtc_sleep_init() has been called to * configure the system for deep sleep. * * @param wakeup_opt - same as for rtc_sleep_start * @param reject_opt - same as for rtc_sleep_start * * @return non-zero if sleep was rejected by hardware */ uint32_t rtc_deep_sleep_start(uint32_t wakeup_opt, uint32_t reject_opt); /** * RTC power and clock control initialization settings */ typedef struct { uint32_t ck8m_wait : 8; //!< Number of rtc_fast_clk cycles to wait for 8M clock to be ready uint32_t xtal_wait : 8; //!< Number of rtc_fast_clk cycles to wait for XTAL clock to be ready uint32_t pll_wait : 8; //!< Number of rtc_fast_clk cycles to wait for PLL to be ready uint32_t clkctl_init : 1; //!< Perform clock control related initialization uint32_t pwrctl_init : 1; //!< Perform power control related initialization uint32_t rtc_dboost_fpd : 1; //!< Force power down RTC_DBOOST uint32_t xtal_fpu : 1; uint32_t bbpll_fpu : 1; uint32_t cpu_waiti_clk_gate : 1; uint32_t cali_ocode : 1; //!< Calibrate Ocode to make bangap voltage more precise. } rtc_config_t; /** * Default initializer of rtc_config_t. * * This initializer sets all fields to "reasonable" values (e.g. suggested for * production use). */ #define RTC_CONFIG_DEFAULT() {\ .ck8m_wait = RTC_CNTL_CK8M_WAIT_DEFAULT, \ .xtal_wait = RTC_CNTL_XTL_BUF_WAIT_DEFAULT, \ .pll_wait = RTC_CNTL_PLL_BUF_WAIT_DEFAULT, \ .clkctl_init = 1, \ .pwrctl_init = 1, \ .rtc_dboost_fpd = 1, \ .xtal_fpu = 0, \ .bbpll_fpu = 0, \ .cpu_waiti_clk_gate = 1, \ .cali_ocode = 0\ } /** * Initialize RTC clock and power control related functions * @param cfg configuration options as rtc_config_t */ void rtc_init(rtc_config_t cfg); /** * Structure describing vddsdio configuration */ typedef struct { uint32_t force : 1; //!< If 1, use configuration from RTC registers; if 0, use EFUSE/bootstrapping pins. uint32_t enable : 1; //!< Enable VDDSDIO regulator uint32_t tieh : 1; //!< Select VDDSDIO voltage. One of RTC_VDDSDIO_TIEH_1_8V, RTC_VDDSDIO_TIEH_3_3V uint32_t drefh : 2; //!< Tuning parameter for VDDSDIO regulator uint32_t drefm : 2; //!< Tuning parameter for VDDSDIO regulator uint32_t drefl : 2; //!< Tuning parameter for VDDSDIO regulator } rtc_vddsdio_config_t; /** * Get current VDDSDIO configuration * If VDDSDIO configuration is overridden by RTC, get values from RTC * Otherwise, if VDDSDIO is configured by EFUSE, get values from EFUSE * Otherwise, use default values and the level of MTDI bootstrapping pin. * @return currently used VDDSDIO configuration */ rtc_vddsdio_config_t rtc_vddsdio_get_config(void); /** * Set new VDDSDIO configuration using RTC registers. * If config.force == 1, this overrides configuration done using bootstrapping * pins and EFUSE. * * @param config new VDDSDIO configuration */ void rtc_vddsdio_set_config(rtc_vddsdio_config_t config); /** * Using valid hardware calibration value to calibrate slowclk * If there is no hardware calibration in process, start hardware calibration and wait for calibration finished * @param cal_clk clock to be measured * @param slowclk_cycles if no hardware calibration in process, use this amount of slow cycles to calibrate slowclk. */ uint32_t rtc_clk_cal_cycling(rtc_cal_sel_t cal_clk, uint32_t slowclk_cycles); #ifdef __cplusplus } #endif