diff mbox series

[v2,1/1] dt-bindings: MIPS: Document Ingenic SoCs binding.

Message ID 20200602183354.39707-2-zhouyanjie@wanyeetech.com (mailing list archive)
State Accepted
Headers show
Series Document Ingenic SoCs binding. | expand

Commit Message

Zhou Yanjie June 2, 2020, 6:33 p.m. UTC
Document the available properties for the SoC root node and the
CPU nodes of the devicetree for the Ingenic XBurst SoCs.

Tested-by: H. Nikolaus Schaller <hns@goldelico.com>
Tested-by: Paul Boddie <paul@boddie.org.uk>
Signed-off-by: 周琰杰 (Zhou Yanjie) <zhouyanjie@wanyeetech.com>
---

Notes:
    v1->v2:
    1.Remove unnecessary "items".
    2.Add "clocks" as suggested by Paul Cercueil.

 .../bindings/mips/ingenic/ingenic,cpu.yaml         | 67 ++++++++++++++++++++++
 1 file changed, 67 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/mips/ingenic/ingenic,cpu.yaml

Comments

Rob Herring (Arm) June 10, 2020, 7:50 p.m. UTC | #1
On Wed, 03 Jun 2020 02:33:54 +0800, 周琰杰 (Zhou Yanjie) wrote:
> Document the available properties for the SoC root node and the
> CPU nodes of the devicetree for the Ingenic XBurst SoCs.
> 
> Tested-by: H. Nikolaus Schaller <hns@goldelico.com>
> Tested-by: Paul Boddie <paul@boddie.org.uk>
> Signed-off-by: 周琰杰 (Zhou Yanjie) <zhouyanjie@wanyeetech.com>
> ---
> 
> Notes:
>     v1->v2:
>     1.Remove unnecessary "items".
>     2.Add "clocks" as suggested by Paul Cercueil.
> 
>  .../bindings/mips/ingenic/ingenic,cpu.yaml         | 67 ++++++++++++++++++++++
>  1 file changed, 67 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/mips/ingenic/ingenic,cpu.yaml
> 

Reviewed-by: Rob Herring <robh@kernel.org>
Thomas Bogendoerfer June 19, 2020, 11:05 a.m. UTC | #2
On Wed, Jun 03, 2020 at 02:33:54AM +0800, 周琰杰 (Zhou Yanjie) wrote:
> Document the available properties for the SoC root node and the
> CPU nodes of the devicetree for the Ingenic XBurst SoCs.
> 
> Tested-by: H. Nikolaus Schaller <hns@goldelico.com>
> Tested-by: Paul Boddie <paul@boddie.org.uk>
> Signed-off-by: 周琰杰 (Zhou Yanjie) <zhouyanjie@wanyeetech.com>
> ---
> 
> Notes:
>     v1->v2:
>     1.Remove unnecessary "items".
>     2.Add "clocks" as suggested by Paul Cercueil.
> 
>  .../bindings/mips/ingenic/ingenic,cpu.yaml         | 67 ++++++++++++++++++++++
>  1 file changed, 67 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/mips/ingenic/ingenic,cpu.yaml

applied to mips-next.

Thomas.
Fabio Estevam June 29, 2020, 7:28 p.m. UTC | #3
On Fri, Jun 19, 2020 at 9:48 AM Thomas Bogendoerfer
<tsbogend@alpha.franken.de> wrote:
>
> On Wed, Jun 03, 2020 at 02:33:54AM +0800, 周琰杰 (Zhou Yanjie) wrote:
> > Document the available properties for the SoC root node and the
> > CPU nodes of the devicetree for the Ingenic XBurst SoCs.
> >
> > Tested-by: H. Nikolaus Schaller <hns@goldelico.com>
> > Tested-by: Paul Boddie <paul@boddie.org.uk>
> > Signed-off-by: 周琰杰 (Zhou Yanjie) <zhouyanjie@wanyeetech.com>
> > ---
> >
> > Notes:
> >     v1->v2:
> >     1.Remove unnecessary "items".
> >     2.Add "clocks" as suggested by Paul Cercueil.
> >
> >  .../bindings/mips/ingenic/ingenic,cpu.yaml         | 67 ++++++++++++++++++++++
> >  1 file changed, 67 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/mips/ingenic/ingenic,cpu.yaml
>
> applied to mips-next.

This causes 'make dt_binding_check' to fail:

$ make dt_binding_check
  CHKDT   Documentation/devicetree/bindings/mips/ingenic/ingenic,cpu.yaml
Documentation/devicetree/bindings/mips/ingenic/ingenic,cpu.yaml:
while scanning a block scalar
  in "<unicode string>", line 42, column 5
found a tab character where an indentation space is expected
  in "<unicode string>", line 46, column 1
Documentation/devicetree/bindings/Makefile:20: recipe for target
'Documentation/devicetree/bindings/mips/ingenic/ingenic,cpu.example.dts'
failed
make[1]: *** [Documentation/devicetree/bindings/mips/ingenic/ingenic,cpu.example.dts]
Error 1
Makefile:1343: recipe for target 'dt_binding_check' failed
make: *** [dt_binding_check] Error 2
Thomas Bogendoerfer July 2, 2020, 10:12 a.m. UTC | #4
On Mon, Jun 29, 2020 at 04:28:31PM -0300, Fabio Estevam wrote:
> On Fri, Jun 19, 2020 at 9:48 AM Thomas Bogendoerfer
> <tsbogend@alpha.franken.de> wrote:
> >
> > On Wed, Jun 03, 2020 at 02:33:54AM +0800, 周琰杰 (Zhou Yanjie) wrote:
> > > Document the available properties for the SoC root node and the
> > > CPU nodes of the devicetree for the Ingenic XBurst SoCs.
> > >
> > > Tested-by: H. Nikolaus Schaller <hns@goldelico.com>
> > > Tested-by: Paul Boddie <paul@boddie.org.uk>
> > > Signed-off-by: 周琰杰 (Zhou Yanjie) <zhouyanjie@wanyeetech.com>
> > > ---
> > >
> > > Notes:
> > >     v1->v2:
> > >     1.Remove unnecessary "items".
> > >     2.Add "clocks" as suggested by Paul Cercueil.
> > >
> > >  .../bindings/mips/ingenic/ingenic,cpu.yaml         | 67 ++++++++++++++++++++++
> > >  1 file changed, 67 insertions(+)
> > >  create mode 100644 Documentation/devicetree/bindings/mips/ingenic/ingenic,cpu.yaml
> >
> > applied to mips-next.
> 
> This causes 'make dt_binding_check' to fail:
> 
> $ make dt_binding_check
>   CHKDT   Documentation/devicetree/bindings/mips/ingenic/ingenic,cpu.yaml
> Documentation/devicetree/bindings/mips/ingenic/ingenic,cpu.yaml:
> while scanning a block scalar
>   in "<unicode string>", line 42, column 5
> found a tab character where an indentation space is expected
>   in "<unicode string>", line 46, column 1
> Documentation/devicetree/bindings/Makefile:20: recipe for target
> 'Documentation/devicetree/bindings/mips/ingenic/ingenic,cpu.example.dts'
> failed
> make[1]: *** [Documentation/devicetree/bindings/mips/ingenic/ingenic,cpu.example.dts]
> Error 1
> Makefile:1343: recipe for target 'dt_binding_check' failed
> make: *** [dt_binding_check] Error 2


thank you for noticing. It's my fault, I've changed spaces into tabs while
applying, which is of course wrong for yaml files... I've commited a fix
for this to mips-next and 'make dt_binding_check' now passes for me.

Thomas.
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/mips/ingenic/ingenic,cpu.yaml b/Documentation/devicetree/bindings/mips/ingenic/ingenic,cpu.yaml
new file mode 100644
index 000000000000..171503e08505
--- /dev/null
+++ b/Documentation/devicetree/bindings/mips/ingenic/ingenic,cpu.yaml
@@ -0,0 +1,67 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mips/ingenic/ingenic,cpu.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Bindings for Ingenic XBurst family CPUs
+
+maintainers:
+  - 周琰杰 (Zhou Yanjie) <zhouyanjie@wanyeetech.com>
+
+description:
+  Ingenic XBurst family CPUs shall have the following properties.
+
+properties:
+  compatible:
+    oneOf:
+
+      - description: Ingenic XBurst®1 CPU Cores
+        enum:
+          - ingenic,xburst-mxu1.0
+          - ingenic,xburst-fpu1.0-mxu1.1
+          - ingenic,xburst-fpu2.0-mxu2.0
+
+      - description: Ingenic XBurst®2 CPU Cores
+        enum:
+          - ingenic,xburst2-fpu2.1-mxu2.1-smt
+
+  reg:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+
+required:
+  - device_type
+  - compatible
+  - reg
+  - clocks
+
+examples:
+  - |
+    #include <dt-bindings/clock/jz4780-cgu.h>
+
+    cpus {
+    	#address-cells = <1>;
+    	#size-cells = <0>;
+
+    	cpu0: cpu@0 {
+    		device_type = "cpu";
+    		compatible = "ingenic,xburst-fpu1.0-mxu1.1";
+    		reg = <0>;
+
+    		clocks = <&cgu JZ4780_CLK_CPU>;
+    		clock-names = "cpu";
+    	};
+
+    	cpu1: cpu@1 {
+    		device_type = "cpu";
+    		compatible = "ingenic,xburst-fpu1.0-mxu1.1";
+    		reg = <1>;
+
+    		clocks = <&cgu JZ4780_CLK_CORE1>;
+    		clock-names = "cpu";
+    	};
+    };
+...