TIM One Pulse functions

TIM One Pulse functions. More...

Collaboration diagram for TIM One Pulse functions:

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. More...
HAL_StatusTypeDef	HAL_TIM_OnePulse_DeInit (TIM_HandleTypeDef *htim)
	DeInitializes the TIM One Pulse. More...
void	HAL_TIM_OnePulse_MspInit (TIM_HandleTypeDef *htim)
	Initializes the TIM One Pulse MSP. More...
void	HAL_TIM_OnePulse_MspDeInit (TIM_HandleTypeDef *htim)
	DeInitializes TIM One Pulse MSP. More...
HAL_StatusTypeDef	HAL_TIM_OnePulse_Start (TIM_HandleTypeDef *htim, uint32_t OutputChannel)
	Starts the TIM One Pulse signal generation. More...
HAL_StatusTypeDef	HAL_TIM_OnePulse_Stop (TIM_HandleTypeDef *htim, uint32_t OutputChannel)
	Stops the TIM One Pulse signal generation. More...
HAL_StatusTypeDef	HAL_TIM_OnePulse_Start_IT (TIM_HandleTypeDef *htim, uint32_t OutputChannel)
	Starts the TIM One Pulse signal generation in interrupt mode. More...
HAL_StatusTypeDef	HAL_TIM_OnePulse_Stop_IT (TIM_HandleTypeDef *htim, uint32_t OutputChannel)
	Stops the TIM One Pulse signal generation in interrupt mode. More...

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_TIM_OnePulse_DeInit()

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 2697 of file stm32f4xx_hal_tim.c.

HAL_TIM_OnePulse_Init()

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 2628 of file stm32f4xx_hal_tim.c.

HAL_TIM_OnePulse_MspDeInit()

__weak 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 2757 of file stm32f4xx_hal_tim.c.

HAL_TIM_OnePulse_MspInit()

__weak 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 2742 of file stm32f4xx_hal_tim.c.

HAL_TIM_OnePulse_Start()

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 2777 of file stm32f4xx_hal_tim.c.

HAL_TIM_OnePulse_Start_IT()

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 2877 of file stm32f4xx_hal_tim.c.

HAL_TIM_OnePulse_Stop()

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 2834 of file stm32f4xx_hal_tim.c.

HAL_TIM_OnePulse_Stop_IT()

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 2940 of file stm32f4xx_hal_tim.c.