projects / pub / lufa.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Add script reading bootloader flags
[pub/lufa.git] / LUFA / Drivers / Peripheral / AVR8 / ADC_AVR8.h
diff --git a/LUFA/Drivers/Peripheral/AVR8/ADC_AVR8.h b/LUFA/Drivers/Peripheral/AVR8/ADC_AVR8.h
index 437b4d1..f81484d 100644 (file)
--- a/LUFA/Drivers/Peripheral/AVR8/ADC_AVR8.h
+++ b/LUFA/Drivers/Peripheral/AVR8/ADC_AVR8.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2011.
+     Copyright (C) Dean Camera, 2021.
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
-  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2021  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
@@ -18,7 +18,7 @@
   advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 
   advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 
-  The author disclaim all warranties with regard to this
+  The author disclaims 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
   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
@@ -41,14 +41,14 @@
 /** \ingroup Group_ADC
  *  \defgroup Group_ADC_AVR8 ADC Peripheral Driver (AVR8)
  *
 /** \ingroup Group_ADC
  *  \defgroup Group_ADC_AVR8 ADC Peripheral Driver (AVR8)
  *
- *  \section Sec_ModDescription Module Description
+ *  \section Sec_ADC_AVR8_ModDescription Module Description
  *  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.
  *
  *  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.
  *
- *  \section Sec_ExampleUsage Example Usage
+ *  \section Sec_ADC_AVR8_ExampleUsage Example Usage
  *  The following snippet is an example of how this module may be used within a typical
  *  application.
  *
  *  The following snippet is an example of how this module may be used within a typical
  *  application.
  *
@@ -93,22 +93,14 @@
 
                #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_ATmega16U4__)  || defined(__AVR_ATmega32U4__) || \
-                         defined(__AVR_ATmega32U6__))
+                         defined(__AVR_ATmega16U4__)  || defined(__AVR_ATmega32U4__))
                        #error The ADC peripheral driver is not currently available for your selected microcontroller model.
                #endif
 
                        #error The ADC peripheral driver is not currently available for your selected microcontroller model.
                #endif
 
-       /* Private Interface - For use in library only: */
-       #if !defined(__DOXYGEN__)
-               /* Macros: */
-                       #define _ADC_GET_MUX_MASK2(y)           ADC_CHANNEL ## y
-                       #define _ADC_GET_MUX_MASK(y)            _ADC_GET_MUX_MASK2(y)
-       #endif
-       
        /* Public Interface - May be used in end-application: */
                /* Macros: */
                        /** \name ADC Reference Configuration Masks */
        /* 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
 
@@ -117,10 +109,10 @@
 
                        /** 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 */
                        /** \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
                         *  \ref ADC_GetResult() macro contain the 8 most significant bits of the result.
                         */
                        /** Left-adjusts the 10-bit ADC result, so that the upper 8 bits of the value returned by the
                         *  \ref ADC_GetResult() macro contain the 8 most significant bits of the result.
                         */
@@ -130,10 +122,10 @@
                         *  \ref ADC_GetResult() macro contain the 8 least significant bits of the result.
                         */
                        #define ADC_RIGHT_ADJUSTED              (0 << ADLAR)
                         *  \ref ADC_GetResult() macro contain the 8 least significant bits of the result.
                         */
                        #define ADC_RIGHT_ADJUSTED              (0 << ADLAR)
-                       //@}
+                       /**@}*/
 
                        /** \name ADC Mode Configuration Masks */
 
                        /** \name ADC Mode Configuration Masks */
-                       //@{
+                       /**@{*/
                        /** 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.
                         */
                        /** 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.
                         */
@@ -143,10 +135,10 @@
                         *  the ADC returns to idle.
                         */
                        #define ADC_SINGLE_CONVERSION           (0 << ADATE)
                         *  the ADC returns to idle.
                         */
                        #define ADC_SINGLE_CONVERSION           (0 << ADATE)
-                       //@}
-                       
+                       /**@}*/
+
                        /** \name ADC Prescaler Configuration Masks */
                        /** \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)
 
@@ -167,17 +159,17 @@
 
                        /** 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 */
 
                        /** \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 ADC1 channel of the ADC. See \ref ADC_StartReading() and \ref ADC_GetChannelReading(). */
                        #define ADC_CHANNEL1                    (0x01 << MUX0)
 
                        /** 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 ADC1 channel of the ADC. See \ref ADC_StartReading() and \ref ADC_GetChannelReading(). */
                        #define ADC_CHANNEL1                    (0x01 << MUX0)
 
-                       #if !(defined(__AVR_ATmega16U4__)  || defined(__AVR_ATmega32U4__) || defined(__DOXYGEN__))
+                       #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.
                                /** 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.
@@ -203,9 +195,6 @@
                        /** MUX mask define for the ADC7 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading. */
                        #define ADC_CHANNEL7                    (0x07 << MUX0)
 
                        /** MUX mask define for the ADC7 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading. */
                        #define ADC_CHANNEL7                    (0x07 << 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().
                                 *
@@ -251,15 +240,18 @@
                                #define ADC_INT_TEMP_SENS           ((1 << 8) | (0x07 << MUX0))
                        #endif
 
                                #define ADC_INT_TEMP_SENS           ((1 << 8) | (0x07 << MUX0))
                        #endif
 
+                       /** MUX mask define for the internal 1.1V band-gap channel of the ADC. See \ref ADC_StartReading() and \ref ADC_GetChannelReading(). */
+                       #define ADC_1100MV_BANDGAP              (0x1E << MUX0)
+
                        /** Retrieves the ADC MUX mask for the given ADC channel number.
                         *
                        /** Retrieves the ADC MUX mask for the given ADC channel number.
                         *
-                        *  \note This macro will only work correctly on channel numbers that are compile-time
-                        *        constants defined by the preprocessor.
+                        *  \attention This macro will only work correctly on channel numbers that are compile-time
+                        *             constants defined by the preprocessor.
                         *
                         *  \param[in] Channel  Index of the ADC channel whose MUX mask is to be retrieved.
                         */
                         *
                         *  \param[in] Channel  Index of the ADC channel whose MUX mask is to be retrieved.
                         */
-                       #define ADC_GET_CHANNEL_MASK(Channel)   _ADC_GET_MUX_MASK(Channel)
-                       //@}
+                       #define ADC_GET_CHANNEL_MASK(Channel)   CONCAT_EXPANDED(ADC_CHANNEL, Channel)
+                       /**@}*/
 
                /* Inline Functions: */
                        /** Configures the given ADC channel, ready for ADC conversions. This function sets the
 
                /* Inline Functions: */
                        /** Configures the given ADC channel, ready for ADC conversions. This function sets the
@@ -268,17 +260,15 @@
                         *
                         *  \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.
                         *
                         *  \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 <b>not</b> a \c ADC_CHANNEL* mask.
+                        *  \warning The channel number must be specified as an integer, and <b>not</b> a \c ADC_CHANNEL* mask.
                         *
                         *  \param[in] ChannelIndex  ADC channel number to set up for conversions.
                         */
                        static inline void ADC_SetupChannel(const uint8_t ChannelIndex)
                        {
                                #if (defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB646__) || \
                         *
                         *  \param[in] ChannelIndex  ADC channel number to set up for conversions.
                         */
                        static inline void ADC_SetupChannel(const uint8_t ChannelIndex)
                        {
                                #if (defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB646__) || \
-                                        defined(__AVR_AT90USB1287__) || defined(__AVR_AT90USB647__) || \
-                                        defined(__AVR_ATmega32U6__))
+                                        defined(__AVR_AT90USB1287__) || defined(__AVR_AT90USB647__))
                                DDRF  &= ~(1 << ChannelIndex);
                                DIDR0 |=  (1 << ChannelIndex);
                                #elif (defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__))
                                DDRF  &= ~(1 << ChannelIndex);
                                DIDR0 |=  (1 << ChannelIndex);
                                #elif (defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__))
@@ -311,17 +301,15 @@
                         *
                         *  \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.
                         *
                         *  \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 <b>not</b> a \c ADC_CHANNEL* mask.
+                        *  \warning The channel number must be specified as an integer, and <b>not</b> a \c ADC_CHANNEL* mask.
                         *
                         *  \param[in] ChannelIndex  ADC channel number to set up for conversions.
                         */
                        static inline void ADC_DisableChannel(const uint8_t ChannelIndex)
                        {
                                #if (defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB646__) || \
                         *
                         *  \param[in] ChannelIndex  ADC channel number to set up for conversions.
                         */
                        static inline void ADC_DisableChannel(const uint8_t ChannelIndex)
                        {
                                #if (defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB646__) || \
-                                        defined(__AVR_AT90USB1287__) || defined(__AVR_AT90USB647__) || \
-                                        defined(__AVR_ATmega32U6__))
+                                        defined(__AVR_AT90USB1287__) || defined(__AVR_AT90USB647__))
                                DDRF  &= ~(1 << ChannelIndex);
                                DIDR0 &= ~(1 << ChannelIndex);
                                #elif (defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__))
                                DDRF  &= ~(1 << ChannelIndex);
                                DIDR0 &= ~(1 << ChannelIndex);
                                #elif (defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__))
@@ -374,7 +362,7 @@
 
                        /** Indicates if the current ADC conversion is completed, or still in progress.
                         *
 
                        /** 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
+                        *  \return Boolean \c 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;
                         *          complete and ready to be read out with \ref ADC_GetResult().
                         */
                        static inline bool ADC_IsReadingComplete(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
@@ -403,6 +391,8 @@
                         *        the results read directly from the \ref ADC_GetResult() instead to reduce overhead.
                         *
                         *  \param[in] MUXMask  Mask comprising of an ADC channel mask, reference mask and adjustment mask.
                         *        the results read directly from the \ref ADC_GetResult() instead to reduce overhead.
                         *
                         *  \param[in] MUXMask  Mask comprising of an ADC channel mask, reference mask and adjustment mask.
+                        *
+                        *  \return Converted ADC result for the given ADC channel.
                         */
                        static inline uint16_t ADC_GetChannelReading(const uint16_t MUXMask) ATTR_WARN_UNUSED_RESULT;
                        static inline uint16_t ADC_GetChannelReading(const uint16_t MUXMask)
                         */
                        static inline uint16_t ADC_GetChannelReading(const uint16_t MUXMask) ATTR_WARN_UNUSED_RESULT;
                        static inline uint16_t ADC_GetChannelReading(const uint16_t MUXMask)
@@ -420,8 +410,8 @@
                         *
                         *  \param[in] Mode  Mask of ADC prescale and mode settings.
                         */
                         *
                         *  \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(const uint8_t Mode) ATTR_ALWAYS_INLINE;
+                       static inline void ADC_Init(const uint8_t Mode)
                        {
                                ADCSRA = ((1 << ADEN) | Mode);
                        }
                        {
                                ADCSRA = ((1 << ADEN) | Mode);
                        }
Lightweight USB Framework for AVRs