projects / pub / USBasp.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Added board hardware driver support for the Microsin AVR-USB162 development board.
[pub/USBasp.git] / LUFA / Drivers / Peripheral / AVRU4U6U7 / ADC.h
diff --git a/LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h b/LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h
index ed42b34..4790668 100644 (file)
--- a/LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h
+++ b/LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h
@@ -1,21 +1,21 @@
 /*
              LUFA Library
      Copyright (C) Dean Camera, 2010.
 /*
              LUFA Library
      Copyright (C) Dean Camera, 2010.
-              
+
   dean [at] fourwalledcubicle [dot] com
   dean [at] fourwalledcubicle [dot] com
-      www.fourwalledcubicle.com
+           www.lufa-lib.org
 */
 
 /*
   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
 */
 
 /*
   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
-  Permission to use, copy, modify, distribute, and sell this 
+  Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
   software and its documentation for any purpose is hereby granted
-  without fee, provided that the above copyright notice appear in 
+  without fee, provided that the above copyright notice appear in
   all copies and that both that the copyright notice and this
   all copies and that both that the copyright notice and this
-  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 
+  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
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this
@@ -31,7 +31,8 @@
 /** \file
  *  \brief ADC peripheral driver for the U7, U6 and U4 USB AVRs.
  *
 /** \file
  *  \brief ADC peripheral driver for the U7, U6 and U4 USB AVRs.
  *
- *  ADC driver for the AT90USB1287, AT90USB1286, AT90USB647, AT90USB646, ATMEGA16U4 and ATMEGA32U4 AVRs.
+ *  On-chip Analogue-to-Digital converter (ADC) driver for supported U4, U6 and U7 model AVRs that contain an ADC
+ *  peripheral internally.
  *
  *  \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.
  *
  *  \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.
@@ -40,23 +41,24 @@
 /** \ingroup Group_ADC
  *  @defgroup Group_ADC_AVRU4U6U7 Series U4, U6 and U7 Model ADC Driver
  *
 /** \ingroup Group_ADC
  *  @defgroup Group_ADC_AVRU4U6U7 Series U4, U6 and U7 Model ADC Driver
  *
- *  ADC driver for the AT90USB1287, AT90USB1286, AT90USB647, AT90USB646, ATMEGA16U4 and ATMEGA32U4 AVRs.
+ *  On-chip Analogue-to-Digital converter (ADC) driver for supported U4, U6 and U7 model AVRs that contain an ADC
+ *  peripheral internally.
  *
  *  \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.
  *
  *  @{
  */
  *
  *  \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.
  *
  *  @{
  */
- 
+
 #ifndef __ADC_AVRU4U6U7_H__
 #define __ADC_AVRU4U6U7_H__
 
        /* Includes: */
                #include "../../../Common/Common.h"
 #ifndef __ADC_AVRU4U6U7_H__
 #define __ADC_AVRU4U6U7_H__
 
        /* Includes: */
                #include "../../../Common/Common.h"
-               
+
                #include <avr/io.h>
                #include <stdbool.h>
                #include <avr/io.h>
                #include <stdbool.h>
-               
+
        /* Enable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
                        extern "C" {
        /* Enable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
                        extern "C" {
@@ -68,7 +70,9 @@
                #endif
 
        /* Public Interface - May be used in end-application: */
                #endif
 
        /* Public Interface - May be used in end-application: */
-               /* Macros: */                   
+               /* Macros: */
+                       /** \name ADC Reference Configuration Masks */
+                       //@{
                        /** Reference mask, for using the voltage present at the AVR's AREF pin for the ADC reference. */
                        #define ADC_REFERENCE_AREF              0
 
                        /** Reference mask, for using the voltage present at the AVR's AREF pin for the ADC reference. */
                        #define ADC_REFERENCE_AREF              0
 
@@ -77,23 +81,36 @@
 
                        /** Reference mask, for using the internally generated 2.56V reference voltage as the ADC reference. */
                        #define ADC_REFERENCE_INT2560MV         ((1 << REFS1) | (1 << REFS0))
 
                        /** Reference mask, for using the internally generated 2.56V reference voltage as the ADC reference. */
                        #define ADC_REFERENCE_INT2560MV         ((1 << REFS1) | (1 << REFS0))
+                       //@}
                        
                        
+                       /** \name ADC Result Adjustment Configuration Masks */
+                       //@{
                        /** Left-adjusts the 10-bit ADC result, so that the upper 8 bits of the value returned by the
                        /** Left-adjusts the 10-bit ADC result, so that the upper 8 bits of the value returned by the
-                        *  ADC_GetResult() macro contain the 8 most significant bits of the result. */
+                        *  ADC_GetResult() macro contain the 8 most significant bits of the result.
+                        */
                        #define ADC_LEFT_ADJUSTED               (1 << ADLAR)
 
                        /** Right-adjusts the 10-bit ADC result, so that the lower 8 bits of the value returned by the
                        #define ADC_LEFT_ADJUSTED               (1 << ADLAR)
 
                        /** Right-adjusts the 10-bit ADC result, so that the lower 8 bits of the value returned by the
-                        *  ADC_GetResult() macro contain the 8 least significant bits of the result. */
+                        *  ADC_GetResult() macro contain the 8 least significant bits of the result.
+                        */
                        #define ADC_RIGHT_ADJUSTED              (0 << ADLAR)
                        #define ADC_RIGHT_ADJUSTED              (0 << ADLAR)
-                       
+                       //@}
+
+                       /** \name ADC Mode Configuration Masks */
+                       //@{
                        /** Sets the ADC mode to free running, so that conversions take place continuously as fast as the ADC
                        /** Sets the ADC mode to free running, so that conversions take place continuously as fast as the ADC
-                        *  is capable of at the given input clock speed. */
+                        *  is capable of at the given input clock speed.
+                        */
                        #define ADC_FREE_RUNNING                (1 << ADATE)
 
                        /** Sets the ADC mode to single conversion, so that only a single conversion will take place before
                        #define ADC_FREE_RUNNING                (1 << ADATE)
 
                        /** Sets the ADC mode to single conversion, so that only a single conversion will take place before
-                        *  the ADC returns to idle. */
+                        *  the ADC returns to idle.
+                        */
                        #define ADC_SINGLE_CONVERSION           (0 << ADATE)
                        #define ADC_SINGLE_CONVERSION           (0 << ADATE)
+                       //@}
                        
                        
+                       /** \name ADC Prescaler Configuration Masks */
+                       //@{
                        /** Sets the ADC input clock to prescale by a factor of 2 the AVR's system clock. */
                        #define ADC_PRESCALE_2                  (1 << ADPS0)
 
                        /** Sets the ADC input clock to prescale by a factor of 2 the AVR's system clock. */
                        #define ADC_PRESCALE_2                  (1 << ADPS0)
 
@@ -114,7 +131,9 @@
 
                        /** Sets the ADC input clock to prescale by a factor of 128 the AVR's system clock. */
                        #define ADC_PRESCALE_128                ((1 << ADPS2) | (1 << ADPS1) | (1 << ADPS0))
 
                        /** Sets the ADC input clock to prescale by a factor of 128 the AVR's system clock. */
                        #define ADC_PRESCALE_128                ((1 << ADPS2) | (1 << ADPS1) | (1 << ADPS0))
-                       
+                       //@}
+
+                       /** \name ADC MUX Masks */
                        //@{
                        /** MUX mask define for the ADC0 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading. */
                        #define ADC_CHANNEL0                    (0x00 << MUX0)
                        //@{
                        /** MUX mask define for the ADC0 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading. */
                        #define ADC_CHANNEL0                    (0x00 << MUX0)
@@ -150,7 +169,7 @@
 
                        /** MUX mask define for the internal 1.1V bandgap channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading. */
                        #define ADC_1100MV_BANDGAP              (0x1E << MUX0)
 
                        /** MUX mask define for the internal 1.1V bandgap channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading. */
                        #define ADC_1100MV_BANDGAP              (0x1E << MUX0)
-                       
+
                        #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.
                                 *
                        #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.
                                 *
@@ -196,7 +215,7 @@
                                #define ADC_INT_TEMP_SENS           ((1 << 8) | (0x07 << MUX0))
                        #endif
                        //@}
                                #define ADC_INT_TEMP_SENS           ((1 << 8) | (0x07 << MUX0))
                        #endif
                        //@}
-                       
+
                /* 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
                /* 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
@@ -208,39 +227,39 @@
                         *
                         *  \note The channel number must be specified as an integer, and NOT a ADC_CHANNELx mask.
                         *
                         *
                         *  \note The channel number must be specified as an integer, and NOT a ADC_CHANNELx mask.
                         *
-                        *  \param[in] Channel  ADC channel number to set up for conversions.
+                        *  \param[in] ChannelIndex  ADC channel number to set up for conversions.
                         */
                         */
-                       static inline void ADC_SetupChannel(const uint8_t Channel)
+                       static inline void ADC_SetupChannel(const uint8_t ChannelIndex)
                        {
                                #if (defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB646__) || \
                                         defined(__AVR_AT90USB1287__) || defined(__AVR_AT90USB647__) || \
                        {
                                #if (defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB646__) || \
                                         defined(__AVR_AT90USB1287__) || defined(__AVR_AT90USB647__) || \
-                                        defined(__AVR_ATmega32U6__))                           
-                               DDRF  &= ~(1 << Channel);
-                               DIDR0 |=  (1 << Channel);
+                                        defined(__AVR_ATmega32U6__))
+                               DDRF  &= ~(1 << ChannelIndex);
+                               DIDR0 |=  (1 << ChannelIndex);
                                #elif (defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__))
                                #elif (defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__))
-                               if (Channel < 8)
+                               if (ChannelIndex < 8)
                                {
                                {
-                                       DDRF  &= ~(1 << Channel);
-                                       DIDR0 |=  (1 << Channel);
+                                       DDRF  &= ~(1 << ChannelIndex);
+                                       DIDR0 |=  (1 << ChannelIndex);
                                }
                                }
-                               else if (Channel == 8)
+                               else if (ChannelIndex == 8)
                                {
                                        DDRD  &= ~(1 << 4);
                                        DIDR2 |=  (1 << 0);
                                }
                                {
                                        DDRD  &= ~(1 << 4);
                                        DIDR2 |=  (1 << 0);
                                }
-                               else if (Channel < 11)
+                               else if (ChannelIndex < 11)
                                {
                                {
-                                       DDRD  &= ~(1 << (Channel - 3));
-                                       DIDR2 |=  (1 << (Channel - 8));
+                                       DDRD  &= ~(1 << (ChannelIndex - 3));
+                                       DIDR2 |=  (1 << (ChannelIndex - 8));
                                }
                                else
                                {
                                }
                                else
                                {
-                                       DDRB  &= ~(1 << (Channel - 7));
-                                       DIDR2 |=  (1 << (Channel - 8));
+                                       DDRB  &= ~(1 << (ChannelIndex - 7));
+                                       DIDR2 |=  (1 << (ChannelIndex - 8));
                                }
                                #endif
                        }
                                }
                                #endif
                        }
-                       
+
                        /** De-configures the given ADC channel, re-enabling digital I/O mode instead of analog. This
                         *  function sets the associated port pin as an input and re-enabled the digital portion of
                         *  the I/O.
                        /** De-configures the given ADC channel, re-enabling digital I/O mode instead of analog. This
                         *  function sets the associated port pin as an input and re-enabled the digital portion of
                         *  the I/O.
@@ -251,35 +270,35 @@
                         *
                         *  \note The channel number must be specified as an integer, and NOT a ADC_CHANNELx mask.
                         *
                         *
                         *  \note The channel number must be specified as an integer, and NOT a ADC_CHANNELx mask.
                         *
-                        *  \param[in] Channel  ADC channel number to set up for conversions.
+                        *  \param[in] ChannelIndex  ADC channel number to set up for conversions.
                         */
                         */
-                       static inline void ADC_DisableChannel(const uint8_t Channel)
+                       static inline void ADC_DisableChannel(const uint8_t ChannelIndex)
                        {
                                #if (defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB646__) || \
                                         defined(__AVR_AT90USB1287__) || defined(__AVR_AT90USB647__) || \
                        {
                                #if (defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB646__) || \
                                         defined(__AVR_AT90USB1287__) || defined(__AVR_AT90USB647__) || \
-                                        defined(__AVR_ATmega32U6__))                           
-                               DDRF  &= ~(1 << Channel);
-                               DIDR0 &= ~(1 << Channel);
+                                        defined(__AVR_ATmega32U6__))
+                               DDRF  &= ~(1 << ChannelIndex);
+                               DIDR0 &= ~(1 << ChannelIndex);
                                #elif (defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__))
                                #elif (defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__))
-                               if (Channel < 8)
+                               if (ChannelIndex < 8)
                                {
                                {
-                                       DDRF  &= ~(1 << Channel);
-                                       DIDR0 &= ~(1 << Channel);
+                                       DDRF  &= ~(1 << ChannelIndex);
+                                       DIDR0 &= ~(1 << ChannelIndex);
                                }
                                }
-                               else if (Channel == 8)
+                               else if (ChannelIndex == 8)
                                {
                                        DDRD  &= ~(1 << 4);
                                        DIDR2 &= ~(1 << 0);
                                }
                                {
                                        DDRD  &= ~(1 << 4);
                                        DIDR2 &= ~(1 << 0);
                                }
-                               else if (Channel < 11)
+                               else if (ChannelIndex < 11)
                                {
                                {
-                                       DDRD  &= ~(1 << (Channel - 3));
-                                       DIDR2 &= ~(1 << (Channel - 8));
+                                       DDRD  &= ~(1 << (ChannelIndex - 3));
+                                       DIDR2 &= ~(1 << (ChannelIndex - 8));
                                }
                                else
                                {
                                }
                                else
                                {
-                                       DDRB  &= ~(1 << (Channel - 7));
-                                       DIDR2 &= ~(1 << (Channel - 8));
+                                       DDRB  &= ~(1 << (ChannelIndex - 7));
+                                       DIDR2 &= ~(1 << (ChannelIndex - 8));
                                }
                                #endif
                        }
                                }
                                #endif
                        }
@@ -292,19 +311,19 @@
                         *  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.
                         *
                         *  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.
                         *
-                        *  \param[in] MUXMask  Mask comprising of an ADC channel mask, reference mask and adjustment mask.
+                        *  \param[in] MUXMask  ADC channel mask, reference mask and adjustment mask.
                         */
                        static inline void ADC_StartReading(const uint16_t MUXMask)
                        {
                                ADMUX = MUXMask;
                         */
                        static inline void ADC_StartReading(const uint16_t MUXMask)
                        {
                                ADMUX = MUXMask;
-                               
+
                                #if (defined(__AVR_ATmega16U4__)  || defined(__AVR_ATmega32U4__) || defined(__DOXYGEN__))
                                if (MUXMask & (1 << 8))
                                  ADCSRB |=  (1 << MUX5);
                                else
                                  ADCSRB &= ~(1 << MUX5);
                                #endif
                                #if (defined(__AVR_ATmega16U4__)  || defined(__AVR_ATmega32U4__) || defined(__DOXYGEN__))
                                if (MUXMask & (1 << 8))
                                  ADCSRB |=  (1 << MUX5);
                                else
                                  ADCSRB &= ~(1 << MUX5);
                                #endif
-                       
+
                                ADCSRA |= (1 << ADSC);
                        }
 
                                ADCSRA |= (1 << ADSC);
                        }
 
@@ -318,7 +337,7 @@
                        {
                                return ((ADCSRA & (1 << ADIF)) ? true : false);
                        }
                        {
                                return ((ADCSRA & (1 << ADIF)) ? true : false);
                        }
-                       
+
                        /** Retrieves the conversion value of the last completed ADC conversion and clears the reading
                         *  completion flag.
                         *
                        /** Retrieves the conversion value of the last completed ADC conversion and clears the reading
                         *  completion flag.
                         *
@@ -344,9 +363,9 @@
                        static inline uint16_t ADC_GetChannelReading(const uint16_t MUXMask)
                        {
                                ADC_StartReading(MUXMask);
                        static inline uint16_t ADC_GetChannelReading(const uint16_t MUXMask)
                        {
                                ADC_StartReading(MUXMask);
-       
+
                                while (!(ADC_IsReadingComplete()));
                                while (!(ADC_IsReadingComplete()));
-       
+
                                return ADC_GetResult();
                        }
 
                                return ADC_GetResult();
                        }
 
@@ -354,7 +373,7 @@
                         *  The "mode" parameter should be a mask comprised of a conversion mode (free running or single) and
                         *  prescaler masks.
                         *
                         *  The "mode" parameter should be a mask comprised of a conversion mode (free running or single) and
                         *  prescaler masks.
                         *
-                        *  \param[in] Mode  Mask of ADC settings, including adjustment, prescale, mode and reference.
+                        *  \param[in] Mode  Mask of ADC prescale and mode settings.
                         */
                        static inline void ADC_Init(uint8_t Mode) ATTR_ALWAYS_INLINE;
                        static inline void ADC_Init(uint8_t Mode)
                         */
                        static inline void ADC_Init(uint8_t Mode) ATTR_ALWAYS_INLINE;
                        static inline void ADC_Init(uint8_t Mode)
@@ -370,7 +389,7 @@
                        {
                                ADCSRA = 0;
                        }
                        {
                                ADCSRA = 0;
                        }
-                       
+
                        /** Indicates if the ADC is currently enabled.
                         *
                         *  \return Boolean true if the ADC subsystem is currently enabled, false otherwise.
                        /** Indicates if the ADC is currently enabled.
                         *
                         *  \return Boolean true if the ADC subsystem is currently enabled, false otherwise.
@@ -380,12 +399,13 @@
                        {
                                return ((ADCSRA & (1 << ADEN)) ? true : false);
                        }
                        {
                                return ((ADCSRA & (1 << ADEN)) ? true : false);
                        }
-                       
+
        /* Disable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
                        }
                #endif
        /* Disable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
                        }
                #endif
-               
+
 #endif
 
 /** @} */
 #endif
 
 /** @} */
+
USB isp AVR programmer