Re: [PATCH 1/2] dt-bindings: convert rtc/faraday,ftrtc01 to yaml

From: Rob Herring
Date: Thu May 06 2021 - 13:45:44 EST


On Mon, May 03, 2021 at 07:50:47PM +0000, Corentin Labbe wrote:
> Converts rtc/faraday,ftrtc01.txt to yaml.
> This permits to detect some missing properties: reg, resets, interrupts
>
> Signed-off-by: Corentin Labbe <clabbe@xxxxxxxxxxxx>
> ---
> .../bindings/rtc/faraday,ftrtc010.txt | 28 ---------
> .../bindings/rtc/faraday,ftrtc010.yaml | 59 +++++++++++++++++++
> 2 files changed, 59 insertions(+), 28 deletions(-)
> delete mode 100644 Documentation/devicetree/bindings/rtc/faraday,ftrtc010.txt
> create mode 100644 Documentation/devicetree/bindings/rtc/faraday,ftrtc010.yaml


> diff --git a/Documentation/devicetree/bindings/rtc/faraday,ftrtc010.yaml b/Documentation/devicetree/bindings/rtc/faraday,ftrtc010.yaml
> new file mode 100644
> index 000000000000..6b318650e79f
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/rtc/faraday,ftrtc010.yaml
> @@ -0,0 +1,59 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/rtc/faraday,ftrtc010.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Faraday Technology FTRTC010 Real Time Clock
> +
> +maintainers:
> + - Linus Walleij <linus.walleij@xxxxxxxxxx>
> +
> +description: |
> + This RTC appears in for example the Storlink Gemini family of SoCs.
> +
> +properties:
> + compatible:
> + oneOf:
> + - const: "faraday,ftrtc010"
> + - items:
> + - const: "cortina,gemini-rtc"
> + - const: "faraday,ftrtc010"

Drop quotes.

> +
> + resets:
> + maxItems: 1
> +
> + reg:
> + maxItems: 1
> +
> + interrupts:
> + maxItems: 1
> +
> + clocks:
> + minItems: 2
> + description: when present should contain clock references to the
> + PCLK and EXTCLK clocks. Faraday calls the later CLK1HZ and
> + says the clock should be 1 Hz, but implementers actually seem
> + to choose different clocks here, like Cortina who chose
> + 32768 Hz (a typical low-power clock).

Normal formatting is 2 space indent.

Split to use 'items' like PCI.

> +
> + clock-names:
> + items:
> + - const: "PCLK"
> + - const: "EXTCLK"
> +
> +required:
> + - compatible
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + #include <dt-bindings/interrupt-controller/irq.h>
> + rtc@45000000 {
> + compatible = "cortina,gemini-rtc", "faraday,ftrtc010";
> + reg = <0x45000000 0x100>;
> + interrupts = <17 IRQ_TYPE_LEVEL_HIGH>;
> + clocks = <&foo 0>, <&foo 1>;
> + clock-names = "PCLK", "EXTCLK";
> + };
> --
> 2.26.3
>