Added board hardware driver support for the Microsin AVR-USB162 development board.
[pub/USBasp.git] / LUFA / Drivers / Peripheral / AVRU4U6U7 / ADC.h
index 0aaaa93..4790668 100644 (file)
@@ -3,7 +3,7 @@
      Copyright (C) Dean Camera, 2010.
 
   dean [at] fourwalledcubicle [dot] com
      Copyright (C) Dean Camera, 2010.
 
   dean [at] fourwalledcubicle [dot] com
-      www.fourwalledcubicle.com
+           www.lufa-lib.org
 */
 
 /*
 */
 
 /*
@@ -71,6 +71,8 @@
 
        /* Public Interface - May be used in end-application: */
                /* Macros: */
 
        /* Public Interface - May be used in end-application: */
                /* 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
 
 
                        /** 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)
 
 
                        /** 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)