Output Compare management functions. More...

Modules
	Input Capture management functions
	Input Capture management functions.
	Interrupts DMA and flags management functions
	Interrupts, DMA and flags management functions.
	Clocks management functions
	Clocks management functions.
	Synchronization management functions
	Synchronization management functions.
	Specific interface management functions
	Specific interface management functions.
Functions
static void	TI1_Config (TIM5_ICPolarity_TypeDef TIM5_ICPolarity, TIM5_ICSelection_TypeDef TIM5_ICSelection, uint8_t TIM5_ICFilter)
	Configure the TI1 as Input.
static void	TI2_Config (TIM5_ICPolarity_TypeDef TIM5_ICPolarity, TIM5_ICSelection_TypeDef TIM5_ICSelection, uint8_t TIM5_ICFilter)
	Configure the TI2 as Input.
void	TIM5_BKRConfig (TIM5_OSSIState_TypeDef TIM5_OSSIState, TIM5_LockLevel_TypeDef TIM5_LockLevel, TIM5_BreakState_TypeDef TIM5_BreakState, TIM5_BreakPolarity_TypeDef TIM5_BreakPolarity, TIM5_AutomaticOutput_TypeDef TIM5_AutomaticOutput)
	Configures the Break feature, dead time, Lock level, the OSSI, and the AOE(automatic output enable).
void	TIM5_CCxCmd (TIM5_Channel_TypeDef TIM5_Channel, FunctionalState NewState)
	Enables or disables the TIM5 Capture Compare Channel x.
void	TIM5_CtrlPWMOutputs (FunctionalState NewState)
	Enables or disables the TIM5 peripheral Main Outputs.
void	TIM5_ForcedOC1Config (TIM5_ForcedAction_TypeDef TIM5_ForcedAction)
	Forces the TIM5 Channel1 output waveform to active or inactive level.
void	TIM5_ForcedOC2Config (TIM5_ForcedAction_TypeDef TIM5_ForcedAction)
	Forces the TIM5 Channel2 output waveform to active or inactive level.
void	TIM5_OC1FastConfig (FunctionalState NewState)
	Configures the TIM5 Capture Compare 1 Fast feature.
void	TIM5_OC1Init (TIM5_OCMode_TypeDef TIM5_OCMode, TIM5_OutputState_TypeDef TIM5_OutputState, uint16_t TIM5_Pulse, TIM5_OCPolarity_TypeDef TIM5_OCPolarity, TIM5_OCIdleState_TypeDef TIM5_OCIdleState)
	Initializes the TIM5 Channel1 according to the specified parameters.
void	TIM5_OC1PolarityConfig (TIM5_OCPolarity_TypeDef TIM5_OCPolarity)
	Configures the TIM5 Channel 1 polarity.
void	TIM5_OC1PreloadConfig (FunctionalState NewState)
	Enables or disables the TIM5 peripheral Preload Register on CCR1.
void	TIM5_OC2FastConfig (FunctionalState NewState)
	Configures the TIM5 Capture Compare 2 Fast feature.
void	TIM5_OC2Init (TIM5_OCMode_TypeDef TIM5_OCMode, TIM5_OutputState_TypeDef TIM5_OutputState, uint16_t TIM5_Pulse, TIM5_OCPolarity_TypeDef TIM5_OCPolarity, TIM5_OCIdleState_TypeDef TIM5_OCIdleState)
	Initializes the TIM5 Channel2 according to the specified parameters.
void	TIM5_OC2PolarityConfig (TIM5_OCPolarity_TypeDef TIM5_OCPolarity)
	Configures the TIM5 Channel 2 polarity.
void	TIM5_OC2PreloadConfig (FunctionalState NewState)
	Enables or disables the TIM5 peripheral Preload Register on CCR2.
void	TIM5_SelectOCxM (TIM5_Channel_TypeDef TIM5_Channel, TIM5_OCMode_TypeDef TIM5_OCMode)
	Selects the TIM5 Output Compare Mode.
void	TIM5_SetCompare1 (uint16_t Compare)
	Sets the TIM5 Capture Compare1 Register value.
void	TIM5_SetCompare2 (uint16_t Compare)
	Sets the TIM5 Capture Compare2 Register value.

Detailed Description

Output Compare management functions.

 ===============================================================================
                        Output Compare management functions
 ===============================================================================  
   
       ===================================================================      
              TIM5 Driver: how to use it in Output Compare Mode
       =================================================================== 
       To use the Timer in Output Compare mode, the following steps are mandatory:
       
       1. Enable TIM5 clock using CLK_PeripheralClockConfig(CLK_Peripheral_TIM5, ENABLE) function.
       
       2. Configure the TIM5 pins in output mode by configuring the corresponding GPIO pins
          
       3. Configure the Time base unit as described in the first part of this driver, if needed,
          otherwise the Timer will run with the default configuration:
          - Autoreload value = 0xFFFF
          - Prescaler value = 0x0000
          - Counter mode = Up counting
      
       4. Call TIM5_OCxInit() to configure the channel x with the desired parameters
          including:
          - TIM5 Output Compare mode: TIM5_OCMode
          - TIM5 Output State: TIM5_OutputState
          - TIM5 Pulse value: TIM5_Pulse
          - TIM5 Output Compare Polarity: TIM5_OCPolarity
          - TIM5 Output Idle State: TIM5_OCIdleState
       
       5. Call the TIM5_Cmd(ENABLE) function to enable the TIM5 counter.
       
       Note1: All other functions can be used separately to modify, if needed,
          a specific feature of the Timer. 
       
       Note2: If the corresponding interrupt or DMA request are needed, the user should:
              1. Enable global interrupts (or the DMA) to use the TIM5 interrupts (or DMA requests). 
              2. Enable the corresponding interrupt (or DMA request) using the function 
              TIM5_ITConfig(TIM5_IT_CCx) (or TIM5_DMACmd(TIM5_DMASource_CCx))

Function Documentation

static void TI1_Config	(	TIM5_ICPolarity_TypeDef	TIM5_ICPolarity,
		TIM5_ICSelection_TypeDef	TIM5_ICSelection,
		uint8_t	TIM5_ICFilter
	)		`[static]`

Configure the TI1 as Input.

Parameters:

TIM5_ICPolarity,:	Input Capture Polarity This parameter can be one of the following values: TIM5_ICPolarity_Rising: Input Capture on Rising Edge TIM5_ICPolarity_Falling: Input Capture on Falling Edge
TIM5_ICSelection,:	Specifies the input to be used. This parameter can be one of the following values: TIM5_ICSelection_DirectTI: Input Capture mapped on the direct input TIM5_ICSelection_IndirectTI: Input Capture mapped on the indirect input TIM5_ICSelection_TRGI: Input Capture mapped on the Trigger Input
TIM5_ICFilter,:	Specifies the Input Capture Filter. This parameter must be a value between 0x00 and 0x0F.

Return values:

None

Definition at line 2044 of file stm8l15x_tim5.c.

References IS_TIM5_IC_FILTER, IS_TIM5_IC_POLARITY, IS_TIM5_IC_SELECTION, TIM5, TIM5_ICPolarity_Falling, TIM_CCER1_CC1E, TIM_CCER1_CC1P, TIM_CCMR_CCxS, and TIM_CCMR_ICxF.

Referenced by TIM5_ICInit(), TIM5_PWMIConfig(), and TIM5_TIxExternalClockConfig().

static void TI2_Config	(	TIM5_ICPolarity_TypeDef	TIM5_ICPolarity,
		TIM5_ICSelection_TypeDef	TIM5_ICSelection,
		uint8_t	TIM5_ICFilter
	)		`[static]`

Configure the TI2 as Input.

Parameters:

TIM5_ICPolarity,:	Input Capture Polarity This parameter can be one of the following values: TIM5_ICPolarity_Rising: Input Capture on Rising Edge TIM5_ICPolarity_Falling: Input Capture on Falling Edge
TIM5_ICSelection,:	Specifies the input to be used. This parameter can be one of the following values: TIM5_ICSelection_DirectTI: Input Capture mapped on the direct input TIM5_ICSelection_IndirectTI: Input Capture mapped on the indirect input TIM5_ICSelection_TRGI: Input Capture mapped on the Trigger Input
TIM5_ICFilter,:	Specifies the Input Capture Filter. This parameter must be a value between 0x00 and 0x0F.

Return values:

None

Definition at line 2095 of file stm8l15x_tim5.c.

References IS_TIM5_IC_FILTER, IS_TIM5_IC_POLARITY, IS_TIM5_IC_SELECTION, TIM5, TIM5_ICPolarity_Falling, TIM_CCER1_CC2E, TIM_CCER1_CC2P, TIM_CCMR_CCxS, and TIM_CCMR_ICxF.

Referenced by TIM5_ICInit(), TIM5_PWMIConfig(), and TIM5_TIxExternalClockConfig().

void TIM5_BKRConfig	(	TIM5_OSSIState_TypeDef	TIM5_OSSIState,
		TIM5_LockLevel_TypeDef	TIM5_LockLevel,
		TIM5_BreakState_TypeDef	TIM5_BreakState,
		TIM5_BreakPolarity_TypeDef	TIM5_BreakPolarity,
		TIM5_AutomaticOutput_TypeDef	TIM5_AutomaticOutput
	)

Configures the Break feature, dead time, Lock level, the OSSI, and the AOE(automatic output enable).

Parameters:

TIM5_OSSIState,:	Off-State Selection for Idle mode states. This parameter can be one of the following values: TIM5_OSSIState_Enable: Off-State Selection for Idle mode enabled TIM5_OSSIState_Disable: Off-State Selection for Idle mode disabled
TIM5_LockLevel,:	Lock level. This parameter can be one of the following values: TIM5_LockLevel_Off: Lock option disabled TIM5_LockLevel_1: Select Lock Level 1 TIM5_LockLevel_2: Select Lock Level 2 TIM5_LockLevel_3: Select Lock Level 3
TIM5_BreakState,:	Break Input enable/disable . This parameter can be one of the following values: TIM5_BreakState_Disable: Break State disabled (break option disabled) TIM5_BreakState_Enable: Break State enabled (break option enabled)
TIM5_BreakPolarity,:	Break Polarity. This parameter can be one of the following values: TIM5_BreakPolarity_High: if Break, channel polarity = High TIM5_BreakPolarity_Low: if Break, channel polarity = Low
TIM5_AutomaticOutput,:	TIM5 AOE Bit Set/Reset . This parameter can be one of the following values: TIM5_AutomaticOutput_Enable: Automatic Output option enabled TIM5_AutomaticOutput_Disable: Automatic Output option disabled

Return values:

None

Definition at line 748 of file stm8l15x_tim5.c.

References IS_TIM5_AUTOMATIC_OUTPUT_STATE, IS_TIM5_BREAK_POLARITY, IS_TIM5_BREAK_STATE, IS_TIM5_LOCK_LEVEL, IS_TIM5_OSSI_STATE, and TIM5.

void TIM5_CCxCmd	(	TIM5_Channel_TypeDef	TIM5_Channel,
		FunctionalState	NewState
	)

Enables or disables the TIM5 Capture Compare Channel x.

Parameters:

TIM5_Channel,:	Specifies the TIM5 Channel. This parameter can be one of the following values: TIM5_Channel_1: Channel 1 TIM5_Channel_2: Channel 2
NewState,:	Specifies the TIM5 Channel CCxE bit new state. This parameter can be ENABLE or DISABLE

Return values:

None

Definition at line 1068 of file stm8l15x_tim5.c.

References DISABLE, IS_FUNCTIONAL_STATE, IS_TIM5_CHANNEL, TIM5, TIM5_Channel_1, TIM_CCER1_CC1E, and TIM_CCER1_CC2E.

void TIM5_CtrlPWMOutputs ( FunctionalState NewState )

Enables or disables the TIM5 peripheral Main Outputs.

Parameters:

NewState,: The new state of the TIM5 peripheral. This parameter can be ENABLE or DISABLE

Return values:

None

Definition at line 777 of file stm8l15x_tim5.c.

References DISABLE, IS_FUNCTIONAL_STATE, TIM5, and TIM_BKR_MOE.

void TIM5_ForcedOC1Config ( TIM5_ForcedAction_TypeDef TIM5_ForcedAction )

Forces the TIM5 Channel1 output waveform to active or inactive level.

Parameters:

TIM5_ForcedAction,:

Specifies the forced Action to be set to the output waveform. This parameter can be one of the following values:

TIM5_ForcedAction_Active: Output Reference is forced low
TIM5_ForcedAction_Inactive: Output Reference is forced high

Return values:

None

Definition at line 877 of file stm8l15x_tim5.c.

References IS_TIM5_FORCED_ACTION, TIM5, and TIM_CCMR_OCM.

void TIM5_ForcedOC2Config ( TIM5_ForcedAction_TypeDef TIM5_ForcedAction )

Forces the TIM5 Channel2 output waveform to active or inactive level.

Parameters:

TIM5_ForcedAction,:

Specifies the forced Action to be set to the output waveform. This parameter can be one of the following values:

TIM5_ForcedAction_Active: Output Reference is forced low
TIM5_ForcedAction_Inactive: Output Reference is forced high

Return values:

None

Definition at line 903 of file stm8l15x_tim5.c.

References IS_TIM5_FORCED_ACTION, TIM5, and TIM_CCMR_OCM.

void TIM5_OC1FastConfig ( FunctionalState NewState )

Configures the TIM5 Capture Compare 1 Fast feature.

Parameters:

NewState,: The new state of the Output Compare Fast Enable bit. This parameter can be ENABLE or DISABLE

Return values:

None

Definition at line 971 of file stm8l15x_tim5.c.

References DISABLE, IS_FUNCTIONAL_STATE, TIM5, and TIM_CCMR_OCxFE.

void TIM5_OC1Init	(	TIM5_OCMode_TypeDef	TIM5_OCMode,
		TIM5_OutputState_TypeDef	TIM5_OutputState,
		uint16_t	TIM5_Pulse,
		TIM5_OCPolarity_TypeDef	TIM5_OCPolarity,
		TIM5_OCIdleState_TypeDef	TIM5_OCIdleState
	)

Initializes the TIM5 Channel1 according to the specified parameters.

Parameters:

TIM5_OCMode,:	Output Compare Mode This parameter can be one of the following values: TIM5_OCMode_Timing: Timing (Frozen) Mode TIM5_OCMode_Active: Active Mode TIM5_OCMode_Inactive: Inactive Mode TIM5_OCMode_Toggle: Toggle Mode TIM5_OCMode_PWM1: PWM Mode 1 TIM5_OCMode_PWM2: PWM Mode 2
TIM5_OutputState,:	Output state This parameter can be one of the following values: TIM5_OutputState_Disable: Output compare State disabled (channel output disabled) TIM5_OutputState_Enable: Output compare State enabled (channel output enabled)
TIM5_Pulse,:	This parameter must be a value between 0x0000 and 0xFFFF.
TIM5_OCPolarity,:	Polarity This parameter can be one of the following values: TIM5_OCPolarity_High: Output compare polarity = High TIM5_OCPolarity_Low: Output compare polarity = Low
TIM5_OCIdleState,:	Output Compare Idle State This parameter can be one of the following values: TIM5_OCIdleState_Reset: Output Compare Idle state = Reset TIM5_OCIdleState_Set: Output Compare Idle state = Set

Return values:

None

Definition at line 572 of file stm8l15x_tim5.c.

References IS_TIM5_OC_MODE, IS_TIM5_OC_POLARITY, IS_TIM5_OCIDLE_STATE, IS_TIM5_OUTPUT_STATE, TIM5, TIM5_OCIdleState_Set, TIM5_OCPolarity_Low, TIM5_OutputState_Enable, TIM_CCER1_CC1E, TIM_CCER1_CC1P, TIM_CCMR_OCM, and TIM_OISR_OIS1.

void TIM5_OC1PolarityConfig ( TIM5_OCPolarity_TypeDef TIM5_OCPolarity )

Configures the TIM5 Channel 1 polarity.

Parameters:

TIM5_OCPolarity,:

Specifies the OC1 Polarity. This parameter can be one of the following values:

TIM5_OCPolarity_High: Output compare polarity = High
TIM5_OCPolarity_Low: Output compare polarity = Low

Return values:

None

Definition at line 1018 of file stm8l15x_tim5.c.

References IS_TIM5_OC_POLARITY, TIM5, TIM5_OCPolarity_Low, and TIM_CCER1_CC1P.

void TIM5_OC1PreloadConfig ( FunctionalState NewState )

Enables or disables the TIM5 peripheral Preload Register on CCR1.

Parameters:

NewState,: The new state of the Capture Compare Preload register. This parameter can be ENABLE or DISABLE

Return values:

None

Definition at line 927 of file stm8l15x_tim5.c.

References DISABLE, IS_FUNCTIONAL_STATE, TIM5, and TIM_CCMR_OCxPE.

void TIM5_OC2FastConfig ( FunctionalState NewState )

Configures the TIM5 Capture Compare 2 Fast feature.

Parameters:

NewState,: The new state of the Output Compare Fast Enable bit. This parameter can be ENABLE or DISABLE

Return values:

None

Definition at line 994 of file stm8l15x_tim5.c.

References DISABLE, IS_FUNCTIONAL_STATE, TIM5, and TIM_CCMR_OCxFE.

void TIM5_OC2Init	(	TIM5_OCMode_TypeDef	TIM5_OCMode,
		TIM5_OutputState_TypeDef	TIM5_OutputState,
		uint16_t	TIM5_Pulse,
		TIM5_OCPolarity_TypeDef	TIM5_OCPolarity,
		TIM5_OCIdleState_TypeDef	TIM5_OCIdleState
	)

Initializes the TIM5 Channel2 according to the specified parameters.

Parameters:

TIM5_OCMode,:	Output Compare Mode This parameter can be one of the following values: TIM5_OCMode_Timing: Timing (Frozen) Mode TIM5_OCMode_Active: Active Mode TIM5_OCMode_Inactive: Inactive Mode TIM5_OCMode_Toggle: Toggle Mode TIM5_OCMode_PWM1: PWM Mode 1 TIM5_OCMode_PWM2: PWM Mode 2
TIM5_OutputState,:	Output state This parameter can be one of the following values: TIM5_OutputState_Disable: Output compare State disabled (channel output disabled) TIM5_OutputState_Enable: Output compare State enabled (channel output enabled)
TIM5_Pulse,:	This parameter must be a value between 0x0000 and 0xFFFF.
TIM5_OCPolarity,:	Polarity This parameter can be one of the following values: TIM5_OCPolarity_High: Output compare polarity = High TIM5_OCPolarity_Low: Output compare polarity = Low
TIM5_OCIdleState,:	Output Compare Idle State This parameter can be one of the following values: TIM5_OCIdleState_Reset: Output Compare Idle state = Reset TIM5_OCIdleState_Set: Output Compare Idle state = Set

Return values:

None

Definition at line 658 of file stm8l15x_tim5.c.

References IS_TIM5_OC_MODE, IS_TIM5_OC_POLARITY, IS_TIM5_OCIDLE_STATE, IS_TIM5_OUTPUT_STATE, TIM5, TIM5_OCIdleState_Set, TIM5_OCPolarity_Low, TIM5_OutputState_Enable, TIM_CCER1_CC2E, TIM_CCER1_CC2P, TIM_CCMR_OCM, and TIM_OISR_OIS2.

void TIM5_OC2PolarityConfig ( TIM5_OCPolarity_TypeDef TIM5_OCPolarity )

Configures the TIM5 Channel 2 polarity.

Parameters:

TIM5_OCPolarity,:

Specifies the OC2 Polarity. This parameter can be one of the following values:

TIM5_OCPolarity_High: Output compare polarity = High
TIM5_OCPolarity_Low: Output compare polarity = Low

Return values:

None

Definition at line 1042 of file stm8l15x_tim5.c.

References IS_TIM5_OC_POLARITY, TIM5, TIM5_OCPolarity_Low, and TIM_CCER1_CC2P.

void TIM5_OC2PreloadConfig ( FunctionalState NewState )

Enables or disables the TIM5 peripheral Preload Register on CCR2.

Parameters:

NewState,: The new state of the Capture Compare Preload register. This parameter can be ENABLE or DISABLE

Return values:

None

Definition at line 949 of file stm8l15x_tim5.c.

References DISABLE, IS_FUNCTIONAL_STATE, TIM5, and TIM_CCMR_OCxPE.

void TIM5_SelectOCxM	(	TIM5_Channel_TypeDef	TIM5_Channel,
		TIM5_OCMode_TypeDef	TIM5_OCMode
	)

Selects the TIM5 Output Compare Mode.

This function disables the selected channel before changing the Output Compare Mode. User has to enable this channel using TIM5_CCxCmd and TIM5_CCxNCmd functions.

Parameters:

TIM5_Channel,:	Specifies the TIM5 Channel. This parameter can be one of the following values: TIM5_Channel_1: Channel 1 TIM5_Channel_2: Channel 2
TIM5_OCMode,:	Specifies the TIM5 Output Compare Mode. This parameter can be one of the following values: TIM5_OCMode_Timing: Timing (Frozen) Mode TIM5_OCMode_Active: Active Mode TIM5_OCMode_Inactive: Inactive Mode TIM5_OCMode_Toggle: Toggle Mode TIM5_OCMode_PWM1: PWM Mode 1 TIM5_OCMode_PWM2: PWM Mode 2

Return values:

None

Definition at line 812 of file stm8l15x_tim5.c.

References IS_TIM5_CHANNEL, IS_TIM5_OCM, TIM5, TIM5_Channel_1, TIM_CCER1_CC1E, TIM_CCER1_CC2E, and TIM_CCMR_OCM.

void TIM5_SetCompare1 ( uint16_t Compare )

Sets the TIM5 Capture Compare1 Register value.

Parameters:

Compare,: Specifies the Capture Compare1 register new value. This parameter is between 0x0000 and 0xFFFF.

Return values:

None

Definition at line 849 of file stm8l15x_tim5.c.

References TIM5.

void TIM5_SetCompare2 ( uint16_t Compare )

Sets the TIM5 Capture Compare2 Register value.

Parameters:

Compare,: Specifies the Capture Compare2 register new value. This parameter is between 0x0000 and 0xFFFF.

Return values:

None

Definition at line 862 of file stm8l15x_tim5.c.

References TIM5.

STM8L15x Standard Peripherals Drivers: Output Compare management functions

STM8L15x/16x Standard Peripherals Drivers

Output Compare management functions

Modules

Functions

Detailed Description

Function Documentation

Get in touch