Abdessamad El Abbassi / mbed-src-temp

mbed library sources

Fork of mbed-src by mbed official

targets/cmsis/TARGET_STM/TARGET_NUCLEO_L152RE/stm32l1xx_pwr.h@106:ced8cbb51063, 2014-02-26 (annotated)

Committer:
mbed_official
Date:
Wed Feb 26 09:45:12 2014 +0000
Revision:
106:ced8cbb51063
Parent:
80:66393a7b209d 
Synchronized with git revision 4222735eff5868389433f0e9271976b39c8115cd



Full URL: https://github.com/mbedmicro/mbed/commit/4222735eff5868389433f0e9271976b39c8115cd/



[NUCLEO_xxx] Update STM32CubeF4 driver V1.0.0 + update license

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 76:aeb1df146756 1 /**
mbed_official 76:aeb1df146756 2 ******************************************************************************
mbed_official 76:aeb1df146756 3 * @file stm32l1xx_pwr.h
mbed_official 76:aeb1df146756 4 * @author MCD Application Team
mbed_official 80:66393a7b209d 5 * @version V1.3.0
mbed_official 80:66393a7b209d 6 * @date 31-January-2014
mbed_official 76:aeb1df146756 7 * @brief This file contains all the functions prototypes for the PWR firmware
mbed_official 76:aeb1df146756 8 * library.
mbed_official 76:aeb1df146756 9 ******************************************************************************
mbed_official 76:aeb1df146756 10 * @attention
mbed_official 76:aeb1df146756 11 *
mbed_official 106:ced8cbb51063 12 * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
mbed_official 76:aeb1df146756 13 *
mbed_official 106:ced8cbb51063 14 * Redistribution and use in source and binary forms, with or without modification,
mbed_official 106:ced8cbb51063 15 * are permitted provided that the following conditions are met:
mbed_official 106:ced8cbb51063 16 * 1. Redistributions of source code must retain the above copyright notice,
mbed_official 106:ced8cbb51063 17 * this list of conditions and the following disclaimer.
mbed_official 106:ced8cbb51063 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
mbed_official 106:ced8cbb51063 19 * this list of conditions and the following disclaimer in the documentation
mbed_official 106:ced8cbb51063 20 * and/or other materials provided with the distribution.
mbed_official 106:ced8cbb51063 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
mbed_official 106:ced8cbb51063 22 * may be used to endorse or promote products derived from this software
mbed_official 106:ced8cbb51063 23 * without specific prior written permission.
mbed_official 76:aeb1df146756 24 *
mbed_official 106:ced8cbb51063 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
mbed_official 106:ced8cbb51063 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
mbed_official 106:ced8cbb51063 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
mbed_official 106:ced8cbb51063 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
mbed_official 106:ced8cbb51063 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
mbed_official 106:ced8cbb51063 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
mbed_official 106:ced8cbb51063 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
mbed_official 106:ced8cbb51063 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
mbed_official 106:ced8cbb51063 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
mbed_official 106:ced8cbb51063 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
mbed_official 76:aeb1df146756 35 *
mbed_official 76:aeb1df146756 36 ******************************************************************************
mbed_official 76:aeb1df146756 37 */
mbed_official 76:aeb1df146756 38
mbed_official 76:aeb1df146756 39 /* Define to prevent recursive inclusion -------------------------------------*/
mbed_official 76:aeb1df146756 40 #ifndef __STM32L1xx_PWR_H
mbed_official 76:aeb1df146756 41 #define __STM32L1xx_PWR_H
mbed_official 76:aeb1df146756 42
mbed_official 76:aeb1df146756 43 #ifdef __cplusplus
mbed_official 76:aeb1df146756 44 extern "C" {
mbed_official 76:aeb1df146756 45 #endif
mbed_official 76:aeb1df146756 46
mbed_official 76:aeb1df146756 47 /* Includes ------------------------------------------------------------------*/
mbed_official 76:aeb1df146756 48 #include "stm32l1xx.h"
mbed_official 76:aeb1df146756 49
mbed_official 76:aeb1df146756 50 /** @addtogroup STM32L1xx_StdPeriph_Driver
mbed_official 76:aeb1df146756 51 * @{
mbed_official 76:aeb1df146756 52 */
mbed_official 76:aeb1df146756 53
mbed_official 76:aeb1df146756 54 /** @addtogroup PWR
mbed_official 76:aeb1df146756 55 * @{
mbed_official 76:aeb1df146756 56 */
mbed_official 76:aeb1df146756 57
mbed_official 76:aeb1df146756 58 /* Exported types ------------------------------------------------------------*/
mbed_official 76:aeb1df146756 59 /* Exported constants --------------------------------------------------------*/
mbed_official 76:aeb1df146756 60
mbed_official 76:aeb1df146756 61 /** @defgroup PWR_Exported_Constants
mbed_official 76:aeb1df146756 62 * @{
mbed_official 76:aeb1df146756 63 */
mbed_official 76:aeb1df146756 64
mbed_official 76:aeb1df146756 65 /** @defgroup PWR_PVD_detection_level
mbed_official 76:aeb1df146756 66 * @{
mbed_official 76:aeb1df146756 67 */
mbed_official 76:aeb1df146756 68
mbed_official 76:aeb1df146756 69 #define PWR_PVDLevel_0 PWR_CR_PLS_LEV0
mbed_official 76:aeb1df146756 70 #define PWR_PVDLevel_1 PWR_CR_PLS_LEV1
mbed_official 76:aeb1df146756 71 #define PWR_PVDLevel_2 PWR_CR_PLS_LEV2
mbed_official 76:aeb1df146756 72 #define PWR_PVDLevel_3 PWR_CR_PLS_LEV3
mbed_official 76:aeb1df146756 73 #define PWR_PVDLevel_4 PWR_CR_PLS_LEV4
mbed_official 76:aeb1df146756 74 #define PWR_PVDLevel_5 PWR_CR_PLS_LEV5
mbed_official 76:aeb1df146756 75 #define PWR_PVDLevel_6 PWR_CR_PLS_LEV6
mbed_official 76:aeb1df146756 76 #define PWR_PVDLevel_7 PWR_CR_PLS_LEV7 /* External input analog voltage
mbed_official 76:aeb1df146756 77 (Compare internally to VREFINT) */
mbed_official 76:aeb1df146756 78 #define IS_PWR_PVD_LEVEL(LEVEL) (((LEVEL) == PWR_PVDLevel_0) || ((LEVEL) == PWR_PVDLevel_1)|| \
mbed_official 76:aeb1df146756 79 ((LEVEL) == PWR_PVDLevel_2) || ((LEVEL) == PWR_PVDLevel_3)|| \
mbed_official 76:aeb1df146756 80 ((LEVEL) == PWR_PVDLevel_4) || ((LEVEL) == PWR_PVDLevel_5)|| \
mbed_official 76:aeb1df146756 81 ((LEVEL) == PWR_PVDLevel_6) || ((LEVEL) == PWR_PVDLevel_7))
mbed_official 76:aeb1df146756 82 /**
mbed_official 76:aeb1df146756 83 * @}
mbed_official 76:aeb1df146756 84 */
mbed_official 76:aeb1df146756 85
mbed_official 76:aeb1df146756 86 /** @defgroup PWR_WakeUp_Pins
mbed_official 76:aeb1df146756 87 * @{
mbed_official 76:aeb1df146756 88 */
mbed_official 76:aeb1df146756 89
mbed_official 76:aeb1df146756 90 #define PWR_WakeUpPin_1 ((uint32_t)0x00000000)
mbed_official 76:aeb1df146756 91 #define PWR_WakeUpPin_2 ((uint32_t)0x00000004)
mbed_official 76:aeb1df146756 92 #define PWR_WakeUpPin_3 ((uint32_t)0x00000008)
mbed_official 76:aeb1df146756 93 #define IS_PWR_WAKEUP_PIN(PIN) (((PIN) == PWR_WakeUpPin_1) || \
mbed_official 76:aeb1df146756 94 ((PIN) == PWR_WakeUpPin_2) || \
mbed_official 76:aeb1df146756 95 ((PIN) == PWR_WakeUpPin_3))
mbed_official 76:aeb1df146756 96 /**
mbed_official 76:aeb1df146756 97 * @}
mbed_official 76:aeb1df146756 98 */
mbed_official 76:aeb1df146756 99
mbed_official 76:aeb1df146756 100
mbed_official 76:aeb1df146756 101 /** @defgroup PWR_Voltage_Scaling_Ranges
mbed_official 76:aeb1df146756 102 * @{
mbed_official 76:aeb1df146756 103 */
mbed_official 76:aeb1df146756 104
mbed_official 76:aeb1df146756 105 #define PWR_VoltageScaling_Range1 PWR_CR_VOS_0
mbed_official 76:aeb1df146756 106 #define PWR_VoltageScaling_Range2 PWR_CR_VOS_1
mbed_official 76:aeb1df146756 107 #define PWR_VoltageScaling_Range3 PWR_CR_VOS
mbed_official 76:aeb1df146756 108
mbed_official 76:aeb1df146756 109 #define IS_PWR_VOLTAGE_SCALING_RANGE(RANGE) (((RANGE) == PWR_VoltageScaling_Range1) || \
mbed_official 76:aeb1df146756 110 ((RANGE) == PWR_VoltageScaling_Range2) || \
mbed_official 76:aeb1df146756 111 ((RANGE) == PWR_VoltageScaling_Range3))
mbed_official 76:aeb1df146756 112 /**
mbed_official 76:aeb1df146756 113 * @}
mbed_official 76:aeb1df146756 114 */
mbed_official 76:aeb1df146756 115
mbed_official 76:aeb1df146756 116 /** @defgroup PWR_Regulator_state_is_Sleep_STOP_mode
mbed_official 76:aeb1df146756 117 * @{
mbed_official 76:aeb1df146756 118 */
mbed_official 76:aeb1df146756 119
mbed_official 76:aeb1df146756 120 #define PWR_Regulator_ON ((uint32_t)0x00000000)
mbed_official 76:aeb1df146756 121 #define PWR_Regulator_LowPower PWR_CR_LPSDSR
mbed_official 76:aeb1df146756 122 #define IS_PWR_REGULATOR(REGULATOR) (((REGULATOR) == PWR_Regulator_ON) || \
mbed_official 76:aeb1df146756 123 ((REGULATOR) == PWR_Regulator_LowPower))
mbed_official 76:aeb1df146756 124 /**
mbed_official 76:aeb1df146756 125 * @}
mbed_official 76:aeb1df146756 126 */
mbed_official 76:aeb1df146756 127
mbed_official 76:aeb1df146756 128 /** @defgroup PWR_SLEEP_mode_entry
mbed_official 76:aeb1df146756 129 * @{
mbed_official 76:aeb1df146756 130 */
mbed_official 76:aeb1df146756 131
mbed_official 76:aeb1df146756 132 #define PWR_SLEEPEntry_WFI ((uint8_t)0x01)
mbed_official 76:aeb1df146756 133 #define PWR_SLEEPEntry_WFE ((uint8_t)0x02)
mbed_official 76:aeb1df146756 134 #define IS_PWR_SLEEP_ENTRY(ENTRY) (((ENTRY) == PWR_SLEEPEntry_WFI) || ((ENTRY) == PWR_SLEEPEntry_WFE))
mbed_official 76:aeb1df146756 135
mbed_official 76:aeb1df146756 136 /**
mbed_official 76:aeb1df146756 137 * @}
mbed_official 76:aeb1df146756 138 */
mbed_official 76:aeb1df146756 139
mbed_official 76:aeb1df146756 140 /** @defgroup PWR_STOP_mode_entry
mbed_official 76:aeb1df146756 141 * @{
mbed_official 76:aeb1df146756 142 */
mbed_official 76:aeb1df146756 143
mbed_official 76:aeb1df146756 144 #define PWR_STOPEntry_WFI ((uint8_t)0x01)
mbed_official 76:aeb1df146756 145 #define PWR_STOPEntry_WFE ((uint8_t)0x02)
mbed_official 76:aeb1df146756 146 #define IS_PWR_STOP_ENTRY(ENTRY) (((ENTRY) == PWR_STOPEntry_WFI) || ((ENTRY) == PWR_STOPEntry_WFE))
mbed_official 76:aeb1df146756 147
mbed_official 76:aeb1df146756 148 /**
mbed_official 76:aeb1df146756 149 * @}
mbed_official 76:aeb1df146756 150 */
mbed_official 76:aeb1df146756 151
mbed_official 76:aeb1df146756 152 /** @defgroup PWR_Flag
mbed_official 76:aeb1df146756 153 * @{
mbed_official 76:aeb1df146756 154 */
mbed_official 76:aeb1df146756 155
mbed_official 76:aeb1df146756 156 #define PWR_FLAG_WU PWR_CSR_WUF
mbed_official 76:aeb1df146756 157 #define PWR_FLAG_SB PWR_CSR_SBF
mbed_official 76:aeb1df146756 158 #define PWR_FLAG_PVDO PWR_CSR_PVDO
mbed_official 76:aeb1df146756 159 #define PWR_FLAG_VREFINTRDY PWR_CSR_VREFINTRDYF
mbed_official 76:aeb1df146756 160 #define PWR_FLAG_VOS PWR_CSR_VOSF
mbed_official 76:aeb1df146756 161 #define PWR_FLAG_REGLP PWR_CSR_REGLPF
mbed_official 76:aeb1df146756 162
mbed_official 76:aeb1df146756 163 #define IS_PWR_GET_FLAG(FLAG) (((FLAG) == PWR_FLAG_WU) || ((FLAG) == PWR_FLAG_SB) || \
mbed_official 76:aeb1df146756 164 ((FLAG) == PWR_FLAG_PVDO) || ((FLAG) == PWR_FLAG_VREFINTRDY) || \
mbed_official 76:aeb1df146756 165 ((FLAG) == PWR_FLAG_VOS) || ((FLAG) == PWR_FLAG_REGLP))
mbed_official 76:aeb1df146756 166
mbed_official 76:aeb1df146756 167 #define IS_PWR_CLEAR_FLAG(FLAG) (((FLAG) == PWR_FLAG_WU) || ((FLAG) == PWR_FLAG_SB))
mbed_official 76:aeb1df146756 168 /**
mbed_official 76:aeb1df146756 169 * @}
mbed_official 76:aeb1df146756 170 */
mbed_official 76:aeb1df146756 171
mbed_official 76:aeb1df146756 172 /**
mbed_official 76:aeb1df146756 173 * @}
mbed_official 76:aeb1df146756 174 */
mbed_official 76:aeb1df146756 175
mbed_official 76:aeb1df146756 176 /* Exported macro ------------------------------------------------------------*/
mbed_official 76:aeb1df146756 177 /* Exported functions ------------------------------------------------------- */
mbed_official 76:aeb1df146756 178
mbed_official 76:aeb1df146756 179 /* Function used to set the PWR configuration to the default reset state ******/
mbed_official 76:aeb1df146756 180 void PWR_DeInit(void);
mbed_official 76:aeb1df146756 181
mbed_official 76:aeb1df146756 182 /* RTC Domain Access function *************************************************/
mbed_official 76:aeb1df146756 183 void PWR_RTCAccessCmd(FunctionalState NewState);
mbed_official 76:aeb1df146756 184
mbed_official 76:aeb1df146756 185 /* PVD configuration functions ************************************************/
mbed_official 76:aeb1df146756 186 void PWR_PVDLevelConfig(uint32_t PWR_PVDLevel);
mbed_official 76:aeb1df146756 187 void PWR_PVDCmd(FunctionalState NewState);
mbed_official 76:aeb1df146756 188
mbed_official 76:aeb1df146756 189 /* WakeUp pins configuration functions ****************************************/
mbed_official 76:aeb1df146756 190 void PWR_WakeUpPinCmd(uint32_t PWR_WakeUpPin, FunctionalState NewState);
mbed_official 76:aeb1df146756 191
mbed_official 76:aeb1df146756 192 /* Ultra Low Power mode configuration functions *******************************/
mbed_official 76:aeb1df146756 193 void PWR_FastWakeUpCmd(FunctionalState NewState);
mbed_official 76:aeb1df146756 194 void PWR_UltraLowPowerCmd(FunctionalState NewState);
mbed_official 76:aeb1df146756 195
mbed_official 76:aeb1df146756 196 /* Voltage Scaling configuration functions ************************************/
mbed_official 76:aeb1df146756 197 void PWR_VoltageScalingConfig(uint32_t PWR_VoltageScaling);
mbed_official 76:aeb1df146756 198
mbed_official 76:aeb1df146756 199 /* Low Power modes configuration functions ************************************/
mbed_official 76:aeb1df146756 200 void PWR_EnterLowPowerRunMode(FunctionalState NewState);
mbed_official 76:aeb1df146756 201 void PWR_EnterSleepMode(uint32_t PWR_Regulator, uint8_t PWR_SLEEPEntry);
mbed_official 76:aeb1df146756 202 void PWR_EnterSTOPMode(uint32_t PWR_Regulator, uint8_t PWR_STOPEntry);
mbed_official 76:aeb1df146756 203 void PWR_EnterSTANDBYMode(void);
mbed_official 76:aeb1df146756 204
mbed_official 76:aeb1df146756 205 /* Flags management functions *************************************************/
mbed_official 76:aeb1df146756 206 FlagStatus PWR_GetFlagStatus(uint32_t PWR_FLAG);
mbed_official 76:aeb1df146756 207 void PWR_ClearFlag(uint32_t PWR_FLAG);
mbed_official 76:aeb1df146756 208
mbed_official 76:aeb1df146756 209 #ifdef __cplusplus
mbed_official 76:aeb1df146756 210 }
mbed_official 76:aeb1df146756 211 #endif
mbed_official 76:aeb1df146756 212
mbed_official 76:aeb1df146756 213 #endif /* __STM32L1xx_PWR_H */
mbed_official 76:aeb1df146756 214
mbed_official 76:aeb1df146756 215 /**
mbed_official 76:aeb1df146756 216 * @}
mbed_official 76:aeb1df146756 217 */
mbed_official 76:aeb1df146756 218
mbed_official 76:aeb1df146756 219 /**
mbed_official 76:aeb1df146756 220 * @}
mbed_official 76:aeb1df146756 221 */
mbed_official 76:aeb1df146756 222
mbed_official 76:aeb1df146756 223 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/