amiro-lld / include / alld_ltc4412.h @ 8c47f14b
History | View | Annotate | Download (2.14 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 | f125ae07 | Thomas Schöpping | Copyright (C) 2016..2019 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 | * @file alld_ltc4412.h
|
||
21 | * @brief PowerPath Controller macros and structures.
|
||
22 | *
|
||
23 | * @addtogroup lld_powerpath
|
||
24 | * @{
|
||
25 | */
|
||
26 | |||
27 | 8c47f14b | Thomas Schöpping | #ifndef AMIROLLD_LTC4412_H
|
28 | #define AMIROLLD_LTC4412_H
|
||
29 | d6728c5b | Thomas Schöpping | |
30 | #include <amiro-lld.h> |
||
31 | |||
32 | #if defined(AMIROLLD_CFG_USE_LTC4412) || defined(__DOXYGEN__)
|
||
33 | |||
34 | /**
|
||
35 | * @brief CTRL GPIO active state.
|
||
36 | */
|
||
37 | #define LTC4412_LLD_CTRL_ACTIVE_STATE APAL_GPIO_ACTIVE_HIGH
|
||
38 | |||
39 | /**
|
||
40 | * @brief STAT GPIO active state.
|
||
41 | */
|
||
42 | #define LTC4412_LLD_STAT_ACTIVE_STATE APAL_GPIO_ACTIVE_HIGH
|
||
43 | |||
44 | /**
|
||
45 | * @brief LTC4412 driver struct.
|
||
46 | */
|
||
47 | typedef struct { |
||
48 | 11500ad8 | Thomas Schöpping | const apalControlGpio_t* gpio_ctrl; /**< @brief Control GPIO */ |
49 | const apalControlGpio_t* gpio_stat; /**< @brief Status GPIO */ |
||
50 | d6728c5b | Thomas Schöpping | } LTC4412Driver; |
51 | |||
52 | typedef enum { |
||
53 | LTC4412_LLD_CTRL_INACTIVE = 0x0,
|
||
54 | LTC4412_LLD_CTRL_ACTIVE = 0x1,
|
||
55 | } ltc4412_lld_ctrl_t; |
||
56 | |||
57 | typedef enum { |
||
58 | LTC4412_LLD_STAT_INACTIVE = 0x0,
|
||
59 | LTC4412_LLD_STAT_ACTIVE = 0x1,
|
||
60 | } ltc4412_lld_stat_t; |
||
61 | |||
62 | #ifdef __cplusplus
|
||
63 | extern "C" { |
||
64 | #endif
|
||
65 | apalExitStatus_t ltc4412_lld_get_ctrl(const LTC4412Driver* const ltc4412, ltc4412_lld_ctrl_t* const ctrl); |
||
66 | apalExitStatus_t ltc4412_lld_set_ctrl(const LTC4412Driver* const ltc4412, const ltc4412_lld_ctrl_t ctrl); |
||
67 | apalExitStatus_t ltc4412_lld_get_stat(const LTC4412Driver* const ltc4412, ltc4412_lld_stat_t* const stat); |
||
68 | #ifdef __cplusplus
|
||
69 | } |
||
70 | #endif
|
||
71 | |||
72 | #endif /* defined(AMIROLLD_CFG_USE_LTC4412) */ |
||
73 | |||
74 | 8c47f14b | Thomas Schöpping | #endif /* AMIROLLD_LTC4412_H */ |
75 | 5e2f673b | Marc Rothmann | |
76 | /** @} */ |