Thread (91 messages) 91 messages, 8 authors, 2015-02-09

Re: [PATCH/RFC v10 09/19] DT: Add documentation for the mfd Maxim max77693

From: Jacek Anaszewski <hidden>
Date: 2015-01-20 14:36:33
Also in: linux-leds, linux-media, lkml

On 01/20/2015 12:21 PM, Lee Jones wrote:
On Fri, 09 Jan 2015, Jacek Anaszewski wrote:
quoted
This patch adds device tree binding documentation for
the flash cell of the Maxim max77693 multifunctional device.

Signed-off-by: Jacek Anaszewski <redacted>
Signed-off-by: Andrzej Hajda <redacted>
Acked-by: Kyungmin Park <kyungmin.park@samsung.com>
Cc: Lee Jones <redacted>
Cc: Chanwoo Choi <cw00.choi@samsung.com>
Cc: Bryan Wu <redacted>
Cc: Richard Purdie <redacted>
Cc: Rob Herring <robh+dt@kernel.org>
Cc: Pawel Moll <redacted>
Cc: Mark Rutland <mark.rutland@arm.com>
Cc: Ian Campbell <redacted>
Cc: Kumar Gala <redacted>
---
  Documentation/devicetree/bindings/mfd/max77693.txt |   69 ++++++++++++++++++++
  1 file changed, 69 insertions(+)
diff --git a/Documentation/devicetree/bindings/mfd/max77693.txt b/Documentation/devicetree/bindings/mfd/max77693.txt
index 01e9f30..ef184f0 100644
--- a/Documentation/devicetree/bindings/mfd/max77693.txt
+++ b/Documentation/devicetree/bindings/mfd/max77693.txt
@@ -41,7 +41,52 @@ Optional properties:
  	 To get more informations, please refer to documentaion.
  	[*] refer Documentation/devicetree/bindings/pwm/pwm.txt

+- 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:
+		MAX77693_LED_TRIG_TYPE_EDGE - Rising edge of the signal triggers
+			the flash,
+		MAX77693_LED_TRIG_TYPE_LEVEL - Strobe pulse length controls
+			duration of the flash.
I think you should represent the proper values here instead of the
defines.
I see both versions in the existing bindings and also a combination of
them, e.g.: MAX77693_LED_TRIG_TYPE_EDGE (0). I think that it is
reasonable to mention the macros, especially if they are to appear
in the DT binding example at the end of the documentation file.
quoted
+- 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
+	MAX77693_LED_BOOST_FIXED in case both current sources are used.
+	Possible values:
+		MAX77693_LED_BOOST_OFF - no boost,
+		MAX77693_LED_BOOST_ADAPTIVE - adaptive mode,
+		MAX77693_LED_BOOST_FIXED - fixed mode.
Same here.
MAX77693_LED_BOOST_OFF (0) - no boost,
MAX77693_LED_BOOST_ADAPTIVE (1) - adaptive mode,
MAX77693_LED_BOOST_FIXED (2) - fixed mode.

?
quoted
+- maxim,boost-vout : Output voltage of the boost module in millivolts.
-mvout?
-microvout?
maxim,boost-mvout ?
quoted
+- maxim,vsys-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.
mvsys?
microvsys?
maxim,mvsys-min ?

-- 
Best Regards,
Jacek Anaszewski
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help