1 //*****************************************************************************
2 //
3 // comp.h - Prototypes for the analog comparator driver.
4 //
5 // Copyright (c) 2005-2017 Texas Instruments Incorporated.  All rights reserved.
6 // Software License Agreement
7 //
8 //   Redistribution and use in source and binary forms, with or without
9 //   modification, are permitted provided that the following conditions
10 //   are met:
11 //
12 //   Redistributions of source code must retain the above copyright
13 //   notice, this list of conditions and the following disclaimer.
14 //
15 //   Redistributions in binary form must reproduce the above copyright
16 //   notice, this list of conditions and the following disclaimer in the
17 //   documentation and/or other materials provided with the
18 //   distribution.
19 //
20 //   Neither the name of Texas Instruments Incorporated nor the names of
21 //   its contributors may be used to endorse or promote products derived
22 //   from this software without specific prior written permission.
23 //
24 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 //
36 //*****************************************************************************
37 
38 #ifndef __DRIVERLIB_COMP_H__
39 #define __DRIVERLIB_COMP_H__
40 
41 #include <stdint.h>
42 #include <stdbool.h>
43 
44 //*****************************************************************************
45 //
46 // If building with a C++ compiler, make all of the definitions in this header
47 // have a C binding.
48 //
49 //*****************************************************************************
50 #ifdef __cplusplus
51 extern "C"
52 {
53 #endif
54 
55 //*****************************************************************************
56 //
57 // Values that can be passed to ComparatorConfigure() as the ui32Config
58 // parameter.  For each group (in other words, COMP_TRIG_xxx, COMP_INT_xxx, and
59 // so on), one of the values may be selected and combined together with values
60 // from the other groups via a logical OR.
61 //
62 //*****************************************************************************
63 #define COMP_TRIG_NONE          0x00000000  // No ADC trigger
64 #define COMP_TRIG_HIGH          0x00000880  // Trigger when high
65 #define COMP_TRIG_LOW           0x00000800  // Trigger when low
66 #define COMP_TRIG_FALL          0x00000820  // Trigger on falling edge
67 #define COMP_TRIG_RISE          0x00000840  // Trigger on rising edge
68 #define COMP_TRIG_BOTH          0x00000860  // Trigger on both edges
69 #define COMP_INT_HIGH           0x00000010  // Interrupt when high
70 #define COMP_INT_LOW            0x00000000  // Interrupt when low
71 #define COMP_INT_FALL           0x00000004  // Interrupt on falling edge
72 #define COMP_INT_RISE           0x00000008  // Interrupt on rising edge
73 #define COMP_INT_BOTH           0x0000000C  // Interrupt on both edges
74 #define COMP_ASRCP_PIN          0x00000000  // Dedicated Comp+ pin
75 #define COMP_ASRCP_PIN0         0x00000200  // Comp0+ pin
76 #define COMP_ASRCP_REF          0x00000400  // Internal voltage reference
77 #define COMP_OUTPUT_NORMAL      0x00000000  // Comparator output normal
78 #define COMP_OUTPUT_INVERT      0x00000002  // Comparator output inverted
79 
80 //*****************************************************************************
81 //
82 // Values that can be passed to ComparatorSetRef() as the ui32Ref parameter.
83 //
84 //*****************************************************************************
85 #define COMP_REF_OFF            0x00000000  // Turn off the internal reference
86 #define COMP_REF_0V             0x00000300  // Internal reference of 0V
87 #define COMP_REF_0_1375V        0x00000301  // Internal reference of 0.1375V
88 #define COMP_REF_0_275V         0x00000302  // Internal reference of 0.275V
89 #define COMP_REF_0_4125V        0x00000303  // Internal reference of 0.4125V
90 #define COMP_REF_0_55V          0x00000304  // Internal reference of 0.55V
91 #define COMP_REF_0_6875V        0x00000305  // Internal reference of 0.6875V
92 #define COMP_REF_0_825V         0x00000306  // Internal reference of 0.825V
93 #define COMP_REF_0_928125V      0x00000201  // Internal reference of 0.928125V
94 #define COMP_REF_0_9625V        0x00000307  // Internal reference of 0.9625V
95 #define COMP_REF_1_03125V       0x00000202  // Internal reference of 1.03125V
96 #define COMP_REF_1_134375V      0x00000203  // Internal reference of 1.134375V
97 #define COMP_REF_1_1V           0x00000308  // Internal reference of 1.1V
98 #define COMP_REF_1_2375V        0x00000309  // Internal reference of 1.2375V
99 #define COMP_REF_1_340625V      0x00000205  // Internal reference of 1.340625V
100 #define COMP_REF_1_375V         0x0000030A  // Internal reference of 1.375V
101 #define COMP_REF_1_44375V       0x00000206  // Internal reference of 1.44375V
102 #define COMP_REF_1_5125V        0x0000030B  // Internal reference of 1.5125V
103 #define COMP_REF_1_546875V      0x00000207  // Internal reference of 1.546875V
104 #define COMP_REF_1_65V          0x0000030C  // Internal reference of 1.65V
105 #define COMP_REF_1_753125V      0x00000209  // Internal reference of 1.753125V
106 #define COMP_REF_1_7875V        0x0000030D  // Internal reference of 1.7875V
107 #define COMP_REF_1_85625V       0x0000020A  // Internal reference of 1.85625V
108 #define COMP_REF_1_925V         0x0000030E  // Internal reference of 1.925V
109 #define COMP_REF_1_959375V      0x0000020B  // Internal reference of 1.959375V
110 #define COMP_REF_2_0625V        0x0000030F  // Internal reference of 2.0625V
111 #define COMP_REF_2_165625V      0x0000020D  // Internal reference of 2.165625V
112 #define COMP_REF_2_26875V       0x0000020E  // Internal reference of 2.26875V
113 #define COMP_REF_2_371875V      0x0000020F  // Internal reference of 2.371875V
114 
115 //*****************************************************************************
116 //
117 // Prototypes for the APIs.
118 //
119 //*****************************************************************************
120 extern void ComparatorConfigure(uint32_t ui32Base, uint32_t ui32Comp,
121                                 uint32_t ui32Config);
122 extern void ComparatorRefSet(uint32_t ui32Base, uint32_t ui32Ref);
123 extern bool ComparatorValueGet(uint32_t ui32Base, uint32_t ui32Comp);
124 extern void ComparatorIntRegister(uint32_t ui32Base, uint32_t ui32Comp,
125                                   void (*pfnHandler)(void));
126 extern void ComparatorIntUnregister(uint32_t ui32Base, uint32_t ui32Comp);
127 extern void ComparatorIntEnable(uint32_t ui32Base, uint32_t ui32Comp);
128 extern void ComparatorIntDisable(uint32_t ui32Base, uint32_t ui32Comp);
129 extern bool ComparatorIntStatus(uint32_t ui32Base, uint32_t ui32Comp,
130                                 bool bMasked);
131 extern void ComparatorIntClear(uint32_t ui32Base, uint32_t ui32Comp);
132 
133 //*****************************************************************************
134 //
135 // Mark the end of the C bindings section for C++ compilers.
136 //
137 //*****************************************************************************
138 #ifdef __cplusplus
139 }
140 #endif
141 
142 #endif // __DRIVERLIB_COMP_H__
143