LUFA/Drivers/Board/Buttons.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   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  *
  33  *  This file is the master dispatch header file for the board-specific Buttons driver, for boards containing
  34  *  physical pushbuttons connected to the AVR's GPIO pins.
  35  *
  36  *  User code should include this file, which will in turn include the correct Button driver header file for the
  37  *  currently selected board.
  38  *
  39  *  If the BOARD value is set to BOARD_USER, this will include the /Board/Buttons.h file in the user project
  40  *  directory.
  41  */
  42
  43 /** \ingroup Group_BoardDrivers
  44  *  @defgroup Group_Buttons Buttons Driver - LUFA/Drivers/Board/Buttons.h
  45  *
  46  *  \section Sec_Dependencies Module Source Dependencies
  47  *  The following files must be built with any user project that uses this module:
  48  *    - None
  49  *
  50  *  \section Module Description
  51  *  Hardware buttons driver. This provides an easy to use driver for the hardware buttons present on many boards.
  52  *  It provides a way to easily configure and check the status of all the buttons on the board so that appropriate
  53  *  actions can be taken.
  54  *
  55  *  If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project
  56  *  directory. Otherwise, it will include the appropriate built in board driver header file.
  57  *
  58  *  @{
  59  */
  60
  61 #ifndef __BUTTONS_H__
  62 #define __BUTTONS_H__
  63
  64         /* Macros: */
  65         #if !defined(__DOXYGEN__)
  66                 #define INCLUDE_FROM_BUTTONS_H
  67                 #define INCLUDE_FROM_BOARD_DRIVER
  68         #endif
  69
  70         /* Includes: */
  71         #include "../../Common/Common.h"
  72
  73         #if !defined(BOARD)
  74                 #error BOARD must be set in makefile to a value specified in BoardTypes.h.
  75         #elif (BOARD == BOARD_USBKEY)
  76                 #include "USBKEY/Buttons.h"
  77         #elif (BOARD == BOARD_STK525)
  78                 #include "STK525/Buttons.h"
  79         #elif (BOARD == BOARD_STK526)
  80                 #include "STK526/Buttons.h"
  81         #elif (BOARD == BOARD_ATAVRUSBRF01)
  82                 #include "ATAVRUSBRF01/Buttons.h"
  83         #elif (BOARD == BOARD_USER)
  84                 #include "Board/Buttons.h"
  85         #else
  86                 #error The selected board does not contain any GPIO buttons.
  87         #endif
  88
  89         /* Pseudo-Functions for Doxygen: */
  90         #if defined(__DOXYGEN__)
  91                 /** Initializes the BUTTONS driver, so that the current button position can be read. This sets the appropriate
  92                  *  I/O pins to an inputs with pull-ups enabled.
  93                  *
  94                  *  This must be called before any Button driver functions are used.
  95                  */
  96                 static inline void Buttons_Init(void);
  97
  98                 /** Returns a mask indicating which board buttons are currently pressed.
  99                  *
 100                  *  \return Mask indicating which board buttons are currently pressed
 101                  */
 102                 static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
 103         #endif
 104
 105 #endif
 106
 107 /** @} */