X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/2073b96d82433607bd287e3b6529fd0d3cc428cd..0da99447d3e88e83f9977501bee56af5c7aa56c0:/LUFA/Drivers/Board/Buttons.h diff --git a/LUFA/Drivers/Board/Buttons.h b/LUFA/Drivers/Board/Buttons.h index e112683a8..73ccb4194 100644 --- a/LUFA/Drivers/Board/Buttons.h +++ b/LUFA/Drivers/Board/Buttons.h @@ -1,13 +1,13 @@ /* LUFA Library - Copyright (C) Dean Camera, 2010. + Copyright (C) Dean Camera, 2012. dean [at] fourwalledcubicle [dot] com www.lufa-lib.org */ /* - Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com) + Copyright 2012 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 @@ -29,52 +29,56 @@ */ /** \file - * \brief Master include file for the board digital button driver. + * \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 AVR's GPIO pins. + * 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 BOARD value is set to BOARD_USER, this will include the /Board/Buttons.h file in the user project + * 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 BOARD makefile values, see \ref Group_BoardTypes. + * For possible \c BOARD makefile values, see \ref Group_BoardTypes. */ /** \ingroup Group_BoardDrivers - * @defgroup Group_Buttons Buttons Driver - LUFA/Drivers/Board/Buttons.h + * \defgroup Group_Buttons Buttons Driver - LUFA/Drivers/Board/Buttons.h + * \brief Digital button board hardware driver. * * \section Sec_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - None * - * \section Module Description + * \section Sec_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 BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project + * 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 BOARD makefile values, see \ref Group_BoardTypes. + * For possible \c BOARD makefile values, see \ref Group_BoardTypes. + * + * \section Sec_ExampleUsage Example Usage + * The following snippet is an example of how this module may be used within a typical + * application. * - * Example Usage: * \code - * // Initialise the button driver before first use + * // 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 - * + * * @{ */ @@ -82,66 +86,88 @@ #define __BUTTONS_H__ /* Macros: */ - #if !defined(__DOXYGEN__) #define __INCLUDE_FROM_BUTTONS_H - #define INCLUDE_FROM_BUTTONS_H - #endif /* Includes: */ - #include "../../Common/Common.h" - - #if (BOARD == BOARD_NONE) - #error The Board Buttons driver cannot be used if the makefile BOARD option is not set. - #elif (BOARD == BOARD_USBKEY) - #include "USBKEY/Buttons.h" - #elif (BOARD == BOARD_STK525) - #include "STK525/Buttons.h" - #elif (BOARD == BOARD_STK526) - #include "STK526/Buttons.h" - #elif (BOARD == BOARD_ATAVRUSBRF01) - #include "ATAVRUSBRF01/Buttons.h" - #elif (BOARD == BOARD_BUMBLEB) - #include "BUMBLEB/Buttons.h" - #elif (BOARD == BOARD_EVK527) - #include "EVK527/Buttons.h" - #elif (BOARD == BOARD_USBTINYMKII) - #include "USBTINYMKII/Buttons.h" - #elif (BOARD == BOARD_BENITO) - #include "BENITO/Buttons.h" - #elif (BOARD == BOARD_JMDBU2) - #include "JMDBU2/Buttons.h" - #elif (BOARD == BOARD_OLIMEX162) - #include "OLIMEX162/Buttons.h" - #elif (BOARD == BOARD_USBFOO) - #include "USBFOO/Buttons.h" - #elif (BOARD == BOARD_UDIP) - #include "UDIP/Buttons.h" - #elif (BOARD == BOARD_CULV3) - #include "CULV3/Buttons.h" - #elif (BOARD == BOARD_MINIMUS) - #include "MINIMUS/Buttons.h" - #elif (BOARD == BOARD_MICROSIN162) - #include "MICROSIN162/Buttons.h" - #elif (BOARD == BOARD_USER) - #include "Board/Buttons.h" - #else - #error The selected board does not contain any GPIO buttons. - #endif + #include "../../Common/Common.h" + + #if (BOARD == BOARD_NONE) + #error The Board Buttons driver cannot be used if the makefile BOARD option is not set. + #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" + #else + #include "Board/Buttons.h" + #endif /* Pseudo-Functions for Doxygen: */ #if defined(__DOXYGEN__) - /** Initialises the BUTTONS driver, so that the current button position can be read. This sets the appropriate + /** 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 indicating which board buttons are currently pressed. */ - static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT; + static inline uint_reg_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT; #endif #endif