diff mbox series

[2/3] dt-bindings: fpga: Add binding doc for versal fpga manager

Message ID 20210118024318.9530-2-nava.manne@xilinx.com (mailing list archive)
State Changes Requested
Headers show
Series [1/3] drivers: firmware: Add Pdi load API support | expand

Commit Message

Nava kishore Manne Jan. 18, 2021, 2:43 a.m. UTC 
From: Appana Durga Kedareswara rao <appana.durga.rao@xilinx.com>

This patch adds binding doc for versal fpga manager driver.

Signed-off-by: Nava kishore Manne <nava.manne@xilinx.com>
Signed-off-by: Appana Durga Kedareswara rao <appana.durga.rao@xilinx.com>
---
 .../bindings/fpga/xlnx,versal-fpga.yaml       | 33 +++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/fpga/xlnx,versal-fpga.yaml

Comments

Michal Simek Jan. 18, 2021, 8:52 a.m. UTC | #1 
On 1/18/21 3:43 AM, Nava kishore Manne wrote:
> From: Appana Durga Kedareswara rao <appana.durga.rao@xilinx.com>
> 
> This patch adds binding doc for versal fpga manager driver.
> 
> Signed-off-by: Nava kishore Manne <nava.manne@xilinx.com>
> Signed-off-by: Appana Durga Kedareswara rao <appana.durga.rao@xilinx.com>
> ---
>  .../bindings/fpga/xlnx,versal-fpga.yaml       | 33 +++++++++++++++++++
>  1 file changed, 33 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/fpga/xlnx,versal-fpga.yaml
> 
> diff --git a/Documentation/devicetree/bindings/fpga/xlnx,versal-fpga.yaml b/Documentation/devicetree/bindings/fpga/xlnx,versal-fpga.yaml
> new file mode 100644
> index 000000000000..cf3aa7917488
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/fpga/xlnx,versal-fpga.yaml
> @@ -0,0 +1,33 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +
> +$id: http://devicetree.org/schemas/fpga/xilinx/xlnx,versal-fpga.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Xilinx versal-fpga driver.
> +
> +maintainers:
> +  - Nava kishore Manne <nava.manne@xilinx.com>
> +
> +description: |
> +Device Tree versal-fpga bindings for the Versal SOC, Controlled
> +using Versal SoC firmware interface.
> +
> +properties:
> +  compatible:
> +    items:
> +      - enum:
> +        - xlnx,versal-fpga
> +
> +required:
> +  - compatible
> +
> +Required properties:
> +- compatible: should contain "xlnx,versal-fpga"
> +
> +examples:
> +  - |
> +    versal_fpga: fpga {
> +         compatible = "xlnx,versal-fpga";
> +    };
> 

There are issues with the binding
Run
make
DT_SCHEMA_FILES=Documentation/devicetree/bindings/fpga/xlnx,versal-fpga.yaml
dt_binding_check

and fix
./Documentation/devicetree/bindings/fpga/xlnx,versal-fpga.yaml:15:1:
[error] syntax error: could not find expected ':' (syntax)
and maybe others.

Thanks,
Michal
Rob Herring (Arm) Jan. 18, 2021, 3:47 p.m. UTC | #2 
On Mon, 18 Jan 2021 08:13:17 +0530, Nava kishore Manne wrote:
> From: Appana Durga Kedareswara rao <appana.durga.rao@xilinx.com>
> 
> This patch adds binding doc for versal fpga manager driver.
> 
> Signed-off-by: Nava kishore Manne <nava.manne@xilinx.com>
> Signed-off-by: Appana Durga Kedareswara rao <appana.durga.rao@xilinx.com>
> ---
>  .../bindings/fpga/xlnx,versal-fpga.yaml       | 33 +++++++++++++++++++
>  1 file changed, 33 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/fpga/xlnx,versal-fpga.yaml
> 

My bot found errors running 'make dt_binding_check' on your patch:

yamllint warnings/errors:
./Documentation/devicetree/bindings/fpga/xlnx,versal-fpga.yaml:15:1: [error] syntax error: could not find expected ':' (syntax)

dtschema/dtc warnings/errors:
make[1]: *** Deleting file 'Documentation/devicetree/bindings/fpga/xlnx,versal-fpga.example.dts'
Traceback (most recent call last):
  File "/usr/local/bin/dt-extract-example", line 45, in <module>
    binding = yaml.load(open(args.yamlfile, encoding='utf-8').read())
  File "/usr/local/lib/python3.8/dist-packages/ruamel/yaml/main.py", line 343, in load
    return constructor.get_single_data()
  File "/usr/local/lib/python3.8/dist-packages/ruamel/yaml/constructor.py", line 111, in get_single_data
    node = self.composer.get_single_node()
  File "_ruamel_yaml.pyx", line 706, in _ruamel_yaml.CParser.get_single_node
  File "_ruamel_yaml.pyx", line 724, in _ruamel_yaml.CParser._compose_document
  File "_ruamel_yaml.pyx", line 775, in _ruamel_yaml.CParser._compose_node
  File "_ruamel_yaml.pyx", line 891, in _ruamel_yaml.CParser._compose_mapping_node
  File "_ruamel_yaml.pyx", line 904, in _ruamel_yaml.CParser._parse_next_event
ruamel.yaml.scanner.ScannerError: while scanning a simple key
  in "<unicode string>", line 14, column 1
could not find expected ':'
  in "<unicode string>", line 15, column 1
make[1]: *** [Documentation/devicetree/bindings/Makefile:20: Documentation/devicetree/bindings/fpga/xlnx,versal-fpga.example.dts] Error 1
make[1]: *** Waiting for unfinished jobs....
./Documentation/devicetree/bindings/fpga/xlnx,versal-fpga.yaml:  while scanning a simple key
  in "<unicode string>", line 14, column 1
could not find expected ':'
  in "<unicode string>", line 15, column 1
/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/fpga/xlnx,versal-fpga.yaml: ignoring, error parsing file
warning: no schema found in file: ./Documentation/devicetree/bindings/fpga/xlnx,versal-fpga.yaml
make: *** [Makefile:1370: dt_binding_check] Error 2

See https://patchwork.ozlabs.org/patch/1427979

This check can fail if there are any dependencies. The base for a patch
series is generally the most recent rc1.

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:

pip3 install dtschema --upgrade

Please check and re-submit.
Nava kishore Manne Jan. 22, 2021, 9:44 a.m. UTC | #3 
Hi Michal,

	Thanks for the review.
Please find my response inline.

> -----Original Message-----
> From: Michal Simek <michal.simek@xilinx.com>
> Sent: Monday, January 18, 2021 2:22 PM
> To: Nava kishore Manne <navam@xilinx.com>; mdf@kernel.org;
> trix@redhat.com; robh+dt@kernel.org; Michal Simek <michals@xilinx.com>;
> linux-fpga@vger.kernel.org; devicetree@vger.kernel.org; linux-arm-
> kernel@lists.infradead.org; linux-kernel@vger.kernel.org
> Cc: git <git@xilinx.com>; chinnikishore369@gmail.com; Appana Durga
> Kedareswara Rao <appanad@xilinx.com>
> Subject: Re: [PATCH 2/3] dt-bindings: fpga: Add binding doc for versal fpga
> manager
> 
> 
> 
> On 1/18/21 3:43 AM, Nava kishore Manne wrote:
> > From: Appana Durga Kedareswara rao <appana.durga.rao@xilinx.com>
> >
> > This patch adds binding doc for versal fpga manager driver.
> >
> > Signed-off-by: Nava kishore Manne <nava.manne@xilinx.com>
> > Signed-off-by: Appana Durga Kedareswara rao
> > <appana.durga.rao@xilinx.com>
> > ---
> >  .../bindings/fpga/xlnx,versal-fpga.yaml       | 33 +++++++++++++++++++
> >  1 file changed, 33 insertions(+)
> >  create mode 100644
> > Documentation/devicetree/bindings/fpga/xlnx,versal-fpga.yaml
> >
> > diff --git
> > a/Documentation/devicetree/bindings/fpga/xlnx,versal-fpga.yaml
> > b/Documentation/devicetree/bindings/fpga/xlnx,versal-fpga.yaml
> > new file mode 100644
> > index 000000000000..cf3aa7917488
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/fpga/xlnx,versal-fpga.yaml
> > @@ -0,0 +1,33 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) %YAML 1.2
> > +---
> > +
> > +$id: http://devicetree.org/schemas/fpga/xilinx/xlnx,versal-fpga.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Xilinx versal-fpga driver.
> > +
> > +maintainers:
> > +  - Nava kishore Manne <nava.manne@xilinx.com>
> > +
> > +description: |
> > +Device Tree versal-fpga bindings for the Versal SOC, Controlled using
> > +Versal SoC firmware interface.
> > +
> > +properties:
> > +  compatible:
> > +    items:
> > +      - enum:
> > +        - xlnx,versal-fpga
> > +
> > +required:
> > +  - compatible
> > +
> > +Required properties:
> > +- compatible: should contain "xlnx,versal-fpga"
> > +
> > +examples:
> > +  - |
> > +    versal_fpga: fpga {
> > +         compatible = "xlnx,versal-fpga";
> > +    };
> >
> 
> There are issues with the binding
> Run
> make
> DT_SCHEMA_FILES=Documentation/devicetree/bindings/fpga/xlnx,versal-
> fpga.yaml
> dt_binding_check
> 

Thanks for pointing it. Will fix in v2.

> and fix
> ./Documentation/devicetree/bindings/fpga/xlnx,versal-fpga.yaml:15:1:
> [error] syntax error: could not find expected ':' (syntax) and maybe others.
> 

Will fix in v2.

Regards,
Navakishore.
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/fpga/xlnx,versal-fpga.yaml b/Documentation/devicetree/bindings/fpga/xlnx,versal-fpga.yaml
new file mode 100644
index 000000000000..cf3aa7917488
--- /dev/null
+++ b/Documentation/devicetree/bindings/fpga/xlnx,versal-fpga.yaml
@@ -0,0 +1,33 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+
+$id: http://devicetree.org/schemas/fpga/xilinx/xlnx,versal-fpga.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Xilinx versal-fpga driver.
+
+maintainers:
+  - Nava kishore Manne <nava.manne@xilinx.com>
+
+description: |
+Device Tree versal-fpga bindings for the Versal SOC, Controlled
+using Versal SoC firmware interface.
+
+properties:
+  compatible:
+    items:
+      - enum:
+        - xlnx,versal-fpga
+
+required:
+  - compatible
+
+Required properties:
+- compatible: should contain "xlnx,versal-fpga"
+
+examples:
+  - |
+    versal_fpga: fpga {
+         compatible = "xlnx,versal-fpga";
+    };