HAL_TimeBase

Functions
void	TIM6_DAC_IRQHandler (void)
	This function handles TIM interrupt request. More...
HAL_StatusTypeDef	HAL_InitTick (uint32_t TickPriority)
	This function configures the TIM6 as a time base source. The time source is configured to have 1ms time base with a dedicated Tick interrupt priority. More...
void	HAL_SuspendTick (void)
	Suspend Tick increment. More...
void	HAL_ResumeTick (void)
	Resume Tick increment. More...
void	HAL_TIM_PeriodElapsedCallback (TIM_HandleTypeDef *htim)
	Period elapsed callback in non blocking mode. More...

Variables
TIM_HandleTypeDef	TimHandle

Detailed Description

Function Documentation

HAL_InitTick()

HAL_StatusTypeDef HAL_InitTick

(

uint32_t

TickPriority

)

This function configures the TIM6 as a time base source. The time source is configured to have 1ms time base with a dedicated Tick interrupt priority.

Note

This function is called automatically at the beginning of program after reset by HAL_Init() or at any time when clock is configured, by HAL_RCC_ClockConfig().

Parameters

TickPriority

Tick interrupt priority.

Return values

HAL

status

Definition at line 70 of file stm32l4xx_hal_timebase_tim_template.c.

{
  RCC_ClkInitTypeDef    clkconfig;
  uint32_t              uwTimclock, uwAPB1Prescaler = 0U;
  uint32_t              uwPrescalerValue = 0U;
  uint32_t              pFLatency;
  
  /* Configure the TIM6 IRQ priority */
  HAL_NVIC_SetPriority(TIM6_DAC_IRQn, TickPriority, 0U);
  
  /* Enable the TIM6 global Interrupt */
  HAL_NVIC_EnableIRQ(TIM6_DAC_IRQn);
  
  /* Enable TIM6 clock */
  __HAL_RCC_TIM6_CLK_ENABLE();
  
  /* Get clock configuration */
  HAL_RCC_GetClockConfig(&clkconfig, &pFLatency);
  
  /* Get APB1 prescaler */
  uwAPB1Prescaler = clkconfig.APB1CLKDivider;
  
  /* Compute TIM6 clock */
  if (uwAPB1Prescaler == RCC_HCLK_DIV1) 
  {
    uwTimclock = HAL_RCC_GetPCLK1Freq();
  }
  else
  {
    uwTimclock = 2*HAL_RCC_GetPCLK1Freq();
  }
  
  /* Compute the prescaler value to have TIM6 counter clock equal to 1MHz */
  uwPrescalerValue = (uint32_t) ((uwTimclock / 1000000U) - 1U);
  
  /* Initialize TIM6 */
  TimHandle.Instance = TIM6;
  
  /* Initialize TIMx peripheral as follow:
  + Period = [(TIM6CLK/1000) - 1]. to have a (1/1000) s time base.
  + Prescaler = (uwTimclock/1000000 - 1) to have a 1MHz counter clock.
  + ClockDivision = 0
  + Counter direction = Up
  */
  TimHandle.Init.Period = (1000000U / 1000U) - 1U;
  TimHandle.Init.Prescaler = uwPrescalerValue;
  TimHandle.Init.ClockDivision = 0;
  TimHandle.Init.CounterMode = TIM_COUNTERMODE_UP;
  TimHandle.Init.AutoReloadPreload = TIM_AUTORELOAD_PRELOAD_DISABLE;
  if(HAL_TIM_Base_Init(&TimHandle) == HAL_OK)
  {
    /* Start the TIM time Base generation in interrupt mode */
    return HAL_TIM_Base_Start_IT(&TimHandle);
  }
  
  /* Return function status */
  return HAL_ERROR;
}

HAL_ResumeTick()

void HAL_ResumeTick

(

void

)

Resume Tick increment.

Note

Enable the tick increment by enabling TIM6 update interrupt.

Parameters

None

Return values

None

Definition at line 147 of file stm32l4xx_hal_timebase_tim_template.c.

{
  /* Enable TIM6 update interrupt */
  __HAL_TIM_ENABLE_IT(&TimHandle, TIM_IT_UPDATE);
}

HAL_SuspendTick()

void HAL_SuspendTick

(

void

)

Suspend Tick increment.

Note

Disable the tick increment by disabling TIM6 update interrupt.

Parameters

None

Return values

None

Definition at line 135 of file stm32l4xx_hal_timebase_tim_template.c.

{
  /* Disable TIM6 update interrupt */
  __HAL_TIM_DISABLE_IT(&TimHandle, TIM_IT_UPDATE);
}

HAL_TIM_PeriodElapsedCallback()

void HAL_TIM_PeriodElapsedCallback

(

TIM_HandleTypeDef *

htim

)

Period elapsed callback in non blocking mode.

Note

This function is called when TIM6 interrupt took place, inside HAL_TIM_IRQHandler(). It makes a direct call to HAL_IncTick() to increment a global variable "uwTick" used as application time base.

Parameters

htim	: TIM handle

Return values

None

Definition at line 161 of file stm32l4xx_hal_timebase_tim_template.c.

{
  HAL_IncTick();
}

TIM6_DAC_IRQHandler()

void TIM6_DAC_IRQHandler

(

void

)

This function handles TIM interrupt request.

Parameters

None

Return values

None

Definition at line 171 of file stm32l4xx_hal_timebase_tim_template.c.

{
  HAL_TIM_IRQHandler(&TimHandle);
}

Variable Documentation

TimHandle

TIM_HandleTypeDef TimHandle

Definition at line 56 of file stm32l4xx_hal_timebase_tim_template.c.