]> begriffs open source - cmsis-freertos/blob - Demo/CORTEX_LM3S811_IAR/LuminaryCode/hw_adc.h
Update README.md - branch main is now the base branch
[cmsis-freertos] / Demo / CORTEX_LM3S811_IAR / LuminaryCode / hw_adc.h
1 //*****************************************************************************
2 //
3 // hw_adc.h - Macros used when accessing the ADC hardware.
4 //
5 // Copyright (c) 2005,2006 Luminary Micro, Inc.  All rights reserved.
6 //
7 // Software License Agreement
8 //
9 // Luminary Micro, Inc. (LMI) is supplying this software for use solely and
10 // exclusively on LMI's Stellaris Family of microcontroller products.
11 //
12 // The software is owned by LMI and/or its suppliers, and is protected under
13 // applicable copyright laws.  All rights are reserved.  Any use in violation
14 // of the foregoing restrictions may subject the user to criminal sanctions
15 // under applicable laws, as well as to civil liability for the breach of the
16 // terms and conditions of this license.
17 //
18 // THIS SOFTWARE IS PROVIDED "AS IS".  NO WARRANTIES, WHETHER EXPRESS, IMPLIED
19 // OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF
20 // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE.
21 // LMI SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, OR
22 // CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.
23 //
24 // This is part of revision 991 of the Stellaris Driver Library.
25 //
26 //*****************************************************************************
27
28 #ifndef __HW_ADC_H__
29 #define __HW_ADC_H__
30
31 //*****************************************************************************
32 //
33 // The following define the offsets of the ADC registers.
34 //
35 //*****************************************************************************
36 #define ADC_O_ACTSS             0x00000000  // Active sample register
37 #define ADC_O_RIS               0x00000004  // Raw interrupt status register
38 #define ADC_O_IM                0x00000008  // Interrupt mask register
39 #define ADC_O_ISC               0x0000000C  // Interrupt status/clear register
40 #define ADC_O_OSTAT             0x00000010  // Overflow status register
41 #define ADC_O_EMUX              0x00000014  // Event multiplexer select reg.
42 #define ADC_O_USTAT             0x00000018  // Underflow status register
43 #define ADC_O_SSPRI             0x00000020  // Channel priority register
44 #define ADC_O_PSSI              0x00000028  // Processor sample initiate reg.
45 #define ADC_O_SAC               0x00000030  // Sample Averaging Control reg.
46 #define ADC_O_SSMUX0            0x00000040  // Multiplexer select 0 register
47 #define ADC_O_SSCTL0            0x00000044  // Sample sequence control 0 reg.
48 #define ADC_O_SSFIFO0           0x00000048  // Result FIFO 0 register
49 #define ADC_O_SSFSTAT0          0x0000004C  // FIFO 0 status register
50 #define ADC_O_SSMUX1            0x00000060  // Multiplexer select 1 register
51 #define ADC_O_SSCTL1            0x00000064  // Sample sequence control 1 reg.
52 #define ADC_O_SSFIFO1           0x00000068  // Result FIFO 1 register
53 #define ADC_O_SSFSTAT1          0x0000006C  // FIFO 1 status register
54 #define ADC_O_SSMUX2            0x00000080  // Multiplexer select 2 register
55 #define ADC_O_SSCTL2            0x00000084  // Sample sequence control 2 reg.
56 #define ADC_O_SSFIFO2           0x00000088  // Result FIFO 2 register
57 #define ADC_O_SSFSTAT2          0x0000008C  // FIFO 2 status register
58 #define ADC_O_SSMUX3            0x000000A0  // Multiplexer select 3 register
59 #define ADC_O_SSCTL3            0x000000A4  // Sample sequence control 3 reg.
60 #define ADC_O_SSFIFO3           0x000000A8  // Result FIFO 3 register
61 #define ADC_O_SSFSTAT3          0x000000AC  // FIFO 3 status register
62 #define ADC_O_TMLB              0x00000100  // Test mode loopback register
63
64 //*****************************************************************************
65 //
66 // The following define the offsets of the ADC sequence registers.
67 //
68 //*****************************************************************************
69 #define ADC_O_SEQ               0x00000040  // Offset to the first sequence
70 #define ADC_O_SEQ_STEP          0x00000020  // Increment to the next sequence
71 #define ADC_O_X_SSMUX           0x00000000  // Multiplexer select register
72 #define ADC_O_X_SSCTL           0x00000004  // Sample sequence control register
73 #define ADC_O_X_SSFIFO          0x00000008  // Result FIFO register
74 #define ADC_O_X_SSFSTAT         0x0000000C  // FIFO status register
75
76 //*****************************************************************************
77 //
78 // The following define the bit fields in the ADC_ACTSS register.
79 //
80 //*****************************************************************************
81 #define ADC_ACTSS_ASEN3         0x00000008  // Sample sequence 3 enable
82 #define ADC_ACTSS_ASEN2         0x00000004  // Sample sequence 2 enable
83 #define ADC_ACTSS_ASEN1         0x00000002  // Sample sequence 1 enable
84 #define ADC_ACTSS_ASEN0         0x00000001  // Sample sequence 0 enable
85
86 //*****************************************************************************
87 //
88 // The following define the bit fields in the ADC_RIS register.
89 //
90 //*****************************************************************************
91 #define ADC_RIS_INR3            0x00000008  // Sample sequence 3 interrupt
92 #define ADC_RIS_INR2            0x00000004  // Sample sequence 2 interrupt
93 #define ADC_RIS_INR1            0x00000002  // Sample sequence 1 interrupt
94 #define ADC_RIS_INR0            0x00000001  // Sample sequence 0 interrupt
95
96 //*****************************************************************************
97 //
98 // The following define the bit fields in the ADC_IM register.
99 //
100 //*****************************************************************************
101 #define ADC_IM_MASK3            0x00000008  // Sample sequence 3 mask
102 #define ADC_IM_MASK2            0x00000004  // Sample sequence 2 mask
103 #define ADC_IM_MASK1            0x00000002  // Sample sequence 1 mask
104 #define ADC_IM_MASK0            0x00000001  // Sample sequence 0 mask
105
106 //*****************************************************************************
107 //
108 // The following define the bit fields in the ADC_ISC register.
109 //
110 //*****************************************************************************
111 #define ADC_ISC_IN3             0x00000008 // Sample sequence 3 interrupt
112 #define ADC_ISC_IN2             0x00000004 // Sample sequence 2 interrupt
113 #define ADC_ISC_IN1             0x00000002 // Sample sequence 1 interrupt
114 #define ADC_ISC_IN0             0x00000001 // Sample sequence 0 interrupt
115
116 //*****************************************************************************
117 //
118 // The following define the bit fields in the ADC_OSTAT register.
119 //
120 //*****************************************************************************
121 #define ADC_OSTAT_OV3           0x00000008  // Sample sequence 3 overflow
122 #define ADC_OSTAT_OV2           0x00000004  // Sample sequence 2 overflow
123 #define ADC_OSTAT_OV1           0x00000002  // Sample sequence 1 overflow
124 #define ADC_OSTAT_OV0           0x00000001  // Sample sequence 0 overflow
125
126 //*****************************************************************************
127 //
128 // The following define the bit fields in the ADC_EMUX register.
129 //
130 //*****************************************************************************
131 #define ADC_EMUX_EM3_MASK       0x0000F000  // Event mux 3 mask
132 #define ADC_EMUX_EM3_PROCESSOR  0x00000000  // Processor event
133 #define ADC_EMUX_EM3_COMP0      0x00001000  // Analog comparator 0 event
134 #define ADC_EMUX_EM3_COMP1      0x00002000  // Analog comparator 1 event
135 #define ADC_EMUX_EM3_COMP2      0x00003000  // Analog comparator 2 event
136 #define ADC_EMUX_EM3_EXTERNAL   0x00004000  // External event
137 #define ADC_EMUX_EM3_TIMER      0x00005000  // Timer event
138 #define ADC_EMUX_EM3_PWM0       0x00006000  // PWM0 event
139 #define ADC_EMUX_EM3_PWM1       0x00007000  // PWM1 event
140 #define ADC_EMUX_EM3_PWM2       0x00008000  // PWM2 event
141 #define ADC_EMUX_EM3_ALWAYS     0x0000F000  // Always event
142 #define ADC_EMUX_EM2_MASK       0x00000F00  // Event mux 2 mask
143 #define ADC_EMUX_EM2_PROCESSOR  0x00000000  // Processor event
144 #define ADC_EMUX_EM2_COMP0      0x00000100  // Analog comparator 0 event
145 #define ADC_EMUX_EM2_COMP1      0x00000200  // Analog comparator 1 event
146 #define ADC_EMUX_EM2_COMP2      0x00000300  // Analog comparator 2 event
147 #define ADC_EMUX_EM2_EXTERNAL   0x00000400  // External event
148 #define ADC_EMUX_EM2_TIMER      0x00000500  // Timer event
149 #define ADC_EMUX_EM2_PWM0       0x00000600  // PWM0 event
150 #define ADC_EMUX_EM2_PWM1       0x00000700  // PWM1 event
151 #define ADC_EMUX_EM2_PWM2       0x00000800  // PWM2 event
152 #define ADC_EMUX_EM2_ALWAYS     0x00000F00  // Always event
153 #define ADC_EMUX_EM1_MASK       0x000000F0  // Event mux 1 mask
154 #define ADC_EMUX_EM1_PROCESSOR  0x00000000  // Processor event
155 #define ADC_EMUX_EM1_COMP0      0x00000010  // Analog comparator 0 event
156 #define ADC_EMUX_EM1_COMP1      0x00000020  // Analog comparator 1 event
157 #define ADC_EMUX_EM1_COMP2      0x00000030  // Analog comparator 2 event
158 #define ADC_EMUX_EM1_EXTERNAL   0x00000040  // External event
159 #define ADC_EMUX_EM1_TIMER      0x00000050  // Timer event
160 #define ADC_EMUX_EM1_PWM0       0x00000060  // PWM0 event
161 #define ADC_EMUX_EM1_PWM1       0x00000070  // PWM1 event
162 #define ADC_EMUX_EM1_PWM2       0x00000080  // PWM2 event
163 #define ADC_EMUX_EM1_ALWAYS     0x000000F0  // Always event
164 #define ADC_EMUX_EM0_MASK       0x0000000F  // Event mux 0 mask
165 #define ADC_EMUX_EM0_PROCESSOR  0x00000000  // Processor event
166 #define ADC_EMUX_EM0_COMP0      0x00000001  // Analog comparator 0 event
167 #define ADC_EMUX_EM0_COMP1      0x00000002  // Analog comparator 1 event
168 #define ADC_EMUX_EM0_COMP2      0x00000003  // Analog comparator 2 event
169 #define ADC_EMUX_EM0_EXTERNAL   0x00000004  // External event
170 #define ADC_EMUX_EM0_TIMER      0x00000005  // Timer event
171 #define ADC_EMUX_EM0_PWM0       0x00000006  // PWM0 event
172 #define ADC_EMUX_EM0_PWM1       0x00000007  // PWM1 event
173 #define ADC_EMUX_EM0_PWM2       0x00000008  // PWM2 event
174 #define ADC_EMUX_EM0_ALWAYS     0x0000000F  // Always event
175 #define ADC_EMUX_EM0_SHIFT               0  // The shift for the first event
176 #define ADC_EMUX_EM1_SHIFT               4  // The shift for the second event
177 #define ADC_EMUX_EM2_SHIFT               8  // The shift for the third event
178 #define ADC_EMUX_EM3_SHIFT              12  // The shift for the fourth event
179
180 //*****************************************************************************
181 //
182 // The following define the bit fields in the ADC_USTAT register.
183 //
184 //*****************************************************************************
185 #define ADC_USTAT_UV3           0x00000008  // Sample sequence 3 underflow
186 #define ADC_USTAT_UV2           0x00000004  // Sample sequence 2 underflow
187 #define ADC_USTAT_UV1           0x00000002  // Sample sequence 1 underflow
188 #define ADC_USTAT_UV0           0x00000001  // Sample sequence 0 underflow
189
190 //*****************************************************************************
191 //
192 // The following define the bit fields in the ADC_SSPRI register.
193 //
194 //*****************************************************************************
195 #define ADC_SSPRI_SS3_MASK      0x00003000  // Sequencer 3 priority mask
196 #define ADC_SSPRI_SS3_1ST       0x00000000  // First priority
197 #define ADC_SSPRI_SS3_2ND       0x00001000  // Second priority
198 #define ADC_SSPRI_SS3_3RD       0x00002000  // Third priority
199 #define ADC_SSPRI_SS3_4TH       0x00003000  // Fourth priority
200 #define ADC_SSPRI_SS2_MASK      0x00000300  // Sequencer 2 priority mask
201 #define ADC_SSPRI_SS2_1ST       0x00000000  // First priority
202 #define ADC_SSPRI_SS2_2ND       0x00000100  // Second priority
203 #define ADC_SSPRI_SS2_3RD       0x00000200  // Third priority
204 #define ADC_SSPRI_SS2_4TH       0x00000300  // Fourth priority
205 #define ADC_SSPRI_SS1_MASK      0x00000030  // Sequencer 1 priority mask
206 #define ADC_SSPRI_SS1_1ST       0x00000000  // First priority
207 #define ADC_SSPRI_SS1_2ND       0x00000010  // Second priority
208 #define ADC_SSPRI_SS1_3RD       0x00000020  // Third priority
209 #define ADC_SSPRI_SS1_4TH       0x00000030  // Fourth priority
210 #define ADC_SSPRI_SS0_MASK      0x00000003  // Sequencer 0 priority mask
211 #define ADC_SSPRI_SS0_1ST       0x00000000  // First priority
212 #define ADC_SSPRI_SS0_2ND       0x00000001  // Second priority
213 #define ADC_SSPRI_SS0_3RD       0x00000002  // Third priority
214 #define ADC_SSPRI_SS0_4TH       0x00000003  // Fourth priority
215
216 //*****************************************************************************
217 //
218 // The following define the bit fields in the ADC_PSSI register.
219 //
220 //*****************************************************************************
221 #define ADC_PSSI_SS3            0x00000008  // Trigger sample sequencer 3
222 #define ADC_PSSI_SS2            0x00000004  // Trigger sample sequencer 2
223 #define ADC_PSSI_SS1            0x00000002  // Trigger sample sequencer 1
224 #define ADC_PSSI_SS0            0x00000001  // Trigger sample sequencer 0
225
226 //*****************************************************************************
227 //
228 // The following define the bit fields in the ADC_SAC register.
229 //
230 //*****************************************************************************
231 #define ADC_SAC_AVG_OFF         0x00000000  // No hardware oversampling
232 #define ADC_SAC_AVG_2X          0x00000001  // 2x hardware oversampling
233 #define ADC_SAC_AVG_4X          0x00000002  // 4x hardware oversampling
234 #define ADC_SAC_AVG_8X          0x00000003  // 8x hardware oversampling
235 #define ADC_SAC_AVG_16X         0x00000004  // 16x hardware oversampling
236 #define ADC_SAC_AVG_32X         0x00000005  // 32x hardware oversampling
237 #define ADC_SAC_AVG_64X         0x00000006  // 64x hardware oversampling
238
239 //*****************************************************************************
240 //
241 // The following define the bit fields in the ADC_SSMUX0, ADC_SSMUX1,
242 // ADC_SSMUX2, and ADC_SSMUX3 registers.  Not all fields are present in all
243 // registers.
244 //
245 //*****************************************************************************
246 #define ADC_SSMUX_MUX7_MASK     0x70000000  // 8th mux select mask
247 #define ADC_SSMUX_MUX6_MASK     0x07000000  // 7th mux select mask
248 #define ADC_SSMUX_MUX5_MASK     0x00700000  // 6th mux select mask
249 #define ADC_SSMUX_MUX4_MASK     0x00070000  // 5th mux select mask
250 #define ADC_SSMUX_MUX3_MASK     0x00007000  // 4th mux select mask
251 #define ADC_SSMUX_MUX2_MASK     0x00000700  // 3rd mux select mask
252 #define ADC_SSMUX_MUX1_MASK     0x00000070  // 2nd mux select mask
253 #define ADC_SSMUX_MUX0_MASK     0x00000007  // 1st mux select mask
254 #define ADC_SSMUX_MUX7_SHIFT    28
255 #define ADC_SSMUX_MUX6_SHIFT    24
256 #define ADC_SSMUX_MUX5_SHIFT    20
257 #define ADC_SSMUX_MUX4_SHIFT    16
258 #define ADC_SSMUX_MUX3_SHIFT    12
259 #define ADC_SSMUX_MUX2_SHIFT    8
260 #define ADC_SSMUX_MUX1_SHIFT    4
261 #define ADC_SSMUX_MUX0_SHIFT    0
262
263 //*****************************************************************************
264 //
265 // The following define the bit fields in the ADC_SSCTL0, ADC_SSCTL1,
266 // ADC_SSCTL2, and ADC_SSCTL3 registers.  Not all fields are present in all
267 // registers.
268 //
269 //*****************************************************************************
270 #define ADC_SSCTL_TS7           0x80000000  // 8th temperature sensor select
271 #define ADC_SSCTL_IE7           0x40000000  // 8th interrupt enable
272 #define ADC_SSCTL_END7          0x20000000  // 8th sequence end select
273 #define ADC_SSCTL_D7            0x10000000  // 8th differential select
274 #define ADC_SSCTL_TS6           0x08000000  // 7th temperature sensor select
275 #define ADC_SSCTL_IE6           0x04000000  // 7th interrupt enable
276 #define ADC_SSCTL_END6          0x02000000  // 7th sequence end select
277 #define ADC_SSCTL_D6            0x01000000  // 7th differential select
278 #define ADC_SSCTL_TS5           0x00800000  // 6th temperature sensor select
279 #define ADC_SSCTL_IE5           0x00400000  // 6th interrupt enable
280 #define ADC_SSCTL_END5          0x00200000  // 6th sequence end select
281 #define ADC_SSCTL_D5            0x00100000  // 6th differential select
282 #define ADC_SSCTL_TS4           0x00080000  // 5th temperature sensor select
283 #define ADC_SSCTL_IE4           0x00040000  // 5th interrupt enable
284 #define ADC_SSCTL_END4          0x00020000  // 5th sequence end select
285 #define ADC_SSCTL_D4            0x00010000  // 5th differential select
286 #define ADC_SSCTL_TS3           0x00008000  // 4th temperature sensor select
287 #define ADC_SSCTL_IE3           0x00004000  // 4th interrupt enable
288 #define ADC_SSCTL_END3          0x00002000  // 4th sequence end select
289 #define ADC_SSCTL_D3            0x00001000  // 4th differential select
290 #define ADC_SSCTL_TS2           0x00000800  // 3rd temperature sensor select
291 #define ADC_SSCTL_IE2           0x00000400  // 3rd interrupt enable
292 #define ADC_SSCTL_END2          0x00000200  // 3rd sequence end select
293 #define ADC_SSCTL_D2            0x00000100  // 3rd differential select
294 #define ADC_SSCTL_TS1           0x00000080  // 2nd temperature sensor select
295 #define ADC_SSCTL_IE1           0x00000040  // 2nd interrupt enable
296 #define ADC_SSCTL_END1          0x00000020  // 2nd sequence end select
297 #define ADC_SSCTL_D1            0x00000010  // 2nd differential select
298 #define ADC_SSCTL_TS0           0x00000008  // 1st temperature sensor select
299 #define ADC_SSCTL_IE0           0x00000004  // 1st interrupt enable
300 #define ADC_SSCTL_END0          0x00000002  // 1st sequence end select
301 #define ADC_SSCTL_D0            0x00000001  // 1st differential select
302
303 //*****************************************************************************
304 //
305 // The following define the bit fields in the ADC_SSFIFO0, ADC_SSFIFO1,
306 // ADC_SSFIFO2, and ADC_SSFIFO3 registers.
307 //
308 //*****************************************************************************
309 #define ADC_SSFIFO_DATA_MASK    0x000003FF  // Sample data
310 #define ADC_SSFIFO_DATA_SHIFT   0
311
312 //*****************************************************************************
313 //
314 // The following define the bit fields in the ADC_SSFSTAT0, ADC_SSFSTAT1,
315 // ADC_SSFSTAT2, and ADC_SSFSTAT3 registers.
316 //
317 //*****************************************************************************
318 #define ADC_SSFSTAT_FULL        0x00001000  // FIFO is full
319 #define ADC_SSFSTAT_EMPTY       0x00000100  // FIFO is empty
320 #define ADC_SSFSTAT_HPTR        0x000000F0  // FIFO head pointer
321 #define ADC_SSFSTAT_TPTR        0x0000000F  // FIFO tail pointer
322
323 //*****************************************************************************
324 //
325 // The following define the bit fields in the ADC_TMLB register.
326 //
327 //*****************************************************************************
328 #define ADC_TMLB_LB             0x00000001  // Loopback control signals
329
330 //*****************************************************************************
331 //
332 // The following define the bit fields in the loopback ADC data.
333 //
334 //*****************************************************************************
335 #define ADC_LB_CNT_MASK         0x000003C0  // Sample counter mask
336 #define ADC_LB_CONT             0x00000020  // Continuation sample
337 #define ADC_LB_DIFF             0x00000010  // Differential sample
338 #define ADC_LB_TS               0x00000008  // Temperature sensor sample
339 #define ADC_LB_MUX_MASK         0x00000007  // Input channel number mask
340 #define ADC_LB_CNT_SHIFT        6           // Sample counter shift
341 #define ADC_LB_MUX_SHIFT        0           // Input channel number shift
342
343 #endif // __HW_ADC_H__