From 32830a2b827cbeb40284c5ea379381948fb9113e Mon Sep 17 00:00:00 2001
From: Dean Camera <dean@fourwalledcubicle.com>
Date: Sun, 16 Jan 2011 16:13:22 +0000
Subject: Added new ADC_GET_CHANNEL_MASK() convenience macro to the ADC driver.

---
 LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h | 16 ++++++++++++++++
 LUFA/Drivers/USB/LowLevel/Endpoint.h    | 10 ++++++++--
 LUFA/ManPages/ChangeLog.txt             |  1 +
 3 files changed, 25 insertions(+), 2 deletions(-)

(limited to 'LUFA')

diff --git a/LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h b/LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h
index 9d6e91bc8..5f4b034ef 100644
--- a/LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h
+++ b/LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h
@@ -90,6 +90,13 @@
 			#error Do not include this file directly. Include LUFA/Drivers/Peripheral/ADC.h instead.
 		#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 */
@@ -235,6 +242,15 @@
 				 */
 				#define ADC_INT_TEMP_SENS           ((1 << 8) | (0x07 << MUX0))
 			#endif
+
+			/** 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.
+			 *
+			 *  \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)
 			//@}
 
 		/* Inline Functions: */
diff --git a/LUFA/Drivers/USB/LowLevel/Endpoint.h b/LUFA/Drivers/USB/LowLevel/Endpoint.h
index 24c61a69a..9ce1380b4 100644
--- a/LUFA/Drivers/USB/LowLevel/Endpoint.h
+++ b/LUFA/Drivers/USB/LowLevel/Endpoint.h
@@ -203,13 +203,19 @@
 			 */
 			#define ENDPOINT_EPSIZE_MASK                    0x7F
 
-			/** Maximum size in bytes of a given endpoint.
+			/** Retrives the maximum bank size in bytes of a given endpoint.
+			 *
+			 *  \note This macro will only work correctly on endpoint indexes that are compile-time constants
+			 *        defined by the preprocessor.
 			 *
 			 *  \param[in] EPIndex  Endpoint number, a value between 0 and (\ref ENDPOINT_TOTAL_ENDPOINTS - 1)
 			 */
 			#define ENDPOINT_MAX_SIZE(EPIndex)              _ENDPOINT_GET_MAXSIZE(EPIndex)
 
-			/** Indicates the total number of banks supported by the given endpoint.
+			/** Retrieves the total number of banks supported by the given endpoint.
+			 *
+			 *  \note This macro will only work correctly on endpoint indexes that are compile-time constants
+			 *        defined by the preprocessor.
 			 *
 			 *  \param[in] EPIndex  Endpoint number, a value between 0 and (\ref ENDPOINT_TOTAL_ENDPOINTS - 1)
 			 */
diff --git a/LUFA/ManPages/ChangeLog.txt b/LUFA/ManPages/ChangeLog.txt
index edf354c55..26b3a9a38 100644
--- a/LUFA/ManPages/ChangeLog.txt
+++ b/LUFA/ManPages/ChangeLog.txt
@@ -16,6 +16,7 @@
   *   - Added new GCC_FORCE_POINTER_ACCESS() macro to correct GCC's mishandling of struct pointer accesses
   *   - Added basic driver example use code to the library documentation
   *   - Added new Endpoint_Null_Stream() and Pipe_Null_stream() functions
+  *   - Added new ADC_GET_CHANNEL_MASK() convenience macro
   *  - Library Applications:
   *   - Added ability to write protect Mass Storage disk write operations from the host OS
   *
-- 
cgit v1.2.3