Merge pull request #7225 from bcostm/fix_hal_tick_comment

STM32: Add comments for HAL_InitTick function

Author: Cruz Monrreal

targets/TARGET_STM/hal_tick_16b.c

@@ -34,7 +34,8 @@ void timer_irq_handler(void)
 
 #if defined(TARGET_STM32F0)
 } // end timer_update_irq_handler function
-// Used for mbed timeout (channel 1) and HAL tick (channel 2)
+
+// Channel 1 used for mbed timeout
 void timer_oc_irq_handler(void)
 {
     TimMasterHandle.Instance = TIM_MST;
@@ -49,7 +50,12 @@ void timer_oc_irq_handler(void)
     }
 }
 
-// Reconfigure the HAL tick using a standard timer instead of systick.
+// Overwrite the default ST HAL function (defined as "weak") in order to configure an HW timer
+// used for mbed timeouts only (not used for the Systick configuration).
+// Additional notes:
+// - The default ST HAL_InitTick function initializes the Systick to 1 ms and this is not correct for mbed
+//   as the mbed Systick as to be configured to 1 us instead.
+// - Furthermore the Systick is configured by mbed RTOS directly.
 HAL_StatusTypeDef HAL_InitTick(uint32_t TickPriority)
 {
     // Enable timer clock

targets/TARGET_STM/hal_tick_32b.c

@@ -35,7 +35,12 @@ void timer_irq_handler(void)
     }
 }
 
-// Reconfigure the HAL tick using a standard timer instead of systick.
+// Overwrite the default ST HAL function (defined as "weak") in order to configure an HW timer
+// used for mbed timeouts only (not used for the Systick configuration).
+// Additional notes:
+// - The default ST HAL_InitTick function initializes the Systick to 1 ms and this is not correct for mbed
+//   as the mbed Systick as to be configured to 1 us instead.
+// - Furthermore the Systick is configured by mbed RTOS directly.
 HAL_StatusTypeDef HAL_InitTick(uint32_t TickPriority)
 {
     RCC_ClkInitTypeDef RCC_ClkInitStruct;