From: Jacek Anaszewski Date: Wed, 7 Oct 2015 09:10:44 +0000 (+0200) Subject: Documentation: leds: Add description of brightness setting API X-Git-Url: https://git.karo-electronics.de/?a=commitdiff_plain;h=648da8ff4849c75061df4ee3d4ffb0ede286d729;p=linux-beck.git 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 Acked-by: Sakari Ailus --- 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 ==================================