[clock] Add new api enableClock

fpistm · fpistm · commit 932714929818 · 2018-06-13T09:36:06.000+02:00
Handle properly clock activation.

Signed-off-by: Frederic Pillon &lt;frederic.pillon@st.com&gt;
diff --git a/cores/arduino/stm32/clock.c b/cores/arduino/stm32/clock.c
@@ -35,7 +35,7 @@
   *
   ******************************************************************************
   */
-#include "stm32_def.h"
+#include "clock.h"
 
 #ifdef __cplusplus
  extern "C" {
@@ -120,6 +120,64 @@ void delayInsideIT(uint32_t delay_us)
 #endif
 }
 
+/**
+  * @brief  Enable the specified clock if not already set
+  * @param  source: clock source: LSE_CLOCK, LSI_CLOCK, HSI_CLOCK or HSE_CLOCK
+  * @retval None
+  */
+void enableClock(sourceClock_t source)
+{
+  RCC_OscInitTypeDef RCC_OscInitStruct = {0};
+  RCC_OscInitStruct.PLL.PLLState = RCC_PLL_NONE;
+
+  switch(source) {
+    case LSI_CLOCK:
+      if(__HAL_RCC_GET_FLAG(RCC_FLAG_LSIRDY) == RESET) {
+        RCC_OscInitStruct.OscillatorType =  RCC_OSCILLATORTYPE_LSI;
+        RCC_OscInitStruct.LSIState = RCC_LSI_ON;
+      }
+      break;
+    case HSI_CLOCK:
+      if(__HAL_RCC_GET_FLAG(RCC_FLAG_HSIRDY) == RESET) {
+        RCC_OscInitStruct.OscillatorType =  RCC_OSCILLATORTYPE_HSI;
+        RCC_OscInitStruct.HSIState = RCC_HSI_ON;
+        RCC_OscInitStruct.HSICalibrationValue = RCC_HSICALIBRATION_DEFAULT;
+      }
+      break;
+    case LSE_CLOCK:
+      /* Enable Power Clock */
+      if(__HAL_RCC_PWR_IS_CLK_DISABLED()) {
+        __HAL_RCC_PWR_CLK_ENABLE();
+      }
+#ifdef HAL_PWR_MODULE_ENABLED
+      /* Allow access to Backup domain */
+      HAL_PWR_EnableBkUpAccess();
+#endif
+      if(__HAL_RCC_GET_FLAG(RCC_FLAG_LSERDY) == RESET) {
+#ifdef __HAL_RCC_LSEDRIVE_CONFIG
+        __HAL_RCC_LSEDRIVE_CONFIG(RCC_LSEDRIVE_LOW);
+#endif
+        RCC_OscInitStruct.OscillatorType =  RCC_OSCILLATORTYPE_LSE;
+        RCC_OscInitStruct.LSEState = RCC_LSE_ON;
+      }
+      break;
+    case HSE_CLOCK:
+      if(__HAL_RCC_GET_FLAG(RCC_FLAG_HSERDY) == RESET) {
+        RCC_OscInitStruct.OscillatorType =  RCC_OSCILLATORTYPE_HSE;
+        RCC_OscInitStruct.HSEState = RCC_HSE_ON;
+      }
+      break;
+    default:
+      /* No valid clock to enable */
+      break;
+  }
+  if(RCC_OscInitStruct.OscillatorType != RCC_OSCILLATORTYPE_NONE) {
+    if(HAL_RCC_OscConfig(&RCC_OscInitStruct) != HAL_OK) {
+      Error_Handler();
+    }
+  }
+}
+
 #ifdef __cplusplus
 }
 #endif
diff --git a/cores/arduino/stm32/clock.h b/cores/arduino/stm32/clock.h
@@ -47,13 +47,22 @@
 #endif
 
 /* Exported types ------------------------------------------------------------*/
+/* Clock source selection */
+typedef enum {
+  LSI_CLOCK,
+  HSI_CLOCK,
+  LSE_CLOCK,
+  HSE_CLOCK
+} sourceClock_t;
+
 /* Exported constants --------------------------------------------------------*/
 /* Exported macro ------------------------------------------------------------*/
 /* Exported functions ------------------------------------------------------- */
 uint32_t GetCurrentMilli(void);
 uint32_t GetCurrentMicro(void);
 void delayInsideIT(uint32_t delay_us);
 
+void enableClock(sourceClock_t source);
 #ifdef __cplusplus
 }
 #endif
diff --git a/cores/arduino/stm32/rtc.c b/cores/arduino/stm32/rtc.c
@@ -100,22 +100,11 @@ void RTC_SetClockSource(sourceClock_t source)
   */
 static void RTC_initClock(sourceClock_t source)
 {
-  RCC_OscInitTypeDef RCC_OscInitStruct;
   RCC_PeriphCLKInitTypeDef PeriphClkInit;
 
   if(source == LSE_CLOCK) {
     /* Enable the clock if not already set by user */
-    if(__HAL_RCC_GET_FLAG(RCC_FLAG_LSERDY) == RESET) {
-#ifdef __HAL_RCC_LSEDRIVE_CONFIG
-      __HAL_RCC_LSEDRIVE_CONFIG(RCC_LSEDRIVE_LOW);
-#endif
-      RCC_OscInitStruct.OscillatorType =  RCC_OSCILLATORTYPE_LSE;
-      RCC_OscInitStruct.PLL.PLLState = RCC_PLL_NONE;
-      RCC_OscInitStruct.LSEState = RCC_LSE_ON;
-      if(HAL_RCC_OscConfig(&RCC_OscInitStruct) != HAL_OK) {
-        Error_Handler();
-      }
-    }
+    enableClock(LSE_CLOCK);
 
     PeriphClkInit.PeriphClockSelection = RCC_PERIPHCLK_RTC;
     PeriphClkInit.RTCClockSelection = RCC_RTCCLKSOURCE_LSE;
@@ -125,14 +114,8 @@ static void RTC_initClock(sourceClock_t source)
     clkSrc = LSE_CLOCK;
   } else if(source == HSE_CLOCK) {
     /* Enable the clock if not already set by user */
-    if(__HAL_RCC_GET_FLAG(RCC_FLAG_HSERDY) == RESET) {
-      RCC_OscInitStruct.OscillatorType =  RCC_OSCILLATORTYPE_HSE;
-      RCC_OscInitStruct.PLL.PLLState = RCC_PLL_NONE;
-      RCC_OscInitStruct.HSEState = RCC_HSE_ON;
-      if(HAL_RCC_OscConfig(&RCC_OscInitStruct) != HAL_OK) {
-        Error_Handler();
-      }
-    }
+    enableClock(HSE_CLOCK);
+
     /* HSE division factor for RTC clock must be set to ensure that
      * the clock supplied to the RTC is less than or equal to 1 MHz
      */
@@ -182,14 +165,7 @@ static void RTC_initClock(sourceClock_t source)
     clkSrc = HSE_CLOCK;
   } else if(source == LSI_CLOCK) {
     /* Enable the clock if not already set by user */
-    if(__HAL_RCC_GET_FLAG(RCC_FLAG_LSIRDY) == RESET) {
-      RCC_OscInitStruct.OscillatorType =  RCC_OSCILLATORTYPE_LSI;
-      RCC_OscInitStruct.PLL.PLLState = RCC_PLL_NONE;
-      RCC_OscInitStruct.LSIState = RCC_LSI_ON;
-      if(HAL_RCC_OscConfig(&RCC_OscInitStruct) != HAL_OK) {
-        Error_Handler();
-      }
-    }
+    enableClock(LSI_CLOCK);
 
     PeriphClkInit.PeriphClockSelection = RCC_PERIPHCLK_RTC;
     PeriphClkInit.RTCClockSelection = RCC_RTCCLKSOURCE_LSI;
@@ -314,14 +290,6 @@ void RTC_init(hourFormat_t format, sourceClock_t source)
 {
   initFormat = format;
 
-  /* Enable Power Clock */
-  __HAL_RCC_PWR_CLK_ENABLE();
-
-#ifdef HAL_PWR_MODULE_ENABLED
-  /* Allow access to Backup domain */
-  HAL_PWR_EnableBkUpAccess();
-#endif
-
   /* Init RTC clock */
   RTC_initClock(source);
 
diff --git a/cores/arduino/stm32/rtc.h b/cores/arduino/stm32/rtc.h
@@ -40,7 +40,7 @@
 #define __RTC_H
 
 /* Includes ------------------------------------------------------------------*/
-#include "stm32_def.h"
+#include "clock.h"
 
 #ifdef HAL_RTC_MODULE_ENABLED
 
@@ -72,13 +72,6 @@ typedef enum {
   Y_MSK   = 32
 } alarmMask_t;
 
-/* Clock source selection */
-typedef enum {
-  LSI_CLOCK,
-  LSE_CLOCK,
-  HSE_CLOCK
-} sourceClock_t;
-
 typedef void(*voidCallbackPtr)(void *);
 
 /* Exported constants --------------------------------------------------------*/
diff --git a/cores/arduino/stm32/uart.c b/cores/arduino/stm32/uart.c
@@ -328,18 +328,7 @@ void uart_init(serial_t *obj)
     /* If baudrate is lower than or equal to 9600 try to change to LSE */
     if(obj->baudrate <= 9600) {
       /* Enable the clock if not already set by user */
-      if(__HAL_RCC_GET_FLAG(RCC_FLAG_LSERDY) == RESET) {
-#ifdef __HAL_RCC_LSEDRIVE_CONFIG
-        __HAL_RCC_LSEDRIVE_CONFIG(RCC_LSEDRIVE_LOW);
-#endif
-        RCC_OscInitTypeDef RCC_OscInitStruct = {0};
-        RCC_OscInitStruct.OscillatorType =  RCC_OSCILLATORTYPE_LSE;
-        RCC_OscInitStruct.PLL.PLLState = RCC_PLL_NONE;
-        RCC_OscInitStruct.LSEState = RCC_LSE_ON;
-        if(HAL_RCC_OscConfig(&RCC_OscInitStruct) != HAL_OK) {
-          Error_Handler();
-        }
-      }
+      enableClock(LSE_CLOCK);
 
       __HAL_RCC_LPUART1_CONFIG(RCC_LPUART1CLKSOURCE_LSE);
       if (HAL_UART_Init(huart) == HAL_OK) {
@@ -496,17 +485,9 @@ void uart_config_lowpower(serial_t *obj)
   if(obj == NULL) {
     return;
   }
-  RCC_OscInitTypeDef RCC_OscInitStruct = {0};
   /* Ensure HSI clock is enable */
-  if(__HAL_RCC_GET_FLAG(RCC_FLAG_HSIRDY) == RESET) {
-    RCC_OscInitStruct.OscillatorType = RCC_OSCILLATORTYPE_HSI;
-    RCC_OscInitStruct.HSIState = RCC_HSI_ON;
-    RCC_OscInitStruct.HSICalibrationValue = RCC_HSICALIBRATION_DEFAULT;
-    RCC_OscInitStruct.PLL.PLLState = RCC_PLL_NONE;
-    if (HAL_RCC_OscConfig(&RCC_OscInitStruct)!= HAL_OK) {
-      Error_Handler();
-    }
-  }
+  enableClock(HSI_CLOCK);
+
   /* Configure HSI as source clock for low power wakeup clock */
   switch (obj->index) {
 #if defined(USART1_BASE)
