linux-leds.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jacek Anaszewski <j.anaszewski@samsung.com>
To: linux-leds@vger.kernel.org
Cc: linux-kernel@vger.kernel.org, pavel@ucw.cz,
	sakari.ailus@linux.intel.com, andrew@lunn.ch,
	Jacek Anaszewski <j.anaszewski@samsung.com>
Subject: [PATCH v3 06/10] Documentation: leds: Add description of brightness setting API
Date: Wed, 07 Oct 2015 11:10:44 +0200	[thread overview]
Message-ID: <1444209048-29415-7-git-send-email-j.anaszewski@samsung.com> (raw)
In-Reply-To: <1444209048-29415-1-git-send-email-j.anaszewski@samsung.com>

This patch adds description of the LED subsystem API for
setting an LED brightness.

Signed-off-by: Jacek Anaszewski <j.anaszewski@samsung.com>
---
 Documentation/leds/leds-class.txt |   13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/Documentation/leds/leds-class.txt b/Documentation/leds/leds-class.txt
index 62261c0..d406d98 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
 ==================================
 
-- 
1.7.9.5

  parent reply	other threads:[~2015-10-07  9:10 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-10-07  9:10 [PATCH v3 00/10] LED core improvements Jacek Anaszewski
2015-10-07  9:10 ` [PATCH v3 01/10] leds: core: Add two new LED_BLINK_ flags Jacek Anaszewski
2015-10-16 15:32   ` Sakari Ailus
2015-10-07  9:10 ` [PATCH v3 02/10] leds: Rename brightness_set_sync op to brightness_set_blocking Jacek Anaszewski
2015-10-16 15:34   ` Sakari Ailus
2015-10-07  9:10 ` [PATCH v3 03/10] leds: core: Add led_set_brightness_nosleep{nopm} functions Jacek Anaszewski
2015-10-07  9:10 ` [PATCH v3 04/10] leds: core: Use set_brightness_work for the blocking op Jacek Anaszewski
2015-10-16 15:43   ` Sakari Ailus
2015-10-18  7:06     ` Jacek Anaszewski
2015-10-07  9:10 ` [PATCH v3 05/10] leds: core: Drivers shouldn't enforce SYNC/ASYNC brightness setting Jacek Anaszewski
2015-10-07  9:10 ` Jacek Anaszewski [this message]
2015-10-16 15:36   ` [PATCH v3 06/10] Documentation: leds: Add description of brightness setting API Sakari Ailus
2015-10-18  7:08     ` Jacek Anaszewski
2015-10-07  9:10 ` [PATCH v3 07/10] leds: max77693: Remove work queue Jacek Anaszewski
2015-10-07  9:10 ` [PATCH v3 08/10] leds: aat1290: " Jacek Anaszewski
2015-10-07  9:10 ` [PATCH v3 09/10] leds: ktd2692: " Jacek Anaszewski
2015-10-07  9:10 ` [PATCH v3 10/10] media: flash: use led_set_brightness_sync for torch brightness Jacek Anaszewski
2015-10-07 10:49   ` Pavel Machek
2015-11-16  9:35   ` Jacek Anaszewski
2015-11-16  9:47     ` Sakari Ailus
2015-11-16 13:34       ` Jacek Anaszewski
2015-12-03 13:35       ` Mauro Carvalho Chehab

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1444209048-29415-7-git-send-email-j.anaszewski@samsung.com \
    --to=j.anaszewski@samsung.com \
    --cc=andrew@lunn.ch \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-leds@vger.kernel.org \
    --cc=pavel@ucw.cz \
    --cc=sakari.ailus@linux.intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).