Fix up the incomplete Webserver project so that it integrates with the uIP stack...
[pub/USBasp.git] / LUFA / Drivers / Peripheral / ADC.h
index 02d2d08..1a11169 100644 (file)
@@ -1,21 +1,21 @@
 /*\r
              LUFA Library\r
 /*\r
              LUFA Library\r
-     Copyright (C) Dean Camera, 2009.\r
+     Copyright (C) Dean Camera, 2010.\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
 \r
 \r
-  Permission to use, copy, modify, and distribute this software\r
-  and its documentation for any purpose and without fee is hereby\r
-  granted, provided that the above copyright notice appear in all\r
-  copies and that both that the copyright notice and this\r
-  permission notice and warranty disclaimer appear in supporting\r
-  documentation, and that the name of the author not be used in\r
-  advertising or publicity pertaining to distribution of the\r
+  Permission to use, copy, modify, distribute, and sell this \r
+  software and its documentation for any purpose is hereby granted\r
+  without fee, provided that the above copyright notice appear in \r
+  all copies and that both that the copyright notice and this\r
+  permission notice and warranty disclaimer appear in supporting \r
+  documentation, and that the name of the author not be used in \r
+  advertising or publicity pertaining to distribution of the \r
   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r
   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r
  *  currently selected AVR model.\r
  */\r
 \r
  *  currently selected AVR model.\r
  */\r
 \r
-/** \ingroup Group_SubsystemDrivers\r
+/** \ingroup Group_PeripheralDrivers\r
  *  @defgroup Group_ADC ADC Driver - LUFA/Drivers/Peripheral/ADC.h\r
  *  @defgroup Group_ADC ADC Driver - LUFA/Drivers/Peripheral/ADC.h\r
+ *\r
+ *  \section Sec_Dependencies Module Source Dependencies\r
+ *  The following files must be built with any user project that uses this module:\r
+ *    - None\r
+ *\r
+ *  \section Module Description\r
+ *  Hardware ADC driver. This module provides an easy to use driver for the hardware\r
+ *  ADC present on many AVR models, for the conversion of analogue signals into the\r
+ *  digital domain.\r
  */\r
  \r
 #ifndef __ADC_H__\r
  */\r
  \r
 #ifndef __ADC_H__\r
                     defined(__AVR_AT90USB1287__) || defined(__AVR_AT90USB647__) || \\r
                         defined(__AVR_ATmega16U4__)  || defined(__AVR_ATmega32U4__) || \\r
                         defined(__AVR_ATmega32U6__))\r
                     defined(__AVR_AT90USB1287__) || defined(__AVR_AT90USB647__) || \\r
                         defined(__AVR_ATmega16U4__)  || defined(__AVR_ATmega32U4__) || \\r
                         defined(__AVR_ATmega32U6__))\r
-                       #include "AT90USBXXX67/ADC.h"\r
+                       #include "AVRU4U6U7/ADC.h"\r
                #else\r
                        #error "ADC is not available for the currently selected AVR model."\r
                #endif\r
                #else\r
                        #error "ADC is not available for the currently selected AVR model."\r
                #endif\r
-\r
-       /* Public Interface - May be used in end-application: */\r
-               /* Inline Functions: */\r
-                       /** Starts the reading of the given channel, but does not wait until the conversion has completed.\r
-                        *  Once executed, the conversion status can be determined via the ADC_IsReadingComplete() macro and\r
-                        *  the result read via the ADC_GetResult() macro.\r
-                        *\r
-                        *  \param MUXMask  Mask comprising of an ADC channel number, reference mask and adjustment mask\r
-                        */\r
-                       static inline void ADC_StartReading(const uint8_t MUXMask);\r
-\r
-                       /** Performs a complete single reading from channel, including a polling spinloop to wait for the\r
-                        *  conversion to complete, and the returning of the converted value.\r
-                        *\r
-                        *  \param MUXMask  Mask comprising of an ADC channel number, reference mask and adjustment mask\r
-                        */\r
-                       static inline uint16_t ADC_GetChannelReading(const uint8_t MUXMask) ATTR_WARN_UNUSED_RESULT;\r
-\r
-                       /** Configures the given ADC channel, ready for ADC conversions. This function sets the\r
-                        *  associated port pin as an input and disables the digital portion of the I/O to reduce\r
-                        *  power consumption.\r
-                        *\r
-                        *  \param Channel  ADC channel number to set up for conversions\r
-                        */\r
-                       static inline void ADC_SetupChannel(const uint8_t Channel);\r
                        \r
 #endif\r
                        \r
 #endif\r