diff options
| author | Jacek Anaszewski <j.anaszewski@samsung.com> | 2015-10-07 11:10:44 +0200 |
|---|---|---|
| committer | Jacek Anaszewski <j.anaszewski@samsung.com> | 2016-01-04 09:57:31 +0100 |
| commit | 648da8ff4849c75061df4ee3d4ffb0ede286d729 (patch) | |
| tree | 49ce115d80911e9bb779701f81ac5b08f6834695 /Documentation | |
| parent | 13ae79bbe4c214047f51623304d83b46eb02897d (diff) | |
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>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/leds/leds-class.txt | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/Documentation/leds/leds-class.txt b/Documentation/leds/leds-class.txt index 62261c04060a..d406d98339b2 100644 --- a/Documentation/leds/leds-class.txt +++ b/Documentation/leds/leds-class.txt @@ -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. +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 ================================== |