8b438d9c
 root
Harmonisation ava...
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
/*
LUFA Library
Copyright (C) Dean Camera, 2017.
dean [at] fourwalledcubicle [dot] com
www.lufa-lib.org
*/
/*
Copyright 2017 Dean Camera (dean [at] fourwalledcubicle [dot] com)
Permission to use, copy, modify, distribute, and sell this
software and its documentation for any purpose is hereby granted
without fee, provided that the above copyright notice appear in
all copies and that both that the copyright notice and this
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
software without specific, written prior permission.
The author disclaims 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 Digital joystick board hardware driver.
*
* This file is the master dispatch header file for the board-specific Joystick driver, for boards containing a
* digital 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 \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/Joystick.h file in the user project
* directory.
*
* For possible \c BOARD makefile values, see \ref Group_BoardTypes.
*/
/** \ingroup Group_BoardDrivers
* \defgroup Group_Joystick Joystick Driver - LUFA/Drivers/Board/Joystick.h
* \brief Digital joystick board hardware driver.
*
* \section Sec_Joystick_Dependencies Module Source Dependencies
* The following files must be built with any user project that uses this module:
* - None
*
* \section Sec_Joystick_ModDescription 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 \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/Joystick.h file in the user project
* directory. Otherwise, it will include the appropriate built-in board driver header file.
*
* For possible \c BOARD makefile values, see \ref Group_BoardTypes.
*
* \section Sec_Joystick_ExampleUsage Example Usage
* The following snippet is an example of how this module may be used within a typical
* application.
*
* \code
* // Initialize 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_PRESS)
* printf("Pressed");
* \endcode
*
* @{
*/
#ifndef __JOYSTICK_H__
#define __JOYSTICK_H__
/* Macros: */
#define __INCLUDE_FROM_JOYSTICK_H
/* Includes: */
#include "../../Common/Common.h"
#if (BOARD == BOARD_NONE)
#define JOY_UP 0
#define JOY_DOWN 0
#define JOY_LEFT 0
#define JOY_RIGHT 0
#define JOY_PRESS 0
static inline void Joystick_Init(void) {}
static inline void Joystick_Disable(void) {}
static inline uint_reg_t Joystick_GetStatus(void) { return 0; }
#elif (BOARD == BOARD_USBKEY)
#include "AVR8/USBKEY/Joystick.h"
#elif (BOARD == BOARD_STK525)
#include "AVR8/STK525/Joystick.h"
#elif (BOARD == BOARD_STK526)
#include "AVR8/STK526/Joystick.h"
#elif (BOARD == BOARD_BUMBLEB)
#include "AVR8/BUMBLEB/Joystick.h"
#elif (BOARD == BOARD_EVK527)
#include "AVR8/EVK527/Joystick.h"
#elif (BOARD == BOARD_EVK1101)
#include "UC3/EVK1101/Joystick.h"
#elif (BOARD == BOARD_EVK1100)
#include "UC3/EVK1100/Joystick.h"
#elif (BOARD == BOARD_PINGUI)
#include "AVR8/PINGUI/Joystick.h"
#elif
#include "BOARD/Joystick.h"
#endif
/* 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.
*
* This must be called before any Joystick driver functions are used.
*/
static inline void Joystick_Init(void);
/** Disables the joystick driver, releasing the I/O pins back to their default high-impedance input mode. */
static inline void Joystick_Disable(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 of \c JOYSTICK_* constants indicating the current joystick direction(s).
*/
static inline uint_reg_t Joystick_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
#endif
#endif
/** @} */
|