Squashed 'lib/lufa/' content from commit 385d40300

git-subtree-dir: lib/lufa
git-subtree-split: 385d4030035dbaf41591309dbde47653bd03841b

1 files changed, 189 insertions, 0 deletions

diff --git a/LUFA/Drivers/Board/Buttons.h b/LUFA/Drivers/Board/Buttons.h
new file mode 100644
index 0000000000..00ebe8c15d
--- /dev/null
+++ b/LUFA/Drivers/Board/Buttons.h
@@ -0,0 +1,189 @@
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2017.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+*/
+
+/*
+  Copyright 2017  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 disclaims 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 Digital button board hardware driver.
+ *
+ *  This file is the master dispatch header file for the board-specific Buttons driver, for boards containing
+ *  physical pushbuttons connected to the microcontroller's GPIO pins.
+ *
+ *  User code should include this file, which will in turn include the correct Button driver header file for the
+ *  currently selected board.
+ *
+ *  If the \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/Buttons.h file in the user project
+ *  directory.
+ *
+ *  For possible \c BOARD makefile values, see \ref Group_BoardTypes.
+ */
+
+/** \ingroup Group_BoardDrivers
+ *  \defgroup Group_Buttons Buttons Driver - LUFA/Drivers/Board/Buttons.h
+ *  \brief Digital button board hardware driver.
+ *
+ *  \section Sec_Buttons_Dependencies Module Source Dependencies
+ *  The following files must be built with any user project that uses this module:
+ *    - None
+ *
+ *  \section Sec_Buttons_ModDescription Module Description
+ *  Hardware buttons driver. This provides an easy to use driver for the hardware buttons present on many boards.
+ *  It provides a way to easily configure and check the status of all the buttons on the board so that appropriate
+ *  actions can be taken.
+ *
+ *  If the \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/Buttons.h file in the user project
+ *  directory. Otherwise, it will include the appropriate built-in board driver header file.
+ *
+ *  For possible \c BOARD makefile values, see \ref Group_BoardTypes.
+ *
+ *  \section Sec_Buttons_ExampleUsage Example Usage
+ *  The following snippet is an example of how this module may be used within a typical
+ *  application.
+ *
+ *  \code
+ *      // Initialize the button driver before first use
+ *      Buttons_Init();
+ *
+ *      printf("Waiting for button press...\r\n");
+ *
+ *      // Loop until a board button has been pressed
+ *      uint8_t ButtonPress;
+ *      while (!(ButtonPress = Buttons_GetStatus())) {};
+ *
+ *      // Display which button was pressed (assuming two board buttons)
+ *      printf("Button pressed: %s\r\n", (ButtonPress == BUTTONS_BUTTON1) ? "Button 1" : "Button 2");
+ *  \endcode
+ *
+ *  @{
+ */
+
+#ifndef __BUTTONS_H__
+#define __BUTTONS_H__
+
+	/* Macros: */
+		#define __INCLUDE_FROM_BUTTONS_H
+
+	/* Includes: */
+		#include "../../Common/Common.h"
+
+		#if (BOARD == BOARD_NONE)
+			#define BUTTONS_BUTTON1  0
+			static inline void       Buttons_Init(void) {}
+			static inline void       Buttons_Disable(void) {}
+			static inline uint_reg_t Buttons_GetStatus(void) { return 0; }
+		#elif (BOARD == BOARD_USBKEY)
+			#include "AVR8/USBKEY/Buttons.h"
+		#elif (BOARD == BOARD_STK525)
+			#include "AVR8/STK525/Buttons.h"
+		#elif (BOARD == BOARD_STK526)
+			#include "AVR8/STK526/Buttons.h"
+		#elif (BOARD == BOARD_ATAVRUSBRF01)
+			#include "AVR8/ATAVRUSBRF01/Buttons.h"
+		#elif (BOARD == BOARD_BUMBLEB)
+			#include "AVR8/BUMBLEB/Buttons.h"
+		#elif (BOARD == BOARD_EVK527)
+			#include "AVR8/EVK527/Buttons.h"
+		#elif (BOARD == BOARD_USBTINYMKII)
+			#include "AVR8/USBTINYMKII/Buttons.h"
+		#elif (BOARD == BOARD_BENITO)
+			#include "AVR8/BENITO/Buttons.h"
+		#elif (BOARD == BOARD_JMDBU2)
+			#include "AVR8/JMDBU2/Buttons.h"
+		#elif (BOARD == BOARD_OLIMEX162)
+			#include "AVR8/OLIMEX162/Buttons.h"
+		#elif (BOARD == BOARD_USBFOO)
+			#include "AVR8/USBFOO/Buttons.h"
+		#elif (BOARD == BOARD_UDIP)
+			#include "AVR8/UDIP/Buttons.h"
+		#elif (BOARD == BOARD_CULV3)
+			#include "AVR8/CULV3/Buttons.h"
+		#elif (BOARD == BOARD_MINIMUS)
+			#include "AVR8/MINIMUS/Buttons.h"
+		#elif (BOARD == BOARD_MICROSIN162)
+			#include "AVR8/MICROSIN162/Buttons.h"
+		#elif (BOARD == BOARD_EVK1101)
+			#include "UC3/EVK1101/Buttons.h"
+		#elif (BOARD == BOARD_TUL)
+			#include "AVR8/TUL/Buttons.h"
+		#elif (BOARD == BOARD_EVK1100)
+			#include "UC3/EVK1100/Buttons.h"
+		#elif (BOARD == BOARD_EVK1104)
+			#include "UC3/EVK1104/Buttons.h"
+		#elif (BOARD == BOARD_A3BU_XPLAINED)
+			#include "XMEGA/A3BU_XPLAINED/Buttons.h"
+		#elif ((BOARD == BOARD_USB2AX) || (BOARD == BOARD_USB2AX_V3))
+			#include "AVR8/USB2AX/Buttons.h"
+		#elif ((BOARD == BOARD_MICROPENDOUS_32U2) || (BOARD == BOARD_MICROPENDOUS_A) || \
+		       (BOARD == BOARD_MICROPENDOUS_1)    || (BOARD == BOARD_MICROPENDOUS_2) || \
+		       (BOARD == BOARD_MICROPENDOUS_3)    || (BOARD == BOARD_MICROPENDOUS_4) || \
+		       (BOARD == BOARD_MICROPENDOUS_REV1) || (BOARD == BOARD_MICROPENDOUS_REV2) || \
+		       (BOARD == BOARD_MICROPENDOUS_DIP))
+			#include "AVR8/MICROPENDOUS/Buttons.h"
+		#elif (BOARD == BOARD_B1_XPLAINED)
+			#include "XMEGA/B1_XPLAINED/Buttons.h"
+		#elif (BOARD == BOARD_OLIMEX32U4)
+			#include "AVR8/OLIMEX32U4/Buttons.h"
+		#elif (BOARD == BOARD_OLIMEXT32U4)
+			#include "AVR8/OLIMEXT32U4/Buttons.h"
+		#elif (BOARD == BOARD_OLIMEXISPMK2)
+			#include "AVR8/OLIMEXISPMK2/Buttons.h"
+		#elif (BOARD == BOARD_UC3A3_XPLAINED)
+			#include "UC3/UC3A3_XPLAINED/Buttons.h"
+		#elif (BOARD == BOARD_STANGE_ISP)
+			#include "AVR8/STANGE_ISP/Buttons.h"
+		#elif (BOARD == BOARD_C3_XPLAINED)
+			#include "XMEGA/C3_XPLAINED/Buttons.h"
+		#elif (BOARD == BOARD_U2S)
+			#include "AVR8/U2S/Buttons.h"
+		#else
+			#include "Board/Buttons.h"
+		#endif
+
+	/* Pseudo-Functions for Doxygen: */
+	#if defined(__DOXYGEN__)
+		/** Initializes the buttons driver, so that the current button position can be read. This sets the appropriate
+		 *  I/O pins to an inputs with pull-ups enabled.
+		 *
+		 *  This must be called before any Button driver functions are used.
+		 */
+		static inline void Buttons_Init(void);
+
+		/** Disables the buttons driver, releasing the I/O pins back to their default high-impedance input mode. */
+		static inline void Buttons_Disable(void);
+
+		/** Returns a 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
+
+#endif
+
+/** @} */
+