Statistics
| Branch: | Tag: | Revision:

amiro-lld / include / alld_led.h @ fce9feec

History | View | Annotate | Download (1.84 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
/**
20
 * @file    alld_led.h
21
 * @brief   Led macros and structures.
22
 *
23
 * @addtogroup lld_led
24
 * @{
25
 */
26

    
27
#ifndef _AMIROLLD_LED_H_
28
#define _AMIROLLD_LED_H_
29

    
30
#include <amiro-lld.h>
31

    
32
#if defined(AMIROLLD_CFG_USE_LED) || defined(__DOXYGEN__)
33

    
34
/**
35
 * @brief Active state of LED GPIO (low active).
36
 */
37
#define LED_LLD_GPIO_ACTIVE_STATE APAL_GPIO_ACTIVE_LOW
38

    
39
/**
40
 * @brief LED driver data structure.
41
 */
42
typedef struct {
43
  apalControlGpio_t* gpio;  /**< @brief The identifier of the GPIO.  */
44
} LEDDriver;
45

    
46
/**
47
 * @brief The state of the LED.
48
 */
49
typedef enum {
50
  LED_LLD_STATE_OFF = 0x00,   /**< 'on' state of the LED */
51
  LED_LLD_STATE_ON  = 0x01,   /**< 'off' state of the LED */
52
} led_lld_state_t;
53

    
54
#ifdef __cplusplus
55
extern "C" {
56
#endif
57
  apalExitStatus_t led_lld_set(const LEDDriver* const led, const led_lld_state_t state);
58
  apalExitStatus_t led_lld_get(const LEDDriver* const led, led_lld_state_t* const state);
59
  apalExitStatus_t led_lld_toggle(const LEDDriver* const led);
60
#ifdef __cplusplus
61
}
62
#endif
63

    
64
#endif /* defined(AMIROLLD_CFG_USE_LED) */
65

    
66
#endif /* _AMIROLLD_LED_H_ */
67

    
68
/** @} */