TIM Input Capture functions. More...

Collaboration diagram for TIM Input Capture functions:

Functions
HAL_StatusTypeDef	HAL_TIM_IC_Init (TIM_HandleTypeDef *htim)
	Initializes the TIM Input Capture Time base according to the specified parameters in the TIM_HandleTypeDef and initializes the associated handle. More...

HAL_StatusTypeDef	HAL_TIM_IC_DeInit (TIM_HandleTypeDef *htim)
	DeInitializes the TIM peripheral. More...

void	HAL_TIM_IC_MspInit (TIM_HandleTypeDef *htim)
	Initializes the TIM Input Capture MSP. More...

void	HAL_TIM_IC_MspDeInit (TIM_HandleTypeDef *htim)
	DeInitializes TIM Input Capture MSP. More...

HAL_StatusTypeDef	HAL_TIM_IC_Start (TIM_HandleTypeDef *htim, uint32_t Channel)
	Starts the TIM Input Capture measurement. More...

HAL_StatusTypeDef	HAL_TIM_IC_Stop (TIM_HandleTypeDef *htim, uint32_t Channel)
	Stops the TIM Input Capture measurement. More...

HAL_StatusTypeDef	HAL_TIM_IC_Start_IT (TIM_HandleTypeDef *htim, uint32_t Channel)
	Starts the TIM Input Capture measurement in interrupt mode. More...

HAL_StatusTypeDef	HAL_TIM_IC_Stop_IT (TIM_HandleTypeDef *htim, uint32_t Channel)
	Stops the TIM Input Capture measurement in interrupt mode. More...

HAL_StatusTypeDef	HAL_TIM_IC_Start_DMA (TIM_HandleTypeDef htim, uint32_t Channel, uint32_t pData, uint16_t Length)
	Starts the TIM Input Capture measurement in DMA mode. More...

HAL_StatusTypeDef	HAL_TIM_IC_Stop_DMA (TIM_HandleTypeDef *htim, uint32_t Channel)
	Stops the TIM Input Capture measurement in DMA mode. More...

Detailed Description

TIM Input Capture functions.

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

Function Documentation

◆ HAL_TIM_IC_DeInit()

HAL_StatusTypeDef HAL_TIM_IC_DeInit ( TIM_HandleTypeDef * htim )

DeInitializes the TIM peripheral.

Parameters

htim	TIM Input Capture handle

Return values

HAL status

Definition at line 2039 of file stm32f4xx_hal_tim.c.

◆ HAL_TIM_IC_Init()

HAL_StatusTypeDef HAL_TIM_IC_Init ( TIM_HandleTypeDef * htim )

Initializes the TIM Input Capture Time base according to the specified parameters in the TIM_HandleTypeDef and initializes 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_IC_DeInit() before HAL_TIM_IC_Init()

Parameters

htim	TIM Input Capture handle

Return values

HAL status

Definition at line 1979 of file stm32f4xx_hal_tim.c.

◆ HAL_TIM_IC_MspDeInit()

__weak void HAL_TIM_IC_MspDeInit ( TIM_HandleTypeDef * htim )

DeInitializes TIM Input Capture MSP.

Parameters

htim	TIM handle

Return values

None

Definition at line 2097 of file stm32f4xx_hal_tim.c.

◆ HAL_TIM_IC_MspInit()

__weak void HAL_TIM_IC_MspInit ( TIM_HandleTypeDef * htim )

Initializes the TIM Input Capture MSP.

Parameters

htim	TIM Input Capture handle

Return values

None

Definition at line 2082 of file stm32f4xx_hal_tim.c.

◆ HAL_TIM_IC_Start()

HAL_StatusTypeDef HAL_TIM_IC_Start	(	TIM_HandleTypeDef *	htim,
		uint32_t	Channel
	)

Starts the TIM Input Capture measurement.

Parameters

htim	TIM Input Capture handle
Channel	TIM Channels to be enabled This parameter can be one of the following values: TIM_CHANNEL_1: TIM Channel 1 selected TIM_CHANNEL_2: TIM Channel 2 selected TIM_CHANNEL_3: TIM Channel 3 selected TIM_CHANNEL_4: TIM Channel 4 selected

Return values

HAL status

Definition at line 2118 of file stm32f4xx_hal_tim.c.

◆ HAL_TIM_IC_Start_DMA()

HAL_StatusTypeDef HAL_TIM_IC_Start_DMA	(	TIM_HandleTypeDef *	htim,
		uint32_t	Channel,
		uint32_t *	pData,
		uint16_t	Length
	)

Starts the TIM Input Capture measurement in DMA mode.

Parameters

htim	TIM Input Capture handle
Channel	TIM Channels to be enabled This parameter can be one of the following values: TIM_CHANNEL_1: TIM Channel 1 selected TIM_CHANNEL_2: TIM Channel 2 selected TIM_CHANNEL_3: TIM Channel 3 selected TIM_CHANNEL_4: TIM Channel 4 selected
pData	The destination Buffer address.
Length	The length of data to be transferred from TIM peripheral to memory.

Return values

HAL status

Definition at line 2364 of file stm32f4xx_hal_tim.c.

◆ HAL_TIM_IC_Start_IT()

HAL_StatusTypeDef HAL_TIM_IC_Start_IT	(	TIM_HandleTypeDef *	htim,
		uint32_t	Channel
	)

Starts the TIM Input Capture measurement in interrupt mode.

Parameters

htim	TIM Input Capture handle
Channel	TIM Channels to be enabled This parameter can be one of the following values: TIM_CHANNEL_1: TIM Channel 1 selected TIM_CHANNEL_2: TIM Channel 2 selected TIM_CHANNEL_3: TIM Channel 3 selected TIM_CHANNEL_4: TIM Channel 4 selected

Return values

HAL status

Definition at line 2200 of file stm32f4xx_hal_tim.c.

◆ HAL_TIM_IC_Stop()

HAL_StatusTypeDef HAL_TIM_IC_Stop	(	TIM_HandleTypeDef *	htim,
		uint32_t	Channel
	)

Stops the TIM Input Capture measurement.

Parameters

htim	TIM Input Capture handle
Channel	TIM Channels to be disabled This parameter can be one of the following values: TIM_CHANNEL_1: TIM Channel 1 selected TIM_CHANNEL_2: TIM Channel 2 selected TIM_CHANNEL_3: TIM Channel 3 selected TIM_CHANNEL_4: TIM Channel 4 selected

Return values

HAL status

Definition at line 2170 of file stm32f4xx_hal_tim.c.

◆ HAL_TIM_IC_Stop_DMA()

HAL_StatusTypeDef HAL_TIM_IC_Stop_DMA	(	TIM_HandleTypeDef *	htim,
		uint32_t	Channel
	)

Stops the TIM Input Capture measurement in DMA mode.

Parameters

htim	TIM Input Capture handle
Channel	TIM Channels to be disabled This parameter can be one of the following values: TIM_CHANNEL_1: TIM Channel 1 selected TIM_CHANNEL_2: TIM Channel 2 selected TIM_CHANNEL_3: TIM Channel 3 selected TIM_CHANNEL_4: TIM Channel 4 selected

Return values

HAL status

Definition at line 2523 of file stm32f4xx_hal_tim.c.

◆ HAL_TIM_IC_Stop_IT()

HAL_StatusTypeDef HAL_TIM_IC_Stop_IT	(	TIM_HandleTypeDef *	htim,
		uint32_t	Channel
	)

Stops the TIM Input Capture measurement in interrupt mode.

Parameters

htim	TIM Input Capture handle
Channel	TIM Channels to be disabled This parameter can be one of the following values: TIM_CHANNEL_1: TIM Channel 1 selected TIM_CHANNEL_2: TIM Channel 2 selected TIM_CHANNEL_3: TIM Channel 3 selected TIM_CHANNEL_4: TIM Channel 4 selected

Return values

HAL status

Definition at line 2292 of file stm32f4xx_hal_tim.c.

Functions

Detailed Description

Function Documentation

◆ HAL_TIM_IC_DeInit()

◆ HAL_TIM_IC_Init()

◆ HAL_TIM_IC_MspDeInit()

◆ HAL_TIM_IC_MspInit()

◆ HAL_TIM_IC_Start()

◆ HAL_TIM_IC_Start_DMA()

◆ HAL_TIM_IC_Start_IT()

◆ HAL_TIM_IC_Stop()

◆ HAL_TIM_IC_Stop_DMA()

◆ HAL_TIM_IC_Stop_IT()