From patchwork Thu Apr 30 10:34:21 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jacek Anaszewski X-Patchwork-Id: 6301381 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 ACFDFBEEE1 for ; Thu, 30 Apr 2015 10:34:44 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id B3E40201CD for ; Thu, 30 Apr 2015 10:34:43 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 3FE6420154 for ; Thu, 30 Apr 2015 10:34:41 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751307AbbD3Kei (ORCPT ); Thu, 30 Apr 2015 06:34:38 -0400 Received: from mailout1.samsung.com ([203.254.224.24]:63309 "EHLO mailout1.samsung.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751286AbbD3Kef (ORCPT ); Thu, 30 Apr 2015 06:34:35 -0400 Received: from epcpsbgm1.samsung.com (epcpsbgm1 [203.254.230.26]) by mailout1.samsung.com (Oracle Communications Messaging Server 7.0.5.31.0 64bit (built May 5 2014)) with ESMTP id <0NNM004EJ81L7BA0@mailout1.samsung.com>; Thu, 30 Apr 2015 19:34:33 +0900 (KST) X-AuditID: cbfee61a-f79516d000006302-7b-554205396fe1 Received: from epmmp2 ( [203.254.227.17]) by epcpsbgm1.samsung.com (EPCPMTA) with SMTP id FD.BB.25346.93502455; Thu, 30 Apr 2015 19:34:33 +0900 (KST) Received: from AMDC2362.DIGITAL.local ([106.120.53.23]) by mmp2.samsung.com (Oracle Communications Messaging Server 7.0.5.31.0 64bit (built May 5 2014)) with ESMTPA id <0NNM009LJ81CHK90@mmp2.samsung.com>; Thu, 30 Apr 2015 19:34:33 +0900 (KST) From: Jacek Anaszewski To: linux-leds@vger.kernel.org, linux-media@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 v7] Documentation: leds: Add description of v4l2-flash sub-device Date: Thu, 30 Apr 2015 12:34:21 +0200 Message-id: <1430390061-7090-1-git-send-email-j.anaszewski@samsung.com> X-Mailer: git-send-email 1.7.9.5 X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFupmluLIzCtJLcpLzFFi42I5/e+xoK4lq1Oowc8JchZHd05ksui9+pzR 4mzTG3aLrW/WMVr0bNjKanH31FE2i927nrJaHH7TzmpxZv9KNgdOj52z7rJ7HP66kMVjz/wf rB59W1YxeqxY/Z3d4/MmuQC2KC6blNSczLLUIn27BK6Mjd/msha8kqj4PO0QSwPjTZEuRk4O CQETiVW3F7BD2GISF+6tZ+ti5OIQEpjOKDF5zipWCOcno0TjjC1MIFVsAoYSP1+8BrNFBKwl Zh2azgJSxCywgVHi8oRGFpCEsECwRNOePawgNouAqsTNW3fAVvAKuEtsf/iJsYuRA2idgsSc STYTGLkXMDKsYhRNLUguKE5KzzXUK07MLS7NS9dLzs/dxAgOomdSOxhXNlgcYhTgYFTi4f3Q 7hgqxJpYVlyZe4hRgoNZSYTX5D9QiDclsbIqtSg/vqg0J7X4EKM0B4uSOO8cXblQIYH0xJLU 7NTUgtQimCwTB6dUA+ORqcnJC9/yHhdy++edqLhNy9r23M+tP/amvXyxu9726YuXE7Wk3JL9 H1k+aTupfVZCVWatZk7KjVdN+wWlvm674f30941gEa3Fa7fmZGa7OT9abxj9cnLv0yXRrnzu s/7Mj9y8JVZxym2lN1s4eS+9n7hAKqhJVylZXCjx65nGuammk5UzFX4qsRRnJBpqMRcVJwIA 8+cJ9R4CAAA= 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 This patch extends LED Flash class documention by the description of interactions with v4l2-flash sub-device. Signed-off-by: Jacek Anaszewski Acked-by: Kyungmin Park Acked-by: Sakari Ailus Cc: Bryan Wu Cc: Richard Purdie --- Documentation/leds/leds-class-flash.txt | 47 +++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) diff --git a/Documentation/leds/leds-class-flash.txt b/Documentation/leds/leds-class-flash.txt index 19bb673..4cedc58 100644 --- a/Documentation/leds/leds-class-flash.txt +++ b/Documentation/leds/leds-class-flash.txt @@ -20,3 +20,50 @@ Following sysfs attributes are exposed for controlling flash LED devices: - max_flash_timeout - flash_strobe - flash_fault + + +V4L2 flash wrapper for flash LEDs +================================= + +A LED subsystem driver can be controlled also from the level of VideoForLinux2 +subsystem. In order to enable this CONFIG_V4L2_FLASH_LED_CLASS symbol has to +be defined in the kernel config. + +The driver must call the v4l2_flash_init function to get registered in the +V4L2 subsystem. The function takes three arguments: +- fled_cdev : the LED Flash class device to wrap +- ops : V4L2 specific ops + * external_strobe_set - defines the source of the flash LED strobe - + V4L2_CID_FLASH_STROBE control or external source, typically + a sensor, which makes it possible to synchronise the flash + strobe start with exposure start, + * intensity_to_led_brightness and led_brightness_to_intensity - perform + enum led_brightness <-> V4L2 intensity conversion in a device + specific manner - they can be used for devices with non-linear + LED current scale. +- config : configuration for V4L2 Flash sub-device + * dev_name - the name of the media entity, unique in the system, + * flash_faults - bitmask of flash faults that the LED Flash class + device can report; corresponding LED_FAULT* bit definitions are + available in , + * intensity - constraints for the LED in the TORCH or INDICATOR mode, + in microamperes, + * has_external_strobe - determines whether the flash strobe source + can be switched to external, + * indicator_led - signifies that a led is of indicator type, which + implies that it can have only two V4L2 controls: + V4L2_CID_FLASH_INDICATOR_INTENSITY and V4L2_CID_FLASH_FAULT. + +On remove the v4l2_flash_release function has to be called, which takes one +argument - struct v4l2_flash pointer returned previously by v4l2_flash_init. + +Please refer to drivers/leds/leds-max77693.c for an exemplary usage of the +v4l2 flash wrapper. + +Once the V4L2 sub-device is registered by the driver which created the Media +controller device, the sub-device node acts just as a node of a native V4L2 +flash API device would. The calls are simply routed to the LED flash API. + +Opening the V4L2 flash sub-device makes the LED subsystem sysfs interface +unavailable. The interface is re-enabled after the V4L2 flash sub-device +is closed.