Statistics
| Branch: | Tag: | Revision:

amiro-lld / drivers / TPS6211x / v1 / alld_TPS6211x.h @ f69ec051

History | View | Annotate | Download (3.41 KB)

1
/*
2
AMiRo-LLD is a compilation of low-level hardware drivers for the Autonomous Mini Robot (AMiRo) platform.
3
Copyright (C) 2016..2020  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_TPS6211x.h
21
 * @brief   Step-Down Converter macros and structures.
22
 *
23
 * @addtogroup lld_stepdown
24
 * @{
25
 */
26

    
27
#ifndef AMIROLLD_TPS6211X_H
28
#define AMIROLLD_TPS6211X_H
29

    
30
#include <amiro-lld.h>
31

    
32
/******************************************************************************/
33
/* CONSTANTS                                                                  */
34
/******************************************************************************/
35

    
36
/**
37
 * @brief   Power pin active state.
38
 */
39
#define TPS6211x_LLD_POWER_ACTIVE_STATE   APAL_GPIO_ACTIVE_HIGH
40

    
41
/******************************************************************************/
42
/* SETTINGS                                                                   */
43
/******************************************************************************/
44

    
45
/******************************************************************************/
46
/* CHECKS                                                                     */
47
/******************************************************************************/
48

    
49
/******************************************************************************/
50
/* DATA STRUCTURES AND TYPES                                                  */
51
/******************************************************************************/
52

    
53
/**
54
 * @brief The TPS6211x driver struct.
55
 */
56
typedef struct {
57
  const apalControlGpio_t* gpio_power;  /**< GPIO to turn power on/off */
58
} TPS6211xDriver;
59

    
60
/**
61
 * @brief Power enable enum.
62
 */
63
typedef enum {
64
  TPS6211x_LLD_POWER_ENABLED  = 0x01,
65
  TPS6211x_LLD_POWER_DISABLED = 0x00,
66
} tps6211x_lld_power_en_t;
67

    
68
/******************************************************************************/
69
/* MACROS                                                                     */
70
/******************************************************************************/
71

    
72
/******************************************************************************/
73
/* EXTERN DECLARATIONS                                                        */
74
/******************************************************************************/
75

    
76
#ifdef __cplusplus
77
extern "C" {
78
#endif
79
  apalExitStatus_t tps6211x_lld_get_power_en(const TPS6211xDriver* const tps6211x, tps6211x_lld_power_en_t* const power);
80
  apalExitStatus_t tps6211x_lld_set_power_en(const TPS6211xDriver* const tps6211x, const tps6211x_lld_power_en_t power);
81
#ifdef __cplusplus
82
}
83
#endif
84

    
85
/******************************************************************************/
86
/* INLINE FUNCTIONS                                                           */
87
/******************************************************************************/
88

    
89
#endif /* AMIROLLD_TPS6211X_H */
90

    
91
/** @} */
92