X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/41c1fb38434c006fa88b0071f81d65b2330940fc..6f90d45684206e5dfca3c4554a14a5784da49d92:/LUFA/CodeTemplates/DriverStubs/Buttons.h diff --git a/LUFA/CodeTemplates/DriverStubs/Buttons.h b/LUFA/CodeTemplates/DriverStubs/Buttons.h index c92577a44..66f5e1661 100644 --- a/LUFA/CodeTemplates/DriverStubs/Buttons.h +++ b/LUFA/CodeTemplates/DriverStubs/Buttons.h @@ -1,21 +1,21 @@ /* LUFA Library - Copyright (C) Dean Camera, 2010. - + Copyright (C) Dean Camera, 2012. + dean [at] fourwalledcubicle [dot] com - www.fourwalledcubicle.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 + 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 + 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 + 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 @@ -28,24 +28,23 @@ this software. */ -/* - This is a stub driver header file, for implementing custom board - layout hardware with compatible LUFA board specific drivers. If - the library is configured to use the BOARD_USER board mode, this - driver file should be completed and copied into the "/Board/" folder - inside the application's folder. - - This stub is for the board-specific component of the LUFA Buttons driver, - for the control of physical board-mounted GPIO pushbuttons. -*/ - +/** \file + * \brief LUFA Custom Board Button Hardware Driver (Template) + * + * This is a stub driver header file, for implementing custom board + * layout hardware with compatible LUFA board specific drivers. If + * the library is configured to use the BOARD_USER board mode, this + * driver file should be completed and copied into the "/Board/" folder + * inside the application's folder. + * + * This stub is for the board-specific component of the LUFA Buttons driver, + * for the control of physical board-mounted GPIO pushbuttons. + */ + #ifndef __BUTTONS_USER_H__ #define __BUTTONS_USER_H__ /* Includes: */ - #include - #include - // TODO: Add any required includes here /* Enable C linkage for C++ Compilers: */ @@ -57,12 +56,12 @@ #if !defined(__INCLUDE_FROM_BUTTONS_H) #error Do not include this file directly. Include LUFA/Drivers/Board/Buttons.h instead. #endif - + /* Public Interface - May be used in end-application: */ /* Macros: */ /** Button mask for the first button on the board. */ #define BUTTONS_BUTTON1 // TODO: Add mask for first board button here - + /* Inline Functions: */ #if !defined(__DOXYGEN__) static inline void Buttons_Init(void) @@ -70,6 +69,11 @@ // TODO: Initialize the appropriate port pins as an inputs here, with pull-ups } + static inline void Buttons_Disable(void) + { + // TODO: Clear the appropriate port pins as high impedance inputs here + } + static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT; static inline uint8_t Buttons_GetStatus(void) { @@ -81,5 +85,6 @@ #if defined(__cplusplus) } #endif - + #endif +