TIM Callbacks functions

TIM Callbacks functions. More...

Collaboration diagram for TIM Callbacks functions:

Functions
void	HAL_TIM_PeriodElapsedCallback (TIM_HandleTypeDef *htim)
	Period elapsed callback in non-blocking mode. More...
void	HAL_TIM_PeriodElapsedHalfCpltCallback (TIM_HandleTypeDef *htim)
	Period elapsed half complete callback in non-blocking mode. More...
void	HAL_TIM_OC_DelayElapsedCallback (TIM_HandleTypeDef *htim)
	Output Compare callback in non-blocking mode. More...
void	HAL_TIM_IC_CaptureCallback (TIM_HandleTypeDef *htim)
	Input Capture callback in non-blocking mode. More...
void	HAL_TIM_IC_CaptureHalfCpltCallback (TIM_HandleTypeDef *htim)
	Input Capture half complete callback in non-blocking mode. More...
void	HAL_TIM_PWM_PulseFinishedCallback (TIM_HandleTypeDef *htim)
	PWM Pulse finished callback in non-blocking mode. More...
void	HAL_TIM_PWM_PulseFinishedHalfCpltCallback (TIM_HandleTypeDef *htim)
	PWM Pulse finished half complete callback in non-blocking mode. More...
void	HAL_TIM_TriggerCallback (TIM_HandleTypeDef *htim)
	Hall Trigger detection callback in non-blocking mode. More...
void	HAL_TIM_TriggerHalfCpltCallback (TIM_HandleTypeDef *htim)
	Hall Trigger detection half complete callback in non-blocking mode. More...
void	HAL_TIM_ErrorCallback (TIM_HandleTypeDef *htim)
	Timer error callback in non-blocking mode. More...
HAL_StatusTypeDef	HAL_TIM_RegisterCallback (TIM_HandleTypeDef *htim, HAL_TIM_CallbackIDTypeDef CallbackID, pTIM_CallbackTypeDef pCallback)
	Register a User TIM callback to be used instead of the weak predefined callback. More...
HAL_StatusTypeDef	HAL_TIM_UnRegisterCallback (TIM_HandleTypeDef *htim, HAL_TIM_CallbackIDTypeDef CallbackID)
	Unregister a TIM callback TIM callback is redirected to the weak predefined callback. More...

Detailed Description

TIM Callbacks functions.

  ==============================================================================
                        ##### TIM Callbacks functions #####
  ==============================================================================
 [..]
   This section provides TIM callback functions:
   (+) TIM Period elapsed callback
   (+) TIM Output Compare callback
   (+) TIM Input capture callback
   (+) TIM Trigger callback
   (+) TIM Error callback

Function Documentation

HAL_TIM_ErrorCallback()

__weak void HAL_TIM_ErrorCallback

(

TIM_HandleTypeDef *

htim

)

Timer error callback in non-blocking mode.

Parameters

htim	TIM handle

Return values

None

Definition at line 5792 of file stm32f4xx_hal_tim.c.

HAL_TIM_IC_CaptureCallback()

__weak void HAL_TIM_IC_CaptureCallback

(

TIM_HandleTypeDef *

htim

)

Input Capture callback in non-blocking mode.

Parameters

htim	TIM IC handle

Return values

None

Definition at line 5702 of file stm32f4xx_hal_tim.c.

HAL_TIM_IC_CaptureHalfCpltCallback()

__weak void HAL_TIM_IC_CaptureHalfCpltCallback

(

TIM_HandleTypeDef *

htim

)

Input Capture half complete callback in non-blocking mode.

Parameters

htim	TIM IC handle

Return values

None

Definition at line 5717 of file stm32f4xx_hal_tim.c.

HAL_TIM_OC_DelayElapsedCallback()

__weak void HAL_TIM_OC_DelayElapsedCallback

(

TIM_HandleTypeDef *

htim

)

Output Compare callback in non-blocking mode.

Parameters

htim	TIM OC handle

Return values

None

Definition at line 5687 of file stm32f4xx_hal_tim.c.

HAL_TIM_PeriodElapsedCallback()

__weak void HAL_TIM_PeriodElapsedCallback

(

TIM_HandleTypeDef *

htim

)

Period elapsed callback in non-blocking mode.

Parameters

htim	TIM handle

Return values

None

Definition at line 5657 of file stm32f4xx_hal_tim.c.

HAL_TIM_PeriodElapsedHalfCpltCallback()

__weak void HAL_TIM_PeriodElapsedHalfCpltCallback

(

TIM_HandleTypeDef *

htim

)

Period elapsed half complete callback in non-blocking mode.

Parameters

htim	TIM handle

Return values

None

Definition at line 5672 of file stm32f4xx_hal_tim.c.

HAL_TIM_PWM_PulseFinishedCallback()

__weak void HAL_TIM_PWM_PulseFinishedCallback

(

TIM_HandleTypeDef *

htim

)

PWM Pulse finished callback in non-blocking mode.

Parameters

htim	TIM handle

Return values

None

Definition at line 5732 of file stm32f4xx_hal_tim.c.

HAL_TIM_PWM_PulseFinishedHalfCpltCallback()

__weak void HAL_TIM_PWM_PulseFinishedHalfCpltCallback

(

TIM_HandleTypeDef *

htim

)

PWM Pulse finished half complete callback in non-blocking mode.

Parameters

htim	TIM handle

Return values

None

Definition at line 5747 of file stm32f4xx_hal_tim.c.

HAL_TIM_RegisterCallback()

HAL_StatusTypeDef HAL_TIM_RegisterCallback	(	TIM_HandleTypeDef *	htim,
		HAL_TIM_CallbackIDTypeDef	CallbackID,
		pTIM_CallbackTypeDef	pCallback
	)

Register a User TIM callback to be used instead of the weak predefined callback.

Parameters

htim	tim handle
CallbackID	ID of the callback to be registered This parameter can be one of the following values: HAL_TIM_BASE_MSPINIT_CB_ID Base MspInit Callback ID HAL_TIM_BASE_MSPDEINIT_CB_ID Base MspDeInit Callback ID HAL_TIM_IC_MSPINIT_CB_ID IC MspInit Callback ID HAL_TIM_IC_MSPDEINIT_CB_ID IC MspDeInit Callback ID HAL_TIM_OC_MSPINIT_CB_ID OC MspInit Callback ID HAL_TIM_OC_MSPDEINIT_CB_ID OC MspDeInit Callback ID HAL_TIM_PWM_MSPINIT_CB_ID PWM MspInit Callback ID HAL_TIM_PWM_MSPDEINIT_CB_ID PWM MspDeInit Callback ID HAL_TIM_ONE_PULSE_MSPINIT_CB_ID One Pulse MspInit Callback ID HAL_TIM_ONE_PULSE_MSPDEINIT_CB_ID One Pulse MspDeInit Callback ID HAL_TIM_ENCODER_MSPINIT_CB_ID Encoder MspInit Callback ID HAL_TIM_ENCODER_MSPDEINIT_CB_ID Encoder MspDeInit Callback ID HAL_TIM_HALL_SENSOR_MSPINIT_CB_ID Hall Sensor MspInit Callback ID HAL_TIM_HALL_SENSOR_MSPDEINIT_CB_ID Hall Sensor MspDeInit Callback ID HAL_TIM_PERIOD_ELAPSED_CB_ID Period Elapsed Callback ID HAL_TIM_PERIOD_ELAPSED_HALF_CB_ID Period Elapsed half complete Callback ID HAL_TIM_TRIGGER_CB_ID Trigger Callback ID HAL_TIM_TRIGGER_HALF_CB_ID Trigger half complete Callback ID HAL_TIM_IC_CAPTURE_CB_ID Input Capture Callback ID HAL_TIM_IC_CAPTURE_HALF_CB_ID Input Capture half complete Callback ID HAL_TIM_OC_DELAY_ELAPSED_CB_ID Output Compare Delay Elapsed Callback ID HAL_TIM_PWM_PULSE_FINISHED_CB_ID PWM Pulse Finished Callback ID HAL_TIM_PWM_PULSE_FINISHED_HALF_CB_ID PWM Pulse Finished half complete Callback ID HAL_TIM_ERROR_CB_ID Error Callback ID HAL_TIM_COMMUTATION_CB_ID Commutation Callback ID HAL_TIM_COMMUTATION_HALF_CB_ID Commutation half complete Callback ID HAL_TIM_BREAK_CB_ID Break Callback ID
pCallback	pointer to the callback function

Return values

status

Definition at line 5838 of file stm32f4xx_hal_tim.c.

HAL_TIM_TriggerCallback()

__weak void HAL_TIM_TriggerCallback

(

TIM_HandleTypeDef *

htim

)

Hall Trigger detection callback in non-blocking mode.

Parameters

htim	TIM handle

Return values

None

Definition at line 5762 of file stm32f4xx_hal_tim.c.

HAL_TIM_TriggerHalfCpltCallback()

__weak void HAL_TIM_TriggerHalfCpltCallback

(

TIM_HandleTypeDef *

htim

)

Hall Trigger detection half complete callback in non-blocking mode.

Parameters

htim	TIM handle

Return values

None

Definition at line 5777 of file stm32f4xx_hal_tim.c.

HAL_TIM_UnRegisterCallback()

HAL_StatusTypeDef HAL_TIM_UnRegisterCallback	(	TIM_HandleTypeDef *	htim,
		HAL_TIM_CallbackIDTypeDef	CallbackID
	)

Unregister a TIM callback TIM callback is redirected to the weak predefined callback.

Parameters

htim

tim handle

CallbackID

ID of the callback to be unregistered This parameter can be one of the following values: HAL_TIM_BASE_MSPINIT_CB_ID Base MspInit Callback ID HAL_TIM_BASE_MSPDEINIT_CB_ID Base MspDeInit Callback ID HAL_TIM_IC_MSPINIT_CB_ID IC MspInit Callback ID HAL_TIM_IC_MSPDEINIT_CB_ID IC MspDeInit Callback ID HAL_TIM_OC_MSPINIT_CB_ID OC MspInit Callback ID HAL_TIM_OC_MSPDEINIT_CB_ID OC MspDeInit Callback ID HAL_TIM_PWM_MSPINIT_CB_ID PWM MspInit Callback ID HAL_TIM_PWM_MSPDEINIT_CB_ID PWM MspDeInit Callback ID HAL_TIM_ONE_PULSE_MSPINIT_CB_ID One Pulse MspInit Callback ID HAL_TIM_ONE_PULSE_MSPDEINIT_CB_ID One Pulse MspDeInit Callback ID HAL_TIM_ENCODER_MSPINIT_CB_ID Encoder MspInit Callback ID HAL_TIM_ENCODER_MSPDEINIT_CB_ID Encoder MspDeInit Callback ID HAL_TIM_HALL_SENSOR_MSPINIT_CB_ID Hall Sensor MspInit Callback ID HAL_TIM_HALL_SENSOR_MSPDEINIT_CB_ID Hall Sensor MspDeInit Callback ID HAL_TIM_PERIOD_ELAPSED_CB_ID Period Elapsed Callback ID HAL_TIM_PERIOD_ELAPSED_HALF_CB_ID Period Elapsed half complete Callback ID HAL_TIM_TRIGGER_CB_ID Trigger Callback ID HAL_TIM_TRIGGER_HALF_CB_ID Trigger half complete Callback ID HAL_TIM_IC_CAPTURE_CB_ID Input Capture Callback ID HAL_TIM_IC_CAPTURE_HALF_CB_ID Input Capture half complete Callback ID HAL_TIM_OC_DELAY_ELAPSED_CB_ID Output Compare Delay Elapsed Callback ID HAL_TIM_PWM_PULSE_FINISHED_CB_ID PWM Pulse Finished Callback ID HAL_TIM_PWM_PULSE_FINISHED_HALF_CB_ID PWM Pulse Finished half complete Callback ID HAL_TIM_ERROR_CB_ID Error Callback ID HAL_TIM_COMMUTATION_CB_ID Commutation Callback ID HAL_TIM_COMMUTATION_HALF_CB_ID Commutation half complete Callback ID HAL_TIM_BREAK_CB_ID Break Callback ID

Return values

status

Definition at line 6076 of file stm32f4xx_hal_tim.c.