Blame view

src/lufa-LUFA-170418/LUFA/CodeTemplates/DriverStubs/Buttons.h 2.87 KB
ca85a266   gperson   le vrai commit, c...
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
  /*
               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 LUFA Custom Board Button Hardware Driver (Template)
   *
   *  This is a stub driver header file, for implementing custom board
   *  layout hardware with compatible LUFA board specific drivers. If
   *  the library is configured to use the BOARD_USER board mode, this
   *  driver file should be completed and copied into the "/Board/" folder
   *  inside the application's folder.
   *
   *  This stub is for the board-specific component of the LUFA Buttons driver,
   *  for the control of physical board-mounted GPIO pushbuttons.
   */
  
  #ifndef __BUTTONS_USER_H__
  #define __BUTTONS_USER_H__
  
  	/* Includes: */
  		// TODO: Add any required includes here
  
  	/* Enable C linkage for C++ Compilers: */
  		#if defined(__cplusplus)
  			extern "C" {
  		#endif
  
  	/* Preprocessor Checks: */
  		#if !defined(__INCLUDE_FROM_BUTTONS_H)
  			#error Do not include this file directly. Include LUFA/Drivers/Board/Buttons.h instead.
  		#endif
  
  	/* Public Interface - May be used in end-application: */
  		/* Macros: */
  			/** Button mask for the first button on the board. */
  			#define BUTTONS_BUTTON1          // TODO: Add mask for first board button here
  
  		/* Inline Functions: */
  		#if !defined(__DOXYGEN__)
  			static inline void Buttons_Init(void)
  			{
  				// TODO: Initialize the appropriate port pins as an inputs here, with pull-ups
  			}
  
  			static inline void Buttons_Disable(void)
  			{
  				// TODO: Clear the appropriate port pins as high impedance inputs here
  			}
  
  			static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
  			static inline uint8_t Buttons_GetStatus(void)
  			{
  				// TODO: Return current button status here, debounced if required
  			}
  		#endif
  
  	/* Disable C linkage for C++ Compilers: */
  		#if defined(__cplusplus)
  			}
  		#endif
  
  #endif