stm32f4xx.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307
  1. /**
  2. ******************************************************************************
  3. * @file stm32f4xx.h
  4. * @author MCD Application Team
  5. * @brief CMSIS STM32F4xx Device Peripheral Access Layer Header File.
  6. *
  7. * The file is the unique include file that the application programmer
  8. * is using in the C source code, usually in main.c. This file contains:
  9. * - Configuration section that allows to select:
  10. * - The STM32F4xx device used in the target application
  11. * - To use or not the peripheral’s drivers in application code(i.e.
  12. * code will be based on direct access to peripheral’s registers
  13. * rather than drivers API), this option is controlled by
  14. * "#define USE_HAL_DRIVER"
  15. *
  16. ******************************************************************************
  17. * @attention
  18. *
  19. * <h2><center>&copy; Copyright (c) 2017 STMicroelectronics.
  20. * All rights reserved.</center></h2>
  21. *
  22. * This software component is licensed by ST under BSD 3-Clause license,
  23. * the "License"; You may not use this file except in compliance with the
  24. * License. You may obtain a copy of the License at:
  25. * opensource.org/licenses/BSD-3-Clause
  26. *
  27. ******************************************************************************
  28. */
  29. /** @addtogroup CMSIS
  30. * @{
  31. */
  32. /** @addtogroup stm32f4xx
  33. * @{
  34. */
  35. #ifndef __STM32F4xx_H
  36. #define __STM32F4xx_H
  37. #ifdef __cplusplus
  38. extern "C" {
  39. #endif /* __cplusplus */
  40. /** @addtogroup Library_configuration_section
  41. * @{
  42. */
  43. /**
  44. * @brief STM32 Family
  45. */
  46. #if !defined (STM32F4)
  47. #define STM32F4
  48. #endif /* STM32F4 */
  49. /* Uncomment the line below according to the target STM32 device used in your
  50. application
  51. */
  52. #if !defined (STM32F405xx) && !defined (STM32F415xx) && !defined (STM32F407xx) && !defined (STM32F417xx) && \
  53. !defined (STM32F427xx) && !defined (STM32F437xx) && !defined (STM32F429xx) && !defined (STM32F439xx) && \
  54. !defined (STM32F401xC) && !defined (STM32F401xE) && !defined (STM32F410Tx) && !defined (STM32F410Cx) && \
  55. !defined (STM32F410Rx) && !defined (STM32F411xE) && !defined (STM32F446xx) && !defined (STM32F469xx) && \
  56. !defined (STM32F479xx) && !defined (STM32F412Cx) && !defined (STM32F412Rx) && !defined (STM32F412Vx) && \
  57. !defined (STM32F412Zx) && !defined (STM32F413xx) && !defined (STM32F423xx)
  58. /* #define STM32F405xx */ /*!< STM32F405RG, STM32F405VG and STM32F405ZG Devices */
  59. /* #define STM32F415xx */ /*!< STM32F415RG, STM32F415VG and STM32F415ZG Devices */
  60. /* #define STM32F407xx */ /*!< STM32F407VG, STM32F407VE, STM32F407ZG, STM32F407ZE, STM32F407IG and STM32F407IE Devices */
  61. /* #define STM32F417xx */ /*!< STM32F417VG, STM32F417VE, STM32F417ZG, STM32F417ZE, STM32F417IG and STM32F417IE Devices */
  62. /* #define STM32F427xx */ /*!< STM32F427VG, STM32F427VI, STM32F427ZG, STM32F427ZI, STM32F427IG and STM32F427II Devices */
  63. /* #define STM32F437xx */ /*!< STM32F437VG, STM32F437VI, STM32F437ZG, STM32F437ZI, STM32F437IG and STM32F437II Devices */
  64. /* #define STM32F429xx */ /*!< STM32F429VG, STM32F429VI, STM32F429ZG, STM32F429ZI, STM32F429BG, STM32F429BI, STM32F429NG,
  65. STM32F439NI, STM32F429IG and STM32F429II Devices */
  66. /* #define STM32F439xx */ /*!< STM32F439VG, STM32F439VI, STM32F439ZG, STM32F439ZI, STM32F439BG, STM32F439BI, STM32F439NG,
  67. STM32F439NI, STM32F439IG and STM32F439II Devices */
  68. /* #define STM32F401xC */ /*!< STM32F401CB, STM32F401CC, STM32F401RB, STM32F401RC, STM32F401VB and STM32F401VC Devices */
  69. /* #define STM32F401xE */ /*!< STM32F401CD, STM32F401RD, STM32F401VD, STM32F401CE, STM32F401RE and STM32F401VE Devices */
  70. /* #define STM32F410Tx */ /*!< STM32F410T8 and STM32F410TB Devices */
  71. /* #define STM32F410Cx */ /*!< STM32F410C8 and STM32F410CB Devices */
  72. /* #define STM32F410Rx */ /*!< STM32F410R8 and STM32F410RB Devices */
  73. /* #define STM32F411xE */ /*!< STM32F411CC, STM32F411RC, STM32F411VC, STM32F411CE, STM32F411RE and STM32F411VE Devices */
  74. /* #define STM32F446xx */ /*!< STM32F446MC, STM32F446ME, STM32F446RC, STM32F446RE, STM32F446VC, STM32F446VE, STM32F446ZC,
  75. and STM32F446ZE Devices */
  76. /* #define STM32F469xx */ /*!< STM32F469AI, STM32F469II, STM32F469BI, STM32F469NI, STM32F469AG, STM32F469IG, STM32F469BG,
  77. STM32F469NG, STM32F469AE, STM32F469IE, STM32F469BE and STM32F469NE Devices */
  78. /* #define STM32F479xx */ /*!< STM32F479AI, STM32F479II, STM32F479BI, STM32F479NI, STM32F479AG, STM32F479IG, STM32F479BG
  79. and STM32F479NG Devices */
  80. /* #define STM32F412Cx */ /*!< STM32F412CEU and STM32F412CGU Devices */
  81. /* #define STM32F412Zx */ /*!< STM32F412ZET, STM32F412ZGT, STM32F412ZEJ and STM32F412ZGJ Devices */
  82. /* #define STM32F412Vx */ /*!< STM32F412VET, STM32F412VGT, STM32F412VEH and STM32F412VGH Devices */
  83. /* #define STM32F412Rx */ /*!< STM32F412RET, STM32F412RGT, STM32F412REY and STM32F412RGY Devices */
  84. /* #define STM32F413xx */ /*!< STM32F413CH, STM32F413MH, STM32F413RH, STM32F413VH, STM32F413ZH, STM32F413CG, STM32F413MG,
  85. STM32F413RG, STM32F413VG and STM32F413ZG Devices */
  86. /* #define STM32F423xx */ /*!< STM32F423CH, STM32F423RH, STM32F423VH and STM32F423ZH Devices */
  87. #endif
  88. /* Tip: To avoid modifying this file each time you need to switch between these
  89. devices, you can define the device in your toolchain compiler preprocessor.
  90. */
  91. #if !defined (USE_HAL_DRIVER)
  92. /**
  93. * @brief Comment the line below if you will not use the peripherals drivers.
  94. In this case, these drivers will not be included and the application code will
  95. be based on direct access to peripherals registers
  96. */
  97. /*#define USE_HAL_DRIVER */
  98. #endif /* USE_HAL_DRIVER */
  99. /**
  100. * @brief CMSIS version number V2.6.7
  101. */
  102. #define __STM32F4xx_CMSIS_VERSION_MAIN (0x02U) /*!< [31:24] main version */
  103. #define __STM32F4xx_CMSIS_VERSION_SUB1 (0x06U) /*!< [23:16] sub1 version */
  104. #define __STM32F4xx_CMSIS_VERSION_SUB2 (0x07U) /*!< [15:8] sub2 version */
  105. #define __STM32F4xx_CMSIS_VERSION_RC (0x00U) /*!< [7:0] release candidate */
  106. #define __STM32F4xx_CMSIS_VERSION ((__STM32F4xx_CMSIS_VERSION_MAIN << 24)\
  107. |(__STM32F4xx_CMSIS_VERSION_SUB1 << 16)\
  108. |(__STM32F4xx_CMSIS_VERSION_SUB2 << 8 )\
  109. |(__STM32F4xx_CMSIS_VERSION_RC))
  110. /**
  111. * @}
  112. */
  113. /** @addtogroup Device_Included
  114. * @{
  115. */
  116. #if defined(STM32F405xx)
  117. #include "stm32f405xx.h"
  118. #elif defined(STM32F415xx)
  119. #include "stm32f415xx.h"
  120. #elif defined(STM32F407xx)
  121. #include "stm32f407xx.h"
  122. #elif defined(STM32F417xx)
  123. #include "stm32f417xx.h"
  124. #elif defined(STM32F427xx)
  125. #include "stm32f427xx.h"
  126. #elif defined(STM32F437xx)
  127. #include "stm32f437xx.h"
  128. #elif defined(STM32F429xx)
  129. #include "stm32f429xx.h"
  130. #elif defined(STM32F439xx)
  131. #include "stm32f439xx.h"
  132. #elif defined(STM32F401xC)
  133. #include "stm32f401xc.h"
  134. #elif defined(STM32F401xE)
  135. #include "stm32f401xe.h"
  136. #elif defined(STM32F410Tx)
  137. #include "stm32f410tx.h"
  138. #elif defined(STM32F410Cx)
  139. #include "stm32f410cx.h"
  140. #elif defined(STM32F410Rx)
  141. #include "stm32f410rx.h"
  142. #elif defined(STM32F411xE)
  143. #include "stm32f411xe.h"
  144. #elif defined(STM32F446xx)
  145. #include "stm32f446xx.h"
  146. #elif defined(STM32F469xx)
  147. #include "stm32f469xx.h"
  148. #elif defined(STM32F479xx)
  149. #include "stm32f479xx.h"
  150. #elif defined(STM32F412Cx)
  151. #include "stm32f412cx.h"
  152. #elif defined(STM32F412Zx)
  153. #include "stm32f412zx.h"
  154. #elif defined(STM32F412Rx)
  155. #include "stm32f412rx.h"
  156. #elif defined(STM32F412Vx)
  157. #include "stm32f412vx.h"
  158. #elif defined(STM32F413xx)
  159. #include "stm32f413xx.h"
  160. #elif defined(STM32F423xx)
  161. #include "stm32f423xx.h"
  162. #else
  163. #error "Please select first the target STM32F4xx device used in your application (in stm32f4xx.h file)"
  164. #endif
  165. /**
  166. * @}
  167. */
  168. /** @addtogroup Exported_types
  169. * @{
  170. */
  171. typedef enum
  172. {
  173. RESET = 0U,
  174. SET = !RESET
  175. } FlagStatus, ITStatus;
  176. typedef enum
  177. {
  178. DISABLE = 0U,
  179. ENABLE = !DISABLE
  180. } FunctionalState;
  181. #define IS_FUNCTIONAL_STATE(STATE) (((STATE) == DISABLE) || ((STATE) == ENABLE))
  182. typedef enum
  183. {
  184. SUCCESS = 0U,
  185. ERROR = !SUCCESS
  186. } ErrorStatus;
  187. /**
  188. * @}
  189. */
  190. /** @addtogroup Exported_macro
  191. * @{
  192. */
  193. #define SET_BIT(REG, BIT) ((REG) |= (BIT))
  194. #define CLEAR_BIT(REG, BIT) ((REG) &= ~(BIT))
  195. #define READ_BIT(REG, BIT) ((REG) & (BIT))
  196. #define CLEAR_REG(REG) ((REG) = (0x0))
  197. #define WRITE_REG(REG, VAL) ((REG) = (VAL))
  198. #define READ_REG(REG) ((REG))
  199. #define MODIFY_REG(REG, CLEARMASK, SETMASK) WRITE_REG((REG), (((READ_REG(REG)) & (~(CLEARMASK))) | (SETMASK)))
  200. #define POSITION_VAL(VAL) (__CLZ(__RBIT(VAL)))
  201. /* Use of CMSIS compiler intrinsics for register exclusive access */
  202. /* Atomic 32-bit register access macro to set one or several bits */
  203. #define ATOMIC_SET_BIT(REG, BIT) \
  204. do { \
  205. uint32_t val; \
  206. do { \
  207. val = __LDREXW((__IO uint32_t *)&(REG)) | (BIT); \
  208. } while ((__STREXW(val,(__IO uint32_t *)&(REG))) != 0U); \
  209. } while(0)
  210. /* Atomic 32-bit register access macro to clear one or several bits */
  211. #define ATOMIC_CLEAR_BIT(REG, BIT) \
  212. do { \
  213. uint32_t val; \
  214. do { \
  215. val = __LDREXW((__IO uint32_t *)&(REG)) & ~(BIT); \
  216. } while ((__STREXW(val,(__IO uint32_t *)&(REG))) != 0U); \
  217. } while(0)
  218. /* Atomic 32-bit register access macro to clear and set one or several bits */
  219. #define ATOMIC_MODIFY_REG(REG, CLEARMSK, SETMASK) \
  220. do { \
  221. uint32_t val; \
  222. do { \
  223. val = (__LDREXW((__IO uint32_t *)&(REG)) & ~(CLEARMSK)) | (SETMASK); \
  224. } while ((__STREXW(val,(__IO uint32_t *)&(REG))) != 0U); \
  225. } while(0)
  226. /* Atomic 16-bit register access macro to set one or several bits */
  227. #define ATOMIC_SETH_BIT(REG, BIT) \
  228. do { \
  229. uint16_t val; \
  230. do { \
  231. val = __LDREXH((__IO uint16_t *)&(REG)) | (BIT); \
  232. } while ((__STREXH(val,(__IO uint16_t *)&(REG))) != 0U); \
  233. } while(0)
  234. /* Atomic 16-bit register access macro to clear one or several bits */
  235. #define ATOMIC_CLEARH_BIT(REG, BIT) \
  236. do { \
  237. uint16_t val; \
  238. do { \
  239. val = __LDREXH((__IO uint16_t *)&(REG)) & ~(BIT); \
  240. } while ((__STREXH(val,(__IO uint16_t *)&(REG))) != 0U); \
  241. } while(0)
  242. /* Atomic 16-bit register access macro to clear and set one or several bits */
  243. #define ATOMIC_MODIFYH_REG(REG, CLEARMSK, SETMASK) \
  244. do { \
  245. uint16_t val; \
  246. do { \
  247. val = (__LDREXH((__IO uint16_t *)&(REG)) & ~(CLEARMSK)) | (SETMASK); \
  248. } while ((__STREXH(val,(__IO uint16_t *)&(REG))) != 0U); \
  249. } while(0)
  250. /**
  251. * @}
  252. */
  253. #if defined (USE_HAL_DRIVER)
  254. #include "stm32f4xx_hal.h"
  255. #endif /* USE_HAL_DRIVER */
  256. #ifdef __cplusplus
  257. }
  258. #endif /* __cplusplus */
  259. #endif /* __STM32F4xx_H */
  260. /**
  261. * @}
  262. */
  263. /**
  264. * @}
  265. */
  266. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/