1 /****************************************************************************** 2 * Copyright (C) 2017, Huada Semiconductor Co.,Ltd All rights reserved. 3 * 4 * This software is owned and published by: 5 * Huada Semiconductor Co.,Ltd ("HDSC"). 6 * 7 * BY DOWNLOADING, INSTALLING OR USING THIS SOFTWARE, YOU AGREE TO BE BOUND 8 * BY ALL THE TERMS AND CONDITIONS OF THIS AGREEMENT. 9 * 10 * This software contains source code for use with HDSC 11 * components. This software is licensed by HDSC to be adapted only 12 * for use in systems utilizing HDSC components. HDSC shall not be 13 * responsible for misuse or illegal use of this software for devices not 14 * supported herein. HDSC is providing this software "AS IS" and will 15 * not be responsible for issues arising from incorrect user implementation 16 * of the software. 17 * 18 * Disclaimer: 19 * HDSC MAKES NO WARRANTY, EXPRESS OR IMPLIED, ARISING BY LAW OR OTHERWISE, 20 * REGARDING THE SOFTWARE (INCLUDING ANY ACOOMPANYING WRITTEN MATERIALS), 21 * ITS PERFORMANCE OR SUITABILITY FOR YOUR INTENDED USE, INCLUDING, 22 * WITHOUT LIMITATION, THE IMPLIED WARRANTY OF MERCHANTABILITY, THE IMPLIED 23 * WARRANTY OF FITNESS FOR A PARTICULAR PURPOSE OR USE, AND THE IMPLIED 24 * WARRANTY OF NONINFRINGEMENT. 25 * HDSC SHALL HAVE NO LIABILITY (WHETHER IN CONTRACT, WARRANTY, TORT, 26 * NEGLIGENCE OR OTHERWISE) FOR ANY DAMAGES WHATSOEVER (INCLUDING, WITHOUT 27 * LIMITATION, DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, 28 * LOSS OF BUSINESS INFORMATION, OR OTHER PECUNIARY LOSS) ARISING FROM USE OR 29 * INABILITY TO USE THE SOFTWARE, INCLUDING, WITHOUT LIMITATION, ANY DIRECT, 30 * INDIRECT, INCIDENTAL, SPECIAL OR CONSEQUENTIAL DAMAGES OR LOSS OF DATA, 31 * SAVINGS OR PROFITS, 32 * EVEN IF Disclaimer HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 33 * YOU ASSUME ALL RESPONSIBILITIES FOR SELECTION OF THE SOFTWARE TO ACHIEVE YOUR 34 * INTENDED RESULTS, AND FOR THE INSTALLATION OF, USE OF, AND RESULTS OBTAINED 35 * FROM, THE SOFTWARE. 36 * 37 * This software may be replicated in part or whole for the licensed use, 38 * with the restriction that this Disclaimer and Copyright notice must be 39 * included with each copy of this software, whether used in part or whole, 40 * at all times. 41 */ 42 /*****************************************************************************/ 43 /** \file lpm.h 44 ** 45 ** Lpm 数据结构及API声明 46 ** 47 ** 48 ** History: 49 ** - 2017-06-06 Lux V1.0 50 ** 51 *****************************************************************************/ 52 53 #ifndef __LPM_H__ 54 #define __LPM_H__ 55 56 /***************************************************************************** 57 * Include files 58 *****************************************************************************/ 59 #include "ddl.h" 60 61 #ifdef __cplusplus 62 extern "C" 63 { 64 #endif 65 66 /** 67 ******************************************************************************* 68 ** \defgroup LpmGroup Low Power Management (LPM) 69 ** 70 ** 71 ******************************************************************************/ 72 //@{ 73 74 /****************************************************************************** 75 ** Global pre-processor symbols/macros ('#define') 76 ******************************************************************************/ 77 78 /****************************************************************************** 79 * Global type definitions 80 ******************************************************************************/ 81 82 /** 83 ****************************************************************************** 84 ** \brief 事件挂起使能枚举重定义 (SEVONPEND) 85 *****************************************************************************/ 86 typedef enum en_lpm_sevonpend 87 { 88 SevPndDisable = 0u, ///< 事件挂起禁止 89 SevPndEnable = 1u, ///< 事件挂起使能 90 }en_lpm_sevonpend_t; 91 92 /** 93 ****************************************************************************** 94 ** \brief 深度睡眠使能枚举重定义 (SLEEPDEEP) 95 *****************************************************************************/ 96 typedef enum en_lpm_sleepdeep 97 { 98 SlpDpDisable = 0u, ///< 深度睡眠禁止 99 SlpDpEnable = 1u, ///< 深度睡眠使能 100 }en_lpm_sleepdeep_t; 101 102 /** 103 ****************************************************************************** 104 ** \brief 异常退出进睡眠使能枚举重定义 (SLEEPONEXIT) 105 *****************************************************************************/ 106 typedef enum en_lpm_sleeponexit 107 { 108 SlpExtDisable = 0u, ///< 异常退出进睡眠禁止 109 SlpExtEnable = 1u, ///< 异常退出进睡眠使能 110 }en_lpm_sleeponexit_t; 111 112 /** 113 ****************************************************************************** 114 ** \brief Low Power Mode 配置结构体定义 115 *****************************************************************************/ 116 typedef struct stc_lpm_config 117 { 118 en_lpm_sevonpend_t enSEVONPEND; ///< 使能:每次新中断会产生一个事件,如果使用WFE休眠,则可用于唤醒处理器. 119 en_lpm_sleepdeep_t enSLEEPDEEP; ///< 使能:执行WFI进入深度休眠;不使能:执行WFI进入休眠. 120 en_lpm_sleeponexit_t enSLEEPONEXIT; ///< 使能:退出异常处理并返回时,处理器自动进入休眠模式;不使能:该特性禁止. 121 }stc_lpm_config_t; 122 123 /****************************************************************************** 124 * Global variable declarations ('extern', definition in C source) 125 *****************************************************************************/ 126 127 /****************************************************************************** 128 * Global function prototypes (definition in C source) 129 *****************************************************************************/ 130 ///<功能配置及操作函数 131 ///<低功耗模式配置 132 en_result_t Lpm_Config(stc_lpm_config_t* pstcConfig); 133 ///<进入低功耗模式 134 void Lpm_GotoLpmMode(void); 135 136 //@} // LpmGroup 137 138 #ifdef __cplusplus 139 #endif 140 141 142 #endif /* __LPM_H__ */ 143 /****************************************************************************** 144 * EOF (not truncated) 145 *****************************************************************************/ 146 147 148