STM8L15x Standard Peripherals Drivers: TIM3_Exported_Macros

STM8L15x/16x Standard Peripherals Drivers

previous page next page
STM8L15x Standard Peripherals Drivers
Defines

TIM3_Exported_Macros

TIM3

Defines

#define IS_TIM3_AUTOMATIC_OUTPUT_STATE(STATE)
 Macro TIM3 AOE Bit Set/Reset.
#define IS_TIM3_BREAK_POLARITY(POLARITY)
 Macro Break Polarity.
#define IS_TIM3_BREAK_STATE(STATE)
 Macro Break Input enable/disable.
#define IS_TIM3_CHANNEL(CHANNEL)
 Macro TIM3 Channel.
#define IS_TIM3_CLEAR_FLAG(FLAG)   ((((FLAG) & (uint16_t)0xE100) == 0x0000) && ((FLAG) != 0x0000))
#define IS_TIM3_COUNTER_MODE(MODE)
 Macro TIM3 Counter Mode.
#define IS_TIM3_DMA_SOURCE(SOURCE)
 Macro TIM3 DMA sources.
#define IS_TIM3_ENCODER_MODE(MODE)
 Macro TIM3 encoder mode.
#define IS_TIM3_EVENT_SOURCE(SOURCE)   ((((SOURCE) & (uint8_t)0x18) == 0x00) && ((SOURCE) != 0x00))
 Macro TIM3 event source.
#define IS_TIM3_EXT_FILTER(EXTFILTER)   ((EXTFILTER) <= 0x0F)
 Macro TIM3 External Trigger Filter.
#define IS_TIM3_EXT_POLARITY(POLARITY)
 Macro TIM3 Trigger Polarity.
#define IS_TIM3_EXT_PRESCALER(PRESCALER)
 Macro TIM3 external trigger prescaler.
#define IS_TIM3_FORCED_ACTION(ACTION)
 Macro used by the assert function to check the different functions parameters.
#define IS_TIM3_GET_FLAG(FLAG)
 Macro TIM3 Flags.
#define IS_TIM3_GET_IT(IT)
#define IS_TIM3_IC_FILTER(ICFILTER)   ((ICFILTER) <= 0x0F)
 Macro TIM3 Input Capture Filter Value.
#define IS_TIM3_IC_POLARITY(POLARITY)
 Macro TIM3 IC POLARITY.
#define IS_TIM3_IC_PRESCALER(PRESCALER)
 Macro TIM3 IC PRESCALER.
#define IS_TIM3_IC_SELECTION(SELECTION)
 Macro TIM3 IC SELECTION.
#define IS_TIM3_IT(IT)   ((IT) != 0x00)
 Macro TIM3 Interrupts.
#define IS_TIM3_LOCK_LEVEL(LEVEL)
 Macro Lock levels.
#define IS_TIM3_OC_MODE(MODE)
 Macro TIM3 Output Compare and PWM modes.
#define IS_TIM3_OC_POLARITY(POLARITY)
 Macro TIM3 Output Compare Polarity.
#define IS_TIM3_OCIDLE_STATE(STATE)
 Macro TIM3 OC IDLE STATE.
#define IS_TIM3_OCM(MODE)
#define IS_TIM3_OPM_MODE(MODE)
 Macro TIM3 One Pulse Mode.
#define IS_TIM3_OSSI_STATE(STATE)
 Macro OSSI: Off-State Selection for Idle mode states.
#define IS_TIM3_OUTPUT_STATE(STATE)
 Macro TIM3 Output Compare states.
#define IS_TIM3_PRESCALER(PRESCALER)
 Macro TIM3 Prescaler.
#define IS_TIM3_PRESCALER_RELOAD(RELOAD)
 Macro TIM3 Prescaler Reload.
#define IS_TIM3_SLAVE_MODE(MODE)
 Macro TIM3 Slave mode.
#define IS_TIM3_TIX_TRIGGER_SELECTION(SELECTION)
#define IS_TIM3_TIXCLK_SOURCE(SOURCE)
 Macro TIM3 TIx external Clock Selection.
#define IS_TIM3_TRGO_SOURCE(SOURCE)
 Macro TIM3 TRGO source.
#define IS_TIM3_TRIGGER_SELECTION(SELECTION)
 Macro TIM3 Trigger Selection.
#define IS_TIM3_UPDATE_SOURCE(SOURCE)
 Macro TIM3 update source.

Define Documentation

#define IS_TIM3_AUTOMATIC_OUTPUT_STATE (   STATE)
Value:
(((STATE) == TIM3_AutomaticOutput_Enable) || \
   ((STATE) == TIM3_AutomaticOutput_Disable))

Macro TIM3 AOE Bit Set/Reset.

Definition at line 595 of file stm8l15x_tim3.h.

Referenced by TIM3_BKRConfig().

#define IS_TIM3_BREAK_POLARITY (   POLARITY)
Value:
(((POLARITY) == TIM3_BreakPolarity_Low) || \
   ((POLARITY) == TIM3_BreakPolarity_High))

Macro Break Polarity.

Definition at line 588 of file stm8l15x_tim3.h.

Referenced by TIM3_BKRConfig().

#define IS_TIM3_BREAK_STATE (   STATE)
Value:
(((STATE) == TIM3_BreakState_Enable) || \
   ((STATE) == TIM3_BreakState_Disable))

Macro Break Input enable/disable.

Definition at line 581 of file stm8l15x_tim3.h.

Referenced by TIM3_BKRConfig().

#define IS_TIM3_CHANNEL (   CHANNEL)
Value:
(((CHANNEL) == TIM3_Channel_1) || \
   ((CHANNEL) == TIM3_Channel_2) )

Macro TIM3 Channel.

Definition at line 549 of file stm8l15x_tim3.h.

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

#define IS_TIM3_CLEAR_FLAG (   FLAG)    ((((FLAG) & (uint16_t)0xE100) == 0x0000) && ((FLAG) != 0x0000))

Definition at line 774 of file stm8l15x_tim3.h.

Referenced by TIM3_ClearFlag().

#define IS_TIM3_COUNTER_MODE (   MODE)
Value:
(((MODE) == TIM3_CounterMode_Up)   || \
   ((MODE) == TIM3_CounterMode_Down) || \
   ((MODE) == TIM3_CounterMode_CenterAligned1) || \
   ((MODE) == TIM3_CounterMode_CenterAligned2) || \
   ((MODE) == TIM3_CounterMode_CenterAligned3))

Macro TIM3 Counter Mode.

Definition at line 556 of file stm8l15x_tim3.h.

Referenced by TIM3_CounterModeConfig(), and TIM3_TimeBaseInit().

#define IS_TIM3_DMA_SOURCE (   SOURCE)
Value:
(((SOURCE) == TIM3_DMASource_Update) || \
   ((SOURCE) == TIM3_DMASource_CC1) || \
   ((SOURCE) == TIM3_DMASource_CC2))

Macro TIM3 DMA sources.

Definition at line 781 of file stm8l15x_tim3.h.

Referenced by TIM3_DMACmd().

#define IS_TIM3_ENCODER_MODE (   MODE)
Value:
(((MODE) == TIM3_EncoderMode_TI1) || \
   ((MODE) == TIM3_EncoderMode_TI2) || \
   ((MODE) == TIM3_EncoderMode_TI12))

Macro TIM3 encoder mode.

Definition at line 726 of file stm8l15x_tim3.h.

Referenced by TIM3_EncoderInterfaceConfig().

#define IS_TIM3_EVENT_SOURCE (   SOURCE)    ((((SOURCE) & (uint8_t)0x18) == 0x00) && ((SOURCE) != 0x00))

Macro TIM3 event source.

Definition at line 734 of file stm8l15x_tim3.h.

Referenced by TIM3_GenerateEvent().

#define IS_TIM3_EXT_FILTER (   EXTFILTER)    ((EXTFILTER) <= 0x0F)

Macro TIM3 External Trigger Filter.

Definition at line 713 of file stm8l15x_tim3.h.

Referenced by TIM3_ETRConfig().

#define IS_TIM3_EXT_POLARITY (   POLARITY)
Value:
(((POLARITY) == TIM3_ExtTRGPolarity_Inverted) || \
   ((POLARITY) == TIM3_ExtTRGPolarity_NonInverted))

Macro TIM3 Trigger Polarity.

Definition at line 706 of file stm8l15x_tim3.h.

Referenced by TIM3_ETRConfig().

#define IS_TIM3_EXT_PRESCALER (   PRESCALER)
Value:
(((PRESCALER) == TIM3_ExtTRGPSC_OFF)  || \
   ((PRESCALER) == TIM3_ExtTRGPSC_DIV2) || \
   ((PRESCALER) == TIM3_ExtTRGPSC_DIV4) || \
   ((PRESCALER) == TIM3_ExtTRGPSC_DIV8))

Macro TIM3 external trigger prescaler.

Definition at line 670 of file stm8l15x_tim3.h.

Referenced by TIM3_ETRConfig().

#define IS_TIM3_FORCED_ACTION (   ACTION)
Value:
(((ACTION) == TIM3_ForcedAction_Active) || \
   ((ACTION) == TIM3_ForcedAction_Inactive))

Macro used by the assert function to check the different functions parameters.

Macro TIM3 Forced Action

Definition at line 502 of file stm8l15x_tim3.h.

Referenced by TIM3_ForcedOC1Config(), and TIM3_ForcedOC2Config().

#define IS_TIM3_GET_FLAG (   FLAG)
Value:
(((FLAG) == TIM3_FLAG_Update)  || \
   ((FLAG) == TIM3_FLAG_CC1)     || \
   ((FLAG) == TIM3_FLAG_CC2)     || \
   ((FLAG) == TIM3_FLAG_Trigger) || \
   ((FLAG) == TIM3_FLAG_Break)   || \
   ((FLAG) == TIM3_FLAG_CC1OF)   || \
   ((FLAG) == TIM3_FLAG_CC2OF))

Macro TIM3 Flags.

Definition at line 765 of file stm8l15x_tim3.h.

Referenced by TIM3_GetFlagStatus().

#define IS_TIM3_GET_IT (   IT)
Value:
(((IT) == TIM3_IT_Update)  || \
   ((IT) == TIM3_IT_CC1)     || \
   ((IT) == TIM3_IT_CC2)     || \
   ((IT) == TIM3_IT_Trigger) || \
   ((IT) == TIM3_IT_Break))

Definition at line 660 of file stm8l15x_tim3.h.

Referenced by TIM3_GetITStatus().

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

Macro TIM3 Input Capture Filter Value.

Definition at line 651 of file stm8l15x_tim3.h.

Referenced by TI1_Config(), TI2_Config(), and TIM3_TIxExternalClockConfig().

#define IS_TIM3_IC_POLARITY (   POLARITY)
Value:
(((POLARITY) == TIM3_ICPolarity_Rising) || \
   ((POLARITY) == TIM3_ICPolarity_Falling))

Macro TIM3 IC POLARITY.

Definition at line 626 of file stm8l15x_tim3.h.

Referenced by TI1_Config(), TI2_Config(), TIM3_EncoderInterfaceConfig(), and TIM3_TIxExternalClockConfig().

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

Macro TIM3 IC PRESCALER.

Definition at line 642 of file stm8l15x_tim3.h.

Referenced by TIM3_SetIC1Prescaler(), and TIM3_SetIC2Prescaler().

#define IS_TIM3_IC_SELECTION (   SELECTION)
Value:
(((SELECTION) == TIM3_ICSelection_DirectTI)   || \
   ((SELECTION) == TIM3_ICSelection_IndirectTI) || \
   ((SELECTION) == TIM3_ICSelection_TRGI))

Macro TIM3 IC SELECTION.

Definition at line 633 of file stm8l15x_tim3.h.

Referenced by TI1_Config(), and TI2_Config().

#define IS_TIM3_IT (   IT)    ((IT) != 0x00)

Macro TIM3 Interrupts.

Definition at line 657 of file stm8l15x_tim3.h.

Referenced by TIM3_ClearITPendingBit(), and TIM3_ITConfig().

#define IS_TIM3_LOCK_LEVEL (   LEVEL)
Value:
(((LEVEL) == TIM3_LockLevel_Off) || \
   ((LEVEL) == TIM3_LockLevel_1)   || \
   ((LEVEL) == TIM3_LockLevel_2)   || \
   ((LEVEL) == TIM3_LockLevel_3))

Macro Lock levels.

Definition at line 602 of file stm8l15x_tim3.h.

Referenced by TIM3_BKRConfig().

#define IS_TIM3_OC_MODE (   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))

Macro TIM3 Output Compare and PWM modes.

Definition at line 522 of file stm8l15x_tim3.h.

Referenced by TIM3_OC1Init(), and TIM3_OC2Init().

#define IS_TIM3_OC_POLARITY (   POLARITY)
Value:
(((POLARITY) == TIM3_OCPolarity_High) || \
   ((POLARITY) == TIM3_OCPolarity_Low))

Macro TIM3 Output Compare Polarity.

Definition at line 566 of file stm8l15x_tim3.h.

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

#define IS_TIM3_OCIDLE_STATE (   STATE)
Value:
(((STATE) == TIM3_OCIdleState_Set) || \
   ((STATE) == TIM3_OCIdleState_Reset))

Macro TIM3 OC IDLE STATE.

Definition at line 618 of file stm8l15x_tim3.h.

Referenced by TIM3_OC1Init(), and TIM3_OC2Init().

#define IS_TIM3_OCM (   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 530 of file stm8l15x_tim3.h.

Referenced by TIM3_SelectOCxM().

#define IS_TIM3_OPM_MODE (   MODE)
Value:
(((MODE) == TIM3_OPMode_Single) || \
   ((MODE) == TIM3_OPMode_Repetitive))

Macro TIM3 One Pulse Mode.

Definition at line 542 of file stm8l15x_tim3.h.

Referenced by TIM3_SelectOnePulseMode().

#define IS_TIM3_OSSI_STATE (   STATE)
Value:
(((STATE) == TIM3_OSSIState_Enable) || \
   ((STATE) == TIM3_OSSIState_Disable))

Macro OSSI: Off-State Selection for Idle mode states.

Definition at line 611 of file stm8l15x_tim3.h.

Referenced by TIM3_BKRConfig().

#define IS_TIM3_OUTPUT_STATE (   STATE)
Value:
(((STATE) == TIM3_OutputState_Disable) || \
   ((STATE) == TIM3_OutputState_Enable))

Macro TIM3 Output Compare states.

Definition at line 573 of file stm8l15x_tim3.h.

Referenced by TIM3_OC1Init(), and TIM3_OC2Init().

#define IS_TIM3_PRESCALER (   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))

Macro TIM3 Prescaler.

Definition at line 509 of file stm8l15x_tim3.h.

Referenced by TIM3_PrescalerConfig(), and TIM3_TimeBaseInit().

#define IS_TIM3_PRESCALER_RELOAD (   RELOAD)
Value:
(((RELOAD) == TIM3_PSCReloadMode_Update) || \
   ((RELOAD) == TIM3_PSCReloadMode_Immediate))

Macro TIM3 Prescaler Reload.

Definition at line 719 of file stm8l15x_tim3.h.

Referenced by TIM3_PrescalerConfig().

#define IS_TIM3_SLAVE_MODE (   MODE)
Value:
(((MODE) == TIM3_SlaveMode_Reset)   || \
   ((MODE) == TIM3_SlaveMode_Gated)   || \
   ((MODE) == TIM3_SlaveMode_Trigger) || \
   ((MODE) == TIM3_SlaveMode_External1))

Macro TIM3 Slave mode.

Definition at line 757 of file stm8l15x_tim3.h.

Referenced by TIM3_SelectSlaveMode().

#define IS_TIM3_TIX_TRIGGER_SELECTION (   SELECTION)
Value:
(((SELECTION) == TIM3_TRGSelection_TI1F_ED) || \
   ((SELECTION) == TIM3_TRGSelection_TI1FP1)  || \
   ((SELECTION) == TIM3_TRGSelection_TI2FP2))

Definition at line 690 of file stm8l15x_tim3.h.

#define IS_TIM3_TIXCLK_SOURCE (   SOURCE)
Value:
(((SOURCE) == TIM3_TIxExternalCLK1Source_TI1ED) || \
   ((SOURCE) == TIM3_TIxExternalCLK1Source_TI2)   || \
   ((SOURCE) == TIM3_TIxExternalCLK1Source_TI1))

Macro TIM3 TIx external Clock Selection.

Definition at line 698 of file stm8l15x_tim3.h.

Referenced by TIM3_TIxExternalClockConfig().

#define IS_TIM3_TRGO_SOURCE (   SOURCE)
Value:
(((SOURCE) == TIM3_TRGOSource_Reset)  || \
   ((SOURCE) == TIM3_TRGOSource_Enable) || \
   ((SOURCE) == TIM3_TRGOSource_Update) || \
   ((SOURCE) == TIM3_TRGOSource_OC1)    || \
   ((SOURCE) == TIM3_TRGOSource_OC1REF) || \
   ((SOURCE) == TIM3_TRGOSource_OC2REF))

Macro TIM3 TRGO source.

Definition at line 747 of file stm8l15x_tim3.h.

Referenced by TIM3_SelectOutputTrigger().

#define IS_TIM3_TRIGGER_SELECTION (   SELECTION)
Value:
(((SELECTION) == TIM3_TRGSelection_TI1F_ED) || \
   ((SELECTION) == TIM3_TRGSelection_TI1FP1)  || \
   ((SELECTION) == TIM3_TRGSelection_TI2FP2)  || \
   ((SELECTION) == TIM3_TRGSelection_TIM4) || \
   ((SELECTION) == TIM3_TRGSelection_TIM1) || \
   ((SELECTION) == TIM3_TRGSelection_TIM5) || \
   ((SELECTION) == TIM3_TRGSelection_TIM2) || \
   ((SELECTION) == TIM3_TRGSelection_ETRF))

Macro TIM3 Trigger Selection.

Definition at line 679 of file stm8l15x_tim3.h.

Referenced by TIM3_SelectInputTrigger().

#define IS_TIM3_UPDATE_SOURCE (   SOURCE)
Value:
(((SOURCE) == TIM3_UpdateSource_Global) || \
   ((SOURCE) == TIM3_UpdateSource_Regular))

Macro TIM3 update source.

Definition at line 740 of file stm8l15x_tim3.h.

Referenced by TIM3_UpdateRequestConfig().

STM8S Firmware Library: Overview

 

 

 

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

 

previous page start next page