Received-SPF: pass (google.com: domain of linux-kernel+bounces-197374-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) client-ip=147.75.199.223;
From: Frank Li <Frank.Li@nxp.com>
To: Ulf Hansson <ulf.hansson@linaro.org>,
	Rob Herring <robh@kernel.org>,
	Krzysztof Kozlowski <krzk+dt@kernel.org>,
	Conor Dooley <conor+dt@kernel.org>,
	linux-mmc@vger.kernel.org (open list:MULTIMEDIA CARD (MMC), SECURE DIGITAL (SD) AND...),
	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] dt-bindings: mmc: Convert fsl-esdhc.txt to yaml
Date: Fri, 31 May 2024 15:37:44 -0400
Message-Id: <20240531193745.1714046-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?c0LEX8vLNLkdxi9ucUmf6pVU4Iq2didbCsz88H+wnh1K5qWApgh+wsChz8mD?=
 =?us-ascii?Q?42nN+7Tb4XC1GLERF6o2okqys+/8dC4/T3Yu71fgwamhZNvvHp0nTXMjBrQh?=
 =?us-ascii?Q?1PsRhJPY99ehSysNImOkgcp0hR3eSc38xFnk7zCSt5pkVuWxARCRorcdqvZW?=
 =?us-ascii?Q?aTWCFftBoQA6UrgYXtULq9DSPYJV150arVL0IqPzg9RW7LQ47IR7HHzI47id?=
 =?us-ascii?Q?hrJMJapcYFIxU/5XrhZ4XEIcNVRgRkKtDMq9KEASGKnGH4nfaOpxtEo6pR5D?=
 =?us-ascii?Q?qAwbZeTilu2YhFgrBtmSbot+3od3SGwxtX5JSIScwirFUjMtd0ohTWpusM/W?=
 =?us-ascii?Q?Yt1/0CuQuwu0tetrJIqNbChxT5Wa8o3T3yS4ibhfEF1LoZU17FTLLLTBSvrM?=
 =?us-ascii?Q?b1cFDayD0C9rjeYzCTYmHA3rQrXOBk4Motmh9HSbqii61wY/VVCzuvpbfi2v?=
 =?us-ascii?Q?EKt4heuHUQobJegRkiijJHr20lNdHXFUuMLwZ1AkfmUXd12UgRAPmoU4jKKX?=
 =?us-ascii?Q?2H+TzIkv17t/pjyJ+fInzGg6NmAjYVmfD8eCeFwNGBReKWkkfLao5n+QCP3S?=
 =?us-ascii?Q?mx/XaY1Cn6mPfOyZP0GyjYT/9dQxGf+LkxQIEzu7ZDqS4BpWH65IfCNMM8bf?=
 =?us-ascii?Q?FQ6E59XUFe9k7kahq24ynJyjW/96ee7iFXjedExfaE7xV0e2PK4j03FNqR2w?=
 =?us-ascii?Q?qZQ4kyvnAhEwommzPHjeEcjH5h4Ag5/75o5lsAh8pfWW9SaGx1xwUztVAxJa?=
 =?us-ascii?Q?WMVpIp4yvgt7tfpQDl2Siv+K69901EfqPHhra5/CBzm2NTRISVYS44b4fKTx?=
 =?us-ascii?Q?8UYB2PELz9TfcAiXqFUDcZv5Riv5uAvqxF4Ggj+9OKhg2CxXvPOL9hKeNQo/?=
 =?us-ascii?Q?bR7w6tqYobFcoCSUsOzI6HbpgDPAXajvRXsdZmY+MkNP6ae1Qq7/HSGpDBjd?=
 =?us-ascii?Q?DDvhWiFvYWUpQ0F1rf1kf33Ea11HxwZRw2CsuxQ1iNa+Y1sqzQrjILC+/AiR?=
 =?us-ascii?Q?EjynHcbJ5Nf0+VIOa1OMNmq5VECnn8Jg0TQk18Rah8/6yT/zww3KolQhbETh?=
 =?us-ascii?Q?S1La4pj2azlbRQuoY79/rHxJscPC4xUwKfOpK+qrbp/S0/++tR2KB0W5gKpm?=
 =?us-ascii?Q?Yv43WM1zOiAHIUcPNyn2g1Onu1c20AdT7KSy9piNQT/W1sDrosb2zCRBPjfg?=
 =?us-ascii?Q?A48YbC+kyZOhLoWVj+CFcz+WasSA0PpfDIjntMUb3Yao64iSIvNjmt6jW5Zz?=
 =?us-ascii?Q?3mhTjB/bxygCGRcC+/NXlEUAHFCa8n50Z1Cu4EJ9xCzAQlS0sx6q67Uxe8cB?=
 =?us-ascii?Q?xNVVv9ho5swLUzx3/kclnOW2EEgs770Ft6xld8K42ImAFzgQfslV/NDK5fHy?=
 =?us-ascii?Q?n1MZAL2VkWb61AU7Hw39Y5I4/ULuUIxKiD6lATRMWU/DCtSZ3gZsjSxeWw2F?=
 =?us-ascii?Q?4OhKDcpkmg1g9wCEi1Xl3M/+ad3NF0X7ZCcwwLqmvcOB7l8B1lJmBrIHtqli?=
 =?us-ascii?Q?+DYj/Bs0WcSfoQHuGg/VyUuf9zHwT2bxuizgFipvyf0awhuvmlD+E/Ymmav+?=
 =?us-ascii?Q?E16OA3x0xFQIYUcRWhPA2thzxQNqxl8KMdrc+PwG?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 0b095422-695a-40a5-8d7c-08dc81a92e7b
X-MS-Exchange-CrossTenant-AuthSource: PAXPR04MB9642.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 31 May 2024 19:38:01.0553
 (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: FWsGQhUWwc2x5cUZMgYWhQKuj4QOF02GdLQr7P4agS0ghaK5XJypRrB5d1JvqvcliTpJS+wLrYAUOF6IhgMAfQ==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: PAXPR04MB9679

Convert layerscape fsl-esdhc binding doc from txt to yaml format.

Addtional change during convert:
- deprecate "sdhci,wp-inverted", "sdhci,1-bit-only".
- Add "reg" and "interrupts" property.
- change example "sdhci@2e000" to "mmc@2e000".
- compatible string require fsl,<chip>-esdhc followed by fsl,esdhc to match
most existed dts file.

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

Notes:
    pass dt_binding_check
    make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- -j8  dt_binding_check DT_SCHEMA_FILES=fsl-ls-esdhc.yaml
      SCHEMA  Documentation/devicetree/bindings/processed-schema.json
      CHKDT   Documentation/devicetree/bindings
      LINT    Documentation/devicetree/bindings
      DTEX    Documentation/devicetree/bindings/mmc/fsl-ls-esdhc.example.dts
      DTC_CHK Documentation/devicetree/bindings/mmc/fsl-ls-esdhc.example.dtb

 .../devicetree/bindings/mmc/fsl-esdhc.txt     | 52 ----------
 .../devicetree/bindings/mmc/fsl-ls-esdhc.yaml | 98 +++++++++++++++++++
 2 files changed, 98 insertions(+), 52 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/mmc/fsl-esdhc.txt
 create mode 100644 Documentation/devicetree/bindings/mmc/fsl-ls-esdhc.yaml

diff --git a/Documentation/devicetree/bindings/mmc/fsl-esdhc.txt b/Documentation/devicetree/bindings/mmc/fsl-esdhc.txt
deleted file mode 100644
index edb8cadb95412..0000000000000
--- a/Documentation/devicetree/bindings/mmc/fsl-esdhc.txt
+++ /dev/null
@@ -1,52 +0,0 @@
-* Freescale Enhanced Secure Digital Host Controller (eSDHC)
-
-The Enhanced Secure Digital Host Controller provides an interface
-for MMC, SD, and SDIO types of memory cards.
-
-This file documents differences between the core properties described
-by mmc.txt and the properties used by the sdhci-esdhc driver.
-
-Required properties:
-  - compatible : should be "fsl,esdhc", or "fsl,<chip>-esdhc".
-    Possible compatibles for PowerPC:
-	"fsl,mpc8536-esdhc"
-	"fsl,mpc8378-esdhc"
-	"fsl,p2020-esdhc"
-	"fsl,p4080-esdhc"
-	"fsl,t1040-esdhc"
-	"fsl,t4240-esdhc"
-    Possible compatibles for ARM:
-	"fsl,ls1012a-esdhc"
-	"fsl,ls1028a-esdhc"
-	"fsl,ls1088a-esdhc"
-	"fsl,ls1043a-esdhc"
-	"fsl,ls1046a-esdhc"
-	"fsl,ls2080a-esdhc"
-  - clock-frequency : specifies eSDHC base clock frequency.
-
-Optional properties:
-  - sdhci,wp-inverted : specifies that eSDHC controller reports
-    inverted write-protect state; New devices should use the generic
-    "wp-inverted" property.
-  - sdhci,1-bit-only : specifies that a controller can only handle
-    1-bit data transfers. New devices should use the generic
-    "bus-width = <1>" property.
-  - sdhci,auto-cmd12: specifies that a controller can only handle auto
-    CMD12.
-  - voltage-ranges : two cells are required, first cell specifies minimum
-    slot voltage (mV), second cell specifies maximum slot voltage (mV).
-    Several ranges could be specified.
-  - little-endian : If the host controller is little-endian mode, specify
-    this property. The default endian mode is big-endian.
-
-Example:
-
-sdhci@2e000 {
-	compatible = "fsl,mpc8378-esdhc", "fsl,esdhc";
-	reg = <0x2e000 0x1000>;
-	interrupts = <42 0x8>;
-	interrupt-parent = <&ipic>;
-	/* Filled in by U-Boot */
-	clock-frequency = <0>;
-	voltage-ranges = <3300 3300>;
-};
diff --git a/Documentation/devicetree/bindings/mmc/fsl-ls-esdhc.yaml b/Documentation/devicetree/bindings/mmc/fsl-ls-esdhc.yaml
new file mode 100644
index 0000000000000..cafc09c4f1234
--- /dev/null
+++ b/Documentation/devicetree/bindings/mmc/fsl-ls-esdhc.yaml
@@ -0,0 +1,98 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mmc/fsl-ls-esdhc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Freescale Enhanced Secure Digital Host Controller (eSDHC)
+
+description:
+  The Enhanced Secure Digital Host Controller provides an interface
+  for MMC, SD, and SDIO types of memory cards.
+
+maintainers:
+  - Frank Li <Frank.Li@nxp.com>
+
+properties:
+  compatible:
+    items:
+      - enum:
+          - fsl,mpc8536-esdhc
+          - fsl,mpc8378-esdhc
+          - fsl,p2020-esdhc
+          - fsl,p4080-esdhc
+          - fsl,t1040-esdhc
+          - fsl,t4240-esdhc
+          - fsl,ls1012a-esdhc
+          - fsl,ls1028a-esdhc
+          - fsl,ls1088a-esdhc
+          - fsl,ls1043a-esdhc
+          - fsl,ls1046a-esdhc
+          - fsl,ls2080a-esdhc
+      - const: fsl,esdhc
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  clock-frequency:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: specifies eSDHC base clock frequency.
+
+  sdhci,wp-inverted:
+    $ref: /schemas/types.yaml#/definitions/flag
+    deprecated: true
+    description:
+      specifies that eSDHC controller reports
+      inverted write-protect state; New devices should use the generic
+      "wp-inverted" property.
+
+  sdhci,1-bit-only:
+    $ref: /schemas/types.yaml#/definitions/flag
+    deprecated: true
+    description:
+      specifies that a controller can only handle
+      1-bit data transfers. New devices should use the generic
+      "bus-width = <1>" property.
+
+  sdhci,auto-cmd12:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description:
+      specifies that a controller can only handle auto CMD12.
+
+  voltage-ranges:
+    $ref: /schemas/types.yaml#/definitions/uint32-matrix
+    items:
+      items:
+        - description: specifies minimum slot voltage (mV).
+        - description: specifies maximum slot voltage (mV).
+
+  little-endian:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description:
+      If the host controller is little-endian mode, specify
+      this property. The default endian mode is big-endian.
+
+required:
+  - compatible
+  - reg
+  - interrupts
+
+allOf:
+  - $ref: sdhci-common.yaml#
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    mmc@2e000 {
+        compatible = "fsl,mpc8378-esdhc", "fsl,esdhc";
+        reg = <0x2e000 0x1000>;
+        interrupts = <42 0x8>;
+        interrupt-parent = <&ipic>;
+        /* Filled in by U-Boot */
+        clock-frequency = <0>;
+        voltage-ranges = <3300 3300>;
+    };
-- 
2.34.1