From patchwork Wed Nov 12 16:09:17 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jacek Anaszewski X-Patchwork-Id: 5290751 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.19.201]) by patchwork2.web.kernel.org (Postfix) with ESMTP id 4CBBCC11AC for ; Wed, 12 Nov 2014 16:10:49 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id 68A9D201C8 for ; Wed, 12 Nov 2014 16:10:48 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 683C3201BB for ; Wed, 12 Nov 2014 16:10:47 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1753311AbaKLQKp (ORCPT ); Wed, 12 Nov 2014 11:10:45 -0500 Received: from mailout4.samsung.com ([203.254.224.34]:13820 "EHLO mailout4.samsung.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1753141AbaKLQKp (ORCPT ); Wed, 12 Nov 2014 11:10:45 -0500 Received: from epcpsbgm1.samsung.com (epcpsbgm1 [203.254.230.26]) by mailout4.samsung.com (Oracle Communications Messaging Server 7u4-24.01(7.0.4.24.0) 64bit (built Nov 17 2011)) with ESMTP id <0NEX00EA2OXVFR30@mailout4.samsung.com>; Thu, 13 Nov 2014 01:10:43 +0900 (KST) X-AuditID: cbfee61a-f79c06d000004e71-58-546386833efd Received: from epmmp1.local.host ( [203.254.227.16]) by epcpsbgm1.samsung.com (EPCPMTA) with SMTP id 3A.84.20081.38683645; Thu, 13 Nov 2014 01:10:43 +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 <0NEX00MBOOVK75B0@mmp1.samsung.com>; Thu, 13 Nov 2014 01:10:43 +0900 (KST) From: Jacek Anaszewski To: linux-leds@vger.kernel.org Cc: linux-media@vger.kernel.org, sakari.ailus@linux.intel.com, kyungmin.park@samsung.com, b.zolnierkie@samsung.com, Jacek Anaszewski , Bryan Wu , Richard Purdie Subject: [PATCH/RFC v7 3/3] Documentation: leds: Add description of LED Flash Class extension Date: Wed, 12 Nov 2014 17:09:17 +0100 Message-id: <1415808557-29557-4-git-send-email-j.anaszewski@samsung.com> X-Mailer: git-send-email 1.7.9.5 In-reply-to: <1415808557-29557-1-git-send-email-j.anaszewski@samsung.com> References: <1415808557-29557-1-git-send-email-j.anaszewski@samsung.com> X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFprGLMWRmVeSWpSXmKPExsVy+t9jAd3mtuQQgwPvBS02zljPanF050Qm i96rzxktzja9YbfY+mYdo0XPhq2sFrt3PWW1+LTlG5MDh8fOWXfZPeadDPTYM/8Hq0ffllWM Hp83yQWwRnHZpKTmZJalFunbJXBlzHmxlamgRbRiYcsmpgbGNsEuRk4OCQETiduH3zBD2GIS F+6tZ+ti5OIQEljEKHHi8VYWCKedSeLd21tMIFVsAoYSP1+8BrI5OEQE5CR2nqkEqWEWeMEo 0b9oLjtIXFggXmLGNieQchYBVYlNS5+CtfIKeEjM/twH1iohoCAxZ5INSJhTwFOic8cNNhBb CKjk+KUm9gmMvAsYGVYxiqYWJBcUJ6XnGuoVJ+YWl+al6yXn525iBIfWM6kdjCsbLA4xCnAw KvHwcjokhwixJpYVV+YeYpTgYFYS4fWvBwrxpiRWVqUW5ccXleakFh9ilOZgURLnPdBqHSgk kJ5YkpqdmlqQWgSTZeLglGpgrDil8d8pXrWYM/0qb43pqUcmeuzbs+IYKqckP3154hMDcwVP RWrBuhyu5fNdbr3YkXR2+VGGNQkHjrNn/r/M0tr34k2p8Y4VXSGHjWIj+72DXH2ctmcUlwuv Pauv/rRj7YNrP//tlZteO+8poyJr95GN876oLl5itH/NotSjt/6s8taMm+J2V4mlOCPRUIu5 qDgRANh6VQopAgAA Sender: linux-media-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-media@vger.kernel.org X-Spam-Status: No, score=-7.5 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_HI, 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 The documentation being added contains overall description of the LED Flash Class and the related sysfs attributes. Signed-off-by: Jacek Anaszewski Acked-by: Kyungmin Park Cc: Bryan Wu Cc: Richard Purdie --- Documentation/leds/leds-class-flash.txt | 39 +++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 Documentation/leds/leds-class-flash.txt diff --git a/Documentation/leds/leds-class-flash.txt b/Documentation/leds/leds-class-flash.txt new file mode 100644 index 0000000..0164329 --- /dev/null +++ b/Documentation/leds/leds-class-flash.txt @@ -0,0 +1,39 @@ + +Flash LED handling under Linux +============================== + +Some LED devices support two modes - torch and flash. In order to enable +support for flash LEDs CONFIG_LEDS_CLASS_FLASH symbol must be defined +in the kernel config. A flash LED driver must register in the LED subsystem +with led_classdev_flash_register to gain flash capabilities. + +Following sysfs attributes are exposed for controlling flash led devices: + + - flash_brightness - flash LED brightness in microamperes (RW) + - max_flash_brightness - maximum available flash LED brightness (RO) + - indicator_brightness - privacy LED brightness in microamperes (RW) + - max_indicator_brightness - maximum privacy LED brightness in + microamperes (RO) + - flash_timeout - flash strobe duration in microseconds (RW) + - max_flash_timeout - maximum available flash strobe duration (RO) + - flash_strobe - flash strobe state (RW) + - flash_fault - bitmask of flash faults that may have occurred, + possible flags are: + * 0x01 - flash controller voltage to the flash LED has exceeded + the limit specific to the flash controller + * 0x02 - 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 + * 0x04 - the flash controller has overheated + * 0x08 - the short circuit protection of the flash controller + has been triggered + * 0x10 - current in the LED power supply has exceeded the limit + specific to the flash controller + * 0x40 - flash controller voltage to the flash LED has been + below the minimum limit specific to the flash + * 0x80 - 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 + * 0x100 - the temperature of the LED has exceeded its allowed + upper limit