Statistics
| Branch: | Tag: | Revision:

amiro-lld / include / alld_ltc4412.h @ ef078306

History | View | Annotate | Download (3.81 KB)

1
/*
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_ltc4412.h
21
 * @brief   PowerPath Controller macros and structures.
22
 *
23
 * @addtogroup lld_powerpath
24
 * @{
25
 */
26

    
27
#ifndef AMIROLLD_LTC4412_H
28
#define AMIROLLD_LTC4412_H
29

    
30
#include <amiro-lld.h>
31

    
32
#if defined(AMIROLLD_CFG_USE_LTC4412) || defined(__DOXYGEN__)
33

    
34
/******************************************************************************/
35
/* CONSTANTS                                                                  */
36
/******************************************************************************/
37

    
38
/**
39
 * @brief CTRL GPIO active state.
40
 */
41
#define LTC4412_LLD_CTRL_ACTIVE_STATE   APAL_GPIO_ACTIVE_HIGH
42

    
43
/**
44
 * @brief STAT GPIO active state.
45
 */
46
#define LTC4412_LLD_STAT_ACTIVE_STATE   APAL_GPIO_ACTIVE_HIGH
47

    
48
/******************************************************************************/
49
/* SETTINGS                                                                   */
50
/******************************************************************************/
51

    
52
/******************************************************************************/
53
/* CHECKS                                                                     */
54
/******************************************************************************/
55

    
56
/******************************************************************************/
57
/* DATA STRUCTURES AND TYPES                                                  */
58
/******************************************************************************/
59

    
60
/**
61
 * @brief LTC4412 driver struct.
62
 */
63
typedef struct {
64
  const apalControlGpio_t* gpio_ctrl;   /**< @brief Control GPIO */
65
  const apalControlGpio_t* gpio_stat;   /**< @brief Status GPIO */
66
} LTC4412Driver;
67

    
68
typedef enum {
69
  LTC4412_LLD_CTRL_INACTIVE = 0x0,
70
  LTC4412_LLD_CTRL_ACTIVE   = 0x1,
71
} ltc4412_lld_ctrl_t;
72

    
73
typedef enum {
74
  LTC4412_LLD_STAT_INACTIVE = 0x0,
75
  LTC4412_LLD_STAT_ACTIVE   = 0x1,
76
} ltc4412_lld_stat_t;
77

    
78
/******************************************************************************/
79
/* MACROS                                                                     */
80
/******************************************************************************/
81

    
82
/******************************************************************************/
83
/* EXTERN DECLARATIONS                                                        */
84
/******************************************************************************/
85

    
86
#ifdef __cplusplus
87
extern "C" {
88
#endif
89
  apalExitStatus_t ltc4412_lld_get_ctrl(const LTC4412Driver* const ltc4412, ltc4412_lld_ctrl_t* const ctrl);
90
  apalExitStatus_t ltc4412_lld_set_ctrl(const LTC4412Driver* const ltc4412, const ltc4412_lld_ctrl_t ctrl);
91
  apalExitStatus_t ltc4412_lld_get_stat(const LTC4412Driver* const ltc4412, ltc4412_lld_stat_t* const stat);
92
#ifdef __cplusplus
93
}
94
#endif
95

    
96
/******************************************************************************/
97
/* INLINE FUNCTIONS                                                           */
98
/******************************************************************************/
99

    
100
#endif /* defined(AMIROLLD_CFG_USE_LTC4412) */
101

    
102
#endif /* AMIROLLD_LTC4412_H */
103

    
104
/** @} */