Add support for the Atmel UC3-A3 Xplained board.

8 files changed, 310 insertions, 7 deletions

diff --git a/LUFA/Common/BoardTypes.h b/LUFA/Common/BoardTypes.h
index 378dd7f0c..0ac68321a 100644
--- a/LUFA/Common/BoardTypes.h
+++ b/LUFA/Common/BoardTypes.h
@@ -219,6 +219,9 @@
 			/** Selects the Arduino Leonardo specific board drivers, including the driver for the board LEDs. */
 			#define BOARD_LEONARDO             51
 			
+			/** Selects the UC3-A3 Xplained specific board drivers, including the Button and LED drivers. */
+			#define BOARD_UC3A3_XPLAINED       52
+			
 			#if !defined(__DOXYGEN__)
 				#define BOARD_                 BOARD_NONE
 
diff --git a/LUFA/DoxygenPages/ChangeLog.txt b/LUFA/DoxygenPages/ChangeLog.txt
index 791b1a31e..0b351550e 100644
--- a/LUFA/DoxygenPages/ChangeLog.txt
+++ b/LUFA/DoxygenPages/ChangeLog.txt
@@ -10,6 +10,7 @@
   *  <b>New:</b>
   *  - Core:
   *   - Added support for the Arduino Leonardo board
+  *   - Added support for the Atmel UC3-A3 Xplained board
   *   - Added new doxygen_upgrade and doxygen_create targets to the DOXYGEN build system module
   *  - Library Applications:
   *   - Added a different device serial number when the AVRISP-MKII Clone project is in libUSB compatibility mode, so that
diff --git a/LUFA/DoxygenPages/DeviceSupport.txt b/LUFA/DoxygenPages/DeviceSupport.txt
index 6ba66ae58..517071081 100644
--- a/LUFA/DoxygenPages/DeviceSupport.txt
+++ b/LUFA/DoxygenPages/DeviceSupport.txt
@@ -290,6 +290,7 @@
  *   - EVK1100
  *   - EVK1101
  *   - EVK1104
+ *   - UC3-A3 Xplained
  *
  *  \section Sec_UC3Support_ThirdParty Supported Third Party Models
  *
diff --git a/LUFA/Drivers/Board/Buttons.h b/LUFA/Drivers/Board/Buttons.h
index b3c915fc6..0fe7a1087 100644
--- a/LUFA/Drivers/Board/Buttons.h
+++ b/LUFA/Drivers/Board/Buttons.h
@@ -144,11 +144,13 @@
 		#elif (BOARD == BOARD_B1_XPLAINED)
 			#include "XMEGA/B1_XPLAINED/Buttons.h"
 		#elif (BOARD == BOARD_OLIMEX32U4)
-			#include "AVR8/OLIMEX32U4/Buttons.h"		
+			#include "AVR8/OLIMEX32U4/Buttons.h"
 		#elif (BOARD == BOARD_OLIMEXT32U4)
-			#include "AVR8/OLIMEXT32U4/Buttons.h"		
+			#include "AVR8/OLIMEXT32U4/Buttons.h"
 		#elif (BOARD == BOARD_OLIMEXISPMK2)
-			#include "AVR8/OLIMEXISPMK2/Buttons.h"	
+			#include "AVR8/OLIMEXISPMK2/Buttons.h"
+		#elif (BOARD == BOARD_UC3A3_XPLAINED)
+			#include "UC3/UC3A3_XPLAINED/Buttons.h"
 		#else
 			#include "Board/Buttons.h"
 		#endif
@@ -167,7 +169,7 @@
 
 		/** Returns a mask indicating which board buttons are currently pressed.
 		 *
-		 *  \return Mask indicating which board buttons are currently pressed.
+		 *  \return Mask of \c BUTTONS_BUTTON* constants indicating which board buttons are currently pressed.
 		 */
 		static inline uint_reg_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
 	#endif
diff --git a/LUFA/Drivers/Board/Joystick.h b/LUFA/Drivers/Board/Joystick.h
index 2f90a9ca3..cbe9b0fd8 100644
--- a/LUFA/Drivers/Board/Joystick.h
+++ b/LUFA/Drivers/Board/Joystick.h
@@ -123,6 +123,8 @@
 	#if defined(__DOXYGEN__)
 		/** Initializes the joystick driver so that the joystick position can be read. This sets the appropriate
 		 *  I/O pins to inputs with their pull-ups enabled.
+		 *
+		 *  This must be called before any Joystick driver functions are used.
 		 */
 		static inline void Joystick_Init(void);
 
@@ -132,8 +134,7 @@
 		/** Returns the current status of the joystick, as a mask indicating the direction the joystick is
 		 *  currently facing in (multiple bits can be set).
 		 *
-		 *  \return Mask indicating the joystick direction - see corresponding board specific Joystick.h file
-		 *          for direction masks.
+		 *  \return Mask of \c JOYSTICK_* constants indicating the current joystick direction(s).
 		 */
 		static inline uint_reg_t Joystick_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
 	#endif
diff --git a/LUFA/Drivers/Board/LEDs.h b/LUFA/Drivers/Board/LEDs.h
index 185985a51..03063d7ad 100644
--- a/LUFA/Drivers/Board/LEDs.h
+++ b/LUFA/Drivers/Board/LEDs.h
@@ -195,6 +195,8 @@
 			#include "AVR8/OLIMEXISPMK2/LEDs.h"
 		#elif (BOARD == BOARD_LEONARDO)
 			#include "AVR8/LEONARDO/LEDs.h"
+		#elif (BOARD == BOARD_UC3A3_XPLAINED)
+			#include "UC3/UC3A3_XPLAINED/LEDs.h"
 		#else
 			#include "Board/LEDs.h"
 		#endif
@@ -222,6 +224,8 @@
 	#if defined(__DOXYGEN__)
 		/** Initializes the board LED driver so that the LEDs can be controlled. This sets the appropriate port
 		 *  I/O pins as outputs, and sets the LEDs to default to off.
+		 *
+		 *  This must be called before any LED driver functions are used.
 		 */
 		static inline void LEDs_Init(void);
 
@@ -265,7 +269,7 @@
 		/** Returns the status of all the board LEDs; set LED masks in the return value indicate that the
 		 *  corresponding LED is on.
 		 *
-		 *  \return Mask of the board LEDs which are currently turned on.
+		 *  \return Mask of \c LEDS_LED* constants indicating which of the board LEDs are currently turned on.
 		 */
 		static inline uint_reg_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
 	#endif
diff --git a/LUFA/Drivers/Board/UC3/UC3A3_XPLAINED/Buttons.h b/LUFA/Drivers/Board/UC3/UC3A3_XPLAINED/Buttons.h
new file mode 100644
index 000000000..400402dcc
--- /dev/null
+++ b/LUFA/Drivers/Board/UC3/UC3A3_XPLAINED/Buttons.h
@@ -0,0 +1,109 @@
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2012.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+*/
+
+/*
+  Copyright 2012  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 Board specific Buttons driver header for the Atmel UC3-A3 Xplained.
+ *  \copydetails Group_Buttons_UC3A3_XPLAINED
+ *
+ *  \note This file should not be included directly. It is automatically included as needed by the Buttons driver
+ *        dispatch header located in LUFA/Drivers/Board/Buttons.h.
+ */
+
+/** \ingroup Group_Buttons
+ *  \defgroup Group_Buttons_UC3A3_XPLAINED UC3A3_XPLAINED
+ *  \brief Board specific Buttons driver header for the Atmel UC3-A3 Xplained.
+ *
+ *  Board specific Buttons driver header for the Atmel UC3-A3 Xplained.
+ *
+ *  <table>
+ *    <tr><th>Name</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr>
+ *    <tr><td>BUTTONS_BUTTON1</td><td>SW0 Button</td><td>Low</td><td>GPIO32</td></tr>
+ *  </table>
+ *
+ *  @{
+ */
+
+#ifndef __BUTTONS_UC3A3_XPLAINED_H__
+#define __BUTTONS_UC3A3_XPLAINED_H__
+
+	/* Includes: */
+		#include "../../../../Common/Common.h"
+
+	/* Enable C linkage for C++ Compilers: */
+		#if defined(__cplusplus)
+			extern "C" {
+		#endif
+
+	/* Preprocessor Checks: */
+		#if !defined(__INCLUDE_FROM_BUTTONS_H)
+			#error Do not include this file directly. Include LUFA/Drivers/Board/Buttons.h instead.
+		#endif
+
+	/* Private Interface - For use in library only: */
+	#if !defined(__DOXYGEN__)
+		/* Macros: */
+			#define BUTTONS_PORT          1
+	#endif
+
+	/* Public Interface - May be used in end-application: */
+		/* Macros: */
+			/** Mask of the first button on the board */
+			#define BUTTONS_BUTTON1       (1UL << 0)
+
+		/* Inline Functions: */
+		#if !defined(__DOXYGEN__)
+			static inline void Buttons_Init(void)
+			{
+				AVR32_GPIO.port[BUTTONS_PORT].gpers = (BUTTONS_BUTTON1 | BUTTONS_BUTTON2);
+				AVR32_GPIO.port[BUTTONS_PORT].puers = (BUTTONS_BUTTON1 | BUTTONS_BUTTON2);
+			}
+
+			static inline void Buttons_Disable(void)
+			{
+				AVR32_GPIO.port[BUTTONS_PORT].gperc = (BUTTONS_BUTTON1 | BUTTONS_BUTTON2);
+				AVR32_GPIO.port[BUTTONS_PORT].puerc = (BUTTONS_BUTTON1 | BUTTONS_BUTTON2);
+			}
+
+			static inline uint32_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
+			static inline uint32_t Buttons_GetStatus(void)
+			{
+				return (~(AVR32_GPIO.port[JOY_MOVE_PORT].pvr & (BUTTONS_BUTTON1 | BUTTONS_BUTTON2)));
+			}
+		#endif
+
+	/* Disable C linkage for C++ Compilers: */
+		#if defined(__cplusplus)
+			}
+		#endif
+
+#endif
+
+/** @} */
+
diff --git a/LUFA/Drivers/Board/UC3/UC3A3_XPLAINED/LEDs.h b/LUFA/Drivers/Board/UC3/UC3A3_XPLAINED/LEDs.h
new file mode 100644
index 000000000..5272c401c
--- /dev/null
+++ b/LUFA/Drivers/Board/UC3/UC3A3_XPLAINED/LEDs.h
@@ -0,0 +1,182 @@
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2012.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+*/
+
+/*
+  Copyright 2012  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 Board specific LED driver header for the Atmel UC3-A3 Xplained.
+ *  \copydetails Group_LEDs_UC3A3_XPLAINED
+ *
+ *  \note This file should not be included directly. It is automatically included as needed by the LEDs driver
+ *        dispatch header located in LUFA/Drivers/Board/LEDs.h.
+ */
+
+/** \ingroup Group_LEDs
+ *  \defgroup Group_LEDs_UC3A3_XPLAINED UC3A3_XPLAINED
+ *  \brief Board specific LED driver header for the Atmel UC3-A3 Xplained.
+ *
+ *  Board specific LED driver header for the Atmel UC3-A3 Xplained.
+ *
+ *  <table>
+ *    <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr>
+ *    <tr><td>LEDS_LED1</td><td>Yellow</td><td>LED0 LED</td><td>Low</td><td>GPIO35</td></tr>
+ *    <tr><td>LEDS_LED2</td><td>Yellow</td><td>LED1 LED</td><td>Low</td><td>GPIO73</td></tr>
+ *    <tr><td>LEDS_LED3</td><td>Yellow</td><td>LED2 LED</td><td>Low</td><td>GPIO34</td></tr>
+ *    <tr><td>LEDS_LED4</td><td>Yellow</td><td>LED3 LED</td><td>Low</td><td>GPIO38</td></tr>
+ *    <tr><td>LEDS_LED5</td><td>Green</td><td>Status</td><td>Low</td><td>GPIO50</td></tr>
+ *    <tr><td>LEDS_LED6</td><td>Red</td><td>Power</td><td>High</td><td>GPIO49</td></tr>
+ *  </table>
+ *
+ *  @{
+ */
+
+#ifndef __LEDS_UC3A3_XPLAINED_H__
+#define __LEDS_UC3A3_XPLAINED_H__
+
+	/* Includes: */
+		#include "../../../../Common/Common.h"
+
+	/* Enable C linkage for C++ Compilers: */
+		#if defined(__cplusplus)
+			extern "C" {
+		#endif
+
+	/* Preprocessor Checks: */
+		#if !defined(__INCLUDE_FROM_LEDS_H)
+			#error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead.
+		#endif
+
+	/* Private Interface - For use in library only: */
+	#if !defined(__DOXYGEN__)
+		/* Macros: */
+			#define LEDS_LEDMASK1   ((1UL << 3) | (1UL << 2) | (1UL << 6) | (1UL << 18) | (1UL << 17))
+			#define LEDS_LEDMASK3    (1UL << 9)
+	#endif
+
+	/* Public Interface - May be used in end-application: */
+		/* Macros: */
+			/** LED mask for the first LED on the board. */
+			#define LEDS_LED1        (1UL << 3)
+
+			/** LED mask for the second LED on the board. */
+			#define LEDS_LED2        (1UL << 9)
+
+			/** LED mask for the third LED on the board. */
+			#define LEDS_LED3        (1UL << 2)
+
+			/** LED mask for the fourth LED on the board. */
+			#define LEDS_LED4        (1UL << 6)
+
+			/** LED mask for the fifth LED on the board. */
+			#define LEDS_LED5        (1UL << 18)
+
+			/** LED mask for the sixth LED on the board. */
+			#define LEDS_LED6        (1UL << 17)
+
+			/** LED mask for all the LEDs on the board. */
+			#define LEDS_ALL_LEDS    (LEDS_LED1 | LEDS_LED2 | LEDS_LED3 | LEDS_LED4 | LEDS_LED5 | LEDS_LED6)
+
+			/** LED mask for the none of the board LEDs */
+			#define LEDS_NO_LEDS     0
+
+		/* Inline Functions: */
+		#if !defined(__DOXYGEN__)
+			static inline void LEDs_Init(void)
+			{
+				AVR32_GPIO.port[1].gpers = LEDS_LEDMASK1;
+				AVR32_GPIO.port[1].oders = LEDS_LEDMASK1;
+				AVR32_GPIO.port[1].ovrs  = LEDS_LEDMASK1;
+
+				AVR32_GPIO.port[3].gpers = LEDS_LEDMASK3;
+				AVR32_GPIO.port[3].oders = LEDS_LEDMASK3;
+				AVR32_GPIO.port[3].ovrs  = LEDS_LEDMASK3;
+			}
+
+			static inline void LEDs_Disable(void)
+			{
+				AVR32_GPIO.port[1].gperc = LEDS_LEDMASK1;
+				AVR32_GPIO.port[1].oderc = LEDS_LEDMASK1;
+				AVR32_GPIO.port[1].ovrc  = LEDS_LEDMASK1;
+
+				AVR32_GPIO.port[3].gperc = LEDS_LEDMASK3;
+				AVR32_GPIO.port[3].oderc = LEDS_LEDMASK3;
+				AVR32_GPIO.port[3].ovrc  = LEDS_LEDMASK3;
+			}
+
+			static inline void LEDs_TurnOnLEDs(const uint32_t LEDMask)
+			{
+				AVR32_GPIO.port[1].ovrc  = (LEDMask & LEDS_LEDMASK1);
+				AVR32_GPIO.port[3].ovrc  = (LEDMask & LEDS_LEDMASK3);
+			}
+
+			static inline void LEDs_TurnOffLEDs(const uint32_t LEDMask)
+			{
+				AVR32_GPIO.port[1].ovrs  = (LEDMask & LEDS_LEDMASK1);
+				AVR32_GPIO.port[3].ovrs  = (LEDMask & LEDS_LEDMASK3);
+			}
+
+			static inline void LEDs_SetAllLEDs(const uint32_t LEDMask)
+			{
+				AVR32_GPIO.port[1].ovrs  = LEDS_LEDMASK1;
+				AVR32_GPIO.port[1].ovrc  = (LEDMask & LEDS_LEDMASK1);
+
+				AVR32_GPIO.port[3].ovrs  = LEDS_LEDMASK3;
+				AVR32_GPIO.port[3].ovrc  = (LEDMask & LEDS_LEDMASK3);
+			}
+
+			static inline void LEDs_ChangeLEDs(const uint32_t LEDMask, const uint32_t ActiveMask)
+			{
+				AVR32_GPIO.port[1].ovrs  = (LEDMask    & LEDS_LEDMASK1);
+				AVR32_GPIO.port[1].ovrc  = (ActiveMask & LEDS_LEDMASK1);
+
+				AVR32_GPIO.port[3].ovrs  = (LEDMask    & LEDS_LEDMASK3);
+				AVR32_GPIO.port[3].ovrc  = (ActiveMask & LEDS_LEDMASK3);
+			}
+
+			static inline void LEDs_ToggleLEDs(const uint32_t LEDMask)
+			{
+				AVR32_GPIO.port[1].ovrt  = (LEDMask & LEDS_LEDMASK1);
+				AVR32_GPIO.port[3].ovrt  = (LEDMask & LEDS_LEDMASK3);
+			}
+
+			static inline uint32_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
+			static inline uint32_t LEDs_GetLEDs(void)
+			{
+				return ((~AVR32_GPIO.port[1].ovr & LEDS_LEDMASK1) | (~AVR32_GPIO.port[3].ovr & LEDS_LEDMASK3));
+			}
+		#endif
+
+	/* Disable C linkage for C++ Compilers: */
+		#if defined(__cplusplus)
+			}
+		#endif
+
+#endif
+
+/** @} */
+