stm32f4xx_hal.h 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293
  1. /**
  2. ******************************************************************************
  3. * @file stm32f4xx_hal.h
  4. * @author MCD Application Team
  5. * @brief This file contains all the functions prototypes for the HAL
  6. * module driver.
  7. ******************************************************************************
  8. * @attention
  9. *
  10. * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
  11. *
  12. * Redistribution and use in source and binary forms, with or without modification,
  13. * are permitted provided that the following conditions are met:
  14. * 1. Redistributions of source code must retain the above copyright notice,
  15. * this list of conditions and the following disclaimer.
  16. * 2. Redistributions in binary form must reproduce the above copyright notice,
  17. * this list of conditions and the following disclaimer in the documentation
  18. * and/or other materials provided with the distribution.
  19. * 3. Neither the name of STMicroelectronics nor the names of its contributors
  20. * may be used to endorse or promote products derived from this software
  21. * without specific prior written permission.
  22. *
  23. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  24. * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  26. * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  27. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  29. * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  30. * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  31. * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  32. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33. *
  34. ******************************************************************************
  35. */
  36. /* Define to prevent recursive inclusion -------------------------------------*/
  37. #ifndef __STM32F4xx_HAL_H
  38. #define __STM32F4xx_HAL_H
  39. #include "linux/types.h"
  40. #include "stm32f4xx.h"
  41. //#include "stm32f4xx_hal_def.h"
  42. #include "stm32f4xx_hal_conf.h"
  43. #ifdef __cplusplus
  44. extern "C" {
  45. #endif
  46. /* Exported types ------------------------------------------------------------*/
  47. /* Exported constants --------------------------------------------------------*/
  48. /** @defgroup HAL_Exported_Constants HAL Exported Constants
  49. * @{
  50. */
  51. /** @defgroup HAL_TICK_FREQ Tick Frequency
  52. * @{
  53. */
  54. typedef enum
  55. {
  56. HAL_TICK_FREQ_10HZ = 100U,
  57. HAL_TICK_FREQ_100HZ = 10U,
  58. HAL_TICK_FREQ_1KHZ = 1U,
  59. HAL_TICK_FREQ_DEFAULT = HAL_TICK_FREQ_1KHZ
  60. } HAL_TickFreqTypeDef;
  61. /**
  62. * @}
  63. */
  64. /**
  65. * @}
  66. */
  67. /* Exported macro ------------------------------------------------------------*/
  68. /** @defgroup HAL_Exported_Macros HAL Exported Macros
  69. * @{
  70. */
  71. /** @brief Freeze/Unfreeze Peripherals in Debug mode
  72. */
  73. #define __HAL_DBGMCU_FREEZE_TIM2() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM2_STOP))
  74. #define __HAL_DBGMCU_FREEZE_TIM3() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM3_STOP))
  75. #define __HAL_DBGMCU_FREEZE_TIM4() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM4_STOP))
  76. #define __HAL_DBGMCU_FREEZE_TIM5() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM5_STOP))
  77. #define __HAL_DBGMCU_FREEZE_TIM6() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM6_STOP))
  78. #define __HAL_DBGMCU_FREEZE_TIM7() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM7_STOP))
  79. #define __HAL_DBGMCU_FREEZE_TIM12() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM12_STOP))
  80. #define __HAL_DBGMCU_FREEZE_TIM13() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM13_STOP))
  81. #define __HAL_DBGMCU_FREEZE_TIM14() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM14_STOP))
  82. #define __HAL_DBGMCU_FREEZE_RTC() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_RTC_STOP))
  83. #define __HAL_DBGMCU_FREEZE_WWDG() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_WWDG_STOP))
  84. #define __HAL_DBGMCU_FREEZE_IWDG() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_IWDG_STOP))
  85. #define __HAL_DBGMCU_FREEZE_I2C1_TIMEOUT() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_I2C1_SMBUS_TIMEOUT))
  86. #define __HAL_DBGMCU_FREEZE_I2C2_TIMEOUT() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_I2C2_SMBUS_TIMEOUT))
  87. #define __HAL_DBGMCU_FREEZE_I2C3_TIMEOUT() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_I2C3_SMBUS_TIMEOUT))
  88. #define __HAL_DBGMCU_FREEZE_CAN1() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_CAN1_STOP))
  89. #define __HAL_DBGMCU_FREEZE_CAN2() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_CAN2_STOP))
  90. #define __HAL_DBGMCU_FREEZE_TIM1() (DBGMCU->APB2FZ |= (DBGMCU_APB2_FZ_DBG_TIM1_STOP))
  91. #define __HAL_DBGMCU_FREEZE_TIM8() (DBGMCU->APB2FZ |= (DBGMCU_APB2_FZ_DBG_TIM8_STOP))
  92. #define __HAL_DBGMCU_FREEZE_TIM9() (DBGMCU->APB2FZ |= (DBGMCU_APB2_FZ_DBG_TIM9_STOP))
  93. #define __HAL_DBGMCU_FREEZE_TIM10() (DBGMCU->APB2FZ |= (DBGMCU_APB2_FZ_DBG_TIM10_STOP))
  94. #define __HAL_DBGMCU_FREEZE_TIM11() (DBGMCU->APB2FZ |= (DBGMCU_APB2_FZ_DBG_TIM11_STOP))
  95. #define __HAL_DBGMCU_UNFREEZE_TIM2() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM2_STOP))
  96. #define __HAL_DBGMCU_UNFREEZE_TIM3() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM3_STOP))
  97. #define __HAL_DBGMCU_UNFREEZE_TIM4() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM4_STOP))
  98. #define __HAL_DBGMCU_UNFREEZE_TIM5() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM5_STOP))
  99. #define __HAL_DBGMCU_UNFREEZE_TIM6() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM6_STOP))
  100. #define __HAL_DBGMCU_UNFREEZE_TIM7() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM7_STOP))
  101. #define __HAL_DBGMCU_UNFREEZE_TIM12() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM12_STOP))
  102. #define __HAL_DBGMCU_UNFREEZE_TIM13() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM13_STOP))
  103. #define __HAL_DBGMCU_UNFREEZE_TIM14() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM14_STOP))
  104. #define __HAL_DBGMCU_UNFREEZE_RTC() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_RTC_STOP))
  105. #define __HAL_DBGMCU_UNFREEZE_WWDG() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_WWDG_STOP))
  106. #define __HAL_DBGMCU_UNFREEZE_IWDG() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_IWDG_STOP))
  107. #define __HAL_DBGMCU_UNFREEZE_I2C1_TIMEOUT() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_I2C1_SMBUS_TIMEOUT))
  108. #define __HAL_DBGMCU_UNFREEZE_I2C2_TIMEOUT() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_I2C2_SMBUS_TIMEOUT))
  109. #define __HAL_DBGMCU_UNFREEZE_I2C3_TIMEOUT() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_I2C3_SMBUS_TIMEOUT))
  110. #define __HAL_DBGMCU_UNFREEZE_CAN1() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_CAN1_STOP))
  111. #define __HAL_DBGMCU_UNFREEZE_CAN2() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_CAN2_STOP))
  112. #define __HAL_DBGMCU_UNFREEZE_TIM1() (DBGMCU->APB2FZ &= ~(DBGMCU_APB2_FZ_DBG_TIM1_STOP))
  113. #define __HAL_DBGMCU_UNFREEZE_TIM8() (DBGMCU->APB2FZ &= ~(DBGMCU_APB2_FZ_DBG_TIM8_STOP))
  114. #define __HAL_DBGMCU_UNFREEZE_TIM9() (DBGMCU->APB2FZ &= ~(DBGMCU_APB2_FZ_DBG_TIM9_STOP))
  115. #define __HAL_DBGMCU_UNFREEZE_TIM10() (DBGMCU->APB2FZ &= ~(DBGMCU_APB2_FZ_DBG_TIM10_STOP))
  116. #define __HAL_DBGMCU_UNFREEZE_TIM11() (DBGMCU->APB2FZ &= ~(DBGMCU_APB2_FZ_DBG_TIM11_STOP))
  117. /** @brief Main Flash memory mapped at 0x00000000
  118. */
  119. #define __HAL_SYSCFG_REMAPMEMORY_FLASH() (SYSCFG->MEMRMP &= ~(SYSCFG_MEMRMP_MEM_MODE))
  120. /** @brief System Flash memory mapped at 0x00000000
  121. */
  122. #define __HAL_SYSCFG_REMAPMEMORY_SYSTEMFLASH() do {SYSCFG->MEMRMP &= ~(SYSCFG_MEMRMP_MEM_MODE);\
  123. SYSCFG->MEMRMP |= SYSCFG_MEMRMP_MEM_MODE_0;\
  124. }while(0);
  125. /** @brief Embedded SRAM mapped at 0x00000000
  126. */
  127. #define __HAL_SYSCFG_REMAPMEMORY_SRAM() do {SYSCFG->MEMRMP &= ~(SYSCFG_MEMRMP_MEM_MODE);\
  128. SYSCFG->MEMRMP |= (SYSCFG_MEMRMP_MEM_MODE_0 | SYSCFG_MEMRMP_MEM_MODE_1);\
  129. }while(0);
  130. #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx)|| defined(STM32F417xx)
  131. /** @brief FSMC Bank1 (NOR/PSRAM 1 and 2) mapped at 0x00000000
  132. */
  133. #define __HAL_SYSCFG_REMAPMEMORY_FSMC() do {SYSCFG->MEMRMP &= ~(SYSCFG_MEMRMP_MEM_MODE);\
  134. SYSCFG->MEMRMP |= (SYSCFG_MEMRMP_MEM_MODE_1);\
  135. }while(0);
  136. #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx */
  137. #if defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx)|| defined(STM32F439xx) ||\
  138. defined(STM32F469xx) || defined(STM32F479xx)
  139. /** @brief FMC Bank1 (NOR/PSRAM 1 and 2) mapped at 0x00000000
  140. */
  141. #define __HAL_SYSCFG_REMAPMEMORY_FMC() do {SYSCFG->MEMRMP &= ~(SYSCFG_MEMRMP_MEM_MODE);\
  142. SYSCFG->MEMRMP |= (SYSCFG_MEMRMP_MEM_MODE_1);\
  143. }while(0);
  144. /** @brief FMC/SDRAM Bank 1 and 2 mapped at 0x00000000
  145. */
  146. #define __HAL_SYSCFG_REMAPMEMORY_FMC_SDRAM() do {SYSCFG->MEMRMP &= ~(SYSCFG_MEMRMP_MEM_MODE);\
  147. SYSCFG->MEMRMP |= (SYSCFG_MEMRMP_MEM_MODE_2);\
  148. }while(0);
  149. #endif /* STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx || STM32F469xx || STM32F479xx */
  150. #if defined(STM32F410Tx) || defined(STM32F410Cx) || defined(STM32F410Rx) || defined(STM32F413xx) || defined(STM32F423xx)
  151. /** @defgroup Cortex_Lockup_Enable Cortex Lockup Enable
  152. * @{
  153. */
  154. /** @brief SYSCFG Break Lockup lock
  155. * Enables and locks the connection of Cortex-M4 LOCKUP (Hardfault) output to TIM1/8 input
  156. * @note The selected configuration is locked and can be unlocked by system reset
  157. */
  158. #define __HAL_SYSCFG_BREAK_PVD_LOCK() do {SYSCFG->CFGR2 &= ~(SYSCFG_CFGR2_PVD_LOCK); \
  159. SYSCFG->CFGR2 |= SYSCFG_CFGR2_PVD_LOCK; \
  160. }while(0)
  161. /**
  162. * @}
  163. */
  164. /** @defgroup PVD_Lock_Enable PVD Lock
  165. * @{
  166. */
  167. /** @brief SYSCFG Break PVD lock
  168. * Enables and locks the PVD connection with Timer1/8 Break Input, , as well as the PVDE and PLS[2:0] in the PWR_CR register
  169. * @note The selected configuration is locked and can be unlocked by system reset
  170. */
  171. #define __HAL_SYSCFG_BREAK_LOCKUP_LOCK() do {SYSCFG->CFGR2 &= ~(SYSCFG_CFGR2_LOCKUP_LOCK); \
  172. SYSCFG->CFGR2 |= SYSCFG_CFGR2_LOCKUP_LOCK; \
  173. }while(0)
  174. /**
  175. * @}
  176. */
  177. #endif /* STM32F410Tx || STM32F410Cx || STM32F410Rx || STM32F413xx || STM32F423xx */
  178. /**
  179. * @}
  180. */
  181. /** @defgroup HAL_Private_Macros HAL Private Macros
  182. * @{
  183. */
  184. #define IS_TICKFREQ(FREQ) (((FREQ) == HAL_TICK_FREQ_10HZ) || \
  185. ((FREQ) == HAL_TICK_FREQ_100HZ) || \
  186. ((FREQ) == HAL_TICK_FREQ_1KHZ))
  187. /**
  188. * @}
  189. */
  190. /* Exported functions --------------------------------------------------------*/
  191. /** @addtogroup HAL_Exported_Functions
  192. * @{
  193. */
  194. /** @addtogroup HAL_Exported_Functions_Group1
  195. * @{
  196. */
  197. /* Initialization and Configuration functions ******************************/
  198. HAL_StatusTypeDef HAL_Init(void);
  199. HAL_StatusTypeDef HAL_DeInit(void);
  200. void HAL_MspInit(void);
  201. void HAL_MspDeInit(void);
  202. HAL_StatusTypeDef HAL_InitTick (uint32_t TickPriority);
  203. /**
  204. * @}
  205. */
  206. /** @addtogroup HAL_Exported_Functions_Group2
  207. * @{
  208. */
  209. /* Peripheral Control functions ************************************************/
  210. void HAL_IncTick(void);
  211. void HAL_Delay(uint32_t Delay);
  212. uint32_t HAL_GetTick(void);
  213. uint32_t HAL_GetTickPrio(void);
  214. HAL_StatusTypeDef HAL_SetTickFreq(HAL_TickFreqTypeDef Freq);
  215. HAL_TickFreqTypeDef HAL_GetTickFreq(void);
  216. void HAL_SuspendTick(void);
  217. void HAL_ResumeTick(void);
  218. uint32_t HAL_GetHalVersion(void);
  219. uint32_t HAL_GetREVID(void);
  220. uint32_t HAL_GetDEVID(void);
  221. void HAL_DBGMCU_EnableDBGSleepMode(void);
  222. void HAL_DBGMCU_DisableDBGSleepMode(void);
  223. void HAL_DBGMCU_EnableDBGStopMode(void);
  224. void HAL_DBGMCU_DisableDBGStopMode(void);
  225. void HAL_DBGMCU_EnableDBGStandbyMode(void);
  226. void HAL_DBGMCU_DisableDBGStandbyMode(void);
  227. void HAL_EnableCompensationCell(void);
  228. void HAL_DisableCompensationCell(void);
  229. void HAL_GetUID(uint32_t *UID);
  230. #if defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx)|| defined(STM32F439xx) ||\
  231. defined(STM32F469xx) || defined(STM32F479xx)
  232. void HAL_EnableMemorySwappingBank(void);
  233. void HAL_DisableMemorySwappingBank(void);
  234. #endif /* STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx || STM32F469xx || STM32F479xx */
  235. /**
  236. * @}
  237. */
  238. /**
  239. * @}
  240. */
  241. /* Private types -------------------------------------------------------------*/
  242. /* Private variables ---------------------------------------------------------*/
  243. /** @defgroup HAL_Private_Variables HAL Private Variables
  244. * @{
  245. */
  246. /**
  247. * @}
  248. */
  249. /* Private constants ---------------------------------------------------------*/
  250. /** @defgroup HAL_Private_Constants HAL Private Constants
  251. * @{
  252. */
  253. /**
  254. * @}
  255. */
  256. /* Private macros ------------------------------------------------------------*/
  257. /* Private functions ---------------------------------------------------------*/
  258. /**
  259. * @}
  260. */
  261. /**
  262. * @}
  263. */
  264. #ifdef __cplusplus
  265. }
  266. #endif
  267. #endif /* __STM32F4xx_HAL_H */
  268. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/