Joystick.h 4.87 KB
Newer Older
 Dean Camera committed May 08, 2010 1 2 /* LUFA Library  Dean Camera committed Jan 01, 2011 3  Copyright (C) Dean Camera, 2011.  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 */ /*  Dean Camera committed Jan 01, 2011 10  Copyright 2011 Dean Camera (dean [at] fourwalledcubicle [dot] com)  Dean Camera committed May 08, 2010 11   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  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  Dean Camera committed Feb 20, 2011 32  * \brief Digital joystick board hardware driver.  Dean Camera committed May 08, 2010 33 34  * * This file is the master dispatch header file for the board-specific Joystick driver, for boards containing a  Dean Camera committed Feb 20, 2011 35  * digital joystick.  Dean Camera committed May 08, 2010 36 37 38 39  * * User code should include this file, which will in turn include the correct joystick driver header file for the * currently selected board. *  Dean Camera committed Jan 08, 2011 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  Dean Camera committed May 08, 2010 41  * directory.  Dean Camera committed Sep 03, 2010 42  *  Dean Camera committed Jan 08, 2011 43  * For possible \c BOARD makefile values, see \ref Group_BoardTypes.  Dean Camera committed May 08, 2010 44  */  45   Dean Camera committed May 08, 2010 46 /** \ingroup Group_BoardDrivers  Dean Camera committed Feb 19, 2011 47  * \defgroup Group_Joystick Joystick Driver - LUFA/Drivers/Board/Joystick.h  Dean Camera committed Feb 20, 2011 48  * \brief Digital joystick board hardware driver.  Dean Camera committed May 08, 2010 49 50 51 52 53  * * \section Sec_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - None *  Dean Camera committed Dec 26, 2010 54  * \section Sec_ModDescription Module Description  Dean Camera committed May 08, 2010 55 56 57  * Hardware Joystick driver. This module provides an easy to use interface to control the hardware digital Joystick * located on many boards. *  Dean Camera committed Jun 05, 2011 58  * If the \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/Joystick.h file in the user project  Dean Camera committed May 08, 2010 59 60  * directory. Otherwise, it will include the appropriate built in board driver header file. *  Dean Camera committed Jan 08, 2011 61  * For possible \c BOARD makefile values, see \ref Group_BoardTypes.  Dean Camera committed Sep 03, 2010 62  *  Dean Camera committed Dec 26, 2010 63 64 65 66  * \section Sec_ExampleUsage Example Usage * The following snippet is an example of how this module may be used within a typical * application. *  Dean Camera committed Dec 26, 2010 67  * \code  Dean Camera committed Jun 01, 2011 68  * // Initialize the board Joystick driver before first use  Dean Camera committed Dec 26, 2010 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89  * 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 90 91 92 93 94 95 96 97 98 99  * @{ */ #ifndef __JOYSTICK_H__ #define __JOYSTICK_H__ /* Macros: */ #define __INCLUDE_FROM_JOYSTICK_H /* Includes: */  Dean Camera committed Feb 20, 2011 100  #include "../../Common/Common.h"  101   Dean Camera committed Feb 20, 2011 102 103 104  #if (BOARD == BOARD_NONE) #error The Board Joystick driver cannot be used if the makefile BOARD option is not set. #elif (BOARD == BOARD_USBKEY)  105  #include "AVR8/USBKEY/Joystick.h"  Dean Camera committed Feb 20, 2011 106  #elif (BOARD == BOARD_STK525)  107  #include "AVR8/STK525/Joystick.h"  Dean Camera committed Feb 20, 2011 108  #elif (BOARD == BOARD_STK526)  109  #include "AVR8/STK526/Joystick.h"  Dean Camera committed Feb 20, 2011 110  #elif (BOARD == BOARD_BUMBLEB)  111  #include "AVR8/BUMBLEB/Joystick.h"  Dean Camera committed Feb 20, 2011 112  #elif (BOARD == BOARD_EVK527)  113  #include "AVR8/EVK527/Joystick.h"  Dean Camera committed Feb 20, 2011 114  #elif (BOARD == BOARD_EVK1101)  115  #include "UC3/EVK1101/Joystick.h"  Dean Camera committed Jun 27, 2011 116 117  #elif (BOARD == BOARD_EVK1100) #include "UC3/EVK1100/Joystick.h"  Dean Camera committed Feb 20, 2011 118 119 120  #else #include "Board/Joystick.h" #endif  Dean Camera committed May 08, 2010 121   Dean Camera committed Feb 20, 2011 122 123  /* Pseudo-Functions for Doxygen: */ #if defined(__DOXYGEN__)  Dean Camera committed Jun 01, 2011 124  /** Initializes the joystick driver so that the joystick position can be read. This sets the appropriate  Dean Camera committed Feb 20, 2011 125 126 127  * I/O pins to inputs with their pull-ups enabled. */ static inline void Joystick_Init(void);  Dean Camera committed May 08, 2010 128   Dean Camera committed Feb 20, 2011 129 130 131 132 133 134 135 136  /** 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 * for direction masks. */ static inline uint_reg_t Joystick_GetStatus(void) ATTR_WARN_UNUSED_RESULT; #endif  Dean Camera committed May 08, 2010 137 138 139 140  #endif /** @} */  141