TIM One Pulse functions

TIM One Pulse functions. More...

Functions
HAL_StatusTypeDef	HAL_TIM_OnePulse_Init (TIM_HandleTypeDef *htim, uint32_t OnePulseMode)
	Initializes the TIM One Pulse Time Base according to the specified parameters in the TIM_HandleTypeDef and initializes the associated handle.
HAL_StatusTypeDef	HAL_TIM_OnePulse_DeInit (TIM_HandleTypeDef *htim)
	DeInitializes the TIM One Pulse.
__weak void	HAL_TIM_OnePulse_MspInit (TIM_HandleTypeDef *htim)
	Initializes the TIM One Pulse MSP.
__weak void	HAL_TIM_OnePulse_MspDeInit (TIM_HandleTypeDef *htim)
	DeInitializes TIM One Pulse MSP.
HAL_StatusTypeDef	HAL_TIM_OnePulse_Start (TIM_HandleTypeDef *htim, uint32_t OutputChannel)
	Starts the TIM One Pulse signal generation.
HAL_StatusTypeDef	HAL_TIM_OnePulse_Stop (TIM_HandleTypeDef *htim, uint32_t OutputChannel)
	Stops the TIM One Pulse signal generation.
HAL_StatusTypeDef	HAL_TIM_OnePulse_Start_IT (TIM_HandleTypeDef *htim, uint32_t OutputChannel)
	Starts the TIM One Pulse signal generation in interrupt mode.
HAL_StatusTypeDef	HAL_TIM_OnePulse_Stop_IT (TIM_HandleTypeDef *htim, uint32_t OutputChannel)
	Stops the TIM One Pulse signal generation in interrupt mode.

---

Detailed Description

TIM One Pulse functions.

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

---

Function Documentation

HAL_StatusTypeDef HAL_TIM_OnePulse_DeInit

(

TIM_HandleTypeDef *

htim

)

DeInitializes the TIM One Pulse.

Parameters:

htim	TIM One Pulse handle

Return values:

HAL

status

Definition at line 2690 of file stm32f4xx_hal_tim.c.

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

HAL_StatusTypeDef HAL_TIM_OnePulse_Init	(	TIM_HandleTypeDef *	htim,
		uint32_t	OnePulseMode
	)

Initializes the TIM One Pulse 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_OnePulse_DeInit() before HAL_TIM_OnePulse_Init()

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

Parameters:

htim	TIM One Pulse handle
OnePulseMode	Select the One pulse mode. This parameter can be one of the following values: TIM_OPMODE_SINGLE: Only one pulse will be generated. TIM_OPMODE_REPETITIVE: Repetitive pulses will be generated.

Return values:

HAL

status

Definition at line 2622 of file stm32f4xx_hal_tim.c.

References assert_param, TIM_Base_InitTypeDef::AutoReloadPreload, TIM_Base_InitTypeDef::ClockDivision, TIM_Base_InitTypeDef::CounterMode, __TIM_HandleTypeDef::DMABurstState, HAL_DMA_BURST_STATE_READY, HAL_TIM_CHANNEL_STATE_READY, HAL_TIM_OnePulse_MspInit(), HAL_TIM_STATE_BUSY, HAL_TIM_STATE_READY, HAL_TIM_STATE_RESET, __TIM_HandleTypeDef::Init, __TIM_HandleTypeDef::Instance, IS_TIM_AUTORELOAD_PRELOAD, IS_TIM_CLOCKDIVISION_DIV, IS_TIM_COUNTER_MODE, IS_TIM_OPM_MODE, __TIM_HandleTypeDef::Lock, __TIM_HandleTypeDef::OnePulse_MspInitCallback, __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_OnePulse_MspDeInit

(

TIM_HandleTypeDef *

htim

)

DeInitializes TIM One Pulse MSP.

Parameters:

htim	TIM One Pulse handle

Return values:

None

Definition at line 2750 of file stm32f4xx_hal_tim.c.

Referenced by HAL_TIM_OnePulse_DeInit(), and HAL_TIM_UnRegisterCallback().

void HAL_TIM_OnePulse_MspInit

(

TIM_HandleTypeDef *

htim

)

Initializes the TIM One Pulse MSP.

Parameters:

htim	TIM One Pulse handle

Return values:

None

Definition at line 2735 of file stm32f4xx_hal_tim.c.

Referenced by HAL_TIM_OnePulse_Init(), and HAL_TIM_UnRegisterCallback().

HAL_StatusTypeDef HAL_TIM_OnePulse_Start	(	TIM_HandleTypeDef *	htim,
		uint32_t	OutputChannel
	)

Starts the TIM One Pulse signal generation.

Note:

Though OutputChannel parameter is deprecated and ignored by the function it has been kept to avoid HAL_TIM API compatibility break.

The pulse output channel is determined when calling HAL_TIM_OnePulse_ConfigChannel().

Parameters:

htim	TIM One Pulse handle
OutputChannel	See note above

Return values:

HAL

status

Definition at line 2770 of file stm32f4xx_hal_tim.c.

References __HAL_TIM_MOE_ENABLE, 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_OnePulse_Start_IT	(	TIM_HandleTypeDef *	htim,
		uint32_t	OutputChannel
	)

Starts the TIM One Pulse signal generation in interrupt mode.

Note:

Though OutputChannel parameter is deprecated and ignored by the function it has been kept to avoid HAL_TIM API compatibility break.

The pulse output channel is determined when calling HAL_TIM_OnePulse_ConfigChannel().

Parameters:

htim	TIM One Pulse handle
OutputChannel	See note above

Return values:

HAL

status

Definition at line 2870 of file stm32f4xx_hal_tim.c.

References __HAL_TIM_ENABLE_IT, __HAL_TIM_MOE_ENABLE, 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_OnePulse_Stop	(	TIM_HandleTypeDef *	htim,
		uint32_t	OutputChannel
	)

Stops the TIM One Pulse signal generation.

Note:

Though OutputChannel parameter is deprecated and ignored by the function it has been kept to avoid HAL_TIM API compatibility break.

The pulse output channel is determined when calling HAL_TIM_OnePulse_ConfigChannel().

Parameters:

htim	TIM One Pulse handle
OutputChannel	See note above

Return values:

HAL

status

Definition at line 2827 of file stm32f4xx_hal_tim.c.

References __HAL_TIM_DISABLE, __HAL_TIM_MOE_DISABLE, 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_OnePulse_Stop_IT	(	TIM_HandleTypeDef *	htim,
		uint32_t	OutputChannel
	)

Stops the TIM One Pulse signal generation in interrupt mode.

Note:

Though OutputChannel parameter is deprecated and ignored by the function it has been kept to avoid HAL_TIM API compatibility break.

The pulse output channel is determined when calling HAL_TIM_OnePulse_ConfigChannel().

Parameters:

htim	TIM One Pulse handle
OutputChannel	See note above

Return values:

HAL

status

Definition at line 2933 of file stm32f4xx_hal_tim.c.

References __HAL_TIM_DISABLE, __HAL_TIM_DISABLE_IT, __HAL_TIM_MOE_DISABLE, 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.