STM32F4xx_HAL_Driver  1.8.3
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. More...
 
HAL_StatusTypeDef HAL_TIMEx_OCN_Stop (TIM_HandleTypeDef *htim, uint32_t Channel)
 Stops the TIM Output Compare signal generation on the complementary output. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 

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 
)

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

Parameters
htimTIM Output Compare handle
ChannelTIM 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
HALstatus

Definition at line 625 of file stm32f4xx_hal_tim_ex.c.

◆ 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 
)

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

Parameters
htimTIM Output Compare handle
ChannelTIM 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
pDataThe source Buffer address.
LengthThe length of data to be transferred from memory to TIM peripheral
Return values
HALstatus

Definition at line 870 of file stm32f4xx_hal_tim_ex.c.

◆ HAL_TIMEx_OCN_Start_IT()

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.

Parameters
htimTIM OC handle
ChannelTIM 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
HALstatus

Definition at line 708 of file stm32f4xx_hal_tim_ex.c.

◆ HAL_TIMEx_OCN_Stop()

HAL_StatusTypeDef HAL_TIMEx_OCN_Stop ( TIM_HandleTypeDef htim,
uint32_t  Channel 
)

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

Parameters
htimTIM handle
ChannelTIM 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
HALstatus

Definition at line 676 of file stm32f4xx_hal_tim_ex.c.

◆ HAL_TIMEx_OCN_Stop_DMA()

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.

Parameters
htimTIM Output Compare handle
ChannelTIM 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
HALstatus

Definition at line 1008 of file stm32f4xx_hal_tim_ex.c.

◆ HAL_TIMEx_OCN_Stop_IT()

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.

Parameters
htimTIM Output Compare handle
ChannelTIM 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
HALstatus

Definition at line 795 of file stm32f4xx_hal_tim_ex.c.