WebSVN – DashDisplay – Diff – /branches/Dashboard_L152_v2/Drivers/STM32L1xx_HAL_Driver/Inc/stm32l1xx_ll_utils.h

 /**
   ******************************************************************************
   * @file    stm32l1xx_ll_utils.h
   * @author  MCD Application Team
   * @brief   Header file of UTILS LL module.
   @verbatim
   ==============================================================================
                      ##### How to use this driver #####
   ==============================================================================
     [..]
     The LL UTILS driver contains a set of generic APIs that can be
     used by user:
       (+) Device electronic signature
       (+) Timing functions
       (+) PLL configuration functions
   @endverbatim
   ******************************************************************************
   * @attention
   *
-  * <h2><center>&copy; Copyright(c) 2017 STMicroelectronics.
+  * Copyright (c) 2017 STMicroelectronics.
-  * All rights reserved.</center></h2>
+  * All rights reserved.
   *
-  * This software component is licensed by ST under BSD 3-Clause license,
+  * This software is licensed under terms that can be found in the LICENSE file
-  * the "License"; You may not use this file except in compliance with the
+  * in the root directory of this software component.
-  * License. You may obtain a copy of the License at:
+  * If no LICENSE file comes with this software, it is provided AS-IS.
-  *                        opensource.org/licenses/BSD-3-Clause
+  *
-  *
+  ******************************************************************************
-  ******************************************************************************
+  */
-  */
+/* Define to prevent recursive inclusion -------------------------------------*/
-/* Define to prevent recursive inclusion -------------------------------------*/
+#ifndef __STM32L1xx_LL_UTILS_H
-#ifndef __STM32L1xx_LL_UTILS_H
+#define __STM32L1xx_LL_UTILS_H
-#define __STM32L1xx_LL_UTILS_H
+#ifdef __cplusplus
-#ifdef __cplusplus
+extern "C" {
-extern "C" {
+#endif
-#endif
+/* Includes ------------------------------------------------------------------*/
-/* Includes ------------------------------------------------------------------*/
+#include "stm32l1xx.h"
-#include "stm32l1xx.h"
+/** @addtogroup STM32L1xx_LL_Driver
-/** @addtogroup STM32L1xx_LL_Driver
+  * @{
-  * @{
+  */
-  */
+/** @defgroup UTILS_LL UTILS
-/** @defgroup UTILS_LL UTILS
+  * @{
-  * @{
+  */
-  */
+/* Private types -------------------------------------------------------------*/
-/* Private types -------------------------------------------------------------*/
+/* Private variables ---------------------------------------------------------*/
-/* Private variables ---------------------------------------------------------*/
+/* Private constants ---------------------------------------------------------*/
-/* Private constants ---------------------------------------------------------*/
+/** @defgroup UTILS_LL_Private_Constants UTILS Private Constants
-/** @defgroup UTILS_LL_Private_Constants UTILS Private Constants
+  * @{
-  * @{
+  */
-  */
+/* Max delay can be used in LL_mDelay */
-/* Max delay can be used in LL_mDelay */
+#define LL_MAX_DELAY                  0xFFFFFFFFU
-#define LL_MAX_DELAY                  0xFFFFFFFFU
+/**
-/**
+ * @brief Unique device ID register base address
- * @brief Unique device ID register base address
+ */
- */
+#define UID_BASE_ADDRESS              UID_BASE
-#define UID_BASE_ADDRESS              UID_BASE
+/**
-/**
+ * @brief Flash size data register base address
- * @brief Flash size data register base address
+ */
- */
+#define FLASHSIZE_BASE_ADDRESS        FLASHSIZE_BASE
-#define FLASHSIZE_BASE_ADDRESS        FLASHSIZE_BASE
+/**
-/**
+  * @}
-  * @}
+  */
-  */
+/* Private macros ------------------------------------------------------------*/
-/* Private macros ------------------------------------------------------------*/
+/** @defgroup UTILS_LL_Private_Macros UTILS Private Macros
-/** @defgroup UTILS_LL_Private_Macros UTILS Private Macros
+  * @{
-  * @{
+  */
-  */
+/**
-/**
+  * @}
-  * @}
+  */
-  */
+/* Exported types ------------------------------------------------------------*/
-/* Exported types ------------------------------------------------------------*/
+/** @defgroup UTILS_LL_ES_INIT UTILS Exported structures
-/** @defgroup UTILS_LL_ES_INIT UTILS Exported structures
+  * @{
-  * @{
+  */
-  */
+/**
-/**
+  * @brief  UTILS PLL structure definition
-  * @brief  UTILS PLL structure definition
+  */
-  */
+typedef struct
-typedef struct
+{
-{
+  uint32_t PLLMul;   /*!< Multiplication factor for PLL VCO input clock.
-  uint32_t PLLMul;   /*!< Multiplication factor for PLL VCO input clock.
+                          This parameter can be a value of @ref RCC_LL_EC_PLL_MUL
-                          This parameter can be a value of @ref RCC_LL_EC_PLL_MUL
+                          This feature can be modified afterwards using unitary function
-                          This feature can be modified afterwards using unitary function
+                          @ref LL_RCC_PLL_ConfigDomain_SYS(). */
-                          @ref LL_RCC_PLL_ConfigDomain_SYS(). */
+  uint32_t PLLDiv;   /*!< Division factor for PLL VCO output clock.
-  uint32_t PLLDiv;   /*!< Division factor for PLL VCO output clock.
+                          This parameter can be a value of @ref RCC_LL_EC_PLL_DIV
-                          This parameter can be a value of @ref RCC_LL_EC_PLL_DIV
+                          This feature can be modified afterwards using unitary function
-                          This feature can be modified afterwards using unitary function
+                          @ref LL_RCC_PLL_ConfigDomain_SYS(). */
-                          @ref LL_RCC_PLL_ConfigDomain_SYS(). */
+} LL_UTILS_PLLInitTypeDef;
-} LL_UTILS_PLLInitTypeDef;
+/**
-/**
+  * @brief  UTILS System, AHB and APB buses clock configuration structure definition
-  * @brief  UTILS System, AHB and APB buses clock configuration structure definition
+  */
-  */
+typedef struct
-typedef struct
+{
-{
+  uint32_t AHBCLKDivider;         /*!< The AHB clock (HCLK) divider. This clock is derived from the system clock (SYSCLK).
-  uint32_t AHBCLKDivider;         /*!< The AHB clock (HCLK) divider. This clock is derived from the system clock (SYSCLK).
+                                       This parameter can be a value of @ref RCC_LL_EC_SYSCLK_DIV
-                                       This parameter can be a value of @ref RCC_LL_EC_SYSCLK_DIV
+                                       This feature can be modified afterwards using unitary function
-                                       This feature can be modified afterwards using unitary function
+                                       @ref LL_RCC_SetAHBPrescaler(). */
-                                       @ref LL_RCC_SetAHBPrescaler(). */
+  uint32_t APB1CLKDivider;        /*!< The APB1 clock (PCLK1) divider. This clock is derived from the AHB clock (HCLK).
-  uint32_t APB1CLKDivider;        /*!< The APB1 clock (PCLK1) divider. This clock is derived from the AHB clock (HCLK).
+                                       This parameter can be a value of @ref RCC_LL_EC_APB1_DIV
-                                       This parameter can be a value of @ref RCC_LL_EC_APB1_DIV
+                                       This feature can be modified afterwards using unitary function
-                                       This feature can be modified afterwards using unitary function
+                                       @ref LL_RCC_SetAPB1Prescaler(). */
-                                       @ref LL_RCC_SetAPB1Prescaler(). */
+  uint32_t APB2CLKDivider;        /*!< The APB2 clock (PCLK2) divider. This clock is derived from the AHB clock (HCLK).
-  uint32_t APB2CLKDivider;        /*!< The APB2 clock (PCLK2) divider. This clock is derived from the AHB clock (HCLK).
+                                       This parameter can be a value of @ref RCC_LL_EC_APB2_DIV
-                                       This parameter can be a value of @ref RCC_LL_EC_APB2_DIV
+                                       This feature can be modified afterwards using unitary function
-                                       This feature can be modified afterwards using unitary function
+                                       @ref LL_RCC_SetAPB2Prescaler(). */
-                                       @ref LL_RCC_SetAPB2Prescaler(). */
+} LL_UTILS_ClkInitTypeDef;
-} LL_UTILS_ClkInitTypeDef;
+/**
-/**
+  * @}
-  * @}
+  */
-  */
+/* Exported constants --------------------------------------------------------*/
-/* Exported constants --------------------------------------------------------*/
+/** @defgroup UTILS_LL_Exported_Constants UTILS Exported Constants
-/** @defgroup UTILS_LL_Exported_Constants UTILS Exported Constants
+  * @{
-  * @{
+  */
-  */
+/** @defgroup UTILS_EC_HSE_BYPASS HSE Bypass activation
-/** @defgroup UTILS_EC_HSE_BYPASS HSE Bypass activation
+  * @{
-  * @{
+  */
-  */
+#define LL_UTILS_HSEBYPASS_OFF        0x00000000U       /*!< HSE Bypass is not enabled                */
-#define LL_UTILS_HSEBYPASS_OFF        0x00000000U       /*!< HSE Bypass is not enabled                */
+#define LL_UTILS_HSEBYPASS_ON         0x00000001U       /*!< HSE Bypass is enabled                    */
-#define LL_UTILS_HSEBYPASS_ON         0x00000001U       /*!< HSE Bypass is enabled                    */
+/**
-/**
+  * @}
-  * @}
+  */
-  */
+/**
-/**
+  * @}
-  * @}
+  */
-  */
+/* Exported macro ------------------------------------------------------------*/
-/* Exported macro ------------------------------------------------------------*/
+/* Exported functions --------------------------------------------------------*/
-/* Exported functions --------------------------------------------------------*/
+/** @defgroup UTILS_LL_Exported_Functions UTILS Exported Functions
-/** @defgroup UTILS_LL_Exported_Functions UTILS Exported Functions
+  * @{
-  * @{
+  */
-  */
+/** @defgroup UTILS_EF_DEVICE_ELECTRONIC_SIGNATURE DEVICE ELECTRONIC SIGNATURE
-/** @defgroup UTILS_EF_DEVICE_ELECTRONIC_SIGNATURE DEVICE ELECTRONIC SIGNATURE
+  * @{
-  * @{
+  */
-  */
+/**
-/**
+  * @brief  Get Word0 of the unique device identifier (UID based on 96 bits)
-  * @brief  Get Word0 of the unique device identifier (UID based on 96 bits)
+  * @retval UID[31:0]
-  * @retval UID[31:0]
+  */
-  */
+__STATIC_INLINE uint32_t LL_GetUID_Word0(void)
-__STATIC_INLINE uint32_t LL_GetUID_Word0(void)
+{
-{
+  return (uint32_t)(READ_REG(*((uint32_t *)UID_BASE_ADDRESS)));
-  return (uint32_t)(READ_REG(*((uint32_t *)UID_BASE_ADDRESS)));
+}
-}
+/**
-/**
+  * @brief  Get Word1 of the unique device identifier (UID based on 96 bits)
-  * @brief  Get Word1 of the unique device identifier (UID based on 96 bits)
+  * @retval UID[63:32]
-  * @retval UID[63:32]
+  */
-  */
+__STATIC_INLINE uint32_t LL_GetUID_Word1(void)
-__STATIC_INLINE uint32_t LL_GetUID_Word1(void)
+{
-{
+  return (uint32_t)(READ_REG(*((uint32_t *)(UID_BASE_ADDRESS + 0x04U))));
-  return (uint32_t)(READ_REG(*((uint32_t *)(UID_BASE_ADDRESS + 0x04U))));
+}
-}
+/**
-/**
+  * @brief  Get Word2 of the unique device identifier (UID based on 96 bits)
-  * @brief  Get Word2 of the unique device identifier (UID based on 96 bits)
+  * @retval UID[95:64]
-  * @retval UID[95:64]
+  */
-  */
+__STATIC_INLINE uint32_t LL_GetUID_Word2(void)
-__STATIC_INLINE uint32_t LL_GetUID_Word2(void)
+{
-{
+  return (uint32_t)(READ_REG(*((uint32_t *)(UID_BASE_ADDRESS + 0x14U))));
-  return (uint32_t)(READ_REG(*((uint32_t *)(UID_BASE_ADDRESS + 0x14U))));
+}
-}
+/**
-/**
+  * @brief  Get Flash memory size
-  * @brief  Get Flash memory size
+  * @note   For DEV_ID = 0x416 or 0x427 or 0x429 or 0x437, this field value indicates the Flash memory
-  * @note   For DEV_ID = 0x416 or 0x427 or 0x429 or 0x437, this field value indicates the Flash memory
+  *         size of the device in Kbytes.\n
-  *         size of the device in Kbytes.\n
+  *         Example: 0x0080 = 128 Kbytes.\n
-  *         Example: 0x0080 = 128 Kbytes.\n
+  *         For DEV_ID = 0x436, the field value can be '0' or '1', with '0' for 384 Kbytes and '1' for 256 Kbytes.
-  *         For DEV_ID = 0x436, the field value can be '0' or '1', with '0' for 384 Kbytes and '1' for 256 Kbytes.
+  * @note   For DEV_ID = 0x429, only LSB part of F_SIZE: F_SIZE[7:0] is valid. The MSB part
-  * @note   For DEV_ID = 0x429, only LSB part of F_SIZE: F_SIZE[7:0] is valid. The MSB part
+  *         F_SIZE[15:8] is reserved and must be ignored.
-  *         F_SIZE[15:8] is reserved and must be ignored.
+  * @retval FLASH_SIZE[15:0]: Flash memory size
-  * @retval FLASH_SIZE[15:0]: Flash memory size
+  */
-  */
+__STATIC_INLINE uint32_t LL_GetFlashSize(void)
-__STATIC_INLINE uint32_t LL_GetFlashSize(void)
+{
-{
+  return (uint32_t)(READ_REG(*((uint32_t *)FLASHSIZE_BASE_ADDRESS)) & 0xFFFFU);
-  return (uint32_t)(READ_REG(*((uint32_t *)FLASHSIZE_BASE_ADDRESS)) & 0xFFFFU);
+}
-}
+/**
-/**
+  * @}
-  * @}
+  */
-  */
+/** @defgroup UTILS_LL_EF_DELAY DELAY
-/** @defgroup UTILS_LL_EF_DELAY DELAY
+  * @{
-  * @{
+  */
-  */
+/**
-/**
+  * @brief  This function configures the Cortex-M SysTick source of the time base.
-  * @brief  This function configures the Cortex-M SysTick source of the time base.
+  * @param  HCLKFrequency HCLK frequency in Hz (can be calculated thanks to RCC helper macro)
-  * @param  HCLKFrequency HCLK frequency in Hz (can be calculated thanks to RCC helper macro)
+  * @note   When a RTOS is used, it is recommended to avoid changing the SysTick
-  * @note   When a RTOS is used, it is recommended to avoid changing the SysTick
+  *         configuration by calling this function, for a delay use rather osDelay RTOS service.
-  *         configuration by calling this function, for a delay use rather osDelay RTOS service.
+  * @param  Ticks Number of ticks
-  * @param  Ticks Number of ticks
+  * @retval None
-  * @retval None
+  */
-  */
+__STATIC_INLINE void LL_InitTick(uint32_t HCLKFrequency, uint32_t Ticks)
-__STATIC_INLINE void LL_InitTick(uint32_t HCLKFrequency, uint32_t Ticks)
+{
-{
+  /* Configure the SysTick to have interrupt in 1ms time base */
-  /* Configure the SysTick to have interrupt in 1ms time base */
+  SysTick->LOAD  = (uint32_t)((HCLKFrequency / Ticks) - 1UL);  /* set reload register */
-  SysTick->LOAD  = (uint32_t)((HCLKFrequency / Ticks) - 1UL);  /* set reload register */
+  SysTick->VAL   = 0UL;                                       /* Load the SysTick Counter Value */
-  SysTick->VAL   = 0UL;                                       /* Load the SysTick Counter Value */
+  SysTick->CTRL  = SysTick_CTRL_CLKSOURCE_Msk |
-  SysTick->CTRL  = SysTick_CTRL_CLKSOURCE_Msk |
+                   SysTick_CTRL_ENABLE_Msk;                   /* Enable the Systick Timer */
-                   SysTick_CTRL_ENABLE_Msk;                   /* Enable the Systick Timer */
+}
-}
+void        LL_Init1msTick(uint32_t HCLKFrequency);
-void        LL_Init1msTick(uint32_t HCLKFrequency);
+void        LL_mDelay(uint32_t Delay);
-void        LL_mDelay(uint32_t Delay);
+/**
-/**
+  * @}
-  * @}
+  */
-  */
+/** @defgroup UTILS_EF_SYSTEM SYSTEM
-/** @defgroup UTILS_EF_SYSTEM SYSTEM
+  * @{
-  * @{
+  */
-  */
+void        LL_SetSystemCoreClock(uint32_t HCLKFrequency);
-void        LL_SetSystemCoreClock(uint32_t HCLKFrequency);
+ErrorStatus LL_PLL_ConfigSystemClock_HSI(LL_UTILS_PLLInitTypeDef *UTILS_PLLInitStruct,
-ErrorStatus LL_PLL_ConfigSystemClock_HSI(LL_UTILS_PLLInitTypeDef *UTILS_PLLInitStruct,
+                                         LL_UTILS_ClkInitTypeDef *UTILS_ClkInitStruct);
-                                         LL_UTILS_ClkInitTypeDef *UTILS_ClkInitStruct);
+ErrorStatus LL_PLL_ConfigSystemClock_HSE(uint32_t HSEFrequency, uint32_t HSEBypass,
-ErrorStatus LL_PLL_ConfigSystemClock_HSE(uint32_t HSEFrequency, uint32_t HSEBypass,
+                                         LL_UTILS_PLLInitTypeDef *UTILS_PLLInitStruct, LL_UTILS_ClkInitTypeDef *UTILS_ClkInitStruct);
-                                         LL_UTILS_PLLInitTypeDef *UTILS_PLLInitStruct, LL_UTILS_ClkInitTypeDef *UTILS_ClkInitStruct);
+#if defined(FLASH_ACR_LATENCY)
-#if defined(FLASH_ACR_LATENCY)
+ErrorStatus LL_SetFlashLatency(uint32_t Frequency);
-ErrorStatus LL_SetFlashLatency(uint32_t Frequency);
+#endif /* FLASH_ACR_LATENCY */
-#endif /* FLASH_ACR_LATENCY */
+/**
-/**
+  * @}
-  * @}
+  */
-  */
+/**
-/**
+  * @}
-  * @}
+  */
-  */
+/**
-/**
+  * @}
-  * @}
+  */
-  */
+/**
-/**
+  * @}
-  * @}
+  */
-  */
+#ifdef __cplusplus
-#ifdef __cplusplus
+}
-}
+#endif
-#endif
+#endif /* __STM32L1xx_LL_UTILS_H */
-#endif /* __STM32L1xx_LL_UTILS_H */
-/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/

Subversion Repositories DashDisplay

(root)/branches/Dashboard_L152_v2/Drivers/STM32L1xx_HAL_Driver/Inc/stm32l1xx_ll_utils.h – Rev 56 → 77