amiro-lld / drivers / button / v1 / alld_button.h @ 3ed0cc4d
History | View | Annotate | Download (3.224 KB)
1 | d6728c5b | Thomas Schöpping | /*
|
---|---|---|---|
2 | AMiRo-LLD is a compilation of low-level hardware drivers for the Autonomous Mini Robot (AMiRo) platform.
|
||
3 | f69ec051 | Thomas Schöpping | Copyright (C) 2016..2020 Thomas Schöpping et al.
|
4 | d6728c5b | Thomas Schöpping | |
5 | This program is free software: you can redistribute it and/or modify
|
||
6 | f0ca400f | Thomas Schöpping | it under the terms of the GNU Lesser General Public License as published by
|
7 | d6728c5b | Thomas Schöpping | the Free Software Foundation, either version 3 of the License, or
|
8 | (at your option) any later version.
|
||
9 | |||
10 | This program is distributed in the hope that it will be useful,
|
||
11 | but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
13 | f0ca400f | Thomas Schöpping | GNU Lesser General Public License for more details.
|
14 | d6728c5b | Thomas Schöpping | |
15 | f0ca400f | Thomas Schöpping | You should have received a copy of the GNU Lesser General Public License
|
16 | d6728c5b | Thomas Schöpping | along with this program. If not, see <http://www.gnu.org/licenses/>.
|
17 | */
|
||
18 | |||
19 | 5e2f673b | Marc Rothmann | /**
|
20 | 9466e34d | Thomas Schöpping | * @file alld_button.h
|
21 | * @brief Button macros and structures.
|
||
22 | 5e2f673b | Marc Rothmann | *
|
23 | 9466e34d | Thomas Schöpping | * @addtogroup lld_button
|
24 | 5e2f673b | Marc Rothmann | * @{
|
25 | */
|
||
26 | |||
27 | 9466e34d | Thomas Schöpping | #ifndef AMIROLLD_BUTTON_H
|
28 | #define AMIROLLD_BUTTON_H
|
||
29 | d6728c5b | Thomas Schöpping | |
30 | #include <amiro-lld.h> |
||
31 | |||
32 | ef078306 | Thomas Schöpping | /******************************************************************************/
|
33 | /* CONSTANTS */
|
||
34 | /******************************************************************************/
|
||
35 | |||
36 | /******************************************************************************/
|
||
37 | /* SETTINGS */
|
||
38 | /******************************************************************************/
|
||
39 | |||
40 | /******************************************************************************/
|
||
41 | /* CHECKS */
|
||
42 | /******************************************************************************/
|
||
43 | |||
44 | /******************************************************************************/
|
||
45 | /* DATA STRUCTURES AND TYPES */
|
||
46 | /******************************************************************************/
|
||
47 | |||
48 | d6728c5b | Thomas Schöpping | /**
|
49 | 9466e34d | Thomas Schöpping | * @brief Button driver data structure.
|
50 | d6728c5b | Thomas Schöpping | */
|
51 | typedef struct { |
||
52 | 11500ad8 | Thomas Schöpping | const apalControlGpio_t* gpio; /**< @brief The identifier of the GPIO. */ |
53 | 9466e34d | Thomas Schöpping | } ButtonDriver; |
54 | d6728c5b | Thomas Schöpping | |
55 | /**
|
||
56 | 9466e34d | Thomas Schöpping | * @brief The state of the button.
|
57 | d6728c5b | Thomas Schöpping | */
|
58 | typedef enum { |
||
59 | 9466e34d | Thomas Schöpping | BUTTON_LLD_STATE_RELEASED = 0x00, /**< 'released' state of the button */ |
60 | BUTTON_LLD_STATE_PRESSED = 0x01, /**< 'pressed' state of the button */ |
||
61 | } button_lld_state_t; |
||
62 | d6728c5b | Thomas Schöpping | |
63 | ef078306 | Thomas Schöpping | /******************************************************************************/
|
64 | /* MACROS */
|
||
65 | /******************************************************************************/
|
||
66 | |||
67 | /******************************************************************************/
|
||
68 | /* EXTERN DECLARATIONS */
|
||
69 | /******************************************************************************/
|
||
70 | |||
71 | d6728c5b | Thomas Schöpping | #ifdef __cplusplus
|
72 | extern "C" { |
||
73 | #endif
|
||
74 | 9466e34d | Thomas Schöpping | apalExitStatus_t button_lld_get(const ButtonDriver* const button, button_lld_state_t* const state); |
75 | d6728c5b | Thomas Schöpping | #ifdef __cplusplus
|
76 | } |
||
77 | #endif
|
||
78 | |||
79 | ef078306 | Thomas Schöpping | /******************************************************************************/
|
80 | /* INLINE FUNCTIONS */
|
||
81 | /******************************************************************************/
|
||
82 | |||
83 | 9466e34d | Thomas Schöpping | #endif /* AMIROLLD_BUTTON_H */ |
84 | 5e2f673b | Marc Rothmann | |
85 | /** @} */
|