tmk_core/protocol/lufa/LUFA-git/LUFA/Drivers/Board/XMEGA/C3_XPLAINED/Buttons.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2014.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2014  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 disclaims 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 Board specific Buttons driver header for the Atmel XMEGA C3 Xplained.
  33  *  \copydetails Group_Buttons_C3_XPLAINED
  34  *
  35  *  \note This file should not be included directly. It is automatically included as needed by the Buttons driver
  36  *        dispatch header located in LUFA/Drivers/Board/Buttons.h.
  37  */
  38
  39 /** \ingroup Group_Buttons
  40  *  \defgroup Group_Buttons_C3_XPLAINED C3_XPLAINED
  41  *  \brief Board specific Buttons driver header for the Atmel XMEGA C3 Xplained.
  42  *
  43  *  Board specific Buttons driver header for the Atmel XMEGA C3 Xplained.
  44  *
  45  *  <table>
  46  *    <tr><th>Name</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr>
  47  *    <tr><td>BUTTONS_BUTTON1</td><td>SW0 Button</td><td>Low</td><td>PORTF.1</td></tr>
  48  *    <tr><td>BUTTONS_BUTTON2</td><td>SW1 Button</td><td>Low</td><td>PORTF.2</td></tr>
  49  *  </table>
  50  *
  51  *  @{
  52  */
  53
  54 #ifndef __BUTTONS_C3_XPLAINED_H__
  55 #define __BUTTONS_C3_XPLAINED_H__
  56
  57         /* Includes: */
  58                 #include <avr/io.h>
  59
  60         /* Enable C linkage for C++ Compilers: */
  61                 #if defined(__cplusplus)
  62                         extern "C" {
  63                 #endif
  64
  65         /* Preprocessor Checks: */
  66                 #if !defined(__INCLUDE_FROM_BUTTONS_H)
  67                         #error Do not include this file directly. Include LUFA/Drivers/Board/Buttons.h instead.
  68                 #endif
  69
  70         /* Public Interface - May be used in end-application: */
  71                 /* Macros: */
  72                         /** Button mask for the first button on the board. */
  73                         #define BUTTONS_BUTTON1          (1 << 1)
  74
  75                         /** Button mask for the second button on the board. */
  76                         #define BUTTONS_BUTTON2          (1 << 2)
  77
  78                 /* Inline Functions: */
  79                 #if !defined(__DOXYGEN__)
  80                         static inline void Buttons_Init(void)
  81                         {
  82                                 PORTF.OUTCLR   = (BUTTONS_BUTTON1 | BUTTONS_BUTTON2);
  83                                 PORTF.PIN1CTRL = (PORT_OPC_PULLUP_gc | PORT_INVEN_bm);
  84                                 PORTF.PIN2CTRL = (PORT_OPC_PULLUP_gc | PORT_INVEN_bm);
  85                         }
  86
  87                         static inline void Buttons_Disable(void)
  88                         {
  89                                 PORTF.OUTCLR   = (BUTTONS_BUTTON1 | BUTTONS_BUTTON2);
  90                                 PORTF.PIN1CTRL = 0;
  91                                 PORTF.PIN2CTRL = 0;
  92                         }
  93
  94                         static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
  95                         static inline uint8_t Buttons_GetStatus(void)
  96                         {
  97                                 return (PORTF_IN & (BUTTONS_BUTTON1 | BUTTONS_BUTTON2));
  98                         }
  99                 #endif
 100
 101         /* Disable C linkage for C++ Compilers: */
 102                 #if defined(__cplusplus)
 103                         }
 104                 #endif
 105
 106 #endif
 107
 108 /** @} */
 109