LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  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   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *
  33  *  ADC driver for the AT90USB1287, AT90USB1286, AT90USB647, AT90USB646, ATMEGA16U4 and ATMEGA32U4 AVRs.
  34  *
  35  *  \note This file should not be included directly. It is automatically included as needed by the ADC driver
  36  *        dispatch header located in LUFA/Drivers/Peripheral/ADC.h.
  37  */
  38
  39 /** \ingroup Group_ADC
  40  *  @defgroup Group_ADC_AVRU4U6U7 Series U4, U6 and U7 Model ADC Driver
  41  *
  42  *  @{
  43  */
  44
  45 #ifndef __ADC_AVRU4U6U7_H__
  46 #define __ADC_AVRU4U6U7_H__
  47
  48         /* Includes: */
  49                 #include "../../../Common/Common.h"
  50
  51                 #include <avr/io.h>
  52                 #include <stdbool.h>
  53
  54         /* Enable C linkage for C++ Compilers: */
  55                 #if defined(__cplusplus)
  56                         extern "C" {
  57                 #endif
  58
  59         /* Preprocessor Checks: */
  60                 #if !defined(INCLUDE_FROM_ADC_H)
  61                         #error Do not include this file directly. Include LUFA/Drivers/Peripheral/ADC.h instead.
  62                 #endif
  63
  64         /* Public Interface - May be used in end-application: */
  65                 /* Macros: */
  66                         /** Reference mask, for using the voltage present at the AVR's AREF pin for the ADC reference. */
  67                         #define  ADC_REFERENCE_AREF              0
  68
  69                         /** Reference mask, for using the voltage present at the AVR's AVCC pin for the ADC reference. */
  70                         #define  ADC_REFERENCE_AVCC              (1 << REFS0)
  71
  72                         /** Reference mask, for using the internally generated 2.56V reference voltage as the ADC reference. */
  73                         #define  ADC_REFERENCE_INT2560MV         ((1 << REFS1)| (1 << REFS0))
  74
  75                         /** Left-adjusts the 10-bit ADC result, so that the upper 8 bits of the value returned by the
  76                          *  ADC_GetResult() macro contain the 8 most significant bits of the result. */
  77                         #define  ADC_LEFT_ADJUSTED               (1 << ADLAR)
  78
  79                         /** Right-adjusts the 10-bit ADC result, so that the lower 8 bits of the value returned by the
  80                          *  ADC_GetResult() macro contain the 8 least significant bits of the result. */
  81                         #define  ADC_RIGHT_ADJUSTED              (0 << ADLAR)
  82
  83                         /** Sets the ADC mode to free running, so that conversions take place continuously as fast as the ADC
  84                          *  is capable of at the given input clock speed. */
  85                         #define  ADC_FREE_RUNNING                (1 << ADATE)
  86
  87                         /** Sets the ADC mode to single conversion, so that only a single conversion will take place before
  88                          *  the ADC returns to idle. */
  89                         #define  ADC_SINGLE_CONVERSION           (0 << ADATE)
  90
  91                         /** Sets the ADC input clock to prescale by a factor of 2 the AVR's system clock. */
  92                         #define  ADC_PRESCALE_2                  (1 << ADPS0)
  93
  94                         /** Sets the ADC input clock to prescale by a factor of 4 the AVR's system clock. */
  95                         #define  ADC_PRESCALE_4                  (1 << ADPS1)
  96
  97                         /** Sets the ADC input clock to prescale by a factor of 8 the AVR's system clock. */
  98                         #define  ADC_PRESCALE_8                  ((1 << ADPS0) | (1 << ADPS1))
  99
 100                         /** Sets the ADC input clock to prescale by a factor of 16 the AVR's system clock. */
 101                         #define  ADC_PRESCALE_16                 (1 << ADPS2)
 102
 103                         /** Sets the ADC input clock to prescale by a factor of 32 the AVR's system clock. */
 104                         #define  ADC_PRESCALE_32                 ((1 << ADPS2) | (1 << ADPS0))
 105
 106                         /** Sets the ADC input clock to prescale by a factor of 64 the AVR's system clock. */
 107                         #define  ADC_PRESCALE_64                 ((1 << ADPS2) | (1 << ADPS1))
 108
 109                         /** Sets the ADC input clock to prescale by a factor of 128 the AVR's system clock. */
 110                         #define  ADC_PRESCALE_128                ((1 << ADPS2) | (1 << ADPS1) | (1 << ADPS0))
 111
 112                         //@{
 113                         /** MUX mask define for the ADC0 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading. */
 114                         #define  ADC_CHANNEL0                    0x00
 115
 116                         /** MUX mask define for the ADC1 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading. */
 117                         #define  ADC_CHANNEL1                    0x01
 118
 119                         /** MUX mask define for the ADC2 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading. */
 120                         #define  ADC_CHANNEL2                    0x02
 121
 122                         /** MUX mask define for the ADC3 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading. */
 123                         #define  ADC_CHANNEL3                    0x03
 124
 125                         /** MUX mask define for the ADC4 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading. */
 126                         #define  ADC_CHANNEL4                    0x04
 127
 128                         /** MUX mask define for the ADC5 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading. */
 129                         #define  ADC_CHANNEL5                    0x05
 130
 131                         /** MUX mask define for the ADC6 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading. */
 132                         #define  ADC_CHANNEL6                    0x06
 133
 134                         /** MUX mask define for the ADC7 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading. */
 135                         #define  ADC_CHANNEL7                    0x07
 136
 137                         /** MUX mask define for the internal 1.1V bandgap channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading. */
 138                         #define  ADC_1100MV_BANDGAP              0x1E
 139
 140                         #if (defined(__AVR_ATmega16U4__)  || defined(__AVR_ATmega32U4__) || defined(__DOXYGEN__))
 141                                 /** MUX mask define for the ADC8 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading.
 142                                  *
 143                                  *  \note Note available on all AVR models.
 144                                  */
 145                                 #define  ADC_CHANNEL8                0x20
 146
 147                                 /** MUX mask define for the ADC9 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading.
 148                                  *
 149                                  *  \note Note available on all AVR models.
 150                                  */
 151                                 #define  ADC_CHANNEL9                0x21
 152
 153                                 /** MUX mask define for the ADC10 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading.
 154                                  *
 155                                  *  \note Note available on all AVR models.
 156                                  */
 157                                 #define  ADC_CHANNEL10               0x22
 158
 159                                 /** MUX mask define for the ADC11 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading.
 160                                  *
 161                                  *  \note Note available on all AVR models.
 162                                  */
 163                                 #define  ADC_CHANNEL11               0x23
 164
 165                                 /** MUX mask define for the ADC12 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading.
 166                                  *
 167                                  *  \note Note available on all AVR models.
 168                                  */
 169                                 #define  ADC_CHANNEL12               0x24
 170
 171                                 /** MUX mask define for the ADC13 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading.
 172                                  *
 173                                  *  \note Note available on all AVR models.
 174                                  */
 175                                 #define  ADC_CHANNEL13               0x25
 176
 177                                 /** MUX mask define for the internal temperature sensor channel of the ADC. See \ref ADC_StartReading and
 178                                  *  \ref ADC_GetChannelReading.
 179                                  *
 180                                  *  \note Note available on all AVR models.
 181                                  */
 182                                 #define  ADC_INT_TEMP_SENS           0x27
 183                         #endif
 184                         //@}
 185
 186                 /* Pseudo-Function Macros: */
 187                         #if defined(__DOXYGEN__)
 188                                 /** Initializes the ADC, ready for conversions. This must be called before any other ADC operations.
 189                                  *  The "mode" parameter should be a mask comprised of a conversion mode (free running or single) and
 190                                  *  prescaler masks.
 191                                  *
 192                                  *  \param[in] Mode  Mask of ADC settings, including adjustment, prescale, mode and reference
 193                                  */
 194                                 static inline void ADC_Init(uint8_t Mode);
 195
 196                                 /** Turns off the ADC. If this is called, any further ADC operations will require a call to
 197                                  *  \ref ADC_Init() before the ADC can be used again.
 198                                  */
 199                                 static inline void ADC_ShutDown(void);
 200
 201                                 /** Indicates if the ADC is currently enabled.
 202                                  *
 203                                  *  \return Boolean true if the ADC subsystem is currently enabled, false otherwise.
 204                                  */
 205                                 static inline bool ADC_GetStatus(void);
 206
 207                                 /** Indicates if the current ADC conversion is completed, or still in progress.
 208                                  *
 209                                  *  \return Boolean false if the reading is still taking place, or true if the conversion is
 210                                  *          complete and ready to be read out with \ref ADC_GetResult()
 211                                  */
 212                                 static inline bool ADC_IsReadingComplete(void);
 213
 214                                 /** Retrieves the conversion value of the last completed ADC conversion.
 215                                  *
 216                                  *  \return The result of the last ADC conversion
 217                                  */
 218                                 static inline uint16_t ADC_GetResult(void);
 219                         #else
 220                                 #define  ADC_Init(mode)          MACROS{ ADCSRA = ((1 << ADEN) | mode);         }MACROE
 221
 222                                 #define  ADC_ShutDown()          MACROS{ ADCSRA = 0;                            }MACROE
 223
 224                                 #define  ADC_GetStatus()               ((ADCSRA & (1 << ADEN)) ? true : false)
 225
 226                                 #define  ADC_IsReadingComplete()        (ADCSRA & (1 << ADSC))
 227
 228                                 #define  ADC_GetResult()                 ADC
 229                         #endif
 230
 231                 /* Inline Functions: */
 232                         /** Configures the given ADC channel, ready for ADC conversions. This function sets the
 233                          *  associated port pin as an input and disables the digital portion of the I/O to reduce
 234                          *  power consumption.
 235                          *
 236                          *  \note This must only be called for ADC channels with are connected to a physical port
 237                          *        pin of the AVR, denoted by its special alternative function ADCx.
 238                          *
 239                          *  \note The channel number must be specified as an integer, and NOT a ADC_CHANNELx mask.
 240                          *
 241                          *  \param[in] Channel  ADC channel number to set up for conversions
 242                          */
 243                         static inline void ADC_SetupChannel(const uint8_t Channel)
 244                         {
 245                                 #if (defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB646__) || \
 246                                          defined(__AVR_AT90USB1287__) || defined(__AVR_AT90USB647__) || \
 247                                          defined(__AVR_ATmega32U6__))
 248                                 DDRF  &= ~(1 << Channel);
 249                                 DIDR0 |=  (1 << Channel);
 250                                 #elif (defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__))
 251                                 if (Channel < 8)
 252                                 {
 253                                         DDRF  &= ~(1 << Channel);
 254                                         DIDR0 |=  (1 << Channel);
 255                                 }
 256                                 else if (Channel == 8)
 257                                 {
 258                                         DDRD  &= ~(1 << 4);
 259                                         DIDR2 |=  (1 << 0);
 260                                 }
 261                                 else if (Channel < 11)
 262                                 {
 263                                         DDRD  &= ~(1 << (Channel - 3));
 264                                         DIDR2 |=  (1 << (Channel - 8));
 265                                 }
 266                                 else
 267                                 {
 268                                         DDRB  &= ~(1 << (Channel - 7));
 269                                         DIDR2 |=  (1 << (Channel - 8));
 270                                 }
 271                                 #endif
 272                         }
 273
 274                         /** Starts the reading of the given channel, but does not wait until the conversion has completed.
 275                          *  Once executed, the conversion status can be determined via the \ref ADC_IsReadingComplete() macro and
 276                          *  the result read via the \ref ADC_GetResult() macro.
 277                          *
 278                          *  \param[in] MUXMask  Mask comprising of an ADC channel mask, reference mask and adjustment mask
 279                          */
 280                         static inline void ADC_StartReading(const uint8_t MUXMask)
 281                         {
 282                                 ADMUX = MUXMask;
 283
 284                                 ADCSRA |= (1 << ADSC);
 285                         }
 286
 287                         /** Performs a complete single reading from channel, including a polling spin-loop to wait for the
 288                          *  conversion to complete, and the returning of the converted value.
 289                          *
 290                          *  \param[in] MUXMask  Mask comprising of an ADC channel mask, reference mask and adjustment mask
 291                          */
 292                         static inline uint16_t ADC_GetChannelReading(const uint8_t MUXMask) ATTR_WARN_UNUSED_RESULT;
 293                         static inline uint16_t ADC_GetChannelReading(const uint8_t MUXMask)
 294                         {
 295                                 ADC_StartReading(MUXMask);
 296
 297                                 while (!(ADC_IsReadingComplete()));
 298
 299                                 return ADC_GetResult();
 300                         }
 301
 302         /* Disable C linkage for C++ Compilers: */
 303                 #if defined(__cplusplus)
 304                         }
 305                 #endif
 306
 307 #endif
 308
 309 /** @} */