Arrow / Mbed OS DAPLink Reset
Embed: (wiki syntax)

« Back to documentation index

Time Base functions

Time Base functions
[TIM Exported 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 create the associated handle.
HAL_StatusTypeDef HAL_TIM_Base_DeInit (TIM_HandleTypeDef *htim)
 DeInitializes the TIM Base peripheral.
__weak void HAL_TIM_Base_MspInit (TIM_HandleTypeDef *htim)
 Initializes the TIM Base MSP.
__weak void HAL_TIM_Base_MspDeInit (TIM_HandleTypeDef *htim)
 DeInitializes TIM Base MSP.
HAL_StatusTypeDef HAL_TIM_Base_Start (TIM_HandleTypeDef *htim)
 Starts the TIM Base generation.
HAL_StatusTypeDef HAL_TIM_Base_Stop (TIM_HandleTypeDef *htim)
 Stops the TIM Base generation.
HAL_StatusTypeDef HAL_TIM_Base_Start_IT (TIM_HandleTypeDef *htim)
 Starts the TIM Base generation in interrupt mode.
HAL_StatusTypeDef HAL_TIM_Base_Stop_IT (TIM_HandleTypeDef *htim)
 Stops the TIM Base generation in interrupt mode.
HAL_StatusTypeDef HAL_TIM_Base_Start_DMA (TIM_HandleTypeDef *htim, uint32_t *pData, uint16_t Length)
 Starts the TIM Base generation in DMA mode.
HAL_StatusTypeDef HAL_TIM_Base_Stop_DMA (TIM_HandleTypeDef *htim)
 Stops the TIM Base generation in DMA mode.

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_StatusTypeDef HAL_TIM_Base_DeInit ( TIM_HandleTypeDef *  htim )

DeInitializes the TIM Base peripheral.

Parameters:
htim: TIM Base handle
Return values:
HALstatus

Definition at line 245 of file stm32f1xx_hal_tim.c.

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 create the associated handle.

Parameters:
htim: TIM Base handle
Return values:
HALstatus

Definition at line 206 of file stm32f1xx_hal_tim.c.

__weak void HAL_TIM_Base_MspDeInit ( TIM_HandleTypeDef *  htim )

DeInitializes TIM Base MSP.

Parameters:
htim: TIM handle
Return values:
None

Definition at line 286 of file stm32f1xx_hal_tim.c.

__weak void HAL_TIM_Base_MspInit ( TIM_HandleTypeDef *  htim )

Initializes the TIM Base MSP.

Parameters:
htim: TIM handle
Return values:
None

Definition at line 272 of file stm32f1xx_hal_tim.c.

HAL_StatusTypeDef HAL_TIM_Base_Start ( TIM_HandleTypeDef *  htim )

Starts the TIM Base generation.

Parameters:
htim: TIM handle
Return values:
HALstatus

Definition at line 301 of file stm32f1xx_hal_tim.c.

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 handle
pData: The source Buffer address.
Length: The length of data to be transferred from memory to peripheral.
Return values:
HALstatus

Definition at line 388 of file stm32f1xx_hal_tim.c.

HAL_StatusTypeDef HAL_TIM_Base_Start_IT ( TIM_HandleTypeDef *  htim )

Starts the TIM Base generation in interrupt mode.

Parameters:
htim: TIM handle
Return values:
HALstatus

Definition at line 347 of file stm32f1xx_hal_tim.c.

HAL_StatusTypeDef HAL_TIM_Base_Stop ( TIM_HandleTypeDef *  htim )

Stops the TIM Base generation.

Parameters:
htim: TIM handle
Return values:
HALstatus

Definition at line 324 of file stm32f1xx_hal_tim.c.

HAL_StatusTypeDef HAL_TIM_Base_Stop_DMA ( TIM_HandleTypeDef *  htim )

Stops the TIM Base generation in DMA mode.

Parameters:
htim: TIM handle
Return values:
HALstatus

Definition at line 432 of file stm32f1xx_hal_tim.c.

HAL_StatusTypeDef HAL_TIM_Base_Stop_IT ( TIM_HandleTypeDef *  htim )

Stops the TIM Base generation in interrupt mode.

Parameters:
htim: TIM handle
Return values:
HALstatus

Definition at line 367 of file stm32f1xx_hal_tim.c.