dt-bindings: rtc: rtc-sh: convert bindings to json-schema

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 <horms+renesas@verge.net.au>
Reviewed-by: Ulrich Hecht <uli+renesas@fpond.eu>
Acked-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: Rob Herring <robh@kernel.org>
This commit is contained in:
Simon Horman 2019-09-23 14:14:04 +02:00 committed by Rob Herring
parent 99e0b62152
commit 7ae8b2f5df
2 changed files with 70 additions and 28 deletions

View File

@ -0,0 +1,70 @@
# 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 <chris.brandt@renesas.com>
- Geert Uytterhoeven <geert+renesas@glider.be>
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.
minItems: 1
maxItems: 4
clock-names:
# The functional clock must be labeled as "fck". Other clocks
# may be named in accordance to the SoC hardware manuals.
minItems: 1
maxItems: 4
items:
enum: [ fck, rtc_x1, rtc_x3, extal ]
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";
};

View File

@ -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";
};