PageRenderTime 65ms CodeModel.GetById 25ms RepoModel.GetById 0ms app.codeStats 1ms

/src/platform/lm3s/driverlib/adc.h

https://github.com/mauriciobomfim/elua
C Header | 269 lines | 174 code | 13 blank | 82 comment | 0 complexity | 755b3e06358c3dde349fe30eb2b91551 MD5 | raw file
    

  1. //*****************************************************************************
    2. 

  2. //
    3. 

  3. // adc.h - ADC headers for using the ADC driver functions.
    4. 

  4. //
    5. 

  5. // Copyright (c) 2005-2011 Texas Instruments Incorporated.  All rights reserved.
    6. 

  6. // Software License Agreement
    7. 

  7. // 
    8. 

  8. // Texas Instruments (TI) is supplying this software for use solely and
    9. 

  9. // exclusively on TI's microcontroller products. The software is owned by
    10. 

  10. // TI and/or its suppliers, and is protected under applicable copyright
    11. 

  11. // laws. You may not combine this software with "viral" open-source
    12. 

  12. // software in order to form a larger program.
    13. 

  13. // 
    14. 

  14. // THIS SOFTWARE IS PROVIDED "AS IS" AND WITH ALL FAULTS.
    15. 

  15. // NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING, BUT
    16. 

  16. // NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
    17. 

  17. // A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE. TI SHALL NOT, UNDER ANY
    18. 

  18. // CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, OR CONSEQUENTIAL
    19. 

  19. // DAMAGES, FOR ANY REASON WHATSOEVER.
    20. 

  20. // 
    21. 

  21. // This is part of revision 7611 of the Stellaris Peripheral Driver Library.
    22. 

  22. //
    23. 

  23. //*****************************************************************************
    24. 

  24. 

  25. #ifndef __ADC_H__
    26. 

  26. #define __ADC_H__
    27. 

  27. 

  28. //*****************************************************************************
    29. 

  29. //
    30. 

  30. // If building with a C++ compiler, make all of the definitions in this header
    31. 

  31. // have a C binding.
    32. 

  32. //
    33. 

  33. //*****************************************************************************
    34. 

  34. #ifdef __cplusplus
    35. 

  35. extern "C"
    36. 

  36. {
    37. 

  37. #endif
    38. 

  38. 

  39. //*****************************************************************************
    40. 

  40. //
    41. 

  41. // Values that can be passed to ADCSequenceConfigure as the ulTrigger
    42. 

  42. // parameter.
    43. 

  43. //
    44. 

  44. //*****************************************************************************
    45. 

  45. #define ADC_TRIGGER_PROCESSOR   0x00000000  // Processor event
    46. 

  46. #define ADC_TRIGGER_COMP0       0x00000001  // Analog comparator 0 event
    47. 

  47. #define ADC_TRIGGER_COMP1       0x00000002  // Analog comparator 1 event
    48. 

  48. #define ADC_TRIGGER_COMP2       0x00000003  // Analog comparator 2 event
    49. 

  49. #define ADC_TRIGGER_EXTERNAL    0x00000004  // External event
    50. 

  50. #define ADC_TRIGGER_TIMER       0x00000005  // Timer event
    51. 

  51. #define ADC_TRIGGER_PWM0        0x00000006  // PWM0 event
    52. 

  52. #define ADC_TRIGGER_PWM1        0x00000007  // PWM1 event
    53. 

  53. #define ADC_TRIGGER_PWM2        0x00000008  // PWM2 event
    54. 

  54. #define ADC_TRIGGER_PWM3        0x00000009  // PWM3 event
    55. 

  55. #define ADC_TRIGGER_ALWAYS      0x0000000F  // Always event
    56. 

  56. 

  57. //*****************************************************************************
    58. 

  58. //
    59. 

  59. // Values that can be passed to ADCSequenceStepConfigure as the ulConfig
    60. 

  60. // parameter.
    61. 

  61. //
    62. 

  62. //*****************************************************************************
    63. 

  63. #define ADC_CTL_TS              0x00000080  // Temperature sensor select
    64. 

  64. #define ADC_CTL_IE              0x00000040  // Interrupt enable
    65. 

  65. #define ADC_CTL_END             0x00000020  // Sequence end select
    66. 

  66. #define ADC_CTL_D               0x00000010  // Differential select
    67. 

  67. #define ADC_CTL_CH0             0x00000000  // Input channel 0
    68. 

  68. #define ADC_CTL_CH1             0x00000001  // Input channel 1
    69. 

  69. #define ADC_CTL_CH2             0x00000002  // Input channel 2
    70. 

  70. #define ADC_CTL_CH3             0x00000003  // Input channel 3
    71. 

  71. #define ADC_CTL_CH4             0x00000004  // Input channel 4
    72. 

  72. #define ADC_CTL_CH5             0x00000005  // Input channel 5
    73. 

  73. #define ADC_CTL_CH6             0x00000006  // Input channel 6
    74. 

  74. #define ADC_CTL_CH7             0x00000007  // Input channel 7
    75. 

  75. #define ADC_CTL_CH8             0x00000008  // Input channel 8
    76. 

  76. #define ADC_CTL_CH9             0x00000009  // Input channel 9
    77. 

  77. #define ADC_CTL_CH10            0x0000000A  // Input channel 10
    78. 

  78. #define ADC_CTL_CH11            0x0000000B  // Input channel 11
    79. 

  79. #define ADC_CTL_CH12            0x0000000C  // Input channel 12
    80. 

  80. #define ADC_CTL_CH13            0x0000000D  // Input channel 13
    81. 

  81. #define ADC_CTL_CH14            0x0000000E  // Input channel 14
    82. 

  82. #define ADC_CTL_CH15            0x0000000F  // Input channel 15
    83. 

  83. #define ADC_CTL_CMP0            0x00080000  // Select Comparator 0
    84. 

  84. #define ADC_CTL_CMP1            0x00090000  // Select Comparator 1
    85. 

  85. #define ADC_CTL_CMP2            0x000A0000  // Select Comparator 2
    86. 

  86. #define ADC_CTL_CMP3            0x000B0000  // Select Comparator 3
    87. 

  87. #define ADC_CTL_CMP4            0x000C0000  // Select Comparator 4
    88. 

  88. #define ADC_CTL_CMP5            0x000D0000  // Select Comparator 5
    89. 

  89. #define ADC_CTL_CMP6            0x000E0000  // Select Comparator 6
    90. 

  90. #define ADC_CTL_CMP7            0x000F0000  // Select Comparator 7
    91. 

  91. 

  92. //*****************************************************************************
    93. 

  93. //
    94. 

  94. // Values that can be passed to ADCComparatorConfigure as part of the
    95. 

  95. // ulConfig parameter.
    96. 

  96. //
    97. 

  97. //*****************************************************************************
    98. 

  98. #define ADC_COMP_TRIG_NONE      0x00000000  // Trigger Disabled
    99. 

  99. #define ADC_COMP_TRIG_LOW_ALWAYS \
    100. 

  100.                                 0x00001000  // Trigger Low Always
    101. 

  101. #define ADC_COMP_TRIG_LOW_ONCE  0x00001100  // Trigger Low Once
    102. 

  102. #define ADC_COMP_TRIG_LOW_HALWAYS \
    103. 

  103.                                 0x00001200  // Trigger Low Always (Hysteresis)
    104. 

  104. #define ADC_COMP_TRIG_LOW_HONCE 0x00001300  // Trigger Low Once (Hysteresis)
    105. 

  105. #define ADC_COMP_TRIG_MID_ALWAYS \
    106. 

  106.                                 0x00001400  // Trigger Mid Always
    107. 

  107. #define ADC_COMP_TRIG_MID_ONCE  0x00001500  // Trigger Mid Once
    108. 

  108. #define ADC_COMP_TRIG_HIGH_ALWAYS \
    109. 

  109.                                 0x00001C00  // Trigger High Always
    110. 

  110. #define ADC_COMP_TRIG_HIGH_ONCE 0x00001D00  // Trigger High Once
    111. 

  111. #define ADC_COMP_TRIG_HIGH_HALWAYS \
    112. 

  112.                                 0x00001E00  // Trigger High Always (Hysteresis)
    113. 

  113. #define ADC_COMP_TRIG_HIGH_HONCE \
    114. 

  114.                                 0x00001F00  // Trigger High Once (Hysteresis)
    115. 

  115. 

  116. #define ADC_COMP_INT_NONE       0x00000000  // Interrupt Disabled
    117. 

  117. #define ADC_COMP_INT_LOW_ALWAYS \
    118. 

  118.                                 0x00000010  // Interrupt Low Always
    119. 

  119. #define ADC_COMP_INT_LOW_ONCE   0x00000011  // Interrupt Low Once
    120. 

  120. #define ADC_COMP_INT_LOW_HALWAYS \
    121. 

  121.                                 0x00000012  // Interrupt Low Always
    122. 

  122.                                             // (Hysteresis)
    123. 

  123. #define ADC_COMP_INT_LOW_HONCE  0x00000013  // Interrupt Low Once (Hysteresis)
    124. 

  124. #define ADC_COMP_INT_MID_ALWAYS \
    125. 

  125.                                 0x00000014  // Interrupt Mid Always
    126. 

  126. #define ADC_COMP_INT_MID_ONCE   0x00000015  // Interrupt Mid Once
    127. 

  127. #define ADC_COMP_INT_HIGH_ALWAYS \
    128. 

  128.                                 0x0000001C  // Interrupt High Always
    129. 

  129. #define ADC_COMP_INT_HIGH_ONCE  0x0000001D  // Interrupt High Once
    130. 

  130. #define ADC_COMP_INT_HIGH_HALWAYS \
    131. 

  131.                                 0x0000001E  // Interrupt High Always
    132. 

  132.                                             // (Hysteresis)
    133. 

  133. #define ADC_COMP_INT_HIGH_HONCE \
    134. 

  134.                                 0x0000001F  // Interrupt High Once (Hysteresis)
    135. 

  135. 

  136. //*****************************************************************************
    137. 

  137. //
    138. 

  138. // Values that can be used to modify the sequence number passed to
    139. 

  139. // ADCProcessorTrigger in order to get cross-module synchronous processor
    140. 

  140. // triggers.
    141. 

  141. //
    142. 

  142. //*****************************************************************************
    143. 

  143. #define ADC_TRIGGER_WAIT        0x08000000  // Wait for the synchronous trigger
    144. 

  144. #define ADC_TRIGGER_SIGNAL      0x80000000  // Signal the synchronous trigger
    145. 

  145. 

  146. //*****************************************************************************
    147. 

  147. //
    148. 

  148. // Values that can be passed to ADCPhaseDelaySet as the ulPhase parameter and
    149. 

  149. // returned from ADCPhaseDelayGet.
    150. 

  150. //
    151. 

  151. //*****************************************************************************
    152. 

  152. #define ADC_PHASE_0             0x00000000  // 0 degrees
    153. 

  153. #define ADC_PHASE_22_5          0x00000001  // 22.5 degrees
    154. 

  154. #define ADC_PHASE_45            0x00000002  // 45 degrees
    155. 

  155. #define ADC_PHASE_67_5          0x00000003  // 67.5 degrees
    156. 

  156. #define ADC_PHASE_90            0x00000004  // 90 degrees
    157. 

  157. #define ADC_PHASE_112_5         0x00000005  // 112.5 degrees
    158. 

  158. #define ADC_PHASE_135           0x00000006  // 135 degrees
    159. 

  159. #define ADC_PHASE_157_5         0x00000007  // 157.5 degrees
    160. 

  160. #define ADC_PHASE_180           0x00000008  // 180 degrees
    161. 

  161. #define ADC_PHASE_202_5         0x00000009  // 202.5 degrees
    162. 

  162. #define ADC_PHASE_225           0x0000000A  // 225 degrees
    163. 

  163. #define ADC_PHASE_247_5         0x0000000B  // 247.5 degrees
    164. 

  164. #define ADC_PHASE_270           0x0000000C  // 270 degrees
    165. 

  165. #define ADC_PHASE_292_5         0x0000000D  // 292.5 degrees
    166. 

  166. #define ADC_PHASE_315           0x0000000E  // 315 degrees
    167. 

  167. #define ADC_PHASE_337_5         0x0000000F  // 337.5 degrees
    168. 

  168. 

  169. //*****************************************************************************
    170. 

  170. //
    171. 

  171. // Values that can be passed to ADCReferenceSet as the ulRef parameter.
    172. 

  172. //
    173. 

  173. //*****************************************************************************
    174. 

  174. #define ADC_REF_INT             0x00000000  // Internal reference
    175. 

  175. #define ADC_REF_EXT_3V          0x00000001  // External 3V reference
    176. 

  176. #define ADC_REF_EXT_1V          0x00000003  // External 1V reference
    177. 

  177. 

  178. //*****************************************************************************
    179. 

  179. //
    180. 

  180. // Values that can be passed to ADCResolutionSet as the ulResolution parameter.
    181. 

  181. //
    182. 

  182. //*****************************************************************************
    183. 

  183. #define ADC_RES_10BIT           0x00000000  // 10-bit resolution
    184. 

  184. #define ADC_RES_12BIT           0x00000010  // 12-bit resolution
    185. 

  185. 

  186. //*****************************************************************************
    187. 

  187. //
    188. 

  188. // Prototypes for the APIs.
    189. 

  189. //
    190. 

  190. //*****************************************************************************
    191. 

  191. extern void ADCIntRegister(unsigned long ulBase, unsigned long ulSequenceNum,
    192. 

  192.                            void (*pfnHandler)(void));
    193. 

  193. extern void ADCIntUnregister(unsigned long ulBase,
    194. 

  194.                              unsigned long ulSequenceNum);
    195. 

  195. extern void ADCIntDisable(unsigned long ulBase, unsigned long ulSequenceNum);
    196. 

  196. extern void ADCIntEnable(unsigned long ulBase, unsigned long ulSequenceNum);
    197. 

  197. extern unsigned long ADCIntStatus(unsigned long ulBase,
    198. 

  198.                                   unsigned long ulSequenceNum,
    199. 

  199.                                   tBoolean bMasked);
    200. 

  200. extern void ADCIntClear(unsigned long ulBase, unsigned long ulSequenceNum);
    201. 

  201. extern void ADCSequenceEnable(unsigned long ulBase,
    202. 

  202.                               unsigned long ulSequenceNum);
    203. 

  203. extern void ADCSequenceDisable(unsigned long ulBase,
    204. 

  204.                                unsigned long ulSequenceNum);
    205. 

  205. extern void ADCSequenceConfigure(unsigned long ulBase,
    206. 

  206.                                  unsigned long ulSequenceNum,
    207. 

  207.                                  unsigned long ulTrigger,
    208. 

  208.                                  unsigned long ulPriority);
    209. 

  209. extern void ADCSequenceStepConfigure(unsigned long ulBase,
    210. 

  210.                                      unsigned long ulSequenceNum,
    211. 

  211.                                      unsigned long ulStep,
    212. 

  212.                                      unsigned long ulConfig);
    213. 

  213. extern long ADCSequenceOverflow(unsigned long ulBase,
    214. 

  214.                                 unsigned long ulSequenceNum);
    215. 

  215. extern void ADCSequenceOverflowClear(unsigned long ulBase,
    216. 

  216.                                      unsigned long ulSequenceNum);
    217. 

  217. extern long ADCSequenceUnderflow(unsigned long ulBase,
    218. 

  218.                                  unsigned long ulSequenceNum);
    219. 

  219. extern void ADCSequenceUnderflowClear(unsigned long ulBase,
    220. 

  220.                                       unsigned long ulSequenceNum);
    221. 

  221. extern long ADCSequenceDataGet(unsigned long ulBase,
    222. 

  222.                                unsigned long ulSequenceNum,
    223. 

  223.                                unsigned long *pulBuffer);
    224. 

  224. extern void ADCProcessorTrigger(unsigned long ulBase,
    225. 

  225.                                 unsigned long ulSequenceNum);
    226. 

  226. extern void ADCSoftwareOversampleConfigure(unsigned long ulBase,
    227. 

  227.                                            unsigned long ulSequenceNum,
    228. 

  228.                                            unsigned long ulFactor);
    229. 

  229. extern void ADCSoftwareOversampleStepConfigure(unsigned long ulBase,
    230. 

  230.                                                unsigned long ulSequenceNum,
    231. 

  231.                                                unsigned long ulStep,
    232. 

  232.                                                unsigned long ulConfig);
    233. 

  233. extern void ADCSoftwareOversampleDataGet(unsigned long ulBase,
    234. 

  234.                                          unsigned long ulSequenceNum,
    235. 

  235.                                          unsigned long *pulBuffer,
    236. 

  236.                                          unsigned long ulCount);
    237. 

  237. extern void ADCHardwareOversampleConfigure(unsigned long ulBase,
    238. 

  238.                                            unsigned long ulFactor);
    239. 

  239. extern void ADCComparatorConfigure(unsigned long ulBase, unsigned long ulComp,
    240. 

  240.                                    unsigned long ulConfig);
    241. 

  241. extern void ADCComparatorRegionSet(unsigned long ulBase, unsigned long ulComp,
    242. 

  242.                                    unsigned long ulLowRef,
    243. 

  243.                                    unsigned long ulHighRef);
    244. 

  244. extern void ADCComparatorReset(unsigned long ulBase, unsigned long ulComp,
    245. 

  245.                                tBoolean bTrigger, tBoolean bInterrupt);
    246. 

  246. extern void ADCComparatorIntDisable(unsigned long ulBase,
    247. 

  247.                                     unsigned long ulSequenceNum);
    248. 

  248. extern void ADCComparatorIntEnable(unsigned long ulBase,
    249. 

  249.                                    unsigned long ulSequenceNum);
    250. 

  250. extern unsigned long ADCComparatorIntStatus(unsigned long ulBase);
    251. 

  251. extern void ADCComparatorIntClear(unsigned long ulBase,
    252. 

  252.                                   unsigned long ulStatus);
    253. 

  253. extern void ADCReferenceSet(unsigned long ulBase, unsigned long ulRef);
    254. 

  254. extern unsigned long ADCReferenceGet(unsigned long ulBase);
    255. 

  255. extern void ADCResolutionSet(unsigned long ulBase, unsigned long ulResolution);
    256. 

  256. extern unsigned long ADCResolutionGet(unsigned long ulBase);
    257. 

  257. extern void ADCPhaseDelaySet(unsigned long ulBase, unsigned long ulPhase);
    258. 

  258. extern unsigned long ADCPhaseDelayGet(unsigned long ulBase);
    259. 

  259. 

  260. //*****************************************************************************
    261. 

  261. //
    262. 

  262. // Mark the end of the C bindings section for C++ compilers.
    263. 

  263. //
    264. 

  264. //*****************************************************************************
    265. 

  265. #ifdef __cplusplus
    266. 

  266. }
    267. 

  267. #endif
    268. 

  268. 

  269. #endif // __ADC_H__
    270. 

  270.