From patchwork Mon Mar 30 09:52:27 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jacek Anaszewski X-Patchwork-Id: 6119531 Return-Path: X-Original-To: patchwork-linux-media@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork1.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.136]) by patchwork1.web.kernel.org (Postfix) with ESMTP id 074549F32E for ; Mon, 30 Mar 2015 09:52:52 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id 237372035B for ; Mon, 30 Mar 2015 09:52:51 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 4B80020219 for ; Mon, 30 Mar 2015 09:52:48 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752763AbbC3Jwq (ORCPT ); Mon, 30 Mar 2015 05:52:46 -0400 Received: from mailout1.samsung.com ([203.254.224.24]:63482 "EHLO mailout1.samsung.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1752490AbbC3Jwp (ORCPT ); Mon, 30 Mar 2015 05:52:45 -0400 Received: from epcpsbgm2.samsung.com (epcpsbgm2 [203.254.230.27]) by mailout1.samsung.com (Oracle Communications Messaging Server 7.0.5.31.0 64bit (built May 5 2014)) with ESMTP id <0NM000MVORFVW700@mailout1.samsung.com>; Mon, 30 Mar 2015 18:52:43 +0900 (KST) X-AuditID: cbfee61b-f79d76d0000024d6-d5-55191ceaed31 Received: from epmmp1.local.host ( [203.254.227.16]) by epcpsbgm2.samsung.com (EPCPMTA) with SMTP id FB.CD.09430.AEC19155; Mon, 30 Mar 2015 18:52:43 +0900 (KST) Received: from AMDC2362.DIGITAL.local ([106.120.53.23]) by mmp1.samsung.com (Oracle Communications Messaging Server 7.0.5.31.0 64bit (built May 5 2014)) with ESMTPA id <0NM000FRARFJI520@mmp1.samsung.com>; Mon, 30 Mar 2015 18:52:42 +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 v3] Documentation: leds: Add description of v4l2-flash sub-device Date: Mon, 30 Mar 2015 11:52:27 +0200 Message-id: <1427709149-15014-1-git-send-email-j.anaszewski@samsung.com> X-Mailer: git-send-email 1.7.9.5 X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFupmluLIzCtJLcpLzFFi42I5/e+xgO5rGclQg3ntzBZHd05ksui9+pzR 4mzTG3aLrW/WMVr0bNjKanH31FE2i927nrJaHH7TzmpxZv9KNgdOj52z7rJ7HP66kMVjz/wf rB59W1YxeqxY/Z3d4/MmuQC2KC6blNSczLLUIn27BK6MZ+9+Mxasl6jY//knUwPjUpEuRk4O CQETiVtn9zNC2GISF+6tZ+ti5OIQEljEKNH++DOU85NR4t/V08wgVWwChhI/X7xmArFFBKwl Zh2azgJSxCywgVHi8oRGFpCEsECwxO3rZ8FsFgFViXV/3rGC2LwCHhKbbx0DWscBtE5BYs4k mwmM3AsYGVYxiqYWJBcUJ6XnGukVJ+YWl+al6yXn525iBAfRM+kdjKsaLA4xCnAwKvHwOtRL hAqxJpYVV+YeYpTgYFYS4bXklQwV4k1JrKxKLcqPLyrNSS0+xCjNwaIkzqtk3xYiJJCeWJKa nZpakFoEk2Xi4JRqYFzEde1V3g3jlGOXk47d8Hzwlr1MLmbKzTvbtym9Mz0qU2H3zDpcT7cy Q/bHgtkVzHdEdj21nJa+et5Ot9eRYgIKHyXFTKN/Mp44Urpmqelkxa1OYp1FL314RGTX35rB s9QsX7nCtGSSQULjrxmyUr+MZnNl/G1/oXWspfbXwQPXnvHND99c8kSJpTgj0VCLuag4EQBL RirxHgIAAA== 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 Cc: Bryan Wu Cc: Richard Purdie --- Documentation/leds/leds-class-flash.txt | 46 +++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) - extended description of v4l2_flash API diff --git a/Documentation/leds/leds-class-flash.txt b/Documentation/leds/leds-class-flash.txt index 19bb673..9d45667 100644 --- a/Documentation/leds/leds-class-flash.txt +++ b/Documentation/leds/leds-class-flash.txt @@ -20,3 +20,49 @@ 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 - external strobe capability, + * 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 the drivers/leds/leds-max77693.c for an exemplary usage of the +v4l2-flash API. + +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.