This series converts the following existing bindings to dtschema:
- armada-380-rtc
- alphascale,asm9260
- digicolor-rtc (renamed to cnxt,cx92755-rtc to match compatible)
- nxp,lpc1788-rtc
All bindings include at least one compatible that is referenced in the
existing dts (arch/arm). Those dts could be tested against the new
bindings.
It might be worth mentioning that the reference to nxp,lpc1788-rtc in
arch/arm/boot/dts/nxp/lpc/lpc18xx.dtsi also includes another compatible
called nxp,lpc1850-rtc, which is not documented or supported by existing
drivers. That generates a warning when testing against nxp,lpc1788-rtc.
Signed-off-by: Javier Carrasco <[email protected]>
---
Javier Carrasco (4):
dt-bindings: rtc: armada-380-rtc: convert to dtschema
dt-bindings: rtc: alphascale,asm9260: convert to dtschema
dt-bindings: rtc: digicolor-rtc: convert to dtschema
dt-bindings: rtc: nxp,lpc1788-rtc: convert to dtschema
.../bindings/rtc/alphascale,asm9260-rtc.txt | 19 --------
.../bindings/rtc/alphascale,asm9260-rtc.yaml | 49 +++++++++++++++++++
.../devicetree/bindings/rtc/armada-380-rtc.txt | 24 ---------
.../devicetree/bindings/rtc/cnxt,cx92755-rtc.yaml | 37 ++++++++++++++
.../devicetree/bindings/rtc/digicolor-rtc.txt | 17 -------
.../bindings/rtc/marvell,armada-380-rtc.yaml | 48 ++++++++++++++++++
.../devicetree/bindings/rtc/nxp,lpc1788-rtc.txt | 21 --------
.../devicetree/bindings/rtc/nxp,lpc1788-rtc.yaml | 57 ++++++++++++++++++++++
8 files changed, 191 insertions(+), 81 deletions(-)
---
base-commit: 70293240c5ce675a67bfc48f419b093023b862b3
change-id: 20240322-rtc-yaml-473335cbf911
Best regards,
--
Javier Carrasco <[email protected]>
Convert existing binding to dtschema to support validation.
This is a direct conversion with no additions.
Signed-off-by: Javier Carrasco <[email protected]>
---
.../devicetree/bindings/rtc/armada-380-rtc.txt | 24 -----------
.../bindings/rtc/marvell,armada-380-rtc.yaml | 48 ++++++++++++++++++++++
2 files changed, 48 insertions(+), 24 deletions(-)
diff --git a/Documentation/devicetree/bindings/rtc/armada-380-rtc.txt b/Documentation/devicetree/bindings/rtc/armada-380-rtc.txt
deleted file mode 100644
index c3c9a1226f9a..000000000000
--- a/Documentation/devicetree/bindings/rtc/armada-380-rtc.txt
+++ /dev/null
@@ -1,24 +0,0 @@
-* Real Time Clock of the Armada 38x/7K/8K SoCs
-
-RTC controller for the Armada 38x, 7K and 8K SoCs
-
-Required properties:
-- compatible : Should be one of the following:
- "marvell,armada-380-rtc" for Armada 38x SoC
- "marvell,armada-8k-rtc" for Aramda 7K/8K SoCs
-- reg: a list of base address and size pairs, one for each entry in
- reg-names
-- reg names: should contain:
- * "rtc" for the RTC registers
- * "rtc-soc" for the SoC related registers and among them the one
- related to the interrupt.
-- interrupts: IRQ line for the RTC.
-
-Example:
-
-rtc@a3800 {
- compatible = "marvell,armada-380-rtc";
- reg = <0xa3800 0x20>, <0x184a0 0x0c>;
- reg-names = "rtc", "rtc-soc";
- interrupts = <GIC_SPI 21 IRQ_TYPE_LEVEL_HIGH>;
-};
diff --git a/Documentation/devicetree/bindings/rtc/marvell,armada-380-rtc.yaml b/Documentation/devicetree/bindings/rtc/marvell,armada-380-rtc.yaml
new file mode 100644
index 000000000000..388c7d7a044d
--- /dev/null
+++ b/Documentation/devicetree/bindings/rtc/marvell,armada-380-rtc.yaml
@@ -0,0 +1,48 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/rtc/marvell,armada-380-rtc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: RTC controller for the Armada 38x, 7K and 8K SoCs
+
+maintainers:
+ - Javier Carrasco <[email protected]>
+
+properties:
+ compatible:
+ enum:
+ - marvell,armada-380-rtc
+ - marvell,armada-8k-rtc
+
+ reg:
+ items:
+ - description: RTC base address size
+ - description: Base address and size of SoC related registers
+
+ reg-names:
+ items:
+ - const: rtc
+ - const: rtc-soc
+
+ interrupts:
+ maxItems: 1
+
+required:
+ - compatible
+ - reg
+ - reg-names
+ - interrupts
+
+additionalProperties: false
+
+examples:
+ - |
+ #include <dt-bindings/interrupt-controller/arm-gic.h>
+
+ rtc@a3800 {
+ compatible = "marvell,armada-380-rtc";
+ reg = <0xa3800 0x20>, <0x184a0 0x0c>;
+ reg-names = "rtc", "rtc-soc";
+ interrupts = <GIC_SPI 21 IRQ_TYPE_LEVEL_HIGH>;
+ };
--
2.40.1
Convert existing binding to dtschema to support validation.
This is a direct conversion with no additions.
Signed-off-by: Javier Carrasco <[email protected]>
---
.../bindings/rtc/alphascale,asm9260-rtc.txt | 19 ---------
.../bindings/rtc/alphascale,asm9260-rtc.yaml | 49 ++++++++++++++++++++++
2 files changed, 49 insertions(+), 19 deletions(-)
diff --git a/Documentation/devicetree/bindings/rtc/alphascale,asm9260-rtc.txt b/Documentation/devicetree/bindings/rtc/alphascale,asm9260-rtc.txt
deleted file mode 100644
index 76ebca568db9..000000000000
--- a/Documentation/devicetree/bindings/rtc/alphascale,asm9260-rtc.txt
+++ /dev/null
@@ -1,19 +0,0 @@
-* Alphascale asm9260 SoC Real Time Clock
-
-Required properties:
-- compatible: Should be "alphascale,asm9260-rtc"
-- reg: Physical base address of the controller and length
- of memory mapped region.
-- interrupts: IRQ line for the RTC.
-- clocks: Reference to the clock entry.
-- clock-names: should contain:
- * "ahb" for the SoC RTC clock
-
-Example:
-rtc0: rtc@800a0000 {
- compatible = "alphascale,asm9260-rtc";
- reg = <0x800a0000 0x100>;
- clocks = <&acc CLKID_AHB_RTC>;
- clock-names = "ahb";
- interrupts = <2>;
-};
diff --git a/Documentation/devicetree/bindings/rtc/alphascale,asm9260-rtc.yaml b/Documentation/devicetree/bindings/rtc/alphascale,asm9260-rtc.yaml
new file mode 100644
index 000000000000..f949634ef56b
--- /dev/null
+++ b/Documentation/devicetree/bindings/rtc/alphascale,asm9260-rtc.yaml
@@ -0,0 +1,49 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/rtc/alphascale,asm9260-rtc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Alphascale asm9260 SoC Real Time Clock
+
+maintainers:
+ - Javier Carrasco <[email protected]>
+
+properties:
+ compatible:
+ const: alphascale,asm9260-rtc
+
+ reg:
+ description:
+ Base address and length of the register region.
+ maxItems: 1
+
+ clocks:
+ maxItems: 1
+
+ clock-names:
+ const: ahb
+
+ interrupts:
+ maxItems: 1
+
+required:
+ - compatible
+ - reg
+ - clocks
+ - clock-names
+ - interrupts
+
+additionalProperties: false
+
+examples:
+ - |
+ #include <dt-bindings/clock/alphascale,asm9260.h>
+
+ rtc@800a0000 {
+ compatible = "alphascale,asm9260-rtc";
+ reg = <0x800a0000 0x100>;
+ clocks = <&acc CLKID_AHB_RTC>;
+ clock-names = "ahb";
+ interrupts = <2>;
+ };
--
2.40.1
Convert existing binding to dtschema to support validation.
The binding has been renamed to match its compatible. Apart from that,
it is a direct conversion with no additions.
Signed-off-by: Javier Carrasco <[email protected]>
---
.../devicetree/bindings/rtc/cnxt,cx92755-rtc.yaml | 37 ++++++++++++++++++++++
.../devicetree/bindings/rtc/digicolor-rtc.txt | 17 ----------
2 files changed, 37 insertions(+), 17 deletions(-)
diff --git a/Documentation/devicetree/bindings/rtc/cnxt,cx92755-rtc.yaml b/Documentation/devicetree/bindings/rtc/cnxt,cx92755-rtc.yaml
new file mode 100644
index 000000000000..bdd6f0718b0a
--- /dev/null
+++ b/Documentation/devicetree/bindings/rtc/cnxt,cx92755-rtc.yaml
@@ -0,0 +1,37 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/rtc/cnxt,cx92755-rtc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Conexant Digicolor Real Time Clock Controller
+
+maintainers:
+ - Javier Carrasco <[email protected]>
+
+properties:
+ compatible:
+ const: cnxt,cx92755-rtc
+
+ reg:
+ description:
+ Base address and length of the register region.
+ maxItems: 1
+
+ interrupts:
+ maxItems: 1
+
+required:
+ - compatible
+ - reg
+ - interrupts
+
+additionalProperties: false
+
+examples:
+ - |
+ rtc@f0000c30 {
+ compatible = "cnxt,cx92755-rtc";
+ reg = <0xf0000c30 0x18>;
+ interrupts = <25>;
+ };
diff --git a/Documentation/devicetree/bindings/rtc/digicolor-rtc.txt b/Documentation/devicetree/bindings/rtc/digicolor-rtc.txt
deleted file mode 100644
index d464986012cd..000000000000
--- a/Documentation/devicetree/bindings/rtc/digicolor-rtc.txt
+++ /dev/null
@@ -1,17 +0,0 @@
-Conexant Digicolor Real Time Clock controller
-
-This binding currently supports the CX92755 SoC.
-
-Required properties:
-- compatible: should be "cnxt,cx92755-rtc"
-- reg: physical base address of the controller and length of memory mapped
- region.
-- interrupts: rtc alarm interrupt
-
-Example:
-
- rtc@f0000c30 {
- compatible = "cnxt,cx92755-rtc";
- reg = <0xf0000c30 0x18>;
- interrupts = <25>;
- };
--
2.40.1
Convert existing binding to dtschema to support validation.
This is a direct conversion with no additions.
Signed-off-by: Javier Carrasco <[email protected]>
---
.../devicetree/bindings/rtc/nxp,lpc1788-rtc.txt | 21 --------
.../devicetree/bindings/rtc/nxp,lpc1788-rtc.yaml | 57 ++++++++++++++++++++++
2 files changed, 57 insertions(+), 21 deletions(-)
diff --git a/Documentation/devicetree/bindings/rtc/nxp,lpc1788-rtc.txt b/Documentation/devicetree/bindings/rtc/nxp,lpc1788-rtc.txt
deleted file mode 100644
index 3c97bd180592..000000000000
--- a/Documentation/devicetree/bindings/rtc/nxp,lpc1788-rtc.txt
+++ /dev/null
@@ -1,21 +0,0 @@
-NXP LPC1788 real-time clock
-
-The LPC1788 RTC provides calendar and clock functionality
-together with periodic tick and alarm interrupt support.
-
-Required properties:
-- compatible : must contain "nxp,lpc1788-rtc"
-- reg : Specifies base physical address and size of the registers.
-- interrupts : A single interrupt specifier.
-- clocks : Must contain clock specifiers for rtc and register clock
-- clock-names : Must contain "rtc" and "reg"
- See ../clocks/clock-bindings.txt for details.
-
-Example:
-rtc: rtc@40046000 {
- compatible = "nxp,lpc1788-rtc";
- reg = <0x40046000 0x1000>;
- interrupts = <47>;
- clocks = <&creg_clk 0>, <&ccu1 CLK_CPU_BUS>;
- clock-names = "rtc", "reg";
-};
diff --git a/Documentation/devicetree/bindings/rtc/nxp,lpc1788-rtc.yaml b/Documentation/devicetree/bindings/rtc/nxp,lpc1788-rtc.yaml
new file mode 100644
index 000000000000..af157ff24835
--- /dev/null
+++ b/Documentation/devicetree/bindings/rtc/nxp,lpc1788-rtc.yaml
@@ -0,0 +1,57 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/rtc/nxp,lpc1788-rtc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: NXP LPC1788 real-time clock
+
+description:
+ The LPC1788 RTC provides calendar and clock functionality
+ together with periodic tick and alarm interrupt support.
+
+maintainers:
+ - Javier Carrasco <[email protected]>
+
+properties:
+ compatible:
+ const: nxp,lpc1788-rtc
+
+ reg:
+ description:
+ Base address and length of the register region.
+ maxItems: 1
+
+ clocks:
+ items:
+ - description: RTC clock
+ - description: Register clock
+
+ clock-names:
+ items:
+ - const: rtc
+ - const: reg
+
+ interrupts:
+ maxItems: 1
+
+required:
+ - compatible
+ - reg
+ - clocks
+ - clock-names
+ - interrupts
+
+additionalProperties: false
+
+examples:
+ - |
+ #include <dt-bindings/clock/lpc18xx-ccu.h>
+
+ rtc@40046000 {
+ compatible = "nxp,lpc1788-rtc";
+ reg = <0x40046000 0x1000>;
+ clocks = <&creg_clk 0>, <&ccu1 CLK_CPU_BUS>;
+ clock-names = "rtc", "reg";
+ interrupts = <47>;
+ };
--
2.40.1
On 23/03/2024 23:46:13+0100, Javier Carrasco wrote:
> Convert existing binding to dtschema to support validation.
>
> This is a direct conversion with no additions.
>
> Signed-off-by: Javier Carrasco <[email protected]>
> ---
> .../devicetree/bindings/rtc/armada-380-rtc.txt | 24 -----------
> .../bindings/rtc/marvell,armada-380-rtc.yaml | 48 ++++++++++++++++++++++
> 2 files changed, 48 insertions(+), 24 deletions(-)
>
> diff --git a/Documentation/devicetree/bindings/rtc/armada-380-rtc.txt b/Documentation/devicetree/bindings/rtc/armada-380-rtc.txt
> deleted file mode 100644
> index c3c9a1226f9a..000000000000
> --- a/Documentation/devicetree/bindings/rtc/armada-380-rtc.txt
> +++ /dev/null
> @@ -1,24 +0,0 @@
> -* Real Time Clock of the Armada 38x/7K/8K SoCs
> -
> -RTC controller for the Armada 38x, 7K and 8K SoCs
> -
> -Required properties:
> -- compatible : Should be one of the following:
> - "marvell,armada-380-rtc" for Armada 38x SoC
> - "marvell,armada-8k-rtc" for Aramda 7K/8K SoCs
> -- reg: a list of base address and size pairs, one for each entry in
> - reg-names
> -- reg names: should contain:
> - * "rtc" for the RTC registers
> - * "rtc-soc" for the SoC related registers and among them the one
> - related to the interrupt.
> -- interrupts: IRQ line for the RTC.
> -
> -Example:
> -
> -rtc@a3800 {
> - compatible = "marvell,armada-380-rtc";
> - reg = <0xa3800 0x20>, <0x184a0 0x0c>;
> - reg-names = "rtc", "rtc-soc";
> - interrupts = <GIC_SPI 21 IRQ_TYPE_LEVEL_HIGH>;
> -};
> diff --git a/Documentation/devicetree/bindings/rtc/marvell,armada-380-rtc.yaml b/Documentation/devicetree/bindings/rtc/marvell,armada-380-rtc.yaml
> new file mode 100644
> index 000000000000..388c7d7a044d
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/rtc/marvell,armada-380-rtc.yaml
> @@ -0,0 +1,48 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/rtc/marvell,armada-380-rtc.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: RTC controller for the Armada 38x, 7K and 8K SoCs
> +
> +maintainers:
> + - Javier Carrasco <[email protected]>
> +
> +properties:
> + compatible:
> + enum:
> + - marvell,armada-380-rtc
> + - marvell,armada-8k-rtc
> +
> + reg:
> + items:
> + - description: RTC base address size
> + - description: Base address and size of SoC related registers
> +
> + reg-names:
> + items:
> + - const: rtc
> + - const: rtc-soc
> +
> + interrupts:
> + maxItems: 1
> +
> +required:
> + - compatible
> + - reg
> + - reg-names
> + - interrupts
> +
> +additionalProperties: false
This is not correct because at least start-year is supported. Please
check for all your other submissions too.
> +
> +examples:
> + - |
> + #include <dt-bindings/interrupt-controller/arm-gic.h>
> +
> + rtc@a3800 {
> + compatible = "marvell,armada-380-rtc";
> + reg = <0xa3800 0x20>, <0x184a0 0x0c>;
> + reg-names = "rtc", "rtc-soc";
> + interrupts = <GIC_SPI 21 IRQ_TYPE_LEVEL_HIGH>;
> + };
>
> --
> 2.40.1
>
--
Alexandre Belloni, co-owner and COO, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
On 3/24/24 00:37, Alexandre Belloni wrote:
> On 23/03/2024 23:46:13+0100, Javier Carrasco wrote:
>> Convert existing binding to dtschema to support validation.
>>
>> +required:
>> + - compatible
>> + - reg
>> + - reg-names
>> + - interrupts
>> +
>> +additionalProperties: false
>
> This is not correct because at least start-year is supported. Please
> check for all your other submissions too.
>
allOf:
- $ref: rtc.yaml#
is missing, and then
unvealuatedProperties: false
to account for that.
"start-year" is read in the RTC base class, so I wonder why so many RTC
bindings add a reference to rtc.yaml, but then use
additionalProperties: false
>> +
>> +examples:
>> + - |
>> + #include <dt-bindings/interrupt-controller/arm-gic.h>
>> +
>> + rtc@a3800 {
>> + compatible = "marvell,armada-380-rtc";
>> + reg = <0xa3800 0x20>, <0x184a0 0x0c>;
>> + reg-names = "rtc", "rtc-soc";
>> + interrupts = <GIC_SPI 21 IRQ_TYPE_LEVEL_HIGH>;
>> + };
>>
>> --
>> 2.40.1
>>
>
Thanks and best regards,
Javier Carrasco
On Sat, Mar 23, 2024 at 11:46:15PM +0100, Javier Carrasco wrote:
> Convert existing binding to dtschema to support validation.
>
> The binding has been renamed to match its compatible. Apart from that,
> it is a direct conversion with no additions.
>
> Signed-off-by: Javier Carrasco <[email protected]>
> ---
> .../devicetree/bindings/rtc/cnxt,cx92755-rtc.yaml | 37 ++++++++++++++++++++++
> .../devicetree/bindings/rtc/digicolor-rtc.txt | 17 ----------
> 2 files changed, 37 insertions(+), 17 deletions(-)
This could probably just go into trivial-rtc.yaml.
Rob
On Sun, Mar 24, 2024 at 01:02:31AM +0100, Javier Carrasco wrote:
> On 3/24/24 00:37, Alexandre Belloni wrote:
> > On 23/03/2024 23:46:13+0100, Javier Carrasco wrote:
> >> Convert existing binding to dtschema to support validation.
> >>
> >> +required:
> >> + - compatible
> >> + - reg
> >> + - reg-names
> >> + - interrupts
> >> +
> >> +additionalProperties: false
> >
> > This is not correct because at least start-year is supported. Please
> > check for all your other submissions too.
> >
>
> allOf:
> - $ref: rtc.yaml#
>
> is missing, and then
>
> unvealuatedProperties: false
>
> to account for that.
>
> "start-year" is read in the RTC base class, so I wonder why so many RTC
> bindings add a reference to rtc.yaml, but then use
>
> additionalProperties: false
They may have pre-dated support for 'unevaluatedProperties', or you can
list out which properties are used from a referenced schema which
disallows unlisted properties. There's no hard rule here. Either way is
fine.
Other than this and my 1 other comment, this series looks fine to me.
Rob
On 25/03/2024 20:46, Javier Carrasco wrote:
> On 3/25/24 17:01, Rob Herring wrote:
>> On Sat, Mar 23, 2024 at 11:46:15PM +0100, Javier Carrasco wrote:
>>> Convert existing binding to dtschema to support validation.
>>>
>>> The binding has been renamed to match its compatible. Apart from that,
>>> it is a direct conversion with no additions.
>>>
>>> Signed-off-by: Javier Carrasco <[email protected]>
>>> ---
>>> .../devicetree/bindings/rtc/cnxt,cx92755-rtc.yaml | 37 ++++++++++++++++++++++
>>> .../devicetree/bindings/rtc/digicolor-rtc.txt | 17 ----------
>>> 2 files changed, 37 insertions(+), 17 deletions(-)
>>
>> This could probably just go into trivial-rtc.yaml.
>>
>> Rob
>
> Does it make no difference if the reg property is a single address or
> address + size? trivial-rtc.yaml does no specify that ('an address' is
> mentioned), and I don't know if it is obvious for someone who wants to
> use this device.
First, you can answer to this by yourself: where do you have the "size"
documented? You will see that nowhere, because your description is
actually redundant and should be dropped. So if "nowhere", then your
binding is the same as trivial-rtc.
The presence of size is defined by the bus, not by this binding.
Therefore you do not have to tell anyone that it is address+size,
because it is obvious from the bus. And from device datasheet (bindings
are not replacement of datasheets).
Best regards,
Krzysztof
On 3/25/24 17:01, Rob Herring wrote:
> On Sat, Mar 23, 2024 at 11:46:15PM +0100, Javier Carrasco wrote:
>> Convert existing binding to dtschema to support validation.
>>
>> The binding has been renamed to match its compatible. Apart from that,
>> it is a direct conversion with no additions.
>>
>> Signed-off-by: Javier Carrasco <[email protected]>
>> ---
>> .../devicetree/bindings/rtc/cnxt,cx92755-rtc.yaml | 37 ++++++++++++++++++++++
>> .../devicetree/bindings/rtc/digicolor-rtc.txt | 17 ----------
>> 2 files changed, 37 insertions(+), 17 deletions(-)
>
> This could probably just go into trivial-rtc.yaml.
>
> Rob
Does it make no difference if the reg property is a single address or
address + size? trivial-rtc.yaml does no specify that ('an address' is
mentioned), and I don't know if it is obvious for someone who wants to
use this device.
Best regards,
Javier Carrasco