xt_hal_pm.h

浏览该文件的文档.

 
#ifndef __XT_HAL_PM_H__
#define __XT_HAL_PM_H__
 
/* ==================== [Includes] ========================================== */
 
#include "xt_hal_internal.h"
#include "xt_hal_rtc.h"
 
#ifdef __cplusplus
extern "C" {
#endif

 
/* ==================== [Defines] =========================================== */
 
#define XT_HAL_PM_INVALID_ID (0xFF)
 
/* ==================== [Typedefs] ========================================== */

enum xt_hal_pm_event_id {
    XT_HAL_PM_EVENT_WAKEUP = 0x00, 
    XT_HAL_PM_EVENT_TIMER = 0x01,  
};

typedef void (*xt_hal_pm_cb_t)(uint8_t id, uint32_t event_id);

enum xt_hal_pm_mode {
    XT_HAL_PM_MODE_WORK = 0,    
    XT_HAL_PM_MODE_SLEEP,       
    XT_HAL_PM_MODE_PSM,         
    XT_HAL_PM_MODE_MAX,         
};

enum xt_hal_pm_wake_reason {
    XT_HAL_PM_WAKE_REASON_RESET = 0,    
    XT_HAL_PM_WAKE_REASON_RTC,          
    XT_HAL_PM_WAKE_REASON_WAKEUP,       
    XT_HAL_PM_WAKE_REASON_KEY_WAKEUP,   
};

enum xt_hal_pm_last_state {
    XT_HAL_PM_LAST_STATE_RESET = 0,     
    XT_HAL_PM_LAST_STATE_DEEP_SLEEP = 3,
    XT_HAL_PM_LAST_STATE_STANDBY = 4,   
};

enum xt_hal_pm_wake_reason_detail {
    XT_HAL_PM_WAKE_REASON_DETAIL_RESET = 0,     
    XT_HAL_PM_WAKE_REASON_DETAIL_RTC = 1,       
    XT_HAL_PM_WAKE_REASON_DETAIL_WAKEUP = 2,    
    XT_HAL_PM_WAKE_REASON_DETAIL_WAKEUP_RTC = 3,
};
 
enum xt_hal_pm_power_on_reason {
    XT_HAL_PM_POWER_ON_NORMAL = 0,      
    XT_HAL_PM_POWER_ON_CHARGING,        
    XT_HAL_PM_POWER_ON_ALRAM,           
    XT_HAL_PM_POWER_ON_EXCEPTRESET,     
    XT_HAL_PM_POWER_ON_FOTA,            /*!* FOTA 开机 */
    XT_HAL_PM_POWER_ON_RTC,             
    XT_HAL_PM_POWER_ON_RESET,           
    XT_HAL_PM_POWER_ON_WDT,             
    XT_HAL_PM_POWER_ON_STANDBY,         
    XT_HAL_PM_POWER_ON_SW_RESET,        
    XT_HAL_PM_POWER_ON_UNKNOWN,         
    XT_HAL_PM_POWER_ON_INVALID,
};
 
/* ==================== [Global Prototypes] ================================= */

xt_err_t xt_hal_pm_request(uint8_t mode);

xt_err_t xt_hal_pm_force(uint8_t mode);

int32_t xt_hal_pm_check(uint8_t mode);

xt_err_t xt_hal_pm_timer_setup(uint8_t timer_id, uint32_t timeout_ms, xt_hal_pm_cb_t cb);

xt_err_t xt_hal_pm_timer_close(uint8_t timer_id);

bool xt_hal_pm_timer_is_running(uint8_t timer_id);

xt_err_t xt_hal_pm_timer_get_remaining(uint8_t timer_id, xt_hal_rtc_timestamp_t *remaining_time_ms);

xt_err_t xt_hal_pm_get_last_state(uint8_t *last_state, uint8_t *wake_reason);

int32_t xt_hal_pm_get_wake_reason(void);

int32_t xt_hal_pm_get_reset_reason(void);

xt_err_t xt_hal_pm_poweroff(void);

xt_err_t xt_hal_pm_reset(void);

xt_err_t xt_hal_pm_set_power(uint8_t power_id, uint8_t val);
 
/* ==================== [Macros] ============================================ */
  /* xt_hal_pm */
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* __XT_HAL_PM_H__ */