Statistics
| Branch: | Tag: | Revision:

amiro-lld / include / alld_tps2051bdbv.h @ ef078306

History | View | Annotate | Download (4.01 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_tps2051bdbv.h
21
 * @brief   Power-Distribution Switch macros and structures.
22
 *
23
 * @addtogroup lld_switch
24
 * @{
25
 */
26

    
27
#ifndef AMIROLLD_TPS2051B_H
28
#define AMIROLLD_TPS2051B_H
29

    
30
#include <amiro-lld.h>
31

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

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

    
38
/**
39
 * @brief   Enable pin active state.
40
 */
41
#define TPS2051B_LLD_ENABLE_ACTIVE_STATE        APAL_GPIO_ACTIVE_HIGH
42

    
43
/**
44
 * @brief   Overcurrent pin active state.
45
 */
46
#define TPS2051B_LLD_OVERCURRENT_ACTIVE_STATE   APAL_GPIO_ACTIVE_LOW
47

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

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

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

    
60
/**
61
 * @brief The TPS2051B driver struct.
62
 */
63
typedef struct {
64
  const apalControlGpio_t* enable;        /**< @brief GPIO to enable/disable the tps2051b. */
65
  const apalControlGpio_t* overcurrent;   /**< @brief GPIO to indicate overcurrent */
66
} TPS2051BDriver;
67

    
68
/**
69
 * @brief Enable/Disable enum.
70
 */
71
typedef enum {
72
  TPS2051B_LLD_ENABLE = 0x01,
73
  TPS2051B_LLD_DISABLE = 0x00,
74
} tps2051b_lld_enable_t;
75

    
76
/**
77
 * @brief Overcurrent enum.
78
 */
79
typedef enum {
80
  TPS2051B_LLD_OVERCURRENT = 0x01,
81
  TPS2051B_LLD_NO_OVERCURRENT = 0x00,
82
} tps2051b_lld_overcurrent_t;
83

    
84
/******************************************************************************/
85
/* MACROS                                                                     */
86
/******************************************************************************/
87

    
88
/******************************************************************************/
89
/* EXTERN DECLARATIONS                                                        */
90
/******************************************************************************/
91

    
92
#ifdef __cplusplus
93
extern "C" {
94
#endif
95
  apalExitStatus_t tps2051b_lld_set_enable(const TPS2051BDriver* const tps2051b, const tps2051b_lld_enable_t enable);
96
  apalExitStatus_t tps2051b_lld_read_enable(const TPS2051BDriver* const tps2051b, tps2051b_lld_enable_t* const enable);
97
  apalExitStatus_t tps2051b_lld_read_overcurrent(const TPS2051BDriver* const tps2051b, tps2051b_lld_overcurrent_t* const oc);
98
#ifdef __cplusplus
99
}
100
#endif
101

    
102
/******************************************************************************/
103
/* INLINE FUNCTIONS                                                           */
104
/******************************************************************************/
105

    
106
#endif /* defined(AMIROLLD_CFG_USE_TPS2051BDBV) */
107

    
108
#endif /* AMIROLLD_TPS2051B_H */
109

    
110
/** @} */