HAL_rcc.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368
  1. /**
  2. ******************************************************************************
  3. * @file HAL_rcc.h
  4. * @author AE Team
  5. * @version V2.0.0
  6. * @date 22/08/2017
  7. * @brief This file contains all the functions prototypes for the RCC firmware
  8. * library.
  9. ******************************************************************************
  10. * @copy
  11. *
  12. * THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS
  13. * WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE
  14. * TIME. AS A RESULT, MindMotion SHALL NOT BE HELD LIABLE FOR ANY
  15. * DIRECT, INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING
  16. * FROM THE CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE
  17. * CODING INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.
  18. *
  19. * <h2><center>&copy; COPYRIGHT 2017 MindMotion</center></h2>
  20. */
  21. //SJH&TM change
  22. /* Define to prevent recursive inclusion -------------------------------------*/
  23. #ifndef __HAL_RCC_H
  24. #define __HAL_RCC_H
  25. /* Includes ------------------------------------------------------------------*/
  26. #include "HAL_device.h"
  27. /** @addtogroup StdPeriph_Driver
  28. * @{
  29. */
  30. /** @addtogroup RCC
  31. * @{
  32. */
  33. /** @defgroup RCC_Exported_Types
  34. * @{
  35. */
  36. typedef struct
  37. {
  38. uint32_t SYSCLK_Frequency;
  39. uint32_t HCLK_Frequency;
  40. uint32_t PCLK1_Frequency;
  41. uint32_t PCLK2_Frequency;
  42. }RCC_ClocksTypeDef;
  43. /**
  44. * @}
  45. */
  46. /** @defgroup RCC_Exported_Constants
  47. * @{
  48. */
  49. /** @defgroup HSE_configuration
  50. * @{
  51. */
  52. #define RCC_HSE_OFF ((uint32_t)0x00000000)
  53. #define RCC_HSE_ON ((uint32_t)0x00010000)
  54. #define RCC_HSE_Bypass ((uint32_t)0x00040000)
  55. #define IS_RCC_HSE(HSE) (((HSE) == RCC_HSE_OFF) || ((HSE) == RCC_HSE_ON) || \
  56. ((HSE) == RCC_HSE_Bypass))
  57. /**
  58. * @}
  59. */
  60. /** @defgroup PLL_entry_clock_source
  61. * @{
  62. */
  63. #define RCC_PLLSource_HSI_Div4 ((uint32_t)0x00000000)
  64. #define RCC_PLLSource_HSE_Div1 ((uint32_t)0x00010000)
  65. #define RCC_PLLSource_HSE_Div2 ((uint32_t)0x00030000)
  66. #define IS_RCC_PLL_SOURCE(SOURCE) (((SOURCE) == RCC_PLLSource_HSI_Div4) || \
  67. ((SOURCE) == RCC_PLLSource_HSE_Div1) || \
  68. ((SOURCE) == RCC_PLLSource_HSE_Div2))
  69. /**
  70. * @}
  71. */
  72. /** @defgroup System_clock_source
  73. * @{
  74. */
  75. #define RCC_SYSCLKSource_HSI ((uint32_t)0x00000000)
  76. #define RCC_SYSCLKSource_HSE ((uint32_t)0x00000001)
  77. #define RCC_SYSCLKSource_PLLCLK ((uint32_t)0x00000002)
  78. #define RCC_SYSCLKSource_LSI ((uint32_t)0x00000003)
  79. #define IS_RCC_SYSCLK_SOURCE(SOURCE) (((SOURCE) == RCC_SYSCLKSource_HSI) || \
  80. ((SOURCE) == RCC_SYSCLKSource_HSE) || \
  81. ((SOURCE) == RCC_SYSCLKSource_PLLCLK||(SOURCE) == RCC_SYSCLKSource_LSI))
  82. /**
  83. * @}
  84. */
  85. /** @defgroup AHB_clock_source
  86. * @{
  87. */
  88. #define RCC_SYSCLK_Div1 ((uint32_t)0x00000000)
  89. #define RCC_SYSCLK_Div2 ((uint32_t)0x00000080)
  90. #define RCC_SYSCLK_Div4 ((uint32_t)0x00000090)
  91. #define RCC_SYSCLK_Div8 ((uint32_t)0x000000A0)
  92. #define RCC_SYSCLK_Div16 ((uint32_t)0x000000B0)
  93. #define RCC_SYSCLK_Div64 ((uint32_t)0x000000C0)
  94. #define RCC_SYSCLK_Div128 ((uint32_t)0x000000D0)
  95. #define RCC_SYSCLK_Div256 ((uint32_t)0x000000E0)
  96. #define RCC_SYSCLK_Div512 ((uint32_t)0x000000F0)
  97. #define IS_RCC_HCLK(HCLK) (((HCLK) == RCC_SYSCLK_Div1) || ((HCLK) == RCC_SYSCLK_Div2) || \
  98. ((HCLK) == RCC_SYSCLK_Div4) || ((HCLK) == RCC_SYSCLK_Div8) || \
  99. ((HCLK) == RCC_SYSCLK_Div16) || ((HCLK) == RCC_SYSCLK_Div64) || \
  100. ((HCLK) == RCC_SYSCLK_Div128) || ((HCLK) == RCC_SYSCLK_Div256) || \
  101. ((HCLK) == RCC_SYSCLK_Div512))
  102. /**
  103. * @}
  104. */
  105. /** @defgroup APB1_APB2_clock_source
  106. * @{
  107. */
  108. #define RCC_HCLK_Div1 ((uint32_t)0x00000000)
  109. #define RCC_HCLK_Div2 ((uint32_t)0x00000400)
  110. #define RCC_HCLK_Div4 ((uint32_t)0x00000500)
  111. #define RCC_HCLK_Div8 ((uint32_t)0x00000600)
  112. #define RCC_HCLK_Div16 ((uint32_t)0x00000700)
  113. #define IS_RCC_PCLK(PCLK) (((PCLK) == RCC_HCLK_Div1) || ((PCLK) == RCC_HCLK_Div2) || \
  114. ((PCLK) == RCC_HCLK_Div4) || ((PCLK) == RCC_HCLK_Div8) || \
  115. ((PCLK) == RCC_HCLK_Div16))
  116. /**
  117. * @}
  118. */
  119. /** @defgroup PLL_multiplication_factor
  120. * @{
  121. */
  122. #define RCC_PLLMul_2 ((uint32_t)0x00000000)
  123. #define RCC_PLLMul_3 ((uint32_t)0x00040000)
  124. #define RCC_PLLMul_4 ((uint32_t)0x00080000)
  125. #define RCC_PLLMul_5 ((uint32_t)0x000C0000)
  126. #define RCC_PLLMul_6 ((uint32_t)0x00100000)
  127. #define RCC_PLLMul_7 ((uint32_t)0x00140000)
  128. #define RCC_PLLMul_8 ((uint32_t)0x00180000)
  129. #define RCC_PLLMul_9 ((uint32_t)0x001C0000)
  130. #define RCC_PLLMul_10 ((uint32_t)0x00200000)
  131. #define RCC_PLLMul_11 ((uint32_t)0x00240000)
  132. #define RCC_PLLMul_12 ((uint32_t)0x00280000)
  133. #define RCC_PLLMul_13 ((uint32_t)0x002C0000)
  134. #define RCC_PLLMul_14 ((uint32_t)0x00300000)
  135. #define RCC_PLLMul_15 ((uint32_t)0x00340000)
  136. #define RCC_PLLMul_16 ((uint32_t)0x00380000)
  137. #define IS_RCC_PLL_MUL(MUL) (((MUL) == RCC_PLLMul_2) || ((MUL) == RCC_PLLMul_3) || \
  138. ((MUL) == RCC_PLLMul_4) || ((MUL) == RCC_PLLMul_5) || \
  139. ((MUL) == RCC_PLLMul_6) || ((MUL) == RCC_PLLMul_7) || \
  140. ((MUL) == RCC_PLLMul_8) || ((MUL) == RCC_PLLMul_9) || \
  141. ((MUL) == RCC_PLLMul_10) || ((MUL) == RCC_PLLMul_11) || \
  142. ((MUL) == RCC_PLLMul_12) || ((MUL) == RCC_PLLMul_13) || \
  143. ((MUL) == RCC_PLLMul_14) || ((MUL) == RCC_PLLMul_15) || \
  144. ((MUL) == RCC_PLLMul_16))
  145. /**
  146. * @}
  147. */
  148. /** @defgroup RCC_Interrupt_source
  149. * @{
  150. */
  151. #define RCC_IT_LSIRDY ((uint8_t)0x01)
  152. #define RCC_IT_HSIRDY ((uint8_t)0x04)
  153. #define RCC_IT_HSERDY ((uint8_t)0x08)
  154. #define RCC_IT_PLLRDY ((uint8_t)0x10)
  155. #define IS_RCC_IT(IT) ((((IT) & (uint8_t)0xE0) == 0x00) && ((IT) != 0x00))
  156. #define IS_RCC_GET_IT(IT) (((IT) == RCC_IT_LSIRDY) || \
  157. ((IT) == RCC_IT_HSIRDY) || ((IT) == RCC_IT_HSERDY) || \
  158. ((IT) == RCC_IT_PLLRDY))
  159. #define IS_RCC_CLEAR_IT(IT) ((((IT) & (uint8_t)0x60) == 0x00) && ((IT) != 0x00))
  160. /**
  161. * @}
  162. */
  163. /** @defgroup USB_clock_source
  164. * @{
  165. */
  166. #define RCC_USBCLKSource_PLLCLK_Div1 ((uint32_t)0x00000000)
  167. #define RCC_USBCLKSource_PLLCLK_Div2 ((uint32_t)0x00400000)
  168. #define RCC_USBCLKSource_PLLCLK_Div3 ((uint32_t)0x00800000)
  169. #define RCC_USBCLKSource_PLLCLK_Div4 ((uint32_t)0x00c00000)
  170. #define IS_RCC_USBCLK_SOURCE(SOURCE) (((SOURCE) == RCC_USBCLKSource_PLLCLK_Div1) || \
  171. ((SOURCE) == RCC_USBCLKSource_PLLCLK_Div2) || ((SOURCE) == RCC_USBCLKSource_PLLCLK_Div3)|| \
  172. ((SOURCE) == RCC_USBCLKSource_PLLCLK_Div4))
  173. /** @defgroup AHB_peripheral
  174. * @{
  175. */
  176. #define RCC_AHBPeriph_DMA1 ((uint32_t)0x00000001)
  177. #define RCC_AHBPeriph_SRAM ((uint32_t)0x00000004)
  178. #define RCC_AHBPeriph_FLITF ((uint32_t)0x00000010)
  179. #define RCC_AHBPeriph_AES ((uint32_t)0x00000080)
  180. #define RCC_AHBPeriph_GPIOA ((uint32_t)0x00020000)
  181. #define RCC_AHBPeriph_GPIOB ((uint32_t)0x00040000)
  182. #define RCC_AHBPeriph_GPIOC ((uint32_t)0x00080000)
  183. #define RCC_AHBPeriph_GPIOD ((uint32_t)0x00100000)
  184. #define IS_RCC_AHB_PERIPH(PERIPH) ((((PERIPH) & 0xFFE1FF6A) == 0x00) && ((PERIPH) != 0x00))
  185. /**
  186. * @}
  187. */
  188. /** @defgroup APB2_peripheral
  189. * @{
  190. */
  191. #define RCC_APB2Periph_SYSCFG ((uint32_t)0x00000001)
  192. #define RCC_APB2Periph_ADC1 ((uint32_t)0x00000200)
  193. #define RCC_APB2Periph_TIM1 ((uint32_t)0x00000800)
  194. #define RCC_APB2Periph_SPI1 ((uint32_t)0x00001000)
  195. #define RCC_APB2Periph_UART1 ((uint32_t)0x00004000)
  196. #define RCC_APB2Periph_COMP ((uint32_t)0x00008000)
  197. #define RCC_APB2Periph_TIM14 ((uint32_t)0x00010000)
  198. #define RCC_APB2Periph_TIM16 ((uint32_t)0x00020000)
  199. #define RCC_APB2Periph_TIM17 ((uint32_t)0x00040000)
  200. #define RCC_APB2Periph_DBGMCU ((uint32_t)0x00400000)
  201. #define RCC_APB2Periph_ALL ((uint32_t)0x0047DA01)
  202. #define IS_RCC_APB2_PERIPH(PERIPH) ((((PERIPH) & 0xFFB825FE) == 0x00) && ((PERIPH) != 0x00))
  203. /**
  204. * @}
  205. */
  206. /** @defgroup APB1_peripheral
  207. * @{
  208. */
  209. #define RCC_APB1Periph_TIM2 ((uint32_t)0x00000001)
  210. #define RCC_APB1Periph_TIM3 ((uint32_t)0x00000002)
  211. #define RCC_APB1Periph_WWDG ((uint32_t)0x00000800)
  212. #define RCC_APB1Periph_SPI2 ((uint32_t)0x00004000)
  213. #define RCC_APB1Periph_UART2 ((uint32_t)0x00020000)
  214. #define RCC_APB1Periph_I2C1 ((uint32_t)0x00200000)
  215. #define RCC_APB1Periph_USB ((uint32_t)0x00800000)
  216. #define RCC_APB1Periph_CAN1 ((uint32_t)0x02000000)
  217. #define RCC_APB1Periph_PWR ((uint32_t)0x10000000)
  218. #define RCC_APB1Periph_CRS ((uint32_t)0x08000000)
  219. #define RCC_APB1Periph_ALL ((uint32_t)0x1AA24803)
  220. #define IS_RCC_APB1_PERIPH(PERIPH) ((((PERIPH) & 0xE55DB7FC) == 0x00) && ((PERIPH) != 0x00))
  221. /**
  222. * @}
  223. */
  224. /** @defgroup Clock_source_to_output_on_MCO_pin
  225. * @{
  226. */
  227. #define RCC_MCO_NoClock ((uint8_t)0x00)
  228. #define RCC_MCO_SYSCLK ((uint8_t)0x04)
  229. #define RCC_MCO_HSI ((uint8_t)0x05)
  230. #define RCC_MCO_HSE ((uint8_t)0x06)
  231. #define RCC_MCO_PLLCLK_Div2 ((uint8_t)0x07)
  232. #define RCC_MCO_LSI ((uint8_t)0x02)
  233. #define IS_RCC_MCO(MCO) (((MCO) == RCC_MCO_NoClock) || ((MCO) == RCC_MCO_HSI) || \
  234. ((MCO) == RCC_MCO_SYSCLK) || ((MCO) == RCC_MCO_HSE) || \
  235. ((MCO) == RCC_MCO_PLLCLK_Div2)||((MCO) == RCC_MCO_LSI))
  236. /**
  237. * @}
  238. */
  239. /** @defgroup RCC_Flag
  240. * @{
  241. */
  242. #define RCC_FLAG_HSIRDY ((uint8_t)0x21)
  243. #define RCC_FLAG_HSERDY ((uint8_t)0x31)
  244. #define RCC_FLAG_PLLRDY ((uint8_t)0x39)
  245. #define RCC_FLAG_LSIRDY ((uint8_t)0x61)
  246. #define RCC_FLAG_PINRST ((uint8_t)0x7A)
  247. #define RCC_FLAG_PORRST ((uint8_t)0x7B)
  248. #define RCC_FLAG_SFTRST ((uint8_t)0x7C)
  249. #define RCC_FLAG_IWDGRST ((uint8_t)0x7D)
  250. #define RCC_FLAG_WWDGRST ((uint8_t)0x7E)
  251. #define IS_RCC_FLAG(FLAG) (((FLAG) == RCC_FLAG_HSIRDY) || ((FLAG) == RCC_FLAG_HSERDY) || \
  252. ((FLAG) == RCC_FLAG_PLLRDY) || ((FLAG) == RCC_FLAG_LSERDY) || \
  253. ((FLAG) == RCC_FLAG_LSIRDY) || ((FLAG) == RCC_FLAG_PINRST) || \
  254. ((FLAG) == RCC_FLAG_PORRST) || ((FLAG) == RCC_FLAG_SFTRST) || \
  255. ((FLAG) == RCC_FLAG_IWDGRST)|| ((FLAG) == RCC_FLAG_WWDGRST))
  256. #define IS_RCC_CALIBRATION_VALUE(VALUE) ((VALUE) <= 0x1F)
  257. /**
  258. * @}
  259. */
  260. /**
  261. * @}
  262. */
  263. /** @defgroup RCC_Exported_Macros
  264. * @{
  265. */
  266. /**
  267. * @}
  268. */
  269. /** @defgroup RCC_Exported_Functions
  270. * @{
  271. */
  272. void RCC_DeInit(void);
  273. void RCC_HSEConfig(uint32_t RCC_HSE);
  274. ErrorStatus RCC_WaitForHSEStartUp(void);
  275. void RCC_AdjustHSICalibrationValue(uint8_t HSICalibrationValue);
  276. void RCC_HSICmd(FunctionalState NewState);
  277. void RCC_PLLConfig(uint32_t RCC_PLLSource, uint32_t RCC_PLLMul);
  278. void RCC_PLLCmd(FunctionalState NewState);
  279. void RCC_SYSCLKConfig(uint32_t RCC_SYSCLKSource);
  280. uint8_t RCC_GetSYSCLKSource(void);
  281. void RCC_HCLKConfig(uint32_t RCC_SYSCLK);
  282. void RCC_PCLK1Config(uint32_t RCC_HCLK);
  283. void RCC_PCLK2Config(uint32_t RCC_HCLK);
  284. void RCC_ITConfig(uint8_t RCC_IT, FunctionalState NewState);
  285. void RCC_USBCLKConfig(uint32_t RCC_USBCLKSource);
  286. void RCC_LSICmd(FunctionalState NewState);
  287. void RCC_GetClocksFreq(RCC_ClocksTypeDef* RCC_Clocks);
  288. void RCC_AHBPeriphClockCmd(uint32_t RCC_AHBPeriph, FunctionalState NewState);
  289. void RCC_APB2PeriphClockCmd(uint32_t RCC_APB2Periph, FunctionalState NewState);
  290. void RCC_APB1PeriphClockCmd(uint32_t RCC_APB1Periph, FunctionalState NewState);
  291. void RCC_APB2PeriphResetCmd(uint32_t RCC_APB2Periph, FunctionalState NewState);
  292. void RCC_APB1PeriphResetCmd(uint32_t RCC_APB1Periph, FunctionalState NewState);
  293. void RCC_ClockSecuritySystemCmd(FunctionalState NewState);
  294. void RCC_MCOConfig(uint8_t RCC_MCO);
  295. FlagStatus RCC_GetFlagStatus(uint8_t RCC_FLAG);
  296. void RCC_ClearFlag(void);
  297. ITStatus RCC_GetITStatus(uint8_t RCC_IT);
  298. void RCC_ClearITPendingBit(uint8_t RCC_IT);
  299. #endif /* __HAL_RCC_H */
  300. /**
  301. * @}
  302. */
  303. /**
  304. * @}
  305. */
  306. /**
  307. * @}
  308. */
  309. /*-------------------------(C) COPYRIGHT 2017 MindMotion ----------------------*/