STM32F4xx_HAL_Driver  1.8.3
Break function configuration
+ Collaboration diagram for Break function configuration:

Functions

__STATIC_INLINE void LL_TIM_EnableBRK (TIM_TypeDef *TIMx)
 Enable the break function. More...
 
__STATIC_INLINE void LL_TIM_DisableBRK (TIM_TypeDef *TIMx)
 Disable the break function. @rmtoll BDTR BKE LL_TIM_DisableBRK. More...
 
__STATIC_INLINE void LL_TIM_ConfigBRK (TIM_TypeDef *TIMx, uint32_t BreakPolarity)
 Configure the break input. More...
 
__STATIC_INLINE void LL_TIM_SetOffStates (TIM_TypeDef *TIMx, uint32_t OffStateIdle, uint32_t OffStateRun)
 Select the outputs off state (enabled v.s. disabled) in Idle and Run modes. More...
 
__STATIC_INLINE void LL_TIM_EnableAutomaticOutput (TIM_TypeDef *TIMx)
 Enable automatic output (MOE can be set by software or automatically when a break input is active). More...
 
__STATIC_INLINE void LL_TIM_DisableAutomaticOutput (TIM_TypeDef *TIMx)
 Disable automatic output (MOE can be set only by software). More...
 
__STATIC_INLINE uint32_t LL_TIM_IsEnabledAutomaticOutput (const TIM_TypeDef *TIMx)
 Indicate whether automatic output is enabled. More...
 
__STATIC_INLINE void LL_TIM_EnableAllOutputs (TIM_TypeDef *TIMx)
 Enable the outputs (set the MOE bit in TIMx_BDTR register). More...
 
__STATIC_INLINE void LL_TIM_DisableAllOutputs (TIM_TypeDef *TIMx)
 Disable the outputs (reset the MOE bit in TIMx_BDTR register). More...
 
__STATIC_INLINE uint32_t LL_TIM_IsEnabledAllOutputs (const TIM_TypeDef *TIMx)
 Indicates whether outputs are enabled. More...
 

Detailed Description

Function Documentation

◆ LL_TIM_ConfigBRK()

__STATIC_INLINE void LL_TIM_ConfigBRK ( TIM_TypeDef *  TIMx,
uint32_t  BreakPolarity 
)

Configure the break input.

Note
Macro IS_TIM_BREAK_INSTANCE(TIMx) can be used to check whether or not a timer instance provides a break input. @rmtoll BDTR BKP LL_TIM_ConfigBRK
Parameters
TIMxTimer instance
BreakPolarityThis parameter can be one of the following values:
  • LL_TIM_BREAK_POLARITY_LOW
  • LL_TIM_BREAK_POLARITY_HIGH
Return values
None

Definition at line 2917 of file stm32f4xx_ll_tim.h.

◆ LL_TIM_DisableAllOutputs()

__STATIC_INLINE void LL_TIM_DisableAllOutputs ( TIM_TypeDef *  TIMx)

Disable the outputs (reset the MOE bit in TIMx_BDTR register).

Note
The MOE bit in TIMx_BDTR register allows to enable /disable the outputs by software and is reset in case of break or break2 event.
Macro IS_TIM_BREAK_INSTANCE(TIMx) can be used to check whether or not a timer instance provides a break input. @rmtoll BDTR MOE LL_TIM_DisableAllOutputs
Parameters
TIMxTimer instance
Return values
None

Definition at line 3010 of file stm32f4xx_ll_tim.h.

◆ LL_TIM_DisableAutomaticOutput()

__STATIC_INLINE void LL_TIM_DisableAutomaticOutput ( TIM_TypeDef *  TIMx)

Disable automatic output (MOE can be set only by software).

Note
Macro IS_TIM_BREAK_INSTANCE(TIMx) can be used to check whether or not a timer instance provides a break input. @rmtoll BDTR AOE LL_TIM_DisableAutomaticOutput
Parameters
TIMxTimer instance
Return values
None

Definition at line 2967 of file stm32f4xx_ll_tim.h.

◆ LL_TIM_DisableBRK()

__STATIC_INLINE void LL_TIM_DisableBRK ( TIM_TypeDef *  TIMx)

Disable the break function. @rmtoll BDTR BKE LL_TIM_DisableBRK.

Parameters
TIMxTimer instance
Note
Macro IS_TIM_BREAK_INSTANCE(TIMx) can be used to check whether or not a timer instance provides a break input.
Return values
None

Definition at line 2897 of file stm32f4xx_ll_tim.h.

◆ LL_TIM_EnableAllOutputs()

__STATIC_INLINE void LL_TIM_EnableAllOutputs ( TIM_TypeDef *  TIMx)

Enable the outputs (set the MOE bit in TIMx_BDTR register).

Note
The MOE bit in TIMx_BDTR register allows to enable /disable the outputs by software and is reset in case of break or break2 event
Macro IS_TIM_BREAK_INSTANCE(TIMx) can be used to check whether or not a timer instance provides a break input. @rmtoll BDTR MOE LL_TIM_EnableAllOutputs
Parameters
TIMxTimer instance
Return values
None

Definition at line 2995 of file stm32f4xx_ll_tim.h.

◆ LL_TIM_EnableAutomaticOutput()

__STATIC_INLINE void LL_TIM_EnableAutomaticOutput ( TIM_TypeDef *  TIMx)

Enable automatic output (MOE can be set by software or automatically when a break input is active).

Note
Macro IS_TIM_BREAK_INSTANCE(TIMx) can be used to check whether or not a timer instance provides a break input. @rmtoll BDTR AOE LL_TIM_EnableAutomaticOutput
Parameters
TIMxTimer instance
Return values
None

Definition at line 2954 of file stm32f4xx_ll_tim.h.

◆ LL_TIM_EnableBRK()

__STATIC_INLINE void LL_TIM_EnableBRK ( TIM_TypeDef *  TIMx)

Enable the break function.

Note
Macro IS_TIM_BREAK_INSTANCE(TIMx) can be used to check whether or not a timer instance provides a break input. @rmtoll BDTR BKE LL_TIM_EnableBRK
Parameters
TIMxTimer instance
Return values
None

Definition at line 2880 of file stm32f4xx_ll_tim.h.

◆ LL_TIM_IsEnabledAllOutputs()

__STATIC_INLINE uint32_t LL_TIM_IsEnabledAllOutputs ( const TIM_TypeDef *  TIMx)

Indicates whether outputs are enabled.

Note
Macro IS_TIM_BREAK_INSTANCE(TIMx) can be used to check whether or not a timer instance provides a break input. @rmtoll BDTR MOE LL_TIM_IsEnabledAllOutputs
Parameters
TIMxTimer instance
Return values
Stateof bit (1 or 0).

Definition at line 3023 of file stm32f4xx_ll_tim.h.

◆ LL_TIM_IsEnabledAutomaticOutput()

__STATIC_INLINE uint32_t LL_TIM_IsEnabledAutomaticOutput ( const TIM_TypeDef *  TIMx)

Indicate whether automatic output is enabled.

Note
Macro IS_TIM_BREAK_INSTANCE(TIMx) can be used to check whether or not a timer instance provides a break input. @rmtoll BDTR AOE LL_TIM_IsEnabledAutomaticOutput
Parameters
TIMxTimer instance
Return values
Stateof bit (1 or 0).

Definition at line 2980 of file stm32f4xx_ll_tim.h.

◆ LL_TIM_SetOffStates()

__STATIC_INLINE void LL_TIM_SetOffStates ( TIM_TypeDef *  TIMx,
uint32_t  OffStateIdle,
uint32_t  OffStateRun 
)

Select the outputs off state (enabled v.s. disabled) in Idle and Run modes.

Note
Macro IS_TIM_BREAK_INSTANCE(TIMx) can be used to check whether or not a timer instance provides a break input. @rmtoll BDTR OSSI LL_TIM_SetOffStates
BDTR OSSR LL_TIM_SetOffStates
Parameters
TIMxTimer instance
OffStateIdleThis parameter can be one of the following values:
  • LL_TIM_OSSI_DISABLE
  • LL_TIM_OSSI_ENABLE
OffStateRunThis parameter can be one of the following values:
  • LL_TIM_OSSR_DISABLE
  • LL_TIM_OSSR_ENABLE
Return values
None

Definition at line 2941 of file stm32f4xx_ll_tim.h.