Add new ARCH option to the makefiles to (eventually) specify the target device architecture. Update non-usb peripheral drivers to reflect future multiple architecture support.

4 files changed, 158 insertions, 62 deletions

diff --git a/LUFA/Common/Architectures.h b/LUFA/Common/Architectures.h
new file mode 100644
index 000000000..8bf9c7cac
--- /dev/null
+++ b/LUFA/Common/Architectures.h
@@ -0,0 +1,74 @@
+/*

+             LUFA Library

+     Copyright (C) Dean Camera, 2011.

+

+  dean [at] fourwalledcubicle [dot] com

+           www.lufa-lib.org

+*/

+

+/*

+  Copyright 2011  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 disclaim 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 Supported architecture defines.

+ *

+ *  This file contains constants which can be passed to the compiler (via setting the macro ARCH) in the

+ *  user project makefile using the -D option to configure the library drivers.

+ *

+ *  \note Do not include this file directly, rather include the Common.h header file instead to gain this file's

+ *        functionality.

+ */

+

+/** \ingroup Group_Common

+ *  \defgroup Group_Architectures Hardware Architectures

+ *

+ *  Macros for indicating the chosen hardware architecture to the library. These macros should be used when

+ *  defining the ARCH token to the chosen hardware via the -D switch in the project makefile.

+ *

+ *  @{

+ */

+

+#ifndef __LUFA_ARCHITECTURES_H__

+#define __LUFA_ARCHITECTURES_H__

+

+	/* Preprocessor Checks: */

+		#if !defined(__INCLUDE_FROM_COMMON_H)

+			#error Do not include this file directly. Include LUFA/Common/Common.h instead to gain this functionality.

+		#endif

+

+	/* Public Interface - May be used in end-application: */

+		/* Macros: */

+			/** Selects the Atmel 8-bit AVR (AT90USB* and ATMEGA*U* chips) architecture. */

+			#define ARCH_AVR8           1

+

+			#if !defined(__DOXYGEN__)

+				#define ARCH_           ARCH_AVR8

+

+				#if !defined(ARCH)

+					#define ARCH        ARCH_AVR8

+				#endif

+			#endif

+

+#endif

+

+/** @} */

+

diff --git a/LUFA/Common/Attributes.h b/LUFA/Common/Attributes.h
index 67a3166b2..ff4058cf1 100644
--- a/LUFA/Common/Attributes.h
+++ b/LUFA/Common/Attributes.h
@@ -44,7 +44,7 @@
  */
 
 /** \ingroup Group_Common
- *  @defgroup Group_GCCAttr Function/Variable Attributes
+ *  \defgroup Group_GCCAttr Function/Variable Attributes
  *
  *  Macros for easy access GCC function and variable attributes, which can be applied to function prototypes or
  *  variable attributes.
@@ -52,11 +52,11 @@
  *  @{
  */
 
-#ifndef __FUNCATTR_H__
-#define __FUNCATTR_H__
+#ifndef __LUFA_FUNCATTR_H__
+#define __LUFA_FUNCATTR_H__
 
 	/* Preprocessor Checks: */
-		#if !defined(__COMMON_H__)
+		#if !defined(__INCLUDE_FROM_COMMON_H)
 			#error Do not include this file directly. Include LUFA/Common/Common.h instead to gain this functionality.
 		#endif
 
diff --git a/LUFA/Common/BoardTypes.h b/LUFA/Common/BoardTypes.h
index 264908fe2..7d9162262 100644
--- a/LUFA/Common/BoardTypes.h
+++ b/LUFA/Common/BoardTypes.h
@@ -39,7 +39,7 @@
  */
 
 /** \ingroup Group_Common
- *  @defgroup Group_BoardTypes Board Types
+ *  \defgroup Group_BoardTypes Board Types
  *
  *  Macros for indicating the chosen physical board hardware to the library. These macros should be used when
  *  defining the BOARD token to the chosen hardware via the -D switch in the project makefile.
@@ -47,11 +47,11 @@
  *  @{
  */
 
-#ifndef __BOARDTYPES_H__
-#define __BOARDTYPES_H__
+#ifndef __LUFA_BOARDTYPES_H__
+#define __LUFA_BOARDTYPES_H__
 
 	/* Preprocessor Checks: */
-		#if !defined(__COMMON_H__)
+		#if !defined(__INCLUDE_FROM_COMMON_H)
 			#error Do not include this file directly. Include LUFA/Common/Common.h instead to gain this functionality.
 		#endif
 
diff --git a/LUFA/Common/Common.h b/LUFA/Common/Common.h
index c1aa27a5f..3afb60d00 100644
--- a/LUFA/Common/Common.h
+++ b/LUFA/Common/Common.h
@@ -35,7 +35,7 @@
  *  also includes other common code headers.
  */
 
-/** @defgroup Group_Common Common Utility Headers - LUFA/Drivers/Common/Common.h
+/** \defgroup Group_Common Common Utility Headers - LUFA/Drivers/Common/Common.h
  *
  *  Common utility headers containing macros, functions, enums and types which are common to all
  *  aspects of the library.
@@ -43,25 +43,41 @@
  *  @{
  */
 
-/** @defgroup Group_Debugging Debugging Macros
+/** \defgroup Group_Debugging Debugging Macros
  *
  *  Macros for debugging use.
  */
 
-/** @defgroup Group_BitManip Endian and Bit Macros
+/** \defgroup Group_BitManip Endian and Bit Macros
  *
  *  Functions for swapping endianness and reversing bit orders.
  */
 
-#ifndef __COMMON_H__
-#define __COMMON_H__
+#ifndef __LUFA_COMMON_H__
+#define __LUFA_COMMON_H__
 
+	/* Macros: */
+		#if !defined(__DOXYGEN__)
+			#define __INCLUDE_FROM_COMMON_H
+		#endif
+		
 	/* Includes: */
 		#include <stdint.h>
 		#include <stdbool.h>
 
+		#include "Architectures.h"
 		#include "Attributes.h"
 		#include "BoardTypes.h"
+		
+	/* Architecture specific utility includes: */
+		#if (ARCH == ARCH_AVR8)
+			#include <avr/io.h>
+			#include <avr/interrupt.h>
+			#include <avr/pgmspace.h>
+			#include <avr/eeprom.h>
+			#include <util/atomic.h>
+			#include <util/delay.h>
+		#endif
 
 	/* Public Interface - May be used in end-application: */
 		/* Macros: */
@@ -89,7 +105,9 @@
 			 *
 			 *  \return The larger of the two input parameters
 			 */
-			#define MAX(x, y)               ((x > y) ? x : y)
+			#if !defined(MAX) || defined(__DOXYGEN__)
+				#define MAX(x, y)               ((x > y) ? x : y)
+			#endif
 
 			/** Convenience macro to determine the smaller of two values.
 			 *
@@ -101,44 +119,61 @@
 			 *
 			 *  \return The smaller of the two input parameters
 			 */
-			#define MIN(x, y)               ((x < y) ? x : y)
-
-			/** Defines a volatile \c NOP statement which cannot be optimized out by the compiler, and thus can always
-			 *  be set as a breakpoint in the resulting code. Useful for debugging purposes, where the optimiser
-			 *  removes/reorders code to the point where break points cannot reliably be set.
-			 *
-			 *  \ingroup Group_Debugging
-			 */
-			#define JTAG_DEBUG_POINT()      __asm__ __volatile__ ("NOP" ::)
+			#if !defined(MIN) || defined(__DOXYGEN__)
+				#define MIN(x, y)               ((x < y) ? x : y)
+			#endif
 
-			/** Defines an explicit JTAG break point in the resulting binary via the assembly \c BREAK statement. When
-			 *  a JTAG is used, this causes the program execution to halt when reached until manually resumed.
-			 *
-			 *  \ingroup Group_Debugging
-			 */
-			#define JTAG_DEBUG_BREAK()      __asm__ __volatile__ ("BREAK" ::)
+			#if (ARCH == ARCH_AVR8)
+				/** Defines a volatile \c NOP statement which cannot be optimized out by the compiler, and thus can always
+				 *  be set as a breakpoint in the resulting code. Useful for debugging purposes, where the optimiser
+				 *  removes/reorders code to the point where break points cannot reliably be set.
+				 *
+				 *  \ingroup Group_Debugging
+				 */
+				#define JTAG_DEBUG_POINT()      __asm__ __volatile__ ("NOP" ::)
 
-			/** Macro for testing condition "x" and breaking via \ref JTAG_DEBUG_BREAK() if the condition is false.
-			 *
-			 *  \param[in] Condition  Condition that will be evaluated,
-			 *
-			 *  \ingroup Group_Debugging
-			*/
-			#define JTAG_DEBUG_ASSERT(Condition)    MACROS{ if (!(Condition)) { JTAG_DEBUG_BREAK(); } }MACROE
+				/** Defines an explicit JTAG break point in the resulting binary via the assembly \c BREAK statement. When
+				 *  a JTAG is used, this causes the program execution to halt when reached until manually resumed.
+				 *
+				 *  \ingroup Group_Debugging
+				 */
+				#define JTAG_DEBUG_BREAK()      __asm__ __volatile__ ("BREAK" ::)
+
+				#if !defined(pgm_read_ptr) || defined(__DOXYGEN__)
+					/** Reads a pointer out of PROGMEM space. This is currently a wrapper for the avr-libc \c pgm_read_ptr()
+					 *  macro with a \c void* cast, so that its value can be assigned directly to a pointer variable or used
+					 *  in pointer arithmetic without further casting in C. In a future avr-libc distribution this will be
+					 *  part of the standard API and will be implemented in a more formal manner.
+					 *
+					 *  \param[in] Addr  Address of the pointer to read.
+					 *
+					 *  \return Pointer retrieved from PROGMEM space.
+					 */
+					#define pgm_read_ptr(Addr)    (void*)pgm_read_word(Addr)
+				#endif
+
+				/** Macro for testing condition "x" and breaking via \ref JTAG_DEBUG_BREAK() if the condition is false.
+				 *
+				 *  \param[in] Condition  Condition that will be evaluated,
+				 *
+				 *  \ingroup Group_Debugging
+				*/
+				#define JTAG_DEBUG_ASSERT(Condition)    MACROS{ if (!(Condition)) { JTAG_DEBUG_BREAK(); } }MACROE
 
-			/** Macro for testing condition "x" and writing debug data to the stdout stream if \c false. The stdout stream
-			 *  must be pre-initialized before this macro is run and linked to an output device, such as the AVR's USART
-			 *  peripheral.
-			 *
-			 *  The output takes the form "{FILENAME}: Function {FUNCTION NAME}, Line {LINE NUMBER}: Assertion {Condition} failed."
-			 *
-			 *  \param[in] Condition  Condition that will be evaluated,
-			 *
-			 *  \ingroup Group_Debugging
-			 */
-			#define STDOUT_ASSERT(Condition)        MACROS{ if (!(x)) { printf_P(PSTR("%s: Function \"%s\", Line %d: "   \
-			                                                "Assertion \"%s\" failed.\r\n"),     \
-			                                                __FILE__, __func__, __LINE__, #Condition); } }MACROE
+				/** Macro for testing condition "x" and writing debug data to the stdout stream if \c false. The stdout stream
+				 *  must be pre-initialized before this macro is run and linked to an output device, such as the AVR's USART
+				 *  peripheral.
+				 *
+				 *  The output takes the form "{FILENAME}: Function {FUNCTION NAME}, Line {LINE NUMBER}: Assertion {Condition} failed."
+				 *
+				 *  \param[in] Condition  Condition that will be evaluated,
+				 *
+				 *  \ingroup Group_Debugging
+				 */
+				#define STDOUT_ASSERT(Condition)        MACROS{ if (!(x)) { printf_P(PSTR("%s: Function \"%s\", Line %d: "   \
+				                                                "Assertion \"%s\" failed.\r\n"),     \
+				                                                __FILE__, __func__, __LINE__, #Condition); } }MACROE
+			#endif
 			
 			/** Forces GCC to use pointer indirection (via the AVR's pointer register pairs) when accessing the given
 			 *  struct pointer. In some cases GCC will emit non-optimal assembly code when accessing a structure through
@@ -150,19 +185,6 @@
 			 */
 			#define GCC_FORCE_POINTER_ACCESS(StructPtr) __asm__ __volatile__("" : "=b" (StructPtr) : "0" (StructPtr))
 
-			#if !defined(pgm_read_ptr) || defined(__DOXYGEN__)
-				/** Reads a pointer out of PROGMEM space. This is currently a wrapper for the avr-libc \c pgm_read_ptr()
-				 *  macro with a \c void* cast, so that its value can be assigned directly to a pointer variable or used
-				 *  in pointer arithmetic without further casting in C. In a future avr-libc distribution this will be
-				 *  part of the standard API and will be implemented in a more formal manner.
-				 *
-				 *  \param[in] Addr  Address of the pointer to read.
-				 *
-				 *  \return Pointer retrieved from PROGMEM space.
-				 */
-				#define pgm_read_ptr(Addr)    (void*)pgm_read_word(Addr)
-			#endif
-
 			/** Swaps the byte ordering of a 16-bit value at compile time. Do not use this macro for swapping byte orderings
 			 *  of dynamic values computed at runtime, use \ref SwapEndian_16() instead. The result of this macro can be used
 			 *  inside struct or other variable initializers outside of a function, something that is not possible with the