+/*\r
+ LUFA Library\r
+ Copyright (C) Dean Camera, 2010.\r
+ \r
+ dean [at] fourwalledcubicle [dot] com\r
+ www.fourwalledcubicle.com\r
+*/\r
+\r
+/*\r
+ Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\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, 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
+ * ADC driver for the 8-Bit AVRs containing a hardware ADC module.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the ADC driver\r
+ * dispatch header located in LUFA/Drivers/Peripheral/ADC.h.\r
+ */\r
+\r
+/** \ingroup Group_ADC\r
+ * @defgroup Group_ADC_AVR8 8-Bit AVR ADC Driver\r
+ *\r
+ * ADC driver for 8-Bit AVRs containing a hardware ADC module.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the ADC driver\r
+ * dispatch header located in LUFA/Drivers/Peripheral/ADC.h.\r
+ *\r
+ * @{\r
+ */\r
+ \r
+#ifndef __ADC_AVR8_H__\r
+#define __ADC_AVR8_H__\r
+\r
+ /* Includes: */\r
+ #include "../../../Common/Common.h"\r
+ \r
+ #include <avr/io.h>\r
+ #include <stdbool.h>\r
+ \r
+ /* Enable C linkage for C++ Compilers: */\r
+ #if defined(__cplusplus)\r
+ extern "C" {\r
+ #endif\r
+\r
+ /* Preprocessor Checks: */\r
+ #if !defined(__INCLUDE_FROM_ADC_H)\r
+ #error Do not include this file directly. Include LUFA/Drivers/Peripheral/ADC.h instead.\r
+ #endif\r
+\r
+ /* Public Interface - May be used in end-application: */\r
+ /* Macros: */ \r
+ /** Reference mask, for using the voltage present at the AVR's AREF pin for the ADC reference. */\r
+ #define ADC_REFERENCE_AREF 0\r
+\r
+ /** Reference mask, for using the voltage present at the AVR's AVCC pin for the ADC reference. */\r
+ #define ADC_REFERENCE_AVCC (1 << REFS0)\r
+\r
+ /** Reference mask, for using the internally generated 2.56V reference voltage as the ADC reference. */\r
+ #define ADC_REFERENCE_INT2560MV ((1 << REFS1)| (1 << REFS0))\r
+ \r
+ /** Left-adjusts the 10-bit ADC result, so that the upper 8 bits of the value returned by the\r
+ * ADC_GetResult() macro contain the 8 most significant bits of the result. */\r
+ #define ADC_LEFT_ADJUSTED (1 << ADLAR)\r
+\r
+ /** Right-adjusts the 10-bit ADC result, so that the lower 8 bits of the value returned by the\r
+ * ADC_GetResult() macro contain the 8 least significant bits of the result. */\r
+ #define ADC_RIGHT_ADJUSTED (0 << ADLAR)\r
+ \r
+ /** Sets the ADC mode to free running, so that conversions take place continuously as fast as the ADC\r
+ * is capable of at the given input clock speed. */\r
+ #define ADC_FREE_RUNNING (1 << ADATE)\r
+\r
+ /** Sets the ADC mode to single conversion, so that only a single conversion will take place before\r
+ * the ADC returns to idle. */\r
+ #define ADC_SINGLE_CONVERSION (0 << ADATE)\r
+ \r
+ /** Sets the ADC input clock to prescale by a factor of 2 the AVR's system clock. */\r
+ #define ADC_PRESCALE_2 (1 << ADPS0)\r
+\r
+ /** Sets the ADC input clock to prescale by a factor of 4 the AVR's system clock. */\r
+ #define ADC_PRESCALE_4 (1 << ADPS1)\r
+\r
+ /** Sets the ADC input clock to prescale by a factor of 8 the AVR's system clock. */\r
+ #define ADC_PRESCALE_8 ((1 << ADPS0) | (1 << ADPS1))\r
+\r
+ /** Sets the ADC input clock to prescale by a factor of 16 the AVR's system clock. */\r
+ #define ADC_PRESCALE_16 (1 << ADPS2)\r
+\r
+ /** Sets the ADC input clock to prescale by a factor of 32 the AVR's system clock. */\r
+ #define ADC_PRESCALE_32 ((1 << ADPS2) | (1 << ADPS0))\r
+\r
+ /** Sets the ADC input clock to prescale by a factor of 64 the AVR's system clock. */\r
+ #define ADC_PRESCALE_64 ((1 << ADPS2) | (1 << ADPS1))\r
+\r
+ /** Sets the ADC input clock to prescale by a factor of 128 the AVR's system clock. */\r
+ #define ADC_PRESCALE_128 ((1 << ADPS2) | (1 << ADPS1) | (1 << ADPS0))\r
+ \r
+ //@{\r
+ /** MUX mask define for the ADC0 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading. */\r
+ #define ADC_CHANNEL0 0x00\r
+\r
+ /** MUX mask define for the ADC1 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading. */\r
+ #define ADC_CHANNEL1 0x01\r
+\r
+ #if !(defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__) || defined(__DOXYGEN__))\r
+ /** MUX mask define for the ADC2 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading.\r
+ *\r
+ * \note Note available on all AVR models.\r
+ */\r
+ #define ADC_CHANNEL2 0x02\r
+\r
+ /** MUX mask define for the ADC3 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading.\r
+ *\r
+ * \note Note available on all AVR models.\r
+ */\r
+ #define ADC_CHANNEL3 0x03\r
+ #endif\r
+\r
+ /** MUX mask define for the ADC4 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading. */\r
+ #define ADC_CHANNEL4 0x04\r
+\r
+ /** MUX mask define for the ADC5 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading. */\r
+ #define ADC_CHANNEL5 0x05\r
+\r
+ /** MUX mask define for the ADC6 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading. */\r
+ #define ADC_CHANNEL6 0x06\r
+\r
+ /** MUX mask define for the ADC7 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading. */\r
+ #define ADC_CHANNEL7 0x07\r
+\r
+ /** MUX mask define for the internal 1.1V bandgap channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading. */\r
+ #define ADC_1100MV_BANDGAP 0x1E\r
+ \r
+ #if (defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__) || defined(__DOXYGEN__))\r
+ /** MUX mask define for the ADC8 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading.\r
+ *\r
+ * \note Note available on all AVR models.\r
+ */\r
+ #define ADC_CHANNEL8 0x20\r
+\r
+ /** MUX mask define for the ADC9 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading.\r
+ *\r
+ * \note Note available on all AVR models.\r
+ */\r
+ #define ADC_CHANNEL9 0x21\r
+\r
+ /** MUX mask define for the ADC10 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading.\r
+ *\r
+ * \note Note available on all AVR models.\r
+ */\r
+ #define ADC_CHANNEL10 0x22\r
+\r
+ /** MUX mask define for the ADC11 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading.\r
+ *\r
+ * \note Note available on all AVR models.\r
+ */\r
+ #define ADC_CHANNEL11 0x23\r
+\r
+ /** MUX mask define for the ADC12 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading.\r
+ *\r
+ * \note Note available on all AVR models.\r
+ */\r
+ #define ADC_CHANNEL12 0x24\r
+\r
+ /** MUX mask define for the ADC13 channel of the ADC. See \ref ADC_StartReading and \ref ADC_GetChannelReading.\r
+ *\r
+ * \note Note available on all AVR models.\r
+ */\r
+ #define ADC_CHANNEL13 0x25\r
+\r
+ /** MUX mask define for the internal temperature sensor channel of the ADC. See \ref ADC_StartReading and\r
+ * \ref ADC_GetChannelReading.\r
+ *\r
+ * \note Note available on all AVR models.\r
+ */\r
+ #define ADC_INT_TEMP_SENS 0x27 \r
+ #endif\r
+ //@}\r
+ \r
+ /* Pseudo-Function Macros: */\r
+ #if defined(__DOXYGEN__)\r
+ /** Initializes the ADC, ready for conversions. This must be called before any other ADC operations.\r
+ * The "mode" parameter should be a mask comprised of a conversion mode (free running or single) and\r
+ * prescaler masks.\r
+ *\r
+ * \param[in] Mode Mask of ADC settings, including adjustment, prescale, mode and reference\r
+ */\r
+ static inline void ADC_Init(uint8_t Mode);\r
+\r
+ /** Turns off the ADC. If this is called, any further ADC operations will require a call to\r
+ * \ref ADC_Init() before the ADC can be used again.\r
+ */\r
+ static inline void ADC_ShutDown(void);\r
+ \r
+ /** Indicates if the ADC is currently enabled.\r
+ *\r
+ * \return Boolean true if the ADC subsystem is currently enabled, false otherwise.\r
+ */\r
+ static inline bool ADC_GetStatus(void);\r
+ \r
+ /** Indicates if the current ADC conversion is completed, or still in progress.\r
+ *\r
+ * \return Boolean false if the reading is still taking place, or true if the conversion is\r
+ * complete and ready to be read out with \ref ADC_GetResult()\r
+ */\r
+ static inline bool ADC_IsReadingComplete(void);\r
+ \r
+ /** Retrieves the conversion value of the last completed ADC conversion.\r
+ *\r
+ * \return The result of the last ADC conversion\r
+ */\r
+ static inline uint16_t ADC_GetResult(void);\r
+ #else\r
+ #define ADC_Init(mode) MACROS{ ADCSRA = ((1 << ADEN) | mode); }MACROE\r
+\r
+ #define ADC_ShutDown() MACROS{ ADCSRA = 0; }MACROE\r
+ \r
+ #define ADC_GetStatus() ((ADCSRA & (1 << ADEN)) ? true : false)\r
+\r
+ #define ADC_IsReadingComplete() (ADCSRA & (1 << ADSC))\r
+ \r
+ #define ADC_GetResult() ADC \r
+ #endif\r
+ \r
+ /* Inline Functions: */\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
+ * \note This must only be called for ADC channels with are connected to a physical port\r
+ * pin of the AVR, denoted by its special alternative function ADCx.\r
+ *\r
+ * \note The channel number must be specified as an integer, and NOT a ADC_CHANNELx mask.\r
+ *\r
+ * \param[in] Channel ADC channel number to set up for conversions\r
+ */\r
+ static inline void ADC_SetupChannel(const uint8_t Channel)\r
+ {\r
+ #if (defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB646__) || \\r
+ defined(__AVR_AT90USB1287__) || defined(__AVR_AT90USB647__) || \\r
+ defined(__AVR_ATmega32U6__)) \r
+ DDRF &= ~(1 << Channel);\r
+ DIDR0 |= (1 << Channel);\r
+ #elif (defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__))\r
+ if (Channel < 8)\r
+ {\r
+ DDRF &= ~(1 << Channel);\r
+ DIDR0 |= (1 << Channel);\r
+ }\r
+ else if (Channel == 8)\r
+ {\r
+ DDRD &= ~(1 << 4);\r
+ DIDR2 |= (1 << 0);\r
+ }\r
+ else if (Channel < 11)\r
+ {\r
+ DDRD &= ~(1 << (Channel - 3));\r
+ DIDR2 |= (1 << (Channel - 8));\r
+ }\r
+ else\r
+ {\r
+ DDRB &= ~(1 << (Channel - 7));\r
+ DIDR2 |= (1 << (Channel - 8));\r
+ }\r
+ #endif\r
+ }\r
+ \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 \ref ADC_IsReadingComplete() macro and\r
+ * the result read via the \ref ADC_GetResult() macro.\r
+ *\r
+ * \param[in] MUXMask Mask comprising of an ADC channel mask, reference mask and adjustment mask\r
+ */\r
+ static inline void ADC_StartReading(const uint8_t MUXMask)\r
+ {\r
+ ADMUX = MUXMask;\r
+ \r
+ ADCSRA |= (1 << ADSC);\r
+ }\r
+\r
+ /** Performs a complete single reading from channel, including a polling spin-loop to wait for the\r
+ * conversion to complete, and the returning of the converted value.\r
+ *\r
+ * \param[in] MUXMask Mask comprising of an ADC channel mask, reference mask and adjustment mask\r
+ */\r
+ static inline uint16_t ADC_GetChannelReading(const uint8_t MUXMask) ATTR_WARN_UNUSED_RESULT;\r
+ static inline uint16_t ADC_GetChannelReading(const uint8_t MUXMask)\r
+ {\r
+ ADC_StartReading(MUXMask);\r
+ \r
+ while (!(ADC_IsReadingComplete()));\r
+ \r
+ return ADC_GetResult();\r
+ }\r
+\r
+ /* Disable C linkage for C++ Compilers: */\r
+ #if defined(__cplusplus)\r
+ }\r
+ #endif\r
+ \r
+#endif\r
+\r
+/** @} */\r
projects / pub / USBasp.git / commitdiff