Statistics
| Branch: | Tag: | Revision:

amiro-lld / include / TPS6211x / v1 / alld_TPS6211x_v1.h @ 1d5bcc82

History | View | Annotate | Download (3.59 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 1d5bcc82 Thomas Schöpping
 * @file    alld_TPS6211x_v1.h
21 5e2f673b Marc Rothmann
 * @brief   Step-Down Converter macros and structures.
22
 *
23
 * @addtogroup lld_stepdown
24
 * @{
25
 */
26
27 1d5bcc82 Thomas Schöpping
#ifndef AMIROLLD_TPS6211X_V1_H
28
#define AMIROLLD_TPS6211X_V1_H
29 d6728c5b Thomas Schöpping
30
#include <amiro-lld.h>
31
32 1d5bcc82 Thomas Schöpping
#if (defined(AMIROLLD_CFG_TPS6211x) && (AMIROLLD_CFG_TPS6211x == 1)) || defined(__DOXYGEN__)
33 d6728c5b Thomas Schöpping
34 ef078306 Thomas Schöpping
/******************************************************************************/
35
/* CONSTANTS                                                                  */
36
/******************************************************************************/
37
38 d6728c5b Thomas Schöpping
/**
39
 * @brief   Power pin active state.
40
 */
41 1d5bcc82 Thomas Schöpping
#define TPS6211x_LLD_POWER_ACTIVE_STATE   APAL_GPIO_ACTIVE_HIGH
42 d6728c5b Thomas Schöpping
43 ef078306 Thomas Schöpping
/******************************************************************************/
44
/* SETTINGS                                                                   */
45
/******************************************************************************/
46
47
/******************************************************************************/
48
/* CHECKS                                                                     */
49
/******************************************************************************/
50
51
/******************************************************************************/
52
/* DATA STRUCTURES AND TYPES                                                  */
53
/******************************************************************************/
54
55 d6728c5b Thomas Schöpping
/**
56 1d5bcc82 Thomas Schöpping
 * @brief The TPS6211x driver struct.
57 d6728c5b Thomas Schöpping
 */
58
typedef struct {
59 11500ad8 Thomas Schöpping
  const apalControlGpio_t* gpio_power;  /**< GPIO to turn power on/off */
60 1d5bcc82 Thomas Schöpping
} TPS6211xDriver;
61 d6728c5b Thomas Schöpping
62
/**
63
 * @brief Power enable enum.
64
 */
65
typedef enum {
66 1d5bcc82 Thomas Schöpping
  TPS6211x_LLD_POWER_ENABLED  = 0x01,
67
  TPS6211x_LLD_POWER_DISABLED = 0x00,
68
} tps6211x_lld_power_en_t;
69 d6728c5b Thomas Schöpping
70 ef078306 Thomas Schöpping
/******************************************************************************/
71
/* MACROS                                                                     */
72
/******************************************************************************/
73
74
/******************************************************************************/
75
/* EXTERN DECLARATIONS                                                        */
76
/******************************************************************************/
77
78 d6728c5b Thomas Schöpping
#ifdef __cplusplus
79
extern "C" {
80
#endif
81 1d5bcc82 Thomas Schöpping
  apalExitStatus_t tps6211x_lld_get_power_en(const TPS6211xDriver* const tps6211x, tps6211x_lld_power_en_t* const power);
82
  apalExitStatus_t tps6211x_lld_set_power_en(const TPS6211xDriver* const tps6211x, const tps6211x_lld_power_en_t power);
83 d6728c5b Thomas Schöpping
#ifdef __cplusplus
84
}
85
#endif
86
87 ef078306 Thomas Schöpping
/******************************************************************************/
88
/* INLINE FUNCTIONS                                                           */
89
/******************************************************************************/
90
91 1d5bcc82 Thomas Schöpping
#endif /* defined(AMIROLLD_CFG_TPS6211x) && (AMIROLLD_CFG_TPS6211x == 1) */
92 d6728c5b Thomas Schöpping
93 1d5bcc82 Thomas Schöpping
#endif /* AMIROLLD_TPS6211X_V1_H */
94 5e2f673b Marc Rothmann
95
/** @} */