mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_NUCLEO_L011K4/TOOLCHAIN_ARM_MICRO/stm32l0xx_ll_utils.h@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
Parent:
TARGET_DISCO_L072CZ_LRWAN1/TARGET_STM/TARGET_STM32L0/device/stm32l0xx_ll_utils.h@167:84c0a372a020 
mbed library. Release version 164

Who changed what in which revision?

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