Re: [PATCH v6 1/4] dt-bindings: leds: Add Qualcomm Light Pulse Generator binding

Rob Herring
2020-10-26T15:02:42Z

On Wed, Oct 21, 2020 at 01:12:21PM -0700, 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 v5:
> - None
>
> .../bindings/leds/leds-qcom-lpg.yaml | 170 ++++++++++++++++++
> 1 file changed, 170 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/leds/leds-qcom-lpg.yaml
>
> diff --git a/Documentation/devicetree/bindings/leds/leds-qcom-lpg.yaml b/Documentation/devicetree/bindings/leds/leds-qcom-lpg.yaml
> new file mode 100644
> index 000000000000..5ccf0f3d8f1b
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/leds/leds-qcom-lpg.yaml
> @@ -0,0 +1,170 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/leds/leds-qcom-lpg.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Qualcomm Light Pulse Generator
> +
> +maintainers:
> + - Bjorn Andersson <bjorn.andersson@linaro.org>
> +
> +description: >
> + 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.
> +
> +properties:
> + compatible:
> + enum:
> + - qcom,pm8916-pwm

Are the LED properties valid when PWM is used/enabled? The schema
suggests yes, the example suggests no. If not, I think this should be 2
schema docs.

> + - qcom,pm8941-lpg
> + - qcom,pm8994-lpg
> + - qcom,pmi8994-lpg
> + - qcom,pmi8998-lpg
> +
> + "#pwm-cells":
> + const: 2
> +
> + "#address-cells":
> + const: 1
> +
> + "#size-cells":
> + const: 0
> +
> + qcom,power-source:
> + $ref: /schemas/types.yaml#definitions/uint32

led-sources can't be made to work for this?

> + description: >
> + power-source used to drive the output, as defined in the datasheet.
> + Should be specified if the TRILED block is present
> + enum:
> + - 0
> + - 1
> + - 3
> +
> + multi-led:
> + type: object
> + $ref: leds-class-multicolor.yaml#
> + properties:
> + "#address-cells":
> + const: 1
> +
> + "#size-cells":
> + const: 0
> +
> + "^led@[0-9a-f]$":
> + type: object
> + $ref: common.yaml#
> +
> + properties:
> + "qcom,dtest":

Don't need quotes.

> + $ref: /schemas/types.yaml#definitions/uint32-array

The description sounds like a matrix rather than an array.

> + description: >
> + 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
> + minItems: 2
> + maxItems: 2

If so, then you'd want:

items:
minItems: 2
maxItems: 2

> +
> + required:
> + - reg
> +
> +patternProperties:
> + "^led@[0-9a-f]$":
> + type: object
> + $ref: common.yaml#
> + properties:
> + "qcom,dtest":
> + $ref: /schemas/types.yaml#definitions/uint32-array
> + description: >
> + 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
> + minItems: 2
> + maxItems: 2
> +
> + required:
> + - reg
> +
> +required:
> + - compatible
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + #include <dt-bindings/leds/common.h>
> +
> + lpg {
> + compatible = "qcom,pmi8994-lpg";
> +
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + qcom,power-source = <1>;
> +
> + led@1 {
> + reg = <1>;
> + label = "green:user1";
> + };
> +
> + led@2 {
> + reg = <2>;
> + label = "green:user0";
> + default-state = "on";
> + };
> +
> + led@3 {
> + reg = <3>;
> + label = "green:user2";
> + };
> +
> + led@4 {
> + reg = <4>;
> + label = "green:user3";
> +
> + qcom,dtest = <4 1>;
> + };
> + };
> + - |
> + #include <dt-bindings/leds/common.h>
> +
> + lpg {
> + compatible = "qcom,pmi8994-lpg";
> +
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + qcom,power-source = <1>;
> +
> + multi-led {
> + color = <LED_COLOR_ID_MULTI>;
> + label = "rgb:notification";
> +
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + led@1 {
> + reg = <1>;
> + color = <LED_COLOR_ID_RED>;
> + };
> +
> + led@2 {
> + reg = <2>;
> + color = <LED_COLOR_ID_GREEN>;
> + };
> +
> + led@3 {
> + reg = <3>;
> + color = <LED_COLOR_ID_BLUE>;
> + };
> + };
> + };
> + - |
> + lpg {
> + compatible = "qcom,pm8916-pwm";
> + #pwm-cells = <2>;
> + };
> +...
> --
> 2.28.0
>