Add board driver support for the Atmel XMEGA-B1 Xplained board.

[pub/lufa.git] / LUFA / Drivers / Board / XMEGA / B1_XPLAINED / Buttons.h

diff --git a/LUFA/Drivers/Board/XMEGA/B1_XPLAINED/Buttons.h b/LUFA/Drivers/Board/XMEGA/B1_XPLAINED/Buttons.h
new file mode 100644 (file)
index 0000000..3dd1dfe
--- /dev/null
+++ b/LUFA/Drivers/Board/XMEGA/B1_XPLAINED/Buttons.h
@@ -0,0 +1,111 @@
+/*\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 Buttons driver header for the Atmel XMEGA B1 Xplained.\r
+ *  \copydetails Group_Buttons_B1_XPLAINED\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the Buttons driver\r
+ *        dispatch header located in LUFA/Drivers/Board/Buttons.h.\r
+ */\r
+\r
+/** \ingroup Group_Buttons\r
+ *  \defgroup Group_Buttons_B1_XPLAINED B1_XPLAINED\r
+ *  \brief Board specific Buttons driver header for the Atmel XMEGA B1 Xplained.\r
+ *\r
+ *  Board specific Buttons driver header for the Atmel XMEGA B1 Xplained.\r
+ *\r
+ *  @{\r
+ */\r
+\r
+#ifndef __BUTTONS_B1_XPLAINED_H__\r
+#define __BUTTONS_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_BUTTONS_H)\r
+                       #error Do not include this file directly. Include LUFA/Drivers/Board/Buttons.h instead.\r
+               #endif\r
+\r
+       /* Public Interface - May be used in end-application: */\r
+               /* Macros: */\r
+                       /** Button mask for the first button on the board. */\r
+                       #define BUTTONS_BUTTON1          (1 << 0)\r
+\r
+                       /** Button mask for the second button on the board. */\r
+                       #define BUTTONS_BUTTON2          (1 << 1)\r
+\r
+                       /** Button mask for the third button on the board. */\r
+                       #define BUTTONS_BUTTON3          (1 << 2)\r
+\r
+                       /** Button mask for the fourth button on the board. */\r
+                       #define BUTTONS_BUTTON4          (1 << 3)\r
+\r
+               /* Inline Functions: */\r
+               #if !defined(__DOXYGEN__)\r
+                       static inline void Buttons_Init(void)\r
+                       {\r
+                               PORTE_OUTCLR    = (BUTTONS_BUTTON1 | BUTTONS_BUTTON2 | BUTTONS_BUTTON3 | BUTTONS_BUTTON4);\r
+\r
+                               PORTCFG_MPCMASK = (BUTTONS_BUTTON1 | BUTTONS_BUTTON2 | BUTTONS_BUTTON3 | BUTTONS_BUTTON4);\r
+                               PORTE_PIN0CTRL  = PORT_OPC_PULLUP_gc;\r
+                       }\r
+\r
+                       static inline void Buttons_Disable(void)\r
+                       {\r
+                               PORTE_OUTCLR    = (BUTTONS_BUTTON1 | BUTTONS_BUTTON2 | BUTTONS_BUTTON3 | BUTTONS_BUTTON4);\r
+\r
+                               PORTCFG_MPCMASK = (BUTTONS_BUTTON1 | BUTTONS_BUTTON2 | BUTTONS_BUTTON3 | BUTTONS_BUTTON4);\r
+                               PORTE_PIN0CTRL  = 0;\r
+                       }\r
+\r
+                       static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT;\r
+                       static inline uint8_t Buttons_GetStatus(void)\r
+                       {\r
+                               return (~PORTE_IN & (BUTTONS_BUTTON1 | BUTTONS_BUTTON2 | BUTTONS_BUTTON3 | BUTTONS_BUTTON4));\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