X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/938f86d06321c1a29cf87201000a9dae4e5a7c25..ceb16ee24f1e6add5e2ad0398369c24d2d868cd8:/LUFA/Drivers/Board/Buttons.h diff --git a/LUFA/Drivers/Board/Buttons.h b/LUFA/Drivers/Board/Buttons.h index 1ea3668cb..0077df36b 100644 --- a/LUFA/Drivers/Board/Buttons.h +++ b/LUFA/Drivers/Board/Buttons.h @@ -1,21 +1,21 @@ /* LUFA Library - Copyright (C) Dean Camera, 2009. + Copyright (C) Dean Camera, 2010. dean [at] fourwalledcubicle [dot] com www.fourwalledcubicle.com */ /* - Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com) + Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com) - Permission to use, copy, modify, and distribute this software - and its documentation for any purpose and without fee is hereby - granted, 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 + 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 @@ -29,6 +29,7 @@ */ /** \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. @@ -48,7 +49,9 @@ * - None * * \section Module Description - * Functions, macros, variables, enums and types related to the control of physical board GPIO buttons. + * 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. @@ -61,15 +64,15 @@ /* Macros: */ #if !defined(__DOXYGEN__) + #define __INCLUDE_FROM_BUTTONS_H #define INCLUDE_FROM_BUTTONS_H - #define INCLUDE_FROM_BOARD_DRIVER #endif /* Includes: */ #include "../../Common/Common.h" - #if !defined(BOARD) - #error BOARD must be set in makefile to a value specified in BoardTypes.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) @@ -78,8 +81,18 @@ #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_USER) - #include "Board/Buttons.h" + #include "Board/Buttons.h" #else #error The selected board does not contain any GPIO buttons. #endif