Add svn:eol-style property to source files, so that the line endings are correctly...
[pub/USBasp.git] / LUFA / Drivers / Board / Buttons.h
index 0077df3..ec25f5f 100644 (file)
-/*\r
-             LUFA Library\r
-     Copyright (C) Dean Camera, 2010.\r
-              \r
-  dean [at] fourwalledcubicle [dot] com\r
-      www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\r
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
-  Permission to use, copy, modify, distribute, and sell this \r
-  software and its documentation for any purpose is hereby granted\r
-  without fee, provided that the above copyright notice appear in \r
-  all copies and that both that the copyright notice and this\r
-  permission notice and warranty disclaimer appear in supporting \r
-  documentation, and that the name of the author not be used in \r
-  advertising or publicity pertaining to distribution of the \r
-  software without specific, written prior permission.\r
-\r
-  The author disclaim all warranties with regard to this\r
-  software, including all implied warranties of merchantability\r
-  and fitness.  In no event shall the author be liable for any\r
-  special, indirect or consequential damages or any damages\r
-  whatsoever resulting from loss of use, data or profits, whether\r
-  in an action of contract, negligence or other tortious action,\r
-  arising out of or in connection with the use or performance of\r
-  this software.\r
-*/\r
-\r
-/** \file\r
- *  \brief Master include file for the board digital button driver.\r
- *\r
- *  This file is the master dispatch header file for the board-specific Buttons driver, for boards containing\r
- *  physical pushbuttons connected to the AVR's GPIO pins.\r
- *\r
- *  User code should include this file, which will in turn include the correct Button driver header file for the\r
- *  currently selected board.\r
- *\r
- *  If the BOARD value is set to BOARD_USER, this will include the /Board/Buttons.h file in the user project\r
- *  directory.\r
- */\r
-\r
-/** \ingroup Group_BoardDrivers\r
- *  @defgroup Group_Buttons Buttons Driver - LUFA/Drivers/Board/Buttons.h\r
- *\r
- *  \section Sec_Dependencies Module Source Dependencies\r
- *  The following files must be built with any user project that uses this module:\r
- *    - None\r
- *\r
- *  \section Module Description\r
- *  Hardware buttons driver. This provides an easy to use driver for the hardware buttons present on many boards.\r
- *  It provides a way to easily configure and check the status of all the buttons on the board so that appropriate\r
- *  actions can be taken.\r
- *\r
- *  If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project\r
- *  directory. Otherwise, it will include the appropriate built in board driver header file.\r
- *\r
- *  @{\r
- */\r
-\r
-#ifndef __BUTTONS_H__\r
-#define __BUTTONS_H__\r
-\r
-       /* Macros: */\r
-       #if !defined(__DOXYGEN__)\r
-               #define __INCLUDE_FROM_BUTTONS_H\r
-               #define INCLUDE_FROM_BUTTONS_H\r
-       #endif\r
-\r
-       /* Includes: */\r
-       #include "../../Common/Common.h"\r
-       \r
-       #if (BOARD == BOARD_NONE)\r
-               #error The Board Buttons driver cannot be used if the makefile BOARD option is not set.\r
-       #elif (BOARD == BOARD_USBKEY)\r
-               #include "USBKEY/Buttons.h"\r
-       #elif (BOARD == BOARD_STK525)\r
-               #include "STK525/Buttons.h"\r
-       #elif (BOARD == BOARD_STK526)\r
-               #include "STK526/Buttons.h"\r
-       #elif (BOARD == BOARD_ATAVRUSBRF01)\r
-               #include "ATAVRUSBRF01/Buttons.h"\r
-       #elif (BOARD == BOARD_BUMBLEB)\r
-               #include "BUMBLEB/Buttons.h"\r
-       #elif (BOARD == BOARD_EVK527)\r
-               #include "EVK527/Buttons.h"\r
-       #elif (BOARD == BOARD_USBTINYMKII)\r
-               #include "USBTINYMKII/Buttons.h"                \r
-       #elif (BOARD == BOARD_BENITO)\r
-               #include "BENITO/Buttons.h"\r
-       #elif (BOARD == BOARD_JMDBU2)\r
-               #include "JMDBU2/Buttons.h"\r
-       #elif (BOARD == BOARD_USER)\r
-               #include "Board/Buttons.h"\r
-       #else\r
-               #error The selected board does not contain any GPIO buttons.\r
-       #endif\r
-       \r
-       /* Pseudo-Functions for Doxygen: */\r
-       #if defined(__DOXYGEN__)\r
-               /** Initializes the BUTTONS driver, so that the current button position can be read. This sets the appropriate\r
-                *  I/O pins to an inputs with pull-ups enabled.\r
-                *\r
-                *  This must be called before any Button driver functions are used.\r
-                */\r
-               static inline void Buttons_Init(void);\r
-               \r
-               /** Returns a mask indicating which board buttons are currently pressed.\r
-                *\r
-                *  \return Mask indicating which board buttons are currently pressed\r
-                */\r
-               static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT;\r
-       #endif\r
-\r
-#endif\r
-\r
-/** @} */\r
+/*
+             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.
+ */
+
+/** \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.
+ *
+ *  @{
+ */
+
+#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"
+       #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__)
+               /** 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);
+               
+               /** 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;
+       #endif
+
+#endif
+
+/** @} */