Statistics
| Branch: | Tag: | Revision:

amiro-lld / source / alld_led.c @ 9e45662e

History | View | Annotate | Download (2.35 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_led.c
21
 * @brief   Led function implementations.
22
 *
23
 * @addtogroup lld_led
24
 * @{
25
 */
26

    
27
#include <alld_led.h>
28

    
29
#if defined(AMIROLLD_CFG_USE_LED) || defined(__DOXYGEN__)
30

    
31
/**
32
 * @brief Set the LED to a specific state.
33
 * @param[in]   ledp        The LED driver object.
34
 * @param[in]   led_state   The state to set the LED to.
35
 * @return                  An indicator whether the call was successful.
36
 */
37
inline apalExitStatus_t
38
led_lld_set(const LEDDriver* const led, const led_lld_state_t state)
39
{
40
  apalDbgAssert(led != NULL);
41

    
42
  return apalControlGpioSet(led->gpio, (state == LED_LLD_STATE_ON) ? APAL_GPIO_ON : APAL_GPIO_OFF);
43
}
44

    
45
/**
46
 * @brief Get the current status of the LED.
47
 * @param[in]   ledp        The LED driver object.
48
 * @param[out]  led_state   The state object to fill.
49
 * @return                  An indicator whether the call was successful.
50
 */
51
inline apalExitStatus_t
52
led_lld_get(const LEDDriver* const led, led_lld_state_t* const state)
53
{
54
  apalDbgAssert(led != NULL);
55
  apalDbgAssert(state != NULL);
56

    
57
  apalControlGpioState_t gpio_state;
58
  apalExitStatus_t status = apalControlGpioGet(led->gpio, &gpio_state);
59
  *state = gpio_state == APAL_GPIO_ON ? LED_LLD_STATE_ON : LED_LLD_STATE_OFF;
60
  return status;
61
}
62

    
63
/**
64
 * @brief Toggle the LED.
65
 * @param[in]   ledp        The LED driver object.
66
 * @return                  An indicator whether the call was successful.
67
 */
68
inline apalExitStatus_t
69
led_lld_toggle(const LEDDriver* const led)
70
{
71
  apalDbgAssert(led != NULL);
72

    
73
  return apalGpioToggle(led->gpio->gpio);
74
}
75

    
76
#endif /* defined(AMIROLLD_CFG_USE_LED) */
77

    
78
/** @} */