-/*\r
- LUFA Library\r
- Copyright (C) Dean Camera, 2009.\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
-\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
- software without specific, written prior permission.\r
-\r
- The author disclaim all warranties with regard to this\r
- software, including all implied warranties of merchantability\r
- and fitness. In no event shall the author be liable for any\r
- special, indirect or consequential damages or any damages\r
- whatsoever resulting from loss of use, data or profits, whether\r
- in an action of contract, negligence or other tortious action,\r
- arising out of or in connection with the use or performance of\r
- this software.\r
-*/\r
-\r
-/** \file\r
- *\r
- * This file is the master dispatch header file for the device-specific ADC driver, for AVRs containing an ADC.\r
- *\r
- * User code should include this file, which will in turn include the correct ADC driver header file for the\r
- * currently selected AVR model.\r
- */\r
-\r
-/** \ingroup Group_SubsystemDrivers\r
- * @defgroup Group_ADC ADC Driver - LUFA/Drivers/Peripheral/ADC.h\r
- */\r
- \r
-#ifndef __ADC_H__\r
-#define __ADC_H__\r
-\r
- /* Macros: */\r
- #if !defined(__DOXYGEN__)\r
- #define INCLUDE_FROM_ADC_H\r
- #define INCLUDE_FROM_CHIP_DRIVER\r
- #endif\r
-\r
- /* Includes: */\r
- #if (defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB646__) || \\r
- defined(__AVR_AT90USB1287__) || defined(__AVR_AT90USB647__) || \\r
- defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__) || \\r
- defined(__AVR_ATmega32U6__))\r
- #include "AT90USBXXX67/ADC.h"\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
+/*
+ LUFA Library
+ Copyright (C) Dean Camera, 2021.
+
+ dean [at] fourwalledcubicle [dot] com
+ www.lufa-lib.org
+*/
+
+/*
+ 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
+ without fee, provided that the above copyright notice appear in
+ 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
+ software without specific, written prior permission.
+
+ 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
+ whatsoever resulting from loss of use, data or profits, whether
+ in an action of contract, negligence or other tortious action,
+ arising out of or in connection with the use or performance of
+ this software.
+*/
+
+/** \file
+ * \brief Hardware Analogue-to-Digital converter driver.
+ *
+ * This file is the master dispatch header file for the device-specific ADC driver, for microcontrollers
+ * containing an ADC.
+ *
+ * User code should include this file, which will in turn include the correct ADC driver header file for the
+ * currently selected architecture and microcontroller model.
+ */
+
+/** \ingroup Group_PeripheralDrivers
+ * \defgroup Group_ADC ADC Driver - LUFA/Drivers/Peripheral/ADC.h
+ * \brief Hardware Analogue-to-Digital converter driver.
+ *
+ * \section Sec_ADC_Dependencies Module Source Dependencies
+ * The following files must be built with any user project that uses this module:
+ * - None
+ *
+ * \section Sec_ADC_ModDescription Module Description
+ * Hardware ADC driver. This module provides an easy to use driver for the hardware ADC
+ * present on many microcontrollers, for the conversion of analogue signals into the
+ * digital domain.
+ *
+ * \note The exact API for this driver may vary depending on the target used - see
+ * individual target module documentation for the API specific to your target processor.
+ */
+
+#ifndef __ADC_H__
+#define __ADC_H__
+
+ /* Macros: */
+ #define __INCLUDE_FROM_ADC_H
+
+ /* Includes: */
+ #include "../../Common/Common.h"
+
+ /* Includes: */
+ #if (ARCH == ARCH_AVR8)
+ #include "AVR8/ADC_AVR8.h"
+ #else
+ #error The ADC peripheral driver is not currently available for your selected architecture.
+ #endif
+
+#endif
+
projects / pub / lufa.git / blobdiff