LKML Archive on lore.kernel.org
help / color / mirror / Atom feed
From: Sakari Ailus <sakari.ailus@iki.fi>
To: Jacek Anaszewski <j.anaszewski@samsung.com>
Cc: linux-leds@vger.kernel.org, linux-media@vger.kernel.org,
	linux-kernel@vger.kernel.org, devicetree@vger.kernel.org,
	kyungmin.park@samsung.com, pavel@ucw.cz, cooloney@gmail.com,
	rpurdie@rpsys.net, s.nawrocki@samsung.com,
	Andrzej Hajda <a.hajda@samsung.com>,
	Lee Jones <lee.jones@linaro.org>,
	Chanwoo Choi <cw00.choi@samsung.com>
Subject: Re: [PATCH/RFC v12 10/19] DT: Add documentation for the mfd Maxim max77693
Date: Mon, 9 Mar 2015 12:54:05 +0200	[thread overview]
Message-ID: <20150309105404.GC11954@valkosipuli.retiisi.org.uk> (raw)
In-Reply-To: <1425485680-8417-11-git-send-email-j.anaszewski@samsung.com>

Hi Jacek,

On Wed, Mar 04, 2015 at 05:14:31PM +0100, Jacek Anaszewski wrote:
> This patch adds device tree binding documentation for
> the flash cell of the Maxim max77693 multifunctional device.
> 
> Signed-off-by: Jacek Anaszewski <j.anaszewski@samsung.com>
> Signed-off-by: Andrzej Hajda <a.hajda@samsung.com>
> Acked-by: Kyungmin Park <kyungmin.park@samsung.com>
> Cc: Lee Jones <lee.jones@linaro.org>
> Cc: Chanwoo Choi <cw00.choi@samsung.com>
> Cc: Bryan Wu <cooloney@gmail.com>
> Cc: Richard Purdie <rpurdie@rpsys.net>
> ---
>  Documentation/devicetree/bindings/mfd/max77693.txt |   61 ++++++++++++++++++++
>  1 file changed, 61 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/mfd/max77693.txt b/Documentation/devicetree/bindings/mfd/max77693.txt
> index 38e6440..ab8fbd5 100644
> --- a/Documentation/devicetree/bindings/mfd/max77693.txt
> +++ b/Documentation/devicetree/bindings/mfd/max77693.txt
> @@ -76,7 +76,53 @@ Optional properties:
>      Valid values: 4300000, 4700000, 4800000, 4900000
>      Default: 4300000
>  
> +- led : the LED submodule device node
> +
> +There are two LED outputs available - FLED1 and FLED2. Each of them can
> +control a separate LED or they can be connected together to double
> +the maximum current for a single connected LED. One LED is represented
> +by one child node.
> +
> +Required properties:
> +- compatible : Must be "maxim,max77693-led".
> +
> +Optional properties:
> +- maxim,trigger-type : Flash trigger type.
> +	Possible trigger types:
> +		LEDS_TRIG_TYPE_EDGE (0) - Rising edge of the signal triggers
> +			the flash,
> +		LEDS_TRIG_TYPE_LEVEL (1) - Strobe pulse length controls duration
> +			of the flash.
> +- maxim,boost-mode :
> +	In boost mode the device can produce up to 1.2A of total current
> +	on both outputs. The maximum current on each output is reduced
> +	to 625mA then. If not enabled explicitly, boost setting defaults to
> +	LEDS_BOOST_FIXED in case both current sources are used.
> +	Possible values:
> +		LEDS_BOOST_OFF (0) - no boost,
> +		LEDS_BOOST_ADAPTIVE (1) - adaptive mode,
> +		LEDS_BOOST_FIXED (2) - fixed mode.
> +- maxim,boost-mvout : Output voltage of the boost module in millivolts.
> +- maxim,mvsys-min : Low input voltage level in millivolts. Flash is not fired
> +	if chip estimates that system voltage could drop below this level due
> +	to flash power consumption.
> +
> +Required properties of the LED child node:
> +- label : see Documentation/devicetree/bindings/leds/common.txt

According to ePAPR, label is "a human readable string describing a device".
There's no requirement that this would be unique, for instance. If you have
a camera flash LED, there's necessarily no meaningful label for it, as it
doesn't really tell the user anything (vs. HDD activity LED, for instance).

I think I'd make this optional.

What comes to entity naming in Media controller, the label isn't enough. As
we haven't yet fully agreed on how to name the entities in the future, I'd
propose sticking to current practices: chip name (and optional numerical LED
ID) followed by the I2C address. The name should be specified by the driver.

Do you have other than I2C busses required by the current drivers?

> +- led-sources : see Documentation/devicetree/bindings/leds/common.txt;
> +		device current output identifiers: 0 - FLED1, 1 - FLED2
> +
> +Optional properties of the LED child node:
> +- max-microamp : see Documentation/devicetree/bindings/leds/common.txt
> +		Range: 15625 - 250000
> +- flash-max-microamp : see Documentation/devicetree/bindings/leds/common.txt
> +		Range: 15625 - 1000000
> +- flash-timeout-us : see Documentation/devicetree/bindings/leds/common.txt
> +		Range: 62500 - 1000000
> +
>  Example:
> +#include <dt-bindings/leds/max77693.h>
> +
>  	max77693@66 {
>  		compatible = "maxim,max77693";
>  		reg = <0x66>;
> @@ -117,5 +163,20 @@ Example:
>  			maxim,thermal-regulation-celsius = <75>;
>  			maxim,battery-overcurrent-microamp = <3000000>;
>  			maxim,charge-input-threshold-microvolt = <4300000>;
> +
> +		led {
> +			compatible = "maxim,max77693-led";
> +			maxim,trigger-type = <LEDS_TRIG_TYPE_LEVEL>;
> +			maxim,boost-mode = <LEDS_BOOST_FIXED>;
> +			maxim,boost-mvout = <5000>;
> +			maxim,mvsys-min = <2400>;
> +
> +			camera_flash: flash-led {
> +				label = "max77693-flash1";
> +				led-sources = <0>, <1>;
> +				max-microamp = <500000>;
> +				flash-max-microamp = <1250000>;
> +				flash-timeout-us = <1000000>;
> +			};
>  		};
>  	};

-- 
Kind regards,

Sakari Ailus
e-mail: sakari.ailus@iki.fi	XMPP: sailus@retiisi.org.uk

  reply	other threads:[~2015-03-09 10:54 UTC|newest]

Thread overview: 33+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-03-04 16:14 [PATCH/RFC v12 00/19] LED / flash API integration Jacek Anaszewski
2015-03-04 16:14 ` [PATCH/RFC v12 01/19] leds: flash: Remove synchronized flash strobe feature Jacek Anaszewski
2015-03-09 23:23   ` Bryan Wu
2015-03-04 16:14 ` [PATCH/RFC v12 02/19] leds: flash: document sysfs interface Jacek Anaszewski
2015-03-10  0:17   ` Bryan Wu
2015-03-04 16:14 ` [PATCH/RFC v12 03/19] Documentation: leds: Add description of LED Flash class extension Jacek Anaszewski
2015-03-10  0:23   ` Bryan Wu
2015-03-04 16:14 ` [PATCH/RFC v12 04/19] dt-binding: leds: Add common LED DT bindings macros Jacek Anaszewski
2015-03-05  7:56   ` Jacek Anaszewski
2015-03-10  0:33     ` Bryan Wu
2015-03-04 16:14 ` [PATCH/RFC v12 05/19] mfd: max77693: Modify flash cell name identifiers Jacek Anaszewski
2015-03-09  9:36   ` Lee Jones
2015-03-04 16:14 ` [PATCH/RFC v12 06/19] mfd: max77693: Remove struct max77693_led_platform_data Jacek Anaszewski
2015-03-09  9:35   ` Lee Jones
2015-03-04 16:14 ` [PATCH/RFC v12 07/19] mfd: max77693: add TORCH_IOUT_MASK macro Jacek Anaszewski
2015-03-09  9:36   ` Lee Jones
2015-03-04 16:14 ` [PATCH/RFC v12 08/19] mfd: max77693: Adjust FLASH_EN_SHIFT and TORCH_EN_SHIFT macros Jacek Anaszewski
2015-03-09  9:35   ` Lee Jones
2015-03-04 16:14 ` [PATCH/RFC v12 09/19] leds: Add support for max77693 mfd flash cell Jacek Anaszewski
2015-03-04 16:14 ` [PATCH/RFC v12 10/19] DT: Add documentation for the mfd Maxim max77693 Jacek Anaszewski
2015-03-09 10:54   ` Sakari Ailus [this message]
2015-03-09 12:19     ` Jacek Anaszewski
2015-03-09 12:37       ` Sakari Ailus
2015-03-09 13:45         ` Jacek Anaszewski
2015-03-04 16:14 ` [PATCH/RFC v12 11/19] leds: Add driver for AAT1290 current regulator Jacek Anaszewski
2015-03-04 16:14 ` [PATCH/RFC v12 12/19] of: Add Skyworks Solutions, Inc. vendor prefix Jacek Anaszewski
2015-03-04 16:14 ` [PATCH/RFC v12 13/19] DT: Add documentation for the Skyworks AAT1290 Jacek Anaszewski
2015-03-04 16:14 ` [PATCH/RFC v12 14/19] exynos4-is: Add support for v4l2-flash subdevs Jacek Anaszewski
2015-03-04 16:14 ` [PATCH/RFC v12 15/19] media: Add registration helpers for V4L2 flash sub-devices Jacek Anaszewski
2015-03-04 16:14 ` [PATCH/RFC v12 16/19] Documentation: leds: Add description of v4l2-flash sub-device Jacek Anaszewski
2015-03-04 16:14 ` [PATCH/RFC v12 17/19] DT: Add documentation for exynos4-is 'flashes' property Jacek Anaszewski
2015-03-04 16:14 ` [PATCH/RFC v12 18/19] leds: max77693: add support for V4L2 Flash sub-device Jacek Anaszewski
2015-03-04 16:14 ` [PATCH/RFC v12 19/19] leds: aat1290: " Jacek Anaszewski

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20150309105404.GC11954@valkosipuli.retiisi.org.uk \
    --to=sakari.ailus@iki.fi \
    --cc=a.hajda@samsung.com \
    --cc=cooloney@gmail.com \
    --cc=cw00.choi@samsung.com \
    --cc=devicetree@vger.kernel.org \
    --cc=j.anaszewski@samsung.com \
    --cc=kyungmin.park@samsung.com \
    --cc=lee.jones@linaro.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-leds@vger.kernel.org \
    --cc=linux-media@vger.kernel.org \
    --cc=pavel@ucw.cz \
    --cc=rpurdie@rpsys.net \
    --cc=s.nawrocki@samsung.com \
    --subject='Re: [PATCH/RFC v12 10/19] DT: Add documentation for the mfd Maxim max77693' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).