Martin Johnson / STM32F3-Discovery

Dependents:   Space_Invaders_Demo neopixels gpio_test_stm32f3_discovery gpio_test_systimer ... more

Embed: (wiki syntax)

« Back to documentation index

Advanced-control timers (TIM1 and TIM8) specific features

Advanced-control timers (TIM1 and TIM8) specific features
[TIM_Private_Functions]

Advanced-control timers (TIM1 and TIM8) specific features. More...

Functions

void TIM_BDTRConfig (TIM_TypeDef *TIMx, TIM_BDTRInitTypeDef *TIM_BDTRInitStruct)
 Configures the Break feature, dead time, Lock level, OSSI/OSSR State and the AOE(automatic output enable).
void TIM_Break1Config (TIM_TypeDef *TIMx, uint32_t TIM_Break1Polarity, uint8_t TIM_Break1Filter)
 Configures the Break1 feature.
void TIM_Break2Config (TIM_TypeDef *TIMx, uint32_t TIM_Break2Polarity, uint8_t TIM_Break2Filter)
 Configures the Break2 feature.
void TIM_Break1Cmd (TIM_TypeDef *TIMx, FunctionalState NewState)
 Enables or disables the TIM Break1 input.
void TIM_Break2Cmd (TIM_TypeDef *TIMx, FunctionalState NewState)
 Enables or disables the TIM Break2 input.
void TIM_BDTRStructInit (TIM_BDTRInitTypeDef *TIM_BDTRInitStruct)
 Fills each TIM_BDTRInitStruct member with its default value.
void TIM_CtrlPWMOutputs (TIM_TypeDef *TIMx, FunctionalState NewState)
 Enables or disables the TIM peripheral Main Outputs.
void TIM_SelectCOM (TIM_TypeDef *TIMx, FunctionalState NewState)
 Selects the TIM peripheral Commutation event.
void TIM_CCPreloadControl (TIM_TypeDef *TIMx, FunctionalState NewState)
 Sets or Resets the TIM peripheral Capture Compare Preload Control bit.

Detailed Description

Advanced-control timers (TIM1 and TIM8) specific features.

 ===============================================================================
     ##### Advanced-control timers (TIM1 and TIM8) specific features #####
 ===============================================================================  
       
  *** TIM Driver: how to use the Break feature ***
  ================================================ 
  [..]
  After configuring the Timer channel(s) in the appropriate Output Compare mode: 
                         
       (#) Fill the TIM_BDTRInitStruct with the desired parameters for the Timer
           Break Polarity, dead time, Lock level, the OSSI/OSSR State and the 
           AOE(automatic output enable).
               
       (#) Call TIM_BDTRConfig(TIMx, &TIM_BDTRInitStruct) to configure the Timer
          
       (#) Enable the Main Output using TIM_CtrlPWMOutputs(TIM1, ENABLE) 
          
       (#) Once the break even occurs, the Timer's output signals are put in reset
           state or in a known state (according to the configuration made in
           TIM_BDTRConfig() function).


Function Documentation

void TIM_BDTRConfig ( TIM_TypeDef *  TIMx,
TIM_BDTRInitTypeDef *  TIM_BDTRInitStruct 
)

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

Parameters:
TIMx,:where x can be 1, 8, 15, 16, 20 or 17 to select the TIM
TIM_BDTRInitStruct,:pointer to a TIM_BDTRInitTypeDef structure that contains the BDTR Register configuration information for the TIM peripheral.
Return values:
None

Definition at line 2714 of file stm32f30x_tim.c.

void TIM_BDTRStructInit ( TIM_BDTRInitTypeDef *  TIM_BDTRInitStruct )

Fills each TIM_BDTRInitStruct member with its default value.

Parameters:
TIM_BDTRInitStruct,:pointer to a TIM_BDTRInitTypeDef structure which will be initialized.
Return values:
None

Definition at line 2835 of file stm32f30x_tim.c.

void TIM_Break1Cmd ( TIM_TypeDef *  TIMx,
FunctionalState  NewState 
)

Enables or disables the TIM Break1 input.

Parameters:
TIMx,:where x can be 1, 8, 20, 16 or 17 to select the TIMx peripheral.
NewState,:new state of the TIM Break1 input. This parameter can be: ENABLE or DISABLE.
Return values:
None

Definition at line 2786 of file stm32f30x_tim.c.

void TIM_Break1Config ( TIM_TypeDef *  TIMx,
uint32_t  TIM_Break1Polarity,
uint8_t  TIM_Break1Filter 
)

Configures the Break1 feature.

Parameters:
TIMx,:where x can be 1 or 8 or 20 to select the TIM
TIM_Break1Polarity,:specifies the Break1 polarity. This parameter can be one of the following values:

  • TIM_Break1Polarity_Low: Break1 input is active low
  • TIM_Break1Polarity_High: Break1 input is active high
TIM_Break1Filter,:specifies the Break1 filter value. This parameter must be a value between 0x00 and 0x0F
Return values:
None

Definition at line 2744 of file stm32f30x_tim.c.

void TIM_Break2Cmd ( TIM_TypeDef *  TIMx,
FunctionalState  NewState 
)

Enables or disables the TIM Break2 input.

Parameters:
TIMx,:where x can be 1 or 8 or 20 to select the TIMx peripheral.
NewState,:new state of the TIM Break2 input. This parameter can be: ENABLE or DISABLE.
Return values:
None

Definition at line 2811 of file stm32f30x_tim.c.

void TIM_Break2Config ( TIM_TypeDef *  TIMx,
uint32_t  TIM_Break2Polarity,
uint8_t  TIM_Break2Filter 
)

Configures the Break2 feature.

Parameters:
TIMx,:where x can be 1 or 8 or 20 to select the TIM
TIM_Break2Polarity,:specifies the Break2 polarity. This parameter can be one of the following values:

  • TIM_Break2Polarity_Low: Break2 input is active low
  • TIM_Break2Polarity_High: Break2 input is active high
TIM_Break2Filter,:specifies the Break2 filter value. This parameter must be a value between 0x00 and 0x0F
Return values:
None

Definition at line 2766 of file stm32f30x_tim.c.

void TIM_CCPreloadControl ( TIM_TypeDef *  TIMx,
FunctionalState  NewState 
)

Sets or Resets the TIM peripheral Capture Compare Preload Control bit.

Parameters:
TIMx,:where x can be 1 or 8 or 20 to select the TIMx peripheral
NewState,:new state of the Capture Compare Preload Control bit This parameter can be: ENABLE or DISABLE.
Return values:
None

Definition at line 2904 of file stm32f30x_tim.c.

void TIM_CtrlPWMOutputs ( TIM_TypeDef *  TIMx,
FunctionalState  NewState 
)

Enables or disables the TIM peripheral Main Outputs.

Parameters:
TIMx,:where x can be 1, 8, 15, 16, 20 or 17 to select the TIMx peripheral.
NewState,:new state of the TIM peripheral Main Outputs. This parameter can be: ENABLE or DISABLE.
Return values:
None

Definition at line 2854 of file stm32f30x_tim.c.

void TIM_SelectCOM ( TIM_TypeDef *  TIMx,
FunctionalState  NewState 
)

Selects the TIM peripheral Commutation event.

Parameters:
TIMx,:where x can be 1, 8, 15, 16, 20 or 17 to select the TIMx peripheral
NewState,:new state of the Commutation event. This parameter can be: ENABLE or DISABLE.
Return values:
None

Definition at line 2879 of file stm32f30x_tim.c.