| Nano100BN Series BSP V3.03.002 The Board Support Package for Nano100BN Series

adc.h
Go to the documentation of this file.
1 /**************************************************************************/
12 #ifndef __ADC_H__
13 #define __ADC_H__
14
15 #ifdef __cplusplus
16 extern "C"
17 {
18 #endif
19
20
33 #define ADC_CH_0_MASK (1UL << 0)
34 #define ADC_CH_1_MASK (1UL << 1)
35 #define ADC_CH_2_MASK (1UL << 2)
36 #define ADC_CH_3_MASK (1UL << 3)
37 #define ADC_CH_4_MASK (1UL << 4)
38 #define ADC_CH_5_MASK (1UL << 5)
39 #define ADC_CH_6_MASK (1UL << 6)
40 #define ADC_CH_7_MASK (1UL << 7)
41 #define ADC_CH_8_MASK (1UL << 8)
42 #define ADC_CH_9_MASK (1UL << 9)
43 #define ADC_CH_10_MASK (1UL << 10)
44 #define ADC_CH_11_MASK (1UL << 11)
45 #define ADC_CH_12_MASK (1UL << 12)
46 #define ADC_CH_13_MASK (1UL << 13)
47 #define ADC_CH_14_MASK (1UL << 14)
48 #define ADC_CH_15_MASK (1UL << 15)
49 #define ADC_CH_16_MASK (1UL << 16)
50 #define ADC_CH_17_MASK (1UL << 17)
51 #define ADC_CHEN_Msk (0x3FFFF)
52 #define ADC_PDMADATA_AD_PDMA_Msk (0xFFF)
53 #define ADC_CMP_LESS_THAN (0UL)
54 #define ADC_CMP_GREATER_OR_EQUAL_TO (ADC_CMPR_CMPCOND_Msk)
55 #define ADC_TRIGGER_BY_EXT_PIN (0UL)
56 #define ADC_LOW_LEVEL_TRIGGER (0UL << ADC_CR_TRGCOND_Pos)
57 #define ADC_HIGH_LEVEL_TRIGGER (1UL << ADC_CR_TRGCOND_Pos)
58 #define ADC_FALLING_EDGE_TRIGGER (2UL << ADC_CR_TRGCOND_Pos)
59 #define ADC_RISING_EDGE_TRIGGER (3UL << ADC_CR_TRGCOND_Pos)
60 #define ADC_ADF_INT (ADC_SR_ADF_Msk)
61 #define ADC_CMP0_INT (ADC_SR_CMPF0_Msk)
62 #define ADC_CMP1_INT (ADC_SR_CMPF1_Msk)
63 #define ADC_INPUT_MODE_SINGLE_END (0UL << ADC_CR_DIFF_Pos)
64 #define ADC_INPUT_MODE_DIFFERENTIAL (1UL << ADC_CR_DIFF_Pos)
65 #define ADC_OPERATION_MODE_SINGLE (0UL << ADC_CR_ADMD_Pos)
66 #define ADC_OPERATION_MODE_SINGLE_CYCLE (2UL << ADC_CR_ADMD_Pos)
67 #define ADC_OPERATION_MODE_CONTINUOUS (3UL << ADC_CR_ADMD_Pos)
68 #define ADC_DMODE_OUT_FORMAT_UNSIGNED (0UL << ADC_CR_DIFF_Pos)
69 #define ADC_DMODE_OUT_FORMAT_2COMPLEMENT (1UL << ADC_CR_DIFF_Pos)
70 #define ADC_RESSEL_6_BIT (0UL << ADC_CR_RESSEL_Pos)
71 #define ADC_RESSEL_8_BIT (1UL << ADC_CR_RESSEL_Pos)
72 #define ADC_RESSEL_10_BIT (2UL << ADC_CR_RESSEL_Pos)
73 #define ADC_RESSEL_12_BIT (3UL << ADC_CR_RESSEL_Pos)
74 #define ADC_REFSEL_POWER (0UL << ADC_CR_REFSEL_Pos)
75 #define ADC_REFSEL_INT_VREF (1UL << ADC_CR_REFSEL_Pos)
76 #define ADC_REFSEL_VREF (2UL << ADC_CR_REFSEL_Pos)
78 /* end of group NANO100_ADC_EXPORTED_CONSTANTS */
79
80
92 #define ADC_GET_CONVERSION_DATA(adc, u32ChNum) (ADC->RESULT[u32ChNum] & ADC_RESULT_RSLT_Msk)
93
104 #define ADC_GET_INT_FLAG(adc, u32Mask) (ADC->SR & (u32Mask))
105
116 #define ADC_CLR_INT_FLAG(adc, u32Mask) (ADC->SR = (ADC->SR & ~(ADC_SR_ADF_Msk | \
117 ADC_SR_CMPF0_Msk | \
118 ADC_SR_CMPF1_Msk)) | (u32Mask))
119
128 #define ADC_IS_BUSY(adc) (ADC->SR & ADC_SR_BUSY_Msk ? 1 : 0)
129
139 #define ADC_IS_DATA_OVERRUN(adc, u32ChNum) (ADC->RESULT[u32ChNum] & ADC_RESULT_OVERRUN_Msk ? 1 : 0)
140
150 #define ADC_IS_DATA_VALID(adc, u32ChNum) (ADC->RESULT[u32ChNum] & ADC_RESULT_VALID_Msk ? 1 : 0)
151
158 #define ADC_POWER_DOWN(adc) (ADC->CR &= ~ADC_CR_ADEN_Msk)
159
166 #define ADC_POWER_ON(adc) \
167 do { \
168 ADC->CR |= ADC_CR_ADEN_Msk; \
169 while ((!(ADC->SR & ADC_SR_INITRDY_Msk)) || (!(ADC->PWRCTL & ADC_PWRCTL_PWUPRDY_Msk))); \
170 } while(0)
171
187 #define ADC_ENABLE_CMP0(adc, \
188 u32ChNum, \
189 u32Condition, \
190 u32Data, \
191 u32MatchCount) (ADC->CMPR0 = ((u32ChNum) << ADC_CMPR_CMPCH_Pos) | \
192 (u32Condition) | \
193 ((u32Data) << ADC_CMPR_CMPD_Pos) | \
194 (((u32MatchCount) - 1) << ADC_CMPR_CMPMATCNT_Pos) |\
195 ADC_CMPR_CMPEN_Msk)
196
203 #define ADC_DISABLE_CMP0(adc) (ADC->CMPR0 = 0)
204
220 #define ADC_ENABLE_CMP1(adc, \
221 u32ChNum, \
222 u32Condition, \
223 u32Data, \
224 u32MatchCount) (ADC->CMPR1 = ((u32ChNum) << ADC_CMPR_CMPCH_Pos) | \
225 (u32Condition) | \
226 ((u32Data) << ADC_CMPR_CMPD_Pos) | \
227 ((u32MatchCount - 1) << ADC_CMPR_CMPMATCNT_Pos) |\
228 ADC_CMPR_CMPEN_Msk)
229
236 #define ADC_DISABLE_CMP1(adc) (ADC->CMPR1 = 0)
237
245 #define ADC_SET_INPUT_CHANNEL(adc, u32Mask) (ADC->CHEN = (ADC->CHEN & ~ADC_CHEN_Msk) | (u32Mask))
246
253 #define ADC_START_CONV(adc) (ADC->CR |= ADC_CR_ADST_Msk)
254
261 #define ADC_STOP_CONV(adc) (ADC->CR &= ~ADC_CR_ADST_Msk)
262
272 #define ADC_SET_DMOF(adc, u32Format) (ADC->CR = (ADC->CR & ~ADC_CR_DIFF_Msk) | u32Format)
273
285 #define ADC_SET_RESOLUTION(adc, u32Resolution) (ADC->CR = (ADC->CR & ~ADC_CR_RESSEL_Msk) | u32Resolution)
286
297 #define ADC_SET_REF_VOLTAGE(adc, u32Ref) (ADC->CR = (ADC->CR & ~ADC_CR_REFSEL_Msk) | u32Ref)
298
307 #define ADC_SET_POWERDOWN_MODE(adc, u32Mode, u32CalEn) \
308 ADC->PWRCTL = (ADC->PWRCTL & ~(ADC_PWRCTL_PWDMOD_Msk | ADC_PWRCTL_PWDCALEN_Msk)) \
309 | (u32Mode << ADC_PWRCTL_PWDMOD_Pos) | (u32CalEn << ADC_PWRCTL_PWDCALEN_Pos)
310
317 #define ADC_ENABLE_PDMA(adc) (ADC->CR |= ADC_CR_PTEN_Msk)
318
325 #define ADC_DISABLE_PDMA(adc) (ADC->CR &= ~ADC_CR_PTEN_Msk)
326
333 #define ADC_GET_PDMA_DATA(adc) (ADC->PDMA & ADC_PDMADATA_AD_PDMA_Msk)
334
335 void ADC_Open(ADC_T *adc,
336 uint32_t u32InputMode,
337 uint32_t u32OpMode,
338 uint32_t u32ChMask);
339 void ADC_Close(ADC_T *adc);
340 void ADC_EnableHWTrigger(ADC_T *adc,
341 uint32_t u32Source,
342 uint32_t u32Param);
343 void ADC_DisableHWTrigger(ADC_T *adc);
344 void ADC_EnableTimerTrigger(ADC_T *adc,
345 uint32_t u32Source,
346 uint32_t u32PDMACnt);
347 void ADC_DisableTimerTrigger(ADC_T *adc);
348 void ADC_SetExtraSampleTime(ADC_T *adc,
349 uint32_t u32ChNum,
350 uint32_t u32SampleTime);
351 void ADC_EnableInt(ADC_T *adc, uint32_t u32Mask);
352 void ADC_DisableInt(ADC_T *adc, uint32_t u32Mask);
353
354
355 /* end of group NANO100_ADC_EXPORTED_FUNCTIONS */
357 /* end of group NANO100_ADC_Driver */
359 /* end of group NANO100_Device_Driver */
361
362 #ifdef __cplusplus
363 }
364 #endif
365
366 #endif //__ADC_H__
367
368 /*** (C) COPYRIGHT 2013-2014 Nuvoton Technology Corp. ***/
ADC_EnableTimerTrigger
void ADC_EnableTimerTrigger(ADC_T *adc, uint32_t u32Source, uint32_t u32PDMACnt)
Config and enable timer trigger.
Definition: adc.c:107
ADC_Close
void ADC_Close(ADC_T *adc)
Disable ADC module.
Definition: adc.c:59
ADC_Open
void ADC_Open(ADC_T *adc, uint32_t u32InputMode, uint32_t u32OpMode, uint32_t u32ChMask)
This API configures ADC module to be ready for convert the input from selected channel.
Definition: adc.c:41
ADC_DisableHWTrigger
void ADC_DisableHWTrigger(ADC_T *adc)
Disable hardware trigger ADC function.
Definition: adc.c:94
ADC_DisableTimerTrigger
void ADC_DisableTimerTrigger(ADC_T *adc)
Disable timer trigger ADC function.
Definition: adc.c:122
ADC_T
Definition: Nano100Series.h:164
ADC_EnableInt
void ADC_EnableInt(ADC_T *adc, uint32_t u32Mask)
Enable the interrupt(s) selected by u32Mask parameter.
Definition: adc.c:160
ADC_EnableHWTrigger
void ADC_EnableHWTrigger(ADC_T *adc, uint32_t u32Source, uint32_t u32Param)
Configure the hardware trigger condition and enable hardware trigger.
Definition: adc.c:80
ADC_SetExtraSampleTime
void ADC_SetExtraSampleTime(ADC_T *adc, uint32_t u32ChNum, uint32_t u32SampleTime)
Configure the extended sampling time.
Definition: adc.c:136
ADC_DisableInt
void ADC_DisableInt(ADC_T *adc, uint32_t u32Mask)
Disable the interrupt(s) selected by u32Mask parameter.
Definition: adc.c:183