amiro-lld / include / LED / v1 / alld_LED_v1.h @ 1d5bcc82
History | View | Annotate | Download (3.57 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_v1.h
|
21 |
* @brief Led macros and structures.
|
22 |
*
|
23 |
* @addtogroup lld_led
|
24 |
* @{
|
25 |
*/
|
26 |
|
27 |
#ifndef AMIROLLD_LED_V1_H
|
28 |
#define AMIROLLD_LED_V1_H
|
29 |
|
30 |
#include <amiro-lld.h> |
31 |
|
32 |
#if (defined(AMIROLLD_CFG_LED) && (AMIROLLD_CFG_LED == 1)) || defined(__DOXYGEN__) |
33 |
|
34 |
/******************************************************************************/
|
35 |
/* CONSTANTS */
|
36 |
/******************************************************************************/
|
37 |
|
38 |
/**
|
39 |
* @brief Active state of LED GPIO (low active).
|
40 |
*/
|
41 |
#define LED_LLD_GPIO_ACTIVE_STATE APAL_GPIO_ACTIVE_LOW
|
42 |
|
43 |
/******************************************************************************/
|
44 |
/* SETTINGS */
|
45 |
/******************************************************************************/
|
46 |
|
47 |
/******************************************************************************/
|
48 |
/* CHECKS */
|
49 |
/******************************************************************************/
|
50 |
|
51 |
/******************************************************************************/
|
52 |
/* DATA STRUCTURES AND TYPES */
|
53 |
/******************************************************************************/
|
54 |
|
55 |
/**
|
56 |
* @brief LED driver data structure.
|
57 |
*/
|
58 |
typedef struct { |
59 |
const apalControlGpio_t* gpio; /**< @brief The identifier of the GPIO. */ |
60 |
} LEDDriver; |
61 |
|
62 |
/**
|
63 |
* @brief The state of the LED.
|
64 |
*/
|
65 |
typedef enum { |
66 |
LED_LLD_STATE_OFF = 0x00, /**< 'on' state of the LED */ |
67 |
LED_LLD_STATE_ON = 0x01, /**< 'off' state of the LED */ |
68 |
} led_lld_state_t; |
69 |
|
70 |
/******************************************************************************/
|
71 |
/* MACROS */
|
72 |
/******************************************************************************/
|
73 |
|
74 |
/******************************************************************************/
|
75 |
/* EXTERN DECLARATIONS */
|
76 |
/******************************************************************************/
|
77 |
|
78 |
#ifdef __cplusplus
|
79 |
extern "C" { |
80 |
#endif
|
81 |
apalExitStatus_t led_lld_set(const LEDDriver* const led, const led_lld_state_t state); |
82 |
apalExitStatus_t led_lld_get(const LEDDriver* const led, led_lld_state_t* const state); |
83 |
apalExitStatus_t led_lld_toggle(const LEDDriver* const led); |
84 |
#ifdef __cplusplus
|
85 |
} |
86 |
#endif
|
87 |
|
88 |
/******************************************************************************/
|
89 |
/* INLINE FUNCTIONS */
|
90 |
/******************************************************************************/
|
91 |
|
92 |
#endif /* defined(AMIROLLD_CFG_LED) && (AMIROLLD_CFG_LED == 1) */ |
93 |
|
94 |
#endif /* AMIROLLD_LED_V1_H */ |
95 |
|
96 |
/** @} */
|