ADC.h 15.5 KB
Newer Older
1
2
3
/*
             LUFA Library
     Copyright (C) Dean Camera, 2010.
4

5
  dean [at] fourwalledcubicle [dot] com
6
           www.lufa-lib.org
7
8
9
10
11
*/

/*
  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)

12
  Permission to use, copy, modify, distribute, and sell this
13
  software and its documentation for any purpose is hereby granted
14
  without fee, provided that the above copyright notice appear in
15
  all copies and that both that the copyright notice and this
16
17
18
  permission notice and warranty disclaimer appear in supporting
  documentation, and that the name of the author not be used in
  advertising or publicity pertaining to distribution of the
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
  software without specific, written prior permission.

  The author disclaim all warranties with regard to this
  software, including all implied warranties of merchantability
  and fitness.  In no event shall the author be liable for any
  special, indirect or consequential damages or any damages
  whatsoever resulting from loss of use, data or profits, whether
  in an action of contract, negligence or other tortious action,
  arising out of or in connection with the use or performance of
  this software.
*/

/** \file
 *  \brief ADC peripheral driver for the U7, U6 and U4 USB AVRs.
 *
34
35
 *  On-chip Analogue-to-Digital converter (ADC) driver for supported U4, U6 and U7 model AVRs that contain an ADC
 *  peripheral internally.
36
37
38
39
40
41
42
43
 *
 *  \note This file should not be included directly. It is automatically included as needed by the ADC driver
 *        dispatch header located in LUFA/Drivers/Peripheral/ADC.h.
 */

/** \ingroup Group_ADC
 *  @defgroup Group_ADC_AVRU4U6U7 Series U4, U6 and U7 Model ADC Driver
 *
44
45
 *  On-chip Analogue-to-Digital converter (ADC) driver for supported U4, U6 and U7 model AVRs that contain an ADC
 *  peripheral internally.
46
47
48
49
50
51
 *
 *  \note This file should not be included directly. It is automatically included as needed by the ADC driver
 *        dispatch header located in LUFA/Drivers/Peripheral/ADC.h.
 *
 *  @{
 */
52

53
54
55
56
57
#ifndef __ADC_AVRU4U6U7_H__
#define __ADC_AVRU4U6U7_H__

	/* Includes: */
		#include "../../../Common/Common.h"
58

59
60
		#include <avr/io.h>
		#include <stdbool.h>
61

62
63
64
65
66
67
68
69
70
71
72
	/* Enable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			extern "C" {
		#endif

	/* Preprocessor Checks: */
		#if !defined(__INCLUDE_FROM_ADC_H)
			#error Do not include this file directly. Include LUFA/Drivers/Peripheral/ADC.h instead.
		#endif

	/* Public Interface - May be used in end-application: */
73
		/* Macros: */
74
75
			/** \name ADC Reference Configuration Masks */
			//@{
76
			/** Reference mask, for using the voltage present at the AVR's AREF pin for the ADC reference. */
77
			#define ADC_REFERENCE_AREF              0
78
79

			/** Reference mask, for using the voltage present at the AVR's AVCC pin for the ADC reference. */
80
			#define ADC_REFERENCE_AVCC              (1 << REFS0)
81
82

			/** Reference mask, for using the internally generated 2.56V reference voltage as the ADC reference. */
83
			#define ADC_REFERENCE_INT2560MV         ((1 << REFS1) | (1 << REFS0))
84
85
86
87
			//@}
			
			/** \name ADC Result Adjustment Configuration Masks */
			//@{
88
			/** Left-adjusts the 10-bit ADC result, so that the upper 8 bits of the value returned by the
89
90
			 *  ADC_GetResult() macro contain the 8 most significant bits of the result.
			 */
91
			#define ADC_LEFT_ADJUSTED               (1 << ADLAR)
92
93

			/** Right-adjusts the 10-bit ADC result, so that the lower 8 bits of the value returned by the
94
95
			 *  ADC_GetResult() macro contain the 8 least significant bits of the result.
			 */
96
			#define ADC_RIGHT_ADJUSTED              (0 << ADLAR)
97
			//@}
98

99
100
			/** \name ADC Mode Configuration Masks */
			//@{
101
			/** Sets the ADC mode to free running, so that conversions take place continuously as fast as the ADC
102
103
			 *  is capable of at the given input clock speed.
			 */
104
			#define ADC_FREE_RUNNING                (1 << ADATE)
105
106

			/** Sets the ADC mode to single conversion, so that only a single conversion will take place before
107
108
			 *  the ADC returns to idle.
			 */
109
			#define ADC_SINGLE_CONVERSION           (0 << ADATE)
110
111
112
113
			//@}
			
			/** \name ADC Prescaler Configuration Masks */
			//@{
114
			/** Sets the ADC input clock to prescale by a factor of 2 the AVR's system clock. */
115
			#define ADC_PRESCALE_2                  (1 << ADPS0)
116
117

			/** Sets the ADC input clock to prescale by a factor of 4 the AVR's system clock. */
118
			#define ADC_PRESCALE_4                  (1 << ADPS1)
119
120

			/** Sets the ADC input clock to prescale by a factor of 8 the AVR's system clock. */
121
			#define ADC_PRESCALE_8                  ((1 << ADPS0) | (1 << ADPS1))
122
123

			/** Sets the ADC input clock to prescale by a factor of 16 the AVR's system clock. */
124
			#define ADC_PRESCALE_16                 (1 << ADPS2)
125
126

			/** Sets the ADC input clock to prescale by a factor of 32 the AVR's system clock. */
127
			#define ADC_PRESCALE_32                 ((1 << ADPS2) | (1 << ADPS0))
128
129

			/** Sets the ADC input clock to prescale by a factor of 64 the AVR's system clock. */
130
			#define ADC_PRESCALE_64                 ((1 << ADPS2) | (1 << ADPS1))
131
132

			/** Sets the ADC input clock to prescale by a factor of 128 the AVR's system clock. */
133
			#define ADC_PRESCALE_128                ((1 << ADPS2) | (1 << ADPS1) | (1 << ADPS0))
134
			//@}
135

136
			/** \name ADC MUX Masks */
137
138
			//@{
			/** MUX mask define for the ADC0 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading. */
139
			#define ADC_CHANNEL0                    (0x00 << MUX0)
140
141

			/** MUX mask define for the ADC1 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading. */
142
			#define ADC_CHANNEL1                    (0x01 << MUX0)
143
144
145
146
147
148

			#if !(defined(__AVR_ATmega16U4__)  || defined(__AVR_ATmega32U4__) || defined(__DOXYGEN__))
				/** MUX mask define for the ADC2 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading.
				 *
				 *  \note Not available on all AVR models.
				 */
149
				#define ADC_CHANNEL2                (0x02 << MUX0)
150
151
152
153
154

				/** MUX mask define for the ADC3 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading.
				 *
				 *  \note Not available on all AVR models.
				 */
155
				#define ADC_CHANNEL3                (0x03 << MUX0)
156
157
158
			#endif

			/** MUX mask define for the ADC4 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading. */
159
			#define ADC_CHANNEL4                    (0x04 << MUX0)
160
161

			/** MUX mask define for the ADC5 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading. */
162
			#define ADC_CHANNEL5                    (0x05 << MUX0)
163
164

			/** MUX mask define for the ADC6 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading. */
165
			#define ADC_CHANNEL6                    (0x06 << MUX0)
166
167

			/** MUX mask define for the ADC7 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading. */
168
			#define ADC_CHANNEL7                    (0x07 << MUX0)
169
170

			/** MUX mask define for the internal 1.1V bandgap channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading. */
171
			#define ADC_1100MV_BANDGAP              (0x1E << MUX0)
172

173
174
175
176
177
			#if (defined(__AVR_ATmega16U4__)  || defined(__AVR_ATmega32U4__) || defined(__DOXYGEN__))
				/** MUX mask define for the ADC8 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading.
				 *
				 *  \note Not available on all AVR models.
				 */
178
				#define ADC_CHANNEL8                ((1 << 8) | (0x00 << MUX0))
179
180
181
182
183

				/** MUX mask define for the ADC9 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading.
				 *
				 *  \note Not available on all AVR models.
				 */
184
				#define ADC_CHANNEL9                ((1 << 8) | (0x01 << MUX0))
185
186
187
188
189

				/** MUX mask define for the ADC10 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading.
				 *
				 *  \note Not available on all AVR models.
				 */
190
				#define ADC_CHANNEL10               ((1 << 8) | (0x02 << MUX0))
191
192
193
194
195

				/** MUX mask define for the ADC11 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading.
				 *
				 *  \note Not available on all AVR models.
				 */
196
				#define ADC_CHANNEL11               ((1 << 8) | (0x03 << MUX0))
197
198
199
200
201

				/** MUX mask define for the ADC12 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading.
				 *
				 *  \note Not available on all AVR models.
				 */
202
				#define ADC_CHANNEL12               ((1 << 8) | (0x04 << MUX0))
203
204
205
206
207

				/** MUX mask define for the ADC13 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading.
				 *
				 *  \note Not available on all AVR models.
				 */
208
				#define ADC_CHANNEL13               ((1 << 8) | (0x05 << MUX0))
209
210
211
212
213
214

				/** MUX mask define for the internal temperature sensor channel of the ADC. See \ref ADC_StartReading and
				 *  \ref ADC_GetChannelReading.
				 *
				 *  \note Not available on all AVR models.
				 */
215
				#define ADC_INT_TEMP_SENS           ((1 << 8) | (0x07 << MUX0))
216
217
			#endif
			//@}
218

219
220
221
222
223
224
225
226
227
228
229
		/* Inline Functions: */
			/** Configures the given ADC channel, ready for ADC conversions. This function sets the
			 *  associated port pin as an input and disables the digital portion of the I/O to reduce
			 *  power consumption.
			 *
			 *  \note This must only be called for ADC channels with are connected to a physical port
			 *        pin of the AVR, denoted by its special alternative function ADCx.
			 *        \n\n
			 *
			 *  \note The channel number must be specified as an integer, and NOT a ADC_CHANNELx mask.
			 *
230
			 *  \param[in] ChannelIndex  ADC channel number to set up for conversions.
231
			 */
232
			static inline void ADC_SetupChannel(const uint8_t ChannelIndex)
233
234
235
			{
				#if (defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB646__) || \
					 defined(__AVR_AT90USB1287__) || defined(__AVR_AT90USB647__) || \
236
					 defined(__AVR_ATmega32U6__))
237
238
				DDRF  &= ~(1 << ChannelIndex);
				DIDR0 |=  (1 << ChannelIndex);
239
				#elif (defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__))
240
				if (ChannelIndex < 8)
241
				{
242
243
					DDRF  &= ~(1 << ChannelIndex);
					DIDR0 |=  (1 << ChannelIndex);
244
				}
245
				else if (ChannelIndex == 8)
246
247
248
249
				{
					DDRD  &= ~(1 << 4);
					DIDR2 |=  (1 << 0);
				}
250
				else if (ChannelIndex < 11)
251
				{
252
253
					DDRD  &= ~(1 << (ChannelIndex - 3));
					DIDR2 |=  (1 << (ChannelIndex - 8));
254
255
256
				}
				else
				{
257
258
					DDRB  &= ~(1 << (ChannelIndex - 7));
					DIDR2 |=  (1 << (ChannelIndex - 8));
259
260
261
				}
				#endif
			}
262

263
			/** De-configures the given ADC channel, re-enabling digital I/O mode instead of analog. This
264
265
266
267
268
269
270
271
272
			 *  function sets the associated port pin as an input and re-enabled the digital portion of
			 *  the I/O.
			 *
			 *  \note This must only be called for ADC channels with are connected to a physical port
			 *        pin of the AVR, denoted by its special alternative function ADCx.
			 *        \n\n
			 *
			 *  \note The channel number must be specified as an integer, and NOT a ADC_CHANNELx mask.
			 *
273
			 *  \param[in] ChannelIndex  ADC channel number to set up for conversions.
274
			 */
275
			static inline void ADC_DisableChannel(const uint8_t ChannelIndex)
276
277
278
			{
				#if (defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB646__) || \
					 defined(__AVR_AT90USB1287__) || defined(__AVR_AT90USB647__) || \
279
					 defined(__AVR_ATmega32U6__))
280
281
				DDRF  &= ~(1 << ChannelIndex);
				DIDR0 &= ~(1 << ChannelIndex);
282
				#elif (defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__))
283
				if (ChannelIndex < 8)
284
				{
285
286
					DDRF  &= ~(1 << ChannelIndex);
					DIDR0 &= ~(1 << ChannelIndex);
287
				}
288
				else if (ChannelIndex == 8)
289
290
291
292
				{
					DDRD  &= ~(1 << 4);
					DIDR2 &= ~(1 << 0);
				}
293
				else if (ChannelIndex < 11)
294
				{
295
296
					DDRD  &= ~(1 << (ChannelIndex - 3));
					DIDR2 &= ~(1 << (ChannelIndex - 8));
297
298
299
				}
				else
				{
300
301
					DDRB  &= ~(1 << (ChannelIndex - 7));
					DIDR2 &= ~(1 << (ChannelIndex - 8));
302
303
304
305
				}
				#endif
			}

306
307
308
309
310
311
312
313
			/** Starts the reading of the given channel, but does not wait until the conversion has completed.
			 *  Once executed, the conversion status can be determined via the \ref ADC_IsReadingComplete() macro and
			 *  the result read via the \ref ADC_GetResult() macro.
			 *
			 *  If the ADC has been initialized in free running mode, calling this function once will begin the repeated
			 *  conversions. If the ADC is in single conversion mode (or the channel to convert from is to be changed),
			 *  this function must be called each time a conversion is to take place.
			 *
314
			 *  \param[in] MUXMask  ADC channel mask, reference mask and adjustment mask.
315
316
317
318
			 */
			static inline void ADC_StartReading(const uint16_t MUXMask)
			{
				ADMUX = MUXMask;
319

320
321
322
323
324
325
				#if (defined(__AVR_ATmega16U4__)  || defined(__AVR_ATmega32U4__) || defined(__DOXYGEN__))
				if (MUXMask & (1 << 8))
				  ADCSRB |=  (1 << MUX5);
				else
				  ADCSRB &= ~(1 << MUX5);
				#endif
326

327
328
329
				ADCSRA |= (1 << ADSC);
			}

330
331
332
333
334
335
336
337
338
339
			/** Indicates if the current ADC conversion is completed, or still in progress.
			 *
			 *  \return Boolean false if the reading is still taking place, or true if the conversion is
			 *          complete and ready to be read out with \ref ADC_GetResult().
			 */
			static inline bool ADC_IsReadingComplete(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline bool ADC_IsReadingComplete(void)
			{
				return ((ADCSRA & (1 << ADIF)) ? true : false);
			}
340

341
342
343
344
345
346
347
348
349
350
351
352
			/** Retrieves the conversion value of the last completed ADC conversion and clears the reading
			 *  completion flag.
			 *
			 *  \return The result of the last ADC conversion as an unsigned value.
			 */
			static inline uint16_t ADC_GetResult(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline uint16_t ADC_GetResult(void)
			{
				ADCSRA |= (1 << ADIF);
				return ADC;
			}

353
354
355
356
357
358
359
			/** Performs a complete single reading from channel, including a polling spin-loop to wait for the
			 *  conversion to complete, and the returning of the converted value.
			 *
			 *  \note For free running mode, the automated conversions should be initialized with a single call
			 *        to \ref ADC_StartReading() to select the channel and begin the automated conversions, and
			 *        the results read directly from the \ref ADC_GetResult() instead to reduce overhead.
			 *
360
			 *  \param[in] MUXMask  Mask comprising of an ADC channel mask, reference mask and adjustment mask.
361
362
363
364
365
			 */
			static inline uint16_t ADC_GetChannelReading(const uint16_t MUXMask) ATTR_WARN_UNUSED_RESULT;
			static inline uint16_t ADC_GetChannelReading(const uint16_t MUXMask)
			{
				ADC_StartReading(MUXMask);
366

367
				while (!(ADC_IsReadingComplete()));
368

369
370
371
				return ADC_GetResult();
			}

372
			/** Initialises the ADC, ready for conversions. This must be called before any other ADC operations.
373
374
375
			 *  The "mode" parameter should be a mask comprised of a conversion mode (free running or single) and
			 *  prescaler masks.
			 *
376
			 *  \param[in] Mode  Mask of ADC prescale and mode settings.
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
			 */
			static inline void ADC_Init(uint8_t Mode) ATTR_ALWAYS_INLINE;
			static inline void ADC_Init(uint8_t Mode)
			{
				ADCSRA = ((1 << ADEN) | Mode);
			}

			/** Turns off the ADC. If this is called, any further ADC operations will require a call to
			 *  \ref ADC_Init() before the ADC can be used again.
			 */
			static inline void ADC_ShutDown(void) ATTR_ALWAYS_INLINE;
			static inline void ADC_ShutDown(void)
			{
				ADCSRA = 0;
			}
392

393
394
395
396
397
398
399
400
401
			/** Indicates if the ADC is currently enabled.
			 *
			 *  \return Boolean true if the ADC subsystem is currently enabled, false otherwise.
			 */
			static inline bool ADC_GetStatus(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline bool ADC_GetStatus(void)
			{
				return ((ADCSRA & (1 << ADEN)) ? true : false);
			}
402

403
404
405
406
	/* Disable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			}
		#endif
407

408
409
410
#endif

/** @} */
411