Joystick.h 4.85 KB
Newer Older
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 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
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
32
 *  \brief Digital joystick board hardware driver.
33 34
 *
 *  This file is the master dispatch header file for the board-specific Joystick driver, for boards containing a
35
 *  digital joystick.
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.
 *
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
 *  \brief Digital joystick board hardware driver.
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
 *
54
 *  \section Sec_ModDescription Module Description
55 56 57
 *  Hardware Joystick driver. This module provides an easy to use interface to control the hardware digital Joystick
 *  located on many boards.
 *
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
59 60
 *  directory. Otherwise, it will include the appropriate built in board driver header file.
 *
61
 *  For possible \c BOARD makefile values, see \ref Group_BoardTypes.
62
 *
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.
 *
67
 *  \code
68
 *      // Initialize the board Joystick driver before first use
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
 *      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");
 *
86
 *      if (JoystickMovement & JOY_PRESS)
87 88 89
 *        printf("Pressed");
 *  \endcode
 *
90 91 92 93 94 95 96 97 98 99
 *  @{
 */

#ifndef __JOYSTICK_H__
#define __JOYSTICK_H__

	/* Macros: */
		#define __INCLUDE_FROM_JOYSTICK_H

	/* Includes: */
100
		#include "../../Common/Common.h"
101

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"
106
		#elif (BOARD == BOARD_STK525)
107
			#include "AVR8/STK525/Joystick.h"
108
		#elif (BOARD == BOARD_STK526)
109
			#include "AVR8/STK526/Joystick.h"
110
		#elif (BOARD == BOARD_BUMBLEB)
111
			#include "AVR8/BUMBLEB/Joystick.h"
112
		#elif (BOARD == BOARD_EVK527)
113
			#include "AVR8/EVK527/Joystick.h"
114
		#elif (BOARD == BOARD_EVK1101)
115
			#include "UC3/EVK1101/Joystick.h"
116 117
		#elif (BOARD == BOARD_EVK1100)
			#include "UC3/EVK1100/Joystick.h"
118 119 120
		#else
			#include "Board/Joystick.h"
		#endif
121

122 123 124 125 126 127
	/* Pseudo-Functions for Doxygen: */
	#if defined(__DOXYGEN__)
		/** Initializes the joystick driver so that the joystick position can be read. This sets the appropriate
		 *  I/O pins to inputs with their pull-ups enabled.
		 */
		static inline void Joystick_Init(void);
128

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
137 138 139 140

#endif

/** @} */
141