Buttons.h 5.04 KB
Newer Older
1
2
3
/*
             LUFA Library
     Copyright (C) Dean Camera, 2010.
4

5
  dean [at] fourwalledcubicle [dot] com
6
           www.lufa-lib.org
7
8
9
10
11
*/

/*
  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)

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
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 button driver.
 *
 *  This file is the master dispatch header file for the board-specific Buttons driver, for boards containing
 *  physical pushbuttons connected to the AVR's GPIO pins.
 *
 *  User code should include this file, which will in turn include the correct Button driver header file for the
 *  currently selected board.
 *
 *  If the BOARD value is set to BOARD_USER, this will include the /Board/Buttons.h file in the user project
 *  directory.
42
43
 *
 *  For possible BOARD makefile values, see \ref Group_BoardTypes.
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 */

/** \ingroup Group_BoardDrivers
 *  @defgroup Group_Buttons Buttons Driver - LUFA/Drivers/Board/Buttons.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 buttons driver. This provides an easy to use driver for the hardware buttons present on many boards.
 *  It provides a way to easily configure and check the status of all the buttons on the board so that appropriate
 *  actions can be taken.
 *
 *  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.
 *
61
62
 *  For possible BOARD makefile values, see \ref Group_BoardTypes.
 *
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 *  <b>Example Usage:</b>
 *  \code
 *      // Initialise the button driver before first use
 *      Buttons_Init();
 *
 *      printf("Waiting for button press...\r\n");
 *
 *      // Loop until a board button has been pressed
 *      uint8_t ButtonPress;
 *      while (!(ButtonPress = Buttons_GetStatus())) {};
 *
 *      // Display which button was pressed (assuming two board buttons)
 *      printf("Button pressed: %s\r\n", (ButtonPress == BUTTONS_BUTTON1) ? "Button 1" : "Button 2");
 *  \endcode
 * 
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 *  @{
 */

#ifndef __BUTTONS_H__
#define __BUTTONS_H__

	/* Macros: */
	#if !defined(__DOXYGEN__)
		#define __INCLUDE_FROM_BUTTONS_H
		#define INCLUDE_FROM_BUTTONS_H
	#endif

	/* Includes: */
	#include "../../Common/Common.h"
92

93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
	#if (BOARD == BOARD_NONE)
		#error The Board Buttons driver cannot be used if the makefile BOARD option is not set.
	#elif (BOARD == BOARD_USBKEY)
		#include "USBKEY/Buttons.h"
	#elif (BOARD == BOARD_STK525)
		#include "STK525/Buttons.h"
	#elif (BOARD == BOARD_STK526)
		#include "STK526/Buttons.h"
	#elif (BOARD == BOARD_ATAVRUSBRF01)
		#include "ATAVRUSBRF01/Buttons.h"
	#elif (BOARD == BOARD_BUMBLEB)
		#include "BUMBLEB/Buttons.h"
	#elif (BOARD == BOARD_EVK527)
		#include "EVK527/Buttons.h"
	#elif (BOARD == BOARD_USBTINYMKII)
108
		#include "USBTINYMKII/Buttons.h"
109
110
111
112
	#elif (BOARD == BOARD_BENITO)
		#include "BENITO/Buttons.h"
	#elif (BOARD == BOARD_JMDBU2)
		#include "JMDBU2/Buttons.h"
113
114
	#elif (BOARD == BOARD_OLIMEX162)
		#include "OLIMEX162/Buttons.h"
115
116
	#elif (BOARD == BOARD_USBFOO)
		#include "USBFOO/Buttons.h"
117
118
	#elif (BOARD == BOARD_UDIP)
		#include "UDIP/Buttons.h"
119
120
	#elif (BOARD == BOARD_CULV3)
		#include "CULV3/Buttons.h"
121
122
	#elif (BOARD == BOARD_MINIMUS)
		#include "MINIMUS/Buttons.h"
123
124
	#elif (BOARD == BOARD_MICROSIN162)
		#include "MICROSIN162/Buttons.h"
125
126
127
128
129
	#elif (BOARD == BOARD_USER)
		#include "Board/Buttons.h"
	#else
		#error The selected board does not contain any GPIO buttons.
	#endif
130

131
132
	/* Pseudo-Functions for Doxygen: */
	#if defined(__DOXYGEN__)
133
		/** Initialises the BUTTONS driver, so that the current button position can be read. This sets the appropriate
134
135
136
137
138
		 *  I/O pins to an inputs with pull-ups enabled.
		 *
		 *  This must be called before any Button driver functions are used.
		 */
		static inline void Buttons_Init(void);
139

140
141
		/** Returns a mask indicating which board buttons are currently pressed.
		 *
142
		 *  \return Mask indicating which board buttons are currently pressed.
143
144
145
146
147
148
149
		 */
		static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
	#endif

#endif

/** @} */
150