LUFA/CodeTemplates/DriverStubs/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 /*
  32    This is a stub driver header file, for implementing custom board
  33    layout hardware with compatible LUFA board specific drivers. If
  34    the library is configured to use the BOARD_USER board mode, this
  35    driver file should be completed and copied into the "/Board/" folder
  36    inside the application's folder.
  37
  38    This stub is for the board-specific component of the LUFA Buttons driver,
  39    for the control of physical board-mounted GPIO pushbuttons.
  40 */
  41
  42 #ifndef __BUTTONS_USER_H__
  43 #define __BUTTONS_USER_H__
  44
  45         /* Includes: */
  46                 #include <avr/io.h>
  47                 #include <stdbool.h>
  48
  49                 // TODO: Add any required includes here
  50
  51         /* Enable C linkage for C++ Compilers: */
  52                 #if defined(__cplusplus)
  53                         extern "C" {
  54                 #endif
  55
  56         /* Preprocessor Checks: */
  57                 #if !defined(__INCLUDE_FROM_BUTTONS_H)
  58                         #error Do not include this file directly. Include LUFA/Drivers/Board/Buttons.h instead.
  59                 #endif
  60
  61         /* Public Interface - May be used in end-application: */
  62                 /* Macros: */
  63                         /** Button mask for the first button on the board. */
  64                         #define BUTTONS_BUTTON1          // TODO: Add mask for first board button here
  65
  66                 /* Inline Functions: */
  67                 #if !defined(__DOXYGEN__)
  68                         static inline void Buttons_Init(void)
  69                         {
  70                                 // TODO: Initialize the appropriate port pins as an inputs here, with pull-ups
  71                         }
  72
  73                         static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
  74                         static inline uint8_t Buttons_GetStatus(void)
  75                         {
  76                                 // TODO: Return current button status here, debounced if required
  77                         }
  78                 #endif
  79
  80         /* Disable C linkage for C++ Compilers: */
  81                 #if defined(__cplusplus)
  82                         }
  83                 #endif
  84
  85 #endif
  86