Blame view

src/lufa-LUFA-170418/LUFA/Drivers/Board/AVR8/BUMBLEB/Buttons.h 3.22 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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
  /*
               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 Board specific Buttons driver header for the Fletchtronics BUMBLEB.
   *  \copydetails Group_Buttons_BUMBLEB
   *
   *  \note This file should not be included directly. It is automatically included as needed by the Buttons driver
   *        dispatch header located in LUFA/Drivers/Board/Buttons.h.
   */
  
  /** \ingroup Group_Buttons
   *  \defgroup Group_Buttons_BUMBLEB BUMBLEB
   *  \brief Board specific Buttons driver header for the Fletchtronics BUMBLEB.
   *
   *  Board specific buttons driver header for the Fletchtronics BUMBLEB (http://fletchtronics.net/bumble-b). The BUMBLEB
   *  third-party board does not include any on-board peripherals, but does have an officially recommended external peripheral
   *  layout for buttons, LEDs and a Joystick.
   *
   *  <table>
   *    <tr><th>Name</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr>
   *    <tr><td>BUTTONS_BUTTON1</td><td>HWB Button</td><td>Low</td><td>PORTD.7</td></tr>
   *  </table>
   *
   *  @{
   */
  
  #ifndef __BUTTONS_BUMBLEB_H__
  #define __BUTTONS_BUMBLEB_H__
  
  	/* Includes: */
  		#include "../../../../Common/Common.h"
  
  	/* 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      (1 << 7)
  
  		/* Inline Functions: */
  		#if !defined(__DOXYGEN__)
  			static inline void Buttons_Init(void)
  			{
  				DDRD  &= ~BUTTONS_BUTTON1;
  				PORTD |=  BUTTONS_BUTTON1;
  			}
  
  			static inline void Buttons_Disable(void)
  			{
  				DDRD  &= ~BUTTONS_BUTTON1;
  				PORTD &= ~BUTTONS_BUTTON1;
  			}
  
  			static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
  			static inline uint8_t Buttons_GetStatus(void)
  			{
  				return ((PIND & BUTTONS_BUTTON1) ^ BUTTONS_BUTTON1);
  			}
  		#endif
  
  	/* Disable C linkage for C++ Compilers: */
  		#if defined(__cplusplus)
  			}
  		#endif
  
  #endif
  
  /** @} */