Statistics
| Branch: | Tag: | Revision:

root / LUFA / CodeTemplates / DriverStubs / Buttons.h @ 978b99e5

History | View | Annotate | Download (2.74 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
/*
32
   This is a stub driver header file, for implementing custom board
33
   layout hardware with compatible LUFA board specific drivers. If
34
   the library is configured to use the BOARD_USER board mode, this
35
   driver file should be completed and copied into the "/Board/" folder
36
   inside the application's folder.
37

38
   This stub is for the board-specific component of the LUFA Buttons driver,
39
   for the control of physical board-mounted GPIO pushbuttons.
40
*/
41

    
42
#ifndef __BUTTONS_USER_H__
43
#define __BUTTONS_USER_H__
44

    
45
        /* Includes: */
46
                // TODO: Add any required includes here
47

    
48
        /* Enable C linkage for C++ Compilers: */
49
                #if defined(__cplusplus)
50
                        extern "C" {
51
                #endif
52

    
53
        /* Preprocessor Checks: */
54
                #if !defined(__INCLUDE_FROM_BUTTONS_H)
55
                        #error Do not include this file directly. Include LUFA/Drivers/Board/Buttons.h instead.
56
                #endif
57

    
58
        /* Public Interface - May be used in end-application: */
59
                /* Macros: */
60
                        /** Button mask for the first button on the board. */
61
                        #define BUTTONS_BUTTON1          // TODO: Add mask for first board button here
62

    
63
                /* Inline Functions: */
64
                #if !defined(__DOXYGEN__)
65
                        static inline void Buttons_Init(void)
66
                        {
67
                                // TODO: Initialize the appropriate port pins as an inputs here, with pull-ups
68
                        }
69

    
70
                        static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
71
                        static inline uint8_t Buttons_GetStatus(void)
72
                        {
73
                                // TODO: Return current button status here, debounced if required
74
                        }
75
                #endif
76

    
77
        /* Disable C linkage for C++ Compilers: */
78
                #if defined(__cplusplus)
79
                        }
80
                #endif
81

    
82
#endif
83