patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 8 Packages Projects Releases Wiki Activity

drivers: led: introduce led_set_color syscall

Browse source 
The led_set_color syscall adds support for multicolor (i.e.
multi-channel) LEDs to the LED API. It allows a user to set all the
colors/channels of a LED at once by passing a color array. Note that
this array must provide an entry per color/channel and must also be
ordered following the color mapping of the LED. This color mapping can
be either retrieved from the "color-mapping" DT property or from the LED
driver itself (by using the led_get_info syscall).

Signed-off-by: Simon Guinot <simon.guinot@seagate.com>
This commit is contained in:
Simon Guinot 2020-05-20 11:42:33 +02:00 committed by Carles Cufí
parent 713809f0ce
commit 2e26262451
2 changed files with 50 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
drivers/led/led_handlers.c
View file

@ -33,6 +33,15 @@ static inline int z_vrfy_led_set_brightness(struct device *dev, uint32_t led,
}
#include <syscalls/led_set_brightness_mrsh.c>
static inline int z_impl_led_set_color(struct device *dev, uint32_t led,
uint8_t num_colors, const uint8_t *color)
{
Z_OOPS(Z_SYSCALL_OBJ(dev, K_OBJ_DRIVER_LED));
Z_OOPS(Z_SYSCALL_MEMORY_READ(color, num_colors));
return z_impl_led_set_color(dev, led, num_colors, color);
}
#include <syscalls/led_set_color_mrsh.c>
static inline int z_vrfy_led_on(struct device *dev, uint32_t led)
{
Z_OOPS(Z_SYSCALL_DRIVER_LED(dev, on));

43
include/drivers/led.h
View file

@ -65,6 +65,15 @@ typedef int (*led_api_get_info)(struct device *dev, uint32_t led,
*/
typedef int (*led_api_set_brightness)(struct device *dev, uint32_t led,
uint8_t value);
/**
* @typedef led_api_set_color()
* @brief Optional API callback to set the colors of a LED.
*
* @see led_set_color() for argument descriptions.
*/
typedef int (*led_api_set_color)(struct device *dev, uint32_t led,
uint8_t num_colors, const uint8_t *color);
/**
* @typedef led_api_on()
* @brief Callback API for turning on an LED
@ -83,8 +92,6 @@ typedef int (*led_api_off)(struct device *dev, uint32_t led);
/**
* @brief LED driver API
*
* This is the mandatory API any LED driver needs to expose.
*/
__subsystem struct led_driver_api {
/* Mandatory callbacks. */
@ -94,6 +101,7 @@ __subsystem struct led_driver_api {
led_api_off off;
/* Optional callbacks. */
led_api_get_info get_info;
led_api_set_color set_color;
};
/**
@ -168,6 +176,37 @@ static inline int z_impl_led_set_brightness(struct device *dev, uint32_t led,
return api->set_brightness(dev, led, value);
}
/**
* @brief Set LED color
*
* This routine configures all the color channels of a LED with the given
* color array.
*
* Calling this function after led_blink() won't affect blinking.
*
* @param dev LED device
* @param led LED number
* @param num_colors Number of colors in the array.
* @param color Array of colors. It must be ordered following the color
* mapping of the LED controller. See the the color_mapping member
* in struct led_info.
* @return 0 on success, negative on error
*/
__syscall int led_set_color(struct device *dev, uint32_t led,
uint8_t num_colors, const uint8_t *color);
static inline int z_impl_led_set_color(struct device *dev, uint32_t led,
uint8_t num_colors, const uint8_t *color)
{
const struct led_driver_api *api =
(const struct led_driver_api *)dev->api;
if (!api->set_color) {
return -ENOTSUP;
}
return api->set_color(dev, led, num_colors, color);
}
/**
* @brief Turn on an LED
*