Buttons.h 3.62 KB
Newer Older
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
/*
             LUFA Library
     Copyright (C) Dean Camera, 2009.
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

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

  Permission to use, copy, modify, and distribute this software
  and its documentation for any purpose and without fee is hereby
  granted, 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 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
 *
33
34
 *  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.
35
 *
36
 *  User code should include this file, which will in turn include the correct Button driver header file for the
37
38
 *  currently selected board.
 *
39
 *  If the BOARD value is set to BOARD_USER, this will include the /Board/Buttons.h file in the user project
40
41
 *  directory.
 */
42
43

/** \ingroup Group_BoardDrivers
44
 *  @defgroup Group_Buttons Buttons Driver - LUFA/Drivers/Board/Buttons.h
45
 *
46
47
48
49
50
 *  \section Sec_Dependencies Module Source Dependencies
 *  The following files must be built with any user project that uses this module:
 *    - None
 *
 *  \section Module Description
51
 *  Functions, macros, variables, enums and types related to the control of physical board GPIO buttons.
52
 *
53
54
55
 *  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.
 *
56
57
58
 *  @{
 */

59
60
#ifndef __BUTTONS_H__
#define __BUTTONS_H__
61
62
63

	/* Macros: */
	#if !defined(__DOXYGEN__)
64
		#define INCLUDE_FROM_BUTTONS_H
65
66
67
68
69
70
71
72
73
		#define INCLUDE_FROM_BOARD_DRIVER
	#endif

	/* Includes: */
	#include "../../Common/Common.h"
	
	#if !defined(BOARD)
		#error BOARD must be set in makefile to a value specified in BoardTypes.h.
	#elif (BOARD == BOARD_USBKEY)
74
		#include "USBKEY/Buttons.h"
75
	#elif (BOARD == BOARD_STK525)
76
		#include "STK525/Buttons.h"
77
	#elif (BOARD == BOARD_STK526)
78
		#include "STK526/Buttons.h"
79
	#elif (BOARD == BOARD_ATAVRUSBRF01)
80
		#include "ATAVRUSBRF01/Buttons.h"
81
	#elif (BOARD == BOARD_USER)
82
		#include "Board/Buttons.h"		
83
	#else
84
		#error The selected board does not contain any GPIO buttons.
85
86
	#endif
	
87
	/* Pseudo-Functions for Doxygen: */
88
	#if defined(__DOXYGEN__)
89
90
		/** Initializes the BUTTONS driver, so that the current button position can be read. This sets the appropriate
		 *  I/O pins to an inputs with pull-ups enabled.
91
		 *
92
		 *  This must be called before any Button driver functions are used.
93
		 */
94
		static inline void Buttons_Init(void);
95
		
96
		/** Returns a mask indicating which board buttons are currently pressed.
97
		 *
98
		 *  \return Mask indicating which board buttons are currently pressed
99
		 */
100
		static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
101
102
103
	#endif

#endif
104
105

/** @} */