Joystick.h 4.63 KB
 Dean Camera committed May 08, 2010 1 2 3 /* LUFA Library Copyright (C) Dean Camera, 2010.  4   Dean Camera committed May 08, 2010 5  dean [at] fourwalledcubicle [dot] com  Dean Camera committed Oct 28, 2010 6  www.lufa-lib.org  Dean Camera committed May 08, 2010 7 8 9 10 11 */ /* Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)  12  Permission to use, copy, modify, distribute, and sell this  Dean Camera committed May 08, 2010 13  software and its documentation for any purpose is hereby granted  14  without fee, provided that the above copyright notice appear in  Dean Camera committed May 08, 2010 15  all copies and that both that the copyright notice and this  16 17 18  permission notice and warranty disclaimer appear in supporting documentation, and that the name of the author not be used in advertising or publicity pertaining to distribution of the  Dean Camera committed May 08, 2010 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41  software without specific, written prior permission. The author disclaim all warranties with regard to this software, including all implied warranties of merchantability and fitness. In no event shall the author be liable for any special, indirect or consequential damages or any damages whatsoever resulting from loss of use, data or profits, whether in an action of contract, negligence or other tortious action, arising out of or in connection with the use or performance of this software. */ /** \file * \brief Master include file for the board digital joystick driver. * * This file is the master dispatch header file for the board-specific Joystick driver, for boards containing a * 5-way joystick. * * User code should include this file, which will in turn include the correct joystick driver header file for the * currently selected board. * * If the BOARD value is set to BOARD_USER, this will include the /Board/Joystick.h file in the user project * directory.  Dean Camera committed Sep 03, 2010 42  *  43  * For possible BOARD makefile values, see \ref Group_BoardTypes.  Dean Camera committed May 08, 2010 44  */  45   Dean Camera committed May 08, 2010 46 47 48 49 50 51 52 53 54 55 56 57 58 59 /** \ingroup Group_BoardDrivers * @defgroup Group_Joystick Joystick Driver - LUFA/Drivers/Board/Joystick.h * * \section Sec_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - None * * \section Module Description * Hardware Joystick driver. This module provides an easy to use interface to control the hardware digital Joystick * located on many boards. * * If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project * directory. Otherwise, it will include the appropriate built in board driver header file. *  Dean Camera committed Sep 03, 2010 60 61  * For possible BOARD makefile values, see \ref Group_BoardTypes. *  Dean Camera committed Dec 26, 2010 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85  * Example Usage: * \code * // Initialise the board Joystick driver before first use * Joystick_Init(); * * printf("Waiting for joystick movement...\r\n"); * * // Loop until a the joystick has been moved * uint8_t JoystickMovement; * while (!(JoystickMovement = Joystick_GetStatus())) {}; * * // Display which direction the joystick was moved in * printf("Joystick moved:\r\n"); * * if (JoystickMovement & (JOY_UP | JOY_DOWN)) * printf("%s ", (JoystickMovement & JOY_UP) ? "Up" : "Down"); * * if (JoystickMovement & (JOY_LEFT | JOY_RIGHT)) * printf("%s ", (JoystickMovement & JOY_LEFT) ? "Left" : "Right"); * * if (JoystickMovement & JOY_PRESSED) * printf("Pressed"); * \endcode *  Dean Camera committed May 08, 2010 86 87 88 89 90 91 92 93 94 95 96 97 98 99  * @{ */ #ifndef __JOYSTICK_H__ #define __JOYSTICK_H__ /* Macros: */ #if !defined(__DOXYGEN__) #define __INCLUDE_FROM_JOYSTICK_H #define INCLUDE_FROM_JOYSTICK_H #endif /* Includes: */ #include "../../Common/Common.h"  100   Dean Camera committed May 08, 2010 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120  #if (BOARD == BOARD_NONE) #error The Board Joystick driver cannot be used if the makefile BOARD option is not set. #elif (BOARD == BOARD_USBKEY) #include "USBKEY/Joystick.h" #elif (BOARD == BOARD_STK525) #include "STK525/Joystick.h" #elif (BOARD == BOARD_STK526) #include "STK526/Joystick.h" #elif (BOARD == BOARD_BUMBLEB) #include "BUMBLEB/Joystick.h" #elif (BOARD == BOARD_EVK527) #include "EVK527/Joystick.h" #elif (BOARD == BOARD_USER) #include "Board/Joystick.h" #else #error The selected board does not contain a joystick. #endif /* Pseudo-Functions for Doxygen: */ #if defined(__DOXYGEN__)  Dean Camera committed Jul 30, 2010 121  /** Initialises the joystick driver so that the joystick position can be read. This sets the appropriate  Dean Camera committed May 08, 2010 122 123 124 125 126 127 128 129  * I/O pins to inputs with their pull-ups enabled. */ static inline void Joystick_Init(void); /** Returns the current status of the joystick, as a mask indicating the direction the joystick is * currently facing in (multiple bits can be set). * * \return Mask indicating the joystick direction - see corresponding board specific Joystick.h file  Dean Camera committed Jun 17, 2010 130  * for direction masks.  Dean Camera committed May 08, 2010 131 132 133 134 135 136 137  */ static inline uint8_t Joystick_GetStatus(void) ATTR_WARN_UNUSED_RESULT; #endif #endif /** @} */  138