led.h
2.78 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
/*
* Copyright (C) 2016 Freie Universität Berlin
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @defgroup drivers_led Control on-board LEDs
* @ingroup drivers
* @brief Access macros to control the on-board LEDs
*
* This header contains a set of macros for controlling the on-board LEDs of
* a board. The LEDs are enumerated, starting from LED0 to LED7. As most
* platforms have a different number of LEDs, the existing ones are mapped onto
* the lowest LED numbers, while the higher LED numbers will simply be empty
* defines. This ensures, that the LED macros are portable to any platform with
* any number of LEDs.
*
* Providing access macros to 8 LEDs is a random decision, as currently 8 is the
* maximum number of on-board LEDs found on any board in RIOT (stm32f3discovery).
*
* @{
*
* @file
* @brief Macros for controlling the on-board LEDs
*
* @author Hauke Petersen <hauke.petersen@fu-berlin.de>
*/
#ifndef LED_H_
#define LED_H_
#include "board.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief LED fallback macros
* @{
*/
#ifndef LED0_ON
#define LED0_ON /* defined empty */
#define LED0_OFF /* defined empty */
#define LED0_TOGGLE /* defined empty */
#endif
#ifndef LED1_ON
#define LED1_ON /* defined empty */
#define LED1_OFF /* defined empty */
#define LED1_TOGGLE /* defined empty */
#endif
#ifndef LED2_ON
#define LED2_ON /* defined empty */
#define LED2_OFF /* defined empty */
#define LED2_TOGGLE /* defined empty */
#endif
#ifndef LED3_ON
#define LED3_ON /* defined empty */
#define LED3_OFF /* defined empty */
#define LED3_TOGGLE /* defined empty */
#endif
#ifndef LED4_ON
#define LED4_ON /* defined empty */
#define LED4_OFF /* defined empty */
#define LED4_TOGGLE /* defined empty */
#endif
#ifndef LED5_ON
#define LED5_ON /* defined empty */
#define LED5_OFF /* defined empty */
#define LED5_TOGGLE /* defined empty */
#endif
#ifndef LED6_ON
#define LED6_ON /* defined empty */
#define LED6_OFF /* defined empty */
#define LED6_TOGGLE /* defined empty */
#endif
#ifndef LED7_ON
#define LED7_ON /* defined empty */
#define LED7_OFF /* defined empty */
#define LED7_TOGGLE /* defined empty */
#endif
/** @} */
/**
* @brief Convenience LED control macros
* @{
*/
#define LED_ON(x) LED ## x ##_ON
#define LED_OFF(x) LED ## x ## _OFF
#define LED_TOGGLE(x) LED ## x ##_TOGGLE
/** @} */
#ifdef __cplusplus
}
#endif
#endif /* LED_H_ */
/** @} */