stm32h7xx_hal_timebase_tim.c File Reference

HAL time base based on the hardware TIM. More...

#include "stm32h7xx_hal.h"
#include "stm32h7xx_hal_tim.h"

Include dependency graph for stm32h7xx_hal_timebase_tim.c:

Go to the source code of this file.

Functions
HAL_StatusTypeDef	HAL_InitTick (uint32_t TickPriority)
	This function configures the TIM4 as a time base source. The time source is configured to have 1ms time base with a dedicated Tick interrupt priority.
void	HAL_SuspendTick (void)
	Suspend Tick increment.
void	HAL_ResumeTick (void)
	Resume Tick increment.

Variables
TIM_HandleTypeDef	htim4

Detailed Description

HAL time base based on the hardware TIM.

Attention

Copyright (c) 2025 STMicroelectronics. All rights reserved.

This software is licensed under terms that can be found in the LICENSE file in the root directory of this software component. If no LICENSE file comes with this software, it is provided AS-IS.

Definition in file stm32h7xx_hal_timebase_tim.c.

Function Documentation

HAL_InitTick()

HAL_StatusTypeDef HAL_InitTick

(

uint32_t

TickPriority

)

This function configures the TIM4 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 41 of file stm32h7xx_hal_timebase_tim.c.

{
  RCC_ClkInitTypeDef    clkconfig;
  uint32_t              uwTimclock, uwAPB1Prescaler;
  uint32_t              uwPrescalerValue;
  uint32_t              pFLatency;
 
  /*Configure the TIM4 IRQ priority */
  if (TickPriority < (1UL << __NVIC_PRIO_BITS))
   {
     HAL_NVIC_SetPriority(TIM4_IRQn, TickPriority ,0);
 
     /* Enable the TIM4 global Interrupt */
     HAL_NVIC_EnableIRQ(TIM4_IRQn);
     uwTickPrio = TickPriority;
    }
  else
  {
    return HAL_ERROR;
  }
 
  /* Enable TIM4 clock */
  __HAL_RCC_TIM4_CLK_ENABLE();
 
  /* Get clock configuration */
  HAL_RCC_GetClockConfig(&clkconfig, &pFLatency);
 
  /* Get APB1 prescaler */
  uwAPB1Prescaler = clkconfig.APB1CLKDivider;
  /* Compute TIM4 clock */
  if (uwAPB1Prescaler == RCC_HCLK_DIV1)
  {
    uwTimclock = HAL_RCC_GetPCLK1Freq();
  }
  else
  {
    uwTimclock = 2UL * HAL_RCC_GetPCLK1Freq();
  }
 
  /* Compute the prescaler value to have TIM4 counter clock equal to 1MHz */
  uwPrescalerValue = (uint32_t) ((uwTimclock / 1000000U) - 1U);
 
  /* Initialize TIM4 */
  htim4.Instance = TIM4;
 
  /* Initialize TIMx peripheral as follow:
   * Period = [(TIM4CLK/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
   */
  htim4.Init.Period = (1000000U / 1000U) - 1U;
  htim4.Init.Prescaler = uwPrescalerValue;
  htim4.Init.ClockDivision = 0;
  htim4.Init.CounterMode = TIM_COUNTERMODE_UP;
 
  if(HAL_TIM_Base_Init(&htim4) == HAL_OK)
  {
    /* Start the TIM time Base generation in interrupt mode */
    return HAL_TIM_Base_Start_IT(&htim4);
  }
 
  /* Return function status */
  return HAL_ERROR;
}

References HAL_ERROR, HAL_OK, and htim4.

HAL_ResumeTick()

void HAL_ResumeTick

(

void

)

Resume Tick increment.

Note

Enable the tick increment by Enabling TIM4 update interrupt.

Parameters

None

Return values

None

Definition at line 125 of file stm32h7xx_hal_timebase_tim.c.

{
  /* Enable TIM4 Update interrupt */
  __HAL_TIM_ENABLE_IT(&htim4, TIM_IT_UPDATE);
}

References htim4.

HAL_SuspendTick()

void HAL_SuspendTick

(

void

)

Suspend Tick increment.

Note

Disable the tick increment by disabling TIM4 update interrupt.

Parameters

None

Return values

None

Definition at line 113 of file stm32h7xx_hal_timebase_tim.c.

{
  /* Disable TIM4 update Interrupt */
  __HAL_TIM_DISABLE_IT(&htim4, TIM_IT_UPDATE);
}

References htim4.

Variable Documentation

htim4

TIM_HandleTypeDef htim4

Definition at line 28 of file stm32h7xx_hal_timebase_tim.c.

Referenced by HAL_InitTick(), HAL_ResumeTick(), HAL_SuspendTick(), and TIM4_IRQHandler().