TIM Output Compare functions. More...

Collaboration diagram for TIM Output Compare functions:

Functions
HAL_StatusTypeDef	HAL_TIM_OC_Init (TIM_HandleTypeDef *htim)
	Initializes the TIM Output Compare according to the specified parameters in the TIM_HandleTypeDef and initializes the associated handle. More...

HAL_StatusTypeDef	HAL_TIM_OC_DeInit (TIM_HandleTypeDef *htim)
	DeInitializes the TIM peripheral. More...

void	HAL_TIM_OC_MspInit (TIM_HandleTypeDef *htim)
	Initializes the TIM Output Compare MSP. More...

void	HAL_TIM_OC_MspDeInit (TIM_HandleTypeDef *htim)
	DeInitializes TIM Output Compare MSP. More...

HAL_StatusTypeDef	HAL_TIM_OC_Start (TIM_HandleTypeDef *htim, uint32_t Channel)
	Starts the TIM Output Compare signal generation. More...

HAL_StatusTypeDef	HAL_TIM_OC_Stop (TIM_HandleTypeDef *htim, uint32_t Channel)
	Stops the TIM Output Compare signal generation. More...

HAL_StatusTypeDef	HAL_TIM_OC_Start_IT (TIM_HandleTypeDef *htim, uint32_t Channel)
	Starts the TIM Output Compare signal generation in interrupt mode. More...

HAL_StatusTypeDef	HAL_TIM_OC_Stop_IT (TIM_HandleTypeDef *htim, uint32_t Channel)
	Stops the TIM Output Compare signal generation in interrupt mode. More...

HAL_StatusTypeDef	HAL_TIM_OC_Start_DMA (TIM_HandleTypeDef htim, uint32_t Channel, const uint32_t pData, uint16_t Length)
	Starts the TIM Output Compare signal generation in DMA mode. More...

HAL_StatusTypeDef	HAL_TIM_OC_Stop_DMA (TIM_HandleTypeDef *htim, uint32_t Channel)
	Stops the TIM Output Compare signal generation in DMA mode. More...

Detailed Description

TIM Output Compare functions.

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

Function Documentation

◆ HAL_TIM_OC_DeInit()

HAL_StatusTypeDef HAL_TIM_OC_DeInit ( TIM_HandleTypeDef * htim )

DeInitializes the TIM peripheral.

Parameters

htim	TIM Output Compare handle

Return values

HAL status

Definition at line 710 of file stm32f4xx_hal_tim.c.

◆ HAL_TIM_OC_Init()

HAL_StatusTypeDef HAL_TIM_OC_Init ( TIM_HandleTypeDef * htim )

Initializes the TIM Output Compare 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_OC_DeInit() before HAL_TIM_OC_Init()

Parameters

htim	TIM Output Compare handle

Return values

HAL status

Definition at line 650 of file stm32f4xx_hal_tim.c.

◆ HAL_TIM_OC_MspDeInit()

__weak void HAL_TIM_OC_MspDeInit ( TIM_HandleTypeDef * htim )

DeInitializes TIM Output Compare MSP.

Parameters

htim	TIM Output Compare handle

Return values

None

Definition at line 768 of file stm32f4xx_hal_tim.c.

◆ HAL_TIM_OC_MspInit()

__weak void HAL_TIM_OC_MspInit ( TIM_HandleTypeDef * htim )

Initializes the TIM Output Compare MSP.

Parameters

htim	TIM Output Compare handle

Return values

None

Definition at line 753 of file stm32f4xx_hal_tim.c.

◆ HAL_TIM_OC_Start()

HAL_StatusTypeDef HAL_TIM_OC_Start	(	TIM_HandleTypeDef *	htim,
		uint32_t	Channel
	)

Starts the TIM Output Compare signal generation.

Parameters

htim	TIM Output Compare handle
Channel	TIM Channel to be enabled This parameter can be one of the following values: TIM_CHANNEL_1: TIM Channel 1 selected TIM_CHANNEL_2: TIM Channel 2 selected TIM_CHANNEL_3: TIM Channel 3 selected TIM_CHANNEL_4: TIM Channel 4 selected

Return values

HAL status

Definition at line 789 of file stm32f4xx_hal_tim.c.

◆ HAL_TIM_OC_Start_DMA()

HAL_StatusTypeDef HAL_TIM_OC_Start_DMA	(	TIM_HandleTypeDef *	htim,
		uint32_t	Channel,
		const uint32_t *	pData,
		uint16_t	Length
	)

Starts the TIM Output Compare signal generation in DMA mode.

Parameters

htim	TIM Output Compare handle
Channel	TIM Channel to be enabled This parameter can be one of the following values: TIM_CHANNEL_1: TIM Channel 1 selected TIM_CHANNEL_2: TIM Channel 2 selected TIM_CHANNEL_3: TIM Channel 3 selected TIM_CHANNEL_4: TIM Channel 4 selected
pData	The source Buffer address.
Length	The length of data to be transferred from memory to TIM peripheral

Return values

HAL status

Definition at line 1048 of file stm32f4xx_hal_tim.c.

◆ HAL_TIM_OC_Start_IT()

HAL_StatusTypeDef HAL_TIM_OC_Start_IT	(	TIM_HandleTypeDef *	htim,
		uint32_t	Channel
	)

Starts the TIM Output Compare signal generation in interrupt mode.

Parameters

htim	TIM Output Compare handle
Channel	TIM Channel to be enabled This parameter can be one of the following values: TIM_CHANNEL_1: TIM Channel 1 selected TIM_CHANNEL_2: TIM Channel 2 selected TIM_CHANNEL_3: TIM Channel 3 selected TIM_CHANNEL_4: TIM Channel 4 selected

Return values

HAL status

Definition at line 878 of file stm32f4xx_hal_tim.c.

◆ HAL_TIM_OC_Stop()

HAL_StatusTypeDef HAL_TIM_OC_Stop	(	TIM_HandleTypeDef *	htim,
		uint32_t	Channel
	)

Stops the TIM Output Compare signal generation.

Parameters

htim	TIM Output Compare handle
Channel	TIM Channel to be disabled This parameter can be one of the following values: TIM_CHANNEL_1: TIM Channel 1 selected TIM_CHANNEL_2: TIM Channel 2 selected TIM_CHANNEL_3: TIM Channel 3 selected TIM_CHANNEL_4: TIM Channel 4 selected

Return values

HAL status

Definition at line 843 of file stm32f4xx_hal_tim.c.

◆ HAL_TIM_OC_Stop_DMA()

HAL_StatusTypeDef HAL_TIM_OC_Stop_DMA	(	TIM_HandleTypeDef *	htim,
		uint32_t	Channel
	)

Stops the TIM Output Compare signal generation in DMA mode.

Parameters

htim	TIM Output Compare handle
Channel	TIM Channel to be disabled This parameter can be one of the following values: TIM_CHANNEL_1: TIM Channel 1 selected TIM_CHANNEL_2: TIM Channel 2 selected TIM_CHANNEL_3: TIM Channel 3 selected TIM_CHANNEL_4: TIM Channel 4 selected

Return values

HAL status

Definition at line 1212 of file stm32f4xx_hal_tim.c.

◆ HAL_TIM_OC_Stop_IT()

HAL_StatusTypeDef HAL_TIM_OC_Stop_IT	(	TIM_HandleTypeDef *	htim,
		uint32_t	Channel
	)

Stops the TIM Output Compare signal generation in interrupt mode.

Parameters

htim	TIM Output Compare handle
Channel	TIM Channel to be disabled This parameter can be one of the following values: TIM_CHANNEL_1: TIM Channel 1 selected TIM_CHANNEL_2: TIM Channel 2 selected TIM_CHANNEL_3: TIM Channel 3 selected TIM_CHANNEL_4: TIM Channel 4 selected

Return values

HAL status

Definition at line 971 of file stm32f4xx_hal_tim.c.

Functions

Detailed Description

Function Documentation

◆ HAL_TIM_OC_DeInit()

◆ HAL_TIM_OC_Init()

◆ HAL_TIM_OC_MspDeInit()

◆ HAL_TIM_OC_MspInit()

◆ HAL_TIM_OC_Start()

◆ HAL_TIM_OC_Start_DMA()

◆ HAL_TIM_OC_Start_IT()

◆ HAL_TIM_OC_Stop()

◆ HAL_TIM_OC_Stop_DMA()

◆ HAL_TIM_OC_Stop_IT()