Mercurial > public > ostc4

comparison Common/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_ll_utils.h @ 128:c78bcbd5deda FlipDisplay

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added current STM32 standandard libraries in version independend folder structure
author Ideenmodellierer
date Sun, 17 Feb 2019 21:12:22 +0100
parents
children
comparison
equal deleted inserted replaced
127:1369f8660eaa 128:c78bcbd5deda
1 /**
2 ******************************************************************************
3 * @file stm32f4xx_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
17 @endverbatim
18 ******************************************************************************
19 * @attention
20 *
21 * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
22 *
23 * Redistribution and use in source and binary forms, with or without modification,
24 * are permitted provided that the following conditions are met:
25 * 1. Redistributions of source code must retain the above copyright notice,
26 * this list of conditions and the following disclaimer.
27 * 2. Redistributions in binary form must reproduce the above copyright notice,
28 * this list of conditions and the following disclaimer in the documentation
29 * and/or other materials provided with the distribution.
30 * 3. Neither the name of STMicroelectronics nor the names of its contributors
31 * may be used to endorse or promote products derived from this software
32 * without specific prior written permission.
33 *
34 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
35 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
36 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
37 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
38 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
39 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
40 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
41 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
42 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
43 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44 *
45 ******************************************************************************
46 */
47
48 /* Define to prevent recursive inclusion -------------------------------------*/
49 #ifndef __STM32F4xx_LL_UTILS_H
50 #define __STM32F4xx_LL_UTILS_H
51
52 #ifdef __cplusplus
53 extern "C" {
54 #endif
55
56 /* Includes ------------------------------------------------------------------*/
57 #include "stm32f4xx.h"
58
59 /** @addtogroup STM32F4xx_LL_Driver
60 * @{
61 */
62
63 /** @defgroup UTILS_LL UTILS
64 * @{
65 */
66
67 /* Private types -------------------------------------------------------------*/
68 /* Private variables ---------------------------------------------------------*/
69
70 /* Private constants ---------------------------------------------------------*/
71 /** @defgroup UTILS_LL_Private_Constants UTILS Private Constants
72 * @{
73 */
74
75 /* Max delay can be used in LL_mDelay */
76 #define LL_MAX_DELAY 0xFFFFFFFFU
77
78 /**
79 * @brief Unique device ID register base address
80 */
81 #define UID_BASE_ADDRESS UID_BASE
82
83 /**
84 * @brief Flash size data register base address
85 */
86 #define FLASHSIZE_BASE_ADDRESS FLASHSIZE_BASE
87
88 /**
89 * @brief Package data register base address
90 */
91 #define PACKAGE_BASE_ADDRESS PACKAGE_BASE
92
93 /**
94 * @}
95 */
96
97 /* Private macros ------------------------------------------------------------*/
98 /** @defgroup UTILS_LL_Private_Macros UTILS Private Macros
99 * @{
100 */
101 /**
102 * @}
103 */
104 /* Exported types ------------------------------------------------------------*/
105 /** @defgroup UTILS_LL_ES_INIT UTILS Exported structures
106 * @{
107 */
108 /**
109 * @brief UTILS PLL structure definition
110 */
111 typedef struct
112 {
113 uint32_t PLLM; /*!< Division factor for PLL VCO input clock.
114 This parameter can be a value of @ref RCC_LL_EC_PLLM_DIV
115
116 This feature can be modified afterwards using unitary function
117 @ref LL_RCC_PLL_ConfigDomain_SYS(). */
118
119 uint32_t PLLN; /*!< Multiplication factor for PLL VCO output clock.
120 This parameter must be a number between Min_Data = @ref RCC_PLLN_MIN_VALUE
121 and Max_Data = @ref RCC_PLLN_MIN_VALUE
122
123 This feature can be modified afterwards using unitary function
124 @ref LL_RCC_PLL_ConfigDomain_SYS(). */
125
126 uint32_t PLLP; /*!< Division for the main system clock.
127 This parameter can be a value of @ref RCC_LL_EC_PLLP_DIV
128
129 This feature can be modified afterwards using unitary function
130 @ref LL_RCC_PLL_ConfigDomain_SYS(). */
131 } LL_UTILS_PLLInitTypeDef;
132
133 /**
134 * @brief UTILS System, AHB and APB buses clock configuration structure definition
135 */
136 typedef struct
137 {
138 uint32_t AHBCLKDivider; /*!< The AHB clock (HCLK) divider. This clock is derived from the system clock (SYSCLK).
139 This parameter can be a value of @ref RCC_LL_EC_SYSCLK_DIV
140
141 This feature can be modified afterwards using unitary function
142 @ref LL_RCC_SetAHBPrescaler(). */
143
144 uint32_t APB1CLKDivider; /*!< The APB1 clock (PCLK1) divider. This clock is derived from the AHB clock (HCLK).
145 This parameter can be a value of @ref RCC_LL_EC_APB1_DIV
146
147 This feature can be modified afterwards using unitary function
148 @ref LL_RCC_SetAPB1Prescaler(). */
149
150 uint32_t APB2CLKDivider; /*!< The APB2 clock (PCLK2) divider. This clock is derived from the AHB clock (HCLK).
151 This parameter can be a value of @ref RCC_LL_EC_APB2_DIV
152
153 This feature can be modified afterwards using unitary function
154 @ref LL_RCC_SetAPB2Prescaler(). */
155
156 } LL_UTILS_ClkInitTypeDef;
157
158 /**
159 * @}
160 */
161
162 /* Exported constants --------------------------------------------------------*/
163 /** @defgroup UTILS_LL_Exported_Constants UTILS Exported Constants
164 * @{
165 */
166
167 /** @defgroup UTILS_EC_HSE_BYPASS HSE Bypass activation
168 * @{
169 */
170 #define LL_UTILS_HSEBYPASS_OFF 0x00000000U /*!< HSE Bypass is not enabled */
171 #define LL_UTILS_HSEBYPASS_ON 0x00000001U /*!< HSE Bypass is enabled */
172 /**
173 * @}
174 */
175
176 /** @defgroup UTILS_EC_PACKAGETYPE PACKAGE TYPE
177 * @{
178 */
179 #define LL_UTILS_PACKAGETYPE_WLCSP36_UFQFPN48_LQFP64 0x00000000U /*!< WLCSP36 or UFQFPN48 or LQFP64 package type */
180 #define LL_UTILS_PACKAGETYPE_WLCSP168_FBGA169_LQFP100_LQFP64_UFQFPN48 0x00000100U /*!< WLCSP168 or FBGA169 or LQFP100 or LQFP64 or UFQFPN48 package type */
181 #define LL_UTILS_PACKAGETYPE_WLCSP64_WLCSP81_LQFP176_UFBGA176 0x00000200U /*!< WLCSP64 or WLCSP81 or LQFP176 or UFBGA176 package type */
182 #define LL_UTILS_PACKAGETYPE_LQFP144_UFBGA144_UFBGA144_UFBGA100 0x00000300U /*!< LQFP144 or UFBGA144 or UFBGA144 or UFBGA100 package type */
183 #define LL_UTILS_PACKAGETYPE_LQFP100_LQFP208_TFBGA216 0x00000400U /*!< LQFP100 or LQFP208 or TFBGA216 package type */
184 #define LL_UTILS_PACKAGETYPE_LQFP208_TFBGA216 0x00000500U /*!< LQFP208 or TFBGA216 package type */
185 #define LL_UTILS_PACKAGETYPE_TQFP64_UFBGA144_LQFP144 0x00000700U /*!< TQFP64 or UFBGA144 or LQFP144 package type */
186 /**
187 * @}
188 */
189
190 /**
191 * @}
192 */
193
194 /* Exported macro ------------------------------------------------------------*/
195
196 /* Exported functions --------------------------------------------------------*/
197 /** @defgroup UTILS_LL_Exported_Functions UTILS Exported Functions
198 * @{
199 */
200
201 /** @defgroup UTILS_EF_DEVICE_ELECTRONIC_SIGNATURE DEVICE ELECTRONIC SIGNATURE
202 * @{
203 */
204
205 /**
206 * @brief Get Word0 of the unique device identifier (UID based on 96 bits)
207 * @retval UID[31:0]
208 */
209 __STATIC_INLINE uint32_t LL_GetUID_Word0(void)
210 {
211 return (uint32_t)(READ_REG(*((uint32_t *)UID_BASE_ADDRESS)));
212 }
213
214 /**
215 * @brief Get Word1 of the unique device identifier (UID based on 96 bits)
216 * @retval UID[63:32]
217 */
218 __STATIC_INLINE uint32_t LL_GetUID_Word1(void)
219 {
220 return (uint32_t)(READ_REG(*((uint32_t *)(UID_BASE_ADDRESS + 4U))));
221 }
222
223 /**
224 * @brief Get Word2 of the unique device identifier (UID based on 96 bits)
225 * @retval UID[95:64]
226 */
227 __STATIC_INLINE uint32_t LL_GetUID_Word2(void)
228 {
229 return (uint32_t)(READ_REG(*((uint32_t *)(UID_BASE_ADDRESS + 8U))));
230 }
231
232 /**
233 * @brief Get Flash memory size
234 * @note This bitfield indicates the size of the device Flash memory expressed in
235 * Kbytes. As an example, 0x040 corresponds to 64 Kbytes.
236 * @retval FLASH_SIZE[15:0]: Flash memory size
237 */
238 __STATIC_INLINE uint32_t LL_GetFlashSize(void)
239 {
240 return (uint16_t)(READ_REG(*((uint32_t *)FLASHSIZE_BASE_ADDRESS)));
241 }
242
243 /**
244 * @brief Get Package type
245 * @retval Returned value can be one of the following values:
246 * @arg @ref LL_UTILS_PACKAGETYPE_WLCSP36_UFQFPN48_LQFP64 (*)
247 * @arg @ref LL_UTILS_PACKAGETYPE_WLCSP168_FBGA169_LQFP100_LQFP64_UFQFPN48 (*)
248 * @arg @ref LL_UTILS_PACKAGETYPE_WLCSP64_WLCSP81_LQFP176_UFBGA176 (*)
249 * @arg @ref LL_UTILS_PACKAGETYPE_LQFP144_UFBGA144_UFBGA144_UFBGA100 (*)
250 * @arg @ref LL_UTILS_PACKAGETYPE_LQFP100_LQFP208_TFBGA216 (*)
251 * @arg @ref LL_UTILS_PACKAGETYPE_LQFP208_TFBGA216 (*)
252 * @arg @ref LL_UTILS_PACKAGETYPE_TQFP64_UFBGA144_LQFP144 (*)
253 *
254 * (*) value not defined in all devices.
255 */
256 __STATIC_INLINE uint32_t LL_GetPackageType(void)
257 {
258 return (uint8_t)(READ_REG(*((uint32_t *)PACKAGE_BASE_ADDRESS)) & 0x0700U);
259 }
260
261 /**
262 * @}
263 */
264
265 /** @defgroup UTILS_LL_EF_DELAY DELAY
266 * @{
267 */
268
269 /**
270 * @brief This function configures the Cortex-M SysTick source of the time base.
271 * @param HCLKFrequency HCLK frequency in Hz (can be calculated thanks to RCC helper macro)
272 * @note When a RTOS is used, it is recommended to avoid changing the SysTick
273 * configuration by calling this function, for a delay use rather osDelay RTOS service.
274 * @param Ticks Number of ticks
275 * @retval None
276 */
277 __STATIC_INLINE void LL_InitTick(uint32_t HCLKFrequency, uint32_t Ticks)
278 {
279 /* Configure the SysTick to have interrupt in 1ms time base */
280 SysTick->LOAD = (uint32_t)((HCLKFrequency / Ticks) - 1UL); /* set reload register */
281 SysTick->VAL = 0UL; /* Load the SysTick Counter Value */
282 SysTick->CTRL = SysTick_CTRL_CLKSOURCE_Msk |
283 SysTick_CTRL_ENABLE_Msk; /* Enable the Systick Timer */
284 }
285
286 void LL_Init1msTick(uint32_t HCLKFrequency);
287 void LL_mDelay(uint32_t Delay);
288
289 /**
290 * @}
291 */
292
293 /** @defgroup UTILS_EF_SYSTEM SYSTEM
294 * @{
295 */
296
297 void LL_SetSystemCoreClock(uint32_t HCLKFrequency);
298 ErrorStatus LL_PLL_ConfigSystemClock_HSI(LL_UTILS_PLLInitTypeDef *UTILS_PLLInitStruct,
299 LL_UTILS_ClkInitTypeDef *UTILS_ClkInitStruct);
300 ErrorStatus LL_PLL_ConfigSystemClock_HSE(uint32_t HSEFrequency, uint32_t HSEBypass,
301 LL_UTILS_PLLInitTypeDef *UTILS_PLLInitStruct, LL_UTILS_ClkInitTypeDef *UTILS_ClkInitStruct);
302
303 /**
304 * @}
305 */
306
307 /**
308 * @}
309 */
310
311 /**
312 * @}
313 */
314
315 /**
316 * @}
317 */
318
319 #ifdef __cplusplus
320 }
321 #endif
322
323 #endif /* __STM32F4xx_LL_UTILS_H */
324
325 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/