Break function configuration

Functions
__STATIC_INLINE void	LL_TIM_EnableBRK (TIM_TypeDef *TIMx)
	Enable the break function.
__STATIC_INLINE void	LL_TIM_DisableBRK (TIM_TypeDef *TIMx)
	Disable the break function.
__STATIC_INLINE void	LL_TIM_ConfigBRK (TIM_TypeDef *TIMx, uint32_t BreakPolarity, uint32_t BreakFilter, uint32_t BreakAFMode)
	Configure the break input.
__STATIC_INLINE void	LL_TIM_DisarmBRK (TIM_TypeDef *TIMx)
	Disarm the break input (when it operates in bidirectional mode).
__STATIC_INLINE void	LL_TIM_ReArmBRK (TIM_TypeDef *TIMx)
	Re-arm the break input (when it operates in bidirectional mode).
__STATIC_INLINE void	LL_TIM_EnableBRK2 (TIM_TypeDef *TIMx)
	Enable the break 2 function.
__STATIC_INLINE void	LL_TIM_DisableBRK2 (TIM_TypeDef *TIMx)
	Disable the break 2 function.
__STATIC_INLINE void	LL_TIM_ConfigBRK2 (TIM_TypeDef *TIMx, uint32_t Break2Polarity, uint32_t Break2Filter, uint32_t Break2AFMode)
	Configure the break 2 input.
__STATIC_INLINE void	LL_TIM_DisarmBRK2 (TIM_TypeDef *TIMx)
	Disarm the break 2 input (when it operates in bidirectional mode).
__STATIC_INLINE void	LL_TIM_ReArmBRK2 (TIM_TypeDef *TIMx)
	Re-arm the break 2 input (when it operates in bidirectional mode).
__STATIC_INLINE void	LL_TIM_SetOffStates (TIM_TypeDef *TIMx, uint32_t OffStateIdle, uint32_t OffStateRun)
	Select the outputs off state (enabled v.s.
__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).
__STATIC_INLINE void	LL_TIM_DisableAutomaticOutput (TIM_TypeDef *TIMx)
	Disable automatic output (MOE can be set only by software).
__STATIC_INLINE uint32_t	LL_TIM_IsEnabledAutomaticOutput (TIM_TypeDef *TIMx)
	Indicate whether automatic output is enabled.
__STATIC_INLINE void	LL_TIM_EnableAllOutputs (TIM_TypeDef *TIMx)
	Enable the outputs (set the MOE bit in TIMx_BDTR register).
__STATIC_INLINE void	LL_TIM_DisableAllOutputs (TIM_TypeDef *TIMx)
	Disable the outputs (reset the MOE bit in TIMx_BDTR register).
__STATIC_INLINE uint32_t	LL_TIM_IsEnabledAllOutputs (TIM_TypeDef *TIMx)
	Indicates whether outputs are enabled.
__STATIC_INLINE void	LL_TIM_EnableBreakInputSource (TIM_TypeDef *TIMx, uint32_t BreakInput, uint32_t Source)
	Enable the signals connected to the designated timer break input.
__STATIC_INLINE void	LL_TIM_DisableBreakInputSource (TIM_TypeDef *TIMx, uint32_t BreakInput, uint32_t Source)
	Disable the signals connected to the designated timer break input.
__STATIC_INLINE void	LL_TIM_SetBreakInputSourcePolarity (TIM_TypeDef *TIMx, uint32_t BreakInput, uint32_t Source, uint32_t Polarity)
	Set the polarity of the break signal for the timer break input.

---

Function Documentation

__STATIC_INLINE void LL_TIM_ConfigBRK	(	TIM_TypeDef *	TIMx,
		uint32_t	BreakPolarity,
		uint32_t	BreakFilter,
		uint32_t	BreakAFMode
	)

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.

Bidirectional mode is only supported by advanced timer instances. Macro IS_TIM_ADVANCED_INSTANCE(TIMx) can be used to check whether or not a timer instance is an advanced-control timer.

In bidirectional mode (BKBID bit set), the Break input is configured both in input mode and in open drain output mode. Any active Break event will assert a low logic level on the Break input to indicate an internal break event to external devices.

When bidirectional mode isn't supported, BreakAFMode must be set to LL_TIM_BREAK_AFMODE_INPUT.

Reference Manual to LL API cross reference:

BDTR BKP LL_TIM_ConfigBRK
BDTR BKF LL_TIM_ConfigBRK
BDTR BKBID LL_TIM_ConfigBRK

Parameters:

TIMx	Timer instance
BreakPolarity	This parameter can be one of the following values: LL_TIM_BREAK_POLARITY_LOW LL_TIM_BREAK_POLARITY_HIGH
BreakFilter	This parameter can be one of the following values: LL_TIM_BREAK_FILTER_FDIV1 LL_TIM_BREAK_FILTER_FDIV1_N2 LL_TIM_BREAK_FILTER_FDIV1_N4 LL_TIM_BREAK_FILTER_FDIV1_N8 LL_TIM_BREAK_FILTER_FDIV2_N6 LL_TIM_BREAK_FILTER_FDIV2_N8 LL_TIM_BREAK_FILTER_FDIV4_N6 LL_TIM_BREAK_FILTER_FDIV4_N8 LL_TIM_BREAK_FILTER_FDIV8_N6 LL_TIM_BREAK_FILTER_FDIV8_N8 LL_TIM_BREAK_FILTER_FDIV16_N5 LL_TIM_BREAK_FILTER_FDIV16_N6 LL_TIM_BREAK_FILTER_FDIV16_N8 LL_TIM_BREAK_FILTER_FDIV32_N5 LL_TIM_BREAK_FILTER_FDIV32_N6 LL_TIM_BREAK_FILTER_FDIV32_N8
BreakAFMode	This parameter can be one of the following values: LL_TIM_BREAK_AFMODE_INPUT LL_TIM_BREAK_AFMODE_BIDIRECTIONAL

Return values:

None

Definition at line 3636 of file stm32h7xx_ll_tim.h.

__STATIC_INLINE void LL_TIM_ConfigBRK2	(	TIM_TypeDef *	TIMx,
		uint32_t	Break2Polarity,
		uint32_t	Break2Filter,
		uint32_t	Break2AFMode
	)

Configure the break 2 input.

Note:

Macro IS_TIM_BKIN2_INSTANCE(TIMx) can be used to check whether or not a timer instance provides a second break input.

Bidirectional mode is only supported by advanced timer instances. Macro IS_TIM_ADVANCED_INSTANCE(TIMx) can be used to check whether or not a timer instance is an advanced-control timer.

In bidirectional mode (BK2BID bit set), the Break 2 input is configured both in input mode and in open drain output mode. Any active Break event will assert a low logic level on the Break 2 input to indicate an internal break event to external devices.

When bidirectional mode isn't supported, Break2AFMode must be set to LL_TIM_BREAK2_AFMODE_INPUT.

Reference Manual to LL API cross reference:

BDTR BK2P LL_TIM_ConfigBRK2
BDTR BK2F LL_TIM_ConfigBRK2
BDTR BK2BID LL_TIM_ConfigBRK2

Parameters:

TIMx	Timer instance
Break2Polarity	This parameter can be one of the following values: LL_TIM_BREAK2_POLARITY_LOW LL_TIM_BREAK2_POLARITY_HIGH
Break2Filter	This parameter can be one of the following values: LL_TIM_BREAK2_FILTER_FDIV1 LL_TIM_BREAK2_FILTER_FDIV1_N2 LL_TIM_BREAK2_FILTER_FDIV1_N4 LL_TIM_BREAK2_FILTER_FDIV1_N8 LL_TIM_BREAK2_FILTER_FDIV2_N6 LL_TIM_BREAK2_FILTER_FDIV2_N8 LL_TIM_BREAK2_FILTER_FDIV4_N6 LL_TIM_BREAK2_FILTER_FDIV4_N8 LL_TIM_BREAK2_FILTER_FDIV8_N6 LL_TIM_BREAK2_FILTER_FDIV8_N8 LL_TIM_BREAK2_FILTER_FDIV16_N5 LL_TIM_BREAK2_FILTER_FDIV16_N6 LL_TIM_BREAK2_FILTER_FDIV16_N8 LL_TIM_BREAK2_FILTER_FDIV32_N5 LL_TIM_BREAK2_FILTER_FDIV32_N6 LL_TIM_BREAK2_FILTER_FDIV32_N8
Break2AFMode	This parameter can be one of the following values: LL_TIM_BREAK2_AFMODE_INPUT LL_TIM_BREAK2_AFMODE_BIDIRECTIONAL

Return values:

None

Definition at line 3777 of file stm32h7xx_ll_tim.h.

__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.

Reference Manual to LL API cross reference:

BDTR MOE LL_TIM_DisableAllOutputs

Parameters:

TIMx	Timer instance

Return values:

None

Definition at line 3932 of file stm32h7xx_ll_tim.h.

__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.

Reference Manual to LL API cross reference:

BDTR AOE LL_TIM_DisableAutomaticOutput

Parameters:

TIMx	Timer instance

Return values:

None

Definition at line 3889 of file stm32h7xx_ll_tim.h.

__STATIC_INLINE void LL_TIM_DisableBreakInputSource	(	TIM_TypeDef *	TIMx,
		uint32_t	BreakInput,
		uint32_t	Source
	)

Disable the signals connected to the designated timer break input.

Note:

Macro IS_TIM_BREAKSOURCE_INSTANCE(TIMx) can be used to check whether or not a timer instance allows for break input selection.

Reference Manual to LL API cross reference:

AF1 BKINE LL_TIM_DisableBreakInputSource
AF1 BKCMP1E LL_TIM_DisableBreakInputSource
AF1 BKCMP2E LL_TIM_DisableBreakInputSource
AF1 BKDF1BK0E LL_TIM_DisableBreakInputSource
AF2 BK2INE LL_TIM_DisableBreakInputSource
AF2 BK2CMP1E LL_TIM_DisableBreakInputSource
AF2 BK2CMP2E LL_TIM_DisableBreakInputSource
AF2 BK2DF1BK1E LL_TIM_DisableBreakInputSource

Parameters:

TIMx	Timer instance
BreakInput	This parameter can be one of the following values: LL_TIM_BREAK_INPUT_BKIN LL_TIM_BREAK_INPUT_BKIN2
Source	This parameter can be one of the following values: LL_TIM_BKIN_SOURCE_BKIN LL_TIM_BKIN_SOURCE_BKCOMP1 LL_TIM_BKIN_SOURCE_BKCOMP2 LL_TIM_BKIN_SOURCE_DF1BK

Return values:

None

Definition at line 4003 of file stm32h7xx_ll_tim.h.

__STATIC_INLINE void LL_TIM_DisableBRK

(

TIM_TypeDef *

TIMx

)

Disable the break function.

Reference Manual to LL API cross reference:

BDTR BKE LL_TIM_DisableBRK

Parameters:

TIMx	Timer 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 3588 of file stm32h7xx_ll_tim.h.

__STATIC_INLINE void LL_TIM_DisableBRK2

(

TIM_TypeDef *

TIMx

)

Disable the break 2 function.

Note:

Macro IS_TIM_BKIN2_INSTANCE(TIMx) can be used to check whether or not a timer instance provides a second break input.

Reference Manual to LL API cross reference:

BDTR BK2E LL_TIM_DisableBRK2

Parameters:

TIMx	Timer instance

Return values:

None

Definition at line 3729 of file stm32h7xx_ll_tim.h.

__STATIC_INLINE void LL_TIM_DisarmBRK

(

TIM_TypeDef *

TIMx

)

Disarm the break input (when it operates in bidirectional mode).

Note:

The break input can be disarmed only when it is configured in bidirectional mode and when when MOE is reset.

Purpose is to be able to have the input voltage back to high-state, whatever the time constant on the output .

Reference Manual to LL API cross reference:

BDTR BKDSRM LL_TIM_DisarmBRK

Parameters:

TIMx	Timer instance

Return values:

None

Definition at line 3690 of file stm32h7xx_ll_tim.h.

__STATIC_INLINE void LL_TIM_DisarmBRK2

(

TIM_TypeDef *

TIMx

)

Disarm the break 2 input (when it operates in bidirectional mode).

Note:

The break 2 input can be disarmed only when it is configured in bidirectional mode and when when MOE is reset.

Purpose is to be able to have the input voltage back to high-state, whatever the time constant on the output.

Reference Manual to LL API cross reference:

BDTR BK2DSRM LL_TIM_DisarmBRK2

Parameters:

TIMx	Timer instance

Return values:

None

Definition at line 3830 of file stm32h7xx_ll_tim.h.

__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.

Reference Manual to LL API cross reference:

BDTR MOE LL_TIM_EnableAllOutputs

Parameters:

TIMx	Timer instance

Return values:

None

Definition at line 3917 of file stm32h7xx_ll_tim.h.

__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.

Reference Manual to LL API cross reference:

BDTR AOE LL_TIM_EnableAutomaticOutput

Parameters:

TIMx	Timer instance

Return values:

None

Definition at line 3876 of file stm32h7xx_ll_tim.h.

__STATIC_INLINE void LL_TIM_EnableBreakInputSource	(	TIM_TypeDef *	TIMx,
		uint32_t	BreakInput,
		uint32_t	Source
	)

Enable the signals connected to the designated timer break input.

Note:

Macro IS_TIM_BREAKSOURCE_INSTANCE(TIMx) can be used to check whether or not a timer instance allows for break input selection.

Reference Manual to LL API cross reference:

AF1 BKINE LL_TIM_EnableBreakInputSource
AF1 BKCMP1E LL_TIM_EnableBreakInputSource
AF1 BKCMP2E LL_TIM_EnableBreakInputSource
AF1 BKDF1BK0E LL_TIM_EnableBreakInputSource
AF2 BK2INE LL_TIM_EnableBreakInputSource
AF2 BK2CMP1E LL_TIM_EnableBreakInputSource
AF2 BK2CMP2E LL_TIM_EnableBreakInputSource
AF2 BK2DF1BK1E LL_TIM_EnableBreakInputSource

Parameters:

TIMx	Timer instance
BreakInput	This parameter can be one of the following values: LL_TIM_BREAK_INPUT_BKIN LL_TIM_BREAK_INPUT_BKIN2
Source	This parameter can be one of the following values: LL_TIM_BKIN_SOURCE_BKIN LL_TIM_BKIN_SOURCE_BKCOMP1 LL_TIM_BKIN_SOURCE_BKCOMP2 LL_TIM_BKIN_SOURCE_DF1BK

Return values:

None

Definition at line 3974 of file stm32h7xx_ll_tim.h.

__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.

Reference Manual to LL API cross reference:

BDTR BKE LL_TIM_EnableBRK

Parameters:

TIMx	Timer instance

Return values:

None

Definition at line 3575 of file stm32h7xx_ll_tim.h.

__STATIC_INLINE void LL_TIM_EnableBRK2

(

TIM_TypeDef *

TIMx

)

Enable the break 2 function.

Note:

Macro IS_TIM_BKIN2_INSTANCE(TIMx) can be used to check whether or not a timer instance provides a second break input.

Reference Manual to LL API cross reference:

BDTR BK2E LL_TIM_EnableBRK2

Parameters:

TIMx	Timer instance

Return values:

None

Definition at line 3716 of file stm32h7xx_ll_tim.h.

__STATIC_INLINE uint32_t LL_TIM_IsEnabledAllOutputs

(

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.

Reference Manual to LL API cross reference:

BDTR MOE LL_TIM_IsEnabledAllOutputs

Parameters:

TIMx	Timer instance

Return values:

State

of bit (1 or 0).

Definition at line 3945 of file stm32h7xx_ll_tim.h.

__STATIC_INLINE uint32_t LL_TIM_IsEnabledAutomaticOutput

(

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.

Reference Manual to LL API cross reference:

BDTR AOE LL_TIM_IsEnabledAutomaticOutput

Parameters:

TIMx	Timer instance

Return values:

State

of bit (1 or 0).

Definition at line 3902 of file stm32h7xx_ll_tim.h.

__STATIC_INLINE void LL_TIM_ReArmBRK

(

TIM_TypeDef *

TIMx

)

Re-arm the break input (when it operates in bidirectional mode).

Note:

The Break input is automatically armed as soon as MOE bit is set.

Reference Manual to LL API cross reference:

BDTR BKDSRM LL_TIM_ReArmBRK

Parameters:

TIMx	Timer instance

Return values:

None

Definition at line 3702 of file stm32h7xx_ll_tim.h.

__STATIC_INLINE void LL_TIM_ReArmBRK2

(

TIM_TypeDef *

TIMx

)

Re-arm the break 2 input (when it operates in bidirectional mode).

Note:

The Break 2 input is automatically armed as soon as MOE bit is set.

Reference Manual to LL API cross reference:

BDTR BK2DSRM LL_TIM_ReArmBRK2

Parameters:

TIMx	Timer instance

Return values:

None

Definition at line 3842 of file stm32h7xx_ll_tim.h.

__STATIC_INLINE void LL_TIM_SetBreakInputSourcePolarity	(	TIM_TypeDef *	TIMx,
		uint32_t	BreakInput,
		uint32_t	Source,
		uint32_t	Polarity
	)

Set the polarity of the break signal for the timer break input.

Note:

Macro IS_TIM_BREAKSOURCE_INSTANCE(TIMx) can be used to check whether or not a timer instance allows for break input selection.

Reference Manual to LL API cross reference:

AF1 BKINP LL_TIM_SetBreakInputSourcePolarity
AF1 BKCMP1P LL_TIM_SetBreakInputSourcePolarity
AF1 BKCMP2P LL_TIM_SetBreakInputSourcePolarity
AF2 BK2INP LL_TIM_SetBreakInputSourcePolarity
AF2 BK2CMP1P LL_TIM_SetBreakInputSourcePolarity
AF2 BK2CMP2P LL_TIM_SetBreakInputSourcePolarity

Parameters:

TIMx	Timer instance
BreakInput	This parameter can be one of the following values: LL_TIM_BREAK_INPUT_BKIN LL_TIM_BREAK_INPUT_BKIN2
Source	This parameter can be one of the following values: LL_TIM_BKIN_SOURCE_BKIN LL_TIM_BKIN_SOURCE_BKCOMP1 LL_TIM_BKIN_SOURCE_BKCOMP2
Polarity	This parameter can be one of the following values: LL_TIM_BKIN_POLARITY_LOW LL_TIM_BKIN_POLARITY_HIGH

Return values:

None

Definition at line 4032 of file stm32h7xx_ll_tim.h.

References TIM_POSITION_BRK_SOURCE, and TIMx_AF1_BKINP.

__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.

Reference Manual to LL API cross reference:

BDTR OSSI LL_TIM_SetOffStates
BDTR OSSR LL_TIM_SetOffStates

Parameters:

TIMx	Timer instance
OffStateIdle	This parameter can be one of the following values: LL_TIM_OSSI_DISABLE LL_TIM_OSSI_ENABLE
OffStateRun	This parameter can be one of the following values: LL_TIM_OSSR_DISABLE LL_TIM_OSSR_ENABLE

Return values:

None

Definition at line 3863 of file stm32h7xx_ll_tim.h.