Extended Timer Complementary Output Compare functions

Timer Complementary Output Compare functions. More...

Collaboration diagram for Extended Timer Complementary Output Compare functions:

Functions
HAL_StatusTypeDef	HAL_TIMEx_OCN_Start (TIM_HandleTypeDef *htim, uint32_t Channel)
	Starts the TIM Output Compare signal generation on the complementary output.
HAL_StatusTypeDef	HAL_TIMEx_OCN_Stop (TIM_HandleTypeDef *htim, uint32_t Channel)
	Stops the TIM Output Compare signal generation on the complementary output.
HAL_StatusTypeDef	HAL_TIMEx_OCN_Start_IT (TIM_HandleTypeDef *htim, uint32_t Channel)
	Starts the TIM Output Compare signal generation in interrupt mode on the complementary output.
HAL_StatusTypeDef	HAL_TIMEx_OCN_Stop_IT (TIM_HandleTypeDef *htim, uint32_t Channel)
	Stops the TIM Output Compare signal generation in interrupt mode on the complementary output.
HAL_StatusTypeDef	HAL_TIMEx_OCN_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 on the complementary output.
HAL_StatusTypeDef	HAL_TIMEx_OCN_Stop_DMA (TIM_HandleTypeDef *htim, uint32_t Channel)
	Stops the TIM Output Compare signal generation in DMA mode on the complementary output.

Detailed Description

Timer Complementary Output Compare functions.

  ==============================================================================
              ##### Timer Complementary Output Compare functions #####
  ==============================================================================
  [..]
    This section provides functions allowing to:
    (+) Start the Complementary Output Compare/PWM.
    (+) Stop the Complementary Output Compare/PWM.
    (+) Start the Complementary Output Compare/PWM and enable interrupts.
    (+) Stop the Complementary Output Compare/PWM and disable interrupts.
    (+) Start the Complementary Output Compare/PWM and enable DMA transfers.
    (+) Stop the Complementary Output Compare/PWM and disable DMA transfers.

Function Documentation

HAL_TIMEx_OCN_Start()

HAL_StatusTypeDef HAL_TIMEx_OCN_Start	(	TIM_HandleTypeDef *	htim,
		uint32_t	Channel )

#include <stm32f4xx_hal_tim_ex.h>

Starts the TIM Output Compare signal generation on the complementary output.

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

Return values

HAL

status

Definition at line 625 of file stm32f4xx_hal_tim_ex.c.

References __HAL_TIM_ENABLE, __HAL_TIM_MOE_ENABLE, assert_param, HAL_ERROR, HAL_OK, HAL_TIM_CHANNEL_STATE_BUSY, HAL_TIM_CHANNEL_STATE_READY, TIM_HandleTypeDef::Instance, IS_TIM_SLAVEMODE_TRIGGER_ENABLED, TIM_CCxN_ENABLE, TIM_CCxNChannelCmd(), TIM_CHANNEL_N_STATE_GET, and TIM_CHANNEL_N_STATE_SET.

HAL_TIMEx_OCN_Stop()

HAL_StatusTypeDef HAL_TIMEx_OCN_Stop	(	TIM_HandleTypeDef *	htim,
		uint32_t	Channel )

#include <stm32f4xx_hal_tim_ex.h>

Stops the TIM Output Compare signal generation on the complementary output.

Parameters

htim	TIM 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

Return values

HAL

status

Definition at line 676 of file stm32f4xx_hal_tim_ex.c.

References __HAL_TIM_DISABLE, __HAL_TIM_MOE_DISABLE, assert_param, HAL_OK, HAL_TIM_CHANNEL_STATE_READY, TIM_HandleTypeDef::Instance, TIM_CCxN_DISABLE, TIM_CCxNChannelCmd(), and TIM_CHANNEL_N_STATE_SET.

HAL_TIMEx_OCN_Start_IT()

HAL_StatusTypeDef HAL_TIMEx_OCN_Start_IT	(	TIM_HandleTypeDef *	htim,
		uint32_t	Channel )

#include <stm32f4xx_hal_tim_ex.h>

Starts the TIM Output Compare signal generation in interrupt mode on the complementary output.

Parameters

htim	TIM OC 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

Return values

HAL

status

Definition at line 708 of file stm32f4xx_hal_tim_ex.c.

References __HAL_TIM_ENABLE, __HAL_TIM_ENABLE_IT, __HAL_TIM_MOE_ENABLE, assert_param, HAL_ERROR, HAL_OK, HAL_TIM_CHANNEL_STATE_BUSY, HAL_TIM_CHANNEL_STATE_READY, TIM_HandleTypeDef::Instance, IS_TIM_SLAVEMODE_TRIGGER_ENABLED, TIM_CCxN_ENABLE, TIM_CCxNChannelCmd(), TIM_CHANNEL_1, TIM_CHANNEL_2, TIM_CHANNEL_3, TIM_CHANNEL_N_STATE_GET, TIM_CHANNEL_N_STATE_SET, TIM_IT_BREAK, TIM_IT_CC1, TIM_IT_CC2, and TIM_IT_CC3.

HAL_TIMEx_OCN_Stop_IT()

HAL_StatusTypeDef HAL_TIMEx_OCN_Stop_IT	(	TIM_HandleTypeDef *	htim,
		uint32_t	Channel )

#include <stm32f4xx_hal_tim_ex.h>

Stops the TIM Output Compare signal generation in interrupt mode on the complementary output.

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

Return values

HAL

status

Definition at line 795 of file stm32f4xx_hal_tim_ex.c.

References __HAL_TIM_DISABLE, __HAL_TIM_DISABLE_IT, __HAL_TIM_MOE_DISABLE, assert_param, HAL_ERROR, HAL_OK, HAL_TIM_CHANNEL_STATE_READY, TIM_HandleTypeDef::Instance, TIM_CCER_CCxNE_MASK, TIM_CCxN_DISABLE, TIM_CCxNChannelCmd(), TIM_CHANNEL_1, TIM_CHANNEL_2, TIM_CHANNEL_3, TIM_CHANNEL_N_STATE_SET, TIM_IT_BREAK, TIM_IT_CC1, TIM_IT_CC2, and TIM_IT_CC3.

HAL_TIMEx_OCN_Start_DMA()

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

#include <stm32f4xx_hal_tim_ex.h>

Starts the TIM Output Compare signal generation in DMA mode on the complementary output.

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
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 870 of file stm32f4xx_hal_tim_ex.c.

References __HAL_TIM_ENABLE, __HAL_TIM_ENABLE_DMA, __HAL_TIM_MOE_ENABLE, assert_param, HAL_BUSY, HAL_DMA_Start_IT(), HAL_ERROR, HAL_OK, HAL_TIM_CHANNEL_STATE_BUSY, HAL_TIM_CHANNEL_STATE_READY, TIM_HandleTypeDef::hdma, TIM_HandleTypeDef::Instance, IS_TIM_SLAVEMODE_TRIGGER_ENABLED, TIM_CCxN_ENABLE, TIM_CCxNChannelCmd(), TIM_CHANNEL_1, TIM_CHANNEL_2, TIM_CHANNEL_3, TIM_CHANNEL_N_STATE_GET, TIM_CHANNEL_N_STATE_SET, TIM_DMA_CC1, TIM_DMA_CC2, TIM_DMA_CC3, TIM_DMA_ID_CC1, TIM_DMA_ID_CC2, TIM_DMA_ID_CC3, TIM_DMADelayPulseHalfCplt(), TIM_DMADelayPulseNCplt(), TIM_DMAErrorCCxN(), __DMA_HandleTypeDef::XferCpltCallback, __DMA_HandleTypeDef::XferErrorCallback, and __DMA_HandleTypeDef::XferHalfCpltCallback.

HAL_TIMEx_OCN_Stop_DMA()

HAL_StatusTypeDef HAL_TIMEx_OCN_Stop_DMA	(	TIM_HandleTypeDef *	htim,
		uint32_t	Channel )

#include <stm32f4xx_hal_tim_ex.h>

Stops the TIM Output Compare signal generation in DMA mode on the complementary output.

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

Return values

HAL

status

Definition at line 1008 of file stm32f4xx_hal_tim_ex.c.

References __HAL_TIM_DISABLE, __HAL_TIM_DISABLE_DMA, __HAL_TIM_MOE_DISABLE, assert_param, HAL_DMA_Abort_IT(), HAL_ERROR, HAL_OK, HAL_TIM_CHANNEL_STATE_READY, TIM_HandleTypeDef::hdma, TIM_HandleTypeDef::Instance, TIM_CCxN_DISABLE, TIM_CCxNChannelCmd(), TIM_CHANNEL_1, TIM_CHANNEL_2, TIM_CHANNEL_3, TIM_CHANNEL_N_STATE_SET, TIM_DMA_CC1, TIM_DMA_CC2, TIM_DMA_CC3, TIM_DMA_ID_CC1, TIM_DMA_ID_CC2, and TIM_DMA_ID_CC3.