mbed official / mbed

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

Committer:
Kojto
Date:
Thu Jul 07 14:34:11 2016 +0100
Revision:
122:f9eeca106725
Parent:
90:cb3d968589d8
Child:
123:b0220dba8be7
Release 122 of the mbed library

Changes:
- new targets - Nucleo L432KC, Beetle, Nucleo F446ZE, Nucleo L011K4
- Thread safety addition - mbed API should contain a statement about thread safety
- critical section API addition
- CAS API (core_util_atomic_incr/decr)
- DEVICE_ are generated from targets.json file, device.h deprecated
- Callback replaces FunctionPointer to provide std like interface
- mbed HAL API docs improvements
- toolchain - prexif attributes with MBED_
- add new attributes - packed, weak, forcedinline, align
- target.json - contains targets definitions
- ST - L1XX - Cube update to 1.5
- SPI clock selection fix (clock from APB domain)
- F7 - Cube update v1.4.0
- L0 - baudrate init fix
- L1 - Cube update v1.5
- F3 - baudrate init fix, 3 targets CAN support
- F4 - Cube update v1.12.0, 3 targets CAN support
- L4XX - Cube update v1.5.1
- F0 - update Cube to v1.5.0
- L4 - 2 targets (L476RG/VG) CAN support
- NXP - pwm clock fix for KSDK2 MCU
- LPC2368 - remove ARM toolchain support - due to regression
- KSDK2 - fix SPI , I2C address and repeat start
- Silabs - some fixes backported from mbed 3
- Renesas - RZ_A1H - SystemCoreClockUpdate addition

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Kojto 90:cb3d968589d8 1 /**
Kojto 90:cb3d968589d8 2 ******************************************************************************
Kojto 90:cb3d968589d8 3 * @file stm32f3xx_hal_pwr.h
Kojto 90:cb3d968589d8 4 * @author MCD Application Team
Kojto 122:f9eeca106725 5 * @version V1.2.1
Kojto 122:f9eeca106725 6 * @date 29-April-2015
Kojto 90:cb3d968589d8 7 * @brief Header file of PWR HAL module.
Kojto 90:cb3d968589d8 8 ******************************************************************************
Kojto 90:cb3d968589d8 9 * @attention
Kojto 90:cb3d968589d8 10 *
Kojto 122:f9eeca106725 11 * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
Kojto 90:cb3d968589d8 12 *
Kojto 90:cb3d968589d8 13 * Redistribution and use in source and binary forms, with or without modification,
Kojto 90:cb3d968589d8 14 * are permitted provided that the following conditions are met:
Kojto 90:cb3d968589d8 15 * 1. Redistributions of source code must retain the above copyright notice,
Kojto 90:cb3d968589d8 16 * this list of conditions and the following disclaimer.
Kojto 90:cb3d968589d8 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
Kojto 90:cb3d968589d8 18 * this list of conditions and the following disclaimer in the documentation
Kojto 90:cb3d968589d8 19 * and/or other materials provided with the distribution.
Kojto 90:cb3d968589d8 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Kojto 90:cb3d968589d8 21 * may be used to endorse or promote products derived from this software
Kojto 90:cb3d968589d8 22 * without specific prior written permission.
Kojto 90:cb3d968589d8 23 *
Kojto 90:cb3d968589d8 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Kojto 90:cb3d968589d8 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Kojto 90:cb3d968589d8 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Kojto 90:cb3d968589d8 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Kojto 90:cb3d968589d8 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Kojto 90:cb3d968589d8 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Kojto 90:cb3d968589d8 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Kojto 90:cb3d968589d8 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Kojto 90:cb3d968589d8 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Kojto 90:cb3d968589d8 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Kojto 90:cb3d968589d8 34 *
Kojto 90:cb3d968589d8 35 ******************************************************************************
Kojto 90:cb3d968589d8 36 */
Kojto 90:cb3d968589d8 37
Kojto 90:cb3d968589d8 38 /* Define to prevent recursive inclusion -------------------------------------*/
Kojto 90:cb3d968589d8 39 #ifndef __STM32F3xx_HAL_PWR_H
Kojto 90:cb3d968589d8 40 #define __STM32F3xx_HAL_PWR_H
Kojto 90:cb3d968589d8 41
Kojto 90:cb3d968589d8 42 #ifdef __cplusplus
Kojto 90:cb3d968589d8 43 extern "C" {
Kojto 90:cb3d968589d8 44 #endif
Kojto 90:cb3d968589d8 45
Kojto 90:cb3d968589d8 46 /* Includes ------------------------------------------------------------------*/
Kojto 90:cb3d968589d8 47 #include "stm32f3xx_hal_def.h"
Kojto 90:cb3d968589d8 48
Kojto 90:cb3d968589d8 49 /** @addtogroup STM32F3xx_HAL_Driver
Kojto 90:cb3d968589d8 50 * @{
Kojto 90:cb3d968589d8 51 */
Kojto 90:cb3d968589d8 52
Kojto 122:f9eeca106725 53 /** @addtogroup PWR PWR
Kojto 90:cb3d968589d8 54 * @{
Kojto 90:cb3d968589d8 55 */
Kojto 90:cb3d968589d8 56
Kojto 90:cb3d968589d8 57 /* Exported types ------------------------------------------------------------*/
Kojto 90:cb3d968589d8 58 /* Exported constants --------------------------------------------------------*/
Kojto 90:cb3d968589d8 59 /** @defgroup PWR_Alias_Exported_Constants PWR Alias Exported Constants
Kojto 90:cb3d968589d8 60 * @{
Kojto 90:cb3d968589d8 61 */
Kojto 90:cb3d968589d8 62 /* ------------- PWR registers bit address in the alias region ---------------*/
Kojto 90:cb3d968589d8 63 #define PWR_OFFSET (PWR_BASE - PERIPH_BASE)
Kojto 90:cb3d968589d8 64
Kojto 90:cb3d968589d8 65 /* --- CR Register ---*/
Kojto 90:cb3d968589d8 66 #define CR_OFFSET (PWR_OFFSET + 0x00)
Kojto 90:cb3d968589d8 67 /* Alias word address of DBP bit */
Kojto 122:f9eeca106725 68 #define DBP_BIT_NUMBER POSITION_VAL(PWR_CR_DBP)
Kojto 122:f9eeca106725 69 #define CR_DBP_BB (PERIPH_BB_BASE + (CR_OFFSET * 32) + (DBP_BIT_NUMBER * 4))
Kojto 90:cb3d968589d8 70
Kojto 90:cb3d968589d8 71 /* Alias word address of PVDE bit */
Kojto 122:f9eeca106725 72 #define PVDE_BIT_NUMBER POSITION_VAL(PWR_CR_PVDE)
Kojto 122:f9eeca106725 73 #define CR_PVDE_BB (PERIPH_BB_BASE + (CR_OFFSET * 32) + (PVDE_BIT_NUMBER * 4))
Kojto 90:cb3d968589d8 74
Kojto 90:cb3d968589d8 75 /* --- CSR Register ---*/
Kojto 90:cb3d968589d8 76 #define CSR_OFFSET (PWR_OFFSET + 0x04)
Kojto 90:cb3d968589d8 77 /* Alias word address of EWUP1 bit */
Kojto 90:cb3d968589d8 78 #define EWUP1_BitNumber POSITION_VAL(PWR_CSR_EWUP1)
Kojto 90:cb3d968589d8 79 #define CSR_EWUP1_BB (PERIPH_BB_BASE + (CSR_OFFSET * 32) + (EWUP1_BitNumber * 4))
Kojto 90:cb3d968589d8 80
Kojto 90:cb3d968589d8 81 /* Alias word address of EWUP2 bit */
Kojto 90:cb3d968589d8 82 #define EWUP2_BitNumber POSITION_VAL(PWR_CSR_EWUP2)
Kojto 90:cb3d968589d8 83 #define CSR_EWUP2_BB (PERIPH_BB_BASE + (CSR_OFFSET * 32) + (EWUP2_BitNumber * 4))
Kojto 90:cb3d968589d8 84
Kojto 90:cb3d968589d8 85 /* Alias word address of EWUP3 bit */
Kojto 90:cb3d968589d8 86 #define EWUP3_BitNumber POSITION_VAL(PWR_CSR_EWUP3)
Kojto 90:cb3d968589d8 87 #define CSR_EWUP3_BB (PERIPH_BB_BASE + (CSR_OFFSET * 32) + (EWUP3_BitNumber * 4))
Kojto 90:cb3d968589d8 88 /**
Kojto 90:cb3d968589d8 89 * @}
Kojto 90:cb3d968589d8 90 */
Kojto 90:cb3d968589d8 91
Kojto 90:cb3d968589d8 92 /** @defgroup PWR_Exported_Constants PWR Exported Constants
Kojto 90:cb3d968589d8 93 * @{
Kojto 90:cb3d968589d8 94 */
Kojto 90:cb3d968589d8 95
Kojto 90:cb3d968589d8 96 /** @defgroup PWR_WakeUp_Pins PWR WakeUp Pins
Kojto 90:cb3d968589d8 97 * @{
Kojto 90:cb3d968589d8 98 */
Kojto 90:cb3d968589d8 99
Kojto 122:f9eeca106725 100 #define PWR_WAKEUP_PIN1 ((uint32_t)0x00) /*!< Wakeup pin 1 */
Kojto 122:f9eeca106725 101 #define PWR_WAKEUP_PIN2 ((uint32_t)0x01) /*!< Wakeup pin 2 */
Kojto 122:f9eeca106725 102 #define PWR_WAKEUP_PIN3 ((uint32_t)0x02) /*!< Wakeup pin 3 */
Kojto 90:cb3d968589d8 103 /**
Kojto 90:cb3d968589d8 104 * @}
Kojto 90:cb3d968589d8 105 */
Kojto 90:cb3d968589d8 106
Kojto 90:cb3d968589d8 107 /** @defgroup PWR_Regulator_state_in_STOP_mode PWR Regulator state in STOP mode
Kojto 90:cb3d968589d8 108 * @{
Kojto 90:cb3d968589d8 109 */
Kojto 122:f9eeca106725 110 #define PWR_MAINREGULATOR_ON ((uint32_t)0x00000000) /*!< Voltage regulator on during STOP mode */
Kojto 122:f9eeca106725 111 #define PWR_LOWPOWERREGULATOR_ON PWR_CR_LPDS /*!< Voltage regulator in low-power mode during STOP mode */
Kojto 90:cb3d968589d8 112 /**
Kojto 90:cb3d968589d8 113 * @}
Kojto 90:cb3d968589d8 114 */
Kojto 90:cb3d968589d8 115
Kojto 90:cb3d968589d8 116 /** @defgroup PWR_SLEEP_mode_entry PWR SLEEP mode entry
Kojto 90:cb3d968589d8 117 * @{
Kojto 90:cb3d968589d8 118 */
Kojto 122:f9eeca106725 119 #define PWR_SLEEPENTRY_WFI ((uint8_t)0x01) /*!< Wait For Interruption instruction to enter SLEEP mode */
Kojto 122:f9eeca106725 120 #define PWR_SLEEPENTRY_WFE ((uint8_t)0x02) /*!< Wait For Event instruction to enter SLEEP mode */
Kojto 90:cb3d968589d8 121 /**
Kojto 90:cb3d968589d8 122 * @}
Kojto 90:cb3d968589d8 123 */
Kojto 90:cb3d968589d8 124
Kojto 90:cb3d968589d8 125 /** @defgroup PWR_STOP_mode_entry PWR STOP mode entry
Kojto 90:cb3d968589d8 126 * @{
Kojto 90:cb3d968589d8 127 */
Kojto 122:f9eeca106725 128 #define PWR_STOPENTRY_WFI ((uint8_t)0x01) /*!< Wait For Interruption instruction to enter STOP mode */
Kojto 122:f9eeca106725 129 #define PWR_STOPENTRY_WFE ((uint8_t)0x02) /*!< Wait For Event instruction to enter STOP mode */
Kojto 90:cb3d968589d8 130 /**
Kojto 90:cb3d968589d8 131 * @}
Kojto 90:cb3d968589d8 132 */
Kojto 90:cb3d968589d8 133
Kojto 90:cb3d968589d8 134 /** @defgroup PWR_Flag PWR Flag
Kojto 90:cb3d968589d8 135 * @{
Kojto 90:cb3d968589d8 136 */
Kojto 122:f9eeca106725 137 #define PWR_FLAG_WU PWR_CSR_WUF /*!< Wakeup event from wakeup pin or RTC alarm */
Kojto 122:f9eeca106725 138 #define PWR_FLAG_SB PWR_CSR_SBF /*!< Standby flag */
Kojto 122:f9eeca106725 139 #define PWR_FLAG_PVDO PWR_CSR_PVDO /*!< Power Voltage Detector output flag */
Kojto 122:f9eeca106725 140 #define PWR_FLAG_VREFINTRDY PWR_CSR_VREFINTRDYF /*!< VREFINT reference voltage ready */
Kojto 90:cb3d968589d8 141 /**
Kojto 90:cb3d968589d8 142 * @}
Kojto 90:cb3d968589d8 143 */
Kojto 90:cb3d968589d8 144
Kojto 90:cb3d968589d8 145 /**
Kojto 90:cb3d968589d8 146 * @}
Kojto 90:cb3d968589d8 147 */
Kojto 90:cb3d968589d8 148
Kojto 90:cb3d968589d8 149 /* Exported macro ------------------------------------------------------------*/
Kojto 90:cb3d968589d8 150 /** @defgroup PWR_Exported_Macro PWR Exported Macro
Kojto 90:cb3d968589d8 151 * @{
Kojto 90:cb3d968589d8 152 */
Kojto 90:cb3d968589d8 153
Kojto 90:cb3d968589d8 154 /** @brief Check PWR flag is set or not.
Kojto 90:cb3d968589d8 155 * @param __FLAG__: specifies the flag to check.
Kojto 90:cb3d968589d8 156 * This parameter can be one of the following values:
Kojto 90:cb3d968589d8 157 * @arg PWR_FLAG_WU: Wake Up flag. This flag indicates that a wakeup event
Kojto 90:cb3d968589d8 158 * was received from the WKUP pin or from the RTC alarm (Alarm A
Kojto 90:cb3d968589d8 159 * or Alarm B), RTC Tamper event, RTC TimeStamp event or RTC Wakeup.
Kojto 90:cb3d968589d8 160 * An additional wakeup event is detected if the WKUP pin is enabled
Kojto 90:cb3d968589d8 161 * (by setting the EWUP bit) when the WKUP pin level is already high.
Kojto 90:cb3d968589d8 162 * @arg PWR_FLAG_SB: StandBy flag. This flag indicates that the system was
Kojto 90:cb3d968589d8 163 * resumed from StandBy mode.
Kojto 90:cb3d968589d8 164 * @arg PWR_FLAG_PVDO: PVD Output. This flag is valid only if PVD is enabled
Kojto 90:cb3d968589d8 165 * by the HAL_PWR_EnablePVD() function. The PVD is stopped by Standby mode
Kojto 90:cb3d968589d8 166 * For this reason, this bit is equal to 0 after Standby or reset
Kojto 90:cb3d968589d8 167 * until the PVDE bit is set.
Kojto 90:cb3d968589d8 168 * @arg PWR_FLAG_VREFINTRDY: This flag indicates that the internal reference
Kojto 90:cb3d968589d8 169 * voltage VREFINT is ready.
Kojto 90:cb3d968589d8 170 * @retval The new state of __FLAG__ (TRUE or FALSE).
Kojto 90:cb3d968589d8 171 */
Kojto 90:cb3d968589d8 172 #define __HAL_PWR_GET_FLAG(__FLAG__) ((PWR->CSR & (__FLAG__)) == (__FLAG__))
Kojto 90:cb3d968589d8 173
Kojto 90:cb3d968589d8 174 /** @brief Clear the PWR's pending flags.
Kojto 90:cb3d968589d8 175 * @param __FLAG__: specifies the flag to clear.
Kojto 90:cb3d968589d8 176 * This parameter can be one of the following values:
Kojto 90:cb3d968589d8 177 * @arg PWR_FLAG_WU: Wake Up flag
Kojto 90:cb3d968589d8 178 * @arg PWR_FLAG_SB: StandBy flag
Kojto 90:cb3d968589d8 179 */
Kojto 90:cb3d968589d8 180 #define __HAL_PWR_CLEAR_FLAG(__FLAG__) (PWR->CR |= (__FLAG__) << 2)
Kojto 90:cb3d968589d8 181
Kojto 90:cb3d968589d8 182 /**
Kojto 90:cb3d968589d8 183 * @}
Kojto 90:cb3d968589d8 184 */
Kojto 122:f9eeca106725 185
Kojto 122:f9eeca106725 186 /* Private macros --------------------------------------------------------*/
Kojto 122:f9eeca106725 187 /** @addtogroup PWR_Private_Macros PWR Private Macros
Kojto 122:f9eeca106725 188 * @{
Kojto 122:f9eeca106725 189 */
Kojto 122:f9eeca106725 190
Kojto 122:f9eeca106725 191 #define IS_PWR_WAKEUP_PIN(PIN) (((PIN) == PWR_WAKEUP_PIN1) || \
Kojto 122:f9eeca106725 192 ((PIN) == PWR_WAKEUP_PIN2) || \
Kojto 122:f9eeca106725 193 ((PIN) == PWR_WAKEUP_PIN3))
Kojto 122:f9eeca106725 194
Kojto 122:f9eeca106725 195 #define IS_PWR_REGULATOR(REGULATOR) (((REGULATOR) == PWR_MAINREGULATOR_ON) || \
Kojto 122:f9eeca106725 196 ((REGULATOR) == PWR_LOWPOWERREGULATOR_ON))
Kojto 122:f9eeca106725 197
Kojto 122:f9eeca106725 198 #define IS_PWR_SLEEP_ENTRY(ENTRY) (((ENTRY) == PWR_SLEEPENTRY_WFI) || ((ENTRY) == PWR_SLEEPENTRY_WFE))
Kojto 122:f9eeca106725 199
Kojto 122:f9eeca106725 200 #define IS_PWR_STOP_ENTRY(ENTRY) (((ENTRY) == PWR_STOPENTRY_WFI) || ((ENTRY) == PWR_STOPENTRY_WFE))
Kojto 122:f9eeca106725 201
Kojto 122:f9eeca106725 202 /**
Kojto 122:f9eeca106725 203 * @}
Kojto 122:f9eeca106725 204 */
Kojto 90:cb3d968589d8 205
Kojto 90:cb3d968589d8 206 /* Include PWR HAL Extended module */
Kojto 90:cb3d968589d8 207 #include "stm32f3xx_hal_pwr_ex.h"
Kojto 90:cb3d968589d8 208
Kojto 90:cb3d968589d8 209 /* Exported functions --------------------------------------------------------*/
Kojto 90:cb3d968589d8 210
Kojto 90:cb3d968589d8 211 /** @addtogroup PWR_Exported_Functions PWR Exported Functions
Kojto 90:cb3d968589d8 212 * @{
Kojto 90:cb3d968589d8 213 */
Kojto 90:cb3d968589d8 214
Kojto 90:cb3d968589d8 215 /** @addtogroup PWR_Exported_Functions_Group1 Initialization and de-initialization functions
Kojto 90:cb3d968589d8 216 * @{
Kojto 90:cb3d968589d8 217 */
Kojto 90:cb3d968589d8 218
Kojto 90:cb3d968589d8 219 /* Initialization and de-initialization functions *****************************/
Kojto 90:cb3d968589d8 220 void HAL_PWR_DeInit(void);
Kojto 90:cb3d968589d8 221
Kojto 90:cb3d968589d8 222 /**
Kojto 90:cb3d968589d8 223 * @}
Kojto 90:cb3d968589d8 224 */
Kojto 90:cb3d968589d8 225
Kojto 90:cb3d968589d8 226 /** @addtogroup PWR_Exported_Functions_Group2 Peripheral Control functions
Kojto 90:cb3d968589d8 227 * @{
Kojto 90:cb3d968589d8 228 */
Kojto 90:cb3d968589d8 229
Kojto 90:cb3d968589d8 230 /* Peripheral Control functions **********************************************/
Kojto 90:cb3d968589d8 231 void HAL_PWR_EnableBkUpAccess(void);
Kojto 90:cb3d968589d8 232 void HAL_PWR_DisableBkUpAccess(void);
Kojto 90:cb3d968589d8 233
Kojto 90:cb3d968589d8 234 /* WakeUp pins configuration functions ****************************************/
Kojto 90:cb3d968589d8 235 void HAL_PWR_EnableWakeUpPin(uint32_t WakeUpPinx);
Kojto 90:cb3d968589d8 236 void HAL_PWR_DisableWakeUpPin(uint32_t WakeUpPinx);
Kojto 90:cb3d968589d8 237
Kojto 90:cb3d968589d8 238 /* Low Power modes configuration functions ************************************/
Kojto 90:cb3d968589d8 239 void HAL_PWR_EnterSTOPMode(uint32_t Regulator, uint8_t STOPEntry);
Kojto 90:cb3d968589d8 240 void HAL_PWR_EnterSLEEPMode(uint32_t Regulator, uint8_t SLEEPEntry);
Kojto 90:cb3d968589d8 241 void HAL_PWR_EnterSTANDBYMode(void);
Kojto 90:cb3d968589d8 242
Kojto 122:f9eeca106725 243 void HAL_PWR_EnableSleepOnExit(void);
Kojto 122:f9eeca106725 244 void HAL_PWR_DisableSleepOnExit(void);
Kojto 122:f9eeca106725 245 void HAL_PWR_EnableSEVOnPend(void);
Kojto 122:f9eeca106725 246 void HAL_PWR_DisableSEVOnPend(void);
Kojto 90:cb3d968589d8 247 /**
Kojto 90:cb3d968589d8 248 * @}
Kojto 90:cb3d968589d8 249 */
Kojto 90:cb3d968589d8 250
Kojto 90:cb3d968589d8 251 /**
Kojto 90:cb3d968589d8 252 * @}
Kojto 90:cb3d968589d8 253 */
Kojto 90:cb3d968589d8 254
Kojto 90:cb3d968589d8 255 /**
Kojto 90:cb3d968589d8 256 * @}
Kojto 90:cb3d968589d8 257 */
Kojto 90:cb3d968589d8 258
Kojto 90:cb3d968589d8 259 /**
Kojto 90:cb3d968589d8 260 * @}
Kojto 90:cb3d968589d8 261 */
Kojto 90:cb3d968589d8 262
Kojto 90:cb3d968589d8 263 #ifdef __cplusplus
Kojto 90:cb3d968589d8 264 }
Kojto 90:cb3d968589d8 265 #endif
Kojto 90:cb3d968589d8 266
Kojto 90:cb3d968589d8 267
Kojto 90:cb3d968589d8 268 #endif /* __STM32F3xx_HAL_PWR_H */
Kojto 90:cb3d968589d8 269
Kojto 90:cb3d968589d8 270 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/