You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 

288 lines
9.7 KiB

  1. /**
  2. ******************************************************************************
  3. * @file stm32f0xx_ll_utils.h
  4. * @author MCD Application Team
  5. * @brief Header file of UTILS LL module.
  6. @verbatim
  7. ==============================================================================
  8. ##### How to use this driver #####
  9. ==============================================================================
  10. [..]
  11. The LL UTILS driver contains a set of generic APIs that can be
  12. used by user:
  13. (+) Device electronic signature
  14. (+) Timing functions
  15. (+) PLL configuration functions
  16. @endverbatim
  17. ******************************************************************************
  18. * @attention
  19. *
  20. * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
  21. *
  22. * Redistribution and use in source and binary forms, with or without modification,
  23. * are permitted provided that the following conditions are met:
  24. * 1. Redistributions of source code must retain the above copyright notice,
  25. * this list of conditions and the following disclaimer.
  26. * 2. Redistributions in binary form must reproduce the above copyright notice,
  27. * this list of conditions and the following disclaimer in the documentation
  28. * and/or other materials provided with the distribution.
  29. * 3. Neither the name of STMicroelectronics nor the names of its contributors
  30. * may be used to endorse or promote products derived from this software
  31. * without specific prior written permission.
  32. *
  33. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  34. * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  35. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  36. * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  37. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  38. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  39. * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  40. * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  41. * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  42. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  43. *
  44. ******************************************************************************
  45. */
  46. /* Define to prevent recursive inclusion -------------------------------------*/
  47. #ifndef __STM32F0xx_LL_UTILS_H
  48. #define __STM32F0xx_LL_UTILS_H
  49. #ifdef __cplusplus
  50. extern "C" {
  51. #endif
  52. /* Includes ------------------------------------------------------------------*/
  53. #include "stm32f0xx.h"
  54. /** @addtogroup STM32F0xx_LL_Driver
  55. * @{
  56. */
  57. /** @defgroup UTILS_LL UTILS
  58. * @{
  59. */
  60. /* Private types -------------------------------------------------------------*/
  61. /* Private variables ---------------------------------------------------------*/
  62. /* Private constants ---------------------------------------------------------*/
  63. /** @defgroup UTILS_LL_Private_Constants UTILS Private Constants
  64. * @{
  65. */
  66. /* Max delay can be used in LL_mDelay */
  67. #define LL_MAX_DELAY 0xFFFFFFFFU
  68. /**
  69. * @brief Unique device ID register base address
  70. */
  71. #define UID_BASE_ADDRESS UID_BASE
  72. /**
  73. * @brief Flash size data register base address
  74. */
  75. #define FLASHSIZE_BASE_ADDRESS FLASHSIZE_BASE
  76. /**
  77. * @}
  78. */
  79. /* Private macros ------------------------------------------------------------*/
  80. /** @defgroup UTILS_LL_Private_Macros UTILS Private Macros
  81. * @{
  82. */
  83. /**
  84. * @}
  85. */
  86. /* Exported types ------------------------------------------------------------*/
  87. /** @defgroup UTILS_LL_ES_INIT UTILS Exported structures
  88. * @{
  89. */
  90. /**
  91. * @brief UTILS PLL structure definition
  92. */
  93. typedef struct
  94. {
  95. uint32_t PLLMul; /*!< Multiplication factor for PLL VCO input clock.
  96. This parameter can be a value of @ref RCC_LL_EC_PLL_MUL
  97. This feature can be modified afterwards using unitary function
  98. @ref LL_RCC_PLL_ConfigDomain_SYS(). */
  99. #if defined(RCC_PLLSRC_PREDIV1_SUPPORT)
  100. uint32_t PLLDiv; /*!< Division factor for PLL VCO output clock.
  101. This parameter can be a value of @ref RCC_LL_EC_PREDIV_DIV
  102. This feature can be modified afterwards using unitary function
  103. @ref LL_RCC_PLL_ConfigDomain_SYS(). */
  104. #else
  105. uint32_t Prediv; /*!< Division factor for HSE used as PLL clock source.
  106. This parameter can be a value of @ref RCC_LL_EC_PREDIV_DIV
  107. This feature can be modified afterwards using unitary function
  108. @ref LL_RCC_PLL_ConfigDomain_SYS(). */
  109. #endif /* RCC_PLLSRC_PREDIV1_SUPPORT */
  110. } LL_UTILS_PLLInitTypeDef;
  111. /**
  112. * @brief UTILS System, AHB and APB buses clock configuration structure definition
  113. */
  114. typedef struct
  115. {
  116. uint32_t AHBCLKDivider; /*!< The AHB clock (HCLK) divider. This clock is derived from the system clock (SYSCLK).
  117. This parameter can be a value of @ref RCC_LL_EC_SYSCLK_DIV
  118. This feature can be modified afterwards using unitary function
  119. @ref LL_RCC_SetAHBPrescaler(). */
  120. uint32_t APB1CLKDivider; /*!< The APB1 clock (PCLK1) divider. This clock is derived from the AHB clock (HCLK).
  121. This parameter can be a value of @ref RCC_LL_EC_APB1_DIV
  122. This feature can be modified afterwards using unitary function
  123. @ref LL_RCC_SetAPB1Prescaler(). */
  124. } LL_UTILS_ClkInitTypeDef;
  125. /**
  126. * @}
  127. */
  128. /* Exported constants --------------------------------------------------------*/
  129. /** @defgroup UTILS_LL_Exported_Constants UTILS Exported Constants
  130. * @{
  131. */
  132. /** @defgroup UTILS_EC_HSE_BYPASS HSE Bypass activation
  133. * @{
  134. */
  135. #define LL_UTILS_HSEBYPASS_OFF 0x00000000U /*!< HSE Bypass is not enabled */
  136. #define LL_UTILS_HSEBYPASS_ON 0x00000001U /*!< HSE Bypass is enabled */
  137. /**
  138. * @}
  139. */
  140. /**
  141. * @}
  142. */
  143. /* Exported macro ------------------------------------------------------------*/
  144. /* Exported functions --------------------------------------------------------*/
  145. /** @defgroup UTILS_LL_Exported_Functions UTILS Exported Functions
  146. * @{
  147. */
  148. /** @defgroup UTILS_EF_DEVICE_ELECTRONIC_SIGNATURE DEVICE ELECTRONIC SIGNATURE
  149. * @{
  150. */
  151. /**
  152. * @brief Get Word0 of the unique device identifier (UID based on 96 bits)
  153. * @retval UID[31:0]: X and Y coordinates on the wafer expressed in BCD format
  154. */
  155. __STATIC_INLINE uint32_t LL_GetUID_Word0(void)
  156. {
  157. return (uint32_t)(READ_REG(*((uint32_t *)UID_BASE_ADDRESS)));
  158. }
  159. /**
  160. * @brief Get Word1 of the unique device identifier (UID based on 96 bits)
  161. * @retval UID[63:32]: Wafer number (UID[39:32]) & LOT_NUM[23:0] (UID[63:40])
  162. */
  163. __STATIC_INLINE uint32_t LL_GetUID_Word1(void)
  164. {
  165. return (uint32_t)(READ_REG(*((uint32_t *)(UID_BASE_ADDRESS + 4U))));
  166. }
  167. /**
  168. * @brief Get Word2 of the unique device identifier (UID based on 96 bits)
  169. * @retval UID[95:64]: Lot number (ASCII encoded) - LOT_NUM[55:24]
  170. */
  171. __STATIC_INLINE uint32_t LL_GetUID_Word2(void)
  172. {
  173. return (uint32_t)(READ_REG(*((uint32_t *)(UID_BASE_ADDRESS + 8U))));
  174. }
  175. /**
  176. * @brief Get Flash memory size
  177. * @note This bitfield indicates the size of the device Flash memory expressed in
  178. * Kbytes. As an example, 0x040 corresponds to 64 Kbytes.
  179. * @retval FLASH_SIZE[15:0]: Flash memory size
  180. */
  181. __STATIC_INLINE uint32_t LL_GetFlashSize(void)
  182. {
  183. return (uint16_t)(READ_REG(*((uint32_t *)FLASHSIZE_BASE_ADDRESS)));
  184. }
  185. /**
  186. * @}
  187. */
  188. /** @defgroup UTILS_LL_EF_DELAY DELAY
  189. * @{
  190. */
  191. /**
  192. * @brief This function configures the Cortex-M SysTick source of the time base.
  193. * @param HCLKFrequency HCLK frequency in Hz (can be calculated thanks to RCC helper macro)
  194. * @note When a RTOS is used, it is recommended to avoid changing the SysTick
  195. * configuration by calling this function, for a delay use rather osDelay RTOS service.
  196. * @param Ticks Number of ticks
  197. * @retval None
  198. */
  199. __STATIC_INLINE void LL_InitTick(uint32_t HCLKFrequency, uint32_t Ticks)
  200. {
  201. /* Configure the SysTick to have interrupt in 1ms time base */
  202. SysTick->LOAD = (uint32_t)((HCLKFrequency / Ticks) - 1UL); /* set reload register */
  203. SysTick->VAL = 0UL; /* Load the SysTick Counter Value */
  204. SysTick->CTRL = SysTick_CTRL_CLKSOURCE_Msk |
  205. SysTick_CTRL_ENABLE_Msk; /* Enable the Systick Timer */
  206. }
  207. void LL_Init1msTick(uint32_t HCLKFrequency);
  208. void LL_mDelay(uint32_t Delay);
  209. /**
  210. * @}
  211. */
  212. /** @defgroup UTILS_EF_SYSTEM SYSTEM
  213. * @{
  214. */
  215. void LL_SetSystemCoreClock(uint32_t HCLKFrequency);
  216. ErrorStatus LL_PLL_ConfigSystemClock_HSI(LL_UTILS_PLLInitTypeDef *UTILS_PLLInitStruct,
  217. LL_UTILS_ClkInitTypeDef *UTILS_ClkInitStruct);
  218. #if defined(RCC_CFGR_SW_HSI48)
  219. ErrorStatus LL_PLL_ConfigSystemClock_HSI48(LL_UTILS_PLLInitTypeDef *UTILS_PLLInitStruct,
  220. LL_UTILS_ClkInitTypeDef *UTILS_ClkInitStruct);
  221. #endif /*RCC_CFGR_SW_HSI48*/
  222. ErrorStatus LL_PLL_ConfigSystemClock_HSE(uint32_t HSEFrequency, uint32_t HSEBypass,
  223. LL_UTILS_PLLInitTypeDef *UTILS_PLLInitStruct, LL_UTILS_ClkInitTypeDef *UTILS_ClkInitStruct);
  224. /**
  225. * @}
  226. */
  227. /**
  228. * @}
  229. */
  230. /**
  231. * @}
  232. */
  233. /**
  234. * @}
  235. */
  236. #ifdef __cplusplus
  237. }
  238. #endif
  239. #endif /* __STM32F0xx_LL_UTILS_H */
  240. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/