protocol/lufa/LUFA-120730/LUFA/Drivers/Board/AVR8/BUMBLEB/Joystick.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2012.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2012  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 /** \file
  32  *  \brief Board specific joystick driver header for the Fletchtronics BUMBLEB.
  33  *  \copydetails Group_Joystick_BUMBLEB
  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_BUMBLEB BUMBLEB
  41  *  \brief Board specific joystick driver header for the Fletchtronics BUMBLEB.
  42  *
  43  *  Board specific joystick driver header for the Fletchtronics BUMBLEB (http://fletchtronics.net/bumble-b). The BUMBLEB
  44  *  third-party board does not include any on-board peripherals, but does have an officially recommended external peripheral
  45  *  layout for buttons, LEDs and a Joystick.
  46  *
  47  *  <table>
  48  *    <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>
  49  *    <tr><td>PORTD.2</td><td>PORTD.3</td><td>PORTD.0</td><td>PORTD.1</td><td>PORTD.4</td></tr>
  50  *  </table>
  51  *
  52  *  @{
  53  */
  54
  55 #ifndef __JOYSTICK_BUMBLEB_H__
  56 #define __JOYSTICK_BUMBLEB_H__
  57
  58         /* Includes: */
  59                 #include "../../../../Common/Common.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_JOYSTICK_H)
  68                         #error Do not include this file directly. Include LUFA/Drivers/Board/Joystick.h instead.
  69                 #endif
  70
  71         /* Private Interface - For use in library only: */
  72         #if !defined(__DOXYGEN__)
  73                 /* Macros: */
  74                         #define JOY_MASK                 ((1 << 0) | (1 << 1) | (1 << 2) | (1 << 3) | (1 << 4))
  75         #endif
  76
  77         /* Public Interface - May be used in end-application: */
  78                 /* Macros: */
  79                         /** Mask for the joystick being pushed in the left direction. */
  80                         #define JOY_LEFT                  (1 << 2)
  81
  82                         /** Mask for the joystick being pushed in the upward direction. */
  83                         #define JOY_UP                    (1 << 3)
  84
  85                         /** Mask for the joystick being pushed in the right direction. */
  86                         #define JOY_RIGHT                 (1 << 0)
  87
  88                         /** Mask for the joystick being pushed in the downward direction. */
  89                         #define JOY_DOWN                  (1 << 1)
  90
  91                         /** Mask for the joystick being pushed inward. */
  92                         #define JOY_PRESS                 (1 << 4)
  93
  94                 /* Inline Functions: */
  95                 #if !defined(__DOXYGEN__)
  96                         static inline void Joystick_Init(void)
  97                         {
  98                                 DDRD  &= ~JOY_MASK;
  99                                 PORTD |=  JOY_MASK;
 100                         }
 101
 102                         static inline void Joystick_Disable(void)
 103                         {
 104                                 DDRD  &= ~JOY_MASK;
 105                                 PORTD &= ~JOY_MASK;
 106                         }
 107
 108                         static inline uint8_t Joystick_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
 109                         static inline uint8_t Joystick_GetStatus(void)
 110                         {
 111                                 return (uint8_t)(~PIND & JOY_MASK);
 112                         }
 113                 #endif
 114
 115         /* Disable C linkage for C++ Compilers: */
 116                 #if defined(__cplusplus)
 117                         }
 118                 #endif
 119
 120 #endif
 121
 122 /** @} */
 123