/src/platform/lm3s/adc.h

https://github.com/lanwan/elua · C Header · 216 lines · 144 code · 10 blank · 62 comment · 0 complexity · 9a054df44a27569c05b6b00541c98ea4 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-2009 Luminary Micro, Inc.  All rights reserved.
    6. 

  6. // Software License Agreement
    7. 

  7. // 
    8. 

  8. // Luminary Micro, Inc. (LMI) is supplying this software for use solely and
    9. 

  9. // exclusively on LMI's microcontroller products.
    10. 

  10. // 
    11. 

  11. // The software is owned by LMI and/or its suppliers, and is protected under
    12. 

  12. // applicable copyright laws.  All rights are reserved.  You may not combine
    13. 

  13. // this software with "viral" open-source software in order to form a larger
    14. 

  14. // program.  Any use in violation of the foregoing restrictions may subject
    15. 

  15. // the user to criminal sanctions under applicable laws, as well as to civil
    16. 

  16. // liability for the breach of the terms and conditions of this license.
    17. 

  17. // 
    18. 

  18. // THIS SOFTWARE IS PROVIDED "AS IS".  NO WARRANTIES, WHETHER EXPRESS, IMPLIED
    19. 

  19. // OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF
    20. 

  20. // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE.
    21. 

  21. // LMI SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, OR
    22. 

  22. // CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.
    23. 

  23. // 
    24. 

  24. // This is part of revision 4781 of the Stellaris Peripheral Driver Library.
    25. 

  25. //
    26. 

  26. //*****************************************************************************
    27. 

  27. 

  28. #ifndef __ADC_H__
    29. 

  29. #define __ADC_H__
    30. 

  30. 

  31. //*****************************************************************************
    32. 

  32. //
    33. 

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

  34. // have a C binding.
    35. 

  35. //
    36. 

  36. //*****************************************************************************
    37. 

  37. #ifdef __cplusplus
    38. 

  38. extern "C"
    39. 

  39. {
    40. 

  40. #endif
    41. 

  41. 

  42. //*****************************************************************************
    43. 

  43. //
    44. 

  44. // Values that can be passed to ADCSequenceConfigure as the ulTrigger
    45. 

  45. // parameter.
    46. 

  46. //
    47. 

  47. //*****************************************************************************
    48. 

  48. #define ADC_TRIGGER_PROCESSOR   0x00000000  // Processor event
    49. 

  49. #define ADC_TRIGGER_COMP0       0x00000001  // Analog comparator 0 event
    50. 

  50. #define ADC_TRIGGER_COMP1       0x00000002  // Analog comparator 1 event
    51. 

  51. #define ADC_TRIGGER_COMP2       0x00000003  // Analog comparator 2 event
    52. 

  52. #define ADC_TRIGGER_EXTERNAL    0x00000004  // External event
    53. 

  53. #define ADC_TRIGGER_TIMER       0x00000005  // Timer event
    54. 

  54. #define ADC_TRIGGER_PWM0        0x00000006  // PWM0 event
    55. 

  55. #define ADC_TRIGGER_PWM1        0x00000007  // PWM1 event
    56. 

  56. #define ADC_TRIGGER_PWM2        0x00000008  // PWM2 event
    57. 

  57. #define ADC_TRIGGER_ALWAYS      0x0000000F  // Always event
    58. 

  58. 

  59. //*****************************************************************************
    60. 

  60. //
    61. 

  61. // Values that can be passed to ADCSequenceStepConfigure as the ulConfig
    62. 

  62. // parameter.
    63. 

  63. //
    64. 

  64. //*****************************************************************************
    65. 

  65. #define ADC_CTL_TS              0x00000080  // Temperature sensor select
    66. 

  66. #define ADC_CTL_IE              0x00000040  // Interrupt enable
    67. 

  67. #define ADC_CTL_END             0x00000020  // Sequence end select
    68. 

  68. #define ADC_CTL_D               0x00000010  // Differential select
    69. 

  69. #define ADC_CTL_CH0             0x00000000  // Input channel 0
    70. 

  70. #define ADC_CTL_CH1             0x00000001  // Input channel 1
    71. 

  71. #define ADC_CTL_CH2             0x00000002  // Input channel 2
    72. 

  72. #define ADC_CTL_CH3             0x00000003  // Input channel 3
    73. 

  73. #define ADC_CTL_CH4             0x00000004  // Input channel 4
    74. 

  74. #define ADC_CTL_CH5             0x00000005  // Input channel 5
    75. 

  75. #define ADC_CTL_CH6             0x00000006  // Input channel 6
    76. 

  76. #define ADC_CTL_CH7             0x00000007  // Input channel 7
    77. 

  77. #define ADC_CTL_CH8             0x00000008  // Input channel 8
    78. 

  78. #define ADC_CTL_CH9             0x00000009  // Input channel 9
    79. 

  79. #define ADC_CTL_CH10            0x0000000A  // Input channel 10
    80. 

  80. #define ADC_CTL_CH11            0x0000000B  // Input channel 11
    81. 

  81. #define ADC_CTL_CH12            0x0000000C  // Input channel 12
    82. 

  82. #define ADC_CTL_CH13            0x0000000D  // Input channel 13
    83. 

  83. #define ADC_CTL_CH14            0x0000000E  // Input channel 14
    84. 

  84. #define ADC_CTL_CH15            0x0000000F  // Input channel 15
    85. 

  85. #define ADC_CTL_CMP0            0x00080000  // Select Comparator 0
    86. 

  86. #define ADC_CTL_CMP1            0x00090000  // Select Comparator 1
    87. 

  87. #define ADC_CTL_CMP2            0x000A0000  // Select Comparator 2
    88. 

  88. #define ADC_CTL_CMP3            0x000B0000  // Select Comparator 3
    89. 

  89. #define ADC_CTL_CMP4            0x000C0000  // Select Comparator 4
    90. 

  90. #define ADC_CTL_CMP5            0x000D0000  // Select Comparator 5
    91. 

  91. #define ADC_CTL_CMP6            0x000E0000  // Select Comparator 6
    92. 

  92. #define ADC_CTL_CMP7            0x000F0000  // Select Comparator 7
    93. 

  93. 

  94. //*****************************************************************************
    95. 

  95. //
    96. 

  96. // Values that can be passed to ADCComparatorConfigure as part of the
    97. 

  97. // ulConfig parameter.
    98. 

  98. //
    99. 

  99. //*****************************************************************************
    100. 

  100. #define ADC_COMP_TRIG_NONE      0x00000000  // Trigger Disabled
    101. 

  101. #define ADC_COMP_TRIG_LOW_ALWAYS \
    102. 

  102.                                 0x00001000  // Trigger Low Always
    103. 

  103. #define ADC_COMP_TRIG_LOW_ONCE  0x00001100  // Trigger Low Once
    104. 

  104. #define ADC_COMP_TRIG_LOW_HALWAYS \
    105. 

  105.                                 0x00001200  // Trigger Low Always (Hysteresis)
    106. 

  106. #define ADC_COMP_TRIG_LOW_HONCE 0x00001300  // Trigger Low Once (Hysteresis)
    107. 

  107. #define ADC_COMP_TRIG_MID_ALWAYS \
    108. 

  108.                                 0x00001400  // Trigger Mid Always
    109. 

  109. #define ADC_COMP_TRIG_MID_ONCE  0x00001500  // Trigger Mid Once
    110. 

  110. #define ADC_COMP_TRIG_HIGH_ALWAYS \
    111. 

  111.                                 0x00001C00  // Trigger High Always
    112. 

  112. #define ADC_COMP_TRIG_HIGH_ONCE 0x00001D00  // Trigger High Once
    113. 

  113. #define ADC_COMP_TRIG_HIGH_HALWAYS \
    114. 

  114.                                 0x00001E00  // Trigger High Always (Hysteresis)
    115. 

  115. #define ADC_COMP_TRIG_HIGH_HONCE \
    116. 

  116.                                 0x00001F00  // Trigger High Once (Hysteresis)
    117. 

  117. 

  118. #define ADC_COMP_INT_NONE       0x00000000  // Interrupt Disabled
    119. 

  119. #define ADC_COMP_INT_LOW_ALWAYS \
    120. 

  120.                                 0x00000010  // Interrupt Low Always
    121. 

  121. #define ADC_COMP_INT_LOW_ONCE   0x00000011  // Interrupt Low Once
    122. 

  122. #define ADC_COMP_INT_LOW_HALWAYS \
    123. 

  123.                                 0x00000012  // Interrupt Low Always
    124. 

  124.                                             // (Hysteresis)
    125. 

  125. #define ADC_COMP_INT_LOW_HONCE  0x00000013  // Interrupt Low Once (Hysteresis)
    126. 

  126. #define ADC_COMP_INT_MID_ALWAYS \
    127. 

  127.                                 0x00000014  // Interrupt Mid Always
    128. 

  128. #define ADC_COMP_INT_MID_ONCE   0x00000015  // Interrupt Mid Once
    129. 

  129. #define ADC_COMP_INT_HIGH_ALWAYS \
    130. 

  130.                                 0x0000001C  // Interrupt High Always
    131. 

  131. #define ADC_COMP_INT_HIGH_ONCE  0x0000001D  // Interrupt High Once
    132. 

  132. #define ADC_COMP_INT_HIGH_HALWAYS \
    133. 

  133.                                 0x0000001E  // Interrupt High Always
    134. 

  134.                                             // (Hysteresis)
    135. 

  135. #define ADC_COMP_INT_HIGH_HONCE \
    136. 

  136.                                 0x0000001F  // Interrupt High Once (Hysteresis)
    137. 

  137. 

  138. //*****************************************************************************
    139. 

  139. //
    140. 

  140. // Prototypes for the APIs.
    141. 

  141. //
    142. 

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

  143. extern void ADCIntRegister(unsigned long ulBase, unsigned long ulSequenceNum,
    144. 

  144.                            void (*pfnHandler)(void));
    145. 

  145. extern void ADCIntUnregister(unsigned long ulBase,
    146. 

  146.                              unsigned long ulSequenceNum);
    147. 

  147. extern void ADCIntDisable(unsigned long ulBase, unsigned long ulSequenceNum);
    148. 

  148. extern void ADCIntEnable(unsigned long ulBase, unsigned long ulSequenceNum);
    149. 

  149. extern unsigned long ADCIntStatus(unsigned long ulBase,
    150. 

  150.                                   unsigned long ulSequenceNum,
    151. 

  151.                                   tBoolean bMasked);
    152. 

  152. extern void ADCIntClear(unsigned long ulBase, unsigned long ulSequenceNum);
    153. 

  153. extern void ADCSequenceEnable(unsigned long ulBase,
    154. 

  154.                               unsigned long ulSequenceNum);
    155. 

  155. extern void ADCSequenceDisable(unsigned long ulBase,
    156. 

  156.                                unsigned long ulSequenceNum);
    157. 

  157. extern void ADCSequenceConfigure(unsigned long ulBase,
    158. 

  158.                                  unsigned long ulSequenceNum,
    159. 

  159.                                  unsigned long ulTrigger,
    160. 

  160.                                  unsigned long ulPriority);
    161. 

  161. extern void ADCSequenceStepConfigure(unsigned long ulBase,
    162. 

  162.                                      unsigned long ulSequenceNum,
    163. 

  163.                                      unsigned long ulStep,
    164. 

  164.                                      unsigned long ulConfig);
    165. 

  165. extern long ADCSequenceOverflow(unsigned long ulBase,
    166. 

  166.                                 unsigned long ulSequenceNum);
    167. 

  167. extern void ADCSequenceOverflowClear(unsigned long ulBase,
    168. 

  168.                                      unsigned long ulSequenceNum);
    169. 

  169. extern long ADCSequenceUnderflow(unsigned long ulBase,
    170. 

  170.                                  unsigned long ulSequenceNum);
    171. 

  171. extern void ADCSequenceUnderflowClear(unsigned long ulBase,
    172. 

  172.                                       unsigned long ulSequenceNum);
    173. 

  173. extern long ADCSequenceDataGet(unsigned long ulBase,
    174. 

  174.                                unsigned long ulSequenceNum,
    175. 

  175.                                unsigned long *pulBuffer);
    176. 

  176. extern void ADCProcessorTrigger(unsigned long ulBase,
    177. 

  177.                                 unsigned long ulSequenceNum);
    178. 

  178. extern void ADCSoftwareOversampleConfigure(unsigned long ulBase,
    179. 

  179.                                            unsigned long ulSequenceNum,
    180. 

  180.                                            unsigned long ulFactor);
    181. 

  181. extern void ADCSoftwareOversampleStepConfigure(unsigned long ulBase,
    182. 

  182.                                                unsigned long ulSequenceNum,
    183. 

  183.                                                unsigned long ulStep,
    184. 

  184.                                                unsigned long ulConfig);
    185. 

  185. extern void ADCSoftwareOversampleDataGet(unsigned long ulBase,
    186. 

  186.                                          unsigned long ulSequenceNum,
    187. 

  187.                                          unsigned long *pulBuffer,
    188. 

  188.                                          unsigned long ulCount);
    189. 

  189. extern void ADCHardwareOversampleConfigure(unsigned long ulBase,
    190. 

  190.                                            unsigned long ulFactor);
    191. 

  191. extern void ADCComparatorConfigure(unsigned long ulBase, unsigned long ulComp,
    192. 

  192.                                    unsigned long ulConfig);
    193. 

  193. extern void ADCComparatorRegionSet(unsigned long ulBase, unsigned long ulComp,
    194. 

  194.                                    unsigned long ulLowRef,
    195. 

  195.                                    unsigned long ulHighRef);
    196. 

  196. extern void ADCComparatorReset(unsigned long ulBase, unsigned long ulComp,
    197. 

  197.                                tBoolean bTrigger, tBoolean bInterrupt);
    198. 

  198. extern void ADCComparatorIntDisable(unsigned long ulBase,
    199. 

  199.                                     unsigned long ulSequenceNum);
    200. 

  200. extern void ADCComparatorIntEnable(unsigned long ulBase,
    201. 

  201.                                    unsigned long ulSequenceNum);
    202. 

  202. extern unsigned long ADCComparatorIntStatus(unsigned long ulBase);
    203. 

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

  204.                                   unsigned long ulStatus);
    205. 

  205. 

  206. 

  207. //*****************************************************************************
    208. 

  208. //
    209. 

  209. // Mark the end of the C bindings section for C++ compilers.
    210. 

  210. //
    211. 

  211. //*****************************************************************************
    212. 

  212. #ifdef __cplusplus
    213. 

  213. }
    214. 

  214. #endif
    215. 

  215. 

  216. #endif // __ADC_H__
    217.