amiro-lld / include / MIC9404x / v1 / alld_MIC9404x_v1.h @ 6ef38c23
History | View | Annotate | Download (3.665 KB)
| 1 | 78cc79d4 | Thomas Schöpping | /*
|
|---|---|---|---|
| 2 | AMiRo-LLD is a compilation of low-level hardware drivers for the Autonomous Mini Robot (AMiRo) platform.
|
||
| 3 | Copyright (C) 2016..2019 Thomas Schöpping et al.
|
||
| 4 | |||
| 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_MIC9404x_v1.h
|
||
| 21 | * @brief MIC9404x power switch macros and structures.
|
||
| 22 | *
|
||
| 23 | * @addtogroup lld_powerswitch
|
||
| 24 | * @{
|
||
| 25 | */
|
||
| 26 | |||
| 27 | #ifndef AMIROLLD_MIC9404x_V1_H
|
||
| 28 | #define AMIROLLD_MIC9404x_V1_H
|
||
| 29 | |||
| 30 | #include <amiro-lld.h> |
||
| 31 | |||
| 32 | #if (defined(AMIROLLD_CFG_MIC9404x) && (AMIROLLD_CFG_MIC9404x == 1)) || defined(__DOXYGEN__) |
||
| 33 | |||
| 34 | /******************************************************************************/
|
||
| 35 | /* CONSTANTS */
|
||
| 36 | /******************************************************************************/
|
||
| 37 | |||
| 38 | /**
|
||
| 39 | * @brief Active state of EN GPIO (active high).
|
||
| 40 | */
|
||
| 41 | #define MIC9404x_LLD_EN_ACTIVE_STATE APAL_GPIO_ACTIVE_HIGH
|
||
| 42 | |||
| 43 | /******************************************************************************/
|
||
| 44 | /* SETTINGS */
|
||
| 45 | /******************************************************************************/
|
||
| 46 | |||
| 47 | /******************************************************************************/
|
||
| 48 | /* CHECKS */
|
||
| 49 | /******************************************************************************/
|
||
| 50 | |||
| 51 | /******************************************************************************/
|
||
| 52 | /* DATA STRUCTURES AND TYPES */
|
||
| 53 | /******************************************************************************/
|
||
| 54 | |||
| 55 | /**
|
||
| 56 | * @brief MIC9404x driver data structure.
|
||
| 57 | */
|
||
| 58 | typedef struct { |
||
| 59 | const apalControlGpio_t* en; /**< @brief The identifier of the EN GPIO. */ |
||
| 60 | } MIC9404xDriver; |
||
| 61 | |||
| 62 | /**
|
||
| 63 | * @brief The state of the MIC9404x.
|
||
| 64 | */
|
||
| 65 | typedef enum { |
||
| 66 | MIC9404x_LLD_STATE_OFF = 0x00, /**< 'on' state of the MIC9404x */ |
||
| 67 | MIC9404x_LLD_STATE_ON = 0x01, /**< 'off' state of the MIC9404x */ |
||
| 68 | } mic9404x_lld_state_t; |
||
| 69 | |||
| 70 | /******************************************************************************/
|
||
| 71 | /* MACROS */
|
||
| 72 | /******************************************************************************/
|
||
| 73 | |||
| 74 | /******************************************************************************/
|
||
| 75 | /* EXTERN DECLARATIONS */
|
||
| 76 | /******************************************************************************/
|
||
| 77 | |||
| 78 | #ifdef __cplusplus
|
||
| 79 | extern "C" { |
||
| 80 | #endif
|
||
| 81 | apalExitStatus_t mic9404x_lld_set(const MIC9404xDriver* const mic9404x, const mic9404x_lld_state_t state); |
||
| 82 | apalExitStatus_t mic9404x_lld_get(const MIC9404xDriver* const mic9404x, mic9404x_lld_state_t* const state); |
||
| 83 | #ifdef __cplusplus
|
||
| 84 | } |
||
| 85 | #endif
|
||
| 86 | |||
| 87 | /******************************************************************************/
|
||
| 88 | /* INLINE FUNCTIONS */
|
||
| 89 | /******************************************************************************/
|
||
| 90 | |||
| 91 | #endif /* defined(AMIROLLD_CFG_MIC9404x) && (AMIROLLD_CFG_MIC9404x == 1) */ |
||
| 92 | |||
| 93 | #endif /* AMIROLLD_MIC9404x_V1_H */ |
||
| 94 | |||
| 95 | /** @} */ |