diff mbox series

[2/2] doc: dt-binding: cdns-salvo-phy: add binding doc

Message ID 20200227062754.19131-2-peter.chen@nxp.com (mailing list archive)
State Superseded
Headers show
Series [1/2] phy: cadence: salvo: add salvo phy driver | expand

Commit Message

Peter Chen Feb. 27, 2020, 6:27 a.m. UTC
Add Cadence SALVO PHY binding doc, this PHY is a lagacy module,
and is only used for USB3 and USB2.

Signed-off-by: Peter Chen <peter.chen@nxp.com>
---
 .../bindings/phy/cdns,salvo-phy.yaml          | 47 +++++++++++++++++++
 1 file changed, 47 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/phy/cdns,salvo-phy.yaml

Comments

Rob Herring (Arm) Feb. 27, 2020, 5:08 p.m. UTC | #1
On Thu, 27 Feb 2020 14:27:54 +0800, Peter Chen wrote:
> Add Cadence SALVO PHY binding doc, this PHY is a lagacy module,
> and is only used for USB3 and USB2.
> 
> Signed-off-by: Peter Chen <peter.chen@nxp.com>
> ---
>  .../bindings/phy/cdns,salvo-phy.yaml          | 47 +++++++++++++++++++
>  1 file changed, 47 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/phy/cdns,salvo-phy.yaml
> 

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

warning: no schema found in file: Documentation/devicetree/bindings/phy/cdns,salvo-phy.yaml
/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/phy/cdns,salvo-phy.yaml: ignoring, error parsing file
Documentation/devicetree/bindings/display/simple-framebuffer.example.dts:21.16-37.11: Warning (chosen_node_is_root): /example-0/chosen: chosen node must be at root node
Documentation/devicetree/bindings/phy/cdns,salvo-phy.yaml:  while scanning a block scalar
  in "<unicode string>", line 39, column 5
found a tab character where an indentation space is expected
  in "<unicode string>", line 41, column 1
Documentation/devicetree/bindings/Makefile:12: recipe for target 'Documentation/devicetree/bindings/phy/cdns,salvo-phy.example.dts' failed
make[1]: *** [Documentation/devicetree/bindings/phy/cdns,salvo-phy.example.dts] Error 1
Makefile:1263: recipe for target 'dt_binding_check' failed
make: *** [dt_binding_check] Error 2

See https://patchwork.ozlabs.org/patch/1245562
Please check and re-submit.
Peter Chen Feb. 28, 2020, 9:29 a.m. UTC | #2
> >  .../bindings/phy/cdns,salvo-phy.yaml          | 47 +++++++++++++++++++
> >  1 file changed, 47 insertions(+)
> >  create mode 100644
> > Documentation/devicetree/bindings/phy/cdns,salvo-phy.yaml
> >
> 
> My bot found errors running 'make dt_binding_check' on your patch:
> 
> warning: no schema found in file:
> Documentation/devicetree/bindings/phy/cdns,salvo-phy.yaml
> /builds/robherring/linux-dt-
> review/Documentation/devicetree/bindings/phy/cdns,salvo-phy.yaml: ignoring, error
> parsing file
> Documentation/devicetree/bindings/display/simple-framebuffer.example.dts:21.16-
> 37.11: Warning (chosen_node_is_root): /example-0/chosen: chosen node must be
> at root node
> Documentation/devicetree/bindings/phy/cdns,salvo-phy.yaml:  while scanning a
> block scalar
>   in "<unicode string>", line 39, column 5 found a tab character where an indentation
> space is expected
>   in "<unicode string>", line 41, column 1
> Documentation/devicetree/bindings/Makefile:12: recipe for target
> 'Documentation/devicetree/bindings/phy/cdns,salvo-phy.example.dts' failed
> make[1]: *** [Documentation/devicetree/bindings/phy/cdns,salvo-phy.example.dts]
> Error 1
> Makefile:1263: recipe for target 'dt_binding_check' failed
> make: *** [dt_binding_check] Error 2
> 
Hi Rob,

After changing some format, I still got below errors, would you please point to
what's wrong with line 40, column 12? Thanks.

 31 required:
 32   - compatible
 33   - reg
 34   - "#phy-cells"
 35
 36 additionalProperties: false
 37
 38 examples:
 39     -|
 40     usb3phy: usb3-phy {
 41         compatible = "nxp,salvo-phy";
 42         reg = <0x5B160000 0x40000>;
 43         clocks = <&usb3_lpcg 4>;
 44         clock-names = "salvo_phy_clk";
 45         power-domains = <&pd IMX_SC_R_USB_2_PHY>;
 46         #phy-cells = <0>;
 47     };


make[1]: Entering directory '/home/b29397/work/projects/upstream/usb/outout/imx_v8'
  CHKDT   Documentation/devicetree/bindings/phy/cdns,salvo-phy.yaml
/home/b29397/work/projects/upstream/usb/Documentation/devicetree/bindings/phy/cdns,salvo-phy.yaml:  mapping values are not allowed in this context
  in "<unicode string>", line 40, column 12
/home/b29397/work/projects/upstream/usb/Documentation/devicetree/bindings/Makefile:12: recipe for target 'Documentation/devicetree/bindings/phy/cdns,salvo-phy.example.dts' failed
make[2]: *** [Documentation/devicetree/bindings/phy/cdns,salvo-phy.example.dts] Error 1
/home/b29397/work/projects/upstream/usb/Makefile:1262: recipe for target 'dt_binding_check' failed
make[1]: *** [dt_binding_check] Error 2
make[1]: Leaving directory '/home/b29397/work/projects/upstream/usb/outout/imx_v8'
Makefile:179: recipe for target 'sub-make' failed
make: *** [sub-make] Error 2

Peter
Rob Herring (Arm) Feb. 28, 2020, 1:37 p.m. UTC | #3
On Fri, Feb 28, 2020 at 3:29 AM Peter Chen <peter.chen@nxp.com> wrote:
>
>
> > >  .../bindings/phy/cdns,salvo-phy.yaml          | 47 +++++++++++++++++++
> > >  1 file changed, 47 insertions(+)
> > >  create mode 100644
> > > Documentation/devicetree/bindings/phy/cdns,salvo-phy.yaml
> > >
> >
> > My bot found errors running 'make dt_binding_check' on your patch:
> >
> > warning: no schema found in file:
> > Documentation/devicetree/bindings/phy/cdns,salvo-phy.yaml
> > /builds/robherring/linux-dt-
> > review/Documentation/devicetree/bindings/phy/cdns,salvo-phy.yaml: ignoring, error
> > parsing file
> > Documentation/devicetree/bindings/display/simple-framebuffer.example.dts:21.16-
> > 37.11: Warning (chosen_node_is_root): /example-0/chosen: chosen node must be
> > at root node
> > Documentation/devicetree/bindings/phy/cdns,salvo-phy.yaml:  while scanning a
> > block scalar
> >   in "<unicode string>", line 39, column 5 found a tab character where an indentation
> > space is expected
> >   in "<unicode string>", line 41, column 1
> > Documentation/devicetree/bindings/Makefile:12: recipe for target
> > 'Documentation/devicetree/bindings/phy/cdns,salvo-phy.example.dts' failed
> > make[1]: *** [Documentation/devicetree/bindings/phy/cdns,salvo-phy.example.dts]
> > Error 1
> > Makefile:1263: recipe for target 'dt_binding_check' failed
> > make: *** [dt_binding_check] Error 2
> >
> Hi Rob,
>
> After changing some format, I still got below errors, would you please point to
> what's wrong with line 40, column 12? Thanks.

It is line numbers of the generated .example.dts you need to look at.

>
>  31 required:
>  32   - compatible
>  33   - reg
>  34   - "#phy-cells"
>  35
>  36 additionalProperties: false
>  37
>  38 examples:
>  39     -|
>  40     usb3phy: usb3-phy {

Needs a unit address.

>  41         compatible = "nxp,salvo-phy";
>  42         reg = <0x5B160000 0x40000>;
>  43         clocks = <&usb3_lpcg 4>;
>  44         clock-names = "salvo_phy_clk";
>  45         power-domains = <&pd IMX_SC_R_USB_2_PHY>;

Need to include the header for this define.

>  46         #phy-cells = <0>;
>  47     };
Peter Chen March 2, 2020, 2:58 a.m. UTC | #4
On 20-02-28 07:37:14, Rob Herring wrote:
> On Fri, Feb 28, 2020 at 3:29 AM Peter Chen <peter.chen@nxp.com> wrote:
> >
> >
> > > >  .../bindings/phy/cdns,salvo-phy.yaml          | 47 +++++++++++++++++++
> > > >  1 file changed, 47 insertions(+)
> > > >  create mode 100644
> > > > Documentation/devicetree/bindings/phy/cdns,salvo-phy.yaml
> > > >
> > >
> > > My bot found errors running 'make dt_binding_check' on your patch:
> > >
> > > warning: no schema found in file:
> > > Documentation/devicetree/bindings/phy/cdns,salvo-phy.yaml
> > > /builds/robherring/linux-dt-
> > > review/Documentation/devicetree/bindings/phy/cdns,salvo-phy.yaml: ignoring, error
> > > parsing file
> > > Documentation/devicetree/bindings/display/simple-framebuffer.example.dts:21.16-
> > > 37.11: Warning (chosen_node_is_root): /example-0/chosen: chosen node must be
> > > at root node
> > > Documentation/devicetree/bindings/phy/cdns,salvo-phy.yaml:  while scanning a
> > > block scalar
> > >   in "<unicode string>", line 39, column 5 found a tab character where an indentation
> > > space is expected
> > >   in "<unicode string>", line 41, column 1
> > > Documentation/devicetree/bindings/Makefile:12: recipe for target
> > > 'Documentation/devicetree/bindings/phy/cdns,salvo-phy.example.dts' failed
> > > make[1]: *** [Documentation/devicetree/bindings/phy/cdns,salvo-phy.example.dts]
> > > Error 1
> > > Makefile:1263: recipe for target 'dt_binding_check' failed
> > > make: *** [dt_binding_check] Error 2
> > >
> > Hi Rob,
> >
> > After changing some format, I still got below errors, would you please point to
> > what's wrong with line 40, column 12? Thanks.
> 
> It is line numbers of the generated .example.dts you need to look at.

There is no cdns,salvo-phy.example.dts file at both source folder or
obj (-O) folder. I use https://github.com/robherring/dt-schema to
create dt-doc-validate. The command I use to verify yaml file:
make O=$OUTKNL dt_binding_check, OUTKNL is my kernel obj folder.

I am sorry I get below error:

make[1]: Entering directory '/home/b29397/work/projects/upstream/usb/outout/imx_v8'
  CHKDT   Documentation/devicetree/bindings/phy/cdns,salvo-phy.yaml
/home/b29397/work/projects/upstream/usb/Documentation/devicetree/bindings/phy/cdns,salvo-phy.yaml:  while parsing a block mapping
  in "<unicode string>", line 5, column 1
did not find expected key
  in "<unicode string>", line 42, column 5
/home/b29397/work/projects/upstream/usb/Documentation/devicetree/bindings/Makefile:12: recipe for target 'Documentation/devicetree/bindings/phy/cdns,salvo-phy.example.dts' failed
make[2]: *** [Documentation/devicetree/bindings/phy/cdns,salvo-phy.example.dts] Error 1
/home/b29397/work/projects/upstream/usb/Makefile:1262: recipe for target 'dt_binding_check' failed
make[1]: *** [dt_binding_check] Error 2
make[1]: Leaving directory '/home/b29397/work/projects/upstream/usb/outout/imx_v8'
Makefile:179: recipe for target 'sub-make' failed
make: *** [sub-make] Error 2

  1 # SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
  2 # Copyright (c) 2020 NXP
  3 %YAML 1.2
  4 ---
  5 $id: "http://devicetree.org/schemas/phy/cdns,salvo-phy.yaml#"
  6 $schema: "http://devicetree.org/meta-schemas/core.yaml#"
  7 
  8 title: Cadence SALVO PHY
  9 
 10 maintainers:
 11   - Peter Chen <peter.chen@nxp.com>
 12 
 13 properties:
 14   compatible:
 15     enum:
 16       - nxp,salvo-phy
 17 
 18   reg:
 19     maxItems: 1
 20 
 21   clocks:
 22     maxItems: 1
 23 
 24   clock-names:
 25     items:
 26       - const: salvo_phy_clk
 27 
 28   "#phy-cells":
 29     const: 1
 30 
 31 required:
 32   - compatible
 33   - reg
 34   - "#phy-cells"
 35 
 36 additionalProperties: false
 37 
 38 examples:
 39     -|
 40     #include <dt-bindings/firmware/imx/rsrc.h>
 41 
 42     usb3phy: usb3-phy@5B160000 {
 43         compatible = "nxp,salvo-phy";
 44         reg = <0x5B160000 0x40000>;
 45         clocks = <&usb3_lpcg 4>;
 46         clock-names = "salvo_phy_clk";
 47         power-domains = <&pd IMX_SC_R_USB_2_PHY>;
 48         #phy-cells = <0>;
 49     };
Rob Herring (Arm) March 2, 2020, 4:14 p.m. UTC | #5
On Sun, Mar 1, 2020 at 8:58 PM Peter Chen <peter.chen@nxp.com> wrote:
>
> On 20-02-28 07:37:14, Rob Herring wrote:
> > On Fri, Feb 28, 2020 at 3:29 AM Peter Chen <peter.chen@nxp.com> wrote:
> > >
> > >
> > > > >  .../bindings/phy/cdns,salvo-phy.yaml          | 47 +++++++++++++++++++
> > > > >  1 file changed, 47 insertions(+)
> > > > >  create mode 100644
> > > > > Documentation/devicetree/bindings/phy/cdns,salvo-phy.yaml
> > > > >
> > > >
> > > > My bot found errors running 'make dt_binding_check' on your patch:
> > > >
> > > > warning: no schema found in file:
> > > > Documentation/devicetree/bindings/phy/cdns,salvo-phy.yaml
> > > > /builds/robherring/linux-dt-
> > > > review/Documentation/devicetree/bindings/phy/cdns,salvo-phy.yaml: ignoring, error
> > > > parsing file
> > > > Documentation/devicetree/bindings/display/simple-framebuffer.example.dts:21.16-
> > > > 37.11: Warning (chosen_node_is_root): /example-0/chosen: chosen node must be
> > > > at root node
> > > > Documentation/devicetree/bindings/phy/cdns,salvo-phy.yaml:  while scanning a
> > > > block scalar
> > > >   in "<unicode string>", line 39, column 5 found a tab character where an indentation
> > > > space is expected
> > > >   in "<unicode string>", line 41, column 1
> > > > Documentation/devicetree/bindings/Makefile:12: recipe for target
> > > > 'Documentation/devicetree/bindings/phy/cdns,salvo-phy.example.dts' failed
> > > > make[1]: *** [Documentation/devicetree/bindings/phy/cdns,salvo-phy.example.dts]
> > > > Error 1
> > > > Makefile:1263: recipe for target 'dt_binding_check' failed
> > > > make: *** [dt_binding_check] Error 2
> > > >
> > > Hi Rob,
> > >
> > > After changing some format, I still got below errors, would you please point to
> > > what's wrong with line 40, column 12? Thanks.
> >
> > It is line numbers of the generated .example.dts you need to look at.

Sorry, it is the schema file line numbers.

> There is no cdns,salvo-phy.example.dts file at both source folder or

Because there's an error in the schema file.

> obj (-O) folder. I use https://github.com/robherring/dt-schema to
> create dt-doc-validate. The command I use to verify yaml file:
> make O=$OUTKNL dt_binding_check, OUTKNL is my kernel obj folder.
>
> I am sorry I get below error:
>
> make[1]: Entering directory '/home/b29397/work/projects/upstream/usb/outout/imx_v8'
>   CHKDT   Documentation/devicetree/bindings/phy/cdns,salvo-phy.yaml
> /home/b29397/work/projects/upstream/usb/Documentation/devicetree/bindings/phy/cdns,salvo-phy.yaml:  while parsing a block mapping
>   in "<unicode string>", line 5, column 1
> did not find expected key
>   in "<unicode string>", line 42, column 5
> /home/b29397/work/projects/upstream/usb/Documentation/devicetree/bindings/Makefile:12: recipe for target 'Documentation/devicetree/bindings/phy/cdns,salvo-phy.example.dts' failed
> make[2]: *** [Documentation/devicetree/bindings/phy/cdns,salvo-phy.example.dts] Error 1
> /home/b29397/work/projects/upstream/usb/Makefile:1262: recipe for target 'dt_binding_check' failed
> make[1]: *** [dt_binding_check] Error 2
> make[1]: Leaving directory '/home/b29397/work/projects/upstream/usb/outout/imx_v8'
> Makefile:179: recipe for target 'sub-make' failed
> make: *** [sub-make] Error 2
>
>   1 # SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
>   2 # Copyright (c) 2020 NXP
>   3 %YAML 1.2
>   4 ---
>   5 $id: "http://devicetree.org/schemas/phy/cdns,salvo-phy.yaml#"
>   6 $schema: "http://devicetree.org/meta-schemas/core.yaml#"
>   7
>   8 title: Cadence SALVO PHY
>   9
>  10 maintainers:
>  11   - Peter Chen <peter.chen@nxp.com>
>  12
>  13 properties:
>  14   compatible:
>  15     enum:
>  16       - nxp,salvo-phy
>  17
>  18   reg:
>  19     maxItems: 1
>  20
>  21   clocks:
>  22     maxItems: 1
>  23
>  24   clock-names:
>  25     items:
>  26       - const: salvo_phy_clk
>  27
>  28   "#phy-cells":
>  29     const: 1
>  30
>  31 required:
>  32   - compatible
>  33   - reg
>  34   - "#phy-cells"
>  35
>  36 additionalProperties: false
>  37
>  38 examples:
>  39     -|

The indentation is wrong here. It should be 2 spaces, not 4. What
follows has to be indented more than the above line. Indentation is
how the end of the block is found.

>  40     #include <dt-bindings/firmware/imx/rsrc.h>
>  41
>  42     usb3phy: usb3-phy@5B160000 {
>  43         compatible = "nxp,salvo-phy";
>  44         reg = <0x5B160000 0x40000>;
>  45         clocks = <&usb3_lpcg 4>;
>  46         clock-names = "salvo_phy_clk";
>  47         power-domains = <&pd IMX_SC_R_USB_2_PHY>;
>  48         #phy-cells = <0>;
>  49     };
>
>
> --
>
> Thanks,
> Peter Chen
Peter Chen March 3, 2020, 9:23 a.m. UTC | #6
> >  38 examples:
> >  39     -|
> 
> The indentation is wrong here. It should be 2 spaces, not 4. What follows has to be
> indented more than the above line. Indentation is how the end of the block is found.
> 
> >  40     #include <dt-bindings/firmware/imx/rsrc.h>
> >  41
> >  42     usb3phy: usb3-phy@5B160000 {
> >  43         compatible = "nxp,salvo-phy";
> >  44         reg = <0x5B160000 0x40000>;
> >  45         clocks = <&usb3_lpcg 4>;
> >  46         clock-names = "salvo_phy_clk";
> >  47         power-domains = <&pd IMX_SC_R_USB_2_PHY>;
> >  48         #phy-cells = <0>;
> >  49     };
 
Thanks, Rob, I fixed it. I will send v2 after driver review finishes.

Peter
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/phy/cdns,salvo-phy.yaml b/Documentation/devicetree/bindings/phy/cdns,salvo-phy.yaml
new file mode 100644
index 000000000000..f829f44c5e33
--- /dev/null
+++ b/Documentation/devicetree/bindings/phy/cdns,salvo-phy.yaml
@@ -0,0 +1,47 @@ 
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+# Copyright (c) 2020 NXP
+%YAML 1.2
+---
+$id: "http://devicetree.org/schemas/phy/cdns,salvo-phy.yaml#"
+$schema: "http://devicetree.org/meta-schemas/core.yaml#"
+
+title: Cadence SALVO PHY
+
+maintainers:
+  - Peter Chen <peter.chen@nxp.com>
+
+properties:
+  compatible:
+    enum:
+      - nxp,salvo-phy
+
+  reg:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+
+  clock-names:
+    items:
+      - const: salvo_phy_clk
+
+  "#phy-cells":
+    const: 1
+
+required:
+  - compatible
+  - reg
+  - "#phy-cells"
+
+additionalProperties: false
+
+examples:
+  - |
+    usb3phy: usb3-phy {
+	  compatible = "nxp,salvo-phy";
+	  reg = <0x5B160000 0x40000>;
+	  clocks = <&usb3_lpcg 4>;
+	  clock-names = "salvo_phy_clk";
+	  power-domains = <&pd IMX_SC_R_USB_2_PHY>;
+	  #phy-cells = <0>;
+};