source: asp3_wo_tecs/trunk/arch/arm_m_gcc/stm32f4xx_stm32cube/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_pwr.h@ 303

Last change on this file since 303 was 303, checked in by ertl-honda, 7 years ago

nucleo_f401re依存部の追加

File size: 15.1 KB
Line 
1/**
2 ******************************************************************************
3 * @file stm32f4xx_hal_pwr.h
4 * @author MCD Application Team
5 * @version V1.4.1
6 * @date 09-October-2015
7 * @brief Header file of PWR HAL module.
8 ******************************************************************************
9 * @attention
10 *
11 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
12 *
13 * Redistribution and use in source and binary forms, with or without modification,
14 * are permitted provided that the following conditions are met:
15 * 1. Redistributions of source code must retain the above copyright notice,
16 * this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright notice,
18 * this list of conditions and the following disclaimer in the documentation
19 * and/or other materials provided with the distribution.
20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 *
35 ******************************************************************************
36 */
37
38/* Define to prevent recursive inclusion -------------------------------------*/
39#ifndef __STM32F4xx_HAL_PWR_H
40#define __STM32F4xx_HAL_PWR_H
41
42#ifdef __cplusplus
43 extern "C" {
44#endif
45
46/* Includes ------------------------------------------------------------------*/
47#include "stm32f4xx_hal_def.h"
48
49/** @addtogroup STM32F4xx_HAL_Driver
50 * @{
51 */
52
53/** @addtogroup PWR
54 * @{
55 */
56
57/* Exported types ------------------------------------------------------------*/
58
59/** @defgroup PWR_Exported_Types PWR Exported Types
60 * @{
61 */
62
63/**
64 * @brief PWR PVD configuration structure definition
65 */
66typedef struct
67{
68 uint32_t PVDLevel; /*!< PVDLevel: Specifies the PVD detection level.
69 This parameter can be a value of @ref PWR_PVD_detection_level */
70
71 uint32_t Mode; /*!< Mode: Specifies the operating mode for the selected pins.
72 This parameter can be a value of @ref PWR_PVD_Mode */
73}PWR_PVDTypeDef;
74
75/**
76 * @}
77 */
78
79/* Exported constants --------------------------------------------------------*/
80/** @defgroup PWR_Exported_Constants PWR Exported Constants
81 * @{
82 */
83
84/** @defgroup PWR_WakeUp_Pins PWR WakeUp Pins
85 * @{
86 */
87#define PWR_WAKEUP_PIN1 ((uint32_t)0x00000100)
88/**
89 * @}
90 */
91
92/** @defgroup PWR_PVD_detection_level PWR PVD detection level
93 * @{
94 */
95#define PWR_PVDLEVEL_0 PWR_CR_PLS_LEV0
96#define PWR_PVDLEVEL_1 PWR_CR_PLS_LEV1
97#define PWR_PVDLEVEL_2 PWR_CR_PLS_LEV2
98#define PWR_PVDLEVEL_3 PWR_CR_PLS_LEV3
99#define PWR_PVDLEVEL_4 PWR_CR_PLS_LEV4
100#define PWR_PVDLEVEL_5 PWR_CR_PLS_LEV5
101#define PWR_PVDLEVEL_6 PWR_CR_PLS_LEV6
102#define PWR_PVDLEVEL_7 PWR_CR_PLS_LEV7/* External input analog voltage
103 (Compare internally to VREFINT) */
104/**
105 * @}
106 */
107
108/** @defgroup PWR_PVD_Mode PWR PVD Mode
109 * @{
110 */
111#define PWR_PVD_MODE_NORMAL ((uint32_t)0x00000000) /*!< basic mode is used */
112#define PWR_PVD_MODE_IT_RISING ((uint32_t)0x00010001) /*!< External Interrupt Mode with Rising edge trigger detection */
113#define PWR_PVD_MODE_IT_FALLING ((uint32_t)0x00010002) /*!< External Interrupt Mode with Falling edge trigger detection */
114#define PWR_PVD_MODE_IT_RISING_FALLING ((uint32_t)0x00010003) /*!< External Interrupt Mode with Rising/Falling edge trigger detection */
115#define PWR_PVD_MODE_EVENT_RISING ((uint32_t)0x00020001) /*!< Event Mode with Rising edge trigger detection */
116#define PWR_PVD_MODE_EVENT_FALLING ((uint32_t)0x00020002) /*!< Event Mode with Falling edge trigger detection */
117#define PWR_PVD_MODE_EVENT_RISING_FALLING ((uint32_t)0x00020003) /*!< Event Mode with Rising/Falling edge trigger detection */
118/**
119 * @}
120 */
121
122
123/** @defgroup PWR_Regulator_state_in_STOP_mode PWR Regulator state in SLEEP/STOP mode
124 * @{
125 */
126#define PWR_MAINREGULATOR_ON ((uint32_t)0x00000000)
127#define PWR_LOWPOWERREGULATOR_ON PWR_CR_LPDS
128/**
129 * @}
130 */
131
132/** @defgroup PWR_SLEEP_mode_entry PWR SLEEP mode entry
133 * @{
134 */
135#define PWR_SLEEPENTRY_WFI ((uint8_t)0x01)
136#define PWR_SLEEPENTRY_WFE ((uint8_t)0x02)
137/**
138 * @}
139 */
140
141/** @defgroup PWR_STOP_mode_entry PWR STOP mode entry
142 * @{
143 */
144#define PWR_STOPENTRY_WFI ((uint8_t)0x01)
145#define PWR_STOPENTRY_WFE ((uint8_t)0x02)
146/**
147 * @}
148 */
149
150/** @defgroup PWR_Flag PWR Flag
151 * @{
152 */
153#define PWR_FLAG_WU PWR_CSR_WUF
154#define PWR_FLAG_SB PWR_CSR_SBF
155#define PWR_FLAG_PVDO PWR_CSR_PVDO
156#define PWR_FLAG_BRR PWR_CSR_BRR
157#define PWR_FLAG_VOSRDY PWR_CSR_VOSRDY
158/**
159 * @}
160 */
161
162/**
163 * @}
164 */
165
166/* Exported macro ------------------------------------------------------------*/
167/** @defgroup PWR_Exported_Macro PWR Exported Macro
168 * @{
169 */
170
171/** @brief Check PWR flag is set or not.
172 * @param __FLAG__: specifies the flag to check.
173 * This parameter can be one of the following values:
174 * @arg PWR_FLAG_WU: Wake Up flag. This flag indicates that a wakeup event
175 * was received from the WKUP pin or from the RTC alarm (Alarm A
176 * or Alarm B), RTC Tamper event, RTC TimeStamp event or RTC Wakeup.
177 * An additional wakeup event is detected if the WKUP pin is enabled
178 * (by setting the EWUP bit) when the WKUP pin level is already high.
179 * @arg PWR_FLAG_SB: StandBy flag. This flag indicates that the system was
180 * resumed from StandBy mode.
181 * @arg PWR_FLAG_PVDO: PVD Output. This flag is valid only if PVD is enabled
182 * by the HAL_PWR_EnablePVD() function. The PVD is stopped by Standby mode
183 * For this reason, this bit is equal to 0 after Standby or reset
184 * until the PVDE bit is set.
185 * @arg PWR_FLAG_BRR: Backup regulator ready flag. This bit is not reset
186 * when the device wakes up from Standby mode or by a system reset
187 * or power reset.
188 * @arg PWR_FLAG_VOSRDY: This flag indicates that the Regulator voltage
189 * scaling output selection is ready.
190 * @retval The new state of __FLAG__ (TRUE or FALSE).
191 */
192#define __HAL_PWR_GET_FLAG(__FLAG__) ((PWR->CSR & (__FLAG__)) == (__FLAG__))
193
194/** @brief Clear the PWR's pending flags.
195 * @param __FLAG__: specifies the flag to clear.
196 * This parameter can be one of the following values:
197 * @arg PWR_FLAG_WU: Wake Up flag
198 * @arg PWR_FLAG_SB: StandBy flag
199 */
200#define __HAL_PWR_CLEAR_FLAG(__FLAG__) (PWR->CR |= (__FLAG__) << 2)
201
202/**
203 * @brief Enable the PVD Exti Line 16.
204 * @retval None.
205 */
206#define __HAL_PWR_PVD_EXTI_ENABLE_IT() (EXTI->IMR |= (PWR_EXTI_LINE_PVD))
207
208/**
209 * @brief Disable the PVD EXTI Line 16.
210 * @retval None.
211 */
212#define __HAL_PWR_PVD_EXTI_DISABLE_IT() (EXTI->IMR &= ~(PWR_EXTI_LINE_PVD))
213
214/**
215 * @brief Enable event on PVD Exti Line 16.
216 * @retval None.
217 */
218#define __HAL_PWR_PVD_EXTI_ENABLE_EVENT() (EXTI->EMR |= (PWR_EXTI_LINE_PVD))
219
220/**
221 * @brief Disable event on PVD Exti Line 16.
222 * @retval None.
223 */
224#define __HAL_PWR_PVD_EXTI_DISABLE_EVENT() (EXTI->EMR &= ~(PWR_EXTI_LINE_PVD))
225
226/**
227 * @brief Enable the PVD Extended Interrupt Rising Trigger.
228 * @retval None.
229 */
230#define __HAL_PWR_PVD_EXTI_ENABLE_RISING_EDGE() SET_BIT(EXTI->RTSR, PWR_EXTI_LINE_PVD)
231
232/**
233 * @brief Disable the PVD Extended Interrupt Rising Trigger.
234 * @retval None.
235 */
236#define __HAL_PWR_PVD_EXTI_DISABLE_RISING_EDGE() CLEAR_BIT(EXTI->RTSR, PWR_EXTI_LINE_PVD)
237
238/**
239 * @brief Enable the PVD Extended Interrupt Falling Trigger.
240 * @retval None.
241 */
242#define __HAL_PWR_PVD_EXTI_ENABLE_FALLING_EDGE() SET_BIT(EXTI->FTSR, PWR_EXTI_LINE_PVD)
243
244
245/**
246 * @brief Disable the PVD Extended Interrupt Falling Trigger.
247 * @retval None.
248 */
249#define __HAL_PWR_PVD_EXTI_DISABLE_FALLING_EDGE() CLEAR_BIT(EXTI->FTSR, PWR_EXTI_LINE_PVD)
250
251
252/**
253 * @brief PVD EXTI line configuration: set rising & falling edge trigger.
254 * @retval None.
255 */
256#define __HAL_PWR_PVD_EXTI_ENABLE_RISING_FALLING_EDGE() __HAL_PWR_PVD_EXTI_ENABLE_RISING_EDGE();__HAL_PWR_PVD_EXTI_ENABLE_FALLING_EDGE();
257
258/**
259 * @brief Disable the PVD Extended Interrupt Rising & Falling Trigger.
260 * This parameter can be:
261 * @retval None.
262 */
263#define __HAL_PWR_PVD_EXTI_DISABLE_RISING_FALLING_EDGE() __HAL_PWR_PVD_EXTI_DISABLE_RISING_EDGE();__HAL_PWR_PVD_EXTI_DISABLE_FALLING_EDGE();
264
265/**
266 * @brief checks whether the specified PVD Exti interrupt flag is set or not.
267 * @retval EXTI PVD Line Status.
268 */
269#define __HAL_PWR_PVD_EXTI_GET_FLAG() (EXTI->PR & (PWR_EXTI_LINE_PVD))
270
271/**
272 * @brief Clear the PVD Exti flag.
273 * @retval None.
274 */
275#define __HAL_PWR_PVD_EXTI_CLEAR_FLAG() (EXTI->PR = (PWR_EXTI_LINE_PVD))
276
277/**
278 * @brief Generates a Software interrupt on PVD EXTI line.
279 * @retval None
280 */
281#define __HAL_PWR_PVD_EXTI_GENERATE_SWIT() (EXTI->SWIER |= (PWR_EXTI_LINE_PVD))
282
283/**
284 * @}
285 */
286
287/* Include PWR HAL Extension module */
288#include "stm32f4xx_hal_pwr_ex.h"
289
290/* Exported functions --------------------------------------------------------*/
291/** @addtogroup PWR_Exported_Functions PWR Exported Functions
292 * @{
293 */
294
295/** @addtogroup PWR_Exported_Functions_Group1 Initialization and de-initialization functions
296 * @{
297 */
298/* Initialization and de-initialization functions *****************************/
299void HAL_PWR_DeInit(void);
300void HAL_PWR_EnableBkUpAccess(void);
301void HAL_PWR_DisableBkUpAccess(void);
302/**
303 * @}
304 */
305
306/** @addtogroup PWR_Exported_Functions_Group2 Peripheral Control functions
307 * @{
308 */
309/* Peripheral Control functions **********************************************/
310/* PVD configuration */
311void HAL_PWR_ConfigPVD(PWR_PVDTypeDef *sConfigPVD);
312void HAL_PWR_EnablePVD(void);
313void HAL_PWR_DisablePVD(void);
314
315/* WakeUp pins configuration */
316void HAL_PWR_EnableWakeUpPin(uint32_t WakeUpPinx);
317void HAL_PWR_DisableWakeUpPin(uint32_t WakeUpPinx);
318
319/* Low Power modes entry */
320void HAL_PWR_EnterSTOPMode(uint32_t Regulator, uint8_t STOPEntry);
321void HAL_PWR_EnterSLEEPMode(uint32_t Regulator, uint8_t SLEEPEntry);
322void HAL_PWR_EnterSTANDBYMode(void);
323
324/* Power PVD IRQ Handler */
325void HAL_PWR_PVD_IRQHandler(void);
326void HAL_PWR_PVDCallback(void);
327
328/* Cortex System Control functions *******************************************/
329void HAL_PWR_EnableSleepOnExit(void);
330void HAL_PWR_DisableSleepOnExit(void);
331void HAL_PWR_EnableSEVOnPend(void);
332void HAL_PWR_DisableSEVOnPend(void);
333/**
334 * @}
335 */
336
337/**
338 * @}
339 */
340
341/* Private types -------------------------------------------------------------*/
342/* Private variables ---------------------------------------------------------*/
343/* Private constants ---------------------------------------------------------*/
344/** @defgroup PWR_Private_Constants PWR Private Constants
345 * @{
346 */
347
348/** @defgroup PWR_PVD_EXTI_Line PWR PVD EXTI Line
349 * @{
350 */
351#define PWR_EXTI_LINE_PVD ((uint32_t)EXTI_IMR_MR16) /*!< External interrupt line 16 Connected to the PVD EXTI Line */
352/**
353 * @}
354 */
355
356/** @defgroup PWR_register_alias_address PWR Register alias address
357 * @{
358 */
359/* ------------- PWR registers bit address in the alias region ---------------*/
360#define PWR_OFFSET (PWR_BASE - PERIPH_BASE)
361#define PWR_CR_OFFSET 0x00
362#define PWR_CSR_OFFSET 0x04
363#define PWR_CR_OFFSET_BB (PWR_OFFSET + PWR_CR_OFFSET)
364#define PWR_CSR_OFFSET_BB (PWR_OFFSET + PWR_CSR_OFFSET)
365/**
366 * @}
367 */
368
369/** @defgroup PWR_CR_register_alias PWR CR Register alias address
370 * @{
371 */
372/* --- CR Register ---*/
373/* Alias word address of DBP bit */
374#define DBP_BIT_NUMBER POSITION_VAL(PWR_CR_DBP)
375#define CR_DBP_BB (uint32_t)(PERIPH_BB_BASE + (PWR_CR_OFFSET_BB * 32) + (DBP_BIT_NUMBER * 4))
376
377/* Alias word address of PVDE bit */
378#define PVDE_BIT_NUMBER POSITION_VAL(PWR_CR_PVDE)
379#define CR_PVDE_BB (uint32_t)(PERIPH_BB_BASE + (PWR_CR_OFFSET_BB * 32) + (PVDE_BIT_NUMBER * 4))
380
381/* Alias word address of PMODE bit */
382#define PMODE_BIT_NUMBER POSITION_VAL(PWR_CR_PMODE)
383#define CR_PMODE_BB (uint32_t)(PERIPH_BB_BASE + (PWR_CR_OFFSET_BB * 32) + (PMODE_BIT_NUMBER * 4))
384/**
385 * @}
386 */
387
388/** @defgroup PWR_CSR_register_alias PWR CSR Register alias address
389 * @{
390 */
391/* --- CSR Register ---*/
392/* Alias word address of EWUP bit */
393#define EWUP_BIT_NUMBER POSITION_VAL(PWR_CSR_EWUP)
394#define CSR_EWUP_BB (PERIPH_BB_BASE + (PWR_CSR_OFFSET_BB * 32) + (EWUP_BIT_NUMBER * 4))
395/**
396 * @}
397 */
398
399/**
400 * @}
401 */
402/* Private macros ------------------------------------------------------------*/
403/** @defgroup PWR_Private_Macros PWR Private Macros
404 * @{
405 */
406
407/** @defgroup PWR_IS_PWR_Definitions PWR Private macros to check input parameters
408 * @{
409 */
410#define IS_PWR_PVD_LEVEL(LEVEL) (((LEVEL) == PWR_PVDLEVEL_0) || ((LEVEL) == PWR_PVDLEVEL_1)|| \
411 ((LEVEL) == PWR_PVDLEVEL_2) || ((LEVEL) == PWR_PVDLEVEL_3)|| \
412 ((LEVEL) == PWR_PVDLEVEL_4) || ((LEVEL) == PWR_PVDLEVEL_5)|| \
413 ((LEVEL) == PWR_PVDLEVEL_6) || ((LEVEL) == PWR_PVDLEVEL_7))
414#define IS_PWR_PVD_MODE(MODE) (((MODE) == PWR_PVD_MODE_IT_RISING)|| ((MODE) == PWR_PVD_MODE_IT_FALLING) || \
415 ((MODE) == PWR_PVD_MODE_IT_RISING_FALLING) || ((MODE) == PWR_PVD_MODE_EVENT_RISING) || \
416 ((MODE) == PWR_PVD_MODE_EVENT_FALLING) || ((MODE) == PWR_PVD_MODE_EVENT_RISING_FALLING) || \
417 ((MODE) == PWR_PVD_MODE_NORMAL))
418#define IS_PWR_REGULATOR(REGULATOR) (((REGULATOR) == PWR_MAINREGULATOR_ON) || \
419 ((REGULATOR) == PWR_LOWPOWERREGULATOR_ON))
420#define IS_PWR_SLEEP_ENTRY(ENTRY) (((ENTRY) == PWR_SLEEPENTRY_WFI) || ((ENTRY) == PWR_SLEEPENTRY_WFE))
421#define IS_PWR_STOP_ENTRY(ENTRY) (((ENTRY) == PWR_STOPENTRY_WFI) || ((ENTRY) == PWR_STOPENTRY_WFE))
422/**
423 * @}
424 */
425
426/**
427 * @}
428 */
429
430/**
431 * @}
432 */
433
434/**
435 * @}
436 */
437
438#ifdef __cplusplus
439}
440#endif
441
442
443#endif /* __STM32F4xx_HAL_PWR_H */
444
445/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
Note: See TracBrowser for help on using the repository browser.