STM8S/A Standard Peripherals Firmware Library: TIM3_Exported_Types

STM8S/A

previous page next page
STM8S/A Standard Peripherals Firmware Library
Defines | Enumerations
TIM3_Exported_Types
STM8S_StdPeriph_Driver

Defines

#define IS_TIM3_CHANNEL_OK(CHANNEL)
#define IS_TIM3_CLEAR_FLAG_OK(FLAG)   ((((uint16_t)(FLAG) & 0xF9F8) == 0x0000) && ((uint16_t)(FLAG)!= 0x0000))
#define IS_TIM3_EVENT_SOURCE_OK(SOURCE)   (((SOURCE) != 0x00))
#define IS_TIM3_FORCED_ACTION_OK(ACTION)
#define IS_TIM3_GET_FLAG_OK(FLAG)
#define IS_TIM3_GET_IT_OK(IT)
#define IS_TIM3_IC_FILTER_OK(ICFILTER)   ((ICFILTER) <= 0x0F)
 TIM3 Input Capture Filer Value.
#define IS_TIM3_IC_POLARITY_OK(POLARITY)
#define IS_TIM3_IC_PRESCALER_OK(PRESCALER)
#define IS_TIM3_IC_SELECTION_OK(SELECTION)
#define IS_TIM3_IT_OK(IT)   (((IT) != 0x00) && ((IT) <= 0x07))
#define IS_TIM3_OC_MODE_OK(MODE)
#define IS_TIM3_OC_POLARITY_OK(POLARITY)
#define IS_TIM3_OCM_OK(MODE)
#define IS_TIM3_OPM_MODE_OK(MODE)
#define IS_TIM3_OUTPUT_STATE_OK(STATE)
#define IS_TIM3_PRESCALER_OK(PRESCALER)
#define IS_TIM3_PRESCALER_RELOAD_OK(RELOAD)
#define IS_TIM3_PWMI_CHANNEL_OK(CHANNEL)
#define IS_TIM3_UPDATE_SOURCE_OK(SOURCE)

Enumerations

enum  TIM3_Channel_TypeDef { TIM3_CHANNEL_1 = ((uint8_t)0x00), TIM3_CHANNEL_2 = ((uint8_t)0x01) }
 TIM3 Channel. More...
enum  TIM3_EventSource_TypeDef { TIM3_EVENTSOURCE_UPDATE = ((uint8_t)0x01), TIM3_EVENTSOURCE_CC1 = ((uint8_t)0x02), TIM3_EVENTSOURCE_CC2 = ((uint8_t)0x04) }
 TIM3 Event Source. More...
enum  TIM3_FLAG_TypeDef {
  TIM3_FLAG_UPDATE = ((uint16_t)0x0001), TIM3_FLAG_CC1 = ((uint16_t)0x0002), TIM3_FLAG_CC2 = ((uint16_t)0x0004), TIM3_FLAG_CC1OF = ((uint16_t)0x0200),
  TIM3_FLAG_CC2OF = ((uint16_t)0x0400)
}
 TIM3 Flags. More...
enum  TIM3_ForcedAction_TypeDef { TIM3_FORCEDACTION_ACTIVE = ((uint8_t)0x50), TIM3_FORCEDACTION_INACTIVE = ((uint8_t)0x40) }
 TIM3 Forced Action. More...
enum  TIM3_ICPolarity_TypeDef { TIM3_ICPOLARITY_RISING = ((uint8_t)0x00), TIM3_ICPOLARITY_FALLING = ((uint8_t)0x44) }
 TIM3 Input Capture Polarity. More...
enum  TIM3_ICPSC_TypeDef { TIM3_ICPSC_DIV1 = ((uint8_t)0x00), TIM3_ICPSC_DIV2 = ((uint8_t)0x04), TIM3_ICPSC_DIV4 = ((uint8_t)0x08), TIM3_ICPSC_DIV8 = ((uint8_t)0x0C) }
 TIM3 Input Capture Prescaler. More...
enum  TIM3_ICSelection_TypeDef { TIM3_ICSELECTION_DIRECTTI = ((uint8_t)0x01), TIM3_ICSELECTION_INDIRECTTI = ((uint8_t)0x02), TIM3_ICSELECTION_TRGI = ((uint8_t)0x03) }
 TIM3 Input Capture Selection. More...
enum  TIM3_IT_TypeDef { TIM3_IT_UPDATE = ((uint8_t)0x01), TIM3_IT_CC1 = ((uint8_t)0x02), TIM3_IT_CC2 = ((uint8_t)0x04) }
 TIM3 interrupt sources. More...
enum  TIM3_OCMode_TypeDef {
  TIM3_OCMODE_TIMING = ((uint8_t)0x00), TIM3_OCMODE_ACTIVE = ((uint8_t)0x10), TIM3_OCMODE_INACTIVE = ((uint8_t)0x20), TIM3_OCMODE_TOGGLE = ((uint8_t)0x30),
  TIM3_OCMODE_PWM1 = ((uint8_t)0x60), TIM3_OCMODE_PWM2 = ((uint8_t)0x70)
}
 TIM3 Output Compare and PWM modes. More...
enum  TIM3_OCPolarity_TypeDef { TIM3_OCPOLARITY_HIGH = ((uint8_t)0x00), TIM3_OCPOLARITY_LOW = ((uint8_t)0x22) }
 TIM3 Output Compare Polarity. More...
enum  TIM3_OPMode_TypeDef { TIM3_OPMODE_SINGLE = ((uint8_t)0x01), TIM3_OPMODE_REPETITIVE = ((uint8_t)0x00) }
 TIM3 One Pulse Mode. More...
enum  TIM3_OutputState_TypeDef { TIM3_OUTPUTSTATE_DISABLE = ((uint8_t)0x00), TIM3_OUTPUTSTATE_ENABLE = ((uint8_t)0x11) }
 TIM3 Output Compare states. More...
enum  TIM3_Prescaler_TypeDef {
  TIM3_PRESCALER_1 = ((uint8_t)0x00), TIM3_PRESCALER_2 = ((uint8_t)0x01), TIM3_PRESCALER_4 = ((uint8_t)0x02), TIM3_PRESCALER_8 = ((uint8_t)0x03),
  TIM3_PRESCALER_16 = ((uint8_t)0x04), TIM3_PRESCALER_32 = ((uint8_t)0x05), TIM3_PRESCALER_64 = ((uint8_t)0x06), TIM3_PRESCALER_128 = ((uint8_t)0x07),
  TIM3_PRESCALER_256 = ((uint8_t)0x08), TIM3_PRESCALER_512 = ((uint8_t)0x09), TIM3_PRESCALER_1024 = ((uint8_t)0x0A), TIM3_PRESCALER_2048 = ((uint8_t)0x0B),
  TIM3_PRESCALER_4096 = ((uint8_t)0x0C), TIM3_PRESCALER_8192 = ((uint8_t)0x0D), TIM3_PRESCALER_16384 = ((uint8_t)0x0E), TIM3_PRESCALER_32768 = ((uint8_t)0x0F)
}
 TIM3 Prescaler. More...
enum  TIM3_PSCReloadMode_TypeDef { TIM3_PSCRELOADMODE_UPDATE = ((uint8_t)0x00), TIM3_PSCRELOADMODE_IMMEDIATE = ((uint8_t)0x01) }
 TIM3 Prescaler Reload Mode. More...
enum  TIM3_UpdateSource_TypeDef { TIM3_UPDATESOURCE_GLOBAL = ((uint8_t)0x00), TIM3_UPDATESOURCE_REGULAR = ((uint8_t)0x01) }
 TIM3 Update Source. More...

Define Documentation

#define IS_TIM3_CHANNEL_OK (   CHANNEL)
Value:
(((CHANNEL) == TIM3_CHANNEL_1) || \
                                     ((CHANNEL) == TIM3_CHANNEL_2))

Definition at line 138 of file stm8s_tim3.h.

Referenced by TIM3_CCxCmd(), TIM3_ICInit(), and TIM3_SelectOCxM().

#define IS_TIM3_CLEAR_FLAG_OK (   FLAG)    ((((uint16_t)(FLAG) & 0xF9F8) == 0x0000) && ((uint16_t)(FLAG)!= 0x0000))

Definition at line 263 of file stm8s_tim3.h.

Referenced by TIM3_ClearFlag().

#define IS_TIM3_EVENT_SOURCE_OK (   SOURCE)    (((SOURCE) != 0x00))

Definition at line 235 of file stm8s_tim3.h.

Referenced by TIM3_GenerateEvent().

#define IS_TIM3_FORCED_ACTION_OK (   ACTION)
Value:
(((ACTION) == TIM3_FORCEDACTION_ACTIVE) || \
    ((ACTION) == TIM3_FORCEDACTION_INACTIVE))

Definition at line 52 of file stm8s_tim3.h.

Referenced by TIM3_ForcedOC1Config(), and TIM3_ForcedOC2Config().

#define IS_TIM3_GET_FLAG_OK (   FLAG)
Value:
(((FLAG) == TIM3_FLAG_UPDATE) || \
                                   ((FLAG) == TIM3_FLAG_CC1) || \
                                   ((FLAG) == TIM3_FLAG_CC2) || \
                                   ((FLAG) == TIM3_FLAG_CC1OF) || \
                                   ((FLAG) == TIM3_FLAG_CC2OF) )

Definition at line 257 of file stm8s_tim3.h.

Referenced by TIM3_GetFlagStatus().

#define IS_TIM3_GET_IT_OK (   IT)
Value:
(((IT) == TIM3_IT_UPDATE) || \
                               ((IT) == TIM3_IT_CC1) || \
                               ((IT) == TIM3_IT_CC2))

Definition at line 213 of file stm8s_tim3.h.

Referenced by TIM3_GetITStatus().

#define IS_TIM3_IC_FILTER_OK (   ICFILTER)    ((ICFILTER) <= 0x0F)

TIM3 Input Capture Filer Value.

Definition at line 201 of file stm8s_tim3.h.

Referenced by TIM3_ICInit().

#define IS_TIM3_IC_POLARITY_OK (   POLARITY)
Value:
(((POLARITY) == TIM3_ICPOLARITY_RISING) || \
    ((POLARITY) == TIM3_ICPOLARITY_FALLING))

Definition at line 171 of file stm8s_tim3.h.

Referenced by TIM3_ICInit(), and TIM3_PWMIConfig().

#define IS_TIM3_IC_PRESCALER_OK (   PRESCALER)
Value:
(((PRESCALER) == TIM3_ICPSC_DIV1) || \
    ((PRESCALER) == TIM3_ICPSC_DIV2) || \
    ((PRESCALER) == TIM3_ICPSC_DIV4) || \
    ((PRESCALER) == TIM3_ICPSC_DIV8))

Definition at line 195 of file stm8s_tim3.h.

Referenced by TIM3_ICInit(), TIM3_PWMIConfig(), TIM3_SetIC1Prescaler(), and TIM3_SetIC2Prescaler().

#define IS_TIM3_IC_SELECTION_OK (   SELECTION)
Value:
(((SELECTION) == TIM3_ICSELECTION_DIRECTTI) || \
    ((SELECTION) == TIM3_ICSELECTION_INDIRECTTI) || \
    ((SELECTION) == TIM3_ICSELECTION_TRGI))

Definition at line 182 of file stm8s_tim3.h.

Referenced by TIM3_ICInit(), and TIM3_PWMIConfig().

#define IS_TIM3_IT_OK (   IT)    (((IT) != 0x00) && ((IT) <= 0x07))

Definition at line 211 of file stm8s_tim3.h.

Referenced by TIM3_ClearITPendingBit(), and TIM3_ITConfig().

#define IS_TIM3_OC_MODE_OK (   MODE)
Value:
(((MODE) ==  TIM3_OCMODE_TIMING) || \
                                  ((MODE) == TIM3_OCMODE_ACTIVE) || \
                                  ((MODE) == TIM3_OCMODE_INACTIVE) || \
                                  ((MODE) == TIM3_OCMODE_TOGGLE)|| \
                                  ((MODE) == TIM3_OCMODE_PWM1) || \
                                  ((MODE) == TIM3_OCMODE_PWM2))

Definition at line 104 of file stm8s_tim3.h.

Referenced by TIM3_OC1Init(), and TIM3_OC2Init().

#define IS_TIM3_OC_POLARITY_OK (   POLARITY)
Value:
(((POLARITY) == TIM3_OCPOLARITY_HIGH) || \
    ((POLARITY) == TIM3_OCPOLARITY_LOW))

Definition at line 151 of file stm8s_tim3.h.

Referenced by TIM3_OC1Init(), TIM3_OC1PolarityConfig(), TIM3_OC2Init(), and TIM3_OC2PolarityConfig().

#define IS_TIM3_OCM_OK (   MODE)
Value:
(((MODE) ==  TIM3_OCMODE_TIMING) || \
                             ((MODE) == TIM3_OCMODE_ACTIVE) || \
                             ((MODE) == TIM3_OCMODE_INACTIVE) || \
                             ((MODE) == TIM3_OCMODE_TOGGLE)|| \
                             ((MODE) == TIM3_OCMODE_PWM1) || \
                             ((MODE) == TIM3_OCMODE_PWM2) || \
                             ((MODE) == (uint8_t)TIM3_FORCEDACTION_ACTIVE) || \
                             ((MODE) == (uint8_t)TIM3_FORCEDACTION_INACTIVE))

Definition at line 111 of file stm8s_tim3.h.

Referenced by TIM3_SelectOCxM().

#define IS_TIM3_OPM_MODE_OK (   MODE)
Value:
(((MODE) == TIM3_OPMODE_SINGLE) || \
                                   ((MODE) == TIM3_OPMODE_REPETITIVE))

Definition at line 127 of file stm8s_tim3.h.

Referenced by TIM3_SelectOnePulseMode().

#define IS_TIM3_OUTPUT_STATE_OK (   STATE)
Value:
(((STATE) == TIM3_OUTPUTSTATE_DISABLE) || \
                                        ((STATE) == TIM3_OUTPUTSTATE_ENABLE))

Definition at line 161 of file stm8s_tim3.h.

Referenced by TIM3_OC1Init(), and TIM3_OC2Init().

#define IS_TIM3_PRESCALER_OK (   PRESCALER)
Value:
(((PRESCALER) == TIM3_PRESCALER_1  ) || \
    ((PRESCALER) == TIM3_PRESCALER_2    ) || \
    ((PRESCALER) == TIM3_PRESCALER_4    ) || \
    ((PRESCALER) == TIM3_PRESCALER_8  ) || \
    ((PRESCALER) == TIM3_PRESCALER_16   ) || \
    ((PRESCALER) == TIM3_PRESCALER_32     ) || \
    ((PRESCALER) == TIM3_PRESCALER_64    ) || \
    ((PRESCALER) == TIM3_PRESCALER_128   ) || \
    ((PRESCALER) == TIM3_PRESCALER_256   ) || \
    ((PRESCALER) == TIM3_PRESCALER_512   ) || \
    ((PRESCALER) == TIM3_PRESCALER_1024  ) || \
    ((PRESCALER) == TIM3_PRESCALER_2048 ) || \
    ((PRESCALER) == TIM3_PRESCALER_4096 ) || \
    ((PRESCALER) == TIM3_PRESCALER_8192 ) || \
    ((PRESCALER) == TIM3_PRESCALER_16384 ) || \
    ((PRESCALER) == TIM3_PRESCALER_32768 ))

Definition at line 76 of file stm8s_tim3.h.

Referenced by TIM3_PrescalerConfig().

#define IS_TIM3_PRESCALER_RELOAD_OK (   RELOAD)
Value:
(((RELOAD) == TIM3_PSCRELOADMODE_UPDATE) || \
    ((RELOAD) == TIM3_PSCRELOADMODE_IMMEDIATE))

Definition at line 224 of file stm8s_tim3.h.

Referenced by TIM3_PrescalerConfig().

#define IS_TIM3_PWMI_CHANNEL_OK (   CHANNEL)
Value:
(((CHANNEL) == TIM3_CHANNEL_1) || \
    ((CHANNEL) == TIM3_CHANNEL_2))

Definition at line 141 of file stm8s_tim3.h.

Referenced by TIM3_PWMIConfig().

#define IS_TIM3_UPDATE_SOURCE_OK (   SOURCE)
Value:
(((SOURCE) == TIM3_UPDATESOURCE_GLOBAL) || \
    ((SOURCE) == TIM3_UPDATESOURCE_REGULAR))

Definition at line 244 of file stm8s_tim3.h.

Referenced by TIM3_UpdateRequestConfig().

Enumeration Type Documentation

enum TIM3_Channel_TypeDef

TIM3 Channel.

Enumerator:
TIM3_CHANNEL_1 
TIM3_CHANNEL_2 

Definition at line 132 of file stm8s_tim3.h.

enum TIM3_EventSource_TypeDef

TIM3 Event Source.

Enumerator:
TIM3_EVENTSOURCE_UPDATE 
TIM3_EVENTSOURCE_CC1 
TIM3_EVENTSOURCE_CC2 

Definition at line 228 of file stm8s_tim3.h.

enum TIM3_FLAG_TypeDef

TIM3 Flags.

Enumerator:
TIM3_FLAG_UPDATE 
TIM3_FLAG_CC1 
TIM3_FLAG_CC2 
TIM3_FLAG_CC1OF 
TIM3_FLAG_CC2OF 

Definition at line 248 of file stm8s_tim3.h.

enum TIM3_ForcedAction_TypeDef

TIM3 Forced Action.

Enumerator:
TIM3_FORCEDACTION_ACTIVE 
TIM3_FORCEDACTION_INACTIVE 

Definition at line 46 of file stm8s_tim3.h.

enum TIM3_ICPolarity_TypeDef

TIM3 Input Capture Polarity.

Enumerator:
TIM3_ICPOLARITY_RISING 
TIM3_ICPOLARITY_FALLING 

Definition at line 165 of file stm8s_tim3.h.

enum TIM3_ICPSC_TypeDef

TIM3 Input Capture Prescaler.

Enumerator:
TIM3_ICPSC_DIV1 
TIM3_ICPSC_DIV2 
TIM3_ICPSC_DIV4 
TIM3_ICPSC_DIV8 

Definition at line 187 of file stm8s_tim3.h.

enum TIM3_ICSelection_TypeDef

TIM3 Input Capture Selection.

Enumerator:
TIM3_ICSELECTION_DIRECTTI 
TIM3_ICSELECTION_INDIRECTTI 
TIM3_ICSELECTION_TRGI 

Definition at line 175 of file stm8s_tim3.h.

enum TIM3_IT_TypeDef

TIM3 interrupt sources.

Enumerator:
TIM3_IT_UPDATE 
TIM3_IT_CC1 
TIM3_IT_CC2 

Definition at line 204 of file stm8s_tim3.h.

enum TIM3_OCMode_TypeDef

TIM3 Output Compare and PWM modes.

Enumerator:
TIM3_OCMODE_TIMING 
TIM3_OCMODE_ACTIVE 
TIM3_OCMODE_INACTIVE 
TIM3_OCMODE_TOGGLE 
TIM3_OCMODE_PWM1 
TIM3_OCMODE_PWM2 

Definition at line 94 of file stm8s_tim3.h.

enum TIM3_OCPolarity_TypeDef

TIM3 Output Compare Polarity.

Enumerator:
TIM3_OCPOLARITY_HIGH 
TIM3_OCPOLARITY_LOW 

Definition at line 145 of file stm8s_tim3.h.

enum TIM3_OPMode_TypeDef

TIM3 One Pulse Mode.

Enumerator:
TIM3_OPMODE_SINGLE 
TIM3_OPMODE_REPETITIVE 

Definition at line 121 of file stm8s_tim3.h.

enum TIM3_OutputState_TypeDef

TIM3 Output Compare states.

Enumerator:
TIM3_OUTPUTSTATE_DISABLE 
TIM3_OUTPUTSTATE_ENABLE 

Definition at line 155 of file stm8s_tim3.h.

enum TIM3_Prescaler_TypeDef

TIM3 Prescaler.

Enumerator:
TIM3_PRESCALER_1 
TIM3_PRESCALER_2 
TIM3_PRESCALER_4 
TIM3_PRESCALER_8 
TIM3_PRESCALER_16 
TIM3_PRESCALER_32 
TIM3_PRESCALER_64 
TIM3_PRESCALER_128 
TIM3_PRESCALER_256 
TIM3_PRESCALER_512 
TIM3_PRESCALER_1024 
TIM3_PRESCALER_2048 
TIM3_PRESCALER_4096 
TIM3_PRESCALER_8192 
TIM3_PRESCALER_16384 
TIM3_PRESCALER_32768 

Definition at line 56 of file stm8s_tim3.h.

enum TIM3_PSCReloadMode_TypeDef

TIM3 Prescaler Reload Mode.

Enumerator:
TIM3_PSCRELOADMODE_UPDATE 
TIM3_PSCRELOADMODE_IMMEDIATE 

Definition at line 218 of file stm8s_tim3.h.

enum TIM3_UpdateSource_TypeDef

TIM3 Update Source.

Enumerator:
TIM3_UPDATESOURCE_GLOBAL 
TIM3_UPDATESOURCE_REGULAR 

Definition at line 238 of file stm8s_tim3.h.

STM8 Standard Peripherals Library: Footer

 

 

 

      For complete documentation on STM8 8-bit Microcontrollers platform visit www.st.com

 

previous page start next page