From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S932862AbbIVLDl (ORCPT ); Tue, 22 Sep 2015 07:03:41 -0400 Received: from mailout3.w1.samsung.com ([210.118.77.13]:24508 "EHLO mailout3.w1.samsung.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S932130AbbIVLDj (ORCPT ); Tue, 22 Sep 2015 07:03:39 -0400 X-AuditID: cbfec7f4-f79c56d0000012ee-91-560135882ff3 Message-id: <56013587.9040009@samsung.com> Date: Tue, 22 Sep 2015 13:03:35 +0200 From: Jacek Anaszewski User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:17.0) Gecko/20130804 Thunderbird/17.0.8 MIME-version: 1.0 To: Sakari Ailus Cc: linux-leds@vger.kernel.org, linux-kernel@vger.kernel.org, andrew@lunn.ch Subject: Re: [PATCH 2/5] Documentation: leds: Add description of brightness setting API References: <1442845770-17800-1-git-send-email-j.anaszewski@samsung.com> <1442845770-17800-3-git-send-email-j.anaszewski@samsung.com> <56012CC0.3030405@linux.intel.com> In-reply-to: <56012CC0.3030405@linux.intel.com> Content-type: text/plain; charset=ISO-8859-1; format=flowed Content-transfer-encoding: 7bit X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFjrALMWRmVeSWpSXmKPExsVy+t/xK7odpoxhBlv2CVicv3uI2eLyrjls FlvfrGO0+LTlG5MDi8e8k4EeO3d8ZvL4vEkugDmKyyYlNSezLLVI3y6BK2Pe1oiCc4IVW2a1 szQwTufrYuTkkBAwkfi3bA0zhC0mceHeerYuRi4OIYGljBILGs4wgiSEBJ4xSqx8oAJi8wpo SXS83s4EYrMIqEq0X7vOAmKzCRhK/HzxGiwuKhAh8ef0PlaIekGJH5PvAdVwcIgI6EtMemAG EmYW8JFYcuwRWImwQKTE18cgJSB71zBKbDkxmQ0kwQlUv/vIamaIBmuJlZO2MULY8hKb17xl nsAoMAvJillIymYhKVvAyLyKUTS1NLmgOCk911CvODG3uDQvXS85P3cTIyRcv+xgXHzM6hCj AAejEg+vZx9DmBBrYllxZe4hRgkOZiUR3nWKjGFCvCmJlVWpRfnxRaU5qcWHGKU5WJTEeefu eh8iJJCeWJKanZpakFoEk2Xi4JRqYJTv1qxjvDQ/X/bU1+VhO5WPn1A82H/sXdXH4N8/Zujt KJLa9XzSNJu6f6+2nv81ReGmlat3uKxBqojCm1itcI6UeYJmmoK6vhGd+d9+JOVvYnvb/LNO Now5yH2/rtpehm6fObccz5+omCR8cu4UpYa/x9a6m3Nu8gzb6W//M/xkg8XRb/sSXiqxFGck GmoxFxUnAgDE2qAUUwIAAA== Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Hi Sakari, On 09/22/2015 12:26 PM, Sakari Ailus wrote: > Hi Jacek, > > Jacek Anaszewski wrote: >> 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. > > led_set_brightness_nosleep() isn't part of the API intended to be used > outside the LED framework --- I wouldn't document it here, only the part > relevant for users outside the LED class and triggers frameworks. OK, I'll move this description to drivers/leds/leds.h, next to the function declaration. >> + >> + >> Hardware accelerated blink of LEDs >> ================================== >> >> > > -- Best Regards, Jacek Anaszewski