From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1756699AbbIUObx (ORCPT ); Mon, 21 Sep 2015 10:31:53 -0400 Received: from mailout1.samsung.com ([203.254.224.24]:53356 "EHLO mailout1.samsung.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1755991AbbIUObE (ORCPT ); Mon, 21 Sep 2015 10:31:04 -0400 X-AuditID: cbfee61b-f79d56d0000048c5-79-560014a2bfde From: Jacek Anaszewski To: linux-leds@vger.kernel.org Cc: linux-kernel@vger.kernel.org, andrew@lunn.ch, sakari.ailus@linux.intel.com, Jacek Anaszewski Subject: [PATCH 2/5] Documentation: leds: Add description of brightness setting API Date: Mon, 21 Sep 2015 16:29:27 +0200 Message-id: <1442845770-17800-3-git-send-email-j.anaszewski@samsung.com> X-Mailer: git-send-email 1.7.9.5 In-reply-to: <1442845770-17800-1-git-send-email-j.anaszewski@samsung.com> References: <1442845770-17800-1-git-send-email-j.anaszewski@samsung.com> X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFmplluLIzCtJLcpLzFFi42I5/e+xgO4iEYYwg8lHDCzO3z3EbNF79Tmj xeVdc9gstr5Zx2jxacs3JgdWj3knAz127vjM5NG3ZRWjx+dNcgEsUVw2Kak5mWWpRfp2CVwZ c5b+Zy6YxFsx69hZ5gbG+1xdjJwcEgImEsvv72CCsMUkLtxbz9bFyMUhJLCUUWLOjEMsEM5P Roljbb2MIFVsAoYSP1+8Burg4BARkJPYeaYSJMwsUCvxv6uDBcQWFgiVeDP7LzuIzSKgKrFn z3mwBbwCHhLtz7oYQVolBBQk5kyyAQlzCnhKzLrWDTZdCKhk3sGpTBMYeRcwMqxilEgtSC4o TkrPNcpLLdcrTswtLs1L10vOz93ECA6cZ9I7GA/vcj/EKMDBqMTD6yDwP1SINbGsuDL3EKME B7OSCO9xfoYwId6UxMqq1KL8+KLSnNTiQ4zSHCxK4ryyK5+FCgmkJ5akZqemFqQWwWSZODil GhjlL2QLuNZ/Y89wfiYWMs3th/zVooNP1+yuf3z1OFMJay6H9AEztuvpifeSf1rGanV821on rMP9g0G1Q/ap7Mfm18t4XhQftfZRlPfpt27g1D93jdv8ibCVWoYA96/od8dWHl6Znmh2Z7Gc /JSK/AXv1k3exH1qXfw5hkmKvN6sSkvfWpv/vKDEUpyRaKjFXFScCAAgyE8rGAIAAA== Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org This patch adds description of the LED subsystem API for setting an LED brightness. Signed-off-by: Jacek Anaszewski --- Documentation/leds/leds-class.txt | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/Documentation/leds/leds-class.txt b/Documentation/leds/leds-class.txt index 62261c0..2cc38fa 100644 --- a/Documentation/leds/leds-class.txt +++ b/Documentation/leds/leds-class.txt @@ -52,6 +52,27 @@ 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 : if necessary, cancels the software blink timer that + implements blinking when the hardware doesn't; it is guaranteed + not to sleep, which implies the possibility of delegating the + job to a work queue task (uses led_set_brightness_nosleep + underneath - see below), + - 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, + - led_set_brightness_nosleep : sets an LEDs brightness using either + brightness_set op, which is guaranteed not to sleep, or, if only + brightness_set_blocking op is available, delegates it to a work + queue task; this API is inteded for use by LED core and + led-triggers, as they can be called from atomic context, and thus + cannot sleep. + + Hardware accelerated blink of LEDs ================================== -- 1.7.9.5