Update Studio Integration DLL, to include package logging.

[pub/USBasp.git] / LUFA / Drivers / Board / Buttons.h

diff --git a/LUFA/Drivers/Board/Buttons.h b/LUFA/Drivers/Board/Buttons.h
index c3d6c0d..6f3bf15 100644 (file)
--- a/LUFA/Drivers/Board/Buttons.h
+++ b/LUFA/Drivers/Board/Buttons.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2012.
+     Copyright (C) Dean Camera, 2015.

 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*

-  Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2015  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
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted


@@ -18,7 +18,7 @@
   advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 
   advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 

-  The author disclaim all warranties with regard to this
+  The author disclaims 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
   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


@@ -47,21 +47,21 @@
  *  \defgroup Group_Buttons Buttons Driver - LUFA/Drivers/Board/Buttons.h
  *  \brief Digital button board hardware driver.
  *
  *  \defgroup Group_Buttons Buttons Driver - LUFA/Drivers/Board/Buttons.h
  *  \brief Digital button board hardware driver.
  *

- *  \section Sec_Dependencies Module Source Dependencies
+ *  \section Sec_Buttons_Dependencies Module Source Dependencies

  *  The following files must be built with any user project that uses this module:
  *    - None
  *
  *  The following files must be built with any user project that uses this module:
  *    - None
  *

- *  \section Sec_ModDescription Module Description
+ *  \section Sec_Buttons_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 \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/Buttons.h file in the user project
  *  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 \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.
+ *  directory. Otherwise, it will include the appropriate built-in board driver header file.

  *
  *  For possible \c BOARD makefile values, see \ref Group_BoardTypes.
  *
  *
  *  For possible \c BOARD makefile values, see \ref Group_BoardTypes.
  *

- *  \section Sec_ExampleUsage Example Usage
+ *  \section Sec_Buttons_ExampleUsage Example Usage

  *  The following snippet is an example of how this module may be used within a typical
  *  application.
  *
  *  The following snippet is an example of how this module may be used within a typical
  *  application.
  *


@@ -92,7 +92,9 @@
                #include "../../Common/Common.h"
 
                #if (BOARD == BOARD_NONE)
                #include "../../Common/Common.h"
 
                #if (BOARD == BOARD_NONE)

-                       #error The Board Buttons driver cannot be used if the makefile BOARD option is not set.
+                       #define BUTTONS_BUTTON1  0
+                       static inline void       Buttons_Init(void) {};
+                       static inline uint_reg_t Buttons_GetStatus(void) { return 0; };

                #elif (BOARD == BOARD_USBKEY)
                        #include "AVR8/USBKEY/Buttons.h"
                #elif (BOARD == BOARD_STK525)
                #elif (BOARD == BOARD_USBKEY)
                        #include "AVR8/USBKEY/Buttons.h"
                #elif (BOARD == BOARD_STK525)


@@ -144,9 +146,19 @@
                #elif (BOARD == BOARD_B1_XPLAINED)
                        #include "XMEGA/B1_XPLAINED/Buttons.h"
                #elif (BOARD == BOARD_OLIMEX32U4)
                #elif (BOARD == BOARD_B1_XPLAINED)
                        #include "XMEGA/B1_XPLAINED/Buttons.h"
                #elif (BOARD == BOARD_OLIMEX32U4)

-                       #include "AVR8/OLIMEX32U4/Buttons.h"            
+                       #include "AVR8/OLIMEX32U4/Buttons.h"

                #elif (BOARD == BOARD_OLIMEXT32U4)
                #elif (BOARD == BOARD_OLIMEXT32U4)

-                       #include "AVR8/OLIMEXT32U4/Buttons.h"           
+                       #include "AVR8/OLIMEXT32U4/Buttons.h"
+               #elif (BOARD == BOARD_OLIMEXISPMK2)
+                       #include "AVR8/OLIMEXISPMK2/Buttons.h"
+               #elif (BOARD == BOARD_UC3A3_XPLAINED)
+                       #include "UC3/UC3A3_XPLAINED/Buttons.h"
+               #elif (BOARD == BOARD_STANGE_ISP)
+                       #include "AVR8/STANGE_ISP/Buttons.h"
+               #elif (BOARD == BOARD_C3_XPLAINED)
+                       #include "XMEGA/C3_XPLAINED/Buttons.h"
+               #elif (BOARD == BOARD_U2S)
+                       #include "AVR8/U2S/Buttons.h"

                #else
                        #include "Board/Buttons.h"
                #endif
                #else
                        #include "Board/Buttons.h"
                #endif


@@ -160,12 +172,12 @@
                 */
                static inline void Buttons_Init(void);
 
                 */
                static inline void Buttons_Init(void);
 

-               /** Disables the buttons driver, releasing the I/O pins back to their default high-impedence input mode. */
+               /** 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.
                 *
                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.
+                *  \return Mask of \c BUTTONS_BUTTON* constants indicating which board buttons are currently pressed.

                 */
                static inline uint_reg_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
        #endif
                 */
                static inline uint_reg_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
        #endif