Statistics
| Branch: | Tag: | Revision:

amiro-lld / source / alld_led.c @ f0ca400f

History | View | Annotate | Download (2.235 KB)

1
/*
2
AMiRo-LLD is a compilation of low-level hardware drivers for the Autonomous Mini Robot (AMiRo) platform.
3
Copyright (C) 2016..2018  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
#include <alld_led.h>
20

    
21
#if defined(AMIROLLD_CFG_USE_LED) || defined(__DOXYGEN__)
22

    
23
/**
24
 * @brief Set the LED to a specific state.
25
 * @param[in]   ledp        The LED driver object.
26
 * @param[in]   led_state   The state to set the LED to.
27
 * @return                  An indicator whether the call was successful.
28
 */
29
inline apalExitStatus_t
30
led_lld_set(const LEDDriver* const led, const led_lld_state_t state)
31
{
32
  apalDbgAssert(led != NULL);
33

    
34
  return apalControlGpioSet(&(led->gpio), (state == LED_LLD_STATE_ON) ? APAL_GPIO_ON : APAL_GPIO_OFF);
35
}
36

    
37
/**
38
 * @brief Get the current status of the LED.
39
 * @param[in]   ledp        The LED driver object.
40
 * @param[out]  led_state   The state object to fill.
41
 * @return                  An indicator whether the call was successful.
42
 */
43
inline apalExitStatus_t
44
led_lld_get(const LEDDriver* const led, led_lld_state_t* const state)
45
{
46
  apalDbgAssert(led != NULL);
47
  apalDbgAssert(state != NULL);
48

    
49
  apalControlGpioState_t gpio_state;
50
  apalExitStatus_t status = apalControlGpioGet(&led->gpio, &gpio_state);
51
  *state = gpio_state == APAL_GPIO_ON ? LED_LLD_STATE_ON : LED_LLD_STATE_OFF;
52
  return status;
53
}
54

    
55
/**
56
 * @brief Toggle the LED.
57
 * @param[in]   ledp        The LED driver object.
58
 * @return                  An indicator whether the call was successful.
59
 */
60
inline apalExitStatus_t
61
led_lld_toggle(const LEDDriver* const led)
62
{
63
  apalDbgAssert(led != NULL);
64

    
65
  return apalGpioToggle(led->gpio.gpio);
66
}
67

    
68
#endif /* defined(AMIROLLD_CFG_USE_LED) */