diff mbox series

[1/1] dt-bindings: rtc: Convert rtc-fsl-ftm-alarm.txt to yaml format

Message ID 20240520214614.863539-1-Frank.Li@nxp.com (mailing list archive)
State Superseded
Headers show
Series [1/1] dt-bindings: rtc: Convert rtc-fsl-ftm-alarm.txt to yaml format | expand

Commit Message

Frank Li May 20, 2024, 9:46 p.m. UTC 
Convert dt-binding doc "rtc-fsl-ftm-alarm.txt" to yaml format.

Change example's reg to 32bit address and length.
Remove unrelated rcpm@1e34040 in example.

Signed-off-by: Frank Li <Frank.Li@nxp.com>
---

Notes:
    make dt_binding_check DT_SCHEMA_FILES=rtc-fsl-ftm-alarm.yaml
      SCHEMA  Documentation/devicetree/bindings/processed-schema.json
      CHKDT   Documentation/devicetree/bindings
      LINT    Documentation/devicetree/bindings
      DTEX    Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.example.dts
      DTC_CHK Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.example.dtb

 .../bindings/rtc/rtc-fsl-ftm-alarm.txt        | 36 -----------
 .../bindings/rtc/rtc-fsl-ftm-alarm.yaml       | 61 +++++++++++++++++++
 2 files changed, 61 insertions(+), 36 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.txt
 create mode 100644 Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.yaml

Comments

Krzysztof Kozlowski May 21, 2024, 7:59 a.m. UTC | #1 
On 20/05/2024 23:46, Frank Li wrote:
> Convert dt-binding doc "rtc-fsl-ftm-alarm.txt" to yaml format.
> 
> Change example's reg to 32bit address and length.
> Remove unrelated rcpm@1e34040 in example.
> 
> Signed-off-by: Frank Li <Frank.Li@nxp.com>
> ---
> 
> Notes:
>     make dt_binding_check DT_SCHEMA_FILES=rtc-fsl-ftm-alarm.yaml
>       SCHEMA  Documentation/devicetree/bindings/processed-schema.json
>       CHKDT   Documentation/devicetree/bindings
>       LINT    Documentation/devicetree/bindings
>       DTEX    Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.example.dts
>       DTC_CHK Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.example.dtb
> 
>  .../bindings/rtc/rtc-fsl-ftm-alarm.txt        | 36 -----------
>  .../bindings/rtc/rtc-fsl-ftm-alarm.yaml       | 61 +++++++++++++++++++
>  2 files changed, 61 insertions(+), 36 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.txt
>  create mode 100644 Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.yaml
> 
> diff --git a/Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.txt b/Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.txt
> deleted file mode 100644
> index fffac74999da6..0000000000000
> --- a/Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.txt
> +++ /dev/null
> @@ -1,36 +0,0 @@
> -Freescale FlexTimer Module (FTM) Alarm
> -
> -Required properties:
> -- compatible : Should be "fsl,<chip>-ftm-alarm", the
> -	       supported chips include
> -	       "fsl,ls1012a-ftm-alarm"
> -	       "fsl,ls1021a-ftm-alarm"
> -	       "fsl,ls1028a-ftm-alarm"
> -	       "fsl,ls1043a-ftm-alarm"
> -	       "fsl,ls1046a-ftm-alarm"
> -	       "fsl,ls1088a-ftm-alarm"
> -	       "fsl,ls208xa-ftm-alarm"
> -	       "fsl,lx2160a-ftm-alarm"
> -- reg : Specifies base physical address and size of the register sets for the
> -  FlexTimer Module.
> -- interrupts : Should be the FlexTimer Module interrupt.
> -- fsl,rcpm-wakeup property and rcpm node : Please refer
> -	Documentation/devicetree/bindings/soc/fsl/rcpm.txt
> -
> -Optional properties:
> -- big-endian: If the host controller is big-endian mode, specify this property.
> -  The default endian mode is little-endian.
> -
> -Example:
> -rcpm: rcpm@1e34040 {
> -	compatible = "fsl,ls1088a-rcpm", "fsl,qoriq-rcpm-2.1+";
> -	reg = <0x0 0x1e34040 0x0 0x18>;
> -	#fsl,rcpm-wakeup-cells = <6>;
> -};
> -
> -ftm_alarm0: timer@2800000 {
> -	compatible = "fsl,ls1088a-ftm-alarm";
> -	reg = <0x0 0x2800000 0x0 0x10000>;
> -	fsl,rcpm-wakeup = <&rcpm 0x0 0x0 0x0 0x0 0x4000 0x0>;
> -	interrupts = <0 44 4>;
> -};
> diff --git a/Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.yaml b/Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.yaml
> new file mode 100644
> index 0000000000000..69b44e9920033
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.yaml

fsl,ls-ftm-alarm.yaml

or

fsl,ls1012a-ftm-alarm.yaml

> @@ -0,0 +1,61 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/rtc/rtc-fsl-ftm-alarm.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Freescale FlexTimer Module (FTM) Alarm
> +
> +maintainers:
> +  - Frank Li <Frank.Li@nxp.com>
> +
> +properties:
> +  compatible:
> +    enum:
> +      - fsl,ls1012a-ftm-alarm
> +      - fsl,ls1021a-ftm-alarm
> +      - fsl,ls1028a-ftm-alarm
> +      - fsl,ls1043a-ftm-alarm
> +      - fsl,ls1046a-ftm-alarm
> +      - fsl,ls1088a-ftm-alarm
> +      - fsl,ls208xa-ftm-alarm
> +      - fsl,lx2160a-ftm-alarm
> +
> +  reg:
> +    description:
> +      Specifies base physical address and size of the register sets for the
> +      FlexTimer Module.

Drop description, redundant.

> +    maxItems: 1
> +
> +  interrupts:
> +    description: Should be the FlexTimer Module interrupt.

Drop description, redundant.


> +    maxItems: 1
> +
> +  fsl,rcpm-wakeup:
> +    $ref: /schemas/types.yaml#/definitions/phandle-array

Please describe the items (see syscon-like phandles).

> +    description:
> +      phandle to rcpm node, Please refer
> +      documentation/devicetree/bindings/soc/fsl/rcpm.txt
> +
> +  big-endian:
> +    $ref: /schemas/types.yaml#/definitions/flag
> +    description:
> +      If the host controller is big-endian mode, specify this property.
> +      The default endian mode is little-endian.
> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - fsl,rcpm-wakeup
> +

Missing allOf with ref to rtc.yaml.

> +unevaluatedProperties: false

becauase otherwise above does not make much sense... unless this is not
a RTC?

> +
> +examples:
> +  - |
> +    timer@2800000 {

timer or rtc?

> +        compatible = "fsl,ls1088a-ftm-alarm";
> +        reg = <0x2800000 0x10000>;
> +        fsl,rcpm-wakeup = <&rcpm 0x0 0x0 0x0 0x0 0x4000 0x0>;
> +        interrupts = <0 44 4>;

Include proper header and use defines for GIC and flags.

> +    };

Best regards,
Krzysztof
Frank Li May 28, 2024, 4:01 p.m. UTC | #2 
On Tue, May 21, 2024 at 09:59:00AM +0200, Krzysztof Kozlowski wrote:
> On 20/05/2024 23:46, Frank Li wrote:
> > Convert dt-binding doc "rtc-fsl-ftm-alarm.txt" to yaml format.
> > 
> > Change example's reg to 32bit address and length.
> > Remove unrelated rcpm@1e34040 in example.
> > 
> > Signed-off-by: Frank Li <Frank.Li@nxp.com>
> > ---
> > 
> > Notes:
> >     make dt_binding_check DT_SCHEMA_FILES=rtc-fsl-ftm-alarm.yaml
> >       SCHEMA  Documentation/devicetree/bindings/processed-schema.json
> >       CHKDT   Documentation/devicetree/bindings
> >       LINT    Documentation/devicetree/bindings
> >       DTEX    Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.example.dts
> >       DTC_CHK Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.example.dtb
> > 
> >  .../bindings/rtc/rtc-fsl-ftm-alarm.txt        | 36 -----------
> >  .../bindings/rtc/rtc-fsl-ftm-alarm.yaml       | 61 +++++++++++++++++++
> >  2 files changed, 61 insertions(+), 36 deletions(-)
> >  delete mode 100644 Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.txt
> >  create mode 100644 Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.yaml
> > 
> > diff --git a/Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.txt b/Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.txt
> > deleted file mode 100644
> > index fffac74999da6..0000000000000
> > --- a/Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.txt
> > +++ /dev/null
> > @@ -1,36 +0,0 @@
> > -Freescale FlexTimer Module (FTM) Alarm
> > -
> > -Required properties:
> > -- compatible : Should be "fsl,<chip>-ftm-alarm", the
> > -	       supported chips include
> > -	       "fsl,ls1012a-ftm-alarm"
> > -	       "fsl,ls1021a-ftm-alarm"
> > -	       "fsl,ls1028a-ftm-alarm"
> > -	       "fsl,ls1043a-ftm-alarm"
> > -	       "fsl,ls1046a-ftm-alarm"
> > -	       "fsl,ls1088a-ftm-alarm"
> > -	       "fsl,ls208xa-ftm-alarm"
> > -	       "fsl,lx2160a-ftm-alarm"
> > -- reg : Specifies base physical address and size of the register sets for the
> > -  FlexTimer Module.
> > -- interrupts : Should be the FlexTimer Module interrupt.
> > -- fsl,rcpm-wakeup property and rcpm node : Please refer
> > -	Documentation/devicetree/bindings/soc/fsl/rcpm.txt
> > -
> > -Optional properties:
> > -- big-endian: If the host controller is big-endian mode, specify this property.
> > -  The default endian mode is little-endian.
> > -
> > -Example:
> > -rcpm: rcpm@1e34040 {
> > -	compatible = "fsl,ls1088a-rcpm", "fsl,qoriq-rcpm-2.1+";
> > -	reg = <0x0 0x1e34040 0x0 0x18>;
> > -	#fsl,rcpm-wakeup-cells = <6>;
> > -};
> > -
> > -ftm_alarm0: timer@2800000 {
> > -	compatible = "fsl,ls1088a-ftm-alarm";
> > -	reg = <0x0 0x2800000 0x0 0x10000>;
> > -	fsl,rcpm-wakeup = <&rcpm 0x0 0x0 0x0 0x0 0x4000 0x0>;
> > -	interrupts = <0 44 4>;
> > -};
> > diff --git a/Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.yaml b/Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.yaml
> > new file mode 100644
> > index 0000000000000..69b44e9920033
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.yaml
> 
> fsl,ls-ftm-alarm.yaml
> 
> or
> 
> fsl,ls1012a-ftm-alarm.yaml
> 
> > @@ -0,0 +1,61 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/rtc/rtc-fsl-ftm-alarm.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Freescale FlexTimer Module (FTM) Alarm
> > +
> > +maintainers:
> > +  - Frank Li <Frank.Li@nxp.com>
> > +
> > +properties:
> > +  compatible:
> > +    enum:
> > +      - fsl,ls1012a-ftm-alarm
> > +      - fsl,ls1021a-ftm-alarm
> > +      - fsl,ls1028a-ftm-alarm
> > +      - fsl,ls1043a-ftm-alarm
> > +      - fsl,ls1046a-ftm-alarm
> > +      - fsl,ls1088a-ftm-alarm
> > +      - fsl,ls208xa-ftm-alarm
> > +      - fsl,lx2160a-ftm-alarm
> > +
> > +  reg:
> > +    description:
> > +      Specifies base physical address and size of the register sets for the
> > +      FlexTimer Module.
> 
> Drop description, redundant.
> 
> > +    maxItems: 1
> > +
> > +  interrupts:
> > +    description: Should be the FlexTimer Module interrupt.
> 
> Drop description, redundant.
> 
> 
> > +    maxItems: 1
> > +
> > +  fsl,rcpm-wakeup:
> > +    $ref: /schemas/types.yaml#/definitions/phandle-array
> 
> Please describe the items (see syscon-like phandles).
> 
> > +    description:
> > +      phandle to rcpm node, Please refer
> > +      documentation/devicetree/bindings/soc/fsl/rcpm.txt
> > +
> > +  big-endian:
> > +    $ref: /schemas/types.yaml#/definitions/flag
> > +    description:
> > +      If the host controller is big-endian mode, specify this property.
> > +      The default endian mode is little-endian.
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +  - interrupts
> > +  - fsl,rcpm-wakeup
> > +
> 
> Missing allOf with ref to rtc.yaml.
> 
> > +unevaluatedProperties: false
> 
> becauase otherwise above does not make much sense... unless this is not
> a RTC?

Sorry! which one doesn't make sense? I suppose not "unevaluatedProperties".

Frank

> 
> > +
> > +examples:
> > +  - |
> > +    timer@2800000 {
> 
> timer or rtc?
> 
> > +        compatible = "fsl,ls1088a-ftm-alarm";
> > +        reg = <0x2800000 0x10000>;
> > +        fsl,rcpm-wakeup = <&rcpm 0x0 0x0 0x0 0x0 0x4000 0x0>;
> > +        interrupts = <0 44 4>;
> 
> Include proper header and use defines for GIC and flags.
> 
> > +    };
> 
> Best regards,
> Krzysztof
>
Krzysztof Kozlowski May 28, 2024, 4:09 p.m. UTC | #3 
On 28/05/2024 18:01, Frank Li wrote:
>>> +required:
>>> +  - compatible
>>> +  - reg
>>> +  - interrupts
>>> +  - fsl,rcpm-wakeup
>>> +
>>
>> Missing allOf with ref to rtc.yaml.
>>
>>> +unevaluatedProperties: false
>>
>> becauase otherwise above does not make much sense... unless this is not
>> a RTC?
> 
> Sorry! which one doesn't make sense? I suppose not "unevaluatedProperties".
> 

unevaluated does not make sense on its own. For some rationale or
background see example-schema, writing bindings or my old slides.

Best regards,
Krzysztof
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.txt b/Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.txt
deleted file mode 100644
index fffac74999da6..0000000000000
--- a/Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.txt
+++ /dev/null
@@ -1,36 +0,0 @@ 
-Freescale FlexTimer Module (FTM) Alarm
-
-Required properties:
-- compatible : Should be "fsl,<chip>-ftm-alarm", the
-	       supported chips include
-	       "fsl,ls1012a-ftm-alarm"
-	       "fsl,ls1021a-ftm-alarm"
-	       "fsl,ls1028a-ftm-alarm"
-	       "fsl,ls1043a-ftm-alarm"
-	       "fsl,ls1046a-ftm-alarm"
-	       "fsl,ls1088a-ftm-alarm"
-	       "fsl,ls208xa-ftm-alarm"
-	       "fsl,lx2160a-ftm-alarm"
-- reg : Specifies base physical address and size of the register sets for the
-  FlexTimer Module.
-- interrupts : Should be the FlexTimer Module interrupt.
-- fsl,rcpm-wakeup property and rcpm node : Please refer
-	Documentation/devicetree/bindings/soc/fsl/rcpm.txt
-
-Optional properties:
-- big-endian: If the host controller is big-endian mode, specify this property.
-  The default endian mode is little-endian.
-
-Example:
-rcpm: rcpm@1e34040 {
-	compatible = "fsl,ls1088a-rcpm", "fsl,qoriq-rcpm-2.1+";
-	reg = <0x0 0x1e34040 0x0 0x18>;
-	#fsl,rcpm-wakeup-cells = <6>;
-};
-
-ftm_alarm0: timer@2800000 {
-	compatible = "fsl,ls1088a-ftm-alarm";
-	reg = <0x0 0x2800000 0x0 0x10000>;
-	fsl,rcpm-wakeup = <&rcpm 0x0 0x0 0x0 0x0 0x4000 0x0>;
-	interrupts = <0 44 4>;
-};
diff --git a/Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.yaml b/Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.yaml
new file mode 100644
index 0000000000000..69b44e9920033
--- /dev/null
+++ b/Documentation/devicetree/bindings/rtc/rtc-fsl-ftm-alarm.yaml
@@ -0,0 +1,61 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/rtc/rtc-fsl-ftm-alarm.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Freescale FlexTimer Module (FTM) Alarm
+
+maintainers:
+  - Frank Li <Frank.Li@nxp.com>
+
+properties:
+  compatible:
+    enum:
+      - fsl,ls1012a-ftm-alarm
+      - fsl,ls1021a-ftm-alarm
+      - fsl,ls1028a-ftm-alarm
+      - fsl,ls1043a-ftm-alarm
+      - fsl,ls1046a-ftm-alarm
+      - fsl,ls1088a-ftm-alarm
+      - fsl,ls208xa-ftm-alarm
+      - fsl,lx2160a-ftm-alarm
+
+  reg:
+    description:
+      Specifies base physical address and size of the register sets for the
+      FlexTimer Module.
+    maxItems: 1
+
+  interrupts:
+    description: Should be the FlexTimer Module interrupt.
+    maxItems: 1
+
+  fsl,rcpm-wakeup:
+    $ref: /schemas/types.yaml#/definitions/phandle-array
+    description:
+      phandle to rcpm node, Please refer
+      documentation/devicetree/bindings/soc/fsl/rcpm.txt
+
+  big-endian:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description:
+      If the host controller is big-endian mode, specify this property.
+      The default endian mode is little-endian.
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - fsl,rcpm-wakeup
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    timer@2800000 {
+        compatible = "fsl,ls1088a-ftm-alarm";
+        reg = <0x2800000 0x10000>;
+        fsl,rcpm-wakeup = <&rcpm 0x0 0x0 0x0 0x0 0x4000 0x0>;
+        interrupts = <0 44 4>;
+    };