Statistics
| Branch: | Tag: | Revision:

amiro-lld / source / alld_led.c @ ef078306

History | View | Annotate | Download (3.78 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
 * @file    alld_led.c
21
 * @brief   Led function implementations.
22
 *
23
 * @addtogroup lld_led
24
 * @{
25
 */
26
27 d6728c5b Thomas Schöpping
#include <alld_led.h>
28
29
#if defined(AMIROLLD_CFG_USE_LED) || defined(__DOXYGEN__)
30
31 ef078306 Thomas Schöpping
/******************************************************************************/
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 d6728c5b Thomas Schöpping
/**
56
 * @brief Set the LED to a specific state.
57
 * @param[in]   ledp        The LED driver object.
58
 * @param[in]   led_state   The state to set the LED to.
59
 * @return                  An indicator whether the call was successful.
60
 */
61
inline apalExitStatus_t
62
led_lld_set(const LEDDriver* const led, const led_lld_state_t state)
63
{
64
  apalDbgAssert(led != NULL);
65
66 cf1f756b Thomas Schöpping
  return apalControlGpioSet(led->gpio, (state == LED_LLD_STATE_ON) ? APAL_GPIO_ON : APAL_GPIO_OFF);
67 d6728c5b Thomas Schöpping
}
68
69
/**
70
 * @brief Get the current status of the LED.
71
 * @param[in]   ledp        The LED driver object.
72
 * @param[out]  led_state   The state object to fill.
73
 * @return                  An indicator whether the call was successful.
74
 */
75
inline apalExitStatus_t
76
led_lld_get(const LEDDriver* const led, led_lld_state_t* const state)
77
{
78
  apalDbgAssert(led != NULL);
79
  apalDbgAssert(state != NULL);
80
81
  apalControlGpioState_t gpio_state;
82 cf1f756b Thomas Schöpping
  apalExitStatus_t status = apalControlGpioGet(led->gpio, &gpio_state);
83 d6728c5b Thomas Schöpping
  *state = gpio_state == APAL_GPIO_ON ? LED_LLD_STATE_ON : LED_LLD_STATE_OFF;
84
  return status;
85
}
86
87
/**
88
 * @brief Toggle the LED.
89
 * @param[in]   ledp        The LED driver object.
90
 * @return                  An indicator whether the call was successful.
91
 */
92
inline apalExitStatus_t
93
led_lld_toggle(const LEDDriver* const led)
94
{
95
  apalDbgAssert(led != NULL);
96
97 cf1f756b Thomas Schöpping
  return apalGpioToggle(led->gpio->gpio);
98 d6728c5b Thomas Schöpping
}
99
100
#endif /* defined(AMIROLLD_CFG_USE_LED) */
101 5e2f673b Marc Rothmann
102
/** @} */