diff mbox series

[V2,2/5] dt-bindings: nvmem: Convert xlnx,zynqmp-nvmem.txt to yaml

Message ID 20231019060651.23341-3-praveen.teja.kundanala@amd.com
State Changes Requested
Headers show
Series Add ZynqMP efuse access support | expand

Checks

Context Check Description
robh/checkpatch warning total: 0 errors, 2 warnings, 40 lines checked
robh/patch-applied success
robh/dtbs-check warning build log
robh/dt-meta-schema success

Commit Message

Praveen Teja Kundanala Oct. 19, 2023, 6:06 a.m. UTC
Convert the xlnx,zynqmp-nvmem.txt to yaml.

Signed-off-by: Praveen Teja Kundanala <praveen.teja.kundanala@amd.com>
---
 .../bindings/nvmem/xlnx,zynqmp-nvmem.txt      | 46 -------------------
 .../bindings/nvmem/xlnx,zynqmp-nvmem.yaml     | 40 ++++++++++++++++
 2 files changed, 40 insertions(+), 46 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/nvmem/xlnx,zynqmp-nvmem.txt
 create mode 100644 Documentation/devicetree/bindings/nvmem/xlnx,zynqmp-nvmem.yaml

Comments

Krzysztof Kozlowski Oct. 19, 2023, 9:26 a.m. UTC | #1
On 19/10/2023 08:06, Praveen Teja Kundanala wrote:
> Convert the xlnx,zynqmp-nvmem.txt to yaml.
> 
> Signed-off-by: Praveen Teja Kundanala <praveen.teja.kundanala@amd.com>
> ---
>  .../bindings/nvmem/xlnx,zynqmp-nvmem.txt      | 46 -------------------
>  .../bindings/nvmem/xlnx,zynqmp-nvmem.yaml     | 40 ++++++++++++++++
>  2 files changed, 40 insertions(+), 46 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/nvmem/xlnx,zynqmp-nvmem.txt
>  create mode 100644 Documentation/devicetree/bindings/nvmem/xlnx,zynqmp-nvmem.yaml
> 
> diff --git a/Documentation/devicetree/bindings/nvmem/xlnx,zynqmp-nvmem.txt b/Documentation/devicetree/bindings/nvmem/xlnx,zynqmp-nvmem.txt
> deleted file mode 100644
> index 4881561b3a02..000000000000
> --- a/Documentation/devicetree/bindings/nvmem/xlnx,zynqmp-nvmem.txt
> +++ /dev/null
> @@ -1,46 +0,0 @@
> ---------------------------------------------------------------------------
> -=  Zynq UltraScale+ MPSoC nvmem firmware driver binding =
> ---------------------------------------------------------------------------
> -The nvmem_firmware node provides access to the hardware related data
> -like soc revision, IDCODE... etc, By using the firmware interface.
> -
> -Required properties:
> -- compatible: should be "xlnx,zynqmp-nvmem-fw"
> -
> -= Data cells =
> -Are child nodes of silicon id, bindings of which as described in
> -bindings/nvmem/nvmem.txt
> -
> --------
> - Example
> --------
> -firmware {
> -	zynqmp_firmware: zynqmp-firmware {
> -		compatible = "xlnx,zynqmp-firmware";
> -		method = "smc";
> -
> -		nvmem_firmware {
> -			compatible = "xlnx,zynqmp-nvmem-fw";
> -			#address-cells = <1>;
> -			#size-cells = <1>;
> -
> -			/* Data cells */
> -			soc_revision: soc_revision {
> -				reg = <0x0 0x4>;
> -			};
> -		};
> -	};
> -};
> -
> -= Data consumers =
> -Are device nodes which consume nvmem data cells.
> -
> -For example:
> -	pcap {
> -		...
> -
> -		nvmem-cells = <&soc_revision>;
> -		nvmem-cell-names = "soc_revision";
> -
> -		...
> -	};
> diff --git a/Documentation/devicetree/bindings/nvmem/xlnx,zynqmp-nvmem.yaml b/Documentation/devicetree/bindings/nvmem/xlnx,zynqmp-nvmem.yaml
> new file mode 100644
> index 000000000000..5d20362a0615
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/nvmem/xlnx,zynqmp-nvmem.yaml
> @@ -0,0 +1,40 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/nvmem/xlnx,zynqmp-nvmem.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Zynq UltraScale+ MPSoC Non Volatile Memory interface
> +
> +description: |
> +    The ZynqMP MPSoC provides access to the hardware related data
> +    like SOC revision, IDCODE and specific purpose efuses.
> +
> +maintainers:
> +  - Kalyani Akula <kalyani.akula@amd.com>
> +  - Praveen Teja Kundanala <praveen.teja.kundanala@amd.com>
> +
> +allOf:
> +  - $ref: nvmem.yaml#
> +
> +properties:
> +  compatible:
> +    const: xlnx,zynqmp-nvmem-fw
> +
> +required:
> +  - compatible

Test your bindings before sending. I am not a free tester of your
code... It's your duty.

> +
> +unevaluatedProperties: false
> +
> +examples:
> +  - |
> +    nvmem-firmware {

Node names should be generic, so "nvmem". See also an explanation and
list of examples (not exhaustive) in DT specification:
https://devicetree-specification.readthedocs.io/en/latest/chapter2-devicetree-basics.html#generic-names-recommendation

I already asked for this.

Best regards,
Krzysztof
Praveen Teja Kundanala Oct. 19, 2023, 10:35 a.m. UTC | #2
[AMD Official Use Only - General]

Hi Kozlowski,

> -----Original Message-----
> From: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
> Sent: Thursday, October 19, 2023 2:57 PM
> To: Kundanala, Praveen Teja <praveen.teja.kundanala@amd.com>;
> srinivas.kandagatla@linaro.org; robh+dt@kernel.org;
> krzysztof.kozlowski+dt@linaro.org; conor+dt@kernel.org; Simek, Michal
> <michal.simek@amd.com>; Kundanala, Praveen Teja
> <praveen.teja.kundanala@amd.com>; devicetree@vger.kernel.org; linux-arm-
> kernel@lists.infradead.org
> Cc: linux-kernel@vger.kernel.org
> Subject: Re: [PATCH V2 2/5] dt-bindings: nvmem: Convert xlnx,zynqmp-
> nvmem.txt to yaml
>
> Caution: This message originated from an External Source. Use proper caution
> when opening attachments, clicking links, or responding.
>
>
> On 19/10/2023 08:06, Praveen Teja Kundanala wrote:
> > Convert the xlnx,zynqmp-nvmem.txt to yaml.
> >
> > Signed-off-by: Praveen Teja Kundanala <praveen.teja.kundanala@amd.com>
> > ---
> >  .../bindings/nvmem/xlnx,zynqmp-nvmem.txt      | 46 -------------------
> >  .../bindings/nvmem/xlnx,zynqmp-nvmem.yaml     | 40 ++++++++++++++++
> >  2 files changed, 40 insertions(+), 46 deletions(-)  delete mode
> > 100644 Documentation/devicetree/bindings/nvmem/xlnx,zynqmp-
> nvmem.txt
> >  create mode 100644
> > Documentation/devicetree/bindings/nvmem/xlnx,zynqmp-nvmem.yaml
> >
> > diff --git
> > a/Documentation/devicetree/bindings/nvmem/xlnx,zynqmp-nvmem.txt
> > b/Documentation/devicetree/bindings/nvmem/xlnx,zynqmp-nvmem.txt
> > deleted file mode 100644
> > index 4881561b3a02..000000000000
> > --- a/Documentation/devicetree/bindings/nvmem/xlnx,zynqmp-nvmem.txt
> > +++ /dev/null
> > @@ -1,46 +0,0 @@
> > ----------------------------------------------------------------------
> > ----- -=  Zynq UltraScale+ MPSoC nvmem firmware driver binding =
> > ----------------------------------------------------------------------
> > ----- -The nvmem_firmware node provides access to the hardware related
> > data -like soc revision, IDCODE... etc, By using the firmware
> > interface.
> > -
> > -Required properties:
> > -- compatible: should be "xlnx,zynqmp-nvmem-fw"
> > -
> > -= Data cells =
> > -Are child nodes of silicon id, bindings of which as described in
> > -bindings/nvmem/nvmem.txt
> > -
> > --------
> > - Example
> > --------
> > -firmware {
> > -     zynqmp_firmware: zynqmp-firmware {
> > -             compatible = "xlnx,zynqmp-firmware";
> > -             method = "smc";
> > -
> > -             nvmem_firmware {
> > -                     compatible = "xlnx,zynqmp-nvmem-fw";
> > -                     #address-cells = <1>;
> > -                     #size-cells = <1>;
> > -
> > -                     /* Data cells */
> > -                     soc_revision: soc_revision {
> > -                             reg = <0x0 0x4>;
> > -                     };
> > -             };
> > -     };
> > -};
> > -
> > -= Data consumers =
> > -Are device nodes which consume nvmem data cells.
> > -
> > -For example:
> > -     pcap {
> > -             ...
> > -
> > -             nvmem-cells = <&soc_revision>;
> > -             nvmem-cell-names = "soc_revision";
> > -
> > -             ...
> > -     };
> > diff --git
> > a/Documentation/devicetree/bindings/nvmem/xlnx,zynqmp-nvmem.yaml
> > b/Documentation/devicetree/bindings/nvmem/xlnx,zynqmp-nvmem.yaml
> > new file mode 100644
> > index 000000000000..5d20362a0615
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/nvmem/xlnx,zynqmp-
> nvmem.yaml
> > @@ -0,0 +1,40 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) %YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/nvmem/xlnx,zynqmp-nvmem.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Zynq UltraScale+ MPSoC Non Volatile Memory interface
> > +
> > +description: |
> > +    The ZynqMP MPSoC provides access to the hardware related data
> > +    like SOC revision, IDCODE and specific purpose efuses.
> > +
> > +maintainers:
> > +  - Kalyani Akula <kalyani.akula@amd.com>
> > +  - Praveen Teja Kundanala <praveen.teja.kundanala@amd.com>
> > +
> > +allOf:
> > +  - $ref: nvmem.yaml#
> > +
> > +properties:
> > +  compatible:
> > +    const: xlnx,zynqmp-nvmem-fw
> > +
> > +required:
> > +  - compatible
>
> Test your bindings before sending. I am not a free tester of your code... It's your
> duty.
[Kundanala, Praveen Teja] Missed it will send V3 after testing.
>
> > +
> > +unevaluatedProperties: false
> > +
> > +examples:
> > +  - |
> > +    nvmem-firmware {
>
> Node names should be generic, so "nvmem". See also an explanation and list of
> examples (not exhaustive) in DT specification:
> https://devicetree-specification.readthedocs.io/en/latest/chapter2-devicetree-
> basics.html#generic-names-recommendation
>
> I already asked for this.
[Kundanala, Praveen Teja] Will refer and update it.

Regards,
Praveen
>
> Best regards,
> Krzysztof
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/nvmem/xlnx,zynqmp-nvmem.txt b/Documentation/devicetree/bindings/nvmem/xlnx,zynqmp-nvmem.txt
deleted file mode 100644
index 4881561b3a02..000000000000
--- a/Documentation/devicetree/bindings/nvmem/xlnx,zynqmp-nvmem.txt
+++ /dev/null
@@ -1,46 +0,0 @@ 
---------------------------------------------------------------------------
-=  Zynq UltraScale+ MPSoC nvmem firmware driver binding =
---------------------------------------------------------------------------
-The nvmem_firmware node provides access to the hardware related data
-like soc revision, IDCODE... etc, By using the firmware interface.
-
-Required properties:
-- compatible: should be "xlnx,zynqmp-nvmem-fw"
-
-= Data cells =
-Are child nodes of silicon id, bindings of which as described in
-bindings/nvmem/nvmem.txt
-
--------
- Example
--------
-firmware {
-	zynqmp_firmware: zynqmp-firmware {
-		compatible = "xlnx,zynqmp-firmware";
-		method = "smc";
-
-		nvmem_firmware {
-			compatible = "xlnx,zynqmp-nvmem-fw";
-			#address-cells = <1>;
-			#size-cells = <1>;
-
-			/* Data cells */
-			soc_revision: soc_revision {
-				reg = <0x0 0x4>;
-			};
-		};
-	};
-};
-
-= Data consumers =
-Are device nodes which consume nvmem data cells.
-
-For example:
-	pcap {
-		...
-
-		nvmem-cells = <&soc_revision>;
-		nvmem-cell-names = "soc_revision";
-
-		...
-	};
diff --git a/Documentation/devicetree/bindings/nvmem/xlnx,zynqmp-nvmem.yaml b/Documentation/devicetree/bindings/nvmem/xlnx,zynqmp-nvmem.yaml
new file mode 100644
index 000000000000..5d20362a0615
--- /dev/null
+++ b/Documentation/devicetree/bindings/nvmem/xlnx,zynqmp-nvmem.yaml
@@ -0,0 +1,40 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/nvmem/xlnx,zynqmp-nvmem.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Zynq UltraScale+ MPSoC Non Volatile Memory interface
+
+description: |
+    The ZynqMP MPSoC provides access to the hardware related data
+    like SOC revision, IDCODE and specific purpose efuses.
+
+maintainers:
+  - Kalyani Akula <kalyani.akula@amd.com>
+  - Praveen Teja Kundanala <praveen.teja.kundanala@amd.com>
+
+allOf:
+  - $ref: nvmem.yaml#
+
+properties:
+  compatible:
+    const: xlnx,zynqmp-nvmem-fw
+
+required:
+  - compatible
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    nvmem-firmware {
+        compatible = "xlnx,zynqmp-nvmem-fw";
+        #address-cells = <1>;
+        #size-cells = <1>;
+
+        /* Data cells */
+        soc_revision: soc-revision@0 {
+            reg = <0x0 0x4>;
+        };
+    };