los_lowpower.h

浏览该文件的文档.

/* ----------------------------------------------------------------------------
 * Copyright (c) Huawei Technologies Co., Ltd. 2020-2021. All rights reserved.
 * Description: Low-power Framework.
 * Author: Huawei LiteOS Team
 * Create: 2020-09-19
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 * 1. Redistributions of source code must retain the above copyright notice, this list of
 * conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice, this list
 * of conditions and the following disclaimer in the documentation and/or other materials
 * provided with the distribution.
 * 3. Neither the name of the copyright holder nor the names of its contributors may be used
 * to endorse or promote products derived from this software without specific prior written
 * permission.
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * --------------------------------------------------------------------------- */
 
#ifndef _LOS_LOWPOWER_H
#define _LOS_LOWPOWER_H
 
#include "los_base.h"
#include "los_sys.h"
#include "los_err.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
typedef enum LOS_SLEEP_MODE {
    LOS_SLEEP_NORMAL = 0,
    LOS_SLEEP_LIGHT, 
    LOS_SLEEP_DEEP,  
    LOS_SLEEP_MAX,   
} LosSleepMode;
 
#ifdef LOSCFG_KERNEL_DYN_FREQ
typedef enum LOS_FREQ_MODE {
    LOS_SYS_FREQ_SUPER = 0, 
    LOS_SYS_FREQ_HIGH,      
    LOS_SYS_FREQ_NORMAL,    
    LOS_SYS_FREQ_LOW,       
    LOS_SYS_FREQ_MAX,
} LosFreqMode;
 
extern VOID LOS_PowerMgrChangeFreq(LosFreqMode freq);
#endif
 
typedef struct {
#ifdef LOSCFG_KERNEL_DYN_FREQ
    UINT32 (*changeFreq)(LosFreqMode freq); 
#endif
#if defined (LOSCFG_KERNEL_LIGHTSLEEP) || defined (LOSCFG_KERNEL_DEEPSLEEP)
    LosSleepMode (*getSleepMode)(VOID);     
#endif
#ifdef LOSCFG_KERNEL_LIGHTSLEEP
    VOID (*enterLightSleep)(VOID);    
#endif
#ifdef LOSCFG_KERNEL_DEEPSLEEP
#ifdef LOSCFG_LOWPOWER_SLEEP_USERCONFIG
    VOID (*userPreConfig)(VOID);      
    VOID (*userPostConfig)(VOID);     
#endif
    VOID (*systemWakeup)(VOID);       
    VOID (*suspendConfig)(VOID);      
    VOID (*resumeConfig)(VOID);       
#ifdef LOSCFG_KERNEL_SMP
    VOID (*otherCoreResume)(VOID);    
#endif
    VOID (*enterDeepSleep)(VOID);     
    VOID (*setWakeUpTimer)(UINT32 timeout);   
    UINT32 (*withdrawWakeUpTimer)(VOID);      
#ifdef LOSCFG_KERNEL_RAM_SAVE
    VOID (*contextSave)(VOID);        
    VOID (*contextRestore)(VOID);     
#endif
#endif
#ifdef LOSCFG_LOWPOWER_SLEEP_WFI
    VOID (*enterWFI)(VOID);     
#endif
} PowerMgrRunOps;
 
typedef struct {
    PowerMgrRunOps runOps;           
} PowerMgrParameter;
 
#ifdef LOSCFG_KERNEL_DYN_FREQ
    #define SET_RUNOPS_CHANGEFREQ(hook) .changeFreq = hook,
#else
    #define SET_RUNOPS_CHANGEFREQ(hook)
#endif
#if defined (LOSCFG_KERNEL_LIGHTSLEEP) || defined (LOSCFG_KERNEL_DEEPSLEEP)
    #define SET_RUNOPS_GETSLEEPMODE(hook) .getSleepMode = hook,
#else
    #define SET_RUNOPS_GETSLEEPMODE(hook)
#endif
#ifdef LOSCFG_KERNEL_LIGHTSLEEP
    #define SET_RUNOPS_ENTERLIGHTSLEEP(hook) .enterLightSleep = hook,
#else
    #define SET_RUNOPS_ENTERLIGHTSLEEP(hook)
#endif
#ifdef LOSCFG_KERNEL_DEEPSLEEP
#ifdef LOSCFG_LOWPOWER_SLEEP_USERCONFIG
    #define SET_RUNOPS_USERPRECONFIG(hook) .userPreConfig = hook,
    #define SET_RUNOPS_USERPOSTCONFIG(hook) .userPostConfig = hook,
#else
    #define SET_RUNOPS_USERPRECONFIG(hook)
    #define SET_RUNOPS_USERPOSTCONFIG(hook)
#endif
    #define SET_RUNOPS_SYSTEMWAKEUP(hook) .systemWakeup = hook,
    #define SET_RUNOPS_SUSPENDCONFIG(hook) .suspendConfig = hook,
    #define SET_RUNOPS_RESUMECONFIG(hook) .resumeConfig = hook,
#ifdef LOSCFG_KERNEL_SMP
    #define SET_RUNOPS_OTHERCORERESUME(hook) .otherCoreResume = hook,
#else
    #define SET_RUNOPS_OTHERCORERESUME(hook)
#endif
    #define SET_RUNOPS_ENTERDEEPSLEEP(hook) .enterDeepSleep = hook,
    #define SET_RUNOPS_SETWAKEUPTIMER(hook) .setWakeUpTimer = hook,
    #define SET_RUNOPS_WITHDRAWWAKEUPTIMER(hook) .withdrawWakeUpTimer = hook,
#ifdef LOSCFG_KERNEL_RAM_SAVE
    #define SET_RUNOPS_CONTEXTSAVE(hook) .contextSave = hook,
    #define SET_RUNOPS_CONTEXTRESTORE(hook) .contextRestore = hook,
#else
    #define SET_RUNOPS_CONTEXTSAVE(hook)
    #define SET_RUNOPS_CONTEXTRESTORE(hook)
#endif
#else
    #define SET_RUNOPS_SYSTEMWAKEUP(hook)
    #define SET_RUNOPS_SUSPENDCONFIG(hook)
    #define SET_RUNOPS_RESUMECONFIG(hook)
    #define SET_RUNOPS_ENTERDEEPSLEEP(hook)
    #define SET_RUNOPS_SETWAKEUPTIMER(hook)
    #define SET_RUNOPS_WITHDRAWWAKEUPTIMER(hook)
#endif
#ifdef LOSCFG_LOWPOWER_SLEEP_WFI
    #define SET_RUNOPS_ENTERWFI(hook) .enterWFI = hook,
#else
    #define SET_RUNOPS_ENTERWFI(hook)
#endif
 
extern UINT32 LOS_PowerMgrInit(const PowerMgrParameter *para);
 
#define LOS_ERRNO_LPM_INIT_NULL                  LOS_ERRNO_OS_ERROR(LOS_MOD_TSK, 0x01)
 
#ifdef LOSCFG_LOWPOWER_SLEEP_VETO
extern UINT32 LOS_PowerMgrSleepLock(LosSleepMode mode, UINT32 requestId);
 
extern UINT32 LOS_PowerMgrSleepUnLock(LosSleepMode mode, UINT32 requestId);
#endif
 
#ifdef LOSCFG_LOWPOWER_SLEEP_DEBUG
extern VOID LOS_EnableLowPower(VOID);
 
extern VOID LOS_DisableLowPower(VOID);
 
extern UINT32 LOS_GetLowPowerStatus(VOID);
#endif
 
extern UINT32 LOS_SleepTicksGet(VOID);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* _LOS_LOWPOWER_H */