pm.h

Go to the documentation of this file.

/********************************************************************************************************
 * @file     pm.h
 *
 * @brief    This is the header file for TLSR8258
 *
 * @author   Driver Group
 * @date     May 8, 2018
 *
 * @par      Copyright (c) 2018, Telink Semiconductor (Shanghai) Co., Ltd.
 *           All rights reserved.
 *
 *           The information contained herein is confidential property of Telink
 *           Semiconductor (Shanghai) Co., Ltd. and is available under the terms
 *           of Commercial License Agreement between Telink Semiconductor (Shanghai)
 *           Co., Ltd. and the licensee or the terms described here-in. This heading
 *           MUST NOT be removed from this file.
 *
 *           Licensees are granted free, non-transferable use of the information in this
 *           file under Mutual Non-Disclosure Agreement. NO WARRENTY of ANY KIND is provided.
 * @par      History:
 *           1.initial release(DEC. 26 2018)
 *
 * @version  A001
 *
 *******************************************************************************************************/

#pragma once

#include "bsp.h"
#include "gpio.h"

#define PM_LONG_SUSPEND_EN                  1

#ifndef PM_TIM_RECOVER_MODE
#define PM_TIM_RECOVER_MODE                 0
#endif



#define PM_XTAL_DELAY_DURATION              500
#define EARLYWAKEUP_TIME_US_DEEP            1100
#define EARLYWAKEUP_TIME_US_SUSPEND         1250
#define EMPTYRUN_TIME_US                    1500

#define PM_DCDC_DELAY_DURATION              1000



#define PM_LONG_SLEEP_WAKEUP_EN             0 //if user need to make MCU sleep for a long time that is more than 268s, this macro need to be enabled and use "pm_long_sleep_wakeup" function
#define SYS_CLK_48MRC_EN                    0 //if user take 48M RC as system clock, this macro need to be enabled

#define DEEP_ANA_REG0                       0x3a //initial value =0x00
#define DEEP_ANA_REG1                       0x3b //initial value =0x00
#define DEEP_ANA_REG2                       0x3c //initial value =0x00

#define DEEP_ANA_REG6                       0x35 //initial value =0x00
#define DEEP_ANA_REG7                       0x36 //initial value =0x00
#define DEEP_ANA_REG8                       0x37 //initial value =0x00
#define DEEP_ANA_REG9                       0x38 //initial value =0x00
#define DEEP_ANA_REG10                      0x39 //initial value =0x00


#define SYS_NEED_REINIT_EXT32K              BIT(0)


//ana3c system used, user can not use
#define SYS_DEEP_ANA_REG                    DEEP_ANA_REG2
#define WAKEUP_STATUS_TIMER_CORE            ( WAKEUP_STATUS_TIMER | WAKEUP_STATUS_CORE)
#define WAKEUP_STATUS_TIMER_PAD             ( WAKEUP_STATUS_TIMER | WAKEUP_STATUS_PAD)


typedef enum {
    //available mode for customer
    SUSPEND_MODE                        = 0,

    DEEPSLEEP_MODE                      = 0x80,
    DEEPSLEEP_MODE_RET_SRAM_LOW8K       = 0x61,  //for boot from sram
    DEEPSLEEP_MODE_RET_SRAM_LOW16K      = 0x43,  //for boot from sram
    DEEPSLEEP_MODE_RET_SRAM_LOW32K      = 0x07,  //for boot from sram

    SHUTDOWN_MODE                       = 0xFF,

    //not available mode
    DEEPSLEEP_RETENTION_FLAG            = 0x7F,
}SleepMode_TypeDef;


typedef enum {
     //available wake-up source for customer
     PM_WAKEUP_PAD          = BIT(4),
     PM_WAKEUP_CORE         = BIT(5),
     PM_WAKEUP_TIMER        = BIT(6),
     PM_WAKEUP_COMPARATOR   = BIT(7),
     //not available wake-up source for customer
     PM_TIM_RECOVER_START   = BIT(14),
     PM_TIM_RECOVER_END     = BIT(15),
}SleepWakeupSrc_TypeDef;

enum {
     WAKEUP_STATUS_COMPARATOR       = BIT(0),
     WAKEUP_STATUS_TIMER            = BIT(1),
     WAKEUP_STATUS_CORE             = BIT(2),
     WAKEUP_STATUS_PAD              = BIT(3),

     WAKEUP_STATUS_WD               = BIT(6),
     STATUS_GPIO_ERR_NO_ENTER_PM    = BIT(7),

     STATUS_ENTER_SUSPEND           = BIT(30),
};

typedef struct{
    unsigned char ext_cap_en;    //24xtal  cap
    unsigned char pad32k_en;
    unsigned char pm_enter_en;
}misc_para_t;

extern misc_para_t              blt_miscParam;

typedef struct{
    unsigned char is_deepretn_back;
    unsigned char is_pad_wakeup;
    unsigned char wakeup_src;
}pm_para_t;

extern pm_para_t    pmParam;

#if (PM_TIM_RECOVER_MODE)

typedef struct{
    unsigned int   tick_sysClk;
    unsigned int   tick_32k;
    unsigned char  recover_flag;
}pm_tim_recover_t;

extern pm_tim_recover_t         pm_timRecover;
#endif


typedef int (*suspend_handler_t)(void);
extern  suspend_handler_t        func_before_suspend;

void bls_pm_registerFuncBeforeSuspend (suspend_handler_t func );


static inline int pm_is_MCU_deepRetentionWakeup(void)
{
    return pmParam.is_deepretn_back;
}

static inline int pm_is_deepPadWakeup(void)
{
    return pmParam.is_pad_wakeup;
}

static inline int pm_get_wakeup_src(void)
{
    return pmParam.wakeup_src;
}

void cpu_stall_wakeup_by_timer0(unsigned int tick);

void cpu_stall_wakeup_by_timer1(unsigned int tick);

void cpu_stall_wakeup_by_timer2(unsigned int tick);

unsigned int cpu_stall(int WakeupSrc, unsigned int IntervalUs,unsigned int sysclktick);

void cpu_set_gpio_wakeup (GPIO_PinTypeDef pin, GPIO_LevelTypeDef pol, int en);


void start_reboot(void);

extern unsigned int pm_get_32k_tick(void);

void cpu_wakeup_init(void);

unsigned int pm_tim_recover_32k_rc(unsigned int now_tick_32k);

unsigned int pm_tim_recover_32k_xtal(unsigned int now_tick_32k);


typedef unsigned int (*pm_tim_recover_handler_t)(unsigned int);

extern  pm_tim_recover_handler_t pm_tim_recover;


int  cpu_sleep_wakeup_32k_rc(SleepMode_TypeDef sleep_mode,  SleepWakeupSrc_TypeDef wakeup_src, unsigned int  wakeup_tick);

int  cpu_sleep_wakeup_32k_xtal(SleepMode_TypeDef sleep_mode,  SleepWakeupSrc_TypeDef wakeup_src, unsigned int  wakeup_tick);

typedef int (*cpu_pm_handler_t)(SleepMode_TypeDef sleep_mode,  SleepWakeupSrc_TypeDef wakeup_src, unsigned int  wakeup_tick);

extern  cpu_pm_handler_t         cpu_sleep_wakeup;

static inline void blc_pm_select_internal_32k_crystal(void)
{
    cpu_sleep_wakeup        = cpu_sleep_wakeup_32k_rc;
    pm_tim_recover          = pm_tim_recover_32k_rc;

    blt_miscParam.pm_enter_en   = 1; // allow enter pm, 32k rc does not need to wait for 32k clk to be stable
}

static inline void blc_pm_select_external_32k_crystal(void)
{
    cpu_sleep_wakeup        = cpu_sleep_wakeup_32k_xtal;
    pm_tim_recover          = pm_tim_recover_32k_xtal;

    blt_miscParam.pad32k_en     = 1; // set '1': 32k clk src use external 32k crystal
}

/**********************************  Internal APIs (not for user)***************************************************/
extern  unsigned char           tl_multi_addr;
extern  unsigned char           tl_24mrc_cal;
extern  unsigned short          tick_32k_calib;
extern  unsigned int            tick_cur;
extern  unsigned int            tick_32k_cur;

void sleep_start(void);

unsigned int  pm_get_info0(void);

unsigned int  pm_get_info1(void);

unsigned int cpu_get_32k_tick(void);

void soft_reboot_dly13ms_use24mRC(void);

void check_32k_clk_stable(void);

#if PM_LONG_SLEEP_WAKEUP_EN

int pm_long_sleep_wakeup (SleepMode_TypeDef sleep_mode, SleepWakeupSrc_TypeDef wakeup_src, unsigned int  SleepDurationUs);
#endif

 //end of GP7