From patchwork Wed Feb 18 16:20:22 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jacek Anaszewski X-Patchwork-Id: 5845051 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 E9A57BF440 for ; Wed, 18 Feb 2015 16:21:34 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id 0164920256 for ; Wed, 18 Feb 2015 16:21:34 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id EBB9820225 for ; Wed, 18 Feb 2015 16:21:32 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752288AbbBRQVa (ORCPT ); Wed, 18 Feb 2015 11:21:30 -0500 Received: from mailout1.samsung.com ([203.254.224.24]:24095 "EHLO mailout1.samsung.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751897AbbBRQV3 (ORCPT ); Wed, 18 Feb 2015 11:21:29 -0500 Received: from epcpsbgm2.samsung.com (epcpsbgm2 [203.254.230.27]) by mailout1.samsung.com (Oracle Communications Messaging Server 7u4-24.01(7.0.4.24.0) 64bit (built Nov 17 2011)) with ESMTP id <0NJZ00AHK6RR6030@mailout1.samsung.com>; Thu, 19 Feb 2015 01:21:27 +0900 (KST) X-AuditID: cbfee61b-f79d76d0000024d6-fe-54e4bc0745f3 Received: from epmmp1.local.host ( [203.254.227.16]) by epcpsbgm2.samsung.com (EPCPMTA) with SMTP id 5E.A3.09430.70CB4E45; Thu, 19 Feb 2015 01:21:27 +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 <0NJZ003WS6QJDJ20@mmp1.samsung.com>; Thu, 19 Feb 2015 01:21:27 +0900 (KST) From: Jacek Anaszewski To: linux-leds@vger.kernel.org, linux-media@vger.kernel.org, devicetree@vger.kernel.org Cc: 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 v11 01/20] leds: flash: document sysfs interface Date: Wed, 18 Feb 2015 17:20:22 +0100 Message-id: <1424276441-3969-2-git-send-email-j.anaszewski@samsung.com> X-Mailer: git-send-email 1.7.9.5 In-reply-to: <1424276441-3969-1-git-send-email-j.anaszewski@samsung.com> References: <1424276441-3969-1-git-send-email-j.anaszewski@samsung.com> X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFlrGLMWRmVeSWpSXmKPExsVy+t9jAV32PU9CDH6/k7I4unMik8X8I+dY LXqvPme0ONv0ht1i65t1jBY9G7ayWtw9dZTNYveup6wWh9+0s1qc2b+SzYHLY+esu+weh78u ZPHYM/8Hq0ffllWMHitWf2f3+LxJLoAtissmJTUnsyy1SN8ugStj6vQOpoILahVf/11laWD8 L9/FyMkhIWAice3GXiYIW0ziwr31bF2MXBxCAosYJXZdOccC4bQzSfS9mcAKUsUmYCjx88Vr sA4RgUiJd0cvMYMUMQtsYJS4PKERqIODQ1jAReLBq3SQGhYBVYmLq08ygti8Au4S71+/YgUp kRBQkJgzyQbE5BTwkLjw3AOkQgioYvrNd6wTGHkXMDKsYhRNLUguKE5KzzXSK07MLS7NS9dL zs/dxAgOvWfSOxhXNVgcYhTgYFTi4W34/ThEiDWxrLgy9xCjBAezkghv7sonIUK8KYmVValF +fFFpTmpxYcYpTlYlMR5lezbQoQE0hNLUrNTUwtSi2CyTBycUg2MQu0vrFmYK+ZuzroVOXOl ydLih+f2fozyP5VtMyF9sdyLI5cepFdfzZmWZHHXUb943/quqR/MPi97y8eyY9fVbTnLNc84 xH1zMA5dJ/Au0sz86zvW5a7rDrM26SkZPi8UU9r5frrCh70zN5zpWMaXwfy+302g1X5L/onn GsIJil6in6UdHqveUGIpzkg01GIuKk4EALyIhsw5AgAA 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 | 104 +++++++++++++++++++++++ 1 file changed, 104 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..c941d21 --- /dev/null +++ b/Documentation/ABI/testing/sysfs-class-led-flash @@ -0,0 +1,104 @@ +What: /sys/class/leds//flash_brightness +Date: February 2015 +KernelVersion: 3.20 +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: February 2015 +KernelVersion: 3.20 +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: February 2015 +KernelVersion: 3.20 +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: February 2015 +KernelVersion: 3.20 +Contact: Jacek Anaszewski +Description: read only + Maximum flash timeout for this LED, in microseconds. + +What: /sys/class/leds//flash_strobe +Date: February 2015 +KernelVersion: 3.20 +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_sync_strobe +Date: February 2015 +KernelVersion: 3.20 +Contact: Jacek Anaszewski +Description: read/write + Identifier of the LED to synchronize the flash strobe with. + 0 stands for no synchronization. Usually the LEDs available for + flash strobing are driven by the same flash LED device. The LEDs + available for flash strobe synchronization can be obtained by + reading the /sys/class/leds//available_sync_leds attribute. + + On read the currently selected LED is displayed in the format: + led_id.led_name + +What: /sys/class/leds//available_sync_leds +Date: February 2015 +KernelVersion: 3.20 +Contact: Jacek Anaszewski +Description: read/write + Space separated list of LEDs available for flash strobe + synchronization, displayed in the format: + + led1_id.led1_name led2_id.led2_name led3_id.led3_name etc. + +What: /sys/class/leds//flash_fault +Date: February 2015 +KernelVersion: 3.20 +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