michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: reference: Add the LED and LED Strip APIs

Browse source 
Add the LED (regular and strip) APIs to the doc.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
This commit is contained in:
Carles Cufi 2020-03-17 15:01:47 +01:00 • committed by Carles Cufí
commit 22854d39c0
4 changed files with 61 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

15
include/drivers/led.h
View file

@ -4,12 +4,19 @@
* SPDX-License-Identifier: Apache-2.0
*/
/**
* @file
* @brief Public LED driver APIs
*/
#ifndef ZEPHYR_INCLUDE_DRIVERS_LED_H_
#define ZEPHYR_INCLUDE_DRIVERS_LED_H_
/**
* @file
* @brief Public LED driver APIs
* @brief LED Interface
* @defgroup led_interface LED Interface
* @ingroup io_interfaces
* @{
*/
#include <zephyr/types.h>
@ -144,6 +151,10 @@ static inline int z_impl_led_off(struct device *dev, u32_t led)
return api->off(dev, led);
}
/**
* @}
*/
#include <syscalls/led.h>
#endif /* ZEPHYR_INCLUDE_DRIVERS_LED_H_ */

17
include/drivers/led_strip.h
View file

@ -4,9 +4,6 @@
* SPDX-License-Identifier: Apache-2.0
*/
#ifndef ZEPHYR_INCLUDE_DRIVERS_LED_STRIP_H_
#define ZEPHYR_INCLUDE_DRIVERS_LED_STRIP_H_
/**
* @file
* @brief Public API for controlling linear strips of LEDs.
@ -15,6 +12,16 @@
* addressable strips of LEDs.
*/
#ifndef ZEPHYR_INCLUDE_DRIVERS_LED_STRIP_H_
#define ZEPHYR_INCLUDE_DRIVERS_LED_STRIP_H_
/**
* @brief LED Strip Interface
* @defgroup led_strip_interface LED Strip Interface
* @ingroup io_interfaces
* @{
*/
#include <zephyr/types.h>
#include <device.h>
@ -126,4 +133,8 @@ static inline int led_strip_update_channels(struct device *dev,
}
#endif
/**
* @}
*/
#endif /* ZEPHYR_INCLUDE_DRIVERS_LED_STRIP_H_ */