TIM Callbacks functions

TIM Callbacks functions. More...

Functions
__weak void	HAL_TIM_PeriodElapsedCallback (TIM_HandleTypeDef *htim)
	Period elapsed callback in non-blocking mode.
__weak void	HAL_TIM_OC_DelayElapsedCallback (TIM_HandleTypeDef *htim)
	Output Compare callback in non-blocking mode.
__weak void	HAL_TIM_IC_CaptureCallback (TIM_HandleTypeDef *htim)
	Input Capture callback in non-blocking mode.
__weak void	HAL_TIM_PWM_PulseFinishedCallback (TIM_HandleTypeDef *htim)
	PWM Pulse finished callback in non-blocking mode.
__weak void	HAL_TIM_TriggerCallback (TIM_HandleTypeDef *htim)
	Hall Trigger detection callback in non-blocking mode.
__weak void	HAL_TIM_ErrorCallback (TIM_HandleTypeDef *htim)
	Timer error callback in non-blocking mode.
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.
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.

---

Detailed Description

TIM Callbacks functions.

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

---

Function Documentation

void HAL_TIM_ErrorCallback

(

TIM_HandleTypeDef *

htim

)

Timer error callback in non-blocking mode.

Parameters:

htim	TIM handle

Return values:

None

Definition at line 4912 of file stm32l4xx_hal_tim.c.

Referenced by HAL_TIM_UnRegisterCallback(), TIM_DMAError(), and TIM_ResetCallback().

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 4867 of file stm32l4xx_hal_tim.c.

Referenced by HAL_TIM_IRQHandler(), HAL_TIM_UnRegisterCallback(), TIM_DMACaptureCplt(), and TIM_ResetCallback().

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 4853 of file stm32l4xx_hal_tim.c.

Referenced by HAL_TIM_IRQHandler(), HAL_TIM_UnRegisterCallback(), and TIM_ResetCallback().

void HAL_TIM_PeriodElapsedCallback

(

TIM_HandleTypeDef *

htim

)

Period elapsed callback in non-blocking mode.

Parameters:

htim	TIM handle

Return values:

None

Definition at line 4838 of file stm32l4xx_hal_tim.c.

Referenced by HAL_TIM_IRQHandler(), HAL_TIM_UnRegisterCallback(), TIM_DMAPeriodElapsedCplt(), and TIM_ResetCallback().

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 4882 of file stm32l4xx_hal_tim.c.

Referenced by HAL_TIM_IRQHandler(), HAL_TIM_UnRegisterCallback(), TIM_DMADelayPulseCplt(), and TIM_ResetCallback().

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_TRIGGER_CB_ID Trigger Callback ID HAL_TIM_IC_CAPTURE_CB_ID Input Capture 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_ERROR_CB_ID Error Callback ID HAL_TIM_COMMUTATION_CB_ID Commutation Callback ID HAL_TIM_BREAK_CB_ID Break Callback ID HAL_TIM_BREAK2_CB_ID Break2 Callback ID
pCallback	pointer to the callback function

Return values:

status

Definition at line 4954 of file stm32l4xx_hal_tim.c.

References __TIM_HandleTypeDef::Base_MspDeInitCallback, __TIM_HandleTypeDef::Base_MspInitCallback, __TIM_HandleTypeDef::Break2Callback, __TIM_HandleTypeDef::BreakCallback, __TIM_HandleTypeDef::CommutationCallback, __TIM_HandleTypeDef::Encoder_MspDeInitCallback, __TIM_HandleTypeDef::Encoder_MspInitCallback, __TIM_HandleTypeDef::ErrorCallback, HAL_TIM_BASE_MSPDEINIT_CB_ID, HAL_TIM_BASE_MSPINIT_CB_ID, HAL_TIM_BREAK2_CB_ID, HAL_TIM_BREAK_CB_ID, HAL_TIM_COMMUTATION_CB_ID, HAL_TIM_ENCODER_MSPDEINIT_CB_ID, HAL_TIM_ENCODER_MSPINIT_CB_ID, HAL_TIM_ERROR_CB_ID, HAL_TIM_HALL_SENSOR_MSPDEINIT_CB_ID, HAL_TIM_HALL_SENSOR_MSPINIT_CB_ID, HAL_TIM_IC_CAPTURE_CB_ID, HAL_TIM_IC_MSPDEINIT_CB_ID, HAL_TIM_IC_MSPINIT_CB_ID, HAL_TIM_OC_DELAY_ELAPSED_CB_ID, HAL_TIM_OC_MSPDEINIT_CB_ID, HAL_TIM_OC_MSPINIT_CB_ID, HAL_TIM_ONE_PULSE_MSPDEINIT_CB_ID, HAL_TIM_ONE_PULSE_MSPINIT_CB_ID, HAL_TIM_PERIOD_ELAPSED_CB_ID, HAL_TIM_PWM_MSPDEINIT_CB_ID, HAL_TIM_PWM_MSPINIT_CB_ID, HAL_TIM_PWM_PULSE_FINISHED_CB_ID, HAL_TIM_STATE_READY, HAL_TIM_STATE_RESET, HAL_TIM_TRIGGER_CB_ID, __TIM_HandleTypeDef::HallSensor_MspDeInitCallback, __TIM_HandleTypeDef::HallSensor_MspInitCallback, __TIM_HandleTypeDef::IC_CaptureCallback, __TIM_HandleTypeDef::IC_MspDeInitCallback, __TIM_HandleTypeDef::IC_MspInitCallback, __TIM_HandleTypeDef::OC_DelayElapsedCallback, __TIM_HandleTypeDef::OC_MspDeInitCallback, __TIM_HandleTypeDef::OC_MspInitCallback, __TIM_HandleTypeDef::OnePulse_MspDeInitCallback, __TIM_HandleTypeDef::OnePulse_MspInitCallback, __TIM_HandleTypeDef::PeriodElapsedCallback, __TIM_HandleTypeDef::PWM_MspDeInitCallback, __TIM_HandleTypeDef::PWM_MspInitCallback, __TIM_HandleTypeDef::PWM_PulseFinishedCallback, __TIM_HandleTypeDef::State, and __TIM_HandleTypeDef::TriggerCallback.

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 4897 of file stm32l4xx_hal_tim.c.

Referenced by HAL_TIM_IRQHandler(), HAL_TIM_UnRegisterCallback(), TIM_DMATriggerCplt(), and TIM_ResetCallback().

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_TRIGGER_CB_ID Trigger Callback ID HAL_TIM_IC_CAPTURE_CB_ID Input Capture 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_ERROR_CB_ID Error Callback ID HAL_TIM_COMMUTATION_CB_ID Commutation Callback ID HAL_TIM_BREAK_CB_ID Break Callback ID HAL_TIM_BREAK2_CB_ID Break2 Callback ID

Definition at line 5175 of file stm32l4xx_hal_tim.c.

References __TIM_HandleTypeDef::Base_MspDeInitCallback, __TIM_HandleTypeDef::Base_MspInitCallback, __TIM_HandleTypeDef::Break2Callback, __TIM_HandleTypeDef::BreakCallback, __TIM_HandleTypeDef::CommutationCallback, __TIM_HandleTypeDef::Encoder_MspDeInitCallback, __TIM_HandleTypeDef::Encoder_MspInitCallback, __TIM_HandleTypeDef::ErrorCallback, HAL_TIM_Base_MspDeInit(), HAL_TIM_BASE_MSPDEINIT_CB_ID, HAL_TIM_Base_MspInit(), HAL_TIM_BASE_MSPINIT_CB_ID, HAL_TIM_BREAK2_CB_ID, HAL_TIM_BREAK_CB_ID, HAL_TIM_COMMUTATION_CB_ID, HAL_TIM_Encoder_MspDeInit(), HAL_TIM_ENCODER_MSPDEINIT_CB_ID, HAL_TIM_Encoder_MspInit(), HAL_TIM_ENCODER_MSPINIT_CB_ID, HAL_TIM_ERROR_CB_ID, HAL_TIM_ErrorCallback(), HAL_TIM_HALL_SENSOR_MSPDEINIT_CB_ID, HAL_TIM_HALL_SENSOR_MSPINIT_CB_ID, HAL_TIM_IC_CAPTURE_CB_ID, HAL_TIM_IC_CaptureCallback(), HAL_TIM_IC_MspDeInit(), HAL_TIM_IC_MSPDEINIT_CB_ID, HAL_TIM_IC_MspInit(), HAL_TIM_IC_MSPINIT_CB_ID, HAL_TIM_OC_DELAY_ELAPSED_CB_ID, HAL_TIM_OC_DelayElapsedCallback(), HAL_TIM_OC_MspDeInit(), HAL_TIM_OC_MSPDEINIT_CB_ID, HAL_TIM_OC_MspInit(), HAL_TIM_OC_MSPINIT_CB_ID, HAL_TIM_ONE_PULSE_MSPDEINIT_CB_ID, HAL_TIM_ONE_PULSE_MSPINIT_CB_ID, HAL_TIM_OnePulse_MspDeInit(), HAL_TIM_OnePulse_MspInit(), HAL_TIM_PERIOD_ELAPSED_CB_ID, HAL_TIM_PeriodElapsedCallback(), HAL_TIM_PWM_MspDeInit(), HAL_TIM_PWM_MSPDEINIT_CB_ID, HAL_TIM_PWM_MspInit(), HAL_TIM_PWM_MSPINIT_CB_ID, HAL_TIM_PWM_PULSE_FINISHED_CB_ID, HAL_TIM_PWM_PulseFinishedCallback(), HAL_TIM_STATE_READY, HAL_TIM_STATE_RESET, HAL_TIM_TRIGGER_CB_ID, HAL_TIM_TriggerCallback(), HAL_TIMEx_Break2Callback(), HAL_TIMEx_BreakCallback(), HAL_TIMEx_CommutationCallback(), HAL_TIMEx_HallSensor_MspDeInit(), HAL_TIMEx_HallSensor_MspInit(), __TIM_HandleTypeDef::HallSensor_MspDeInitCallback, __TIM_HandleTypeDef::HallSensor_MspInitCallback, __TIM_HandleTypeDef::IC_CaptureCallback, __TIM_HandleTypeDef::IC_MspDeInitCallback, __TIM_HandleTypeDef::IC_MspInitCallback, __TIM_HandleTypeDef::OC_DelayElapsedCallback, __TIM_HandleTypeDef::OC_MspDeInitCallback, __TIM_HandleTypeDef::OC_MspInitCallback, __TIM_HandleTypeDef::OnePulse_MspDeInitCallback, __TIM_HandleTypeDef::OnePulse_MspInitCallback, __TIM_HandleTypeDef::PeriodElapsedCallback, __TIM_HandleTypeDef::PWM_MspDeInitCallback, __TIM_HandleTypeDef::PWM_MspInitCallback, __TIM_HandleTypeDef::PWM_PulseFinishedCallback, __TIM_HandleTypeDef::State, and __TIM_HandleTypeDef::TriggerCallback.