Make sure that the NVM bus/controller busy waits in the AVRISP MKII clone project...

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

diff --git a/LUFA/Drivers/Board/Buttons.h b/LUFA/Drivers/Board/Buttons.h
index 46d1473..0077df3 100644 (file)
--- a/LUFA/Drivers/Board/Buttons.h
+++ b/LUFA/Drivers/Board/Buttons.h
@@ -1,21 +1,21 @@
 /*\r
              LUFA Library\r
 /*\r
              LUFA Library\r

-     Copyright (C) Dean Camera, 2009.\r
+     Copyright (C) Dean Camera, 2010.\r

               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r

-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r

 \r
 \r

-  Permission to use, copy, modify, and distribute this software\r
-  and its documentation for any purpose and without fee is hereby\r
-  granted, provided that the above copyright notice appear in all\r
-  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
+  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 without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r


@@ -29,6 +29,7 @@
 */\r
 \r
 /** \file\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
  *  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


@@ -48,7 +49,9 @@
  *    - None\r
  *\r
  *  \section Module Description\r
  *    - None\r
  *\r
  *  \section Module Description\r

- *  Functions, macros, variables, enums and types related to the control of physical board GPIO buttons.\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
  *  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


@@ -61,25 +64,35 @@
 \r
        /* Macros: */\r
        #if !defined(__DOXYGEN__)\r
 \r
        /* Macros: */\r
        #if !defined(__DOXYGEN__)\r

+               #define __INCLUDE_FROM_BUTTONS_H\r

                #define INCLUDE_FROM_BUTTONS_H\r
                #define INCLUDE_FROM_BUTTONS_H\r

-               #define INCLUDE_FROM_BOARD_DRIVER\r

        #endif\r
 \r
        /* Includes: */\r
        #include "../../Common/Common.h"\r
        \r
        #endif\r
 \r
        /* Includes: */\r
        #include "../../Common/Common.h"\r
        \r

-       #if !defined(BOARD)\r
-               #error BOARD must be set in makefile to a value specified in BoardTypes.h.\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
        #elif (BOARD == BOARD_USBKEY)\r

-               #include "USBKEY/BUTTONS.h"\r
+               #include "USBKEY/Buttons.h"\r

        #elif (BOARD == BOARD_STK525)\r
        #elif (BOARD == BOARD_STK525)\r

-               #include "STK525/BUTTONS.h"\r
+               #include "STK525/Buttons.h"\r

        #elif (BOARD == BOARD_STK526)\r
        #elif (BOARD == BOARD_STK526)\r

-               #include "STK526/BUTTONS.h"\r
+               #include "STK526/Buttons.h"\r

        #elif (BOARD == BOARD_ATAVRUSBRF01)\r
        #elif (BOARD == BOARD_ATAVRUSBRF01)\r

-               #include "ATAVRUSBRF01/BUTTONS.h"\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
        #elif (BOARD == BOARD_USER)\r

-               #include "Board/BUTTONS.h"              \r
+               #include "Board/Buttons.h"\r

        #else\r
                #error The selected board does not contain any GPIO buttons.\r
        #endif\r
        #else\r
                #error The selected board does not contain any GPIO buttons.\r
        #endif\r