TIM Time Base functions

Time Base functions. More...

Functions
HAL_StatusTypeDef	HAL_TIM_Base_Init (TIM_HandleTypeDef *htim)
	Initializes the TIM Time base Unit according to the specified parameters in the TIM_HandleTypeDef and initialize the associated handle. More...
HAL_StatusTypeDef	HAL_TIM_Base_DeInit (TIM_HandleTypeDef *htim)
	DeInitializes the TIM Base peripheral. More...
void	HAL_TIM_Base_MspInit (TIM_HandleTypeDef *htim)
	Initializes the TIM Base MSP. More...
void	HAL_TIM_Base_MspDeInit (TIM_HandleTypeDef *htim)
	DeInitializes TIM Base MSP. More...
HAL_StatusTypeDef	HAL_TIM_Base_Start (TIM_HandleTypeDef *htim)
	Starts the TIM Base generation. More...
HAL_StatusTypeDef	HAL_TIM_Base_Stop (TIM_HandleTypeDef *htim)
	Stops the TIM Base generation. More...
HAL_StatusTypeDef	HAL_TIM_Base_Start_IT (TIM_HandleTypeDef *htim)
	Starts the TIM Base generation in interrupt mode. More...
HAL_StatusTypeDef	HAL_TIM_Base_Stop_IT (TIM_HandleTypeDef *htim)
	Stops the TIM Base generation in interrupt mode. More...
HAL_StatusTypeDef	HAL_TIM_Base_Start_DMA (TIM_HandleTypeDef *htim, uint32_t *pData, uint16_t Length)
	Starts the TIM Base generation in DMA mode. More...
HAL_StatusTypeDef	HAL_TIM_Base_Stop_DMA (TIM_HandleTypeDef *htim)
	Stops the TIM Base generation in DMA mode. More...

Detailed Description

Time Base functions.

  ==============================================================================
              ##### Time Base functions #####
  ==============================================================================
  [..]
    This section provides functions allowing to:
    (+) Initialize and configure the TIM base.
    (+) De-initialize the TIM base.
    (+) Start the Time Base.
    (+) Stop the Time Base.
    (+) Start the Time Base and enable interrupt.
    (+) Stop the Time Base and disable interrupt.
    (+) Start the Time Base and enable DMA transfer.
    (+) Stop the Time Base and disable DMA transfer.

Function Documentation

HAL_TIM_Base_DeInit()

HAL_StatusTypeDef HAL_TIM_Base_DeInit

(

TIM_HandleTypeDef *

htim

)

DeInitializes the TIM Base peripheral.

Parameters

htim	TIM Base handle

Return values

HAL

status

Definition at line 320 of file stm32l4xx_hal_tim.c.

{
  /* Check the parameters */
  assert_param(IS_TIM_INSTANCE(htim->Instance));

  htim->State = HAL_TIM_STATE_BUSY;

  /* Disable the TIM Peripheral Clock */
  __HAL_TIM_DISABLE(htim);

#if (USE_HAL_TIM_REGISTER_CALLBACKS == 1)
  if (htim->Base_MspDeInitCallback == NULL)
  {
    htim->Base_MspDeInitCallback = HAL_TIM_Base_MspDeInit;
  }
  /* DeInit the low level hardware */
  htim->Base_MspDeInitCallback(htim);
#else
  /* DeInit the low level hardware: GPIO, CLOCK, NVIC */
  HAL_TIM_Base_MspDeInit(htim);
#endif /* USE_HAL_TIM_REGISTER_CALLBACKS */

  /* Change TIM state */
  htim->State = HAL_TIM_STATE_RESET;

  /* Release Lock */
  __HAL_UNLOCK(htim);

  return HAL_OK;
}

HAL_TIM_Base_Init()

HAL_StatusTypeDef HAL_TIM_Base_Init

(

TIM_HandleTypeDef *

htim

)

Initializes the TIM Time base Unit according to the specified parameters in the TIM_HandleTypeDef and initialize the associated handle.

Note

Switching from Center Aligned counter mode to Edge counter mode (or reverse) requires a timer reset to avoid unexpected direction due to DIR bit readonly in center aligned mode. Ex: call HAL_TIM_Base_DeInit() before HAL_TIM_Base_Init()

Parameters

htim	TIM Base handle

Return values

HAL

status

Definition at line 268 of file stm32l4xx_hal_tim.c.

{
  /* Check the TIM handle allocation */
  if (htim == NULL)
  {
    return HAL_ERROR;
  }

  /* Check the parameters */
  assert_param(IS_TIM_INSTANCE(htim->Instance));
  assert_param(IS_TIM_COUNTER_MODE(htim->Init.CounterMode));
  assert_param(IS_TIM_CLOCKDIVISION_DIV(htim->Init.ClockDivision));
  assert_param(IS_TIM_AUTORELOAD_PRELOAD(htim->Init.AutoReloadPreload));

  if (htim->State == HAL_TIM_STATE_RESET)
  {
    /* Allocate lock resource and initialize it */
    htim->Lock = HAL_UNLOCKED;

#if (USE_HAL_TIM_REGISTER_CALLBACKS == 1)
    /* Reset interrupt callbacks to legacy weak callbacks */
    TIM_ResetCallback(htim);

    if (htim->Base_MspInitCallback == NULL)
    {
      htim->Base_MspInitCallback = HAL_TIM_Base_MspInit;
    }
    /* Init the low level hardware : GPIO, CLOCK, NVIC */
    htim->Base_MspInitCallback(htim);
#else
    /* Init the low level hardware : GPIO, CLOCK, NVIC */
    HAL_TIM_Base_MspInit(htim);
#endif /* USE_HAL_TIM_REGISTER_CALLBACKS */
  }

  /* Set the TIM state */
  htim->State = HAL_TIM_STATE_BUSY;

  /* Set the Time Base configuration */
  TIM_Base_SetConfig(htim->Instance, &htim->Init);

  /* Initialize the TIM state*/
  htim->State = HAL_TIM_STATE_READY;

  return HAL_OK;
}

HAL_TIM_Base_MspDeInit()

__weak void HAL_TIM_Base_MspDeInit

(

TIM_HandleTypeDef *

htim

)

DeInitializes TIM Base MSP.

Parameters

htim	TIM Base handle

Return values

None

Definition at line 371 of file stm32l4xx_hal_tim.c.

{
  /* Prevent unused argument(s) compilation warning */
  UNUSED(htim);

  /* NOTE : This function should not be modified, when the callback is needed,
            the HAL_TIM_Base_MspDeInit could be implemented in the user file
   */
}

HAL_TIM_Base_MspInit()

__weak void HAL_TIM_Base_MspInit

(

TIM_HandleTypeDef *

htim

)

Initializes the TIM Base MSP.

Parameters

htim	TIM Base handle

Return values

None

Definition at line 356 of file stm32l4xx_hal_tim.c.

{
  /* Prevent unused argument(s) compilation warning */
  UNUSED(htim);

  /* NOTE : This function should not be modified, when the callback is needed,
            the HAL_TIM_Base_MspInit could be implemented in the user file
   */
}

HAL_TIM_Base_Start()

HAL_StatusTypeDef HAL_TIM_Base_Start

(

TIM_HandleTypeDef *

htim

)

Starts the TIM Base generation.

Parameters

htim	TIM Base handle

Return values

HAL

status

Definition at line 387 of file stm32l4xx_hal_tim.c.

{
  uint32_t tmpsmcr;

  /* Check the parameters */
  assert_param(IS_TIM_INSTANCE(htim->Instance));

  /* Set the TIM state */
  htim->State = HAL_TIM_STATE_BUSY;

  /* Enable the Peripheral, except in trigger mode where enable is automatically done with trigger */
  tmpsmcr = htim->Instance->SMCR & TIM_SMCR_SMS;
  if (!IS_TIM_SLAVEMODE_TRIGGER_ENABLED(tmpsmcr))
  {
    __HAL_TIM_ENABLE(htim);
  }

  /* Change the TIM state*/
  htim->State = HAL_TIM_STATE_READY;

  /* Return function status */
  return HAL_OK;
}

HAL_TIM_Base_Start_DMA()

HAL_StatusTypeDef HAL_TIM_Base_Start_DMA	(	TIM_HandleTypeDef *	htim,
		uint32_t *	pData,
		uint16_t	Length
	)

Starts the TIM Base generation in DMA mode.

Parameters

htim	TIM Base handle
pData	The source Buffer address.
Length	The length of data to be transferred from memory to peripheral.

Return values

HAL

status

Definition at line 486 of file stm32l4xx_hal_tim.c.

{
  uint32_t tmpsmcr;

  /* Check the parameters */
  assert_param(IS_TIM_DMA_INSTANCE(htim->Instance));

  if ((htim->State == HAL_TIM_STATE_BUSY))
  {
    return HAL_BUSY;
  }
  else if ((htim->State == HAL_TIM_STATE_READY))
  {
    if ((pData == NULL) && (Length > 0U))
    {
      return HAL_ERROR;
    }
    else
    {
      htim->State = HAL_TIM_STATE_BUSY;
    }
  }
  else
  {
    /* nothing to do */
  }

  /* Set the DMA Period elapsed callbacks */
  htim->hdma[TIM_DMA_ID_UPDATE]->XferCpltCallback = TIM_DMAPeriodElapsedCplt;
  htim->hdma[TIM_DMA_ID_UPDATE]->XferHalfCpltCallback = TIM_DMAPeriodElapsedHalfCplt;

  /* Set the DMA error callback */
  htim->hdma[TIM_DMA_ID_UPDATE]->XferErrorCallback = TIM_DMAError ;

  /* Enable the DMA channel */
  if (HAL_DMA_Start_IT(htim->hdma[TIM_DMA_ID_UPDATE], (uint32_t)pData, (uint32_t)&htim->Instance->ARR, Length) != HAL_OK)
  {
    return HAL_ERROR;
  }

  /* Enable the TIM Update DMA request */
  __HAL_TIM_ENABLE_DMA(htim, TIM_DMA_UPDATE);

  /* Enable the Peripheral, except in trigger mode where enable is automatically done with trigger */
  tmpsmcr = htim->Instance->SMCR & TIM_SMCR_SMS;
  if (!IS_TIM_SLAVEMODE_TRIGGER_ENABLED(tmpsmcr))
  {
    __HAL_TIM_ENABLE(htim);
  }

  /* Return function status */
  return HAL_OK;
}

HAL_TIM_Base_Start_IT()

HAL_StatusTypeDef HAL_TIM_Base_Start_IT

(

TIM_HandleTypeDef *

htim

)

Starts the TIM Base generation in interrupt mode.

Parameters

htim	TIM Base handle

Return values

HAL

status

Definition at line 439 of file stm32l4xx_hal_tim.c.

{
  uint32_t tmpsmcr;

  /* Check the parameters */
  assert_param(IS_TIM_INSTANCE(htim->Instance));

  /* Enable the TIM Update interrupt */
  __HAL_TIM_ENABLE_IT(htim, TIM_IT_UPDATE);

  /* Enable the Peripheral, except in trigger mode where enable is automatically done with trigger */
  tmpsmcr = htim->Instance->SMCR & TIM_SMCR_SMS;
  if (!IS_TIM_SLAVEMODE_TRIGGER_ENABLED(tmpsmcr))
  {
    __HAL_TIM_ENABLE(htim);
  }

  /* Return function status */
  return HAL_OK;
}

HAL_TIM_Base_Stop()

HAL_StatusTypeDef HAL_TIM_Base_Stop

(

TIM_HandleTypeDef *

htim

)

Stops the TIM Base generation.

Parameters

htim	TIM Base handle

Return values

HAL

status

Definition at line 416 of file stm32l4xx_hal_tim.c.

{
  /* Check the parameters */
  assert_param(IS_TIM_INSTANCE(htim->Instance));

  /* Set the TIM state */
  htim->State = HAL_TIM_STATE_BUSY;

  /* Disable the Peripheral */
  __HAL_TIM_DISABLE(htim);

  /* Change the TIM state*/
  htim->State = HAL_TIM_STATE_READY;

  /* Return function status */
  return HAL_OK;
}

HAL_TIM_Base_Stop_DMA()

HAL_StatusTypeDef HAL_TIM_Base_Stop_DMA

(

TIM_HandleTypeDef *

htim

)

Stops the TIM Base generation in DMA mode.

Parameters

htim	TIM Base handle

Return values

HAL

status

Definition at line 545 of file stm32l4xx_hal_tim.c.

{
  /* Check the parameters */
  assert_param(IS_TIM_DMA_INSTANCE(htim->Instance));

  /* Disable the TIM Update DMA request */
  __HAL_TIM_DISABLE_DMA(htim, TIM_DMA_UPDATE);

  (void)HAL_DMA_Abort_IT(htim->hdma[TIM_DMA_ID_UPDATE]);

  /* Disable the Peripheral */
  __HAL_TIM_DISABLE(htim);

  /* Change the htim state */
  htim->State = HAL_TIM_STATE_READY;

  /* Return function status */
  return HAL_OK;
}

HAL_TIM_Base_Stop_IT()

HAL_StatusTypeDef HAL_TIM_Base_Stop_IT

(

TIM_HandleTypeDef *

htim

)

Stops the TIM Base generation in interrupt mode.

Parameters

htim	TIM Base handle

Return values

HAL

status

Definition at line 465 of file stm32l4xx_hal_tim.c.

{
  /* Check the parameters */
  assert_param(IS_TIM_INSTANCE(htim->Instance));
  /* Disable the TIM Update interrupt */
  __HAL_TIM_DISABLE_IT(htim, TIM_IT_UPDATE);

  /* Disable the Peripheral */
  __HAL_TIM_DISABLE(htim);

  /* Return function status */
  return HAL_OK;
}