Changed HWB board driver to Buttons driver, to allow for the support of future boards...

[pub/lufa.git] / LUFA / DriverStubs / Buttons.h

diff --git a/LUFA/DriverStubs/Buttons.h b/LUFA/DriverStubs/Buttons.h
new file mode 100644 (file)
index 0000000..0d02e5c
--- /dev/null
+++ b/LUFA/DriverStubs/Buttons.h
@@ -0,0 +1,87 @@
+/*\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
+/*\r
+   This is a stub driver header file, for implementing custom board\r
+   layout hardware with compatible LUFA board specific drivers. If\r
+   the library is configured to use the BOARD_USER board mode, this\r
+   driver file should be completed and copied into the "/Board/" folder\r
+   inside the application's folder.\r
+\r
+   This stub is for the board-specific component of the LUFA Buttons driver,\r
+   for the control of physical board-mounted GPIO pushbuttons.\r
+*/\r
+ \r
+#ifndef __BUTTONS_USER_H__\r
+#define __BUTTONS_USER_H__\r
+\r
+       /* Includes: */\r
+               #include <avr/io.h>\r
+               #include <stdbool.h>\r
+\r
+               #include "../../../Common/Common.h"\r
+\r
+               // TODO: Add any required includes here\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          // TODO: Add mask for first board buton here\r
+       \r
+               /* Inline Functions: */\r
+               #if !defined(__DOXYGEN__)\r
+                       static inline void Buttons_Init(void)\r
+                       {\r
+                               // TODO: Initialize the appropriate port pins as an inputs here, with pull-ups\r
+                       }\r
+\r
+                       static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT;\r
+                       static inline uint8_t Buttons_GetStatus(void)\r
+                       {\r
+                               // TODO: Return current button status here, debounced if required\r
+                       }\r
+               #endif\r
+\r
+       /* Disable C linkage for C++ Compilers: */\r
+               #if defined(__cplusplus)\r
+                       }\r
+               #endif\r
+                       \r
+#endif\r