blob: c8cc19b647698771ec648eca00824d945a341794 (
plain)
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
|
/*
* Copyright (C) 2016 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef SYSTEM_PERIPHERALMANAGER_LED_H_
#define SYSTEM_PERIPHERALMANAGER_LED_H_
#include <sys/cdefs.h>
#include <sys/types.h>
__BEGIN_DECLS
/// @defgroup Led Led Interface
/// @brief Functions to control onboard LEDs.
///
/// These functions can be used to query and control LEDs.
/// @{
typedef struct BLed BLed;
/// Sets the LED brightness.
/// @param led Pointer to the BLed object.
/// @param brightness Brightness to set. If the brightness exceeds the maximum
/// brightness supported, sets the maximum supported.
/// @return 0 on success, errno on error.
int BLed_setBrightness(const BLed* led, uint32_t brightness);
/// Gets the LED brightness.
/// @param led Pointer to the BLed object.
/// @param brightness Output pointer to the current brightness.
/// @return 0 on success, errno on error.
int BLed_getBrightness(const BLed* led, uint32_t* brightness);
/// Gets the LED max brightness.
/// @param led Pointer to the BLed object.
/// @param max_brightness Output pointer to the maximum brightness supported.
/// @return 0 on success, errno on error.
int BLed_getMaxBrightness(const BLed* led, uint32_t* max_brightness);
/// Destroys a BLed object.
/// @param led Pointer to the BLed object to destroy.
void BLed_delete(BLed* led);
/// @}
__END_DECLS
#endif // SYSTEM_PERIPHERALMANAGER_LED_H_
|
