Statistics
| Branch: | Tag: | Revision:

amiro-lld / drivers / LED / v1 / alld_LED.c @ f69ec051

History | View | Annotate | Download (3.656 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 f69ec051 Thomas Schöpping
Copyright (C) 2016..2020  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 9466e34d Thomas Schöpping
 * @file    alld_LED.c
21 5e2f673b Marc Rothmann
 * @brief   Led function implementations.
22
 *
23
 * @addtogroup lld_led
24
 * @{
25
 */
26
27 1d5bcc82 Thomas Schöpping
#include <alld_LED.h>
28 d6728c5b Thomas Schöpping
29 ef078306 Thomas Schöpping
/******************************************************************************/
30
/* LOCAL DEFINITIONS                                                          */
31
/******************************************************************************/
32
33
/******************************************************************************/
34
/* EXPORTED VARIABLES                                                         */
35
/******************************************************************************/
36
37
/******************************************************************************/
38
/* LOCAL TYPES                                                                */
39
/******************************************************************************/
40
41
/******************************************************************************/
42
/* LOCAL VARIABLES                                                            */
43
/******************************************************************************/
44
45
/******************************************************************************/
46
/* LOCAL FUNCTIONS                                                            */
47
/******************************************************************************/
48
49
/******************************************************************************/
50
/* EXPORTED FUNCTIONS                                                         */
51
/******************************************************************************/
52
53 d6728c5b Thomas Schöpping
/**
54
 * @brief Set the LED to a specific state.
55
 * @param[in]   ledp        The LED driver object.
56
 * @param[in]   led_state   The state to set the LED to.
57
 * @return                  An indicator whether the call was successful.
58
 */
59 21076167 Thomas Schöpping
apalExitStatus_t led_lld_set(const LEDDriver* const led, const led_lld_state_t state)
60 d6728c5b Thomas Schöpping
{
61
  apalDbgAssert(led != NULL);
62
63 cf1f756b Thomas Schöpping
  return apalControlGpioSet(led->gpio, (state == LED_LLD_STATE_ON) ? APAL_GPIO_ON : APAL_GPIO_OFF);
64 d6728c5b Thomas Schöpping
}
65
66
/**
67
 * @brief Get the current status of the LED.
68
 * @param[in]   ledp        The LED driver object.
69
 * @param[out]  led_state   The state object to fill.
70
 * @return                  An indicator whether the call was successful.
71
 */
72 21076167 Thomas Schöpping
apalExitStatus_t led_lld_get(const LEDDriver* const led, led_lld_state_t* const state)
73 d6728c5b Thomas Schöpping
{
74
  apalDbgAssert(led != NULL);
75
  apalDbgAssert(state != NULL);
76
77
  apalControlGpioState_t gpio_state;
78 cf1f756b Thomas Schöpping
  apalExitStatus_t status = apalControlGpioGet(led->gpio, &gpio_state);
79 d6728c5b Thomas Schöpping
  *state = gpio_state == APAL_GPIO_ON ? LED_LLD_STATE_ON : LED_LLD_STATE_OFF;
80
  return status;
81
}
82
83
/**
84
 * @brief Toggle the LED.
85
 * @param[in]   ledp        The LED driver object.
86
 * @return                  An indicator whether the call was successful.
87
 */
88 21076167 Thomas Schöpping
apalExitStatus_t led_lld_toggle(const LEDDriver* const led)
89 d6728c5b Thomas Schöpping
{
90
  apalDbgAssert(led != NULL);
91
92 cf1f756b Thomas Schöpping
  return apalGpioToggle(led->gpio->gpio);
93 d6728c5b Thomas Schöpping
}
94
95 5e2f673b Marc Rothmann
/** @} */