diff mbox

[v6,2/2] Bindings documentation for ISSI is31fl319x driver

Message ID 403335d22f6a8e131bc44077f97e499970e61245.1468928850.git.hns@goldelico.com
State Not Applicable, archived
Headers show

Commit Message

H. Nikolaus Schaller July 19, 2016, 11:47 a.m. UTC
Signed-off-by: H. Nikolaus Schaller <hns@goldelico.com>
---
 .../devicetree/bindings/leds/is31fl319x.txt        | 59 ++++++++++++++++++++++
 1 file changed, 59 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/leds/is31fl319x.txt

Comments

Rob Herring (Arm) July 20, 2016, 1:24 a.m. UTC | #1
On Tue, Jul 19, 2016 at 01:47:31PM +0200, H. Nikolaus Schaller wrote:
> Signed-off-by: H. Nikolaus Schaller <hns@goldelico.com>
> ---
>  .../devicetree/bindings/leds/is31fl319x.txt        | 59 ++++++++++++++++++++++
>  1 file changed, 59 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/leds/is31fl319x.txt
> 
> diff --git a/Documentation/devicetree/bindings/leds/is31fl319x.txt b/Documentation/devicetree/bindings/leds/is31fl319x.txt
> new file mode 100644
> index 0000000..03287c0
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/leds/is31fl319x.txt
> @@ -0,0 +1,59 @@
> +LEDs connected to is31fl319x LED controller chip
> +
> +Required properties:
> +- compatible : Should be any of
> +	"issi,is31fl3190"
> +	"issi,is31fl3191"
> +	"issi,is31fl3193"
> +	"issi,is31fl3196"
> +	"issi,is31fl3199"
> +	"si-en,sn3199".
> +- #address-cells: Must be 1.
> +- #size-cells: Must be 0.
> +- reg: 0x64, 0x65, 0x66, 0x67.

This is an OR or AND? OR it seems. With that,

Acked-by: Rob Herring <robh@kernel.org>
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Jacek Anaszewski July 22, 2016, 6:36 a.m. UTC | #2
On 07/20/2016 03:24 AM, Rob Herring wrote:
> On Tue, Jul 19, 2016 at 01:47:31PM +0200, H. Nikolaus Schaller wrote:
>> Signed-off-by: H. Nikolaus Schaller <hns@goldelico.com>
>> ---
>>   .../devicetree/bindings/leds/is31fl319x.txt        | 59 ++++++++++++++++++++++
>>   1 file changed, 59 insertions(+)
>>   create mode 100644 Documentation/devicetree/bindings/leds/is31fl319x.txt
>>
>> diff --git a/Documentation/devicetree/bindings/leds/is31fl319x.txt b/Documentation/devicetree/bindings/leds/is31fl319x.txt
>> new file mode 100644
>> index 0000000..03287c0
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/leds/is31fl319x.txt
>> @@ -0,0 +1,59 @@
>> +LEDs connected to is31fl319x LED controller chip
>> +
>> +Required properties:
>> +- compatible : Should be any of
>> +	"issi,is31fl3190"
>> +	"issi,is31fl3191"
>> +	"issi,is31fl3193"
>> +	"issi,is31fl3196"
>> +	"issi,is31fl3199"
>> +	"si-en,sn3199".
>> +- #address-cells: Must be 1.
>> +- #size-cells: Must be 0.
>> +- reg: 0x64, 0x65, 0x66, 0x67.
>
> This is an OR or AND? OR it seems. With that,

Nikolaus, could you please make it explicit?

>
> Acked-by: Rob Herring <robh@kernel.org>
>
>
H. Nikolaus Schaller July 22, 2016, 6:42 a.m. UTC | #3
Hi,

> Am 22.07.2016 um 08:36 schrieb Jacek Anaszewski <j.anaszewski@samsung.com>:
> 
> On 07/20/2016 03:24 AM, Rob Herring wrote:
>> On Tue, Jul 19, 2016 at 01:47:31PM +0200, H. Nikolaus Schaller wrote:
>>> Signed-off-by: H. Nikolaus Schaller <hns@goldelico.com>
>>> ---
>>>  .../devicetree/bindings/leds/is31fl319x.txt        | 59 ++++++++++++++++++++++
>>>  1 file changed, 59 insertions(+)
>>>  create mode 100644 Documentation/devicetree/bindings/leds/is31fl319x.txt
>>> 
>>> diff --git a/Documentation/devicetree/bindings/leds/is31fl319x.txt b/Documentation/devicetree/bindings/leds/is31fl319x.txt
>>> new file mode 100644
>>> index 0000000..03287c0
>>> --- /dev/null
>>> +++ b/Documentation/devicetree/bindings/leds/is31fl319x.txt
>>> @@ -0,0 +1,59 @@
>>> +LEDs connected to is31fl319x LED controller chip
>>> +
>>> +Required properties:
>>> +- compatible : Should be any of
>>> +	"issi,is31fl3190"
>>> +	"issi,is31fl3191"
>>> +	"issi,is31fl3193"
>>> +	"issi,is31fl3196"
>>> +	"issi,is31fl3199"
>>> +	"si-en,sn3199".
>>> +- #address-cells: Must be 1.
>>> +- #size-cells: Must be 0.
>>> +- reg: 0x64, 0x65, 0x66, 0x67.
>> 
>> This is an OR or AND? OR it seems. With that,
> 
> Nikolaus, could you please make it explicit?

Yes, Rob's intuition is right. An AND does
obviously not make sense for a reg property.

It is an OR.

So if you perfer, please substitute 

- reg: 0x64, 0x65, 0x66, or 0x67.

BR,
Nikolaus

--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Jacek Anaszewski July 22, 2016, 7:12 a.m. UTC | #4
On 07/22/2016 08:42 AM, H. Nikolaus Schaller wrote:
> Hi,
>
>> Am 22.07.2016 um 08:36 schrieb Jacek Anaszewski <j.anaszewski@samsung.com>:
>>
>> On 07/20/2016 03:24 AM, Rob Herring wrote:
>>> On Tue, Jul 19, 2016 at 01:47:31PM +0200, H. Nikolaus Schaller wrote:
>>>> Signed-off-by: H. Nikolaus Schaller <hns@goldelico.com>
>>>> ---
>>>>   .../devicetree/bindings/leds/is31fl319x.txt        | 59 ++++++++++++++++++++++
>>>>   1 file changed, 59 insertions(+)
>>>>   create mode 100644 Documentation/devicetree/bindings/leds/is31fl319x.txt
>>>>
>>>> diff --git a/Documentation/devicetree/bindings/leds/is31fl319x.txt b/Documentation/devicetree/bindings/leds/is31fl319x.txt
>>>> new file mode 100644
>>>> index 0000000..03287c0
>>>> --- /dev/null
>>>> +++ b/Documentation/devicetree/bindings/leds/is31fl319x.txt
>>>> @@ -0,0 +1,59 @@
>>>> +LEDs connected to is31fl319x LED controller chip
>>>> +
>>>> +Required properties:
>>>> +- compatible : Should be any of
>>>> +	"issi,is31fl3190"
>>>> +	"issi,is31fl3191"
>>>> +	"issi,is31fl3193"
>>>> +	"issi,is31fl3196"
>>>> +	"issi,is31fl3199"
>>>> +	"si-en,sn3199".
>>>> +- #address-cells: Must be 1.
>>>> +- #size-cells: Must be 0.
>>>> +- reg: 0x64, 0x65, 0x66, 0x67.
>>>
>>> This is an OR or AND? OR it seems. With that,
>>
>> Nikolaus, could you please make it explicit?
>
> Yes, Rob's intuition is right. An AND does
> obviously not make sense for a reg property.
>
> It is an OR.
>
> So if you perfer, please substitute
>
> - reg: 0x64, 0x65, 0x66, or 0x67.

Updated the for-4.9 branch accordingly. I also added "led-" prefix
to the file name to match it with the vast majority of the
remaining ones.
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/leds/is31fl319x.txt b/Documentation/devicetree/bindings/leds/is31fl319x.txt
new file mode 100644
index 0000000..03287c0
--- /dev/null
+++ b/Documentation/devicetree/bindings/leds/is31fl319x.txt
@@ -0,0 +1,59 @@ 
+LEDs connected to is31fl319x LED controller chip
+
+Required properties:
+- compatible : Should be any of
+	"issi,is31fl3190"
+	"issi,is31fl3191"
+	"issi,is31fl3193"
+	"issi,is31fl3196"
+	"issi,is31fl3199"
+	"si-en,sn3199".
+- #address-cells: Must be 1.
+- #size-cells: Must be 0.
+- reg: 0x64, 0x65, 0x66, 0x67.
+
+Optional properties:
+- audio-gain-db : audio gain selection for external analog modulation input.
+	Valid values: 0 - 21, step by 3 (rounded down)
+	Default: 0
+
+Each led is represented as a sub-node of the issi,is31fl319x device.
+There can be less leds subnodes than the chip can support but not more.
+
+Required led sub-node properties:
+- reg : number of LED line
+	Valid values: 1 - number of leds supported by the chip variant.
+
+Optional led sub-node properties:
+- label : see Documentation/devicetree/bindings/leds/common.txt.
+- linux,default-trigger :
+	see Documentation/devicetree/bindings/leds/common.txt.
+- led-max-microamp : (optional)
+	Valid values: 5000 - 40000, step by 5000 (rounded down)
+	Default: 20000 (20 mA)
+	Note: a driver will take the lowest of all led limits since the
+	chip has a single global setting. The lowest value will be chosen
+	due to the PWM specificity, where lower brightness is achieved
+	by reducing the dury-cycle of pulses and not the current, which
+	will always have its peak value equal to led-max-microamp.
+
+Examples:
+
+fancy_leds: leds@65 {
+	compatible = "issi,is31fl3196";
+	#address-cells = <1>;
+	#size-cells = <0>;
+	reg = <0x65>;
+
+	red_aux: led@1 {
+		label = "red:aux";
+		reg = <1>;
+		led-max-microamp = <10000>;
+	};
+
+	green_power: led@5 {
+		label = "green:power";
+		reg = <5>;
+		linux,default-trigger = "default-on";
+	};
+};