amiro-lld / drivers / switch / v1 / alld_switch.h @ ed9a1bf5
History | View | Annotate | Download (3.215 KB)
| 1 | df051abd | 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 | df051abd | Thomas Schöpping | |
| 5 | This program is free software: you can redistribute it and/or modify
|
||
| 6 | it under the terms of the GNU Lesser General Public License as published by
|
||
| 7 | 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 | GNU Lesser General Public License for more details.
|
||
| 14 | |||
| 15 | You should have received a copy of the GNU Lesser General Public License
|
||
| 16 | along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||
| 17 | */
|
||
| 18 | |||
| 19 | /**
|
||
| 20 | * @file alld_switch.h
|
||
| 21 | * @brief Switch macros and structures.
|
||
| 22 | *
|
||
| 23 | * @addtogroup lld_switch
|
||
| 24 | * @{
|
||
| 25 | */
|
||
| 26 | |||
| 27 | #ifndef AMIROLLD_SWITCH_H
|
||
| 28 | #define AMIROLLD_SWITCH_H
|
||
| 29 | |||
| 30 | #include <amiro-lld.h> |
||
| 31 | |||
| 32 | /******************************************************************************/
|
||
| 33 | /* CONSTANTS */
|
||
| 34 | /******************************************************************************/
|
||
| 35 | |||
| 36 | /******************************************************************************/
|
||
| 37 | /* SETTINGS */
|
||
| 38 | /******************************************************************************/
|
||
| 39 | |||
| 40 | /******************************************************************************/
|
||
| 41 | /* CHECKS */
|
||
| 42 | /******************************************************************************/
|
||
| 43 | |||
| 44 | /******************************************************************************/
|
||
| 45 | /* DATA STRUCTURES AND TYPES */
|
||
| 46 | /******************************************************************************/
|
||
| 47 | |||
| 48 | /**
|
||
| 49 | * @brief Switch driver data structure.
|
||
| 50 | */
|
||
| 51 | typedef struct { |
||
| 52 | const apalControlGpio_t* gpio; /**< @brief The identifier of the GPIO. */ |
||
| 53 | } SwitchDriver; |
||
| 54 | |||
| 55 | /**
|
||
| 56 | * @brief The state of the switch.
|
||
| 57 | */
|
||
| 58 | typedef enum { |
||
| 59 | SWITCH_LLD_STATE_OFF = 0x00, /**< 'released' state of the switch */ |
||
| 60 | SWITCH_LLD_STATE_ON = 0x01, /**< 'pressed' state of the switch */ |
||
| 61 | } switch_lld_state_t; |
||
| 62 | |||
| 63 | /******************************************************************************/
|
||
| 64 | /* MACROS */
|
||
| 65 | /******************************************************************************/
|
||
| 66 | |||
| 67 | /******************************************************************************/
|
||
| 68 | /* EXTERN DECLARATIONS */
|
||
| 69 | /******************************************************************************/
|
||
| 70 | |||
| 71 | #ifdef __cplusplus
|
||
| 72 | extern "C" { |
||
| 73 | #endif
|
||
| 74 | apalExitStatus_t switch_lld_get(const SwitchDriver* const switchp, switch_lld_state_t* const state); |
||
| 75 | #ifdef __cplusplus
|
||
| 76 | } |
||
| 77 | #endif
|
||
| 78 | |||
| 79 | /******************************************************************************/
|
||
| 80 | /* INLINE FUNCTIONS */
|
||
| 81 | /******************************************************************************/
|
||
| 82 | |||
| 83 | #endif /* AMIROLLD_SWITCH_H */ |
||
| 84 | |||
| 85 | /** @} */
|