mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Jacek Anaszewski <j.anaszewski@samsung.com>
To: linux-leds@vger.kernel.org
Cc: linux-kernel@vger.kernel.org, sakari.ailus@linux.intel.com,
	andrew@lunn.ch, rpurdie@rpsys.net,
	Jacek Anaszewski <j.anaszewski@samsung.com>
Subject: [PATCH v2 08/12] Documentation: leds: Add description of brightness setting API
Date: Mon, 28 Sep 2015 15:07:17 +0200	[thread overview]
Message-ID: <1443445641-9529-9-git-send-email-j.anaszewski@samsung.com> (raw)
In-Reply-To: <1443445641-9529-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-09-28 13:07 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-09-28 13:07 [PATCH v2 00/12] LED core improvements Jacek Anaszewski
2015-09-28 13:07 ` [PATCH v2 01/12] leds: core: Use EXPORT_SYMBOL_GPL consistently Jacek Anaszewski
2015-09-28 15:13   ` Jacek Anaszewski
2015-10-08 15:51     ` Pavel Machek
2015-10-09  8:19       ` Jacek Anaszewski
2015-10-09 11:17         ` Pavel Machek
2015-09-28 13:07 ` [PATCH v2 02/12] leds: core: Move LED core callbacks out of led-class.c Jacek Anaszewski
2015-09-28 13:07 ` [PATCH v2 03/12] leds: core: Add two new LED_BLINK_ flags Jacek Anaszewski
2015-09-28 13:07 ` [PATCH v2 04/12] leds: Rename brightness_set_sync op to brightness_set_blocking Jacek Anaszewski
2015-09-28 13:07 ` [PATCH v2 05/12] leds: core: Add an internal led_set_brightness_nosleep function Jacek Anaszewski
2015-09-28 13:07 ` [PATCH v2 06/12] leds: core: Use set_brightness_work for the blocking op Jacek Anaszewski
2015-09-28 13:07 ` [PATCH v2 07/12] leds: core: Drivers shouldn't enforce SYNC/ASYNC brightness setting Jacek Anaszewski
2015-09-28 13:07 ` Jacek Anaszewski [this message]
2015-09-28 13:07 ` [PATCH v2 09/12] leds: max77693: Remove work queue Jacek Anaszewski
2015-09-28 13:07 ` [PATCH v2 10/12] leds: aat1290: " Jacek Anaszewski
2015-09-28 13:07 ` [PATCH v2 11/12] leds: ktd2692: " Jacek Anaszewski
2015-09-28 13:07 ` [PATCH v2 12/12] media: flash: use led_set_brightness_sync for torch brightness Jacek Anaszewski
2015-09-28 20:37   ` Pavel Machek
2015-09-29  7:26     ` Jacek Anaszewski
2015-09-29  9:39       ` Pavel Machek
2015-10-01 13:22 ` [PATCH v2 00/12] LED core improvements Sakari Ailus
2015-10-01 13:55   ` Jacek Anaszewski

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=1443445641-9529-9-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=rpurdie@rpsys.net \
    --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

Powered by JetHome