LUFA/Drivers/Board/Joystick.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2011.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2011  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 Master include file for the board digital joystick driver.
  33  *
  34  *  This file is the master dispatch header file for the board-specific Joystick driver, for boards containing a
  35  *  5-way joystick.
  36  *
  37  *  User code should include this file, which will in turn include the correct joystick driver header file for the
  38  *  currently selected board.
  39  *
  40  *  If the \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/Joystick.h file in the user project
  41  *  directory.
  42  *
  43  *  For possible \c BOARD makefile values, see \ref Group_BoardTypes.
  44  */
  45
  46 /** \ingroup Group_BoardDrivers
  47  *  \defgroup Group_Joystick Joystick Driver - LUFA/Drivers/Board/Joystick.h
  48  *
  49  *  \section Sec_Dependencies Module Source Dependencies
  50  *  The following files must be built with any user project that uses this module:
  51  *    - None
  52  *
  53  *  \section Sec_ModDescription Module Description
  54  *  Hardware Joystick driver. This module provides an easy to use interface to control the hardware digital Joystick
  55  *  located on many boards.
  56  *
  57  *  If the \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/Dataflash.h file in the user project
  58  *  directory. Otherwise, it will include the appropriate built in board driver header file.
  59  *
  60  *  For possible \c BOARD makefile values, see \ref Group_BoardTypes.
  61  *
  62  *  \section Sec_ExampleUsage Example Usage
  63  *  The following snippet is an example of how this module may be used within a typical
  64  *  application.
  65  *
  66  *  \code
  67  *      // Initialise the board Joystick driver before first use
  68  *      Joystick_Init();
  69  *
  70  *      printf("Waiting for joystick movement...\r\n");
  71  *
  72  *      // Loop until a the joystick has been moved
  73  *      uint8_t JoystickMovement;
  74  *      while (!(JoystickMovement = Joystick_GetStatus())) {};
  75  *
  76  *      // Display which direction the joystick was moved in
  77  *      printf("Joystick moved:\r\n");
  78  *
  79  *      if (JoystickMovement & (JOY_UP | JOY_DOWN))
  80  *        printf("%s ", (JoystickMovement & JOY_UP) ? "Up" : "Down");
  81  *
  82  *      if (JoystickMovement & (JOY_LEFT | JOY_RIGHT))
  83  *        printf("%s ", (JoystickMovement & JOY_LEFT) ? "Left" : "Right");
  84  *
  85  *      if (JoystickMovement & JOY_PRESSED)
  86  *        printf("Pressed");
  87  *  \endcode
  88  *
  89  *  @{
  90  */
  91
  92 #ifndef __JOYSTICK_H__
  93 #define __JOYSTICK_H__
  94
  95         /* Macros: */
  96         #if !defined(__DOXYGEN__)
  97                 #define __INCLUDE_FROM_JOYSTICK_H
  98                 #define INCLUDE_FROM_JOYSTICK_H
  99         #endif
 100
 101         /* Includes: */
 102         #include "../../Common/Common.h"
 103
 104         #if (BOARD == BOARD_NONE)
 105                 #error The Board Joystick driver cannot be used if the makefile BOARD option is not set.
 106         #elif (BOARD == BOARD_USBKEY)
 107                 #include "USBKEY/Joystick.h"
 108         #elif (BOARD == BOARD_STK525)
 109                 #include "STK525/Joystick.h"
 110         #elif (BOARD == BOARD_STK526)
 111                 #include "STK526/Joystick.h"
 112         #elif (BOARD == BOARD_BUMBLEB)
 113                 #include "BUMBLEB/Joystick.h"
 114         #elif (BOARD == BOARD_EVK527)
 115                 #include "EVK527/Joystick.h"
 116         #else
 117                 #include "Board/Joystick.h"
 118         #endif
 119
 120         /* Pseudo-Functions for Doxygen: */
 121         #if defined(__DOXYGEN__)
 122                 /** Initialises the joystick driver so that the joystick position can be read. This sets the appropriate
 123                  *  I/O pins to inputs with their pull-ups enabled.
 124                  */
 125                 static inline void Joystick_Init(void);
 126
 127                 /** Returns the current status of the joystick, as a mask indicating the direction the joystick is
 128                  *  currently facing in (multiple bits can be set).
 129                  *
 130                  *  \return Mask indicating the joystick direction - see corresponding board specific Joystick.h file
 131                  *          for direction masks.
 132                  */
 133                 static inline uint8_t Joystick_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
 134         #endif
 135
 136 #endif
 137
 138 /** @} */
 139