protocol/lufa/LUFA-120730/LUFA/Drivers/Board/AVR8/CULV3/Buttons.h

   1 /*\r
   2              LUFA Library\r
   3      Copyright (C) Dean Camera, 2012.\r
   4 \r
   5   dean [at] fourwalledcubicle [dot] com\r
   6            www.lufa-lib.org\r
   7 */\r
   8 \r
   9 /*\r
  10   Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
  11 \r
  12   Permission to use, copy, modify, distribute, and sell this\r
  13   software and its documentation for any purpose is hereby granted\r
  14   without fee, provided that the above copyright notice appear in\r
  15   all copies and that both that the copyright notice and this\r
  16   permission notice and warranty disclaimer appear in supporting\r
  17   documentation, and that the name of the author not be used in\r
  18   advertising or publicity pertaining to distribution of the\r
  19   software without specific, written prior permission.\r
  20 \r
  21   The author disclaim all warranties with regard to this\r
  22   software, including all implied warranties of merchantability\r
  23   and fitness.  In no event shall the author be liable for any\r
  24   special, indirect or consequential damages or any damages\r
  25   whatsoever resulting from loss of use, data or profits, whether\r
  26   in an action of contract, negligence or other tortious action,\r
  27   arising out of or in connection with the use or performance of\r
  28   this software.\r
  29 */\r
  30 \r
  31 /** \file\r
  32  *  \brief Board specific LED driver header for the Busware CULV3.\r
  33  *  \copydetails Group_LEDs_CULV3\r
  34  *\r
  35  *  \note This file should not be included directly. It is automatically included as needed by the Buttons driver\r
  36  *        dispatch header located in LUFA/Drivers/Board/LEDs.h.\r
  37  */\r
  38 \r
  39 /** \ingroup Group_Buttons\r
  40  *  \defgroup Group_Buttons_CULV3 CULV3\r
  41  *  \brief Board specific Buttons driver header for the Busware CULV3.\r
  42  *\r
  43  *  Board specific Buttons driver header for the Busware CUL V3 (http://busware.de/tiki-index.php?page=CUL).\r
  44  *\r
  45  *  <table>\r
  46  *    <tr><th>Name</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr>\r
  47  *    <tr><td>BUTTONS_BUTTON1</td><td>HWB Button</td><td>Low</td><td>PORTE.2</td></tr>\r
  48  *  </table>\r
  49  *\r
  50  *  @{\r
  51  */\r
  52 \r
  53 #ifndef __BUTTONS_CULV3_H__\r
  54 #define __BUTTONS_CULV3_H__\r
  55 \r
  56         /* Includes: */\r
  57                 #include "../../../../Common/Common.h"\r
  58 \r
  59         /* Enable C linkage for C++ Compilers: */\r
  60                 #if defined(__cplusplus)\r
  61                         extern "C" {\r
  62                 #endif\r
  63 \r
  64         /* Preprocessor Checks: */\r
  65                 #if !defined(__INCLUDE_FROM_BUTTONS_H)\r
  66                         #error Do not include this file directly. Include LUFA/Drivers/Board/Buttons.h instead.\r
  67                 #endif\r
  68 \r
  69         /* Public Interface - May be used in end-application: */\r
  70                 /* Macros: */\r
  71                         /** Button mask for the first button on the board. */\r
  72                         #define BUTTONS_BUTTON1      (1 << 2)\r
  73 \r
  74                 /* Inline Functions: */\r
  75                 #if !defined(__DOXYGEN__)\r
  76                         static inline void Buttons_Init(void)\r
  77                         {\r
  78                                 DDRE  &= ~BUTTONS_BUTTON1;\r
  79                                 PORTE |=  BUTTONS_BUTTON1;\r
  80                         }\r
  81 \r
  82                         static inline void Buttons_Disable(void)\r
  83                         {\r
  84                                 DDRE  &= ~BUTTONS_BUTTON1;\r
  85                                 PORTE &= ~BUTTONS_BUTTON1;\r
  86                         }\r
  87 \r
  88                         static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT;\r
  89                         static inline uint8_t Buttons_GetStatus(void)\r
  90                         {\r
  91                                 return ((PINE & BUTTONS_BUTTON1) ^ BUTTONS_BUTTON1);\r
  92                         }\r
  93                 #endif\r
  94 \r
  95         /* Disable C linkage for C++ Compilers: */\r
  96                 #if defined(__cplusplus)\r
  97                         }\r
  98                 #endif\r
  99 \r
 100 #endif\r
 101 \r
 102 /** @} */\r
 103 \r