/*! \file gd32f3x0_adc.h \brief definitions for the ADC */ /* Copyright (C) 2017 GigaDevice 2017-06-06, V1.0.0, firmware for GD32F3x0 */ #ifndef GD32F3X0_ADC_H #define GD32F3X0_ADC_H #include "gd32f3x0.h" /* ADC definitions */ #define ADC ADC_BASE /* registers definitions */ #define ADC_STAT REG32(ADC + 0x00U) /*!< ADC status register */ #define ADC_CTL0 REG32(ADC + 0x04U) /*!< ADC control register 0 */ #define ADC_CTL1 REG32(ADC + 0x08U) /*!< ADC control register 1 */ #define ADC_SAMPT0 REG32(ADC + 0x0CU) /*!< ADC sampling time register 0 */ #define ADC_SAMPT1 REG32(ADC + 0x10U) /*!< ADC sampling time register 1 */ #define ADC_IOFF0 REG32(ADC + 0x14U) /*!< ADC inserted channel data offset register 0 */ #define ADC_IOFF1 REG32(ADC + 0x18U) /*!< ADC inserted channel data offset register 1 */ #define ADC_IOFF2 REG32(ADC + 0x1CU) /*!< ADC inserted channel data offset register 2 */ #define ADC_IOFF3 REG32(ADC + 0x20U) /*!< ADC inserted channel data offset register 3 */ #define ADC_WDHT REG32(ADC + 0x24U) /*!< ADC watchdog high threshold register */ #define ADC_WDLT REG32(ADC + 0x28U) /*!< ADC watchdog low threshold register */ #define ADC_RSQ0 REG32(ADC + 0x2CU) /*!< ADC regular sequence register 0 */ #define ADC_RSQ1 REG32(ADC + 0x30U) /*!< ADC regular sequence register 1 */ #define ADC_RSQ2 REG32(ADC + 0x34U) /*!< ADC regular sequence register 2 */ #define ADC_ISQ REG32(ADC + 0x38U) /*!< ADC inserted sequence register */ #define ADC_IDATA0 REG32(ADC + 0x3CU) /*!< ADC inserted data register 0 */ #define ADC_IDATA1 REG32(ADC + 0x40U) /*!< ADC inserted data register 1 */ #define ADC_IDATA2 REG32(ADC + 0x44U) /*!< ADC inserted data register 2 */ #define ADC_IDATA3 REG32(ADC + 0x48U) /*!< ADC inserted data register 3 */ #define ADC_RDATA REG32(ADC + 0x4CU) /*!< ADC regular data register */ #define ADC_OVSAMPCTL REG32(ADC + 0x80U) /*!< ADC oversampling control register */ /* bits definitions */ /* ADC_STAT */ #define ADC_STAT_WDE BIT(0) /*!< analog watchdog event flag */ #define ADC_STAT_EOC BIT(1) /*!< end of conversion */ #define ADC_STAT_EOIC BIT(2) /*!< inserted channel end of conversion */ #define ADC_STAT_STIC BIT(3) /*!< inserted channel start flag */ #define ADC_STAT_STRC BIT(4) /*!< regular channel start flag */ /* ADC_CTL0 */ #define ADC_CTL0_WDCHSEL BITS(0,4) /*!< analog watchdog channel select bits */ #define ADC_CTL0_EOCIE BIT(5) /*!< interrupt enable for EOC */ #define ADC_CTL0_WDEIE BIT(6) /*!< analog watchdog interrupt enable */ #define ADC_CTL0_EOICIE BIT(7) /*!< interrupt enable for inserted channels */ #define ADC_CTL0_SM BIT(8) /*!< scan mode */ #define ADC_CTL0_WDSC BIT(9) /*!< when in scan mode, analog watchdog is effective on a single channel */ #define ADC_CTL0_ICA BIT(10) /*!< automatic inserted group conversion */ #define ADC_CTL0_DISRC BIT(11) /*!< discontinuous mode on regular channels */ #define ADC_CTL0_DISIC BIT(12) /*!< discontinuous mode on inserted channels */ #define ADC_CTL0_DISNUM BITS(13,15) /*!< discontinuous mode channel count */ #define ADC_CTL0_IWDEN BIT(22) /*!< analog watchdog enable on inserted channels */ #define ADC_CTL0_RWDEN BIT(23) /*!< analog watchdog enable on regular channels */ #define ADC_CTL0_DRES BITS(24,25) /*!< ADC data resolution */ /* ADC_CTL1 */ #define ADC_CTL1_ADCON BIT(0) /*!< ADC converter on */ #define ADC_CTL1_CTN BIT(1) /*!< continuous conversion */ #define ADC_CTL1_CLB BIT(2) /*!< ADC calibration */ #define ADC_CTL1_RSTCLB BIT(3) /*!< reset calibration */ #define ADC_CTL1_DMA BIT(8) /*!< direct memory access mode */ #define ADC_CTL1_DAL BIT(11) /*!< data alignment */ #define ADC_CTL1_ETSIC BITS(12,14) /*!< external trigger select for inserted channel */ #define ADC_CTL1_ETEIC BIT(15) /*!< external trigger enable for inserted channel */ #define ADC_CTL1_ETSRC BITS(17,19) /*!< external trigger select for regular channel */ #define ADC_CTL1_ETERC BIT(20) /*!< external trigger enable for regular channel */ #define ADC_CTL1_SWICST BIT(21) /*!< start on inserted channel */ #define ADC_CTL1_SWRCST BIT(22) /*!< start on regular channel */ #define ADC_CTL1_TSVREN BIT(23) /*!< enable channel 16 and 17 */ #define ADC_CTL1_VBETEN BIT(24) /*!< VBAT enable */ /* ADC_SAMPTx x=0,1 */ #define ADC_SAMPTX_SPTN BITS(0,2) /*!< channel n sample time selection */ /* ADC_IOFFx x=0..3 */ #define ADC_IOFFX_IOFF BITS(0,11) /*!< data offset for inserted channel x */ /* ADC_WDHT */ #define ADC_WDHT_WDHT BITS(0,11) /*!< analog watchdog high threshold */ /* ADC_WDLT */ #define ADC_WDLT_WDLT BITS(0,11) /*!< analog watchdog low threshold */ /* ADC_RSQx x=0..2 */ #define ADC_RSQX_RSQN BITS(0,4) /*!< x conversion in regular sequence */ #define ADC_RSQ0_RL BITS(20,23) /*!< regular channel sequence length */ /* ADC_ISQ */ #define ADC_ISQ_ISQN BITS(0,4) /*!< n conversion in regular sequence */ #define ADC_ISQ_IL BITS(20,21) /*!< inserted sequence length */ /* ADC_IDATAx x=0..3*/ #define ADC_IDATAX_IDATAN BITS(0,15) /*!< inserted channel x conversion data */ /* ADC_RDATA */ #define ADC_RDATA_RDATA BITS(0,15) /*!< regular channel data */ /* ADC_OVSAMPCTL */ #define ADC_OVSAMPCTL_OVSEN BIT(0) /*!< oversampling enable */ #define ADC_OVSAMPCTL_OVSR BITS(2,4) /*!< oversampling ratio */ #define ADC_OVSAMPCTL_OVSS BITS(5,8) /*!< oversampling shift */ #define ADC_OVSAMPCTL_TOVS BIT(9) /*!< triggered oversampling */ /* constants definitions */ /* ADC flag definitions */ #define ADC_FLAG_WDE ADC_STAT_WDE /*!< analog watchdog event flag */ #define ADC_FLAG_EOC ADC_STAT_EOC /*!< end of group conversion flag */ #define ADC_FLAG_EOIC ADC_STAT_EOIC /*!< end of inserted channel group conversion flag */ #define ADC_FLAG_STIC ADC_STAT_STIC /*!< start flag of inserted channel group */ #define ADC_FLAG_STRC ADC_STAT_STRC /*!< start flag of regular channel group */ /* adc_ctl0 register value */ #define CTL0_DISNUM(regval) (BITS(13,15) & ((uint32_t)(regval) << 13)) /*!< number of conversions in discontinuous mode */ /* ADC special function */ #define ADC_SCAN_MODE ADC_CTL0_SM /*!< scan mode */ #define ADC_INSERTED_CHANNEL_AUTO ADC_CTL0_ICA /*!< inserted channel group convert automatically */ #define ADC_CONTINUOUS_MODE ADC_CTL1_CTN /*!< continuous mode */ /* ADC data alignment */ #define ADC_DATAALIGN_RIGHT ((uint32_t)0x00000000U) /*!< LSB alignment */ #define ADC_DATAALIGN_LEFT ADC_CTL1_DAL /*!< MSB alignment */ /* external trigger select for regular channel */ #define CTL1_ETSRC(regval) (BITS(17,19) & ((uint32_t)(regval) << 17)) #define ADC_EXTTRIG_REGULAR_T0_CH0 CTL1_ETSRC(0) /*!< TIMER0 CH0 event select */ #define ADC_EXTTRIG_REGULAR_T0_CH1 CTL1_ETSRC(1) /*!< TIMER0 CH1 event select */ #define ADC_EXTTRIG_REGULAR_T0_CH2 CTL1_ETSRC(2) /*!< TIMER0 CH2 event select */ #define ADC_EXTTRIG_REGULAR_T1_CH1 CTL1_ETSRC(3) /*!< TIMER1 CH1 event select */ #define ADC_EXTTRIG_REGULAR_T2_TRGO CTL1_ETSRC(4) /*!< TIMER2 TRGO event select */ #define ADC_EXTTRIG_REGULAR_T14_CH1 CTL1_ETSRC(5) /*!< TIMER14 CH1 event select */ #define ADC_EXTTRIG_REGULAR_EXTI_11 CTL1_ETSRC(6) /*!< external interrupt line 11 */ #define ADC_EXTTRIG_REGULAR_NONE CTL1_ETSRC(7) /*!< software trigger */ /* external trigger select for inserted channel */ #define CTL1_ETSIC(regval) (BITS(12,14) & ((uint32_t)(regval) << 12)) #define ADC_EXTTRIG_INSERTED_T0_TRGO CTL1_ETSIC(0) /*!< TIMER0 TRGO event select */ #define ADC_EXTTRIG_INSERTED_T0_CH3 CTL1_ETSIC(1) /*!< TIMER0 CH3 event select */ #define ADC_EXTTRIG_INSERTED_T1_TRGO CTL1_ETSIC(2) /*!< TIMER1 TRGO event select */ #define ADC_EXTTRIG_INSERTED_T1_CH0 CTL1_ETSIC(3) /*!< TIMER1 CH0 event select */ #define ADC_EXTTRIG_INSERTED_T2_CH3 CTL1_ETSIC(4) /*!< TIMER2 CH3 event select */ #define ADC_EXTTRIG_INSERTED_T14_TRGO CTL1_ETSIC(5) /*!< TIMER14 TRGO event select */ #define ADC_EXTTRIG_INSERTED_EXTI_15 CTL1_ETSIC(6) /*!< external interrupt line 15 */ #define ADC_EXTTRIG_INSERTED_NONE CTL1_ETSIC(7) /*!< software trigger */ /* adc_samptx register value */ #define SAMPTX_SPT(regval) (BITS(0,2) & ((uint32_t)(regval) << 0)) #define ADC_SAMPLETIME_1POINT5 SAMPTX_SPT(0) /*!< 1.5 sampling cycles */ #define ADC_SAMPLETIME_7POINT5 SAMPTX_SPT(1) /*!< 7.5 sampling cycles */ #define ADC_SAMPLETIME_13POINT5 SAMPTX_SPT(2) /*!< 13.5 sampling cycles */ #define ADC_SAMPLETIME_28POINT5 SAMPTX_SPT(3) /*!< 28.5 sampling cycles */ #define ADC_SAMPLETIME_41POINT5 SAMPTX_SPT(4) /*!< 41.5 sampling cycles */ #define ADC_SAMPLETIME_55POINT5 SAMPTX_SPT(5) /*!< 55.5 sampling cycles */ #define ADC_SAMPLETIME_71POINT5 SAMPTX_SPT(6) /*!< 71.5 sampling cycles */ #define ADC_SAMPLETIME_239POINT5 SAMPTX_SPT(7) /*!< 239.5 sampling cycles */ /* ADC data offset for inserted channel x*/ #define IOFFX_IOFF(regval) (BITS(0,11) & ((uint32_t)(regval) << 0)) /* ADC analog watchdog high threshold */ #define WDHT_WDHT(regval) (BITS(0,11) & ((uint32_t)(regval) << 0)) /* ADC analog watchdog low threshold */ #define WDLT_WDLT(regval) (BITS(0,11) & ((uint32_t)(regval) << 0)) /* ADC regular channel group length */ #define RSQ0_RL(regval) (BITS(20,23) & ((uint32_t)(regval) << 20)) /* ADC inserted channel group length */ #define ISQ_IL(regval) (BITS(20,21) & ((uint32_t)(regval) << 20)) /* ADC resolution definitions */ #define CTL0_DRES(regval) (BITS(24,25) & ((regval) << 24)) /*!< ADC resolution */ #define ADC_RESOLUTION_12B CTL0_DRES(0) /*!< 12-bit ADC resolution */ #define ADC_RESOLUTION_10B CTL0_DRES(1) /*!< 10-bit ADC resolution */ #define ADC_RESOLUTION_8B CTL0_DRES(2) /*!< 8-bit ADC resolution */ #define ADC_RESOLUTION_6B CTL0_DRES(3) /*!< 6-bit ADC resolution */ /* ADC oversampling shift */ #define OVSAMPCTL_OVSS(regval) (BITS(5,8) & ((uint32_t)(regval) << 5)) #define ADC_OVERSAMPLING_SHIFT_NONE OVSAMPCTL_OVSS(0) /*!< no oversampling shift */ #define ADC_OVERSAMPLING_SHIFT_1B OVSAMPCTL_OVSS(1) /*!< 1-bit oversampling shift */ #define ADC_OVERSAMPLING_SHIFT_2B OVSAMPCTL_OVSS(2) /*!< 2-bit oversampling shift */ #define ADC_OVERSAMPLING_SHIFT_3B OVSAMPCTL_OVSS(3) /*!< 3-bit oversampling shift */ #define ADC_OVERSAMPLING_SHIFT_4B OVSAMPCTL_OVSS(4) /*!< 4-bit oversampling shift */ #define ADC_OVERSAMPLING_SHIFT_5B OVSAMPCTL_OVSS(5) /*!< 5-bit oversampling shift */ #define ADC_OVERSAMPLING_SHIFT_6B OVSAMPCTL_OVSS(6) /*!< 6-bit oversampling shift */ #define ADC_OVERSAMPLING_SHIFT_7B OVSAMPCTL_OVSS(7) /*!< 7-bit oversampling shift */ #define ADC_OVERSAMPLING_SHIFT_8B OVSAMPCTL_OVSS(8) /*!< 8-bit oversampling shift */ /* ADC oversampling ratio */ #define OVSAMPCTL_OVSR(regval) (BITS(2,4) & ((uint32_t)(regval) << 2)) #define ADC_OVERSAMPLING_RATIO_MUL2 OVSAMPCTL_OVSR(0) /*!< oversampling ratio multiple 2 */ #define ADC_OVERSAMPLING_RATIO_MUL4 OVSAMPCTL_OVSR(1) /*!< oversampling ratio multiple 4 */ #define ADC_OVERSAMPLING_RATIO_MUL8 OVSAMPCTL_OVSR(2) /*!< oversampling ratio multiple 8 */ #define ADC_OVERSAMPLING_RATIO_MUL16 OVSAMPCTL_OVSR(3) /*!< oversampling ratio multiple 16 */ #define ADC_OVERSAMPLING_RATIO_MUL32 OVSAMPCTL_OVSR(4) /*!< oversampling ratio multiple 32 */ #define ADC_OVERSAMPLING_RATIO_MUL64 OVSAMPCTL_OVSR(5) /*!< oversampling ratio multiple 64 */ #define ADC_OVERSAMPLING_RATIO_MUL128 OVSAMPCTL_OVSR(6) /*!< oversampling ratio multiple 128 */ #define ADC_OVERSAMPLING_RATIO_MUL256 OVSAMPCTL_OVSR(7) /*!< oversampling ratio multiple 256 */ /* ADC triggered oversampling */ #define ADC_OVERSAMPLING_ALL_CONVERT 0U /*!< all oversampled conversions for a channel are done consecutively after a trigger */ #define ADC_OVERSAMPLING_ONE_CONVERT 1U /*!< each oversampled conversion for a channel needs a trigger */ /* ADC channel group definitions */ #define ADC_REGULAR_CHANNEL ((uint8_t)0x01U) /*!< ADC regular channel group */ #define ADC_INSERTED_CHANNEL ((uint8_t)0x02U) /*!< ADC inserted channel group */ #define ADC_REGULAR_INSERTED_CHANNEL ((uint8_t)0x03U) /*!< both regular and inserted channel group */ #define ADC_CHANNEL_DISCON_DISABLE ((uint8_t)0x04U) /*!< disable discontinuous mode of regular & inserted channel */ /* ADC inserted channel definitions */ #define ADC_INSERTED_CHANNEL_0 ((uint8_t)0x00U) /*!< ADC inserted channel 0 */ #define ADC_INSERTED_CHANNEL_1 ((uint8_t)0x01U) /*!< ADC inserted channel 1 */ #define ADC_INSERTED_CHANNEL_2 ((uint8_t)0x02U) /*!< ADC inserted channel 2 */ #define ADC_INSERTED_CHANNEL_3 ((uint8_t)0x03U) /*!< ADC inserted channel 3 */ /* ADC channel definitions */ #define ADC_CHANNEL_0 ((uint8_t)0x00U) /*!< ADC channel 0 */ #define ADC_CHANNEL_1 ((uint8_t)0x01U) /*!< ADC channel 1 */ #define ADC_CHANNEL_2 ((uint8_t)0x02U) /*!< ADC channel 2 */ #define ADC_CHANNEL_3 ((uint8_t)0x03U) /*!< ADC channel 3 */ #define ADC_CHANNEL_4 ((uint8_t)0x04U) /*!< ADC channel 4 */ #define ADC_CHANNEL_5 ((uint8_t)0x05U) /*!< ADC channel 5 */ #define ADC_CHANNEL_6 ((uint8_t)0x06U) /*!< ADC channel 6 */ #define ADC_CHANNEL_7 ((uint8_t)0x07U) /*!< ADC channel 7 */ #define ADC_CHANNEL_8 ((uint8_t)0x08U) /*!< ADC channel 8 */ #define ADC_CHANNEL_9 ((uint8_t)0x09U) /*!< ADC channel 9 */ #define ADC_CHANNEL_10 ((uint8_t)0x0AU) /*!< ADC channel 10 */ #define ADC_CHANNEL_11 ((uint8_t)0x0BU) /*!< ADC channel 11 */ #define ADC_CHANNEL_12 ((uint8_t)0x0CU) /*!< ADC channel 12 */ #define ADC_CHANNEL_13 ((uint8_t)0x0DU) /*!< ADC channel 13 */ #define ADC_CHANNEL_14 ((uint8_t)0x0EU) /*!< ADC channel 14 */ #define ADC_CHANNEL_15 ((uint8_t)0x0FU) /*!< ADC channel 15 */ #define ADC_CHANNEL_16 ((uint8_t)0x10U) /*!< ADC channel 16 */ #define ADC_CHANNEL_17 ((uint8_t)0x11U) /*!< ADC channel 17 */ #define ADC_CHANNEL_18 ((uint8_t)0x12U) /*!< ADC channel 18 */ /* ADC interrupt definitions */ #define ADC_INT_WDE ADC_STAT_WDE /*!< analog watchdog event interrupt */ #define ADC_INT_EOC ADC_STAT_EOC /*!< end of group conversion interrupt */ #define ADC_INT_EOIC ADC_STAT_EOIC /*!< end of inserted group conversion interrupt */ /* ADC interrupt flag */ #define ADC_INT_FLAG_WDE ADC_STAT_WDE /*!< analog watchdog event interrupt flag */ #define ADC_INT_FLAG_EOC ADC_STAT_EOC /*!< end of group conversion interrupt flag */ #define ADC_INT_FLAG_EOIC ADC_STAT_EOIC /*!< end of inserted group conversion interrupt flag */ /* function declarations */ /* reset ADC */ void adc_deinit(void); /* enable ADC interface */ void adc_enable(void); /* disable ADC interface */ void adc_disable(void); /* ADC calibration and reset calibration */ void adc_calibration_enable(void); /* enable DMA request */ void adc_dma_mode_enable(void); /* disable DMA request */ void adc_dma_mode_disable(void); /* enable the temperature sensor and Vrefint channel */ void adc_tempsensor_vrefint_enable(void); /* disable the temperature sensor and Vrefint channel */ void adc_tempsensor_vrefint_disable(void); /* enable the vbat channel */ void adc_vbat_enable(void); /* disable the vbat channel */ void adc_vbat_disable(void); /* configure ADC discontinuous mode */ void adc_discontinuous_mode_config(uint8_t channel_group, uint8_t length); /* configure ADC special function */ void adc_special_function_config(uint32_t function, ControlStatus newvalue); /* configure ADC data alignment */ void adc_data_alignment_config(uint32_t data_alignment); /* configure the length of regular channel group or inserted channel group */ void adc_channel_length_config(uint8_t channel_group, uint32_t length); /* configure ADC regular channel */ void adc_regular_channel_config(uint8_t rank, uint8_t channel, uint32_t sample_time); /* configure ADC inserted channel */ void adc_inserted_channel_config(uint8_t rank, uint8_t channel, uint32_t sample_time); /* configure ADC inserted channel offset */ void adc_inserted_channel_offset_config(uint8_t inserted_channel, uint16_t offset); /* enable ADC external trigger */ void adc_external_trigger_config(uint8_t channel_group, ControlStatus newvalue); /* configure ADC external trigger source */ void adc_external_trigger_source_config(uint8_t channel_group, uint32_t external_trigger_source); /* enable ADC software trigger */ void adc_software_trigger_enable(uint8_t channel_group); /* read ADC regular group data register */ uint16_t adc_regular_data_read(void); /* read ADC inserted group data register */ uint16_t adc_inserted_data_read(uint8_t inserted_channel); /* get the ADC flag bits */ FlagStatus adc_flag_get(uint32_t flag); /* clear the ADC flag bits */ void adc_flag_clear(uint32_t flag); /* get the ADC interrupt bits */ FlagStatus adc_interrupt_flag_get(uint32_t flag); /* clear the ADC flag */ void adc_interrupt_flag_clear(uint32_t flag); /* enable ADC interrupt */ void adc_interrupt_enable(uint32_t interrupt); /* disable ADC interrupt */ void adc_interrupt_disable(uint32_t interrupt); /* configure ADC analog watchdog single channel */ void adc_watchdog_single_channel_enable(uint8_t channel); /* configure ADC analog watchdog group channel */ void adc_watchdog_group_channel_enable(uint8_t channel_group); /* disable ADC analog watchdog */ void adc_watchdog_disable(void); /* configure ADC analog watchdog threshold */ void adc_watchdog_threshold_config(uint16_t low_threshold, uint16_t high_threshold); /* configure ADC resolution */ void adc_resolution_config(uint32_t resolution); /* configure ADC oversample mode */ void adc_oversample_mode_config(uint8_t mode, uint16_t shift, uint8_t ratio); /* enable ADC oversample mode */ void adc_oversample_mode_enable(void); /* disable ADC oversample mode */ void adc_oversample_mode_disable(void); #endif /* GD32F3X0_ADC_H */