Commit 648da8ff authored by Jacek Anaszewski's avatar Jacek Anaszewski
Browse files

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: default avatarJacek Anaszewski <j.anaszewski@samsung.com>
Acked-by: default avatarSakari Ailus <sakari.ailus@linux.intel.com>
parent 13ae79bb

Documentation/leds/leds-class.txt

+13 −0
Original line number Diff line number Diff line
@@ -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

==================================