+/*\r
+ LUFA Library\r
+ Copyright (C) Dean Camera, 2009.\r
+ \r
+ dean [at] fourwalledcubicle [dot] com\r
+ www.fourwalledcubicle.com\r
+*/\r
+\r
+/*\r
+ Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+ Permission to use, copy, modify, and distribute this software\r
+ and its documentation for any purpose and without fee is hereby\r
+ granted, provided that the above copyright notice appear in all\r
+ 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
+ *\r
+ * This file is the master dispatch header file for the board-specific Buttons driver, for boards containing\r
+ * physical pushbuttons connected to the AVR's GPIO pins.\r
+ *\r
+ * User code should include this file, which will in turn include the correct Button driver header file for the\r
+ * currently selected board.\r
+ *\r
+ * If the BOARD value is set to BOARD_USER, this will include the /Board/Buttons.h file in the user project\r
+ * directory.\r
+ */\r
+\r
+/** \ingroup Group_BoardDrivers\r
+ * @defgroup Group_Buttons Buttons Driver - LUFA/Drivers/Board/Buttons.h\r
+ *\r
+ * \section Sec_Dependencies Module Source Dependencies\r
+ * The following files must be built with any user project that uses this module:\r
+ * - None\r
+ *\r
+ * \section Module Description\r
+ * Functions, macros, variables, enums and types related to the control of physical board GPIO buttons.\r
+ *\r
+ * If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project\r
+ * directory. Otherwise, it will include the appropriate built in board driver header file.\r
+ *\r
+ * @{\r
+ */\r
+\r
+#ifndef __BUTTONS_H__\r
+#define __BUTTONS_H__\r
+\r
+ /* Macros: */\r
+ #if !defined(__DOXYGEN__)\r
+ #define INCLUDE_FROM_BUTTONS_H\r
+ #define INCLUDE_FROM_BOARD_DRIVER\r
+ #endif\r
+\r
+ /* Includes: */\r
+ #include "../../Common/Common.h"\r
+ \r
+ #if !defined(BOARD)\r
+ #error BOARD must be set in makefile to a value specified in BoardTypes.h.\r
+ #elif (BOARD == BOARD_USBKEY)\r
+ #include "USBKEY/BUTTONS.h"\r
+ #elif (BOARD == BOARD_STK525)\r
+ #include "STK525/BUTTONS.h"\r
+ #elif (BOARD == BOARD_STK526)\r
+ #include "STK526/BUTTONS.h"\r
+ #elif (BOARD == BOARD_ATAVRUSBRF01)\r
+ #include "ATAVRUSBRF01/BUTTONS.h"\r
+ #elif (BOARD == BOARD_USER)\r
+ #include "Board/BUTTONS.h" \r
+ #else\r
+ #error The selected board does not contain any GPIO buttons.\r
+ #endif\r
+ \r
+ /* Pseudo-Functions for Doxygen: */\r
+ #if defined(__DOXYGEN__)\r
+ /** Initializes the BUTTONS driver, so that the current button position can be read. This sets the appropriate\r
+ * I/O pins to an inputs with pull-ups enabled.\r
+ *\r
+ * This must be called before any Button driver functions are used.\r
+ */\r
+ static inline void Buttons_Init(void);\r
+ \r
+ /** Returns a mask indicating which board buttons are currently pressed.\r
+ *\r
+ * \return Mask indicating which board buttons are currently pressed\r
+ */\r
+ static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT;\r
+ #endif\r
+\r
+#endif\r
+\r
+/** @} */\r