Documentation: leds: Add description of brightness setting API
This patch adds description of the LED subsystem API for setting an LED brightness. Signed-off-by: Jacek Anaszewski <j.anaszewski@samsung.com> Acked-by: Sakari Ailus <sakari.ailus@linux.intel.com>
This commit is contained in:
parent
13ae79bbe4
commit
648da8ff48
1 changed files with 13 additions and 0 deletions
|
@ -52,6 +52,19 @@ above leaves scope for further attributes should they be needed. If sections
|
||||||
of the name don't apply, just leave that section blank.
|
of the name don't apply, just leave that section blank.
|
||||||
|
|
||||||
|
|
||||||
|
Brightness setting API
|
||||||
|
======================
|
||||||
|
|
||||||
|
LED subsystem core exposes following API for setting brightness:
|
||||||
|
|
||||||
|
- led_set_brightness : it is guaranteed not to sleep, passing LED_OFF stops
|
||||||
|
blinking,
|
||||||
|
- led_set_brightness_sync : for use cases when immediate effect is desired -
|
||||||
|
it can block the caller for the time required for accessing
|
||||||
|
device registers and can sleep, passing LED_OFF stops hardware
|
||||||
|
blinking, returns -EBUSY if software blink fallback is enabled.
|
||||||
|
|
||||||
|
|
||||||
Hardware accelerated blink of LEDs
|
Hardware accelerated blink of LEDs
|
||||||
==================================
|
==================================
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue