LUFA/Drivers/Board/BUMBLEB/Joystick.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  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 BUMLEB.
  33  *
  34  *  Board specific joystick driver header for the BUMBLEB (http://fletchtronics.net/bumble-b).
  35  *
  36  *  The BUMBLEB third-party board does not include any on-board peripherals, but does have an officially recommended
  37  *  external peripheral layout for buttons, LEDs and a Joystick.
  38  *
  39  *  \note This file should not be included directly. It is automatically included as needed by the joystick driver
  40  *        dispatch header located in LUFA/Drivers/Board/Joystick.h.
  41  */
  42
  43 /** \ingroup Group_Joystick
  44  *  @defgroup Group_Joystick_BUMBLEB BUMBLEB
  45  *
  46  *  Board specific joystick driver header for the BUMBLEB (http://fletchtronics.net/bumble-b). The BUMBLEB third-party
  47  *  board does not include any on-board peripherals, but does have an officially recommended external peripheral layout
  48  *  for buttons, LEDs and a Joystick.
  49  *
  50  *  \note This file should not be included directly. It is automatically included as needed by the joystick driver
  51  *        dispatch header located in LUFA/Drivers/Board/Joystick.h.
  52  *
  53  *  @{
  54  */
  55
  56 #ifndef __JOYSTICK_BUMBLEB_H__
  57 #define __JOYSTICK_BUMBLEB_H__
  58
  59         /* Includes: */
  60                 #include <avr/io.h>
  61
  62                 #include "../../../Common/Common.h"
  63
  64         /* Enable C linkage for C++ Compilers: */
  65                 #if defined(__cplusplus)
  66                         extern "C" {
  67                 #endif
  68
  69         /* Preprocessor Checks: */
  70                 #if !defined(__INCLUDE_FROM_JOYSTICK_H)
  71                         #error Do not include this file directly. Include LUFA/Drivers/Board/Joystick.h instead.
  72                 #endif
  73
  74         /* Private Interface - For use in library only: */
  75         #if !defined(__DOXYGEN__)
  76                 /* Macros: */
  77                         #define JOY_MASK                 ((1 << 0) | (1 << 1) | (1 << 2) | (1 << 3) | (1 << 4))
  78         #endif
  79
  80         /* Public Interface - May be used in end-application: */
  81                 /* Macros: */
  82                         /** Mask for the joystick being pushed in the left direction. */
  83                         #define JOY_LEFT                  (1 << 2)
  84
  85                         /** Mask for the joystick being pushed in the upward direction. */
  86                         #define JOY_UP                    (1 << 3)
  87
  88                         /** Mask for the joystick being pushed in the right direction. */
  89                         #define JOY_RIGHT                 (1 << 0)
  90
  91                         /** Mask for the joystick being pushed in the downward direction. */
  92                         #define JOY_DOWN                  (1 << 1)
  93
  94                         /** Mask for the joystick being pushed inward. */
  95                         #define JOY_PRESS                 (1 << 4)
  96
  97                 /* Inline Functions: */
  98                 #if !defined(__DOXYGEN__)
  99                         static inline void Joystick_Init(void)
 100                         {
 101                                 DDRD  &= ~JOY_MASK;
 102                                 PORTD |= JOY_MASK;
 103                         }
 104
 105                         static inline uint8_t Joystick_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
 106                         static inline uint8_t Joystick_GetStatus(void)
 107                         {
 108                                 return (uint8_t)(~PIND & JOY_MASK);
 109                         }
 110                 #endif
 111
 112         /* Disable C linkage for C++ Compilers: */
 113                 #if defined(__cplusplus)
 114                         }
 115                 #endif
 116
 117 #endif
 118
 119 /** @} */