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

[Rob Herring <robh@kernel.org>]

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