Statistics
| Branch: | Tag: | Revision:

root / LUFA / Drivers / Board / Joystick.h @ 978b99e5

History | View | Annotate | Download (4.99 KB)

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 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
 *  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
 *  \brief Digital joystick board hardware driver.
49
 *
50
 *  \section Sec_Dependencies Module Source Dependencies
51
 *  The following files must be built with any user project that uses this module:
52
 *    - None
53
 *
54
 *  \section Sec_ModDescription Module Description
55
 *  Hardware Joystick driver. This module provides an easy to use interface to control the hardware digital Joystick
56
 *  located on many boards.
57
 *
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
 *  directory. Otherwise, it will include the appropriate built in board driver header file.
60
 *
61
 *  For possible \c BOARD makefile values, see \ref Group_BoardTypes.
62
 *
63
 *  \section Sec_ExampleUsage Example Usage
64
 *  The following snippet is an example of how this module may be used within a typical
65
 *  application.
66
 *
67
 *  \code
68
 *      // Initialize the board Joystick driver before first use
69
 *      Joystick_Init();
70
 *
71
 *      printf("Waiting for joystick movement...\r\n");
72
 *
73
 *      // Loop until a the joystick has been moved
74
 *      uint8_t JoystickMovement;
75
 *      while (!(JoystickMovement = Joystick_GetStatus())) {};
76
 *
77
 *      // Display which direction the joystick was moved in
78
 *      printf("Joystick moved:\r\n");
79
 *      
80
 *      if (JoystickMovement & (JOY_UP | JOY_DOWN))
81
 *        printf("%s ", (JoystickMovement & JOY_UP) ? "Up" : "Down");
82
 *
83
 *      if (JoystickMovement & (JOY_LEFT | JOY_RIGHT))
84
 *        printf("%s ", (JoystickMovement & JOY_LEFT) ? "Left" : "Right");
85
 *
86
 *      if (JoystickMovement & JOY_PRESSED)
87
 *        printf("Pressed");
88
 *  \endcode
89
 *
90
 *  @{
91
 */
92

    
93
#ifndef __JOYSTICK_H__
94
#define __JOYSTICK_H__
95

    
96
        /* Macros: */
97
                #define __INCLUDE_FROM_JOYSTICK_H
98

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

    
102
                #if (BOARD == BOARD_NONE)
103
                        #error The Board Joystick driver cannot be used if the makefile BOARD option is not set.
104
                #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
                #elif (BOARD == BOARD_EVK1100)
117
                        #include "UC3/EVK1100/Joystick.h"
118
                #else
119
                        #include "Board/Joystick.h"
120
                #endif
121

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

    
129
                /** Returns the current status of the joystick, as a mask indicating the direction the joystick is
130
                 *  currently facing in (multiple bits can be set).
131
                 *
132
                 *  \return Mask indicating the joystick direction - see corresponding board specific Joystick.h file
133
                 *          for direction masks.
134
                 */
135
                static inline uint_reg_t Joystick_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
136
        #endif
137

    
138
#endif
139

    
140
/** @} */
141