Statistics
| Branch: | Tag: | Revision:

amiro-lld / source / TPS20xxB / v1 / alld_TPS20xxB_v1.c @ de56f814

History | View | Annotate | Download (4.247 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_TPS20xxB_v1.c
21
 * @brief   Power-Distribution function implementations.
22
 *
23
 * @addtogroup lld_switch
24
 * @{
25
 */
26

    
27
#include <alld_TPS20xxB.h>
28

    
29
#if (defined(AMIROLLD_CFG_TPS20xxB) && (AMIROLLD_CFG_TPS20xxB == 1)) || defined(__DOXYGEN__)
30

    
31
/******************************************************************************/
32
/* LOCAL DEFINITIONS                                                          */
33
/******************************************************************************/
34

    
35
/******************************************************************************/
36
/* EXPORTED VARIABLES                                                         */
37
/******************************************************************************/
38

    
39
/******************************************************************************/
40
/* LOCAL TYPES                                                                */
41
/******************************************************************************/
42

    
43
/******************************************************************************/
44
/* LOCAL VARIABLES                                                            */
45
/******************************************************************************/
46

    
47
/******************************************************************************/
48
/* LOCAL FUNCTIONS                                                            */
49
/******************************************************************************/
50

    
51
/******************************************************************************/
52
/* EXPORTED FUNCTIONS                                                         */
53
/******************************************************************************/
54

    
55
/**
56
 * @brief Set the laser_en GPIO pin.
57
 * @param[in]   tpsd        TPS20xxB driver
58
 * @param[in]   enable      new state of the pin
59
 * @return                  An indicator whether the call was successfull
60
 */
61
apalExitStatus_t tps20xxb_lld_set_enable(const TPS20xxBDriver* const tps20xxb, const tps20xxb_lld_enable_t enable)
62
{
63
  apalDbgAssert(tps20xxb != NULL);
64

    
65
  return apalControlGpioSet(tps20xxb->enable, enable == TPS20xxB_LLD_ENABLE ? APAL_GPIO_ON : APAL_GPIO_OFF);
66
}
67

    
68
/**
69
 * @brief Read the laser_en GPIO pin.
70
 * @param[in]   tpsd        TPS20xxB driver
71
 * @param[out]  enable      state of the enable pin
72
 * @return                  An indicator whether the call was successfull
73
 */
74
apalExitStatus_t tps20xxb_lld_read_enable(const TPS20xxBDriver* const tps20xxb, tps20xxb_lld_enable_t* const enable)
75
{
76
  apalDbgAssert(tps20xxb != NULL);
77
  apalDbgAssert(enable != NULL);
78

    
79
  apalControlGpioState_t gpio_state;
80
  apalExitStatus_t status = apalControlGpioGet(tps20xxb->enable, &gpio_state);
81
  *enable = gpio_state == APAL_GPIO_ON ? TPS20xxB_LLD_ENABLE : TPS20xxB_LLD_DISABLE;
82
  return status;
83
}
84

    
85
/**
86
 * @brief Read the laser_oc GPIO pin.
87
 * @param[in]   tpsd        TPS20xxB driver
88
 * @param[out]  oc          state of the overcurrent pin
89
 * @return                  An indicator whether the call was successfull
90
 */
91
apalExitStatus_t tps20xxb_lld_read_overcurrent(const TPS20xxBDriver* const tps20xxb, tps20xxb_lld_overcurrent_t* const oc)
92
{
93
  apalDbgAssert(tps20xxb != NULL);
94
  apalDbgAssert(oc != NULL);
95

    
96
  apalControlGpioState_t gpio_state;
97
  apalExitStatus_t status = apalControlGpioGet(tps20xxb->overcurrent, &gpio_state);
98
  *oc = gpio_state == APAL_GPIO_ON ? TPS20xxB_LLD_OVERCURRENT : TPS20xxB_LLD_NO_OVERCURRENT;
99
  return status;
100
}
101

    
102
#endif /* defined(AMIROLLD_CFG_TPS20xxB) && (AMIROLLD_CFG_TPS20xxB == 1) */
103

    
104
/** @} */