Received-SPF: pass (google.com: domain of linux-kernel+bounces-194616-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) client-ip=2604:1380:45e3:2400::1;
From: Frank Li <Frank.Li@nxp.com>
To: Mark Brown <broonie@kernel.org>,
	Rob Herring <robh@kernel.org>,
	Krzysztof Kozlowski <krzk+dt@kernel.org>,
	Conor Dooley <conor+dt@kernel.org>,
	Vladimir Oltean <olteanv@gmail.com>,
	linux-spi@vger.kernel.org (open list:SPI SUBSYSTEM),
	devicetree@vger.kernel.org (open list:OPEN FIRMWARE AND FLATTENED DEVICE TREE BINDINGS),
	linux-kernel@vger.kernel.org (open list)
Cc: imx@lists.linux.dev
Subject: [PATCH 1/1] spi: dt-bindings: fsl-dspi: Convert to yaml format
Date: Wed, 29 May 2024 15:36:50 -0400
Message-Id: <20240529193651.1029840-1-Frank.Li@nxp.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0:
	=?us-ascii?Q?3fWLeX8qZYNZNqxzwBrCdFkVAclMn77NIbvOixqMg3qzHbDyCFMOx+ldONg1?=
 =?us-ascii?Q?8qJh4viRDaTWDr9DC3qhKxuXDPjIllskoTFZirLqKk0XAiiNpnoGaSqryQhV?=
 =?us-ascii?Q?NqohmblzWnZE/SQsps1gwWqD5554zlxzACMf3sMH4tKdivDmasn50H0OyIvB?=
 =?us-ascii?Q?efSYeA8ZrFlkxewRgkRPcNpBL/O7JpjcOVhiUFCaW/jVVsD8/aoyKQ0AMvPK?=
 =?us-ascii?Q?ySmNAjnbKPay0v1T9yujxljfpUPKXtSI5o/0NMIoS4pS7pC53XidS7rGa2Ho?=
 =?us-ascii?Q?jjqtpp9J+GC58AvPNIrlQ5lHgh4WO8zTUT2A2LxazrVhE3vT/J8tcCt7b5rx?=
 =?us-ascii?Q?GV6HGUrSe2hj6FbY78feAfoTsJTKrtm+ZK+bIyflit2ejI/Mv7vyEcVC7Uua?=
 =?us-ascii?Q?t2nFJwqP8qeemi06RZ80eL0C3iskjbnTLXhAYXZXm1eextzUpilk71E4Pn37?=
 =?us-ascii?Q?iXCBAqFHFdn5h0zOEFb9hMOMyi0GlS+kRStWZ3j8F2gh52UipuptPoJjtAkM?=
 =?us-ascii?Q?JRXE8aoPpLc1SMy2OuSfyObuDORgBsLxaxXH5t6Fq8dEBIUksD5KHqJbZ08i?=
 =?us-ascii?Q?Q6oL41/F0X6Ed8I8PMVoEzi3DTfJ25L7l+bxejWEij3gXGGz9CMD8Ajjw3AC?=
 =?us-ascii?Q?LWwgmgOMx9RMnTmybtFUrFTm3vsaURL4+/brsSc3j1mjPTHtHHekpDimAJpZ?=
 =?us-ascii?Q?kGWbpTVi9mPvqXxfV3K2f4ya8VlPHRN6NZ5jp5CobaauyOAkAKraOLFCN7xu?=
 =?us-ascii?Q?QzQQEUpug27v3eiWlTU5nEe7PQFUiEjx761KtiWZL2iLw271S7+9xummbTF1?=
 =?us-ascii?Q?PAlxviIK9ev3QNPjdmrBW0+//WQGOyo4pxpG8WgIF7HFzRBhwlqN/NqIvxtl?=
 =?us-ascii?Q?i0KxwSKagpTB8wg3oPkLp+DCA7MlL0JBDZv2kCHQaFkRHNyphjqpeS1XsuXC?=
 =?us-ascii?Q?CbuOm8mhvzJBKhfkFyixyhGHkzjQtsXXvo6K9kz+b4jyoQ43mrWwW6wUxZHa?=
 =?us-ascii?Q?8w975Wuh3v6WP6xDV8u9KdD7Z9U5nJFG/mDDskvmwGuJ4wXOsayu4bDftIkl?=
 =?us-ascii?Q?i/9bXp9SlSKddVuLAFDp4ejiY0PRXpyPPJQgFc8226uKlLBUext6zkmfVGCe?=
 =?us-ascii?Q?FCADh8MJGtze7R7j/SW1pdF/r+RFytwYK6E3yEGZjJ3F4fGSooOOk4rAzNuj?=
 =?us-ascii?Q?jLs21qT4zWduOP26jYEQNnmYSbURQl9CjHHcNwyWm5+hSWfPuACOdGvEE9r+?=
 =?us-ascii?Q?x+bxfIYAqiUHwCFgxMonf5zMDwcMeN8z7Ok35Vx0Ax8gLEhB21PGx+yq+BMo?=
 =?us-ascii?Q?e6Q6SVgHjMBSAc3m+QFPxCtnFOrG/pHQ20XXKVJ6xMogTUS6VTdFamTTULm8?=
 =?us-ascii?Q?CSISrGqc47Mu9z1zdp1RdxFPxfhXKVoLTbKvYrLLmYatIsRHeYJF0k2ck3sb?=
 =?us-ascii?Q?+5JafIFFH8OqxridPYxtwJ83z51rpt177rwxgvC3PLQmudv6iwlcj8s6+1oP?=
 =?us-ascii?Q?EbKCp719eND8+wcuM6bozzVMGVzASITuDBe1VwRHmGehFQb6iYWLKXAx/3Q5?=
 =?us-ascii?Q?HOUm9+p4JbNr66Y8yM6iQXVim6r+Uthp2VcuJnZ1?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 5fabf339-8d90-431a-155e-08dc8016bac7
X-MS-Exchange-CrossTenant-AuthSource: PAXPR04MB9642.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 29 May 2024 19:37:09.3192
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 686ea1d3-bc2b-4c6f-a92c-d99c5c301635
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: ujmAd3J02n95ck3B6BRD4HkHND13ohUNg0RQmQwvT+XjV2QgVzEg755T8Ka9Fhjbgc6W22SDxfM1De8xp9Ibjg==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: VI1PR04MB7023

Convert dt-binding spi-fsl-dspi.txt to yaml format.

Addtional changes during convert:
- compatible string "fsl,ls1028a-dspi" can be followed by
fsl,ls1021a-v1.0-dspi
- Change "dspi0@4002c000" to "spi@4002c000" in example
- Reorder properties in example
- Use GIC include in example

Signed-off-by: Frank Li <Frank.Li@nxp.com>
---

Notes:
    pass dt_binding_check
    
    make dt_binding_check DT_SCHEMA_FILES=fsl,dspi.yaml
      SCHEMA  Documentation/devicetree/bindings/processed-schema.json
      CHKDT   Documentation/devicetree/bindings
      LINT    Documentation/devicetree/bindings
      DTEX    Documentation/devicetree/bindings/spi/fsl,dspi.example.dts
      DTC_CHK Documentation/devicetree/bindings/spi/fsl,dspi.example.dtb

 .../devicetree/bindings/spi/fsl,dspi.yaml     | 126 ++++++++++++++++++
 .../devicetree/bindings/spi/spi-fsl-dspi.txt  |  65 ---------
 2 files changed, 126 insertions(+), 65 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/spi/fsl,dspi.yaml
 delete mode 100644 Documentation/devicetree/bindings/spi/spi-fsl-dspi.txt

diff --git a/Documentation/devicetree/bindings/spi/fsl,dspi.yaml b/Documentation/devicetree/bindings/spi/fsl,dspi.yaml
new file mode 100644
index 0000000000000..12a67b2cc25c8
--- /dev/null
+++ b/Documentation/devicetree/bindings/spi/fsl,dspi.yaml
@@ -0,0 +1,126 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/spi/fsl,dspi.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: ARM Freescale DSPI controller
+
+maintainers:
+  - Frank Li <Frank.Li@nxp.com>
+
+properties:
+  compatible:
+    oneOf:
+      - enum:
+          - fsl,vf610-dspi
+          - fsl,ls1021a-v1.0-dspi
+          - fsl,ls1012a-dspi
+          - fsl,ls1028a-dspi
+          - fsl,ls1043a-dspi
+          - fsl,ls1046a-dspi
+          - fsl,ls1088a-dspi
+          - fsl,ls2080a-dspi
+          - fsl,ls2085a-dspi
+          - fsl,lx2160a-dspi
+      - items:
+          - enum:
+              - fsl,ls1012a-dspi
+              - fsl,ls1043a-dspi
+              - fsl,ls1046a-dspi
+              - fsl,ls1088a-dspi
+          - const: fsl,ls1021a-v1.0-dspi
+      - items:
+          - const: fsl,ls2080a-dspi
+          - const: fsl,ls2085a-dspi
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+
+  clock-names:
+    items:
+      - const: dspi
+
+  pinctrl-0: true
+
+  pinctrl-names:
+    items:
+      - const: default
+
+  spi-num-chipselects:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: the number of the chipselect signals.
+
+  big-endian:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description:
+      If present the dspi device's registers are implemented
+      in big endian mode.
+
+  bus-num:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: the slave chip chipselect signal number.
+
+  fsl,spi-cs-sck-delay:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description:
+      a delay in nanoseconds between activating chip
+      select and the start of clock signal, at the start of a transfer.
+  fsl,spi-sck-cs-delay:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description:
+      a delay in nanoseconds between stopping the clock
+      signal and deactivating chip select, at the end of a transfer.
+
+required:
+  - compatible
+  - reg
+  - clocks
+  - clock-names
+  - interrupts
+  - pinctrl-0
+  - pinctrl-names
+  - spi-num-chipselects
+
+allOf:
+  - $ref: spi-controller.yaml#
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+    #include <dt-bindings/clock/vf610-clock.h>
+
+    spi@4002c000 {
+        compatible = "fsl,vf610-dspi";
+        reg = <0x4002c000 0x1000>;
+        #address-cells = <1>;
+        #size-cells = <0>;
+        interrupts = <GIC_SPI 67 IRQ_TYPE_LEVEL_HIGH>;
+        clocks = <&clks VF610_CLK_DSPI0>;
+        clock-names = "dspi";
+        spi-num-chipselects = <5>;
+        bus-num = <0>;
+        pinctrl-names = "default";
+        pinctrl-0 = <&pinctrl_dspi0_1>;
+        big-endian;
+
+        flash@0 {
+                compatible = "atmel,at26df081a";
+                reg = <0>;
+                spi-max-frequency = <16000000>;
+                spi-cpol;
+                spi-cpha;
+                linux,modalias = "m25p80";
+                modal = "at26df081a";
+                fsl,spi-cs-sck-delay = <100>;
+                fsl,spi-sck-cs-delay = <50>;
+        };
+    };
diff --git a/Documentation/devicetree/bindings/spi/spi-fsl-dspi.txt b/Documentation/devicetree/bindings/spi/spi-fsl-dspi.txt
deleted file mode 100644
index 30a79da9c039d..0000000000000
--- a/Documentation/devicetree/bindings/spi/spi-fsl-dspi.txt
+++ /dev/null
@@ -1,65 +0,0 @@
-ARM Freescale DSPI controller
-
-Required properties:
-- compatible : must be one of:
-	"fsl,vf610-dspi",
-	"fsl,ls1021a-v1.0-dspi",
-	"fsl,ls1012a-dspi" (optionally followed by "fsl,ls1021a-v1.0-dspi"),
-	"fsl,ls1028a-dspi",
-	"fsl,ls1043a-dspi" (optionally followed by "fsl,ls1021a-v1.0-dspi"),
-	"fsl,ls1046a-dspi" (optionally followed by "fsl,ls1021a-v1.0-dspi"),
-	"fsl,ls1088a-dspi" (optionally followed by "fsl,ls1021a-v1.0-dspi"),
-	"fsl,ls2080a-dspi" (optionally followed by "fsl,ls2085a-dspi"),
-	"fsl,ls2085a-dspi",
-	"fsl,lx2160a-dspi",
-- reg : Offset and length of the register set for the device
-- interrupts : Should contain SPI controller interrupt
-- clocks: from common clock binding: handle to dspi clock.
-- clock-names: from common clock binding: Shall be "dspi".
-- pinctrl-0: pin control group to be used for this controller.
-- pinctrl-names: must contain a "default" entry.
-- spi-num-chipselects : the number of the chipselect signals.
-
-Optional property:
-- big-endian: If present the dspi device's registers are implemented
-  in big endian mode.
-- bus-num : the slave chip chipselect signal number.
-
-Optional SPI slave node properties:
-- fsl,spi-cs-sck-delay: a delay in nanoseconds between activating chip
-  select and the start of clock signal, at the start of a transfer.
-- fsl,spi-sck-cs-delay: a delay in nanoseconds between stopping the clock
-  signal and deactivating chip select, at the end of a transfer.
-
-Example:
-
-dspi0@4002c000 {
-	#address-cells = <1>;
-	#size-cells = <0>;
-	compatible = "fsl,vf610-dspi";
-	reg = <0x4002c000 0x1000>;
-	interrupts = <0 67 0x04>;
-	clocks = <&clks VF610_CLK_DSPI0>;
-	clock-names = "dspi";
-	spi-num-chipselects = <5>;
-	bus-num = <0>;
-	pinctrl-names = "default";
-	pinctrl-0 = <&pinctrl_dspi0_1>;
-	big-endian;
-
-	sflash: at26df081a@0 {
-		#address-cells = <1>;
-		#size-cells = <1>;
-		compatible = "atmel,at26df081a";
-		spi-max-frequency = <16000000>;
-		spi-cpol;
-		spi-cpha;
-		reg = <0>;
-		linux,modalias = "m25p80";
-		modal = "at26df081a";
-		fsl,spi-cs-sck-delay = <100>;
-		fsl,spi-sck-cs-delay = <50>;
-	};
-};
-
-
-- 
2.34.1