STM32F4xx HAL Documentation
Hardware Abstraction Layer for STM32F4 familiy
Loading...
Searching...
No Matches
stm32f4xx_hal.h
Go to the documentation of this file.
1
20/* Define to prevent recursive inclusion -------------------------------------*/
21#ifndef __STM32F4xx_HAL_H
22#define __STM32F4xx_HAL_H
23
24#ifdef __cplusplus
25 extern "C" {
26#endif
27
28/* Includes ------------------------------------------------------------------*/
29#include "stm32f4xx_hal_conf.h"
30
39/* Exported types ------------------------------------------------------------*/
40/* Exported constants --------------------------------------------------------*/
41
64/* Exported macro ------------------------------------------------------------*/
71#define __HAL_DBGMCU_FREEZE_TIM2() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM2_STOP))
72#define __HAL_DBGMCU_FREEZE_TIM3() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM3_STOP))
73#define __HAL_DBGMCU_FREEZE_TIM4() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM4_STOP))
74#define __HAL_DBGMCU_FREEZE_TIM5() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM5_STOP))
75#define __HAL_DBGMCU_FREEZE_TIM6() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM6_STOP))
76#define __HAL_DBGMCU_FREEZE_TIM7() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM7_STOP))
77#define __HAL_DBGMCU_FREEZE_TIM12() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM12_STOP))
78#define __HAL_DBGMCU_FREEZE_TIM13() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM13_STOP))
79#define __HAL_DBGMCU_FREEZE_TIM14() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM14_STOP))
80#define __HAL_DBGMCU_FREEZE_RTC() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_RTC_STOP))
81#define __HAL_DBGMCU_FREEZE_WWDG() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_WWDG_STOP))
82#define __HAL_DBGMCU_FREEZE_IWDG() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_IWDG_STOP))
83#define __HAL_DBGMCU_FREEZE_I2C1_TIMEOUT() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_I2C1_SMBUS_TIMEOUT))
84#define __HAL_DBGMCU_FREEZE_I2C2_TIMEOUT() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_I2C2_SMBUS_TIMEOUT))
85#define __HAL_DBGMCU_FREEZE_I2C3_TIMEOUT() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_I2C3_SMBUS_TIMEOUT))
86#define __HAL_DBGMCU_FREEZE_CAN1() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_CAN1_STOP))
87#define __HAL_DBGMCU_FREEZE_CAN2() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_CAN2_STOP))
88#define __HAL_DBGMCU_FREEZE_TIM1() (DBGMCU->APB2FZ |= (DBGMCU_APB2_FZ_DBG_TIM1_STOP))
89#define __HAL_DBGMCU_FREEZE_TIM8() (DBGMCU->APB2FZ |= (DBGMCU_APB2_FZ_DBG_TIM8_STOP))
90#define __HAL_DBGMCU_FREEZE_TIM9() (DBGMCU->APB2FZ |= (DBGMCU_APB2_FZ_DBG_TIM9_STOP))
91#define __HAL_DBGMCU_FREEZE_TIM10() (DBGMCU->APB2FZ |= (DBGMCU_APB2_FZ_DBG_TIM10_STOP))
92#define __HAL_DBGMCU_FREEZE_TIM11() (DBGMCU->APB2FZ |= (DBGMCU_APB2_FZ_DBG_TIM11_STOP))
93
94#define __HAL_DBGMCU_UNFREEZE_TIM2() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM2_STOP))
95#define __HAL_DBGMCU_UNFREEZE_TIM3() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM3_STOP))
96#define __HAL_DBGMCU_UNFREEZE_TIM4() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM4_STOP))
97#define __HAL_DBGMCU_UNFREEZE_TIM5() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM5_STOP))
98#define __HAL_DBGMCU_UNFREEZE_TIM6() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM6_STOP))
99#define __HAL_DBGMCU_UNFREEZE_TIM7() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM7_STOP))
100#define __HAL_DBGMCU_UNFREEZE_TIM12() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM12_STOP))
101#define __HAL_DBGMCU_UNFREEZE_TIM13() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM13_STOP))
102#define __HAL_DBGMCU_UNFREEZE_TIM14() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM14_STOP))
103#define __HAL_DBGMCU_UNFREEZE_RTC() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_RTC_STOP))
104#define __HAL_DBGMCU_UNFREEZE_WWDG() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_WWDG_STOP))
105#define __HAL_DBGMCU_UNFREEZE_IWDG() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_IWDG_STOP))
106#define __HAL_DBGMCU_UNFREEZE_I2C1_TIMEOUT() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_I2C1_SMBUS_TIMEOUT))
107#define __HAL_DBGMCU_UNFREEZE_I2C2_TIMEOUT() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_I2C2_SMBUS_TIMEOUT))
108#define __HAL_DBGMCU_UNFREEZE_I2C3_TIMEOUT() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_I2C3_SMBUS_TIMEOUT))
109#define __HAL_DBGMCU_UNFREEZE_CAN1() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_CAN1_STOP))
110#define __HAL_DBGMCU_UNFREEZE_CAN2() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_CAN2_STOP))
111#define __HAL_DBGMCU_UNFREEZE_TIM1() (DBGMCU->APB2FZ &= ~(DBGMCU_APB2_FZ_DBG_TIM1_STOP))
112#define __HAL_DBGMCU_UNFREEZE_TIM8() (DBGMCU->APB2FZ &= ~(DBGMCU_APB2_FZ_DBG_TIM8_STOP))
113#define __HAL_DBGMCU_UNFREEZE_TIM9() (DBGMCU->APB2FZ &= ~(DBGMCU_APB2_FZ_DBG_TIM9_STOP))
114#define __HAL_DBGMCU_UNFREEZE_TIM10() (DBGMCU->APB2FZ &= ~(DBGMCU_APB2_FZ_DBG_TIM10_STOP))
115#define __HAL_DBGMCU_UNFREEZE_TIM11() (DBGMCU->APB2FZ &= ~(DBGMCU_APB2_FZ_DBG_TIM11_STOP))
116
119#define __HAL_SYSCFG_REMAPMEMORY_FLASH() (SYSCFG->MEMRMP &= ~(SYSCFG_MEMRMP_MEM_MODE))
120
123#define __HAL_SYSCFG_REMAPMEMORY_SYSTEMFLASH() do {SYSCFG->MEMRMP &= ~(SYSCFG_MEMRMP_MEM_MODE);\
124 SYSCFG->MEMRMP |= SYSCFG_MEMRMP_MEM_MODE_0;\
125 }while(0);
126
129#define __HAL_SYSCFG_REMAPMEMORY_SRAM() do {SYSCFG->MEMRMP &= ~(SYSCFG_MEMRMP_MEM_MODE);\
130 SYSCFG->MEMRMP |= (SYSCFG_MEMRMP_MEM_MODE_0 | SYSCFG_MEMRMP_MEM_MODE_1);\
131 }while(0);
132
133#if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx)|| defined(STM32F417xx)
136#define __HAL_SYSCFG_REMAPMEMORY_FSMC() do {SYSCFG->MEMRMP &= ~(SYSCFG_MEMRMP_MEM_MODE);\
137 SYSCFG->MEMRMP |= (SYSCFG_MEMRMP_MEM_MODE_1);\
138 }while(0);
139#endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx */
140
141#if defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx)|| defined(STM32F439xx) ||\
142 defined(STM32F469xx) || defined(STM32F479xx)
145#define __HAL_SYSCFG_REMAPMEMORY_FMC() do {SYSCFG->MEMRMP &= ~(SYSCFG_MEMRMP_MEM_MODE);\
146 SYSCFG->MEMRMP |= (SYSCFG_MEMRMP_MEM_MODE_1);\
147 }while(0);
148
151#define __HAL_SYSCFG_REMAPMEMORY_FMC_SDRAM() do {SYSCFG->MEMRMP &= ~(SYSCFG_MEMRMP_MEM_MODE);\
152 SYSCFG->MEMRMP |= (SYSCFG_MEMRMP_MEM_MODE_2);\
153 }while(0);
154#endif /* STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx || STM32F469xx || STM32F479xx */
155
156#if defined(STM32F410Tx) || defined(STM32F410Cx) || defined(STM32F410Rx) || defined(STM32F413xx) || defined(STM32F423xx)
164#define __HAL_SYSCFG_BREAK_PVD_LOCK() do {SYSCFG->CFGR2 &= ~(SYSCFG_CFGR2_PVD_LOCK); \
165 SYSCFG->CFGR2 |= SYSCFG_CFGR2_PVD_LOCK; \
166 }while(0)
178#define __HAL_SYSCFG_BREAK_LOCKUP_LOCK() do {SYSCFG->CFGR2 &= ~(SYSCFG_CFGR2_LOCKUP_LOCK); \
179 SYSCFG->CFGR2 |= SYSCFG_CFGR2_LOCKUP_LOCK; \
180 }while(0)
184#endif /* STM32F410Tx || STM32F410Cx || STM32F410Rx || STM32F413xx || STM32F423xx */
192#define IS_TICKFREQ(FREQ) (((FREQ) == HAL_TICK_FREQ_10HZ) || \
193 ((FREQ) == HAL_TICK_FREQ_100HZ) || \
194 ((FREQ) == HAL_TICK_FREQ_1KHZ))
199/* Exported variables --------------------------------------------------------*/
200
204extern __IO uint32_t uwTick;
205extern uint32_t uwTickPrio;
206extern HAL_TickFreqTypeDef uwTickFreq;
211/* Exported functions --------------------------------------------------------*/
218/* Initialization and Configuration functions ******************************/
219HAL_StatusTypeDef HAL_Init(void);
220HAL_StatusTypeDef HAL_DeInit(void);
221void HAL_MspInit(void);
222void HAL_MspDeInit(void);
223HAL_StatusTypeDef HAL_InitTick (uint32_t TickPriority);
231/* Peripheral Control functions ************************************************/
232void HAL_IncTick(void);
233void HAL_Delay(uint32_t Delay);
234uint32_t HAL_GetTick(void);
235uint32_t HAL_GetTickPrio(void);
236HAL_StatusTypeDef HAL_SetTickFreq(HAL_TickFreqTypeDef Freq);
237HAL_TickFreqTypeDef HAL_GetTickFreq(void);
238void HAL_SuspendTick(void);
239void HAL_ResumeTick(void);
240uint32_t HAL_GetHalVersion(void);
241uint32_t HAL_GetREVID(void);
242uint32_t HAL_GetDEVID(void);
243void HAL_DBGMCU_EnableDBGSleepMode(void);
244void HAL_DBGMCU_DisableDBGSleepMode(void);
245void HAL_DBGMCU_EnableDBGStopMode(void);
246void HAL_DBGMCU_DisableDBGStopMode(void);
247void HAL_DBGMCU_EnableDBGStandbyMode(void);
248void HAL_DBGMCU_DisableDBGStandbyMode(void);
249void HAL_EnableCompensationCell(void);
250void HAL_DisableCompensationCell(void);
251uint32_t HAL_GetUIDw0(void);
252uint32_t HAL_GetUIDw1(void);
253uint32_t HAL_GetUIDw2(void);
254#if defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx)|| defined(STM32F439xx) ||\
255 defined(STM32F469xx) || defined(STM32F479xx)
256void HAL_EnableMemorySwappingBank(void);
257void HAL_DisableMemorySwappingBank(void);
258#endif /* STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx || STM32F469xx || STM32F479xx */
266/* Private types -------------------------------------------------------------*/
267/* Private variables ---------------------------------------------------------*/
274/* Private constants ---------------------------------------------------------*/
281/* Private macros ------------------------------------------------------------*/
282/* Private functions ---------------------------------------------------------*/
291#ifdef __cplusplus
292}
293#endif
294
295#endif /* __STM32F4xx_HAL_H */
296
297
HAL_MspInit
void HAL_MspInit(void)
Initialize the MSP.
Definition stm32f4xx_hal.c:219
HAL_InitTick
HAL_StatusTypeDef HAL_InitTick(uint32_t TickPriority)
This function configures the source of the time base. The time source is configured to have 1ms time ...
Definition stm32f4xx_hal.c:253
HAL_DeInit
HAL_StatusTypeDef HAL_DeInit(void)
This function de-Initializes common part of the HAL and stops the systick. This function is optional.
Definition stm32f4xx_hal.c:190
HAL_MspDeInit
void HAL_MspDeInit(void)
DeInitializes the MSP.
Definition stm32f4xx_hal.c:230
HAL_Init
HAL_StatusTypeDef HAL_Init(void)
This function is used to initialize the HAL Library; it must be the first instruction to be executed ...
Definition stm32f4xx_hal.c:157
HAL_EnableCompensationCell
void HAL_EnableCompensationCell(void)
Enables the I/O Compensation Cell.
Definition stm32f4xx_hal.c:525
HAL_DBGMCU_EnableDBGStandbyMode
void HAL_DBGMCU_EnableDBGStandbyMode(void)
Enable the Debug Module during STANDBY mode.
Definition stm32f4xx_hal.c:505
HAL_DBGMCU_DisableDBGStopMode
void HAL_DBGMCU_DisableDBGStopMode(void)
Disable the Debug Module during STOP mode.
Definition stm32f4xx_hal.c:496
HAL_SetTickFreq
HAL_StatusTypeDef HAL_SetTickFreq(HAL_TickFreqTypeDef Freq)
Set new tick Freq.
Definition stm32f4xx_hal.c:341
HAL_GetUIDw1
uint32_t HAL_GetUIDw1(void)
Returns second word of the unique device identifier (UID based on 96 bits)
Definition stm32f4xx_hal.c:554
HAL_GetUIDw2
uint32_t HAL_GetUIDw2(void)
Returns third word of the unique device identifier (UID based on 96 bits)
Definition stm32f4xx_hal.c:563
HAL_DisableCompensationCell
void HAL_DisableCompensationCell(void)
Power-down the I/O Compensation Cell.
Definition stm32f4xx_hal.c:536
HAL_DBGMCU_DisableDBGStandbyMode
void HAL_DBGMCU_DisableDBGStandbyMode(void)
Disable the Debug Module during STANDBY mode.
Definition stm32f4xx_hal.c:514
HAL_GetTickFreq
HAL_TickFreqTypeDef HAL_GetTickFreq(void)
Return tick frequency.
Definition stm32f4xx_hal.c:374
HAL_SuspendTick
void HAL_SuspendTick(void)
Suspend Tick increment.
Definition stm32f4xx_hal.c:416
HAL_Delay
void HAL_Delay(uint32_t Delay)
This function provides minimum delay (in milliseconds) based on variable incremented.
Definition stm32f4xx_hal.c:390
HAL_IncTick
void HAL_IncTick(void)
This function is called to increment a global variable "uwTick" used as application time base.
Definition stm32f4xx_hal.c:312
HAL_ResumeTick
void HAL_ResumeTick(void)
Resume Tick increment.
Definition stm32f4xx_hal.c:432
HAL_DBGMCU_DisableDBGSleepMode
void HAL_DBGMCU_DisableDBGSleepMode(void)
Disable the Debug Module during SLEEP mode.
Definition stm32f4xx_hal.c:478
HAL_GetTick
uint32_t HAL_GetTick(void)
Provides a tick value in millisecond.
Definition stm32f4xx_hal.c:323
HAL_GetTickPrio
uint32_t HAL_GetTickPrio(void)
This function returns a tick priority.
Definition stm32f4xx_hal.c:332
HAL_DBGMCU_EnableDBGStopMode
void HAL_DBGMCU_EnableDBGStopMode(void)
Enable the Debug Module during STOP mode.
Definition stm32f4xx_hal.c:487
HAL_GetREVID
uint32_t HAL_GetREVID(void)
Returns the device revision identifier.
Definition stm32f4xx_hal.c:451
HAL_DBGMCU_EnableDBGSleepMode
void HAL_DBGMCU_EnableDBGSleepMode(void)
Enable the Debug Module during SLEEP mode.
Definition stm32f4xx_hal.c:469
HAL_GetUIDw0
uint32_t HAL_GetUIDw0(void)
Returns first word of the unique device identifier (UID based on 96 bits)
Definition stm32f4xx_hal.c:545
HAL_GetHalVersion
uint32_t HAL_GetHalVersion(void)
Returns the HAL revision.
Definition stm32f4xx_hal.c:442
HAL_GetDEVID
uint32_t HAL_GetDEVID(void)
Returns the device identifier.
Definition stm32f4xx_hal.c:460
uwTickPrio
uint32_t uwTickPrio
Definition stm32f4xx_hal.c:95
uwTickFreq
HAL_TickFreqTypeDef uwTickFreq
Definition stm32f4xx_hal.c:96
uwTick
__IO uint32_t uwTick
Definition stm32f4xx_hal.c:94
HAL_TickFreqTypeDef
HAL_TickFreqTypeDef
Definition stm32f4xx_hal.h:50
HAL_TICK_FREQ_DEFAULT
@ HAL_TICK_FREQ_DEFAULT
Definition stm32f4xx_hal.h:54
HAL_TICK_FREQ_1KHZ
@ HAL_TICK_FREQ_1KHZ
Definition stm32f4xx_hal.h:53
HAL_TICK_FREQ_10HZ
@ HAL_TICK_FREQ_10HZ
Definition stm32f4xx_hal.h:51
HAL_TICK_FREQ_100HZ
@ HAL_TICK_FREQ_100HZ
Definition stm32f4xx_hal.h:52
stm32f4xx_hal_conf.h
HAL_StatusTypeDef
HAL_StatusTypeDef
HAL Status structures definition
Definition stm32f4xx_hal_def.h:39