mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
4e092be6d6
We reserve 4KB Slow RTC memory to save RF calibation result and BT NVS data. If not all these Slow RTC momory Blocks are used, we will open the other parts.
207 lines
6.4 KiB
C
207 lines
6.4 KiB
C
// Copyright 2010-2016 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.
|
|
|
|
#ifndef _ROM_RTC_H_
|
|
#define _ROM_RTC_H_
|
|
|
|
#include "ets_sys.h"
|
|
|
|
#include <stdbool.h>
|
|
#include <stdint.h>
|
|
|
|
#include "soc/soc.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/** \defgroup rtc_apis, rtc registers and memory related apis
|
|
* @brief rtc apis
|
|
*/
|
|
|
|
/** @addtogroup rtc_apis
|
|
* @{
|
|
*/
|
|
|
|
/**************************************************************************************
|
|
* Note: *
|
|
* Some Rtc memory and registers are used, in ROM or in internal library. *
|
|
* Please do not use reserved or used rtc memory or registers. *
|
|
* *
|
|
*************************************************************************************
|
|
* RTC Memory & Store Register usage
|
|
*************************************************************************************
|
|
* rtc memory addr type size usage
|
|
* 0x3ff61000(0x50000000) Slow SIZE_CP Co-Processor code/Reset Entry
|
|
* 0x3ff61000+SIZE_CP Slow 4096-SIZE_CP
|
|
* 0x3ff62800 Slow 4096 Reserved
|
|
*
|
|
* 0x3ff80000(0x400c0000) Fast 8192 deep sleep entry code
|
|
*
|
|
*************************************************************************************
|
|
* Rtc store registers usage
|
|
* RTC_CNTL_STORE0_REG
|
|
* RTC_CNTL_STORE1_REG
|
|
* RTC_CNTL_STORE2_REG
|
|
* RTC_CNTL_STORE3_REG
|
|
* RTC_CNTL_STORE4_REG Reserved
|
|
* RTC_CNTL_STORE5_REG External Xtal Frequency
|
|
* RTC_CNTL_STORE6_REG FAST_RTC_MEMORY_ENTRY
|
|
* RTC_CNTL_STORE7_REG FAST_RTC_MEMORY_CRC
|
|
*************************************************************************************
|
|
*/
|
|
#define RTC_ENTRY_ADDR_REG RTC_CNTL_STORE6_REG
|
|
#define RTC_MEMORY_CRC_REG RTC_CNTL_STORE7_REG
|
|
|
|
|
|
typedef enum {
|
|
AWAKE = 0, //<CPU ON
|
|
LIGHT_SLEEP = BIT0, //CPU waiti, PLL ON. We don't need explicitly set this mode.
|
|
DEEP_SLEEP = BIT1 //CPU OFF, PLL OFF, only specific timer could wake up
|
|
} SLEEP_MODE;
|
|
|
|
typedef enum {
|
|
NO_MEAN = 0,
|
|
POWERON_RESET = 1, /**<1, Vbat power on reset*/
|
|
SW_RESET = 3, /**<3, Software reset digital core*/
|
|
OWDT_RESET = 4, /**<4, Legacy watch dog reset digital core*/
|
|
DEEPSLEEP_RESET = 5, /**<3, Deep Sleep reset digital core*/
|
|
SDIO_RESET = 6, /**<6, Reset by SLC module, reset digital core*/
|
|
TG0WDT_SYS_RESET = 7, /**<7, Timer Group0 Watch dog reset digital core*/
|
|
TG1WDT_SYS_RESET = 8, /**<8, Timer Group1 Watch dog reset digital core*/
|
|
RTCWDT_SYS_RESET = 9, /**<9, RTC Watch dog Reset digital core*/
|
|
INTRUSION_RESET = 10, /**<10, Instrusion tested to reset CPU*/
|
|
TGWDT_CPU_RESET = 11, /**<11, Time Group reset CPU*/
|
|
SW_CPU_RESET = 12, /**<12, Software reset CPU*/
|
|
RTCWDT_CPU_RESET = 13, /**<13, RTC Watch dog Reset CPU*/
|
|
EXT_CPU_RESET = 14, /**<14, for APP CPU, reseted by PRO CPU*/
|
|
RTCWDT_BROWN_OUT_RESET = 15, /**<15, Reset when the vdd voltage is not stable*/
|
|
RTCWDT_RTC_RESET = 16 /**<16, RTC Watch dog reset digital core and rtc module*/
|
|
} RESET_REASON;
|
|
|
|
typedef enum {
|
|
NO_SLEEP = 0,
|
|
EXT_EVENT0_TRIG = BIT0,
|
|
EXT_EVENT1_TRIG = BIT1,
|
|
GPIO_TRIG = BIT2,
|
|
TIMER_EXPIRE = BIT3,
|
|
SDIO_TRIG = BIT4,
|
|
MAC_TRIG = BIT5,
|
|
UART0_TRIG = BIT6,
|
|
UART1_TRIG = BIT7,
|
|
TOUCH_TRIG = BIT8,
|
|
SAR_TRIG = BIT9,
|
|
BT_TRIG = BIT10
|
|
} WAKEUP_REASON;
|
|
|
|
typedef enum {
|
|
DISEN_WAKEUP = NO_SLEEP,
|
|
EXT_EVENT0_TRIG_EN = EXT_EVENT0_TRIG,
|
|
EXT_EVENT1_TRIG_EN = EXT_EVENT1_TRIG,
|
|
GPIO_TRIG_EN = GPIO_TRIG,
|
|
TIMER_EXPIRE_EN = TIMER_EXPIRE,
|
|
SDIO_TRIG_EN = SDIO_TRIG,
|
|
MAC_TRIG_EN = MAC_TRIG,
|
|
UART0_TRIG_EN = UART0_TRIG,
|
|
UART1_TRIG_EN = UART1_TRIG,
|
|
TOUCH_TRIG_EN = TOUCH_TRIG,
|
|
SAR_TRIG_EN = SAR_TRIG,
|
|
BT_TRIG_EN = BT_TRIG
|
|
} WAKEUP_ENABLE;
|
|
|
|
typedef enum {
|
|
NO_INT = 0,
|
|
WAKEUP_INT = BIT0,
|
|
REJECT_INT = BIT1,
|
|
SDIO_IDLE_INT = BIT2,
|
|
RTC_WDT_INT = BIT3,
|
|
RTC_TIME_VALID_INT = BIT4
|
|
} RTC_INT_REASON;
|
|
|
|
typedef enum {
|
|
DISEN_INT = 0,
|
|
WAKEUP_INT_EN = WAKEUP_INT,
|
|
REJECT_INT_EN = REJECT_INT,
|
|
SDIO_IDLE_INT_EN = SDIO_IDLE_INT,
|
|
RTC_WDT_INT_EN = RTC_WDT_INT,
|
|
RTC_TIME_VALID_INT_EN = RTC_TIME_VALID_INT
|
|
} RTC_INT_EN;
|
|
|
|
/**
|
|
* @brief Get the reset reason for CPU.
|
|
*
|
|
* @param int cpu_no : CPU no.
|
|
*
|
|
* @return RESET_REASON
|
|
*/
|
|
RESET_REASON rtc_get_reset_reason(int cpu_no);
|
|
|
|
/**
|
|
* @brief Get the wakeup cause for CPU.
|
|
*
|
|
* @param int cpu_no : CPU no.
|
|
*
|
|
* @return WAKEUP_REASON
|
|
*/
|
|
WAKEUP_REASON rtc_get_wakeup_cause(void);
|
|
|
|
/**
|
|
* @brief Get CRC for Fast RTC Memory.
|
|
*
|
|
* @param uint32_t start_addr : 0 - 0x7ff for Fast RTC Memory.
|
|
*
|
|
* @param uint32_t crc_len : 0 - 0x7ff, 0 for 4 byte, 0x7ff for 0x2000 byte.
|
|
*
|
|
* @return uint32_t : CRC32 result
|
|
*/
|
|
uint32_t calc_rtc_memory_crc(uint32_t start_addr, uint32_t crc_len);
|
|
|
|
/**
|
|
* @brief Set CRC of Fast RTC memory 0-0x7ff into RTC STORE7.
|
|
*
|
|
* @param None
|
|
*
|
|
* @return None
|
|
*/
|
|
void set_rtc_memory_crc(void);
|
|
|
|
/**
|
|
* @brief Software Reset digital core.
|
|
*
|
|
* @param None
|
|
*
|
|
* @return None
|
|
*/
|
|
void software_reset(void);
|
|
|
|
/**
|
|
* @brief Software Reset digital core.
|
|
*
|
|
* @param int cpu_no : The CPU to reset, 0 for PRO CPU, 1 for APP CPU.
|
|
*
|
|
* @return None
|
|
*/
|
|
void software_reset_cpu(int cpu_no);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* _ROM_RTC_H_ */
|
|
|