michaelh/zephyr
1
0
Fork 0
Code Releases Activity

led.h: clarify brightness API for on/off LEDs

Browse source 
This clarification makes Zephyr's LED brightness API match the
behavior that both the Android lights HAL and Linux's userspace LED
drivers expose.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
This commit is contained in:
Martí Bolívar 2021-04-27 13:22:34 -07:00 • committed by Ioannis Glaropoulos
commit e869582338
1 changed files with 4 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

4
include/drivers/led.h
View file

@ -179,6 +179,10 @@ static inline int z_impl_led_get_info(const struct device *dev, uint32_t led,
* This optional routine sets the brightness of a LED to the given value.
* Calling this function after led_blink() won't affect blinking.
*
* LEDs which can only be turned on or off may provide this function.
* These should simply turn the LED on if @p value is nonzero, and off
* if @p value is zero.
*
* @param dev LED device
* @param led LED number
* @param value Brightness value to set in percent