STM8L15x Standard Peripherals Drivers: stm8l15x_tim2.c File Reference

STM8L15x/16x Standard Peripherals Drivers

previous page next page
STM8L15x Standard Peripherals Drivers
Functions

stm8l15x_tim2.c File Reference

This file provides firmware functions to manage the following functionalities of the TIM2 peripheral:

  • TimeBase management
  • Output Compare management
  • Input Capture management
  • Interrupts, DMA and flags management
  • Clocks management
  • Synchronization management
  • Specific interface management.
More...
#include "stm8l15x_TIM2.h"

Go to the source code of this file.

Functions

static void TI1_Config (TIM2_ICPolarity_TypeDef TIM2_ICPolarity, TIM2_ICSelection_TypeDef TIM2_ICSelection, uint8_t TIM2_ICFilter)
 Configure the TI1 as Input.
static void TI2_Config (TIM2_ICPolarity_TypeDef TIM2_ICPolarity, TIM2_ICSelection_TypeDef TIM2_ICSelection, uint8_t TIM2_ICFilter)
 Configure the TI2 as Input.
void TIM2_ARRPreloadConfig (FunctionalState NewState)
 Enables or disables TIM2 peripheral Preload register on ARR.
void TIM2_BKRConfig (TIM2_OSSIState_TypeDef TIM2_OSSIState, TIM2_LockLevel_TypeDef TIM2_LockLevel, TIM2_BreakState_TypeDef TIM2_BreakState, TIM2_BreakPolarity_TypeDef TIM2_BreakPolarity, TIM2_AutomaticOutput_TypeDef TIM2_AutomaticOutput)
 Configures the Break feature, dead time, Lock level, the OSSI, and the AOE(automatic output enable).
void TIM2_CCxCmd (TIM2_Channel_TypeDef TIM2_Channel, FunctionalState NewState)
 Enables or disables the TIM2 Capture Compare Channel x.
void TIM2_ClearFlag (TIM2_FLAG_TypeDef TIM2_FLAG)
 Clears the TIM�s pending flags.
void TIM2_ClearITPendingBit (TIM2_IT_TypeDef TIM2_IT)
 Clears the TIM's interrupt pending bits.
void TIM2_Cmd (FunctionalState NewState)
 Enables or disables the TIM2 peripheral.
void TIM2_CounterModeConfig (TIM2_CounterMode_TypeDef TIM2_CounterMode)
 Specifies the TIM2 Counter Mode to be used.
void TIM2_CtrlPWMOutputs (FunctionalState NewState)
 Enables or disables the TIM2 peripheral Main Outputs.
void TIM2_DeInit (void)
 Deinitialize the TIM2 peripheral registers to their default reset values.
void TIM2_DMACmd (TIM2_DMASource_TypeDef TIM2_DMASource, FunctionalState NewState)
 Enables or disables the TIM2 DMA Requests.
void TIM2_EncoderInterfaceConfig (TIM2_EncoderMode_TypeDef TIM2_EncoderMode, TIM2_ICPolarity_TypeDef TIM2_IC1Polarity, TIM2_ICPolarity_TypeDef TIM2_IC2Polarity)
 Configures the TIM2 Encoder Interface.
void TIM2_ETRClockMode1Config (TIM2_ExtTRGPSC_TypeDef TIM2_ExtTRGPrescaler, TIM2_ExtTRGPolarity_TypeDef TIM2_ExtTRGPolarity, uint8_t ExtTRGFilter)
 Configures the TIM2 External clock Mode1.
void TIM2_ETRClockMode2Config (TIM2_ExtTRGPSC_TypeDef TIM2_ExtTRGPrescaler, TIM2_ExtTRGPolarity_TypeDef TIM2_ExtTRGPolarity, uint8_t ExtTRGFilter)
 Configures the TIM2 External clock Mode2.
void TIM2_ETRConfig (TIM2_ExtTRGPSC_TypeDef TIM2_ExtTRGPrescaler, TIM2_ExtTRGPolarity_TypeDef TIM2_ExtTRGPolarity, uint8_t ExtTRGFilter)
 Configures the TIM2 External Trigger.
void TIM2_ForcedOC1Config (TIM2_ForcedAction_TypeDef TIM2_ForcedAction)
 Forces the TIM2 Channel1 output waveform to active or inactive level.
void TIM2_ForcedOC2Config (TIM2_ForcedAction_TypeDef TIM2_ForcedAction)
 Forces the TIM2 Channel2 output waveform to active or inactive level.
void TIM2_GenerateEvent (TIM2_EventSource_TypeDef TIM2_EventSource)
 Configures the TIM2 event to be generated by software.
uint16_t TIM2_GetCapture1 (void)
 Gets the TIM2 Input Capture 1 value.
uint16_t TIM2_GetCapture2 (void)
 Gets the TIM2 Input Capture 2 value.
uint16_t TIM2_GetCounter (void)
 Gets the TIM2 Counter value.
FlagStatus TIM2_GetFlagStatus (TIM2_FLAG_TypeDef TIM2_FLAG)
 Checks whether the specified TIM2 flag is set or not.
ITStatus TIM2_GetITStatus (TIM2_IT_TypeDef TIM2_IT)
 Checks whether the TIM2 interrupt has occurred or not.
TIM2_Prescaler_TypeDef TIM2_GetPrescaler (void)
 Gets the TIM2 Prescaler value.
void TIM2_ICInit (TIM2_Channel_TypeDef TIM2_Channel, TIM2_ICPolarity_TypeDef TIM2_ICPolarity, TIM2_ICSelection_TypeDef TIM2_ICSelection, TIM2_ICPSC_TypeDef TIM2_ICPrescaler, uint8_t TIM2_ICFilter)
 Initializes the TIM2 peripheral according to the specified parameters.
void TIM2_InternalClockConfig (void)
 Enables the TIM2 internal Clock.
void TIM2_ITConfig (TIM2_IT_TypeDef TIM2_IT, FunctionalState NewState)
 Enables or disables the specified TIM2 interrupts.
void TIM2_OC1FastConfig (FunctionalState NewState)
 Configures the TIM2 Capture Compare 1 Fast feature.
void TIM2_OC1Init (TIM2_OCMode_TypeDef TIM2_OCMode, TIM2_OutputState_TypeDef TIM2_OutputState, uint16_t TIM2_Pulse, TIM2_OCPolarity_TypeDef TIM2_OCPolarity, TIM2_OCIdleState_TypeDef TIM2_OCIdleState)
 Initializes the TIM2 Channel1 according to the specified parameters.
void TIM2_OC1PolarityConfig (TIM2_OCPolarity_TypeDef TIM2_OCPolarity)
 Configures the TIM2 Channel 1 polarity.
void TIM2_OC1PreloadConfig (FunctionalState NewState)
 Enables or disables the TIM2 peripheral Preload Register on CCR1.
void TIM2_OC2FastConfig (FunctionalState NewState)
 Configures the TIM2 Capture Compare 2 Fast feature.
void TIM2_OC2Init (TIM2_OCMode_TypeDef TIM2_OCMode, TIM2_OutputState_TypeDef TIM2_OutputState, uint16_t TIM2_Pulse, TIM2_OCPolarity_TypeDef TIM2_OCPolarity, TIM2_OCIdleState_TypeDef TIM2_OCIdleState)
 Initializes the TIM2 Channel2 according to the specified parameters.
void TIM2_OC2PolarityConfig (TIM2_OCPolarity_TypeDef TIM2_OCPolarity)
 Configures the TIM2 Channel 2 polarity.
void TIM2_OC2PreloadConfig (FunctionalState NewState)
 Enables or disables the TIM2 peripheral Preload Register on CCR2.
void TIM2_PrescalerConfig (TIM2_Prescaler_TypeDef Prescaler, TIM2_PSCReloadMode_TypeDef TIM2_PSCReloadMode)
 Configures the TIM2 Prescaler.
void TIM2_PWMIConfig (TIM2_Channel_TypeDef TIM2_Channel, TIM2_ICPolarity_TypeDef TIM2_ICPolarity, TIM2_ICSelection_TypeDef TIM2_ICSelection, TIM2_ICPSC_TypeDef TIM2_ICPrescaler, uint8_t TIM2_ICFilter)
 Configures the TIM2 peripheral in PWM Input Mode according to the specified parameters.
void TIM2_SelectCCDMA (FunctionalState NewState)
 Selects the TIM2 peripheral Capture Compare DMA source.
void TIM2_SelectHallSensor (FunctionalState NewState)
 Enables or Disables the TIM�s Hall sensor interface.
void TIM2_SelectInputTrigger (TIM2_TRGSelection_TypeDef TIM2_InputTriggerSource)
 Selects the TIM2 Input Trigger source.
void TIM2_SelectMasterSlaveMode (FunctionalState NewState)
 Sets or Resets the TIM2 Master/Slave Mode.
void TIM2_SelectOCxM (TIM2_Channel_TypeDef TIM2_Channel, TIM2_OCMode_TypeDef TIM2_OCMode)
 Selects the TIM2 Output Compare Mode.
void TIM2_SelectOnePulseMode (TIM2_OPMode_TypeDef TIM2_OPMode)
 Selects the TIM�s One Pulse Mode.
void TIM2_SelectOutputTrigger (TIM2_TRGOSource_TypeDef TIM2_TRGOSource)
 Selects the TIM2 Trigger Output Mode.
void TIM2_SelectSlaveMode (TIM2_SlaveMode_TypeDef TIM2_SlaveMode)
 Selects the TIM2 Slave Mode.
void TIM2_SetAutoreload (uint16_t Autoreload)
 Sets the TIM2 Autoreload Register value.
void TIM2_SetCompare1 (uint16_t Compare)
 Sets the TIM2 Capture Compare1 Register value.
void TIM2_SetCompare2 (uint16_t Compare)
 Sets the TIM2 Capture Compare2 Register value.
void TIM2_SetCounter (uint16_t Counter)
 Sets the TIM2 Counter Register value.
void TIM2_SetIC1Prescaler (TIM2_ICPSC_TypeDef TIM2_IC1Prescaler)
 Sets the TIM2 Input Capture 1 prescaler.
void TIM2_SetIC2Prescaler (TIM2_ICPSC_TypeDef TIM2_IC2Prescaler)
 Sets the TIM2 Input Capture 2 prescaler.
void TIM2_TimeBaseInit (TIM2_Prescaler_TypeDef TIM2_Prescaler, TIM2_CounterMode_TypeDef TIM2_CounterMode, uint16_t TIM2_Period)
 Initializes the TIM2 Time Base Unit according to the specified parameters.
void TIM2_TIxExternalClockConfig (TIM2_TIxExternalCLK1Source_TypeDef TIM2_TIxExternalCLKSource, TIM2_ICPolarity_TypeDef TIM2_ICPolarity, uint8_t ICFilter)
 Configures the TIM2 Trigger as External Clock.
void TIM2_UpdateDisableConfig (FunctionalState NewState)
 Enables or Disables the TIM2 Update event.
void TIM2_UpdateRequestConfig (TIM2_UpdateSource_TypeDef TIM2_UpdateSource)
 Selects the TIM2 Update Request Interrupt source.

Detailed Description

This file provides firmware functions to manage the following functionalities of the TIM2 peripheral:

  • TimeBase management
  • Output Compare management
  • Input Capture management
  • Interrupts, DMA and flags management
  • Clocks management
  • Synchronization management
  • Specific interface management.
Author:
MCD Application Team
Version:
V1.5.0
Date:
13-May-2011 
  *  
  *          ===================================================================
  *                                 How to use this driver
  *          ===================================================================
  *          This driver provides functions to configure and initialise the TIM2
  *          peripheral
  *          These functions are split in 7 groups: 
  *   
  *          1. TIM2 TimeBase management: this group includes all needed functions 
  *             to configure the TIM Timebase unit:
  *                   - Set/Get Prescaler
  *                   - Set/Get Autoreload  
  *                   - Counter modes configuration
  *                   - Select the One Pulse mode
  *                   - Update Request Configuration
  *                   - Update Disable Configuration
  *                   - Auto-Preload Configuration 
  *                   - Enable/Disable the counter
  *                 
  *          2. TIM2 Output Compare management: this group includes all needed 
  *             functions to configure the Capture/Compare unit used in Output 
  *             compare mode: 
  *                   - Configure each channel, independently, in Output Compare mode
  *                   - Select the output compare modes
  *                   - Select the Polarities of each channel
  *                   - Set/Get the Capture/Compare register values
  *                   - Select the Output Compare Fast mode 
  *                   - Select the Output Compare Forced mode  
  *                   - Output Compare-Preload Configuration 
  *                   - Enable/Disable the Capture/Compare Channels    
  *                   
  *          3. TIM2 Input Capture management: this group includes all needed 
  *             functions to configure the Capture/Compare unit used in 
  *             Input Capture mode:
  *                   - Configure each channel in input capture mode
  *                   - Configure Channel1/2 in PWM Input mode
  *                   - Set the Input Capture Prescaler
  *                   - Get the Capture/Compare values      
  *        
  *          4. TIM2 interrupts, DMA and flags management
  *                   - Enable/Disable interrupt sources
  *                   - Get flags status
  *                   - Clear flags/ Pending bits
  *                   - Enable/Disable DMA requests 
  *                   - Select CaptureCompare DMA request  
  *              
  *          5. TIM2 clocks management: this group includes all needed functions 
  *             to configure the clock controller unit:
  *                   - Select internal/External clock
  *                   - Select the external clock mode: ETR(Mode1/Mode2) or TIx
  *         
  *          6. TIM2 synchronization management: this group includes all needed 
  *             functions to configure the Synchronization unit:
  *                   - Select Input Trigger  
  *                   - Select Output Trigger  
  *                   - Select Master Slave Mode 
  *                   - ETR Configuration when used as external trigger   
  *     
  *          7. TIM2 specific interface management, this group includes all 
  *             needed functions to use the specific TIM2 interface:
  *                   - Encoder Interface Configuration
  *                   - Select Hall Sensor        
  *   
  *
Attention:

THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE TIME. AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY DIRECT, INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING FROM THE CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE CODING INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.

© COPYRIGHT 2011 STMicroelectronics

Definition in file stm8l15x_tim2.c.

STM8S Firmware Library: Overview

 

 

 

For complete documentation on STM8L15x 8-bit microcontrollers platform visit www.st.com

 

previous page start next page