diff mbox series

dt-bindings: spi: Convert NXP flexspi to json schema

Message ID 1614593046-23832-1-git-send-email-kuldeep.singh@nxp.com (mailing list archive)
State Superseded
Headers show
Series dt-bindings: spi: Convert NXP flexspi to json schema | expand

Commit Message

Kuldeep Singh March 1, 2021, 10:04 a.m. UTC
Convert the NXP FlexSPI binding to DT schema format using json-schema.
Also, update MAINTAINERS to reflect the change.

Signed-off-by: Kuldeep Singh <kuldeep.singh@nxp.com>
---
 .../bindings/spi/nxp,spi-nxp-fspi.yaml        | 101 ++++++++++++++++++
 .../devicetree/bindings/spi/spi-nxp-fspi.txt  |  42 --------
 MAINTAINERS                                   |   2 +-
 3 files changed, 102 insertions(+), 43 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/spi/nxp,spi-nxp-fspi.yaml
 delete mode 100644 Documentation/devicetree/bindings/spi/spi-nxp-fspi.txt

Comments

Rob Herring March 1, 2021, 2:44 p.m. UTC | #1
On Mon, 01 Mar 2021 15:34:06 +0530, Kuldeep Singh wrote:
> Convert the NXP FlexSPI binding to DT schema format using json-schema.
> Also, update MAINTAINERS to reflect the change.
> 
> Signed-off-by: Kuldeep Singh <kuldeep.singh@nxp.com>
> ---
>  .../bindings/spi/nxp,spi-nxp-fspi.yaml        | 101 ++++++++++++++++++
>  .../devicetree/bindings/spi/spi-nxp-fspi.txt  |  42 --------
>  MAINTAINERS                                   |   2 +-
>  3 files changed, 102 insertions(+), 43 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/spi/nxp,spi-nxp-fspi.yaml
>  delete mode 100644 Documentation/devicetree/bindings/spi/spi-nxp-fspi.txt
> 

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

yamllint warnings/errors:

dtschema/dtc warnings/errors:
/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/spi/nxp,spi-nxp-fspi.yaml: properties:clocks:maxItems: False schema does not allow 2
/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/spi/nxp,spi-nxp-fspi.yaml: ignoring, error in schema: properties: clocks: maxItems
warning: no schema found in file: ./Documentation/devicetree/bindings/spi/nxp,spi-nxp-fspi.yaml
Error: Documentation/devicetree/bindings/spi/nxp,spi-nxp-fspi.example.dts:26.31-32 syntax error
FATAL ERROR: Unable to parse input tree
make[1]: *** [scripts/Makefile.lib:349: Documentation/devicetree/bindings/spi/nxp,spi-nxp-fspi.example.dt.yaml] Error 1
make: *** [Makefile:1380: dt_binding_check] Error 2

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

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.
Kuldeep Singh March 5, 2021, 11:16 a.m. UTC | #2
> -----Original Message-----
> From: Rob Herring <robh@kernel.org>
> Sent: Monday, March 1, 2021 8:14 PM
> To: Kuldeep Singh <kuldeep.singh@nxp.com>
> Cc: devicetree@vger.kernel.org; Rob Herring <robh+dt@kernel.org>; Mark Brown
> <broonie@kernel.org>; Ashish Kumar <ashish.kumar@nxp.com>; linux-
> kernel@vger.kernel.org; linux-spi@vger.kernel.org
> Subject: [EXT] Re: [PATCH] dt-bindings: spi: Convert NXP flexspi to json schema
> 
> Caution: EXT Email
> 
> On Mon, 01 Mar 2021 15:34:06 +0530, Kuldeep Singh wrote:
> > Convert the NXP FlexSPI binding to DT schema format using json-schema.
> > Also, update MAINTAINERS to reflect the change.
> >
> > Signed-off-by: Kuldeep Singh <kuldeep.singh@nxp.com>
> > ---
> >  .../bindings/spi/nxp,spi-nxp-fspi.yaml        | 101 ++++++++++++++++++
> >  .../devicetree/bindings/spi/spi-nxp-fspi.txt  |  42 --------
> >  MAINTAINERS                                   |   2 +-
> >  3 files changed, 102 insertions(+), 43 deletions(-)  create mode
> > 100644 Documentation/devicetree/bindings/spi/nxp,spi-nxp-fspi.yaml
> >  delete mode 100644
> > Documentation/devicetree/bindings/spi/spi-nxp-fspi.txt
> >
> 
> My bot found errors running 'make dt_binding_check' on your patch:
> 
> yamllint warnings/errors:
> 
> dtschema/dtc warnings/errors:
> /builds/robherring/linux-dt-
> review/Documentation/devicetree/bindings/spi/nxp,spi-nxp-fspi.yaml:
> properties:clocks:maxItems: False schema does not allow 2
> /builds/robherring/linux-dt-
> review/Documentation/devicetree/bindings/spi/nxp,spi-nxp-fspi.yaml: ignoring,
> error in schema: properties: clocks: maxItems
> warning: no schema found in
> file: ./Documentation/devicetree/bindings/spi/nxp,spi-nxp-fspi.yaml
> Error: Documentation/devicetree/bindings/spi/nxp,spi-nxp-
> fspi.example.dts:26.31-32 syntax error FATAL ERROR: Unable to parse input tree
> make[1]: *** [scripts/Makefile.lib:349:
> Documentation/devicetree/bindings/spi/nxp,spi-nxp-fspi.example.dt.yaml] Error
> 1
> make: *** [Makefile:1380: dt_binding_check] Error 2
> 
> See
> https://eur01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fpatchwork
> .ozlabs.org%2Fpatch%2F1445509&amp;data=04%7C01%7Ckuldeep.singh%40nxp.
> com%7Cb964d840a95e45dbf3cc08d8dcc08376%7C686ea1d3bc2b4c6fa92cd99c5c
> 301635%7C0%7C0%7C637502066681922692%7CUnknown%7CTWFpbGZsb3d8eyJ
> WIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1
> 000&amp;sdata=Ga5fpQ7oBEz8sQaA%2BtBZh75gPELe%2FDg6R5qJ2tZ2pB4%3D&
> amp;reserved=0
> 
> 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.

Thanks Rob for mentioning. I will make sure to run 'make dt_binding_check' before submitting next version.

Regards
Kuldeep
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/spi/nxp,spi-nxp-fspi.yaml b/Documentation/devicetree/bindings/spi/nxp,spi-nxp-fspi.yaml
new file mode 100644
index 000000000000..56598b87ba15
--- /dev/null
+++ b/Documentation/devicetree/bindings/spi/nxp,spi-nxp-fspi.yaml
@@ -0,0 +1,101 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/spi/nxp,spi-nxp-fspi.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: NXP Flex Serial Peripheral Interface (FSPI)
+
+maintainers:
+  - Ashish Kumar <ashish.kumar@nxp.com>
+
+allOf:
+  - $ref: "/schemas/spi/spi-controller.yaml#"
+
+properties:
+  compatible:
+    enum:
+      - nxp,lx2160a-fspi
+      - nxp,imx8qxp-fspi
+      - nxp,imx8mm-fspi
+      - nxp,imx8dxl-fspi
+
+  reg:
+    items:
+      - description: registers
+      - description: memory mapping
+
+  reg-names:
+    items:
+      - const: fspi_base
+      - const: fspi_mmap
+
+  interrupts:
+    maxItems: 1
+
+  clocks:
+    maxItems: 2
+    items:
+      - description: SoC SPI fspi_en clock
+      - description: SoC SPI fspi clock
+
+  clock-names:
+    items:
+      - const: fspi_en
+      - const: fspi
+
+required:
+  - compatible
+  - reg
+  - reg-names
+  - interrupts
+  - clocks
+  - clock-names
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+
+    spi@20c0000 {
+      compatible = "nxp,lx2160a-fspi";
+      reg = <0x0 0x20c0000 0x0 0x100000>, <0x0 0x20000000 0x0 0x10000>;
+      reg-names = "fspi_base", "fspi_mmap";
+      interrupts = <GIC_SPI 25 IRQ_TYPE_LEVEL_HIGH>;
+      clocks = <&clockgen QORIQ_CLK_PLATFORM_PLL QORIQ_CLK_PLL_DIV(4)>,
+               <&clockgen QORIQ_CLK_PLATFORM_PLL QORIQ_CLK_PLL_DIV(4)>,
+      clock-names = "fspi_en", "fspi";
+      #address-cells = <1>;
+      #size-cells = <1>;
+
+      flash@0 {
+        compatible = "jedec,spi-nor";
+        spi-max-frequency = <50000000>;
+        reg = <0>;
+        spi-rx-bus-width = <8>;
+        spi-tx-bus-width = <8>;
+      };
+    };
+
+  - |
+    #include <dt-bindings/clock/imx8mm-clock.h>
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+
+    spi@30bb0000 {
+      compatible = "nxp,imx8mm-fspi";
+      reg = <0x30bb0000 0x10000>, <0x8000000 0x10000000>;
+      reg-names = "fspi_base", "fspi_mmap";
+      interrupts = <GIC_SPI 107 IRQ_TYPE_LEVEL_HIGH>;
+      clocks = <&clk IMX8MM_CLK_QSPI_ROOT>,
+               <&clk IMX8MM_CLK_QSPI_ROOT>;
+      clock-names = "fspi", "fspi_en";
+
+      flash@0 {
+        compatible = "jedec,spi-nor";
+        spi-max-frequency = <80000000>;
+        reg = <0>;
+        spi-rx-bus-width = <4>;
+        spi-tx-bus-width = <4>;
+      };
+    };
diff --git a/Documentation/devicetree/bindings/spi/spi-nxp-fspi.txt b/Documentation/devicetree/bindings/spi/spi-nxp-fspi.txt
deleted file mode 100644
index 7ac60d9fe357..000000000000
--- a/Documentation/devicetree/bindings/spi/spi-nxp-fspi.txt
+++ /dev/null
@@ -1,42 +0,0 @@ 
-* NXP Flex Serial Peripheral Interface (FSPI)
-
-Required properties:
-  - compatible : Should be "nxp,lx2160a-fspi"
-			    "nxp,imx8qxp-fspi"
-			    "nxp,imx8mm-fspi"
-
-  - reg :        First contains the register location and length,
-                 Second contains the memory mapping address and length
-  - reg-names :  Should contain the resource reg names:
-	         - fspi_base: configuration register address space
-                 - fspi_mmap: memory mapped address space
-  - interrupts : Should contain the interrupt for the device
-
-Required SPI slave node properties:
-  - reg :        There are two buses (A and B) with two chip selects each.
-                 This encodes to which bus and CS the flash is connected:
-                 - <0>: Bus A, CS 0
-                 - <1>: Bus A, CS 1
-                 - <2>: Bus B, CS 0
-                 - <3>: Bus B, CS 1
-
-Example showing the usage of two SPI NOR slave devices on bus A:
-
-fspi0: spi@20c0000 {
-	compatible = "nxp,lx2160a-fspi";
-	reg = <0x0 0x20c0000 0x0 0x10000>, <0x0 0x20000000 0x0 0x10000000>;
-	reg-names = "fspi_base", "fspi_mmap";
-	interrupts = <0 25 0x4>; /* Level high type */
-	clocks = <&clockgen 4 3>, <&clockgen 4 3>;
-	clock-names = "fspi_en", "fspi";
-
-	mt35xu512aba0: flash@0 {
-		reg = <0>;
-		....
-	};
-
-	mt35xu512aba1: flash@1 {
-		reg = <1>;
-		....
-	};
-};
diff --git a/MAINTAINERS b/MAINTAINERS
index f9d462c8f4d6..9179722cff2e 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -12731,7 +12731,7 @@  M:	Ashish Kumar <ashish.kumar@nxp.com>
 R:	Yogesh Gaur <yogeshgaur.83@gmail.com>
 L:	linux-spi@vger.kernel.org
 S:	Maintained
-F:	Documentation/devicetree/bindings/spi/spi-nxp-fspi.txt
+F:	Documentation/devicetree/bindings/spi/nxp,spi-nxp-fspi.yaml
 F:	drivers/spi/spi-nxp-fspi.c
 
 NXP FXAS21002C DRIVER