On Tue, Sep 17, 2019 at 10:36:34AM +0200, Simon Horman wrote:
> Convert Real Time Clock for Renesas SH and ARM SoCs bindings documentation
> to json-schema. Also name bindings documentation file according to the
> compat string being documented.
>
> Also correct syntax error in interrupts field in example.
>
> Signed-off-by: Simon Horman <[email protected]>
> ---
> * Based on v5.3
> * Tested using:
> # ARCH=arm64 make dtbs_check
> DT_SCHEMA_FILES=Documentation/devicetree/bindings/bus/renesas,bsc.yaml
> # ARCH=arm make dtbs_check
> DT_SCHEMA_FILES=Documentation/devicetree/bindings/bus/renesas,bsc.yaml
The above should read:
* Tested using:
# ARCH=arm64 make dtbs_check
DT_SCHEMA_FILES=Documentation/devicetree/bindings/rtc/renesas,sh-rtc.yaml
# ARCH=arm make dtbs_check
DT_SCHEMA_FILES=Documentation/devicetree/bindings/rtc/renesas,sh-rtc.yaml
> ---
> .../devicetree/bindings/rtc/renesas,sh-rtc.yaml | 66
> ++++++++++++++++++++++
> Documentation/devicetree/bindings/rtc/rtc-sh.txt | 28 ---------
> 2 files changed, 66 insertions(+), 28 deletions(-)
> create mode 100644 Documentation/devicetree/bindings/rtc/renesas,sh-rtc.yaml
> delete mode 100644 Documentation/devicetree/bindings/rtc/rtc-sh.txt
>
> diff --git a/Documentation/devicetree/bindings/rtc/renesas,sh-rtc.yaml
> b/Documentation/devicetree/bindings/rtc/renesas,sh-rtc.yaml
> new file mode 100644
> index 000000000000..07dbcd4436ce
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/rtc/renesas,sh-rtc.yaml
> @@ -0,0 +1,66 @@
> +# SPDX-License-Identifier: GPL-2.0
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/rtc/renesas,sh-rtc.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Real Time Clock for Renesas SH and ARM SoCs
> +
> +maintainers:
> + - Chris Brandt <[email protected]>
> + - Geert Uytterhoeven <[email protected]>
> +
> +properties:
> + compatible:
> + items:
> + - const: renesas,r7s72100-rtc # RZ/A1H
> + - const: renesas,sh-rtc
> +
> + reg:
> + maxItems: 1
> +
> + interrupts:
> + maxItems: 3
> +
> + interrupt-names:
> + items:
> + - const: alarm
> + - const: period
> + - const: carry
> +
> + clocks:
> + # The functional clock source for the RTC controller must be listed
> + # first (if it exists). Additionally, potential clock counting sources
> + # are to be listed.
> + true
> +
> + clock-names:
> + # The functional clock must be labeled as "fck". Other clocks
> + # may be named in accordance to the SoC hardware manuals.
> + true
> +
> +required:
> + - compatible
> + - reg
> + - interrupts
> + - interrupt-names
> + - clocks
> + - clock-names
> +
> +examples:
> + - |
> + #include <dt-bindings/clock/r7s72100-clock.h>
> + #include <dt-bindings/interrupt-controller/arm-gic.h>
> + #include <dt-bindings/interrupt-controller/irq.h>
> +
> + rtc: rtc@fcff1000 {
> + compatible = "renesas,r7s72100-rtc", "renesas,sh-rtc";
> + reg = <0xfcff1000 0x2e>;
> + interrupts = <GIC_SPI 276 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 277 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 278 IRQ_TYPE_EDGE_RISING>;
> + interrupt-names = "alarm", "period", "carry";
> + clocks = <&mstp6_clks R7S72100_CLK_RTC>, <&rtc_x1_clk>,
> + <&rtc_x3_clk>, <&extal_clk>;
> + clock-names = "fck", "rtc_x1", "rtc_x3", "extal";
> + };
> diff --git a/Documentation/devicetree/bindings/rtc/rtc-sh.txt
> b/Documentation/devicetree/bindings/rtc/rtc-sh.txt
> deleted file mode 100644
> index 7676c7d28874..000000000000
> --- a/Documentation/devicetree/bindings/rtc/rtc-sh.txt
> +++ /dev/null
> @@ -1,28 +0,0 @@
> -* Real Time Clock for Renesas SH and ARM SoCs
> -
> -Required properties:
> -- compatible: Should be "renesas,r7s72100-rtc" and "renesas,sh-rtc" as a
> - fallback.
> -- reg: physical base address and length of memory mapped region.
> -- interrupts: 3 interrupts for alarm, period, and carry.
> -- interrupt-names: The interrupts should be labeled as "alarm", "period", and
> - "carry".
> -- clocks: The functional clock source for the RTC controller must be listed
> - first (if exists). Additionally, potential clock counting sources are to be
> - listed.
> -- clock-names: The functional clock must be labeled as "fck". Other clocks
> - may be named in accordance to the SoC hardware manuals.
> -
> -
> -Example:
> -rtc: rtc@fcff1000 {
> - compatible = "renesas,r7s72100-rtc", "renesas,sh-rtc";
> - reg = <0xfcff1000 0x2e>;
> - interrupts = <GIC_SPI 276 IRQ_TYPE_EDGE_RISING
> - GIC_SPI 277 IRQ_TYPE_EDGE_RISING
> - GIC_SPI 278 IRQ_TYPE_EDGE_RISING>;
> - interrupt-names = "alarm", "period", "carry";
> - clocks = <&mstp6_clks R7S72100_CLK_RTC>, <&rtc_x1_clk>,
> - <&rtc_x3_clk>, <&extal_clk>;
> - clock-names = "fck", "rtc_x1", "rtc_x3", "extal";
> -};
> --
> 2.11.0
>
