Add board driver support for the Atmel XMEGA-B1 Xplained board.
[pub/lufa.git] / LUFA / Drivers / Board / XMEGA / B1_XPLAINED / LEDs.h
diff --git a/LUFA/Drivers/Board/XMEGA/B1_XPLAINED/LEDs.h b/LUFA/Drivers/Board/XMEGA/B1_XPLAINED/LEDs.h
new file mode 100644 (file)
index 0000000..8cc10c2
--- /dev/null
@@ -0,0 +1,165 @@
+/*\r
+             LUFA Library\r
+     Copyright (C) Dean Camera, 2012.\r
+\r
+  dean [at] fourwalledcubicle [dot] com\r
+           www.lufa-lib.org\r
+*/\r
+\r
+/*\r
+  Copyright 2012  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
+ *  \brief Board specific LED driver header for the Atmel XMEGA B1 Xplained.\r
+ *  \copydetails Group_LEDs_B1_XPLAINED\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the LEDs driver\r
+ *        dispatch header located in LUFA/Drivers/Board/LEDs.h.\r
+ */\r
+\r
+/** \ingroup Group_LEDs\r
+ *  \defgroup Group_LEDs_B1_XPLAINED B1_XPLAINED\r
+ *  \brief Board specific LED driver header for the Atmel XMEGA B1 Xplained.\r
+ *\r
+ *  Board specific LED driver header for the Atmel XMEGA B1 Xplained.\r
+ *\r
+ *  @{\r
+ */\r
+\r
+#ifndef __LEDS_B1_XPLAINED_H__\r
+#define __LEDS_B1_XPLAINED_H__\r
+\r
+       /* Includes: */\r
+               #include <avr/io.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_LEDS_H)\r
+                       #error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead.\r
+               #endif\r
+\r
+       /* Private Interface - For use in library only: */\r
+       #if !defined(__DOXYGEN__)\r
+               /* Macros: */\r
+                       #define LEDS_PORTF_LEDS        (LEDS_LED1 | LEDS_LED2 | LEDS_LED3 | LEDS_LED4)\r
+                       #define LEDS_PORTE_LEDS        LEDS_LED5\r
+\r
+                       #define LEDS_PORTE_MASK_SHIFT  1\r
+       #endif\r
+\r
+       /* Public Interface - May be used in end-application: */\r
+               /* Macros: */\r
+                       /** LED mask for the first LED on the board. */\r
+                       #define LEDS_LED1        (1 << 4)\r
+\r
+                       /** LED mask for the second LED on the board. */\r
+                       #define LEDS_LED2        (1 << 5)\r
+\r
+                       /** LED mask for the third LED on the board. */\r
+                       #define LEDS_LED3        (1 << 6)\r
+\r
+                       /** LED mask for the fourth LED on the board. */\r
+                       #define LEDS_LED4        (1 << 7)\r
+\r
+                       /** LED mask for the fifth LED on the board. */\r
+                       #define LEDS_LED5       ((1 << 4) >> LEDS_PORTE_MASK_SHIFT)\r
+\r
+                       /** LED mask for all the LEDs on the board. */\r
+                       #define LEDS_ALL_LEDS    (LEDS_LED1 | LEDS_LED2 | LEDS_LED3 | LEDS_LED4 | LEDS_LED5)\r
+\r
+                       /** LED mask for none of the board LEDs. */\r
+                       #define LEDS_NO_LEDS     0\r
+\r
+               /* Inline Functions: */\r
+               #if !defined(__DOXYGEN__)\r
+                       static inline void LEDs_Init(void)\r
+                       {\r
+                               PORTF_DIRSET = LEDS_PORTF_LEDS;\r
+                               PORTF_OUTSET = LEDS_PORTF_LEDS;\r
+\r
+                               PORTE_DIRSET = (LEDS_PORTE_LEDS << LEDS_PORTE_MASK_SHIFT);\r
+                               PORTE_OUTCLR = (LEDS_PORTE_LEDS << LEDS_PORTE_MASK_SHIFT);\r
+                       }\r
+\r
+                       static inline void LEDs_Disable(void)\r
+                       {\r
+                               PORTF_DIRCLR = LEDS_PORTF_LEDS;\r
+                               PORTF_OUTCLR = LEDS_PORTF_LEDS;\r
+\r
+                               PORTE_DIRCLR = (LEDS_PORTE_LEDS << LEDS_PORTE_MASK_SHIFT);\r
+                               PORTE_OUTCLR = (LEDS_PORTE_LEDS << LEDS_PORTE_MASK_SHIFT);\r
+                       }\r
+\r
+                       static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)\r
+                       {\r
+                               PORTF_OUTCLR = (LEDMask & LEDS_PORTF_LEDS);\r
+                               PORTE_OUTSET = ((LEDMask & LEDS_PORTE_LEDS) << LEDS_PORTE_MASK_SHIFT);\r
+                       }\r
+\r
+                       static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask)\r
+                       {\r
+                               PORTF_OUTSET = (LEDMask & LEDS_PORTF_LEDS);\r
+                               PORTE_OUTCLR = ((LEDMask & LEDS_PORTE_LEDS) << LEDS_PORTE_MASK_SHIFT);\r
+                       }\r
+\r
+                       static inline void LEDs_SetAllLEDs(const uint8_t LEDMask)\r
+                       {\r
+                               PORTF_OUTSET = LEDS_PORTF_LEDS;\r
+                               PORTE_OUTCLR = (LEDS_PORTE_LEDS << LEDS_PORTE_MASK_SHIFT);\r
+\r
+                               PORTF_OUTCLR = (LEDMask & LEDS_PORTF_LEDS);\r
+                               PORTE_OUTSET = ((LEDMask & LEDS_PORTE_LEDS) << LEDS_PORTE_MASK_SHIFT);\r
+                       }\r
+\r
+                       static inline void LEDs_ChangeLEDs(const uint8_t LEDMask, const uint8_t ActiveMask)\r
+                       {\r
+                               PORTF_OUT = (PORTF.OUT & (~LEDMask & LEDS_PORTF_LEDS)) | (ActiveMask & LEDS_PORTF_LEDS);\r
+                               PORTE_OUT = (PORTF.OUT & (((~LEDMask & LEDS_PORTF_LEDS)) << LEDS_PORTE_MASK_SHIFT) &\r
+                                            ~((ActiveMask & LEDS_PORTE_LEDS) << LEDS_PORTE_MASK_SHIFT));\r
+                       }\r
+\r
+                       static inline void LEDs_ToggleLEDs(const uint8_t LEDMask)\r
+                       {\r
+                               PORTF_OUTTGL = (LEDMask & LEDS_PORTF_LEDS);\r
+                               PORTE_OUTTGL = ((LEDMask & LEDS_PORTE_LEDS) << LEDS_PORTE_MASK_SHIFT);\r
+                       }\r
+\r
+                       static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;\r
+                       static inline uint8_t LEDs_GetLEDs(void)\r
+                       {\r
+                               return ((~PORTF_OUT & LEDS_PORTF_LEDS) | (PORTE_OUT & (LEDS_PORTE_LEDS << LEDS_PORTE_MASK_SHIFT)));\r
+                       }\r
+               #endif\r
+\r
+       /* Disable C linkage for C++ Compilers: */\r
+               #if defined(__cplusplus)\r
+                       }\r
+               #endif\r
+\r
+#endif\r
+\r
+/** @} */\r
+\r