1 //*****************************************************************************
2 //
3 // comp.h - Prototypes for the analog comparator driver.
4 //
5 // Copyright (c) 2005-2011 Texas Instruments Incorporated.  All rights reserved.
6 // Software License Agreement
7 //
8 // Texas Instruments (TI) is supplying this software for use solely and
9 // exclusively on TI's microcontroller products. The software is owned by
10 // TI and/or its suppliers, and is protected under applicable copyright
11 // laws. You may not combine this software with "viral" open-source
12 // software in order to form a larger program.
13 //
14 // THIS SOFTWARE IS PROVIDED "AS IS" AND WITH ALL FAULTS.
15 // NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING, BUT
16 // NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
17 // A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE. TI SHALL NOT, UNDER ANY
18 // CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, OR CONSEQUENTIAL
19 // DAMAGES, FOR ANY REASON WHATSOEVER.
20 //
21 // This is part of revision 8264 of the Stellaris Peripheral Driver Library.
22 //
23 //*****************************************************************************
24 
25 #ifndef __COMP_H__
26 #define __COMP_H__
27 
28 //*****************************************************************************
29 //
30 // If building with a C++ compiler, make all of the definitions in this header
31 // have a C binding.
32 //
33 //*****************************************************************************
34 #ifdef __cplusplus
35 extern "C"
36 {
37 #endif
38 
39 //*****************************************************************************
40 //
41 // Values that can be passed to ComparatorConfigure() as the ulConfig
42 // parameter.  For each group (i.e. COMP_TRIG_xxx, COMP_INT_xxx, etc.), one of
43 // the values may be selected and combined together with values from the other
44 // groups via a logical OR.
45 //
46 //*****************************************************************************
47 #define COMP_TRIG_NONE          0x00000000  // No ADC trigger
48 #define COMP_TRIG_HIGH          0x00000880  // Trigger when high
49 #define COMP_TRIG_LOW           0x00000800  // Trigger when low
50 #define COMP_TRIG_FALL          0x00000820  // Trigger on falling edge
51 #define COMP_TRIG_RISE          0x00000840  // Trigger on rising edge
52 #define COMP_TRIG_BOTH          0x00000860  // Trigger on both edges
53 #define COMP_INT_HIGH           0x00000010  // Interrupt when high
54 #define COMP_INT_LOW            0x00000000  // Interrupt when low
55 #define COMP_INT_FALL           0x00000004  // Interrupt on falling edge
56 #define COMP_INT_RISE           0x00000008  // Interrupt on rising edge
57 #define COMP_INT_BOTH           0x0000000C  // Interrupt on both edges
58 #define COMP_ASRCP_PIN          0x00000000  // Dedicated Comp+ pin
59 #define COMP_ASRCP_PIN0         0x00000200  // Comp0+ pin
60 #define COMP_ASRCP_REF          0x00000400  // Internal voltage reference
61 #ifndef DEPRECATED
62 #define COMP_OUTPUT_NONE        0x00000000  // No comparator output
63 #endif
64 #define COMP_OUTPUT_NORMAL      0x00000000  // Comparator output normal
65 #define COMP_OUTPUT_INVERT      0x00000002  // Comparator output inverted
66 
67 //*****************************************************************************
68 //
69 // Values that can be passed to ComparatorSetRef() as the ulRef parameter.
70 //
71 //*****************************************************************************
72 #define COMP_REF_OFF            0x00000000  // Turn off the internal reference
73 #define COMP_REF_0V             0x00000300  // Internal reference of 0V
74 #define COMP_REF_0_1375V        0x00000301  // Internal reference of 0.1375V
75 #define COMP_REF_0_275V         0x00000302  // Internal reference of 0.275V
76 #define COMP_REF_0_4125V        0x00000303  // Internal reference of 0.4125V
77 #define COMP_REF_0_55V          0x00000304  // Internal reference of 0.55V
78 #define COMP_REF_0_6875V        0x00000305  // Internal reference of 0.6875V
79 #define COMP_REF_0_825V         0x00000306  // Internal reference of 0.825V
80 #define COMP_REF_0_928125V      0x00000201  // Internal reference of 0.928125V
81 #define COMP_REF_0_9625V        0x00000307  // Internal reference of 0.9625V
82 #define COMP_REF_1_03125V       0x00000202  // Internal reference of 1.03125V
83 #define COMP_REF_1_134375V      0x00000203  // Internal reference of 1.134375V
84 #define COMP_REF_1_1V           0x00000308  // Internal reference of 1.1V
85 #define COMP_REF_1_2375V        0x00000309  // Internal reference of 1.2375V
86 #define COMP_REF_1_340625V      0x00000205  // Internal reference of 1.340625V
87 #define COMP_REF_1_375V         0x0000030A  // Internal reference of 1.375V
88 #define COMP_REF_1_44375V       0x00000206  // Internal reference of 1.44375V
89 #define COMP_REF_1_5125V        0x0000030B  // Internal reference of 1.5125V
90 #define COMP_REF_1_546875V      0x00000207  // Internal reference of 1.546875V
91 #define COMP_REF_1_65V          0x0000030C  // Internal reference of 1.65V
92 #define COMP_REF_1_753125V      0x00000209  // Internal reference of 1.753125V
93 #define COMP_REF_1_7875V        0x0000030D  // Internal reference of 1.7875V
94 #define COMP_REF_1_85625V       0x0000020A  // Internal reference of 1.85625V
95 #define COMP_REF_1_925V         0x0000030E  // Internal reference of 1.925V
96 #define COMP_REF_1_959375V      0x0000020B  // Internal reference of 1.959375V
97 #define COMP_REF_2_0625V        0x0000030F  // Internal reference of 2.0625V
98 #define COMP_REF_2_165625V      0x0000020D  // Internal reference of 2.165625V
99 #define COMP_REF_2_26875V       0x0000020E  // Internal reference of 2.26875V
100 #define COMP_REF_2_371875V      0x0000020F  // Internal reference of 2.371875V
101 
102 //*****************************************************************************
103 //
104 // Prototypes for the APIs.
105 //
106 //*****************************************************************************
107 extern void ComparatorConfigure(unsigned long ulBase, unsigned long ulComp,
108                                 unsigned long ulConfig);
109 extern void ComparatorRefSet(unsigned long ulBase, unsigned long ulRef);
110 extern tBoolean ComparatorValueGet(unsigned long ulBase, unsigned long ulComp);
111 extern void ComparatorIntRegister(unsigned long ulBase, unsigned long ulComp,
112                                   void (*pfnHandler)(void));
113 extern void ComparatorIntUnregister(unsigned long ulBase,
114                                     unsigned long ulComp);
115 extern void ComparatorIntEnable(unsigned long ulBase, unsigned long ulComp);
116 extern void ComparatorIntDisable(unsigned long ulBase, unsigned long ulComp);
117 extern tBoolean ComparatorIntStatus(unsigned long ulBase, unsigned long ulComp,
118                                     tBoolean bMasked);
119 extern void ComparatorIntClear(unsigned long ulBase, unsigned long ulComp);
120 
121 //*****************************************************************************
122 //
123 // Mark the end of the C bindings section for C++ compilers.
124 //
125 //*****************************************************************************
126 #ifdef __cplusplus
127 }
128 #endif
129 
130 #endif // __COMP_H__
131