STM8S/A Standard Peripherals Drivers: ADC1_Private_Macros

STM8S/A

STM8S/A Standard Peripherals Drivers
ADC1_Private_Macros

Macros used by the assert function to check the different functions parameters. More...

Defines

#define IS_ADC1_ALIGN_OK(ALIGN)
 Macro used by the assert function to check the different alignment modes.
#define IS_ADC1_BUFFER_OK(BUFFER)   ((BUFFER) <= (uint8_t)0x09)
 Macro used by the assert function to check the possible buffer values.
#define IS_ADC1_CHANNEL_OK(CHANNEL)
 Macro used by the assert function to check the different channels values.
#define IS_ADC1_CONVERSIONMODE_OK(MODE)
 Macro used by the assert function to check the different conversion modes.
#define IS_ADC1_EXTTRIG_OK(EXTRIG)
 Macro used by the assert function to check the different external trigger values.
#define IS_ADC1_FLAG_OK(FLAG)
 Macro used by the assert function to check the ADC1 Flag.
#define IS_ADC1_IT_OK(IT)
 Macro used by the assert function to check the Interrupt source.
#define IS_ADC1_ITPENDINGBIT_OK(ITPENDINGBIT)
 Macro used by the assert function to check the ADC1 pending bits.
#define IS_ADC1_PRESSEL_OK(PRESCALER)
 Macro used by the assert function to check the different prescaler's values.
#define IS_ADC1_SCHMITTTRIG_OK(SCHMITTTRIG)
 Macro used by the assert function to check the different schmitt trigger values.

Detailed Description

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


Define Documentation

#define IS_ADC1_ALIGN_OK (   ALIGN)
Value:
(((ALIGN) == ADC1_ALIGN_LEFT) || \
                                ((ALIGN) == ADC1_ALIGN_RIGHT))

Macro used by the assert function to check the different alignment modes.

Definition at line 207 of file stm8s_adc1.h.

Referenced by ADC1_ConversionConfig(), and ADC1_Init().

#define IS_ADC1_BUFFER_OK (   BUFFER)    ((BUFFER) <= (uint8_t)0x09)

Macro used by the assert function to check the possible buffer values.

Definition at line 290 of file stm8s_adc1.h.

Referenced by ADC1_GetBufferValue().

#define IS_ADC1_CHANNEL_OK (   CHANNEL)
Value:
(((CHANNEL) == ADC1_CHANNEL_0) || \
                                    ((CHANNEL) == ADC1_CHANNEL_1) || \
                                    ((CHANNEL) == ADC1_CHANNEL_2) || \
                                    ((CHANNEL) == ADC1_CHANNEL_3) || \
                                    ((CHANNEL) == ADC1_CHANNEL_4) || \
                                    ((CHANNEL) == ADC1_CHANNEL_5) || \
                                    ((CHANNEL) == ADC1_CHANNEL_6) || \
                                    ((CHANNEL) == ADC1_CHANNEL_7) || \
                                    ((CHANNEL) == ADC1_CHANNEL_8) || \
                                    ((CHANNEL) == ADC1_CHANNEL_12) || \
                                    ((CHANNEL) == ADC1_CHANNEL_9))

Macro used by the assert function to check the different channels values.

Definition at line 275 of file stm8s_adc1.h.

Referenced by ADC1_AWDChannelConfig(), ADC1_ConversionConfig(), ADC1_GetAWDChannelStatus(), and ADC1_Init().

#define IS_ADC1_CONVERSIONMODE_OK (   MODE)
Value:

Macro used by the assert function to check the different conversion modes.

Definition at line 269 of file stm8s_adc1.h.

Referenced by ADC1_ConversionConfig(), and ADC1_Init().

#define IS_ADC1_EXTTRIG_OK (   EXTRIG)
Value:
(((EXTRIG) == ADC1_EXTTRIG_TIM) || \
                                   ((EXTRIG) == ADC1_EXTTRIG_GPIO))

Macro used by the assert function to check the different external trigger values.

Definition at line 201 of file stm8s_adc1.h.

Referenced by ADC1_ExternalTriggerConfig(), and ADC1_Init().

#define IS_ADC1_FLAG_OK (   FLAG)
Value:
(((FLAG) == ADC1_FLAG_EOC)|| \
                              ((FLAG) == ADC1_FLAG_OVR) || \
                              ((FLAG) == ADC1_FLAG_AWD) || \
                              ((FLAG) == ADC1_FLAG_AWS0) || \
                              ((FLAG) == ADC1_FLAG_AWS1) || \
                              ((FLAG) == ADC1_FLAG_AWS2) || \
                              ((FLAG) == ADC1_FLAG_AWS3) || \
                              ((FLAG) == ADC1_FLAG_AWS4) || \
                              ((FLAG) == ADC1_FLAG_AWS5) || \
                              ((FLAG) == ADC1_FLAG_AWS6) || \
                              ((FLAG) == ADC1_FLAG_AWS7) || \
                              ((FLAG) == ADC1_FLAG_AWS8) || \
                              ((FLAG) == ADC1_FLAG_AWS9))

Macro used by the assert function to check the ADC1 Flag.

Definition at line 219 of file stm8s_adc1.h.

Referenced by ADC1_ClearFlag(), and ADC1_GetFlagStatus().

#define IS_ADC1_IT_OK (   IT)
Value:
(((IT) == ADC1_IT_EOCIE) || \
                          ((IT) == ADC1_IT_AWDIE))

Macro used by the assert function to check the Interrupt source.

Definition at line 213 of file stm8s_adc1.h.

Referenced by ADC1_ITConfig().

#define IS_ADC1_ITPENDINGBIT_OK (   ITPENDINGBIT)
Value:
(((ITPENDINGBIT) == ADC1_IT_EOC) || \
    ((ITPENDINGBIT) == ADC1_IT_AWD) || \
    ((ITPENDINGBIT) == ADC1_IT_AWS0) || \
    ((ITPENDINGBIT) == ADC1_IT_AWS1) || \
    ((ITPENDINGBIT) == ADC1_IT_AWS2) || \
    ((ITPENDINGBIT) == ADC1_IT_AWS3) || \
    ((ITPENDINGBIT) == ADC1_IT_AWS4) || \
    ((ITPENDINGBIT) == ADC1_IT_AWS5) || \
    ((ITPENDINGBIT) == ADC1_IT_AWS6) || \
    ((ITPENDINGBIT) == ADC1_IT_AWS7) || \
    ((ITPENDINGBIT) == ADC1_IT_AWS8) || \
    ((ITPENDINGBIT) == ADC1_IT_AWS12) || \
    ((ITPENDINGBIT) == ADC1_IT_AWS9))

Macro used by the assert function to check the ADC1 pending bits.

Definition at line 236 of file stm8s_adc1.h.

Referenced by ADC1_ClearITPendingBit(), and ADC1_GetITStatus().

#define IS_ADC1_PRESSEL_OK (   PRESCALER)
Value:
(((PRESCALER) == ADC1_PRESSEL_FCPU_D2) || \
                                      ((PRESCALER) == ADC1_PRESSEL_FCPU_D3) || \
                                      ((PRESCALER) == ADC1_PRESSEL_FCPU_D4) || \
                                      ((PRESCALER) == ADC1_PRESSEL_FCPU_D6) || \
                                      ((PRESCALER) == ADC1_PRESSEL_FCPU_D8) || \
                                      ((PRESCALER) == ADC1_PRESSEL_FCPU_D10) || \
                                      ((PRESCALER) == ADC1_PRESSEL_FCPU_D12) || \
                                      ((PRESCALER) == ADC1_PRESSEL_FCPU_D18))

Macro used by the assert function to check the different prescaler's values.

Definition at line 189 of file stm8s_adc1.h.

Referenced by ADC1_Init(), and ADC1_PrescalerConfig().

#define IS_ADC1_SCHMITTTRIG_OK (   SCHMITTTRIG)
Value:
(((SCHMITTTRIG) == ADC1_SCHMITTTRIG_CHANNEL0) || \
    ((SCHMITTTRIG) == ADC1_SCHMITTTRIG_CHANNEL1) || \
    ((SCHMITTTRIG) == ADC1_SCHMITTTRIG_CHANNEL2) || \
    ((SCHMITTTRIG) == ADC1_SCHMITTTRIG_CHANNEL3) || \
    ((SCHMITTTRIG) == ADC1_SCHMITTTRIG_CHANNEL4) || \
    ((SCHMITTTRIG) == ADC1_SCHMITTTRIG_CHANNEL5) || \
    ((SCHMITTTRIG) == ADC1_SCHMITTTRIG_CHANNEL6) || \
    ((SCHMITTTRIG) == ADC1_SCHMITTTRIG_CHANNEL7) || \
    ((SCHMITTTRIG) == ADC1_SCHMITTTRIG_CHANNEL8) || \
    ((SCHMITTTRIG) == ADC1_SCHMITTTRIG_CHANNEL12) || \
    ((SCHMITTTRIG) == ADC1_SCHMITTTRIG_ALL) || \
    ((SCHMITTTRIG) == ADC1_SCHMITTTRIG_CHANNEL9))

Macro used by the assert function to check the different schmitt trigger values.

Definition at line 253 of file stm8s_adc1.h.

Referenced by ADC1_Init(), and ADC1_SchmittTriggerConfig().

STM8 Standard Peripherals Library: Footer

 

 

 

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