LUFA/Drivers/Board/Buttons.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  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 BOARD value is set to BOARD_USER, this will include the /Board/Buttons.h file in the user project
  41  *  directory.
  42  */
  43
  44 /** \ingroup Group_BoardDrivers
  45  *  @defgroup Group_Buttons Buttons Driver - LUFA/Drivers/Board/Buttons.h
  46  *
  47  *  \section Sec_Dependencies Module Source Dependencies
  48  *  The following files must be built with any user project that uses this module:
  49  *    - None
  50  *
  51  *  \section Module Description
  52  *  Hardware buttons driver. This provides an easy to use driver for the hardware buttons present on many boards.
  53  *  It provides a way to easily configure and check the status of all the buttons on the board so that appropriate
  54  *  actions can be taken.
  55  *
  56  *  If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project
  57  *  directory. Otherwise, it will include the appropriate built in board driver header file.
  58  *
  59  *  @{
  60  */
  61
  62 #ifndef __BUTTONS_H__
  63 #define __BUTTONS_H__
  64
  65         /* Macros: */
  66         #if !defined(__DOXYGEN__)
  67                 #define __INCLUDE_FROM_BUTTONS_H
  68                 #define INCLUDE_FROM_BUTTONS_H
  69         #endif
  70
  71         /* Includes: */
  72         #include "../../Common/Common.h"
  73
  74         #if (BOARD == BOARD_NONE)
  75                 #error The Board Buttons driver cannot be used if the makefile BOARD option is not set.
  76         #elif (BOARD == BOARD_USBKEY)
  77                 #include "USBKEY/Buttons.h"
  78         #elif (BOARD == BOARD_STK525)
  79                 #include "STK525/Buttons.h"
  80         #elif (BOARD == BOARD_STK526)
  81                 #include "STK526/Buttons.h"
  82         #elif (BOARD == BOARD_ATAVRUSBRF01)
  83                 #include "ATAVRUSBRF01/Buttons.h"
  84         #elif (BOARD == BOARD_BUMBLEB)
  85                 #include "BUMBLEB/Buttons.h"
  86         #elif (BOARD == BOARD_EVK527)
  87                 #include "EVK527/Buttons.h"
  88         #elif (BOARD == BOARD_USBTINYMKII)
  89                 #include "USBTINYMKII/Buttons.h"
  90         #elif (BOARD == BOARD_BENITO)
  91                 #include "BENITO/Buttons.h"
  92         #elif (BOARD == BOARD_JMDBU2)
  93                 #include "JMDBU2/Buttons.h"
  94         #elif (BOARD == BOARD_USER)
  95                 #include "Board/Buttons.h"
  96         #else
  97                 #error The selected board does not contain any GPIO buttons.
  98         #endif
  99
 100         /* Pseudo-Functions for Doxygen: */
 101         #if defined(__DOXYGEN__)
 102                 /** Initialises the BUTTONS driver, so that the current button position can be read. This sets the appropriate
 103                  *  I/O pins to an inputs with pull-ups enabled.
 104                  *
 105                  *  This must be called before any Button driver functions are used.
 106                  */
 107                 static inline void Buttons_Init(void);
 108
 109                 /** Returns a mask indicating which board buttons are currently pressed.
 110                  *
 111                  *  \return Mask indicating which board buttons are currently pressed.
 112                  */
 113                 static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
 114         #endif
 115
 116 #endif
 117
 118 /** @} */