TIM Encoder functions

TIM Encoder functions. More...

Functions
HAL_StatusTypeDef	HAL_TIM_Encoder_Init (TIM_HandleTypeDef *htim, TIM_Encoder_InitTypeDef *sConfig)
	Initializes the TIM Encoder Interface and initialize the associated handle.
HAL_StatusTypeDef	HAL_TIM_Encoder_DeInit (TIM_HandleTypeDef *htim)
	DeInitializes the TIM Encoder interface.
__weak void	HAL_TIM_Encoder_MspInit (TIM_HandleTypeDef *htim)
	Initializes the TIM Encoder Interface MSP.
__weak void	HAL_TIM_Encoder_MspDeInit (TIM_HandleTypeDef *htim)
	DeInitializes TIM Encoder Interface MSP.
HAL_StatusTypeDef	HAL_TIM_Encoder_Start (TIM_HandleTypeDef *htim, uint32_t Channel)
	Starts the TIM Encoder Interface.
HAL_StatusTypeDef	HAL_TIM_Encoder_Stop (TIM_HandleTypeDef *htim, uint32_t Channel)
	Stops the TIM Encoder Interface.
HAL_StatusTypeDef	HAL_TIM_Encoder_Start_IT (TIM_HandleTypeDef *htim, uint32_t Channel)
	Starts the TIM Encoder Interface in interrupt mode.
HAL_StatusTypeDef	HAL_TIM_Encoder_Stop_IT (TIM_HandleTypeDef *htim, uint32_t Channel)
	Stops the TIM Encoder Interface in interrupt mode.
HAL_StatusTypeDef	HAL_TIM_Encoder_Start_DMA (TIM_HandleTypeDef *htim, uint32_t Channel, uint32_t *pData1, uint32_t *pData2, uint16_t Length)
	Starts the TIM Encoder Interface in DMA mode.
HAL_StatusTypeDef	HAL_TIM_Encoder_Stop_DMA (TIM_HandleTypeDef *htim, uint32_t Channel)
	Stops the TIM Encoder Interface in DMA mode.

---

Detailed Description

TIM Encoder functions.

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

---

Function Documentation

HAL_StatusTypeDef HAL_TIM_Encoder_DeInit

(

TIM_HandleTypeDef *

htim

)

DeInitializes the TIM Encoder interface.

Parameters:

htim	TIM Encoder Interface handle

Return values:

HAL

status

Definition at line 3126 of file stm32f4xx_hal_tim.c.

References __HAL_TIM_DISABLE, assert_param, __TIM_HandleTypeDef::DMABurstState, __TIM_HandleTypeDef::Encoder_MspDeInitCallback, HAL_DMA_BURST_STATE_RESET, HAL_TIM_CHANNEL_STATE_RESET, HAL_TIM_Encoder_MspDeInit(), HAL_TIM_STATE_BUSY, HAL_TIM_STATE_RESET, __TIM_HandleTypeDef::Instance, __TIM_HandleTypeDef::State, TIM_CHANNEL_1, TIM_CHANNEL_2, TIM_CHANNEL_N_STATE_SET, and TIM_CHANNEL_STATE_SET.

HAL_StatusTypeDef HAL_TIM_Encoder_Init	(	TIM_HandleTypeDef *	htim,
		TIM_Encoder_InitTypeDef *	sConfig
	)

Initializes the TIM Encoder Interface 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_Encoder_DeInit() before HAL_TIM_Encoder_Init()

Encoder mode and External clock mode 2 are not compatible and must not be selected together Ex: A call for HAL_TIM_Encoder_Init will erase the settings of HAL_TIM_ConfigClockSource using TIM_CLOCKSOURCE_ETRMODE2 and vice versa

When the timer instance is initialized in Encoder mode, timer channels 1 and channel 2 are reserved and cannot be used for other purpose.

Parameters:

htim	TIM Encoder Interface handle
sConfig	TIM Encoder Interface configuration structure

Return values:

HAL

status

Definition at line 3012 of file stm32f4xx_hal_tim.c.

References assert_param, TIM_Base_InitTypeDef::AutoReloadPreload, TIM_Base_InitTypeDef::ClockDivision, TIM_Base_InitTypeDef::CounterMode, __TIM_HandleTypeDef::DMABurstState, __TIM_HandleTypeDef::Encoder_MspInitCallback, TIM_Encoder_InitTypeDef::EncoderMode, HAL_DMA_BURST_STATE_READY, HAL_TIM_CHANNEL_STATE_READY, HAL_TIM_Encoder_MspInit(), HAL_TIM_STATE_BUSY, HAL_TIM_STATE_READY, HAL_TIM_STATE_RESET, TIM_Encoder_InitTypeDef::IC1Filter, TIM_Encoder_InitTypeDef::IC1Polarity, TIM_Encoder_InitTypeDef::IC1Prescaler, TIM_Encoder_InitTypeDef::IC1Selection, TIM_Encoder_InitTypeDef::IC2Filter, TIM_Encoder_InitTypeDef::IC2Polarity, TIM_Encoder_InitTypeDef::IC2Prescaler, TIM_Encoder_InitTypeDef::IC2Selection, __TIM_HandleTypeDef::Init, __TIM_HandleTypeDef::Instance, IS_TIM_AUTORELOAD_PRELOAD, IS_TIM_CLOCKDIVISION_DIV, IS_TIM_COUNTER_MODE, IS_TIM_ENCODER_MODE, IS_TIM_ENCODERINPUT_POLARITY, IS_TIM_IC_FILTER, IS_TIM_IC_PRESCALER, IS_TIM_IC_SELECTION, __TIM_HandleTypeDef::Lock, __TIM_HandleTypeDef::State, TIM_Base_SetConfig(), TIM_CHANNEL_1, TIM_CHANNEL_2, TIM_CHANNEL_N_STATE_SET, TIM_CHANNEL_STATE_SET, and TIM_ResetCallback().

void HAL_TIM_Encoder_MspDeInit

(

TIM_HandleTypeDef *

htim

)

DeInitializes TIM Encoder Interface MSP.

Parameters:

htim	TIM Encoder Interface handle

Return values:

None

Definition at line 3186 of file stm32f4xx_hal_tim.c.

Referenced by HAL_TIM_Encoder_DeInit(), and HAL_TIM_UnRegisterCallback().

void HAL_TIM_Encoder_MspInit

(

TIM_HandleTypeDef *

htim

)

Initializes the TIM Encoder Interface MSP.

Parameters:

htim	TIM Encoder Interface handle

Return values:

None

Definition at line 3171 of file stm32f4xx_hal_tim.c.

Referenced by HAL_TIM_Encoder_Init(), and HAL_TIM_UnRegisterCallback().

HAL_StatusTypeDef HAL_TIM_Encoder_Start	(	TIM_HandleTypeDef *	htim,
		uint32_t	Channel
	)

Starts the TIM Encoder Interface.

Parameters:

htim	TIM Encoder Interface 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_ALL: TIM Channel 1 and TIM Channel 2 are selected

Return values:

HAL

status

Definition at line 3206 of file stm32f4xx_hal_tim.c.

References __HAL_TIM_ENABLE, assert_param, HAL_TIM_CHANNEL_STATE_BUSY, HAL_TIM_CHANNEL_STATE_READY, __TIM_HandleTypeDef::Instance, TIM_CCx_ENABLE, TIM_CCxChannelCmd(), TIM_CHANNEL_1, TIM_CHANNEL_2, TIM_CHANNEL_N_STATE_GET, TIM_CHANNEL_N_STATE_SET, TIM_CHANNEL_STATE_GET, and TIM_CHANNEL_STATE_SET.

HAL_StatusTypeDef HAL_TIM_Encoder_Start_DMA	(	TIM_HandleTypeDef *	htim,
		uint32_t	Channel,
		uint32_t *	pData1,
		uint32_t *	pData2,
		uint16_t	Length
	)

Starts the TIM Encoder Interface in DMA mode.

Parameters:

htim	TIM Encoder Interface 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_ALL: TIM Channel 1 and TIM Channel 2 are selected
pData1	The destination Buffer address for IC1.
pData2	The destination Buffer address for IC2.
Length	The length of data to be transferred from TIM peripheral to memory.

Return values:

HAL

status

Definition at line 3525 of file stm32f4xx_hal_tim.c.

References __HAL_TIM_ENABLE, __HAL_TIM_ENABLE_DMA, assert_param, HAL_DMA_Start_IT(), HAL_TIM_CHANNEL_STATE_BUSY, HAL_TIM_CHANNEL_STATE_READY, __TIM_HandleTypeDef::hdma, __TIM_HandleTypeDef::Instance, TIM_CCx_ENABLE, TIM_CCxChannelCmd(), TIM_CHANNEL_1, TIM_CHANNEL_2, TIM_CHANNEL_N_STATE_GET, TIM_CHANNEL_N_STATE_SET, TIM_CHANNEL_STATE_GET, TIM_CHANNEL_STATE_SET, TIM_DMA_CC1, TIM_DMA_CC2, TIM_DMA_ID_CC1, TIM_DMA_ID_CC2, TIM_DMACaptureCplt(), TIM_DMACaptureHalfCplt(), TIM_DMAError(), __DMA_HandleTypeDef::XferCpltCallback, __DMA_HandleTypeDef::XferErrorCallback, and __DMA_HandleTypeDef::XferHalfCpltCallback.

HAL_StatusTypeDef HAL_TIM_Encoder_Start_IT	(	TIM_HandleTypeDef *	htim,
		uint32_t	Channel
	)

Starts the TIM Encoder Interface in interrupt mode.

Parameters:

htim	TIM Encoder Interface 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_ALL: TIM Channel 1 and TIM Channel 2 are selected

Return values:

HAL

status

Definition at line 3360 of file stm32f4xx_hal_tim.c.

References __HAL_TIM_ENABLE, __HAL_TIM_ENABLE_IT, assert_param, HAL_TIM_CHANNEL_STATE_BUSY, HAL_TIM_CHANNEL_STATE_READY, __TIM_HandleTypeDef::Instance, TIM_CCx_ENABLE, TIM_CCxChannelCmd(), TIM_CHANNEL_1, TIM_CHANNEL_2, TIM_CHANNEL_N_STATE_GET, TIM_CHANNEL_N_STATE_SET, TIM_CHANNEL_STATE_GET, TIM_CHANNEL_STATE_SET, TIM_IT_CC1, and TIM_IT_CC2.

HAL_StatusTypeDef HAL_TIM_Encoder_Stop	(	TIM_HandleTypeDef *	htim,
		uint32_t	Channel
	)

Stops the TIM Encoder Interface.

Parameters:

htim	TIM Encoder Interface 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_ALL: TIM Channel 1 and TIM Channel 2 are selected

Return values:

HAL

status

Definition at line 3300 of file stm32f4xx_hal_tim.c.

References __HAL_TIM_DISABLE, assert_param, HAL_TIM_CHANNEL_STATE_READY, __TIM_HandleTypeDef::Instance, TIM_CCx_DISABLE, TIM_CCxChannelCmd(), TIM_CHANNEL_1, TIM_CHANNEL_2, TIM_CHANNEL_N_STATE_SET, and TIM_CHANNEL_STATE_SET.

HAL_StatusTypeDef HAL_TIM_Encoder_Stop_DMA	(	TIM_HandleTypeDef *	htim,
		uint32_t	Channel
	)

Stops the TIM Encoder Interface in DMA mode.

Parameters:

htim	TIM Encoder Interface 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_ALL: TIM Channel 1 and TIM Channel 2 are selected

Return values:

HAL

status

Definition at line 3738 of file stm32f4xx_hal_tim.c.

References __HAL_TIM_DISABLE, __HAL_TIM_DISABLE_DMA, assert_param, HAL_DMA_Abort_IT(), HAL_TIM_CHANNEL_STATE_READY, __TIM_HandleTypeDef::hdma, __TIM_HandleTypeDef::Instance, TIM_CCx_DISABLE, TIM_CCxChannelCmd(), TIM_CHANNEL_1, TIM_CHANNEL_2, TIM_CHANNEL_N_STATE_SET, TIM_CHANNEL_STATE_SET, TIM_DMA_CC1, TIM_DMA_CC2, TIM_DMA_ID_CC1, and TIM_DMA_ID_CC2.

HAL_StatusTypeDef HAL_TIM_Encoder_Stop_IT	(	TIM_HandleTypeDef *	htim,
		uint32_t	Channel
	)

Stops the TIM Encoder Interface in interrupt mode.

Parameters:

htim	TIM Encoder Interface 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_ALL: TIM Channel 1 and TIM Channel 2 are selected

Return values:

HAL

status

Definition at line 3460 of file stm32f4xx_hal_tim.c.

References __HAL_TIM_DISABLE, __HAL_TIM_DISABLE_IT, assert_param, HAL_TIM_CHANNEL_STATE_READY, __TIM_HandleTypeDef::Instance, TIM_CCx_DISABLE, TIM_CCxChannelCmd(), TIM_CHANNEL_1, TIM_CHANNEL_2, TIM_CHANNEL_N_STATE_SET, TIM_CHANNEL_STATE_SET, TIM_IT_CC1, and TIM_IT_CC2.