LUFA/Drivers/Board/XMEGA/A3BU_XPLAINED/Buttons.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2020.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2020  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 A3BU Xplained.
  33  *  \copydetails Group_Buttons_A3BU_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_A3BU_XPLAINED A3BU_XPLAINED
  41  *  \brief Board specific Buttons driver header for the Atmel XMEGA A3BU Xplained.
  42  *
  43  *  Board specific Buttons driver header for the Atmel XMEGA A3BU 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>PORTE.5</td></tr>
  48  *    <tr><td>BUTTONS_BUTTON2</td><td>SW1 Button</td><td>Low</td><td>PORTF.1</td></tr>
  49  *    <tr><td>BUTTONS_BUTTON3</td><td>SW2 Button</td><td>Low</td><td>PORTF.2</td></tr>
  50  *  </table>
  51  *
  52  *  @{
  53  */
  54
  55 #ifndef __BUTTONS_A3BU_XPLAINED_H__
  56 #define __BUTTONS_A3BU_XPLAINED_H__
  57
  58         /* Includes: */
  59                 #include <avr/io.h>
  60
  61         /* Enable C linkage for C++ Compilers: */
  62                 #if defined(__cplusplus)
  63                         extern "C" {
  64                 #endif
  65
  66         /* Preprocessor Checks: */
  67                 #if !defined(__INCLUDE_FROM_BUTTONS_H)
  68                         #error Do not include this file directly. Include LUFA/Drivers/Board/Buttons.h instead.
  69                 #endif
  70
  71         /* Public Interface - May be used in end-application: */
  72                 /* Macros: */
  73                         /** Button mask for the first button on the board. */
  74                         #define BUTTONS_BUTTON1          (1 << 5)
  75
  76                         /** Button mask for the second button on the board. */
  77                         #define BUTTONS_BUTTON2          (1 << 1)
  78
  79                         /** Button mask for the third button on the board. */
  80                         #define BUTTONS_BUTTON3          (1 << 2)
  81
  82                 /* Inline Functions: */
  83                 #if !defined(__DOXYGEN__)
  84                         static inline void Buttons_Init(void)
  85                         {
  86                                 PORTE.OUTCLR   = BUTTONS_BUTTON1;
  87                                 PORTE.PIN5CTRL = (PORT_OPC_PULLUP_gc | PORT_INVEN_bm);
  88
  89                                 PORTF.OUTCLR   = (BUTTONS_BUTTON2 | BUTTONS_BUTTON3);
  90                                 PORTF.PIN1CTRL = (PORT_OPC_PULLUP_gc | PORT_INVEN_bm);
  91                                 PORTF.PIN2CTRL = (PORT_OPC_PULLUP_gc | PORT_INVEN_bm);
  92                         }
  93
  94                         static inline void Buttons_Disable(void)
  95                         {
  96                                 PORTE.OUTCLR   = BUTTONS_BUTTON1;
  97                                 PORTE.PIN5CTRL = 0;
  98
  99                                 PORTF.OUTCLR   = (BUTTONS_BUTTON2 | BUTTONS_BUTTON3);
 100                                 PORTF.PIN1CTRL = 0;
 101                                 PORTF.PIN2CTRL = 0;
 102                         }
 103
 104                         static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
 105                         static inline uint8_t Buttons_GetStatus(void)
 106                         {
 107                                 return ((PORTE_IN & BUTTONS_BUTTON1) | (PORTF_IN & (BUTTONS_BUTTON2 | BUTTONS_BUTTON3)));
 108                         }
 109                 #endif
 110
 111         /* Disable C linkage for C++ Compilers: */
 112                 #if defined(__cplusplus)
 113                         }
 114                 #endif
 115
 116 #endif
 117
 118 /** @} */
 119