STM32F4xx HAL Documentation: Extended Timer Hall Sensor functions

STM32F4xx HAL Documentation

Hardware Abstraction Layer for STM32F4 familiy

Loading...

Searching...

No Matches

Timer Hall Sensor functions. More...

Collaboration diagram for Extended Timer Hall Sensor functions:

Functions
HAL_StatusTypeDef	HAL_TIMEx_HallSensor_Init (TIM_HandleTypeDef htim, const TIM_HallSensor_InitTypeDef sConfig)
	Initializes the TIM Hall Sensor Interface and initialize the associated handle.

HAL_StatusTypeDef	HAL_TIMEx_HallSensor_DeInit (TIM_HandleTypeDef *htim)
	DeInitializes the TIM Hall Sensor interface.

void	HAL_TIMEx_HallSensor_MspInit (TIM_HandleTypeDef *htim)
	Initializes the TIM Hall Sensor MSP.

void	HAL_TIMEx_HallSensor_MspDeInit (TIM_HandleTypeDef *htim)
	DeInitializes TIM Hall Sensor MSP.

HAL_StatusTypeDef	HAL_TIMEx_HallSensor_Start (TIM_HandleTypeDef *htim)
	Starts the TIM Hall Sensor Interface.

HAL_StatusTypeDef	HAL_TIMEx_HallSensor_Stop (TIM_HandleTypeDef *htim)
	Stops the TIM Hall sensor Interface.

HAL_StatusTypeDef	HAL_TIMEx_HallSensor_Start_IT (TIM_HandleTypeDef *htim)
	Starts the TIM Hall Sensor Interface in interrupt mode.

HAL_StatusTypeDef	HAL_TIMEx_HallSensor_Stop_IT (TIM_HandleTypeDef *htim)
	Stops the TIM Hall Sensor Interface in interrupt mode.

HAL_StatusTypeDef	HAL_TIMEx_HallSensor_Start_DMA (TIM_HandleTypeDef htim, uint32_t pData, uint16_t Length)
	Starts the TIM Hall Sensor Interface in DMA mode.

HAL_StatusTypeDef	HAL_TIMEx_HallSensor_Stop_DMA (TIM_HandleTypeDef *htim)
	Stops the TIM Hall Sensor Interface in DMA mode.

Detailed Description

Timer Hall Sensor functions.

  ==============================================================================
                      ##### Timer Hall Sensor functions #####
  ==============================================================================
  [..]
    This section provides functions allowing to:
    (+) Initialize and configure TIM HAL Sensor.
    (+) De-initialize TIM HAL Sensor.
    (+) Start the Hall Sensor Interface.
    (+) Stop the Hall Sensor Interface.
    (+) Start the Hall Sensor Interface and enable interrupts.
    (+) Stop the Hall Sensor Interface and disable interrupts.
    (+) Start the Hall Sensor Interface and enable DMA transfers.
    (+) Stop the Hall Sensor Interface and disable DMA transfers.

Function Documentation

◆ HAL_TIMEx_HallSensor_Init()

HAL_StatusTypeDef HAL_TIMEx_HallSensor_Init	(	TIM_HandleTypeDef *	htim,
		const TIM_HallSensor_InitTypeDef *	sConfig )

#include <stm32f4xx_hal_tim_ex.h>

Initializes the TIM Hall Sensor Interface and initialize the associated handle.

Note: When the timer instance is initialized in Hall Sensor Interface mode, timer channels 1 and channel 2 are reserved and cannot be used for other purpose.

Parameters

htim	TIM Hall Sensor Interface handle
sConfig	TIM Hall Sensor configuration structure

Return values

HAL status

Definition at line 138 of file stm32f4xx_hal_tim_ex.c.

References assert_param, TIM_Base_InitTypeDef::AutoReloadPreload, TIM_Base_InitTypeDef::ClockDivision, TIM_HallSensor_InitTypeDef::Commutation_Delay, TIM_Base_InitTypeDef::CounterMode, TIM_HandleTypeDef::DMABurstState, HAL_DMA_BURST_STATE_READY, HAL_ERROR, HAL_OK, HAL_TIM_CHANNEL_STATE_READY, HAL_TIM_STATE_BUSY, HAL_TIM_STATE_READY, HAL_TIM_STATE_RESET, HAL_TIMEx_HallSensor_MspInit(), HAL_UNLOCKED, TIM_HallSensor_InitTypeDef::IC1Filter, TIM_HallSensor_InitTypeDef::IC1Polarity, TIM_HallSensor_InitTypeDef::IC1Prescaler, TIM_HandleTypeDef::Init, TIM_HandleTypeDef::Instance, IS_TIM_AUTORELOAD_PRELOAD, IS_TIM_CLOCKDIVISION_DIV, IS_TIM_COUNTER_MODE, IS_TIM_IC_FILTER, IS_TIM_IC_POLARITY, IS_TIM_IC_PRESCALER, IS_TIM_PERIOD, TIM_HandleTypeDef::Lock, TIM_OC_InitTypeDef::OCFastMode, TIM_OC_InitTypeDef::OCIdleState, TIM_OC_InitTypeDef::OCMode, TIM_OC_InitTypeDef::OCNIdleState, TIM_OC_InitTypeDef::OCNPolarity, TIM_OC_InitTypeDef::OCPolarity, TIM_Base_InitTypeDef::Period, TIM_OC_InitTypeDef::Pulse, TIM_HandleTypeDef::State, TIM_Base_SetConfig(), TIM_CHANNEL_1, TIM_CHANNEL_2, TIM_CHANNEL_N_STATE_SET, TIM_CHANNEL_STATE_SET, TIM_ICSELECTION_TRC, TIM_OC2_SetConfig(), TIM_OCFAST_DISABLE, TIM_OCIDLESTATE_RESET, TIM_OCMODE_PWM2, TIM_OCNIDLESTATE_RESET, TIM_OCNPOLARITY_HIGH, TIM_OCPOLARITY_HIGH, TIM_SLAVEMODE_RESET, TIM_TI1_SetConfig(), TIM_TRGO_OC2REF, and TIM_TS_TI1F_ED.

◆ HAL_TIMEx_HallSensor_DeInit()

HAL_StatusTypeDef HAL_TIMEx_HallSensor_DeInit ( TIM_HandleTypeDef * htim )

#include <stm32f4xx_hal_tim_ex.h>

DeInitializes the TIM Hall Sensor interface.

Parameters

htim	TIM Hall Sensor Interface handle

Return values

HAL status

Definition at line 240 of file stm32f4xx_hal_tim_ex.c.

References __HAL_TIM_DISABLE, __HAL_UNLOCK, assert_param, TIM_HandleTypeDef::DMABurstState, HAL_DMA_BURST_STATE_RESET, HAL_OK, HAL_TIM_CHANNEL_STATE_RESET, HAL_TIM_STATE_BUSY, HAL_TIM_STATE_RESET, HAL_TIMEx_HallSensor_MspDeInit(), TIM_HandleTypeDef::Instance, TIM_HandleTypeDef::State, TIM_CHANNEL_1, TIM_CHANNEL_2, TIM_CHANNEL_N_STATE_SET, and TIM_CHANNEL_STATE_SET.

◆ HAL_TIMEx_HallSensor_MspInit()

__weak void HAL_TIMEx_HallSensor_MspInit ( TIM_HandleTypeDef * htim )

#include <stm32f4xx_hal_tim_ex.h>

Initializes the TIM Hall Sensor MSP.

Parameters

htim	TIM Hall Sensor Interface handle

Return values

None

Definition at line 285 of file stm32f4xx_hal_tim_ex.c.

References UNUSED.

Referenced by HAL_TIMEx_HallSensor_Init().

◆ HAL_TIMEx_HallSensor_MspDeInit()

__weak void HAL_TIMEx_HallSensor_MspDeInit ( TIM_HandleTypeDef * htim )

#include <stm32f4xx_hal_tim_ex.h>

DeInitializes TIM Hall Sensor MSP.

Parameters

htim	TIM Hall Sensor Interface handle

Return values

None

Definition at line 300 of file stm32f4xx_hal_tim_ex.c.

References UNUSED.

Referenced by HAL_TIMEx_HallSensor_DeInit().

◆ HAL_TIMEx_HallSensor_Start()

HAL_StatusTypeDef HAL_TIMEx_HallSensor_Start ( TIM_HandleTypeDef * htim )

#include <stm32f4xx_hal_tim_ex.h>

Starts the TIM Hall Sensor Interface.

Parameters

htim	TIM Hall Sensor Interface handle

Return values

HAL status

Definition at line 315 of file stm32f4xx_hal_tim_ex.c.

References __HAL_TIM_ENABLE, assert_param, HAL_ERROR, HAL_OK, HAL_TIM_CHANNEL_STATE_BUSY, HAL_TIM_CHANNEL_STATE_READY, TIM_HandleTypeDef::Instance, IS_TIM_SLAVEMODE_TRIGGER_ENABLED, 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_TIMEx_HallSensor_Stop()

HAL_StatusTypeDef HAL_TIMEx_HallSensor_Stop ( TIM_HandleTypeDef * htim )

#include <stm32f4xx_hal_tim_ex.h>

Stops the TIM Hall sensor Interface.

Parameters

htim	TIM Hall Sensor Interface handle

Return values

HAL status

Definition at line 369 of file stm32f4xx_hal_tim_ex.c.

References __HAL_TIM_DISABLE, assert_param, HAL_OK, 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_TIMEx_HallSensor_Start_IT()

HAL_StatusTypeDef HAL_TIMEx_HallSensor_Start_IT ( TIM_HandleTypeDef * htim )

#include <stm32f4xx_hal_tim_ex.h>

Starts the TIM Hall Sensor Interface in interrupt mode.

Parameters

htim	TIM Hall Sensor Interface handle

Return values

HAL status

Definition at line 397 of file stm32f4xx_hal_tim_ex.c.

References __HAL_TIM_ENABLE, __HAL_TIM_ENABLE_IT, assert_param, HAL_ERROR, HAL_OK, HAL_TIM_CHANNEL_STATE_BUSY, HAL_TIM_CHANNEL_STATE_READY, TIM_HandleTypeDef::Instance, IS_TIM_SLAVEMODE_TRIGGER_ENABLED, 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, and TIM_IT_CC1.

◆ HAL_TIMEx_HallSensor_Stop_IT()

HAL_StatusTypeDef HAL_TIMEx_HallSensor_Stop_IT ( TIM_HandleTypeDef * htim )

#include <stm32f4xx_hal_tim_ex.h>

Stops the TIM Hall Sensor Interface in interrupt mode.

Parameters

htim	TIM Hall Sensor Interface handle

Return values

HAL status

Definition at line 454 of file stm32f4xx_hal_tim_ex.c.

References __HAL_TIM_DISABLE, __HAL_TIM_DISABLE_IT, assert_param, HAL_OK, 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, and TIM_IT_CC1.

◆ HAL_TIMEx_HallSensor_Start_DMA()

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

#include <stm32f4xx_hal_tim_ex.h>

Starts the TIM Hall Sensor Interface in DMA mode.

Parameters

htim	TIM Hall Sensor Interface handle
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 487 of file stm32f4xx_hal_tim_ex.c.

References __HAL_TIM_ENABLE, __HAL_TIM_ENABLE_DMA, assert_param, HAL_BUSY, HAL_DMA_Start_IT(), HAL_ERROR, HAL_OK, HAL_TIM_CHANNEL_STATE_BUSY, HAL_TIM_CHANNEL_STATE_READY, TIM_HandleTypeDef::hdma, TIM_HandleTypeDef::Instance, IS_TIM_SLAVEMODE_TRIGGER_ENABLED, TIM_CCx_ENABLE, TIM_CCxChannelCmd(), TIM_CHANNEL_1, TIM_CHANNEL_N_STATE_GET, TIM_CHANNEL_N_STATE_SET, TIM_CHANNEL_STATE_GET, TIM_CHANNEL_STATE_SET, TIM_DMA_CC1, TIM_DMA_ID_CC1, TIM_DMACaptureCplt(), TIM_DMACaptureHalfCplt(), TIM_DMAError(), __DMA_HandleTypeDef::XferCpltCallback, __DMA_HandleTypeDef::XferErrorCallback, and __DMA_HandleTypeDef::XferHalfCpltCallback.

◆ HAL_TIMEx_HallSensor_Stop_DMA()

HAL_StatusTypeDef HAL_TIMEx_HallSensor_Stop_DMA ( TIM_HandleTypeDef * htim )

#include <stm32f4xx_hal_tim_ex.h>

Stops the TIM Hall Sensor Interface in DMA mode.

Parameters

htim	TIM Hall Sensor Interface handle

Return values

HAL status

Definition at line 563 of file stm32f4xx_hal_tim_ex.c.

References __HAL_TIM_DISABLE, __HAL_TIM_DISABLE_DMA, assert_param, HAL_DMA_Abort_IT(), HAL_OK, HAL_TIM_CHANNEL_STATE_READY, TIM_HandleTypeDef::hdma, TIM_HandleTypeDef::Instance, TIM_CCx_DISABLE, TIM_CCxChannelCmd(), TIM_CHANNEL_1, TIM_CHANNEL_N_STATE_SET, TIM_CHANNEL_STATE_SET, TIM_DMA_CC1, and TIM_DMA_ID_CC1.

Generated on Wed Feb 26 2025 for STM32F4xx HAL Documentation by 1.12.0