Statistics
| Branch: | Tag: | Revision:

amiro-lld / include / alld_tps2051bdbv.h @ 8c47f14b

History | View | Annotate | Download (2.35 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
 * @brief   Enable pin active state.
36
 */
37
#define TPS2051B_LLD_ENABLE_ACTIVE_STATE        APAL_GPIO_ACTIVE_HIGH
38

    
39
/**
40
 * @brief   Overcurrent pin active state.
41
 */
42
#define TPS2051B_LLD_OVERCURRENT_ACTIVE_STATE   APAL_GPIO_ACTIVE_LOW
43

    
44
/**
45
 * @brief The TPS2051B driver struct.
46
 */
47
typedef struct {
48
  const apalControlGpio_t* enable;        /**< @brief GPIO to enable/disable the tps2051b. */
49
  const apalControlGpio_t* overcurrent;   /**< @brief GPIO to indicate overcurrent */
50
} TPS2051BDriver;
51

    
52
/**
53
 * @brief Enable/Disable enum.
54
 */
55
typedef enum {
56
  TPS2051B_LLD_ENABLE = 0x01,
57
  TPS2051B_LLD_DISABLE = 0x00,
58
} tps2051b_lld_enable_t;
59

    
60
/**
61
 * @brief Overcurrent enum.
62
 */
63
typedef enum {
64
  TPS2051B_LLD_OVERCURRENT = 0x01,
65
  TPS2051B_LLD_NO_OVERCURRENT = 0x00,
66
} tps2051b_lld_overcurrent_t;
67

    
68
#ifdef __cplusplus
69
extern "C" {
70
#endif
71
  apalExitStatus_t tps2051b_lld_set_enable(const TPS2051BDriver* const tps2051b, const tps2051b_lld_enable_t enable);
72
  apalExitStatus_t tps2051b_lld_read_enable(const TPS2051BDriver* const tps2051b, tps2051b_lld_enable_t* const enable);
73
  apalExitStatus_t tps2051b_lld_read_overcurrent(const TPS2051BDriver* const tps2051b, tps2051b_lld_overcurrent_t* const oc);
74
#ifdef __cplusplus
75
}
76
#endif
77

    
78
#endif /* defined(AMIROLLD_CFG_USE_TPS2051BDBV) */
79

    
80
#endif /* AMIROLLD_TPS2051B_H */
81

    
82
/** @} */