From patchwork Wed Mar 4 16:14:23 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jacek Anaszewski X-Patchwork-Id: 5937971 Return-Path: X-Original-To: patchwork-linux-media@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork2.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.136]) by patchwork2.web.kernel.org (Postfix) with ESMTP id 82DA8BF440 for ; Wed, 4 Mar 2015 16:22:37 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id 95890202B8 for ; Wed, 4 Mar 2015 16:22:36 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id F1D52201B4 for ; Wed, 4 Mar 2015 16:22:34 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S933118AbbCDQQI (ORCPT ); Wed, 4 Mar 2015 11:16:08 -0500 Received: from mailout2.samsung.com ([203.254.224.25]:13679 "EHLO mailout2.samsung.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S933099AbbCDQQF (ORCPT ); Wed, 4 Mar 2015 11:16:05 -0500 Received: from epcpsbgm1.samsung.com (epcpsbgm1 [203.254.230.26]) by mailout2.samsung.com (Oracle Communications Messaging Server 7u4-24.01(7.0.4.24.0) 64bit (built Nov 17 2011)) with ESMTP id <0NKP00M2B3URZ6D0@mailout2.samsung.com>; Thu, 05 Mar 2015 01:16:03 +0900 (KST) X-AuditID: cbfee61a-f79c06d000004e71-0f-54f72fc3b312 Received: from epmmp1.local.host ( [203.254.227.16]) by epcpsbgm1.samsung.com (EPCPMTA) with SMTP id 0A.94.20081.3CF27F45; Thu, 05 Mar 2015 01:16:03 +0900 (KST) Received: from AMDC2362.DIGITAL.local ([106.120.53.23]) by mmp1.samsung.com (Oracle Communications Messaging Server 7u4-24.01 (7.0.4.24.0) 64bit (built Nov 17 2011)) with ESMTPA id <0NKP0082A3SJHN70@mmp1.samsung.com>; Thu, 05 Mar 2015 01:16:03 +0900 (KST) From: Jacek Anaszewski To: linux-leds@vger.kernel.org, linux-media@vger.kernel.org Cc: linux-kernel@vger.kernel.org, devicetree@vger.kernel.org, kyungmin.park@samsung.com, pavel@ucw.cz, cooloney@gmail.com, rpurdie@rpsys.net, sakari.ailus@iki.fi, s.nawrocki@samsung.com, Jacek Anaszewski Subject: [PATCH/RFC v12 02/19] leds: flash: document sysfs interface Date: Wed, 04 Mar 2015 17:14:23 +0100 Message-id: <1425485680-8417-3-git-send-email-j.anaszewski@samsung.com> X-Mailer: git-send-email 1.7.9.5 In-reply-to: <1425485680-8417-1-git-send-email-j.anaszewski@samsung.com> References: <1425485680-8417-1-git-send-email-j.anaszewski@samsung.com> X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFlrNLMWRmVeSWpSXmKPExsVy+t9jAd3D+t9DDBoWiFsc3TmRyWL+kXOs Fr1XnzNanG16w25xedccNoutb9YxWvRs2MpqcffUUTaL3bueslocftPOanFm/0o2B26PnbPu snsc/rqQxWPP/B+sHn1bVjF6rFj9nd3j8ya5ALYoLpuU1JzMstQifbsEroz3r3ezFvySq/i8 m6WB8aBkFyMnh4SAicT523fZIWwxiQv31rN1MXJxCAksYpR4dHIqI4TTziRxbXcnM0gVm4Ch xM8Xr5lAbBEBa4lZh6azgBQxC7xhlJi14RxYQljAReLD7ANADRwcLAKqEj+n5YCEeQXcJbr2 7wELSwgoSMyZZAMS5hTwkDh7cz1YpxBQyeGH+1kmMPIuYGRYxSiaWpBcUJyUnmuoV5yYW1ya l66XnJ+7iREchM+kdjCubLA4xCjAwajEw5sR/S1EiDWxrLgy9xCjBAezkgjvc7bvIUK8KYmV ValF+fFFpTmpxYcYpTlYlMR5lezbQoQE0hNLUrNTUwtSi2CyTBycUg2MhzJt489P1z/p9Wu6 4fsPjwTLd5yu0eBcefKEQcMFQyUuny/1l1ZG/2Brm3ZRt6fy3J3psmanBFx4n25cxlfRe6C/ 378+a01sRZay7pM5VlEigWy73n09+3WzKV/n97CHn6MeTxPeXB2w+Nd5hYm57vM77K8IhpUn HO95ru++s2lFw4Fp30PXKLEUZyQaajEXFScCAFwUsME+AgAA Sender: linux-media-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-media@vger.kernel.org X-Spam-Status: No, score=-6.9 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_HI, T_RP_MATCHES_RCVD, UNPARSEABLE_RELAY autolearn=unavailable version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on mail.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP Add a documentation of LED Flash class specific sysfs attributes. Signed-off-by: Jacek Anaszewski Acked-by: Kyungmin Park Cc: Bryan Wu Cc: Richard Purdie --- Documentation/ABI/testing/sysfs-class-led-flash | 80 +++++++++++++++++++++++ 1 file changed, 80 insertions(+) create mode 100644 Documentation/ABI/testing/sysfs-class-led-flash diff --git a/Documentation/ABI/testing/sysfs-class-led-flash b/Documentation/ABI/testing/sysfs-class-led-flash new file mode 100644 index 0000000..220a027 --- /dev/null +++ b/Documentation/ABI/testing/sysfs-class-led-flash @@ -0,0 +1,80 @@ +What: /sys/class/leds//flash_brightness +Date: March 2015 +KernelVersion: 4.0 +Contact: Jacek Anaszewski +Description: read/write + Set the brightness of this LED in the flash strobe mode, in + microamperes. The file is created only for the flash LED devices + that support setting flash brightness. + + The value is between 0 and + /sys/class/leds//max_flash_brightness. + +What: /sys/class/leds//max_flash_brightness +Date: March 2015 +KernelVersion: 4.0 +Contact: Jacek Anaszewski +Description: read only + Maximum brightness level for this LED in the flash strobe mode, + in microamperes. + +What: /sys/class/leds//flash_timeout +Date: March 2015 +KernelVersion: 4.0 +Contact: Jacek Anaszewski +Description: read/write + Hardware timeout for flash, in microseconds. The flash strobe + is stopped after this period of time has passed from the start + of the strobe. The file is created only for the flash LED + devices that support setting flash timeout. + +What: /sys/class/leds//max_flash_timeout +Date: March 2015 +KernelVersion: 4.0 +Contact: Jacek Anaszewski +Description: read only + Maximum flash timeout for this LED, in microseconds. + +What: /sys/class/leds//flash_strobe +Date: March 2015 +KernelVersion: 4.0 +Contact: Jacek Anaszewski +Description: read/write + Flash strobe state. When written with 1 it triggers flash strobe + and when written with 0 it turns the flash off. + + On read 1 means that flash is currently strobing and 0 means + that flash is off. + +What: /sys/class/leds//flash_fault +Date: March 2015 +KernelVersion: 4.0 +Contact: Jacek Anaszewski +Description: read only + Space separated list of flash faults that may have occurred. + Flash faults are re-read after strobing the flash. Possible + flash faults: + + * led-over-voltage - flash controller voltage to the flash LED + has exceeded the limit specific to the flash controller + * flash-timeout-exceeded - the flash strobe was still on when + the timeout set by the user has expired; not all flash + controllers may set this in all such conditions + * controller-over-temperature - the flash controller has + overheated + * controller-short-circuit - the short circuit protection + of the flash controller has been triggered + * led-power-supply-over-current - current in the LED power + supply has exceeded the limit specific to the flash + controller + * indicator-led-fault - the flash controller has detected + a short or open circuit condition on the indicator LED + * led-under-voltage - flash controller voltage to the flash + LED has been below the minimum limit specific to + the flash + * controller-under-voltage - the input voltage of the flash + controller is below the limit under which strobing the + flash at full current will not be possible; + the condition persists until this flag is no longer set + * led-over-temperature - the temperature of the LED has exceeded + its allowed upper limit