LUFA/Drivers/Board/Buttons.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2011.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *  \brief Master include file for the board digital button driver.
  33  *
  34  *  This file is the master dispatch header file for the board-specific Buttons driver, for boards containing
  35  *  physical pushbuttons connected to the AVR's GPIO pins.
  36  *
  37  *  User code should include this file, which will in turn include the correct Button driver header file for the
  38  *  currently selected board.
  39  *
  40  *  If the \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/Buttons.h file in the user project
  41  *  directory.
  42  *
  43  *  For possible \c BOARD makefile values, see \ref Group_BoardTypes.
  44  */
  45
  46 /** \ingroup Group_BoardDrivers
  47  *  @defgroup Group_Buttons Buttons Driver - LUFA/Drivers/Board/Buttons.h
  48  *
  49  *  \section Sec_Dependencies Module Source Dependencies
  50  *  The following files must be built with any user project that uses this module:
  51  *    - None
  52  *
  53  *  \section Sec_ModDescription Module Description
  54  *  Hardware buttons driver. This provides an easy to use driver for the hardware buttons present on many boards.
  55  *  It provides a way to easily configure and check the status of all the buttons on the board so that appropriate
  56  *  actions can be taken.
  57  *
  58  *  If the \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/Dataflash.h file in the user project
  59  *  directory. Otherwise, it will include the appropriate built in board driver header file.
  60  *
  61  *  For possible \c BOARD makefile values, see \ref Group_BoardTypes.
  62  *
  63  *  \section Sec_ExampleUsage Example Usage
  64  *  The following snippet is an example of how this module may be used within a typical
  65  *  application.
  66  *
  67  *  \code
  68  *      // Initialise the button driver before first use
  69  *      Buttons_Init();
  70  *
  71  *      printf("Waiting for button press...\r\n");
  72  *
  73  *      // Loop until a board button has been pressed
  74  *      uint8_t ButtonPress;
  75  *      while (!(ButtonPress = Buttons_GetStatus())) {};
  76  *
  77  *      // Display which button was pressed (assuming two board buttons)
  78  *      printf("Button pressed: %s\r\n", (ButtonPress == BUTTONS_BUTTON1) ? "Button 1" : "Button 2");
  79  *  \endcode
  80  *
  81  *  @{
  82  */
  83
  84 #ifndef __BUTTONS_H__
  85 #define __BUTTONS_H__
  86
  87         /* Macros: */
  88         #if !defined(__DOXYGEN__)
  89                 #define __INCLUDE_FROM_BUTTONS_H
  90                 #define INCLUDE_FROM_BUTTONS_H
  91         #endif
  92
  93         /* Includes: */
  94         #include "../../Common/Common.h"
  95
  96         #if (BOARD == BOARD_NONE)
  97                 #error The Board Buttons driver cannot be used if the makefile BOARD option is not set.
  98         #elif (BOARD == BOARD_USBKEY)
  99                 #include "USBKEY/Buttons.h"
 100         #elif (BOARD == BOARD_STK525)
 101                 #include "STK525/Buttons.h"
 102         #elif (BOARD == BOARD_STK526)
 103                 #include "STK526/Buttons.h"
 104         #elif (BOARD == BOARD_ATAVRUSBRF01)
 105                 #include "ATAVRUSBRF01/Buttons.h"
 106         #elif (BOARD == BOARD_BUMBLEB)
 107                 #include "BUMBLEB/Buttons.h"
 108         #elif (BOARD == BOARD_EVK527)
 109                 #include "EVK527/Buttons.h"
 110         #elif (BOARD == BOARD_USBTINYMKII)
 111                 #include "USBTINYMKII/Buttons.h"
 112         #elif (BOARD == BOARD_BENITO)
 113                 #include "BENITO/Buttons.h"
 114         #elif (BOARD == BOARD_JMDBU2)
 115                 #include "JMDBU2/Buttons.h"
 116         #elif (BOARD == BOARD_OLIMEX162)
 117                 #include "OLIMEX162/Buttons.h"
 118         #elif (BOARD == BOARD_USBFOO)
 119                 #include "USBFOO/Buttons.h"
 120         #elif (BOARD == BOARD_UDIP)
 121                 #include "UDIP/Buttons.h"
 122         #elif (BOARD == BOARD_CULV3)
 123                 #include "CULV3/Buttons.h"
 124         #elif (BOARD == BOARD_MINIMUS)
 125                 #include "MINIMUS/Buttons.h"
 126         #elif (BOARD == BOARD_MICROSIN162)
 127                 #include "MICROSIN162/Buttons.h"
 128         #elif (BOARD == BOARD_USER)
 129                 #include "Board/Buttons.h"
 130         #else
 131                 #error The selected board does not contain any GPIO buttons.
 132         #endif
 133
 134         /* Pseudo-Functions for Doxygen: */
 135         #if defined(__DOXYGEN__)
 136                 /** Initialises the BUTTONS driver, so that the current button position can be read. This sets the appropriate
 137                  *  I/O pins to an inputs with pull-ups enabled.
 138                  *
 139                  *  This must be called before any Button driver functions are used.
 140                  */
 141                 static inline void Buttons_Init(void);
 142
 143                 /** Returns a mask indicating which board buttons are currently pressed.
 144                  *
 145                  *  \return Mask indicating which board buttons are currently pressed.
 146                  */
 147                 static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
 148         #endif
 149
 150 #endif
 151
 152 /** @} */
 153