LUFA/Drivers/Board/AVR8/STK525/Joystick.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2016.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2016  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 joystick driver header for the Atmel STK525.
  33  *  \copydetails Group_Joystick_STK525
  34  *
  35  *  \note This file should not be included directly. It is automatically included as needed by the joystick driver
  36  *        dispatch header located in LUFA/Drivers/Board/Joystick.h.
  37  */
  38
  39 /** \ingroup Group_Joystick
  40  *  \defgroup Group_Joystick_STK525 STK525
  41  *  \brief Board specific joystick driver header for the Atmel STK525.
  42  *
  43  *  Board specific joystick driver header for the Atmel STK525.
  44  *
  45  *  <table>
  46  *    <tr><th>Left Port Pin</th><th>Up Port Pin</th><th>Right Port Pin</th><th>Down Port Pin</th><th>Press Port Pin</th></tr>
  47  *    <tr><td>PORTB.6</td><td>PORTB.7</td><td>PORTE.4</td><td>PORTE.5</td><td>PORTB.5</td></tr>
  48  *  </table>
  49  *
  50  *  @{
  51  */
  52
  53 #ifndef __JOYSTICK_STK525_H__
  54 #define __JOYSTICK_STK525_H__
  55
  56         /* Includes: */
  57                 #include "../../../../Common/Common.h"
  58
  59         /* Enable C linkage for C++ Compilers: */
  60                 #if defined(__cplusplus)
  61                         extern "C" {
  62                 #endif
  63
  64         /* Preprocessor Checks: */
  65                 #if !defined(__INCLUDE_FROM_JOYSTICK_H)
  66                         #error Do not include this file directly. Include LUFA/Drivers/Board/Joystick.h instead.
  67                 #endif
  68
  69         /* Private Interface - For use in library only: */
  70         #if !defined(__DOXYGEN__)
  71                 /* Macros: */
  72                         #define JOY_BMASK                 ((1 << 5) | (1 << 6) | (1 << 7))
  73                         #define JOY_EMASK                 ((1 << 4) | (1 << 5))
  74
  75                         #define JOY_PORTE_MASK_SHIFT      1
  76         #endif
  77
  78         /* Public Interface - May be used in end-application: */
  79                 /* Macros: */
  80                         /** Mask for the joystick being pushed in the left direction. */
  81                         #define JOY_LEFT                  (1 << 6)
  82
  83                         /** Mask for the joystick being pushed in the right direction. */
  84                         #define JOY_RIGHT                ((1 << 4) >> JOY_PORTE_MASK_SHIFT)
  85
  86                         /** Mask for the joystick being pushed in the upward direction. */
  87                         #define JOY_UP                    (1 << 7)
  88
  89                         /** Mask for the joystick being pushed in the downward direction. */
  90                         #define JOY_DOWN                 ((1 << 5) >> JOY_PORTE_MASK_SHIFT)
  91
  92                         /** Mask for the joystick being pushed inward. */
  93                         #define JOY_PRESS                 (1 << 5)
  94
  95                 /* Inline Functions: */
  96                 #if !defined(__DOXYGEN__)
  97                         static inline void Joystick_Init(void)
  98                         {
  99                                 DDRB  &= ~JOY_BMASK;
 100                                 DDRE  &= ~JOY_EMASK;
 101
 102                                 PORTB |=  JOY_BMASK;
 103                                 PORTE |=  JOY_EMASK;
 104                         }
 105
 106                         static inline void Joystick_Disable(void)
 107                         {
 108                                 DDRB  &= ~JOY_BMASK;
 109                                 DDRE  &= ~JOY_EMASK;
 110
 111                                 PORTB &= ~JOY_BMASK;
 112                                 PORTE &= ~JOY_EMASK;
 113                         }
 114
 115                         static inline uint8_t Joystick_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
 116                         static inline uint8_t Joystick_GetStatus(void)
 117                         {
 118                                 return (((uint8_t)~PINB & JOY_BMASK) | (((uint8_t)~PINE & JOY_EMASK) >> JOY_PORTE_MASK_SHIFT));
 119                         }
 120                 #endif
 121
 122         /* Disable C linkage for C++ Compilers: */
 123                 #if defined(__cplusplus)
 124                         }
 125                 #endif
 126
 127 #endif
 128
 129 /** @} */
 130