Statistics
| Branch: | Tag: | Revision:

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

History | View | Annotate | Download (5.61 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 button board hardware driver.
33
 *
34
 *  This file is the master dispatch header file for the board-specific Buttons driver, for boards containing
35
 *  physical pushbuttons connected to the microcontroller's GPIO pins.
36
 *
37
 *  User code should include this file, which will in turn include the correct Button 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/Buttons.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_Buttons Buttons Driver - LUFA/Drivers/Board/Buttons.h
48
 *  \brief Digital button 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 buttons driver. This provides an easy to use driver for the hardware buttons present on many boards.
56
 *  It provides a way to easily configure and check the status of all the buttons on the board so that appropriate
57
 *  actions can be taken.
58
 *
59
 *  If the \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/Buttons.h file in the user project
60
 *  directory. Otherwise, it will include the appropriate built in board driver header file.
61
 *
62
 *  For possible \c BOARD makefile values, see \ref Group_BoardTypes.
63
 *
64
 *  \section Sec_ExampleUsage Example Usage
65
 *  The following snippet is an example of how this module may be used within a typical
66
 *  application.
67
 *
68
 *  \code
69
 *      // Initialize the button driver before first use
70
 *      Buttons_Init();
71
 *
72
 *      printf("Waiting for button press...\r\n");
73
 *
74
 *      // Loop until a board button has been pressed
75
 *      uint8_t ButtonPress;
76
 *      while (!(ButtonPress = Buttons_GetStatus())) {};
77
 *
78
 *      // Display which button was pressed (assuming two board buttons)
79
 *      printf("Button pressed: %s\r\n", (ButtonPress == BUTTONS_BUTTON1) ? "Button 1" : "Button 2");
80
 *  \endcode
81
 * 
82
 *  @{
83
 */
84

    
85
#ifndef __BUTTONS_H__
86
#define __BUTTONS_H__
87

    
88
        /* Macros: */
89
                #define __INCLUDE_FROM_BUTTONS_H
90

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

    
94
                #if (BOARD == BOARD_NONE)
95
                        #error The Board Buttons driver cannot be used if the makefile BOARD option is not set.
96
                #elif (BOARD == BOARD_USBKEY)
97
                        #include "AVR8/USBKEY/Buttons.h"
98
                #elif (BOARD == BOARD_STK525)
99
                        #include "AVR8/STK525/Buttons.h"
100
                #elif (BOARD == BOARD_STK526)
101
                        #include "AVR8/STK526/Buttons.h"
102
                #elif (BOARD == BOARD_ATAVRUSBRF01)
103
                        #include "AVR8/ATAVRUSBRF01/Buttons.h"
104
                #elif (BOARD == BOARD_BUMBLEB)
105
                        #include "AVR8/BUMBLEB/Buttons.h"
106
                #elif (BOARD == BOARD_EVK527)
107
                        #include "AVR8/EVK527/Buttons.h"
108
                #elif (BOARD == BOARD_USBTINYMKII)
109
                        #include "AVR8/USBTINYMKII/Buttons.h"
110
                #elif (BOARD == BOARD_BENITO)
111
                        #include "AVR8/BENITO/Buttons.h"
112
                #elif (BOARD == BOARD_JMDBU2)
113
                        #include "AVR8/JMDBU2/Buttons.h"
114
                #elif (BOARD == BOARD_OLIMEX162)
115
                        #include "AVR8/OLIMEX162/Buttons.h"
116
                #elif (BOARD == BOARD_USBFOO)
117
                        #include "AVR8/USBFOO/Buttons.h"
118
                #elif (BOARD == BOARD_UDIP)
119
                        #include "AVR8/UDIP/Buttons.h"
120
                #elif (BOARD == BOARD_CULV3)
121
                        #include "AVR8/CULV3/Buttons.h"
122
                #elif (BOARD == BOARD_MINIMUS)
123
                        #include "AVR8/MINIMUS/Buttons.h"
124
                #elif (BOARD == BOARD_MICROSIN162)
125
                        #include "AVR8/MICROSIN162/Buttons.h"
126
                #elif (BOARD == BOARD_EVK1101)
127
                        #include "UC3/EVK1101/Buttons.h"
128
                #elif (BOARD == BOARD_TUL)
129
                        #include "AVR8/TUL/Buttons.h"
130
                #elif (BOARD == BOARD_EVK1100)
131
                        #include "UC3/EVK1100/Buttons.h"
132
                #elif (BOARD == BOARD_EVK1104)
133
                        #include "UC3/EVK1104/Buttons.h"
134
                #else
135
                        #include "Board/Buttons.h"
136
                #endif
137

    
138
        /* Pseudo-Functions for Doxygen: */
139
        #if defined(__DOXYGEN__)
140
                /** Initializes the BUTTONS driver, so that the current button position can be read. This sets the appropriate
141
                 *  I/O pins to an inputs with pull-ups enabled.
142
                 *
143
                 *  This must be called before any Button driver functions are used.
144
                 */
145
                static inline void Buttons_Init(void);
146

    
147
                /** Returns a mask indicating which board buttons are currently pressed.
148
                 *
149
                 *  \return Mask indicating which board buttons are currently pressed.
150
                 */
151
                static inline uint_reg_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
152
        #endif
153

    
154
#endif
155

    
156
/** @} */
157