[v3,3/3] DT: leds: Add Qualcomm Light Pulse Generator binding

Message ID 20171115071345.24331-4-bjorn.andersson@linaro.org
State New
Headers show
Series
  • Untitled series #6102
Related show

Commit Message

Bjorn Andersson Nov. 15, 2017, 7:13 a.m.
This adds the binding document describing the three hardware blocks
related to the Light Pulse Generator found in a wide range of Qualcomm
PMICs.

Signed-off-by: Bjorn Andersson <bjorn.andersson@linaro.org>

---

Changes since v2:
- Squashed all things into one node
- Removed quirks from the binding, compatible implies number of channels, their
  configuration etc.
- Binding describes LEDs connected as child nodes
- Support describing multi-channel LEDs
- Change style of the binding document, to match other LED bindings

Changes since v1:
- Dropped custom pattern properties
- Renamed cell-index to qcom,lpg-channel to clarify its purpose

 .../devicetree/bindings/leds/leds-qcom-lpg.txt     | 66 ++++++++++++++++++++++
 1 file changed, 66 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/leds/leds-qcom-lpg.txt

-- 
2.15.0

--
To unsubscribe from this list: send the line "unsubscribe linux-arm-msm" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Comments

Jacek Anaszewski Nov. 19, 2017, 9:35 p.m. | #1
Hi Bjorn,

Thanks for the update.

On 11/15/2017 08:13 AM, Bjorn Andersson wrote:
> This adds the binding document describing the three hardware blocks

> related to the Light Pulse Generator found in a wide range of Qualcomm

> PMICs.

> 

> Signed-off-by: Bjorn Andersson <bjorn.andersson@linaro.org>

> ---

> 

> Changes since v2:

> - Squashed all things into one node

> - Removed quirks from the binding, compatible implies number of channels, their

>   configuration etc.

> - Binding describes LEDs connected as child nodes

> - Support describing multi-channel LEDs

> - Change style of the binding document, to match other LED bindings

> 

> Changes since v1:

> - Dropped custom pattern properties

> - Renamed cell-index to qcom,lpg-channel to clarify its purpose

> 

>  .../devicetree/bindings/leds/leds-qcom-lpg.txt     | 66 ++++++++++++++++++++++

>  1 file changed, 66 insertions(+)

>  create mode 100644 Documentation/devicetree/bindings/leds/leds-qcom-lpg.txt

> 

> diff --git a/Documentation/devicetree/bindings/leds/leds-qcom-lpg.txt b/Documentation/devicetree/bindings/leds/leds-qcom-lpg.txt

> new file mode 100644

> index 000000000000..9cee6f9f543c

> --- /dev/null

> +++ b/Documentation/devicetree/bindings/leds/leds-qcom-lpg.txt

> @@ -0,0 +1,66 @@

> +Binding for Qualcomm Light Pulse Generator

> +

> +The Qualcomm Light Pulse Generator consists of three different hardware blocks;

> +a ramp generator with lookup table, the light pulse generator and a three

> +channel current sink. These blocks are found in a wide range of Qualcomm PMICs.

> +

> +Required properties:

> +- compatible: one of:

> +	      "qcom,pm8916-pwm",

> +	      "qcom,pm8941-lpg",

> +	      "qcom,pm8994-lpg",

> +	      "qcom,pmi8994-lpg",

> +	      "qcom,pmi8998-lpg",

> +

> +Optional properties:

> +- qcom,power-source: power-source used to drive the output, as defined in the

> +		     datasheet. Should be specified if the TRILED block is

> +		     present


Range of possible values is missing here.

> +- qcom,dtest: configures the output into an internal test line of the

> +	      pmic. Specified by a list of u32 pairs, one pair per channel,

> +	      where each pair denotes the test line to drive and the second

> +	      configures how the value should be outputed, as defined in the

> +	      datasheet

> +- #pwm-cells: should be 2, see ../pwm/pwm.txt

> +

> +LED subnodes:

> +A set of subnodes can be used to specify LEDs connected to the LPG. Channels

> +not associated with a LED are available as pwm channels, see ../pwm/pwm.txt.

> +

> +Required properties:

> +- led-sources: list of channels associated with this LED, starting at 1 for the

> +	       first LPG channel

> +

> +Optional properties:

> +- label: see Documentation/devicetree/bindings/leds/common.txt

> +- default-state: see Documentation/devicetree/bindings/leds/common.txt

> +- linux,default-trigger: see Documentation/devicetree/bindings/leds/common.txt

> +

> +Example:

> +The following example defines a RGB LED attached to the PM8941.

> +

> +&spmi_bus {

> +	pm8941@1 {

> +		lpg {

> +			compatible = "qcom,pm8941-lpg";

> +			qcom,power-source = <1>;

> +

> +			rgb {

> +				led-sources = <7 6 5>;

> +			};

> +		};

> +	};

> +};

> +

> +The following example defines the single PWM channel of the PM8916, which can

> +be muxed by the MPP4 as a current sink.

> +

> +&spmi_bus {

> +	pm8916@1 {

> +		pm8916_pwm: pwm {

> +			compatible = "qcom,pm8916-pwm";

> +

> +			#pwm-cells = <2>;


LED has to be represented as a child node -
see Documentation/devicetree/bindings/leds/common.txt

> +		};

> +	};

> +};

> 


Could you please also provide an example of the arrangement on the
board DragonBoard820c, you were describing in the discussions under
the previous version of the patch set. i.e. three green LEDs connected
to TRILED and one to the GPIO sink?

Also any other non-trivial board configurations supported by the
driver would allow to increase our comprehensions of the device
capabilities.

-- 
Best regards,
Jacek Anaszewski
--
To unsubscribe from this list: send the line "unsubscribe linux-arm-msm" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Bjorn Andersson Nov. 20, 2017, 9:45 p.m. | #2
On Mon 20 Nov 12:35 PST 2017, Jacek Anaszewski wrote:

> On 11/20/2017 08:58 PM, Bjorn Andersson wrote:

> > On Sun 19 Nov 13:35 PST 2017, Jacek Anaszewski wrote:

> > 

> >> Hi Bjorn,

> >>

> >> Thanks for the update.

> >>

> >> On 11/15/2017 08:13 AM, Bjorn Andersson wrote:

> >>> This adds the binding document describing the three hardware blocks

> >>> related to the Light Pulse Generator found in a wide range of Qualcomm

> >>> PMICs.

> >>>

> >>> Signed-off-by: Bjorn Andersson <bjorn.andersson@linaro.org>

> >>> ---

> >>>

> >>> Changes since v2:

> >>> - Squashed all things into one node

> >>> - Removed quirks from the binding, compatible implies number of channels, their

> >>>   configuration etc.

> >>> - Binding describes LEDs connected as child nodes

> >>> - Support describing multi-channel LEDs

> >>> - Change style of the binding document, to match other LED bindings

> >>>

> >>> Changes since v1:

> >>> - Dropped custom pattern properties

> >>> - Renamed cell-index to qcom,lpg-channel to clarify its purpose

> >>>

> >>>  .../devicetree/bindings/leds/leds-qcom-lpg.txt     | 66 ++++++++++++++++++++++

> >>>  1 file changed, 66 insertions(+)

> >>>  create mode 100644 Documentation/devicetree/bindings/leds/leds-qcom-lpg.txt

> >>>

> >>> diff --git a/Documentation/devicetree/bindings/leds/leds-qcom-lpg.txt b/Documentation/devicetree/bindings/leds/leds-qcom-lpg.txt

> >>> new file mode 100644

> >>> index 000000000000..9cee6f9f543c

> >>> --- /dev/null

> >>> +++ b/Documentation/devicetree/bindings/leds/leds-qcom-lpg.txt

> >>> @@ -0,0 +1,66 @@

> >>> +Binding for Qualcomm Light Pulse Generator

> >>> +

> >>> +The Qualcomm Light Pulse Generator consists of three different hardware blocks;

> >>> +a ramp generator with lookup table, the light pulse generator and a three

> >>> +channel current sink. These blocks are found in a wide range of Qualcomm PMICs.

> >>> +

> >>> +Required properties:

> >>> +- compatible: one of:

> >>> +	      "qcom,pm8916-pwm",

> >>> +	      "qcom,pm8941-lpg",

> >>> +	      "qcom,pm8994-lpg",

> >>> +	      "qcom,pmi8994-lpg",

> >>> +	      "qcom,pmi8998-lpg",

> >>> +

> >>> +Optional properties:

> >>> +- qcom,power-source: power-source used to drive the output, as defined in the

> >>> +		     datasheet. Should be specified if the TRILED block is

> >>> +		     present

> >>

> >> Range of possible values is missing here.

> >>

> > 

> > There seems to be a 4-way mux in all variants, but the wiring is

> > different in the different products. E.g. in pm8941 1 represents VPH_PWR

> > while in pmi8994 this is pulled from a dedicated pin named VIN_RGB.

> > 

> > Would you like me to list the 4 options for each compatible?

> 

> Could you please explain why user would prefer one power source

> over the other? Is it that they have different max current limit?

> 


The mux in pm8941 is connected to ground (0V), vph_pwr (3.6V), internal
5V and min(5V, charger). In pmi8994 it's ground, vdd_rgb (a dedicated
pin) and 4.2V. PMI8998 is a slight variation of PMI8994 and I expect
there to be more variants.

So it's different voltage level and, potentially, current limit.

[..]
> One more question regarding TRILED - in your design it will be

> exposed as a single LED class device with one brightness file,

> right? Does it mean that all three LEDs will be applied the

> same brightness after writing it to the sysfs file?

> 


Correct, each LED described in DT will become one LED and can have more
than one (any number of) physical channel associated. The current
implementation applies the same brightness (and pattern) to all channels
associated with a LED.

The open question is still how to pass a color from user space, the
brightness_set and pattern_set would need to be modified to map a list
of brightnesses to the individual channels or to adapt the brightness by
some color-modifier(?).


I've tested the driver on single-LEDs and on RGB-leds and it supports
both, the latter with pulse pattern synchronized over the 3 channels.
So I'm hoping that we can move forward with merging the driver with this
limitation and then discuss the RGB interface in LED-class separately.

Regards,
Bjorn
--
To unsubscribe from this list: send the line "unsubscribe linux-arm-msm" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Patch

diff --git a/Documentation/devicetree/bindings/leds/leds-qcom-lpg.txt b/Documentation/devicetree/bindings/leds/leds-qcom-lpg.txt
new file mode 100644
index 000000000000..9cee6f9f543c
--- /dev/null
+++ b/Documentation/devicetree/bindings/leds/leds-qcom-lpg.txt
@@ -0,0 +1,66 @@ 
+Binding for Qualcomm Light Pulse Generator
+
+The Qualcomm Light Pulse Generator consists of three different hardware blocks;
+a ramp generator with lookup table, the light pulse generator and a three
+channel current sink. These blocks are found in a wide range of Qualcomm PMICs.
+
+Required properties:
+- compatible: one of:
+	      "qcom,pm8916-pwm",
+	      "qcom,pm8941-lpg",
+	      "qcom,pm8994-lpg",
+	      "qcom,pmi8994-lpg",
+	      "qcom,pmi8998-lpg",
+
+Optional properties:
+- qcom,power-source: power-source used to drive the output, as defined in the
+		     datasheet. Should be specified if the TRILED block is
+		     present
+- qcom,dtest: configures the output into an internal test line of the
+	      pmic. Specified by a list of u32 pairs, one pair per channel,
+	      where each pair denotes the test line to drive and the second
+	      configures how the value should be outputed, as defined in the
+	      datasheet
+- #pwm-cells: should be 2, see ../pwm/pwm.txt
+
+LED subnodes:
+A set of subnodes can be used to specify LEDs connected to the LPG. Channels
+not associated with a LED are available as pwm channels, see ../pwm/pwm.txt.
+
+Required properties:
+- led-sources: list of channels associated with this LED, starting at 1 for the
+	       first LPG channel
+
+Optional properties:
+- label: see Documentation/devicetree/bindings/leds/common.txt
+- default-state: see Documentation/devicetree/bindings/leds/common.txt
+- linux,default-trigger: see Documentation/devicetree/bindings/leds/common.txt
+
+Example:
+The following example defines a RGB LED attached to the PM8941.
+
+&spmi_bus {
+	pm8941@1 {
+		lpg {
+			compatible = "qcom,pm8941-lpg";
+			qcom,power-source = <1>;
+
+			rgb {
+				led-sources = <7 6 5>;
+			};
+		};
+	};
+};
+
+The following example defines the single PWM channel of the PM8916, which can
+be muxed by the MPP4 as a current sink.
+
+&spmi_bus {
+	pm8916@1 {
+		pm8916_pwm: pwm {
+			compatible = "qcom,pm8916-pwm";
+
+			#pwm-cells = <2>;
+		};
+	};
+};