Buttons.h 4.44 KB
 Dean Camera committed May 08, 2010 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 /* LUFA Library Copyright (C) Dean Camera, 2010. dean [at] fourwalledcubicle [dot] com www.fourwalledcubicle.com */ /* Copyright 2010 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 disclaim 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 Master include file for the board digital button 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. * * 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 * directory.  Dean Camera committed Sep 03, 2010 42 43  * * For possible BOARD makefile values, see \ref Group_BoardTypes.  Dean Camera committed May 08, 2010 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60  */ /** \ingroup Group_BoardDrivers * @defgroup Group_Buttons Buttons Driver - LUFA/Drivers/Board/Buttons.h * * \section Sec_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - None * * \section 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 * directory. Otherwise, it will include the appropriate built in board driver header file. *  Dean Camera committed Sep 03, 2010 61 62  * For possible BOARD makefile values, see \ref Group_BoardTypes. *  Dean Camera committed May 08, 2010 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97  * @{ */ #ifndef __BUTTONS_H__ #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"  Dean Camera committed Sep 03, 2010 98 99  #elif (BOARD == BOARD_OLIMEX162) #include "OLIMEX162/Buttons.h"  Dean Camera committed Sep 04, 2010 100 101  #elif (BOARD == BOARD_USBFOO) #include "USBFOO/Buttons.h"  Dean Camera committed Sep 14, 2010 102 103  #elif (BOARD == BOARD_UDIP) #include "UDIP/Buttons.h"  Dean Camera committed Oct 06, 2010 104 105  #elif (BOARD == BOARD_CULV3) #include "CULV3/Buttons.h"  Dean Camera committed May 08, 2010 106 107 108 109 110 111 112 113  #elif (BOARD == BOARD_USER) #include "Board/Buttons.h" #else #error The selected board does not contain any GPIO buttons. #endif /* Pseudo-Functions for Doxygen: */ #if defined(__DOXYGEN__)  Dean Camera committed Jul 30, 2010 114  /** Initialises the BUTTONS driver, so that the current button position can be read. This sets the appropriate  Dean Camera committed May 08, 2010 115 116 117 118 119 120 121 122  * 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); /** Returns a mask indicating which board buttons are currently pressed. *  Dean Camera committed Jun 17, 2010 123  * \return Mask indicating which board buttons are currently pressed.  Dean Camera committed May 08, 2010 124 125 126 127 128 129 130  */ static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT; #endif #endif /** @} */