Re: [PATCH v3 5/6] dt-bindings: leds: max77650: convert the binding document to yaml

Rob Herring
2019-10-17T18:51:22Z

On Thu, Oct 17, 2019 at 09:12:33AM +0200, Bartosz Golaszewski wrote:
> From: Bartosz Golaszewski <bgolaszewski@baylibre.com>
>
> Convert the binding document for MAX77650 LED module to YAML.
>
> Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>
> ---
> .../bindings/leds/leds-max77650.txt | 57 ------------------
> .../bindings/leds/leds-max77650.yaml | 58 +++++++++++++++++++
> 2 files changed, 58 insertions(+), 57 deletions(-)
> delete mode 100644 Documentation/devicetree/bindings/leds/leds-max77650.txt
> create mode 100644 Documentation/devicetree/bindings/leds/leds-max77650.yaml
>
> diff --git a/Documentation/devicetree/bindings/leds/leds-max77650.txt b/Documentation/devicetree/bindings/leds/leds-max77650.txt
> deleted file mode 100644
> index 3a67115cc1da..000000000000
> --- a/Documentation/devicetree/bindings/leds/leds-max77650.txt
> +++ /dev/null
> @@ -1,57 +0,0 @@
> -LED driver for MAX77650 PMIC from Maxim Integrated.
> -
> -This module is part of the MAX77650 MFD device. For more details
> -see Documentation/devicetree/bindings/mfd/max77650.txt.
> -
> -The LED controller is represented as a sub-node of the PMIC node on
> -the device tree.
> -
> -This device has three current sinks.
> -
> -Required properties:
> ---------------------
> -- compatible: Must be "maxim,max77650-led"
> -- #address-cells: Must be <1>.
> -- #size-cells: Must be <0>.
> -
> -Each LED is represented as a sub-node of the LED-controller node. Up to
> -three sub-nodes can be defined.
> -
> -Required properties of the sub-node:
> -------------------------------------
> -
> -- reg: Must be <0>, <1> or <2>.
> -
> -Optional properties of the sub-node:
> -------------------------------------
> -
> -- label: See Documentation/devicetree/bindings/leds/common.txt
> -- linux,default-trigger: See Documentation/devicetree/bindings/leds/common.txt
> -
> -For more details, please refer to the generic GPIO DT binding document
> -<devicetree/bindings/gpio/gpio.txt>.
> -
> -Example:
> ---------
> -
> - leds {
> - compatible = "maxim,max77650-led";
> - #address-cells = <1>;
> - #size-cells = <0>;
> -
> - led@0 {
> - reg = <0>;
> - label = "blue:usr0";
> - };
> -
> - led@1 {
> - reg = <1>;
> - label = "red:usr1";
> - linux,default-trigger = "heartbeat";
> - };
> -
> - led@2 {
> - reg = <2>;
> - label = "green:usr2";
> - };
> - };
> diff --git a/Documentation/devicetree/bindings/leds/leds-max77650.yaml b/Documentation/devicetree/bindings/leds/leds-max77650.yaml
> new file mode 100644
> index 000000000000..5a1e256185bd
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/leds/leds-max77650.yaml
> @@ -0,0 +1,58 @@
> +# SPDX-License-Identifier: GPL-2.0
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/leds/leds-max77650.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: LED driver for MAX77650 PMIC from Maxim Integrated.
> +
> +maintainers:
> + - Bartosz Golaszewski <bgolaszewski@baylibre.com>
> +
> +description: |
> + This module is part of the MAX77650 MFD device. For more details
> + see Documentation/devicetree/bindings/mfd/max77650.txt.
> +
> + The LED controller is represented as a sub-node of the PMIC node on
> + the device tree.
> +
> + This device has three current sinks.
> +
> +properties:
> + compatible:
> + const: maxim,max77650-led
> +
> + "#address-cells":
> + const: 1
> +
> + "#size-cells":
> + const: 0
> +
> +patternProperties:
> + "^led@[0-2]$":
> + type: object
> + description: |
> + Properties for a single LED.
> +
> + properties:
> + reg:
> + description:
> + Index of the LED.
> + maxItems: 1
> + minimum: 0
> + maximum: 2

Mixing array and scalar constraints. Just need (dropping maxItems):

items:
- minimum: 0
maximum: 2

> +
> + label:
> + $ref: "/schemas/types.yaml#/definitions/string"

Globally defined as a string already.

> + description:
> + The label of this LED.
> +
> + linux,default-trigger:
> + $ref: "/schemas/types.yaml#/definitions/string"

Assume this gets a common binding.

So just 'true' is sufficient for both of these.

> + description:
> + String defining the default trigger assigned to this LED.
> +
> +required:
> + - compatible
> + - "#address-cells"
> + - "#size-cells"
> --
> 2.23.0
>